@allurereport/core 3.14.0 → 3.14.2

package/dist/api.d.ts

@@ -8,7 +8,7 @@ export interface PluginInstance {
     options: Record<string, any>;
 }
 type FullConfigRequiredFromConfig = Required<Pick<Config, "name" | "output" | "open" | "knownIssuesPath">>;
-export interface FullConfig extends Omit<Config, "name" | "output" | "open" | "knownIssuesPath" | "plugins" | "port" | "allureService">, FullConfigRequiredFromConfig {
+export interface FullConfig extends Omit<Config, "name" | "output" | "open" | "allureService" | "knownIssuesPath" | "plugins" | "port">, FullConfigRequiredFromConfig {
     port: Config["port"] | undefined;
     allowedEnvironments?: Config["allowedEnvironments"];
     reportFiles: ReportFiles;

package/dist/report.js

@@ -33,22 +33,21 @@ import { AllureLocalHistory, createHistory } from "./history.js";
 import { DefaultPluginState, PluginFiles } from "./plugin.js";
 import { QualityGate } from "./qualityGate/index.js";
 import { DefaultAllureStore } from "./store/store.js";
-import { createUploadProgressBarCounter } from "./utils/cli.js";
 import { environmentIdentityById, environmentIdentityByName } from "./utils/environment.js";
 import { measurePerf, PERF_METRIC_NAMES, PERF_METRIC_PREFIXES, startPerfSpan, writePerfMetrics } from "./utils/perf.js";
 import { RealtimeChannel } from "./utils/realtimeChannel.js";
 import { RealtimeUpdateScheduler } from "./utils/realtimeUpdateScheduler.js";
 import { resolveDumpAttachmentPath, UnsafeDumpPathError } from "./utils/safeDumpPath.js";
 const { version } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
-const initRequired = "report is not initialised. Call the start() method first.";
-const defaultReadConcurrency = 64;
-const maxReadConcurrency = 256;
+const INIT_REQUIRED_ERROR_MESSAGE = "report is not initialised. Call the start() method first.";
+const DEFAULT_READ_CONCURRENCY = 64;
+const MAX_READ_CONCURRENCY = 256;
 const readConcurrency = () => {
     const parsed = Number.parseInt(process.env.ALLURE_READ_CONCURRENCY ?? "", 10);
     if (!Number.isFinite(parsed)) {
-        return defaultReadConcurrency;
+        return DEFAULT_READ_CONCURRENCY;
     }
-    return Math.min(maxReadConcurrency, Math.max(1, parsed));
+    return Math.min(MAX_READ_CONCURRENCY, Math.max(1, parsed));
 };
 const clonePluginSummary = (summary) => structuredClone(summary);
 const remoteReportParams = (ci) => {
@@ -124,12 +123,36 @@ export class AllureReport {
             const client = __classPrivateFieldGet(this, _AllureReport_allureServiceClient, "f");
             const linksByPluginId = {};
             const summariesSnapshot = __classPrivateFieldGet(this, _AllureReport_cloneSummariesByPluginId, "f").call(this);
-            const uploadProgressBar = createUploadProgressBarCounter(reportsToPublish.length === 1 ? `Publishing "${reportsToPublish[0].pluginId}" report` : "Publishing reports", reportsToPublish.reduce((acc, report) => acc + Object.keys(report.files).length, 0));
+            const uploadProgressMessage = reportsToPublish.length === 1 ? `Publishing "${reportsToPublish[0].pluginId}" report` : "Publishing reports";
+            const totalFilesToUpload = reportsToPublish.reduce((acc, report) => acc + Object.keys(report.files).length, 0);
+            const progressStep = Math.max(1, Math.ceil(totalFilesToUpload / 20));
             let summariesMutated = false;
             let reportCreated = false;
             let publishErrorMessage = "Report upload has failed, the report won't be published";
+            let uploadedFiles = 0;
+            let nextProgressLogAt = 0;
+            let lastProgressLog = -1;
             const endPublishPerfSpan = startPerfSpan(PERF_METRIC_NAMES.publishUploadTotal);
+            const logUploadProgress = (force = false) => {
+                if (force && uploadedFiles === lastProgressLog) {
+                    return;
+                }
+                if (!force && uploadedFiles < nextProgressLogAt && uploadedFiles !== totalFilesToUpload) {
+                    return;
+                }
+                if (!force && uploadedFiles === lastProgressLog) {
+                    return;
+                }
+                console.info(`[AllureReport]: ${uploadProgressMessage}: ${uploadedFiles}/${totalFilesToUpload} files uploaded`);
+                lastProgressLog = uploadedFiles;
+                nextProgressLogAt = Math.min(totalFilesToUpload, uploadedFiles + progressStep);
+            };
+            const incrementUploadProgress = (delta = 1) => {
+                uploadedFiles = Math.min(totalFilesToUpload, uploadedFiles + delta);
+                logUploadProgress();
+            };
             try {
+                logUploadProgress(true);
                 await client.createReport({
                     reportUuid: this.reportUuid,
                     reportName: this.reportName,
@@ -138,11 +161,12 @@ export class AllureReport {
                 reportCreated = true;
                 for (const report of reportsToPublish) {
                     publishErrorMessage = `Plugin "${report.pluginId}" upload has failed, the plugin won't be published`;
+                    const reportFiles = Object.fromEntries(Object.entries(report.files).filter(([filename]) => filename !== "summary.json"));
                     const uploadResult = await measurePerf(`${PERF_METRIC_PREFIXES.publishUploadPlugin}${report.pluginId}`, () => client.uploadReport({
                         reportUuid: this.reportUuid,
                         pluginId: report.pluginId,
-                        files: Object.fromEntries(Object.entries(report.files).filter(([filename]) => filename !== "summary.json")),
-                        onProgress: () => uploadProgressBar.tick(),
+                        files: reportFiles,
+                        onProgress: incrementUploadProgress,
                     }));
                     if (uploadResult.indexHref) {
                         linksByPluginId[report.pluginId] = uploadResult.indexHref;
@@ -167,15 +191,13 @@ export class AllureReport {
                         reportUuid: this.reportUuid,
                         pluginId: updatedReport.pluginId,
                         files: { "summary.json": summaryFilepath },
-                        onProgress: () => uploadProgressBar.tick(),
+                        onProgress: incrementUploadProgress,
                     });
                 }
                 publishErrorMessage = "Report summary upload has failed, the report won't be published";
                 const summaryHref = __classPrivateFieldGet(this, _AllureReport_summaryPath, "f")
-                    ? (await client.uploadReport({
-                        reportUuid: this.reportUuid,
-                        files: { "index.html": __classPrivateFieldGet(this, _AllureReport_summaryPath, "f") },
-                    })).indexHref
+                    ? (await client.uploadReport({ reportUuid: this.reportUuid, files: { "index.html": __classPrivateFieldGet(this, _AllureReport_summaryPath, "f") } }))
+                        .indexHref
                     : undefined;
                 publishErrorMessage = "Report completion has failed, the report won't be published";
                 await client.completeReport({
@@ -189,6 +211,7 @@ export class AllureReport {
                     __classPrivateFieldGet(this, _AllureReport_publishedRemoteHrefs, "f").add(summaryHref);
                 }
                 __classPrivateFieldSet(this, _AllureReport_published, true, "f");
+                logUploadProgress(true);
             }
             catch (err) {
                 if (reportCreated) {
@@ -203,12 +226,11 @@ export class AllureReport {
             }
             finally {
                 endPublishPerfSpan();
-                uploadProgressBar.terminate();
             }
         });
         this.readDirectory = async (resultsDir) => measurePerf(PERF_METRIC_NAMES.generateReadResults, async () => {
             if (__classPrivateFieldGet(this, _AllureReport_executionStage, "f") !== "running") {
-                throw new Error(initRequired);
+                throw new Error(INIT_REQUIRED_ERROR_MESSAGE);
             }
             const resultsDirPath = resolve(resultsDir);
             if (await readXcResultBundle(__classPrivateFieldGet(this, _AllureReport_store, "f"), resultsDirPath)) {
@@ -235,13 +257,13 @@ export class AllureReport {
         });
         this.readFile = async (resultsFile) => measurePerf(PERF_METRIC_NAMES.generateReadResults, async () => {
             if (__classPrivateFieldGet(this, _AllureReport_executionStage, "f") !== "running") {
-                throw new Error(initRequired);
+                throw new Error(INIT_REQUIRED_ERROR_MESSAGE);
             }
             await this.readResult(new PathResultFile(resultsFile));
         });
         this.readResult = async (data) => {
             if (__classPrivateFieldGet(this, _AllureReport_executionStage, "f") !== "running") {
-                throw new Error(initRequired);
+                throw new Error(INIT_REQUIRED_ERROR_MESSAGE);
             }
             for (const reader of __classPrivateFieldGet(this, _AllureReport_readers, "f")) {
                 try {
@@ -681,7 +703,7 @@ export class AllureReport {
         this.done = async () => {
             const summaries = [];
             if (__classPrivateFieldGet(this, _AllureReport_executionStage, "f") !== "running") {
-                throw new Error(initRequired);
+                throw new Error(INIT_REQUIRED_ERROR_MESSAGE);
             }
             try {
                 const testResults = await __classPrivateFieldGet(this, _AllureReport_store, "f").allTestResults();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core",
-  "version": "3.14.0",
+  "version": "3.14.2",
   "description": "Collection of generic Allure utilities used across the entire project",
   "keywords": [
     "allure"
@@ -25,32 +25,32 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/ci": "3.14.0",
-    "@allurereport/core-api": "3.14.0",
-    "@allurereport/plugin-agent": "3.14.0",
-    "@allurereport/plugin-allure2": "3.14.0",
-    "@allurereport/plugin-api": "3.14.0",
-    "@allurereport/plugin-awesome": "3.14.0",
-    "@allurereport/plugin-classic": "3.14.0",
-    "@allurereport/plugin-csv": "3.14.0",
-    "@allurereport/plugin-dashboard": "3.14.0",
-    "@allurereport/plugin-jira": "3.14.0",
-    "@allurereport/plugin-log": "3.14.0",
-    "@allurereport/plugin-progress": "3.14.0",
-    "@allurereport/plugin-slack": "3.14.0",
-    "@allurereport/plugin-testops": "3.14.0",
-    "@allurereport/plugin-testplan": "3.14.0",
-    "@allurereport/reader": "3.14.0",
-    "@allurereport/reader-api": "3.14.0",
-    "@allurereport/service": "3.14.0",
-    "@allurereport/summary": "3.14.0",
+    "@allurereport/ci": "3.14.2",
+    "@allurereport/core-api": "3.14.2",
+    "@allurereport/plugin-agent": "3.14.2",
+    "@allurereport/plugin-allure2": "3.14.2",
+    "@allurereport/plugin-api": "3.14.2",
+    "@allurereport/plugin-awesome": "3.14.2",
+    "@allurereport/plugin-classic": "3.14.2",
+    "@allurereport/plugin-csv": "3.14.2",
+    "@allurereport/plugin-dashboard": "3.14.2",
+    "@allurereport/plugin-jira": "3.14.2",
+    "@allurereport/plugin-log": "3.14.2",
+    "@allurereport/plugin-progress": "3.14.2",
+    "@allurereport/plugin-slack": "3.14.2",
+    "@allurereport/plugin-testops": "3.14.2",
+    "@allurereport/plugin-testplan": "3.14.2",
+    "@allurereport/reader": "3.14.2",
+    "@allurereport/reader-api": "3.14.2",
+    "@allurereport/service": "3.14.2",
+    "@allurereport/summary": "3.14.2",
     "glob": "^13.0.6",
     "handlebars": "^4.7.9",
     "node-stream-zip": "^1.15.0",
     "p-limit": "^7.3.0",
     "yaml": "^2.8.3",
     "yoctocolors": "^2.1.1",
-    "zip-stream": "^7.0.2"
+    "zip-stream": "^7.0.5"
   },
   "devDependencies": {
     "@types/node": "^20",

package/dist/utils/cli.d.ts

@@ -1,4 +0,0 @@
-export declare const createUploadProgressBarCounter: (message: string, total: number) => {
-    tick: () => void;
-    terminate: () => void;
-};

package/dist/utils/cli.js

@@ -1,41 +0,0 @@
-import { blue, bold, cyan } from "yoctocolors";
-const noopUploadProgressBar = {
-    tick: () => { },
-    terminate: () => { },
-};
-const isSilentLogLevel = () => {
-    const level = process.env.LOG_LEVEL ?? process.env.ALLURE_LOG_LEVEL;
-    return level === "silent";
-};
-export const createUploadProgressBarCounter = (message, total) => {
-    if (isSilentLogLevel() || total === 0 || !process.stderr.isTTY) {
-        return noopUploadProgressBar;
-    }
-    const width = 20;
-    const prefix = cyan(bold("[AllureReport]:"));
-    let current = 0;
-    let terminated = false;
-    const render = () => {
-        const ratio = total === 0 ? 1 : current / total;
-        const complete = Math.min(width, Math.round(ratio * width));
-        const bar = `${"=".repeat(complete)}${"-".repeat(width - complete)}`;
-        process.stderr.write(`\r${prefix} ${blue(message)} [${bar}] ${current}/${total}`);
-    };
-    render();
-    return {
-        tick: () => {
-            if (terminated) {
-                return;
-            }
-            current = Math.min(current + 1, total);
-            render();
-        },
-        terminate: () => {
-            if (terminated) {
-                return;
-            }
-            terminated = true;
-            process.stderr.write("\n");
-        },
-    };
-};