@wdio/sumologic-reporter 9.32.0-alpha.6 → 10.0.0-alpha.148

package/AGENTS.md

@@ -0,0 +1,15 @@
+# @wdio/sumologic-reporter
+
+Sends runner events to a Sumo Logic HTTP collector. Extends `@wdio/reporter`.
+
+```sh
+pnpm run test:package wdio-sumologic-reporter
+```
+
+## Test ownership
+
+Unit coverage lives in `tests/reporter.test.ts`.
+
+- The constructor owns a missing or blank `sourceAddress`. `sync()` does not re-check it. The collector URL is fixed once the reporter is enabled. Do not assign `reporter['_options']` to reach a branch production never takes.
+- The runner polls `isSynchronised` and does not call `sync()`. The interval must keep running after `runner:end` until the queue drains. `should stop the timer if runner ended` owns that ordering. A flush test that calls `sync()` itself still passes if the interval is cleared too early.
+- `should start sync when reporter gets initiated` must invoke the scheduled callback. Asserting `setInterval` alone does not prove the reporter syncs.

package/README.md

@@ -38,6 +38,9 @@ module.exports = {
     ['sumologic', {
         // define sync interval how often logs get pushed to Sumologic
         syncInterval: 100,
+        maxRetries: 5,
+        requestTimeout: 30000,
+        shutdownTimeout: 4000,
         // endpoint of collector source
         sourceAddress: process.env.SUMO_SOURCE_ADDRESS
     }]
@@ -46,6 +49,14 @@ module.exports = {
 };
 ```
 
+### Delivery behaviour
+
+Each collector request is limited to a positive `requestTimeout` in milliseconds (default: `30000`); non-positive or invalid values use the default. Transient failures — network errors, `408`, `429`, and `5xx` responses — are retried with backoff. `maxRetries` counts retries after the initial delivery attempt and defaults to `5`. A successful batch resets the retry counter.
+
+Other unsuccessful HTTP responses disable the reporter immediately. When its retry limit is reached, the reporter stops its timer and discards its remaining queued logs. Delivery is best effort: logs may be lost, and retries can produce duplicates if the collector accepts a request before it times out.
+
+After `runner:end`, `shutdownTimeout` limits the total time for remaining delivery attempts (default: `4000` milliseconds). Successful batches do not reset this deadline. When it expires, the reporter aborts the active request, stops its timers, discards pending logs, and logs their count. Non-positive or invalid values use the default; positive finite values are rounded up and capped at `2147483647`. Keep `shutdownTimeout` below WebdriverIO's `reporterSyncTimeout` (default: `5000`), with enough margin for `reporterSyncInterval` polling. A longer shutdown budget may require increasing both options. The shutdown deadline may expire before all configured retries are used.
+
 After running the first tests with the reporter you should be able to check out the tests logs with the following query:
 
 ```

package/build/index.d.ts

@@ -6,10 +6,17 @@ import type { Options } from './types.js';
  */
 export default class SumoLogicReporter extends WDIOReporter {
     private _options;
-    private _interval;
+    private _interval?;
+    private _shutdownTimer?;
+    private _requestController?;
+    private _sourceAddress;
     private _unsynced;
     private _isSynchronising;
+    private _isDisabled;
     private _hasRunnerEnd;
+    private _retryAttempts;
+    private _retryDelay;
+    private _nextRetryAt;
     constructor(options: Options);
     get isSynchronised(): boolean;
     onRunnerStart(runner: RunnerStats): void;
@@ -22,6 +29,13 @@ export default class SumoLogicReporter extends WDIOReporter {
     onSuiteEnd(suite: SuiteStats): void;
     onRunnerEnd(runner: RunnerStats): void;
     sync(): Promise<void>;
+    private _isRetryableStatus;
+    private _retry;
+    private _getMaxRetries;
+    private _getRequestTimeout;
+    private _disable;
+    private _getShutdownTimeout;
+    private _stopInterval;
 }
 export * from './types.js';
 declare global {

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACxE,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAGzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AA4BzC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,YAAY;IACvD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAgB;IAEjC,OAAO,CAAC,SAAS,CAAe;IAChC,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,aAAa,CAAQ;gBAEjB,OAAO,EAAE,OAAO;IAmB5B,IAAI,cAAc,YAEjB;IAED,aAAa,CAAC,MAAM,EAAE,WAAW;IAQjC,YAAY,CAAC,KAAK,EAAE,UAAU;IAQ9B,WAAW,CAAC,IAAI,EAAE,SAAS;IAQ3B,UAAU,CAAC,IAAI,EAAE,SAAS;IAQ1B,UAAU,CAAC,IAAI,EAAE,SAAS;IAQ1B,UAAU,CAAC,IAAI,EAAE,SAAS;IAQ1B,SAAS,CAAC,IAAI,EAAE,SAAS;IAQzB,UAAU,CAAC,KAAK,EAAE,UAAU;IAQ5B,WAAW,CAAC,MAAM,EAAE,WAAW;IASzB,IAAI;CA8Cb;AAED,cAAc,YAAY,CAAA;AAE1B,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,cAAe,SAAQ,OAAO;SAAG;KAC9C;CACJ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACxE,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAGzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAiCzC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,YAAY;IACvD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAC,CAAgB;IAClC,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,kBAAkB,CAAC,CAAiB;IAE5C,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,SAAS,CAAe;IAChC,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,WAAW,CAAI;IACvB,OAAO,CAAC,YAAY,CAAI;gBAEZ,OAAO,EAAE,OAAO;IAqB5B,IAAI,cAAc,YAEjB;IAED,aAAa,CAAC,MAAM,EAAE,WAAW;IAYjC,YAAY,CAAC,KAAK,EAAE,UAAU;IAY9B,WAAW,CAAC,IAAI,EAAE,SAAS;IAY3B,UAAU,CAAC,IAAI,EAAE,SAAS;IAY1B,UAAU,CAAC,IAAI,EAAE,SAAS;IAY1B,UAAU,CAAC,IAAI,EAAE,SAAS;IAY1B,SAAS,CAAC,IAAI,EAAE,SAAS;IAYzB,UAAU,CAAC,KAAK,EAAE,UAAU;IAY5B,WAAW,CAAC,MAAM,EAAE,WAAW;IAkBzB,IAAI;IAoFV,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,MAAM;IAkBd,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,aAAa;CAUxB;AAED,cAAc,YAAY,CAAA;AAE1B,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,cAAe,SAAQ,OAAO;SAAG;KAC9C;CACJ"}

package/build/index.js

@@ -4,6 +4,11 @@ import WDIOReporter from "@wdio/reporter";
 import logger from "@wdio/logger";
 var log = logger("@wdio/sumologic-reporter");
 var MAX_LINES = 100;
+var MAX_RETRY_DELAY = 1e3;
+var DEFAULT_MAX_RETRIES = 5;
+var DEFAULT_REQUEST_TIMEOUT = 3e4;
+var DEFAULT_SHUTDOWN_TIMEOUT = 4e3;
+var MAX_REQUEST_TIMEOUT = 2147483647;
 function formatDate(date) {
   const year = date.getFullYear();
   const month = String(date.getMonth() + 1).padStart(2, "0");
@@ -22,9 +27,16 @@ function formatDate(date) {
 var SumoLogicReporter = class extends WDIOReporter {
   _options;
   _interval;
+  _shutdownTimer;
+  _requestController;
+  _sourceAddress = "";
   _unsynced = [];
   _isSynchronising = false;
+  _isDisabled = false;
   _hasRunnerEnd = false;
+  _retryAttempts = 0;
+  _retryDelay = 0;
+  _nextRetryAt = 0;
   constructor(options) {
     super(options);
     this._options = Object.assign({
@@ -35,16 +47,21 @@ var SumoLogicReporter = class extends WDIOReporter {
       // endpoint of collector source
       sourceAddress: process.env.SUMO_SOURCE_ADDRESS
     }, options);
-    if (typeof this._options.sourceAddress !== "string") {
-      log.error('Sumo Logic requires "sourceAddress" paramater');
+    if (typeof this._options.sourceAddress !== "string" || this._options.sourceAddress.trim() === "") {
+      this._disable('Sumo Logic reporter disabled: a non-empty "sourceAddress" is required');
+      return;
     }
+    this._sourceAddress = this._options.sourceAddress;
     this._interval = global.setInterval(this.sync.bind(this), this._options.syncInterval);
   }
   // @ts-ignore
   get isSynchronised() {
-    return this._unsynced.length === 0;
+    return this._isDisabled || this._unsynced.length === 0;
   }
   onRunnerStart(runner) {
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "runner:start",
@@ -52,6 +69,9 @@ var SumoLogicReporter = class extends WDIOReporter {
     }));
   }
   onSuiteStart(suite) {
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "suite:start",
@@ -59,6 +79,9 @@ var SumoLogicReporter = class extends WDIOReporter {
     }));
   }
   onTestStart(test) {
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "test:start",
@@ -66,6 +89,9 @@ var SumoLogicReporter = class extends WDIOReporter {
     }));
   }
   onTestSkip(test) {
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "test:skip",
@@ -73,6 +99,9 @@ var SumoLogicReporter = class extends WDIOReporter {
     }));
   }
   onTestPass(test) {
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "test:pass",
@@ -80,6 +109,9 @@ var SumoLogicReporter = class extends WDIOReporter {
     }));
   }
   onTestFail(test) {
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "test:fail",
@@ -87,6 +119,9 @@ var SumoLogicReporter = class extends WDIOReporter {
     }));
   }
   onTestEnd(test) {
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "test:end",
@@ -94,6 +129,9 @@ var SumoLogicReporter = class extends WDIOReporter {
     }));
   }
   onSuiteEnd(suite) {
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "suite:end",
@@ -102,32 +140,120 @@ var SumoLogicReporter = class extends WDIOReporter {
   }
   onRunnerEnd(runner) {
     this._hasRunnerEnd = true;
+    if (this._isDisabled) {
+      return;
+    }
     this._unsynced.push(stringify({
       time: formatDate(/* @__PURE__ */ new Date()),
       event: "runner:end",
       data: runner
     }));
+    if (!this._shutdownTimer) {
+      this._shutdownTimer = setTimeout(() => {
+        this._disable(`Sumo Logic reporter shutdown timeout reached; discarding ${this._unsynced.length} queued events`);
+      }, this._getShutdownTimeout());
+    }
   }
   async sync() {
+    if (this._isDisabled) {
+      return;
+    }
     if (this._hasRunnerEnd && this._unsynced.length === 0) {
-      clearInterval(this._interval);
+      this._stopInterval();
+      return;
     }
-    if (this._isSynchronising || this._unsynced.length === 0 || typeof this._options.sourceAddress !== "string") {
+    if (this._isSynchronising || this._unsynced.length === 0 || Date.now() < this._nextRetryAt) {
       return;
     }
     const logLines = this._unsynced.slice(0, MAX_LINES).join("\n");
     this._isSynchronising = true;
     log.debug("start synchronization");
+    const controller = new AbortController();
+    this._requestController = controller;
+    const requestTimer = setTimeout(() => controller.abort(), this._getRequestTimeout());
     try {
-      const resp = await fetch(this._options.sourceAddress, {
+      const resp = await fetch(this._sourceAddress, {
         method: "POST",
-        body: JSON.stringify(logLines)
+        body: JSON.stringify(logLines),
+        signal: controller.signal
       });
+      if (this._isDisabled) {
+        return;
+      }
+      if (!resp.ok) {
+        if (!this._isRetryableStatus(resp.status)) {
+          this._disable(`failed to send data to Sumo Logic (HTTP ${resp.status}); disabling reporter`);
+          return;
+        }
+        this._retry(resp.status);
+        return;
+      }
+      this._retryAttempts = 0;
+      this._retryDelay = 0;
+      this._nextRetryAt = 0;
       this._unsynced.splice(0, MAX_LINES);
-      this._isSynchronising = false;
+      if (this._hasRunnerEnd && this._unsynced.length === 0) {
+        this._stopInterval();
+      }
       return log.debug(`synchronised collector data, server status: ${resp.status}`);
-    } catch (err) {
-      return log.error("failed send data to Sumo Logic:\n", err.stack);
+    } catch {
+      if (!this._isDisabled) {
+        this._retry();
+      }
+    } finally {
+      clearTimeout(requestTimer);
+      controller.abort();
+      this._requestController = void 0;
+      this._isSynchronising = false;
+    }
+  }
+  _isRetryableStatus(status) {
+    return status === 408 || status === 429 || status >= 500 && status <= 599;
+  }
+  _retry(status) {
+    const maxRetries = this._getMaxRetries();
+    if (this._retryAttempts >= maxRetries) {
+      const statusMessage2 = status === void 0 ? "" : ` (HTTP ${status})`;
+      this._disable(`failed to send data to Sumo Logic${statusMessage2}; retry limit of ${maxRetries} reached, disabling reporter`);
+      return;
+    }
+    this._retryAttempts++;
+    this._retryDelay = Math.min(
+      Math.max(this._options.syncInterval ?? 100, this._retryDelay * 2),
+      MAX_RETRY_DELAY
+    );
+    this._nextRetryAt = Date.now() + this._retryDelay;
+    const statusMessage = status === void 0 ? "" : ` (HTTP ${status})`;
+    log.error(`failed to send data to Sumo Logic${statusMessage}; retrying (${this._retryAttempts}/${maxRetries})`);
+  }
+  _getMaxRetries() {
+    const { maxRetries } = this._options;
+    return typeof maxRetries === "number" && Number.isFinite(maxRetries) && maxRetries >= 0 ? Math.floor(maxRetries) : DEFAULT_MAX_RETRIES;
+  }
+  _getRequestTimeout() {
+    const { requestTimeout } = this._options;
+    return typeof requestTimeout === "number" && Number.isFinite(requestTimeout) && requestTimeout > 0 ? Math.min(Math.ceil(requestTimeout), MAX_REQUEST_TIMEOUT) : DEFAULT_REQUEST_TIMEOUT;
+  }
+  _disable(message) {
+    this._isDisabled = true;
+    this._unsynced = [];
+    this._nextRetryAt = 0;
+    this._stopInterval();
+    this._requestController?.abort();
+    log.error(message);
+  }
+  _getShutdownTimeout() {
+    const { shutdownTimeout } = this._options;
+    return typeof shutdownTimeout === "number" && Number.isFinite(shutdownTimeout) && shutdownTimeout > 0 ? Math.min(Math.ceil(shutdownTimeout), MAX_REQUEST_TIMEOUT) : DEFAULT_SHUTDOWN_TIMEOUT;
+  }
+  _stopInterval() {
+    if (this._shutdownTimer) {
+      clearTimeout(this._shutdownTimer);
+      this._shutdownTimer = void 0;
+    }
+    if (this._interval) {
+      clearInterval(this._interval);
+      this._interval = void 0;
     }
   }
 };

package/build/types.d.ts

@@ -5,6 +5,25 @@ export interface Options extends Partial<Reporters.Options> {
      * @default 100
      */
     syncInterval?: number;
+    /**
+     * maximum number of retries after the initial delivery attempt
+     * non-negative finite values are rounded down; all other values use the default
+     * @default 5
+     */
+    maxRetries?: number;
+    /**
+     * maximum time in milliseconds to wait for a collector response
+     * positive finite values are rounded up and capped at 2147483647; all other values use the default
+     * @default 30000
+     */
+    requestTimeout?: number;
+    /**
+     * total time in milliseconds to flush queued events after runner:end, including requests and retries
+     * keep below WebdriverIO's reporterSyncTimeout, allowing time for its polling interval
+     * positive finite values are rounded up and capped at 2147483647; all other values use the default
+     * @default 4000
+     */
+    shutdownTimeout?: number;
     /**
      * endpoint of collector source
      * @default

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;IACvD;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;IACvD;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@wdio/sumologic-reporter",
-  "version": "9.32.0-alpha.6+3d8818a67",
+  "version": "10.0.0-alpha.148+3a926c3d0",
   "description": "A WebdriverIO reporter that sends test results to Sumologic for data analyses",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sumologic-reporter",
   "license": "MIT",
   "engines": {
-    "node": ">=18.20.0"
+    "node": ">=22.19.0"
   },
   "repository": {
     "type": "git",
@@ -30,11 +30,11 @@
       "import": "./build/index.js"
     }
   },
-  "typeScriptVersion": "3.8.3",
+  "typeScriptVersion": "6.0.3",
   "dependencies": {
-    "@wdio/logger": "9.32.0-alpha.6+3d8818a67",
-    "@wdio/reporter": "9.32.0-alpha.6+3d8818a67",
-    "@wdio/types": "9.32.0-alpha.6+3d8818a67",
+    "@wdio/logger": "10.0.0-alpha.148+3a926c3d0",
+    "@wdio/reporter": "10.0.0-alpha.148+3a926c3d0",
+    "@wdio/types": "10.0.0-alpha.148+3a926c3d0",
     "json-stringify-safe": "^5.0.1"
   },
   "devDependencies": {
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3d8818a67404f0b5d4b81eda877ffad1f4d317c0"
+  "gitHead": "3a926c3d08dafa93c92021b2892341709d74968a"
 }