@tramvai/module-common 5.16.2 → 5.17.0

package/lib/command/commandLineRunner.new.js

@@ -0,0 +1,163 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var dippy = require('@tinkoff/dippy');
+var errors = require('@tinkoff/errors');
+var tokensCommon = require('@tramvai/tokens-common');
+var tokensCorePrivate = require('@tramvai/tokens-core-private');
+
+class CommandLineRunner {
+    constructor({ rootDi, lines, logger, plugins, hookFactory, executionContextManager, executionEndHandlers, }) {
+        this.executionContextByDi = new WeakMap();
+        this.abortControllerByDi = new WeakMap();
+        this.rootDi = rootDi;
+        this.lines = lines;
+        this.hookFactory = hookFactory;
+        this.plugins = plugins;
+        this.executionContextManager = executionContextManager;
+        this.executionEndHandlers = executionEndHandlers;
+        this.log = logger('command:command-line-runner');
+        this.runLineHook = this.hookFactory.createAsync('runLine');
+        this.runCommandHook = this.hookFactory.createAsync('runCommand');
+        this.runCommandFnHook = this.hookFactory.createAsync('runCommandFn');
+        this.runLineHook.tapPromise('commandLineRunner', async (_, { env, line, di, key }) => {
+            const commands = this.lines[env][line];
+            const timingInfo = {};
+            di.register({ provide: tokensCorePrivate.COMMAND_LINE_TIMING_INFO_TOKEN, useValue: timingInfo });
+            this.log.debug({
+                event: 'command-run',
+                type: env,
+                status: line,
+            });
+            try {
+                for (const command of commands) {
+                    // emulate old `CommandLineRunner` behavior, important for race conditions at client-side,
+                    // when new line executes in the middle of current line, and we need cleanup current line before
+                    await Promise.resolve();
+                    await this.runCommandHook.callPromise({
+                        env,
+                        line,
+                        di,
+                        command,
+                    });
+                }
+            }
+            finally {
+                this.executionContextByDi.delete(di);
+                this.abortControllerByDi.delete(di);
+                for (const executionEndHandler of this.executionEndHandlers) {
+                    executionEndHandler(di, env, line, timingInfo, key);
+                }
+            }
+        });
+        this.runCommandHook.tapPromise('commandLineRunner', async (_, { env, line, di, command }) => {
+            const commands = di.get({ token: command, optional: true });
+            if (!commands) {
+                return;
+            }
+            const rootExecutionContext = di.get({ token: tokensCommon.ROOT_EXECUTION_CONTEXT_TOKEN, optional: true });
+            const timingInfo = di.get(tokensCorePrivate.COMMAND_LINE_TIMING_INFO_TOKEN);
+            const commandName = command.toString();
+            timingInfo[commandName] = { start: performance.now() };
+            return this.executionContextManager
+                .withContext(rootExecutionContext, `command-line:${commandName}`, async (executionContext, abortController) => {
+                this.executionContextByDi.set(di, executionContext);
+                this.abortControllerByDi.set(di, abortController);
+                if (!Array.isArray(commands)) {
+                    await this.runCommandFnHook.callPromise({ fn: commands, line, command, di });
+                }
+                else {
+                    await Promise.all(commands.map((fn) => {
+                        return this.runCommandFnHook.callPromise({ fn, line, command, di });
+                    }));
+                }
+            })
+                .finally(() => {
+                timingInfo[commandName].end = performance.now();
+            });
+        });
+        this.runCommandFnHook.tapPromise('commandLineRunner', async (_, { fn, command, di }) => {
+            try {
+                await this.executeCommand(fn, command, di);
+            }
+            catch (error) {
+                // in case if any error happens during line execution results from other line handlers will not be used anyway
+                this.abortControllerByDi
+                    .get(di)
+                    ?.abort('Execution context were aborted because of one of the commands failed');
+                throw error;
+            }
+        });
+        this.plugins?.forEach((plugin) => {
+            plugin.apply(this);
+        });
+    }
+    async run(env, line, providers, customDi, key) {
+        const di = customDi ?? this.resolveDi(env, line, this.rootDi, providers);
+        await this.runLineHook.callPromise({ env, line, di, key });
+        return di;
+    }
+    resolveDi(env, line, rootDi, providers) {
+        let di = rootDi;
+        if (env === 'server' && line === 'customer') {
+            di = dippy.createChildContainer(di);
+        }
+        if (providers) {
+            providers.forEach((item) => {
+                return di.register(item);
+            });
+        }
+        return di;
+    }
+    resolveExecutionContextFromDi(di) {
+        return this.executionContextByDi.get(di) ?? null;
+    }
+    async executeCommand(command, commandToken, di) {
+        const commandName = commandToken.toString();
+        if (!(command instanceof Function)) {
+            const error = new TypeError(`Expected function in line processing "commandLineListTokens.${commandName}", received "${command}".
+      Check that all commandLineListTokens providers return functions`);
+            if (process.env.NODE_ENV !== 'production') {
+                const commands = di.get(commandToken);
+                const record = di.getRecord(commandToken.name);
+                // need to find stack trace from this specific token provider
+                for (let i = 0; i < commands.length; i++) {
+                    if (commands[i] === command) {
+                        // @ts-expect-error
+                        error.stack = `${error.stack}\n---- caused by: ----\n${record.multi[i].stack || ''}`;
+                    }
+                }
+            }
+            this.log.error({
+                event: 'line-error',
+                error,
+                line: commandName,
+            });
+            return;
+        }
+        const { name = '' } = command;
+        this.log.debug({
+            event: 'line-run',
+            line: commandName,
+            command: name,
+        });
+        try {
+            await command();
+        }
+        catch (error) {
+            this.log[errors.isSilentError(error) ? 'debug' : 'error']({
+                event: 'line-error',
+                error,
+                line: commandName,
+                command: name,
+            });
+            if (typeof error === 'object') {
+                error.di = di;
+            }
+            throw error;
+        }
+    }
+}
+
+exports.CommandLineRunner = CommandLineRunner;

