@sigil-dev/grimoire 0.9.20 → 0.9.22

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 (94) hide show
  1. package/README.md +83 -83
  2. package/index.ts +50 -48
  3. package/package.json +16 -5
  4. package/public/__grimoire__/grimoire-client.js +12 -0
  5. package/public/__grimoire__/runtime.js +1241 -0
  6. package/server.ts +22 -20
  7. package/src/adapters/bun.ts +17 -0
  8. package/src/adapters/static.ts +41 -0
  9. package/src/adapters/types.ts +36 -0
  10. package/src/base.ts +91 -0
  11. package/src/client/csrf.ts +47 -47
  12. package/src/client/deferred.ts +179 -179
  13. package/src/client/enhance.ts +160 -160
  14. package/src/client/router.ts +870 -833
  15. package/src/dev/compile-module.ts +211 -211
  16. package/src/dev/loader.ts +141 -141
  17. package/src/dev/resolve.ts +70 -70
  18. package/src/dev/runtime-bundle.ts +51 -51
  19. package/src/env/modules.ts +62 -62
  20. package/src/env/required.ts +42 -0
  21. package/src/env/typegen.ts +61 -61
  22. package/src/headers.ts +105 -114
  23. package/src/logger/transports.ts +117 -117
  24. package/src/rendering/head.ts +49 -49
  25. package/src/rendering/hydrate.ts +161 -161
  26. package/src/rendering/images.ts +43 -43
  27. package/src/rendering/index.ts +755 -745
  28. package/src/rendering/preload.ts +101 -95
  29. package/src/rendering/ssrPlugin.ts +108 -108
  30. package/src/rendering/timing.ts +40 -40
  31. package/src/routing/router.ts +186 -186
  32. package/src/routing/scanner.ts +225 -196
  33. package/src/routing/transform-routes.ts +102 -102
  34. package/src/server/after-response.ts +206 -194
  35. package/src/server/asset-cache.ts +57 -55
  36. package/src/server/build.ts +262 -249
  37. package/src/server/cached.ts +114 -114
  38. package/src/server/client-address.ts +82 -82
  39. package/src/server/client-dir.ts +57 -57
  40. package/src/server/client-entry.ts +44 -0
  41. package/src/server/cookie-utils.ts +80 -80
  42. package/src/server/coordinator.ts +476 -471
  43. package/src/server/hooks.ts +122 -122
  44. package/src/server/index.ts +1138 -1022
  45. package/src/server/plugins.ts +172 -172
  46. package/src/server/prerender.ts +444 -0
  47. package/src/server/reserved.ts +17 -0
  48. package/src/server/resolver.ts +98 -98
  49. package/src/server/rewrite.ts +28 -0
  50. package/src/server/warm.ts +91 -91
  51. package/src/server/with-headers.ts +27 -0
  52. package/src/server/worker.ts +74 -72
  53. package/src/testing/dom.ts +73 -0
  54. package/src/testing/index.ts +169 -0
  55. package/src/testing/server.ts +162 -0
  56. package/src/typegen/index.ts +450 -450
  57. package/src/types.ts +501 -432
  58. package/test/after-response.test.ts +132 -113
  59. package/test/asset-cache-policy.test.ts +96 -96
  60. package/test/base.test.ts +134 -0
  61. package/test/cached.test.ts +126 -126
  62. package/test/client-address.test.ts +78 -78
  63. package/test/client-csrf.test.ts +61 -61
  64. package/test/client-dir.test.ts +101 -69
  65. package/test/client-router.test.ts +789 -734
  66. package/test/coordinator.test.ts +96 -94
  67. package/test/deferred.test.ts +256 -256
  68. package/test/dev-loader.test.ts +30 -30
  69. package/test/env.test.ts +168 -168
  70. package/test/force-production.test.ts +44 -0
  71. package/test/images.test.ts +49 -49
  72. package/test/locals-header.test.ts +61 -0
  73. package/test/middleware.test.ts +243 -243
  74. package/test/parser-plugins.test.ts +92 -92
  75. package/test/plugin-handle.test.ts +62 -62
  76. package/test/plugin-services-context.test.ts +97 -97
  77. package/test/preload.test.ts +48 -48
  78. package/test/prerender.test.ts +353 -0
  79. package/test/rendering.test.ts +798 -798
  80. package/test/required-env.test.ts +32 -0
  81. package/test/rewrite-html.test.ts +90 -0
  82. package/test/scanning.test.ts +349 -314
  83. package/test/server.test.ts +640 -619
  84. package/test/services.test.ts +90 -90
  85. package/test/streaming.test.ts +378 -378
  86. package/test/testing-helpers.test.ts +166 -0
  87. package/test/typegen.test.ts +805 -799
  88. package/test/warm.test.ts +96 -96
  89. package/test/worker-context.test.ts +59 -59
  90. package/test/workspace-files.test.ts +149 -146
  91. package/test/workspace-versions.test.ts +131 -131
  92. package/.grimoire/_routes.ts +0 -4
  93. package/public/__grimoire__/client.js +0 -55
  94. package/public/__grimoire__/hydrate.js +0 -63
