@flakiness/sdk 3.3.1 → 3.4.0

package/lib/index.js

@@ -266,6 +266,7 @@ var GitWorktree = class _GitWorktree {
     this._gitRoot = _gitRoot;
     this._posixGitRoot = toPosixAbsolutePath(this._gitRoot);
   }
+  _gitRoot;
   /**
    * Initializes a GitWorktree for any path inside a git repository and resolves the
    * HEAD commit id in a single call.
@@ -492,6 +493,8 @@ var GithubOIDC = class _GithubOIDC {
     this._requestUrl = _requestUrl;
     this._requestToken = _requestToken;
   }
+  _requestUrl;
+  _requestToken;
   /**
    * Creates a GithubOIDC instance from GitHub Actions environment variables.
    *
@@ -1089,10 +1092,17 @@ async function fetchTestDurations(report, options) {
   const githubOIDC = GithubOIDC.initializeFromEnv();
   if (!flakinessAccessToken && githubOIDC && report.flakinessProject)
     flakinessAccessToken = await githubOIDC.createFlakinessAccessToken(report.flakinessProject);
-  if (!flakinessAccessToken)
-    throw new Error("No Flakiness access token available (set FLAKINESS_ACCESS_TOKEN, pass `flakinessAccessToken`, or run in GitHub Actions with `id-token: write` and a configured `flakinessProject`)");
   const flakinessEndpoint = options?.flakinessEndpoint ?? process.env["FLAKINESS_ENDPOINT"] ?? "https://flakiness.io";
-  const fetcher = new TestDurationsFetcher(report, { flakinessAccessToken, flakinessEndpoint });
+  let orgSlug;
+  let projectSlug;
+  if (!flakinessAccessToken) {
+    if (!report.flakinessProject)
+      throw new Error("Cannot fetch test durations: no Flakiness access token, and `report.flakinessProject` is unset so the project cannot be identified. Set FLAKINESS_ACCESS_TOKEN, pass `flakinessAccessToken`, or set `flakinessProject` (anonymous, public projects only).");
+    [orgSlug, projectSlug] = report.flakinessProject.split("/");
+    if (!orgSlug || !projectSlug)
+      throw new Error(`Cannot fetch test durations: \`report.flakinessProject\` must be in "org/project" format, got ${JSON.stringify(report.flakinessProject)}.`);
+  }
+  const fetcher = new TestDurationsFetcher(report, { flakinessAccessToken, flakinessEndpoint, orgSlug, projectSlug });
   return await fetcher.fetch();
 }
 var TestDurationsFetcher = class {
@@ -1105,12 +1115,12 @@ var TestDurationsFetcher = class {
   async _api(pathname, token, body) {
     const url = new URL3(this._options.flakinessEndpoint);
     url.pathname = pathname;
+    const headers = { "Content-Type": "application/json" };
+    if (token)
+      headers["Authorization"] = `Bearer ${token}`;
     return await getJSON(url, {
       method: "POST",
-      headers: {
-        "Authorization": `Bearer ${token}`,
-        "Content-Type": "application/json"
-      },
+      headers,
       body: body ? JSON.stringify(body) : void 0
     });
   }
@@ -1124,7 +1134,15 @@ var TestDurationsFetcher = class {
     const createResponse = await this._api(
       "/api/testDurations/create",
       this._options.flakinessAccessToken,
-      { commitId: this._report.commitId, shardGroupKey }
+      {
+        commitId: this._report.commitId,
+        shardGroupKey,
+        // With a token the server resolves the project from it. Anonymous
+        // callers must name the project explicitly; these are undefined (and so
+        // omitted from the JSON) in the authenticated path.
+        orgSlug: this._options.orgSlug,
+        projectSlug: this._options.projectSlug
+      }
     );
     await this._uploadReport(JSON.stringify(this._report), createResponse.uploadUrl);
     const submitResponse = await this._api(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -28,16 +28,16 @@
     "node": "^20.17.0 || >=22.9.0"
   },
   "devDependencies": {
-    "@flakiness/flakiness-report": "^0.34.0",
-    "@flakiness/playwright": "^1.3.3",
-    "@playwright/test": "^1.58.2",
-    "@types/debug": "^4.1.12",
-    "@types/node": "^25.0.3",
+    "@flakiness/flakiness-report": "0.35.0",
+    "@flakiness/playwright": "^1.14.0",
+    "@playwright/test": "^1.61.0",
+    "@types/debug": "^4.1.13",
+    "@types/node": "^25.9.4",
     "@types/which": "^3.0.4",
-    "esbuild": "^0.27.0",
+    "esbuild": "^0.28.1",
     "kubik": "^0.24.0",
-    "tsx": "^4.21.0",
-    "typescript": "^5.6.2"
+    "tsx": "^4.22.4",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "@flakiness/flakiness-report": ">=0.26.0 <1.0.0"
@@ -46,8 +46,8 @@
     "debug": "^4.4.3",
     "open": "^10.2.0",
     "stable-hash": "^0.0.6",
-    "which": "^6.0.1",
-    "zod": "^4.3.5"
+    "which": "^7.0.0",
+    "zod": "^4.4.3"
   },
   "scripts": {
     "minor": "./version.mjs minor",

package/types/src/fetchTestDurations.d.ts

@@ -16,9 +16,10 @@ export type FetchTestDurationsOptions = {
      * Access token for authenticating with the Flakiness.io platform.
      *
      * Defaults to the `FLAKINESS_ACCESS_TOKEN` environment variable. If no token is provided
-     * through this option or the environment variable, the function will attempt to authenticate
-     * via GitHub Actions OIDC when running in GitHub Actions (requires `report.flakinessProject`
-     * to be set and the project to be bound to the repository).
+     * through this option or the environment variable, the function attempts GitHub Actions OIDC
+     * when running in GitHub Actions (requires `report.flakinessProject` to be set and the project
+     * to be bound to the repository). If no token can be obtained, durations are fetched anonymously
+     * using `report.flakinessProject`, which the server only allows for public projects.
      *
      * @example 'flakiness-io-1234567890abcdef...'
      */
