@sigil-dev/grimoire 0.9.28 → 0.9.30

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 (105) hide show
  1. package/bin/sigil.ts +4 -0
  2. package/index.ts +16 -10
  3. package/package.json +14 -6
  4. package/server.ts +2 -2
  5. package/src/adapters/bun.ts +17 -17
  6. package/src/adapters/static.ts +41 -41
  7. package/src/adapters/types.ts +36 -36
  8. package/src/base.ts +4 -1
  9. package/src/client/csrf.ts +47 -47
  10. package/src/client/deferred.ts +1 -4
  11. package/src/client/enhance.ts +160 -160
  12. package/src/client/router.ts +927 -926
  13. package/src/config-file.ts +84 -0
  14. package/src/dev/compile-module.ts +199 -193
  15. package/src/dev/hmr-client.ts +229 -229
  16. package/src/dev/hmr-server.ts +274 -266
  17. package/src/dev/loader.ts +144 -144
  18. package/src/dev/runtime-bundle.ts +5 -3
  19. package/src/duration.ts +46 -0
  20. package/src/env/modules.ts +62 -62
  21. package/src/env/required.ts +42 -42
  22. package/src/env/typegen.ts +61 -61
  23. package/src/headers.ts +105 -105
  24. package/src/logger/transports.ts +117 -117
  25. package/src/plugin-order.ts +88 -0
  26. package/src/rendering/head.ts +49 -49
  27. package/src/rendering/hydrate.ts +162 -162
  28. package/src/rendering/images.ts +43 -43
  29. package/src/rendering/preload.ts +22 -8
  30. package/src/rendering/ssrPlugin.ts +107 -107
  31. package/src/rendering/timing.ts +40 -40
  32. package/src/routing/route-ids.ts +65 -0
  33. package/src/routing/route.ts +65 -0
  34. package/src/routing/router.ts +84 -32
  35. package/src/routing/scanner.ts +18 -5
  36. package/src/routing/transform-routes.ts +102 -102
  37. package/src/server/after-response.ts +206 -206
  38. package/src/server/asset-cache.ts +57 -57
  39. package/src/server/build.ts +304 -295
  40. package/src/server/cached.ts +114 -114
  41. package/src/server/client-address.ts +82 -82
  42. package/src/server/client-dir.ts +63 -63
  43. package/src/server/client-entry.ts +44 -44
  44. package/src/server/context.ts +18 -10
  45. package/src/server/cookie-utils.ts +80 -80
  46. package/src/server/coordinator.ts +476 -476
  47. package/src/server/hooks.ts +122 -122
  48. package/src/server/index.ts +8 -0
  49. package/src/server/plugins.ts +172 -172
  50. package/src/server/prerender.ts +473 -473
  51. package/src/server/reserved.ts +17 -17
  52. package/src/server/resolver.ts +149 -123
  53. package/src/server/rewrite.ts +28 -28
  54. package/src/server/warm.ts +9 -3
  55. package/src/server/with-headers.ts +27 -27
  56. package/src/server/worker.ts +2 -6
  57. package/src/server-only.ts +78 -0
  58. package/src/testing/dom.ts +73 -73
  59. package/src/testing/index.ts +169 -169
  60. package/src/testing/server.ts +1 -0
  61. package/src/typegen/index.ts +97 -2
  62. package/src/types.ts +140 -19
  63. package/test/after-response.test.ts +132 -132
  64. package/test/asset-cache-policy.test.ts +6 -2
  65. package/test/base.test.ts +20 -6
  66. package/test/cached.test.ts +126 -126
  67. package/test/client-address.test.ts +78 -78
  68. package/test/client-csrf.test.ts +61 -61
  69. package/test/client-dir.test.ts +101 -101
  70. package/test/client-router.test.ts +37 -5
  71. package/test/config-file.test.ts +84 -0
  72. package/test/coordinator.test.ts +9 -2
  73. package/test/deferred.test.ts +4 -2
  74. package/test/dev-loader.test.ts +30 -30
  75. package/test/env.test.ts +171 -171
  76. package/test/force-production.test.ts +7 -2
  77. package/test/images.test.ts +20 -8
  78. package/test/locals-header.test.ts +61 -61
  79. package/test/middleware.test.ts +243 -243
  80. package/test/parser-plugins.test.ts +98 -92
  81. package/test/plugin-handle.test.ts +62 -62
  82. package/test/plugin-order.test.ts +98 -0
  83. package/test/plugin-routes.test.ts +47 -42
  84. package/test/plugin-services-context.test.ts +7 -2
  85. package/test/preload.test.ts +4 -1
  86. package/test/prerender.test.ts +3 -1
  87. package/test/rendering.test.ts +3 -2
  88. package/test/required-env.test.ts +32 -32
  89. package/test/resolver-windows.test.ts +22 -23
  90. package/test/rewrite-html.test.ts +90 -90
  91. package/test/route-group-layouts.test.ts +38 -36
  92. package/test/route.test.ts +103 -0
  93. package/test/routing.test.ts +225 -197
  94. package/test/scanning.test.ts +53 -33
  95. package/test/server-context.test.ts +22 -0
  96. package/test/server-only.test.ts +110 -0
  97. package/test/server.test.ts +640 -640
  98. package/test/services.test.ts +3 -3
  99. package/test/streaming.test.ts +11 -6
  100. package/test/testing-helpers.test.ts +166 -166
  101. package/test/typegen.test.ts +209 -112
  102. package/test/warm.test.ts +96 -96
  103. package/test/worker-context.test.ts +59 -59
  104. package/test/workspace-files.test.ts +26 -10
  105. package/test/workspace-versions.test.ts +146 -131
