Amplify.configure() hangs on hot restart when using AmplifyPushNotificationsPinpoint

[sbkomurcu]

Description

I have been following the official documentation to configure both AmplifyAuthCognito and AmplifyPushNotificationsPinpoint for my Flutter app. However, I have encountered an issue where configuring both libraries simultaneously causes the Authenticator to become stuck on the loading screen.

Interestingly, I discovered that when I comment out the line for AmplifyPushNotificationsPinpoint, the app runs without any issues.

Tested only on Android.

I have included the relevant code snippet below for reference:

import 'package:flutter/material.dart';
import 'package:amplify_analytics_pinpoint/amplify_analytics_pinpoint.dart';
import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
import 'package:amplify_authenticator/amplify_authenticator.dart';
import 'package:amplify_flutter/amplify_flutter.dart';
import 'package:amplify_push_notifications_pinpoint/amplify_push_notifications_pinpoint.dart';


import 'amplifyconfiguration.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  AmplifyLogger().logLevel = LogLevel.info;
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    _configureAmplify();
  }

  void _configureAmplify() async {
    try {
      await Amplify.addPlugins([
        AmplifyAnalyticsPinpoint(),
        AmplifyAuthCognito(),

        // *** Commenting out the following line will cause the app to work as expected. ***
        //  AmplifyPushNotificationsPinpoint()
      ]);
      await Amplify.configure(amplifyconfig);
    } on AmplifyAlreadyConfiguredException {
      safePrint(
        'Tried to reconfigure Amplify; this can occur when your app restarts on Android.',
      );
    }
  }

  @override
  Widget build(BuildContext context) {
    return Authenticator(
      child: MaterialApp(
        builder: Authenticator.builder(),
        home: Scaffold(
          body: Center(
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              children: [
                const Text('You are logged in!'),
                ElevatedButton(
                  onPressed: () async {
                    await Amplify.Auth.signOut();
                  },
                  child: const Text('Sign Out'),
                ),
              ],
            ),
          ),
        ),
      ),
    );
  }
}

Categories

• Analytics
• API (REST)
• API (GraphQL)
• Auth
• Authenticator
• DataStore
• Storage

Steps to Reproduce

1. Create a Flutter app and integrate Amplify-Flutter for both authentication and push notifications.
2. Copy the code snippet provided above and paste it into the main.dart file.
3. Run the app, and it should work without any issues.
4. Close the app.
5. Comment out the line of code that configures AmplifyPushNotificationsPinpoint.
6. Run the app again, and it gets stuck showing the loading spinner.

Screenshots

Platforms

• iOS
• Android
• Web
• macOS
• Windows
• Linux

Flutter Version

3.7.12

Amplify Flutter Version

1.0.1

Deployment Method

Amplify CLI

Schema

No response

[Jordan-Nelson]

@sbkomurcu - if the Authenticator is showing a loading indicator indefinitely that indicates that configuration never completed successfully. My guess is there was a configuration error.

I see you are catching AmplifyAlreadyConfiguredException. Can you try changing that to Exception and see if there is any exception thrown? Can you also confirm that the call to amplify.configure() is completing? You can temporarily add a print statement immediately after that line and see if it is being reached.

[sbkomurcu]

@Jordan-Nelson - Before creating this issue, I attempted to confirm that the configuration process had completed successfully. However, it appears to be stuck on the line amplify.configure() and is not producing any error messages. I have attached two images below to provide further context.

With AmplifyPushNotificationsPinpoint:

Without AmplifyPushNotificationsPinpoint:

[Jordan-Nelson]

Okay. It seems like configuration is not completing when the push notification plugin is added. If you change the log level to verbose do you see any additional log output?

Can you share the contents of your amplify config? You can remove any app specific info or API keys.

[Jordan-Nelson]

Does the same issue exist if AmplifyAnalyticsPinpoint() is removed from the list of plugins?

[jamilsaadeh97]

I do have a similar problem whenever I hot restart my application. It get stuck on Amplify.configure() but without any exception being thrown.

I want to note that I am not using the Authenticator.

[sbkomurcu]

@Jordan-Nelson - I can confirm that the same issue persists even when the AmplifyAnalyticsPinpoint() is not used at all.

