Merge pull request #11098 from quarto-dev/bugfix/10828

pre,postrender - use QUARTO_USE_* environment when requested

src/command/render/project.ts

@@ -326,18 +326,34 @@ export async function renderProject(
 
   // run pre-render step if we are rendering all files
   if (preRenderScripts.length) {
+    // https://github.com/quarto-dev/quarto-cli/issues/10828
+    // some environments limit the length of environment variables.
+    // It's hard to know in advance what the limit is, so we will
+    // instead ask users to configure their environment with
+    // the names of the files we will write the list of files to.
+
+    const filesToRender = projectRenderConfig.filesToRender
+      .map((fileToRender) => fileToRender.path)
+      .map((file) => relative(projDir, file));
+    const env: Record<string, string> = {
+      ...prePostEnv,
+    };
+
+    if (Deno.env.get("QUARTO_USE_FILE_FOR_PROJECT_INPUT_FILES")) {
+      Deno.writeTextFileSync(
+        Deno.env.get("QUARTO_USE_FILE_FOR_PROJECT_INPUT_FILES")!,
+        filesToRender.join("\n"),
+      );
+    } else {
+      env.QUARTO_PROJECT_INPUT_FILES = filesToRender.join("\n");
+    }
+
     await runPreRender(
       projDir,
       preRenderScripts,
       progress,
       !!projectRenderConfig.options.flags?.quiet,
-      {
-        ...prePostEnv,
-        QUARTO_PROJECT_INPUT_FILES: projectRenderConfig.filesToRender
-          .map((fileToRender) => fileToRender.path)
-          .map((file) => relative(projDir, file))
-          .join("\n"),
-      },
+      env,
     );
 
     // re-initialize project context
@@ -814,17 +830,34 @@ export async function renderProject(
 
     // run post-render if this isn't incremental
     if (postRenderScripts.length) {
+      // https://github.com/quarto-dev/quarto-cli/issues/10828
+      // some environments limit the length of environment variables.
+      // It's hard to know in advance what the limit is, so we will
+      // instead ask users to configure their environment with
+      // the names of the files we will write the list of files to.
+
+      const env: Record<string, string> = {
+        ...prePostEnv,
+      };
+
+      if (Deno.env.get("QUARTO_USE_FILE_FOR_PROJECT_OUTPUT_FILES")) {
+        Deno.writeTextFileSync(
+          Deno.env.get("QUARTO_USE_FILE_FOR_PROJECT_OUTPUT_FILES")!,
+          outputFiles.map((outputFile) => relative(projDir, outputFile.file))
+            .join("\n"),
+        );
+      } else {
+        env.QUARTO_PROJECT_OUTPUT_FILES = outputFiles
+          .map((outputFile) => relative(projDir, outputFile.file))
+          .join("\n");
+      }
+
       await runPostRender(
         projDir,
         postRenderScripts,
         progress,
         !!projectRenderConfig.options.flags?.quiet,
-        {
-          ...prePostEnv,
-          QUARTO_PROJECT_OUTPUT_FILES: outputFiles
-            .map((outputFile) => relative(projDir, outputFile.file))
-            .join("\n"),
-        },
+        env,
       );
     }
   }
@@ -908,6 +941,23 @@ async function runScripts(
 
     const handler = handlerForScript(script);
     if (handler) {
+      if (env) {
+        env = {
+          ...env,
+        };
+      } else {
+        env = {};
+      }
+      if (!env) throw new Error("should never get here");
+      const input = Deno.env.get("QUARTO_USE_FILE_FOR_PROJECT_INPUT_FILES");
+      const output = Deno.env.get("QUARTO_USE_FILE_FOR_PROJECT_OUTPUT_FILES");
+      if (input) {
+        env["QUARTO_USE_FILE_FOR_PROJECT_INPUT_FILES"] = input;
+      }
+      if (output) {
+        env["QUARTO_USE_FILE_FOR_PROJECT_OUTPUT_FILES"] = output;
+      }
+
       const result = await handler.run(script, args.splice(1), undefined, {
         cwd: projDir,
         stdout: quiet ? "piped" : "inherit",

src/quarto.ts

@@ -93,7 +93,7 @@ export async function quarto(
 
   // passthrough to run handlers
   if (args[0] === "run" && args[1] !== "help" && args[1] !== "--help") {
-    const result = await runScript(args.slice(1));
+    const result = await runScript(args.slice(1), env);
     Deno.exit(result.code);
   }
 
@@ -151,16 +151,16 @@ export async function quarto(
 
   const promise = quartoCommand.command("help", new HelpCommand().global())
     .command("completions", new CompletionsCommand()).hidden().parse(args);
-  for (const [key, value] of Object.entries(oldEnv)) {
-    if (value === undefined) {
-      Deno.env.delete(key);
-    } else {
-      Deno.env.set(key, value);
-    }
-  }
 
   try {
     await promise;
+    for (const [key, value] of Object.entries(oldEnv)) {
+      if (value === undefined) {
+        Deno.env.delete(key);
+      } else {
+        Deno.env.set(key, value);
+      }
+    }
   } catch (e) {
     if (e instanceof CommandError) {
       logError(e, false);

tests/docs/project/prepost/issue-10828/.gitignore

@@ -0,0 +1 @@
+/.quarto/

tests/docs/project/prepost/issue-10828/_quarto.yml

@@ -0,0 +1,21 @@
+project:
+  type: website
+  pre-render: check-input.ts
+  post-render: check-output.ts
+
+website:
+  title: "issue-10828"
+  navbar:
+    left:
+      - href: index.qmd
+        text: Home
+      - about.qmd
+
+format:
+  html:
+    theme: cosmo
+    css: styles.css
+    toc: true
+
+
+

tests/docs/project/prepost/issue-10828/about.qmd

@@ -0,0 +1,5 @@
+---
+title: "About"
+---
+
+About this site

tests/docs/project/prepost/issue-10828/check-input.ts

@@ -0,0 +1 @@
+Deno.readTextFileSync(Deno.env.get("QUARTO_USE_FILE_FOR_PROJECT_INPUT_FILES"));

tests/docs/project/prepost/issue-10828/check-output.ts

@@ -0,0 +1 @@
+Deno.readTextFileSync(Deno.env.get("QUARTO_USE_FILE_FOR_PROJECT_OUTPUT_FILES"));

tests/docs/project/prepost/issue-10828/index.qmd

@@ -0,0 +1,7 @@
+---
+title: "issue-10828"
+---
+
+This is a Quarto website.
+
+To learn more about Quarto websites visit <https://quarto.org/docs/websites>.

tests/docs/project/prepost/issue-10828/styles.css

@@ -0,0 +1 @@
+/* css styles */

tests/smoke/project/project-prepost.test.ts

@@ -10,7 +10,7 @@ import { join } from "../../../src/deno_ral/path.ts";
 import { existsSync } from "../../../src/deno_ral/fs.ts";
 import { testQuartoCmd } from "../../test.ts";
 import { fileExists, noErrors, printsMessage, verifyNoPath, verifyPath } from "../../verify.ts";
-import { safeRemoveIfExists } from "../../../src/core/path.ts";
+import { normalizePath, safeRemoveIfExists } from "../../../src/core/path.ts";
 
 const renderDir = docs("project/prepost/mutate-render-list");
 const dir = join(Deno.cwd(), renderDir);
@@ -76,4 +76,24 @@ testQuartoCmd(
       verifyPath(path);
       safeRemoveIfExists(path);
     }
-  });
+  });
+
+  testQuartoCmd(
+    "render",
+    [docs("project/prepost/issue-10828")],
+    [],
+    {
+      env: {
+        "QUARTO_USE_FILE_FOR_PROJECT_INPUT_FILES": normalizePath(docs("project/prepost/issue-10828/input-files.txt")),
+        "QUARTO_USE_FILE_FOR_PROJECT_OUTPUT_FILES": normalizePath(docs("project/prepost/issue-10828/output-files.txt"))
+      },
+      teardown: async () => {
+        const inputPath = normalizePath(docs("project/prepost/issue-10828/input-files.txt"));
+        const outputPath = normalizePath(docs("project/prepost/issue-10828/output-files.txt"));
+        verifyPath(inputPath);
+        safeRemoveIfExists(inputPath);
+        verifyPath(outputPath);
+        safeRemoveIfExists(outputPath);
+      }
+    }
+  )