feat: moved magic client instantiation to the adapter class constructor; added call to magic preload function (#988)

Co-authored-by: Samuel Castleman <[email protected]>

Author: scastleman-immutable

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

@@ -83,6 +83,7 @@ describe('Passport', () => {
       rpcProvider: {
         request: mockMagicRequest,
       },
+      preload: jest.fn(),
     }));
   });
 

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

@@ -26,6 +26,7 @@ describe('MagicWallet', () => {
     magicProviderId: providerId,
   } as PassportConfiguration;
   const idToken = 'e30=.e30=.e30=';
+  const preload = jest.fn();
 
   beforeEach(() => {
     jest.resetAllMocks();
@@ -37,13 +38,20 @@ describe('MagicWallet', () => {
         logout: logoutMock,
       },
       rpcProvider,
+      preload,
     }));
     magicWallet = new MagicAdapter(config);
   });
 
+  describe('preload', () => {
+    it('should have called the magic client preload method', () => {
+      expect(preload).toHaveBeenCalled();
+    });
+  });
+
   describe('login', () => {
     it('should call loginWithOIDC and initialise the provider with the correct arguments', async () => {
-      const magicProvider = await magicWallet.login(idToken, config.network);
+      const magicProvider = await magicWallet.login(idToken);
 
       expect(Magic).toHaveBeenCalledWith(apiKey, {
         network: config.network,
@@ -64,7 +72,7 @@ describe('MagicWallet', () => {
       });
 
       await expect(async () => {
-        await magicWallet.login(idToken, config.network);
+        await magicWallet.login(idToken);
       }).rejects.toThrow(
         new PassportError(
           'oops',
@@ -76,7 +84,7 @@ describe('MagicWallet', () => {
 
   describe('logout', () => {
     it('calls the logout function', async () => {
-      await magicWallet.login(idToken, config.network);
+      await magicWallet.login(idToken);
       await magicWallet.logout();
 
       expect(logoutMock).toHaveBeenCalled();

packages/passport/sdk/src/magicAdapter.ts

@@ -4,26 +4,25 @@ import { OpenIdExtension } from '@magic-ext/oidc';
 import { ethers } from 'ethers';
 import { PassportErrorType, withPassportError } from './errors/passportError';
 import { PassportConfiguration } from './config';
-import { Networks } from './types';
 
 export default class MagicAdapter {
   private readonly config: PassportConfiguration;
 
-  private magicClient?: InstanceWithExtensions<SDKBase, [OpenIdExtension]>;
+  private magicClient: InstanceWithExtensions<SDKBase, [OpenIdExtension]>;
 
   constructor(config: PassportConfiguration) {
     this.config = config;
+    this.magicClient = new Magic(this.config.magicPublishableApiKey, {
+      extensions: [new OpenIdExtension()],
+      network: config.network,
+    });
+    this.magicClient.preload();
   }
 
   async login(
     idToken: string,
-    network: Networks,
   ): Promise<ethers.providers.ExternalProvider> {
     return withPassportError<ethers.providers.ExternalProvider>(async () => {
-      this.magicClient = new Magic(this.config.magicPublishableApiKey, {
-        extensions: [new OpenIdExtension()],
-        network,
-      });
       await this.magicClient.openid.loginWithOIDC({
         jwt: idToken,
         providerId: this.config.magicProviderId,
@@ -34,7 +33,7 @@ export default class MagicAdapter {
   }
 
   async logout() {
-    if (this.magicClient?.user) {
+    if (this.magicClient.user) {
       await this.magicClient.user.logout();
     }
   }

packages/passport/sdk/src/starkEx/passportImxProviderFactory.test.ts

@@ -100,7 +100,7 @@ describe('PassportImxProviderFactory', () => {
           );
 
           expect(authManagerMock.login).toHaveBeenCalledTimes(1);
-          expect(magicAdapterMock.login).toHaveBeenCalledWith(mockUser.idToken, config.network);
+          expect(magicAdapterMock.login).toHaveBeenCalledWith(mockUser.idToken);
           expect(getSignerMock).toHaveBeenCalledTimes(1);
           expect(registerPassportStarkEx).toHaveBeenCalledWith({
             ethSigner: ethSignerMock,
@@ -127,7 +127,7 @@ describe('PassportImxProviderFactory', () => {
 
           expect(result).toBe(passportImxProviderMock);
           expect(authManagerMock.login).toHaveBeenCalledTimes(1);
-          expect(magicAdapterMock.login).toHaveBeenCalledWith(mockUserImx.idToken, config.network);
+          expect(magicAdapterMock.login).toHaveBeenCalledWith(mockUserImx.idToken);
           expect(getSignerMock).toHaveBeenCalledTimes(1);
           expect(registerPassportStarkEx).toHaveBeenCalledWith({
             ethSigner: ethSignerMock,
@@ -160,7 +160,7 @@ describe('PassportImxProviderFactory', () => {
 
         expect(result).toBe(passportImxProviderMock);
         expect(authManagerMock.login).toHaveBeenCalledTimes(1);
-        expect(magicAdapterMock.login).toHaveBeenCalledWith(mockUserImx.idToken, config.network);
+        expect(magicAdapterMock.login).toHaveBeenCalledWith(mockUserImx.idToken);
         expect(getSignerMock).toHaveBeenCalledTimes(1);
         expect(registerPassportStarkEx).not.toHaveBeenCalled();
         expect(authManagerMock.loginSilent).not.toHaveBeenCalled();

packages/passport/sdk/src/starkEx/passportImxProviderFactory.ts

@@ -98,7 +98,7 @@ export class PassportImxProviderFactory {
       );
     }
 
-    const magicRpcProvider = await this.magicAdapter.login(user.idToken, this.config.network);
+    const magicRpcProvider = await this.magicAdapter.login(user.idToken);
     const web3Provider = new Web3Provider(
       magicRpcProvider,
     );

packages/passport/sdk/src/zkEvm/signTypedDataV4.test.ts

@@ -140,9 +140,11 @@ describe('signTypedDataV4', () => {
           user: mockUserZkEvm,
           guardianClient: guardianClient as any,
         })
-      )).rejects.toThrow(
-        new JsonRpcError(RpcErrorCode.INVALID_PARAMS, 'Failed to parse typed data JSON: SyntaxError: Unexpected token * in JSON at position 0'),
-      );
+      )).rejects.toMatchObject({
+        code: RpcErrorCode.INVALID_PARAMS,
+        // Using stringMatching to avoid differing error message formats across Node
+        message: expect.stringMatching(/Failed to parse typed data JSON: SyntaxError: Unexpected token.*/),
+      });
     });
   });
 

packages/passport/sdk/src/zkEvm/user/loginZkEvmUser.ts

@@ -31,7 +31,6 @@ export const loginZkEvmUser = async ({
 
   const magicProvider = await magicAdapter.login(
     user.idToken,
-    config.network,
   );
 
   if (!user.zkEvm) {