refactor(auth)!: Plugin options #2691

dnys1 · 2023-02-22T23:53:41Z

Migrates all Auth APIs to new plugin options

Migrates `Amplify.Auth.signIn` to use new plugin options.

Migrates `Amplify.Auth.signUp` to use new plugin options.

Migrates `Amplify.Auth.confirmSignUp` to use new plugin options.

Migrates `Amplify.Auth.resendSignUpCode` to use new plugin options.

Migrates `Amplify.Auth.confirmSignIn` to use new plugin options.

Migrates `Amplify.Auth.signInWithWebUI` to use new plugin options.

Migrates `Amplify.Auth.signOut` to use new plugin options.

Migrates `Amplify.Auth.fetchUserAttributes` to use new plugin options.

Migrates `Amplify.Auth.updateUserAttribute` to use new plugin options.

Migrates `Amplify.Auth.updateUserAttributes` to use new plugin options.

Migrates `Amplify.Auth.confirmUserAttribute` to use new plugin options.

Migrates `Amplify.Auth.resendUserAttributeConfirmationCode` to use new plugin options.

Migrates `Amplify.Auth.updatePassword` to use new plugin options.

Migrates `Amplify.Auth.resetPassword` to use new plugin options.

Migrates `Amplify.Auth.confirmResetPassword` to use new plugin options.

Migrates `Amplify.Auth.getCurrentUser` to use new plugin options.

Migrates `Amplify.Auth.fetchAuthSession` to use new plugin options.

packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart

HuiSF · 2023-03-15T23:26:31Z

packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart

@@ -98,39 +81,40 @@ class AmplifyAuthCognitoDart extends AuthPluginInterface<
      CognitoUserAttributeKey,
      AuthUserAttribute<CognitoUserAttributeKey>,
      CognitoDevice,
-      CognitoSignUpOptions,


So when are not going to strongly type pluginOptions when using Auth.getPlugin(AuthPluginKey)?

NikaHsn · 2023-03-15T22:37:10Z

packages/amplify_core/lib/src/types/auth/attribute/confirm_user_attribute_options.dart

 abstract class ConfirmUserAttributeOptions
