AmplifyTotpSetup component renders broken image for QR code

[HarrisonJackson]

Describe the bug
The QR Code image for TOTP Setup fails to render if AmplifyTotpSetup is used in AmplifyAuthenticator

To Reproduce
Steps to reproduce the behavior:

1. Create auth flow with <AmplifyAuthenticator >...</AmplifyAuthenticator>
2. Add <AmplifyTotpSetup slot="totp-setup" /> child
3. Register a new user or sign in with one that still needs TOTP Setup
4. View broken qr code...

Expected behavior
QR Code renders correctly with no overrides, with issuer override, with header text override, etc

Code Snippet

import React from "react";
import "./App.css";
import Amplify from "aws-amplify";
import {
  AmplifyAuthenticator,
  AmplifySignOut,
  AmplifyTotpSetup,
} from "@aws-amplify/ui-react";
import { AuthState, onAuthUIStateChange } from "@aws-amplify/ui-components";
import awsconfig from "./aws-exports";

Amplify.configure(awsconfig);

const AuthStateApp: React.FunctionComponent = () => {
  const [authState, setAuthState] = React.useState<AuthState>();
  const [user, setUser] = React.useState<object | undefined>();

  React.useEffect(() => {
    return onAuthUIStateChange((nextAuthState, authData) => {
      setAuthState(nextAuthState);
      setUser(authData);
    });
  }, []);

  return authState === AuthState.SignedIn && user ? (
    <div className="App">
      <div>Hello, {(user as any).username}</div>
      <AmplifySignOut />
    </div>
  ) : (
    <AmplifyAuthenticator >
      <AmplifyTotpSetup headerText="My Custom TOTP Setup Text" slot="totp-setup" />
    </AmplifyAuthenticator>
  );
};

export default AuthStateApp;

Screenshots

Working if you don't use the AmplifyTotpSetup component:

Broken with no overrides <AmplifyTotpSetup slot="totp-setup" />

Broken with overrides <AmplifyTotpSetup headerText="My Custom TOTP Setup Text" slot="totp-setup" />

[harrysolovay]

Can you please try passing in the current authenticated CognitoUser via the user prop in the AmplifyTotpSetup component? Aka.

Wherever you return the UI:

return (
  <AmplifyAuthenticator >
-   <AmplifyTotpSetup headerText="My Custom TOTP Setup Text" slot="totp-setup" />
+   <AmplifyTotpSetup headerText="My Custom TOTP Setup Text" slot="totp-setup" {...{user}} />
  </AmplifyAuthenticator>
)
``

[HarrisonJackson]

It still renders a broken image instead of the QR code.

If I remove the <AmplifyTotpSetup ... /> it fast refreshes and the qr code works. I've tried a number of props to try and get the <AmplifyTotpSetup /> slot component to work without luck.

[chrispruitt]

I am seeing this same issue using vue.js. I was unable to get it to work with the above recommendation.

[chrispruitt]

@HarrisonJackson this may be helpful to you. After digging in a bit I found that amplify-js uses stencil.js to compile a single code base to general components that can be used by vue, angular, react. The issue I found was that I was unable to pass in any object (i.e. CognitoUser) to the amplify-totp-setup component as an attribute. If I passed it in as a property it worked!

vue.js offers .prop which will bind as a DOM property instead of an attr. Maybe react is doing the same thing? Found an interesting issue that might be useful for react folks -> facebook/react#7249

This does not work:

<amplify-totp-setup>
    issuer="My Issuer"
    :user="user"
</amplify-totp-setup>

This works:

<amplify-totp-setup>
    issuer="My Issuer"
    :user.prop="user"
</amplify-totp-setup>

[bwindsor]

In case it is useful to anybody, here is what I did as a temporary workaround for a custom issuer in TOTP setup until #7522 is merged:

const MyAuthenticatorWithCustomTotpIssuer: React.FC = () => {
    <AmplifyAuthenticator>
        <CustomTotpSetup />
    </AmplifyAuthenticator>
}

const CustomTotpSetup: React.FC = () => {
    // This component is a bit of a hack because slots are currently not working properly in the Amplify UI,
    // until this gets merged: https://github.com/aws-amplify/amplify-js/pull/7522
    // Because the TOTP component makes a request to AssociateSoftwareToken on mount, the default component makes
    // this request and is then immediately replaced by this component. This leads to two requests. So we delay this
    // second request by one second so that it doesn't clash with the first one and always happens afterwards, which
    // should lead to the correct QR code being displayed.
    const [user, setUser] = React.useState<CognitoUserInterface | undefined>();
    const [displayComponent, setDisplayComponent] = React.useState<boolean>(false);

    React.useEffect(() => {
        return onAuthUIStateChange((nextAuthState, authData) => {
            if (authData && nextAuthState === AuthState.TOTPSetup) {
                setUser(authData as CognitoUserInterface);
            } else {
                setUser(undefined);
            }
        });
    }, []);

    React.useEffect(() => {
        if (user) {
            const timeout = setTimeout(() => setDisplayComponent(true), 1000);
            return () => clearTimeout(timeout);
        } else {
            setDisplayComponent(false);
        }
    }, [user])

    return (
        <span slot="totp-setup">
            {displayComponent ? (
                <AmplifyTotpSetup issuer={'My Custom Issuer'} user={user} />
            ) : <div>Loading...</div>}
        </span>
    );
}

