@mattermost/loadtest-browser-lib 1.31.0-0

package/README.md

@@ -0,0 +1,9 @@
+# Mattermost Load Test NG's Browser Library
+
+Shared types, helpers and utilities for Mattermost browser-based load testing simulations using Playwright.
+
+## Installation
+
+```bash
+npm install @mattermost/loadtest-browser-lib
+```

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export type { BrowserInstance, SimulationRegistryItem } from './types/simulation.js';
+export type { Logger } from './types/log.js';
+export { SessionState } from './types/simulation.js';
+export { performLogin } from './simulation_helpers/login_page.js';
+export { handleLandingPage } from './simulation_helpers/landing_page.js';
+export { performTeamSelection } from './simulation_helpers/select_team_page.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,YAAY,EAAC,eAAe,EAAE,sBAAsB,EAAC,MAAM,uBAAuB,CAAC;AACnF,YAAY,EAAC,MAAM,EAAC,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAC,YAAY,EAAC,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAC,iBAAiB,EAAC,MAAM,sCAAsC,CAAC;AACvE,OAAO,EAAC,oBAAoB,EAAC,MAAM,0CAA0C,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+// Copyright (c) 2019-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+export { SessionState } from './types/simulation.js';
+export { performLogin } from './simulation_helpers/login_page.js';
+export { handleLandingPage } from './simulation_helpers/landing_page.js';
+export { performTeamSelection } from './simulation_helpers/select_team_page.js';

package/dist/simulation_helpers/landing_page.d.ts

@@ -0,0 +1,4 @@
+import type { Page } from '@playwright/test';
+import type { Logger } from '../types/log.js';
+export declare function handleLandingPage(page: Page, log: Logger): Promise<void>;
+//# sourceMappingURL=landing_page.d.ts.map

package/dist/simulation_helpers/landing_page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"landing_page.d.ts","sourceRoot":"","sources":["../../src/simulation_helpers/landing_page.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,kBAAkB,CAAC;AAG3C,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,iBAAiB,CAAC;AAE5C,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAsB9E"}

package/dist/simulation_helpers/landing_page.js

@@ -0,0 +1,23 @@
+// Copyright (c) 2019-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+import { LandingLoginPage } from '@mattermost/playwright-lib';
+export async function handleLandingPage(page, log) {
+    log.info('run--handleLandingPage');
+    try {
+        const isLandingPage = await page
+            .waitForURL((url) => url.pathname.includes('/landing'))
+            .then(() => true)
+            .catch(() => false);
+        if (!isLandingPage) {
+            throw new Error('Not on landing page');
+        }
+        const landingLoginPage = new LandingLoginPage(page);
+        await landingLoginPage.toBeVisible();
+        await landingLoginPage.viewInBrowserButton.click();
+        log.info('pass--handleLandingPage');
+    }
+    catch {
+        // If checkbox not found, log and skip
+        log.info('skip--handleLandingPage');
+    }
+}

package/dist/simulation_helpers/login_page.d.ts

@@ -0,0 +1,9 @@
+import type { Page } from '@playwright/test';
+import type { Logger } from '../types/log.js';
+type ExtraArgs = {
+    userId: string;
+    password: string;
+};
+export declare function performLogin(page: Page, log: Logger, { userId, password }: ExtraArgs): Promise<void>;
+export {};
+//# sourceMappingURL=login_page.d.ts.map

package/dist/simulation_helpers/login_page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"login_page.d.ts","sourceRoot":"","sources":["../../src/simulation_helpers/login_page.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,kBAAkB,CAAC;AAG3C,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,iBAAiB,CAAC;AAE5C,KAAK,SAAS,GAAG;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAsB,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAmBxG"}

package/dist/simulation_helpers/login_page.js

@@ -0,0 +1,19 @@
+// Copyright (c) 2019-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+import { LoginPage } from '@mattermost/playwright-lib';
+export async function performLogin(page, log, { userId, password }) {
+    log.info('run--performLogin');
+    try {
+        const loginPage = new LoginPage(page);
+        await loginPage.toBeVisible();
+        await loginPage.loginInput.fill(userId);
+        await loginPage.passwordInput.waitFor({ state: 'visible' });
+        await loginPage.passwordInput.fill(password);
+        await loginPage.signInButton.waitFor({ state: 'visible' });
+        await loginPage.signInButton.click();
+        log.info('pass--performLogin');
+    }
+    catch (error) {
+        throw { error, testId: 'performLogin' };
+    }
+}

package/dist/simulation_helpers/select_team_page.d.ts

@@ -0,0 +1,11 @@
+import type { Page } from '@playwright/test';
+import type { Logger } from '../types/log.js';
+type ExtraArgs = {
+    /**
+     * If left empty, the first team in the list will be selected.
+     */
+    teamName?: string;
+};
+export declare function performTeamSelection(page: Page, log: Logger, { teamName }: ExtraArgs): Promise<void>;
+export {};
+//# sourceMappingURL=select_team_page.d.ts.map

package/dist/simulation_helpers/select_team_page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"select_team_page.d.ts","sourceRoot":"","sources":["../../src/simulation_helpers/select_team_page.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,kBAAkB,CAAC;AAE3C,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,iBAAiB,CAAC;AAE5C,KAAK,SAAS,GAAG;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAsB,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CA+BxG"}

package/dist/simulation_helpers/select_team_page.js

