-
-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathinfrastructure.test.ts
More file actions
465 lines (422 loc) · 14.3 KB
/
infrastructure.test.ts
File metadata and controls
465 lines (422 loc) · 14.3 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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
import { afterEach, beforeEach, describe, expect, test } from "bun:test";
import { throwApiError } from "../../../src/lib/api/infrastructure.js";
import { ApiError } from "../../../src/lib/errors.js";
describe("throwApiError", () => {
test("network failure with Error produces readable message", () => {
expect(() =>
throwApiError(
new TypeError("fetch failed"),
undefined,
"Failed to resolve short ID"
)
).toThrow(
expect.objectContaining({
message: "Failed to resolve short ID: Network error",
status: 0,
})
);
try {
throwApiError(
new TypeError("fetch failed"),
undefined,
"Failed to resolve short ID"
);
} catch (error) {
expect(error).toBeInstanceOf(ApiError);
const apiError = error as ApiError;
expect(apiError.detail).toContain("fetch failed");
expect(apiError.detail).toContain("Unable to reach Sentry API");
expect(apiError.detail).toContain(
"Check your internet connection and try again"
);
}
});
test("network failure with non-Error produces readable message", () => {
try {
throwApiError("connection refused", undefined, "Failed to list issues");
} catch (error) {
expect(error).toBeInstanceOf(ApiError);
const apiError = error as ApiError;
expect(apiError.message).toBe("Failed to list issues: Network error");
expect(apiError.status).toBe(0);
expect(apiError.detail).toContain("connection refused");
}
});
test("HTTP error with response preserves status and detail", () => {
const mockResponse = new Response("", {
status: 400,
statusText: "Bad Request",
});
try {
throwApiError(
{ detail: "Invalid query syntax" },
mockResponse,
"Failed to list issues"
);
} catch (error) {
expect(error).toBeInstanceOf(ApiError);
const apiError = error as ApiError;
expect(apiError.message).toBe("Failed to list issues: 400 Bad Request");
expect(apiError.status).toBe(400);
expect(apiError.detail).toBe("Invalid query syntax");
}
});
test("HTTP error without detail uses stringified error", () => {
const mockResponse = new Response("", {
status: 500,
statusText: "Internal Server Error",
});
try {
throwApiError("something went wrong", mockResponse, "Failed to fetch");
} catch (error) {
expect(error).toBeInstanceOf(ApiError);
const apiError = error as ApiError;
expect(apiError.message).toBe(
"Failed to fetch: 500 Internal Server Error"
);
expect(apiError.status).toBe(500);
expect(apiError.detail).toBe("something went wrong");
}
});
test("network failure with ECONNREFUSED-style error", () => {
const err = new Error("connect ECONNREFUSED 127.0.0.1:443");
try {
throwApiError(err, undefined, "Failed to get event");
} catch (error) {
expect(error).toBeInstanceOf(ApiError);
const apiError = error as ApiError;
expect(apiError.message).toBe("Failed to get event: Network error");
expect(apiError.detail).toContain("ECONNREFUSED");
}
});
test("non-403 errors do not get enriched", () => {
const mockResponse = new Response("", {
status: 404,
statusText: "Not Found",
});
try {
throwApiError(
{ detail: "Resource not found" },
mockResponse,
"Failed to get org"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.enriched403).toBe(false);
expect(apiError.detail).toBe("Resource not found");
}
});
describe("403 enrichment", () => {
// Test preload sets SENTRY_AUTH_TOKEN, so isEnvTokenActive() returns true
// by default in these tests.
test("does not suggest token scopes for org-policy disabled-feature 403s", () => {
const mockResponse = new Response("", {
status: 403,
statusText: "Forbidden",
});
try {
throwApiError(
{
detail: "Your organization has disabled this feature for members.",
},
mockResponse,
"Failed to create project"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.enriched403).toBe(true);
expect(apiError.detail).toContain("disabled this feature");
expect(apiError.detail).toContain("org-level policy");
expect(apiError.detail).not.toContain("SENTRY_AUTH_TOKEN");
}
});
test("enriches 403 with env-var token hints", () => {
const mockResponse = new Response("", {
status: 403,
statusText: "Forbidden",
});
try {
throwApiError(
{ detail: "You do not have permission to perform this action." },
mockResponse,
"Failed to get organization"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.enriched403).toBe(true);
expect(apiError.status).toBe(403);
expect(apiError.detail).toContain(
"You do not have permission to perform this action."
);
expect(apiError.detail).toContain("SENTRY_AUTH_TOKEN");
expect(apiError.detail).toContain(
"https://sentry.io/settings/account/api/auth-tokens/"
);
}
});
test("extracts specific scope names when present in detail", () => {
const mockResponse = new Response("", {
status: 403,
statusText: "Forbidden",
});
try {
throwApiError(
{
detail:
"You do not have permission. Required scope: org:read, project:read",
},
mockResponse,
"Failed to list issues"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.enriched403).toBe(true);
expect(apiError.detail).toContain(
"missing the required scope(s) 'org:read', 'project:read'"
);
}
});
test("uses generic scope hint when no scope names in detail", () => {
const mockResponse = new Response("", {
status: 403,
statusText: "Forbidden",
});
try {
throwApiError(
{ detail: "You do not have permission to perform this action." },
mockResponse,
"Failed to get organization"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.detail).toContain(
"may lack the required scope for this operation"
);
}
});
test("handles undefined detail without producing noise", () => {
const mockResponse = new Response("", {
status: 403,
statusText: "Forbidden",
});
try {
throwApiError(
{ detail: undefined },
mockResponse,
"Failed to get organization"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.enriched403).toBe(true);
// Should contain enrichment hints
expect(apiError.detail).toContain("SENTRY_AUTH_TOKEN");
// Should NOT contain noisy fallback strings
expect(apiError.detail).not.toMatch(/^undefined/);
expect(apiError.detail).not.toContain("{}");
}
});
test("handles null detail without producing noise", () => {
const mockResponse = new Response("", {
status: 403,
statusText: "Forbidden",
});
try {
throwApiError(
{ detail: null },
mockResponse,
"Failed to get organization"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.enriched403).toBe(true);
expect(apiError.detail).toContain("SENTRY_AUTH_TOKEN");
// Should NOT contain noisy fallback strings
expect(apiError.detail).not.toMatch(/^null/);
expect(apiError.detail).not.toContain('{"detail":null}');
}
});
describe("with OAuth token (no env var)", () => {
let savedAuthToken: string | undefined;
let savedToken: string | undefined;
beforeEach(() => {
savedAuthToken = process.env.SENTRY_AUTH_TOKEN;
savedToken = process.env.SENTRY_TOKEN;
delete process.env.SENTRY_AUTH_TOKEN;
delete process.env.SENTRY_TOKEN;
});
afterEach(() => {
if (savedAuthToken !== undefined) {
process.env.SENTRY_AUTH_TOKEN = savedAuthToken;
} else {
delete process.env.SENTRY_AUTH_TOKEN;
}
if (savedToken !== undefined) {
process.env.SENTRY_TOKEN = savedToken;
} else {
delete process.env.SENTRY_TOKEN;
}
});
test("does not suggest re-authentication for org-policy disabled-feature 403s", () => {
const mockResponse = new Response("", {
status: 403,
statusText: "Forbidden",
});
try {
throwApiError(
{
detail:
"Your organization has disabled this feature for members.",
},
mockResponse,
"Failed to create project"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.enriched403).toBe(true);
expect(apiError.detail).toContain("disabled this feature");
expect(apiError.detail).toContain("org-level policy");
expect(apiError.detail).not.toContain("Re-authenticate");
expect(apiError.detail).not.toContain("sentry auth login");
}
});
test("suggests re-authentication for OAuth tokens", () => {
const mockResponse = new Response("", {
status: 403,
statusText: "Forbidden",
});
try {
throwApiError(
{
detail: "You do not have permission to perform this action.",
},
mockResponse,
"Failed to get organization"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.enriched403).toBe(true);
expect(apiError.detail).toContain(
"You may not have access to this resource."
);
expect(apiError.detail).toContain("sentry auth login");
// Should NOT mention SENTRY_AUTH_TOKEN
expect(apiError.detail).not.toContain("SENTRY_AUTH_TOKEN");
}
});
});
});
describe("401 enrichment", () => {
// Test preload sets SENTRY_AUTH_TOKEN, so isEnvTokenActive() returns true
// by default in these tests.
test("uses 'not recognized or has been revoked' for invalid token", () => {
const mockResponse = new Response("", {
status: 401,
statusText: "Unauthorized",
});
try {
throwApiError(
{ detail: "Invalid token" },
mockResponse,
"Failed to list organizations"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.status).toBe(401);
expect(apiError.message).toBe(
"Failed to list organizations: 401 Unauthorized"
);
expect(apiError.detail).toContain("Invalid token");
expect(apiError.detail).toContain("SENTRY_AUTH_TOKEN");
expect(apiError.detail).toContain("not recognized or has been revoked");
expect(apiError.detail).toContain(
"https://sentry.io/settings/account/api/auth-tokens/"
);
}
});
test("uses 'has expired' for Token expired detail", () => {
const mockResponse = new Response("", {
status: 401,
statusText: "Unauthorized",
});
try {
throwApiError(
{ detail: "Token expired" },
mockResponse,
"Failed to list organizations"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.status).toBe(401);
expect(apiError.detail).toContain("Token expired");
expect(apiError.detail).toContain("SENTRY_AUTH_TOKEN");
expect(apiError.detail).toContain("has expired");
expect(apiError.detail).not.toContain("not recognized");
expect(apiError.detail).toContain(
"https://sentry.io/settings/account/api/auth-tokens/"
);
}
});
test("falls back to 'not recognized' when detail is absent", () => {
const mockResponse = new Response("", {
status: 401,
statusText: "Unauthorized",
});
try {
throwApiError(
{ detail: undefined },
mockResponse,
"Failed to list organizations"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.status).toBe(401);
expect(apiError.detail).toContain("SENTRY_AUTH_TOKEN");
expect(apiError.detail).toContain("not recognized or has been revoked");
expect(apiError.detail).not.toMatch(/^undefined/);
expect(apiError.detail).not.toContain("{}");
}
});
describe("with OAuth token (no env var)", () => {
let savedAuthToken: string | undefined;
let savedToken: string | undefined;
beforeEach(() => {
savedAuthToken = process.env.SENTRY_AUTH_TOKEN;
savedToken = process.env.SENTRY_TOKEN;
delete process.env.SENTRY_AUTH_TOKEN;
delete process.env.SENTRY_TOKEN;
});
afterEach(() => {
if (savedAuthToken !== undefined) {
process.env.SENTRY_AUTH_TOKEN = savedAuthToken;
} else {
delete process.env.SENTRY_AUTH_TOKEN;
}
if (savedToken !== undefined) {
process.env.SENTRY_TOKEN = savedToken;
} else {
delete process.env.SENTRY_TOKEN;
}
});
test("suggests re-authentication for OAuth tokens", () => {
const mockResponse = new Response("", {
status: 401,
statusText: "Unauthorized",
});
try {
throwApiError(
{ detail: "Authentication credentials were not provided." },
mockResponse,
"Failed to list organizations"
);
} catch (error) {
const apiError = error as ApiError;
expect(apiError.status).toBe(401);
expect(apiError.detail).toContain("session has expired");
expect(apiError.detail).toContain("sentry auth login");
// Should NOT mention SENTRY_AUTH_TOKEN
expect(apiError.detail).not.toContain("SENTRY_AUTH_TOKEN");
}
});
});
});
});