@@ -32,7 +33,8 @@ export type FetchTestDurationsOptions = {
  * finishes at roughly the same time.
  *
  * The function performs the following steps:
- * 1. Authenticates using an access token or GitHub Actions OIDC.
+ * 1. Resolves credentials: an access token, GitHub Actions OIDC, or anonymous access
+ *    for public projects.
  * 2. Computes a shard-group key from the report so that all shards of the same run
  *    fetch an identical set of timings.
  * 3. Uploads the (compressed) report so the platform knows which tests to time.
@@ -45,14 +47,18 @@ export type FetchTestDurationsOptions = {
  * 1. **Access token** — provided via `flakinessAccessToken` option or `FLAKINESS_ACCESS_TOKEN` env var.
  * 2. **GitHub Actions OIDC** — when running in GitHub Actions with no access token. This requires
  *    `report.flakinessProject` to be set and the project to be bound to the GitHub repository.
+ * 3. **Anonymous** — when no token can be obtained but `report.flakinessProject` is set. The request
+ *    names the project via that field and sends no credentials. The server only honors this for public
+ *    projects, which covers pull requests from forks: GitHub denies them both repository secrets and an
+ *    OIDC token. Private projects are rejected by the server.
  *
  * @param {FlakinessReport.Report} report - The report describing the tests to fetch durations for.
  * @param {FetchTestDurationsOptions} options - Optional configuration object.
  *
  * @returns {Promise<FlakinessReport.Report>} A report enriched with historical test durations.
  *
- * @throws {Error} If no access token is available, any API call fails, or the durations are not
- *   ready within the polling timeout.
+ * @throws {Error} If the project cannot be identified (no access token and no `report.flakinessProject`),
+ *   any API call fails, or the durations are not ready within the polling timeout.
  *
  * @example
  * ```typescript

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

@@ -1 +1 @@
-{"version":3,"file":"fetchTestDurations.d.ts","sourceRoot":"","sources":["../../src/fetchTestDurations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAU9D;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAA;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,eAAe,CAAC,MAAM,EAC9B,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAajC"}
+{"version":3,"file":"fetchTestDurations.d.ts","sourceRoot":"","sources":["../../src/fetchTestDurations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAgB9D;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAA;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,eAAe,CAAC,MAAM,EAC9B,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CA0BjC"}