@tramvai/test-pw 4.36.2 → 4.38.0

package/README.md

@@ -95,3 +95,60 @@ test.describe('examples/app', async () => {
 ```
 
 You can find more info about `app` object in our [Testing Guide](guides/testing.md#integration-tests)
+
+### Production build testing
+
+If you need to test production build, `@tramvai/test-pw` provide a few fixtures for it:
+- `appServerFixture` to run compiled application server
+- `buildAppFixture` to run production build of the application (will be called implicitly for `appServerFixture`)
+
+First, configure fixtures:
+
+```ts title="__integration__/test-fixture.ts"
+import path from 'path';
+import { test as base } from '@playwright/test';
+import type { BuildAppTypes } from '@tramvai/test-pw';
+import { appServerFixture } from '@tramvai/test-pw';
+
+type TestFixture = {};
+
+type WorkerFixture = {
+  app: BuildAppTypes.TestApp;
+  appTarget: BuildAppTypes.AppTarget;
+  buildOptions: BuildAppTypes.StartOptions;
+};
+
+export const test = base.extend<TestFixture, WorkerFixture>({
+  appTarget: [
+    // provide application name and directory
+    {
+      target: 'appName',
+      cwd: path.resolve(__dirname, '..'),
+    },
+    { scope: 'worker', auto: true, option: true },
+  ],
+  // any `buildCli` parameters
+  buildOptions: [{
+    env: {
+      SOME_MOCKED_API: 'xxx'
+    },
+  }, { scope: 'worker', auto: true, option: true }],
+
+  appServer: appServerFixture,
+});
+```
+
+Then, use the `appServer` object in integration tests:
+
+```ts title="__integration__/appName.integration.ts"
+import { expect } from '@playwright/test';
+import { test } from './test-fixture';
+
+test.describe('examples/app', async () => {
+  test('Navigation is visible', async ({ appServer, page }) => {
+    await page.goto(`http://localhost:${appServer.port}/`);
+
+    expect(page.getByRole('navigation')).toBeVisible();
+  });
+});
+```

package/lib/fixtures/build-app.d.ts

@@ -0,0 +1,53 @@
+import type { WorkerFixture, TestFixture } from '@playwright/test';
+import type { BuildCliOptions } from '@tramvai/test-integration';
+import type { AppTarget as _AppTarget } from './types';
+export type AppServerType = {
+    port: number;
+    staticPort: number;
+};
+export type AppServerOptionsType = {
+    env?: Record<string, string>;
+    output?: {
+        client?: string;
+        server?: string;
+    };
+};
+export declare namespace BuildAppTypes {
+    type Cwd = string;
+    type AppTarget = _AppTarget;
+    type BuildOptions = BuildCliOptions;
+    type AppServer = AppServerType;
+    type AppServerOptions = AppServerOptionsType;
+}
+/**
+ * Фикстура запускает сборку приложения с помощью метода `buildCli` из `@tramvai/test-integration`
+ * @param appTarget указывает какое приложение запускать (может как указывать на существующее приложение с tramvai.json конфигом так и принимать полный конфиг)
+ * @param buildOptions дополнительные параметры метода `buildCli` (например билдтайм env переменные)
+ */
+export declare const buildAppFixture: [
+    WorkerFixture<void, {
+        appTarget: BuildAppTypes.AppTarget;
+        buildOptions?: BuildAppTypes.BuildOptions;
+    }>,
+    {
+        scope: 'worker';
+        timeout: number;
+    }
+];
+/**
+ * Фикстура запускает собранное с помощью `buildAppFixture` приложение (а именно server.js)
+ * @param appTarget указывает какое приложение запускать (может как указывать на существующее приложение с tramvai.json конфигом так и принимать полный конфиг)
+ * @param appServerOptions дополнительные параметры для приложения (например рантайм env переменные)
+ * @returns возвращает свойства запущенного сервера (порт приложения, порт по которому доступны ассеты)
+ */
+export declare const appServerFixture: [
+    TestFixture<BuildAppTypes.AppServer, {
+        appTarget: BuildAppTypes.AppTarget;
+        appServerOptions: BuildAppTypes.AppServerOptions;
+        buildApp: void;
+    }>,
+    {
+        scope: 'test';
+    }
+];
+//# sourceMappingURL=build-app.d.ts.map

package/lib/fixtures/build-app.es.js

@@ -0,0 +1,86 @@
+import mergeDeep from '@tinkoff/utils/object/mergeDeep';
+import path from 'path';
+import { node } from 'execa';
+import waitOn from 'wait-on';
+import getPort from 'get-port';
+import { buildCli } from '@tramvai/test-integration';
+
+/**
+ * Фикстура запускает сборку приложения с помощью метода `buildCli` из `@tramvai/test-integration`
+ * @param appTarget указывает какое приложение запускать (может как указывать на существующее приложение с tramvai.json конфигом так и принимать полный конфиг)
+ * @param buildOptions дополнительные параметры метода `buildCli` (например билдтайм env переменные)
+ */
+const buildAppFixture = [
+    async ({ appTarget, buildOptions }, use) => {
+        var _a;
+        await buildCli('target' in appTarget
+            ? appTarget.target
+            : mergeDeep(appTarget.config, {
+                name: appTarget.name,
+                type: 'application',
+                root: appTarget.cwd,
+            }), {
+            ...buildOptions,
+            rootDir: (_a = appTarget.cwd) !== null && _a !== void 0 ? _a : path.dirname(path.resolve(module.parent.filename, '.')),
+        });
+        await use();
+        // @todo clear dist?
+    },
+    { scope: 'worker', timeout: 60000 },
+];
+/**
+ * Фикстура запускает собранное с помощью `buildAppFixture` приложение (а именно server.js)
+ * @param appTarget указывает какое приложение запускать (может как указывать на существующее приложение с tramvai.json конфигом так и принимать полный конфиг)
+ * @param appServerOptions дополнительные параметры для приложения (например рантайм env переменные)
+ * @returns возвращает свойства запущенного сервера (порт приложения, порт по которому доступны ассеты)
+ */
+const appServerFixture = [
+    async ({ appTarget, appServerOptions, buildApp }, use) => {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const { env = {}, output = {} } = appServerOptions;
+        const root = (_a = appTarget.cwd) !== null && _a !== void 0 ? _a : path.dirname(path.resolve(module.parent.filename, '.'));
+        const port = await getPort();
+        const staticPort = await getPort();
+        const readinessProbePath = `http://localhost:${port}/readyz`;
+        const clientOutput = (_b = output.client) !== null && _b !== void 0 ? _b : path.join('dist', 'client');
+        const serverOutput = (_c = output.server) !== null && _c !== void 0 ? _c : path.join('dist', 'server');
+        const server = node(path.resolve(root, serverOutput, 'server.js'), [], {
+            cwd: root,
+            env: {
+                PORT: String(port),
+                PORT_STATIC: String(staticPort),
+                NODE_ENV: 'production',
+                CACHE_WARMUP_DISABLED: 'true',
+                DEV_STATIC: 'true',
+                ASSETS_PREFIX: `http://localhost:${staticPort}/${clientOutput}/`,
+                ...env,
+            },
+        });
+        // playwright can only collect string-form stdio into the test report
+        // https://github.com/microsoft/playwright/issues/23993
+        (_d = server.stdout) === null || _d === void 0 ? void 0 : _d.setEncoding('utf-8');
+        (_e = server.stderr) === null || _e === void 0 ? void 0 : _e.setEncoding('utf-8');
+        // @todo pipe only when server run is failed
+        (_f = server.stdout) === null || _f === void 0 ? void 0 : _f.pipe(process.stdout);
+        (_g = server.stderr) === null || _g === void 0 ? void 0 : _g.pipe(process.stderr);
+        await Promise.race([
+            server,
+            waitOn({
+                resources: [readinessProbePath],
+                delay: 100,
+                interval: 100,
+                timeout: 5 * 1000,
+                validateStatus: (status) => status === 200,
+            }),
+        ]);
+        const app = {
+            port,
+            staticPort,
+        };
+        await use(app);
+        server.kill('SIGKILL');
+    },
+    { scope: 'test' },
+];
+
+export { appServerFixture, buildAppFixture };

