@azure/microsoft-playwright-testing 1.0.0-alpha.20240911.2

package/dist/common/types.d.ts

@@ -0,0 +1,301 @@
+import type { Location, TestStep } from "@playwright/test/reporter";
+import { ServiceAuth, ServiceOS } from "./constants";
+import type { TokenCredential } from "@azure/identity";
+export type JwtPayload = {
+    iss?: string;
+    sub?: string;
+    aud?: string[] | string;
+    exp?: number;
+    nbf?: number;
+    iat?: number;
+    jti?: string;
+};
+export type AccessTokenClaims = JwtPayload & {
+    aid?: string;
+    accountId?: string;
+};
+/**
+ * @public
+ *
+ * Endpoint options for the service.
+ */
+export type EndpointOptions = {
+    /**
+     * @public
+     *
+     * A browser websocket endpoint to connect to.
+     */
+    wsEndpoint: string;
+};
+/**
+ * @public
+ *
+ * Connect options for the service.
+ */
+export type ConnectOptions = {
+    /**
+     * @public
+     *
+     * Additional HTTP headers to be sent with web socket connect request.
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * @public
+     *
+     * Exposes network available on the connecting client to the browser being connected to.
+     *
+     * @defaultValue `<loopback>`
+     */
+    exposeNetwork?: string;
+    /**
+     * @public
+     *
+     * Maximum time in milliseconds to wait for the connection to be established.
+     *
+     * @defaultValue `30000`
+     */
+    timeout?: number;
+    /**
+     * @public
+     *
+     * Slows down Playwright operations by the specified amount of milliseconds.
+     *
+     * @defaultValue `0`
+     */
+    slowMo?: number;
+};
+/**
+ * @public
+ *
+ * Browser connect options for the service. This includes endpoint options and connect options.
+ *
+ * @example
+ * ```
+ * import playwright, { test, expect, BrowserType } from "@playwright/test";
+ * import { getConnectOptions, BrowserConnectOptions } from "@azure/microsoft-playwright-testing";
+ *
+ * test("has title", async ({ browserName }) => {
+ *  const { wsEndpoint, options } : BrowserConnectOptions = await getConnectOptions();
+ *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);
+ *  const context = await browser.newContext();
+ *  const page = await context.newPage();
+ *
+ *  await page.goto("https://playwright.dev/");
+ *  await expect(page).toHaveTitle(/Playwright/);
+ *
+ *  await page.close();
+ *  await context.close();
+ *  await browser.close();
+ * });
+ * ```
+ */
+export type BrowserConnectOptions = EndpointOptions & {
+    options: ConnectOptions;
+};
+/**
+ * @public
+ *
+ * Base playwright configuration inputs required for generating the service config.
+ */
+export type PlaywrightConfigInput = {
+    /**
+     * @public
+     *
+     * Path to the global setup file. This file will be required and run before all the tests. It must export a single
+     * function that takes a [`TestConfig`] argument.
+     *
+     * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.
+     */
+    globalSetup?: string;
+    /**
+     * @public
+     *
+     * Path to the global teardown file. This file will be required and run after all the tests. It must export a single
+     * function. See also
+     * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-teardown | testConfig.globalTeardown}.
+     *
+     * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.
+     */
+    globalTeardown?: string;
+};
+/**
+ * @public
+ *
+ * Playwright configuration integrated with Microsoft Playwright Testing.
+ *
+ * @remarks
+ *
+ * GlobalSetup and globalTeardown wraps around any existing global setup
+ * and teardown present in the base playwright configuration and runs it.
+ */
+export type PlaywrightConfig = {
+    use?: {
+        connectOptions: BrowserConnectOptions;
+    };
+    globalSetup?: string;
+    globalTeardown?: string;
+};
+/**
+ * @public
+ *
+ * Additional options for the service.
+ */
+export type PlaywrightServiceAdditionalOptions = {
+    /**
+     * @public
+     *
+     * Authentication types supported by Microsoft Playwright Testing.
+     *
+     * @defaultValue  `ENTRA_ID`
+     */
+    serviceAuthType?: AuthenticationType;
+    /**
+     * @public
+     *
+     * Operating system types supported by Microsoft Playwright Testing.
+     *
+     * @defaultValue  `linux`
+     */
+    os?: OsType;
+    /**
+     * @public
+     *
+     * Run id for the test run.
+     *
+     * @defaultValue `current datetime as ISO string`
+     */
+    runId?: string;
+    /**
+     * @public
+     *
+     * Maximum time in milliseconds to wait for the connection to be established.
+     *
+     * @defaultValue `30000`
+     */
+    timeout?: number;
+    /**
+     * @public
+     *
+     * Slows down Playwright operations by the specified amount of milliseconds.
+     *
+     * @defaultValue `0`
+     */
+    slowMo?: number;
+    /**
+     * @public
+     *
+     * Exposes network available on the connecting client to the browser being connected to.
+     *
+     * @defaultValue `<loopback>`
+     */
+    exposeNetwork?: string;
+    /**
+     * @public
+     *
+     * Use cloud hosted browsers.
+     *
+     * @defaultValue `false`
+     */
+    useCloudHostedBrowsers?: boolean;
+    /**
+     * @public
+     *
+     * Custom token credential for Entra ID authentication. Learn more at {@link https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/using-azure-identity.md | Using Azure Identity}.
+     *
+     * @defaultValue `DefaultAzureCredential`
+     */
+    credential?: TokenCredential;
+};
+/**
+ * @public
+ *
+ * OS Types supported by Microsoft Playwright Testing.
+ */
+export type OsType = (typeof ServiceOS)[keyof typeof ServiceOS];
+/**
+ * @public
+ *
+ * Authentication types supported by Microsoft Playwright Testing.
+ */
+export type AuthenticationType = (typeof ServiceAuth)[keyof typeof ServiceAuth];
+export type ErrorDetails = {
+    message: string;
+    location?: Location;
+};
+export type ApiErrorMessage = {
+    [key: string]: {
+        [key: number]: string;
+    };
+};
+/**
+ * @public
+ *
+ * Optional configuration for MPT Reporter.
+ *
+ * @example
+ *
+ * ```
+ * import { defineConfig } from "@playwright/test";
+ *
+ * export default defineConfig({
+ *  reporter: [["@azure/microsoft-playwright-testing/reporter", {
+ *   enableGitHubSummary: true
+ *  }]],
+ * });
+ * ```
+ */
+export interface MPTReporterConfig {
+    /**
+     * @public
+     *
+     * Enable GitHub Actions annotations to diagnose test failures and deep link to MPT Portal.
+     *
+     * @defaultValue `true`
+     */
+    enableGitHubSummary?: boolean;
+    /**
+     * @public
+     *
+     * Enable result publishing for the test run. This will upload the test result and artifacts to the MPT Portal.
+     *
+     * @defaultValue `true`
+     */
+    enableResultPublish?: boolean;
+}
+export type DedupedStep = {
+    step: TestStep;
+    count: number;
+    duration: number;
+};
+export type RawTestStep = {
+    title: string;
+    category: string;
+    startTime: string;
+    duration: number;
+    error?: string;
+    steps: RawTestStep[];
+    location?: Location;
+    snippet?: string;
+    count: number;
+};
+export type IBackOffOptions = {
+    numOfAttempts: number;
+    retry: (e: any, attemptNumber: number) => boolean | Promise<boolean>;
+    jitter: JitterType;
+};
+export type JitterType = "full" | "none";
+export type VersionInfo = {
+    major: number;
+    minor: number;
+    patch: number;
+};
+export type PackageManager = {
+    runCommand: (command: string, args: string) => string;
+    getVersionFromStdout: (stdout: string) => string;
+};
+export interface FullConfig {
+    configFile?: string;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,qBAAqB,GAAG,eAAe,GAAG;IACpD,OAAO,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,CAAC,EAAE;QACJ,cAAc,EAAE,qBAAqB,CAAC;KACvC,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEhF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;CACH,CAAC;AACF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AACD,MAAM,MAAM,WAAW,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACrE,MAAM,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACtD,oBAAoB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;CAClD,CAAC;AAIF,MAAM,WAAW,UAAU;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/common/types.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/common/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Location, TestStep } from \"@playwright/test/reporter\";\nimport { ServiceAuth, ServiceOS } from \"./constants\";\nimport type { TokenCredential } from \"@azure/identity\";\n\nexport type JwtPayload = {\n  iss?: string;\n  sub?: string;\n  aud?: string[] | string;\n  exp?: number;\n  nbf?: number;\n  iat?: number;\n  jti?: string;\n};\n\nexport type AccessTokenClaims = JwtPayload & {\n  aid?: string;\n  accountId?: string;\n};\n\n/**\n * @public\n *\n * Endpoint options for the service.\n */\nexport type EndpointOptions = {\n  /**\n   * @public\n   *\n   * A browser websocket endpoint to connect to.\n   */\n  wsEndpoint: string;\n};\n\n/**\n * @public\n *\n * Connect options for the service.\n */\nexport type ConnectOptions = {\n  /**\n   * @public\n   *\n   * Additional HTTP headers to be sent with web socket connect request.\n   */\n  headers?: { [key: string]: string };\n\n  /**\n   * @public\n   *\n   * Exposes network available on the connecting client to the browser being connected to.\n   *\n   * @defaultValue `<loopback>`\n   */\n  exposeNetwork?: string;\n\n  /**\n   * @public\n   *\n   * Maximum time in milliseconds to wait for the connection to be established.\n   *\n   * @defaultValue `30000`\n   */\n  timeout?: number;\n\n  /**\n   * @public\n   *\n   * Slows down Playwright operations by the specified amount of milliseconds.\n   *\n   * @defaultValue `0`\n   */\n  slowMo?: number;\n};\n\n/**\n * @public\n *\n * Browser connect options for the service. This includes endpoint options and connect options.\n *\n * @example\n * ```\n * import playwright, { test, expect, BrowserType } from \"@playwright/test\";\n * import { getConnectOptions, BrowserConnectOptions } from \"@azure/microsoft-playwright-testing\";\n *\n * test(\"has title\", async ({ browserName }) => {\n *  const { wsEndpoint, options } : BrowserConnectOptions = await getConnectOptions();\n *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);\n *  const context = await browser.newContext();\n *  const page = await context.newPage();\n *\n *  await page.goto(\"https://playwright.dev/\");\n *  await expect(page).toHaveTitle(/Playwright/);\n *\n *  await page.close();\n *  await context.close();\n *  await browser.close();\n * });\n * ```\n */\nexport type BrowserConnectOptions = EndpointOptions & {\n  options: ConnectOptions;\n};\n\n/**\n * @public\n *\n * Base playwright configuration inputs required for generating the service config.\n */\nexport type PlaywrightConfigInput = {\n  /**\n   * @public\n   *\n   * Path to the global setup file. This file will be required and run before all the tests. It must export a single\n   * function that takes a [`TestConfig`] argument.\n   *\n   * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.\n   */\n  globalSetup?: string;\n\n  /**\n   * @public\n   *\n   * Path to the global teardown file. This file will be required and run after all the tests. It must export a single\n   * function. See also\n   * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-teardown | testConfig.globalTeardown}.\n   *\n   * Learn more about {@link https://playwright.dev/docs/test-global-setup-teardown | global setup and teardown}.\n   */\n  globalTeardown?: string;\n};\n\n/**\n * @public\n *\n * Playwright configuration integrated with Microsoft Playwright Testing.\n *\n * @remarks\n *\n * GlobalSetup and globalTeardown wraps around any existing global setup\n * and teardown present in the base playwright configuration and runs it.\n */\nexport type PlaywrightConfig = {\n  use?: {\n    connectOptions: BrowserConnectOptions;\n  };\n  globalSetup?: string;\n  globalTeardown?: string;\n};\n\n/**\n * @public\n *\n * Additional options for the service.\n */\nexport type PlaywrightServiceAdditionalOptions = {\n  /**\n   * @public\n   *\n   * Authentication types supported by Microsoft Playwright Testing.\n   *\n   * @defaultValue  `ENTRA_ID`\n   */\n  serviceAuthType?: AuthenticationType;\n\n  /**\n   * @public\n   *\n   * Operating system types supported by Microsoft Playwright Testing.\n   *\n   * @defaultValue  `linux`\n   */\n  os?: OsType;\n\n  /**\n   * @public\n   *\n   * Run id for the test run.\n   *\n   * @defaultValue `current datetime as ISO string`\n   */\n  runId?: string;\n\n  /**\n   * @public\n   *\n   * Maximum time in milliseconds to wait for the connection to be established.\n   *\n   * @defaultValue `30000`\n   */\n  timeout?: number;\n\n  /**\n   * @public\n   *\n   * Slows down Playwright operations by the specified amount of milliseconds.\n   *\n   * @defaultValue `0`\n   */\n  slowMo?: number;\n\n  /**\n   * @public\n   *\n   * Exposes network available on the connecting client to the browser being connected to.\n   *\n   * @defaultValue `<loopback>`\n   */\n  exposeNetwork?: string;\n\n  /**\n   * @public\n   *\n   * Use cloud hosted browsers.\n   *\n   * @defaultValue `false`\n   */\n  useCloudHostedBrowsers?: boolean;\n\n  /**\n   * @public\n   *\n   * Custom token credential for Entra ID authentication. Learn more at {@link https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/using-azure-identity.md | Using Azure Identity}.\n   *\n   * @defaultValue `DefaultAzureCredential`\n   */\n  credential?: TokenCredential;\n};\n\n/**\n * @public\n *\n * OS Types supported by Microsoft Playwright Testing.\n */\nexport type OsType = (typeof ServiceOS)[keyof typeof ServiceOS];\n\n/**\n * @public\n *\n * Authentication types supported by Microsoft Playwright Testing.\n */\nexport type AuthenticationType = (typeof ServiceAuth)[keyof typeof ServiceAuth];\n\nexport type ErrorDetails = {\n  message: string;\n  location?: Location;\n};\nexport type ApiErrorMessage = {\n  [key: string]: {\n    [key: number]: string;\n  };\n};\n/**\n * @public\n *\n * Optional configuration for MPT Reporter.\n *\n * @example\n *\n * ```\n * import { defineConfig } from \"@playwright/test\";\n *\n * export default defineConfig({\n *  reporter: [[\"@azure/microsoft-playwright-testing/reporter\", {\n *   enableGitHubSummary: true\n *  }]],\n * });\n * ```\n */\nexport interface MPTReporterConfig {\n  /**\n   * @public\n   *\n   * Enable GitHub Actions annotations to diagnose test failures and deep link to MPT Portal.\n   *\n   * @defaultValue `true`\n   */\n  enableGitHubSummary?: boolean;\n\n  /**\n   * @public\n   *\n   * Enable result publishing for the test run. This will upload the test result and artifacts to the MPT Portal.\n   *\n   * @defaultValue `true`\n   */\n  enableResultPublish?: boolean;\n}\nexport type DedupedStep = { step: TestStep; count: number; duration: number };\n\nexport type RawTestStep = {\n  title: string;\n  category: string;\n  startTime: string;\n  duration: number;\n  error?: string;\n  steps: RawTestStep[];\n  location?: Location;\n  snippet?: string;\n  count: number;\n};\n\nexport type IBackOffOptions = {\n  numOfAttempts: number;\n  retry: (e: any, attemptNumber: number) => boolean | Promise<boolean>;\n  jitter: JitterType;\n};\n\nexport type JitterType = \"full\" | \"none\";\n\nexport type VersionInfo = {\n  major: number;\n  minor: number;\n  patch: number;\n};\n\nexport type PackageManager = {\n  runCommand: (command: string, args: string) => string;\n  getVersionFromStdout: (stdout: string) => string;\n};\n\n// Playwright OSS Types\n\nexport interface FullConfig {\n  configFile?: string;\n}\n"]}

