Allow serving content from .zip files via CLI

Author: davidje13

src/bin/ServerManager.mts

@@ -3,7 +3,7 @@ import { createServer, type Server, type ServerOptions } from 'node:http';
 import type { Readable, Writable } from 'node:stream';
 import { findCause, HTTPError, WebListener, type ListenOptions } from '../index.mts';
 import type { ConfigServer, ConfigServerOptions, ConfigBackgroundTask } from './config/types.mts';
-import { buildRouter } from './buildRouter.mts';
+import { buildRouter } from './routes/buildRouter.mts';
 import type { Logger, AddColour } from './log.mts';
 import { TransientError } from './TransientError.mts';
 

src/bin/ServerManager.test.mts

@@ -248,7 +248,7 @@ describe('ServerManager', () => {
           ],
           () => fail(),
         );
-        expect(logs).contains(matches(/directory to serve not found/));
+        expect(logs).contains(matches(/content to serve not found/));
         expect(logs).not(contains(`http://localhost:${port} ready`));
         expect(logs).not(contains('all servers ready'));
 
@@ -299,8 +299,8 @@ describe('ServerManager', () => {
         );
         const capturedError = await awaitError;
         expect(capturedError).isInstanceOf(Error);
-        expect((capturedError as Error).message).contains('directory to serve not found');
-        expect(logs).contains(matches(/directory to serve not found/));
+        expect((capturedError as Error).message).contains('content to serve not found');
+        expect(logs).contains(matches(/content to serve not found/));
         expect(logs).not(contains(`http://localhost:${port} ready`));
         expect(logs).not(contains('all servers ready'));
       } finally {

src/bin/config/types.mts

@@ -4,7 +4,7 @@ import type {
   CombinedServerOptions,
   FileNegotiation,
 } from '../../index.mts';
-import type { DependencyHandlerOptions } from '../modules/dependencies.mts';
+import type { DependencyHandlerOptions } from '../routes/modules/dependencies.mts';
 import type { LogLevel } from '../log.mts';
 
 export type ConfigHeaders = Record<string, string | number | string[]>;

src/bin/man1/web-listener.1

@@ -119,6 +119,10 @@ providing a newline to stdin.
 .
 .It Fl d Ar directory , Fl -dir Ar directory
 The directory to serve files from, relative to the current working directory.
+This can also be the path to a .zip file, or a path within a .zip file
+.Po "e.g. "
+.Qq "/path/to/file.zip/path/within/zip"
+.Pc .
 Can be specified multiple times to provide fall-backs.
 Defaults to
 .Qq "." .

src/bin/routes/anyFileFinder.mts

@@ -0,0 +1,56 @@
+import { stat } from 'node:fs/promises';
+import { join, sep } from 'node:path';
+import {
+  dynamicFileFinder,
+  negotiateEncoding,
+  Negotiator,
+  readZip,
+  staticFileFinder,
+  zipFileFinder,
+  type FileFinder,
+  type FileServerOptions,
+} from '../../index.mts';
+import { TransientError } from '../TransientError.mts';
+
+export async function anyFileFinder(path: string, options: FileServerOptions): Promise<FileFinder> {
+  const direct = await stat(path).catch(() => null);
+  if (direct?.isDirectory()) {
+    if (options.mode === 'static-paths') {
+      return staticFileFinder(path, options);
+    } else {
+      return dynamicFileFinder(path, options);
+    }
+  }
+
+  const parts = path.split(sep);
+  if (parts[parts.length - 1] === '') {
+    parts.pop();
+  }
+  if (!parts[0]) {
+    parts.shift();
+    if (parts.length > 0) {
+      parts[0] = sep + parts[0];
+    }
+  }
+  for (let i = parts.length; i > 0; --i) {
+    const filePath = join(...parts.slice(0, i));
+    const stats = await stat(filePath).catch(() => null);
+    if (!stats) {
+      continue;
+    }
+    if (!stats.isFile()) {
+      break;
+    }
+    const zipRoot = await readZip(filePath);
+    const zipDir = zipRoot.find(parts.slice(i));
+    if (!zipDir?.isDirectory) {
+      throw new Error(`${parts.slice(i).join('/')} in ${filePath} is not a directory`);
+    }
+    const adjustedOptions = options;
+    if (!adjustedOptions.negotiator) {
+      adjustedOptions.negotiator = new Negotiator([negotiateEncoding(['deflate'])]);
+    }
+    return zipFileFinder(zipDir, adjustedOptions);
+  }
+  throw new TransientError(`content to serve not found at ${path}`);
+}

src/bin/routes/anyFileFinder.test.mts

@@ -0,0 +1,72 @@
+import { dirname, join, sep } from 'node:path';
+import { makeTestTempDir } from '../../test-helpers/makeFileStructure.mts';
+import { anyFileFinder } from './anyFileFinder.mts';
+import 'lean-test';
+
+describe('anyFileFinder', () => {
+  describe('given a directory', () => {
+    const TEST_DIR = makeTestTempDir('aff-', { 'file.txt': 'Content' });
+
+    it('loads directories dynamically', async ({ getTyped }) => {
+      const fileFinder = await anyFileFinder(getTyped(TEST_DIR), {});
+      expect(fileFinder.isStaticListing).isFalse();
+      const file = await fileFinder.find(['file.txt']);
+      await file?.handle.close();
+      expect(file?.stats.size).equals(7);
+    });
+
+    it('loads directories statically', async ({ getTyped }) => {
+      const fileFinder = await anyFileFinder(getTyped(TEST_DIR), { mode: 'static-paths' });
+      expect(fileFinder.isStaticListing).isTrue();
+      const file = await fileFinder.find(['file.txt']);
+      await file?.handle.close();
+      expect(file?.stats.size).equals(7);
+    });
+  });
+
+  it('loads zip contents', async () => {
+    const testZip = join(dirname(new URL(import.meta.url).pathname), 'test-assets.zip');
+
+    const fileFinder = await anyFileFinder(testZip, {});
+    expect(fileFinder.isStaticListing).isTrue();
+    const file1 = await fileFinder.find(['file.txt']);
+    await file1?.handle.close();
+    expect(file1?.stats.size).equals(7);
+
+    const file2 = await fileFinder.find(['sub', 'subfile.txt']);
+    await file2?.handle.close();
+    expect(file2?.stats.size).equals(14);
+  });
+
+  it('loads zip contents with trailing slash', async () => {
+    const testZip = join(dirname(new URL(import.meta.url).pathname), 'test-assets.zip') + sep;
+
+    const fileFinder = await anyFileFinder(testZip, {});
+    expect(fileFinder.isStaticListing).isTrue();
+    const file1 = await fileFinder.find(['file.txt']);
+    await file1?.handle.close();
+    expect(file1?.stats.size).equals(7);
+
+    const file2 = await fileFinder.find(['sub', 'subfile.txt']);
+    await file2?.handle.close();
+    expect(file2?.stats.size).equals(14);
+  });
+
+  it('loads nested zip contents', async () => {
+    const testZip = join(dirname(new URL(import.meta.url).pathname), 'test-assets.zip', 'sub');
+
+    const fileFinder = await anyFileFinder(testZip, {});
+    expect(fileFinder.isStaticListing).isTrue();
+    const file = await fileFinder.find(['subfile.txt']);
+    await file?.handle.close();
+    expect(file?.stats.size).equals(14);
+
+    expect(await fileFinder.find(['file.txt'])).isNull();
+  });
+
+  it('throws if given a path which does not exist', async () => {
+    await expect(() => anyFileFinder('/does/not/exist', {})).throws(
+      'content to serve not found at /does/not/exist',
+    );
+  });
+});

src/bin/buildRouter.mts src/bin/routes/buildRouter.mtssrc/bin/buildRouter.mts renamed to src/bin/routes/buildRouter.mts

@@ -2,8 +2,8 @@ import type { IncomingMessage, ServerResponse } from 'node:http';
 import { readFile } from 'node:fs/promises';
 import {
   addTeardown,
+  assetServer,
   CONTINUE,
-  fileServer,
   getPathParameter,
   getQuery,
   getSearch,
@@ -12,12 +12,13 @@ import {
   requestHandler,
   Router,
   getAbsolutePath,
-} from '../index.mts';
-import type { ConfigMount } from './config/types.mts';
+} from '../../index.mts';
+import type { ConfigMount } from '../config/types.mts';
+import { TransientError } from '../TransientError.mts';
 import { dependencies } from './modules/dependencies.mts';
+import { anyFileFinder } from './anyFileFinder.mts';
 import { Mapper, nginxTokenise } from './nginx.mts';
 import { render } from './template.mts';
-import { TransientError } from './TransientError.mts';
 
 export interface LogInfo {
   method: string;
@@ -58,15 +59,13 @@ export async function buildRouter(mount: ConfigMount[], log: (info: LogInfo) =>
             item.options.negotiation && item.options.negotiation.length > 0
               ? new Negotiator(item.options.negotiation)
               : undefined;
-          try {
-            router.mount(item.path, await fileServer(item.dir, { ...item.options, negotiator }));
-          } catch (error: unknown) {
-            if (error && typeof error === 'object' && 'code' in error && error.code === 'ENOENT') {
-              throw new TransientError(`directory to serve not found at ${item.dir}`);
-            } else {
-              throw error;
-            }
-          }
+          router.mount(
+            item.path,
+            assetServer(
+              await anyFileFinder(item.dir, { ...item.options, negotiator }),
+              item.options,
+            ),
+          );
         }
         break;
       case 'proxy':

src/bin/buildRouter.test.mts src/bin/routes/buildRouter.test.mtssrc/bin/buildRouter.test.mts renamed to src/bin/routes/buildRouter.test.mts

@@ -1,9 +1,9 @@
 import { join } from 'node:path';
-import { requestHandler } from '../index.mts';
-import { makeTestTempDir } from '../test-helpers/makeFileStructure.mts';
-import { responds } from '../test-helpers/responds.mts';
-import { withServer } from '../test-helpers/withServer.mts';
-import type { ConfigMount } from './config/types.mts';
+import { requestHandler } from '../../index.mts';
+import { makeTestTempDir } from '../../test-helpers/makeFileStructure.mts';
+import { responds } from '../../test-helpers/responds.mts';
+import { withServer } from '../../test-helpers/withServer.mts';
+import type { ConfigMount } from '../config/types.mts';
 import { buildRouter, type LogInfo } from './buildRouter.mts';
 import 'lean-test';
 

src/bin/modules/PackageInfo.mts src/bin/routes/modules/PackageInfo.mtssrc/bin/modules/PackageInfo.mts renamed to src/bin/routes/modules/PackageInfo.mts

@@ -1,7 +1,7 @@
 import { access, constants, readdir, readFile, realpath, stat } from 'node:fs/promises';
 import { dirname, join, sep } from 'node:path';
 import { fileURLToPath, pathToFileURL } from 'node:url';
-import { Queue } from '../../index.mts';
+import { Queue } from '../../../index.mts';
 
 export interface PackageInfo {
   isRoot: boolean;

src/bin/modules/PackageInfo.test.mts …/bin/routes/modules/PackageInfo.test.mtssrc/bin/modules/PackageInfo.test.mts renamed to src/bin/routes/modules/PackageInfo.test.mts src/bin/modules/PackageInfo.test.mts renamed to src/bin/routes/modules/PackageInfo.test.mts

@@ -1,5 +1,5 @@
 import { join } from 'node:path';
-import { makeTestTempDir } from '../../test-helpers/makeFileStructure.mts';
+import { makeTestTempDir } from '../../../test-helpers/makeFileStructure.mts';
 import { getResolvedExportMap, readPackageGraph, type PackageJson } from './PackageInfo.mts';
 import 'lean-test';