Here is the amplify config:

const amplifyconfig = ''' {
    "UserAgent": "aws-amplify-cli/2.0",
    "Version": "1.0",
    "analytics": {
        "plugins": {
            "awsPinpointAnalyticsPlugin": {
                "pinpointAnalytics": {
                    "appId": "************",
                    "region": "eu-central-1"
                },
                "pinpointTargeting": {
                    "region": "eu-central-1"
                }
            }
        }
    },
    "notifications": {
        "plugins": {
            "awsPinpointPushNotificationsPlugin": {
                "appId": "************",
                "region": "eu-central-1"
            }
        }
    },
    "api": {
        "plugins": {
            "awsAPIPlugin": {
                "API1": {
                    "endpointType": "GraphQL",
                    "endpoint": "************",
                    "region": "eu-central-1",
                    "authorizationType": "AMAZON_COGNITO_USER_POOLS",
                    "apiKey": "************",
                },
                "API2": {
                    "endpointType": "REST",
                    "endpoint": "************",
                    "region": "eu-central-1",
                    "authorizationType": "AWS_IAM"
                },
                "API3": {
                    "endpointType": "REST",
                    "endpoint":"************",
                    "region": "eu-central-1",
                    "authorizationType": "AWS_IAM"
                }
            }
        }
    },
    "auth": {
        "plugins": {
            "awsCognitoAuthPlugin": {
                "UserAgent": "aws-amplify-cli/0.1.0",
                "Version": "0.1.0",
                "IdentityManager": {
                    "Default": {}
                },
                "AppSync": {
                    "Default": {
                        "ApiUrl": "************",
                        "Region": "eu-central-1",
                        "AuthMode": "AMAZON_COGNITO_USER_POOLS",
                        "ClientDatabasePrefix": "************",
                    },
                    "************_API_KEY": {
                        "ApiUrl": "************",
                        "Region": "eu-central-1",
                        "AuthMode": "API_KEY",
                        "ApiKey": "************",
                        "ClientDatabasePrefix": "************",
                    },
                    "************_AWS_IAM": {
                        "ApiUrl": "************",
                        "Region": "eu-central-1",
                        "AuthMode": "AWS_IAM",
                        "ClientDatabasePrefix": "************",
                    }
                },
                "CredentialsProvider": {
                    "CognitoIdentity": {
                        "Default": {
                            "PoolId": "************",
                            "Region": "eu-central-1"
                        }
                    }
                },
                "CognitoUserPool": {
                    "Default": {
                        "PoolId": "************",
                        "AppClientId": "************",
                        "Region": "eu-central-1"
                    }
                },
                "Auth": {
                    "Default": {
                        "authenticationFlowType": "USER_SRP_AUTH",
                        "socialProviders": [],
                        "usernameAttributes": [
                            "EMAIL"
                        ],
                        "signupAttributes": [
                            "EMAIL"
                        ],
                        "passwordProtectionSettings": {
                            "passwordPolicyMinLength": 8,
                            "passwordPolicyCharacters": [
                                "REQUIRES_LOWERCASE",
                                "REQUIRES_UPPERCASE",
                                "REQUIRES_NUMBERS",
                                "REQUIRES_SYMBOLS"
                            ]
                        },
                        "mfaConfiguration": "OFF",
                        "mfaTypes": [],
                        "verificationMechanisms": [
                            "EMAIL"
                        ]
                    }
                },
                "S3TransferUtility": {
                    "Default": {
                        "Bucket": "************",
                        "Region": "eu-central-1"
                    }
                },
                "PinpointAnalytics": {
                    "Default": {
                        "AppId": "************",
                        "Region": "eu-central-1"
                    }
                },
                "PinpointTargeting": {
                    "Default": {
                        "Region": "eu-central-1"
                    }
                }
            }
        }
    },
    "storage": {
        "plugins": {
            "awsS3StoragePlugin": {
                "bucket": "************",
                "region": "eu-central-1",
                "defaultAccessLevel": "guest"
            }
        }
    }
}''';

And here is the output when the log level is verbose:

[Jordan-Nelson]

@jamilsaadeh97 - Is this specific to AmplifyAnalyticsPinpoint()? If not, can you open a new issue and fill out the info in the issue template?