package/dist/core/global/playwright-service-global-setup.d.ts

@@ -0,0 +1,4 @@
+import { FullConfig } from "../../common/types";
+declare const playwrightServiceGlobalSetupWrapper: (config: FullConfig) => Promise<any>;
+export default playwrightServiceGlobalSetupWrapper;
+//# sourceMappingURL=playwright-service-global-setup.d.ts.map

package/dist/core/global/playwright-service-global-setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright-service-global-setup.d.ts","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-setup.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAKhD,QAAA,MAAM,mCAAmC,WAAkB,UAAU,KAAG,OAAO,CAAC,GAAG,CAWlF,CAAC;AAEF,eAAe,mCAAmC,CAAC"}

package/dist/core/global/playwright-service-global-setup.js

@@ -0,0 +1,19 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path_1 = require("path");
+const playwrightServiceEntra_1 = tslib_1.__importDefault(require("../playwrightServiceEntra"));
+const executor_1 = require("../../common/executor");
+const customerConfig_1 = tslib_1.__importDefault(require("../../common/customerConfig"));
+const playwrightServiceGlobalSetupWrapper = async (config) => {
+    const rootDir = config.configFile ? (0, path_1.dirname)(config.configFile) : process.cwd();
+    const customerGlobalSetupFunc = await (0, executor_1.loadCustomerGlobalFunction)(rootDir, customerConfig_1.default.globalSetup);
+    await playwrightServiceEntra_1.default.globalSetup();
+    if (customerGlobalSetupFunc) {
+        return customerGlobalSetupFunc(config);
+    }
+};
+exports.default = playwrightServiceGlobalSetupWrapper;
+//# sourceMappingURL=playwright-service-global-setup.js.map