package/lib/fixtures/build-app.js

@@ -0,0 +1,98 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var mergeDeep = require('@tinkoff/utils/object/mergeDeep');
+var path = require('path');
+var execa = require('execa');
+var waitOn = require('wait-on');
+var getPort = require('get-port');
+var testIntegration = require('@tramvai/test-integration');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var mergeDeep__default = /*#__PURE__*/_interopDefaultLegacy(mergeDeep);
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+var waitOn__default = /*#__PURE__*/_interopDefaultLegacy(waitOn);
+var getPort__default = /*#__PURE__*/_interopDefaultLegacy(getPort);
+
+/**
+ * Фикстура запускает сборку приложения с помощью метода `buildCli` из `@tramvai/test-integration`
+ * @param appTarget указывает какое приложение запускать (может как указывать на существующее приложение с tramvai.json конфигом так и принимать полный конфиг)
+ * @param buildOptions дополнительные параметры метода `buildCli` (например билдтайм env переменные)
+ */
+const buildAppFixture = [
+    async ({ appTarget, buildOptions }, use) => {
+        var _a;
+        await testIntegration.buildCli('target' in appTarget
+            ? appTarget.target
+            : mergeDeep__default["default"](appTarget.config, {
+                name: appTarget.name,
+                type: 'application',
+                root: appTarget.cwd,
+            }), {
+            ...buildOptions,
+            rootDir: (_a = appTarget.cwd) !== null && _a !== void 0 ? _a : path__default["default"].dirname(path__default["default"].resolve(module.parent.filename, '.')),
+        });
+        await use();
+        // @todo clear dist?
+    },
+    { scope: 'worker', timeout: 60000 },
+];
+/**
+ * Фикстура запускает собранное с помощью `buildAppFixture` приложение (а именно server.js)
+ * @param appTarget указывает какое приложение запускать (может как указывать на существующее приложение с tramvai.json конфигом так и принимать полный конфиг)
+ * @param appServerOptions дополнительные параметры для приложения (например рантайм env переменные)
+ * @returns возвращает свойства запущенного сервера (порт приложения, порт по которому доступны ассеты)
+ */
+const appServerFixture = [
+    async ({ appTarget, appServerOptions, buildApp }, use) => {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const { env = {}, output = {} } = appServerOptions;
+        const root = (_a = appTarget.cwd) !== null && _a !== void 0 ? _a : path__default["default"].dirname(path__default["default"].resolve(module.parent.filename, '.'));
+        const port = await getPort__default["default"]();
+        const staticPort = await getPort__default["default"]();
+        const readinessProbePath = `http://localhost:${port}/readyz`;
+        const clientOutput = (_b = output.client) !== null && _b !== void 0 ? _b : path__default["default"].join('dist', 'client');
+        const serverOutput = (_c = output.server) !== null && _c !== void 0 ? _c : path__default["default"].join('dist', 'server');
+        const server = execa.node(path__default["default"].resolve(root, serverOutput, 'server.js'), [], {
+            cwd: root,
+            env: {
+                PORT: String(port),
+                PORT_STATIC: String(staticPort),
+                NODE_ENV: 'production',
+                CACHE_WARMUP_DISABLED: 'true',
+                DEV_STATIC: 'true',
+                ASSETS_PREFIX: `http://localhost:${staticPort}/${clientOutput}/`,
+                ...env,
+            },
+        });
+        // playwright can only collect string-form stdio into the test report
+        // https://github.com/microsoft/playwright/issues/23993
+        (_d = server.stdout) === null || _d === void 0 ? void 0 : _d.setEncoding('utf-8');
+        (_e = server.stderr) === null || _e === void 0 ? void 0 : _e.setEncoding('utf-8');
+        // @todo pipe only when server run is failed
+        (_f = server.stdout) === null || _f === void 0 ? void 0 : _f.pipe(process.stdout);
+        (_g = server.stderr) === null || _g === void 0 ? void 0 : _g.pipe(process.stderr);
+        await Promise.race([
+            server,
+            waitOn__default["default"]({
+                resources: [readinessProbePath],
+                delay: 100,
+                interval: 100,
+                timeout: 5 * 1000,
+                validateStatus: (status) => status === 200,
+            }),
+        ]);
+        const app = {
+            port,
+            staticPort,
+        };
+        await use(app);
+        server.kill('SIGKILL');
+    },
+    { scope: 'test' },
+];
+
+exports.appServerFixture = appServerFixture;
+exports.buildAppFixture = buildAppFixture;

