@geekmidas/testkit 10.0.0-alpha.17 → 10.0.0-alpha.170

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/README.md +108 -0
  2. package/dist/PostgresKyselyMigrator.d.cts +1 -1
  3. package/dist/PostgresKyselyMigrator.d.mts +1 -1
  4. package/dist/{PostgresMigrator-CoHQ95cT.d.cts → PostgresMigrator-CDPnnwMJ.d.cts} +10 -3
  5. package/dist/PostgresMigrator-CDPnnwMJ.d.cts.map +1 -0
  6. package/dist/{PostgresMigrator-CoHQ95cT.d.mts → PostgresMigrator-CDPnnwMJ.d.mts} +10 -3
  7. package/dist/PostgresMigrator-CDPnnwMJ.d.mts.map +1 -0
  8. package/dist/PostgresMigrator.cjs +14 -5
  9. package/dist/PostgresMigrator.cjs.map +1 -1
  10. package/dist/PostgresMigrator.d.cts +1 -1
  11. package/dist/PostgresMigrator.d.mts +1 -1
  12. package/dist/PostgresMigrator.mjs +14 -5
  13. package/dist/PostgresMigrator.mjs.map +1 -1
  14. package/dist/PostgresObjectionMigrator.d.cts +1 -1
  15. package/dist/PostgresObjectionMigrator.d.mts +1 -1
  16. package/dist/browser.cjs +211 -0
  17. package/dist/browser.cjs.map +1 -0
  18. package/dist/browser.d.cts +113 -0
  19. package/dist/browser.d.cts.map +1 -0
  20. package/dist/browser.d.mts +113 -0
  21. package/dist/browser.d.mts.map +1 -0
  22. package/dist/browser.mjs +207 -0
  23. package/dist/browser.mjs.map +1 -0
  24. package/dist/context.cjs +80 -0
  25. package/dist/context.cjs.map +1 -0
  26. package/dist/context.d.cts +55 -0
  27. package/dist/context.d.cts.map +1 -0
  28. package/dist/context.d.mts +55 -0
  29. package/dist/context.d.mts.map +1 -0
  30. package/dist/context.mjs +73 -0
  31. package/dist/context.mjs.map +1 -0
  32. package/dist/faker.cjs +51 -0
  33. package/dist/faker.cjs.map +1 -1
  34. package/dist/faker.d.cts +26 -19
  35. package/dist/faker.d.cts.map +1 -1
  36. package/dist/faker.d.mts +26 -19
  37. package/dist/faker.d.mts.map +1 -1
  38. package/dist/faker.mjs +51 -1
  39. package/dist/faker.mjs.map +1 -1
  40. package/dist/mailbox.cjs +107 -0
  41. package/dist/mailbox.cjs.map +1 -0
  42. package/dist/mailbox.d.cts +58 -0
  43. package/dist/mailbox.d.cts.map +1 -0
  44. package/dist/mailbox.d.mts +58 -0
  45. package/dist/mailbox.d.mts.map +1 -0
  46. package/dist/mailbox.mjs +103 -0
  47. package/dist/mailbox.mjs.map +1 -0
  48. package/dist/transactions.cjs +239 -0
  49. package/dist/transactions.cjs.map +1 -0
  50. package/dist/transactions.d.cts +44 -0
  51. package/dist/transactions.d.cts.map +1 -0
  52. package/dist/transactions.d.mts +44 -0
  53. package/dist/transactions.d.mts.map +1 -0
  54. package/dist/transactions.mjs +234 -0
  55. package/dist/transactions.mjs.map +1 -0
  56. package/package.json +57 -8
  57. package/dist/PostgresMigrator-CoHQ95cT.d.cts.map +0 -1
  58. package/dist/PostgresMigrator-CoHQ95cT.d.mts.map +0 -1
