feat: Add default reset implementation for Plugins (#3080)

Adds default reset implementation for Plugins. Changes all Resettable conformances to async functions. Removes redundant no-op reset method from AWSCognitoAuthPlugin.

Amplify/Core/Plugin/Internal/Plugin+Resettable.swift

@@ -0,0 +1,42 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+public extension Resettable where Self: Plugin {
+ /// A default conformance if the plugin has no reset logic
+ ///
+ /// **Warning**
+ ///
+ /// This conformance will take precedence over a non-async `reset` method in an async context. Thus, given a plugin like:
+ /// ```swift
+ /// class MyPlugin: Plugin {
+ /// // Not invoked during `await Amplify.reset()`
+ /// func reset() { ... }
+ /// }
+ /// ```
+ ///
+ /// The `MyPlugin.reset()` method will never be called during an invocation of `await Amplify.reset()`. Ensure
+ /// plugin `reset()` methods are always declared `async`:
+ /// ```swift
+ /// class MyPlugin: Plugin {
+ /// // Invoked during `await Amplify.reset()`
+ /// func reset() async { ... }
+ /// }
+ /// ```
+ ///
+ /// As a best practice, always invoke `reset` through the Resettable protocol existential, rather than the concrete conforming
+ /// type, especially in tests:
+ /// ```swift
+ /// func testReset() async {
+ /// let resettable = plugin as Resettable
+ /// await resettable.reset()
+ /// // ... assert that the plugin state has been cleared
+ /// }
+ /// ```
+ func reset() async {
+ // Do nothing
+ }
+}

Amplify/DefaultPlugins/AWSUnifiedLoggingPlugin/AWSUnifiedLoggingPlugin.swift

@@ -50,7 +50,7 @@ final public class AWSUnifiedLoggingPlugin: LoggingCategoryPlugin {
  }
 
  /// Removes listeners and empties the message queue
- public func reset() {
+ public func reset() async {
  concurrencyQueue.sync {
  registeredLogs = [:]
  }

AmplifyPlugins/API/Sources/AWSAPIPlugin/AWSAPIPlugin+Resettable.swift

@@ -22,7 +22,7 @@ extension AWSAPIPlugin: Resettable {
  authService = nil
 
  reachabilityMapLock.execute {
-  reachabilityMap.removeAll()
+ reachabilityMap.removeAll()
  }
 
  subscriptionConnectionFactory = nil

AmplifyPlugins/API/Tests/AWSAPIPluginTests/AWSAPICategoryPlugin+ResetTests.swift

@@ -5,13 +5,15 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import Amplify
 import XCTest
 @testable import AWSAPIPlugin
 
 class AWSAPICategoryPluginResetTests: AWSAPICategoryPluginTestBase {
 
  func testReset() async {
- await apiPlugin.reset()
+ let resettable = apiPlugin as Resettable
+ await resettable.reset()
 
  XCTAssertNotNil(apiPlugin.mapper)
  XCTAssertEqual(apiPlugin.mapper.operations.count, 0)

AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/AWSPinpointAnalyticsPlugin+Reset.swift

@@ -11,7 +11,7 @@ import Foundation
 
 extension AWSPinpointAnalyticsPlugin {
  /// Resets the state of the plugin
- public func reset() {
+ public func reset() async {
  if pinpoint != nil {
  pinpoint = nil
  }

AmplifyPlugins/Analytics/Tests/AWSPinpointAnalyticsPluginUnitTests/AWSPinpointAnalyticsPluginResetTests.swift

@@ -5,13 +5,16 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import Amplify
 @_spi(InternalAWSPinpoint) import InternalAWSPinpoint
 @testable import AWSPinpointAnalyticsPlugin
 import XCTest
 
 class AWSPinpointAnalyticsPluginResetTests: AWSPinpointAnalyticsPluginTestBase {
- func testReset() {
- analyticsPlugin.reset()
+ func testReset() async {
+ let resettable = analyticsPlugin as Resettable
+ await resettable.reset()
+
  XCTAssertNil(analyticsPlugin.pinpoint)
  XCTAssertNil(analyticsPlugin.globalProperties)
  XCTAssertNil(analyticsPlugin.isEnabled)

AmplifyPlugins/Analytics/Tests/AWSPinpointAnalyticsPluginUnitTests/AWSPinpointAnalyticsPluginTestBase.swift

@@ -50,6 +50,7 @@ class AWSPinpointAnalyticsPluginTestBase: XCTestCase {
 
  override func tearDown() async throws {
  await Amplify.reset()
- analyticsPlugin.reset()
+ let resettable = analyticsPlugin as Resettable
+ await resettable.reset()
  }
 }

AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/Sync/InitialSync/InitialSyncOrchestrator.swift

@@ -179,7 +179,7 @@ final class AWSInitialSyncOrchestrator: InitialSyncOrchestrator {
 extension AWSInitialSyncOrchestrator: DefaultLogger { }
 
 extension AWSInitialSyncOrchestrator: Resettable {
- func reset() {
+ func reset() async {
  syncOperationQueue.cancelAllOperations()
  syncOperationQueue.waitUntilAllOperationsAreFinished()
  }

AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/Sync/MutationSync/AWSMutationDatabaseAdapter/AWSMutationDatabaseAdapter.swift

@@ -44,7 +44,7 @@ extension AWSMutationDatabaseAdapter: DefaultLogger { }
 
 extension AWSMutationDatabaseAdapter: Resettable {
 
- func reset() {
+ func reset() async {
  log.verbose("Resetting AWSMutationDatabaseAdapter")
  storageAdapter = nil
  nextEventPromise.set(nil)

AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/Sync/MutationSync/MutationEvent/AWSMutationEventPublisher.swift

@@ -94,7 +94,7 @@ extension AWSMutationEventPublisher: MutationEventPublisher {
 extension AWSMutationEventPublisher: DefaultLogger { }
 
 extension AWSMutationEventPublisher: Resettable {
- func reset() {
+ func reset() async {
  eventSource = nil
  }
 }

AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/Sync/MutationSync/OutgoingMutationQueue/OutgoingMutationQueue.swift

@@ -413,7 +413,7 @@ extension OutgoingMutationQueue: Subscriber {
 }
 
 extension OutgoingMutationQueue: Resettable {
- func reset() {
+ func reset() async {
  doStopWithoutNotifyingStateMachine()
  }
 }

AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/Sync/SubscriptionSync/AWSIncomingSubscriptionEventPublisher.swift

@@ -68,13 +68,13 @@ final class AWSIncomingSubscriptionEventPublisher: IncomingSubscriptionEventPubl
 // MARK: Resettable
 extension AWSIncomingSubscriptionEventPublisher: Resettable {
 
- func reset() {
+ func reset() async {
  Amplify.log.verbose("Resetting asyncEvents")
  asyncEvents.reset()
  Amplify.log.verbose("Resetting asyncEvents: finished")
 
  Amplify.log.verbose("Resetting mapper")
- mapper.reset()
+ await mapper.reset()
  Amplify.log.verbose("Resetting mapper: finished")
  }
 

AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/Sync/SubscriptionSync/IncomingAsyncSubscriptionEventToAnyModelMapper.swift

@@ -94,7 +94,7 @@ final class IncomingAsyncSubscriptionEventToAnyModelMapper: Subscriber, AmplifyC
 }
 
 extension IncomingAsyncSubscriptionEventToAnyModelMapper: Resettable {
- func reset() {
+ func reset() async {
  log.verbose("Resetting modelsFromSubscription and subscription")
  modelsFromSubscription.send(completion: .finished)
  subscription?.cancel()

AmplifyPlugins/Geo/Sources/AWSLocationGeoPlugin/AWSLocationGeoPlugin+Reset.swift

@@ -14,7 +14,7 @@ extension AWSLocationGeoPlugin {
  ///
  /// Sets stored objects to nil to allow deallocation, then calls onComplete closure
  /// to signal the reset has completed.
- public func reset() {
+ public func reset() async {
  locationService = nil
  authService = nil
  pluginConfig = nil

AmplifyPlugins/Geo/Tests/AWSLocationGeoPluginTests/AWSLocationGeoPluginConfigureTests.swift

@@ -19,8 +19,9 @@ class AWSLocationGeoPluginConfigureTests: AWSLocationGeoPluginTestBase {
 
  // MARK: - Configuration tests
 
- func testConfigureSuccess() {
- geoPlugin.reset()
+ func testConfigureSuccess() async {
+ let resettable = geoPlugin as Resettable
+ await resettable.reset()
 
  do {
  try geoPlugin.configure(using: GeoPluginTestConfig.geoPluginConfigJSON)

AmplifyPlugins/Geo/Tests/AWSLocationGeoPluginTests/AWSLocationGeoPluginResetTests.swift

@@ -5,12 +5,14 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import Amplify
 @testable import AWSLocationGeoPlugin
 import XCTest
 
 class AWSLocationGeoPluginResetTests: AWSLocationGeoPluginTestBase {
  func testReset() async {
- geoPlugin.reset()
+ let resettable = geoPlugin as Resettable
+ await resettable.reset()
  XCTAssertNil(geoPlugin.locationService)
  XCTAssertNil(geoPlugin.authService)
  XCTAssertNil(geoPlugin.pluginConfig)

AmplifyPlugins/Geo/Tests/AWSLocationGeoPluginTests/AWSLocationGeoPluginTestBase.swift

@@ -52,6 +52,7 @@ class AWSLocationGeoPluginTestBase: XCTestCase {
 
  override func tearDown() async throws {
  await Amplify.reset()
- geoPlugin.reset()
+ let resettable = geoPlugin as Resettable
+ await resettable.reset()
  }
 }

AmplifyPlugins/Notifications/Push/Sources/AWSPinpointPushNotificationsPlugin/AWSPinpointPushNotificationsPlugin+Reset.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 extension AWSPinpointPushNotificationsPlugin {
- public func reset() {
+ public func reset() async {
  if pinpoint != nil {
  pinpoint = nil
  }

AmplifyPlugins/Notifications/Push/Tests/AWSPinpointPushNotificationsPluginUnitTests/AWSPinpointPushNotificationsPluginResetTests.swift

@@ -5,12 +5,15 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import Amplify
 @testable import AWSPinpointPushNotificationsPlugin
 import XCTest
 
 class AWSPinpointPushNotificationsPluginResetTests: AWSPinpointPushNotificationsPluginTestBase {
- func testReset_shouldResetValues() {
- plugin.reset()
+ func testReset_shouldResetValues() async {
+ let resettable = plugin as Resettable
+ await resettable.reset()
+
  XCTAssertNil(plugin.pinpoint)
  XCTAssertTrue(plugin.options.isEmpty)
  }

AmplifyPlugins/Notifications/Push/Tests/AWSPinpointPushNotificationsPluginUnitTests/AWSPinpointPushNotificationsPluginTestBase.swift

@@ -26,6 +26,7 @@ class AWSPinpointPushNotificationsPluginTestBase: XCTestCase {
  }
 
  override func tearDown() async throws {
- plugin.reset()
+ let resettable = plugin as Resettable
+ await resettable.reset()
  }
 }

AmplifyPlugins/Predictions/AWSPredictionsPlugin/AWSPredictionsPlugin+Reset.swift

@@ -11,11 +11,15 @@ import Amplify
 extension AWSPredictionsPlugin {
  public func reset() async {
  if predictionsService != nil {
- predictionsService.reset()
+ let resettable = predictionsService as Resettable
+ await resettable.reset()
  predictionsService = nil
  }
 
  if authService != nil {
+ if let resettable = authService as? Resettable {
+ await resettable.reset()
+ }
  authService = nil
  }
  }

AmplifyPlugins/Predictions/AWSPredictionsPlugin/Service/Predictions/AWSPredictionsService+Resettable.swift

@@ -0,0 +1,20 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Amplify
+
+extension AWSPredictionsService: Resettable {
+ func reset() async {
+ awsTranslate = nil
+ awsRekognition = nil
+ awsTextract = nil
+ awsComprehend = nil
+ awsPolly = nil
+ awsTranscribeStreaming = nil
+ identifier = nil
+ }
+}

AmplifyPlugins/Predictions/AWSPredictionsPlugin/Service/Predictions/AWSPredictionsService.swift

@@ -101,16 +101,6 @@ class AWSPredictionsService {
  self.predictionsConfig = configuration
  }
 
- func reset() {
- awsTranslate = nil
- awsRekognition = nil
- awsTextract = nil
- awsComprehend = nil
- awsPolly = nil
- awsTranscribeStreaming = nil
- identifier = nil
- }
-
  func getEscapeHatch<T>(client: PredictionsAWSService<T>) -> T {
  client.fetch(self)
  }

AmplifyPlugins/Storage/Sources/AWSS3StoragePlugin/AWSS3StoragePlugin+Reset.swift

@@ -17,7 +17,7 @@ extension AWSS3StoragePlugin {
  /// storage service, authentication service, and queue to nil to allow deallocation.
  ///
  /// - Tag: AWSS3StoragePlugin.reset
- public func reset() {
+ public func reset() async {
  if storageService != nil {
  storageService.reset()
  storageService = nil

AmplifyPlugins/Storage/Tests/AWSS3StoragePluginTests/AWSS3StoragePluginResetTests.swift

@@ -5,13 +5,15 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import Amplify
 import XCTest
 @testable import AWSS3StoragePlugin
 
 class AWSS3StoragePluginResetTests: AWSS3StoragePluginTests {
 
- func testReset() {
- storagePlugin.reset()
+ func testReset() async {
+ let resettable = storagePlugin as Resettable
+ await resettable.reset()
 
  XCTAssertNil(storagePlugin.authService)
  XCTAssertNil(storagePlugin.storageService)

AmplifyPlugins/Storage/Tests/AWSS3StoragePluginTests/Service/Storage/AWSS3StorageServiceTestBase.swift

@@ -35,7 +35,7 @@ class AWSS3StorageServiceTestBase: XCTestCase {
 
  }
 
- func testReset() {
+ func testReset() async {
  }
  */
 }

AmplifyTests/CategoryTests/API/APICategoryConfigurationTests.swift

@@ -54,7 +54,7 @@ class APICategoryConfigurationTests: XCTestCase {
 
  try Amplify.configure(amplifyConfig)
  await Amplify.reset()
- await waitForExpectations(timeout: 1.0)
+ await fulfillment(of: [resetWasInvoked], timeout: 1.0)
  }
 
  func testResetRemovesAddedPlugin() async throws {

AmplifyTests/CategoryTests/Analytics/AnalyticsCategoryConfigurationTests.swift

@@ -54,7 +54,7 @@ class AnalyticsCategoryConfigurationTests: XCTestCase {
 
  try Amplify.configure(amplifyConfig)
  await Amplify.reset()
- await waitForExpectations(timeout: 1.0)
+ await fulfillment(of: [resetWasInvoked], timeout: 1.0)
  }
 
  func testResetRemovesAddedPlugin() async throws {

AmplifyTests/CategoryTests/Auth/AuthCategoryConfigurationTests.swift

@@ -79,7 +79,7 @@ class AuthCategoryConfigurationTests: XCTestCase {
 
  try Amplify.configure(amplifyConfig)
  await Amplify.reset()
- await waitForExpectations(timeout: 1.0)
+ await fulfillment(of: [resetWasInvoked], timeout: 1.0)
  }
 
  /// Test whether calling reset removes the plugin added