chore: kickoff release

Author: sebaland

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -92,7 +92,15 @@ body:
       label: Relevant log output
       description: >-
         Include any relevant log output under
-        `~/.amplify/logs/amplify-cli-<issue-date>.log`
+        `~/.amplify/logs/amplify-cli-<issue-date>.log` (See: [Logs Guidance](https://github.com/aws-amplify/amplify-ios/blob/main/LogsGuidance.md))
+      value: |
+        <details>
+        <summary>Log Messages</summary>
+
+        ```
+        INSERT LOG MESSAGES HERE
+        ```
+        </details>
       render: shell
   - type: dropdown
     id: regression

AmplifyPlugins/Analytics/AWSPinpointAnalyticsPluginIntegrationTests/AWSPinpointAnalyticsPluginIntegrationTests.swift

@@ -70,6 +70,40 @@ class AWSPinpointAnalyticsPluginIntergrationTests: XCTestCase {
         Amplify.Analytics.identifyUser(userId, withProfile: userProfile)
 
         wait(for: [identifyUserEvent], timeout: TestCommonConstants.networkTimeout)
+
+        // Remove userId from the current endpoint
+        let targetingClient = escapeHatch().targetingClient
+        let currentProfile = targetingClient.currentEndpointProfile()
+        currentProfile.user?.userId = ""
+        targetingClient.update(currentProfile)
+    }
+
+    /// Run this test when the number of endpoints for the userId exceeds the limit.
+    /// The profile should have permissions to run the "mobiletargeting:DeleteUserEndpoints" action.
+    func skip_testDeleteEndpointsForUser() throws {
+        let userId = "userId"
+        let escapeHatch = escapeHatch()
+        let applicationId = escapeHatch.configuration.appId
+        guard let targetingConfiguration = escapeHatch.configuration.targetingServiceConfiguration else {
+            XCTFail("Targeting configuration is not defined.")
+            return
+        }
+
+        let deleteEndpointsRequest = AWSPinpointTargetingDeleteUserEndpointsRequest()!
+        deleteEndpointsRequest.userId = userId
+        deleteEndpointsRequest.applicationId = applicationId
+
+        let deleteExpectation = expectation(description: "Delete endpoints")
+        let lowLevelClient = lowLevelClient(from: targetingConfiguration)
+        lowLevelClient.deleteUserEndpoints(deleteEndpointsRequest) { response, error in
+            guard error == nil else {
+                XCTFail("Unexpected error when attempting to delete endpoints")
+                deleteExpectation.fulfill()
+                return
+            }
+            deleteExpectation.fulfill()
+        }
+        wait(for: [deleteExpectation], timeout: 1)
     }
 
     func testRecordEventsAreFlushed() {
@@ -79,6 +113,7 @@ class AWSPinpointAnalyticsPluginIntergrationTests: XCTestCase {
                 // TODO: Remove exposing AWSPinpointEvent
                 guard let pinpointEvents = payload.data as? [AWSPinpointEvent] else {
                     XCTFail("Missing data")
+                    flushEventsInvoked.fulfill()
                     return
                 }
                 XCTAssertNotNil(pinpointEvents)
@@ -117,4 +152,17 @@ class AWSPinpointAnalyticsPluginIntergrationTests: XCTestCase {
         XCTAssertNotNil(awsPinpoint.configuration)
         XCTAssertTrue(awsPinpoint.configuration.enableAutoSessionRecording)
     }
+
+    private func escapeHatch() -> AWSPinpoint {
+        guard let plugin = try? Amplify.Analytics.getPlugin(for: "awsPinpointAnalyticsPlugin"),
+              let analyticsPlugin = plugin as? AWSPinpointAnalyticsPlugin else {
+            fatalError("Unable to retrieve configuration")
+        }
+        return analyticsPlugin.getEscapeHatch()
+    }
+
+    private func lowLevelClient(from configuration: AWSServiceConfiguration) -> AWSPinpointTargeting {
+        AWSPinpointTargeting.register(with: configuration, forKey: "integrationTestsTargetingConfiguration")
+        return AWSPinpointTargeting.init(forKey: "integrationTestsTargetingConfiguration")
+    }
 }

AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Dependency/AuthDeviceServiceAdapter.swift

@@ -6,6 +6,11 @@
 //
 
 import Amplify
+#if COCOAPODS
+import AWSMobileClient
+#else
+import AWSMobileClientXCF
+#endif
 
 struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
 
@@ -19,8 +24,7 @@ struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
                       completionHandler: @escaping (Result<[AuthDevice], AuthError>) -> Void) {
 
         awsMobileClient.listDevices { result, error in
-            if let error = error {
-                let authError = AuthErrorHelper.toAuthError(error)
+            if let authError = mapToAuthError(error) {
                 completionHandler(.failure(authError))
                 return
             }
@@ -42,8 +46,7 @@ struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
 
         guard let device = request.device else {
             awsMobileClient.forgetCurrentDevice { error in
-                if let error = error {
-                    let authError = AuthErrorHelper.toAuthError(error)
+                if let authError = mapToAuthError(error) {
                     completionHandler(.failure(authError))
                     return
                 }
@@ -52,8 +55,7 @@ struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
             return
         }
         awsMobileClient.forgetDevice(deviceId: device.id) { error in
-            if let error = error {
-                let authError = AuthErrorHelper.toAuthError(error)
+            if let authError = mapToAuthError(error) {
                 completionHandler(.failure(authError))
                 return
             }
@@ -66,12 +68,29 @@ struct AuthDeviceServiceAdapter: AuthDeviceServiceBehavior {
     func rememberDevice(request: AuthRememberDeviceRequest,
                         completionHandler: @escaping (Result<Void, AuthError>) -> Void) {
         awsMobileClient.updateDeviceStatus(remembered: true) { _, error in
-            if let error = error {
-                let authError = AuthErrorHelper.toAuthError(error)
+            if let authError = mapToAuthError(error) {
                 completionHandler(.failure(authError))
                 return
             }
             completionHandler(.success(()))
         }
     }
+
+    private func mapToAuthError(_ error: Error?) -> AuthError? {
+        guard let error = error else {
+            return nil
+        }
+
+        // `.notSignedIn` should be handled explicitly and not as part of AuthErrorHelper
+        if let awsMobileClientError = error as? AWSMobileClientError,
+            case .notSignedIn = awsMobileClientError {
+            return AuthError.signedOut(
+                AuthPluginErrorConstants.userSignedOutError.errorDescription,
+                AuthPluginErrorConstants.userSignedOutError.recoverySuggestion,
+                error
+            )
+        } else {
+            return AuthErrorHelper.toAuthError(error)
+        }
+    }
 }

AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Support/Constants/AuthPluginErrorConstants.swift

@@ -143,6 +143,10 @@ struct AuthPluginErrorConstants {
     static let changePasswordUnableToSignInError: AuthPluginErrorString = (
     "Could not change password, the user session is expired",
     "Re-authenticate the user by using one of the signIn apis")
+
+    static let userSignedOutError: AuthPluginErrorString = (
+    "There is no user signed in to the Auth category",
+    "SignIn to Auth category by using one of the sign in methods and then try again")
 }
 
 // Field validation errors

AmplifyPlugins/Auth/AWSCognitoAuthPluginIntegrationTests/AuthDeviceTests/AuthDeviceOperationTests.swift

@@ -7,7 +7,13 @@
 
 import XCTest
 @testable import Amplify
+import AmplifyTestCommon
 import AWSCognitoAuthPlugin
+#if COCOAPODS
+import AWSMobileClient
+#else
+import AWSMobileClientXCF
+#endif
 
 class AuthDeviceOperationTests: AWSAuthBaseTest {
 
@@ -22,20 +28,60 @@ class AuthDeviceOperationTests: AWSAuthBaseTest {
         sleep(2)
     }
 
+    /// Test if forgetDevice returns deviceNotTracked error for a signed out user
+    ///
+    /// - Given: A test with the user not signed in
+    /// - When:
+    ///    - I invoke forgetDevice
+    /// - Then:
+    ///    - I should get a notSignedIn error.
+    ///
+    func testForgetDeviceWithSignedOutUser() {
+        let forgetDeviceExpectation = expectation(description: "Received event result from forgetDevice")
+        _ = Amplify.Auth.forgetDevice { result in
+            forgetDeviceExpectation.fulfill()
+            switch result {
+            case .success:
+                XCTFail("Forget device with signed out user should not return success")
+            case .failure(let error):
+                guard let cognitoError = error.underlyingError as? AWSMobileClientError,
+                      case .notSignedIn = cognitoError else {
+                    XCTFail("Should return notSignedIn")
+                    return
+                }
+            }
+        }
+        wait(for: [forgetDeviceExpectation], timeout: networkTimeout)
+    }
+
     /// Test if forgetDevice returns deviceNotTracked error for a unknown device
     ///
-    /// - Given: A test with the device not tracked
+    /// - Given: A test with a device not tracked
     /// - When:
     ///    - I invoke forgetDevice
     /// - Then:
     ///    - I should get a deviceNotTracked error.
     ///
-    func testForgetDeviceWithUnknowdevice() {
+    func testForgetDeviceWithUntrackedDevice() {
+        let username = "integTest\(UUID().uuidString)"
+        let password = "P123@\(UUID().uuidString)"
+        let signInExpectation = expectation(description: "SignIn operation should complete")
+        AuthSignInHelper.registerAndSignInUser(username: username, password: password,
+                                               email: email) { didSucceed, error in
+            signInExpectation.fulfill()
+            XCTAssertTrue(didSucceed, "SignIn operation failed - \(String(describing: error))")
+        }
+        wait(for: [signInExpectation], timeout: networkTimeout)
+
+        let user = Amplify.Auth.getCurrentUser()
+        XCTAssertNotNil(user)
+
         let forgetDeviceExpectation = expectation(description: "Received event result from forgetDevice")
         _ = Amplify.Auth.forgetDevice { result in
+            forgetDeviceExpectation.fulfill()
             switch result {
             case .success:
-                XCTFail("Confirm signUp with non existing user should not return result")
+                XCTFail("Forget device with untracked device should not return result")
             case .failure(let error):
                 guard let cognitoError = error.underlyingError as? AWSCognitoAuthError,
                       case .deviceNotTracked = cognitoError else {
@@ -44,7 +90,6 @@ class AuthDeviceOperationTests: AWSAuthBaseTest {
                 }
 
             }
-            forgetDeviceExpectation.fulfill()
         }
         wait(for: [forgetDeviceExpectation], timeout: networkTimeout)
     }

LogsGuidance.md

@@ -0,0 +1,43 @@
+# Logs Guidance
+
+When providing logs in an issue please follow these recommendations.
+
+1. Use an editor to clear out any sensitive information.
+2. Remove lines which are not relevant to the problem.
+3. Place the logs in the markdown syntax below.
+
+## Screenshots vs Text Logs
+
+Sharing logs as text will make it possible to search for log messages across issues and to trim logs to the relevant details. Collect logs from Xcode Console or the Console app by highlighting lines and copying them to an editor where the text can be prepared for sharing in a new issue.
+
+### Stack Frames
+
+To collect details about the stack frames while debugging, also copy lines from the Xcode Debug Navigator by selecting the stack frames and copying the text to an editor. Showing stack frames shows the backtrace of function calls which is helpful in understanding the context. You can also set a breakpoint which will run a Debugger Command such as `bt 5` which will print 5 of the backtrace from that point where the breakpoint is set. This text will appear in the Xcode Console where it can be copied with other log messages to provide useful context for resolving the issue.
+
+1. Add a breakpoint to where you want to include more context
+2. Edit the breakpoint and select the checkbox at the bottom to automatically continue
+3. Add an Action which will be a Debugger Command
+4. Add `bt 5` to print the last 5 lines of the backtrace to the console
+5. Optionally also add action to log a message which can include an expression
+
+Like the watch window displayed while debugging, a log message from a breakpoint can evalulate an expression to print out those details in the Xcode console. For a variable named `info`, simply add `@info@` to the log message text field. You may want to add debugging features to your code which can provide a string or dictionary which provides useful information which can be used when logging from a breakpoint.
+
+## Sensitive Information
+
+Logs should be trimmed of details which should not be shared publicly, such as user names and credentials. Use an editor to find references using either a keyword search or regular expression and either delete that information or replace it with placeholder text if it helps provide context.
+
+## Collapsible details in markdown
+
+Including a lot of log messages in a GitHub issue is helpful but also requires a lot of scrolling. It can be difficult to also copy that log to an editor to filter to the most useful details. GitHub markdown supports collapsing details with the syntax below. It is just the `<details>` tags which must include a `<summary>` tag at the start.
+
+Beyond just making it possible to collapse the details, n button appears at the top right when it is expanded to let you copy to your clipboard making it easy to bring it to an editor.
+
+````markdown
+<details>
+<summary>Log Messages</summary>
+
+```
+INSERT LOG MESSAGES HERE
+```
+</details>
+````