Memory leak for ContiguousArrayStorage<NSPersistentStore> #225

New Issue

Open

opened 2025-12-29 18:24:33 +01:00 by adam · 3 comments

adam commented 2025-12-29 18:24:33 +01:00

Owner

Copy Link

Copy Source

Originally created by @DmitrijMaz on GitHub (Jul 27, 2018).

Hi,
Prerequisites:

CoreStore (5.1.1)

Sample NSManagedObject subclass. Others use the same principle for importing/updating
Every NSManagedObject subclass have uniqueConstraints setup (usually its id)

infix operator <<->: AssignmentPrecedence

/// Assignment operator that checks values for equality before assigning
///
/// - Parameters:
///   - to: Destination for assignment. Will only be assigned to `from` if they are not equal
///   - from: Source for assignment.
func <<-> <T>(to: inout T, from: T) where T: Equatable  {
    if to == from {
        return
    }
    to = from
}

/// Assignment operator that checks values for equality and unwraps before assigning
///
/// - Parameters:
///   - to: Destination for assignment. Will only be assigned to `from` if they are not equal, and `from` is not `nil`
///   - from: Source for assignment.
func <<-> <T>(to: inout T, from: T?) where T: Equatable  {
    guard let from = from else { return }
    to <<-> from
}

public final class Transfer: NSManagedObject {

    static let dateFormatter: DateFormatter = makeDateFormatter()

    @objc
    public enum Probability: Int16, Equatable & Decodable {
        case confirmed = 1
        case rumor = 2
        case doubtful = 3
    }

    @objc
    public enum Mode: Int16, Equatable & Decodable {
        case contractExtension = 1
        case transfer = 2
        case loan = 3
        case returns = 4
    }

    // MARK: Public
    @NSManaged private(set) var id: UniqueIDType
    @NSManaged private(set) var date: NSDate
    @NSManaged private(set) var daySection: NSNumber?

    // MARK: Relationship
    @NSManaged private(set) var fromTeam: Team?
    @NSManaged private(set) var toTeam: Team?
    @NSManaged private(set) var player: Player?

    // MARK: Private
    @NSManaged private(set) var sa_probability: Probability.RawValue
    @NSManaged private(set) var sa_type: Mode.RawValue
}

public extension Transfer {
    var icon: Images.Transfer {
        switch (probability, type) {
        case (.confirmed, .transfer): return .confirmed
        case (_, .transfer): return .rumor
        case (_, .loan): return .loan
        case (_, .contractExtension): return .contractExtension
        case (_, .returns): return .upDown
        }
    }

    var probability: Probability {
        return Probability(rawValue: sa_probability)!
    }

    var type: Mode {
        return Mode(rawValue: sa_type)!
    }

    func date(withFormat format: String) -> String {
        Transfer.dateFormatter.dateFormat = format
        return Transfer.dateFormatter.string(from: date as Date)
    }
}

