[Core Data] Make new Core Data migration path. Remove models below 30 #15987
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -59,6 +59,17 @@ final class CoreDataIterativeMigrator { | |||||||||||||||||||||||||||
| // Find the current model used by the store. | ||||||||||||||||||||||||||||
| let sourceModel = try model(for: sourceMetadata) | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| // Check if we should nuke the DB entirely based on the oldest supported data model. | ||||||||||||||||||||||||||||
| // We will attempt to either move the merchant to the latest model version, or perform an iterative migration | ||||||||||||||||||||||||||||
| // The persistent store coordinator will automatically create a fresh store with the current model as needed. | ||||||||||||||||||||||||||||
| if shouldDestroyPersistentStore(for: sourceModel) { | ||||||||||||||||||||||||||||
| do { | ||||||||||||||||||||||||||||
| try destroyPersistentStore(sourceStoreURL: sourceStoreURL, storeType: storeType) | ||||||||||||||||||||||||||||
| } catch { | ||||||||||||||||||||||||||||
| DDLogError("[CoreDataIterativeMigrator] Direct migration failed. Error: \(error). Falling back to iterative migration.") | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| // Get the steps to perform the migration. | ||||||||||||||||||||||||||||
| let steps = try MigrationStep.steps(using: modelsInventory, source: sourceModel, target: targetModel) | ||||||||||||||||||||||||||||
| guard !steps.isEmpty else { | ||||||||||||||||||||||||||||
|
|
@@ -176,4 +187,37 @@ private extension CoreDataIterativeMigrator { | |||||||||||||||||||||||||||
| .appendingPathComponent("migration_\(UUID().uuidString)") | ||||||||||||||||||||||||||||
| .appendingPathExtension("sqlite") | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| func shouldDestroyPersistentStore(for sourceModel: NSManagedObjectModel) -> Bool { | ||||||||||||||||||||||||||||
| guard let sourceVersion = CoreDataMigratorUtils.findSourceVersion(for: sourceModel, in: modelsInventory) else { | ||||||||||||||||||||||||||||
| DDLogInfo("Could not determine source model version. Using iterative migration.") | ||||||||||||||||||||||||||||
| return false | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| // If the merchant is on a model version older than this, nuke the DB and migrate them to the latest one without iterative process | ||||||||||||||||||||||||||||
| let oldestModelThreshold = Constants.oldestSupportedDataModel | ||||||||||||||||||||||||||||
| let versionNumber = CoreDataMigratorUtils.extractVersionNumber(from: sourceVersion.name) | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
| guard let sourceVersion = CoreDataMigratorUtils.findSourceVersion(for: sourceModel, in: modelsInventory) else { | |
| DDLogInfo("Could not determine source model version. Using iterative migration.") | |
| return false | |
| } | |
| // If the merchant is on a model version older than this, nuke the DB and migrate them to the latest one without iterative process | |
| let oldestModelThreshold = Constants.oldestSupportedDataModel | |
| let versionNumber = CoreDataMigratorUtils.extractVersionNumber(from: sourceVersion.name) | |
| guard let versionNumber = CoreDataMigratorUtils.findSourceVersionNumber(for: sourceModel, in: modelsInventory) else { | |
| DDLogInfo("Could not determine source model version. Using iterative migration.") | |
| return false | |
| } | |
| // If the merchant is on a model version older than this, nuke the DB and migrate them to the latest one without iterative process | |
| let oldestModelThreshold = Constants.oldestSupportedDataModel |
Contributor
Author
There was a problem hiding this comment.
In general I'd prefer to keep these separated, but with the simplification you suggested on 6080964 we can also remove extractVersionNumber entirely.
jaclync marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
jaclync marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import CoreData | ||
|
|
||
| struct CoreDataMigratorUtils { | ||
| /// Finds the ModelVersion that corresponds to the given NSManagedObjectModel | ||
| static func findSourceVersion(for sourceModel: NSManagedObjectModel, | ||
| in modelsInventory: ManagedObjectModelsInventory) -> ManagedObjectModelsInventory.ModelVersion? { | ||
| do { | ||
| let allModels = try modelsInventory.models(for: modelsInventory.versions) | ||
| for (index, model) in allModels.enumerated() { | ||
| if model.isEqual(sourceModel) { | ||
| return modelsInventory.versions[index] | ||
| } | ||
| } | ||
|
Comment on lines
+8
to
+13
Contributor
There was a problem hiding this comment. ❓ Trying to ensure that it can return a deleted version. When I printed out If it's not possible, I think the code can be simplified by not having to compare with the oldest model version constant, since the available models in
Contributor
Author
There was a problem hiding this comment. That's a very good catch, and excellent suggestion. We can just rely on the existence of the model rather than having to check the version, which simplifies the logic and allows us to remove some. Updated here: 6080964 |
||
| } catch { | ||
| DDLogError("[CoreDataMigratorUtils] Error loading models for version detection: \(error)") | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| /// Extract version number from model version name | ||
| /// Examples: "Model" -> 0, "Model 10" -> 10, "Model 124" -> 124 | ||
| static func extractVersionNumber(from versionName: String) -> Int { | ||
| // Handle the base "Model" case (version 0) | ||
| if versionName == "Model" { | ||
| return 0 | ||
| } | ||
|
|
||
| // Extract number from "Model N" pattern | ||
| let components = versionName.components(separatedBy: " ") | ||
| if components.count == 2, let versionNumber = Int(components[1]) { | ||
| return versionNumber | ||
| } | ||
|
|
||
| // Fallback: couldn't parse version, assume it's very old (version 0) | ||
| DDLogWarn("[CoreDataMigratorUtils] Could not parse version number from '\(versionName)'. Assuming version 0.") | ||
| return 0 | ||
iamgabrielma marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.