@tramvai/module-common 2.7.0 → 2.11.0

package/lib/index.es.js

@@ -1,12 +1,12 @@
 import { __decorate } from 'tslib';
 import eachObj from '@tinkoff/utils/object/each';
-import { createBundle, Scope, Module, commandLineListTokens, COMMAND_LINE_RUNNER_TOKEN, COMMAND_LINES_TOKEN, DI_TOKEN, ACTION_PARAMETERS, ACTIONS_LIST_TOKEN, provide, IS_DI_CHILD_CONTAINER_TOKEN, BUNDLE_LIST_TOKEN } from '@tramvai/core';
+import { createBundle, Scope, Module, commandLineListTokens, COMMAND_LINE_RUNNER_TOKEN, COMMAND_LINES_TOKEN, DI_TOKEN, isTramvaiAction, ACTION_PARAMETERS, ACTIONS_LIST_TOKEN, provide as provide$1, IS_DI_CHILD_CONTAINER_TOKEN, BUNDLE_LIST_TOKEN } from '@tramvai/core';
 import { EnvironmentModule } from '@tramvai/module-environment';
 import { CookieModule } from '@tramvai/module-cookie';
 export { COOKIE_MANAGER_TOKEN } from '@tramvai/module-cookie';
 import { LogModule } from '@tramvai/module-log';
 import { Hooks } from '@tinkoff/hook-runner';
-import { REQUEST_MANAGER_TOKEN, REQUEST, COMBINE_REDUCERS, CONTEXT_TOKEN, RESPONSE_MANAGER_TOKEN, RESPONSE, ACTION_EXECUTION_TOKEN, LOGGER_TOKEN, PUBSUB_FACTORY_TOKEN, PUBSUB_TOKEN, ROOT_PUBSUB_TOKEN, ACTION_REGISTRY_TOKEN, ACTION_CONDITIONALS, STORE_TOKEN, ACTION_PAGE_RUNNER_TOKEN, DISPATCHER_TOKEN, DISPATCHER_CONTEXT_TOKEN, STORE_MIDDLEWARE, INITIAL_APP_STATE_TOKEN, CLEAR_CACHE_TOKEN, CREATE_CACHE_TOKEN, REGISTER_CLEAR_CACHE_TOKEN, HOOK_TOKEN, COMPONENT_REGISTRY_TOKEN, BUNDLE_MANAGER_TOKEN, ADDITIONAL_BUNDLE_TOKEN } from '@tramvai/tokens-common';
+import { REQUEST_MANAGER_TOKEN, REQUEST, COMBINE_REDUCERS, CONTEXT_TOKEN, RESPONSE_MANAGER_TOKEN, RESPONSE, ACTION_EXECUTION_TOKEN, ROOT_EXECUTION_CONTEXT_TOKEN, LOGGER_TOKEN, EXECUTION_CONTEXT_MANAGER_TOKEN, COMMAND_LINE_EXECUTION_CONTEXT_TOKEN, PUBSUB_FACTORY_TOKEN, PUBSUB_TOKEN, ROOT_PUBSUB_TOKEN, ACTION_REGISTRY_TOKEN, ACTION_CONDITIONALS, STORE_TOKEN, ACTION_PAGE_RUNNER_TOKEN, DISPATCHER_TOKEN, DISPATCHER_CONTEXT_TOKEN, STORE_MIDDLEWARE, INITIAL_APP_STATE_TOKEN, CLEAR_CACHE_TOKEN, CREATE_CACHE_TOKEN, REGISTER_CLEAR_CACHE_TOKEN, HOOK_TOKEN, COMPONENT_REGISTRY_TOKEN, BUNDLE_MANAGER_TOKEN, ADDITIONAL_BUNDLE_TOKEN } from '@tramvai/tokens-common';
 export * from '@tramvai/tokens-common';
 import { __lazyErrorHandler } from '@tramvai/react';
 import { fileSystemPagesEnabled, getAllFileSystemPages, isFileSystemPageComponent } from '@tramvai/experiments';
@@ -18,9 +18,9 @@ import { format } from '@tinkoff/url';
 import isEmpty from '@tinkoff/utils/is/empty';
 import values from '@tinkoff/utils/object/values';
 import { METRICS_MODULE_TOKEN } from '@tramvai/tokens-metrics';
