Name the extension in the invalid project metadata error

The validation error reported the raw schema failure with no hint of
which extension caused it. Wrap it in a single-line message that names
the extension and the rejected keys.

Keep mergeExtensionMetadata private, so the tolerant wrapper is the
only entry point, add the render-path and multi-file cases for a
malformed extension, and make the malformed extension contribute a
valid key too, so the tests prove the whole contribution is dropped.

Say in the changelog that every command that builds a project context
now applies the contributed metadata, and give the same suppression
hint in both output-dir warnings.

Author: mcanouil

news/changelog-1.11.md

@@ -4,7 +4,7 @@ All changes included in 1.11:
 
 ### `quarto preview`
 
-- ([#14783](https://github.com/quarto-dev/quarto-cli/issues/14783)): Fix project metadata contributed by an extension, such as `brand`, being ignored during `quarto preview`. `quarto render` already applied it.
+- ([#14783](https://github.com/quarto-dev/quarto-cli/issues/14783)): Fix project metadata contributed by an extension, such as `brand`, being ignored during `quarto preview`. `quarto render` already applied it. Every command that builds a project context now applies it as well, so `quarto inspect` also reports it.
 
 ## Engines
 

src/project/project-context.ts

@@ -108,10 +108,32 @@ import { createTempContext } from "../core/temp.ts";
 
 import { onCleanup } from "../core/cleanup.ts";
 import { warning } from "../deno_ral/log.ts";
+import { ZodError } from "zod";
+import { extensionIdString } from "../extension/extension-shared.ts";
+import { Extension } from "../extension/types.ts";
 import { Zod } from "../resources/types/zod/schema-types.ts";
 import { ExternalEngine } from "../resources/types/schema-types.ts";
 
-export const mergeExtensionMetadata = async (
+// Turn a validation failure into one line that names the offending keys, so
+// the caller can report it without dumping the raw validation error
+const projectMetadataError = (extension: Extension, err: unknown) => {
+  const reason = err instanceof ZodError
+    ? err.issues.map((issue) =>
+      issue.path.length
+        ? `${issue.path.join(".")}: ${issue.message}`
+        : issue.message
+    ).join("; ")
+    : err instanceof Error
+    ? err.message
+    : String(err);
+  return new Error(
+    `The extension ${
+      extensionIdString(extension.id)
+    } contributes invalid project metadata (${reason}).`,
+  );
+};
+
+const mergeExtensionMetadata = async (
   context: ProjectContext,
   extensionContext: ExtensionContext,
 ) => {
@@ -128,7 +150,11 @@ export const mergeExtensionMetadata = async (
     const projectMetadata = extensions.filter((extension) =>
       extension.contributes.metadata?.project
     ).map((extension) => {
-      return Zod.ProjectConfig.parse(extension.contributes.metadata!.project);
+      try {
+        return Zod.ProjectConfig.parse(extension.contributes.metadata!.project);
+      } catch (err) {
+        throw projectMetadataError(extension, err);
+      }
     });
     context.config.project = mergeProjectMetadata(
       context.config.project,
@@ -153,7 +179,7 @@ export const mergeExtensionMetadataForContext = async (
       throw err;
     }
     warning(
-      `Ignoring the project metadata contributed by extensions: ${
+      `Ignoring the project metadata contributed by extensions. ${
         err instanceof Error ? err.message : String(err)
       }`,
     );

src/project/types/single-file/single-file.ts

@@ -141,7 +141,8 @@ export async function singleFileProjectContext(
     } else {
       warning(
         `An extension contributed 'output-dir: ${outputDir}' metadata for a single file.\n` +
-          "Output will go to that directory when the file is rendered.",
+          "Output will go to that directory when the file is rendered.\n" +
+          "To suppress this warning, use --output-dir flag instead of extension metadata.",
       );
     }
   }

tests/unit/preview-extension-brand.test.ts

@@ -14,7 +14,7 @@
  */
 
 import { unitTest } from "../test.ts";
-import { assert, assertEquals } from "testing/asserts";
+import { assert, assertEquals, assertRejects } from "testing/asserts";
 import { join } from "../../src/deno_ral/path.ts";
 import { LightDarkBrandDarkFlag } from "../../src/core/brand/brand.ts";
 import { singleFileProjectContext } from "../../src/project/types/single-file/single-file.ts";
@@ -221,6 +221,11 @@ unitTest(
   },
 );
 
+// One valid key and one key the strict project schema rejects, so a test can
+// tell "the whole contribution was dropped" from "it was partially applied".
+const MALFORMED_METADATA = '      output-dir: "_out"\n' +
+  "      not-a-project-key: true\n";
+
 unitTest(
   "singleFileProjectContext: a malformed extension does not break a context built without renderOptions (#14783)",
   async () => {
@@ -232,20 +237,79 @@ unitTest(
 
     try {
       Deno.writeTextFileSync(file, DOCUMENT);
-      // `not-a-project-key` is rejected by the strict project schema.
-      writeExtension(tmpDir, "      not-a-project-key: true\n");
+      writeExtension(tmpDir, MALFORMED_METADATA);
 
       // preview and inspect must degrade to "metadata not applied" here.
       project = await singleFileProjectContext(file, notebookContext());
 
       assertEquals(
         project.config?.project?.["output-dir"],
         undefined,
-        "no metadata from the malformed extension must be applied",
+        "the whole contribution of a malformed extension must be dropped",
       );
     } finally {
       project?.cleanup?.();
       safeRemoveSync(tmpDir, { recursive: true });
     }
   },
 );
+
+unitTest(
+  "projectContext: a malformed extension does not break a context built without renderOptions (#14783)",
+  async () => {
+    await initYamlIntelligenceResourcesFromFilesystem();
+
+    const tmpDir = Deno.makeTempDirSync({ prefix: "quarto-test" });
+    let project;
+
+    try {
+      Deno.writeTextFileSync(
+        join(tmpDir, "_quarto.yml"),
+        "project:\n  type: default\n",
+      );
+      Deno.writeTextFileSync(join(tmpDir, "index.qmd"), DOCUMENT);
+      writeExtension(tmpDir, MALFORMED_METADATA);
+
+      project = await projectContext(tmpDir, notebookContext());
+      assert(
+        project !== undefined,
+        "projectContext must still resolve with a malformed extension",
+      );
+      assertEquals(
+        project.config?.project?.["output-dir"],
+        undefined,
+        "the whole contribution of a malformed extension must be dropped",
+      );
+    } finally {
+      project?.cleanup?.();
+      safeRemoveSync(tmpDir, { recursive: true });
+    }
+  },
+);
+
+unitTest(
+  "singleFileProjectContext: a malformed extension is fatal on the render path (#14783)",
+  async () => {
+    await initYamlIntelligenceResourcesFromFilesystem();
+
+    const tmpDir = Deno.makeTempDirSync({ prefix: "quarto-test" });
+    const file = join(tmpDir, "test.qmd");
+    const nbContext = notebookContext();
+    const services = renderServices(nbContext);
+    const renderOptions = { services, flags: {} } as RenderOptions;
+
+    try {
+      Deno.writeTextFileSync(file, DOCUMENT);
+      writeExtension(tmpDir, MALFORMED_METADATA);
+
+      await assertRejects(
+        () => singleFileProjectContext(file, nbContext, renderOptions),
+        Error,
+        "contributes invalid project metadata",
+      );
+    } finally {
+      services.cleanup();
+      safeRemoveSync(tmpDir, { recursive: true });
+    }
+  },
+);