extension Transfer: ImportableUniqueObject {
    public typealias UniqueIDType = Int64
    public static var uniqueIDKeyPath: String { return #keyPath(Transfer.id) }

    public struct ImportSource: Decodable {
        let id: UniqueIDType
        let fromTeam: Team.ImportSource
        let toTeam: Team.ImportSource
        let player: Player.ImportSource
        let transferProbabilityType: Probability
        let transferType: Mode
        let transferDate: Date
    }

    public static func uniqueID(from source: ImportSource, in transaction: BaseDataTransaction) throws -> UniqueIDType? {
        return source.id
    }

    public func update(from source: ImportSource, in transaction: BaseDataTransaction) throws {
        id <<-> source.id
        sa_probability <<-> source.transferProbabilityType.rawValue
        sa_type <<-> source.transferType.rawValue
        date <<-> source.transferDate as NSDate
        daySection <<-> Int64(date(withFormat: "yyyyMMdd")).flatMap(NSNumber.init)

        fromTeam = try transaction.importUniqueObject(Into<Team>(), source: source.fromTeam)
        toTeam = try transaction.importUniqueObject(Into<Team>(), source: source.toTeam)
        player = try transaction.importUniqueObject(Into<Player>(), source: source.player)
    }
}

fileprivate extension Transfer {
    static func makeDateFormatter() -> DateFormatter {
        let formatter = DateFormatter()
        formatter.timeZone = TimeZone(abbreviation: "UTC")
        return formatter
    }
}

Core store is setup using the following code:

public func initializeStorage(completion: @escaping (Result<(), StorageService.Errors>) -> Void) throws -> Progress? {
        guard dataStack == .none else {
            throw StorageService.Errors.alreadyInitialized
        }

        dataStack = DataStack(
            xcodeModelName: "<app_name>"
        )
        let storage = getStorage()
        App.logger?[.db].log(
            level: .debug,
            formatLog("Initialize Start", body: "\(storage)")
        )

        defer {
            CoreStore.defaultStack = dataStack
        }

        let storeCompletion: (Result<(), CoreStoreError>) -> Void = { (result) in
            switch result {
            case .success:
                App.logger?[.db].log(
                    level: .debug,
                    self.formatLog("Initialize End", body: "Data stack\n\(CoreStore.defaultStack)")
                )
                completion(.success(()))

            case .failure(let error):
                completion(
                    .failure(.initializationError(error))
                )
            }
        }
        switch storage {
        case let localStorage as SQLiteStore:
            return dataStack.addStorage(localStorage) { storeCompletion($0.asResult()) }
            
        case let inMemory as InMemoryStore:
            dataStack.addStorage(inMemory) { storeCompletion($0.asResult()) }
            return nil
        default:
            fatalError("Unknown storage \(storage)")
        }
    }

I have 5 screens that use ListMonitor to display the same object, just with a diffrent Where clauses