@@ -0,0 +1,30 @@
+// Copyright (c) 2019-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+export async function performTeamSelection(page, log, { teamName }) {
+    log.info('run--performTeamSelection');
+    try {
+        const isTeamSelectionPage = await page
+            .waitForURL((url) => url.pathname.includes('/select_team'))
+            .then(() => true)
+            .catch(() => false);
+        if (!isTeamSelectionPage) {
+            throw new Error('Not on team selection page');
+        }
+        await page.waitForSelector('.signup-team-dir a');
+        let teamIconElement;
+        if (teamName) {
+            teamIconElement = page.locator('.signup-team-dir a').filter({
+                has: page.locator('.signup-team-dir__name', { hasText: teamName }),
+            });
+        }
+        else {
+            teamIconElement = page.locator('.signup-team-dir a').first();
+        }
+        await teamIconElement.click();
+        await page.waitForURL((url) => !url.pathname.includes('/select_team'));
+        log.info('pass--performTeamSelection');
+    }
+    catch {
+        log.info('skip--performTeamSelection');
+    }
+}

package/dist/types/log.d.ts

@@ -0,0 +1,10 @@
+interface LoggerFn {
+    (message?: string, ...args: unknown[]): void;
+}
+export interface Logger {
+    error: LoggerFn;
+    warn: LoggerFn;
+    info: LoggerFn;
+}
+export {};
+//# sourceMappingURL=log.d.ts.map

package/dist/types/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/types/log.ts"],"names":[],"mappings":"AAGA,UAAU,QAAQ;IAChB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,QAAQ,CAAC;IAChB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;CAChB"}

package/dist/types/log.js

@@ -0,0 +1,3 @@
+// Copyright (c) 2019-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+export {};

package/dist/types/simulation.d.ts

@@ -0,0 +1,39 @@
+import type { Browser, BrowserContext, Page } from '@playwright/test';
+import type { Logger } from './log.js';
+export declare enum SessionState {
+    CREATING = "creating",// The browser and other instances are being created
+    CREATION_FAILED = "creation_failed",// The browser or any other instances failed to be created
+    CREATED = "created",// The browser and other instances were created successfully
+    STARTED = "started",// The test was started
+    STOPPING = "stopping",// The test was stopped by the user
+    COMPLETED = "completed",// The test was completed successfully
+    FAILED = "failed",// The test failed at any point
+    CLEANUP_FAILED = "cleanup_failed"
+}
+/**
+ * Browser instance containing a Playwright page and user credentials.
+ * This is the base interface that simulation scenarios receive.
+ */
+export type BrowserInstance = {
+    browser: Browser | null;
+    context: BrowserContext | null;
+    page: Page | null;
+    userId: string;
+    password: string;
+    createdAt: Date;
+    state: SessionState;
+};
+/**
+ * Registry item type for a browser simulation scenario.
+ */
+export interface SimulationRegistryItem {
+    /** Unique identifier for the simulation */
+    id: string;
+    /** Human-readable name for the simulation */
+    name?: string;
+    /** Description of what the simulation does */
+    description?: string;
+    /** The scenario function to execute */
+    scenario: (browserInstance: BrowserInstance, serverURL: string, logger: Logger, runInLoop?: boolean) => Promise<void>;
+}
+//# sourceMappingURL=simulation.d.ts.map

package/dist/types/simulation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../../src/types/simulation.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAC,MAAM,kBAAkB,CAAC;AAEpE,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAErC,oBAAY,YAAY;IACtB,QAAQ,aAAa,CAAE,oDAAoD;IAC3E,eAAe,oBAAoB,CAAE,0DAA0D;IAC/F,OAAO,YAAY,CAAE,4DAA4D;IACjF,OAAO,YAAY,CAAE,uBAAuB;IAC5C,QAAQ,aAAa,CAAE,mCAAmC;IAC1D,SAAS,cAAc,CAAE,sCAAsC;IAC/D,MAAM,WAAW,CAAE,+BAA+B;IAClD,cAAc,mBAAmB;CAClC;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,IAAI,CAAC;IAChB,KAAK,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,QAAQ,EAAE,CAAC,eAAe,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvH"}

package/dist/types/simulation.js

@@ -0,0 +1,13 @@
+// Copyright (c) 2019-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+export var SessionState;
+(function (SessionState) {
+    SessionState["CREATING"] = "creating";
+    SessionState["CREATION_FAILED"] = "creation_failed";
+    SessionState["CREATED"] = "created";
+    SessionState["STARTED"] = "started";
+    SessionState["STOPPING"] = "stopping";
+    SessionState["COMPLETED"] = "completed";
+    SessionState["FAILED"] = "failed";
+    SessionState["CLEANUP_FAILED"] = "cleanup_failed";
+})(SessionState || (SessionState = {}));

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@mattermost/loadtest-browser-lib",
+  "version": "1.31.0-0",
+  "description": "Shared types, helpers and utilities for Mattermost browser-based load testing simulations using Playwright",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mattermost/mattermost-load-test-ng.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mattermost/mattermost-load-test-ng/issues"
+  },
+  "homepage": "https://github.com/mattermost/mattermost-load-test-ng/tree/master/browser/src/lib#readme",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20 || >=22 || >=24",
+    "npm": ">=10 || >=11"
+  },
+  "scripts": {
+    "prepare": "tsc"
+  },
+  "dependencies": {
+    "@mattermost/playwright-lib": "11.4.0-0",
+    "@playwright/test": "^1.57.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}