package/lib/fixtures/start-app.d.ts

@@ -1,18 +1,10 @@
 import type { WorkerFixture } from '@playwright/test';
 import type { StartCliOptions, StartCliResult } from '@tramvai/test-integration';
-import type { ApplicationConfigEntry, ConvertToSchema } from '@tramvai/cli';
+import type { AppTarget as _AppTarget } from './types';
 export declare namespace StartAppTypes {
     type TestApp = StartCliResult;
-    type AppTarget = {
-        name: string;
-        cwd: string;
-        config?: Partial<ConvertToSchema<ApplicationConfigEntry>>;
-    } | {
-        target: string;
-        cwd: string;
-        name?: string;
-    };
     type StartOptions = StartCliOptions;
+    type AppTarget = _AppTarget;
 }
 /**
  * Фикстура запускает приложение с помощью метода `startCli` из `@tramvai/test-integration`

package/lib/fixtures/types.d.ts

@@ -0,0 +1,11 @@
+import type { ApplicationConfigEntry, ConvertToSchema } from '@tramvai/cli';
+export type AppTarget = {
+    name: string;
+    cwd: string;
+    config?: Partial<ConvertToSchema<ApplicationConfigEntry>>;
+} | {
+    target: string;
+    cwd: string;
+    name?: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/lib/index.d.ts

@@ -5,4 +5,5 @@ export { wrapPlaywrightPage } from './wrapper';
 export * from './utils';
 export { createPlaywrightConfig } from './config';
 export { startAppFixture, StartAppTypes } from './fixtures/start-app';
+export { buildAppFixture, appServerFixture, BuildAppTypes } from './fixtures/build-app';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.es.js

@@ -5,3 +5,4 @@ export { wrapPlaywrightPage } from './wrapper.es.js';
 export { waitHydrated } from './utils.es.js';
 export { createPlaywrightConfig } from './config.es.js';
 export { startAppFixture } from './fixtures/start-app.es.js';
+export { appServerFixture, buildAppFixture } from './fixtures/build-app.es.js';

package/lib/index.js

@@ -9,6 +9,7 @@ var wrapper = require('./wrapper.js');
 var utils = require('./utils.js');
 var config = require('./config.js');
 var startApp = require('./fixtures/start-app.js');
+var buildApp = require('./fixtures/build-app.js');
 
 
 
@@ -18,6 +19,8 @@ exports.wrapPlaywrightPage = wrapper.wrapPlaywrightPage;
 exports.waitHydrated = utils.waitHydrated;
 exports.createPlaywrightConfig = config.createPlaywrightConfig;
 exports.startAppFixture = startApp.startAppFixture;
+exports.appServerFixture = buildApp.appServerFixture;
+exports.buildAppFixture = buildApp.buildAppFixture;
 Object.keys(playwrightCore).forEach(function (k) {
 	if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
 		enumerable: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/test-pw",
-  "version": "4.36.2",
+  "version": "4.38.0",
   "description": "",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -18,12 +18,15 @@
   },
   "dependencies": {
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/test-integration": "4.36.2",
-    "@tramvai/tokens-router": "4.36.2",
+    "@tramvai/test-integration": "4.38.0",
+    "@tramvai/tokens-router": "4.38.0",
     "console-with-style": "^1.1.0",
+    "get-port": "^5.1.1",
     "supports-color": "8.1.1",
     "env-ci": "^5.0.2",
-    "tslib": "^2.4.0"
+    "execa": "^5.1.1",
+    "tslib": "^2.4.0",
+    "wait-on": "^5.3.0"
   },
   "peerDependencies": {
     "playwright-core": "*"
@@ -31,7 +34,8 @@
   "devDependencies": {
     "@types/supports-color": "^8.1.1",
     "@types/env-ci": "^3.1.0",
-    "@tramvai/cli": "4.36.2",
+    "@types/wait-on": "^5.2.0",
+    "@tramvai/cli": "4.38.0",
     "@playwright/test": "1.29.0",
     "playwright-core": "1.29.0"
   },