fix(datastore): Rename ModelIdentifiable.Identifier to IdentifierProtocol (#2077)

lawmicha · web-flow · commit f0c3534ce3e0 · 2022-08-05T14:20:09.000-04:00
diff --git a/Amplify/Categories/DataStore/Model/ModelIdentifiable.swift b/Amplify/Categories/DataStore/Model/ModelIdentifiable.swift
@@ -28,7 +28,7 @@ public enum ModelIdentifierFormat {
 /// that can be either a single field or a combination of fields
 public protocol ModelIdentifiable {
     associatedtype IdentifierFormat: AnyModelIdentifierFormat
-    associatedtype Identifier: ModelIdentifierProtocol
+    associatedtype IdentifierProtocol: ModelIdentifierProtocol
 }
 
 /// Defines a `ModelIdentifier` requirements.
@@ -53,15 +53,6 @@ public protocol ModelIdentifierProtocol {
     var predicate: QueryPredicate { get }
 }
 
-extension Model.Identifier: ModelIdentifierProtocol {
-   public var fields: Fields {
-       [(name: ModelIdentifierFormat.Default.name, value: self)]
-   }
-   public var stringValue: String {
-       self
-   }
-}
-
 public extension ModelIdentifierProtocol {
     var stringValue: String {
         if fields.count == 1, let field = fields.first {
diff --git a/AmplifyPlugins/Core/AWSPluginsCore/Sync/MutationSync/MutationSyncMetadata+Schema.swift b/AmplifyPlugins/Core/AWSPluginsCore/Sync/MutationSync/MutationSyncMetadata+Schema.swift
@@ -39,6 +39,6 @@ extension MutationSyncMetadata {
 
 
 extension MutationSyncMetadata: ModelIdentifiable {
-    public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Default>
+    public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Default>
     public typealias IdentifierFormat = ModelIdentifierFormat.Default
 }
diff --git a/AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginTests/Core/SQLStatementTests.swift b/AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginTests/Core/SQLStatementTests.swift
@@ -609,7 +609,7 @@ class SQLStatementTests: XCTestCase {
     ///   - check if the generated SQL statement is valid
     ///   - check if the variables match the expected values
     func testDeleteStatementFromModelWithCustomPK() {
-        let identifier = ModelExplicitCustomPk.Identifier.identifier(userId: "userId")
+        let identifier = ModelExplicitCustomPk.IdentifierProtocol.identifier(userId: "userId")
         let statement = DeleteStatement(modelSchema: ModelExplicitCustomPk.schema,
                                         withIdentifier: identifier)
 
@@ -631,8 +631,8 @@ class SQLStatementTests: XCTestCase {
     ///   - check if the generated SQL statement is valid
     ///   - check if the variables match the expected values
     func testDeleteStatementFromModelWithCompositePK() {
-        let identifier = ModelCompositePk.Identifier.identifier(id: "id",
-                                                        dob: Temporal.DateTime.now())
+        let identifier = ModelCompositePk.IdentifierProtocol.identifier(id: "id",
+                                                                        dob: Temporal.DateTime.now())
         let statement = DeleteStatement(modelSchema: ModelCompositePk.schema,
                                         withIdentifier: identifier)
 
diff --git a/AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginTests/Models/SQLModelValueConverterTests.swift b/AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginTests/Models/SQLModelValueConverterTests.swift
@@ -143,7 +143,7 @@ class SQLModelValueConverterTests: BaseDataStoreTests {
             "__typename": "CommentWithCompositeKey"
         ]
         let bindings = DynamicModel(id: commentId, values: model).sqlValues(modelSchema: CommentWithCompositeKey.schema)
-        let expectedPostIdentifier = PostWithCompositeKey.Identifier.identifier(id: postId, title: postTitle)
+        let expectedPostIdentifier = PostWithCompositeKey.IdentifierProtocol.identifier(id: postId, title: postTitle)
 
         XCTAssertEqual(bindings[0] as? String, commentId)
         XCTAssertEqual(bindings[1] as? String, commentContent)
diff --git a/AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginTests/Storage/CascadeDeleteOperationTests.swift b/AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginTests/Storage/CascadeDeleteOperationTests.swift
@@ -117,7 +117,7 @@ class CascadeDeleteOperationTests: StorageEngineTestsBase {
         XCTAssertEqual(queriedModel[0].dob, model.dob)
 
         let completed = expectation(description: "operation completed")
-        let identifier = ModelCompositePk.Identifier.identifier(id: modelId, dob: modelDob)
+        let identifier = ModelCompositePk.IdentifierProtocol.identifier(id: modelId, dob: modelDob)
         let operation = CascadeDeleteOperation(storageAdapter: storageAdapter,
                                                syncEngine: nil,
                                                modelType: ModelCompositePk.self,
@@ -421,7 +421,7 @@ class CascadeDeleteOperationTests: StorageEngineTestsBase {
         }
 
         let completed = expectation(description: "operation completed")
-        let identifier = ModelCompositePk.Identifier.identifier(id: modelId, dob: modelDob)
+        let identifier = ModelCompositePk.IdentifierProtocol.identifier(id: modelId, dob: modelDob)
         let operation = CascadeDeleteOperation(storageAdapter: storageAdapter,
                                                syncEngine: syncEngine,
                                                modelType: ModelCompositePk.self,
@@ -721,7 +721,7 @@ class CascadeDeleteOperationTests: StorageEngineTestsBase {
         }
 
         let completed = expectation(description: "operation completed")
-        let identifier = PostWithCompositeKey.Identifier.identifier(id: post.id, title: post.title)
+        let identifier = PostWithCompositeKey.IdentifierProtocol.identifier(id: post.id, title: post.title)
         let operation = CascadeDeleteOperation(storageAdapter: storageAdapter,
                                                syncEngine: syncEngine,
                                                modelType: PostWithCompositeKey.self,
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/CommentWithCompositeKey+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/CommentWithCompositeKey+Schema.swift
@@ -44,10 +44,10 @@ extension CommentWithCompositeKey {
 
 extension CommentWithCompositeKey: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-  public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+  public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension CommentWithCompositeKey.Identifier {
+extension CommentWithCompositeKey.IdentifierProtocol {
   public static func identifier(id: String,
       content: String) -> Self {
     .make(fields: [(name: "id", value: id), (name: "content", value: content)])
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/CommentWithCompositeKeyAndIndex+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/CommentWithCompositeKeyAndIndex+Schema.swift
@@ -45,10 +45,10 @@ extension CommentWithCompositeKeyAndIndex {
 
 extension CommentWithCompositeKeyAndIndex: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-  public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+  public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension CommentWithCompositeKeyAndIndex.Identifier {
+extension CommentWithCompositeKeyAndIndex.IdentifierProtocol {
   public static func identifier(id: String,
       content: String) -> Self {
     .make(fields: [(name: "id", value: id), (name: "content", value: content)])
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/CommentWithCompositeKeyUnidirectional+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/CommentWithCompositeKeyUnidirectional+Schema.swift
@@ -46,10 +46,10 @@ extension CommentWithCompositeKeyUnidirectional {
 
 extension CommentWithCompositeKeyUnidirectional: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-  public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+  public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension CommentWithCompositeKeyUnidirectional.Identifier {
+extension CommentWithCompositeKeyUnidirectional.IdentifierProtocol {
   public static func identifier(id: String,
       content: String) -> Self {
     .make(fields: [(name: "id", value: id), (name: "content", value: content)])
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCompositeIntPk+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCompositeIntPk+Schema.swift
@@ -43,10 +43,10 @@ extension ModelCompositeIntPk {
 
 extension ModelCompositeIntPk: ModelIdentifiable {
     public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-    public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+    public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension ModelCompositeIntPk.Identifier {
+extension ModelCompositeIntPk.IdentifierProtocol {
     public static func identifier(id: String, serial: Int) -> Self {
         .make(fields: [(name: "id", value: id), (name: "serial", value: serial)])
     }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCompositePk+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCompositePk+Schema.swift
@@ -43,10 +43,10 @@ extension ModelCompositePk {
 
 extension ModelCompositePk: ModelIdentifiable {
     public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-    public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+    public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension ModelCompositePk.Identifier {
+extension ModelCompositePk.IdentifierProtocol {
     public static func identifier(id: String, dob: Temporal.DateTime) -> Self {
         .make(fields: [(name: "id", value: id), (name: "dob", value: dob)])
     }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCompositePkBelongsTo+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCompositePkBelongsTo+Schema.swift
@@ -50,10 +50,10 @@ extension ModelCompositePkBelongsTo {
 
 extension ModelCompositePkBelongsTo: ModelIdentifiable {
     public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-    public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+    public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension ModelCompositePkBelongsTo.Identifier {
+extension ModelCompositePkBelongsTo.IdentifierProtocol {
     public static func identifier(id: String, dob: Temporal.DateTime) -> Self {
         .make(fields: [(name: "id", value: id), (name: "dob", value: dob)])
     }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCompositePkWithAssociation+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCompositePkWithAssociation+Schema.swift
@@ -48,10 +48,10 @@ extension ModelCompositePkWithAssociation {
 
 extension ModelCompositePkWithAssociation: ModelIdentifiable {
     public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-    public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+    public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension ModelCompositePkWithAssociation.Identifier {
+extension ModelCompositePkWithAssociation.IdentifierProtocol {
     public static func identifier(id: String, dob: Temporal.DateTime) -> Self {
         .make(fields: [(name: "id", value: id), (name: "dob", value: dob)])
     }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCustomPkDefined+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/ModelCustomPkDefined+Schema.swift
@@ -45,10 +45,10 @@ extension ModelCustomPkDefined {
 
 extension ModelCustomPkDefined: ModelIdentifiable {
     public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-    public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+    public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension ModelCustomPkDefined.Identifier {
+extension ModelCustomPkDefined.IdentifierProtocol {
     public static func identifier(id: String, dob: Temporal.DateTime) -> Self {
         .make(fields: [(name: "id", value: id), (name: "dob", value: dob)])
     }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/ModelExplicitCustomPk+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/ModelExplicitCustomPk+Schema.swift
@@ -41,10 +41,10 @@ extension ModelExplicitCustomPk {
 
 extension ModelExplicitCustomPk: ModelIdentifiable {
     public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-    public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+    public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension ModelExplicitCustomPk.Identifier {
+extension ModelExplicitCustomPk.IdentifierProtocol {
     public static func identifier(userId: String) -> Self {
         .make(fields: [(name: "userId", value: userId)])
     }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/ModelExplicitDefaultPk+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/ModelExplicitDefaultPk+Schema.swift
@@ -41,10 +41,10 @@ extension ModelExplicitDefaultPk {
 
 extension ModelExplicitDefaultPk: ModelIdentifiable {
     public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-    public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+    public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension ModelExplicitDefaultPk.Identifier {
+extension ModelExplicitDefaultPk.IdentifierProtocol {
     public static func identifier(id: String) -> Self {
         .make(fields: [(name: "id", value: id)])
     }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/ModelImplicitDefaultPk+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/ModelImplicitDefaultPk+Schema.swift
@@ -37,5 +37,5 @@ extension ModelImplicitDefaultPk {
 
 extension ModelImplicitDefaultPk: ModelIdentifiable {
     public typealias IdentifierFormat = ModelIdentifierFormat.Default
-    public typealias Identifier = DefaultModelIdentifier<Self>
+    public typealias IdentifierProtocol = DefaultModelIdentifier<Self>
 }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/PostTagsWithCompositeKey+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/PostTagsWithCompositeKey+Schema.swift
@@ -45,5 +45,5 @@ extension PostTagsWithCompositeKey {
 
 extension PostTagsWithCompositeKey: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Default
-  public typealias Identifier = DefaultModelIdentifier<Self>
+  public typealias IdentifierProtocol = DefaultModelIdentifier<Self>
 }
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/PostWithCompositeKey+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/PostWithCompositeKey+Schema.swift
@@ -44,10 +44,10 @@ extension PostWithCompositeKey {
 
 extension PostWithCompositeKey: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-  public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+  public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension PostWithCompositeKey.Identifier {
+extension PostWithCompositeKey.IdentifierProtocol {
   public static func identifier(id: String,
       title: String) -> Self {
     .make(fields: [(name: "id", value: id), (name: "title", value: title)])
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/PostWithCompositeKeyAndIndex+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/PostWithCompositeKeyAndIndex+Schema.swift
@@ -44,10 +44,10 @@ extension PostWithCompositeKeyAndIndex {
 
 extension PostWithCompositeKeyAndIndex: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-  public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+  public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension PostWithCompositeKeyAndIndex.Identifier {
+extension PostWithCompositeKeyAndIndex.IdentifierProtocol {
   public static func identifier(id: String,
       title: String) -> Self {
     .make(fields: [(name: "id", value: id), (name: "title", value: title)])
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/PostWithCompositeKeyUnidirectional+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/PostWithCompositeKeyUnidirectional+Schema.swift
@@ -47,10 +47,10 @@ extension PostWithCompositeKeyUnidirectional {
 
 extension PostWithCompositeKeyUnidirectional: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-  public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+  public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension PostWithCompositeKeyUnidirectional.Identifier {
+extension PostWithCompositeKeyUnidirectional.IdentifierProtocol {
   public static func identifier(id: String,
       title: String) -> Self {
     .make(fields: [(name: "id", value: id), (name: "title", value: title)])
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/PostWithTagsCompositeKey+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/PostWithTagsCompositeKey+Schema.swift
@@ -44,10 +44,10 @@ extension PostWithTagsCompositeKey {
 
 extension PostWithTagsCompositeKey: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-  public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+  public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension PostWithTagsCompositeKey.Identifier {
+extension PostWithTagsCompositeKey.IdentifierProtocol {
   public static func identifier(postId: String,
       title: String) -> Self {
     .make(fields: [(name: "postId", value: postId), (name: "title", value: title)])
diff --git a/AmplifyTestCommon/Models/CustomPrimaryKey/TagWithCompositeKey+Schema.swift b/AmplifyTestCommon/Models/CustomPrimaryKey/TagWithCompositeKey+Schema.swift
@@ -44,10 +44,10 @@ extension TagWithCompositeKey {
 
 extension TagWithCompositeKey: ModelIdentifiable {
   public typealias IdentifierFormat = ModelIdentifierFormat.Custom
-  public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
+  public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>
 }
 
-extension TagWithCompositeKey.Identifier {
+extension TagWithCompositeKey.IdentifierProtocol {
   public static func identifier(id: String,
       name: String) -> Self {
     .make(fields: [(name: "id", value: id), (name: "name", value: name)])

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,6 @@ extension MutationSyncMetadata {`
`39`	`39`
`40`	`40`
`41`	`41`	`extension MutationSyncMetadata: ModelIdentifiable {`
`42`		`- public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Default>`
	`42`	`+ public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Default>`
`43`	`43`	`public typealias IdentifierFormat = ModelIdentifierFormat.Default`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ class SQLModelValueConverterTests: BaseDataStoreTests {`
`143`	`143`	`"__typename": "CommentWithCompositeKey"`
`144`	`144`	`]`
`145`	`145`	`let bindings = DynamicModel(id: commentId, values: model).sqlValues(modelSchema: CommentWithCompositeKey.schema)`
`146`		`- let expectedPostIdentifier = PostWithCompositeKey.Identifier.identifier(id: postId, title: postTitle)`
	`146`	`+ let expectedPostIdentifier = PostWithCompositeKey.IdentifierProtocol.identifier(id: postId, title: postTitle)`
`147`	`147`
`148`	`148`	`XCTAssertEqual(bindings[0] as? String, commentId)`
`149`	`149`	`XCTAssertEqual(bindings[1] as? String, commentContent)`
Original file line number	Diff line number	Diff line change
`@@ -43,10 +43,10 @@ extension ModelCompositeIntPk {`
`43`	`43`
`44`	`44`	`extension ModelCompositeIntPk: ModelIdentifiable {`
`45`	`45`	`public typealias IdentifierFormat = ModelIdentifierFormat.Custom`
`46`		`- public typealias Identifier = ModelIdentifier<Self, ModelIdentifierFormat.Custom>`
	`46`	`+ public typealias IdentifierProtocol = ModelIdentifier<Self, ModelIdentifierFormat.Custom>`
`47`	`47`	`}`
`48`	`48`
`49`		`-extension ModelCompositeIntPk.Identifier {`
	`49`	`+extension ModelCompositeIntPk.IdentifierProtocol {`
`50`	`50`	`public static func identifier(id: String, serial: Int) -> Self {`
`51`	`51`	`.make(fields: [(name: "id", value: id), (name: "serial", value: serial)])`
`52`	`52`	`}`