        let from = From<Transfer>()
        let sectionBy = SectionBy<Transfer>(\.daySection)
        let fetchClauses = fetchClauseProvider(from)
        App.storage.monitorSectionedList(
            createAsynchronously: { [weak self] (listMonitor) in
                self?.listMonitor = listMonitor
                handler(listMonitor)
            },
            from,
            sectionBy,
            fetchClauses
        )

The data is loaded from an API and imported using the code i've provided.

The results are the following:

Memory instrument trace:

Any help would be much appreciated. Contact me if more detailed information is needed.

Thanks!

Originally created by @DmitrijMaz on GitHub (Jul 27, 2018). Hi, Prerequisites: **CoreStore (5.1.1)** Sample `NSManagedObject` subclass. Others use the same principle for importing/updating Every `NSManagedObject` subclass have `uniqueConstraints` setup (usually its `id`) ```swift infix operator <<->: AssignmentPrecedence /// Assignment operator that checks values for equality before assigning /// /// - Parameters: /// - to: Destination for assignment. Will only be assigned to `from` if they are not equal /// - from: Source for assignment. func <<-> <T>(to: inout T, from: T) where T: Equatable { if to == from { return } to = from } /// Assignment operator that checks values for equality and unwraps before assigning /// /// - Parameters: /// - to: Destination for assignment. Will only be assigned to `from` if they are not equal, and `from` is not `nil` /// - from: Source for assignment. func <<-> <T>(to: inout T, from: T?) where T: Equatable { guard let from = from else { return } to <<-> from } ``` ```swift public final class Transfer: NSManagedObject { static let dateFormatter: DateFormatter = makeDateFormatter() @objc public enum Probability: Int16, Equatable & Decodable { case confirmed = 1 case rumor = 2 case doubtful = 3 } @objc public enum Mode: Int16, Equatable & Decodable { case contractExtension = 1 case transfer = 2 case loan = 3 case returns = 4 } // MARK: Public @NSManaged private(set) var id: UniqueIDType @NSManaged private(set) var date: NSDate @NSManaged private(set) var daySection: NSNumber? // MARK: Relationship @NSManaged private(set) var fromTeam: Team? @NSManaged private(set) var toTeam: Team? @NSManaged private(set) var player: Player? // MARK: Private @NSManaged private(set) var sa_probability: Probability.RawValue @NSManaged private(set) var sa_type: Mode.RawValue } public extension Transfer { var icon: Images.Transfer { switch (probability, type) { case (.confirmed, .transfer): return .confirmed case (_, .transfer): return .rumor case (_, .loan): return .loan case (_, .contractExtension): return .contractExtension case (_, .returns): return .upDown } } var probability: Probability { return Probability(rawValue: sa_probability)! } var type: Mode { return Mode(rawValue: sa_type)! } func date(withFormat format: String) -> String { Transfer.dateFormatter.dateFormat = format return Transfer.dateFormatter.string(from: date as Date) } } extension Transfer: ImportableUniqueObject { public typealias UniqueIDType = Int64 public static var uniqueIDKeyPath: String { return #keyPath(Transfer.id) } public struct ImportSource: Decodable { let id: UniqueIDType let fromTeam: Team.ImportSource let toTeam: Team.ImportSource let player: Player.ImportSource let transferProbabilityType: Probability let transferType: Mode let transferDate: Date } public static func uniqueID(from source: ImportSource, in transaction: BaseDataTransaction) throws -> UniqueIDType? { return source.id } public func update(from source: ImportSource, in transaction: BaseDataTransaction) throws { id <<-> source.id sa_probability <<-> source.transferProbabilityType.rawValue sa_type <<-> source.transferType.rawValue date <<-> source.transferDate as NSDate daySection <<-> Int64(date(withFormat: "yyyyMMdd")).flatMap(NSNumber.init) fromTeam = try transaction.importUniqueObject(Into<Team>(), source: source.fromTeam) toTeam = try transaction.importUniqueObject(Into<Team>(), source: source.toTeam) player = try transaction.importUniqueObject(Into<Player>(), source: source.player) } } fileprivate extension Transfer { static func makeDateFormatter() -> DateFormatter { let formatter = DateFormatter() formatter.timeZone = TimeZone(abbreviation: "UTC") return formatter } } ``` Core store is setup using the following code: ```swift public func initializeStorage(completion: @escaping (Result<(), StorageService.Errors>) -> Void) throws -> Progress? { guard dataStack == .none else { throw StorageService.Errors.alreadyInitialized } dataStack = DataStack( xcodeModelName: "<app_name>" ) let storage = getStorage() App.logger?[.db].log( level: .debug, formatLog("Initialize Start", body: "\(storage)") ) defer { CoreStore.defaultStack = dataStack } let storeCompletion: (Result<(), CoreStoreError>) -> Void = { (result) in switch result { case .success: App.logger?[.db].log( level: .debug, self.formatLog("Initialize End", body: "Data stack\n\(CoreStore.defaultStack)") ) completion(.success(())) case .failure(let error): completion( .failure(.initializationError(error)) ) } } switch storage { case let localStorage as SQLiteStore: return dataStack.addStorage(localStorage) { storeCompletion($0.asResult()) } case let inMemory as InMemoryStore: dataStack.addStorage(inMemory) { storeCompletion($0.asResult()) } return nil default: fatalError("Unknown storage \(storage)") } } ``` I have 5 screens that use `ListMonitor` to display the same object, just with a diffrent `Where` clauses ```swift let from = From<Transfer>() let sectionBy = SectionBy<Transfer>(\.daySection) let fetchClauses = fetchClauseProvider(from) App.storage.monitorSectionedList( createAsynchronously: { [weak self] (listMonitor) in self?.listMonitor = listMonitor handler(listMonitor) }, from, sectionBy, fetchClauses ) ``` The data is loaded from an API and imported using the code i've provided. The results are the following:  Memory instrument trace:  Any help would be much appreciated. Contact me if more detailed information is needed. Thanks!

adam commented 2025-12-29 18:24:34 +01:00

Author

Owner

Copy Link

Copy Source

@JohnEstropia commented on GitHub (Jul 28, 2018):

Hi, thanks for the detailed info. May I ask how getStorage() creates your SQLiteStore?

Also, are Transfer objects managed in the SQLiteStore or the InMemoryStore?

@JohnEstropia commented on GitHub (Jul 28, 2018): Hi, thanks for the detailed info. May I ask how `getStorage()` creates your `SQLiteStore`? Also, are `Transfer` objects managed in the `SQLiteStore` or the `InMemoryStore`?

adam commented 2025-12-29 18:24:34 +01:00

Author

Owner

Copy Link

Copy Source

@ghost commented on GitHub (Jul 28, 2018):

Its created using local option storage with .recreateStoreOnMismatch
Everything is in sqlite store

@ghost commented on GitHub (Jul 28, 2018): Its created using local option storage with .recreateStoreOnMismatch Everything is in sqlite store

adam commented 2025-12-29 18:24:34 +01:00

Author

Owner

Copy Link

Copy Source

@DmitrijMaz commented on GitHub (Jul 30, 2018):

private func getStorage() -> StorageInterface {
        switch mode {
        case .default:
            return SQLiteStore(
                fileName: "<app_name>",
                localStorageOptions: .recreateStoreOnModelMismatch
            )
        case .testing:
            return InMemoryStore()
        }
    }

I was doing all this in default mode

@DmitrijMaz commented on GitHub (Jul 30, 2018): ```swift private func getStorage() -> StorageInterface { switch mode { case .default: return SQLiteStore( fileName: "<app_name>", localStorageOptions: .recreateStoreOnModelMismatch ) case .testing: return InMemoryStore() } } ``` I was doing all this in `default` mode

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

develop

prototype/swift6

master

prototype/concurrency

minIOS13

prototype/containers

transactionSourceTracking

prototype/swiftui

minIOS11

swift5_3

prototype/propertyWrapperFields

prototype/propertyWrappers

prototype/propertyWrapper

Swift5

throwables

prototype/Swift_4_1

prototype/Swift_4_0

prototype/Swift_3_2

prototype/queryBuilders

temp/develop

corestore4_develop

prototype/mainContextToPSC

master_ios_7_to_9

swift_2_3

gh-pages

_corespotlight-test

9.3.0

9.2.0

9.1.0

9.0.0

8.1.0

8.0.1

8.0.0

7.3.1

7.3.0

7.2.0

7.1.0

7.0.4

7.0.3

7.0.2

7.0.1

7.0.0

6.3.2

6.3.1

6.3.0

6.2.1

6.2.0

6.1.0

6.0.0

5.3.1

5.3.0

5.2.0

5.1.1

5.1.0

5.0.0

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.4

4.1.3

4.1.1

4.1.0

4.0.5

4.0.4

4.0.3

4.0.2

4.0.1

4.0.0

4.0.0-beta3

4.0.0-beta2

4.0.0-beta

3.1.1

3.1.0

3.0.3

3.0.2

3.0.1

3.0.0

2.1.3

2.1.2

2.1.1

2.1.0

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.6.10

1.6.9

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.1

1.2.0

1.0.2

1.0.1

1.0.0

0.2.1

0.2.0

0.1.2

0.1.1

0.1.0

Labels

Clear labels

abandoned

corestore bug

discussion

duplicate

enhancement

fixed

fixed

help wanted

in progress

investigating

ios/compiler bug

irreproducible

looking for workarounds

not a bug

pending

pending docs update

pull-request

Mirrored from GitHub Pull Request

question

regression

user bug

wontfix

No labels

Milestone

No items

No Milestone

Projects

Clear projects

No projects

Assignees

Clear assignees

adam (Adam Melkus)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/CoreStore-JohnEstropia#225