package/dist/core/global/playwright-service-global-setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright-service-global-setup.js","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-setup.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,+BAA+B;AAE/B,+FAA+D;AAC/D,oDAAmE;AACnE,yFAAyD;AAEzD,MAAM,mCAAmC,GAAG,KAAK,EAAE,MAAkB,EAAgB,EAAE;IACrF,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,UAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAChF,MAAM,uBAAuB,GAAG,MAAM,IAAA,qCAA0B,EAC9D,OAAO,EACP,wBAAc,CAAC,WAAW,CAC3B,CAAC;IAEF,MAAM,gCAAsB,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,uBAAuB,EAAE,CAAC;QAC5B,OAAO,uBAAuB,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,mCAAmC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { dirname } from \"path\";\nimport { FullConfig } from \"../../common/types\";\nimport playwrightServiceEntra from \"../playwrightServiceEntra\";\nimport { loadCustomerGlobalFunction } from \"../../common/executor\";\nimport customerConfig from \"../../common/customerConfig\";\n\nconst playwrightServiceGlobalSetupWrapper = async (config: FullConfig): Promise<any> => {\n  const rootDir = config.configFile ? dirname(config.configFile!) : process.cwd();\n  const customerGlobalSetupFunc = await loadCustomerGlobalFunction(\n    rootDir,\n    customerConfig.globalSetup,\n  );\n\n  await playwrightServiceEntra.globalSetup();\n  if (customerGlobalSetupFunc) {\n    return customerGlobalSetupFunc(config);\n  }\n};\n\nexport default playwrightServiceGlobalSetupWrapper;\n"]}

