{{ message }}
Repository navigation
Expand file tree
/
Copy pathgenerate-catalog-pages.test.ts
More file actions
420 lines (374 loc) · 15.3 KB
/
Copy pathgenerate-catalog-pages.test.ts
File metadata and controls
420 lines (374 loc) · 15.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
/**
* The `?hfv=` round trip, end to end.
*
* A declared variable default leaves the explorer as a query parameter, passes
* through the preview wrapper, gets a src rewrite from the player, and is read
* back by the bootstrap the generator appends to the composition. Four hops,
* and a value has to survive all four byte-identical.
*
* It did not: the player re-serialized the whole query with `URLSearchParams`
* (form encoding, space -> `+`) while the bootstrap read it with
* `decodeURIComponent` (percent decoding, which leaves `+` alone), so
* "Ship it today" reached the page as "Ship+it+today" and an SVG `d` attribute
* full of spaces stopped parsing altogether.
*
* These tests run the actual emitted scripts and the actual player helper, so
* reintroducing either half of that mismatch fails them.
*/
import assert from "node:assert/strict";
import { readFileSync } from "node:fs";
import { join } from "node:path";
import { describe, it } from "node:test";
import { fileURLToPath } from "node:url";
import { runInNewContext } from "node:vm";
import { prepareSrcForElement } from "../packages/player/src/shader-options.ts";
import {
groupForItem,
mdxStringAttribute,
sectionEntry,
stageProps,
variableBootstrap,
variablePreviewWrapper,
} from "./generate-catalog-pages.ts";
const here = join(fileURLToPath(import.meta.url), "..");
/** The player as the catalog uses it: no shader attributes at all, so its only
* effect on a src is whatever it does to the query it was handed. */
const plainPlayer = { getAttribute: () => null } as unknown as Element;
const OWN_FILE = "svg-stroke-trace.html";
const WRAPPER_BASE = `../../components/svg-stroke-trace/${OWN_FILE}`;
/**
* Every character class this bug reaches. Spaces are the reported symptom; the
* rest are here so a fix that special-cases spaces cannot pass.
*/
const DECLARED: Record<string, string> = {
spaces: "Ship it today",
plus: "C++ and 1+1 and +1 555 010 0199",
ampersand: "a&b=c&d",
reserved: "50% off #1 ready? yes/no",
nonAscii: "café — naïve 東京 🎬",
quotes: 'he said "hi" and it\'s fine',
svgPath:
"M 92 328 C 178 142 292 138 366 276 C 430 396 500 414 558 262 C 622 94 724 112 786 274 C 836 406 894 376 930 194",
};
function scriptBody(html: string): string {
const match = /<script>([\s\S]*)<\/script>/.exec(html);
assert.ok(match, "expected exactly one inline <script>");
return match[1] ?? "";
}
function queryOf(url: string): string {
const index = url.indexOf("?");
return index >= 0 ? url.slice(index) : "";
}
/**
* Hop 1: the explorer's first load. Mirrors the one expression in
* docs/snippets/catalog-detail.jsx that builds it, which the last test in
* this file pins so the two cannot drift apart silently.
*/
function explorerQuery(values: Record<string, string>): string {
return `?hfv=${encodeURIComponent(JSON.stringify(values))}`;
}
/** Hop 2: the wrapper page, run for real. Returns the src it hands the player,
* either from its own URL or from an explorer message. */
function runWrapper(search: string, message?: Record<string, string>): string {
let src = "";
let onMessage: ((event: { origin: string; data: unknown }) => void) | null = null;
const player = {
ready: false,
currentTime: 0,
setAttribute: (name: string, value: string) => {
if (name === "src") src = value;
},
addEventListener: () => {},
seek: () => {},
play: () => {},
};
runInNewContext(scriptBody(variablePreviewWrapper(WRAPPER_BASE).join("\n")), {
URLSearchParams,
document: { getElementById: () => player },
location: { origin: "https://docs.test", search },
setInterval: () => 0,
clearInterval: () => {},
addEventListener: (
type: string,
handler: (event: { origin: string; data: unknown }) => void,
) => {
if (type === "message") onMessage = handler;
},
});
if (message) {
assert.ok(onMessage, "wrapper never registered a message listener");
(onMessage as (event: unknown) => void)({
origin: "https://docs.test",
data: { hfVariables: message },
});
}
return src;
}
/** Hop 4: the bootstrap the generator appends to the composition, run for real.
* Returns what a composition would actually read. */
function runBootstrap(search: string): {
fromWindow: unknown;
fromAttribute: unknown;
} {
const host = {
attributes: new Map<string, string>([["data-composition-src", `./${OWN_FILE}`]]),
getAttribute(name: string) {
return this.attributes.get(name) ?? null;
},
setAttribute(name: string, value: string) {
this.attributes.set(name, value);
},
};
const win: Record<string, unknown> = {};
runInNewContext(scriptBody(variableBootstrap(OWN_FILE)), {
URLSearchParams,
document: { querySelectorAll: () => [host] },
location: { search },
window: win,
});
const raw = host.getAttribute("data-variable-values");
// Re-parsed in this realm: the object the script built carries the vm realm's
// Object.prototype, which deepEqual counts as a difference all by itself.
const parsed = win.__hfVariables;
return {
fromWindow: parsed === undefined ? undefined : JSON.parse(JSON.stringify(parsed)),
fromAttribute: raw === null ? null : JSON.parse(raw),
};
}
/** A player build that form-encodes the whole query, which is what every
* already-published @hyperframes/player on the CDN does. The reader has to
* survive it, because the docs load the player from a CDN and cannot wait for
* a release. */
function formEncodingPlayer(src: string): string {
const index = src.indexOf("?");
if (index < 0) return src;
return `${src.slice(0, index)}?${new URLSearchParams(src.slice(index + 1)).toString()}`;
}
describe("hfv round trip", () => {
const assertDeclaredSurvives = (demoSrc: string): void => {
const read = runBootstrap(queryOf(demoSrc));
assert.deepEqual(read.fromWindow, DECLARED);
assert.deepEqual(read.fromAttribute, DECLARED);
};
it("carries every declared value through all four hops unchanged", () => {
assertDeclaredSurvives(prepareSrcForElement(plainPlayer, runWrapper(explorerQuery(DECLARED))));
});
it("survives a player build that form-encodes the query", () => {
assertDeclaredSurvives(formEncodingPlayer(runWrapper(explorerQuery(DECLARED))));
});
it("carries an edited value in from the explorer's message", () => {
const edited = { ...DECLARED, spaces: "Make it happen" };
const demoSrc = prepareSrcForElement(plainPlayer, runWrapper("", edited));
assert.deepEqual(runBootstrap(queryOf(demoSrc)).fromWindow, edited);
});
for (const [name, value] of Object.entries(DECLARED)) {
it(`keeps ${name} byte-identical`, () => {
const one = { [name]: value };
const demoSrc = prepareSrcForElement(plainPlayer, runWrapper(explorerQuery(one)));
const read = runBootstrap(queryOf(demoSrc));
assert.deepEqual(read.fromWindow, one);
});
}
it("leaves the composition alone when no values are passed", () => {
assert.equal(runWrapper(""), WRAPPER_BASE);
assert.deepEqual(runBootstrap(""), { fromWindow: undefined, fromAttribute: null });
});
});
describe("player src rewriting", () => {
it("hands the composition its query back byte-identical", () => {
const src = "demo.html?hfv=%7B%22a%22%3A%22one%20two%22%7D&keep=a%20b%2Bc#frag";
assert.equal(prepareSrcForElement(plainPlayer, src), src);
});
});
describe("explorer producer", () => {
it("still posts the values in the message the wrapper listens for", () => {
const source = readFileSync(
join(here, "..", "docs", "snippets", "catalog-detail.jsx"),
"utf-8",
);
assert.match(source, /postMessage\(\{ hfVariables: values \}/);
});
});
describe("mdxStringAttribute", () => {
it("emits a plain double-quoted string, not an expression", () => {
assert.equal(
mdxStringAttribute("title", "beat-freeze-cut.html"),
'title="beat-freeze-cut.html"',
);
});
it("escapes the characters that would end the string or open an expression", () => {
assert.equal(
mdxStringAttribute("title", 'say "hi" & <b>{x}</b>'),
'title="say "hi" & <b>{x}</b>"',
);
});
it("leaves backticks alone inside the quoted value", () => {
assert.equal(mdxStringAttribute("title", "`code`"), 'title="`code`"');
});
it("passes backslashes through unchanged, since JSX strings do not treat them as escapes", () => {
assert.equal(mdxStringAttribute("title", "a\\b"), 'title="a\\b"');
});
});
describe("WebGPU stage fallback props", () => {
const page = (name: string) =>
readFileSync(join(here, "..", "docs", "catalog", "blocks", `${name}.mdx`), "utf-8");
it("gives a live WebGPU item its recorded clip, poster and the webgpu flag", () => {
const mdx = page("frost-sequence-camera-orbit");
assert.match(mdx, /^ {2}previewSrc=/m);
assert.match(mdx, /^ {2}video=".*frost-sequence-camera-orbit\.mp4"/m);
assert.match(mdx, /^ {2}poster=/m);
assert.match(mdx, /^ {2}webgpu$/m);
});
it("leaves a live item that does not need WebGPU without a recorded fallback", () => {
const mdx = page("ai-chat-reveal");
assert.match(mdx, /^ {2}previewSrc=/m);
assert.doesNotMatch(mdx, /^ {2}(video=|webgpu$)/m);
});
});
describe("WebGPU adapter probe", () => {
const source = readFileSync(join(here, "..", "docs", "snippets", "catalog-detail.jsx"), "utf-8");
const fn = source.slice(
source.indexOf("const hasWebgpuAdapter"),
source.indexOf("// END hasWebgpuAdapter"),
);
const probe = runInNewContext(`${fn} hasWebgpuAdapter`, { setTimeout, Promise }) as (
gpu: unknown,
ms: number,
) => Promise<boolean>;
it("says yes only for a real adapter", async () => {
assert.equal(await probe({ requestAdapter: async () => ({}) }, 50), true);
});
it("falls back for no gpu, a null adapter, a rejection, a sync throw and a hang", async () => {
const throws = () => {
throw new Error("blocked");
};
const cases = [
undefined,
{ requestAdapter: async () => null },
{ requestAdapter: () => Promise.reject(new Error("no")) },
{ requestAdapter: throws },
{ requestAdapter: () => new Promise(() => {}) },
];
for (const gpu of cases) assert.equal(await probe(gpu, 30), false);
});
});
describe("snippet scope", () => {
it("has no top-level helper outside its exports, because Mintlify only evaluates exports", () => {
const source = readFileSync(
join(here, "..", "docs", "snippets", "catalog-detail.jsx"),
"utf-8",
);
assert.deepEqual(source.match(/^(?:function|const|let|var|class) .*/gm), null);
});
});
describe("stageProps recorded-clip guard", () => {
const frost = JSON.parse(
readFileSync(
join(here, "..", "registry", "blocks", "frost-sequence-camera-orbit", "registry-item.json"),
"utf-8",
),
);
it("offers the recorded fallback only when the manifest has a clip", () => {
assert.ok(stageProps("block", frost).includes(" webgpu"));
assert.deepEqual(stageProps("block", { ...frost, preview: undefined }), []);
});
});
describe("tile reveal", () => {
const source = readFileSync(join(here, "..", "docs", "snippets", "catalog-gallery.jsx"), "utf-8");
const fn = source.slice(
source.indexOf("const revealWhenPainted"),
source.indexOf("// END revealWhenPainted"),
);
const frames: Array<() => void> = [];
const revealWhenPainted = runInNewContext(`${fn} revealWhenPainted`, {
requestAnimationFrame: (cb: () => void) => frames.push(cb),
}) as (player: unknown, reveal: () => void) => void;
const player = (assetsReady: boolean) => {
const target = new EventTarget();
return Object.assign(target, { assetsReady });
};
it("keeps the poster until assetsready plus one frame, not at runtime ready", () => {
frames.length = 0;
const p = player(false);
let revealed = 0;
revealWhenPainted(p, () => revealed++);
p.dispatchEvent(new Event("ready"));
assert.equal(revealed + frames.length, 0);
p.dispatchEvent(new Event("assetsready"));
assert.equal(revealed, 0);
frames.forEach((f) => f());
assert.equal(revealed, 1);
});
it("reveals after one frame when the assets were already settled", () => {
frames.length = 0;
let revealed = 0;
revealWhenPainted(player(true), () => revealed++);
frames.forEach((f) => f());
assert.equal(revealed, 1);
});
it("wires the reveal into the ready handler and not a bare data-ready flip", () => {
const handler = source.slice(
source.indexOf("addEventListener('ready'"),
source.indexOf("player.setAttribute('srcdoc'"),
);
assert.match(handler, /revealWhenPainted\(/);
assert.doesNotMatch(handler.split("revealWhenPainted")[0] ?? "", /dataset\.ready = 'true'/);
});
});
describe("tile poster priority", () => {
const source = readFileSync(join(here, "..", "docs", "snippets", "catalog-gallery.jsx"), "utf-8");
it("fetches the pinned group's posters eagerly at high priority and every other poster lazily", () => {
assert.match(
source,
/loading: eager \? "eager" : "lazy", fetchPriority: eager \? "high" : undefined/,
);
assert.match(source, /card\(item, group\.pinned === true\)/);
assert.doesNotMatch(source, /\.map\(card\)/);
});
});
describe("3D shelves", () => {
const block = (tags: string[]) => groupForItem({ name: "x", type: "block", tags });
it("shelves 3d-object and 3d-motion items apart, each on its first tag", () => {
assert.equal(block(["3d-object", "three-js", "glass", "title-card"]), "3D objects");
assert.equal(block(["3d-motion", "cards", "orbit"]), "3D motion");
assert.equal(block(["three-js", "3d-object"]), "Blocks");
});
it("names the camera-move shelf Camera, since 3D items live under 3D", () => {
assert.equal(block(["camera", "motion-primitive", "zoom"]), "Camera");
});
});
describe("sectionEntry", () => {
it("flattens a section that wraps exactly one shelf of its own name", () => {
const entry = sectionEntry("3D motion", [{ group: "3D motion", pages: ["a", "b"] }]);
assert.deepEqual(entry, { group: "3D motion", pages: ["a", "b"] });
});
it("nests a section that wraps one differently-named shelf", () => {
const entry = sectionEntry("Data & charts", [{ group: "Data", pages: ["a"] }]);
assert.deepEqual(entry, {
group: "Data & charts",
pages: [{ group: "Data", pages: ["a"] }],
});
});
it("nests every shelf when a section wraps more than one", () => {
const children = [
{ group: "Captions", pages: ["a"] },
{ group: "Typography & Text", pages: ["b"] },
];
const entry = sectionEntry("Text & captions", children);
assert.deepEqual(entry, { group: "Text & captions", pages: children });
});
});
describe("Cursors shelf", () => {
const component = (tags: string[]) => groupForItem({ name: "x", type: "component", tags });
it("shelves an item whose first tag is cursor, even when it is also a video primitive", () => {
assert.equal(component(["cursor", "video-primitive", "motion-primitive"]), "Cursors");
assert.equal(component(["cursor", "motion-primitive", "product-demo"]), "Cursors");
});
it("leaves an item that only mentions cursor later in its tags on its own shelf", () => {
assert.equal(
groupForItem({ name: "x", type: "block", tags: ["html-in-canvas", "text", "cursor"] }),
"HTML-in-Canvas",
);
assert.equal(component(["video-primitive", "cursor"]), "Motion Primitives");
});
});
You can’t perform that action at this time.