@chaos-maker/core 0.2.0 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 # @chaos-maker/core
 
-Core chaos engine for web applications. Intercepts `fetch`, `XMLHttpRequest`, and DOM mutations to inject controlled failures, latency, aborts, corruption, and UI disruptions.
+Core chaos engine for web applications. Intercepts `fetch`, `XMLHttpRequest`, `WebSocket`, `EventSource`, DOM mutations, and Service Worker fetches to inject controlled failures, latency, aborts, corruption, drops, closes, and UI disruptions.
 
 Framework-agnostic. Works with Playwright, Cypress, Selenium, or any browser environment.
 
@@ -82,6 +82,9 @@ const config = new ChaosConfigBuilder()
 | Corruption | `network.corruptions` | Corrupt response bodies |
 | CORS | `network.cors` | Simulate CORS errors |
 | UI Assault | `ui.assaults` | Disable, hide, or remove DOM elements |
+| WebSocket | `websocket.*` | Drop, delay, corrupt, or close socket messages |
+| SSE | `sse.*` | Drop, delay, corrupt, or close EventSource events |
+| GraphQL | `graphqlOperation` | Target one operation on a shared endpoint |
 
 ## Configuration Reference
 
@@ -93,6 +96,7 @@ const config = new ChaosConfigBuilder()
 | `statusCode` | `number` | Yes | HTTP status code (100-599) |
 | `probability` | `number` | Yes | 0.0-1.0 chance of applying |
 | `methods` | `string[]` | No | HTTP methods to match (default: all) |
+| `graphqlOperation` | `string \| RegExp` | No | Operation name matcher for GraphQL requests |
 | `body` | `string` | No | Custom response body |
 | `statusText` | `string` | No | Custom status text |
 | `headers` | `Record<string, string>` | No | Custom response headers |
@@ -105,6 +109,7 @@ const config = new ChaosConfigBuilder()
 | `delayMs` | `number` | Yes | Delay in milliseconds |
 | `probability` | `number` | Yes | 0.0-1.0 chance of applying |
 | `methods` | `string[]` | No | HTTP methods to match |
+| `graphqlOperation` | `string \| RegExp` | No | Operation name matcher for GraphQL requests |
 
 ### NetworkAbortConfig
 
@@ -114,6 +119,7 @@ const config = new ChaosConfigBuilder()
 | `probability` | `number` | Yes | 0.0-1.0 chance of applying |
 | `timeout` | `number` | No | ms before abort (0 or omitted = immediate) |
 | `methods` | `string[]` | No | HTTP methods to match |
+| `graphqlOperation` | `string \| RegExp` | No | Operation name matcher for GraphQL requests |
 
 ### NetworkCorruptionConfig
 
@@ -123,6 +129,7 @@ const config = new ChaosConfigBuilder()
 | `strategy` | `CorruptionStrategy` | Yes | `'truncate'` \| `'malformed-json'` \| `'empty'` \| `'wrong-type'` |
 | `probability` | `number` | Yes | 0.0-1.0 chance of applying |
 | `methods` | `string[]` | No | HTTP methods to match |
+| `graphqlOperation` | `string \| RegExp` | No | Operation name matcher for GraphQL requests |
 
 ### NetworkCorsConfig
 
@@ -131,6 +138,7 @@ const config = new ChaosConfigBuilder()
 | `urlPattern` | `string` | Yes | Substring match against request URL |
 | `probability` | `number` | Yes | 0.0-1.0 chance of applying |
 | `methods` | `string[]` | No | HTTP methods to match |
+| `graphqlOperation` | `string \| RegExp` | No | Operation name matcher for GraphQL requests |
 
 ### UiAssaultConfig
 
@@ -140,6 +148,34 @@ const config = new ChaosConfigBuilder()
 | `action` | `string` | Yes | `'disable'` \| `'hide'` \| `'remove'` |
 | `probability` | `number` | Yes | 0.0-1.0 chance of applying |
 
+### SSEConfig
+
+```ts
+sse: {
+  drops: [{ urlPattern: '/events', eventType: 'token', probability: 0.1 }],
+  delays: [{ urlPattern: '/events', delayMs: 500, probability: 1 }],
+  corruptions: [{ urlPattern: '/events', strategy: 'truncate', probability: 0.05 }],
+  closes: [{ urlPattern: '/events', afterMs: 2000, probability: 0.02 }],
+}
+```
+
+`eventType` defaults to `message`; use a named event or `'*'` for all data events.
+
+### GraphQL operation matching
+
+```ts
+network: {
+  failures: [{
+    urlPattern: '/graphql',
+    graphqlOperation: 'GetUser',
+    statusCode: 503,
+    probability: 1,
+  }],
+}
+```
+
+`graphqlOperation` is an additional matcher on top of `urlPattern` and `methods`.
+
 ## Event System
 
 ```ts
@@ -151,7 +187,7 @@ const log = chaos.getLog();   // all events since start
 chaos.clearLog();
 ```
 
-Event types: `network:failure`, `network:latency`, `network:abort`, `network:corruption`, `network:cors`, `ui:assault`
+Event types: `network:failure`, `network:latency`, `network:abort`, `network:corruption`, `network:cors`, `ui:assault`, `websocket:drop`, `websocket:delay`, `websocket:corrupt`, `websocket:close`, `sse:drop`, `sse:delay`, `sse:corrupt`, `sse:close`
 
 ## Config Validation
 
@@ -171,6 +207,28 @@ try {
 }
 ```
 
+## Service Worker chaos
+
+Chaos applies to SW-originated fetches via the `@chaos-maker/core/sw` subpath. Zod + UI + builder are excluded from this bundle so it stays small enough for production SW deploys.
+
+Classic SW (one line):
+
+```js
+// user's sw.js
+importScripts('/path/to/chaos-maker-sw.js'); // auto-installs
+```
+
+Module SW:
+
+```js
+import { installChaosSW } from '@chaos-maker/core/sw';
+installChaosSW({ source: 'message' });
+```
+
+Page-side config is delivered via `postMessage` + `MessageChannel` ack. Use the adapter helpers (`injectSWChaos` / `removeSWChaos` / `getSWChaosLog`) in `@chaos-maker/{playwright,cypress,webdriverio,puppeteer}`.
+
+Limitations: `caches.match` hits bypass chaos (planned for v0.5.0); push/sync events not covered; cross-origin SWs not supported.
+
 ## License
 
 [MIT](../../LICENSE)