|
| 1 | +import { |
| 2 | + PPOMController, |
| 3 | + PPOMControllerMessenger, |
| 4 | +} from '@metamask/ppom-validator'; |
| 5 | +import { ControllerMessenger } from '@metamask/base-controller'; |
| 6 | +import { PreferencesController } from '../../controllers/preferences-controller'; |
| 7 | +import { buildControllerInitRequestMock, CHAIN_ID_MOCK } from '../test/utils'; |
| 8 | +import { ControllerInitRequest } from '../types'; |
| 9 | +import { |
| 10 | + getPPOMControllerInitMessenger, |
| 11 | + getPPOMControllerMessenger, |
| 12 | + PPOMControllerInitMessenger, |
| 13 | +} from '../messengers/ppom-controller-messenger'; |
| 14 | +import { PPOMControllerInit } from './ppom-controller-init'; |
| 15 | + |
| 16 | +type PPOMControllerOptions = ConstructorParameters<typeof PPOMController>[0]; |
| 17 | + |
| 18 | +jest.mock('@metamask/ppom-validator'); |
| 19 | + |
| 20 | +/** |
| 21 | + * Build a mock PreferencesController. |
| 22 | + * |
| 23 | + * @param partialMock - A partial mock object for the PreferencesController, merged |
| 24 | + * with the default mock. |
| 25 | + * @returns A mock PreferencesController. |
| 26 | + */ |
| 27 | +function buildControllerMock( |
| 28 | + partialMock?: Partial<PreferencesController>, |
| 29 | +): PreferencesController { |
| 30 | + const defaultPreferencesControllerMock = { |
| 31 | + state: { securityAlertsEnabled: true }, |
| 32 | + }; |
| 33 | + |
| 34 | + // @ts-expect-error Incomplete mock, just includes properties used by code-under-test. |
| 35 | + return { |
| 36 | + ...defaultPreferencesControllerMock, |
| 37 | + ...partialMock, |
| 38 | + }; |
| 39 | +} |
| 40 | + |
| 41 | +function buildInitRequestMock(): jest.Mocked< |
| 42 | + ControllerInitRequest<PPOMControllerMessenger, PPOMControllerInitMessenger> |
| 43 | +> { |
| 44 | + const baseControllerMessenger = new ControllerMessenger(); |
| 45 | + |
| 46 | + const requestMock = { |
| 47 | + ...buildControllerInitRequestMock(), |
| 48 | + controllerMessenger: getPPOMControllerMessenger(baseControllerMessenger), |
| 49 | + initMessenger: getPPOMControllerInitMessenger(baseControllerMessenger), |
| 50 | + }; |
| 51 | + |
| 52 | + requestMock.getController.mockReturnValue(buildControllerMock()); |
| 53 | + |
| 54 | + return requestMock; |
| 55 | +} |
| 56 | + |
| 57 | +describe('PPOM Controller Init', () => { |
| 58 | + const ppomControllerClassMock = jest.mocked(PPOMController); |
| 59 | + |
| 60 | + /** |
| 61 | + * Extract a constructor option passed to the controller. |
| 62 | + * |
| 63 | + * @param option - The option to extract. |
| 64 | + * @param dependencyProperties - Any properties required on the controller dependencies. |
| 65 | + * @returns The extracted option. |
| 66 | + */ |
| 67 | + function testConstructorOption<T extends keyof PPOMControllerOptions>( |
| 68 | + option: T, |
| 69 | + dependencyProperties?: Record<string, unknown>, |
| 70 | + ): PPOMControllerOptions[T] { |
| 71 | + const requestMock = buildInitRequestMock(); |
| 72 | + |
| 73 | + requestMock.getController.mockReturnValue( |
| 74 | + buildControllerMock(dependencyProperties), |
| 75 | + ); |
| 76 | + |
| 77 | + PPOMControllerInit(requestMock); |
| 78 | + |
| 79 | + return ppomControllerClassMock.mock.calls[0][0][option]; |
| 80 | + } |
| 81 | + |
| 82 | + beforeEach(() => { |
| 83 | + jest.resetAllMocks(); |
| 84 | + }); |
| 85 | + |
| 86 | + it('returns controller instance', () => { |
| 87 | + const requestMock = buildInitRequestMock(); |
| 88 | + expect(PPOMControllerInit(requestMock).controller).toBeInstanceOf( |
| 89 | + PPOMController, |
| 90 | + ); |
| 91 | + }); |
| 92 | + |
| 93 | + it('determines if security alerts enabled using preference', () => { |
| 94 | + const securityAlertsEnabled = testConstructorOption( |
| 95 | + 'securityAlertsEnabled', |
| 96 | + { state: { securityAlertsEnabled: true } }, |
| 97 | + ); |
| 98 | + |
| 99 | + expect(securityAlertsEnabled).toBe(true); |
| 100 | + }); |
| 101 | + |
| 102 | + it('sets chain ID to global chain ID', () => { |
| 103 | + const chainId = testConstructorOption('chainId'); |
| 104 | + expect(chainId).toBe(CHAIN_ID_MOCK); |
| 105 | + }); |
| 106 | +}); |
0 commit comments