@@ -76,9 +76,9 @@ describe("collectServices", () => {
76
76
  const bad = plugin("bad", () => {
77
77
  throw new Error("no database");
78
78
  });
79
- expect(collectServices([plugin("a", () => ({ ok: 1 })), bad])).rejects.toThrow(
80
- "no database",
81
- );
79
+ expect(
80
+ collectServices([plugin("a", () => ({ ok: 1 })), bad]),
81
+ ).rejects.toThrow("no database");
82
82
  });
83
83
 
84
84
  test("preserves falsy values that are real values", async () => {
@@ -5,9 +5,12 @@ import { join } from "node:path";
5
5
  import { renderRoute } from "../src/rendering";
6
6
  import { matchRoute } from "../src/routing/router";
7
7
  import { scanRoutes } from "../src/routing/scanner";
8
-
9
- // An absolute path, because the fixture lives in a temp dir outside the package.
10
- const DEFERRED_SRC = join(import.meta.dir, "../src/client/deferred.ts").replaceAll("\\", "/");
8
+
9
+ // An absolute path, because the fixture lives in a temp dir outside the package.
10
+ const DEFERRED_SRC = join(
11
+ import.meta.dir,
12
+ "../src/client/deferred.ts",
13
+ ).replaceAll("\\", "/");
11
14
 
12
15
  function makeMatched(path: string, filePath: string, params = {}) {
13
16
  return {
@@ -269,7 +272,7 @@ describe("streamed promises (deferred data)", () => {
269
272
  await writeFile(join(dir, "+page.server.ts"), serverSrc);
270
273
  await writeFile(
271
274
  join(dir, "+page.tsx"),
272
- "export default function P({ data }) { return <div>{data.fast}{String(data.slow)}{String(data.boom)}{data.slow === undefined ? \"[pending]\" : \"\"}</div>; }",
275
+ 'export default function P({ data }) { return <div>{data.fast}{String(data.slow)}{String(data.boom)}{data.slow === undefined ? "[pending]" : ""}</div>; }',
273
276
  );
274
277
  const tree = await scanRoutes(dir);
275
278
  const matched = matchRoute(tree, new URL("http://localhost/"));
@@ -356,7 +359,7 @@ describe("streamed promises (deferred data)", () => {
356
359
  " return (",
357
360
  " <div>",
358
361
  " <h1>{data.title}</h1>",
359
- " {reviews.done ? reviews.value.join() : \"[pending]\"}",
362
+ ' {reviews.done ? reviews.value.join() : "[pending]"}',
360
363
  " </div>",
361
364
  " );",
362
365
  "}",
@@ -364,7 +367,9 @@ describe("streamed promises (deferred data)", () => {
364
367
  );
365
368
  const tree = await scanRoutes(dir);
366
369
  const matched = matchRoute(tree, new URL("http://localhost/"));
367
- const chunks = await readChunks(await renderRoute(matched!, new Request("http://localhost/")));
370
+ const chunks = await readChunks(
371
+ await renderRoute(matched!, new Request("http://localhost/")),
372
+ );
368
373
 
369
374
  // The shell goes out first, with the fallback rendered.
370
375
  const shell = chunks.find((c) => c.includes("__grimoire_state__"))!;
@@ -1,166 +1,166 @@
1
- import { afterAll, beforeAll, describe, expect, test } from "bun:test";
2
- import { mkdir, rm, writeFile } from "node:fs/promises";
3
- import { tmpdir } from "node:os";
4
- import { join } from "node:path";
5
- import { transformSync } from "@babel/core";
6
- import sigilPlugin from "../../compiler/src/babel/index.ts";
7
- import * as runtime from "../../runtime/index.ts";
8
- import {
9
- cleanup,
10
- click,
11
- context,
12
- render,
13
- tick,
14
- type,
15
- } from "../src/testing/index.ts";
16
- import { createTestApp, type TestApp } from "../src/testing/server.ts";
17
-
18
- /** A component compiled for the browser, as the DOM preload would give a test. */
19
- function component(source: string): (props: any) => unknown {
20
- const code = transformSync(source, {
21
- plugins: ["@babel/plugin-syntax-jsx", [sigilPlugin, { mode: "dom" }]],
22
- filename: "c.tsx",
23
- })!.code!;
24
- const body = code
25
- .replace(/import\s*\{[^}]*\}\s*from\s*["']@sigil-dev\/runtime["'];?/g, "")
26
- .replace(/^export\s+/gm, "");
27
- return new Function(
28
- "document",
29
- ...Object.keys(runtime),
30
- `${body};\nreturn Comp;`,
31
- )(globalThis.document, ...Object.values(runtime));
32
- }
33
-
34
- describe("render", () => {
35
- const Counter = component(`
36
- const Comp = (props) => {
37
- let n = $state(props.start ?? 0);
38
- return <div><button onClick={() => n++}>{n}</button><input id="i" /></div>;
39
- };
40
- `);
41
-
42
- test("mounts with props, and updates after an event and a tick", async () => {
43
- const r = render(Counter, { start: 5 });
44
- expect(r.text()).toBe("5");
45
- click(r.$("button")!);
46
- await tick();
47
- expect(r.text()).toBe("6");
48
- expect(r.$$("button")).toHaveLength(1);
49
- expect(r.html()).toContain("<button>6</button>");
50
- });
51
-
52
- test("type() sets the value and fires input", () => {
53
- const r = render(Counter);
54
- let seen = "";
55
- r.$("#i")!.addEventListener("input", (e) => {
56
- seen = (e.target as HTMLInputElement).value;
57
- });
58
- type(r.$("#i")!, "hello");
59
- expect(seen).toBe("hello");
60
- });
61
-
62
- test("unmount and cleanup remove it and stop its effects", async () => {
63
- const a = render(Counter);
64
- const b = render(Counter);
65
- expect(document.body.contains(a.container)).toBe(true);
66
- a.unmount();
67
- expect(document.body.contains(a.container)).toBe(false);
68
- expect(document.body.contains(b.container)).toBe(true);
69
- cleanup();
70
- expect(document.body.contains(b.container)).toBe(false);
71
- });
72
- });
73
-
74
- describe("context", () => {
75
- test("params, url, locals and a form body", async () => {
76
- const ctx = context({
77
- params: { id: "7" },
78
- url: "/books/7?x=1",
79
- form: { title: "Dune" },
80
- locals: { user: "ada" } as never,
81
- });
82
- expect(ctx.params.id).toBe("7");
83
- expect(ctx.url.searchParams.get("x")).toBe("1");
84
- expect(ctx.request.method).toBe("POST");
85
- expect((await ctx.request.formData()).get("title")).toBe("Dune");
86
- expect((ctx.locals as { user: string }).user).toBe("ada");
87
- expect(await ctx.parent()).toEqual({});
88
- });
89
-
90
- test("json bodies, and cookies in and out", async () => {
91
- const ctx = context({ json: { a: 1 }, cookies: { session: "abc" } });
92
- expect(await ctx.request.json()).toEqual({ a: 1 });
93
- expect(ctx.cookies.get("session")).toBe("abc");
94
- ctx.cookies.set("seen", "yes");
95
- expect(ctx.cookies.toHeaders()[0]).toContain("seen=yes");
96
- });
97
-
98
- test("a GET by default, and the method can be set", () => {
99
- expect(context().request.method).toBe("GET");
100
- expect(context({ method: "DELETE" }).request.method).toBe("DELETE");
101
- });
102
- });
103
-
104
- describe("createTestApp", () => {
105
- let dir: string;
106
- let app: TestApp;
107
-
108
- beforeAll(async () => {
109
- dir = join(tmpdir(), `grimoire-testapp-${Date.now()}`);
110
- await mkdir(join(dir, "api"), { recursive: true });
111
- await mkdir(join(dir, "form"), { recursive: true });
112
- await writeFile(
113
- join(dir, "api", "+server.ts"),
114
- "export const GET = () => Response.json({ ok: true });\nexport const POST = async ({ request }) => Response.json(await request.json());",
115
- );
116
- await writeFile(
117
- join(dir, "form", "+page.tsx"),
118
- `export default () => '<form method="post"></form>';`,
119
- );
120
- await writeFile(
121
- join(dir, "form", "+page.server.ts"),
122
- [
123
- "export async function create({ request, cookies }) {",
124
- " const f = await request.formData();",
125
- ' cookies.set("made", String(f.get("title")));',
126
- ' return { redirect: "/done" };',
127
- "}",
128
- ].join("\n"),
129
- );
130
- app = await createTestApp({ routes: dir }, { root: dir });
131
- });
132
- afterAll(async () => {
133
- await app.close();
134
- await rm(dir, { recursive: true, force: true });
135
- });
136
-
137
- test("get and json go through the real pipeline", async () => {
138
- const res = await app.get("/api");
139
- expect(res.status).toBe(200);
140
- expect(await res.json()).toEqual({ ok: true });
141
- const echoed = await app.json("/api", { hello: "there" });
142
- expect(await echoed.json()).toEqual({ hello: "there" });
143
- });
144
-
145
- test("an unknown path is a 404", async () => {
146
- expect((await app.get("/nowhere")).status).toBe(404);
147
- });
148
-
149
- test("submit handles the CSRF token, returns the redirect and keeps the cookies", async () => {
150
- const res = await app.submit("/form?/create", { title: "Dune" });
151
- expect(res.status).toBe(303);
152
- expect(res.headers.get("location")).toBe("/done");
153
- expect(app.cookies.get("made")).toBe("Dune");
154
- expect(app.cookies.has("_csrf")).toBe(true);
155
- });
156
-
157
- test("a post without the token is refused, which is what submit exists to avoid", async () => {
158
- const bare = await createTestApp({ routes: dir }, { root: dir });
159
- const res = await bare.fetch("/form?/create", {
160
- method: "POST",
161
- headers: { "content-type": "application/x-www-form-urlencoded" },
162
- body: "title=x",
163
- });
164
- expect(res.status).toBe(403);
165
- });
166
- });
1
+ import { afterAll, beforeAll, describe, expect, test } from "bun:test";
2
+ import { mkdir, rm, writeFile } from "node:fs/promises";
3
+ import { tmpdir } from "node:os";
4
+ import { join } from "node:path";
5
+ import { transformSync } from "@babel/core";
6
+ import sigilPlugin from "../../compiler/src/babel/index.ts";
7
+ import * as runtime from "../../runtime/index.ts";
8
+ import {
9
+ cleanup,
10
+ click,
11
+ context,
12
+ render,
13
+ tick,
14
+ type,
15
+ } from "../src/testing/index.ts";
16
+ import { createTestApp, type TestApp } from "../src/testing/server.ts";
17
+
18
+ /** A component compiled for the browser, as the DOM preload would give a test. */
19
+ function component(source: string): (props: any) => unknown {
20
+ const code = transformSync(source, {
21
+ plugins: ["@babel/plugin-syntax-jsx", [sigilPlugin, { mode: "dom" }]],
22
+ filename: "c.tsx",
23
+ })!.code!;
24
+ const body = code
25
+ .replace(/import\s*\{[^}]*\}\s*from\s*["']@sigil-dev\/runtime["'];?/g, "")
26
+ .replace(/^export\s+/gm, "");
27
+ return new Function(
28
+ "document",
29
+ ...Object.keys(runtime),
30
+ `${body};\nreturn Comp;`,
31
+ )(globalThis.document, ...Object.values(runtime));
32
+ }
33
+
34
+ describe("render", () => {
35
+ const Counter = component(`
36
+ const Comp = (props) => {
37
+ let n = $state(props.start ?? 0);
38
+ return <div><button onClick={() => n++}>{n}</button><input id="i" /></div>;
39
+ };
40
+ `);
41
+
42
+ test("mounts with props, and updates after an event and a tick", async () => {
43
+ const r = render(Counter, { start: 5 });
44
+ expect(r.text()).toBe("5");
45
+ click(r.$("button")!);
46
+ await tick();
47
+ expect(r.text()).toBe("6");
48
+ expect(r.$$("button")).toHaveLength(1);
49
+ expect(r.html()).toContain("<button>6</button>");
50
+ });
51
+
52
+ test("type() sets the value and fires input", () => {
53
+ const r = render(Counter);
54
+ let seen = "";
55
+ r.$("#i")!.addEventListener("input", (e) => {
56
+ seen = (e.target as HTMLInputElement).value;
57
+ });
58
+ type(r.$("#i")!, "hello");
59
+ expect(seen).toBe("hello");
60
+ });
61
+
62
+ test("unmount and cleanup remove it and stop its effects", async () => {
63
+ const a = render(Counter);
64
+ const b = render(Counter);
65
+ expect(document.body.contains(a.container)).toBe(true);
66
+ a.unmount();
67
+ expect(document.body.contains(a.container)).toBe(false);
68
+ expect(document.body.contains(b.container)).toBe(true);
69
+ cleanup();
70
+ expect(document.body.contains(b.container)).toBe(false);
71
+ });
72
+ });
73
+
74
+ describe("context", () => {
75
+ test("params, url, locals and a form body", async () => {
76
+ const ctx = context({
77
+ params: { id: "7" },
78
+ url: "/books/7?x=1",
79
+ form: { title: "Dune" },
80
+ locals: { user: "ada" } as never,
81
+ });
82
+ expect(ctx.params.id).toBe("7");
83
+ expect(ctx.url.searchParams.get("x")).toBe("1");
84
+ expect(ctx.request.method).toBe("POST");
85
+ expect((await ctx.request.formData()).get("title")).toBe("Dune");
86
+ expect((ctx.locals as { user: string }).user).toBe("ada");
87
+ expect(await ctx.parent()).toEqual({});
88
+ });
89
+
90
+ test("json bodies, and cookies in and out", async () => {
91
+ const ctx = context({ json: { a: 1 }, cookies: { session: "abc" } });
92
+ expect(await ctx.request.json()).toEqual({ a: 1 });
93
+ expect(ctx.cookies.get("session")).toBe("abc");
94
+ ctx.cookies.set("seen", "yes");
95
+ expect(ctx.cookies.toHeaders()[0]).toContain("seen=yes");
96
+ });
97
+
98
+ test("a GET by default, and the method can be set", () => {
99
+ expect(context().request.method).toBe("GET");
100
+ expect(context({ method: "DELETE" }).request.method).toBe("DELETE");
101
+ });
102
+ });
103
+
104
+ describe("createTestApp", () => {
105
+ let dir: string;
106
+ let app: TestApp;
107
+
108
+ beforeAll(async () => {
109
+ dir = join(tmpdir(), `grimoire-testapp-${Date.now()}`);
110
+ await mkdir(join(dir, "api"), { recursive: true });
111
+ await mkdir(join(dir, "form"), { recursive: true });
112
+ await writeFile(
113
+ join(dir, "api", "+server.ts"),
114
+ "export const GET = () => Response.json({ ok: true });\nexport const POST = async ({ request }) => Response.json(await request.json());",
115
+ );
116
+ await writeFile(
117
+ join(dir, "form", "+page.tsx"),
118
+ `export default () => '<form method="post"></form>';`,
119
+ );
120
+ await writeFile(
121
+ join(dir, "form", "+page.server.ts"),
122
+ [
123
+ "export async function create({ request, cookies }) {",
124
+ " const f = await request.formData();",
125
+ ' cookies.set("made", String(f.get("title")));',
126
+ ' return { redirect: "/done" };',
127
+ "}",
128
+ ].join("\n"),
129
+ );
130
+ app = await createTestApp({ routes: dir }, { root: dir });
131
+ });
132
+ afterAll(async () => {
133
+ await app.close();
134
+ await rm(dir, { recursive: true, force: true });
135
+ });
136
+
137
+ test("get and json go through the real pipeline", async () => {
138
+ const res = await app.get("/api");
139
+ expect(res.status).toBe(200);
140
+ expect(await res.json()).toEqual({ ok: true });
141
+ const echoed = await app.json("/api", { hello: "there" });
142
+ expect(await echoed.json()).toEqual({ hello: "there" });
143
+ });
144
+
145
+ test("an unknown path is a 404", async () => {
146
+ expect((await app.get("/nowhere")).status).toBe(404);
147
+ });
148
+
149
+ test("submit handles the CSRF token, returns the redirect and keeps the cookies", async () => {
150
+ const res = await app.submit("/form?/create", { title: "Dune" });
151
+ expect(res.status).toBe(303);
152
+ expect(res.headers.get("location")).toBe("/done");
153
+ expect(app.cookies.get("made")).toBe("Dune");
154
+ expect(app.cookies.has("_csrf")).toBe(true);
155
+ });
156
+
157
+ test("a post without the token is refused, which is what submit exists to avoid", async () => {
158
+ const bare = await createTestApp({ routes: dir }, { root: dir });
159
+ const res = await bare.fetch("/form?/create", {
160
+ method: "POST",
161
+ headers: { "content-type": "application/x-www-form-urlencoded" },
162
+ body: "title=x",
163
+ });
164
+ expect(res.status).toBe(403);
165
+ });
166
+ });