@flakiness/sdk 1.0.1 → 1.1.0-alpha.0

package/lib/browser.js

@@ -171,7 +171,7 @@ function computeTestId(test, suiteId) {
   });
 }
 
-// node_modules/.pnpm/@flakiness+flakiness-report@0.22.0/node_modules/@flakiness/flakiness-report/lib/flakinessReport.js
+// node_modules/.pnpm/@flakiness+flakiness-report@0.25.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/flakinessReport.js
 var FlakinessReport;
 ((FlakinessReport22) => {
   FlakinessReport22.CATEGORY_PLAYWRIGHT = "playwright";
@@ -179,7 +179,7 @@ var FlakinessReport;
   FlakinessReport22.CATEGORY_JUNIT = "junit";
 })(FlakinessReport || (FlakinessReport = {}));
 
-// node_modules/.pnpm/@flakiness+flakiness-report@0.22.0/node_modules/@flakiness/flakiness-report/lib/schema.js
+// node_modules/.pnpm/@flakiness+flakiness-report@0.25.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/schema.js
 import z from "zod/v4";
 var Schema;
 ((Schema2) => {
@@ -284,7 +284,9 @@ var Schema;
     samples: z.array(Schema2.SystemUtilizationSample)
   });
   Schema2.UtilizationTelemetry = z.tuple([Schema2.DurationMS, z.number().min(0).max(100)]);
+  Schema2.FlakinessProject = z.string();
   Schema2.Report = z.object({
+    flakinessProject: Schema2.FlakinessProject.optional(),
     category: z.string().min(1).max(100),
     commitId: Schema2.CommitId,
     relatedCommitIds: z.array(Schema2.CommitId).optional(),

package/lib/index.js

@@ -775,7 +775,7 @@ function computeTestId(test, suiteId) {
   });
 }
 
-// node_modules/.pnpm/@flakiness+flakiness-report@0.22.0/node_modules/@flakiness/flakiness-report/lib/flakinessReport.js
+// node_modules/.pnpm/@flakiness+flakiness-report@0.25.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/flakinessReport.js
 var FlakinessReport;
 ((FlakinessReport22) => {
   FlakinessReport22.CATEGORY_PLAYWRIGHT = "playwright";
@@ -783,7 +783,7 @@ var FlakinessReport;
   FlakinessReport22.CATEGORY_JUNIT = "junit";
 })(FlakinessReport || (FlakinessReport = {}));
 
-// node_modules/.pnpm/@flakiness+flakiness-report@0.22.0/node_modules/@flakiness/flakiness-report/lib/schema.js
+// node_modules/.pnpm/@flakiness+flakiness-report@0.25.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/schema.js
 import z from "zod/v4";
 var Schema;
 ((Schema2) => {
@@ -888,7 +888,9 @@ var Schema;
     samples: z.array(Schema2.SystemUtilizationSample)
   });
   Schema2.UtilizationTelemetry = z.tuple([Schema2.DurationMS, z.number().min(0).max(100)]);
