@chaos-maker/playwright 0.2.0 → 0.4.0

package/README.md

@@ -90,6 +90,28 @@ test('checkout handles combined chaos', async ({ page }) => {
 });
 ```
 
+### SSE and GraphQL
+
+```ts
+await injectChaos(page, {
+  seed: 42,
+  sse: {
+    drops: [{ urlPattern: '/events', eventType: 'token', probability: 0.1 }],
+  },
+  network: {
+    failures: [{
+      urlPattern: '/graphql',
+      graphqlOperation: 'GetUser',
+      statusCode: 503,
+      probability: 1,
+    }],
+  },
+});
+await page.goto('/dashboard');
+```
+
+SSE chaos and GraphQL operation matching use the same pre-navigation `injectChaos()` timing as fetch, XHR, and WebSocket chaos.
+
 ## API
 
 ### `injectChaos(page, config, opts?)`
@@ -167,6 +189,38 @@ test('with direct API', async ({ page }, testInfo) => {
 });
 ```
 
+## Service Worker chaos
+
+Intercept SW-originated fetches. Requires one line in your service-worker script.
+
+```js
+// user's sw.js (classic)
+importScripts('/chaos-maker-sw.js');
+```
+
+```ts
+import { injectSWChaos, removeSWChaos, getSWChaosLog } from '@chaos-maker/playwright';
+
+test('SW-fetched /api returns 503', async ({ page }) => {
+  await page.goto('/app-with-sw/');
+  // wait for controller after your app's SW registration
+  await injectSWChaos(page, {
+    network: { failures: [{ urlPattern: '/api/data', statusCode: 503, probability: 1 }] },
+    seed: 1,
+  });
+  await page.click('#trigger');
+  const log = await getSWChaosLog(page);
+  expect(log.some(e => e.type === 'network:failure' && e.applied)).toBe(true);
+  await removeSWChaos(page);
+});
+```
+
+Two artifacts ship in `@chaos-maker/core`:
+- `dist/sw.js` — IIFE bundle for classic SWs (`importScripts('/chaos-maker-sw.js')`).
+- `dist/sw.mjs` — ESM bundle for module SWs (`import { installChaosSW } from '/chaos-maker-sw.mjs'`).
+
+Serve whichever your SW type uses at a URL reachable from the service-worker scope.
+
 ## License
 
 [MIT](../../LICENSE)

package/dist/{chunk-XVP3BFFM.js → chunk-KHKPTES5.js}

@@ -1,4 +1,5 @@
 // src/index.ts
+import { serializeForTransport } from "@chaos-maker/core";
 import { resolve, dirname } from "path";
 import { createRequire } from "module";
 import { fileURLToPath } from "url";
@@ -107,6 +108,63 @@ async function createTraceReporter(page, testInfo, opts = {}) {
   };
 }
 
+// src/sw.ts
+import { validateConfig, SW_BRIDGE_SOURCE } from "@chaos-maker/core";
+var BRIDGE_INIT_KEY = /* @__PURE__ */ Symbol.for("chaos-maker.playwright.sw.bridgeInit");
+async function ensurePageBridge(page) {
+  if (!page[BRIDGE_INIT_KEY]) {
+    await page.addInitScript({ content: SW_BRIDGE_SOURCE });
+    page[BRIDGE_INIT_KEY] = true;
+  }
+  await page.evaluate(SW_BRIDGE_SOURCE).catch(() => {
+  });
+}
+async function injectSWChaos(page, config, opts = {}) {
+  const validated = validateConfig(config);
+  const timeoutMs = opts.timeoutMs ?? 1e4;
+  await ensurePageBridge(page);
+  const result = await page.evaluate(
+    async ({ cfg, timeoutMs: timeoutMs2 }) => {
+      const bridge = globalThis.__chaosMakerSWBridge;
+      if (!bridge) throw new Error("[chaos-maker] SW bridge missing from page \u2014 ensurePageBridge failed");
+      return await bridge.apply(cfg, timeoutMs2);
+    },
+    { cfg: validated, timeoutMs }
+  );
+  return result;
+}
+async function removeSWChaos(page, opts = {}) {
+  const timeoutMs = opts.timeoutMs ?? 5e3;
+  await page.evaluate(
+    async ({ timeoutMs: timeoutMs2 }) => {
+      const bridge = globalThis.__chaosMakerSWBridge;
+      if (!bridge) return;
+      await bridge.stop(timeoutMs2);
+      bridge.clearLocalLog();
+    },
+    { timeoutMs }
+  ).catch(() => {
+  });
+}
+async function getSWChaosLog(page) {
+  return page.evaluate(() => {
+    const bridge = globalThis.__chaosMakerSWBridge;
+    if (!bridge) return [];
+    return bridge.getLocalLog();
+  });
+}
+async function getSWChaosLogFromSW(page, opts = {}) {
+  const timeoutMs = opts.timeoutMs ?? 5e3;
+  return page.evaluate(
+    async ({ timeoutMs: timeoutMs2 }) => {
+      const bridge = globalThis.__chaosMakerSWBridge;
+      if (!bridge) return [];
+      return bridge.getRemoteLog(timeoutMs2);
+    },
+    { timeoutMs }
+  );
+}
+
 // src/index.ts
 var cachedUmdPath = null;
 function getCoreUmdPath() {
@@ -134,10 +192,11 @@ async function injectChaos(page, config, opts = {}) {
       page[TRACE_HANDLE_KEY] = handle;
     }
   }