package/dist/core/global/playwright-service-global-teardown.d.ts

@@ -0,0 +1,4 @@
+import { FullConfig } from "../../common/types";
+declare const playwrightServiceGlobalTeardownWrapper: (config: FullConfig) => Promise<void>;
+export default playwrightServiceGlobalTeardownWrapper;
+//# sourceMappingURL=playwright-service-global-teardown.d.ts.map

package/dist/core/global/playwright-service-global-teardown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright-service-global-teardown.d.ts","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-teardown.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAKhD,QAAA,MAAM,sCAAsC,WAAkB,UAAU,KAAG,OAAO,CAAC,IAAI,CAWtF,CAAC;AAEF,eAAe,sCAAsC,CAAC"}

package/dist/core/global/playwright-service-global-teardown.js

@@ -0,0 +1,19 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path_1 = require("path");
+const playwrightServiceEntra_1 = tslib_1.__importDefault(require("../playwrightServiceEntra"));
+const executor_1 = require("../../common/executor");
+const customerConfig_1 = tslib_1.__importDefault(require("../../common/customerConfig"));
+const playwrightServiceGlobalTeardownWrapper = async (config) => {
+    const rootDir = config.configFile ? (0, path_1.dirname)(config.configFile) : process.cwd();
+    const customerGlobalTeardownFunc = await (0, executor_1.loadCustomerGlobalFunction)(rootDir, customerConfig_1.default.globalTeardown);
+    playwrightServiceEntra_1.default.globalTeardown();
+    if (customerGlobalTeardownFunc) {
+        await customerGlobalTeardownFunc(config);
+    }
+};
+exports.default = playwrightServiceGlobalTeardownWrapper;
+//# sourceMappingURL=playwright-service-global-teardown.js.map

