@tramvai/module-child-app 4.41.104 → 4.41.110

package/lib/server/loader.d.ts

@@ -1,5 +1,5 @@
 import type { ChildApp } from '@tramvai/child-app-core';
-import type { ChildAppFinalConfig } from '@tramvai/tokens-child-app';
+import { CHILD_APP_LOADER_CACHE_OPTIONS_TOKEN, type ChildAppFinalConfig } from '@tramvai/tokens-child-app';
 import type { CREATE_CACHE_TOKEN, LOGGER_TOKEN, ENV_MANAGER_TOKEN } from '@tramvai/tokens-common';
 import { Loader } from '../shared/loader';
 import type { LoadableStats, ModuleFederationStats } from '../shared/webpack/moduleFederation';
@@ -8,10 +8,11 @@ export declare class ServerLoader extends Loader {
     private readonly initializedMap;
     private internalLoadCache;
     private log;
-    constructor({ logger, createCache, envManager, }: {
+    constructor({ logger, createCache, envManager, cacheOptions, }: {
         logger: typeof LOGGER_TOKEN;
         createCache: typeof CREATE_CACHE_TOKEN;
         envManager: typeof ENV_MANAGER_TOKEN;
+        cacheOptions: typeof CHILD_APP_LOADER_CACHE_OPTIONS_TOKEN | null;
     });
     load(config: ChildAppFinalConfig): Promise<ChildApp | void>;
     init(config: ChildAppFinalConfig): Promise<void>;

package/lib/server/loader.es.js

@@ -4,13 +4,22 @@ import { Loader } from '../shared/loader.es.js';
 import { initModuleFederation, getModuleFederation } from '../shared/webpack/moduleFederation.es.js';
 
 class ServerLoader extends Loader {
-    constructor({ logger, createCache, envManager, }) {
+    constructor({ logger, createCache, envManager, cacheOptions, }) {
         super();
         this.initializedMap = new WeakMap();
         const cache = createCache('memory', {
             name: 'child-app-loader',
             ttl: 1000 * 60 * 60 * 24 * 5,
-            max: 20,
+            // When Child App script is evicted from server loader cache, we get a small memory leak,
+            // because providers in singleton child DI, page components / actions, will store a reference to removed script,
+            // and server loader cache will contain a new instance of the same script.
+            //
+            // So, it is better to have bigger cache size to prevent evicting from cache,
+            // also for one Child App we need to save 3 elements - server JS, stats JSON and loadable stats JSON.
+            //
+            // TODO: cache cleanup for previous versions of Child Apps
+            max: 100,
+            ...cacheOptions,
         });
         this.internalLoadCache = cache;
         this.log = logger('child-app:loader');

package/lib/server/loader.js

@@ -12,13 +12,22 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var isNil__default = /*#__PURE__*/_interopDefaultLegacy(isNil);
 
 class ServerLoader extends loader.Loader {
-    constructor({ logger, createCache, envManager, }) {
+    constructor({ logger, createCache, envManager, cacheOptions, }) {
         super();
         this.initializedMap = new WeakMap();
         const cache = createCache('memory', {
             name: 'child-app-loader',
             ttl: 1000 * 60 * 60 * 24 * 5,
-            max: 20,
+            // When Child App script is evicted from server loader cache, we get a small memory leak,
+            // because providers in singleton child DI, page components / actions, will store a reference to removed script,
+            // and server loader cache will contain a new instance of the same script.
+            //
+            // So, it is better to have bigger cache size to prevent evicting from cache,
+            // also for one Child App we need to save 3 elements - server JS, stats JSON and loadable stats JSON.
+            //
+            // TODO: cache cleanup for previous versions of Child Apps
+            max: 100,
+            ...cacheOptions,
         });
         this.internalLoadCache = cache;
         this.log = logger('child-app:loader');

package/lib/server/providers.es.js

@@ -3,7 +3,7 @@ import { Scope, optional, DI_TOKEN } from '@tinkoff/dippy';
 import { provide, commandLineListTokens } from '@tramvai/core';
 import { ENV_USED_TOKEN, LOGGER_TOKEN, CREATE_CACHE_TOKEN, ENV_MANAGER_TOKEN, STORE_TOKEN, ASYNC_LOCAL_STORAGE_TOKEN } from '@tramvai/tokens-common';
 import { RESOURCES_REGISTRY, RENDER_SLOTS, ResourceType, ResourceSlot, RENDER_FLOW_AFTER_TOKEN, REACT_SERVER_RENDER_MODE, EXTEND_RENDER } from '@tramvai/tokens-render';
-import { CHILD_APP_LOADER_TOKEN, CHILD_APP_STATE_MANAGER_TOKEN, CHILD_APP_DI_MANAGER_TOKEN, CHILD_APP_PRELOAD_MANAGER_TOKEN, CHILD_APP_COMMAND_LINE_RUNNER_TOKEN, CHILD_APP_RESOLUTION_CONFIG_MANAGER_TOKEN, CHILD_APP_RESOLVE_CONFIG_TOKEN, CHILD_APP_RENDER_MANAGER_TOKEN, CHILD_APP_CONTRACT_MANAGER, HOST_PROVIDED_CONTRACTS, HOST_REQUIRED_CONTRACTS } from '@tramvai/tokens-child-app';
+import { CHILD_APP_LOADER_TOKEN, CHILD_APP_LOADER_CACHE_OPTIONS_TOKEN, CHILD_APP_STATE_MANAGER_TOKEN, CHILD_APP_DI_MANAGER_TOKEN, CHILD_APP_PRELOAD_MANAGER_TOKEN, CHILD_APP_COMMAND_LINE_RUNNER_TOKEN, CHILD_APP_RESOLUTION_CONFIG_MANAGER_TOKEN, CHILD_APP_RESOLVE_CONFIG_TOKEN, CHILD_APP_RENDER_MANAGER_TOKEN, CHILD_APP_CONTRACT_MANAGER, HOST_PROVIDED_CONTRACTS, HOST_REQUIRED_CONTRACTS } from '@tramvai/tokens-child-app';
 import { safeStringify } from '@tramvai/safe-strings';
 import { ServerLoader } from './loader.es.js';
 import { PreloadManager } from './preload.es.js';
@@ -33,6 +33,7 @@ const serverProviders = [
         deps: {
             logger: LOGGER_TOKEN,
             createCache: CREATE_CACHE_TOKEN,
+            cacheOptions: optional(CHILD_APP_LOADER_CACHE_OPTIONS_TOKEN),
             envManager: ENV_MANAGER_TOKEN,
         },
     }),

package/lib/server/providers.js

@@ -37,6 +37,7 @@ const serverProviders = [
         deps: {
             logger: tokensCommon.LOGGER_TOKEN,
             createCache: tokensCommon.CREATE_CACHE_TOKEN,
+            cacheOptions: dippy.optional(tokensChildApp.CHILD_APP_LOADER_CACHE_OPTIONS_TOKEN),
             envManager: tokensCommon.ENV_MANAGER_TOKEN,
         },
     }),

package/lib/shared/pageService.browser.js

@@ -11,9 +11,10 @@ class ChildAppPageService {
         (pageComponents || []).forEach((record) => {
             Object.keys(record).forEach((pageComponentName) => {
                 const pageComponent = record[pageComponentName];
-                if (!this.componentRegistry.get(pageComponentName, componentsGroupName)) {
-                    this.componentRegistry.add(pageComponentName, pageComponent, componentsGroupName);
-                }
+                // to prevent memory leaks, always register Child App components,
+                // because if Child App server JS is loaded again after eviction from server loader cache,
+                // we want to load new instance of components and actions and clear memory references to old server JS
+                this.componentRegistry.add(pageComponentName, pageComponent, componentsGroupName);
             });
         });
     }

package/lib/shared/pageService.es.js

@@ -11,9 +11,10 @@ class ChildAppPageService {
         (pageComponents || []).forEach((record) => {
             Object.keys(record).forEach((pageComponentName) => {
                 const pageComponent = record[pageComponentName];
-                if (!this.componentRegistry.get(pageComponentName, componentsGroupName)) {
-                    this.componentRegistry.add(pageComponentName, pageComponent, componentsGroupName);
-                }
+                // to prevent memory leaks, always register Child App components,
+                // because if Child App server JS is loaded again after eviction from server loader cache,
+                // we want to load new instance of components and actions and clear memory references to old server JS
+                this.componentRegistry.add(pageComponentName, pageComponent, componentsGroupName);
             });
         });
     }

package/lib/shared/pageService.js

@@ -19,9 +19,10 @@ class ChildAppPageService {
         (pageComponents || []).forEach((record) => {
             Object.keys(record).forEach((pageComponentName) => {
                 const pageComponent = record[pageComponentName];
-                if (!this.componentRegistry.get(pageComponentName, componentsGroupName)) {
-                    this.componentRegistry.add(pageComponentName, pageComponent, componentsGroupName);
-                }
+                // to prevent memory leaks, always register Child App components,
+                // because if Child App server JS is loaded again after eviction from server loader cache,
+                // we want to load new instance of components and actions and clear memory references to old server JS
+                this.componentRegistry.add(pageComponentName, pageComponent, componentsGroupName);
             });
         });
     }

package/lib/shared/singletonDi.browser.js

@@ -9,6 +9,7 @@ import { shouldIsolateDi } from './isolatedDi.browser.js';
 class SingletonDiManager {
     constructor({ logger, appDi, loader, rootDiAccessMode, contractManager, }) {
         this.cache = new Map();
+        this.moduleCache = new WeakMap();
         this.log = logger('child-app:singleton-di-manager');
         this.appDi = appDi;
         this.loader = loader;
@@ -18,7 +19,16 @@ class SingletonDiManager {
     getChildDi(config) {
         const { key, tag } = config;
         if (this.cache.has(key)) {
-            return this.cache.get(key);
+            const children = this.loader.get(config);
+            // When Child App script is evicted from server loader cache, we get a memory leak,
+            // because providers in singleton child DI will store a reference to removed script,
+            // and server loader cache will contain a new instance of the same script.
+            // To solve this case, we will try to create a new singleton child DI
+            // when new Child App script instance is fetched and compiled.
+            if (children && this.moduleCache.has(children) && this.moduleCache.get(children) === key) {
+                return this.cache.get(key);
+            }
+            this.cache.delete(key);
         }
         try {
             const di = this.resolveDi(config);
@@ -108,6 +118,7 @@ class SingletonDiManager {
                 di.borrowToken(this.appDi, token);
             });
         }
+        this.moduleCache.set(children, config.key);
         return di;
     }
 }

package/lib/shared/singletonDi.d.ts

@@ -11,6 +11,7 @@ export declare class SingletonDiManager implements ChildAppDiManager {
     private rootDiAccessMode?;
     private contractManager;
     private cache;
+    private moduleCache;
     constructor({ logger, appDi, loader, rootDiAccessMode, contractManager, }: {
         logger: typeof LOGGER_TOKEN;
         appDi: Container;

package/lib/shared/singletonDi.es.js

@@ -9,6 +9,7 @@ import { shouldIsolateDi } from './isolatedDi.es.js';
 class SingletonDiManager {
     constructor({ logger, appDi, loader, rootDiAccessMode, contractManager, }) {
         this.cache = new Map();
+        this.moduleCache = new WeakMap();
         this.log = logger('child-app:singleton-di-manager');
         this.appDi = appDi;
         this.loader = loader;
@@ -18,7 +19,16 @@ class SingletonDiManager {
     getChildDi(config) {
         const { key, tag } = config;
         if (this.cache.has(key)) {
-            return this.cache.get(key);
+            const children = this.loader.get(config);
+            // When Child App script is evicted from server loader cache, we get a memory leak,
+            // because providers in singleton child DI will store a reference to removed script,
+            // and server loader cache will contain a new instance of the same script.
+            // To solve this case, we will try to create a new singleton child DI
+            // when new Child App script instance is fetched and compiled.
+            if (children && this.moduleCache.has(children) && this.moduleCache.get(children) === key) {
+                return this.cache.get(key);
+            }
+            this.cache.delete(key);
         }
         try {
             const di = this.resolveDi(config);
@@ -108,6 +118,7 @@ class SingletonDiManager {
                 di.borrowToken(this.appDi, token);
             });
         }
+        this.moduleCache.set(children, config.key);
         return di;
     }
 }

package/lib/shared/singletonDi.js

@@ -17,6 +17,7 @@ var flatten__default = /*#__PURE__*/_interopDefaultLegacy(flatten);
 class SingletonDiManager {
     constructor({ logger, appDi, loader, rootDiAccessMode, contractManager, }) {
         this.cache = new Map();
+        this.moduleCache = new WeakMap();
         this.log = logger('child-app:singleton-di-manager');
         this.appDi = appDi;
         this.loader = loader;
@@ -26,7 +27,16 @@ class SingletonDiManager {
     getChildDi(config) {
         const { key, tag } = config;
         if (this.cache.has(key)) {
-            return this.cache.get(key);
+            const children = this.loader.get(config);
+            // When Child App script is evicted from server loader cache, we get a memory leak,
+            // because providers in singleton child DI will store a reference to removed script,
+            // and server loader cache will contain a new instance of the same script.
+            // To solve this case, we will try to create a new singleton child DI
+            // when new Child App script instance is fetched and compiled.
+            if (children && this.moduleCache.has(children) && this.moduleCache.get(children) === key) {
+                return this.cache.get(key);
+            }
+            this.cache.delete(key);
         }
         try {
             const di = this.resolveDi(config);
@@ -116,6 +126,7 @@ class SingletonDiManager {
                 di.borrowToken(this.appDi, token);
             });
         }
+        this.moduleCache.set(children, config.key);
         return di;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-child-app",
-  "version": "4.41.104",
+  "version": "4.41.110",
   "description": "Module for child apps",
   "browser": {
     "./lib/server.js": "./lib/browser.js",
@@ -33,24 +33,24 @@
     "@tinkoff/env-validators": "0.3.3",
     "@tinkoff/module-loader-client": "0.6.7",
     "@tinkoff/module-loader-server": "0.7.7",
-    "@tramvai/module-common": "4.41.104",
+    "@tramvai/module-common": "4.41.110",
     "@tinkoff/url": "0.10.3",
     "@tinkoff/errors": "0.5.3",
-    "@tramvai/child-app-core": "4.41.104",
+    "@tramvai/child-app-core": "4.41.110",
     "@tramvai/safe-strings": "0.7.9",
-    "@tramvai/tokens-child-app": "4.41.104"
+    "@tramvai/tokens-child-app": "4.41.110"
   },
   "devDependencies": {},
   "peerDependencies": {
-    "@tinkoff/dippy": "0.10.11",
-    "@tinkoff/router": "0.4.239",
+    "@tinkoff/dippy": "0.10.12",
+    "@tinkoff/router": "0.4.245",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/core": "4.41.104",
-    "@tramvai/state": "4.41.104",
-    "@tramvai/react": "4.41.104",
-    "@tramvai/tokens-common": "4.41.104",
-    "@tramvai/tokens-render": "4.41.104",
-    "@tramvai/tokens-router": "4.41.104",
+    "@tramvai/core": "4.41.110",
+    "@tramvai/state": "4.41.110",
+    "@tramvai/react": "4.41.110",
+    "@tramvai/tokens-common": "4.41.110",
+    "@tramvai/tokens-render": "4.41.110",
+    "@tramvai/tokens-router": "4.41.110",
     "react": ">=16.14.0",
     "react-dom": ">=16.14.0",
     "object-assign": "^4.1.1",