@sima-land/isomorph 11.0.0-alpha.0 → 11.0.0-alpha.1

package/src/utils/webpack/module-federation/__test__/index.test.ts

@@ -1,246 +0,0 @@
-import { container, Compiler } from 'webpack';
-import { LIBRARY_ERROR_TEXT, ModuleFederationPlugin, REMOTE_ERROR_TEXT } from '..';
-
-jest.mock('../utils', () => ({
-  createExternalConfig: jest.fn(arg => arg),
-}));
-
-jest.mock('webpack', () => {
-  class ModuleFederationPluginMock {
-    static __spy__ = { constructor: jest.fn(), apply: jest.fn() };
-
-    constructor(...args: any[]) {
-      ModuleFederationPluginMock.__spy__.constructor(...args);
-    }
-
-    apply(...args: any[]) {
-      ModuleFederationPluginMock.__spy__.apply(...args);
-    }
-  }
-
-  return {
-    container: {
-      ModuleFederationPlugin: ModuleFederationPluginMock,
-    },
-    WebpackError: class extends Error {},
-  };
-});
-
-function getSpy(value: any): { constructor: jest.Mock; apply: jest.Mock } {
-  return value.__spy__;
-}
-
-beforeEach(() => {
-  getSpy(container.ModuleFederationPlugin).constructor.mockClear();
-  getSpy(container.ModuleFederationPlugin).apply.mockClear();
-});
-
-describe('ModuleFederationPlugin', () => {
-  function createCompilerMock(): Compiler {
-    return {
-      hooks: {
-        environment: {
-          tap: jest.fn((name, cb) => cb()),
-        },
-      },
-    } as any;
-  }
-
-  describe('ModuleFederationPlugin instance', () => {
-    it('should apply original plugin', () => {
-      const compiler = createCompilerMock();
-      const instance = new ModuleFederationPlugin({ name: 'test-module' });
-
-      expect(getSpy(container.ModuleFederationPlugin).apply).toBeCalledTimes(0);
-
-      instance.apply(compiler);
-
-      expect(getSpy(container.ModuleFederationPlugin).apply).toBeCalledTimes(1);
-      expect(getSpy(container.ModuleFederationPlugin).apply).toBeCalledWith(compiler);
-    });
-
-    it('should not creat and throw error, if library property pass to plugin', () => {
-      expect(() => {
-        new ModuleFederationPlugin({ library: 'test' } as any);
-      }).toThrowError(LIBRARY_ERROR_TEXT);
-    });
-
-    it('should not creat and throw error, if remotes property incorrect', () => {
-      expect(() => {
-        new ModuleFederationPlugin({ remotes: { remoteOne: {} } } as any);
-      }).toThrowError(REMOTE_ERROR_TEXT);
-    });
-  });
-
-  describe('ModuleFederationPlugin instance should create with correct arguments', () => {
-    it('for remotes', () => {
-      const compiler = createCompilerMock();
-      const instance = new ModuleFederationPlugin({
-        name: 'service-name',
-        remotes: {
-          firstRemote: 'first-remote-service',
-          secondRemote: 'second-remote-service',
-        },
-      });
-
-      instance.apply(compiler);
-
-      expect(getSpy(container.ModuleFederationPlugin).constructor).toBeCalledWith({
-        name: 'service-name',
-        library: {
-          type: 'global',
-          name: ['__FederationContainers__', 'service-name'],
-        },
-        remotes: {
-          firstRemote: {
-            external: {
-              serviceName: 'first-remote-service',
-              remoteEntriesGlobalKey: '__RemoteEntriesList__',
-              containersGlobalKey: '__FederationContainers__',
-            },
-          },
-          secondRemote: {
-            external: {
-              serviceName: 'second-remote-service',
-              remoteEntriesGlobalKey: '__RemoteEntriesList__',
-              containersGlobalKey: '__FederationContainers__',
-            },
-          },
-        },
-      });
-    });
-
-    it('for remotes with custom global variables name', () => {
-      const compiler = createCompilerMock();
-      const instance = new ModuleFederationPlugin({
-        name: 'service-name',
-        remotes: {
-          firstRemote: 'first-remote-service',
-          secondRemote: 'second-remote-service',
-        },
-        remoteEntriesGlobalKey: 'remotes-entry-key',
-        containersGlobalKey: 'containers-key',
-      });
-
-      instance.apply(compiler);
-      expect(getSpy(container.ModuleFederationPlugin).constructor).toBeCalledWith({
-        name: 'service-name',
-        library: {
-          type: 'global',
-          name: ['containers-key', 'service-name'],
-        },
-        remotes: {
-          firstRemote: {
-            external: {
-              serviceName: 'first-remote-service',
-              remoteEntriesGlobalKey: 'remotes-entry-key',
-              containersGlobalKey: 'containers-key',
-            },
-          },
-          secondRemote: {
-            external: {
-              serviceName: 'second-remote-service',
-              remoteEntriesGlobalKey: 'remotes-entry-key',
-              containersGlobalKey: 'containers-key',
-            },
-          },
-        },
-      });
-    });
-
-    it('for various remote type', () => {
-      const compiler = createCompilerMock();
-
-      const instance = new ModuleFederationPlugin({
-        name: 'service-name',
-        remotes: {
-          firstRemote: 'first-remote-service',
-          secondRemote: {
-            name: 'second-remote-service',
-          },
-          thirdRemote: {
-            name: 'third-remote-service',
-            remoteEntryPath: '//example.com/path/to/RemoteEntry.js',
-          },
-        },
-      });
-
-      instance.apply(compiler);
-      expect(getSpy(container.ModuleFederationPlugin).constructor).toBeCalledWith({
-        name: 'service-name',
-        library: {
-          type: 'global',
-          name: ['__FederationContainers__', 'service-name'],
-        },
-        remotes: {
-          firstRemote: {
-            external: {
-              serviceName: 'first-remote-service',
-              remoteEntriesGlobalKey: '__RemoteEntriesList__',
-              containersGlobalKey: '__FederationContainers__',
-            },
-          },
-          secondRemote: {
-            external: {
-              serviceName: 'second-remote-service',
-              remoteEntriesGlobalKey: '__RemoteEntriesList__',
-              containersGlobalKey: '__FederationContainers__',
-            },
-          },
-          thirdRemote: {
-            external: {
-              serviceName: 'third-remote-service',
-              remoteEntriesGlobalKey: '__RemoteEntriesList__',
-              containersGlobalKey: '__FederationContainers__',
-              remoteEntryPath: '//example.com/path/to/RemoteEntry.js',
-            },
-          },
-        },
-      });
-    });
-
-    it('for exposes', () => {
-      const compiler = createCompilerMock();
-
-      const instance = new ModuleFederationPlugin({
-        name: 'service-name',
-        filename: 'path/to/RemoteEntry.js',
-        exposes: {
-          './One': './path/to/one.js',
-          './Two': './path/to/two.js',
-        },
-      });
-
-      instance.apply(compiler);
-      expect(getSpy(container.ModuleFederationPlugin).constructor).toBeCalledWith({
-        name: 'service-name',
-        filename: 'path/to/RemoteEntry.js',
-        library: {
-          type: 'global',
-          name: ['__FederationContainers__', 'service-name'],
-        },
-        exposes: {
-          './One': './path/to/one.js',
-          './Two': './path/to/two.js',
-        },
-      });
-    });
-
-    it('for several call "apply" method', () => {
-      const compiler = createCompilerMock();
-
-      const instance = new ModuleFederationPlugin({
-        name: 'service-name',
-      });
-
-      instance.apply(compiler);
-      instance.apply(compiler);
-
-      const calls = getSpy(container.ModuleFederationPlugin).constructor.mock.calls;
-
-      for (const key of Object.keys(calls[0][0])) {
-        expect(calls[1][0][key] === calls[0][0][key]).toBe(true);
-      }
-    });
-  });
-});