package/dist/core/global/playwright-service-global-teardown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright-service-global-teardown.js","sourceRoot":"","sources":["../../../src/core/global/playwright-service-global-teardown.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,+BAA+B;AAE/B,+FAA+D;AAC/D,oDAAmE;AACnE,yFAAyD;AAEzD,MAAM,sCAAsC,GAAG,KAAK,EAAE,MAAkB,EAAiB,EAAE;IACzF,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,UAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAChF,MAAM,0BAA0B,GAAG,MAAM,IAAA,qCAA0B,EACjE,OAAO,EACP,wBAAc,CAAC,cAAc,CAC9B,CAAC;IAEF,gCAAsB,CAAC,cAAc,EAAE,CAAC;IACxC,IAAI,0BAA0B,EAAE,CAAC;QAC/B,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,sCAAsC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { dirname } from \"path\";\nimport { FullConfig } from \"../../common/types\";\nimport playwrightServiceEntra from \"../playwrightServiceEntra\";\nimport { loadCustomerGlobalFunction } from \"../../common/executor\";\nimport customerConfig from \"../../common/customerConfig\";\n\nconst playwrightServiceGlobalTeardownWrapper = async (config: FullConfig): Promise<void> => {\n  const rootDir = config.configFile ? dirname(config.configFile!) : process.cwd();\n  const customerGlobalTeardownFunc = await loadCustomerGlobalFunction(\n    rootDir,\n    customerConfig.globalTeardown,\n  );\n\n  playwrightServiceEntra.globalTeardown();\n  if (customerGlobalTeardownFunc) {\n    await customerGlobalTeardownFunc(config);\n  }\n};\n\nexport default playwrightServiceGlobalTeardownWrapper;\n"]}

package/dist/core/playwrightService.d.ts

