@tramvai/test-child-app 1.55.0

package/README.md

@@ -0,0 +1,56 @@
+# Tramvai test child-app
+
+Helpers library for writing unit tests for tramvai child-app
+
+Uses [`@tramvai/test-unit`](./test-unit.md) under hood to create test root-app that will wrap child-app.
+
+## How to
+
+### Test child-app main component render
+
+You can get React Component returned by child-app from return value of `testChildApp` function and use for example `testComponent` helper from the [`@tramvai/test-react`](./test-react.md)
+
+:::warning
+
+To properly render child-app component pass as props to it its di and optionally props object, that will be passed to the underlying child-app component.
+
+:::
+
+```ts
+import { testComponent } from '@tramvai/test-react';
+import childApp from './child-app.tsx';
+
+(async () => {
+  const {
+    childApp: { Component, di },
+    close,
+  } = await testChildApp(childApp);
+  const { render } = testComponent(<Component di={di} props={{ test: 'abc' }} />);
+
+  expect(render.getByTestId('from-root').textContent).toBe('Value from Root: abc');
+})();
+```
+
+### Test child-app di
+
+```ts
+import childApp from './child-app.tsx';
+
+(async () => {
+  const {
+    childApp: { di },
+    close,
+  } = await testChildApp(childApp);
+
+  expect(di.get(CHILD_APP_BASE_TOKEN)).toBe("I'm little child app");
+})();
+```
+
+<p>
+<details>
+<summary>More examples</summary>
+
+@inline src/testChildApp.spec.tsx
+
+</details>
+</p>

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { testChildApp } from './testChildApp';

package/lib/index.es.js

@@ -0,0 +1,72 @@
+import { createTestApp, testApp } from '@tramvai/test-unit';
+import { provide } from '@tramvai/core';
+import { CHILD_APP_RESOLVE_BASE_URL_TOKEN, CHILD_APP_RESOLUTION_CONFIGS_TOKEN, CHILD_APP_LOADER_TOKEN, CHILD_APP_RESOLVE_CONFIG_TOKEN, CHILD_APP_DI_MANAGER_TOKEN, CHILD_APP_INTERNAL_RENDER_TOKEN } from '@tramvai/child-app-core';
+import { ChildAppModule } from '@tramvai/module-child-app';
+
+// mock module federation internal stuff
+// @ts-ignore
+global.__webpack_init_sharing__ = async () => { };
+// @ts-ignore
+global.__webpack_share_scopes__ = { default: { react: {}, 'react-dom': {} } };
+// @ts-ignore
+global.setImmediate = (fn) => fn();
+const testChildApp = async (childApp, options = {}) => {
+    var _a, _b;
+    const testAppInstance = await createTestApp({
+        ...options,
+        modules: [...((_a = options.modules) !== null && _a !== void 0 ? _a : []), ChildAppModule],
+        providers: [
+            ...((_b = options.providers) !== null && _b !== void 0 ? _b : []),
+            provide({
+                provide: CHILD_APP_RESOLVE_BASE_URL_TOKEN,
+                useValue: 'http://test',
+            }),
+            provide({
+                provide: CHILD_APP_RESOLUTION_CONFIGS_TOKEN,
+                useValue: [
+                    {
+                        name: childApp.name,
+                        byTag: {
+                            latest: {
+                                version: 'test',
+                            },
+                        },
+                    },
+                ],
+            }),
+            provide({
+                // replace loader for child-app as we do not need any logic for loading child-app
+                provide: CHILD_APP_LOADER_TOKEN,
+                useValue: {
+                    get(config) {
+                        if (config.name !== childApp.name) {
+                            throw new Error(`Cannot resolve child-app with name "${config.name}",
+This test wrapper supports only child-app with name "${childApp.name}"`);
+                        }
+                        return childApp;
+                    },
+                    async init(_) { },
+                    async load(_) { },
+                },
+            }),
+        ],
+    });
+    const testAppWrapper = await testApp(testAppInstance.app);
+    const appDi = testAppWrapper.app.di;
+    const resolveExternalConfig = appDi.get(CHILD_APP_RESOLVE_CONFIG_TOKEN);
+    const diManager = appDi.get(CHILD_APP_DI_MANAGER_TOKEN);
+    const di = diManager.getChildDi(resolveExternalConfig({ name: childApp.name }));
+    if (!di) {
+        throw new Error('Cannot resolve child-app di');
+    }
+    const Component = di.get(CHILD_APP_INTERNAL_RENDER_TOKEN);
+    return {
+        ...testAppWrapper,
+        childApp: {
+            di,
+            Component,
+        },
+    };
+};
+
+export { testChildApp };

package/lib/index.js

