Remove default history path in the config (#419)

Author: epszaw

packages/core/src/api.ts

@@ -19,7 +19,7 @@ export interface FullConfig {
   output: string;
   open: boolean;
   port: string | undefined;
-  historyPath: string;
+  historyPath?: string;
   knownIssuesPath: string;
   /**
    * You can specify default labels for tests which don't have them at all

packages/core/src/config.ts

@@ -163,7 +163,7 @@ export const resolveConfig = async (config: Config, override: ConfigOverride = {
   const name = override.name ?? config.name ?? "Allure Report";
   const open = override.open ?? config.open ?? false;
   const port = override.port ?? config.port ?? undefined;
-  const historyPath = resolve(override.historyPath ?? config.historyPath ?? "./.allure/history.jsonl");
+  const historyPath = override.historyPath ?? config.historyPath;
   const appendHistory = config.appendHistory ?? true;
   const knownIssuesPath = resolve(override.knownIssuesPath ?? config.knownIssuesPath ?? "./allure/known.json");
   const output = resolve(override.output ?? config.output ?? "./allure-report");
@@ -185,12 +185,12 @@ export const resolveConfig = async (config: Config, override: ConfigOverride = {
     output,
     open,
     port,
-    historyPath,
     knownIssuesPath,
     known,
     variables,
     environments,
     appendHistory,
+    historyPath: historyPath ? resolve(historyPath) : undefined,
     reportFiles: new FileSystemReportFiles(output),
     plugins: pluginInstances,
     defaultLabels: config.defaultLabels ?? {},

packages/core/src/report.ts

@@ -125,9 +125,12 @@ export class AllureReport {
     this.#plugins = [...plugins];
     this.#reportFiles = reportFiles;
     this.#output = output;
-    this.#history = this.#allureServiceClient
-      ? new AllureRemoteHistory(this.#allureServiceClient, this.#ci?.jobRunBranch)
-      : new AllureLocalHistory(historyPath);
+
+    if (this.#allureServiceClient) {
+      this.#history = new AllureRemoteHistory(this.#allureServiceClient, this.#ci?.jobRunBranch);
+    } else if (historyPath) {
+      this.#history = new AllureLocalHistory(historyPath);
+    }
   }
 
   get hasQualityGate() {

packages/core/src/store/store.ts

@@ -305,8 +305,10 @@ export class DefaultAllureStore implements AllureStore, ResultsVisitor {
     // Compute history-based statuses
     const trHistory = await this.historyByTr(testResult);
 
-    testResult.transition = getStatusTransition(testResult, trHistory);
-    testResult.flaky = isFlaky(testResult, trHistory);
+    if (trHistory) {
+      testResult.transition = getStatusTransition(testResult, trHistory);
+      testResult.flaky = isFlaky(testResult, trHistory);
+    }
 
     this.#testResults.set(testResult.id, testResult);
 
@@ -545,14 +547,22 @@ export class DefaultAllureStore implements AllureStore, ResultsVisitor {
     return tr ? this.retriesByTr(tr) : [];
   }
 
-  async historyByTr(tr: TestResult): Promise<HistoryTestResult[]> {
+  async historyByTr(tr: TestResult): Promise<HistoryTestResult[] | undefined> {
+    if (!this.#history) {
+      return undefined;
+    }
+
     return htrsByTr(this.#historyPoints, tr);
   }
 
-  async historyByTrId(trId: string): Promise<HistoryTestResult[]> {
+  async historyByTrId(trId: string): Promise<HistoryTestResult[] | undefined> {
     const tr = await this.testResultById(trId);
 
-    return tr ? this.historyByTr(tr) : [];
+    if (!tr) {
+      return undefined;
+    }
+
+    return this.historyByTr(tr);
   }
 
   async fixturesByTrId(trId: string): Promise<TestFixtureResult[]> {

packages/core/test/config.test.ts

@@ -246,11 +246,11 @@ describe("resolveConfig", () => {
     expect(resolved.name).toEqual("Custom");
   });
 
-  it("should set default history path if it's not provided", async () => {
+  it("shouldn't set default history path if it's not provided", async () => {
     const fixture = {} as Config;
     const resolved = await resolveConfig(fixture);
 
-    expect(resolved.historyPath).toEqual(resolve("./.allure/history.jsonl"));
+    expect(resolved.historyPath).toBeUndefined();
   });
 
   it("should return provided history path", async () => {

packages/e2e/test/allure-awesome/test/tree.test.ts

@@ -109,14 +109,13 @@ test.describe("commons", () => {
   test("statistics in metadata renders information about the tests", async () => {
     const stats = await treePage.getMetadataValues();
 
-    expect(stats).toEqual({
+    expect(stats).toMatchObject({
       total: "5",
       passed: "1",
       failed: "1",
       broken: "1",
       skipped: "1",
       unknown: "1",
-      new: "5",
     });
   });
 

packages/e2e/test/types.d.ts

@@ -1,3 +1,3 @@
 import type { FullConfig } from "@allurereport/core";
 
-export type ReportConfig = Omit<FullConfig, "output" | "reportFiles" | "plugins" | "historyPath">;
+export type ReportConfig = Omit<FullConfig, "output" | "reportFiles" | "plugins" | "historyPath" | "open" | "port">;

packages/e2e/test/utils/index.ts

@@ -1,6 +1,6 @@
 import { AllureReport, FileSystemReportFiles, type FullConfig } from "@allurereport/core";
-import { type HistoryDataPoint, type TestError } from "@allurereport/core-api";
-import { type ExitCode, QualityGateValidationResult } from "@allurereport/plugin-api";
+import type { HistoryDataPoint, TestError } from "@allurereport/core-api";
+import type { ExitCode, QualityGateValidationResult } from "@allurereport/plugin-api";
 import AwesomePlugin from "@allurereport/plugin-awesome";
 import { BufferResultFile } from "@allurereport/reader-api";
 import { serve } from "@allurereport/static-server";
@@ -20,7 +20,7 @@ export type GeneratorParams = {
   testResults?: Partial<TestResult>[];
   rawTestResults?: Partial<TestResult>[];
   attachments?: { source: string; content: Buffer }[];
-  reportConfig?: Omit<FullConfig, "output" | "reportFiles" | "historyPath">;
+  reportConfig?: Omit<FullConfig, "output" | "reportFiles" | "historyPath" | "port" | "open">;
   globals?: {
     exitCode?: ExitCode;
     errors?: TestError[];

packages/plugin-allure2/src/plugin.ts

@@ -45,7 +45,7 @@ export class Allure2Plugin implements Plugin {
     for (const value of tests) {
       const fixtures = await store.fixturesByTrId(value.id);
       const retries = await store.retriesByTrId(value.id);
-      const history = await store.historyByTrId(value.id);
+      const history = (await store.historyByTrId(value.id)) ?? [];
       const allure2TestResult = convertTestResult(
         {
           attachmentMap,

packages/plugin-api/src/store.ts

@@ -44,7 +44,7 @@ export interface AllureStore {
   attachmentsByTrId: (trId: string) => Promise<AttachmentLink[]>;
   retriesByTr: (tr: TestResult) => Promise<TestResult[]>;
   retriesByTrId: (trId: string) => Promise<TestResult[]>;
-  historyByTrId: (trId: string) => Promise<HistoryTestResult[]>;
+  historyByTrId: (trId: string) => Promise<HistoryTestResult[] | undefined>;
   fixturesByTrId: (trId: string) => Promise<TestFixtureResult[]>;
   // aggregate api
   failedTestResults: () => Promise<TestResult[]>;