package/lib/hook/HookModule.browser.js

@@ -0,0 +1,22 @@
+import { declareModule, provide, Scope } from '@tinkoff/dippy';
+import { TAPABLE_HOOK_FACTORY_TOKEN } from '@tramvai/core';
+import { TapableHooks, Hooks } from '@tinkoff/hook-runner';
+import { HOOK_TOKEN } from '@tramvai/tokens-common';
+
+const TramvaiHookModule = declareModule({
+    name: 'TramvaiHookModule',
+    providers: [
+        provide({
+            provide: TAPABLE_HOOK_FACTORY_TOKEN,
+            scope: Scope.SINGLETON,
+            useClass: TapableHooks,
+        }),
+        provide({
+            provide: HOOK_TOKEN,
+            scope: Scope.SINGLETON,
+            useClass: Hooks,
+        }),
+    ],
+});
+
+export { TramvaiHookModule };

package/lib/hook/HookModule.d.ts

@@ -0,0 +1,4 @@
+export declare const TramvaiHookModule: import("@tinkoff/dippy/lib/modules/module.h").ModuleClass & Partial<import("@tinkoff/dippy/lib/modules/module.h").ModuleSecretParameters> & {
+    [x: string]: (...args: any[]) => import("@tinkoff/dippy").ModuleType;
+};
+//# sourceMappingURL=HookModule.d.ts.map

package/lib/hook/HookModule.es.js

@@ -0,0 +1,22 @@
+import { declareModule, provide, Scope } from '@tinkoff/dippy';
+import { TAPABLE_HOOK_FACTORY_TOKEN } from '@tramvai/core';
+import { TapableHooks, Hooks } from '@tinkoff/hook-runner';
+import { HOOK_TOKEN } from '@tramvai/tokens-common';
+
+const TramvaiHookModule = declareModule({
+    name: 'TramvaiHookModule',
+    providers: [
+        provide({
+            provide: TAPABLE_HOOK_FACTORY_TOKEN,
+            scope: Scope.SINGLETON,
+            useClass: TapableHooks,
+        }),
+        provide({
+            provide: HOOK_TOKEN,
+            scope: Scope.SINGLETON,
+            useClass: Hooks,
+        }),
+    ],
+});
+
+export { TramvaiHookModule };

package/lib/hook/HookModule.js

