fix: wait for addPlugin prior to configuration (#3018)

chore: wait for addPlugin prior to configure

Co-authored-by: Jordan Nelson <[email protected]>

Author: Jordan-Nelson

packages/amplify/amplify_flutter/lib/src/hybrid_impl.dart

@@ -14,11 +14,15 @@ class AmplifyHybridImpl extends AmplifyClassImpl {
   /// {@macro amplify_flutter.amplify_hybrid_impl}
   AmplifyHybridImpl() : super.protected();
 
+  final _addPluginFutures = <Future<void>>[];
+
   @override
   Future<void> configurePlatform(String config) async {
     final amplifyConfig = AmplifyConfig.fromJson(
       (jsonDecode(config) as Map<Object?, Object?>).cast(),
     );
+    await Future.wait(_addPluginFutures);
+    _addPluginFutures.clear();
     await Future.wait(
       [
         ...API.plugins,
@@ -38,7 +42,13 @@ class AmplifyHybridImpl extends AmplifyClassImpl {
   }
 
   @override
-  Future<void> addPlugin(AmplifyPluginInterface plugin) async {
+  Future<void> addPlugin(AmplifyPluginInterface plugin) {
+    final future = _addPlugin(plugin);
+    _addPluginFutures.add(future);
+    return future;
+  }
+
+  Future<void> _addPlugin(AmplifyPluginInterface plugin) async {
     if (isConfigured) {
       throw const AmplifyAlreadyConfiguredException(
         'Amplify has already been configured and adding plugins after configure is not supported.',

packages/amplify_core/lib/src/amplify_class_impl.dart

@@ -21,8 +21,16 @@ class AmplifyClassImpl extends AmplifyClass {
   final AmplifyAuthProviderRepository authProviderRepo =
       AmplifyAuthProviderRepository();
 
+  final _addPluginFutures = <Future<void>>[];
+
   @override
   Future<void> addPlugin(AmplifyPluginInterface plugin) {
+    final future = _addPlugin(plugin);
+    _addPluginFutures.add(future);
+    return future;
+  }
+
+  Future<void> _addPlugin(AmplifyPluginInterface plugin) {
     switch (plugin.category) {
       case Category.analytics:
         return Analytics.addPlugin(
@@ -64,6 +72,8 @@ class AmplifyClassImpl extends AmplifyClass {
     final amplifyConfig = AmplifyConfig.fromJson(
       (jsonDecode(config) as Map<Object?, Object?>).cast(),
     );
+    await Future.wait(_addPluginFutures);
+    _addPluginFutures.clear();
     await Future.wait(
       [
         ...Analytics.plugins,
@@ -83,6 +93,7 @@ class AmplifyClassImpl extends AmplifyClass {
 
   @override
   Future<void> reset() async {
+    _addPluginFutures.clear();
     await Future.wait([
       Analytics.reset(),
       API.reset(),

packages/amplify_core/test/amplify_class_test.dart

@@ -1,6 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import 'dart:async';
+
 import 'package:amplify_core/amplify_core.dart';
 import 'package:test/test.dart';
 
@@ -22,6 +24,16 @@ void main() {
         expect(Amplify.configure(dummyConfiguration), completes);
       });
 
+      test('plugin is configured even if addPlugin is not awaited', () async {
+        expect(Amplify.asyncConfig, completes);
+        final plugin = AsyncAddPlugin();
+        unawaited(Amplify.addPlugin(plugin));
+        expect(Amplify.Analytics.plugins.length, 0);
+        await Amplify.configure(dummyConfiguration);
+        expect(Amplify.Analytics.plugins.length, 1);
+        expect(plugin.isConfigured, isTrue);
+      });
+
       test('throws for invalid JSON', () async {
         expect(
           Amplify.asyncConfig,
@@ -86,3 +98,26 @@ class SuccessPlugin extends AnalyticsPluginInterface {
     return;
   }
 }
+
+/// A plugin that has async behavior in addPlugin.
+class AsyncAddPlugin extends AnalyticsPluginInterface {
+  final _configureCompleter = Completer<void>();
+
+  bool get isConfigured => _configureCompleter.isCompleted;
+
+  @override
+  Future<void> configure({
+    AmplifyConfig? config,
+    required AmplifyAuthProviderRepository authProviderRepo,
+  }) async {
+    _configureCompleter.complete();
+  }
+
+  @override
+  Future<void> addPlugin({
+    required AmplifyAuthProviderRepository authProviderRepo,
+  }) async {
+    await super.addPlugin(authProviderRepo: authProviderRepo);
+    await Future<void>.delayed(Duration.zero);
+  }
+}