@@ -0,0 +1,32 @@
1
+ import { describe, expect, test } from "bun:test";
2
+ import { assertRequiredEnv, missingEnv } from "../src/env/required";
3
+
4
+ describe("required env", () => {
5
+ test("nothing declared, nothing missing", () => {
6
+ expect(missingEnv({}, {})).toEqual([]);
7
+ expect(() => assertRequiredEnv({}, {})).not.toThrow();
8
+ });
9
+
10
+ test("lists every missing name once, with who asked for it", () => {
11
+ const config = {
12
+ env: { required: ["DB_URL", "SESSION_SECRET"] },
13
+ plugins: [{ name: "mailer", requiredEnv: ["SMTP_URL", "DB_URL"] }],
14
+ };
15
+ const err = (() => {
16
+ try {
17
+ assertRequiredEnv(config, { SESSION_SECRET: "x" });
18
+ } catch (e) {
19
+ return e as Error;
20
+ }
21
+ })();
22
+ expect(err?.message).toContain("DB_URL (required by sigil.config.ts)");
23
+ expect(err?.message).toContain('SMTP_URL (required by plugin "mailer")');
24
+ expect(err?.message).not.toContain("SESSION_SECRET");
25
+ expect(err?.message.match(/DB_URL/g)).toHaveLength(1);
26
+ });
27
+
28
+ test("an empty value counts as missing", () => {
29
+ expect(missingEnv({ env: { required: ["A"] } }, { A: "" })).toHaveLength(1);
30
+ expect(missingEnv({ env: { required: ["A"] } }, { A: "1" })).toEqual([]);
31
+ });
32
+ });
@@ -0,0 +1,90 @@
1
+ import { describe, expect, test } from "bun:test";
2
+ import { applyRewriters } from "../src/server/rewrite";
3
+ import type { GrimoirePlugin, RenderContext } from "../src/types";
4
+
5
+ const ctx = {
6
+ route: { path: "/", filePath: "/x", type: "page" },
7
+ request: new Request("http://localhost/"),
8
+ params: {},
9
+ data: undefined,
10
+ } as RenderContext;
11
+
12
+ const enc = new TextEncoder();
13
+
14
+ /** A page that sends its shell, waits, then sends the rest: the shape of a streamed route. */
15
+ function streamedPage(delayMs: number): Response {
16
+ return new Response(
17
+ new ReadableStream({
18
+ async start(c) {
19
+ c.enqueue(
20
+ enc.encode("<html><head><title>x</title></head><body><p>shell</p>"),
21
+ );
22
+ await Bun.sleep(delayMs);
23
+ c.enqueue(enc.encode("<p>late</p></body></html>"));
24
+ c.close();
25
+ },
26
+ }),
27
+ { status: 200, headers: { "content-type": "text/html", "x-keep": "1" } },
28
+ );
29
+ }
30
+
31
+ const injectMeta: GrimoirePlugin = {
32
+ name: "inject",
33
+ rewriteHtml(rewriter) {
34
+ rewriter.on("head", {
35
+ element: (el) => el.append('<meta name="added">', { html: true }),
36
+ });
37
+ },
38
+ };
39
+
40
+ describe("rewriteHtml", () => {
41
+ test("rewrites the shell before the rest of the response exists", async () => {
42
+ const res = await applyRewriters(streamedPage(300), [injectMeta], ctx);
43
+ const reader = res.body!.getReader();
44
+ const t0 = performance.now();
45
+ const first = await reader.read();
46
+ const firstAt = performance.now() - t0;
47
+ expect(new TextDecoder().decode(first.value)).toContain(
48
+ '<meta name="added">',
49
+ );
50
+ // the late chunk is 300ms away: a buffered rewrite could not have answered yet
51
+ expect(firstAt).toBeLessThan(200);
52
+ const rest = await reader.read();
53
+ expect(new TextDecoder().decode(rest.value)).toContain("late");
54
+ });
55
+
56
+ test("several plugins compose on one pass, in plugin order", async () => {
57
+ const second: GrimoirePlugin = {
58
+ name: "second",
59
+ rewriteHtml(rewriter) {
60
+ rewriter.on("head", {
61
+ element: (el) => el.append("<!--two-->", { html: true }),
62
+ });
63
+ },
64
+ };
65
+ const html = await (
66
+ await applyRewriters(streamedPage(0), [injectMeta, second], ctx)
67
+ ).text();
68
+ expect(html.indexOf('name="added"')).toBeLessThan(
69
+ html.indexOf("<!--two-->"),
70
+ );
71
+ });
72
+
73
+ test("keeps status and headers", async () => {
74
+ const res = await applyRewriters(streamedPage(0), [injectMeta], ctx);
75
+ expect(res.status).toBe(200);
76
+ expect(res.headers.get("x-keep")).toBe("1");
77
+ });
78
+
79
+ test("leaves non-HTML, empty and plugin-less responses alone", async () => {
80
+ const json = Response.json({ a: 1 });
81
+ expect(await applyRewriters(json, [injectMeta], ctx)).toBe(json);
82
+ const redirect = new Response(null, {
83
+ status: 303,
84
+ headers: { location: "/" },
85
+ });
86
+ expect(await applyRewriters(redirect, [injectMeta], ctx)).toBe(redirect);
87
+ const page = streamedPage(0);
88
+ expect(await applyRewriters(page, [{ name: "none" }], ctx)).toBe(page);
89
+ });
90
+ });