add lastModified to a module’s hash when it references a file attachm…

…ent (#1837) * when a module references a file attachment, include the file's lastModified timestamp in the module's hash. closes #1836 Note that this allows us to remove from the tests the ts rewrite that we used to do on modules, because their payload’s lastModified is now always set to the fake currentDate injected by the tests. Some tests don't want to use the fake date though! (I hope they never run in parallel?) * clear currentDate in after * prettier --------- Co-authored-by: Mike Bostock <[email protected]>
observablehq · Nov 22, 2024 · 30be23f · 30be23f
1 parent 82922bd
commit 30be23f
Show file tree

Hide file tree

Showing 26 changed files with 83 additions and 23 deletions.
diff --git a/src/config.ts b/src/config.ts
@@ -233,7 +233,7 @@ function readPages(root: string, md: MarkdownIt): Page[] {
   return pages;
 }
 
-let currentDate: Date | null = null;
+export let currentDate: Date | null = null;
 
 /** For testing only! */
 export function setCurrentDate(date: Date | null): void {

diff --git a/src/javascript/module.ts b/src/javascript/module.ts
@@ -6,6 +6,7 @@ import {extname, join} from "node:path/posix";
 import type {Program} from "acorn";
 import type {TransformOptions} from "esbuild";
 import {transform, transformSync} from "esbuild";
+import {currentDate} from "../config.js";
 import {resolveJsrImport} from "../jsr.js";
 import {resolveNodeImport} from "../node.js";
 import {resolveNpmImport} from "../npm.js";
@@ -199,7 +200,7 @@ export function getFileInfo(root: string, path: string): FileInfo | undefined {
     const stat = statSync(key);
     if (!stat.isFile()) return; // ignore non-files
     accessSync(key, constants.R_OK); // verify that file is readable
-    mtimeMs = Math.floor(stat.mtimeMs);
+    mtimeMs = Math.floor((currentDate ?? stat.mtimeMs) as number);
     size = stat.size;
   } catch {
     fileInfoCache.delete(key); // delete stale entry

diff --git a/src/loader.ts b/src/loader.ts
@@ -300,7 +300,7 @@ export class LoaderResolver {
   getOutputFileHash(name: string): string {
     const info = this.getOutputInfo(name);
     if (!info) throw new Error(`output file not found: ${name}`);
-    return info.hash;
+    return createHash("sha256").update(info.hash).update(String(info.mtimeMs)).digest("hex");
   }
 
   getSourceInfo(name: string): FileInfo | undefined {

diff --git a/test/build-test.ts b/test/build-test.ts
@@ -32,6 +32,7 @@ const failureTests = ["missing-file", "missing-import"];
 
 describe("build", () => {
   before(() => setCurrentDate(new Date("2024-01-10T16:00:00")));
+  after(() => setCurrentDate(null));
   mockJsDelivr();
   mockJsr();
   mockDuckDB();
@@ -233,9 +234,6 @@ class TestEffects extends FileBuildEffects {
       contents = contents.replace(/^(\s*<script>\{).*(\}<\/script>)$/gm, "$1/* redacted init script */$2");
       contents = contents.replace(/(registerFile\(.*,"lastModified":)\d+(,"size":\d+.*\))/gm, "$1/* ts */1706742000000$2"); // prettier-ignore
     }
-    if (typeof contents === "string" && outputPath.endsWith(".js")) {
-      contents = contents.replace(/(FileAttachment\(.*,"lastModified":)\d+(,"size":\d+.*\))/gm, "$1/* ts */1706742000000$2"); // prettier-ignore
-    }
     return super.writeFile(outputPath, contents);
   }
 }

diff --git a/test/config-test.ts b/test/config-test.ts
@@ -26,6 +26,7 @@ const DUCKDB_DEFAULTS: DuckDBConfig = {
 
 describe("readConfig(undefined, root)", () => {
   before(() => setCurrentDate(new Date("2024-01-10T16:00:00")));
+  after(() => setCurrentDate(null));
   it("imports the config file at the specified root", async () => {
     const {md, loaders, paths, normalizePath, ...config} = await readConfig(undefined, "test/input/build/config");
     assert(md instanceof MarkdownIt);

diff --git a/test/deploy-test.ts b/test/deploy-test.ts
@@ -195,6 +195,7 @@ const DEPLOY_CONFIG: DeployConfig & {projectId: string; projectSlug: string; wor
 
 describe("deploy", () => {
   before(() => setCurrentDate(new Date("2024-01-10T16:00:00")));
+  after(() => setCurrentDate(null));
   mockObservableApi();
   mockJsDelivr();
 

diff --git a/test/input/build/params2/[code]/analytics.js b/test/input/build/params2/[code]/analytics.js
@@ -0,0 +1,3 @@
+import {FileAttachment} from "npm:@observablehq/stdlib";
+
+FileAttachment("data.json");
diff --git a/test/input/build/params2/[code]/data.json.js b/test/input/build/params2/[code]/data.json.js
@@ -0,0 +1 @@
+process.stdout.write(JSON.stringify({a: 1}));
diff --git a/test/input/build/params2/index.md b/test/input/build/params2/index.md
@@ -0,0 +1,5 @@
+# test
+
+```js
+import "/code/analytics.js"
+```
diff --git a/test/output/build/data-loaders/_import/import-test.3349a02d.js b/test/output/build/data-loaders/_import/import-test.3349a02d.js
@@ -0,0 +1 @@
+export {test} from "./test.a9a4ef0e.js";
diff --git a/test/output/build/data-loaders/_import/import-test.e7269c4e.js b/test/output/build/data-loaders/_import/import-test.e7269c4e.js
diff --git a/...ild/data-loaders/_import/test.86a60bc6.js → ...ild/data-loaders/_import/test.a9a4ef0e.js b/...ild/data-loaders/_import/test.86a60bc6.js → ...ild/data-loaders/_import/test.a9a4ef0e.js
@@ -1,3 +1,3 @@
 import {FileAttachment} from "../_observablehq/stdlib.00000003.js";
 
-export const test = FileAttachment({"name":"../test.txt","mimeType":"text/plain","path":"../_file/test.f2ca1bb6.txt","lastModified":/* ts */1706742000000,"size":5}, import.meta.url).text();
+export const test = FileAttachment({"name":"../test.txt","mimeType":"text/plain","path":"../_file/test.f2ca1bb6.txt","lastModified":1704931200000,"size":5}, import.meta.url).text();
diff --git a/test/output/build/data-loaders/index.html b/test/output/build/data-loaders/index.html
@@ -13,8 +13,8 @@
 <link rel="modulepreload" href="./_observablehq/client.00000001.js">
 <link rel="modulepreload" href="./_observablehq/runtime.00000002.js">
 <link rel="modulepreload" href="./_observablehq/stdlib.00000003.js">
-<link rel="modulepreload" href="./_import/import-test.e7269c4e.js">
-<link rel="modulepreload" href="./_import/test.86a60bc6.js">
+<link rel="modulepreload" href="./_import/import-test.3349a02d.js">
+<link rel="modulepreload" href="./_import/test.a9a4ef0e.js">
 <script type="module">
 
 import {define} from "./_observablehq/client.00000001.js";
@@ -23,7 +23,7 @@
 registerFile("./test.txt", {"name":"./test.txt","mimeType":"text/plain","path":"./_file/test.f2ca1bb6.txt","lastModified":/* ts */1706742000000,"size":5});
 
 define({id: "05e74070", inputs: ["display"], outputs: ["test"], body: async (display) => {
-const {test} = await import("./_import/import-test.e7269c4e.js");
+const {test} = await import("./_import/import-test.3349a02d.js");
 
 display(await test);
 return {test};

diff --git a/...put/build/embed/_import/chart.2ce91e05.js → ...put/build/embed/_import/chart.4140747c.js b/...put/build/embed/_import/chart.2ce91e05.js → ...put/build/embed/_import/chart.4140747c.js
@@ -2,7 +2,7 @@ import {FileAttachment} from "../_observablehq/stdlib.00000003.js";
 import * as Plot from "../_npm/@observablehq/[email protected]/cd372fb8.js";
 
 export async function Chart() {
-  const gistemp = await FileAttachment({"name":"../lib/gistemp.csv","mimeType":"text/csv","path":"../_file/lib/gistemp.1cf298b1.csv","lastModified":/* ts */1706742000000,"size":97}, import.meta.url).csv({typed: true});
+  const gistemp = await FileAttachment({"name":"../lib/gistemp.csv","mimeType":"text/csv","path":"../_file/lib/gistemp.1cf298b1.csv","lastModified":1704931200000,"size":97}, import.meta.url).csv({typed: true});
   return Plot.plot({
     y: {grid: true},
     color: {scheme: "burd"},

diff --git a/test/output/build/embed/chart.js b/test/output/build/embed/chart.js
@@ -1,4 +1,4 @@
 import "./_observablehq/stdlib.00000003.js";
 import "./_npm/@observablehq/[email protected]/cd372fb8.js";
 import "./_npm/[email protected]/cd372fb8.js";
-export * from "./_import/chart.2ce91e05.js";
+export * from "./_import/chart.4140747c.js";
diff --git a/...build/fetches/_import/foo/foo.666599bc.js → ...build/fetches/_import/foo/foo.0cc12e18.js b/...build/fetches/_import/foo/foo.666599bc.js → ...build/fetches/_import/foo/foo.0cc12e18.js
diff --git a/...put/build/fetches/_import/top.c85e149a.js → ...put/build/fetches/_import/top.bacf54cc.js b/...put/build/fetches/_import/top.c85e149a.js → ...put/build/fetches/_import/top.bacf54cc.js
@@ -1,4 +1,4 @@
 import {FileAttachment} from "../_observablehq/stdlib.00000003.js";
-export {fooCsvData, fooJsonData} from "./foo/foo.666599bc.js";
-export const topJsonData = await FileAttachment({"name":"../top-data.json","mimeType":"application/json","path":"../_file/top-data.67358ed8.json","lastModified":/* ts */1706742000000,"size":10}, import.meta.url).json();
-export const topCsvData = await FileAttachment({"name":"../top-data.csv","mimeType":"text/csv","path":"../_file/top-data.24ef4634.csv","lastModified":/* ts */1706742000000,"size":72}, import.meta.url).text();
+export {fooCsvData, fooJsonData} from "./foo/foo.0cc12e18.js";
+export const topJsonData = await FileAttachment({"name":"../top-data.json","mimeType":"application/json","path":"../_file/top-data.67358ed8.json","lastModified":1704931200000,"size":10}, import.meta.url).json();
+export const topCsvData = await FileAttachment({"name":"../top-data.csv","mimeType":"text/csv","path":"../_file/top-data.24ef4634.csv","lastModified":1704931200000,"size":72}, import.meta.url).text();
diff --git a/test/output/build/fetches/foo.html b/test/output/build/fetches/foo.html
@@ -13,7 +13,7 @@
 <link rel="modulepreload" href="./_observablehq/client.00000001.js">
 <link rel="modulepreload" href="./_observablehq/runtime.00000002.js">
 <link rel="modulepreload" href="./_observablehq/stdlib.00000003.js">
-<link rel="modulepreload" href="./_import/foo/foo.666599bc.js">
+<link rel="modulepreload" href="./_import/foo/foo.0cc12e18.js">
 <script type="module">
 
 import {define} from "./_observablehq/client.00000001.js";
@@ -23,7 +23,7 @@
 registerFile("./foo/foo-data.json", {"name":"./foo/foo-data.json","mimeType":"application/json","path":"./_file/foo/foo-data.67358ed8.json","lastModified":/* ts */1706742000000,"size":10});
 
 define({id: "47a695da", inputs: ["display"], outputs: ["fooJsonData","fooCsvData"], body: async (display) => {
-const {fooJsonData, fooCsvData} = await import("./_import/foo/foo.666599bc.js");
+const {fooJsonData, fooCsvData} = await import("./_import/foo/foo.0cc12e18.js");
 
 display(fooJsonData);
 display(fooCsvData);

diff --git a/test/output/build/fetches/top.html b/test/output/build/fetches/top.html
@@ -13,8 +13,8 @@
 <link rel="modulepreload" href="./_observablehq/client.00000001.js">
 <link rel="modulepreload" href="./_observablehq/runtime.00000002.js">
 <link rel="modulepreload" href="./_observablehq/stdlib.00000003.js">
-<link rel="modulepreload" href="./_import/top.c85e149a.js">
-<link rel="modulepreload" href="./_import/foo/foo.666599bc.js">
+<link rel="modulepreload" href="./_import/top.bacf54cc.js">
+<link rel="modulepreload" href="./_import/foo/foo.0cc12e18.js">
 <script type="module">
 
 import {define} from "./_observablehq/client.00000001.js";
@@ -26,7 +26,7 @@
 registerFile("./top-data.json", {"name":"./top-data.json","mimeType":"application/json","path":"./_file/top-data.67358ed8.json","lastModified":/* ts */1706742000000,"size":10});
 
 define({id: "cb908c08", inputs: ["display"], outputs: ["fooCsvData","fooJsonData","topCsvData","topJsonData"], body: async (display) => {
-const {fooCsvData, fooJsonData, topCsvData, topJsonData} = await import("./_import/top.c85e149a.js");
+const {fooCsvData, fooJsonData, topCsvData, topJsonData} = await import("./_import/top.bacf54cc.js");
 
 display(fooJsonData);
 display(fooCsvData);

diff --git a/test/output/build/params2/_file/code/data.015abd7f.json b/test/output/build/params2/_file/code/data.015abd7f.json
@@ -0,0 +1 @@
+{"a":1}
diff --git a/test/output/build/params2/_import/code/analytics.0d826e00.js b/test/output/build/params2/_import/code/analytics.0d826e00.js
@@ -0,0 +1,3 @@
+import {FileAttachment} from "../../_observablehq/stdlib.00000003.js";
+
+FileAttachment({"name":"../../code/data.json","mimeType":"application/json","path":"../../_file/code/data.015abd7f.json","lastModified":1704931200000,"size":7}, import.meta.url);
diff --git a/test/output/build/params2/_observablehq/client.00000001.js b/test/output/build/params2/_observablehq/client.00000001.js
diff --git a/test/output/build/params2/_observablehq/runtime.00000002.js b/test/output/build/params2/_observablehq/runtime.00000002.js
diff --git a/test/output/build/params2/_observablehq/stdlib.00000003.js b/test/output/build/params2/_observablehq/stdlib.00000003.js
diff --git a/test/output/build/params2/_observablehq/theme-air,near-midnight.00000004.css b/test/output/build/params2/_observablehq/theme-air,near-midnight.00000004.css
diff --git a/test/output/build/params2/index.html b/test/output/build/params2/index.html
@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
+<meta name="generator" content="Observable Framework v1.0.0-test">
+<title>test</title>
+<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+<link rel="preload" as="style" href="https://fonts.googleapis.com/css2?family=Source+Serif+4:ital,opsz,wght@0,8..60,200..900;1,8..60,200..900&amp;display=swap" crossorigin>
+<link rel="preload" as="style" href="./_observablehq/theme-air,near-midnight.00000004.css">
+<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css2?family=Source+Serif+4:ital,opsz,wght@0,8..60,200..900;1,8..60,200..900&amp;display=swap" crossorigin>
+<link rel="stylesheet" type="text/css" href="./_observablehq/theme-air,near-midnight.00000004.css">
+<link rel="modulepreload" href="./_observablehq/client.00000001.js">
+<link rel="modulepreload" href="./_observablehq/runtime.00000002.js">
+<link rel="modulepreload" href="./_observablehq/stdlib.00000003.js">
+<link rel="modulepreload" href="./_import/code/analytics.0d826e00.js">
+<script type="module">
+
+import {define} from "./_observablehq/client.00000001.js";
+import {registerFile} from "./_observablehq/stdlib.00000003.js";
+
+registerFile("./code/data.json", {"name":"./code/data.json","mimeType":"application/json","path":"./_file/code/data.015abd7f.json","lastModified":/* ts */1706742000000,"size":7});
+
+define({id: "d2a99c55", body: async () => {
+const {} = await import("./_import/code/analytics.0d826e00.js");
+
+}});
+
+</script>
+</head>
+<body>
+<div id="observablehq-center">
+<aside id="observablehq-toc" data-selector="h1:not(:first-of-type)[id], h2:first-child[id], :not(h1) + h2[id]">
+<nav>
+</nav>
+</aside>
+<main id="observablehq-main" class="observablehq">
+<h1 id="test" tabindex="-1"><a class="observablehq-header-anchor" href="#test">test</a></h1>
+<div class="observablehq observablehq--block"><!--:d2a99c55:--></div>
+</main>
+<footer id="observablehq-footer">
+<div>Built with <a href="https://observablehq.com/" target="_blank" rel="noopener noreferrer">Observable</a> on <a title="2024-01-10T16:00:00">Jan 10, 2024</a>.</div>
+</footer>
+</div>
+</body>
+</html>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import {FileAttachment} from "npm:@observablehq/stdlib";

		FileAttachment("data.json");
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import {FileAttachment} from "../../_observablehq/stdlib.00000003.js";

		FileAttachment({"name":"../../code/data.json","mimeType":"application/json","path":"../../_file/code/data.015abd7f.json","lastModified":1704931200000,"size":7}, import.meta.url);