-    with AWSSerializable<Map<String, Object?>> {
+    with
+        AWSEquatable<ConfirmUserAttributeOptions>,
+        AWSSerializable<Map<String, Object?>>,
+        AWSDebuggable {
  /// {@macro amplify_core.types.auth.confirm_user_attribute_options}
-  const ConfirmUserAttributeOptions();
+  const factory ConfirmUserAttributeOptions({
+    ConfirmUserAttributePluginOptions? pluginOptions,
+  }) = _ConfirmUserAttributeOptions;
+
+  /// Base constructor for subclassing.
+  const ConfirmUserAttributeOptions.base();
+
+  /// {@macro amplify_core.auth.confirm_user_attribute_plugin_options}
+  ConfirmUserAttributePluginOptions? get pluginOptions;
+
+  @override
+  List<Object?> get props => [pluginOptions];
+
+  @Deprecated('Use toJson instead')
+  Map<String, Object?> serializeAsMap() => toJson();
+
+  @override
+  Map<String, Object?> toJson() => {
+        'pluginOptions': pluginOptions?.toJson(),
+      };
+}
+
+class _ConfirmUserAttributeOptions extends ConfirmUserAttributeOptions {
+  const _ConfirmUserAttributeOptions({
+    this.pluginOptions,
+  }) : super.base();
+
+  @override
+  final ConfirmUserAttributePluginOptions? pluginOptions;
+
+  @override
+  String get runtimeTypeName => 'ConfirmUserAttributeOptions';
+}
+
+/// {@template amplify_core.auth.confirm_user_attribute_plugin_options}
+/// Plugin-specific options for `Amplify.Auth.confirmUserAttribute`.
+/// {@endtemplate}
+abstract class ConfirmUserAttributePluginOptions
+    with
+        AWSEquatable<ConfirmUserAttributePluginOptions>,
+        AWSSerializable<Map<String, Object?>>,
+        AWSDebuggable {
+  /// {@macro amplify_core.auth.confirm_user_attribute_plugin_options}
+  const ConfirmUserAttributePluginOptions();
 }


the implementation of Options and PluginOptions seems different than API change review's approved proposal. here we are using abstract classes and typed pluginOptions instead of using generics. am I missing something here ? @HuiSF wdyt?

Make options type non-abstract classes and keep plugin options as abstract classes.

NikaHsn · 2023-03-17T18:37:11Z

...to_dart/lib/src/model/attribute/cognito_resend_user_attribute_confirmation_code_options.dart

+/// Cognito options for `Amplify.Auth.resendUserAttributeConfirmationCode`.
+/// {@endtemplate}
+@zAmplifySerializable
+class CognitoResendUserAttributeConfirmationCodePluginOptions


how about to move PluginOptions classes to their own file so that they follow the class -> file naming convention. I mean instead of having CognitoResendUserAttributeConfirmationCodePluginOptions defined in cognito_resend_user_attribute_confirmation_code_options.dart it will be defined in cognito_resend_user_attribute_confirmation_code_plugin_options.dart

Hm do you think we should do the same for the category plugin options as well?

I don't think so bc they are abstract classes and used only by category level options and so it is okay to have them inside the options file.

### Breaking Changes - chore(datastore)!: Reorganize + import cleanup ([#2760](#2760)) - feat(secure_storage)!: Use Local App Data Directory on Windows ([#2744](#2744)) - refactor(auth)!: Plugin options ([#2691](#2691)) ### Fixes - fix(analytics): event retry logic & max fail tries ([#2713](#2713)) - fix(android): Bump Amplify Android to 2.4.1 - fix(auth): Always pass client metadata - fix(authenticator): Hub event processing - fix(authenticator): Verify attribute state - fix(aws_common): Explicitly serialize values - fix(core): Refine `toJson` outputs when `createFactory = false` - fix(datastore): support use of java8 features in the example App - fix(db_common): Windows build - fix(ios): Bump Amplify iOS to 1.29.1 - fix(secure_storage): Only init Windows config on Windows ([#2751](#2751)) - fix(smithy): Handle uncaught exception ([#2720](#2720)) ### Features - feat(authenticator): Add AutoFill Capabilities ([#2306](#2306)) Updated-Components: aws_common, smithy, Amplify Flutter, Amplify Dart, Amplify UI, DB Common, Secure Storage

Clean up from #2691. Moves plugin options to their own files.

dnys1 force-pushed the feat/auth/plugin-options branch from 93cd9b5 to 4db86d7 Compare March 6, 2023 15:44

Dillon Nys added 6 commits March 13, 2023 14:03

refactor(auth)!: signIn plugin options

437c7d6

Migrates `Amplify.Auth.signIn` to use new plugin options.

refactor(auth)!: signUp plugin options

29d427d

Migrates `Amplify.Auth.signUp` to use new plugin options.

refactor(auth)!: confirmSignUp plugin options

fc06bbf

Migrates `Amplify.Auth.confirmSignUp` to use new plugin options.

refactor(auth)!: resendSignUpCode plugin options

c17fcf2

Migrates `Amplify.Auth.resendSignUpCode` to use new plugin options.

refactor(auth)!: confirmSignIn plugin options

0f8db2e

Migrates `Amplify.Auth.confirmSignIn` to use new plugin options.

refactor(auth)!: signInWithWebUI plugin options

5295a09

Migrates `Amplify.Auth.signInWithWebUI` to use new plugin options.

dnys1 force-pushed the feat/auth/plugin-options branch from 4db86d7 to 7faffd7 Compare March 13, 2023 21:16

dnys1 changed the title ~~chore(auth): PoC of plugin options~~ refactor(auth)!: Plugin options Mar 13, 2023

Dillon Nys added 11 commits March 13, 2023 14:28

refactor(auth)!: signOut plugin options

b43f163

Migrates `Amplify.Auth.signOut` to use new plugin options.

refactor(auth)!: fetchUserAttributes plugin options

16f6647

Migrates `Amplify.Auth.fetchUserAttributes` to use new plugin options.

refactor(auth)!: updateUserAttribute plugin options

bb25781

Migrates `Amplify.Auth.updateUserAttribute` to use new plugin options.

refactor(auth)!: updateUserAttributes plugin options

ba76391

Migrates `Amplify.Auth.updateUserAttributes` to use new plugin options.

refactor(auth)!: confirmUserAttribute plugin options

23eed85

Migrates `Amplify.Auth.confirmUserAttribute` to use new plugin options.

refactor(auth)!: resendUserAttributeConfirmationCode plugin options

9427c2b

Migrates `Amplify.Auth.resendUserAttributeConfirmationCode` to use new plugin options.

refactor(auth)!: updatePassword plugin options

2f3b6ef

Migrates `Amplify.Auth.updatePassword` to use new plugin options.

refactor(auth)!: resetPassword plugin options

809aa1c

Migrates `Amplify.Auth.resetPassword` to use new plugin options.

refactor(auth)!: confirmResetPassword plugin options

5370439

Migrates `Amplify.Auth.confirmResetPassword` to use new plugin options.

refactor(auth)!: getCurrentUser plugin options

7f6178a

Migrates `Amplify.Auth.getCurrentUser` to use new plugin options.

refactor(auth)!: fetchAuthSession plugin options

ae0961a

Migrates `Amplify.Auth.fetchAuthSession` to use new plugin options.

dnys1 force-pushed the feat/auth/plugin-options branch from 7faffd7 to ae0961a Compare March 13, 2023 21:28

dnys1 marked this pull request as ready for review March 13, 2023 21:29

dnys1 requested a review from a team as a code owner March 13, 2023 21:29

chore(auth)!: Deprecate existing plugin options

1e72e6d

Jordan-Nelson approved these changes Mar 15, 2023

View reviewed changes

packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart Outdated Show resolved Hide resolved

packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart Outdated Show resolved Hide resolved

HuiSF reviewed Mar 15, 2023

View reviewed changes

NikaHsn reviewed Mar 15, 2023

View reviewed changes

chore(auth): Clean up validatePluginOptions

2fa3569

dnys1 force-pushed the feat/auth/plugin-options branch from 674ac1e to 2fa3569 Compare March 16, 2023 00:37

chore(auth): Make options types instantiable

e007693

Make options type non-abstract classes and keep plugin options as abstract classes.

NikaHsn reviewed Mar 17, 2023

View reviewed changes

NikaHsn approved these changes Mar 17, 2023

View reviewed changes

dnys1 merged commit b164ba6 into next Mar 17, 2023
68 of 71 checks passed

dnys1 deleted the feat/auth/plugin-options branch March 17, 2023 21:19

dnys1 pushed a commit that referenced this pull request Mar 24, 2023

chore(auth): Move plugin options to separate files

f35addb

Clean up from #2691. Moves plugin options to their own files.

dnys1 mentioned this pull request Mar 24, 2023

chore: Clean up plugin options #2776

Merged

dnys1 pushed a commit that referenced this pull request Mar 24, 2023

chore(auth): Move plugin options to separate files

3fd51c1

Clean up from #2691. Moves plugin options to their own files.

dnys1 pushed a commit that referenced this pull request Mar 24, 2023

chore(auth): Move plugin options to separate files

1290909

Clean up from #2691. Moves plugin options to their own files.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(auth)!: Plugin options #2691

refactor(auth)!: Plugin options #2691

dnys1 commented Feb 22, 2023 •

edited

HuiSF Mar 15, 2023

dnys1 Mar 15, 2023

NikaHsn Mar 15, 2023

NikaHsn Mar 17, 2023

dnys1 Mar 17, 2023

NikaHsn Mar 17, 2023

refactor(auth)!: Plugin options #2691

refactor(auth)!: Plugin options #2691

Conversation

dnys1 commented Feb 22, 2023 • edited

HuiSF Mar 15, 2023

Choose a reason for hiding this comment

dnys1 Mar 15, 2023

Choose a reason for hiding this comment

NikaHsn Mar 15, 2023

Choose a reason for hiding this comment

NikaHsn Mar 17, 2023

Choose a reason for hiding this comment

dnys1 Mar 17, 2023

Choose a reason for hiding this comment

NikaHsn Mar 17, 2023

Choose a reason for hiding this comment

dnys1 commented Feb 22, 2023 •

edited