@@ -0,0 +1,26 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var dippy = require('@tinkoff/dippy');
+var core = require('@tramvai/core');
+var hookRunner = require('@tinkoff/hook-runner');
+var tokensCommon = require('@tramvai/tokens-common');
+
+const TramvaiHookModule = dippy.declareModule({
+    name: 'TramvaiHookModule',
+    providers: [
+        dippy.provide({
+            provide: core.TAPABLE_HOOK_FACTORY_TOKEN,
+            scope: dippy.Scope.SINGLETON,
+            useClass: hookRunner.TapableHooks,
+        }),
+        dippy.provide({
+            provide: tokensCommon.HOOK_TOKEN,
+            scope: dippy.Scope.SINGLETON,
+            useClass: hookRunner.Hooks,
+        }),
+    ],
+});
+
+exports.TramvaiHookModule = TramvaiHookModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-common",
-  "version": "5.16.2",
+  "version": "5.17.0",
   "description": "",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -32,34 +32,34 @@
   "dependencies": {
     "@akashbabu/lfu-cache": "1.0.2",
     "@tinkoff/errors": "0.6.2",
-    "@tinkoff/hook-runner": "0.7.2",
+    "@tinkoff/hook-runner": "0.7.3",
     "@tinkoff/lru-cache-nano": "^7.9.0",
     "@tinkoff/pubsub": "0.8.2",
     "@tinkoff/url": "0.11.2",
-    "@tramvai/experiments": "5.16.2",
-    "@tramvai/module-cookie": "5.16.2",
-    "@tramvai/module-environment": "5.16.2",
-    "@tramvai/module-log": "5.16.2",
+    "@tramvai/experiments": "5.17.0",
+    "@tramvai/module-cookie": "5.17.0",
+    "@tramvai/module-environment": "5.17.0",
+    "@tramvai/module-log": "5.17.0",
     "@tramvai/safe-strings": "0.8.4",
-    "@tramvai/tokens-child-app": "5.16.2",
-    "@tramvai/tokens-common": "5.16.2",
-    "@tramvai/tokens-core-private": "5.16.2",
-    "@tramvai/tokens-metrics": "5.16.2",
-    "@tramvai/tokens-render": "5.16.2",
-    "@tramvai/tokens-router": "5.16.2",
-    "@tramvai/tokens-server-private": "5.16.2",
-    "@tramvai/types-actions-state-context": "5.16.2",
+    "@tramvai/tokens-child-app": "5.17.0",
+    "@tramvai/tokens-common": "5.17.0",
+    "@tramvai/tokens-core-private": "5.17.0",
+    "@tramvai/tokens-metrics": "5.17.0",
+    "@tramvai/tokens-render": "5.17.0",
+    "@tramvai/tokens-router": "5.17.0",
+    "@tramvai/tokens-server-private": "5.17.0",
+    "@tramvai/types-actions-state-context": "5.17.0",
     "hoist-non-react-statics": "^3.3.1"
   },
   "peerDependencies": {
     "@tinkoff/dippy": "0.11.3",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/cli": "5.16.2",
-    "@tramvai/core": "5.16.2",
-    "@tramvai/papi": "5.16.2",
-    "@tramvai/react": "5.16.2",
-    "@tramvai/state": "5.16.2",
-    "@tramvai/tokens-server": "5.16.2",
+    "@tramvai/cli": "5.17.0",
+    "@tramvai/core": "5.17.0",
+    "@tramvai/papi": "5.17.0",
+    "@tramvai/react": "5.17.0",
+    "@tramvai/state": "5.17.0",
+    "@tramvai/tokens-server": "5.17.0",
     "react": ">=16.14.0",
     "tslib": "^2.4.0"
   },

package/lib/command/commandLineRunner.browser.js

