chore(datastore): Update single auth integration tests to use V2 Transform (#1936)

Author: lawmicha

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/DefaultAuthCognito/AWSDataStoreCategoryPluginAuthIntegrationTests.swift

@@ -78,131 +78,6 @@ class AWSDataStoreCategoryPluginAuthIntegrationTests: AWSDataStoreAuthBaseTest {
         XCTAssertEqual(user.username, remoteTodoOwner)
     }
 
-    /// User1, while signed in, creates some data, called "NewUser1Data" in a local store. We wait for this data to be
-    /// synced to the cloud and then call `DataStore.clear()` so that data will be destroyed in the local data store and
-    /// the remote sync engine will be halted. After this finishes, we sign out of user1 and sign in with user2, which
-    /// will restart the sync engine and read all of data from the backend including "NewUser1Data".
-    ///
-    /// - Given: A DataStore plugin configured with auth enabled TodoExplicitOwnerField model that can be read others.
-    /// - When:
-    ///    - The owner user is signed in, user saves a todo, syncReceived successfully
-    ///    - Owner signs out, `DataStore.clear`, then retrieving the todo returns nil
-    ///    - The other user signs in, sync engine is started and does a full sync
-    ///    - The other user is able to retrieve the owner's todo
-    func testOwnerCreatedDataCanBeReadByOtherUsersForReadableModel() throws {
-        setup(withModels: ModelsRegistration(), testType: .defaultAuthCognito)
-
-        signIn(user: user1)
-
-        let id = UUID().uuidString
-        let localTodo = TodoExplicitOwnerField(id: id, content: "owner created content", owner: nil)
-        let localTodoSaveInvoked = expectation(description: "local note was saved")
-
-        let syncReceivedInvoked = expectation(description: "received SyncReceived event")
-        var remoteTodoOptional: TodoExplicitOwnerField?
-        let syncReceivedListener = Amplify.Hub.listen(to: .dataStore, eventName: syncReceived) { payload in
-            guard let mutationEvent = payload.data as? MutationEvent,
-                let todo = try? mutationEvent.decodeModel() as? TodoExplicitOwnerField else {
-                    XCTFail("Can't cast payload as mutation event")
-                    return
-            }
-            if todo.id == localTodo.id, remoteTodoOptional == nil {
-                remoteTodoOptional = todo
-                syncReceivedInvoked.fulfill()
-            }
-        }
-        guard try HubListenerTestUtilities.waitForListener(with: syncReceivedListener, timeout: 5.0) else {
-            XCTFail("syncReceivedListener registered for hub")
-            return
-        }
-
-        Amplify.DataStore.save(localTodo) { result in
-            switch result {
-            case .success(let note):
-                localTodoSaveInvoked.fulfill()
-            case .failure(let error):
-                XCTFail("Failed to save note \(error)")
-            }
-        }
-        wait(for: [localTodoSaveInvoked], timeout: TestCommonConstants.networkTimeout)
-        wait(for: [syncReceivedInvoked], timeout: TestCommonConstants.networkTimeout)
-        guard let remoteTodo = remoteTodoOptional else {
-            XCTFail("Should have received a SyncReceived event with the remote note reconciled to local store")
-            return
-        }
-        guard let owner = remoteTodo.owner else {
-            XCTFail("Could not retrieve owner value from remote note")
-            return
-        }
-
-        signOut()
-
-        let clearCompletedInvoked = expectation(description: "clear completed")
-        Amplify.DataStore.clear { result in
-            switch result {
-            case .success:
-                clearCompletedInvoked.fulfill()
-            case .failure(let error):
-                XCTFail("Failed to clear \(error)")
-            }
-        }
-
-        wait(for: [clearCompletedInvoked], timeout: TestCommonConstants.networkTimeout)
-
-        let modelSyncedInvoked = expectation(description: "Model fully synced")
-        Amplify
-            .Hub
-            .publisher(for: .dataStore)
-            .filter { $0.eventName == HubPayload.EventName.DataStore.ready }
-            .sink { _ in
-                modelSyncedInvoked.fulfill()
-            }.store(in: &requests)
-
-        let localNoteOptional = queryModel(TodoExplicitOwnerField.self, byId: id)
-        XCTAssertNil(localNoteOptional)
-
-        let syncStartedInvoked2 = expectation(description: "Sync started after other sign in")
-        let syncStartedListener2 = Amplify.Hub.listen(to: .dataStore, eventName: syncStarted) { _ in
-            syncStartedInvoked2.fulfill()
-        }
-        guard try HubListenerTestUtilities.waitForListener(with: syncStartedListener2, timeout: 5.0) else {
-            XCTFail("syncStartedListener2 not registered")
-            return
-        }
-
-        let syncReceivedInvoked2 = expectation(description: "received SyncReceived event for owner")
-        var remoteNoteOptional2: TodoExplicitOwnerField?
-        let syncReceivedListener2 = Amplify.Hub.listen(to: .dataStore, eventName: syncReceived) { payload in
-            guard let mutationEvent = payload.data as? MutationEvent,
-                let note = try? mutationEvent.decodeModel() as? TodoExplicitOwnerField else {
-                    XCTFail("Can't cast payload as mutation event")
-                    return
-            }
-            if note.id == localTodo.id {
-                remoteNoteOptional2 = note
-                syncReceivedInvoked2.fulfill()
-            }
-        }
-        guard try HubListenerTestUtilities.waitForListener(with: syncReceivedListener2, timeout: 5.0) else {
-            XCTFail("syncReceivedListener2 registered for hub")
-            return
-        }
-        signIn(user: user2)
-        guard let currentUser = Amplify.Auth.getCurrentUser() else {
-            XCTFail("Could not retrieve current user")
-            return
-        }
-        XCTAssertNotEqual(currentUser.username, owner)
-        wait(for: [syncStartedInvoked2], timeout: TestCommonConstants.networkTimeout)
-        wait(for: [syncReceivedInvoked2], timeout: TestCommonConstants.networkTimeout)
-        guard let ownerRemoteNote = remoteNoteOptional2, let remoteNoteOwner = ownerRemoteNote.owner else {
-            XCTFail("Should have received a SyncReceived event with the remote note reconciled to local store")
-            return
-        }
-
-        XCTAssertEqual(owner, remoteNoteOwner)
-        wait(for: [modelSyncedInvoked], timeout: TestCommonConstants.networkTimeout)
-    }
 }
 
 extension AWSDataStoreCategoryPluginAuthIntegrationTests {

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/DefaultAuthCognito/Models/TodoCustomOwnerExplicit+Schema.swift

@@ -26,7 +26,7 @@ extension TodoCustomOwnerExplicit {
     let todoCustomOwnerExplicit = TodoCustomOwnerExplicit.keys
 
     model.authRules = [
-      rule(allow: .owner, ownerField: "dominus", identityClaim: "cognito:username", operations: [.create, .update, .delete, .read])
+      rule(allow: .owner, ownerField: "dominus", identityClaim: "cognito:username", provider: .userPools, operations: [.create, .update, .delete, .read])
     ]
 
     model.pluralName = "TodoCustomOwnerExplicits"

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/DefaultAuthCognito/Models/TodoCustomOwnerImplicit+Schema.swift

@@ -25,7 +25,7 @@ extension TodoCustomOwnerImplicit {
     let todoCustomOwnerImplicit = TodoCustomOwnerImplicit.keys
 
     model.authRules = [
-      rule(allow: .owner, ownerField: "dominus", identityClaim: "cognito:username", operations: [.create, .update, .delete, .read])
+      rule(allow: .owner, ownerField: "dominus", identityClaim: "cognito:username", provider: .userPools, operations: [.create, .update, .delete, .read])
     ]
 
     model.pluralName = "TodoCustomOwnerImplicits"

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/DefaultAuthCognito/Models/TodoExplicitOwnerField+Schema.swift

@@ -26,7 +26,7 @@ extension TodoExplicitOwnerField {
     let todoExplicitOwnerField = TodoExplicitOwnerField.keys
 
     model.authRules = [
-      rule(allow: .owner, ownerField: "owner", identityClaim: "cognito:username", operations: [.create, .update, .delete])
+      rule(allow: .owner, ownerField: "owner", identityClaim: "cognito:username", provider: .userPools, operations: [.read, .create, .update, .delete])
     ]
 
     model.pluralName = "TodoExplicitOwnerFields"

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/DefaultAuthCognito/Models/TodoImplicitOwnerField+Schema.swift

@@ -25,7 +25,7 @@ extension TodoImplicitOwnerField {
     let todoImplicitOwnerField = TodoImplicitOwnerField.keys
 
     model.authRules = [
-      rule(allow: .owner, ownerField: "owner", identityClaim: "cognito:username", operations: [.create, .update, .delete, .read])
+      rule(allow: .owner, ownerField: "owner", identityClaim: "cognito:username", provider: .userPools, operations: [.create, .update, .delete, .read])
     ]
 
     model.pluralName = "TodoImplicitOwnerFields"

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/DefaultAuthCognito/README.md

@@ -7,19 +7,21 @@ This configuration is used to run the tests in `AWSDataStoreCategoryPluginAuthIn
 
 1. `amplify init`
 
-2. `amplify add api`
+2. Make sure the correct CLI version is used for this test. 
+
+- `amplify --v` should be at least 8.5.2
+- cli.json "transformerversion": 2
+- cli.json "useexperimentalpipelinedtransformer": true
+- cli.json "usesubusernamefordefaultidentityclaim": true
+
+3. `amplify add api`
 
 ```perl
 ? Select from one of the below mentioned services: GraphQL
-? Here is the GraphQL API that we will create. Select a setting to edit or continue Authorization modes: API key (default, expiration time: 7 days fro
-m now)
-? Choose the default authorization type for the API: Cognito User Pools
-? Configure additional auth types? No
-? Here is the GraphQL API that we will create. Select a setting to edit or continue Conflict detection (required for DataStore): Disabled
-? Enable conflict detection? Yes
-? Select the default resolution strategy Auto Merge
-? Here is the GraphQL API that we will create. Select a setting to edit or continue Continue
-? Choose a schema template: Blank Schema
+  Authorization modes: Amazon Cognito User Pool (default) 
+  Conflict detection (required for DataStore): Enabled 
+  Conflict resolution strategy: Auto Merge
+? Choose a schema template: Blank Schema  
 ? Do you want to edit the schema now? `Yes`
 ```
 

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/DefaultAuthCognito/singleauth-cognito-schema.graphql

@@ -1,6 +1,6 @@
 type TodoExplicitOwnerField
     @model
-    @auth(rules: [{ allow: owner, ownerField: "owner", operations: [create, update, delete] }]) {
+    @auth(rules: [{ allow: owner, ownerField: "owner", operations: [read, create, update, delete] }]) {
     id: ID!
     content: String!
     owner: String
@@ -25,7 +25,7 @@ type TodoCustomOwnerExplicit @model @auth(rules: [{ allow: owner, ownerField: "d
 }
 
 type TodoCognitoExplicitOperations @model
-  @auth(rules: [{ allow: owner, operations: [create, delete] }]) {
+  @auth(rules: [{ allow: owner, operations: [read, create, delete] }]) {
   id: ID!
   title: String!
 }

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/DefaultAuthIAM/README.md

@@ -5,7 +5,14 @@ This configuration is used to run the tests in `AWSDataStoreCategoryPluginAuthIn
 
 ### Set-up
 
-1. `amplify init`
+1. `amplify init`. 
+
+These tests were provisioned with V1 Transform:
+
+- cli.json "transformerversion": 1
+- cli.json "useexperimentalpipelinedtransformer": false
+
+TODO: Update the schema and tests to use V2 Transform. 
 
 2. `amplify add api`
 

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginAuthIntegrationTests/MultiAuth/README.md

@@ -8,6 +8,13 @@
 
 1. `amplify init`
 
+These tests were provisioned with V1 Transform:
+
+- cli.json "transformerversion": 1
+- cli.json "useexperimentalpipelinedtransformer": false
+
+TODO: Update the schema and tests to use V2 Transform.
+
 2. `amplify add api`
 
 ```