All files / platform/core/src/extensions ExtensionManager.test.js

0% Statements 0/99
0% Branches 0/2
0% Functions 0/38
0% Lines 0/99

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
import ExtensionManager from './ExtensionManager';
import MODULE_TYPES from './MODULE_TYPES';
import log from './../log.js';
 
jest.mock('./../log.js');
 
describe('ExtensionManager.ts', () => {
  let extensionManager, commandsManager, servicesManager, appConfig;
 
  beforeEach(() => {
    commandsManager = {
      createContext: jest.fn(),
      getContext: jest.fn(),
      registerCommand: jest.fn(),
    };
    servicesManager = {
      registerService: jest.fn(),
      services: {
        // Required for DataSource Module initiation
        UserAuthenticationService: jest.fn(),
        HangingProtocolService: {
          addProtocol: jest.fn(),
        },
      },
    };
    appConfig = {
      testing: true,
    };
    extensionManager = new ExtensionManager({
      servicesManager,
      commandsManager,
      appConfig,
    });
    log.warn.mockClear();
    jest.clearAllMocks();
  });
 
  it('creates a module namespace for each module type', () => {
    const moduleKeys = Object.keys(extensionManager.modules);
    const moduleTypeValues = Object.values(MODULE_TYPES);
 
    expect(moduleKeys.sort()).toEqual(moduleTypeValues.sort());
  });
 
  describe('registerExtensions()', () => {
    it('calls registerExtension() for each extension', async () => {
      extensionManager.registerExtension = jest.fn();
 
      // SUT
      const fakeExtensions = [{ one: '1' }, { two: '2' }, { three: '3 ' }];
      await extensionManager.registerExtensions(fakeExtensions);
 
      // Assert
      expect(extensionManager.registerExtension.mock.calls.length).toBe(3);
    });
 
    it('calls registerExtension() for each extension passing its configuration if tuple', async () => {
      const fakeConfiguration = { testing: true };
      extensionManager.registerExtension = jest.fn();
 
      // SUT
      const fakeExtensions = [{ one: '1' }, [{ two: '2' }, fakeConfiguration], { three: '3 ' }];
      await extensionManager.registerExtensions(fakeExtensions);
 
      // Assert
      expect(extensionManager.registerExtension.mock.calls[1][1]).toEqual(fakeConfiguration);
    });
  });
 
  describe('registerExtension()', () => {
    it('calls preRegistration() for extension', () => {
      // SUT
      const fakeExtension = { id: '1', preRegistration: jest.fn() };
      extensionManager.registerExtension(fakeExtension);
 
      // Assert
      expect(fakeExtension.preRegistration.mock.calls.length).toBe(1);
    });
 
    it('calls preRegistration() passing dependencies and extension configuration to extension', () => {
      const extensionConfiguration = { config: 'Some configuration' };
 
      // SUT
      const extension = { id: '1', preRegistration: jest.fn() };
      extensionManager.registerExtension(extension, extensionConfiguration);
 
      // Assert
      expect(extension.preRegistration.mock.calls[0][0]).toEqual({
        servicesManager,
        commandsManager,
        extensionManager,
        appConfig,
        configuration: extensionConfiguration,
      });
    });
 
    it('logs a warning if the extension is null or undefined', async () => {
      const undefinedExtension = undefined;
      const nullExtension = null;
 
      await expect(extensionManager.registerExtension(undefinedExtension)).rejects.toThrow(
        new Error('Attempting to register a null/undefined extension.')
      );
 
      await expect(extensionManager.registerExtension(nullExtension)).rejects.toThrow(
        new Error('Attempting to register a null/undefined extension.')
      );
    });
 
    it('logs a warning if the extension does not have an id', async () => {
      const extensionWithoutId = {};
 
      await expect(extensionManager.registerExtension(extensionWithoutId)).rejects.toThrow(
        new Error('Extension ID not set')
      );
    });
 
    it('tracks which extensions have been registered', () => {
      const extension = {
        id: 'hello-world',
      };
 
      extensionManager.registerExtension(extension);
 
      expect(extensionManager.registeredExtensionIds).toContain(extension.id);
    });
 
    it('logs a warning if the extension has an id that has already been registered', () => {
      const extension = { id: 'hello-world' };
      extensionManager.registerExtension(extension);
 
      // SUT
      extensionManager.registerExtension(extension);
 
      expect(log.warn.mock.calls.length).toBe(1);
    });
 
    it('logs a warning if a defined module returns null or undefined', () => {
      const extensionWithBadModule = {
        id: 'hello-world',
        getViewportModule: () => {
          return null;
        },
      };
 
      extensionManager.registerExtension(extensionWithBadModule);
 
      expect(log.warn.mock.calls.length).toBe(1);
      expect(log.warn.mock.calls[0][0]).toContain('Null or undefined returned when registering');
    });
 
    it('logs an error if an exception is thrown while retrieving a module', async () => {
      const extensionWithBadModule = {
        id: 'hello-world',
        getViewportModule: () => {
          throw new Error('Hello World');
        },
      };
 
      await expect(extensionManager.registerExtension(extensionWithBadModule)).rejects.toThrow();
    });
 
    it('successfully passes dependencies to each module along with extension configuration', () => {
      const extensionConfiguration = { testing: true };
 
      const extension = {
        id: 'hello-world',
        getViewportModule: jest.fn(),
        getSopClassHandlerModule: jest.fn(),
        getPanelModule: jest.fn(),
        getToolbarModule: jest.fn(),
        getCommandsModule: jest.fn(),
      };
 
      extensionManager.registerExtension(extension, extensionConfiguration);
 
      Object.keys(extension).forEach(module => {
        if (typeof extension[module] === 'function') {
          expect(extension[module].mock.calls[0][0]).toEqual({
            servicesManager,
            commandsManager,
            hotkeysManager: undefined,
            appConfig,
            configuration: extensionConfiguration,
            extensionManager,
          });
        }
      });
    });
 
    it('successfully registers a module for each module type', async () => {
      const extension = {
        id: 'hello-world',
        getViewportModule: () => {
          return [{ name: 'test' }];
        },
        getSopClassHandlerModule: () => {
          return [{ name: 'test' }];
        },
        getPanelModule: () => {
          return [{ name: 'test' }];
        },
        getToolbarModule: () => {
          return [{ name: 'test' }];
        },
        getCommandsModule: () => {
          return [{ name: 'test' }];
        },
        getLayoutTemplateModule: () => {
          return [{ name: 'test' }];
        },
        getDataSourcesModule: () => {
          return [{ name: 'test' }];
        },
        getHangingProtocolModule: () => {
          return [{ name: 'test' }];
        },
        getContextModule: () => {
          return [{ name: 'test' }];
        },
        getUtilityModule: () => {
          return [{ name: 'test' }];
        },
        getCustomizationModule: () => {
          return [{ name: 'test' }];
        },
        getStateSyncModule: () => {
          return [{ name: 'test' }];
        },
      };
 
      await extensionManager.registerExtension(extension);
 
      // Registers 1 module per module type
      Object.keys(extensionManager.modules).forEach(moduleType => {
        const modulesForType = extensionManager.modules[moduleType];
        console.log('moduleType', moduleType);
        expect(modulesForType.length).toBe(1);
      });
    });
 
    it('calls commandsManager.registerCommand for each commandsModule command definition', () => {
      const extension = {
        id: 'hello-world',
        getCommandsModule: () => {
          return {
            definitions: {
              exampleDefinition: {
                commandFn: () => {},
                options: {},
              },
            },
          };
        },
      };
 
      // SUT
      extensionManager.registerExtension(extension);
 
      expect(commandsManager.registerCommand.mock.calls.length).toBe(1);
    });
 
    it('logs a warning if the commandsModule contains no command definitions', () => {
      const extension = {
        id: 'hello-world',
        getCommandsModule: () => {
          return {};
        },
      };
 
      // SUT
      extensionManager.registerExtension(extension);
 
      expect(log.warn.mock.calls.length).toBe(1);
      expect(log.warn.mock.calls[0][0]).toContain(
        'Commands Module contains no command definitions'
      );
    });
  });
});