[SDK-3238] silent signin option (#2170)

packages/passport/sdk/src/Passport.test.ts

@@ -52,6 +52,7 @@ describe('Passport', () => {
   let getProviderSilentMock: jest.Mock;
   let getLinkedAddressesMock: jest.Mock;
   let linkExternalWalletMock: jest.Mock;
+  let forceUserRefreshMock: jest.Mock;
 
   beforeEach(() => {
     authLoginMock = jest.fn().mockReturnValue(mockUser);
@@ -67,6 +68,7 @@ describe('Passport', () => {
     getProviderSilentMock = jest.fn();
     getLinkedAddressesMock = jest.fn();
     linkExternalWalletMock = jest.fn();
+    forceUserRefreshMock = jest.fn();
     (AuthManager as unknown as jest.Mock).mockReturnValue({
       login: authLoginMock,
       loginCallback: loginCallbackMock,
@@ -75,6 +77,7 @@ describe('Passport', () => {
       getDeviceFlowEndSessionEndpoint: getDeviceFlowEndSessionEndpointMock,
       getUser: getUserMock,
       requestRefreshTokenAfterRegistration: requestRefreshTokenMock,
+      forceUserRefresh: forceUserRefreshMock,
     });
     (MagicAdapter as jest.Mock).mockReturnValue({
       login: magicLoginMock,
@@ -493,7 +496,7 @@ describe('Passport', () => {
       expect(user).toEqual(mockUser.profile);
     });
 
-    it('should login if login sliently returns error', async () => {
+    it('should login if login silently returns error', async () => {
       getUserMock.mockRejectedValue(new Error('Unknown or invalid refresh token.'));
       authLoginMock.mockReturnValue(mockUserImx);
       const user = await passport.login();
@@ -547,6 +550,15 @@ describe('Passport', () => {
         );
       }
     });
+
+    it('should try to login silently if silent is true', async () => {
+      getUserMock.mockReturnValue(null);
+
+      await passport.login({ useSilentLogin: true });
+
+      expect(forceUserRefreshMock).toBeCalledTimes(1);
+      expect(authLoginMock).toBeCalledTimes(0);
+    });
   });
 
   describe('linkExternalWallet', () => {

packages/passport/sdk/src/Passport.ts

@@ -176,14 +176,16 @@ export class Passport {
    * @param options.useCachedSession = false - If true, and no active session exists, then the user will not be
    * prompted to log in and the Promise will resolve with a null value.
    * @param options.anonymousId - If provided, Passport internal metrics will be enriched with this value.
+   * @param options.useSilentLogin - If true, and no active session exists, then the user will not be prompted to log in. Instead, we will attempt to authenticate the user silently. This approach will fail if the user does not have an active session with the authentication server, or if user input is required (for example, consent is required).
    * @returns {Promise<UserProfile | null>} the user profile if the user is logged in, otherwise null
    */
   public async login(options?: {
-    useCachedSession: boolean;
+    useCachedSession?: boolean;
     anonymousId?: string;
+    useSilentLogin?: boolean;
   }): Promise<UserProfile | null> {
     return withMetricsAsync(async () => {
-      const { useCachedSession = false } = options || {};
+      const { useCachedSession = false, useSilentLogin } = options || {};
       let user: User | null = null;
 
       try {
@@ -197,7 +199,10 @@ export class Passport {
         }
         logger.warn('Failed to retrieve a cached user session', error);
       }
-      if (!user && !useCachedSession) {
+
+      if (!user && useSilentLogin) {
+        user = await this.authManager.forceUserRefresh();
+      } else if (!user && !useCachedSession) {
         user = await this.authManager.login(options?.anonymousId);
       }
 

packages/passport/sdk/src/authManager.test.ts

@@ -83,7 +83,7 @@ describe('AuthManager', () => {
 
   let authManager: AuthManager;
   let mockSigninPopup: jest.Mock;
-  let mockSigninPopupCallback: jest.Mock;
+  let mockSigninCallback: jest.Mock;
   let mockSignoutRedirect: jest.Mock;
   let mockGetUser: jest.Mock;
   let mockSigninSilent: jest.Mock;
@@ -94,7 +94,7 @@ describe('AuthManager', () => {
 
   beforeEach(() => {
     mockSigninPopup = jest.fn();
-    mockSigninPopupCallback = jest.fn();
+    mockSigninCallback = jest.fn();
     mockSignoutRedirect = jest.fn();
     mockGetUser = jest.fn();
     mockSigninSilent = jest.fn();
@@ -104,7 +104,7 @@ describe('AuthManager', () => {
     mockOverlayRemove = jest.fn();
     (UserManager as jest.Mock).mockReturnValue({
       signinPopup: mockSigninPopup,
-      signinPopupCallback: mockSigninPopupCallback,
+      signinCallback: mockSigninCallback,
       signoutRedirect: mockSignoutRedirect,
       signoutSilent: mockSignoutSilent,
       getUser: mockGetUser,
@@ -365,7 +365,7 @@ describe('AuthManager', () => {
     it('should call login callback', async () => {
       await authManager.loginCallback();
 
-      expect(mockSigninPopupCallback).toBeCalled();
+      expect(mockSigninCallback).toBeCalled();
     });
   });
 

packages/passport/sdk/src/authManager.ts

@@ -264,7 +264,7 @@ export default class AuthManager {
 
   public async loginCallback(): Promise<void> {
     return withPassportError<void>(
-      async () => this.userManager.signinPopupCallback(),
+      async () => { await this.userManager.signinCallback(); },
       PassportErrorType.AUTHENTICATION_ERROR,
     );
   }