-import { createChildContainer, Scope as Scope$1, createToken } from '@tinkoff/dippy';
+import { createChildContainer, provide, Scope as Scope$1, createToken } from '@tinkoff/dippy';
 import noop from '@tinkoff/utils/function/noop';
-import { isSilentError } from '@tinkoff/errors';
+import { isSilentError, ConditionFailError, ExecutionAbortError } from '@tinkoff/errors';
 import { PubSub } from '@tinkoff/pubsub';
 import identity from '@tinkoff/utils/function/identity';
 import objectMap from '@tinkoff/utils/object/map';
@@ -30,6 +30,7 @@ import toArray from '@tinkoff/utils/array/toArray';
 import LRU from '@tinkoff/lru-cache-nano';
 import { SERVER_MODULE_PAPI_PRIVATE_ROUTE } from '@tramvai/tokens-server';
 import { createPapiMethod } from '@tramvai/papi';
+import { AbortController } from 'node-abort-controller';
 import { jsx } from 'react/jsx-runtime';
 import { EXTEND_RENDER } from '@tramvai/tokens-render';
 import { CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN, commandLineListTokens as commandLineListTokens$1 } from '@tramvai/tokens-child-app';
@@ -375,14 +376,17 @@ const resolveDi = (type, status, diContainer, providers) => {
     return di;
 };
 class CommandLineRunner {
-    constructor({ lines, rootDi, logger, metrics, }) {
+    constructor({ lines, rootDi, logger, metrics, executionContextManager, }) {
+        this.executionContextByDi = new WeakMap();
         this.lines = lines;
         this.rootDi = rootDi;
         this.log = logger('command:command-line-runner');
         this.metrics = metrics;
+        this.executionContextManager = executionContextManager;
     }
     run(type, status, providers, customDi) {
         const di = customDi !== null && customDi !== void 0 ? customDi : resolveDi(type, status, this.rootDi, providers);
+        const rootExecutionContext = di.get({ token: ROOT_EXECUTION_CONTEXT_TOKEN, optional: true });
         this.log.debug({
             event: 'command-run',
             type,
@@ -394,13 +398,25 @@ class CommandLineRunner {
                 const doneMetric = this.createDurationMetric();
                 // eslint-disable-next-line promise/no-nesting
                 return Promise.resolve()
-                    .then(() => this.createLineChain(di, line))
+                    .then(() => {
+                    return this.executionContextManager.withContext(rootExecutionContext, `command-line:${line.toString()}`, async (executionContext) => {
+                        this.executionContextByDi.set(di, executionContext);
+                        await this.createLineChain(di, line);
+                    });
+                })
                     .finally(() => doneMetric({ line: line.toString() }));
             });
         }, Promise.resolve())
             // После завершения цепочки отдаем context выполнения
+            .finally(() => {
+            this.executionContextByDi.delete(di);
+        })
             .then(() => di));
     }