@@ -1,145 +0,0 @@
-import { isSilentError } from '@tinkoff/errors';
-import { COMMAND_LINE_TIMING_INFO_TOKEN } from '@tramvai/tokens-core-private';
-import { createChildContainer } from '@tinkoff/dippy';
-import { ROOT_EXECUTION_CONTEXT_TOKEN } from '@tramvai/tokens-common';
-
-class CommandLineRunner {
-    constructor({ lines, rootDi, logger, executionContextManager, executionEndHandlers }) {
-        this.executionContextByDi = new WeakMap();
-        this.abortControllerByDi = new WeakMap();
-        this.lines = lines;
-        this.rootDi = rootDi;
-        this.log = logger('command:command-line-runner');
-        this.executionContextManager = executionContextManager;
-        this.executionEndHandlers = executionEndHandlers;
-    }
-    run(type, status, providers, customDi, key) {
-        const di = customDi ?? this.resolveDi(type, status, this.rootDi, providers);
-        const rootExecutionContext = di.get({ token: ROOT_EXECUTION_CONTEXT_TOKEN, optional: true });
-        this.log.debug({
-            event: 'command-run',
-            type,
-            status,
-        });
-        const timingInfo = {};
-        di.register({ provide: COMMAND_LINE_TIMING_INFO_TOKEN, useValue: timingInfo });
-        return (this.lines[type][status]
-            .reduce((chain, line) => {
-            return chain.then(() => {
-                const lineName = line.toString();
-                timingInfo[lineName] = { start: performance.now() };
-                // eslint-disable-next-line promise/no-nesting
-                return Promise.resolve()
-                    .then(() => {
-                    return this.executionContextManager.withContext(rootExecutionContext, `command-line:${lineName}`, async (executionContext, abortController) => {
-                        this.executionContextByDi.set(di, executionContext);
-                        this.abortControllerByDi.set(di, abortController);
-                        await this.createLineChain(di, line);
-                    });
-                })
-                    .finally(() => {
-                    timingInfo[lineName].end = performance.now();
-                });
-            });
-        }, Promise.resolve())
-            // После завершения цепочки отдаем context выполнения
-            .finally(() => {
-            this.executionContextByDi.delete(di);
-            this.abortControllerByDi.delete(di);
-            if (this.executionEndHandlers) {
-                for (const executionEndHandler of this.executionEndHandlers) {
-                    executionEndHandler(di, type, status, timingInfo, key);
-                }
-            }
-        })
-            .then(() => di));
-    }
-    resolveDi(type, status, rootDi, providers) {
-        let di = rootDi;
-        if (status === 'customer' && type !== 'client') {
-            di = createChildContainer(di);
-        }
-        if (providers) {
-            providers.forEach((item) => {
-                return di.register(item);
-            });
-        }
-        return di;
-    }
-    resolveExecutionContextFromDi(di) {
-        return this.executionContextByDi.get(di) ?? null;
-    }
-    createLineChain(di, line) {
-        let lineInstance;
-        try {
-            lineInstance = di.get({ token: line, optional: true });
-            // Пропускаем step. Так как нет действий
-            if (lineInstance === null) {
-                return Promise.resolve();
-            }
-        }
-        catch (e) {
-            // Логируем ошибку и дальше падаем
-            this.log.error(e);
-            return this.throwError(e, di);
-        }
-        if (!Array.isArray(lineInstance)) {
-            return this.instanceExecute(lineInstance, line, di);
-        }
-        return Promise.all(lineInstance.map((instance) => {
-            return this.instanceExecute(instance, line, di);
-        }));
-    }
-    instanceExecute(instance, line, di) {
-        if (!(instance instanceof Function)) {
-            const error = new TypeError(`Expected function in line processing "commandLineListTokens.${line.toString()}", received "${instance}".
-      Check that all commandLineListTokens subscribers return functions`);
-            if (process.env.NODE_ENV !== 'production') {
-                const instances = di.get(line);
-                const record = di.getRecord(line.toString());
-                // пробегаемся по всем инстансам и для текущего получаем его запись, из которой можно получить стек
-                for (let i = 0; i < instances.length; i++) {
-                    if (instances[i] === instance) {
-                        // @ts-expect-error
-                        error.stack = `${error.stack}\n---- caused by: ----\n${record.multi[i].stack || ''}`;
-                    }
-                }
-            }
-            this.log.error({
-                event: 'line-error',
-                error,
-                line: line.toString(),
-            });
-            return;
-        }
-        const { name = '' } = instance;
-        this.log.debug({
-            event: 'line-run',
-            line: line.toString(),
-            command: name,
-        });
-        return Promise.resolve()
-            .then(() => instance())
-            .catch((err) => {
-            this.log[isSilentError(err) ? 'debug' : 'error']({
-                event: 'line-error',
-                error: err,
-                line: line.toString(),
-                command: name,
-            });
-            // in case if any error happens during line execution results from other line handlers will not be used anyway
-            this.abortControllerByDi.get(di)?.abort(err);
-            this.throwError(err, di);
-        });
-    }
-    // eslint-disable-next-line class-methods-use-this
-    throwError(err, di) {
-        if (typeof err === 'object') {
-            // eslint-disable-next-line no-param-reassign
-            err.di = di;
-        }
-        throw err;
-    }
-}
-
-export { CommandLineRunner };

package/lib/command/commandLineRunner.es.js