@@ -0,0 +1,63 @@
+import { PlaywrightServiceAdditionalOptions, PlaywrightConfig, PlaywrightConfigInput, BrowserConnectOptions } from "../common/types";
+/**
+ * @public
+ *
+ * Generate playwright configuration integrated with Microsoft Playwright Testing.
+ *
+ * @param config - base playwright configuration
+ * @param options - additional options for the service
+ * @returns PlaywrightConfig
+ *
+ * @example
+ * ```
+ * import { defineConfig } from "playwright/test";
+ * import { getServiceConfig } from "@azure/microsoft-playwright-testing";
+ * import playwrightConfig from "./playwright.config";
+ *
+ * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig));
+ * ```
+ *
+ * @example
+ * ```
+ * import { defineConfig } from "playwright/test";
+ * import { getServiceConfig, ServiceOS } from "@azure/microsoft-playwright-testing";
+ * import playwrightConfig from "./playwright.config";
+ *
+ * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig, {
+ *  runId: "custom run id",
+ *  os: ServiceOS.WINDOWS
+ * }));
+ * ```
+ */
+declare const getServiceConfig: (config: PlaywrightConfigInput, options?: PlaywrightServiceAdditionalOptions) => PlaywrightConfig;
+/**
+ * @public
+ *
+ * Get connect options required to connect to Microsoft Playwright Testing's cloud hosted browsers.
+ *
+ * @param options - additional options for the service
+ * @returns BrowserConnectOptions
+ *
+ * @example
+ * ```
+ * import playwright, { test, expect, BrowserType } from "@playwright/test";
+ * import { getConnectOptions } from "@azure/microsoft-playwright-testing";
+ *
+ * test('has title', async ({ browserName }) => {
+ *  const { wsEndpoint, options } = await getConnectOptions();
+ *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);
+ *  const context = await browser.newContext();
+ *  const page = await context.newPage();
+ *
+ *  await page.goto('https://playwright.dev/');
+ *  await expect(page).toHaveTitle(/Playwright/);
+ *
+ *  await page.close();
+ *  await context.close();
+ *  await browser.close();
+ * });
+ * ```
+ */
+declare const getConnectOptions: (options?: Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">) => Promise<BrowserConnectOptions>;
+export { getServiceConfig, getConnectOptions };
+//# sourceMappingURL=playwrightService.d.ts.map

package/dist/core/playwrightService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwrightService.d.ts","sourceRoot":"","sources":["../../src/core/playwrightService.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,kCAAkC,EAClC,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,QAAA,MAAM,gBAAgB,WACZ,qBAAqB,YACnB,kCAAkC,KAC3C,gBAqDF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,QAAA,MAAM,iBAAiB,aACX,IAAI,CAAC,kCAAkC,EAAE,iBAAiB,CAAC,KACpE,OAAO,CAAC,qBAAqB,CAmB/B,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/core/playwrightService.js

@@ -0,0 +1,131 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnectOptions = exports.getServiceConfig = void 0;
+const tslib_1 = require("tslib");
+const constants_1 = require("../common/constants");
+const customerConfig_1 = tslib_1.__importDefault(require("../common/customerConfig"));
+const playwrightServiceConfig_1 = require("../common/playwrightServiceConfig");
+const playwrightServiceEntra_1 = tslib_1.__importDefault(require("./playwrightServiceEntra"));
+const utils_1 = require("../utils/utils");
+/**
+ * @public
+ *
+ * Generate playwright configuration integrated with Microsoft Playwright Testing.
+ *
+ * @param config - base playwright configuration
+ * @param options - additional options for the service
+ * @returns PlaywrightConfig
+ *
+ * @example
+ * ```
+ * import { defineConfig } from "playwright/test";
+ * import { getServiceConfig } from "@azure/microsoft-playwright-testing";
+ * import playwrightConfig from "./playwright.config";
+ *
+ * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig));
+ * ```
+ *
+ * @example
+ * ```
+ * import { defineConfig } from "playwright/test";
+ * import { getServiceConfig, ServiceOS } from "@azure/microsoft-playwright-testing";
+ * import playwrightConfig from "./playwright.config";
+ *
+ * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig, {
+ *  runId: "custom run id",
+ *  os: ServiceOS.WINDOWS
+ * }));
+ * ```
+ */
+const getServiceConfig = (config, options) => {
+    (0, utils_1.validatePlaywrightVersion)();
+    (0, utils_1.validateServiceUrl)();
+    if (options === null || options === void 0 ? void 0 : options.credential) {
+        playwrightServiceEntra_1.default.entraIdAccessToken = options.credential;
+    }
+    if (config.globalSetup) {
+        customerConfig_1.default.globalSetup = config.globalSetup;
+    }
+    if (config.globalTeardown) {
+        customerConfig_1.default.globalTeardown = config.globalTeardown;
+    }
+    const playwrightServiceConfig = new playwrightServiceConfig_1.PlaywrightServiceConfig();
+    playwrightServiceConfig.setOptions(options);
+    (0, utils_1.emitReportingUrl)();
+    const globalFunctions = {};
+    if ((options === null || options === void 0 ? void 0 : options.serviceAuthType) === constants_1.ServiceAuth.ACCESS_TOKEN) {
+        // mpt PAT requested and set by the customer, no need to setup entra lifecycle handlers
+        (0, utils_1.validateMptPAT)();
+    }
+    else {
+        globalFunctions.globalSetup = require.resolve("./global/playwright-service-global-setup");
+        globalFunctions.globalTeardown = require.resolve("./global/playwright-service-global-teardown");
+    }
+    if ((options === null || options === void 0 ? void 0 : options.useCloudHostedBrowsers) === false) {
+        return Object.assign({}, globalFunctions);
+    }
+    if (!process.env[constants_1.InternalEnvironmentVariables.MPT_CLOUD_HOSTED_BROWSER_USED]) {
+        process.env[constants_1.InternalEnvironmentVariables.MPT_CLOUD_HOSTED_BROWSER_USED] = "true";
+        console.log("\nRunning tests using Microsoft Playwright Testing service.");
+    }
+    return Object.assign({ use: {
+            connectOptions: {
+                wsEndpoint: (0, utils_1.getServiceWSEndpoint)(playwrightServiceConfig.runId, playwrightServiceConfig.serviceOs),
+                headers: {
+                    Authorization: `Bearer ${(0, utils_1.getAccessToken)()}`,
+                },
+                timeout: playwrightServiceConfig.timeout,
+                exposeNetwork: playwrightServiceConfig.exposeNetwork,
+                slowMo: playwrightServiceConfig.slowMo,
+            },
+        } }, globalFunctions);
+};
+exports.getServiceConfig = getServiceConfig;
+/**
+ * @public
+ *
+ * Get connect options required to connect to Microsoft Playwright Testing's cloud hosted browsers.
+ *
+ * @param options - additional options for the service
+ * @returns BrowserConnectOptions
+ *
+ * @example
+ * ```
+ * import playwright, { test, expect, BrowserType } from "@playwright/test";
+ * import { getConnectOptions } from "@azure/microsoft-playwright-testing";
+ *
+ * test('has title', async ({ browserName }) => {
+ *  const { wsEndpoint, options } = await getConnectOptions();
+ *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);
+ *  const context = await browser.newContext();
+ *  const page = await context.newPage();
+ *
+ *  await page.goto('https://playwright.dev/');
+ *  await expect(page).toHaveTitle(/Playwright/);
+ *
+ *  await page.close();
+ *  await context.close();
+ *  await browser.close();
+ * });
+ * ```
+ */
+const getConnectOptions = async (options) => {
+    const playwrightServiceConfig = new playwrightServiceConfig_1.PlaywrightServiceConfig();
+    playwrightServiceConfig.setOptions(options);
+    const token = await (0, utils_1.fetchOrValidateAccessToken)(options === null || options === void 0 ? void 0 : options.credential);
+    return {
+        wsEndpoint: (0, utils_1.getServiceWSEndpoint)(playwrightServiceConfig.runId, playwrightServiceConfig.serviceOs),
+        options: {
+            headers: {
+                Authorization: `Bearer ${token}`,
+            },
+            timeout: playwrightServiceConfig.timeout,
+            exposeNetwork: playwrightServiceConfig.exposeNetwork,
+            slowMo: playwrightServiceConfig.slowMo,
+        },
+    };
+};
+exports.getConnectOptions = getConnectOptions;
+//# sourceMappingURL=playwrightService.js.map

package/dist/core/playwrightService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwrightService.js","sourceRoot":"","sources":["../../src/core/playwrightService.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC,mDAAgF;AAChF,sFAAsD;AACtD,+EAA4E;AAC5E,8FAA8D;AAO9D,0CAQwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,gBAAgB,GAAG,CACvB,MAA6B,EAC7B,OAA4C,EAC1B,EAAE;IACpB,IAAA,iCAAyB,GAAE,CAAC;IAC5B,IAAA,0BAAkB,GAAE,CAAC;IACrB,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE,CAAC;QACxB,gCAAsB,CAAC,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IACjE,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,wBAAc,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;IAClD,CAAC;IACD,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,wBAAc,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IACxD,CAAC;IAED,MAAM,uBAAuB,GAAG,IAAI,iDAAuB,EAAE,CAAC;IAC9D,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAA,wBAAgB,GAAE,CAAC;IAEnB,MAAM,eAAe,GAAQ,EAAE,CAAC;IAChC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,MAAK,uBAAW,CAAC,YAAY,EAAE,CAAC;QAC1D,uFAAuF;QACvF,IAAA,sBAAc,GAAE,CAAC;IACnB,CAAC;SAAM,CAAC;QACN,eAAe,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC;QAC1F,eAAe,CAAC,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,6CAA6C,CAAC,CAAC;IAClG,CAAC;IAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,sBAAsB,MAAK,KAAK,EAAE,CAAC;QAC9C,yBACK,eAAe,EAClB;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAA4B,CAAC,6BAA6B,CAAC,EAAE,CAAC;QAC7E,OAAO,CAAC,GAAG,CAAC,wCAA4B,CAAC,6BAA6B,CAAC,GAAG,MAAM,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAC;IAC7E,CAAC;IAED,uBACE,GAAG,EAAE;YACH,cAAc,EAAE;gBACd,UAAU,EAAE,IAAA,4BAAoB,EAC9B,uBAAuB,CAAC,KAAK,EAC7B,uBAAuB,CAAC,SAAS,CAClC;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,IAAA,sBAAc,GAAE,EAAE;iBAC5C;gBACD,OAAO,EAAE,uBAAuB,CAAC,OAAO;gBACxC,aAAa,EAAE,uBAAuB,CAAC,aAAa;gBACpD,MAAM,EAAE,uBAAuB,CAAC,MAAM;aACvC;SACF,IACE,eAAe,EAClB;AACJ,CAAC,CAAC;AAqDO,4CAAgB;AAnDzB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,iBAAiB,GAAG,KAAK,EAC7B,OAAqE,EACrC,EAAE;IAClC,MAAM,uBAAuB,GAAG,IAAI,iDAAuB,EAAE,CAAC;IAC9D,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAE5C,MAAM,KAAK,GAAG,MAAM,IAAA,kCAA0B,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,CAAC,CAAC;IACpE,OAAO;QACL,UAAU,EAAE,IAAA,4BAAoB,EAC9B,uBAAuB,CAAC,KAAK,EAC7B,uBAAuB,CAAC,SAAS,CAClC;QACD,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,EAAE;aACjC;YACD,OAAO,EAAE,uBAAuB,CAAC,OAAO;YACxC,aAAa,EAAE,uBAAuB,CAAC,aAAa;YACpD,MAAM,EAAE,uBAAuB,CAAC,MAAM;SACvC;KACF,CAAC;AACJ,CAAC,CAAC;AAEyB,8CAAiB","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { InternalEnvironmentVariables, ServiceAuth } from \"../common/constants\";\nimport customerConfig from \"../common/customerConfig\";\nimport { PlaywrightServiceConfig } from \"../common/playwrightServiceConfig\";\nimport playwrightServiceEntra from \"./playwrightServiceEntra\";\nimport {\n  PlaywrightServiceAdditionalOptions,\n  PlaywrightConfig,\n  PlaywrightConfigInput,\n  BrowserConnectOptions,\n} from \"../common/types\";\nimport {\n  emitReportingUrl,\n  fetchOrValidateAccessToken,\n  getAccessToken,\n  getServiceWSEndpoint,\n  validateMptPAT,\n  validatePlaywrightVersion,\n  validateServiceUrl,\n} from \"../utils/utils\";\n\n/**\n * @public\n *\n * Generate playwright configuration integrated with Microsoft Playwright Testing.\n *\n * @param config - base playwright configuration\n * @param options - additional options for the service\n * @returns PlaywrightConfig\n *\n * @example\n * ```\n * import { defineConfig } from \"playwright/test\";\n * import { getServiceConfig } from \"@azure/microsoft-playwright-testing\";\n * import playwrightConfig from \"./playwright.config\";\n *\n * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig));\n * ```\n *\n * @example\n * ```\n * import { defineConfig } from \"playwright/test\";\n * import { getServiceConfig, ServiceOS } from \"@azure/microsoft-playwright-testing\";\n * import playwrightConfig from \"./playwright.config\";\n *\n * export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig, {\n *  runId: \"custom run id\",\n *  os: ServiceOS.WINDOWS\n * }));\n * ```\n */\nconst getServiceConfig = (\n  config: PlaywrightConfigInput,\n  options?: PlaywrightServiceAdditionalOptions,\n): PlaywrightConfig => {\n  validatePlaywrightVersion();\n  validateServiceUrl();\n  if (options?.credential) {\n    playwrightServiceEntra.entraIdAccessToken = options.credential;\n  }\n  if (config.globalSetup) {\n    customerConfig.globalSetup = config.globalSetup;\n  }\n  if (config.globalTeardown) {\n    customerConfig.globalTeardown = config.globalTeardown;\n  }\n\n  const playwrightServiceConfig = new PlaywrightServiceConfig();\n  playwrightServiceConfig.setOptions(options);\n  emitReportingUrl();\n\n  const globalFunctions: any = {};\n  if (options?.serviceAuthType === ServiceAuth.ACCESS_TOKEN) {\n    // mpt PAT requested and set by the customer, no need to setup entra lifecycle handlers\n    validateMptPAT();\n  } else {\n    globalFunctions.globalSetup = require.resolve(\"./global/playwright-service-global-setup\");\n    globalFunctions.globalTeardown = require.resolve(\"./global/playwright-service-global-teardown\");\n  }\n\n  if (options?.useCloudHostedBrowsers === false) {\n    return {\n      ...globalFunctions,\n    };\n  }\n  if (!process.env[InternalEnvironmentVariables.MPT_CLOUD_HOSTED_BROWSER_USED]) {\n    process.env[InternalEnvironmentVariables.MPT_CLOUD_HOSTED_BROWSER_USED] = \"true\";\n    console.log(\"\\nRunning tests using Microsoft Playwright Testing service.\");\n  }\n\n  return {\n    use: {\n      connectOptions: {\n        wsEndpoint: getServiceWSEndpoint(\n          playwrightServiceConfig.runId,\n          playwrightServiceConfig.serviceOs,\n        ),\n        headers: {\n          Authorization: `Bearer ${getAccessToken()}`,\n        },\n        timeout: playwrightServiceConfig.timeout,\n        exposeNetwork: playwrightServiceConfig.exposeNetwork,\n        slowMo: playwrightServiceConfig.slowMo,\n      },\n    },\n    ...globalFunctions,\n  };\n};\n\n/**\n * @public\n *\n * Get connect options required to connect to Microsoft Playwright Testing's cloud hosted browsers.\n *\n * @param options - additional options for the service\n * @returns BrowserConnectOptions\n *\n * @example\n * ```\n * import playwright, { test, expect, BrowserType } from \"@playwright/test\";\n * import { getConnectOptions } from \"@azure/microsoft-playwright-testing\";\n *\n * test('has title', async ({ browserName }) => {\n *  const { wsEndpoint, options } = await getConnectOptions();\n *  const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);\n *  const context = await browser.newContext();\n *  const page = await context.newPage();\n *\n *  await page.goto('https://playwright.dev/');\n *  await expect(page).toHaveTitle(/Playwright/);\n *\n *  await page.close();\n *  await context.close();\n *  await browser.close();\n * });\n * ```\n */\nconst getConnectOptions = async (\n  options?: Omit<PlaywrightServiceAdditionalOptions, \"serviceAuthType\">,\n): Promise<BrowserConnectOptions> => {\n  const playwrightServiceConfig = new PlaywrightServiceConfig();\n  playwrightServiceConfig.setOptions(options);\n\n  const token = await fetchOrValidateAccessToken(options?.credential);\n  return {\n    wsEndpoint: getServiceWSEndpoint(\n      playwrightServiceConfig.runId,\n      playwrightServiceConfig.serviceOs,\n    ),\n    options: {\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n      timeout: playwrightServiceConfig.timeout,\n      exposeNetwork: playwrightServiceConfig.exposeNetwork,\n      slowMo: playwrightServiceConfig.slowMo,\n    },\n  };\n};\n\nexport { getServiceConfig, getConnectOptions };\n"]}

