|
| 1 | +import { LoggingController, LogType } from '@metamask/logging-controller'; |
| 2 | +import { Messenger } from '@metamask/messenger'; |
| 3 | + |
| 4 | +import { defaultConfigurations } from '../../defaults'; |
| 5 | +import type { |
| 6 | + DefaultActions, |
| 7 | + DefaultEvents, |
| 8 | + RootMessenger, |
| 9 | +} from '../../defaults'; |
| 10 | +import { loggingController } from './logging-controller'; |
| 11 | + |
| 12 | +const DEFAULT_STATE = { logs: {} }; |
| 13 | + |
| 14 | +/** |
| 15 | + * Creates a root messenger for use in tests. |
| 16 | + * |
| 17 | + * @returns A root messenger. |
| 18 | + */ |
| 19 | +function getRootMessenger(): RootMessenger<DefaultActions, DefaultEvents> { |
| 20 | + return new Messenger({ namespace: 'Root' }); |
| 21 | +} |
| 22 | + |
| 23 | +describe('loggingController', () => { |
| 24 | + it('is registered as a default initialization configuration', () => { |
| 25 | + expect(Object.values(defaultConfigurations)).toContain(loggingController); |
| 26 | + }); |
| 27 | + |
| 28 | + it('initializes a LoggingController with default state', () => { |
| 29 | + const messenger = loggingController.getMessenger(getRootMessenger()); |
| 30 | + |
| 31 | + const instance = loggingController.init({ |
| 32 | + state: undefined, |
| 33 | + messenger, |
| 34 | + options: {}, |
| 35 | + }); |
| 36 | + |
| 37 | + expect(instance).toBeInstanceOf(LoggingController); |
| 38 | + expect(instance.state).toStrictEqual(DEFAULT_STATE); |
| 39 | + }); |
| 40 | + |
| 41 | + it('merges provided state over the defaults', () => { |
| 42 | + const messenger = loggingController.getMessenger(getRootMessenger()); |
| 43 | + |
| 44 | + const entry = { |
| 45 | + id: 'test-id', |
| 46 | + timestamp: 0, |
| 47 | + log: { type: LogType.GenericLog, data: { message: 'hello' } }, |
| 48 | + }; |
| 49 | + |
| 50 | + const instance = loggingController.init({ |
| 51 | + state: { logs: { 'test-id': entry } }, |
| 52 | + messenger, |
| 53 | + options: {}, |
| 54 | + }); |
| 55 | + |
| 56 | + expect(instance.state.logs['test-id']).toStrictEqual(entry); |
| 57 | + }); |
| 58 | + |
| 59 | + it('exposes its state through the root messenger', () => { |
| 60 | + const rootMessenger = getRootMessenger(); |
| 61 | + const messenger = loggingController.getMessenger(rootMessenger); |
| 62 | + |
| 63 | + loggingController.init({ state: undefined, messenger, options: {} }); |
| 64 | + |
| 65 | + expect(rootMessenger.call('LoggingController:getState')).toStrictEqual( |
| 66 | + DEFAULT_STATE, |
| 67 | + ); |
| 68 | + }); |
| 69 | + |
| 70 | + it('registers its method actions on the root messenger', () => { |
| 71 | + const rootMessenger = getRootMessenger(); |
| 72 | + const messenger = loggingController.getMessenger(rootMessenger); |
| 73 | + |
| 74 | + const instance = loggingController.init({ |
| 75 | + state: undefined, |
| 76 | + messenger, |
| 77 | + options: {}, |
| 78 | + }); |
| 79 | + |
| 80 | + rootMessenger.call('LoggingController:add', { |
| 81 | + type: LogType.GenericLog, |
| 82 | + data: { message: 'hello' }, |
| 83 | + }); |
| 84 | + |
| 85 | + expect(Object.values(instance.state.logs)).toHaveLength(1); |
| 86 | + }); |
| 87 | +}); |
0 commit comments