when session cache is used, register cleanup at tempContext cleanup and not exit cleanup

It happens we do cleanup in several places, with at least

- renderServices cleanup calling `lifetime.cleanup()`
- exit cleanup calling `exitWithCleanup()`

The problem is that when session cache is used, we need to register cleanup at tempContext cleanup and not just exit cleanup because tempContext cleanup will try to remove the directory in session cache, and it will fail because Deno.kv is still opened.

Author: cderv

src/core/sass.ts

@@ -307,8 +307,8 @@ export async function compileWithCache(
     const cacheDir = useSessionCache
       ? join(temp.baseDir, "sass")
       : quartoCacheDir("sass");
-    // when using quarto session cache, we ensure to cleanup the cache files
-    const cache = await sassCache(cacheDir, !!useSessionCache);
+    // when using quarto session cache, we ensure to cleanup the cache files at TempContext cleanup
+    const cache = await sassCache(cacheDir, useSessionCache ? temp : undefined);
     return cache.getOrSet(input, loadPaths, temp, cacheIdentifier, compressed);
   } else {
     const outputFilePath = temp.createFile({ suffix: ".css" });

src/core/sass/cache.ts

@@ -158,13 +158,16 @@ class SassCache {
   }
 
   // add a cleanup method to register a cleanup handler
-  cleanup(removeCachePath: boolean = true) {
-    onCleanup(() => {
+  cleanup(temp: TempContext | undefined) {
+    const registerCleanup = temp ? temp.onCleanup : onCleanup;
+    registerCleanup(() => {
       try {
         this.kv.close();
-        if (removeCachePath) safeRemoveIfExists(this.path);
+        if (!temp) safeRemoveIfExists(this.path);
       } catch (error) {
-        log.info("Error occurred during sass cache cleanup: " + error);
+        log.info(
+          `Error occurred during sass cache cleanup for ${this.path}: ${error}`,
+        );
       }
     });
   }
@@ -205,9 +208,10 @@ async function checkVersion(kv: Deno.Kv, path: string) {
 }
 
 const _sassCache: Record<string, SassCache> = {};
+
 export async function sassCache(
   path: string,
-  removeCachePath: boolean = false,
+  temp: TempContext | undefined,
 ): Promise<SassCache> {
   if (!_sassCache[path]) {
     log.debug(`Creating SassCache at ${path}`);
@@ -217,7 +221,7 @@ export async function sassCache(
     await checkVersion(kv, kvFile);
     _sassCache[path] = new SassCache(kv, path);
     // register cleanup for this cache
-    _sassCache[path].cleanup(removeCachePath);
+    _sassCache[path].cleanup(temp);
   }
   log.debug(`Returning SassCache at ${path}`);
   const result = _sassCache[path];

src/core/temp-types.ts

@@ -9,4 +9,5 @@ export interface TempContext {
   createFile: (options?: Deno.MakeTempOptions) => string;
   createDir: (options?: Deno.MakeTempOptions) => string;
   cleanup: () => void;
+  onCleanup: (handler: VoidFunction) => VoidFunction[];
 }

src/core/temp.ts

@@ -4,7 +4,7 @@
  * Copyright (C) 2020-2022 Posit Software, PBC
  */
 
-import { debug } from "../deno_ral/log.ts";
+import { debug, info } from "../deno_ral/log.ts";
 import { join } from "../deno_ral/path.ts";
 import { ensureDirSync, existsSync } from "fs/mod.ts";
 import { normalizePath, removeIfExists, safeRemoveIfExists } from "./path.ts";
@@ -58,6 +58,9 @@ export function createTempContext(options?: Deno.MakeTempOptions) {
     ...options,
     dir: tempDir,
   });
+
+  const tempContextCleanupHandlers: VoidFunction[] = [];
+
   return {
     baseDir: dir,
     createFile: (options?: Deno.MakeTempOptions) => {
@@ -68,10 +71,22 @@ export function createTempContext(options?: Deno.MakeTempOptions) {
     },
     cleanup: () => {
       if (dir) {
+        // Not using .reverse() to not mutate the original array
+        for (let i = tempContextCleanupHandlers.length - 1; i >= 0; i--) {
+          const handler = tempContextCleanupHandlers[i];
+          try {
+            handler();
+          } catch (error) {
+            info("Error occurred during tempContext handler cleanup: " + error);
+          }
+        }
         safeRemoveIfExists(dir);
         dir = undefined;
       }
     },
+    onCleanup(handler: VoidFunction) {
+      tempContextCleanupHandlers.push(handler);
+    },
   };
 }