@azure/microsoft-playwright-testing 1.0.0-alpha.20250317.1 → 1.0.0-alpha.20250319.2

package/dist/commonjs/utils/utils.d.ts

@@ -0,0 +1,28 @@
+import type { VersionInfo } from "../common/types.js";
+import type { TokenCredential } from "@azure/identity";
+export { getPlaywrightVersion } from "./getPlaywrightVersion.js";
+export { parseJwt } from "./parseJwt.js";
+export declare const exitWithFailureMessage: (error: {
+    key: string;
+    message: string;
+}) => never;
+export declare const populateValuesFromServiceUrl: () => {
+    region: string;
+    accountId: string;
+} | null;
+export declare const getAccessToken: () => string | undefined;
+export declare const getServiceBaseURL: () => string | undefined;
+export declare const getAndSetRunId: () => string;
+export declare const getServiceWSEndpoint: (runId: string, os: string) => string;
+export declare const validateServiceUrl: () => void;
+export declare const validateMptPAT: (validationFailureCallback: (error: {
+    key: string;
+    message: string;
+}) => void) => void;
+export declare const warnIfAccessTokenCloseToExpiry: () => void;
+export declare const fetchOrValidateAccessToken: (credential?: TokenCredential) => Promise<string>;
+export declare const emitReportingUrl: () => void;
+export declare const getPackageVersion: () => string;
+export declare const getVersionInfo: (version: string) => VersionInfo;
+export declare const validatePlaywrightVersion: () => void;
+//# sourceMappingURL=utils.d.ts.map

package/dist/commonjs/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/utils/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAc,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAUlE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AASvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,eAAO,MAAM,sBAAsB,GAAI,OAAO;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,KAAG,KAKhF,CAAC;AAEF,eAAO,MAAM,4BAA4B,QAAO;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,IAevF,CAAC;AAEF,eAAO,MAAM,cAAc,QAAO,MAAM,GAAG,SAE1C,CAAC;AAEF,eAAO,MAAM,iBAAiB,QAAO,MAAM,GAAG,SAE7C,CAAC;AAEF,eAAO,MAAM,cAAc,QAAO,MAIjC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAI,OAAO,MAAM,EAAE,IAAI,MAAM,KAAG,MAEhE,CAAC;AAEF,eAAO,MAAM,kBAAkB,QAAO,IAKrC,CAAC;AAEF,eAAO,MAAM,cAAc,GACzB,2BAA2B,CAAC,KAAK,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,KAAK,IAAI,KAC3E,IAqBF,CAAC;AAYF,eAAO,MAAM,8BAA8B,QAAO,IAOjD,CAAC;AAEF,eAAO,MAAM,0BAA0B,GAAU,aAAa,eAAe,KAAG,OAAO,CAAC,MAAM,CAS7F,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAAO,IAUnC,CAAC;AAEF,eAAO,MAAM,iBAAiB,QAAO,MASpC,CAAC;AACF,eAAO,MAAM,cAAc,GAAI,SAAS,MAAM,KAAG,WAYhD,CAAC;AAEF,eAAO,MAAM,yBAAyB,QAAO,IAc5C,CAAC"}

package/dist/{utils → commonjs/utils}/utils.js

@@ -2,16 +2,22 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validatePlaywrightVersion = exports.getVersionInfo = exports.getPackageVersion = exports.getPlaywrightVersion = exports.emitReportingUrl = exports.fetchOrValidateAccessToken = exports.warnIfAccessTokenCloseToExpiry = exports.validateMptPAT = exports.validateServiceUrl = exports.getServiceWSEndpoint = exports.getAndSetRunId = exports.getServiceBaseURL = exports.getAccessToken = exports.parseJwt = exports.populateValuesFromServiceUrl = exports.base64UrlDecode = exports.exitWithFailureMessage = void 0;
+exports.validatePlaywrightVersion = exports.getVersionInfo = exports.getPackageVersion = exports.emitReportingUrl = exports.fetchOrValidateAccessToken = exports.warnIfAccessTokenCloseToExpiry = exports.validateMptPAT = exports.validateServiceUrl = exports.getServiceWSEndpoint = exports.getAndSetRunId = exports.getServiceBaseURL = exports.getAccessToken = exports.populateValuesFromServiceUrl = exports.exitWithFailureMessage = exports.parseJwt = exports.getPlaywrightVersion = void 0;
 const tslib_1 = require("tslib");
