-
Notifications
You must be signed in to change notification settings - Fork 37
Expand file tree
/
Copy pathindex.html
More file actions
205 lines (189 loc) · 10 KB
/
index.html
File metadata and controls
205 lines (189 loc) · 10 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Error Injection — aimock</title>
<link rel="icon" type="image/svg+xml" href="../favicon.svg" />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,300;0,400;0,500;0,600;0,700;1,400&family=Instrument+Sans:wght@400;500;600;700&display=swap"
rel="stylesheet"
/>
<link rel="stylesheet" href="../style.css" />
<script src="/pixels.js" defer></script>
</head>
<body>
<nav class="top-nav">
<div class="nav-inner">
<div style="display: flex; align-items: center; gap: 1rem">
<button
class="sidebar-toggle"
onclick="document.querySelector('.sidebar').classList.toggle('open')"
aria-label="Toggle sidebar"
>
☰
</button>
<a href="/" class="nav-brand"> <span class="prompt">$</span> aimock </a>
</div>
<ul class="nav-links">
<li><a href="/">Home</a></li>
<li><a href="/docs" style="color: var(--accent)">Docs</a></li>
<li>
<a href="https://github.com/CopilotKit/aimock" class="gh-link" target="_blank"
><svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor">
<path
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"
/>
</svg>
GitHub</a
>
</li>
</ul>
</div>
</nav>
<div class="docs-layout">
<aside class="sidebar" id="sidebar"></aside>
<main class="docs-content">
<h1>Error Injection</h1>
<p class="lead">
Test your application's error handling with one-shot errors, stream truncation, and timed
disconnects. aimock provides three mechanisms for simulating failures.
</p>
<h2>One-Shot Errors</h2>
<p>
Queue an error that fires on the next request and auto-removes itself. Useful for testing
retry logic.
</p>
<div class="code-block">
<div class="code-block-header">
one-shot-error.test.ts <span class="lang-tag">ts</span>
</div>
<pre><code><span class="kw">const</span> <span class="op">mock</span> = <span class="kw">new</span> <span class="type">LLMock</span>();
<span class="kw">await</span> <span class="op">mock</span>.<span class="fn">start</span>();
<span class="op">mock</span>.<span class="fn">onMessage</span>(<span class="str">"hello"</span>, { <span class="prop">content</span>: <span class="str">"Hi!"</span> });
<span class="cm">// Queue a 429 rate limit error for the next request</span>
<span class="op">mock</span>.<span class="fn">nextRequestError</span>(<span class="num">429</span>, {
<span class="prop">message</span>: <span class="str">"Rate limit exceeded"</span>,
<span class="prop">type</span>: <span class="str">"rate_limit_error"</span>,
});
<span class="cm">// First request → 429 error</span>
<span class="kw">const</span> <span class="op">res1</span> = <span class="kw">await</span> <span class="fn">fetch</span>(<span class="str">`${mock.url}/v1/chat/completions`</span>, {
<span class="prop">method</span>: <span class="str">"POST"</span>,
<span class="prop">headers</span>: { <span class="str">"Content-Type"</span>: <span class="str">"application/json"</span> },
<span class="prop">body</span>: <span class="type">JSON</span>.<span class="fn">stringify</span>({
<span class="prop">model</span>: <span class="str">"gpt-4"</span>,
<span class="prop">messages</span>: [{ <span class="prop">role</span>: <span class="str">"user"</span>, <span class="prop">content</span>: <span class="str">"hello"</span> }],
}),
});
<span class="fn">expect</span>(<span class="op">res1</span>.<span class="prop">status</span>).<span class="fn">toBe</span>(<span class="num">429</span>);
<span class="cm">// Second request → normal response (error auto-removed)</span>
<span class="kw">const</span> <span class="op">res2</span> = <span class="kw">await</span> <span class="fn">fetch</span>(<span class="str">`${mock.url}/v1/chat/completions`</span>, { <span class="cm">/* same */</span> });
<span class="fn">expect</span>(<span class="op">res2</span>.<span class="prop">status</span>).<span class="fn">toBe</span>(<span class="num">200</span>);</code></pre>
</div>
<h2>Stream Truncation</h2>
<p>
Abort a streaming response after a specific number of SSE chunks. Tests that your
application handles partial streams gracefully.
</p>
<div class="code-block">
<div class="code-block-header">truncation.test.ts <span class="lang-tag">ts</span></div>
<pre><code><span class="op">mock</span>.<span class="fn">on</span>(
{ <span class="prop">userMessage</span>: <span class="str">"long story"</span> },
{ <span class="prop">content</span>: <span class="str">"This is a very long response that will be cut short"</span> },
{ <span class="prop">truncateAfterChunks</span>: <span class="num">3</span> } <span class="cm">// Abort after 3 SSE chunks</span>
);</code></pre>
</div>
<h2>Timed Disconnect</h2>
<p>
Disconnect after a specified number of milliseconds. Simulates network timeouts and
connection drops.
</p>
<div class="code-block">
<div class="code-block-header">disconnect.test.ts <span class="lang-tag">ts</span></div>
<pre><code><span class="op">mock</span>.<span class="fn">on</span>(
{ <span class="prop">userMessage</span>: <span class="str">"slow"</span> },
{ <span class="prop">content</span>: <span class="str">"This response will never complete"</span> },
{ <span class="prop">disconnectAfterMs</span>: <span class="num">100</span> } <span class="cm">// Kill connection after 100ms</span>
);</code></pre>
</div>
<h2>Error Fixtures in JSON</h2>
<div class="code-block">
<div class="code-block-header">
fixtures/errors.json <span class="lang-tag">json</span>
</div>
<pre><code>{
<span class="key">"fixtures"</span>: [
{
<span class="key">"match"</span>: { <span class="key">"userMessage"</span>: <span class="str">"error-test"</span> },
<span class="key">"response"</span>: {
<span class="key">"error"</span>: {
<span class="key">"message"</span>: <span class="str">"Rate limited"</span>,
<span class="key">"type"</span>: <span class="str">"rate_limit_error"</span>
},
<span class="key">"status"</span>: <span class="num">429</span>
}
},
{
<span class="key">"match"</span>: { <span class="key">"userMessage"</span>: <span class="str">"partial"</span> },
<span class="key">"response"</span>: { <span class="key">"content"</span>: <span class="str">"This gets cut off"</span> },
<span class="key">"truncateAfterChunks"</span>: <span class="num">2</span>
},
{
<span class="key">"match"</span>: { <span class="key">"userMessage"</span>: <span class="str">"timeout"</span> },
<span class="key">"response"</span>: { <span class="key">"content"</span>: <span class="str">"Never finishes"</span> },
<span class="key">"disconnectAfterMs"</span>: <span class="num">50</span>
}
]
}</code></pre>
</div>
<h2>Interruption Behavior</h2>
<ul>
<li>
<code>truncateAfterChunks</code> — counts SSE data lines sent; aborts on the Nth
chunk
</li>
<li>
<code>disconnectAfterMs</code> — starts a timer when the response begins; kills
the connection when it fires
</li>
<li>If both are set, whichever fires first wins</li>
<li>
Interrupted requests are recorded in the journal with
<code>response.interrupted: true</code> and <code>response.interruptReason</code>
</li>
</ul>
<div class="info-box">
<p>
<code>nextRequestError()</code> is one-shot: it fires once and auto-removes itself. For
persistent error fixtures, use <code>addFixture()</code> with an error response.
</p>
</div>
<div class="info-box">
<p>
<strong>See also: <a href="/chaos-testing">Chaos Testing</a></strong> — for
probabilistic failure injection. Chaos testing adds configurable error rates, random
latency spikes, and stream corruption that trigger based on probability rather than
deterministic fixture matching. Use error injection for specific, reproducible failure
scenarios; use chaos testing for resilience testing under unpredictable conditions.
</p>
</div>
</main>
<aside class="page-toc" id="page-toc"></aside>
</div>
<footer class="docs-footer">
<div class="footer-inner">
<div class="footer-left"><span>$</span> aimock · MIT License</div>
<ul class="footer-links">
<li><a href="https://github.com/CopilotKit/aimock" target="_blank">GitHub</a></li>
<li>
<a href="https://www.npmjs.com/package/@copilotkit/aimock" target="_blank">npm</a>
</li>
</ul>
</div>
</footer>
<script src="../sidebar.js"></script>
<script src="../cli-tabs.js"></script>
</body>
</html>