+  Schema2.FlakinessProject = z.string();
   Schema2.Report = z.object({
+    flakinessProject: Schema2.FlakinessProject.optional(),
     category: z.string().min(1).max(100),
     commitId: Schema2.CommitId,
     relatedCommitIds: z.array(Schema2.CommitId).optional(),
@@ -936,6 +938,39 @@ function stripAnsi(str) {
 import assert2 from "assert";
 import fs4 from "fs";
 import { URL as URL2 } from "url";
+
+// src/_githubOIDC.ts
+var GithubOIDC = class _GithubOIDC {
+  constructor(_requestUrl, _requestToken) {
+    this._requestUrl = _requestUrl;
+    this._requestToken = _requestToken;
+  }
+  static initializeFromEnv() {
+    const requestUrl = process.env.ACTIONS_ID_TOKEN_REQUEST_URL;
+    const requestToken = process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN;
+    return requestUrl && requestToken ? new _GithubOIDC(requestUrl, requestToken) : void 0;
+  }
+  async fetchToken(audience) {
+    const url = new URL(this._requestUrl);
+    url.searchParams.set("audience", audience);
+    const response = await fetch(url, {
+      headers: {
+        "Authorization": `bearer ${this._requestToken}`,
+        "Accept": "application/json; api-version=2.0"
+      }
+    });
+    if (!response.ok) {
+      const body = await response.text().catch(() => "");
+      throw new Error(`Failed to request GitHub OIDC token: ${response.status} ${body}`);
+    }
+    const json = await response.json();
+    if (!json.value)
+      throw new Error("GitHub OIDC token response did not contain a token value.");
+    return json.value;
+  }
+};
+
+// src/uploadReport.ts
 async function createFileAttachment(contentType, filePath) {
   return {
     type: "file",
@@ -953,9 +988,28 @@ async function createDataAttachment(contentType, data) {
   };
 }
 async function uploadReport(report, attachments, options) {
-  const flakinessAccessToken = options?.flakinessAccessToken ?? process.env["FLAKINESS_ACCESS_TOKEN"];
-  const flakinessEndpoint = options?.flakinessEndpoint ?? process.env["FLAKINESS_ENDPOINT"] ?? "https://flakiness.io";
+  let flakinessAccessToken = options?.flakinessAccessToken ?? process.env["FLAKINESS_ACCESS_TOKEN"];
   const logger = options?.logger ?? console;
+  const githubOIDC = GithubOIDC.initializeFromEnv();
+  if (!flakinessAccessToken && githubOIDC) {
+    if (!report.flakinessProject) {
+      const reason = "`flakinessProject` is not configured to upload using Github OIDC.";
+      if (process.env.CI)
+        logger.warn(`[flakiness.io] \u26A0 Skipping upload: ${reason}`);
+      return { status: "skipped", reason };
+    }
+    try {
+      flakinessAccessToken = await githubOIDC.fetchToken(report.flakinessProject);
+      if (!flakinessAccessToken)
+        throw new Error("token is empty");
+    } catch (e) {
+      const errorMessage = e.message || String(e);
+      logger.error(`[flakiness.io] \u2715 Unexpected error while fetching Github OIDC token: ${errorMessage}`);
+      if (options?.throwOnFailure)
+        throw e;
+      return { status: "failed", error: errorMessage };
+    }
+  }
   if (!flakinessAccessToken) {
     const reason = "No FLAKINESS_ACCESS_TOKEN found";
     if (process.env.CI)
@@ -963,6 +1017,7 @@ async function uploadReport(report, attachments, options) {
     return { status: "skipped", reason };
   }
   try {
+    const flakinessEndpoint = options?.flakinessEndpoint ?? process.env["FLAKINESS_ENDPOINT"] ?? "https://flakiness.io";
     const upload = new ReportUpload(report, attachments, { flakinessAccessToken, flakinessEndpoint });
     const uploadResult = await upload.upload();
     if (!uploadResult.success) {
@@ -1339,7 +1394,7 @@ var StaticServer = class {
     ".ico": "image/x-icon",
     ".txt": "text/plain"
   };
-  constructor(pathPrefix, folderPath, cors) {
+  constructor(pathPrefix, folderPath, cors = []) {
     this._pathPrefix = "/" + pathPrefix.replace(/^\//, "").replace(/\/$/, "");
     this._absoluteFolderPath = path3.resolve(folderPath);
     this._cors = cors;
@@ -1414,9 +1469,10 @@ var StaticServer = class {
   }
   _handleRequest(req, res) {
     const { url, method } = req;
-    if (this._cors) {
+    if (this._cors.length && req.headers.origin && this._cors.includes(req.headers.origin)) {
       res.setHeader("Access-Control-Allow-Headers", "*");
-      res.setHeader("Access-Control-Allow-Origin", this._cors);
+      res.setHeader("Vary", "Origin");
+      res.setHeader("Access-Control-Allow-Origin", req.headers.origin);
       res.setHeader("Access-Control-Allow-Methods", "*");
       if (req.method === "OPTIONS") {
         res.writeHead(204);
@@ -1468,7 +1524,11 @@ async function showReport(reportFolder) {
   const projectPublicId = config.projectPublicId();
   const reportViewerEndpoint = config.reportViewerUrl();
   const token = randomUUIDBase62();
-  const server = new StaticServer(token, reportFolder, reportViewerEndpoint);
+  const server = new StaticServer(token, reportFolder, [
+    reportViewerEndpoint,
+    // trace.playwright.dev is used to load & display Playwright Test traces.
+    "https://trace.playwright.dev"
+  ]);
   await server.start(9373, "127.0.0.1");
   const url = new URL(reportViewerEndpoint);
   url.searchParams.set("port", String(server.port()));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "1.0.1",
+  "version": "1.1.0-alpha.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -25,7 +25,7 @@
   "author": "Degu Labs, Inc",
   "license": "MIT",
   "devDependencies": {
-    "@flakiness/flakiness-report": "^0.22.0",
+    "@flakiness/flakiness-report": "^0.25.0",
     "@types/debug": "^4.1.12",
     "@types/node": "^25.0.3",
     "esbuild": "^0.27.0",
@@ -34,7 +34,7 @@
     "typescript": "^5.6.2"
   },
   "peerDependencies": {
-    "@flakiness/flakiness-report": "^0.22.0"
+    "@flakiness/flakiness-report": "^0.25.0"
   },
   "dependencies": {
     "chalk": "^5.6.2",

package/types/src/_githubOIDC.d.ts

@@ -0,0 +1,8 @@
+export declare class GithubOIDC {
+    private _requestUrl;
+    private _requestToken;
+    static initializeFromEnv(): GithubOIDC | undefined;
+    constructor(_requestUrl: string, _requestToken: string);
+    fetchToken(audience: string): Promise<string>;
+}
+//# sourceMappingURL=_githubOIDC.d.ts.map

package/types/src/_githubOIDC.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_githubOIDC.d.ts","sourceRoot":"","sources":["../../src/_githubOIDC.ts"],"names":[],"mappings":"AAAA,qBAAa,UAAU;IAQnB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,aAAa;IARvB,MAAM,CAAC,iBAAiB,IAAI,UAAU,GAAC,SAAS;gBAOtC,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM;IAKzB,UAAU,CAAC,QAAQ,EAAE,MAAM;CAsBlC"}

package/types/src/showReport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"showReport.d.ts","sourceRoot":"","sources":["../../src/showReport.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,UAAU,CAAC,YAAY,EAAE,MAAM,iBAqBpD"}
+{"version":3,"file":"showReport.d.ts","sourceRoot":"","sources":["../../src/showReport.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,UAAU,CAAC,YAAY,EAAE,MAAM,iBAyBpD"}

package/types/src/staticServer.d.ts

@@ -2,9 +2,9 @@ export declare class StaticServer {
     private _server;
     private _absoluteFolderPath;
     private _pathPrefix;
-    private _cors?;
+    private _cors;
     private _mimeTypes;
-    constructor(pathPrefix: string, folderPath: string, cors?: string);
+    constructor(pathPrefix: string, folderPath: string, cors?: string[]);
     port(): number | undefined;
     address(): string | undefined;
     private _startServer;

package/types/src/staticServer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"staticServer.d.ts","sourceRoot":"","sources":["../../src/staticServer.ts"],"names":[],"mappings":"AAQA,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,KAAK,CAAC,CAAS;IAEvB,OAAO,CAAC,UAAU,CAWhB;gBAEU,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAQjE,IAAI;IAOJ,OAAO,IAAI,MAAM,GAAC,SAAS;YASb,YAAY;IAkBpB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,MAAoB;IAyB7C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAc5B,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,cAAc;CAiEvB"}
+{"version":3,"file":"staticServer.d.ts","sourceRoot":"","sources":["../../src/staticServer.ts"],"names":[],"mappings":"AAQA,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,KAAK,CAAW;IAExB,OAAO,CAAC,UAAU,CAWhB;gBAEU,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,GAAE,MAAM,EAAO;IAQvE,IAAI;IAOJ,OAAO,IAAI,MAAM,GAAC,SAAS;YASb,YAAY;IAkBpB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,MAAoB;IAyB7C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAc5B,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,cAAc;CAkEvB"}

package/types/src/uploadReport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploadReport.d.ts","sourceRoot":"","sources":["../../src/uploadReport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAW9D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,iEAAiE;IACjE,IAAI,EAAE,QAAQ,CAAC;IACf,4EAA4E;IAC5E,EAAE,EAAE,eAAe,CAAC,YAAY,CAAC;IACjC,4EAA4E;IAC5E,WAAW,EAAE,MAAM,CAAC;IACpB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,iFAAiF;IACjF,EAAE,EAAE,eAAe,CAAC,YAAY,CAAC;IACjC,4EAA4E;IAC5E,WAAW,EAAE,MAAM,CAAC;IACpB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;CACd,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,cAAc,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAOzG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAOrG;AAED,KAAK,YAAY,GACb;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GACxC;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACrC;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAExC,UAAU,MAAM;IACd,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,eAAe,CAAC,MAAM,EAC9B,WAAW,EAAE,UAAU,EAAE,EACzB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,YAAY,CAAC,CAiCvB"}
+{"version":3,"file":"uploadReport.d.ts","sourceRoot":"","sources":["../../src/uploadReport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAY9D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,iEAAiE;IACjE,IAAI,EAAE,QAAQ,CAAC;IACf,4EAA4E;IAC5E,EAAE,EAAE,eAAe,CAAC,YAAY,CAAC;IACjC,4EAA4E;IAC5E,WAAW,EAAE,MAAM,CAAC;IACpB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,iFAAiF;IACjF,EAAE,EAAE,eAAe,CAAC,YAAY,CAAC;IACjC,4EAA4E;IAC5E,WAAW,EAAE,MAAM,CAAC;IACpB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;CACd,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,cAAc,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAOzG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAOrG;AAED,KAAK,YAAY,GACb;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GACxC;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACrC;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAExC,UAAU,MAAM;IACd,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,eAAe,CAAC,MAAM,EAC9B,WAAW,EAAE,UAAU,EAAE,EACzB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,YAAY,CAAC,CAqDvB"}