ortoni-report 4.0.1-beta.0 → 4.0.1

package/dist/ortoni-report.d.mts

@@ -78,6 +78,13 @@ interface OrtoniReportConfig {
      * @example { "key": "value" } as string
      */
     meta?: Record<string, string>;
+    /**
+     * Save the history of the reports in a SQL file to be used in future reports.
+     * The history file will be saved in the report folder.
+     * @default true
+     * @example false (to disable)
+     */
+    saveHistory?: boolean;
 }
 
 declare class OrtoniReport implements Reporter {

package/dist/ortoni-report.d.ts

@@ -78,6 +78,13 @@ interface OrtoniReportConfig {
      * @example { "key": "value" } as string
      */
     meta?: Record<string, string>;
+    /**
+     * Save the history of the reports in a SQL file to be used in future reports.
+     * The history file will be saved in the report folder.
+     * @default true
+     * @example false (to disable)
+     */
+    saveHistory?: boolean;
 }
 
 declare class OrtoniReport implements Reporter {

package/dist/ortoni-report.js

@@ -1,4 +1,3 @@
-"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -38,68 +37,131 @@ __export(ortoni_report_exports, {
 module.exports = __toCommonJS(ortoni_report_exports);
 
 // src/helpers/fileManager.ts
+var import_fs2 = __toESM(require("fs"));
+var import_path2 = __toESM(require("path"));
+
+// src/helpers/templateLoader.ts
 var import_fs = __toESM(require("fs"));
 var import_path = __toESM(require("path"));
+var import_meta = {};
+async function readBundledTemplate(pkgName = "ortoni-report") {
+  const packagedRel = "dist/index.html";
+  try {
+    if (typeof require === "function") {
+      const resolved = require.resolve(`${pkgName}/${packagedRel}`);
+      if (import_fs.default.existsSync(resolved)) {
+        return import_fs.default.readFileSync(resolved, "utf-8");
+      }
+    }
+  } catch {
+  }
+  try {
+    const moduleNS = await import("module");
+    if (moduleNS && typeof moduleNS.createRequire === "function") {
+      const createRequire = moduleNS.createRequire;
+      const req = createRequire(
+        // @ts-ignore
+        typeof __filename !== "undefined" ? __filename : import_meta.url
+      );
+      const resolved = req.resolve(`${pkgName}/${packagedRel}`);
+      if (import_fs.default.existsSync(resolved)) {
+        return import_fs.default.readFileSync(resolved, "utf-8");
+      }
+    }
+  } catch {
+  }
+  try {
+    const here = import_path.default.resolve(__dirname, "../dist/index.html");
+    if (import_fs.default.existsSync(here)) return import_fs.default.readFileSync(here, "utf-8");
+  } catch {
+  }
+  try {
+    const nm = import_path.default.join(process.cwd(), "node_modules", pkgName, packagedRel);
+    if (import_fs.default.existsSync(nm)) return import_fs.default.readFileSync(nm, "utf-8");
+  } catch {
+  }
+  try {
+    const alt = import_path.default.join(process.cwd(), "dist", "index.html");
+    if (import_fs.default.existsSync(alt)) return import_fs.default.readFileSync(alt, "utf-8");
+  } catch {
+  }
+  throw new Error(
+    `ortoni-report template not found (tried:
+  - require.resolve('${pkgName}/${packagedRel}')
+  - import('module').createRequire(...).resolve('${pkgName}/${packagedRel}')
+  - relative ../dist/index.html
+  - ${import_path.default.join(
+      process.cwd(),
+      "node_modules",
+      pkgName,
+      packagedRel
+    )}
+  - ${import_path.default.join(process.cwd(), "dist", "index.html")}
+Ensure 'dist/index.html' is present in the published package and package.json 'files' includes 'dist/'.`
+  );
+}
+
+// src/helpers/fileManager.ts
 var FileManager = class {
   constructor(folderPath) {
     this.folderPath = folderPath;
   }
   ensureReportDirectory() {
-    const ortoniDataFolder = import_path.default.join(this.folderPath, "ortoni-data");
-    if (!import_fs.default.existsSync(this.folderPath)) {
-      import_fs.default.mkdirSync(this.folderPath, { recursive: true });
+    const ortoniDataFolder = import_path2.default.join(this.folderPath, "ortoni-data");
+    if (!import_fs2.default.existsSync(this.folderPath)) {
+      import_fs2.default.mkdirSync(this.folderPath, { recursive: true });
     } else {
-      if (import_fs.default.existsSync(ortoniDataFolder)) {
-        import_fs.default.rmSync(ortoniDataFolder, { recursive: true, force: true });
+      if (import_fs2.default.existsSync(ortoniDataFolder)) {
+        import_fs2.default.rmSync(ortoniDataFolder, { recursive: true, force: true });
       }
     }
   }
-  writeReportFile(filename, data) {
-    const templatePath = import_path.default.join(__dirname, "..", "index.html");
-    let html = import_fs.default.readFileSync(templatePath, "utf-8");
+  async writeReportFile(filename, data) {
+    let html = await readBundledTemplate();
     const reportJSON = JSON.stringify({
       data
     });
     html = html.replace("__ORTONI_TEST_REPORTDATA__", reportJSON);
-    import_fs.default.writeFileSync(filename, html);
-    return filename;
+    const outputPath = import_path2.default.join(process.cwd(), this.folderPath, filename);
+    import_fs2.default.writeFileSync(outputPath, html);
+    return outputPath;
   }
   writeRawFile(filename, data) {
-    const outputPath = import_path.default.join(process.cwd(), this.folderPath, filename);
-    import_fs.default.mkdirSync(import_path.default.dirname(outputPath), { recursive: true });
+    const outputPath = import_path2.default.join(process.cwd(), this.folderPath, filename);
+    import_fs2.default.mkdirSync(import_path2.default.dirname(outputPath), { recursive: true });
     const content = typeof data === "string" ? data : JSON.stringify(data, null, 2);
-    import_fs.default.writeFileSync(outputPath, content, "utf-8");
+    import_fs2.default.writeFileSync(outputPath, content, "utf-8");
     return outputPath;
   }
   copyTraceViewerAssets(skip) {
     if (skip) return;
-    const traceViewerFolder = import_path.default.join(
+    const traceViewerFolder = import_path2.default.join(
       require.resolve("playwright-core"),
       "..",
       "lib",
       "vite",
       "traceViewer"
     );
-    const traceViewerTargetFolder = import_path.default.join(this.folderPath, "trace");
-    const traceViewerAssetsTargetFolder = import_path.default.join(
+    const traceViewerTargetFolder = import_path2.default.join(this.folderPath, "trace");
+    const traceViewerAssetsTargetFolder = import_path2.default.join(
       traceViewerTargetFolder,
       "assets"
     );
-    import_fs.default.mkdirSync(traceViewerAssetsTargetFolder, { recursive: true });
-    for (const file of import_fs.default.readdirSync(traceViewerFolder)) {
+    import_fs2.default.mkdirSync(traceViewerAssetsTargetFolder, { recursive: true });
+    for (const file of import_fs2.default.readdirSync(traceViewerFolder)) {
       if (file.endsWith(".map") || file.includes("watch") || file.includes("assets"))
         continue;
-      import_fs.default.copyFileSync(
-        import_path.default.join(traceViewerFolder, file),
-        import_path.default.join(traceViewerTargetFolder, file)
+      import_fs2.default.copyFileSync(
+        import_path2.default.join(traceViewerFolder, file),
+        import_path2.default.join(traceViewerTargetFolder, file)
       );
     }
-    const assetsFolder = import_path.default.join(traceViewerFolder, "assets");
-    for (const file of import_fs.default.readdirSync(assetsFolder)) {
+    const assetsFolder = import_path2.default.join(traceViewerFolder, "assets");
+    for (const file of import_fs2.default.readdirSync(assetsFolder)) {
       if (file.endsWith(".map") || file.includes("xtermModule")) continue;
-      import_fs.default.copyFileSync(
-        import_path.default.join(assetsFolder, file),
-        import_path.default.join(traceViewerAssetsTargetFolder, file)
+      import_fs2.default.copyFileSync(
+        import_path2.default.join(assetsFolder, file),
+        import_path2.default.join(traceViewerAssetsTargetFolder, file)
       );
     }
   }
@@ -148,13 +210,46 @@ var HTMLGenerator = class {
     );
     return data;
   }
+  /**
+   * Return safe analytics/report data.
+   * If no dbManager is provided, return empty defaults and a note explaining why.
+   */
   async getReportData() {
-    return {
-      summary: await this.dbManager.getSummaryData(),
-      trends: await this.dbManager.getTrends(),
-      flakyTests: await this.dbManager.getFlakyTests(),
-      slowTests: await this.dbManager.getSlowTests()
-    };
+    if (!this.dbManager) {
+      return {
+        summary: {},
+        trends: {},
+        flakyTests: [],
+        slowTests: [],
+        note: "Test history/trends are unavailable (saveHistory disabled or DB not initialized)."
+      };
+    }
+    try {
+      const [summary, trends, flakyTests, slowTests] = await Promise.all([
+        this.dbManager.getSummaryData ? this.dbManager.getSummaryData() : Promise.resolve({}),
+        this.dbManager.getTrends ? this.dbManager.getTrends() : Promise.resolve({}),
+        this.dbManager.getFlakyTests ? this.dbManager.getFlakyTests() : Promise.resolve([]),
+        this.dbManager.getSlowTests ? this.dbManager.getSlowTests() : Promise.resolve([])
+      ]);
+      return {
+        summary: summary ?? {},
+        trends: trends ?? {},
+        flakyTests: flakyTests ?? [],
+        slowTests: slowTests ?? []
+      };
+    } catch (err) {
+      console.warn(
+        "HTMLGenerator: failed to read analytics from DB, continuing without history.",
+        err
+      );
+      return {
+        summary: {},
+        trends: {},
+        flakyTests: [],
+        slowTests: [],
+        note: "Test history/trends could not be loaded due to a DB error."
+      };
+    }
   }
   async prepareReportData(filteredResults, totalDuration, results, projectSet) {
     const totalTests = filteredResults.length;
@@ -163,10 +258,10 @@ var HTMLGenerator = class {
     const failed = filteredResults.filter(
       (r) => r.status === "failed" || r.status === "timedOut"
     ).length;
-    const successRate = ((passedTests + flakyTests) / totalTests * 100).toFixed(2);
+    const successRate = totalTests === 0 ? "0.00" : ((passedTests + flakyTests) / totalTests * 100).toFixed(2);
     const allTags = /* @__PURE__ */ new Set();
     results.forEach(
-      (result) => result.testTags.forEach((tag) => allTags.add(tag))
+      (result) => (result.testTags || []).forEach((tag) => allTags.add(tag))
     );
     const projectResults = this.calculateProjectResults(
       filteredResults,
@@ -177,13 +272,31 @@ var HTMLGenerator = class {
     const testHistories = await Promise.all(
       results.map(async (result) => {
         const testId = `${result.filePath}:${result.projectName}:${result.title}`;
-        const history = await this.dbManager.getTestHistory(testId);
-        return {
-          testId,
-          history
-        };
+        if (!this.dbManager || !this.dbManager.getTestHistory) {
+          return {
+            testId,
+            history: []
+          };
+        }
+        try {
+          const history = await this.dbManager.getTestHistory(testId);
+          return {
+            testId,
+            history: history ?? []
+          };
+        } catch (err) {
+          console.warn(
+            `HTMLGenerator: failed to read history for ${testId}`,
+            err
+          );
+          return {
+            testId,
+            history: []
+          };
+        }
       })
     );
+    const reportData = await this.getReportData();
     return {
       summary: {
         overAllResult: {
@@ -219,7 +332,7 @@ var HTMLGenerator = class {
         showProject: this.ortoniConfig.showProject || false
       },
       analytics: {
-        reportData: await this.getReportData()
+        reportData
       }
     };
   }
@@ -257,16 +370,16 @@ var HTMLGenerator = class {
   }
 };
 
-// src/helpers/resultProcessor .ts
+// src/helpers/resultProcessor.ts
 var import_ansi_to_html = __toESM(require("ansi-to-html"));
-var import_path4 = __toESM(require("path"));
+var import_path5 = __toESM(require("path"));
 
 // src/utils/attachFiles.ts
-var import_path2 = __toESM(require("path"));
-var import_fs3 = __toESM(require("fs"));
+var import_path3 = __toESM(require("path"));
+var import_fs4 = __toESM(require("fs"));
 
 // src/helpers/markdownConverter.ts
-var import_fs2 = __toESM(require("fs"));
+var import_fs3 = __toESM(require("fs"));
 
 // node_modules/marked/lib/marked.esm.js
 function M() {
@@ -1392,27 +1505,27 @@ var Qt = b.lex;
 
 // src/helpers/markdownConverter.ts
 function convertMarkdownToHtml(markdownPath, htmlOutputPath) {
-  const hasMarkdown = import_fs2.default.existsSync(markdownPath);
-  const markdownContent = hasMarkdown ? import_fs2.default.readFileSync(markdownPath, "utf-8") : "";
+  const hasMarkdown = import_fs3.default.existsSync(markdownPath);
+  const markdownContent = hasMarkdown ? import_fs3.default.readFileSync(markdownPath, "utf-8") : "";
   const markdownHtml = hasMarkdown ? k(markdownContent) : "";
   const drawerHtml = `${markdownHtml || ""}`;
-  import_fs2.default.writeFileSync(htmlOutputPath, drawerHtml.trim(), "utf-8");
+  import_fs3.default.writeFileSync(htmlOutputPath, drawerHtml.trim(), "utf-8");
   if (hasMarkdown) {
-    import_fs2.default.unlinkSync(markdownPath);
+    import_fs3.default.unlinkSync(markdownPath);
   }
 }
 
 // src/utils/attachFiles.ts
 function attachFiles(subFolder, result, testResult, config, steps, errors) {
   const folderPath = config.folderPath || "ortoni-report";
-  const attachmentsFolder = import_path2.default.join(
+  const attachmentsFolder = import_path3.default.join(
     folderPath,
     "ortoni-data",
     "attachments",
     subFolder
   );
-  if (!import_fs3.default.existsSync(attachmentsFolder)) {
-    import_fs3.default.mkdirSync(attachmentsFolder, { recursive: true });
+  if (!import_fs4.default.existsSync(attachmentsFolder)) {
+    import_fs4.default.mkdirSync(attachmentsFolder, { recursive: true });
   }
   if (!result.attachments) return;
   const { base64Image } = config;
@@ -1421,14 +1534,14 @@ function attachFiles(subFolder, result, testResult, config, steps, errors) {
   result.attachments.forEach((attachment) => {
     const { contentType, name, path: attachmentPath, body } = attachment;
     if (!attachmentPath && !body) return;
-    const fileName = attachmentPath ? import_path2.default.basename(attachmentPath) : `${name}.${getFileExtension(contentType)}`;
-    const relativePath = import_path2.default.join(
+    const fileName = attachmentPath ? import_path3.default.basename(attachmentPath) : `${name}.${getFileExtension(contentType)}`;
+    const relativePath = import_path3.default.join(
       "ortoni-data",
       "attachments",
       subFolder,
       fileName
     );
-    const fullPath = import_path2.default.join(attachmentsFolder, fileName);
+    const fullPath = import_path3.default.join(attachmentsFolder, fileName);
     if (contentType === "image/png") {
       handleImage(
         attachmentPath,
@@ -1471,13 +1584,13 @@ function handleImage(attachmentPath, body, base64Image, fullPath, relativePath,
   let screenshotPath = "";
   if (attachmentPath) {
     try {
-      const screenshotContent = import_fs3.default.readFileSync(
+      const screenshotContent = import_fs4.default.readFileSync(
         attachmentPath,
         base64Image ? "base64" : void 0
       );
       screenshotPath = base64Image ? `data:image/png;base64,${screenshotContent}` : relativePath;
       if (!base64Image) {
-        import_fs3.default.copyFileSync(attachmentPath, fullPath);
+        import_fs4.default.copyFileSync(attachmentPath, fullPath);
       }
     } catch (error) {
       console.error(
@@ -1494,7 +1607,7 @@ function handleImage(attachmentPath, body, base64Image, fullPath, relativePath,
 }
 function handleAttachment(attachmentPath, fullPath, relativePath, resultKey, testResult, steps, errors) {
   if (attachmentPath) {
-    import_fs3.default.copyFileSync(attachmentPath, fullPath);
+    import_fs4.default.copyFileSync(attachmentPath, fullPath);
     if (resultKey === "videoPath") {
       testResult[resultKey]?.push(relativePath);
     } else if (resultKey === "tracePath") {
@@ -1520,13 +1633,13 @@ function getFileExtension(contentType) {
 }
 
 // src/utils/utils.ts
-var import_path3 = __toESM(require("path"));
+var import_path4 = __toESM(require("path"));
 function normalizeFilePath(filePath) {
-  const normalizedPath = import_path3.default.normalize(filePath);
-  return import_path3.default.basename(normalizedPath);
+  const normalizedPath = import_path4.default.normalize(filePath);
+  return import_path4.default.basename(normalizedPath);
 }
 function ensureHtmlExtension(filename) {
-  const ext = import_path3.default.extname(filename);
+  const ext = import_path4.default.extname(filename);
   if (ext && ext.toLowerCase() === ".html") {
     return filename;
   }
@@ -1574,7 +1687,7 @@ function extractSuites(titlePath) {
   };
 }
 
-// src/helpers/resultProcessor .ts
+// src/helpers/resultProcessor.ts
 var TestResultProcessor = class {
   constructor(projectRoot) {
     this.ansiToHtml = new import_ansi_to_html.default({ fg: "var(--snippet-color)" });
@@ -1630,7 +1743,7 @@ var TestResultProcessor = class {
   }
   processSteps(steps) {
     return steps.map((step) => {
-      const stepLocation = step.location ? `${import_path4.default.relative(this.projectRoot, step.location.file)}:${step.location.line}:${step.location.column}` : "";
+      const stepLocation = step.location ? `${import_path5.default.relative(this.projectRoot, step.location.file)}:${step.location.line}:${step.location.column}` : "";
       return {
         snippet: this.ansiToHtml.toHtml(escapeHtml(step.error?.snippet || "")),
         title: step.title,
@@ -1642,14 +1755,14 @@ var TestResultProcessor = class {
 
 // src/utils/expressServer.ts
 var import_express = __toESM(require("express"));
-var import_path5 = __toESM(require("path"));
+var import_path6 = __toESM(require("path"));
 var import_child_process = require("child_process");
 function startReportServer(reportFolder, reportFilename, port = 2004, open2) {
   const app = (0, import_express.default)();
-  app.use(import_express.default.static(reportFolder));
+  app.use(import_express.default.static(reportFolder, { index: false }));
   app.get("/", (_req, res) => {
     try {
-      res.sendFile(import_path5.default.resolve(reportFolder, reportFilename));
+      res.sendFile(import_path6.default.resolve(reportFolder, reportFilename));
     } catch (error) {
       console.error("Ortoni Report: Error sending report file:", error);
       res.status(500).send("Error loading report");
@@ -1995,7 +2108,7 @@ var DatabaseManager = class {
 };
 
 // src/ortoni-report.ts
-var import_path6 = __toESM(require("path"));
+var import_path7 = __toESM(require("path"));
 var OrtoniReport = class {
   constructor(ortoniConfig = {}) {
     this.ortoniConfig = ortoniConfig;
@@ -2026,7 +2139,7 @@ var OrtoniReport = class {
     this.testResultProcessor = new TestResultProcessor(config.rootDir);
     this.fileManager.ensureReportDirectory();
     await this.dbManager.initialize(
-      import_path6.default.join(this.folderPath, "ortoni-data-history.sqlite")
+      import_path7.default.join(this.folderPath, "ortoni-data-history.sqlite")
     );
     this.shardConfig = config?.shard;
   }
@@ -2068,8 +2181,8 @@ var OrtoniReport = class {
           const shard = this.shardConfig;
           const shardFile = `ortoni-shard-${shard.current}-of-${shard.total}.json`;
           const shardData = {
-            status: result.status,
-            duration: totalDuration,
+            // status: result.status,
+            totalDuration,
             results: this.results,
             projectSet: Array.from(this.projectSet),
             userConfig: {
@@ -2082,7 +2195,11 @@ var OrtoniReport = class {
               meta: this.ortoniConfig.meta
             }
           };
-          this.fileManager.writeRawFile(shardFile, shardData);
+          const shardFilePath = this.fileManager.writeRawFile(
+            shardFile,
+            shardData
+          );
+          console.info(`Ortoni Report: Shard data written to ${shardFilePath}`);
           this.shouldGenerateReport = false;
           return;
         }
@@ -2095,7 +2212,7 @@ var OrtoniReport = class {
             this.results,
             this.projectSet
           );
-          this.outputPath = this.fileManager.writeReportFile(
+          this.outputPath = await this.fileManager.writeReportFile(
             this.outputFilename,
             finalReportData
           );

package/dist/ortoni-report.mjs

@@ -8,9 +8,9 @@ import {
   extractSuites,
   normalizeFilePath,
   startReportServer
-} from "./chunk-MPZLDOCN.mjs";
+} from "./chunk-4RZ5C7KY.mjs";
 
-// src/helpers/resultProcessor .ts
+// src/helpers/resultProcessor.ts
 import AnsiToHtml from "ansi-to-html";
 import path2 from "path";
 
@@ -1272,7 +1272,7 @@ function getFileExtension(contentType) {
   return extensions[contentType] || "unknown";
 }
 
-// src/helpers/resultProcessor .ts
+// src/helpers/resultProcessor.ts
 var TestResultProcessor = class {
   constructor(projectRoot) {
     this.ansiToHtml = new AnsiToHtml({ fg: "var(--snippet-color)" });
@@ -1431,8 +1431,8 @@ var OrtoniReport = class {
           const shard = this.shardConfig;
           const shardFile = `ortoni-shard-${shard.current}-of-${shard.total}.json`;
           const shardData = {
-            status: result.status,
-            duration: totalDuration,
+            // status: result.status,
+            totalDuration,
             results: this.results,
             projectSet: Array.from(this.projectSet),
             userConfig: {
@@ -1445,7 +1445,11 @@ var OrtoniReport = class {
               meta: this.ortoniConfig.meta
             }
           };
-          this.fileManager.writeRawFile(shardFile, shardData);
+          const shardFilePath = this.fileManager.writeRawFile(
+            shardFile,
+            shardData
+          );
+          console.info(`Ortoni Report: Shard data written to ${shardFilePath}`);
           this.shouldGenerateReport = false;
           return;
         }
@@ -1458,7 +1462,7 @@ var OrtoniReport = class {
             this.results,
             this.projectSet
           );
-          this.outputPath = this.fileManager.writeReportFile(
+          this.outputPath = await this.fileManager.writeReportFile(
             this.outputFilename,
             finalReportData
           );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ortoni-report",
-  "version": "4.0.1-beta.0",
+  "version": "4.0.1",
   "description": "Playwright Report By LetCode with Koushik",
   "scripts": {
     "tsc": "tsc",
@@ -8,10 +8,11 @@
     "release": "npm publish"
   },
   "bin": {
-    "ortoni-report": "./dist/cli/cli.js"
+    "ortoni-report": "./dist/cli.js"
   },
   "files": [
-    "dist",
+    "dist/",
+    "dist/index.html",
     "README.md",
     "CHANGELOG.md"
   ],
@@ -52,5 +53,11 @@
   },
   "main": "dist/ortoni-report.js",
   "module": "dist/ortoni-report.mjs",
-  "types": "dist/ortoni-report.d.ts"
+  "types": "dist/ortoni-report.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/ortoni-report.js",
+      "import": "./dist/ortoni-report.mjs"
+    }
+  }
 }