@@ -0,0 +1,76 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var testUnit = require('@tramvai/test-unit');
+var core = require('@tramvai/core');
+var childAppCore = require('@tramvai/child-app-core');
+var moduleChildApp = require('@tramvai/module-child-app');
+
+// mock module federation internal stuff
+// @ts-ignore
+global.__webpack_init_sharing__ = async () => { };
+// @ts-ignore
+global.__webpack_share_scopes__ = { default: { react: {}, 'react-dom': {} } };
+// @ts-ignore
+global.setImmediate = (fn) => fn();
+const testChildApp = async (childApp, options = {}) => {
+    var _a, _b;
+    const testAppInstance = await testUnit.createTestApp({
+        ...options,
+        modules: [...((_a = options.modules) !== null && _a !== void 0 ? _a : []), moduleChildApp.ChildAppModule],
+        providers: [
+            ...((_b = options.providers) !== null && _b !== void 0 ? _b : []),
+            core.provide({
+                provide: childAppCore.CHILD_APP_RESOLVE_BASE_URL_TOKEN,
+                useValue: 'http://test',
+            }),
+            core.provide({
+                provide: childAppCore.CHILD_APP_RESOLUTION_CONFIGS_TOKEN,
+                useValue: [
+                    {
+                        name: childApp.name,
+                        byTag: {
+                            latest: {
+                                version: 'test',
+                            },
+                        },
+                    },
+                ],
+            }),
+            core.provide({
+                // replace loader for child-app as we do not need any logic for loading child-app
+                provide: childAppCore.CHILD_APP_LOADER_TOKEN,
+                useValue: {
+                    get(config) {
+                        if (config.name !== childApp.name) {
+                            throw new Error(`Cannot resolve child-app with name "${config.name}",
+This test wrapper supports only child-app with name "${childApp.name}"`);
+                        }
+                        return childApp;
+                    },
+                    async init(_) { },
+                    async load(_) { },
+                },
+            }),
+        ],
+    });
+    const testAppWrapper = await testUnit.testApp(testAppInstance.app);
+    const appDi = testAppWrapper.app.di;
+    const resolveExternalConfig = appDi.get(childAppCore.CHILD_APP_RESOLVE_CONFIG_TOKEN);
+    const diManager = appDi.get(childAppCore.CHILD_APP_DI_MANAGER_TOKEN);
+    const di = diManager.getChildDi(resolveExternalConfig({ name: childApp.name }));
+    if (!di) {
+        throw new Error('Cannot resolve child-app di');
+    }
+    const Component = di.get(childAppCore.CHILD_APP_INTERNAL_RENDER_TOKEN);
+    return {
+        ...testAppWrapper,
+        childApp: {
+            di,
+            Component,
+        },
+    };
+};
+
+exports.testChildApp = testChildApp;

package/lib/testChildApp.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="node" />
+import { createTestApp } from '@tramvai/test-unit';
+import type { ChildApp } from '@tramvai/child-app-core';
+declare type Options = Parameters<typeof createTestApp>[0];
+export declare const testChildApp: (childApp: ChildApp, options?: Options) => Promise<{
+    childApp: {
+        di: import("@tinkoff/dippy").Container;
+        Component: import("react").ComponentType<import("@tramvai/child-app-core").WrapperProps<any>>;
+    };
+    app: import("@tramvai/core").App;
+    request: (path: string, { method }?: {
+        method?: "get" | "post" | "put" | undefined;
+    } | undefined) => import("supertest").Test;
+    render: (path: string, { method, parserOptions, }?: {
+        method?: "get" | "post" | "put" | undefined;
+        parserOptions?: Partial<import("node-html-parser").Options> | undefined;
+    } | undefined) => Promise<{
+        initialState: any;
+        parsed: import("node-html-parser").HTMLElement;
+        head: string;
+        body: string;
+        application: string;
+    }>;
+    mocker: import("@tinkoff/mocker").Mocker | null;
+    close: () => import("http").Server;
+}>;
+export {};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@tramvai/test-child-app",
+  "version": "1.55.0",
+  "description": "",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:Tinkoff/tramvai.git"
+  },
+  "scripts": {
+    "build": "tramvai-build --for-publish",
+    "watch": "tsc -w",
+    "build-for-publish": "true"
+  },
+  "dependencies": {
+    "@tramvai/child-app-core": "1.55.0",
+    "@tramvai/core": "1.55.0",
+    "@tramvai/test-unit": "1.55.0",
+    "tslib": "^2.0.3"
+  },
+  "devDependencies": {
+    "@tramvai/react": "1.55.0",
+    "react": "^17.0.2"
+  },
+  "peerDependencies": {
+    "@tramvai/module-child-app": "1.55.0"
+  },
+  "license": "Apache-2.0",
+  "module": "lib/index.es.js"
+}