@@ -0,0 +1,113 @@
1
+ import { CookieJar } from "tough-cookie";
2
+ //#region src/browser.d.ts
3
+ export interface BrowserOptions {
4
+ /**
5
+ * The `fetch` requests go out on. Defaults to the global one at the time
6
+ * the browser is created — so a browser made inside a test goes through
7
+ * whatever the test installed (MSW, the context stamp) and never through
8
+ * itself once installed.
9
+ */
10
+ fetch?: typeof fetch;
11
+ /**
12
+ * The address this browser connects from. A fresh one by default, from a
13
+ * private range nothing routes to — see {@link Browser.address}.
14
+ */
15
+ address?: string;
16
+ /**
17
+ * The cookies it starts with — another browser's jar, to be the same
18
+ * person on another tab. A fresh jar by default.
19
+ */
20
+ jar?: CookieJar;
21
+ /**
22
+ * The address of the app's site on every subdomain,
23
+ * `https://*.test.shop.localhost:8443`, which {@link Browser.on} puts a
24
+ * tenant's slug into. A feature test passes it when the app declares one.
25
+ */
26
+ site?: string;
27
+ /**
28
+ * The page this browser is on: sent as `Origin` on every request that does
29
+ * not set its own, and what a relative {@link Browser.visit} resolves
30
+ * against. See {@link Browser.on}.
31
+ */
32
+ origin?: string;
33
+ }
34
+ export declare class Browser {
35
+ /** The cookies this browser holds. */
36
+ readonly jar: CookieJar;
37
+ /**
38
+ * The page this browser is on, sent as `Origin` — what a surface's CORS
39
+ * and an auth server's trusted origins check, and what a multi-tenant app
40
+ * reads its tenant from. None until {@link Browser.on} gives it one.
41
+ */
42
+ readonly origin?: string;
43
+ /**
44
+ * The address this browser connects from, sent as `x-forwarded-for` the way
45
+ * a proxy in front of the app adds it. Each browser is a different person on
46
+ * a different connection, so what an app keys by client — an auth server's
47
+ * rate limit — counts each on its own. Without it every browser was the same
48
+ * client, and concurrent tests queued on the same rate-limit row of each
49
+ * other's open transactions. A request that sets the header itself — a test
50
+ * that is several machines — keeps its own.
51
+ */
52
+ readonly address: string;
53
+ /**
54
+ * This browser's `fetch`: cookies from the jar on the way out, `Set-Cookie`
55
+ * into the jar on the way back, redirects followed hop by hop so each hop's
56
+ * cookies are kept.
57
+ *
58
+ * On the server side of a test — a handler serving a request — it is the
59
+ * plain `fetch`: a server forwards what it was handed and never reaches into
60
+ * a browser's jar.
61
+ */
62
+ readonly fetch: typeof fetch;
63
+ private readonly send;
64
+ private readonly site?;
65
+ constructor(options?: BrowserOptions);
66
+ /**
67
+ * Open a URL the way clicking a link does: a GET, redirects followed. A
68
+ * path is opened on the page this browser is on.
69
+ */
70
+ visit(url: string | URL): Promise<Response>;
71
+ /**
72
+ * The same person on a tenant's host: this browser — its cookies, its
73
+ * address, its clients — on `https://<slug>.<domain>`, the app's site on
74
+ * every subdomain. Each request it makes says so in `Origin`, as a page on
75
+ * that host would, so a test signs in once and calls the app as two
76
+ * tenants:
77
+ *
78
+ * ```ts
79
+ * await browser.signIn();
80
+ * await browser.on('acme').api.post('/orders', { body });
81
+ * expect(await browser.on('globex').api.get('/orders')).toEqual([]);
82
+ * ```
83
+ */
84
+ on(slug: string): this;
85
+ /** The cookies this browser would send to `url`, as a header value. */
86
+ cookieHeader(url: string | URL): Promise<string>;
87
+ /**
88
+ * Make this browser the global `fetch`, for code that uses the global one —
89
+ * an app's module-level clients. Returns what puts the previous one back.
90
+ */
91
+ install(): () => void;
92
+ /** Read the body once, so a redirect that keeps the method can send it again. */
93
+ private start;
94
+ private request;
95
+ }
96
+ /** A redirect chain longer than any browser follows. */
97
+ export declare class TooManyRedirects extends Error {
98
+ readonly url: string;
99
+ readonly limit: number;
100
+ constructor(url: string, limit: number);
101
+ }
102
+ /** `browser.on(slug)` in an app with no site on every subdomain. */
103
+ export declare class NoWildcardSite extends Error {
104
+ readonly slug: string;
105
+ constructor(slug: string);
106
+ }
107
+ /** `browser.on(slug)` with something no host can start with. */
108
+ export declare class NotATenantSlug extends Error {
109
+ readonly slug: string;
110
+ constructor(slug: string);
111
+ }
112
+ //#endregion
113
+ //# sourceMappingURL=browser.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"browser.d.cts","names":[],"sources":["../src/browser.ts"],"mappings":";;iBA0BiB;;;;;;;EAOhB,eAAe;;;;;EAKf;;;;;EAKA,MAAM;;;;;;EAMN;;;;;;EAMA;;qBAGY;;WAEH,KAAK;;;;;;WAOL;;;;;;;;;;WAWA;;;;;;;;;;WAWA,cAAc;mBAEN;mBACA;EAEjB,YAAY,UAAS;;;;;EAkBrB,MAAM,cAAc,MAAM,QAAQ;;;;;;;;;;;;;;EAmBlC,GAAG;;EAgBH,aAAa,cAAc,MAAM;;;;;EAQjC;;UASc;UAqBA;;;qBAyEF,yBAAyB;WAE3B;WACA;EAFV,YACU,aACA;;;qBAcE,uBAAuB;WACd;EAArB,YAAqB;;;qBAWT,uBAAuB;WACd;EAArB,YAAqB"}
@@ -0,0 +1,113 @@
1
+ import { CookieJar } from "tough-cookie";
2
+ //#region src/browser.d.ts
3
+ export interface BrowserOptions {
4
+ /**
5
+ * The `fetch` requests go out on. Defaults to the global one at the time
6
+ * the browser is created — so a browser made inside a test goes through
7
+ * whatever the test installed (MSW, the context stamp) and never through
8
+ * itself once installed.
9
+ */
10
+ fetch?: typeof fetch;
11
+ /**
12
+ * The address this browser connects from. A fresh one by default, from a
13
+ * private range nothing routes to — see {@link Browser.address}.
14
+ */
15
+ address?: string;
16
+ /**
17
+ * The cookies it starts with — another browser's jar, to be the same
18
+ * person on another tab. A fresh jar by default.
19
+ */
20
+ jar?: CookieJar;
21
+ /**
22
+ * The address of the app's site on every subdomain,
23
+ * `https://*.test.shop.localhost:8443`, which {@link Browser.on} puts a
24
+ * tenant's slug into. A feature test passes it when the app declares one.
25
+ */
26
+ site?: string;
27
+ /**
28
+ * The page this browser is on: sent as `Origin` on every request that does
29
+ * not set its own, and what a relative {@link Browser.visit} resolves
30
+ * against. See {@link Browser.on}.
31
+ */
32
+ origin?: string;
33
+ }
34
+ export declare class Browser {
35
+ /** The cookies this browser holds. */
36
+ readonly jar: CookieJar;
37
+ /**
38
+ * The page this browser is on, sent as `Origin` — what a surface's CORS
39
+ * and an auth server's trusted origins check, and what a multi-tenant app
40
+ * reads its tenant from. None until {@link Browser.on} gives it one.
41
+ */
42
+ readonly origin?: string;
43
+ /**
44
+ * The address this browser connects from, sent as `x-forwarded-for` the way
45
+ * a proxy in front of the app adds it. Each browser is a different person on
46
+ * a different connection, so what an app keys by client — an auth server's
47
+ * rate limit — counts each on its own. Without it every browser was the same
48
+ * client, and concurrent tests queued on the same rate-limit row of each
49
+ * other's open transactions. A request that sets the header itself — a test
50
+ * that is several machines — keeps its own.
51
+ */
52
+ readonly address: string;
53
+ /**
54
+ * This browser's `fetch`: cookies from the jar on the way out, `Set-Cookie`
55
+ * into the jar on the way back, redirects followed hop by hop so each hop's
56
+ * cookies are kept.
57
+ *
58
+ * On the server side of a test — a handler serving a request — it is the
59
+ * plain `fetch`: a server forwards what it was handed and never reaches into
60
+ * a browser's jar.
61
+ */
62
+ readonly fetch: typeof fetch;
63
+ private readonly send;
64
+ private readonly site?;
65
+ constructor(options?: BrowserOptions);
66
+ /**
67
+ * Open a URL the way clicking a link does: a GET, redirects followed. A
68
+ * path is opened on the page this browser is on.
69
+ */
70
+ visit(url: string | URL): Promise<Response>;
71
+ /**
72
+ * The same person on a tenant's host: this browser — its cookies, its
73
+ * address, its clients — on `https://<slug>.<domain>`, the app's site on
74
+ * every subdomain. Each request it makes says so in `Origin`, as a page on
75
+ * that host would, so a test signs in once and calls the app as two
76
+ * tenants:
77
+ *
78
+ * ```ts
79
+ * await browser.signIn();
80
+ * await browser.on('acme').api.post('/orders', { body });
81
+ * expect(await browser.on('globex').api.get('/orders')).toEqual([]);
82
+ * ```
83
+ */
84
+ on(slug: string): this;
85
+ /** The cookies this browser would send to `url`, as a header value. */
86
+ cookieHeader(url: string | URL): Promise<string>;
87
+ /**
88
+ * Make this browser the global `fetch`, for code that uses the global one —
89
+ * an app's module-level clients. Returns what puts the previous one back.
90
+ */
91
+ install(): () => void;
92
+ /** Read the body once, so a redirect that keeps the method can send it again. */
93
+ private start;
94
+ private request;
95
+ }
96
+ /** A redirect chain longer than any browser follows. */
97
+ export declare class TooManyRedirects extends Error {
98
+ readonly url: string;
99
+ readonly limit: number;
100
+ constructor(url: string, limit: number);
101
+ }
102
+ /** `browser.on(slug)` in an app with no site on every subdomain. */
103
+ export declare class NoWildcardSite extends Error {
104
+ readonly slug: string;
105
+ constructor(slug: string);
106
+ }
107
+ /** `browser.on(slug)` with something no host can start with. */
108
+ export declare class NotATenantSlug extends Error {
109
+ readonly slug: string;
110
+ constructor(slug: string);
111
+ }
112
+ //#endregion
113
+ //# sourceMappingURL=browser.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"browser.d.mts","names":[],"sources":["../src/browser.ts"],"mappings":";;iBA0BiB;;;;;;;EAOhB,eAAe;;;;;EAKf;;;;;EAKA,MAAM;;;;;;EAMN;;;;;;EAMA;;qBAGY;;WAEH,KAAK;;;;;;WAOL;;;;;;;;;;WAWA;;;;;;;;;;WAWA,cAAc;mBAEN;mBACA;EAEjB,YAAY,UAAS;;;;;EAkBrB,MAAM,cAAc,MAAM,QAAQ;;;;;;;;;;;;;;EAmBlC,GAAG;;EAgBH,aAAa,cAAc,MAAM;;;;;EAQjC;;UASc;UAqBA;;;qBAyEF,yBAAyB;WAE3B;WACA;EAFV,YACU,aACA;;;qBAcE,uBAAuB;WACd;EAArB,YAAqB;;;qBAWT,uBAAuB;WACd;EAArB,YAAqB"}
@@ -0,0 +1,207 @@
1
+ import { currentTestContext } from "./context.mjs";
2
+ import { randomInt } from "node:crypto";
3
+ import { CookieJar } from "tough-cookie";
4
+ //#region src/browser.ts
5
+ /**
6
+ * A browser, for tests: a `fetch` that keeps cookies the way a browser does.
7
+ *
8
+ * An app's real clients — its typed API client, better-auth's client — run on
9
+ * whatever `fetch` they are given. Give them this one and a test signs in the
10
+ * way a person does: the auth server's `Set-Cookie` lands in the jar, and every
11
+ * later request to a URL the cookie belongs to carries it. The jar follows the
12
+ * browser's rules (RFC 6265 — Domain, Path, Secure, Expires), so a cookie set
13
+ * for the wrong domain is not sent, exactly as a browser would not send it.
14
+ *
15
+ * Extend it once per app with that app's clients:
16
+ *
17
+ * ```ts
18
+ * export class Browser extends TestBrowser {
19
+ * readonly api = createApi({ baseURL: process.env.API_URL, fetch: this.fetch });
20
+ * }
21
+ * ```
22
+ */
23
+ /** How many redirects `fetch` follows before giving up, as browsers do. */
24
+ const MAX_REDIRECTS = 20;
25
+ var Browser = class {
26
+ /** The cookies this browser holds. */
27
+ jar;
28
+ /**
29
+ * The page this browser is on, sent as `Origin` — what a surface's CORS
30
+ * and an auth server's trusted origins check, and what a multi-tenant app
31
+ * reads its tenant from. None until {@link Browser.on} gives it one.
32
+ */
33
+ origin;
34
+ /**
35
+ * The address this browser connects from, sent as `x-forwarded-for` the way
36
+ * a proxy in front of the app adds it. Each browser is a different person on
37
+ * a different connection, so what an app keys by client — an auth server's
38
+ * rate limit — counts each on its own. Without it every browser was the same
39
+ * client, and concurrent tests queued on the same rate-limit row of each
40
+ * other's open transactions. A request that sets the header itself — a test
41
+ * that is several machines — keeps its own.
42
+ */
43
+ address;
44
+ /**
45
+ * This browser's `fetch`: cookies from the jar on the way out, `Set-Cookie`
46
+ * into the jar on the way back, redirects followed hop by hop so each hop's
47
+ * cookies are kept.
48
+ *
49
+ * On the server side of a test — a handler serving a request — it is the
50
+ * plain `fetch`: a server forwards what it was handed and never reaches into
51
+ * a browser's jar.
52
+ */
53
+ fetch;
54
+ send;
55
+ site;
56
+ constructor(options = {}) {
57
+ this.send = options.fetch ?? globalThis.fetch;
58
+ this.address = options.address ?? privateAddress();
59
+ this.jar = options.jar ?? new CookieJar();
60
+ if (options.site) this.site = options.site;
61
+ if (options.origin) this.origin = options.origin;
62
+ this.fetch = (input, init) => {
63
+ if (currentTestContext()?.side === "server") return this.send(input, init);
64
+ return this.start(new Request(input, init), init?.redirect);
65
+ };
66
+ }
67
+ /**
68
+ * Open a URL the way clicking a link does: a GET, redirects followed. A
69
+ * path is opened on the page this browser is on.
70
+ */
71
+ visit(url) {
72
+ return this.fetch(this.origin ? new URL(url, this.origin).toString() : String(url));
73
+ }
74
+ /**
75
+ * The same person on a tenant's host: this browser — its cookies, its
76
+ * address, its clients — on `https://<slug>.<domain>`, the app's site on
77
+ * every subdomain. Each request it makes says so in `Origin`, as a page on
78
+ * that host would, so a test signs in once and calls the app as two
79
+ * tenants:
80
+ *
81
+ * ```ts
82
+ * await browser.signIn();
83
+ * await browser.on('acme').api.post('/orders', { body });
84
+ * expect(await browser.on('globex').api.get('/orders')).toEqual([]);
85
+ * ```
86
+ */
87
+ on(slug) {
88
+ if (!this.site) throw new NoWildcardSite(slug);
89
+ if (!SLUG.test(slug)) throw new NotATenantSlug(slug);
90
+ const origin = new URL(this.site.replace("*", slug)).origin;
91
+ const Same = this.constructor;
92
+ return new Same({
93
+ fetch: this.send,
94
+ address: this.address,
95
+ jar: this.jar,
96
+ site: this.site,
97
+ origin
98
+ });
99
+ }
100
+ /** The cookies this browser would send to `url`, as a header value. */
101
+ cookieHeader(url) {
102
+ return this.jar.getCookieString(String(url));
103
+ }
104
+ /**
105
+ * Make this browser the global `fetch`, for code that uses the global one —
106
+ * an app's module-level clients. Returns what puts the previous one back.
107
+ */
108
+ install() {
109
+ const previous = globalThis.fetch;
110
+ globalThis.fetch = this.fetch;
111
+ return () => {
112
+ globalThis.fetch = previous;
113
+ };
114
+ }
115
+ /** Read the body once, so a redirect that keeps the method can send it again. */
116
+ async start(request, redirect) {
117
+ const body = request.method === "GET" || request.method === "HEAD" ? void 0 : await request.arrayBuffer();
118
+ const headers = new Headers(request.headers);
119
+ if (!headers.has("x-forwarded-for")) headers.set("x-forwarded-for", this.address);
120
+ if (this.origin && !headers.has("origin")) headers.set("origin", this.origin);
121
+ return this.request({
122
+ url: request.url,
123
+ method: request.method,
124
+ headers,
125
+ body
126
+ }, redirect);
127
+ }
128
+ async request(request, redirect, hops = 0) {
129
+ const headers = new Headers(request.headers);
130
+ const cookie = await this.jar.getCookieString(request.url);
131
+ if (cookie) {
132
+ const existing = headers.get("cookie");
133
+ headers.set("cookie", existing ? `${existing}; ${cookie}` : cookie);
134
+ }
135
+ const response = await this.send(request.url, {
136
+ method: request.method,
137
+ headers,
138
+ body: request.body,
139
+ redirect: "manual"
140
+ });
141
+ for (const set of response.headers.getSetCookie()) await this.jar.setCookie(set, request.url, { ignoreError: true });
142
+ const location = response.headers.get("location");
143
+ if (redirect === "manual" || !location || response.status < 300 || response.status >= 400) return response;
144
+ if (hops >= MAX_REDIRECTS) throw new TooManyRedirects(request.url, MAX_REDIRECTS);
145
+ const keepsMethod = response.status === 307 || response.status === 308 || request.method === "GET" || request.method === "HEAD";
146
+ const url = new URL(location, request.url).toString();
147
+ const next = keepsMethod ? {
148
+ ...request,
149
+ url
150
+ } : {
151
+ url,
152
+ method: "GET",
153
+ headers: withoutBody(request.headers)
154
+ };
155
+ return this.request(next, redirect, hops + 1);
156
+ }
157
+ };
158
+ /** Headers for a request that no longer carries the body they described. */
159
+ function withoutBody(headers) {
160
+ const next = new Headers(headers);
161
+ next.delete("content-type");
162
+ next.delete("content-length");
163
+ return next;
164
+ }
165
+ /** A redirect chain longer than any browser follows. */
166
+ var TooManyRedirects = class extends Error {
167
+ url;
168
+ limit;
169
+ constructor(url, limit) {
170
+ super(`${url} redirected more than ${limit} times. A browser gives up here too — look for a redirect loop.`);
171
+ this.url = url;
172
+ this.limit = limit;
173
+ this.name = "TooManyRedirects";
174
+ }
175
+ };
176
+ /** One DNS label, as a tenant's slug is. */
177
+ const SLUG = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/;
178
+ /** `browser.on(slug)` in an app with no site on every subdomain. */
179
+ var NoWildcardSite = class extends Error {
180
+ slug;
181
+ constructor(slug) {
182
+ super(`browser.on('${slug}') puts a tenant's slug into the app's site on every subdomain, and this browser knows of none. Declare a StaticSite with subdomain: '*', or pass its address as \`site\`.`);
183
+ this.slug = slug;
184
+ this.name = "NoWildcardSite";
185
+ }
186
+ };
187
+ /** `browser.on(slug)` with something no host can start with. */
188
+ var NotATenantSlug = class extends Error {
189
+ slug;
190
+ constructor(slug) {
191
+ super(`'${slug}' is not a tenant's slug: one DNS label of lowercase letters, digits and inner hyphens, such as 'acme'.`);
192
+ this.slug = slug;
193
+ this.name = "NotATenantSlug";
194
+ }
195
+ };
196
+ /**
197
+ * An address from 10.0.0.0/8, which nothing routes to. Random rather than
198
+ * counted: test files run in separate workers that share no counter.
199
+ */
200
+ function privateAddress() {
201
+ const n = randomInt(1, 2 ** 24 - 1);
202
+ return `10.${n >> 16 & 255}.${n >> 8 & 255}.${n & 255}`;
203
+ }
204
+ //#endregion
205
+ export { Browser, NoWildcardSite, NotATenantSlug, TooManyRedirects };
206
+
207
+ //# sourceMappingURL=browser.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"browser.mjs","names":[],"sources":["../src/browser.ts"],"sourcesContent":["/**\n * A browser, for tests: a `fetch` that keeps cookies the way a browser does.\n *\n * An app's real clients — its typed API client, better-auth's client — run on\n * whatever `fetch` they are given. Give them this one and a test signs in the\n * way a person does: the auth server's `Set-Cookie` lands in the jar, and every\n * later request to a URL the cookie belongs to carries it. The jar follows the\n * browser's rules (RFC 6265 — Domain, Path, Secure, Expires), so a cookie set\n * for the wrong domain is not sent, exactly as a browser would not send it.\n *\n * Extend it once per app with that app's clients:\n *\n * ```ts\n * export class Browser extends TestBrowser {\n * readonly api = createApi({ baseURL: process.env.API_URL, fetch: this.fetch });\n * }\n * ```\n */\n\nimport { randomInt } from 'node:crypto';\nimport { CookieJar } from 'tough-cookie';\nimport { currentTestContext } from './context';\n\n/** How many redirects `fetch` follows before giving up, as browsers do. */\nconst MAX_REDIRECTS = 20;\n\nexport interface BrowserOptions {\n\t/**\n\t * The `fetch` requests go out on. Defaults to the global one at the time\n\t * the browser is created — so a browser made inside a test goes through\n\t * whatever the test installed (MSW, the context stamp) and never through\n\t * itself once installed.\n\t */\n\tfetch?: typeof fetch;\n\t/**\n\t * The address this browser connects from. A fresh one by default, from a\n\t * private range nothing routes to — see {@link Browser.address}.\n\t */\n\taddress?: string;\n\t/**\n\t * The cookies it starts with — another browser's jar, to be the same\n\t * person on another tab. A fresh jar by default.\n\t */\n\tjar?: CookieJar;\n\t/**\n\t * The address of the app's site on every subdomain,\n\t * `https://*.test.shop.localhost:8443`, which {@link Browser.on} puts a\n\t * tenant's slug into. A feature test passes it when the app declares one.\n\t */\n\tsite?: string;\n\t/**\n\t * The page this browser is on: sent as `Origin` on every request that does\n\t * not set its own, and what a relative {@link Browser.visit} resolves\n\t * against. See {@link Browser.on}.\n\t */\n\torigin?: string;\n}\n\nexport class Browser {\n\t/** The cookies this browser holds. */\n\treadonly jar: CookieJar;\n\n\t/**\n\t * The page this browser is on, sent as `Origin` — what a surface's CORS\n\t * and an auth server's trusted origins check, and what a multi-tenant app\n\t * reads its tenant from. None until {@link Browser.on} gives it one.\n\t */\n\treadonly origin?: string;\n\n\t/**\n\t * The address this browser connects from, sent as `x-forwarded-for` the way\n\t * a proxy in front of the app adds it. Each browser is a different person on\n\t * a different connection, so what an app keys by client — an auth server's\n\t * rate limit — counts each on its own. Without it every browser was the same\n\t * client, and concurrent tests queued on the same rate-limit row of each\n\t * other's open transactions. A request that sets the header itself — a test\n\t * that is several machines — keeps its own.\n\t */\n\treadonly address: string;\n\n\t/**\n\t * This browser's `fetch`: cookies from the jar on the way out, `Set-Cookie`\n\t * into the jar on the way back, redirects followed hop by hop so each hop's\n\t * cookies are kept.\n\t *\n\t * On the server side of a test — a handler serving a request — it is the\n\t * plain `fetch`: a server forwards what it was handed and never reaches into\n\t * a browser's jar.\n\t */\n\treadonly fetch: typeof fetch;\n\n\tprivate readonly send: typeof fetch;\n\tprivate readonly site?: string;\n\n\tconstructor(options: BrowserOptions = {}) {\n\t\tthis.send = options.fetch ?? globalThis.fetch;\n\t\tthis.address = options.address ?? privateAddress();\n\t\tthis.jar = options.jar ?? new CookieJar();\n\t\tif (options.site) this.site = options.site;\n\t\tif (options.origin) this.origin = options.origin;\n\t\tthis.fetch = (input, init) => {\n\t\t\tif (currentTestContext()?.side === 'server') {\n\t\t\t\treturn this.send(input, init);\n\t\t\t}\n\t\t\treturn this.start(new Request(input, init), init?.redirect);\n\t\t};\n\t}\n\n\t/**\n\t * Open a URL the way clicking a link does: a GET, redirects followed. A\n\t * path is opened on the page this browser is on.\n\t */\n\tvisit(url: string | URL): Promise<Response> {\n\t\treturn this.fetch(\n\t\t\tthis.origin ? new URL(url, this.origin).toString() : String(url),\n\t\t);\n\t}\n\n\t/**\n\t * The same person on a tenant's host: this browser — its cookies, its\n\t * address, its clients — on `https://<slug>.<domain>`, the app's site on\n\t * every subdomain. Each request it makes says so in `Origin`, as a page on\n\t * that host would, so a test signs in once and calls the app as two\n\t * tenants:\n\t *\n\t * ```ts\n\t * await browser.signIn();\n\t * await browser.on('acme').api.post('/orders', { body });\n\t * expect(await browser.on('globex').api.get('/orders')).toEqual([]);\n\t * ```\n\t */\n\ton(slug: string): this {\n\t\tif (!this.site) throw new NoWildcardSite(slug);\n\t\tif (!SLUG.test(slug)) throw new NotATenantSlug(slug);\n\n\t\tconst origin = new URL(this.site.replace('*', slug)).origin;\n\t\tconst Same = this.constructor as new (options: BrowserOptions) => this;\n\t\treturn new Same({\n\t\t\tfetch: this.send,\n\t\t\taddress: this.address,\n\t\t\tjar: this.jar,\n\t\t\tsite: this.site,\n\t\t\torigin,\n\t\t});\n\t}\n\n\t/** The cookies this browser would send to `url`, as a header value. */\n\tcookieHeader(url: string | URL): Promise<string> {\n\t\treturn this.jar.getCookieString(String(url));\n\t}\n\n\t/**\n\t * Make this browser the global `fetch`, for code that uses the global one —\n\t * an app's module-level clients. Returns what puts the previous one back.\n\t */\n\tinstall(): () => void {\n\t\tconst previous = globalThis.fetch;\n\t\tglobalThis.fetch = this.fetch;\n\t\treturn () => {\n\t\t\tglobalThis.fetch = previous;\n\t\t};\n\t}\n\n\t/** Read the body once, so a redirect that keeps the method can send it again. */\n\tprivate async start(\n\t\trequest: Request,\n\t\tredirect: RequestInit['redirect'],\n\t): Promise<Response> {\n\t\tconst body =\n\t\t\trequest.method === 'GET' || request.method === 'HEAD'\n\t\t\t\t? undefined\n\t\t\t\t: await request.arrayBuffer();\n\t\tconst headers = new Headers(request.headers);\n\t\tif (!headers.has('x-forwarded-for')) {\n\t\t\theaders.set('x-forwarded-for', this.address);\n\t\t}\n\t\tif (this.origin && !headers.has('origin')) {\n\t\t\theaders.set('origin', this.origin);\n\t\t}\n\t\treturn this.request(\n\t\t\t{ url: request.url, method: request.method, headers, body },\n\t\t\tredirect,\n\t\t);\n\t}\n\n\tprivate async request(\n\t\trequest: Hop,\n\t\tredirect: RequestInit['redirect'],\n\t\thops = 0,\n\t): Promise<Response> {\n\t\tconst headers = new Headers(request.headers);\n\t\tconst cookie = await this.jar.getCookieString(request.url);\n\t\tif (cookie) {\n\t\t\tconst existing = headers.get('cookie');\n\t\t\theaders.set('cookie', existing ? `${existing}; ${cookie}` : cookie);\n\t\t}\n\n\t\tconst response = await this.send(request.url, {\n\t\t\tmethod: request.method,\n\t\t\theaders,\n\t\t\tbody: request.body,\n\t\t\tredirect: 'manual',\n\t\t});\n\n\t\tfor (const set of response.headers.getSetCookie()) {\n\t\t\t// A cookie a browser would refuse — the wrong domain, Secure over\n\t\t\t// plain HTTP — is dropped silently, as a browser drops it.\n\t\t\tawait this.jar.setCookie(set, request.url, { ignoreError: true });\n\t\t}\n\n\t\tconst location = response.headers.get('location');\n\t\tif (\n\t\t\tredirect === 'manual' ||\n\t\t\t!location ||\n\t\t\tresponse.status < 300 ||\n\t\t\tresponse.status >= 400\n\t\t) {\n\t\t\treturn response;\n\t\t}\n\n\t\tif (hops >= MAX_REDIRECTS) {\n\t\t\tthrow new TooManyRedirects(request.url, MAX_REDIRECTS);\n\t\t}\n\n\t\t// 303, and 301/302 after a POST, continue as a GET without a body — what\n\t\t// every browser does, whatever the spec once said about 302.\n\t\tconst keepsMethod =\n\t\t\tresponse.status === 307 ||\n\t\t\tresponse.status === 308 ||\n\t\t\trequest.method === 'GET' ||\n\t\t\trequest.method === 'HEAD';\n\n\t\tconst url = new URL(location, request.url).toString();\n\t\tconst next: Hop = keepsMethod\n\t\t\t? { ...request, url }\n\t\t\t: { url, method: 'GET', headers: withoutBody(request.headers) };\n\n\t\treturn this.request(next, redirect, hops + 1);\n\t}\n}\n\n/** One request in a redirect chain, with its body already read. */\ninterface Hop {\n\turl: string;\n\tmethod: string;\n\theaders: Headers;\n\tbody?: ArrayBuffer;\n}\n\n/** Headers for a request that no longer carries the body they described. */\nfunction withoutBody(headers: Headers): Headers {\n\tconst next = new Headers(headers);\n\tnext.delete('content-type');\n\tnext.delete('content-length');\n\treturn next;\n}\n\n/** A redirect chain longer than any browser follows. */\nexport class TooManyRedirects extends Error {\n\tconstructor(\n\t\treadonly url: string,\n\t\treadonly limit: number,\n\t) {\n\t\tsuper(\n\t\t\t`${url} redirected more than ${limit} times. A browser gives up here ` +\n\t\t\t\t`too — look for a redirect loop.`,\n\t\t);\n\t\tthis.name = 'TooManyRedirects';\n\t}\n}\n\n/** One DNS label, as a tenant's slug is. */\nconst SLUG = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/;\n\n/** `browser.on(slug)` in an app with no site on every subdomain. */\nexport class NoWildcardSite extends Error {\n\tconstructor(readonly slug: string) {\n\t\tsuper(\n\t\t\t`browser.on('${slug}') puts a tenant's slug into the app's site on ` +\n\t\t\t\t`every subdomain, and this browser knows of none. Declare a ` +\n\t\t\t\t`StaticSite with subdomain: '*', or pass its address as \\`site\\`.`,\n\t\t);\n\t\tthis.name = 'NoWildcardSite';\n\t}\n}\n\n/** `browser.on(slug)` with something no host can start with. */\nexport class NotATenantSlug extends Error {\n\tconstructor(readonly slug: string) {\n\t\tsuper(\n\t\t\t`'${slug}' is not a tenant's slug: one DNS label of lowercase ` +\n\t\t\t\t`letters, digits and inner hyphens, such as 'acme'.`,\n\t\t);\n\t\tthis.name = 'NotATenantSlug';\n\t}\n}\n\n/**\n * An address from 10.0.0.0/8, which nothing routes to. Random rather than\n * counted: test files run in separate workers that share no counter.\n */\nfunction privateAddress(): string {\n\tconst n = randomInt(1, 2 ** 24 - 1);\n\treturn `10.${(n >> 16) & 255}.${(n >> 8) & 255}.${n & 255}`;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAwBA,MAAM,gBAAgB;AAkCtB,IAAa,UAAb,MAAqB;;CAEpB;;;;;;CAOA;;;;;;;;;;CAWA;;;;;;;;;;CAWA;CAEA;CACA;CAEA,YAAY,UAA0B,CAAC,GAAG;EACzC,KAAK,OAAO,QAAQ,SAAS,WAAW;EACxC,KAAK,UAAU,QAAQ,WAAW,eAAe;EACjD,KAAK,MAAM,QAAQ,OAAO,IAAI,UAAU;EACxC,IAAI,QAAQ,MAAM,KAAK,OAAO,QAAQ;EACtC,IAAI,QAAQ,QAAQ,KAAK,SAAS,QAAQ;EAC1C,KAAK,SAAS,OAAO,SAAS;GAC7B,IAAI,mBAAmB,CAAC,EAAE,SAAS,UAClC,OAAO,KAAK,KAAK,OAAO,IAAI;GAE7B,OAAO,KAAK,MAAM,IAAI,QAAQ,OAAO,IAAI,GAAG,MAAM,QAAQ;EAC3D;CACD;;;;;CAMA,MAAM,KAAsC;EAC3C,OAAO,KAAK,MACX,KAAK,SAAS,IAAI,IAAI,KAAK,KAAK,MAAM,CAAC,CAAC,SAAS,IAAI,OAAO,GAAG,CAChE;CACD;;;;;;;;;;;;;;CAeA,GAAG,MAAoB;EACtB,IAAI,CAAC,KAAK,MAAM,MAAM,IAAI,eAAe,IAAI;EAC7C,IAAI,CAAC,KAAK,KAAK,IAAI,GAAG,MAAM,IAAI,eAAe,IAAI;EAEnD,MAAM,SAAS,IAAI,IAAI,KAAK,KAAK,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC;EACrD,MAAM,OAAO,KAAK;EAClB,OAAO,IAAI,KAAK;GACf,OAAO,KAAK;GACZ,SAAS,KAAK;GACd,KAAK,KAAK;GACV,MAAM,KAAK;GACX;EACD,CAAC;CACF;;CAGA,aAAa,KAAoC;EAChD,OAAO,KAAK,IAAI,gBAAgB,OAAO,GAAG,CAAC;CAC5C;;;;;CAMA,UAAsB;EACrB,MAAM,WAAW,WAAW;EAC5B,WAAW,QAAQ,KAAK;EACxB,aAAa;GACZ,WAAW,QAAQ;EACpB;CACD;;CAGA,MAAc,MACb,SACA,UACoB;EACpB,MAAM,OACL,QAAQ,WAAW,SAAS,QAAQ,WAAW,SAC5C,KAAA,IACA,MAAM,QAAQ,YAAY;EAC9B,MAAM,UAAU,IAAI,QAAQ,QAAQ,OAAO;EAC3C,IAAI,CAAC,QAAQ,IAAI,iBAAiB,GACjC,QAAQ,IAAI,mBAAmB,KAAK,OAAO;EAE5C,IAAI,KAAK,UAAU,CAAC,QAAQ,IAAI,QAAQ,GACvC,QAAQ,IAAI,UAAU,KAAK,MAAM;EAElC,OAAO,KAAK,QACX;GAAE,KAAK,QAAQ;GAAK,QAAQ,QAAQ;GAAQ;GAAS;EAAK,GAC1D,QACD;CACD;CAEA,MAAc,QACb,SACA,UACA,OAAO,GACa;EACpB,MAAM,UAAU,IAAI,QAAQ,QAAQ,OAAO;EAC3C,MAAM,SAAS,MAAM,KAAK,IAAI,gBAAgB,QAAQ,GAAG;EACzD,IAAI,QAAQ;GACX,MAAM,WAAW,QAAQ,IAAI,QAAQ;GACrC,QAAQ,IAAI,UAAU,WAAW,GAAG,SAAS,IAAI,WAAW,MAAM;EACnE;EAEA,MAAM,WAAW,MAAM,KAAK,KAAK,QAAQ,KAAK;GAC7C,QAAQ,QAAQ;GAChB;GACA,MAAM,QAAQ;GACd,UAAU;EACX,CAAC;EAED,KAAK,MAAM,OAAO,SAAS,QAAQ,aAAa,GAG/C,MAAM,KAAK,IAAI,UAAU,KAAK,QAAQ,KAAK,EAAE,aAAa,KAAK,CAAC;EAGjE,MAAM,WAAW,SAAS,QAAQ,IAAI,UAAU;EAChD,IACC,aAAa,YACb,CAAC,YACD,SAAS,SAAS,OAClB,SAAS,UAAU,KAEnB,OAAO;EAGR,IAAI,QAAQ,eACX,MAAM,IAAI,iBAAiB,QAAQ,KAAK,aAAa;EAKtD,MAAM,cACL,SAAS,WAAW,OACpB,SAAS,WAAW,OACpB,QAAQ,WAAW,SACnB,QAAQ,WAAW;EAEpB,MAAM,MAAM,IAAI,IAAI,UAAU,QAAQ,GAAG,CAAC,CAAC,SAAS;EACpD,MAAM,OAAY,cACf;GAAE,GAAG;GAAS;EAAI,IAClB;GAAE;GAAK,QAAQ;GAAO,SAAS,YAAY,QAAQ,OAAO;EAAE;EAE/D,OAAO,KAAK,QAAQ,MAAM,UAAU,OAAO,CAAC;CAC7C;AACD;;AAWA,SAAS,YAAY,SAA2B;CAC/C,MAAM,OAAO,IAAI,QAAQ,OAAO;CAChC,KAAK,OAAO,cAAc;CAC1B,KAAK,OAAO,gBAAgB;CAC5B,OAAO;AACR;;AAGA,IAAa,mBAAb,cAAsC,MAAM;CAEjC;CACA;CAFV,YACC,KACA,OACC;EACD,MACC,GAAG,IAAI,wBAAwB,MAAM,gEAEtC;EANS,KAAA,MAAA;EACA,KAAA,QAAA;EAMT,KAAK,OAAO;CACb;AACD;;AAGA,MAAM,OAAO;;AAGb,IAAa,iBAAb,cAAoC,MAAM;CACpB;CAArB,YAAY,MAAuB;EAClC,MACC,eAAe,KAAK,2KAGrB;EALoB,KAAA,OAAA;EAMpB,KAAK,OAAO;CACb;AACD;;AAGA,IAAa,iBAAb,cAAoC,MAAM;CACpB;CAArB,YAAY,MAAuB;EAClC,MACC,IAAI,KAAK,wGAEV;EAJoB,KAAA,OAAA;EAKpB,KAAK,OAAO;CACb;AACD;;;;;AAMA,SAAS,iBAAyB;CACjC,MAAM,IAAI,UAAU,GAAG,KAAK,KAAK,CAAC;CAClC,OAAO,MAAO,KAAK,KAAM,IAAI,GAAI,KAAK,IAAK,IAAI,GAAG,IAAI;AACvD"}
@@ -0,0 +1,80 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
+ let node_async_hooks = require("node:async_hooks");
3
+ //#region src/context.ts
4
+ /**
5
+ * The test a request belongs to.
6
+ *
7
+ * A feature test drives an app the way it runs deployed: a browser calls the
8
+ * API, the API calls the auth server, each over a URL. In a test those URLs are
9
+ * served in-process, and every request made on behalf of one test has to reach
10
+ * *that test's* transactions — its own call to the API, and the API's call to
11
+ * the auth server made while handling it.
12
+ *
13
+ * The id travels two ways. In-process, an `AsyncLocalStorage` carries it
14
+ * through every await a test and its handlers make. On the wire it is the
15
+ * `x-test-context-id` header, which a stamped `fetch` adds to every request made
16
+ * inside a context, so whatever serves the URL can find the context again —
17
+ * without any caller, including code under test, writing the header.
18
+ */
19
+ /** The header a test context travels in between client and server. */
20
+ const TEST_CONTEXT_HEADER = "x-test-context-id";
21
+ const storage = new node_async_hooks.AsyncLocalStorage();
22
+ /** The context the running code belongs to, if any. */
23
+ function currentTestContext() {
24
+ return storage.getStore();
25
+ }
26
+ /** Run `fn` as the client side of the test `id`. */
27
+ function runInTestContext(id, fn) {
28
+ return storage.run({
29
+ id,
30
+ side: "client"
31
+ }, fn);
32
+ }
33
+ /**
34
+ * Run `fn` as a server handling a request for the test `id` — what whatever
35
+ * serves a URL in-process wraps each request in.
36
+ */
37
+ function runAsServer(id, fn) {
38
+ return storage.run({
39
+ id,
40
+ side: "server"
41
+ }, fn);
42
+ }
43
+ /** The test a request was made for, read off its header. */
44
+ function testContextOf(request) {
45
+ return request.headers.get("x-test-context-id") ?? void 0;
46
+ }
47
+ /** `fetch`, adding the current test's id to every request made inside one. */
48
+ function stampedFetch(inner) {
49
+ return (input, init) => {
50
+ const context = currentTestContext();
51
+ if (!context) return inner(input, init);
52
+ const request = new Request(input, init);
53
+ if (!request.headers.has("x-test-context-id")) request.headers.set(TEST_CONTEXT_HEADER, context.id);
54
+ return inner(request);
55
+ };
56
+ }
57
+ /**
58
+ * Stamp the global `fetch` with the current test's id.
59
+ *
60
+ * Install it after anything else that patches `fetch` — MSW's interceptor in
61
+ * particular — so the stamp is added before the request is intercepted.
62
+ * Returns what puts the previous `fetch` back.
63
+ */
64
+ function installContextFetch() {
65
+ const previous = globalThis.fetch;
66
+ globalThis.fetch = stampedFetch(previous);
67
+ return () => {
68
+ globalThis.fetch = previous;
69
+ };
70
+ }
71
+ //#endregion
72
+ exports.TEST_CONTEXT_HEADER = TEST_CONTEXT_HEADER;
73
+ exports.currentTestContext = currentTestContext;
74
+ exports.installContextFetch = installContextFetch;
75
+ exports.runAsServer = runAsServer;
76
+ exports.runInTestContext = runInTestContext;
77
+ exports.stampedFetch = stampedFetch;
78
+ exports.testContextOf = testContextOf;
79
+
80
+ //# sourceMappingURL=context.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.cjs","names":["AsyncLocalStorage"],"sources":["../src/context.ts"],"sourcesContent":["/**\n * The test a request belongs to.\n *\n * A feature test drives an app the way it runs deployed: a browser calls the\n * API, the API calls the auth server, each over a URL. In a test those URLs are\n * served in-process, and every request made on behalf of one test has to reach\n * *that test's* transactions — its own call to the API, and the API's call to\n * the auth server made while handling it.\n *\n * The id travels two ways. In-process, an `AsyncLocalStorage` carries it\n * through every await a test and its handlers make. On the wire it is the\n * `x-test-context-id` header, which a stamped `fetch` adds to every request made\n * inside a context, so whatever serves the URL can find the context again —\n * without any caller, including code under test, writing the header.\n */\n\nimport { AsyncLocalStorage } from 'node:async_hooks';\n\n/** The header a test context travels in between client and server. */\nexport const TEST_CONTEXT_HEADER = 'x-test-context-id';\n\n/**\n * Which side of a URL the running code is on.\n *\n * `client` is the test itself and the frontend it renders — what a browser\n * does. `server` is a handler serving a request. The difference matters for\n * cookies: a browser attaches its cookies to what it sends, a server forwards\n * only what it was handed. A server call that picked up the browser's cookies\n * would hide the bug of a server that forgets to forward them.\n */\nexport type TestSide = 'client' | 'server';\n\nexport interface TestContext {\n\treadonly id: string;\n\treadonly side: TestSide;\n}\n\nconst storage = new AsyncLocalStorage<TestContext>();\n\n/** The context the running code belongs to, if any. */\nexport function currentTestContext(): TestContext | undefined {\n\treturn storage.getStore();\n}\n\n/** Run `fn` as the client side of the test `id`. */\nexport function runInTestContext<T>(id: string, fn: () => T): T {\n\treturn storage.run({ id, side: 'client' }, fn);\n}\n\n/**\n * Run `fn` as a server handling a request for the test `id` — what whatever\n * serves a URL in-process wraps each request in.\n */\nexport function runAsServer<T>(id: string, fn: () => T): T {\n\treturn storage.run({ id, side: 'server' }, fn);\n}\n\n/** The test a request was made for, read off its header. */\nexport function testContextOf(request: Request): string | undefined {\n\treturn request.headers.get(TEST_CONTEXT_HEADER) ?? undefined;\n}\n\n/** `fetch`, adding the current test's id to every request made inside one. */\nexport function stampedFetch(inner: typeof fetch): typeof fetch {\n\treturn (input, init) => {\n\t\tconst context = currentTestContext();\n\t\tif (!context) return inner(input, init);\n\n\t\tconst request = new Request(input, init);\n\t\tif (!request.headers.has(TEST_CONTEXT_HEADER)) {\n\t\t\trequest.headers.set(TEST_CONTEXT_HEADER, context.id);\n\t\t}\n\t\treturn inner(request);\n\t};\n}\n\n/**\n * Stamp the global `fetch` with the current test's id.\n *\n * Install it after anything else that patches `fetch` — MSW's interceptor in\n * particular — so the stamp is added before the request is intercepted.\n * Returns what puts the previous `fetch` back.\n */\nexport function installContextFetch(): () => void {\n\tconst previous = globalThis.fetch;\n\tglobalThis.fetch = stampedFetch(previous);\n\treturn () => {\n\t\tglobalThis.fetch = previous;\n\t};\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAmBA,MAAa,sBAAsB;AAkBnC,MAAM,UAAU,IAAIA,iBAAAA,kBAA+B;;AAGnD,SAAgB,qBAA8C;CAC7D,OAAO,QAAQ,SAAS;AACzB;;AAGA,SAAgB,iBAAoB,IAAY,IAAgB;CAC/D,OAAO,QAAQ,IAAI;EAAE;EAAI,MAAM;CAAS,GAAG,EAAE;AAC9C;;;;;AAMA,SAAgB,YAAe,IAAY,IAAgB;CAC1D,OAAO,QAAQ,IAAI;EAAE;EAAI,MAAM;CAAS,GAAG,EAAE;AAC9C;;AAGA,SAAgB,cAAc,SAAsC;CACnE,OAAO,QAAQ,QAAQ,IAAA,mBAAuB,KAAK,KAAA;AACpD;;AAGA,SAAgB,aAAa,OAAmC;CAC/D,QAAQ,OAAO,SAAS;EACvB,MAAM,UAAU,mBAAmB;EACnC,IAAI,CAAC,SAAS,OAAO,MAAM,OAAO,IAAI;EAEtC,MAAM,UAAU,IAAI,QAAQ,OAAO,IAAI;EACvC,IAAI,CAAC,QAAQ,QAAQ,IAAA,mBAAuB,GAC3C,QAAQ,QAAQ,IAAI,qBAAqB,QAAQ,EAAE;EAEpD,OAAO,MAAM,OAAO;CACrB;AACD;;;;;;;;AASA,SAAgB,sBAAkC;CACjD,MAAM,WAAW,WAAW;CAC5B,WAAW,QAAQ,aAAa,QAAQ;CACxC,aAAa;EACZ,WAAW,QAAQ;CACpB;AACD"}
@@ -0,0 +1,55 @@
1
+ //#region src/context.d.ts
2
+ /**
3
+ * The test a request belongs to.
4
+ *
5
+ * A feature test drives an app the way it runs deployed: a browser calls the
6
+ * API, the API calls the auth server, each over a URL. In a test those URLs are
7
+ * served in-process, and every request made on behalf of one test has to reach
8
+ * *that test's* transactions — its own call to the API, and the API's call to
9
+ * the auth server made while handling it.
10
+ *
11
+ * The id travels two ways. In-process, an `AsyncLocalStorage` carries it
12
+ * through every await a test and its handlers make. On the wire it is the
13
+ * `x-test-context-id` header, which a stamped `fetch` adds to every request made
14
+ * inside a context, so whatever serves the URL can find the context again —
15
+ * without any caller, including code under test, writing the header.
16
+ */
17
+ /** The header a test context travels in between client and server. */
18
+ export declare const TEST_CONTEXT_HEADER = "x-test-context-id";
19
+ /**
20
+ * Which side of a URL the running code is on.
21
+ *
22
+ * `client` is the test itself and the frontend it renders — what a browser
23
+ * does. `server` is a handler serving a request. The difference matters for
24
+ * cookies: a browser attaches its cookies to what it sends, a server forwards
25
+ * only what it was handed. A server call that picked up the browser's cookies
26
+ * would hide the bug of a server that forgets to forward them.
27
+ */
28
+ export type TestSide = 'client' | 'server';
29
+ export interface TestContext {
30
+ readonly id: string;
31
+ readonly side: TestSide;
32
+ }
33
+ /** The context the running code belongs to, if any. */
34
+ export declare function currentTestContext(): TestContext | undefined;
35
+ /** Run `fn` as the client side of the test `id`. */
36
+ export declare function runInTestContext<T>(id: string, fn: () => T): T;
37
+ /**
38
+ * Run `fn` as a server handling a request for the test `id` — what whatever
39
+ * serves a URL in-process wraps each request in.
40
+ */
41
+ export declare function runAsServer<T>(id: string, fn: () => T): T;
42
+ /** The test a request was made for, read off its header. */
43
+ export declare function testContextOf(request: Request): string | undefined;
44
+ /** `fetch`, adding the current test's id to every request made inside one. */
45
+ export declare function stampedFetch(inner: typeof fetch): typeof fetch;
46
+ /**
47
+ * Stamp the global `fetch` with the current test's id.
48
+ *
49
+ * Install it after anything else that patches `fetch` — MSW's interceptor in
50
+ * particular — so the stamp is added before the request is intercepted.
51
+ * Returns what puts the previous `fetch` back.
52
+ */
53
+ export declare function installContextFetch(): () => void;
54
+ //#endregion
55
+ //# sourceMappingURL=context.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.d.cts","names":[],"sources":["../src/context.ts"],"mappings":";;;;;;;;;;;;;;;;;qBAmBa;;;;;;;;;;YAWD;iBAEK;WACP;WACA,MAAM;;;wBAMA,sBAAsB;;wBAKtB,iBAAiB,GAAG,YAAY,UAAU,IAAI;;;;;wBAQ9C,YAAY,GAAG,YAAY,UAAU,IAAI;;wBAKzC,cAAc,SAAS;;wBAKvB,aAAa,cAAc,eAAe;;;;;;;;wBAoB1C"}