package/src/utils/webpack/module-federation/index.ts

@@ -1,92 +0,0 @@
-import type { ModuleFederationPluginOptions, ReadyOptions } from './types';
-import { container, Compiler, WebpackError } from 'webpack';
-import { createExternalConfig } from './utils';
-
-export const LIBRARY_ERROR_TEXT = [
-  'Property "library" set internally as "global" and not overridden.',
-  'For override global variable name use "containersGlobalKey" property.',
-  'For override "library" type use ModuleFederationPlugin.',
-].join(' ');
-
-export const REMOTE_ERROR_TEXT = [
-  'The value of the remote element must be a string,',
-  'or an object with field "name" for dynamic resolution of "remoteEntry".',
-  'Set "remoteEntryPath" field to object for a static path to "remoteEntry".',
-].join(' ');
-
-/**
- * Создает плагин ModuleFederation с опциями, необходимыми для оркестрации удаленных модулей в браузере.
- */
-export class ModuleFederationPlugin {
-  /**
-   * Проверенные, готовые опции.
-   */
-  readonly readyOptions: ReadyOptions;
-
-  /**
-   * @param options Опции.
-   */
-  constructor(options: ModuleFederationPluginOptions) {
-    const {
-      name,
-      remotes,
-      remoteEntriesGlobalKey = '__RemoteEntriesList__',
-      containersGlobalKey = '__FederationContainers__',
-    } = options;
-
-    if ('library' in options) {
-      throw new WebpackError(LIBRARY_ERROR_TEXT);
-    }
-
-    if (remotes) {
-      for (const value of Object.values(remotes)) {
-        if (typeof value !== 'string' && !value.name) {
-          throw new WebpackError(REMOTE_ERROR_TEXT);
-        }
-      }
-    }
-
-    this.readyOptions = {
-      ...options,
-      remoteEntriesGlobalKey,
-      containersGlobalKey,
-      library: {
-        type: 'global',
-        name: [containersGlobalKey, name],
-      },
-    };
-  }
-
-  /**
-   * @param compiler Компилятор.
-   */
-  apply(compiler: Compiler) {
-    const { remotes, remoteEntriesGlobalKey, containersGlobalKey, ...restOptions } =
-      this.readyOptions;
-
-    const configuredRemotes: Record<string, any> = {};
-
-    if (remotes) {
-      for (const [key, value] of Object.entries(remotes)) {
-        const serviceName = typeof value === 'string' ? value : value.name;
-        const remoteEntryPath = typeof value === 'string' ? undefined : value.remoteEntryPath;
-
-        configuredRemotes[key] = {
-          external: createExternalConfig({
-            serviceName,
-            remoteEntryPath,
-            remoteEntriesGlobalKey,
-            containersGlobalKey,
-          }),
-        };
-      }
-    }
-
-    compiler.hooks.environment.tap('[isomorph]ModuleFederationPlugin', () => {
-      new container.ModuleFederationPlugin({
-        ...(remotes && { remotes: configuredRemotes }),
-        ...restOptions,
-      }).apply(compiler);
-    });
-  }
-}