+  const serialized = serializeForTransport(config);
   await page.addInitScript((cfg) => {
     const win = globalThis;
     win.__CHAOS_CONFIG__ = cfg;
-  }, config);
+  }, serialized);
   await page.addInitScript({ path: umdPath });
 }
 function resolveTracing(opts) {
@@ -186,6 +245,10 @@ async function getChaosSeed(page) {
 }
 
 export {
+  injectSWChaos,
+  removeSWChaos,
+  getSWChaosLog,
+  getSWChaosLogFromSW,
   injectChaos,
   removeChaos,
   getChaosLog,

package/dist/fixture.cjs

@@ -27,6 +27,7 @@ module.exports = __toCommonJS(fixture_exports);
 var import_test2 = require("@playwright/test");
 
 // src/index.ts
+var import_core2 = require("@chaos-maker/core");
 var import_path = require("path");
 var import_module = require("module");
 var import_url = require("url");
@@ -135,6 +136,9 @@ async function createTraceReporter(page, testInfo, opts = {}) {
   };
 }
 
+// src/sw.ts
+var import_core = require("@chaos-maker/core");
+
 // src/index.ts
 var import_meta = {};
 var cachedUmdPath = null;
@@ -163,10 +167,11 @@ async function injectChaos(page, config, opts = {}) {
       page[TRACE_HANDLE_KEY] = handle;
     }
   }
+  const serialized = (0, import_core2.serializeForTransport)(config);
   await page.addInitScript((cfg) => {
     const win = globalThis;
     win.__CHAOS_CONFIG__ = cfg;
-  }, config);
+  }, serialized);
   await page.addInitScript({ path: umdPath });
 }
 function resolveTracing(opts) {

package/dist/fixture.js

@@ -3,7 +3,7 @@ import {
   getChaosSeed,
   injectChaos,
   removeChaos
-} from "./chunk-XVP3BFFM.js";
+} from "./chunk-KHKPTES5.js";
 
 // src/fixture.ts
 import { test as base } from "@playwright/test";

package/dist/index.cjs

@@ -22,10 +22,15 @@ var index_exports = {};
 __export(index_exports, {
   getChaosLog: () => getChaosLog,
   getChaosSeed: () => getChaosSeed,
+  getSWChaosLog: () => getSWChaosLog,
+  getSWChaosLogFromSW: () => getSWChaosLogFromSW,
   injectChaos: () => injectChaos,
-  removeChaos: () => removeChaos
+  injectSWChaos: () => injectSWChaos,
+  removeChaos: () => removeChaos,
+  removeSWChaos: () => removeSWChaos
 });
 module.exports = __toCommonJS(index_exports);
+var import_core2 = require("@chaos-maker/core");
 var import_path = require("path");
 var import_module = require("module");
 var import_url = require("url");
@@ -134,6 +139,63 @@ async function createTraceReporter(page, testInfo, opts = {}) {
   };
 }
 
