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

package/src/utils/redux-saga/__test__/take-chain.test.ts

@@ -0,0 +1,141 @@
+import { delay, fork, put, race, take } from 'redux-saga/effects';
+import { generateTakeChain, putDelayed, takeChain } from '../take-chain';
+
+const SettlementTypes = {
+  UPDATE: 'settlement',
+  REMOVE: 'settlement',
+};
+
+describe('takeChain', () => {
+  beforeEach(() => {
+    jest.spyOn(Date, 'now').mockImplementation(() => 123);
+  });
+
+  const testTypes = [SettlementTypes.UPDATE, SettlementTypes.REMOVE];
+  const timeout = 100;
+  const testTask = jest.fn();
+  const deps: [string, number] = ['John', 23];
+
+  it('generateTakeChain few actions', () => {
+    const gen = generateTakeChain(timeout, testTypes, testTask, deps);
+
+    expect(gen.next().value).toEqual(take(testTypes));
+
+    expect(gen.next({ type: SettlementTypes.REMOVE.toString() }).value).toEqual(
+      fork(putDelayed, timeout, { type: 'BREAK_123' }),
+    );
+
+    expect(gen.next().value).toEqual(
+      race({
+        action: take(testTypes),
+        canceled: take('BREAK_123'),
+      }),
+    );
+    expect(
+      gen.next({
+        action: { type: SettlementTypes.UPDATE.toString() },
+        canceled: { type: 'BREAK_123' },
+      }).value,
+    ).toEqual(
+      fork(testTask, ...deps, [
+        { type: SettlementTypes.REMOVE.toString() },
+        { type: SettlementTypes.UPDATE.toString() },
+      ]),
+    );
+    expect(gen.next()).toBeTruthy();
+  });
+
+  it('generateTakeChain one action', () => {
+    const gen = generateTakeChain(timeout, testTypes, testTask, deps);
+
+    expect(gen.next().value).toEqual(take(testTypes));
+
+    expect(gen.next({ type: 'settlement/REMOVE' }).value).toEqual(
+      fork(putDelayed, timeout, { type: 'BREAK_123' }),
+    );
+
+    expect(gen.next().value).toEqual(
+      race({
+        action: take(testTypes),
+        canceled: take('BREAK_123'),
+      }),
+    );
+    expect(
+      gen.next({
+        action: undefined,
+        canceled: { type: 'BREAK_123' },
+      }).value,
+    ).toEqual(fork(testTask, ...deps, [{ type: 'settlement/REMOVE' }]));
+    expect(gen.next()).toBeTruthy();
+  });
+
+  it('generateTakeChain without canceled', () => {
+    const gen = generateTakeChain(timeout, testTypes, testTask, deps);
+
+    expect(gen.next().value).toEqual(take(testTypes));
+
+    expect(gen.next({ type: 'settlement/REMOVE' }).value).toEqual(
+      fork(putDelayed, timeout, { type: 'BREAK_123' }),
+    );
+
+    expect(gen.next().value).toEqual(
+      race({
+        action: take(testTypes),
+        canceled: take('BREAK_123'),
+      }),
+    );
+    expect(
+      gen.next({
+        action: undefined,
+        canceled: undefined,
+      }).value,
+    ).toBeTruthy();
+  });
+
+  it('generateTakeChain when puts all actions and have not canceled', () => {
+    const gen = generateTakeChain(timeout, testTypes, testTask, deps);
+
+    expect(gen.next().value).toEqual(take(testTypes));
+
+    expect(gen.next({ type: SettlementTypes.REMOVE.toString() }).value).toEqual(
+      fork(putDelayed, timeout, { type: 'BREAK_123' }),
+    );
+
+    expect(gen.next().value).toEqual(
+      race({
+        action: take(testTypes),
+        canceled: take('BREAK_123'),
+      }),
+    );
+
+    expect(
+      gen.next({
+        action: { type: SettlementTypes.UPDATE.toString() },
+        canceled: undefined,
+      }).value,
+    ).toEqual(
+      fork(testTask, ...deps, [
+        { type: SettlementTypes.REMOVE.toString() },
+        { type: SettlementTypes.UPDATE.toString() },
+      ]),
+    );
+    expect(gen.next()).toBeTruthy();
+  });
+
+  it('should fork generateTakeChain', () => {
+    const fakeTakeChain = takeChain(timeout, testTypes, testTask, ...deps);
+
+    expect(fakeTakeChain).toEqual(fork(generateTakeChain, timeout, testTypes, testTask, deps));
+  });
+});
+
+describe('putDelayed', () => {
+  it('should works properly', () => {
+    const gen = putDelayed(10, { type: 'test' });
+
+    expect(gen.next().value).toEqual(delay(10));
+    expect(gen.next().value).toEqual(put({ type: 'test' }));
+
+    expect(gen.next()).toBeTruthy();
+  });
+});

package/src/utils/redux-saga/take-chain.ts