package/dist/core/playwrightServiceEntra.d.ts

@@ -0,0 +1,16 @@
+import type { TokenCredential } from "@azure/identity";
+declare class PlaywrightServiceEntra {
+    private _entraIdAccessTokenRotationInterval?;
+    private static instance;
+    private _entraIdAccessToken;
+    static getInstance: () => PlaywrightServiceEntra;
+    set entraIdAccessToken(credential: TokenCredential);
+    constructor();
+    globalSetup: () => Promise<void>;
+    globalTeardown: () => void;
+    private entraIdGlobalSetupRotationHandler;
+    private entraIdAccessTokenRotation;
+}
+declare const instance: PlaywrightServiceEntra;
+export default instance;
+//# sourceMappingURL=playwrightServiceEntra.d.ts.map

package/dist/core/playwrightServiceEntra.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwrightServiceEntra.d.ts","sourceRoot":"","sources":["../../src/core/playwrightServiceEntra.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,cAAM,sBAAsB;IAC1B,OAAO,CAAC,mCAAmC,CAAC,CAAiB;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAyB;IAChD,OAAO,CAAC,mBAAmB,CAAqB;IAEhD,MAAM,CAAC,WAAW,QAAO,sBAAsB,CAK7C;IAEF,IAAI,kBAAkB,CAAC,UAAU,EAAE,eAAe,EAEjD;;IAMM,WAAW,QAAa,OAAO,CAAC,IAAI,CAAC,CAI1C;IAEK,cAAc,QAAO,IAAI,CAM9B;IAEF,OAAO,CAAC,iCAAiC,CAMvC;IAEF,OAAO,CAAC,0BAA0B,CAShC;CACH;AAED,QAAA,MAAM,QAAQ,wBAAuC,CAAC;AACtD,eAAe,QAAQ,CAAC"}