qagentic-reporter 0.1.43 → 1.0.0

package/README.md

@@ -5,8 +5,8 @@
 </p>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/@qagentic/reporter">
-    <img src="https://img.shields.io/npm/v/@qagentic/reporter.svg" alt="npm version">
+  <a href="https://www.npmjs.com/package/qagentic-reporter">
+    <img src="https://img.shields.io/npm/v/qagentic-reporter.svg" alt="npm version">
   </a>
   <a href="https://github.com/qagentic/qagentic-sdk/blob/main/LICENSE">
     <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
@@ -18,29 +18,26 @@
 ## 🚀 Installation
 
 ```bash
-npm install @qagentic/reporter
+npm install qagentic-reporter
 # or
-yarn add @qagentic/reporter
+yarn add qagentic-reporter
 # or
-pnpm add @qagentic/reporter
+pnpm add qagentic-reporter
 ```
 
 ## ⚡ Quick Start
 
 ### Cypress
 
-```javascript
-// cypress.config.js
-const { defineConfig } = require('cypress');
-const { qagentic } = require('@qagentic/reporter/cypress');
+```typescript
+// cypress.config.ts
+import { defineConfig } from 'cypress';
+import { setupQAgentic } from 'qagentic-reporter/cypress/simple-setup';
 
-module.exports = defineConfig({
+export default defineConfig({
   e2e: {
     setupNodeEvents(on, config) {
-      qagentic(on, config, {
-        projectName: 'my-project',
-        apiUrl: 'http://localhost:8080',
-      });
+      setupQAgentic(on, config);  // That's it!
       return config;
     },
   },
@@ -52,14 +49,14 @@ module.exports = defineConfig({
 ```typescript
 // playwright.config.ts
 import { defineConfig } from '@playwright/test';
-import { qagenticReporter } from '@qagentic/reporter/playwright';
+import { qagenticReporter } from 'qagentic-reporter/playwright';
 
 export default defineConfig({
   reporter: [
     ['html'],
     qagenticReporter({
       projectName: 'my-project',
-      apiUrl: 'http://localhost:8080',
+      apiUrl: 'http://localhost:8000',
     }),
   ],
 });
@@ -72,9 +69,9 @@ export default defineConfig({
 module.exports = {
   reporters: [
     'default',
-    ['@qagentic/reporter/jest', {
+    ['qagentic-reporter/jest', {
       projectName: 'my-project',
-      apiUrl: 'http://localhost:8080',
+      apiUrl: 'http://localhost:8000',
     }],
   ],
 };
@@ -86,7 +83,7 @@ module.exports = {
 
 ```javascript
 // cypress/e2e/login.cy.js
-import { step, feature, story, severity } from '@qagentic/reporter/cypress';
+import { step, feature, story, severity } from 'qagentic-reporter/cypress';
 
 describe('User Authentication', () => {
   it('should login successfully', () => {
@@ -112,7 +109,7 @@ describe('User Authentication', () => {
 ```typescript
 // tests/login.spec.ts
 import { test, expect } from '@playwright/test';
-import { step } from '@qagentic/reporter/playwright';
+import { step } from 'qagentic-reporter/playwright';
 
 test('should login successfully', async ({ page }) => {
   await step('Navigate to login page', async () => {
@@ -134,7 +131,7 @@ test('should login successfully', async ({ page }) => {
 ### Attachments
 
 ```javascript
-import { attach, attachScreenshot, attachJson } from '@qagentic/reporter';
+import { attach, attachScreenshot, attachJson } from 'qagentic-reporter';
 
 // Attach screenshot
 attachScreenshot('path/to/screenshot.png', 'Login Page');
@@ -152,7 +149,7 @@ attachText('Log output here...', 'Console Logs');
 
 ```bash
 QAGENTIC_PROJECT_NAME=my-project
-QAGENTIC_API_URL=http://localhost:8080
+QAGENTIC_API_URL=http://localhost:8000
 QAGENTIC_API_KEY=your-api-key
 QAGENTIC_OUTPUT_DIR=./qagentic-results
 QAGENTIC_AI_ANALYSIS=true
@@ -169,7 +166,7 @@ project:
 reporting:
   api:
     enabled: true
-    url: http://localhost:8080
+    url: http://localhost:8000
     key: ${QAGENTIC_API_KEY}
   local:
     enabled: true
@@ -184,6 +181,36 @@ features:
   screenshots: on_failure
 ```
 
+## 🔌 API Schema
+
+The SDK automatically sends a single `POST /ingest/` request at the end of each test run. No manual calls needed. For debugging or custom integrations:
+
+```
+POST /ingest/
+Content-Type: application/json
+X-API-Key: <your-api-key>
+
+{
+  "run_name": "cypress_20260325T120000",
+  "framework": "cypress",               // cypress | playwright | jest
+  "branch": "main",                     // from CI env or GITHUB_REF_NAME
+  "commit_hash": "abc123",              // from CI env or GITHUB_SHA
+  "environment": "staging",
+  "test_cases": [
+    {
+      "name": "Auth > should login",
+      "status": "passed",               // passed | failed | skipped
+      "duration_ms": 1234,
+      "error_message": null,
+      "error_type": null,
+      "error_stacktrace": null
+    }
+  ]
+}
+```
+
+Response: `202 Accepted` with `{ "run_id": "uuid" }`
+
 ## 🔌 CI/CD Integration
 
 ### GitHub Actions
@@ -252,6 +279,40 @@ When connected to QAagentic server:
 | `severity(level)` | Set severity level |
 | `tag(...tags)` | Add tags |
 
+## 🔄 Migration Guide
+
+### Upgrading from v0.1.42 and earlier
+
+**What changed in v0.1.43:**
+- `APIReporter` (the old 3-call protocol) has been removed
+- All test results are now sent via a single `POST /ingest/` call at the end of the run
+- Jest reporter now correctly sends results to the backend (was broken in previous versions)
+
+**What you need to do:**
+
+For most users — nothing. If you used the standard setup (`setupQAgentic`, `QAgenticPlaywrightReporter`, or `QAgenticJestReporter`), the transition is automatic:
+
+```bash
+npm install qagentic-reporter@0.1.43
+```
+
+**If you explicitly used `APIReporter`** (advanced usage), remove those calls:
+
+```typescript
+// BEFORE — remove these
+import { APIReporter } from 'qagentic-reporter';
+const reporter = new APIReporter();
+await reporter.startRun(run);
+// ...
+await reporter.endRun(run);
+
+// AFTER — use sendIngestPayload directly if needed
+import { sendIngestPayload } from 'qagentic-reporter/core/ingest-client';
+await sendIngestPayload(run, 'cypress');
+```
+
+**Why the old approach failed:** The `/api/v1/runs/*` endpoints never existed in `qagentic-core` — they were part of an old API Gateway that was removed in the platform consolidation (Epic 1). The `/ingest/` endpoint is the only supported ingestion path.
+
 ## 🤝 Contributing
 
 See [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines.

package/dist/cypress/index.js

@@ -42,7 +42,7 @@ var defaultConfig = {
   environment: "local",
   api: {
     enabled: true,
-    url: "http://localhost:8080",
+    url: "http://localhost:8000",
     timeout: 3e4,
     retryCount: 3,
     batchSize: 100
@@ -77,6 +77,9 @@ function loadFromEnv(config) {
   if (env.QAGENTIC_API_ENABLED !== void 0) {
     config.api.enabled = env.QAGENTIC_API_ENABLED.toLowerCase() === "true";
   }
+  if (env.QAGENTIC_URL) {
+    config.api.url = env.QAGENTIC_URL;
+  }
   if (env.QAGENTIC_API_URL) {
     config.api.url = env.QAGENTIC_API_URL;
   }
@@ -284,31 +287,39 @@ var JSONReporter = class {
     this.outputDir = this.config.local.outputDir;
   }
   startRun(run) {
-    if (!fs2__namespace.existsSync(this.outputDir)) {
-      fs2__namespace.mkdirSync(this.outputDir, { recursive: true });
-    }
-    if (this.config.local.cleanOnStart) {
-      const files = fs2__namespace.readdirSync(this.outputDir);
-      for (const file of files) {
-        if (file.endsWith(".json")) {
-          fs2__namespace.unlinkSync(path2__namespace.join(this.outputDir, file));
+    try {
+      if (!fs2__namespace.existsSync(this.outputDir)) {
+        fs2__namespace.mkdirSync(this.outputDir, { recursive: true });
+      }
+      if (this.config.local.cleanOnStart) {
+        const files = fs2__namespace.readdirSync(this.outputDir);
+        for (const file of files) {
+          if (file.endsWith(".json")) {
+            fs2__namespace.unlinkSync(path2__namespace.join(this.outputDir, file));
+          }
         }
       }
+    } catch (err) {
+      console.warn("[QAagentic] Warning: could not prepare output directory:", err.message);
     }
   }
   endRun(run) {
     if (!this.config.local.enabled || !this.config.local.formats.includes("json")) {
       return;
     }
-    const runFile = path2__namespace.join(this.outputDir, "run.json");
-    fs2__namespace.writeFileSync(runFile, JSON.stringify(this.serializeRun(run), null, 2));
-    const testsDir = path2__namespace.join(this.outputDir, "tests");
-    if (!fs2__namespace.existsSync(testsDir)) {
-      fs2__namespace.mkdirSync(testsDir, { recursive: true });
-    }
-    for (const test of run.tests) {
-      const testFile = path2__namespace.join(testsDir, `${test.id}.json`);
-      fs2__namespace.writeFileSync(testFile, JSON.stringify(this.serializeTest(test), null, 2));
+    try {
+      const runFile = path2__namespace.join(this.outputDir, "run.json");
+      fs2__namespace.writeFileSync(runFile, JSON.stringify(this.serializeRun(run), null, 2));
+      const testsDir = path2__namespace.join(this.outputDir, "tests");
+      if (!fs2__namespace.existsSync(testsDir)) {
+        fs2__namespace.mkdirSync(testsDir, { recursive: true });
+      }
+      for (const test of run.tests) {
+        const testFile = path2__namespace.join(testsDir, `${test.id}.json`);
+        fs2__namespace.writeFileSync(testFile, JSON.stringify(this.serializeTest(test), null, 2));
+      }
+    } catch (err) {
+      console.warn("[QAagentic] Warning: could not write JSON results:", err.message);
     }
   }
   reportTest(_test) {
@@ -344,17 +355,25 @@ var JUnitReporter = class {
     this.outputDir = this.config.local.outputDir;
   }
   startRun(_run) {
-    if (!fs2__namespace.existsSync(this.outputDir)) {
-      fs2__namespace.mkdirSync(this.outputDir, { recursive: true });
+    try {
+      if (!fs2__namespace.existsSync(this.outputDir)) {
+        fs2__namespace.mkdirSync(this.outputDir, { recursive: true });
+      }
+    } catch (err) {
+      console.warn("[QAagentic] Warning: could not create JUnit output directory:", err.message);
     }
   }
   endRun(run) {
     if (!this.config.local.enabled || !this.config.local.formats.includes("junit")) {
       return;
     }
-    const xml = this.generateXml(run);
-    const junitFile = path2__namespace.join(this.outputDir, "junit.xml");
-    fs2__namespace.writeFileSync(junitFile, xml);
+    try {
+      const xml = this.generateXml(run);
+      const junitFile = path2__namespace.join(this.outputDir, "junit.xml");
+      fs2__namespace.writeFileSync(junitFile, xml);
+    } catch (err) {
+      console.warn("[QAagentic] Warning: could not write junit.xml:", err.message);
+    }
   }
   reportTest(_test) {
   }
@@ -406,155 +425,6 @@ var JUnitReporter = class {
     return xml;
   }
 };
-var APIReporter = class {
-  constructor(config) {
-    this.batch = [];
-    this.config = config || getConfig();
-  }
-  async startRun(run) {
-    if (!this.config.api.enabled) {
-      console.log("[APIReporter] API reporting disabled");
-      return;
-    }
-    this.currentRun = run;
-    this.batch = [];
-    try {
-      console.log("[APIReporter] Starting test run:", run.id);
-      const url = `${this.config.api.url}/api/v1/runs`;
-      console.log("[APIReporter] POST to:", url);
-      const response = await axios__default.default.post(
-        url,
-        {
-          id: run.id,
-          name: run.name,
-          project_name: run.projectName,
-          environment: run.environment,
-          start_time: run.startTime?.toISOString(),
-          labels: run.labels,
-          ci_build_id: run.ciBuildId,
-          branch: run.branch,
-          commit_hash: run.commitHash
-        },
-        {
-          headers: {
-            "Content-Type": "application/json",
-            "X-API-Key": this.config.api.key || "",
-            "X-Project": this.config.projectName
-          },
-          timeout: this.config.api.timeout
-        }
-      );
-      console.log("[APIReporter] Test run started successfully:", response.status);
-    } catch (error) {
-      console.warn("[APIReporter] Failed to register run with API:");
-      console.warn("  Error:", error.message);
-      console.warn("  Status:", error.response?.status);
-      console.warn("  Data:", error.response?.data);
-    }
-  }
-  async endRun(run) {
-    if (!this.config.api.enabled) return;
-    try {
-      console.log("[APIReporter] endRun called, batch size:", this.batch.length);
-      if (this.batch.length > 0) {
-        console.log("[APIReporter] Flushing remaining", this.batch.length, "test results");
-        await this.flushBatch();
-        console.log("[APIReporter] Batch flushed, waiting for processing...");
-        await new Promise((resolve) => setTimeout(resolve, 1500));
-      }
-      console.log("[APIReporter] Finalizing run with test counts:", {
-        total: run.total,
-        passed: run.passed,
-        failed: run.failed,
-        broken: run.broken,
-        skipped: run.skipped
-      });
-      const patchData = {
-        end_time: run.endTime?.toISOString(),
-        duration_ms: run.durationMs,
-        total: run.total,
-        passed: run.passed,
-        failed: run.failed,
-        broken: run.broken,
-        skipped: run.skipped,
-        status: "completed"
-      };
-      console.log("[APIReporter] PATCH to:", `${this.config.api.url}/api/v1/runs/${run.id}`);
-      console.log("[APIReporter] PATCH data:", patchData);
-      const response = await axios__default.default.patch(
-        `${this.config.api.url}/api/v1/runs/${run.id}`,
-        patchData,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            "X-API-Key": this.config.api.key || "",
-            "X-Project": this.config.projectName
-          },
-          timeout: this.config.api.timeout
-        }
-      );
-      console.log("[APIReporter] Run finalized successfully:", response.status);
-    } catch (error) {
-      console.warn("[APIReporter] Failed to finalize run with API:");
-      console.warn("  Error:", error.message);
-      console.warn("  Status:", error.response?.status);
-      console.warn("  Data:", error.response?.data);
-    }
-  }
-  async reportTest(test) {
-    console.log("[APIReporter] reportTest called for:", test.name, "API enabled:", this.config.api.enabled);
-    if (!this.config.api.enabled) {
-      console.log("[APIReporter] API reporting disabled, skipping test report");
-      return;
-    }
-    console.log("[APIReporter] Adding test to batch:", test.name, "- batch size:", this.batch.length + 1);
-    this.batch.push(test);
-    if (this.batch.length >= this.config.api.batchSize) {
-      console.log("[APIReporter] Batch size reached, flushing batch");
-      await this.flushBatch();
-    } else {
-      console.log("[APIReporter] Batch size:", this.batch.length, "/", this.config.api.batchSize);
-    }
-  }
-  async flushBatch() {
-    if (this.batch.length === 0 || !this.currentRun) return;
-    try {
-      console.log("[APIReporter] Flushing batch of", this.batch.length, "test results");
-      const response = await axios__default.default.post(
-        `${this.config.api.url}/api/v1/runs/${this.currentRun.id}/results`,
-        this.batch.map((t) => ({
-          id: t.id,
-          name: t.name,
-          full_name: t.fullName,
-          status: t.status,
-          duration_ms: t.durationMs,
-          start_time: t.startTime?.toISOString(),
-          end_time: t.endTime?.toISOString(),
-          file_path: t.filePath,
-          error_message: t.errorMessage,
-          stack_trace: t.stackTrace,
-          error_type: t.errorType,
-          attachments: t.attachments
-        })),
-        {
-          headers: {
-            "Content-Type": "application/json",
-            "X-API-Key": this.config.api.key || ""
-          },
-          timeout: this.config.api.timeout
-        }
-      );
-      console.log("[APIReporter] Batch flushed successfully:", response.status);
-    } catch (error) {
-      console.warn("[APIReporter] Failed to send test results to API:");
-      console.warn("  Error:", error.message);
-      console.warn("  Status:", error.response?.status);
-      console.warn("  Data:", error.response?.data);
-    } finally {
-      this.batch = [];
-    }
-  }
-};
 var _QAgenticReporter = class _QAgenticReporter {
   constructor(config) {
     this.reporters = [];
@@ -578,10 +448,6 @@ var _QAgenticReporter = class _QAgenticReporter {
         console.log("[QAgenticReporter] Added JUnitReporter");
       }
     }
-    if (this.config.api.enabled) {
-      this.reporters.push(new APIReporter(this.config));
-      console.log("[QAgenticReporter] Added APIReporter");
-    }
     console.log("[QAgenticReporter] Initialization complete with", this.reporters.length, "reporters");
   }
   /**
@@ -912,8 +778,12 @@ function attach(data, name, type = "text/plain", extension) {
 }
 function attachScreenshot(data, name = "Screenshot") {
   if (typeof data === "string" && fs2__namespace.existsSync(data)) {
-    const content = fs2__namespace.readFileSync(data);
-    return attach(content, name, "image/png", "png");
+    try {
+      const content = fs2__namespace.readFileSync(data);
+      return attach(content, name, "image/png", "png");
+    } catch (err) {
+      console.warn("[QAagentic] Warning: could not read screenshot file:", err.message);
+    }
   }
   return attach(data, name, "image/png", "png");
 }
@@ -924,6 +794,95 @@ function attachJson(data, name = "JSON Data") {
 function attachText(text, name = "Text") {
   return attach(text, name, "text/plain", "txt");
 }
+function mapStatus(status) {
+  switch (status) {
+    case "passed" /* PASSED */:
+      return "passed";
+    case "failed" /* FAILED */:
+    case "broken" /* BROKEN */:
+      return "failed";
+    case "skipped" /* SKIPPED */:
+    case "pending" /* PENDING */:
+    case "unknown" /* UNKNOWN */:
+    default:
+      return "skipped";
+  }
+}
+function mapTestCase(test) {
+  return {
+    name: test.fullName || test.name,
+    status: mapStatus(test.status),
+    duration_ms: test.durationMs > 0 ? Math.round(test.durationMs) : void 0,
+    error_message: test.errorMessage || void 0,
+    error_type: test.errorType || void 0,
+    error_stacktrace: test.stackTrace || void 0
+  };
+}
+function getCIEnv() {
+  return {
+    branch: process.env.GITHUB_REF_NAME || process.env.CI_COMMIT_REF_NAME || process.env.BRANCH_NAME || void 0,
+    commit_hash: process.env.GITHUB_SHA || process.env.CI_COMMIT_SHA || void 0,
+    repository: process.env.GITHUB_REPOSITORY || process.env.CI_PROJECT_PATH || void 0
+  };
+}
+async function sendIngestPayload(run, framework) {
+  const config = getConfig();
+  if (!config.api.enabled) {
+    console.log("[QAagentic] API reporting disabled \u2014 skipping ingest");
+    return;
+  }
+  const apiKey = config.api.key;
+  if (!apiKey) {
+    console.warn(
+      "[QAagentic] No API key configured. Set QAGENTIC_API_KEY environment variable. Skipping ingest."
+    );
+    return;
+  }
+  const ci = getCIEnv();
+  const payload = {
+    run_name: run.name || `${framework}_${(/* @__PURE__ */ new Date()).toISOString()}`,
+    framework,
+    branch: run.branch || ci.branch,
+    commit_hash: run.commitHash || ci.commit_hash,
+    repository: ci.repository,
+    environment: run.environment || config.environment,
+    test_cases: run.tests.map(mapTestCase),
+    metadata: {
+      project_name: run.projectName,
+      ...run.ciBuildId ? { ci_build_id: run.ciBuildId } : {},
+      ...run.ciBuildUrl ? { ci_build_url: run.ciBuildUrl } : {}
+    }
+  };
+  const url = `${config.api.url.replace(/\/$/, "")}/ingest/`;
+  try {
+    const response = await axios__default.default.post(url, payload, {
+      headers: {
+        "Content-Type": "application/json",
+        "X-API-Key": apiKey
+      },
+      timeout: config.api.timeout
+    });
+    console.log(
+      `[QAagentic] \u2713 ${run.tests.length} results ingested. run_id=${response.data?.run_id}`
+    );
+  } catch (error) {
+    if (axios__default.default.isAxiosError(error)) {
+      if (!error.response) {
+        console.warn(
+          `[QAagentic] Could not reach QAagentic at ${url}. Results not sent. Check QAGENTIC_URL and ensure qagentic-core is running.`
+        );
+      } else {
+        console.warn(
+          `[QAagentic] Ingest failed (HTTP ${error.response.status}): ${error.response.data?.error || error.message}`
+        );
+      }
+    } else {
+      console.warn("[QAagentic] Unexpected error during ingest:", error.message);
+    }
+  }
+}
+
+// src/cypress/simple-setup.ts
 var QAgenticCypressReporter = class {
   constructor(config) {
     this.currentRun = null;
@@ -942,11 +901,12 @@ var QAgenticCypressReporter = class {
     this.pendingTests = [];
     this.projectName = process.env.QAGENTIC_PROJECT_NAME || config.projectId || "Cypress E2E Tests";
     this.environment = process.env.QAGENTIC_ENVIRONMENT || process.env.NODE_ENV || "e2e";
-    const apiUrl = process.env.QAGENTIC_API_URL || "https://qagentic-api-gateway.onrender.com";
+    const apiUrl = process.env.QAGENTIC_API_URL || "http://localhost:8000";
     configure({
       projectName: this.projectName,
       environment: this.environment,
       apiUrl,
+      apiKey: process.env.QAGENTIC_API_KEY,
       outputDir: "./qagentic-results"
     });
     this.reporter = QAgenticReporter.getInstance();
@@ -1114,13 +1074,7 @@ var QAgenticCypressReporter = class {
       this.currentRun.passed = this.stats.passes;
       this.currentRun.failed = this.stats.failures;
       this.currentRun.skipped = this.stats.pending;
-      console.log("[QAagentic] Calling reporter.endRun with stats:", {
-        total: this.currentRun.total,
-        passed: this.currentRun.passed,
-        failed: this.currentRun.failed,
-        skipped: this.currentRun.skipped
-      });
-      await this.reporter.endRun();
+      await sendIngestPayload(this.currentRun, "cypress");
       console.log("[QAagentic] Run finalized successfully");
     } catch (error) {
       console.warn("[QAagentic] Failed to finalize run:", error);