use jwt instead of self-written format for tokens

Author: epszaw

package.json

@@ -33,8 +33,8 @@
     ]
   },
   "resolutions": {
-    "@preact/signals": "^2.5.1",
     "@preact/compat": "^18.3.1",
+    "@preact/signals": "^2.5.1",
     "backbone.marionette@npm:3.5.1/backbone": "^1.6.0",
     "backbone.marionette@npm:3.5.1/underscore": "^1.13.6",
     "braces": "^3.0.3",

packages/core/test/report.test.ts

@@ -7,6 +7,10 @@ import { resolveConfig } from "../src/index.js";
 import { AllureReport } from "../src/report.js";
 import { AllureServiceClientMock } from "./utils.js";
 
+// JWT payload: { "iss": "allure-service", "url": "https://service.allurereport.org", "projectId": "test-project-id" }
+const validAccessToken =
+  "header.eyJpc3MiOiJhbGx1cmUtc2VydmljZSIsInVybCI6Imh0dHBzOi8vc2VydmljZS5hbGx1cmVyZXBvcnQub3JnIiwicHJvamVjdElkIjoidGVzdC1wcm9qZWN0LWlkIn0.signature";
+
 vi.mock("@allurereport/service", async (importOriginal) => {
   const utils = await import("./utils.js");
 
@@ -215,8 +219,7 @@ describe("report", () => {
     const allureReport = new AllureReport({
       ...config,
       allureService: {
-        url: fixtures.reportUrl,
-        project: "test-project",
+        accessToken: validAccessToken,
       },
     });
 

packages/core/test/utils.ts

@@ -5,26 +5,28 @@ export class AllureServiceMock {}
 // eslint-disable-next-line prefer-arrow/prefer-arrow-functions
 export const AllureServiceClientMock = vi.fn(function () {});
 
-AllureServiceClientMock.prototype.login = vi.fn();
-
-AllureServiceClientMock.prototype.logout = vi.fn();
+AllureServiceClientMock.prototype.decodeToken = vi.fn();
 
 AllureServiceClientMock.prototype.profile = vi.fn();
 
-AllureServiceClientMock.prototype.createProject = vi.fn();
+AllureServiceClientMock.prototype.generateNewAccessToken = vi.fn();
 
 AllureServiceClientMock.prototype.projects = vi.fn();
 
-AllureServiceClientMock.prototype.deleteProject = vi.fn();
+AllureServiceClientMock.prototype.project = vi.fn();
 
-AllureServiceClientMock.prototype.appendHistory = vi.fn();
+AllureServiceClientMock.prototype.createProject = vi.fn();
+
+AllureServiceClientMock.prototype.deleteProject = vi.fn();
 
 AllureServiceClientMock.prototype.downloadHistory = vi.fn();
 
 AllureServiceClientMock.prototype.createReport = vi.fn();
 
+AllureServiceClientMock.prototype.completeReport = vi.fn();
+
+AllureServiceClientMock.prototype.deleteReport = vi.fn();
+
 AllureServiceClientMock.prototype.addReportAsset = vi.fn();
 
 AllureServiceClientMock.prototype.addReportFile = vi.fn();
-
-AllureServiceClientMock.prototype.completeReport = vi.fn();

packages/sandbox/allurerc.mjs

@@ -115,4 +115,7 @@ export default defineConfig({
       matcher: ({ labels }) => labels.some(({ name, value }) => name === "env" && value === "bar"),
     },
   },
+  allureService: {
+    accessToken: "eyJhbGciOiJIUzI1NiJ9.eyJwcm9qZWN0SWQiOiIwOTU1NDZlNS05ZmVkLTQ4MmItYTdkZC0yNGEwMDFmYmI4MzciLCJ1cmwiOiJodHRwOi8vbG9jYWxob3N0Ojk5OTEiLCJpYXQiOjE3Njc4NjEzNDcsImlzcyI6ImFsbHVyZS1zZXJ2aWNlIn0.xXRc3x3VBzKTnzZCtnW-dy23adWpG0puOROSOKG1wM4"
+  }
 });

packages/service/src/service.ts

@@ -15,22 +15,27 @@ export class AllureServiceClient {
       throw new Error("Allure service access token is required");
     }
 
-    const [prefix, body] = atob(config.accessToken).split(":");
+    const { iss, projectId, url: baseUrl } = this.decodeToken(config.accessToken) ?? {};
 
-    if (prefix !== "allure-service") {
-      throw new Error("Invalid access token");
-    }
-
-    const { projectId, url: baseUrl } = JSON.parse(atob(body));
-
-    if (!baseUrl || !projectId) {
+    if (iss !== "allure-service" || !baseUrl || !projectId) {
       throw new Error("Invalid access token");
     }
 
     this.#url = baseUrl;
     this.#client = createServiceHttpClient(this.#url, config.accessToken);
   }
 
+  decodeToken(token: string) {
+    try {
+      const base64Url = token.split(".")[1];
+      const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
+
+      return JSON.parse(atob(base64));
+    } catch {
+      return undefined;
+    }
+  }
+
   /**
    * Returns user profile and current project
    */
@@ -71,34 +76,16 @@ export class AllureServiceClient {
     return this.#client.get<{ project: { id: string; name: string } }>(`/projects/${uuid}`);
   }
 
-  /**
-   * Creates a new project
-   * @param payload
-   */
-  async createProject(payload: { name: string }) {
-    const { project } = await this.#client.post<{ project: { id: string; name: string } }>("/projects", {
-      body: payload,
-    });
-
-    return project;
-  }
-
-  /**
-   * Deletes a project
-   * @param payload
-   */
-  async deleteProject(payload: { id: string }) {
-    return this.#client.delete(`/projects/${payload.id}`);
-  }
-
   /**
    * Downloads history data for a specific branch
    * @param payload
    */
   async downloadHistory(payload: { branch: string; limit?: number }) {
     const { branch, limit } = payload;
     const { history } = await this.#client.get<{ history: HistoryDataPoint[] }>(
-      limit ? `/projects/history/${encodeURIComponent(branch)}?limit=${limit}` : `/projects/history/${encodeURIComponent(branch)}`,
+      limit
+        ? `/projects/history/${encodeURIComponent(branch)}?limit=${encodeURIComponent(limit.toString())}`
+        : `/projects/history/${encodeURIComponent(branch)}`,
     );
 
     return history;

packages/service/test/history.test.ts

@@ -7,8 +7,14 @@ import { HttpClientMock } from "./utils.js";
 
 const { AllureServiceClient: AllureServiceClientClass } = await import("../src/service.js");
 
+// Static JWT token fixture
+// JWT payload: { "iss": "allure-service", "url": "https://service.allurereport.org", "projectId": "test-project-id" }
+const validAccessToken =
+  "header.eyJpc3MiOiJhbGx1cmUtc2VydmljZSIsInVybCI6Imh0dHBzOi8vc2VydmljZS5hbGx1cmVyZXBvcnQub3JnIiwicHJvamVjdElkIjoidGVzdC1wcm9qZWN0LWlkIn0.signature";
+
 const fixtures = {
-  project: "project",
+  accessToken: validAccessToken,
+  project: "test-project-id",
   url: "https://service.allurereport.org",
   branch: "main",
   historyDataPoint: {
@@ -42,7 +48,7 @@ describe("AllureRemoteHistory", () => {
   let history: AllureRemoteHistory;
 
   beforeEach(() => {
-    serviceClient = new AllureServiceClientClass({ url: fixtures.url, project: fixtures.project });
+    serviceClient = new AllureServiceClientClass({ accessToken: fixtures.accessToken });
     history = new AllureRemoteHistory({
       allureServiceClient: serviceClient,
       branch: fixtures.branch,
@@ -69,9 +75,7 @@ describe("AllureRemoteHistory", () => {
 
       const result = await history.readHistory();
 
-      expect(HttpClientMock.prototype.get).toHaveBeenCalledWith(
-        `/projects/${fixtures.project}/${fixtures.branch}/history`,
-      );
+      expect(HttpClientMock.prototype.get).toHaveBeenCalledWith(`/projects/history/${fixtures.branch}`);
       expect(result).toEqual([fixtures.historyDataPoint]);
     });
 
@@ -100,9 +104,7 @@ describe("AllureRemoteHistory", () => {
 
       const result = await history.readHistory();
 
-      expect(HttpClientMock.prototype.get).toHaveBeenCalledWith(
-        `/projects/${fixtures.project}/${fixtures.branch}/history?limit=10`,
-      );
+      expect(HttpClientMock.prototype.get).toHaveBeenCalledWith(`/projects/history/${fixtures.branch}?limit=10`);
       expect(result).toEqual([fixtures.historyDataPoint]);
     });