+    resolveExecutionContextFromDi(di) {
+        var _a;
+        return (_a = this.executionContextByDi.get(di)) !== null && _a !== void 0 ? _a : null;
+    }
     createLineChain(di, line) {
         let lineInstance;
         try {
@@ -511,7 +527,7 @@ let CommandModule = class CommandModule {
 CommandModule = __decorate([
     Module({
         providers: [
-            {
+            provide({
                 // Раннер процессов
                 provide: COMMAND_LINE_RUNNER_TOKEN,
                 scope: Scope$1.SINGLETON,
@@ -524,14 +540,27 @@ CommandModule = __decorate([
                         token: METRICS_MODULE_TOKEN,
                         optional: true,
                     },
+                    executionContextManager: EXECUTION_CONTEXT_MANAGER_TOKEN,
                 },
-            },
-            {
+            }),
+            provide({
+                provide: COMMAND_LINE_EXECUTION_CONTEXT_TOKEN,
+                useFactory: ({ di, commandLineRunner, }) => {
+                    return () => {
+                        return commandLineRunner.resolveExecutionContextFromDi(di);
+                    };
+                },
+                deps: {
+                    di: DI_TOKEN,
+                    commandLineRunner: COMMAND_LINE_RUNNER_TOKEN,
+                },
+            }),
+            provide({
                 // Дефолтный список команл
                 provide: COMMAND_LINES_TOKEN,
                 scope: Scope$1.SINGLETON,
                 useValue: lines$1,
-            },
+            }),
         ],
     })
 ], CommandModule);
@@ -583,14 +612,19 @@ const actionTramvaiReducer = createReducer('actionTramvai', initalState).on(acti
     serverState: payload,
 }));
 
+/**
+ * @deprecated only for compatibility with legacy createAction
+ */
 const actionType = {
     global: 'global',
     local: 'local',
 };
 
+const DEFAULT_CONDITIONS = {};
 class ActionChecker {
     // eslint-disable-next-line max-params
     constructor(globalConditionals, payload, parameters, executionState, type) {
+        var _a;
         this.globalConditionals = globalConditionals;
         this.payload = payload;
         this.parameters = parameters;
@@ -604,7 +638,7 @@ class ActionChecker {
             // если экшен был уже выполнен, то считаем, что его не нужно больше выполнять
             this.status = executionState.status !== 'success';
         }
-        this.conditions = parameters.conditions;
+        this.conditions = (_a = parameters.conditions) !== null && _a !== void 0 ? _a : DEFAULT_CONDITIONS;
     }
     check() {
         this.globalConditionals.forEach((filter) => {
@@ -634,12 +668,16 @@ class ActionChecker {
     }
 }
 
+const EMPTY_DEPS = {};
+const DEFAULT_PAYLOAD = {};
 const getParameters = (action) => action[ACTION_PARAMETERS];
 class ActionExecution {
-    constructor({ actionConditionals, store, context, di, transformAction, }) {
+    constructor({ store, context, di, executionContextManager, actionConditionals, transformAction, }) {
         this.actionConditionals = flatten(actionConditionals !== null && actionConditionals !== void 0 ? actionConditionals : []);
         this.context = context;
+        this.store = store;
         this.di = di;
+        this.executionContextManager = executionContextManager;
         this.execution = new Map();
         this.transformAction = transformAction || identity;
         const initialState = store.getState(actionTramvaiReducer);
@@ -649,32 +687,63 @@ class ActionExecution {
             }, initialState.serverState);
         }
     }
-    run(action, payload, type = actionType.local) {
-        // TODO выпилить после перевода всех экшенов к виду Action
-        this.transformAction(action);
-        const parameters = getParameters(action);
-        const executionState = this.getExecutionState(parameters);
+    async runInContext(executionContext, action, ...params) {
+        var _a;
+        let parameters;
+        const payload = (_a = params[0]) !== null && _a !== void 0 ? _a : DEFAULT_PAYLOAD;
+        // TODO: replace type with pure context usage
+        const type = (executionContext === null || executionContext === void 0 ? void 0 : executionContext.values.pageActions) === true ? actionType.global : actionType.local;
+        // TODO: remove else branch after migration to new declareAction
+        if (isTramvaiAction(action)) {
+            parameters = action;
+        }
+        else {
+            this.transformAction(action);
+            parameters = getParameters(action);
+        }
+        const executionState = this.getExecutionState(parameters.name);
         if (!this.canExecuteAction(payload, parameters, executionState, type)) {
-            return Promise.resolve();
+            switch (parameters.conditionsFailResult) {
+                case 'reject':
+                    // TODO: pass condition that has failed
+                    return Promise.reject(new ConditionFailError());
+                default:
+                    return Promise.resolve();
+            }
         }
-        const deps = parameters.deps ? this.di.getOfDeps(parameters.deps) : {};
         executionState.status = 'pending';
-        return Promise.resolve()
-            .then(() => action(this.context, payload, deps))
-            .then((data) => {
-            executionState.status = 'success';
-            return data;
-        })
-            .catch((err) => {
-            executionState.status = 'failed';
-            throw err;
+        return this.executionContextManager.withContext(executionContext, {
+            name: parameters.name,
+            values: (executionContext === null || executionContext === void 0 ? void 0 : executionContext.values.pageActions) === true ? { pageActions: false } : undefined,
+        }, (executionActionContext) => {
+            const context = this.createActionContext(executionContext, executionActionContext, parameters);
+            return Promise.resolve()
+                .then(() => {
+                // TODO: do not execute action if context.abortSignal is aborted
+                if (isTramvaiAction(action)) {
+                    return action.fn.apply(context, params);
+                }
+                return action(this.context, payload, context.deps);
+            })
+                .then((data) => {
+                executionState.status = 'success';
+                return data;
+            })
+                .catch((err) => {
+                executionState.status = 'failed';
+                throw err;
+            });
         });
     }
-    getExecutionState(parameters) {
-        let executionState = this.execution.get(parameters.name);
+    async run(action, ...params) {
+        return this.runInContext(null, action, ...params);
+    }
+    getExecutionState(name) {
+        let executionState = this.execution.get(name);
+        // TODO: probably do not need to create executionState on client as it is not used
         if (!executionState) {
             executionState = { status: 'pending', state: {} };
-            this.execution.set(parameters.name, executionState);
+            this.execution.set(name, executionState);
         }
         return executionState;
     }
@@ -682,6 +751,16 @@ class ActionExecution {
         const actionChecker = new ActionChecker(this.actionConditionals, payload, parameters, executionState, type);
         return actionChecker.check();
     }
+    createActionContext(parentExecutionContext, actionExecutionContext, parameters) {
+        return {
+            abortSignal: actionExecutionContext === null || actionExecutionContext === void 0 ? void 0 : actionExecutionContext.abortSignal,
+            executeAction: this.runInContext.bind(this, actionExecutionContext),
+            deps: parameters.deps ? this.di.getOfDeps(parameters.deps) : EMPTY_DEPS,
+            actionType: (parentExecutionContext === null || parentExecutionContext === void 0 ? void 0 : parentExecutionContext.values.pageActions) ? 'page' : 'standalone',
+            dispatch: this.store.dispatch,
+            getState: this.store.getState,
+        };
+    }
 }
 
 const GLOBAL_PARAMETER = '@@global';
@@ -711,56 +790,59 @@ class ActionRegistry {
     }
 }
 
-const payload = {};
 class ActionPageRunner {
-    constructor({ store, actionExecution, limitTime, logger }) {
-        this.store = store;
-        this.actionExecution = actionExecution;
-        this.limitTime = limitTime;
-        this.log = logger('action:action-page-runner');
+    constructor(deps) {
+        this.deps = deps;
+        this.log = deps.logger('action:action-page-runner');
     }
     // TODO stopRunAtError нужен только для редиректов на стороне сервера в экшенах. И нужно пересмотреть реализацию редиректов
     runActions(actions, stopRunAtError = () => false) {
-        return new Promise((resolve, reject) => {
-            const timeoutMarker = setTimeout(() => {
-                this.log.warn(`page actions has exceeded timeout of ${this.limitTime}ms, ignore some results of execution`);
-                // eslint-disable-next-line @typescript-eslint/no-use-before-define
-                endChecker();
-            }, this.limitTime);
-            const endChecker = () => {
-                clearTimeout(timeoutMarker);
-                const result = {};
-                this.actionExecution.execution.forEach((value, key) => {
-                    // достаем значения экшенов, которые успешно выполнились, остальные выполнятся на клиенте
-                    if (value.status === 'success') {
-                        result[key] = value;
-                    }
-                });
-                this.syncStateActions(result);
-                resolve();
-            };
-            const actionMapper = (action) => {
-                return Promise.resolve()
-                    .then(() => this.actionExecution.run(action, payload, actionType.global))
-                    .catch((error) => {
-                    const parameters = action[ACTION_PARAMETERS];
-                    this.log.error({
-                        error,
-                        event: `action-execution-error`,
-                        message: `${parameters.name} execution error`,
+        return this.deps.executionContextManager.withContext(this.deps.commandLineExecutionContext(), { name: 'pageActions', values: { pageActions: true } }, (executionContext, abortController) => {
+            return new Promise((resolve, reject) => {
+                const timeoutMarker = setTimeout(() => {
+                    this.log.warn(`page actions has exceeded timeout of ${this.deps.limitTime}ms, ignore some results of execution`);
+                    abortController.abort();
+                    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+                    endChecker();
+                }, this.deps.limitTime);
+                const endChecker = () => {
+                    clearTimeout(timeoutMarker);
+                    const result = {};
+                    // TODO: dehydrate only actions on first level as inner actions are running on client despite their execution on server
+                    this.deps.actionExecution.execution.forEach((value, key) => {
+                        // достаем значения экшенов, которые успешно выполнились, остальные выполнятся на клиенте
+                        if (value.status === 'success') {
+                            result[key] = value;
+                        }
                     });
-                    if (stopRunAtError(error)) {
-                        clearTimeout(timeoutMarker);
-                        reject(error);
-                    }
-                });
-            };
-            // eslint-disable-next-line promise/catch-or-return
-            Promise.all(actions.map(actionMapper)).then(endChecker);
+                    this.syncStateActions(result);
+                    resolve();
+                };
+                const actionMapper = (action) => {
+                    return Promise.resolve()
+                        .then(() => this.deps.actionExecution.runInContext(executionContext, action))
+                        .catch((error) => {
+                        if (!isSilentError(error)) {
+                            const parameters = isTramvaiAction(action) ? action : action[ACTION_PARAMETERS];
+                            this.log.error({
+                                error,
+                                event: `action-execution-error`,
+                                message: `${parameters.name} execution error`,
+                            });
+                        }
+                        if (stopRunAtError(error)) {
+                            clearTimeout(timeoutMarker);
+                            reject(error);
+                        }
+                    });
+                };
+                // eslint-disable-next-line promise/catch-or-return
+                Promise.all(actions.map(actionMapper)).then(endChecker);
+            });
         });
     }
     syncStateActions(success) {
-        return this.store.dispatch(actionServerStateEvent(success));
+        return this.deps.store.dispatch(actionServerStateEvent(success));
     }
 }
 
@@ -829,7 +911,7 @@ ActionModule = __decorate([
                 useClass: ActionRegistry,
                 deps: { actionsList: ACTIONS_LIST_TOKEN },
             },
-            provide({
+            provide$1({
                 provide: ACTION_EXECUTION_TOKEN,
                 scope: Scope.REQUEST,
                 useClass: ActionExecution,
@@ -838,23 +920,26 @@ ActionModule = __decorate([
                     context: CONTEXT_TOKEN,
                     store: STORE_TOKEN,
                     di: DI_TOKEN,
+                    executionContextManager: EXECUTION_CONTEXT_MANAGER_TOKEN,
                     transformAction: {
                         token: 'actionTransformAction',
                         optional: true,
                     },
                 },
             }),
-            {
+            provide$1({
                 provide: ACTION_PAGE_RUNNER_TOKEN,
                 scope: Scope.REQUEST,
                 useClass: ActionPageRunner,
                 deps: {
                     actionExecution: ACTION_EXECUTION_TOKEN,
+                    executionContextManager: EXECUTION_CONTEXT_MANAGER_TOKEN,
+                    commandLineExecutionContext: COMMAND_LINE_EXECUTION_CONTEXT_TOKEN,
                     store: STORE_TOKEN,
                     limitTime: 'limitActionGlobalTimeRun',
                     logger: LOGGER_TOKEN,
                 },
-            },
+            }),
             {
                 provide: 'limitActionGlobalTimeRun',
                 useValue: 500,
@@ -996,6 +1081,58 @@ CacheModule = __decorate([
     })
 ], CacheModule);
 
+const EMPTY_VALUES = {};
+const normalizeOptions = (nameOrOptions) => {
+    return typeof nameOrOptions === 'string' ? { name: nameOrOptions } : nameOrOptions;
+};
+class ExecutionContextManager {
+    async withContext(parentContext, nameOrOptions, cb) {
+        const options = normalizeOptions(nameOrOptions);
+        const { name, values: selfValues = EMPTY_VALUES } = options;
+        const contextName = parentContext ? `${parentContext.name}.${name}` : name;
+        if (parentContext === null || parentContext === void 0 ? void 0 : parentContext.abortSignal.aborted) {
+            throw new ExecutionAbortError({
+                message: `Execution aborted in context "${contextName}"`,
+                contextName,
+            });
+        }
+        const abortController = new AbortController();
+        let abortListener;
+        let values = selfValues;
+        if (parentContext) {
+            values = {
+                ...parentContext.values,
+                ...selfValues,
+            };
+            abortListener = () => {
+                abortController.abort();
+            };
+            // abort child context AbortController if parent AbortController was aborted
+            parentContext.abortSignal.addEventListener('abort', abortListener);
+        }
+        const context = {
+            name: contextName,
+            abortSignal: abortController.signal,
+            values,
+        };
+        try {
+            const result = await cb(context, abortController);
+            return result;
+        }
+        catch (error) {
+            if (!error.executionContextName) {
+                error.executionContextName = context.name;
+            }
+            throw error;
+        }
+        finally {
+            if (abortListener) {
+                parentContext.abortSignal.removeEventListener('abort', abortListener);
+            }
+        }
+    }
+}
+
 let CommonModule = class CommonModule {
 };
 CommonModule = __decorate([
@@ -1013,13 +1150,13 @@ CommonModule = __decorate([
             CacheModule,
         ],
         providers: [
-            provide({
+            provide$1({
                 // Инстанс хук системы
                 provide: HOOK_TOKEN,
                 scope: Scope.SINGLETON,
                 useClass: Hooks,
             }),
-            provide({
+            provide$1({
                 // Регистр ui компонентов
                 provide: COMPONENT_REGISTRY_TOKEN,
                 scope: Scope.SINGLETON,
@@ -1028,7 +1165,7 @@ CommonModule = __decorate([
                     componentList: { token: 'componentDefaultList', optional: true },
                 },
             }),
-            provide({
+            provide$1({
                 // Управление бандлами, хранение и получение
                 provide: BUNDLE_MANAGER_TOKEN,
                 scope: Scope.SINGLETON,
@@ -1054,7 +1191,7 @@ CommonModule = __decorate([
                     logger: LOGGER_TOKEN,
                 },
             }),
-            provide({
+            provide$1({
                 //  Клиентский контекст исполнения
                 provide: CONTEXT_TOKEN,
                 scope: Scope.REQUEST,
@@ -1066,6 +1203,10 @@ CommonModule = __decorate([
                     store: STORE_TOKEN,
                 },
             }),
+            provide$1({
+                provide: EXECUTION_CONTEXT_MANAGER_TOKEN,
+                useClass: ExecutionContextManager,
+            }),
             ...providers$2,
         ],
     })
@@ -1074,7 +1215,7 @@ CommonModule = __decorate([
 const providers = [];
 
 const stateProviders = [
-    provide({
+    provide$1({
         provide: CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN,
         multi: true,
         useValue: [DISPATCHER_TOKEN, STORE_TOKEN, CONTEXT_TOKEN],
@@ -1100,12 +1241,12 @@ const lines = {
     client: command,
 };
 const commandProviders = [
-    provide({
+    provide$1({
         provide: CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN,
         multi: true,
         useValue: COMMAND_LINE_RUNNER_TOKEN,
     }),
-    provide({
+    provide$1({
         provide: COMMAND_LINES_TOKEN,
         scope: Scope.SINGLETON,
         useValue: lines,
@@ -1113,7 +1254,7 @@ const commandProviders = [
 ];
 
 const actionsProviders = [
-    provide({
+    provide$1({
         provide: CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN,
         multi: true,
         useValue: [ACTION_EXECUTION_TOKEN, ACTION_PAGE_RUNNER_TOKEN],
@@ -1134,7 +1275,7 @@ CommonChildAppModule = __decorate([
             ...stateProviders,
             ...commandProviders,
             ...actionsProviders,
-            provide({
+            provide$1({
                 provide: EXTEND_RENDER,
                 multi: true,
                 useFactory: ({ context }) => {
@@ -1151,4 +1292,4 @@ CommonChildAppModule = __decorate([
     })
 ], CommonChildAppModule);
 
-export { ActionExecution, CommandModule, CommonChildAppModule, CommonModule, alwaysCondition, createConsumerContext, onlyBrowser, onlyServer, pageBrowser, pageServer };
+export { ActionExecution, CommandModule, CommonChildAppModule, CommonModule, ExecutionContextManager, alwaysCondition, createConsumerContext, onlyBrowser, onlyServer, pageBrowser, pageServer };