-
-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathpreflight.test.ts
More file actions
368 lines (320 loc) · 11.9 KB
/
Copy pathpreflight.test.ts
File metadata and controls
368 lines (320 loc) · 11.9 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
/**
* Tests for `resolveInitContext`. Stubs API and DSN-detection layers
* with `spyOn` and uses `MockUI` to drive prompts deterministically.
*/
import { afterEach, beforeEach, describe, expect, spyOn, test } from "bun:test";
// biome-ignore lint/performance/noNamespaceImport: spyOn requires object reference
import * as apiClient from "../../../src/lib/api-client.js";
// biome-ignore lint/performance/noNamespaceImport: spyOn requires object reference
import * as auth from "../../../src/lib/db/auth.js";
// biome-ignore lint/performance/noNamespaceImport: spyOn requires object reference
import * as dsnIndex from "../../../src/lib/dsn/index.js";
import { ApiError } from "../../../src/lib/errors.js";
// biome-ignore lint/performance/noNamespaceImport: spyOn requires object reference
import * as prefetch from "../../../src/lib/init/org-prefetch.js";
import { resolveInitContext } from "../../../src/lib/init/preflight.js";
import type { WizardOptions } from "../../../src/lib/init/types.js";
import { CANCELLED } from "../../../src/lib/init/ui/types.js";
// biome-ignore lint/performance/noNamespaceImport: spyOn requires object reference
import * as resolveTarget from "../../../src/lib/resolve-target.js";
// biome-ignore lint/performance/noNamespaceImport: spyOn requires object reference
import * as resolveTeam from "../../../src/lib/resolve-team.js";
import { createMockUI, type MockCall } from "./ui/mock-ui.js";
function makeOptions(overrides?: Partial<WizardOptions>): WizardOptions {
return {
directory: "/tmp/test",
yes: true,
dryRun: false,
...overrides,
};
}
function feedbackOutcomes(calls: MockCall[]): string[] {
return calls
.filter(
(c): c is Extract<MockCall, { kind: "feedback" }> => c.kind === "feedback"
)
.map((c) => c.outcome);
}
let resolveOrgPrefetchedSpy: ReturnType<typeof spyOn>;
let listOrganizationsSpy: ReturnType<typeof spyOn>;
let getProjectSpy: ReturnType<typeof spyOn>;
let tryGetPrimaryDsnSpy: ReturnType<typeof spyOn>;
let getAuthTokenSpy: ReturnType<typeof spyOn>;
let resolveOrCreateTeamSpy: ReturnType<typeof spyOn>;
let detectDsnSpy: ReturnType<typeof spyOn>;
let resolveDsnByPublicKeySpy: ReturnType<typeof spyOn>;
beforeEach(() => {
resolveOrgPrefetchedSpy = spyOn(
prefetch,
"resolveOrgPrefetched"
).mockResolvedValue({ org: "acme" });
listOrganizationsSpy = spyOn(
apiClient,
"listOrganizations"
).mockResolvedValue([{ id: "1", slug: "acme", name: "Acme" }]);
getProjectSpy = spyOn(apiClient, "getProject").mockResolvedValue({
id: "42",
slug: "my-app",
name: "my-app",
platform: "javascript-react",
dateCreated: "2026-04-16T00:00:00Z",
} as any);
tryGetPrimaryDsnSpy = spyOn(apiClient, "tryGetPrimaryDsn").mockResolvedValue(
"https://abc@o1.ingest.sentry.io/42"
);
getAuthTokenSpy = spyOn(auth, "getAuthToken").mockReturnValue("sntrys_test");
resolveOrCreateTeamSpy = spyOn(
resolveTeam,
"resolveOrCreateTeam"
).mockResolvedValue({
slug: "platform",
source: "auto-selected",
});
detectDsnSpy = spyOn(dsnIndex, "detectDsn").mockResolvedValue(null);
resolveDsnByPublicKeySpy = spyOn(
resolveTarget,
"resolveDsnByPublicKey"
).mockResolvedValue(null);
});
afterEach(() => {
resolveOrgPrefetchedSpy.mockRestore();
listOrganizationsSpy.mockRestore();
getProjectSpy.mockRestore();
tryGetPrimaryDsnSpy.mockRestore();
getAuthTokenSpy.mockRestore();
resolveOrCreateTeamSpy.mockRestore();
detectDsnSpy.mockRestore();
resolveDsnByPublicKeySpy.mockRestore();
process.exitCode = 0;
});
describe("resolveInitContext", () => {
test("uses an existing detected project in --yes mode", async () => {
detectDsnSpy.mockResolvedValue({
publicKey: "abc",
protocol: "https",
host: "o1.ingest.sentry.io",
projectId: "42",
raw: "https://abc@o1.ingest.sentry.io/42",
source: "env_file" as const,
});
resolveDsnByPublicKeySpy.mockResolvedValue({
org: "acme",
project: "my-app",
});
const { ui } = createMockUI();
const context = await resolveInitContext(makeOptions(), ui);
expect(context).toEqual(
expect.objectContaining({
org: "acme",
project: "my-app",
team: "platform",
authToken: "sntrys_test",
existingProject: expect.objectContaining({
orgSlug: "acme",
projectSlug: "my-app",
}),
})
);
expect(getProjectSpy).toHaveBeenCalledTimes(1);
expect(tryGetPrimaryDsnSpy).toHaveBeenCalledTimes(1);
});
test("keeps a detected DSN project even when project enrichment fails", async () => {
detectDsnSpy.mockResolvedValue({
publicKey: "abc",
protocol: "https",
host: "o1.ingest.sentry.io",
projectId: "42",
raw: "https://abc@o1.ingest.sentry.io/42",
source: "env_file" as const,
});
resolveDsnByPublicKeySpy.mockResolvedValue({
org: "acme",
project: "my-app",
});
getProjectSpy.mockRejectedValue(new ApiError("temporary failure", 503));
const { ui } = createMockUI();
const context = await resolveInitContext(makeOptions(), ui);
expect(context).toEqual(
expect.objectContaining({
org: "acme",
project: "my-app",
team: "platform",
})
);
expect(context?.existingProject).toBeUndefined();
});
test("retries detected project enrichment during project selection when the first lookup yields no metadata", async () => {
detectDsnSpy.mockResolvedValue({
publicKey: "abc",
protocol: "https",
host: "o1.ingest.sentry.io",
projectId: "42",
raw: "https://abc@o1.ingest.sentry.io/42",
source: "env_file" as const,
});
resolveDsnByPublicKeySpy.mockResolvedValue({
org: "acme",
project: "my-app",
});
getProjectSpy
.mockRejectedValueOnce(new ApiError("not found", 404))
.mockResolvedValue({
id: "42",
slug: "my-app",
name: "my-app",
platform: "javascript-react",
dateCreated: "2026-04-16T00:00:00Z",
} as any);
const { ui } = createMockUI();
const context = await resolveInitContext(makeOptions(), ui);
expect(context?.existingProject).toEqual(
expect.objectContaining({
orgSlug: "acme",
projectSlug: "my-app",
})
);
expect(getProjectSpy).toHaveBeenCalledTimes(2);
expect(tryGetPrimaryDsnSpy).toHaveBeenCalledTimes(1);
});
test("falls back to listing organizations when prefetch misses", async () => {
resolveOrgPrefetchedSpy.mockResolvedValue(null);
listOrganizationsSpy.mockResolvedValue([
{ id: "1", slug: "solo-org", name: "Solo Org" },
]);
const { ui } = createMockUI();
const context = await resolveInitContext(makeOptions({ yes: false }), ui);
expect(context?.org).toBe("solo-org");
});
test("lets the user choose an existing bare-slug project", async () => {
const { ui, respond } = createMockUI();
respond.select("existing");
const context = await resolveInitContext(
makeOptions({ yes: false, project: "my-app" }),
ui
);
expect(context?.project).toBe("my-app");
expect(context?.existingProject?.projectSlug).toBe("my-app");
});
test("keeps the bare slug when the existence lookup fails", async () => {
getProjectSpy.mockRejectedValue(new ApiError("temporary failure", 503));
const { ui } = createMockUI();
const context = await resolveInitContext(
makeOptions({ yes: false, project: "my-app" }),
ui
);
expect(context?.project).toBe("my-app");
expect(context?.existingProject).toBeUndefined();
});
test("defers empty-org team creation until project creation", async () => {
resolveOrCreateTeamSpy.mockResolvedValue({ source: "deferred" } as any);
const { ui } = createMockUI();
const context = await resolveInitContext(makeOptions(), ui);
expect(context?.team).toBeUndefined();
expect(resolveOrCreateTeamSpy).toHaveBeenCalledWith(
"acme",
expect.objectContaining({
team: undefined,
deferAutoCreateOnEmptyOrg: true,
})
);
});
test("clears the project when the user chooses to create new", async () => {
const { ui, respond } = createMockUI();
respond.select("create");
const context = await resolveInitContext(
makeOptions({ yes: false, project: "my-app" }),
ui
);
expect(context?.project).toBeUndefined();
expect(context?.existingProject).toBeUndefined();
});
test("resolves an explicit team during preflight", async () => {
resolveOrCreateTeamSpy.mockImplementation(async (_org, options) => ({
slug: options.team ?? "platform",
source: options.team ? "explicit" : "auto-selected",
}));
const { ui } = createMockUI();
const context = await resolveInitContext(
makeOptions({ team: "backend", yes: false }),
ui
);
expect(context?.team).toBe("backend");
expect(resolveOrCreateTeamSpy).toHaveBeenCalledWith(
"acme",
expect.objectContaining({
team: "backend",
deferAutoCreateOnEmptyOrg: true,
})
);
});
test("uses the ambiguity callback when team selection requires it", async () => {
const { ui, respond } = createMockUI();
respond.select("mobile");
resolveOrCreateTeamSpy.mockImplementation(async (_org, options) => {
const slug = await options.onAmbiguous?.([
{ slug: "mobile", name: "Mobile", isMember: true },
{ slug: "platform", name: "Platform", isMember: true },
] as any);
return { slug, source: "auto-selected" };
});
const context = await resolveInitContext(makeOptions({ yes: false }), ui);
expect(context?.team).toBe("mobile");
});
test("returns null when the user cancels an org selection", async () => {
resolveOrgPrefetchedSpy.mockResolvedValue(null);
listOrganizationsSpy.mockResolvedValue([
{ id: "1", slug: "acme", name: "Acme" },
{ id: "2", slug: "beta", name: "Beta" },
]);
const { ui, calls, respond } = createMockUI();
respond.select(CANCELLED);
const context = await resolveInitContext(makeOptions({ yes: false }), ui);
expect(context).toBeNull();
const cancelCall = calls.find((c) => c.kind === "cancel");
expect(cancelCall?.kind === "cancel" && cancelCall.message).toBe(
"Setup cancelled."
);
expect(feedbackOutcomes(calls)).toEqual(["cancelled"]);
});
test("surfaces 403 guidance when listOrganizations is forbidden", async () => {
resolveOrgPrefetchedSpy.mockResolvedValue(null);
listOrganizationsSpy.mockRejectedValueOnce(
new ApiError(
"Failed to list organizations",
403,
"You do not have permission."
)
);
const { ui, calls } = createMockUI();
await expect(
resolveInitContext(makeOptions({ yes: true }), ui)
).rejects.toThrow("403 Forbidden");
const errorCall = calls.find(
(c): c is Extract<MockCall, { kind: "log.error" }> =>
c.kind === "log.error"
);
expect(errorCall?.message).toContain("403 Forbidden");
expect(errorCall?.message).toContain("sentry init <org-slug>/");
});
test("surfaces 401 guidance when listOrganizations is unauthorized", async () => {
resolveOrgPrefetchedSpy.mockResolvedValue(null);
listOrganizationsSpy.mockRejectedValueOnce(
new ApiError("Failed to list organizations", 401, "Token expired")
);
const { ui, calls } = createMockUI();
await expect(
resolveInitContext(makeOptions({ yes: true }), ui)
).rejects.toThrow("401 Unauthorized");
const errorCall = calls.find(
(c): c is Extract<MockCall, { kind: "log.error" }> =>
c.kind === "log.error"
);
expect(errorCall?.message).toContain("401 Unauthorized");
expect(errorCall?.message).toContain("Token expired");
});
test("includes the auth token in the resolved context", async () => {
const { ui } = createMockUI();
const context = await resolveInitContext(makeOptions(), ui);
expect(context?.authToken).toBe("sntrys_test");
});
});