+// src/sw.ts
+var import_core = require("@chaos-maker/core");
+var BRIDGE_INIT_KEY = /* @__PURE__ */ Symbol.for("chaos-maker.playwright.sw.bridgeInit");
+async function ensurePageBridge(page) {
+  if (!page[BRIDGE_INIT_KEY]) {
+    await page.addInitScript({ content: import_core.SW_BRIDGE_SOURCE });
+    page[BRIDGE_INIT_KEY] = true;
+  }
+  await page.evaluate(import_core.SW_BRIDGE_SOURCE).catch(() => {
+  });
+}
+async function injectSWChaos(page, config, opts = {}) {
+  const validated = (0, import_core.validateConfig)(config);
+  const timeoutMs = opts.timeoutMs ?? 1e4;
+  await ensurePageBridge(page);
+  const result = await page.evaluate(
+    async ({ cfg, timeoutMs: timeoutMs2 }) => {
+      const bridge = globalThis.__chaosMakerSWBridge;
+      if (!bridge) throw new Error("[chaos-maker] SW bridge missing from page \u2014 ensurePageBridge failed");
+      return await bridge.apply(cfg, timeoutMs2);
+    },
+    { cfg: validated, timeoutMs }
+  );
+  return result;
+}
+async function removeSWChaos(page, opts = {}) {
+  const timeoutMs = opts.timeoutMs ?? 5e3;
+  await page.evaluate(
+    async ({ timeoutMs: timeoutMs2 }) => {
+      const bridge = globalThis.__chaosMakerSWBridge;
+      if (!bridge) return;
+      await bridge.stop(timeoutMs2);
+      bridge.clearLocalLog();
+    },
+    { timeoutMs }
+  ).catch(() => {
+  });
+}
+async function getSWChaosLog(page) {
+  return page.evaluate(() => {
+    const bridge = globalThis.__chaosMakerSWBridge;
+    if (!bridge) return [];
+    return bridge.getLocalLog();
+  });
+}
+async function getSWChaosLogFromSW(page, opts = {}) {
+  const timeoutMs = opts.timeoutMs ?? 5e3;
+  return page.evaluate(
+    async ({ timeoutMs: timeoutMs2 }) => {
+      const bridge = globalThis.__chaosMakerSWBridge;
+      if (!bridge) return [];
+      return bridge.getRemoteLog(timeoutMs2);
+    },
+    { timeoutMs }
+  );
+}
+
 // src/index.ts
 var import_meta = {};
 var cachedUmdPath = null;
@@ -162,10 +224,11 @@ async function injectChaos(page, config, opts = {}) {
       page[TRACE_HANDLE_KEY] = handle;
     }
   }
