|
| 1 | +import * as Sentry from '@sentry/browser'; |
| 2 | +import { |
| 3 | + AppCheck, |
| 4 | + CustomProvider, |
| 5 | + initializeAppCheck, |
| 6 | + setTokenAutoRefreshEnabled, |
| 7 | +} from 'firebase/app-check'; |
| 8 | +import { FirebaseService } from '../firebase/FirebaseService'; |
| 9 | +import { FcmMessageEvents, FirebaseEvents } from '../firebase/models'; |
| 10 | +import { |
| 11 | + AppCheckService, |
| 12 | + WAIT_FOR_CHALLENGE_ATTEMPT_COUNT, |
| 13 | + WAIT_FOR_CHALLENGE_DELAY_MS, |
| 14 | +} from './AppCheckService'; |
| 15 | +import registerForChallenge from './utils/registerForChallenge'; |
| 16 | +import { ChallengeTypes } from './models'; |
| 17 | +import { MessagePayload } from 'firebase/messaging/sw'; |
| 18 | +import solveChallenge from './utils/solveChallenge'; |
| 19 | +import verifyChallenge from './utils/verifyChallenge'; |
| 20 | + |
| 21 | +jest.mock('@sentry/browser'); |
| 22 | +jest.mock('firebase/app-check'); |
| 23 | +jest.mock('./utils/registerForChallenge'); |
| 24 | +jest.mock('./utils/verifyChallenge'); |
| 25 | +jest.mock('./utils/solveChallenge'); |
| 26 | + |
| 27 | +describe('AppCheckService', () => { |
| 28 | + let appCheckService: AppCheckService; |
| 29 | + let firebaseService: FirebaseService; |
| 30 | + |
| 31 | + beforeEach(() => { |
| 32 | + jest.resetAllMocks(); |
| 33 | + |
| 34 | + (Sentry.startTransaction as jest.Mock).mockReturnValue({ |
| 35 | + finish: jest.fn(), |
| 36 | + setStatus: jest.fn(), |
| 37 | + startChild: jest.fn(() => ({ |
| 38 | + finish: jest.fn(), |
| 39 | + })), |
| 40 | + }); |
| 41 | + |
| 42 | + firebaseService = { |
| 43 | + isFcmInitialized: true, |
| 44 | + getFirebaseApp: () => ({ name: 'test' }), |
| 45 | + getFcmToken: jest.fn().mockReturnValue('fcmToken'), |
| 46 | + addFcmMessageListener: jest.fn(), |
| 47 | + addFirebaseEventListener: jest.fn(), |
| 48 | + } as unknown as FirebaseService; |
| 49 | + |
| 50 | + appCheckService = new AppCheckService(firebaseService); |
| 51 | + appCheckService.activate(); |
| 52 | + }); |
| 53 | + |
| 54 | + it('subscribes for events on activation correctly', () => { |
| 55 | + expect(firebaseService.addFcmMessageListener).toHaveBeenCalledWith( |
| 56 | + FcmMessageEvents.ID_CHALLENGE, |
| 57 | + expect.any(Function), |
| 58 | + ); |
| 59 | + |
| 60 | + expect(firebaseService.addFirebaseEventListener).toHaveBeenCalledTimes(2); |
| 61 | + expect(firebaseService.addFirebaseEventListener).toHaveBeenNthCalledWith( |
| 62 | + 1, |
| 63 | + FirebaseEvents.FCM_INITIALIZED, |
| 64 | + expect.any(Function), |
| 65 | + ); |
| 66 | + expect(firebaseService.addFirebaseEventListener).toHaveBeenNthCalledWith( |
| 67 | + 2, |
| 68 | + FirebaseEvents.FCM_TERMINATED, |
| 69 | + expect.any(Function), |
| 70 | + ); |
| 71 | + }); |
| 72 | + |
| 73 | + const appCheckMock = { app: { name: 'test' } } as AppCheck; |
| 74 | + |
| 75 | + beforeEach(() => { |
| 76 | + jest.useFakeTimers(); |
| 77 | + jest.mocked(initializeAppCheck).mockReturnValue(appCheckMock); |
| 78 | + |
| 79 | + // simulate FCM_INITIALIZED event |
| 80 | + jest.mocked(firebaseService.addFirebaseEventListener).mock.calls[0]?.[1](); |
| 81 | + }); |
| 82 | + |
| 83 | + afterEach(() => { |
| 84 | + jest.useRealTimers(); |
| 85 | + }); |
| 86 | + |
| 87 | + it('initializes appcheck correctly', () => { |
| 88 | + expect(setTokenAutoRefreshEnabled).not.toHaveBeenCalled(); |
| 89 | + expect(initializeAppCheck).toHaveBeenCalledWith( |
| 90 | + { name: 'test' }, |
| 91 | + { |
| 92 | + provider: expect.any(CustomProvider), |
| 93 | + isTokenAutoRefreshEnabled: true, |
| 94 | + }, |
| 95 | + ); |
| 96 | + |
| 97 | + // simulate FCM_INITIALIZED event (second time) |
| 98 | + jest.mocked(firebaseService.addFirebaseEventListener).mock.calls[0]?.[1](); |
| 99 | + |
| 100 | + expect(initializeAppCheck).toHaveBeenCalledTimes(1); |
| 101 | + expect(setTokenAutoRefreshEnabled).toHaveBeenCalledWith(appCheckMock, true); |
| 102 | + }); |
| 103 | + |
| 104 | + it('terminates appcheck correctly', () => { |
| 105 | + expect(setTokenAutoRefreshEnabled).not.toHaveBeenCalled(); |
| 106 | + expect(initializeAppCheck).toHaveBeenCalledWith( |
| 107 | + { name: 'test' }, |
| 108 | + { |
| 109 | + provider: expect.any(CustomProvider), |
| 110 | + isTokenAutoRefreshEnabled: true, |
| 111 | + }, |
| 112 | + ); |
| 113 | + |
| 114 | + // simulate FCM_TERMINATED event |
| 115 | + jest.mocked(firebaseService.addFirebaseEventListener).mock.calls[1]?.[1](); |
| 116 | + |
| 117 | + expect(setTokenAutoRefreshEnabled).toHaveBeenCalledWith( |
| 118 | + appCheckMock, |
| 119 | + false, |
| 120 | + ); |
| 121 | + }); |
| 122 | + |
| 123 | + describe('getToken', () => { |
| 124 | + it('throws when FCM is not initialized', async () => { |
| 125 | + // eslint-disable-next-line @typescript-eslint/ban-ts-comment |
| 126 | + // @ts-ignore |
| 127 | + firebaseService.isFcmInitialized = false; |
| 128 | + await expect( |
| 129 | + jest.mocked(CustomProvider).mock.calls[0]?.[0].getToken(), |
| 130 | + ).rejects.toThrow('fcm is not initialized'); |
| 131 | + }); |
| 132 | + |
| 133 | + it('throws when FCM token is missing', async () => { |
| 134 | + jest.mocked(firebaseService.getFcmToken).mockReturnValueOnce(undefined); |
| 135 | + await expect( |
| 136 | + jest.mocked(CustomProvider).mock.calls[0]?.[0].getToken(), |
| 137 | + ).rejects.toThrow('fcm token is missing'); |
| 138 | + }); |
| 139 | + |
| 140 | + it('throws a timeout error when challenge is not received in time', async () => { |
| 141 | + jest |
| 142 | + .mocked(CustomProvider) |
| 143 | + .mock.calls[0]?.[0].getToken() |
| 144 | + .catch((err) => { |
| 145 | + expect(err).toBe('timeout'); |
| 146 | + }); |
| 147 | + |
| 148 | + for (let i = 0; i <= WAIT_FOR_CHALLENGE_ATTEMPT_COUNT; i++) { |
| 149 | + jest.advanceTimersByTime(WAIT_FOR_CHALLENGE_DELAY_MS); |
| 150 | + await Promise.resolve(); |
| 151 | + } |
| 152 | + }); |
| 153 | + |
| 154 | + it('generates a token correctly', async () => { |
| 155 | + jest.mocked(crypto.randomUUID).mockReturnValue('1-2-3-4-5'); |
| 156 | + jest.mocked(solveChallenge).mockResolvedValueOnce('solution'); |
| 157 | + jest |
| 158 | + .mocked(verifyChallenge) |
| 159 | + .mockResolvedValueOnce({ token: 'token', exp: 1234 }); |
| 160 | + |
| 161 | + const promise = jest.mocked(CustomProvider).mock.calls[0]?.[0].getToken(); |
| 162 | + |
| 163 | + // trigger ID_CHALLENGE event |
| 164 | + jest.mocked(firebaseService.addFcmMessageListener).mock.calls[0]?.[1]({ |
| 165 | + data: { |
| 166 | + requestId: crypto.randomUUID(), |
| 167 | + registrationId: 'registrationId', |
| 168 | + type: ChallengeTypes.BASIC, |
| 169 | + event: FcmMessageEvents.ID_CHALLENGE, |
| 170 | + details: '{}', |
| 171 | + }, |
| 172 | + } as unknown as MessagePayload); |
| 173 | + |
| 174 | + await Promise.resolve(); |
| 175 | + jest.advanceTimersByTime(1000); |
| 176 | + await Promise.resolve(); |
| 177 | + |
| 178 | + await expect(promise).resolves.toStrictEqual({ |
| 179 | + token: 'token', |
| 180 | + expireTimeMillis: 1234, |
| 181 | + }); |
| 182 | + |
| 183 | + expect(registerForChallenge).toHaveBeenCalledWith({ |
| 184 | + token: 'fcmToken', |
| 185 | + requestId: crypto.randomUUID(), |
| 186 | + }); |
| 187 | + expect(solveChallenge).toHaveBeenCalledWith({ |
| 188 | + type: ChallengeTypes.BASIC, |
| 189 | + challengeDetails: '{}', |
| 190 | + }); |
| 191 | + expect(verifyChallenge).toHaveBeenCalledWith({ |
| 192 | + registrationId: 'registrationId', |
| 193 | + solution: 'solution', |
| 194 | + }); |
| 195 | + }); |
| 196 | + }); |
| 197 | +}); |
0 commit comments