feat!: use plugin options for optional plugin parameters (#4762)

Author: NikaHsn

canaries/lib/main.dart

@@ -20,8 +20,12 @@ Future<void> main() async {
     AmplifyAuthCognito(),
     AmplifyStorageS3(),
     AmplifyAnalyticsPinpoint(),
-    AmplifyAPI(modelProvider: ModelProvider.instance),
-    AmplifyDataStore(modelProvider: ModelProvider.instance),
+    AmplifyAPI(
+      options: APIPluginOptions(modelProvider: ModelProvider.instance),
+    ),
+    AmplifyDataStore(
+      modelProvider: ModelProvider.instance,
+    ),
   ]);
   await Amplify.configure(amplifyconfig);
   safePrint('Successfully configured Amplify.');

packages/amplify_core/lib/src/config/analytics/pinpoint_config.dart

@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import 'package:amplify_core/amplify_core.dart';
-import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';
 
 part 'pinpoint_config.g.dart';
@@ -36,9 +35,7 @@ class PinpointPluginConfig
   const PinpointPluginConfig({
     required this.pinpointAnalytics,
     required this.pinpointTargeting,
-    int autoFlushEventsInterval = 30,
-  }) : _autoFlushEventsInterval = autoFlushEventsInterval;
-
+  });
   factory PinpointPluginConfig.fromJson(Map<String, Object?> json) =>
       _$PinpointPluginConfigFromJson(json);
 
@@ -48,16 +45,8 @@ class PinpointPluginConfig
   final PinpointAnalytics pinpointAnalytics;
   final PinpointTargeting pinpointTargeting;
 
-  final int _autoFlushEventsInterval;
-
-  /// The duration in seconds between flushing analytics events to Pinpoint.
-  @_DurationConverter()
-  Duration get autoFlushEventsInterval =>
-      Duration(seconds: _autoFlushEventsInterval);
-
   @override
-  List<Object?> get props =>
-      [pinpointAnalytics, pinpointTargeting, autoFlushEventsInterval];
+  List<Object?> get props => [pinpointAnalytics, pinpointTargeting];
 
   PinpointPluginConfig copyWith({
     PinpointAnalytics? pinpointAnalytics,
@@ -67,8 +56,6 @@ class PinpointPluginConfig
     return PinpointPluginConfig(
       pinpointAnalytics: pinpointAnalytics ?? this.pinpointAnalytics,
       pinpointTargeting: pinpointTargeting ?? this.pinpointTargeting,
-      autoFlushEventsInterval:
-          autoFlushEventsInterval ?? _autoFlushEventsInterval,
     );
   }
 
@@ -132,13 +119,3 @@ class PinpointTargeting with AWSEquatable<PinpointTargeting>, AWSSerializable {
   @override
   Map<String, Object?> toJson() => _$PinpointTargetingToJson(this);
 }
-
-class _DurationConverter implements JsonConverter<Duration, int> {
-  const _DurationConverter();
-
-  @override
-  Duration fromJson(int json) => Duration(seconds: json);
-
-  @override
-  int toJson(Duration object) => object.inSeconds;
-}

packages/amplify_core/lib/src/config/analytics/pinpoint_config.g.dart

@@ -39,7 +39,6 @@ const expected = {
             region: REGION,
           ),
           pinpointTargeting: PinpointTargeting(region: REGION),
-          autoFlushEventsInterval: ANALYTICS_FLUSH_INTERVAL,
         ),
       },
     ),

packages/amplify_core/test/config/cli_config_test.dart

@@ -39,8 +39,7 @@ const _v4analytics = '''
         },
         "pinpointTargeting": {
           "region": "$REGION"
-        },
-        "autoFlushEventsInterval": $ANALYTICS_FLUSH_INTERVAL
+        }
       }
     }
   }
@@ -226,8 +225,7 @@ const _v5analytics = '''
         },
         "pinpointTargeting": {
           "region": "$REGION"
-        },
-        "autoFlushEventsInterval": $ANALYTICS_FLUSH_INTERVAL
+        }
       }
     }
   }
@@ -413,8 +411,7 @@ const _v6analytics = '''
         },
         "pinpointTargeting": {
           "region": "$REGION"
-        },
-        "autoFlushEventsInterval": $ANALYTICS_FLUSH_INTERVAL
+        }
       }
     }
   }
@@ -600,8 +597,7 @@ const _v7analytics = '''
         },
         "pinpointTargeting": {
           "region": "$REGION"
-        },
-        "autoFlushEventsInterval": $ANALYTICS_FLUSH_INTERVAL
+        }
       }
     }
   }