+  const serialized = (0, import_core2.serializeForTransport)(config);
   await page.addInitScript((cfg) => {
     const win = globalThis;
     win.__CHAOS_CONFIG__ = cfg;
-  }, config);
+  }, serialized);
   await page.addInitScript({ path: umdPath });
 }
 function resolveTracing(opts) {
@@ -216,6 +279,10 @@ async function getChaosSeed(page) {
 0 && (module.exports = {
   getChaosLog,
   getChaosSeed,
+  getSWChaosLog,
+  getSWChaosLogFromSW,
   injectChaos,
-  removeChaos
+  injectSWChaos,
+  removeChaos,
+  removeSWChaos
 });

package/dist/index.d.cts

@@ -1,6 +1,6 @@
-import { TestInfo, Page } from '@playwright/test';
+import { Page, TestInfo } from '@playwright/test';
 import { ChaosEvent, ChaosConfig } from '@chaos-maker/core';
-export { ChaosConfig, ChaosEvent, WebSocketCloseConfig, WebSocketConfig, WebSocketCorruptConfig, WebSocketCorruptionStrategy, WebSocketDelayConfig, WebSocketDirection, WebSocketDropConfig } from '@chaos-maker/core';
+export { ChaosConfig, ChaosEvent, CorruptionStrategy, GraphQLOperationMatcher, NetworkAbortConfig, NetworkConfig, NetworkCorruptionConfig, NetworkCorsConfig, NetworkFailureConfig, NetworkLatencyConfig, NetworkRuleMatchers, SSECloseConfig, SSEConfig, SSECorruptConfig, SSECorruptionStrategy, SSEDelayConfig, SSEDropConfig, SSEEventTypeMatcher, WebSocketCloseConfig, WebSocketConfig, WebSocketCorruptConfig, WebSocketCorruptionStrategy, WebSocketDelayConfig, WebSocketDirection, WebSocketDropConfig } from '@chaos-maker/core';
 
 /**
  * Shape of the JSON attachment written to `testInfo.attachments` on teardown.
@@ -17,6 +17,57 @@ interface TraceReporterOptions {
     attachmentName?: string;
 }
 
+/**
+ * Options accepted by {@link injectSWChaos} / {@link removeSWChaos} /
+ * {@link getSWChaosLog}.
+ */
+interface SWChaosOptions {
+    /**
+     * Maximum milliseconds to wait for `navigator.serviceWorker.controller` and
+     * the SW's ack message. Defaults to `10000`. Raise for slow CI workers or
+     * SWs that do heavy work during `install`.
+     */
+    timeoutMs?: number;
+}
+interface InjectSWChaosResult {
+    /** Seed used by the PRNG inside the SW. `null` if the ack did not carry one. */
+    seed: number | null;
+}
+/**
+ * Configure Service-Worker chaos for a Playwright page. Call **after**
+ * `page.goto(...)` so there is a SW registration + controller to target.
+ *
+ * Requires the user's service worker to load the chaos SW bundle — typically
+ * via `importScripts('/path/to/chaos-maker-sw.js')` (classic SW) or
+ * `import { installChaosSW } from '@chaos-maker/core/sw'; installChaosSW();`
+ * (module SW).
+ *
+ * @example
+ * ```ts
+ * await page.goto('/');
+ * await injectSWChaos(page, {
+ *   network: { failures: [{ urlPattern: '/api', statusCode: 503, probability: 1 }] },
+ * });
+ * ```
+ */
+declare function injectSWChaos(page: Page, config: ChaosConfig, opts?: SWChaosOptions): Promise<InjectSWChaosResult>;
+/**
+ * Stop Service-Worker chaos for a Playwright page. Posts `__chaosMakerStop` to
+ * the current controller and clears the page's in-memory log buffer.
+ */
+declare function removeSWChaos(page: Page, opts?: SWChaosOptions): Promise<void>;
+/**
+ * Read the chaos event log buffered on the page side. Every event emitted by
+ * the SW is broadcast to all controlled clients and captured here.
+ */
+declare function getSWChaosLog(page: Page): Promise<ChaosEvent[]>;
+/**
+ * Ask the SW for its in-memory log. Useful when debugging a race where the
+ * page-side listener missed an early broadcast (e.g. first-paint navigation).
+ * Prefer {@link getSWChaosLog} in normal assertions.
+ */
+declare function getSWChaosLogFromSW(page: Page, opts?: SWChaosOptions): Promise<ChaosEvent[]>;
+
 /**
  * Options for `injectChaos`. Most callers can omit this entirely; defaults
  * preserve backward compatibility with the v0.1.x signature.
@@ -74,4 +125,4 @@ declare function getChaosLog(page: Page): Promise<ChaosEvent[]>;
  */
 declare function getChaosSeed(page: Page): Promise<number | null>;
 
-export { type ChaosTraceAttachment, type InjectChaosOptions, type TraceReporterOptions, getChaosLog, getChaosSeed, injectChaos, removeChaos };
+export { type ChaosTraceAttachment, type InjectChaosOptions, type InjectSWChaosResult, type SWChaosOptions, type TraceReporterOptions, getChaosLog, getChaosSeed, getSWChaosLog, getSWChaosLogFromSW, injectChaos, injectSWChaos, removeChaos, removeSWChaos };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { TestInfo, Page } from '@playwright/test';
+import { Page, TestInfo } from '@playwright/test';
 import { ChaosEvent, ChaosConfig } from '@chaos-maker/core';
-export { ChaosConfig, ChaosEvent, WebSocketCloseConfig, WebSocketConfig, WebSocketCorruptConfig, WebSocketCorruptionStrategy, WebSocketDelayConfig, WebSocketDirection, WebSocketDropConfig } from '@chaos-maker/core';
+export { ChaosConfig, ChaosEvent, CorruptionStrategy, GraphQLOperationMatcher, NetworkAbortConfig, NetworkConfig, NetworkCorruptionConfig, NetworkCorsConfig, NetworkFailureConfig, NetworkLatencyConfig, NetworkRuleMatchers, SSECloseConfig, SSEConfig, SSECorruptConfig, SSECorruptionStrategy, SSEDelayConfig, SSEDropConfig, SSEEventTypeMatcher, WebSocketCloseConfig, WebSocketConfig, WebSocketCorruptConfig, WebSocketCorruptionStrategy, WebSocketDelayConfig, WebSocketDirection, WebSocketDropConfig } from '@chaos-maker/core';
 
 /**
  * Shape of the JSON attachment written to `testInfo.attachments` on teardown.
@@ -17,6 +17,57 @@ interface TraceReporterOptions {
     attachmentName?: string;
 }
 
+/**
+ * Options accepted by {@link injectSWChaos} / {@link removeSWChaos} /
+ * {@link getSWChaosLog}.
+ */
+interface SWChaosOptions {
+    /**
+     * Maximum milliseconds to wait for `navigator.serviceWorker.controller` and
+     * the SW's ack message. Defaults to `10000`. Raise for slow CI workers or
+     * SWs that do heavy work during `install`.
+     */
+    timeoutMs?: number;
+}
+interface InjectSWChaosResult {
+    /** Seed used by the PRNG inside the SW. `null` if the ack did not carry one. */
+    seed: number | null;
+}
+/**
+ * Configure Service-Worker chaos for a Playwright page. Call **after**
+ * `page.goto(...)` so there is a SW registration + controller to target.
+ *
+ * Requires the user's service worker to load the chaos SW bundle — typically
+ * via `importScripts('/path/to/chaos-maker-sw.js')` (classic SW) or
+ * `import { installChaosSW } from '@chaos-maker/core/sw'; installChaosSW();`
+ * (module SW).
+ *
+ * @example
+ * ```ts
+ * await page.goto('/');
+ * await injectSWChaos(page, {
+ *   network: { failures: [{ urlPattern: '/api', statusCode: 503, probability: 1 }] },
+ * });
+ * ```
+ */
+declare function injectSWChaos(page: Page, config: ChaosConfig, opts?: SWChaosOptions): Promise<InjectSWChaosResult>;
+/**
+ * Stop Service-Worker chaos for a Playwright page. Posts `__chaosMakerStop` to
+ * the current controller and clears the page's in-memory log buffer.
+ */
+declare function removeSWChaos(page: Page, opts?: SWChaosOptions): Promise<void>;
+/**
+ * Read the chaos event log buffered on the page side. Every event emitted by
+ * the SW is broadcast to all controlled clients and captured here.
+ */
+declare function getSWChaosLog(page: Page): Promise<ChaosEvent[]>;
+/**
+ * Ask the SW for its in-memory log. Useful when debugging a race where the
+ * page-side listener missed an early broadcast (e.g. first-paint navigation).
+ * Prefer {@link getSWChaosLog} in normal assertions.
+ */
+declare function getSWChaosLogFromSW(page: Page, opts?: SWChaosOptions): Promise<ChaosEvent[]>;
+
 /**
  * Options for `injectChaos`. Most callers can omit this entirely; defaults
  * preserve backward compatibility with the v0.1.x signature.
@@ -74,4 +125,4 @@ declare function getChaosLog(page: Page): Promise<ChaosEvent[]>;
  */
 declare function getChaosSeed(page: Page): Promise<number | null>;
 
-export { type ChaosTraceAttachment, type InjectChaosOptions, type TraceReporterOptions, getChaosLog, getChaosSeed, injectChaos, removeChaos };
+export { type ChaosTraceAttachment, type InjectChaosOptions, type InjectSWChaosResult, type SWChaosOptions, type TraceReporterOptions, getChaosLog, getChaosSeed, getSWChaosLog, getSWChaosLogFromSW, injectChaos, injectSWChaos, removeChaos, removeSWChaos };

package/dist/index.js

@@ -1,12 +1,20 @@
 import {
   getChaosLog,
   getChaosSeed,
+  getSWChaosLog,
+  getSWChaosLogFromSW,
   injectChaos,
-  removeChaos
-} from "./chunk-XVP3BFFM.js";
+  injectSWChaos,
+  removeChaos,
+  removeSWChaos
+} from "./chunk-KHKPTES5.js";
 export {
   getChaosLog,
   getChaosSeed,
+  getSWChaosLog,
+  getSWChaosLogFromSW,
   injectChaos,
-  removeChaos
+  injectSWChaos,
+  removeChaos,
+  removeSWChaos
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chaos-maker/playwright",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Playwright adapter for @chaos-maker/core — one-line chaos injection in E2E tests",
   "keywords": [
@@ -13,10 +13,10 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/jvjithin/chaos-maker.git",
+    "url": "https://github.com/chaos-maker-dev/chaos-maker.git",
     "directory": "packages/playwright"
   },
-  "homepage": "https://github.com/jvjithin/chaos-maker",
+  "homepage": "https://github.com/chaos-maker-dev/chaos-maker",
   "engines": {
     "node": ">=18"
   },
@@ -49,7 +49,7 @@
     "dist"
   ],
   "dependencies": {
-    "@chaos-maker/core": "0.2.0"
+    "@chaos-maker/core": "0.4.0"
   },
   "peerDependencies": {
     "@playwright/test": ">=1.40.0"