-const constants_1 = require("../common/constants");
-const messages_1 = require("../common/messages");
-const entraIdAccessToken_1 = require("../common/entraIdAccessToken");
-const logger_1 = require("../common/logger");
-const reporterUtils_1 = tslib_1.__importDefault(require("./reporterUtils"));
-const cIInfoProvider_1 = require("./cIInfoProvider");
-const packageManager_1 = require("./packageManager");
-const child_process_1 = require("child_process");
+const constants_js_1 = require("../common/constants.js");
+const messages_js_1 = require("../common/messages.js");
+const logger_js_1 = require("../common/logger.js");
+const reporterUtils_js_1 = tslib_1.__importDefault(require("./reporterUtils.js"));
+const cIInfoProvider_js_1 = require("./cIInfoProvider.js");
+const process = tslib_1.__importStar(require("node:process"));
+const parseJwt_js_1 = require("./parseJwt.js");
+const getPlaywrightVersion_js_1 = require("./getPlaywrightVersion.js");
+const entraIdAccessToken_js_1 = require("../common/entraIdAccessToken.js");
+// Re-exporting for backward compatibility
+var getPlaywrightVersion_js_2 = require("./getPlaywrightVersion.js");
+Object.defineProperty(exports, "getPlaywrightVersion", { enumerable: true, get: function () { return getPlaywrightVersion_js_2.getPlaywrightVersion; } });
+var parseJwt_js_2 = require("./parseJwt.js");
+Object.defineProperty(exports, "parseJwt", { enumerable: true, get: function () { return parseJwt_js_2.parseJwt; } });
 const exitWithFailureMessage = (error) => {
     console.log();
     console.error(error.message);
@@ -19,16 +25,10 @@ const exitWithFailureMessage = (error) => {
     process.exit(1);
 };
 exports.exitWithFailureMessage = exitWithFailureMessage;
-const base64UrlDecode = (base64Url) => {
-    const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
-    const buffer = Buffer.from(base64, "base64");
-    return buffer.toString("utf-8");
-};
-exports.base64UrlDecode = base64UrlDecode;
 const populateValuesFromServiceUrl = () => {
     // Service URL format: wss://<region>.api.playwright.microsoft.com/accounts/<workspace-id>/browsers
     const url = process.env["PLAYWRIGHT_SERVICE_URL"];
-    if (!reporterUtils_1.default.isNullOrEmpty(url)) {
+    if (!reporterUtils_js_1.default.isNullOrEmpty(url)) {
         const parts = url.split("/");
         if (parts.length > 2) {
             const subdomainParts = parts[2].split(".");
@@ -40,37 +40,28 @@ const populateValuesFromServiceUrl = () => {
     return null;
 };
 exports.populateValuesFromServiceUrl = populateValuesFromServiceUrl;
-const parseJwt = (token) => {
-    const parts = token.split(".");
-    if (parts.length !== 3) {
-        throw new Error("Invalid JWT token.");
-    }
-    const payload = (0, exports.base64UrlDecode)(parts[1]);
-    return JSON.parse(payload);
-};
-exports.parseJwt = parseJwt;
 const getAccessToken = () => {
-    return process.env[constants_1.ServiceEnvironmentVariable.PLAYWRIGHT_SERVICE_ACCESS_TOKEN];
+    return process.env[constants_js_1.ServiceEnvironmentVariable.PLAYWRIGHT_SERVICE_ACCESS_TOKEN];
 };
 exports.getAccessToken = getAccessToken;
 const getServiceBaseURL = () => {
-    return process.env[constants_1.ServiceEnvironmentVariable.PLAYWRIGHT_SERVICE_URL];
+    return process.env[constants_js_1.ServiceEnvironmentVariable.PLAYWRIGHT_SERVICE_URL];
 };
 exports.getServiceBaseURL = getServiceBaseURL;
 const getAndSetRunId = () => {
-    const runId = reporterUtils_1.default.getRunId(cIInfoProvider_1.CIInfoProvider.getCIInfo());
-    process.env[constants_1.InternalEnvironmentVariables.MPT_SERVICE_RUN_ID] = runId;
+    const runId = reporterUtils_js_1.default.getRunId(cIInfoProvider_js_1.CIInfoProvider.getCIInfo());
+    process.env[constants_js_1.InternalEnvironmentVariables.MPT_SERVICE_RUN_ID] = runId;
     return runId;
 };
 exports.getAndSetRunId = getAndSetRunId;
 const getServiceWSEndpoint = (runId, os) => {
-    return `${(0, exports.getServiceBaseURL)()}?runId=${encodeURIComponent(runId)}&os=${os}&api-version=${constants_1.API_VERSION}`;
+    return `${(0, exports.getServiceBaseURL)()}?runId=${encodeURIComponent(runId)}&os=${os}&api-version=${constants_js_1.API_VERSION}`;
 };
 exports.getServiceWSEndpoint = getServiceWSEndpoint;
 const validateServiceUrl = () => {
     const serviceUrl = (0, exports.getServiceBaseURL)();
     if (!serviceUrl) {
-        (0, exports.exitWithFailureMessage)(messages_1.ServiceErrorMessageConstants.NO_SERVICE_URL_ERROR);
+        (0, exports.exitWithFailureMessage)(messages_js_1.ServiceErrorMessageConstants.NO_SERVICE_URL_ERROR);
     }
 };
 exports.validateServiceUrl = validateServiceUrl;
@@ -79,37 +70,37 @@ const validateMptPAT = (validationFailureCallback) => {
         const accessToken = (0, exports.getAccessToken)();
         const result = (0, exports.populateValuesFromServiceUrl)();
         if (!accessToken) {
-            validationFailureCallback(messages_1.ServiceErrorMessageConstants.NO_AUTH_ERROR);
+            validationFailureCallback(messages_js_1.ServiceErrorMessageConstants.NO_AUTH_ERROR);
         }
-        const claims = (0, exports.parseJwt)(accessToken);
+        const claims = (0, parseJwt_js_1.parseJwt)(accessToken);
         if (!claims.exp) {
-            validationFailureCallback(messages_1.ServiceErrorMessageConstants.INVALID_MPT_PAT_ERROR);
+            validationFailureCallback(messages_js_1.ServiceErrorMessageConstants.INVALID_MPT_PAT_ERROR);
         }
         if (Date.now() >= claims.exp * 1000) {
-            validationFailureCallback(messages_1.ServiceErrorMessageConstants.EXPIRED_MPT_PAT_ERROR);
+            validationFailureCallback(messages_js_1.ServiceErrorMessageConstants.EXPIRED_MPT_PAT_ERROR);
         }
         if (result.accountId !== claims.aid) {
-            validationFailureCallback(messages_1.ServiceErrorMessageConstants.WORKSPACE_MISMATCH_ERROR);
+            validationFailureCallback(messages_js_1.ServiceErrorMessageConstants.WORKSPACE_MISMATCH_ERROR);
         }
     }
     catch (err) {
-        logger_1.coreLogger.error(err);
-        (0, exports.exitWithFailureMessage)(messages_1.ServiceErrorMessageConstants.INVALID_MPT_PAT_ERROR);
+        logger_js_1.coreLogger.error(err);
+        (0, exports.exitWithFailureMessage)(messages_js_1.ServiceErrorMessageConstants.INVALID_MPT_PAT_ERROR);
     }
 };
 exports.validateMptPAT = validateMptPAT;
 const isTokenExpiringSoon = (expirationTime, currentTime) => {
-    return expirationTime * 1000 - currentTime <= constants_1.Constants.sevenDaysInMs;
+    return expirationTime * 1000 - currentTime <= constants_js_1.Constants.sevenDaysInMs;
 };
 const warnAboutTokenExpiry = (expirationTime, currentTime) => {
-    const daysToExpiration = Math.ceil((expirationTime * 1000 - currentTime) / constants_1.Constants.oneDayInMs);
+    const daysToExpiration = Math.ceil((expirationTime * 1000 - currentTime) / constants_js_1.Constants.oneDayInMs);
     const expirationDate = new Date(expirationTime * 1000).toLocaleDateString();
     const expirationWarning = `Warning: The access token used for this test run will expire in ${daysToExpiration} days on ${expirationDate}. Generate a new token from the portal to avoid failures. For a simpler, more secure solution, switch to Microsoft Entra ID and eliminate token management. https://learn.microsoft.com/en-us/entra/identity/`;
     console.warn(expirationWarning);
 };
 const warnIfAccessTokenCloseToExpiry = () => {
     const accessToken = (0, exports.getAccessToken)();
-    const claims = (0, exports.parseJwt)(accessToken);
+    const claims = (0, parseJwt_js_1.parseJwt)(accessToken);
     const currentTime = Date.now();
     if (isTokenExpiringSoon(claims.exp, currentTime)) {
         warnAboutTokenExpiry(claims.exp, currentTime);
@@ -117,12 +108,12 @@ const warnIfAccessTokenCloseToExpiry = () => {
 };
 exports.warnIfAccessTokenCloseToExpiry = warnIfAccessTokenCloseToExpiry;
 const fetchOrValidateAccessToken = async (credential) => {
-    const entraIdAccessToken = new entraIdAccessToken_1.EntraIdAccessToken(credential);
+    const entraIdAccessToken = (0, entraIdAccessToken_js_1.createEntraIdAccessToken)(credential);
     if (entraIdAccessToken.token && entraIdAccessToken.doesEntraIdAccessTokenNeedRotation()) {
         await entraIdAccessToken.fetchEntraIdAccessToken();
     }
     if (!(0, exports.getAccessToken)()) {
-        throw new Error(messages_1.ServiceErrorMessageConstants.NO_AUTH_ERROR.message);
+        throw new Error(messages_js_1.ServiceErrorMessageConstants.NO_AUTH_ERROR.message);
     }
     return (0, exports.getAccessToken)();
 };
@@ -133,24 +124,11 @@ const emitReportingUrl = () => {
     const match = url === null || url === void 0 ? void 0 : url.match(regex);
     if (match && match.length >= 3) {
         const [, region, domain] = match;
-        process.env[constants_1.InternalEnvironmentVariables.MPT_SERVICE_REPORTING_URL] =
+        process.env[constants_js_1.InternalEnvironmentVariables.MPT_SERVICE_REPORTING_URL] =
             `https://${region}.reporting.api.${domain}`;
     }
 };
 exports.emitReportingUrl = emitReportingUrl;
-const getPlaywrightVersion = () => {
-    if (process.env[constants_1.InternalEnvironmentVariables.MPT_PLAYWRIGHT_VERSION]) {
-        return process.env[constants_1.InternalEnvironmentVariables.MPT_PLAYWRIGHT_VERSION];
-    }
-    const packageManager = (0, packageManager_1.getPackageManager)();
-    const command = packageManager.runCommand("playwright", "--version");
-    const stdout = (0, child_process_1.execSync)(command).toString().trim();
-    const version = packageManager.getVersionFromStdout(stdout);
-    process.env[constants_1.InternalEnvironmentVariables.MPT_PLAYWRIGHT_VERSION] = version;
-    logger_1.coreLogger.info(`Playwright version being used - ${process.env[constants_1.InternalEnvironmentVariables.MPT_PLAYWRIGHT_VERSION]}`);
-    return process.env[constants_1.InternalEnvironmentVariables.MPT_PLAYWRIGHT_VERSION];
-};
-exports.getPlaywrightVersion = getPlaywrightVersion;
 const getPackageVersion = () => {
     try {
         // eslint-disable-next-line @typescript-eslint/no-require-imports
@@ -178,15 +156,15 @@ const getVersionInfo = (version) => {
 };
 exports.getVersionInfo = getVersionInfo;
 const validatePlaywrightVersion = () => {
-    const minimumSupportedVersion = constants_1.MINIMUM_SUPPORTED_PLAYWRIGHT_VERSION;
-    const installedVersion = (0, exports.getPlaywrightVersion)();
+    const minimumSupportedVersion = constants_js_1.MINIMUM_SUPPORTED_PLAYWRIGHT_VERSION;
+    const installedVersion = (0, getPlaywrightVersion_js_1.getPlaywrightVersion)();
     const minimumSupportedVersionInfo = (0, exports.getVersionInfo)(minimumSupportedVersion);
     const installedVersionInfo = (0, exports.getVersionInfo)(installedVersion);
     const isInstalledVersionGreater = installedVersionInfo.major > minimumSupportedVersionInfo.major ||
         (installedVersionInfo.major === minimumSupportedVersionInfo.major &&
             installedVersionInfo.minor >= minimumSupportedVersionInfo.minor);
     if (!isInstalledVersionGreater) {
-        (0, exports.exitWithFailureMessage)(messages_1.ServiceErrorMessageConstants.INVALID_PLAYWRIGHT_VERSION_ERROR);
+        (0, exports.exitWithFailureMessage)(messages_js_1.ServiceErrorMessageConstants.INVALID_PLAYWRIGHT_VERSION_ERROR);
     }
 };
 exports.validatePlaywrightVersion = validatePlaywrightVersion;

package/dist/commonjs/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/utils/utils.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAGlC,yDAMgC;AAChC,uDAAqE;AACrE,mDAAiD;AAEjD,kFAA+C;AAC/C,2DAAqD;AACrD,8DAAwC;AACxC,+CAAyC;AACzC,uEAAiE;AACjE,2EAA2E;AAE3E,0CAA0C;AAC1C,qEAAiE;AAAxD,+HAAA,oBAAoB,OAAA;AAC7B,6CAAyC;AAAhC,uGAAA,QAAQ,OAAA;AAEV,MAAM,sBAAsB,GAAG,CAAC,KAAuC,EAAS,EAAE;IACvF,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,6CAA6C;IAC7C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC;AAEK,MAAM,4BAA4B,GAAG,GAAiD,EAAE;IAC7F,mGAAmG;IACnG,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAE,CAAC;IACnD,IAAI,CAAC,0BAAa,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE7B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACpE,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAE3B,OAAO,EAAE,MAAM,EAAE,MAAO,EAAE,SAAS,EAAE,SAAU,EAAE,CAAC;QACpD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAfW,QAAA,4BAA4B,gCAevC;AAEK,MAAM,cAAc,GAAG,GAAuB,EAAE;IACrD,OAAO,OAAO,CAAC,GAAG,CAAC,yCAA0B,CAAC,+BAA+B,CAAC,CAAC;AACjF,CAAC,CAAC;AAFW,QAAA,cAAc,kBAEzB;AAEK,MAAM,iBAAiB,GAAG,GAAuB,EAAE;IACxD,OAAO,OAAO,CAAC,GAAG,CAAC,yCAA0B,CAAC,sBAAsB,CAAC,CAAC;AACxE,CAAC,CAAC;AAFW,QAAA,iBAAiB,qBAE5B;AAEK,MAAM,cAAc,GAAG,GAAW,EAAE;IACzC,MAAM,KAAK,GAAG,0BAAa,CAAC,QAAQ,CAAC,kCAAc,CAAC,SAAS,EAAE,CAAC,CAAC;IACjE,OAAO,CAAC,GAAG,CAAC,2CAA4B,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC;IACrE,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAJW,QAAA,cAAc,kBAIzB;AAEK,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAE,EAAU,EAAU,EAAE;IACxE,OAAO,GAAG,IAAA,yBAAiB,GAAE,UAAU,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,0BAAW,EAAE,CAAC;AACzG,CAAC,CAAC;AAFW,QAAA,oBAAoB,wBAE/B;AAEK,MAAM,kBAAkB,GAAG,GAAS,EAAE;IAC3C,MAAM,UAAU,GAAG,IAAA,yBAAiB,GAAE,CAAC;IACvC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,IAAA,8BAAsB,EAAC,0CAA4B,CAAC,oBAAoB,CAAC,CAAC;IAC5E,CAAC;AACH,CAAC,CAAC;AALW,QAAA,kBAAkB,sBAK7B;AAEK,MAAM,cAAc,GAAG,CAC5B,yBAA4E,EACtE,EAAE;IACR,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,IAAA,sBAAc,GAAE,CAAC;QACrC,MAAM,MAAM,GAAG,IAAA,oCAA4B,GAAE,CAAC;QAC9C,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,yBAAyB,CAAC,0CAA4B,CAAC,aAAa,CAAC,CAAC;QACxE,CAAC;QACD,MAAM,MAAM,GAAG,IAAA,sBAAQ,EAAa,WAAY,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;YAChB,yBAAyB,CAAC,0CAA4B,CAAC,qBAAqB,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,MAAM,CAAC,GAAI,GAAG,IAAI,EAAE,CAAC;YACrC,yBAAyB,CAAC,0CAA4B,CAAC,qBAAqB,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,MAAO,CAAC,SAAS,KAAK,MAAO,CAAC,GAAG,EAAE,CAAC;YACtC,yBAAyB,CAAC,0CAA4B,CAAC,wBAAwB,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,sBAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtB,IAAA,8BAAsB,EAAC,0CAA4B,CAAC,qBAAqB,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC,CAAC;AAvBW,QAAA,cAAc,kBAuBzB;AACF,MAAM,mBAAmB,GAAG,CAAC,cAAsB,EAAE,WAAmB,EAAW,EAAE;IACnF,OAAO,cAAc,GAAG,IAAI,GAAG,WAAW,IAAI,wBAAS,CAAC,aAAa,CAAC;AACxE,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,cAAsB,EAAE,WAAmB,EAAQ,EAAE;IACjF,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,cAAc,GAAG,IAAI,GAAG,WAAW,CAAC,GAAG,wBAAS,CAAC,UAAU,CAAC,CAAC;IACjG,MAAM,cAAc,GAAG,IAAI,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC5E,MAAM,iBAAiB,GAAG,mEAAmE,gBAAgB,YAAY,cAAc,+MAA+M,CAAC;IACvV,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;AAClC,CAAC,CAAC;AAEK,MAAM,8BAA8B,GAAG,GAAS,EAAE;IACvD,MAAM,WAAW,GAAG,IAAA,sBAAc,GAAE,CAAC;IACrC,MAAM,MAAM,GAAG,IAAA,sBAAQ,EAAa,WAAY,CAAC,CAAC;IAClD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC/B,IAAI,mBAAmB,CAAC,MAAM,CAAC,GAAI,EAAE,WAAW,CAAC,EAAE,CAAC;QAClD,oBAAoB,CAAC,MAAM,CAAC,GAAI,EAAE,WAAW,CAAC,CAAC;IACjD,CAAC;AACH,CAAC,CAAC;AAPW,QAAA,8BAA8B,kCAOzC;AAEK,MAAM,0BAA0B,GAAG,KAAK,EAAE,UAA4B,EAAmB,EAAE;IAChG,MAAM,kBAAkB,GAAG,IAAA,gDAAwB,EAAC,UAAU,CAAC,CAAC;IAChE,IAAI,kBAAkB,CAAC,KAAK,IAAI,kBAAkB,CAAC,kCAAkC,EAAE,EAAE,CAAC;QACxF,MAAM,kBAAkB,CAAC,uBAAuB,EAAE,CAAC;IACrD,CAAC;IACD,IAAI,CAAC,IAAA,sBAAc,GAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,0CAA4B,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,IAAA,sBAAc,GAAG,CAAC;AAC3B,CAAC,CAAC;AATW,QAAA,0BAA0B,8BASrC;AAEK,MAAM,gBAAgB,GAAG,GAAS,EAAE;IACzC,MAAM,KAAK,GACT,qFAAqF,CAAC;IACxF,MAAM,GAAG,GAAG,IAAA,yBAAiB,GAAE,CAAC;IAChC,MAAM,KAAK,GAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QAC/B,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,2CAA4B,CAAC,yBAAyB,CAAC;YACjE,WAAW,MAAM,kBAAkB,MAAM,EAAE,CAAC;IAChD,CAAC;AACH,CAAC,CAAC;AAVW,QAAA,gBAAgB,oBAU3B;AAEK,MAAM,iBAAiB,GAAG,GAAW,EAAE;IAC5C,IAAI,CAAC;QACH,iEAAiE;QACjE,MAAM,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC;QACtD,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;QACxD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;AACH,CAAC,CAAC;AATW,QAAA,iBAAiB,qBAS5B;AACK,MAAM,cAAc,GAAG,CAAC,OAAe,EAAe,EAAE;IAC7D,MAAM,KAAK,GAAG,gCAAgC,CAAC;IAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnC,MAAM,WAAW,GAAG;QAClB,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;KACT,CAAC;IACF,WAAW,CAAC,KAAK,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,WAAW,CAAC,KAAK,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,WAAW,CAAC,KAAK,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAZW,QAAA,cAAc,kBAYzB;AAEK,MAAM,yBAAyB,GAAG,GAAS,EAAE;IAClD,MAAM,uBAAuB,GAAG,mDAAoC,CAAC;IACrE,MAAM,gBAAgB,GAAG,IAAA,8CAAoB,GAAE,CAAC;IAEhD,MAAM,2BAA2B,GAAG,IAAA,sBAAc,EAAC,uBAAuB,CAAC,CAAC;IAC5E,MAAM,oBAAoB,GAAG,IAAA,sBAAc,EAAC,gBAAgB,CAAC,CAAC;IAE9D,MAAM,yBAAyB,GAC7B,oBAAoB,CAAC,KAAK,GAAG,2BAA2B,CAAC,KAAK;QAC9D,CAAC,oBAAoB,CAAC,KAAK,KAAK,2BAA2B,CAAC,KAAK;YAC/D,oBAAoB,CAAC,KAAK,IAAI,2BAA2B,CAAC,KAAK,CAAC,CAAC;IACrE,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAC/B,IAAA,8BAAsB,EAAC,0CAA4B,CAAC,gCAAgC,CAAC,CAAC;IACxF,CAAC;AACH,CAAC,CAAC;AAdW,QAAA,yBAAyB,6BAcpC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { JwtPayload, VersionInfo } from \"../common/types.js\";\nimport {\n  API_VERSION,\n  Constants,\n  InternalEnvironmentVariables,\n  MINIMUM_SUPPORTED_PLAYWRIGHT_VERSION,\n  ServiceEnvironmentVariable,\n} from \"../common/constants.js\";\nimport { ServiceErrorMessageConstants } from \"../common/messages.js\";\nimport { coreLogger } from \"../common/logger.js\";\nimport type { TokenCredential } from \"@azure/identity\";\nimport ReporterUtils from \"./reporterUtils.js\";\nimport { CIInfoProvider } from \"./cIInfoProvider.js\";\nimport * as process from \"node:process\";\nimport { parseJwt } from \"./parseJwt.js\";\nimport { getPlaywrightVersion } from \"./getPlaywrightVersion.js\";\nimport { createEntraIdAccessToken } from \"../common/entraIdAccessToken.js\";\n\n// Re-exporting for backward compatibility\nexport { getPlaywrightVersion } from \"./getPlaywrightVersion.js\";\nexport { parseJwt } from \"./parseJwt.js\";\n\nexport const exitWithFailureMessage = (error: { key: string; message: string }): never => {\n  console.log();\n  console.error(error.message);\n  // eslint-disable-next-line n/no-process-exit\n  process.exit(1);\n};\n\nexport const populateValuesFromServiceUrl = (): { region: string; accountId: string } | null => {\n  // Service URL format: wss://<region>.api.playwright.microsoft.com/accounts/<workspace-id>/browsers\n  const url = process.env[\"PLAYWRIGHT_SERVICE_URL\"]!;\n  if (!ReporterUtils.isNullOrEmpty(url)) {\n    const parts = url.split(\"/\");\n\n    if (parts.length > 2) {\n      const subdomainParts = parts[2]!.split(\".\");\n      const region = subdomainParts.length > 0 ? subdomainParts[0] : null;\n      const accountId = parts[4];\n\n      return { region: region!, accountId: accountId! };\n    }\n  }\n  return null;\n};\n\nexport const getAccessToken = (): string | undefined => {\n  return process.env[ServiceEnvironmentVariable.PLAYWRIGHT_SERVICE_ACCESS_TOKEN];\n};\n\nexport const getServiceBaseURL = (): string | undefined => {\n  return process.env[ServiceEnvironmentVariable.PLAYWRIGHT_SERVICE_URL];\n};\n\nexport const getAndSetRunId = (): string => {\n  const runId = ReporterUtils.getRunId(CIInfoProvider.getCIInfo());\n  process.env[InternalEnvironmentVariables.MPT_SERVICE_RUN_ID] = runId;\n  return runId;\n};\n\nexport const getServiceWSEndpoint = (runId: string, os: string): string => {\n  return `${getServiceBaseURL()}?runId=${encodeURIComponent(runId)}&os=${os}&api-version=${API_VERSION}`;\n};\n\nexport const validateServiceUrl = (): void => {\n  const serviceUrl = getServiceBaseURL();\n  if (!serviceUrl) {\n    exitWithFailureMessage(ServiceErrorMessageConstants.NO_SERVICE_URL_ERROR);\n  }\n};\n\nexport const validateMptPAT = (\n  validationFailureCallback: (error: { key: string; message: string }) => void,\n): void => {\n  try {\n    const accessToken = getAccessToken();\n    const result = populateValuesFromServiceUrl();\n    if (!accessToken) {\n      validationFailureCallback(ServiceErrorMessageConstants.NO_AUTH_ERROR);\n    }\n    const claims = parseJwt<JwtPayload>(accessToken!);\n    if (!claims.exp) {\n      validationFailureCallback(ServiceErrorMessageConstants.INVALID_MPT_PAT_ERROR);\n    }\n    if (Date.now() >= claims.exp! * 1000) {\n      validationFailureCallback(ServiceErrorMessageConstants.EXPIRED_MPT_PAT_ERROR);\n    }\n    if (result!.accountId !== claims!.aid) {\n      validationFailureCallback(ServiceErrorMessageConstants.WORKSPACE_MISMATCH_ERROR);\n    }\n  } catch (err) {\n    coreLogger.error(err);\n    exitWithFailureMessage(ServiceErrorMessageConstants.INVALID_MPT_PAT_ERROR);\n  }\n};\nconst isTokenExpiringSoon = (expirationTime: number, currentTime: number): boolean => {\n  return expirationTime * 1000 - currentTime <= Constants.sevenDaysInMs;\n};\n\nconst warnAboutTokenExpiry = (expirationTime: number, currentTime: number): void => {\n  const daysToExpiration = Math.ceil((expirationTime * 1000 - currentTime) / Constants.oneDayInMs);\n  const expirationDate = new Date(expirationTime * 1000).toLocaleDateString();\n  const expirationWarning = `Warning: The access token used for this test run will expire in ${daysToExpiration} days on ${expirationDate}. Generate a new token from the portal to avoid failures. For a simpler, more secure solution, switch to Microsoft Entra ID and eliminate token management. https://learn.microsoft.com/en-us/entra/identity/`;\n  console.warn(expirationWarning);\n};\n\nexport const warnIfAccessTokenCloseToExpiry = (): void => {\n  const accessToken = getAccessToken();\n  const claims = parseJwt<JwtPayload>(accessToken!);\n  const currentTime = Date.now();\n  if (isTokenExpiringSoon(claims.exp!, currentTime)) {\n    warnAboutTokenExpiry(claims.exp!, currentTime);\n  }\n};\n\nexport const fetchOrValidateAccessToken = async (credential?: TokenCredential): Promise<string> => {\n  const entraIdAccessToken = createEntraIdAccessToken(credential);\n  if (entraIdAccessToken.token && entraIdAccessToken.doesEntraIdAccessTokenNeedRotation()) {\n    await entraIdAccessToken.fetchEntraIdAccessToken();\n  }\n  if (!getAccessToken()) {\n    throw new Error(ServiceErrorMessageConstants.NO_AUTH_ERROR.message);\n  }\n  return getAccessToken()!;\n};\n\nexport const emitReportingUrl = (): void => {\n  const regex =\n    /wss:\\/\\/([\\w-]+)\\.api\\.(playwright(?:-test|-int)?\\.io|playwright\\.microsoft\\.com)\\//;\n  const url = getServiceBaseURL();\n  const match = url?.match(regex);\n  if (match && match.length >= 3) {\n    const [, region, domain] = match;\n    process.env[InternalEnvironmentVariables.MPT_SERVICE_REPORTING_URL] =\n      `https://${region}.reporting.api.${domain}`;\n  }\n};\n\nexport const getPackageVersion = (): string => {\n  try {\n    // eslint-disable-next-line @typescript-eslint/no-require-imports\n    const version = require(\"../../package.json\").version;\n    return version;\n  } catch (error) {\n    console.error(\"Error fetching package version:\", error);\n    return \"unknown version\";\n  }\n};\nexport const getVersionInfo = (version: string): VersionInfo => {\n  const regex = /^(\\d+)(?:\\.(\\d+))?(?:\\.(\\d+))?/;\n  const match = version.match(regex);\n  const versionInfo = {\n    major: 0,\n    minor: 0,\n    patch: 0,\n  };\n  versionInfo.major = match && match[1] ? parseInt(match[1], 10) : 0;\n  versionInfo.minor = match && match[2] ? parseInt(match[2], 10) : 0;\n  versionInfo.patch = match && match[3] ? parseInt(match[3], 10) : 0;\n  return versionInfo;\n};\n\nexport const validatePlaywrightVersion = (): void => {\n  const minimumSupportedVersion = MINIMUM_SUPPORTED_PLAYWRIGHT_VERSION;\n  const installedVersion = getPlaywrightVersion();\n\n  const minimumSupportedVersionInfo = getVersionInfo(minimumSupportedVersion);\n  const installedVersionInfo = getVersionInfo(installedVersion);\n\n  const isInstalledVersionGreater =\n    installedVersionInfo.major > minimumSupportedVersionInfo.major ||\n    (installedVersionInfo.major === minimumSupportedVersionInfo.major &&\n      installedVersionInfo.minor >= minimumSupportedVersionInfo.minor);\n  if (!isInstalledVersionGreater) {\n    exitWithFailureMessage(ServiceErrorMessageConstants.INVALID_PLAYWRIGHT_VERSION_ERROR);\n  }\n};\n"]}

package/dist/esm/common/constants.d.ts

@@ -0,0 +1,95 @@
+import type { ApiErrorMessage } from "./types.js";
+export declare const EntraIdAccessTokenConstants: {
+    LIFETIME_LEFT_THRESHOLD_IN_MINUTES_FOR_ROTATION: number;
+    SCOPE: string;
+    ROTATION_INTERVAL_PERIOD_IN_MINUTES: number;
+};
+/** @public
+ *
+ * OS types supported on Microsoft Playwright Testing cloud hosted browsers
+ */
+export declare const ServiceOS: {
+    readonly LINUX: "linux";
+    readonly WINDOWS: "windows";
+};
+/** @public
+ *
+ * Authentication types supported on Microsoft Playwright Testing
+ */
+export declare const ServiceAuth: {
+    readonly ENTRA_ID: "ENTRA_ID";
+    readonly ACCESS_TOKEN: "ACCESS_TOKEN";
+};
+/** @public
+ *
+ * Environment variables used by Microsoft Playwright Testing
+ */
+export declare const ServiceEnvironmentVariable: {
+    PLAYWRIGHT_SERVICE_ACCESS_TOKEN: string;
+    PLAYWRIGHT_SERVICE_URL: string;
+};
+export declare const DefaultConnectOptionsConstants: {
+    DEFAULT_TIMEOUT: number;
+    DEFAULT_SLOW_MO: number;
+    DEFAULT_EXPOSE_NETWORK: string;
+    DEFAULT_SERVICE_OS: "linux";
+};
+export declare const API_VERSION = "2023-10-01-preview";
+export declare class Constants {
+    static readonly TEST_FRAMEWORK_NAME = "PLAYWRIGHT";
+    static readonly TEST_FRAMEWORK_RUNNERNAME = "PLAYWRIGHT";
+    static readonly TEST_TYPE = "WebTest";
+    static readonly TEST_SDK_LANGUAGE = "JAVASCRIPT";
+    static readonly DEFAULT_DASHBOARD_ENDPOINT = "https://playwright.microsoft.com";
+    static readonly DEFAULT_SERVICE_ENDPOINT = "https://{region}.reporting.api.playwright-test.io";
+    static readonly DEFAULT_REDACTED_MESSAGE = "***REDACTED***";
+    static readonly SAS_URI_SEPARATOR = "?";
+    static readonly DEFAULT_TEST_RUN_NAME = "MPTReporterTests";
+    static readonly TEST_BATCH_SIZE = 50;
+    static readonly UPLOAD_MODE = "sdk";
+    static readonly GIT_VERSION_COMMAND = "git --version";
+    static readonly GIT_REV_PARSE = "git rev-parse --is-inside-work-tree";
+    static readonly GIT_COMMIT_MESSAGE_COMMAND = "git log -1 --pretty=format:\"%s\"";
+    static readonly ERROR_MESSAGES_MAX_LENGTH = 100;
+    static readonly sevenDaysInMs: number;
+    static readonly oneDayInMs: number;
+    static readonly API_VERSION = "2024-09-01-preview";
+    static readonly OS = "Os";
+    static readonly NON_RETRYABLE_STATUS_CODES: number[];
+    static readonly SupportedRegions: string[];
+    static readonly CONFLICT_409_ERROR_MESSAGE = "Test run with id {runId} already exists. Provide a unique run id.";
+    static readonly FORBIDDEN_403_ERROR_MESSAGE = "You do not have the required permissions to upload test results. This could be because\n\n  a. Reporting is not enabled for your workspace {workspaceId}. Enable the Reporting feature under Feature management settings using the Playwright portal: https://playwright.microsoft.com/workspaces/{workspaceId}/settings/general\n  b. You do not have the required roles on the workspace. Only Owner and Contributor roles can run tests. Contact the service administrator.\n  c. The workspace you are trying to run the tests on is in a different Azure tenant than what you are signed into. Check the tenant id from Azure portal (https://aka.ms/mpt/find-tenant-id) and login using the command 'az login --tenant <TENANT_ID>\n  ";
+    static readonly testRunsEndpoint: string;
+    static readonly testRunsShardEndpoint: string;
+    static readonly storageUriEndpoint: string;
+    static readonly testResultsEndpoint: string;
+    static readonly patchTestRun: string;
+    static readonly getTestRun: string;
+    static readonly patchTestRunShardStart: string;
+    static readonly patchTestRunShardEnd: string;
+    static readonly postTestResults: string;
+    static readonly getStorageUri: string;
+    static readonly ERROR_MESSAGE: ApiErrorMessage;
+}
+export declare const TestErrorType: {
+    Scalable: string;
+    Reporting: string;
+};
+export declare const TestResultErrorConstants: {
+    key: string;
+    message: string;
+    pattern: RegExp;
+    type: string;
+}[];
+export declare const InternalEnvironmentVariables: {
+    MPT_PLAYWRIGHT_VERSION: string;
+    MPT_SETUP_FATAL_ERROR: string;
+    MPT_SERVICE_RUN_NAME: string;
+    MPT_SERVICE_RUN_ID: string;
+    MPT_CLOUD_HOSTED_BROWSER_USED: string;
+    MPT_SERVICE_OS: string;
+    MPT_SERVICE_REPORTING_URL: string;
+    ONE_TIME_OPERATION_FLAG: string;
+};
+export declare const MINIMUM_SUPPORTED_PLAYWRIGHT_VERSION = "1.47.0";
+//# sourceMappingURL=constants.d.ts.map

package/dist/esm/common/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/common/constants.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,eAAO,MAAM,2BAA2B;;;;CAIvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,SAAS;;;CAGZ,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,WAAW;;;CAGd,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;CAGtC,CAAC;AAEF,eAAO,MAAM,8BAA8B;;;;;CAK1C,CAAC;AAEF,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAKhD,qBAAa,SAAS;IAEpB,gBAAuB,mBAAmB,gBAAgB;IAC1D,gBAAuB,yBAAyB,gBAAgB;IAChE,gBAAuB,SAAS,aAAa;IAC7C,gBAAuB,iBAAiB,gBAAgB;IAExD,gBAAuB,0BAA0B,sCAAsC;IACvF,gBAAuB,wBAAwB,uDACO;IACtD,gBAAuB,wBAAwB,oBAAoB;IACnE,gBAAuB,iBAAiB,OAAO;IAC/C,gBAAuB,qBAAqB,sBAAsB;IAClE,gBAAuB,eAAe,MAAM;IAC5C,gBAAuB,WAAW,SAAS;IAC3C,gBAAuB,mBAAmB,mBAAmB;IAC7D,gBAAuB,aAAa,yCAAyC;IAC7E,gBAAuB,0BAA0B,uCAAqC;IACtF,gBAAuB,yBAAyB,OAAO;IACvD,gBAAuB,aAAa,SAA2B;IAC/D,gBAAuB,UAAU,SAAuB;IACxD,gBAAuB,WAAW,wBAAwB;IAC1D,gBAAuB,EAAE,QAAQ;IACjC,gBAAuB,0BAA0B,WAA6B;IAC9E,gBAAuB,gBAAgB,EAAE,MAAM,EAAE,CAO/C;IAEF,gBAAuB,0BAA0B,uEACqB;IACtE,gBAAuB,2BAA2B,ktBAKhD;IAEF,gBAAuB,gBAAgB,EAAE,MAAM,CAAwC;IACvF,gBAAuB,qBAAqB,EAAE,MAAM,CAC0B;IAC9E,gBAAuB,kBAAkB,EAAE,MAAM,CAC+B;IAChF,gBAAuB,mBAAmB,EAAE,MAAM,CACK;IACvD,gBAAuB,YAAY,EAAE,MAAM,CAAkB;IAC7D,gBAAuB,UAAU,EAAE,MAAM,CAAgB;IACzD,gBAAuB,sBAAsB,EAAE,MAAM,CAA4B;IACjF,gBAAuB,oBAAoB,EAAE,MAAM,CAA0B;IAC7E,gBAAuB,eAAe,EAAE,MAAM,CAAqB;IACnE,gBAAuB,aAAa,EAAE,MAAM,CAAmB;IAC/D,gBAAuB,aAAa,EAAE,eAAe,CAsDnD;CACH;AAED,eAAO,MAAM,aAAa;;;CAGzB,CAAC;AAEF,eAAO,MAAM,wBAAwB;;;;;GAwEpC,CAAC;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;CASxC,CAAC;AAEF,eAAO,MAAM,oCAAoC,WAAW,CAAC"}

package/dist/esm/common/constants.js

@@ -0,0 +1,226 @@
+export const EntraIdAccessTokenConstants = {
+    LIFETIME_LEFT_THRESHOLD_IN_MINUTES_FOR_ROTATION: 15,
+    SCOPE: "https://management.core.windows.net/.default",
+    ROTATION_INTERVAL_PERIOD_IN_MINUTES: 4,
+};
+/** @public
+ *
+ * OS types supported on Microsoft Playwright Testing cloud hosted browsers
+ */
+export const ServiceOS = {
+    LINUX: "linux",
+    WINDOWS: "windows",
+};
+/** @public
+ *
+ * Authentication types supported on Microsoft Playwright Testing
+ */
+export const ServiceAuth = {
+    ENTRA_ID: "ENTRA_ID",
+    ACCESS_TOKEN: "ACCESS_TOKEN",
+};
+/** @public
+ *
+ * Environment variables used by Microsoft Playwright Testing
+ */
+export const ServiceEnvironmentVariable = {
+    PLAYWRIGHT_SERVICE_ACCESS_TOKEN: "PLAYWRIGHT_SERVICE_ACCESS_TOKEN",
+    PLAYWRIGHT_SERVICE_URL: "PLAYWRIGHT_SERVICE_URL",
+};
+export const DefaultConnectOptionsConstants = {
+    DEFAULT_TIMEOUT: 30000,
+    DEFAULT_SLOW_MO: 0,
+    DEFAULT_EXPOSE_NETWORK: "<loopback>",
+    DEFAULT_SERVICE_OS: ServiceOS.LINUX,
+};
+export const API_VERSION = "2023-10-01-preview";
+// Do not put an ending slash for the urls,
+// for example use https://www.microsoft.com/en-in and not https://www.microsoft.com/en-in/
+export class Constants {
+}
+// Config related constants
+Constants.TEST_FRAMEWORK_NAME = "PLAYWRIGHT";
+Constants.TEST_FRAMEWORK_RUNNERNAME = "PLAYWRIGHT";
+Constants.TEST_TYPE = "WebTest";
+Constants.TEST_SDK_LANGUAGE = "JAVASCRIPT";
+// Placeholder version
+Constants.DEFAULT_DASHBOARD_ENDPOINT = "https://playwright.microsoft.com";
+Constants.DEFAULT_SERVICE_ENDPOINT = "https://{region}.reporting.api.playwright-test.io";
+Constants.DEFAULT_REDACTED_MESSAGE = "***REDACTED***";
+Constants.SAS_URI_SEPARATOR = "?";
+Constants.DEFAULT_TEST_RUN_NAME = "MPTReporterTests";
+Constants.TEST_BATCH_SIZE = 50;
+Constants.UPLOAD_MODE = "sdk";
+Constants.GIT_VERSION_COMMAND = "git --version";
+Constants.GIT_REV_PARSE = "git rev-parse --is-inside-work-tree";
+Constants.GIT_COMMIT_MESSAGE_COMMAND = 'git log -1 --pretty=format:"%s"';
+Constants.ERROR_MESSAGES_MAX_LENGTH = 100;
+Constants.sevenDaysInMs = 7 * 24 * 60 * 60 * 1000;
+Constants.oneDayInMs = 24 * 60 * 60 * 1000;
+Constants.API_VERSION = "2024-09-01-preview";
+Constants.OS = "Os";
+Constants.NON_RETRYABLE_STATUS_CODES = [400, 403, 404, 405, 409];
+Constants.SupportedRegions = [
+    "eastus",
+    "eastasia",
+    "westeurope",
+    "westus3",
+    "centraluseuap",
+    "eastus2euap",
+];
+// Error messages
+Constants.CONFLICT_409_ERROR_MESSAGE = "Test run with id {runId} already exists. Provide a unique run id.";
+Constants.FORBIDDEN_403_ERROR_MESSAGE = `You do not have the required permissions to upload test results. This could be because
+
+  a. Reporting is not enabled for your workspace {workspaceId}. Enable the Reporting feature under Feature management settings using the Playwright portal: https://playwright.microsoft.com/workspaces/{workspaceId}/settings/general
+  b. You do not have the required roles on the workspace. Only Owner and Contributor roles can run tests. Contact the service administrator.
+  c. The workspace you are trying to run the tests on is in a different Azure tenant than what you are signed into. Check the tenant id from Azure portal (https://aka.ms/mpt/find-tenant-id) and login using the command 'az login --tenant <TENANT_ID>
+  `;
+// API Endpoints
+Constants.testRunsEndpoint = "workspaces/{workspaceId}/test-runs";
+Constants.testRunsShardEndpoint = "workspaces/{workspaceId}/test-runs/{testRunId}:updateShardExecutionStatus";
+Constants.storageUriEndpoint = "workspaces/{workspaceId}/test-runs/{testRunId}:createArtifactsUploadBaseUri";
+Constants.testResultsEndpoint = "workspaces/{workspaceId}/test-results/upload-batch";
+Constants.patchTestRun = "patchTestRun";
+Constants.getTestRun = "getTestRun";
+Constants.patchTestRunShardStart = "patchTestRunShardStart";
+Constants.patchTestRunShardEnd = "patchTestRunShardEnd";
+Constants.postTestResults = "postTestResults";
+Constants.getStorageUri = "getStorageUri";
+Constants.ERROR_MESSAGE = {
+    patchTestRun: {
+        400: "The request made to the server is invalid. Please check the request parameters and try again.",
+        401: "The authentication token provided is invalid. Please check the token and try again.",
+        500: "An unexpected error occurred on our server. Our team is working to resolve the issue. Please try again later, or contact support if the problem continues.",
+        429: "You have exceeded the rate limit for the API. Please wait and try again later.",
+        504: "The request to the service timed out. Please try again later.",
+        503: "The service is currently unavailable. Please check the service status and try again.",
+    },
+    getTestRun: {
+        400: "The request made to the server is invalid. Please check the request parameters and try again.",
+        401: "The authentication token provided is invalid. Please check the token and try again.",
+        403: "You do not have the required permissions to run tests. Please contact your workspace administrator.",
+        500: "An unexpected error occurred on our server. Our team is working to resolve the issue. Please try again later, or contact support if the problem continues.",
+        429: "You have exceeded the rate limit for the API. Please wait and try again later.",
+        504: "The request to the service timed out. Please try again later.",
+        503: "The service is currently unavailable. Please check the service status and try again.",
+    },
+    patchTestRunShardStart: {
+        400: "The request made to the server is invalid. Please check the request parameters and try again.",
+        401: "The authentication token provided is invalid. Please check the token and try again.",
+        403: "You do not have the required permissions to run tests. Please contact your workspace administrator.",
+        500: "An unexpected error occurred on our server. Our team is working to resolve the issue. Please try again later, or contact support if the problem continues.",
+        429: "You have exceeded the rate limit for the API. Please wait and try again later.",
+        504: "The request to the service timed out. Please try again later.",
+        503: "The service is currently unavailable. Please check the service status and try again.",
+    },
+    patchTestRunShardEnd: {
+        400: "The request made to the server is invalid. Please check the request parameters and try again.",
+        401: "The authentication token provided is invalid. Please check the token and try again.",
+        403: "You do not have the required permissions to run tests. Please contact your workspace administrator.",
+        500: "An unexpected error occurred on our server. Our team is working to resolve the issue. Please try again later, or contact support if the problem continues.",
+        429: "You have exceeded the rate limit for the API. Please wait and try again later.",
+        504: "The request to the service timed out. Please try again later.",
+        503: "The service is currently unavailable. Please check the service status and try again.",
+    },
+    postTestResults: {
+        400: "The request made to the server is invalid. Please check the request parameters and try again.",
+        401: "The authentication token provided is invalid. Please check the token and try again.",
+        403: "You do not have the required permissions to run tests. Please contact your workspace administrator.",
+        500: "An unexpected error occurred on our server. Our team is working to resolve the issue. Please try again later, or contact support if the problem continues.",
+        429: "You have exceeded the rate limit for the API. Please wait and try again later.",
+        504: "The request to the service timed out. Please try again later.",
+        503: "The service is currently unavailable. Please check the service status and try again.",
+    },
+    getStorageUri: {
+        400: "The request made to the server is invalid. Please check the request parameters and try again.",
+        401: "The authentication token provided is invalid. Please check the token and try again.",
+        403: "You do not have the required permissions to run tests. Please contact your workspace administrator.",
+        500: "An unexpected error occurred on our server. Our team is working to resolve the issue. Please try again later, or contact support if the problem continues.",
+        429: "You have exceeded the rate limit for the API. Please wait and try again later.",
+        504: "The request to the service timed out. Please try again later.",
+        503: "The service is currently unavailable. Please check the service status and try again.",
+    },
+};
+export const TestErrorType = {
+    Scalable: "Scalable",
+    Reporting: "Reporting",
+};
+export const TestResultErrorConstants = [
+    {
+        key: "401",
+        message: "The authentication token provided is invalid. Please check the token and try again.",
+        pattern: /(?=.*browserType\.connect)(?=.*401 Unauthorized)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "NoPermissionOnWorkspace_Scalable",
+        message: `You do not have the required permissions to run tests. This could be because:
+
+    a. You do not have the required roles on the workspace. Only Owner and Contributor roles can run tests. Contact the service administrator.
+    b. The workspace you are trying to run the tests on is in a different Azure tenant than what you are signed into. Check the tenant id from Azure portal (https://aka.ms/mpt/find-tenant-id) and login using the command 'az login --tenant <TENANT_ID>'.
+    `,
+        pattern: /(?=.*browserType\.connect)(?=.*403 Forbidden)(?=[\s\S]*CheckAccess API call with non successful response)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "InvalidWorkspace_Scalable",
+        message: "The specified workspace does not exist. Please verify your workspace settings.",
+        pattern: /(?=.*browserType\.connect)(?=.*403 Forbidden)(?=[\s\S]*InvalidAccountOrSubscriptionState)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "InvalidAccessToken",
+        message: "The provided access token does not match the specified workspace URL. Please verify that both values are correct.",
+        pattern: /(?=.*browserType\.connect)(?=.*403 Forbidden)(?=[\s\S]*InvalidAccessToken)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "AccessTokenOrUserOrWorkspaceNotFound_Scalable",
+        message: "The data for the user, workspace or access token was not found. Please check the request or create new token and try again.",
+        pattern: /(?=.*browserType\.connect)(?=.*404 Not Found)(?=[\s\S]*NotFound)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "AccessKeyBasedAuthNotSupported_Scalable",
+        message: "Authentication through service access token is disabled for this workspace. Please use Entra ID to authenticate.",
+        pattern: /(?=.*browserType\.connect)(?=.*403 Forbidden)(?=[\s\S]*AccessKeyBasedAuthNotSupported)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "503",
+        message: "The service is currently unavailable. Please check the service status and try again.",
+        pattern: /(?=.*browserType\.connect)(?=.*503 Service Unavailable)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "504",
+        message: "The request to the service timed out. Please try again later.",
+        pattern: /(?=.*browserType\.connect)(?=.*504 Gateway Timeout)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "QuotaLimitError_Scalable",
+        message: "It is possible that the maximum number of concurrent sessions allowed for your workspace has been exceeded. Check the quota at https://aka.ms/mpt/resource-quota.",
+        pattern: /(?=.*browserType\.connect): (?=.*Timeout .* exceeded)/i,
+        type: TestErrorType.Scalable,
+    },
+    {
+        key: "BrowserConnectionError_Scalable",
+        message: "The service is currently unavailable. Please try again after some time.",
+        pattern: /(?=.*browserType\.connect): (?=.Target page, context or browser has been closed)/i,
+        type: TestErrorType.Scalable,
+    },
+];
+export const InternalEnvironmentVariables = {
+    MPT_PLAYWRIGHT_VERSION: "_MPT_PLAYWRIGHT_VERSION",
+    MPT_SETUP_FATAL_ERROR: "_MPT_SETUP_FATAL_ERROR",
+    MPT_SERVICE_RUN_NAME: "_MPT_SERVICE_RUN_NAME",
+    MPT_SERVICE_RUN_ID: "_MPT_SERVICE_RUN_ID",
+    MPT_CLOUD_HOSTED_BROWSER_USED: "_MPT_CLOUD_HOSTED_BROWSER_USED",
+    MPT_SERVICE_OS: "_MPT_SERVICE_OS",
+    MPT_SERVICE_REPORTING_URL: "_MPT_SERVICE_REPORTING_URL",
+    ONE_TIME_OPERATION_FLAG: "_ONE_TIME_OPERATION_FLAG",
+};
+export const MINIMUM_SUPPORTED_PLAYWRIGHT_VERSION = "1.47.0";
+//# sourceMappingURL=constants.js.map