Merge pull request #11968 from quarto-dev/feature/project-cache

[feat] typescript - projects have a persistent disk cache

Author: cscheid

src/command/preview/cmd.ts

@@ -278,7 +278,7 @@ export const previewCommand = new Command()
       // get project and preview format
       const nbContext = notebookContext();
       const project = (await projectContext(dirname(file), nbContext)) ||
-        singleFileProjectContext(file, nbContext);
+        (await singleFileProjectContext(file, nbContext));
       const formats = await (async () => {
         const services = renderServices(nbContext);
         try {

src/command/preview/preview.ts

@@ -373,7 +373,7 @@ export async function previewFormat(
     return format;
   }
   const nbContext = notebookContext();
-  project = project || singleFileProjectContext(file, nbContext);
+  project = project || (await singleFileProjectContext(file, nbContext));
   formats = formats ||
     await withRenderServices(
       nbContext,
@@ -485,6 +485,8 @@ export async function renderForPreview(
     [],
   ));
 
+  renderResult.context.cleanup();
+
   return {
     file,
     format: renderResult.files[0].format,

src/command/publish/cmd.ts

@@ -339,7 +339,7 @@ async function createPublishOptions(
 
   // check for directory (either website or single-file project)
   const project = (await projectContext(path, nbContext)) ||
-    singleFileProjectContext(path, nbContext);
+    (await singleFileProjectContext(path, nbContext));
   if (Deno.statSync(path).isDirectory) {
     if (projectIsWebsite(project)) {
       input = project;

src/command/render/cmd.ts

@@ -245,6 +245,9 @@ export const renderCommand = new Command()
         const services = renderServices(notebookContext());
         try {
           renderResultInput = relative(Deno.cwd(), walk.path) || ".";
+          if (renderResult) {
+            renderResult.context.cleanup();
+          }
           renderResult = await render(renderResultInput, {
             services,
             flags,
@@ -255,6 +258,7 @@ export const renderCommand = new Command()
 
           // check for error
           if (renderResult.error) {
+            renderResult.context.cleanup();
             throw renderResult.error;
           }
         } finally {
@@ -275,6 +279,10 @@ export const renderCommand = new Command()
         if (finalOutput) {
           info("Output created: " + finalOutput + "\n");
         }
+
+        if (renderResult) {
+          renderResult.context.cleanup();
+        }
       }
     } else {
       throw new Error(`No valid input files passed to render`);

src/command/render/pandoc-html.ts

@@ -53,7 +53,6 @@ export async function resolveSassBundles(
   inputDir: string,
   extras: FormatExtras,
   format: Format,
-  temp: TempContext,
   project: ProjectContext,
 ) {
   extras = cloneDeep(extras);
@@ -159,11 +158,11 @@ export async function resolveSassBundles(
 
     for (const target of targets) {
       let cssPath: string | undefined;
-      cssPath = await compileSass(target.bundles, temp);
+      cssPath = await compileSass(target.bundles, project);
       // First, Clean CSS
       cleanSourceMappingUrl(cssPath);
       // look for a sentinel 'dark' value, extract variables
-      const cssResult = await processCssIntoExtras(cssPath, extras, temp);
+      const cssResult = await processCssIntoExtras(cssPath, extras, project);
       cssPath = cssResult.path;
 
       // it can happen that processing generate an empty css file (e.g quarto-html deps with Quarto CSS variables)
@@ -261,7 +260,7 @@ export async function resolveSassBundles(
     inputDir,
     extras,
     format,
-    temp,
+    project,
     hasDarkStyles ? "light" : "default",
     defaultStyle,
   );
@@ -272,7 +271,7 @@ export async function resolveSassBundles(
       inputDir,
       extras,
       format,
-      temp,
+      project,
       "dark",
       defaultStyle,
     );
@@ -291,7 +290,7 @@ async function resolveQuartoSyntaxHighlighting(
   inputDir: string,
   extras: FormatExtras,
   format: Format,
-  temp: TempContext,
+  project: ProjectContext,
   style: "dark" | "light" | "default",
   defaultStyle?: "dark" | "light",
 ) {
@@ -381,7 +380,7 @@ async function resolveQuartoSyntaxHighlighting(
             rules: rules.join("\n"),
           },
         }],
-        temp,
+        project,
         false,
       );
 
@@ -500,8 +499,9 @@ interface CSSResult {
 async function processCssIntoExtras(
   cssPath: string,
   extras: FormatExtras,
-  temp: TempContext,
+  project: ProjectContext,
 ): Promise<CSSResult> {
+  const { temp } = project;
   extras.html = extras.html || {};
 
   const css = Deno.readTextFileSync(cssPath);

src/command/render/pandoc.ts

@@ -536,7 +536,6 @@ export async function runPandoc(
       options.format,
       cwd,
       options.libDir,
-      options.services.temp,
       dependenciesFile,
       options.project,
     );
@@ -963,9 +962,6 @@ export async function runPandoc(
   // filter results json file
   const filterResultsFile = options.services.temp.createFile();
 
-  // timing results json file
-  const timingResultsFile = options.services.temp.createFile();
-
   const writerKeys: ("to" | "writer")[] = ["to", "writer"];
   for (const key of writerKeys) {
     if (allDefaults[key]?.match(/[.]lua$/)) {
@@ -1397,7 +1393,6 @@ async function resolveExtras(
   format: Format,
   inputDir: string,
   libDir: string,
-  temp: TempContext,
   dependenciesFile: string,
   project: ProjectContext,
 ) {
@@ -1415,7 +1410,6 @@ async function resolveExtras(
       inputDir,
       extras,
       format,
-      temp,
       project,
     );
 

src/command/render/render-contexts.ts

@@ -89,6 +89,21 @@ import {
 import { ExtensionContext } from "../../extension/types.ts";
 import { NotebookContext } from "../../render/notebook/notebook-types.ts";
 
+// we can't naively ld.cloneDeep everything
+// because that destroys class instances
+// with private members
+//
+// Currently, that's ProjectContext.
+//
+// TODO: Ideally, we shouldn't be copying the RenderContext at all.
+export function copyRenderContext(
+  context: RenderContext,
+): RenderContext {
+  return {
+    ...ld.cloneDeep(context),
+    project: context.project,
+  };
+}
 export async function resolveFormatsFromMetadata(
   metadata: Metadata,
   input: string,
@@ -741,20 +756,17 @@ export async function projectMetadataForInputFile(
   input: string,
   project: ProjectContext,
 ): Promise<Metadata> {
-  // don't mutate caller
-  project = ld.cloneDeep(project) as ProjectContext;
-
   if (project.dir && project.config) {
     // If there is directory and configuration information
     // process paths
     return toInputRelativePaths(
       projectType(project.config?.project?.[kProjectType]),
       project.dir,
       dirname(input),
-      project.config,
+      ld.cloneDeep(project.config),
     ) as Metadata;
   } else {
     // Just return the config or empty metadata
-    return project.config || {};
+    return ld.cloneDeep(project.config) || {};
   }
 }

src/command/render/render-files.ts

@@ -48,7 +48,7 @@ import { outputRecipe } from "./output.ts";
 
 import { renderPandoc } from "./render.ts";
 import { PandocRenderCompletion, RenderServices } from "./types.ts";
-import { renderContexts } from "./render-contexts.ts";
+import { copyRenderContext, renderContexts } from "./render-contexts.ts";
 import { renderProgress } from "./render-info.ts";
 import {
   ExecutedFile,
@@ -503,7 +503,7 @@ async function renderFileInternal(
 
   for (const format of Object.keys(contexts)) {
     pushTiming("render-context");
-    const context = ld.cloneDeep(contexts[format]) as RenderContext; // since we're going to mutate it...
+    const context = copyRenderContext(contexts[format]); // since we're going to mutate it...
 
     // disquality some documents from server: shiny
     if (isServerShiny(context.format) && context.project) {

src/command/render/render-shared.ts

@@ -33,6 +33,7 @@ import { kTextPlain } from "../../core/mime.ts";
 import { normalizePath } from "../../core/path.ts";
 import { notebookContext } from "../../render/notebook/notebook-context.ts";
 import { singleFileProjectContext } from "../../project/types/single-file/single-file.ts";
+import { assert } from "testing/asserts";
 
 export async function render(
   path: string,
@@ -95,8 +96,9 @@ export async function render(
   // validate that we didn't get any project-only options
   validateDocumentRenderFlags(options.flags);
 
+  assert(!context, "Expected no context here");
   // NB: singleFileProjectContext is currently not fully-featured
-  context = singleFileProjectContext(path, nbContext, options.flags);
+  context = await singleFileProjectContext(path, nbContext, options.flags);
 
   // otherwise it's just a file render
   const result = await renderFiles(

src/command/render/types.ts

@@ -102,7 +102,7 @@ export interface RenderResourceFiles {
 }
 
 export interface RenderResult {
-  context?: ProjectContext;
+  context: ProjectContext;
   baseDir?: string;
   outputDir?: string;
   files: RenderResultFile[];