Add HtmlDependency support for service workers

Author: dragonstyle

news/changelog-1.2.md

@@ -12,6 +12,7 @@
 ## Extensions
 
 - HTML dependencies may be provided by paths to files outside the extension directory
+- HTML dependencies may now include `serviceworkers`. `serviceworkers` will be copied into the output directory.
 
 ## HTML Format
 

package/src/common/dependencies/dependencies.ts

@@ -53,7 +53,7 @@ export interface PlatformDependency {
 function version(env: string) {
   const version = Deno.env.get(env);
   if (!version) {
-    throw Error(`${env} isn't defined with depedency version`);
+    throw Error(`${env} isn't defined with dependency version`);
   } else {
     return version;
   }

src/command/render/pandoc-dependencies-html.ts

@@ -15,6 +15,7 @@ import { pathWithForwardSlashes, safeExistsSync } from "../../core/path.ts";
 
 import {
   DependencyFile,
+  DependencyServiceWorker,
   FormatDependency,
   FormatExtras,
   kDependencies,
@@ -31,6 +32,8 @@ import {
 import { fixupCssReferences, isCssFile } from "../../core/css.ts";
 
 import { ensureDirSync } from "fs/mod.ts";
+import { ProjectContext } from "../../project/types.ts";
+import { projectOutputDir } from "../../project/project-shared.ts";
 
 export function writeDependencies(
   dependenciesFile: string,
@@ -54,6 +57,7 @@ export function readAndInjectDependencies(
   inputDir: string,
   libDir: string,
   doc: Document,
+  project?: ProjectContext,
 ) {
   const dependencyJsonStream = Deno.readTextFileSync(dependenciesFile);
   const htmlDependencies: FormatDependency[] = [];
@@ -77,6 +81,7 @@ export function readAndInjectDependencies(
       inputDir,
       libDir,
       injector,
+      project,
     );
     injectedDependencies.push(...injected);
     // Finalize the injection
@@ -119,6 +124,7 @@ export function resolveDependencies(
   inputDir: string,
   libDir: string,
   temp: TempContext,
+  project?: ProjectContext,
 ) {
   // deep copy to not mutate caller's object
   extras = ld.cloneDeep(extras);
@@ -133,6 +139,7 @@ export function resolveDependencies(
       inputDir,
       libDir,
       injector,
+      project,
     );
     // Finalize the injection
     injector.finalizeInjection();
@@ -196,6 +203,7 @@ function processHtmlDependencies(
   inputDir: string,
   libDir: string,
   injector: HtmlInjector,
+  project?: ProjectContext,
 ) {
   const copiedDependencies: FormatDependency[] = [];
   for (const dependency of dependencies) {
@@ -260,6 +268,60 @@ function processHtmlDependencies(
       });
     }
 
+    // Process Service Workers
+    if (dependency.serviceworkers) {
+      dependency.serviceworkers.forEach((serviceWorker) => {
+        const resolveDestination = (
+          worker: DependencyServiceWorker,
+          inputDir: string,
+          project?: ProjectContext,
+        ) => {
+          // First make sure there is a destination. If omitted, provide
+          // a default based upon the context
+          if (!worker.destination) {
+            if (project) {
+              worker.destination = `/${basename(worker.source)}`;
+            } else {
+              worker.destination = `${basename(worker.source)}`;
+            }
+          }
+
+          // Now return either a project path or an input
+          // relative path
+          if (worker.destination.startsWith("/")) {
+            if (project) {
+              // This is a project relative path
+              const projectDir = projectOutputDir(project);
+              return join(projectDir, worker.destination.slice(1));
+            } else {
+              throw new Error(
+                "A service worker is being provided with a project relative destination path but no valid Quarto project was found.",
+              );
+            }
+          } else {
+            // this is an input relative path
+            return join(inputDir, worker.destination);
+          }
+        };
+
+        // Compute the path to the destination
+        const destinationFile = resolveDestination(
+          serviceWorker,
+          inputDir,
+          project,
+        );
+        const destinationDir = dirname(destinationFile);
+
+        // Ensure the directory exists and copy the source file
+        // to the destination
+        ensureDirSync(destinationDir);
+        copyFileIfNewer(
+          serviceWorker.source,
+          destinationFile,
+        );
+      });
+    }
+
     // Process head HTML
     if (dependency.head) {
       injector.injectHtml(dependency.head);

src/command/render/pandoc.ts

@@ -1047,6 +1047,7 @@ async function resolveExtras(
             inputDir,
             libDir,
             doc,
+            project,
           ),
       );
     };

src/command/render/render-files.ts

@@ -313,6 +313,7 @@ export async function renderFiles(
           dirname(context.target.source),
           context.libDir,
           tempContext,
+          project,
         );
         if (extras[kIncludeInHeader]) {
           executeResult.includes[kIncludeInHeader] = [

src/config/types.ts

@@ -206,6 +206,7 @@ export interface FormatDependency {
   links?: { rel: string; href: string; type?: string }[];
   scripts?: DependencyHtmlFile[];
   stylesheets?: DependencyHtmlFile[];
+  serviceworkers?: DependencyServiceWorker[];
   head?: string;
   resources?: DependencyFile[];
 }
@@ -215,6 +216,11 @@ export interface DependencyFile {
   path: string;
 }
 
+export interface DependencyServiceWorker {
+  source: string;
+  destination?: string;
+}
+
 export interface DependencyHtmlFile extends DependencyFile {
   attribs?: Record<string, string>;
   afterBody?: boolean;

src/execute/ojs/compile.ts

@@ -797,6 +797,7 @@ export async function ojsCompile(
     dirname(options.source),
     options.libDir,
     options.temp,
+    project,
   );
 
   const ojsBundleTempFiles = [];

src/resources/pandoc/datadir/init.lua

@@ -1485,7 +1485,7 @@ local function resolveDependencyLinkTags(linkTags)
    end
 end
 
--- Convert depedency files which may be just a string (path) or
+-- Convert dependency files which may be just a string (path) or
 -- incomplete objects into valid file dependencies
 local function resolveFileDependencies(name, dependencyFiles)
    if dependencyFiles ~= nil then
@@ -1518,8 +1518,45 @@ local function resolveFileDependencies(name, dependencyFiles)
    else
      return nil
    end
+end
+
+-- Convert dependency files which may be just a string (path) or
+-- incomplete objects into valid file dependencies
+local function resolveServiceWorkers(serviceworkers)
+   if serviceworkers ~= nil then 
+    -- make sure this is an array
+     if type(serviceworkers) ~= "table" or not utils.table.isarray(serviceworkers) then
+       error("Invalid HTML Dependency: serviceworkers property must be an array")
+     end
+ 
+     local finalServiceWorkers = {}
+     for i, v in ipairs(serviceworkers) do
+       if type(v) == "table" then
+         -- fill in the destination as the root, if one is not provided
+         if v.source == nil then
+           error("Invalid HTML Dependency: a serviceworker must have a source.")
+         else
+           v.source = resolvePathExt(v.source)
+         end
+         finalServiceWorkers[i] = v
+
+       elseif type(v) == "string" then
+         -- turn a string into a name and path
+         finalServiceWorkers[i] = {
+            source = resolvePathExt(v)
+         }
+       else
+         -- who knows what this is!
+         error("Invalid HTML Dependency: serviceworkers property contains an unexpected type.")
+       end
+     end
+     return finalServiceWorkers
+   else
+     return nil
+   end
  end
 
+
 local latexTableWithOptionsPattern = "(\\begin{table}%[%w+%])(.*)(\\end{table})"
 local latexTablePattern = "(\\begin{table})(.*)(\\end{table})"
 local latexLongtablePatternwWithPosAndAlign = "(\\begin{longtable}%[[^%]]+%]{.-})(.*)(\\end{longtable})"
@@ -1589,8 +1626,9 @@ quarto = {
          htmlDependency.scripts == nil and 
          htmlDependency.stylesheets == nil and 
          htmlDependency.resources == nil and
+         htmlDependency.seviceworkers == nil and
          htmlDependency.head == nil then
-         error("HTML dependencies must include at least one of meta, links, scripts, stylesheets, or resources. All appear empty.")
+         error("HTML dependencies must include at least one of meta, links, scripts, stylesheets, seviceworkers, or resources. All appear empty.")
       end
 
       -- validate that the meta is as expected
@@ -1630,6 +1668,7 @@ quarto = {
          scripts = resolveDependencyFilePaths(htmlDependency.scripts),
          stylesheets = resolveDependencyFilePaths(htmlDependency.stylesheets),
          resources = resolveDependencyFilePaths(htmlDependency.resources),
+         serviceworkers = resolveServiceWorkers(htmlDependency.serviceworkers),
          head = htmlDependency.head,
       }))
     end,