@@ -0,0 +1,65 @@
+import { Action } from '@reduxjs/toolkit';
+import { delay, fork, put, race, take } from 'redux-saga/effects';
+
+/**
+ * Накапливает экшены и генерирует эффект по таймауту.
+ * @param timeout Время задержки в мс.
+ * @param types Массив с типами ожидаемых экшенов.
+ * @param task Генератор.
+ * @param deps Аргументы для генератора.
+ * @return Эффект.
+ */
+export function takeChain<
+  Deps extends any[],
+  Task extends (...someArgs: [...Deps, Action[]]) => any,
+>(timeout: number, types: string[], task: Task, ...deps: Deps) {
+  return fork(generateTakeChain as any, timeout, types, task, deps);
+}
+
+/**
+ * Генерирует эффект по таймауту.
+ * @param timeout Время задержки в мс.
+ * @param types Массив с типами ожидаемых экшенов.
+ * @param task Генератор.
+ * @param deps Аргументы для генератора.
+ */
+export function* generateTakeChain<
+  Deps extends any[],
+  Task extends (...someArgs: [...Deps, Action[]]) => any,
+>(timeout: number, types: string[], task: Task, deps: Deps): Generator<any, void, any> {
+  while (true) {
+    const breakAction: Action = { type: `BREAK_${Date.now()}` };
+    const firstAction: Action = yield take(types);
+    const collectedActions = [firstAction];
+
+    yield fork(putDelayed, timeout, breakAction);
+
+    while (true) {
+      const { action, canceled } = yield race({
+        action: take(types),
+        canceled: take(breakAction.type),
+      });
+
+      action && collectedActions.push(action);
+
+      if (
+        canceled ||
+        types.every(type => collectedActions.some(someAction => someAction.type === type))
+      ) {
+        // @todo убрать "as any"
+        yield fork(task as any, ...deps, collectedActions);
+        break;
+      }
+    }
+  }
+}
+
+/**
+ * Вызывает экшен с заданной задержкой.
+ * @param timeout Время задержки в мс.
+ * @param action Тип экшена.
+ */
+export function* putDelayed(timeout: number, action: Action) {
+  yield delay(timeout);
+  yield put(action);
+}

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

@@ -0,0 +1,246 @@
+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

@@ -0,0 +1,92 @@
+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

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,43 @@
+/**
+ * Возвращает скрипт инициализации удаленного модуля.
+ * @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.'));
+  }
+})`;
+}

package/cache/helpers.d.ts

@@ -1,4 +0,0 @@
-export function getOnConnectCallback(cache: Object): Function;
-export function getOnReconnectingCallback(cache: Object): Function;
-export function reconnectOnError({ code }: string): boolean;
-export function keyInLocalStorageExists(key: string): boolean;

package/cache/helpers.js

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.keyInLocalStorageExists = exports.reconnectOnError = exports.getOnReconnectingCallback = exports.getOnConnectCallback = void 0;
-const local_storage_1 = __importDefault(require("./local-storage"));
-/**
- * Создаёт обработчик события подключения к redis для установки статуса готовности кэша к работе.
- * @param {Object} cache Объект кэша.
- * @return {Function} Функция устанавливающая статус кэша.
- */
-const getOnConnectCallback = cache => () => cache.status = true;
-exports.getOnConnectCallback = getOnConnectCallback;
-/**
- * Создаёт обработчик события переподключения к redis для установки статуса готовности кэша к работе.
- * @param {Object} cache Объект кэша.
- * @return {Function} Функция устанавливающая статус кэша.
- */
-const getOnReconnectingCallback = cache => () => cache.status = false;
-exports.getOnReconnectingCallback = getOnReconnectingCallback;
-/**
- * Переподключение после ошибки.
- * @param {string} code Код ошибки.
- * @return {boolean} Сходится ли код ошибки с ECONNREFUSED.
- */
-const reconnectOnError = ({ code }) => {
-    const targetError = 'ECONNREFUSED';
-    return code === targetError;
-};
-exports.reconnectOnError = reconnectOnError;
-/**
- * Определяет есть ли в localStorage нужная информация.
- * @param {string} key Ключ.
- * @return {boolean} Признак наличия ключа.
- */
-const keyInLocalStorageExists = key => local_storage_1.default.status && key in localStorage;
-exports.keyInLocalStorageExists = keyInLocalStorageExists;
-//# sourceMappingURL=helpers.js.map

package/cache/helpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/cache/helpers.js"],"names":[],"mappings":";;;;;;AAAA,oEAAgD;AAEhD;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;AAA1D,QAAA,oBAAoB,wBAAsC;AAEvE;;;;GAIG;AACI,MAAM,yBAAyB,GAAG,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;AAAhE,QAAA,yBAAyB,6BAAuC;AAE7E;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IAC3C,MAAM,WAAW,GAAG,cAAc,CAAC;IACnC,OAAO,IAAI,KAAK,WAAW,CAAC;AAC9B,CAAC,CAAC;AAHW,QAAA,gBAAgB,oBAG3B;AAEF;;;;GAIG;AACI,MAAM,uBAAuB,GAAG,GAAG,CAAC,EAAE,CAAC,uBAAiB,CAAC,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC;AAAjF,QAAA,uBAAuB,2BAA0D"}