@@ -1,145 +0,0 @@
-import { isSilentError } from '@tinkoff/errors';
-import { COMMAND_LINE_TIMING_INFO_TOKEN } from '@tramvai/tokens-core-private';
-import { createChildContainer } from '@tinkoff/dippy';
-import { ROOT_EXECUTION_CONTEXT_TOKEN } from '@tramvai/tokens-common';
-
-class CommandLineRunner {
-    constructor({ lines, rootDi, logger, executionContextManager, executionEndHandlers }) {
-        this.executionContextByDi = new WeakMap();
-        this.abortControllerByDi = new WeakMap();
-        this.lines = lines;
-        this.rootDi = rootDi;
-        this.log = logger('command:command-line-runner');
-        this.executionContextManager = executionContextManager;
-        this.executionEndHandlers = executionEndHandlers;
-    }
-    run(type, status, providers, customDi, key) {
-        const di = customDi ?? this.resolveDi(type, status, this.rootDi, providers);
-        const rootExecutionContext = di.get({ token: ROOT_EXECUTION_CONTEXT_TOKEN, optional: true });
-        this.log.debug({
-            event: 'command-run',
-            type,
-            status,
-        });
-        const timingInfo = {};
-        di.register({ provide: COMMAND_LINE_TIMING_INFO_TOKEN, useValue: timingInfo });
-        return (this.lines[type][status]
-            .reduce((chain, line) => {
-            return chain.then(() => {
-                const lineName = line.toString();
-                timingInfo[lineName] = { start: performance.now() };
-                // eslint-disable-next-line promise/no-nesting
-                return Promise.resolve()
-                    .then(() => {
-                    return this.executionContextManager.withContext(rootExecutionContext, `command-line:${lineName}`, async (executionContext, abortController) => {
-                        this.executionContextByDi.set(di, executionContext);
-                        this.abortControllerByDi.set(di, abortController);
-                        await this.createLineChain(di, line);
-                    });
-                })
-                    .finally(() => {
-                    timingInfo[lineName].end = performance.now();
-                });
-            });
-        }, Promise.resolve())
-            // После завершения цепочки отдаем context выполнения
-            .finally(() => {
-            this.executionContextByDi.delete(di);
-            this.abortControllerByDi.delete(di);
-            if (this.executionEndHandlers) {
-                for (const executionEndHandler of this.executionEndHandlers) {
-                    executionEndHandler(di, type, status, timingInfo, key);
-                }
-            }
-        })
-            .then(() => di));
-    }
-    resolveDi(type, status, rootDi, providers) {
-        let di = rootDi;
-        if (status === 'customer' && type !== 'client') {
-            di = createChildContainer(di);
-        }
-        if (providers) {
-            providers.forEach((item) => {
-                return di.register(item);
-            });
-        }
-        return di;
-    }
-    resolveExecutionContextFromDi(di) {
-        return this.executionContextByDi.get(di) ?? null;
-    }
-    createLineChain(di, line) {
-        let lineInstance;
-        try {
-            lineInstance = di.get({ token: line, optional: true });
-            // Пропускаем step. Так как нет действий
-            if (lineInstance === null) {
-                return Promise.resolve();
-            }
-        }
-        catch (e) {
-            // Логируем ошибку и дальше падаем
-            this.log.error(e);
-            return this.throwError(e, di);
-        }
-        if (!Array.isArray(lineInstance)) {
-            return this.instanceExecute(lineInstance, line, di);
-        }
-        return Promise.all(lineInstance.map((instance) => {
-            return this.instanceExecute(instance, line, di);
-        }));
-    }
-    instanceExecute(instance, line, di) {
-        if (!(instance instanceof Function)) {
-            const error = new TypeError(`Expected function in line processing "commandLineListTokens.${line.toString()}", received "${instance}".
-      Check that all commandLineListTokens subscribers return functions`);
-            if (process.env.NODE_ENV !== 'production') {
-                const instances = di.get(line);
-                const record = di.getRecord(line.toString());
-                // пробегаемся по всем инстансам и для текущего получаем его запись, из которой можно получить стек
-                for (let i = 0; i < instances.length; i++) {
-                    if (instances[i] === instance) {
-                        // @ts-expect-error
-                        error.stack = `${error.stack}\n---- caused by: ----\n${record.multi[i].stack || ''}`;
-                    }
-                }
-            }
-            this.log.error({
-                event: 'line-error',
-                error,
-                line: line.toString(),
-            });
-            return;
-        }
-        const { name = '' } = instance;
-        this.log.debug({
-            event: 'line-run',
-            line: line.toString(),
-            command: name,
-        });
-        return Promise.resolve()
-            .then(() => instance())
-            .catch((err) => {
-            this.log[isSilentError(err) ? 'debug' : 'error']({
-                event: 'line-error',
-                error: err,
-                line: line.toString(),
-                command: name,
-            });
-            // in case if any error happens during line execution results from other line handlers will not be used anyway
-            this.abortControllerByDi.get(di)?.abort(err);
-            this.throwError(err, di);
-        });
-    }
-    // eslint-disable-next-line class-methods-use-this
-    throwError(err, di) {
-        if (typeof err === 'object') {
-            // eslint-disable-next-line no-param-reassign
-            err.di = di;
-        }
-        throw err;
-    }
-}
-
-export { CommandLineRunner };