package/src/utils/webpack/module-federation/types.ts

@@ -1,44 +0,0 @@
-import type { container } from 'webpack';
-
-export interface RemoteProperty {
-  name: string;
-  remoteEntryPath?: string;
-  version?: string;
-}
-
-export type OriginalModuleFederationPluginOptions = ConstructorParameters<
-  typeof container.ModuleFederationPlugin
->[0];
-
-export interface ModuleFederationPluginOptions {
-  /** Имя сервиса. */
-  name: string;
-
-  /** Имя удаленной точки входа. */
-  filename?: string;
-
-  /** Удаленные сервисы.  */
-  remotes?: Record<string, string | RemoteProperty>;
-
-  /** Предоставляемые сервисы. */
-  exposes?: OriginalModuleFederationPluginOptions['exposes'];
-
-  /** Общие зависимости.  */
-  shared?: OriginalModuleFederationPluginOptions['shared'];
-
-  /** Ключ свойства в глобальном объекте,в котором хранится карта точек входа в удаленные сервисы. */
-  remoteEntriesGlobalKey?: string;
-
-  /** Ключ свойства в глобальном объекте, в который добавляются контейнеры удаленных сервисов. */
-  containersGlobalKey?: string;
-}
-
-export type ReadyOptions = Omit<
-  ModuleFederationPluginOptions,
-  'remoteEntriesGlobalKey' | 'containersGlobalKey'
-> &
-  Required<
-    Pick<ModuleFederationPluginOptions, 'remoteEntriesGlobalKey' | 'containersGlobalKey'>
-  > & {
-    library: Required<OriginalModuleFederationPluginOptions>['library'];
-  };

package/src/utils/webpack/module-federation/utils.ts

@@ -1,43 +0,0 @@
-/**
- * Возвращает скрипт инициализации удаленного модуля.
- * @param params Параметры.
- * @param params.serviceName Имя сервиса, содержащего удаленные модули.
- * @param params.containersGlobalKey Глобальная переменная, в которую добавляются удаленные контейнеры.
- * @param params.remoteEntriesGlobalKey Глобальная переменная, в которой хранятся пути к удаленным точкам входа.
- * @param params.remoteEntryPath Путь к remoteEntry, если его не надо получать в runtime.
- * @return Скрипт инициализации.
- */
-export function createExternalConfig({
-  serviceName,
-  containersGlobalKey,
-  remoteEntriesGlobalKey,
-  remoteEntryPath,
-}: {
-  serviceName: string;
-  remoteEntriesGlobalKey: string;
-  containersGlobalKey: string;
-  remoteEntryPath?: string;
-}) {
-  return `promise new Promise((resolve, reject) => {
-  if (window['${remoteEntriesGlobalKey}']) {
-    const scriptElement = document.createElement('script');
-    scriptElement.onload = () => {
-      scriptElement.remove();
-      resolve(window['${containersGlobalKey}']['${serviceName}']);
-    };
-    scriptElement.onerror = () => {
-      scriptElement.remove();
-      reject(new Error('Failed loading remoteEntry for "${serviceName}".'));
-    };
-    scriptElement.src = ${
-      remoteEntryPath
-        ? `'${remoteEntryPath}'`
-        : `window['${remoteEntriesGlobalKey}']['${serviceName}']`
-    };
-    scriptElement.async = true;
-    document.head.append(scriptElement);
-  } else {
-    reject(new ReferenceError('Object "${remoteEntriesGlobalKey}" unavailable.'));
-  }
-})`;
-}