@@ -787,8 +783,7 @@ const _vlatestanalytics = '''
         },
         "pinpointTargeting": {
           "region": "$REGION"
-        },
-        "autoFlushEventsInterval": $ANALYTICS_FLUSH_INTERVAL
+        }
       }
     }
   }

packages/amplify_core/test/config/testdata/cli_generated.dart

@@ -14,7 +14,6 @@ const child_process = require('child_process');
 const REGION = '$REGION';
 const API_KEY = '$API_KEY';
 const ANALYTICS_APP_ID = '$ANALYTICS_APP_ID';
-const ANALYTICS_FLUSH_INTERVAL = '$ANALYTICS_FLUSH_INTERVAL';
 const GRAPHQL_ENDPOINT = '$GRAPHQL_ENDPOINT';
 const REST_ENDPOINT = '$REST_ENDPOINT';
 const BUCKET = '$BUCKET';

packages/amplify_core/test/config/testdata/generate/generate.js

@@ -21,7 +21,6 @@ const API_KEY = 'MY_KEY';
 
 /// Analytics values
 const ANALYTICS_APP_ID = 'analytics_app_id';
-const ANALYTICS_FLUSH_INTERVAL = 10;
 
 /// API values
 const GRAPHQL_TYPE = 'GraphQL';

packages/amplify_core/test/config/testdata/test_values.dart

@@ -73,8 +73,10 @@ class _MyAppState extends State<MyApp> {
     try {
       datastorePlugin = AmplifyDataStore(
         modelProvider: ModelProvider.instance,
-        errorHandler: ((error) =>
-            {print("Custom ErrorHandler received: " + error.toString())}),
+        options: DataStorePluginOptions(
+          errorHandler: ((error) =>
+              {print("Custom ErrorHandler received: " + error.toString())}),
+        ),
       );
       await Amplify.addPlugin(datastorePlugin);
 

packages/amplify_datastore/example/lib/main.dart

@@ -6,6 +6,7 @@ import 'dart:convert';
 
 import 'package:amplify_core/amplify_core.dart';
 import 'package:amplify_datastore/src/amplify_datastore_stream_controller.dart';
+import 'package:amplify_datastore/src/datastore_plugin_options.dart';
 import 'package:amplify_datastore/src/method_channel_datastore.dart';
 import 'package:amplify_datastore/src/native_plugin.g.dart';
 import 'package:collection/collection.dart';
@@ -15,36 +16,24 @@ import 'package:meta/meta.dart';
 export 'package:amplify_core/src/types/datastore/datastore_types.dart'
     hide DateTimeParse;
 
+export 'src/datastore_plugin_options.dart';
+
 class AmplifyDataStore extends DataStorePluginInterface
     with AWSDebuggable, AmplifyLoggerMixin {
   /// Constructs an AmplifyDataStore plugin with mandatory [modelProvider]
-  /// and optional datastore configuration properties including
-  ///
-  /// [syncExpressions]: list of sync expressions to filter datastore sync against
-  ///
-  /// [syncInterval]: datastore syncing interval (in seconds)
-  ///
-  /// [syncMaxRecords]: max number of records to sync
-  ///
-  /// [syncPageSize]: page size to sync
+  /// and an optional datastore plugin options [options]
   AmplifyDataStore({
     required ModelProviderInterface modelProvider,
-    Function(AmplifyException)? errorHandler,
-    DataStoreConflictHandler? conflictHandler,
-    List<DataStoreSyncExpression> syncExpressions = const [],
-    int? syncInterval,
-    int? syncMaxRecords,
-    int? syncPageSize,
-    AuthModeStrategy authModeStrategy = AuthModeStrategy.defaultStrategy,
+    DataStorePluginOptions options = const DataStorePluginOptions(),
   }) : super(
           modelProvider: modelProvider,
-          errorHandler: errorHandler,
-          conflictHandler: conflictHandler,
-          syncExpressions: syncExpressions,
-          syncInterval: syncInterval,
-          syncMaxRecords: syncMaxRecords,
-          syncPageSize: syncPageSize,
-          authModeStrategy: authModeStrategy,
+          errorHandler: options.errorHandler,
+          conflictHandler: options.conflictHandler,
+          syncExpressions: options.syncExpressions,
+          syncInterval: options.syncInterval,
+          syncMaxRecords: options.syncMaxRecords,
+          syncPageSize: options.syncPageSize,
+          authModeStrategy: options.authModeStrategy,
         );
 
   /// Internal use constructor

packages/amplify_datastore/lib/amplify_datastore.dart

@@ -0,0 +1,43 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import 'package:amplify_core/amplify_core.dart';
+
+/// {@template amplify_datastore.datastore_plugin_options}
+/// The plugin options for the Amplify DataStore plugin.
+/// {@endtemplate}
+class DataStorePluginOptions {
+  /// {@macro amplify_datastore.datastore_plugin_options}
+  const DataStorePluginOptions({
+    this.errorHandler,
+    this.conflictHandler,
+    this.syncExpressions = const [],
+    this.syncInterval,
+    this.syncMaxRecords,
+    this.syncPageSize,
+    this.authModeStrategy = AuthModeStrategy.defaultStrategy,
+  });
+
+  /// The custom error handler function that receives an [AmplifyException]
+  /// object when DataStore encounters an unhandled error.
+  final Function(AmplifyException)? errorHandler;
+
+  /// The custom conflict handler function that receives an [ConflictData]
+  /// object when DataStore encounters a data conflict.
+  final DataStoreConflictHandler? conflictHandler;
+
+  /// The list of sync expressions to filter datastore sync.
+  final List<DataStoreSyncExpression> syncExpressions;
+
+  /// The syncing interval in seconds.
+  final int? syncInterval;
+
+  /// The max number of records to sync.
+  final int? syncMaxRecords;
+
+  /// The page size to sync.
+  final int? syncPageSize;
+
+  /// The strategy for authorizing an API call.
+  final AuthModeStrategy authModeStrategy;
+}