missing files break the build (#1651)

Author: mbostock

src/build.ts

@@ -2,7 +2,7 @@ import {createHash} from "node:crypto";
 import {copyFile, readFile, rm, stat, writeFile} from "node:fs/promises";
 import {basename, dirname, extname, join} from "node:path/posix";
 import type {Config} from "./config.js";
-import {CliError, isEnoent} from "./error.js";
+import {CliError} from "./error.js";
 import {getClientPath, prepareOutput} from "./files.js";
 import {findModule, getLocalModuleHash, getModuleHash, readJavaScript} from "./javascript/module.js";
 import {transpileModule} from "./javascript/transpile.js";
@@ -176,14 +176,7 @@ export async function build(
   // Copy over referenced files, accumulating hashed aliases.
   for (const file of files) {
     effects.output.write(`${faint("copy")} ${join(root, file)} ${faint("→")} `);
-    let sourcePath: string;
-    try {
-      sourcePath = join(root, await loaders.loadFile(join("/", file), {useStale: true}, effects));
-    } catch (error) {
-      if (!isEnoent(error)) throw error;
-      effects.logger.error(red("error: missing referenced file"));
-      continue;
-    }
+    const sourcePath = join(root, await loaders.loadFile(join("/", file), {useStale: true}, effects));
     const contents = await readFile(sourcePath);
     const hash = createHash("sha256").update(contents).digest("hex").slice(0, 8);
     const alias = applyHash(join("/_file", file), hash);
@@ -242,22 +235,12 @@ export async function build(
   };
   for (const path of localImports) {
     const module = findModule(root, path);
-    if (!module) {
-      effects.logger.error(red(`error: import not found: ${path}`));
-      continue;
-    }
+    if (!module) throw new Error(`import not found: ${path}`);
     const sourcePath = join(root, module.path);
     const importPath = join("_import", module.path);
     effects.output.write(`${faint("copy")} ${sourcePath} ${faint("→")} `);
     const resolveImport = getModuleResolver(root, path);
-    let input: string;
-    try {
-      input = await readJavaScript(sourcePath);
-    } catch (error) {
-      if (!isEnoent(error)) throw error;
-      effects.logger.error(red("error: missing referenced import"));
-      continue;
-    }
+    const input = await readJavaScript(sourcePath);
     const contents = await transpileModule(input, {
       root,
       path,

test/build-test.ts

@@ -25,6 +25,9 @@ function getHashNormalizer() {
   };
 }
 
+/** These tests are intended to fail. */
+const failureTests = ["missing-file", "missing-import"];
+
 describe("build", () => {
   before(() => setCurrentDate(new Date("2024-01-10T16:00:00")));
   mockJsDelivr();
@@ -48,14 +51,21 @@ describe("build", () => {
       : it)(`${inputRoot}/${name}`, async () => {
       const actualDir = join(outputRoot, `${outname}-changed`);
       const expectedDir = join(outputRoot, outname);
-      const generate = !existsSync(expectedDir) && process.env.CI !== "true";
+      const generate = !existsSync(expectedDir) && !failureTests.includes(outname) && process.env.CI !== "true";
       const outputDir = generate ? expectedDir : actualDir;
       const normalizeHash = getHashNormalizer();
 
       await rm(actualDir, {recursive: true, force: true});
       if (generate) console.warn(`! generating ${expectedDir}`);
       const config = {...(await readConfig(undefined, path)), output: outputDir};
-      await build({config}, new TestEffects(outputDir, join(config.root, ".observablehq", "cache")));
+      try {
+        await build({config}, new TestEffects(outputDir, join(config.root, ".observablehq", "cache")));
+      } catch (error) {
+        if (!failureTests.includes(outname)) throw error;
+        await rm(outputDir, {recursive: true, force: true});
+        return;
+      }
+      if (failureTests.includes(outname)) throw new Error(`expected failure: ${outname}`);
 
       // Replace any hashed files in _observablehq with empty files, and
       // renumber the hashes so they are sequential. This way we don’t have to

test/files-test.ts

@@ -55,6 +55,7 @@ describe("visitFiles(root)", () => {
       "files.md",
       "observable logo small.png",
       "observable logo.png",
+      "unknown-mime-extension.really",
       "subsection/additional-styles.css",
       "subsection/file-sub.csv",
       "subsection/subfiles.md"

test/input/build/archives.posix/tar.md

@@ -8,22 +8,10 @@ await FileAttachment("static-tar/file.txt").text()
 await FileAttachment("static-tgz/file.txt").text()
 ```
 
-```js
-await FileAttachment("static-tar/does-not-exist.txt").text()
-```
-
 ```js
 await FileAttachment("dynamic-tar/file.txt").text()
 ```
 
-```js
-await FileAttachment("dynamic-tar/does-not-exist.txt").text()
-```
-
 ```js
 await FileAttachment("dynamic-tar-gz/file.txt").text()
 ```
-
-```js
-await FileAttachment("dynamic-tar-gz/does-not-exist.txt").text()
-```

test/input/build/archives.posix/zip.md

@@ -4,18 +4,10 @@
 await FileAttachment("static/file.txt").text()
 ```
 
-```js
-await FileAttachment("static/not-found.txt").text()
-```
-
 ```js
 await FileAttachment("dynamic/file.txt").text()
 ```
 
-```js
-await FileAttachment("dynamic/not-found.txt").text()
-```
-
 ```js
 // await FileAttachment("dynamic.zip")
 ```

test/input/build/archives.win32/tar.md

@@ -7,7 +7,3 @@ await FileAttachment("static-tar/file.txt").text()
 ```js
 await FileAttachment("static-tgz/file.txt").text()
 ```
-
-```js
-await FileAttachment("static-tar/does-not-exist.txt").text()
-```

test/input/build/archives.win32/zip.md

@@ -3,7 +3,3 @@
 ```js
 await FileAttachment("static/file.txt").text()
 ```
-
-```js
-await FileAttachment("static/not-found.txt").text()
-```

test/output/build/missing-file/_observablehq/client.00000001.js renamed to test/input/build/files/unknown-mime-extension.really

@@ -16,11 +16,8 @@
 import {define} from "./_observablehq/client.00000001.js";
 import {registerFile} from "./_observablehq/stdlib.00000003.js";
 
-registerFile("./dynamic-tar-gz/does-not-exist.txt", {"name":"./dynamic-tar-gz/does-not-exist.txt","mimeType":"text/plain","path":"./dynamic-tar-gz/does-not-exist.txt"});
 registerFile("./dynamic-tar-gz/file.txt", {"name":"./dynamic-tar-gz/file.txt","mimeType":"text/plain","path":"./_file/dynamic-tar-gz/file.c93138d8.txt","lastModified":/* ts */1706742000000,"size":21});
-registerFile("./dynamic-tar/does-not-exist.txt", {"name":"./dynamic-tar/does-not-exist.txt","mimeType":"text/plain","path":"./dynamic-tar/does-not-exist.txt"});
 registerFile("./dynamic-tar/file.txt", {"name":"./dynamic-tar/file.txt","mimeType":"text/plain","path":"./_file/dynamic-tar/file.c93138d8.txt","lastModified":/* ts */1706742000000,"size":21});
-registerFile("./static-tar/does-not-exist.txt", {"name":"./static-tar/does-not-exist.txt","mimeType":"text/plain","path":"./static-tar/does-not-exist.txt"});
 registerFile("./static-tar/file.txt", {"name":"./static-tar/file.txt","mimeType":"text/plain","path":"./_file/static-tar/file.c93138d8.txt","lastModified":/* ts */1706742000000,"size":21});
 registerFile("./static-tgz/file.txt", {"name":"./static-tgz/file.txt","mimeType":"text/plain","path":"./_file/static-tgz/file.c93138d8.txt","lastModified":/* ts */1706742000000,"size":21});
 
@@ -36,36 +33,18 @@
 ))
 }});
 
-define({id: "d84cd7fb", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
-display(await(
-await FileAttachment("./static-tar/does-not-exist.txt").text()
-))
-}});
-
 define({id: "86bd51aa", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
 display(await(
 await FileAttachment("./dynamic-tar/file.txt").text()
 ))
 }});
 
-define({id: "95938c22", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
-display(await(
-await FileAttachment("./dynamic-tar/does-not-exist.txt").text()
-))
-}});
-
 define({id: "7e5740fd", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
 display(await(
 await FileAttachment("./dynamic-tar-gz/file.txt").text()
 ))
 }});
 
-define({id: "d0a58efd", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
-display(await(
-await FileAttachment("./dynamic-tar-gz/does-not-exist.txt").text()
-))
-}});
-
 </script>
 <input id="observablehq-sidebar-toggle" type="checkbox" title="Toggle sidebar">
 <label id="observablehq-sidebar-backdrop" for="observablehq-sidebar-toggle"></label>
@@ -89,11 +68,8 @@
 <h1 id="tar" tabindex="-1"><a class="observablehq-header-anchor" href="#tar">Tar</a></h1>
 <div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:d5134368:--></div>
 <div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:a0c06958:--></div>
-<div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:d84cd7fb:--></div>
 <div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:86bd51aa:--></div>
-<div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:95938c22:--></div>
 <div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:7e5740fd:--></div>
-<div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:d0a58efd:--></div>
 </main>
 <footer id="observablehq-footer">
 <nav><a rel="next" href="./zip"><span>Zip</span></a></nav>

test/output/build/archives.posix/tar.html

@@ -17,34 +17,20 @@
 import {registerFile} from "./_observablehq/stdlib.00000003.js";
 
 registerFile("./dynamic/file.txt", {"name":"./dynamic/file.txt","mimeType":"text/plain","path":"./_file/dynamic/file.c93138d8.txt","lastModified":/* ts */1706742000000,"size":21});
-registerFile("./dynamic/not-found.txt", {"name":"./dynamic/not-found.txt","mimeType":"text/plain","path":"./dynamic/not-found.txt"});
 registerFile("./static/file.txt", {"name":"./static/file.txt","mimeType":"text/plain","path":"./_file/static/file.d9014c46.txt","lastModified":/* ts */1706742000000,"size":14});
-registerFile("./static/not-found.txt", {"name":"./static/not-found.txt","mimeType":"text/plain","path":"./static/not-found.txt"});
 
 define({id: "d3b9d0ee", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
 display(await(
 await FileAttachment("./static/file.txt").text()
 ))
 }});
 
-define({id: "bab54217", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
-display(await(
-await FileAttachment("./static/not-found.txt").text()
-))
-}});
-
 define({id: "11eec300", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
 display(await(
 await FileAttachment("./dynamic/file.txt").text()
 ))
 }});
 
-define({id: "ee2310f3", inputs: ["FileAttachment","display"], body: async (FileAttachment,display) => {
-display(await(
-await FileAttachment("./dynamic/not-found.txt").text()
-))
-}});
-
 define({id: "f9a513d8", body: () => {
 // await FileAttachment("dynamic.zip")
 }});
@@ -71,9 +57,7 @@
 <main id="observablehq-main" class="observablehq">
 <h1 id="zip" tabindex="-1"><a class="observablehq-header-anchor" href="#zip">Zip</a></h1>
 <div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:d3b9d0ee:--></div>
-<div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:bab54217:--></div>
 <div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:11eec300:--></div>
-<div class="observablehq observablehq--block"><observablehq-loading></observablehq-loading><!--:ee2310f3:--></div>
 <div class="observablehq observablehq--block"><!--:f9a513d8:--></div>
 </main>
 <footer id="observablehq-footer">