[wlee221]

Hi, #7522 should fix this issue. This is now on the unstable npm tag and will be included in the release cycle. Please let us know if this resolves the issue!

[bwindsor]

I just tested with

    "@aws-amplify/auth": "^3.4.18-unstable.6",
    "@aws-amplify/ui-react": "^0.2.35-unstable.6",

I can confirm that it mostly fixed my issue when customising TOTP setup using AmplifyTotpSetup.

You still need to provide the user prop manually when using a custom TOTP setup component. I am unsure if this is expected behaviour or another issue, as below.

This does not work, and the TOTP setup page does not display a QR code at all. It's because the user prop is not provided to AmplifyTotpSetup.

const MyAuthenticator: React.FC = () => {
    return (
        <AmplifyAuthenticator>
            <AmplifyTotpSetup slot={"totp-setup"} issuer={'My Custom Issuer'} />
        </AmplifyAuthenticator>
    );
}

This does work:

const MyAuthenticator: React.FC = () => {
    const [user, setUser] = React.useState<CognitoUserInterface | undefined>();

    React.useEffect(() => {
        return onAuthUIStateChange((nextAuthState, authData) => {
            setUser(authData as (CognitoUserInterface | undefined));
        });
    }, []);

    return (
        <AmplifyAuthenticator>
            <AmplifyTotpSetup slot={"totp-setup"} issuer={'My Custom Issuer'} user={user}/>
        </AmplifyAuthenticator>
    );
}

[wlee221]

Yes, that is the expected behavior -- I should have clarified. You need to pass the user object manually because the custom component is outside amplify-authenticator and hence doesn't have access to user internal to the authenticator. I'll update the docs to clarify this.

[wlee221]

That being said, I see that having to pass user manually is cumbersome. I'll bring this up to the team and discuss if we can reduce this complexity.

[bwindsor]

Thanks, with that as expected behaviour then AmplifyTotpSetup is fixed as far as I can tell! It may be good to show how to get the user obejct as an example in the docs.

One option to reduce the complexity for developers would be if amplify just exported something like a useAuthData hook, then it would only be one line for developers to grab the current user object:

export const useAuthData = () => {
    const [authData, setAuthData] = React.useState<CognitoUserInterface | undefined>();

    React.useEffect(() => {
        return onAuthUIStateChange((nextAuthState, data) => {
            setAuthData(data as (CognitoUserInterface | undefined));
        });
    }, []);

    return authData;
}

This actually contains a bug which I've opened a separate issue for #7613, where setAuthData could get called after the component is unmounted. But a workaround would be to use something like this useStateSafe instead of useState.

[jssuttles]

That being said, I see that having to pass user manually is cumbersome. I'll bring this up to the team and discuss if we can reduce this complexity.

When using Vue and the following format, it attempts to associateSoftwareToken on creation which means that an error toast is displayed as soon as the component is loaded onto the screen. I can manually specify the user, but it's too late because it's already run the setup code without the user.

<amplify-authenticator>
  <amplify-sign-in
    slot="sign-in"
    hide-sign-up
    username-alias="email"
  />
  <amplify-totp-setup
    slot="totp-setup"
    header-text="Setup Multi-Factor Authentication App"
    issuer="AnIssuer"
    :user.prop="user"
  />
</amplify-authenticator>

[bwindsor]

I was having the same issue before #7522 was merged. However there is no stable npm release for it yet. If you're using @aws-amplify/ui-vue version 0.2.33 or below, you will get this associateSoftwareToken error. I believe it should be fixed from 0.2.34-unstable.6 onwards. (release list)

[dennybiasiolli]

@jssuttles sorry for the late reply, I just got here searching for a solution.
As a temporary solution I added a v-if="user" in this way this:

<amplify-totp-setup
    v-if="user"
    slot="totp-setup"
    header-text="Setup Multi-Factor Authentication App"
    issuer="AnIssuer"
    :user.prop="user"
  />

Tricky thing to do, I think they need to fix that, or al least improve the documentation because the user prop is not marked as required, nor the v-if thing.

[github-actions]

This issue has been automatically locked since there hasn't been any recent activity after it was closed. Please open a new issue for related bugs.

Looking for a help forum? We recommend joining the Amplify Community Discord server *-help channels or Discussions for those types of questions.