@lde/distribution-downloader 0.6.8 → 0.6.9

package/README.md

@@ -1,3 +1,13 @@
-# Distribution Download
+# @lde/distribution-downloader
 
 Downloads Distribution files from a given URL and saves them to the local filesystem.
+
+## Installation
+
+```sh
+npm install @lde/distribution-downloader
+```
+
+## Documentation
+
+See the [full documentation](https://ldelements.org/reference/distribution-downloader).

package/dist/download.d.ts

@@ -9,6 +9,17 @@ export interface Logger {
 }
 export interface DownloadOptions {
     logger?: Logger;
+    /**
+     * Idle timeout in milliseconds: the download is aborted when no bytes have
+     * arrived for this long, whether while waiting for the response headers or
+     * midway through the body. A large file that keeps flowing is never cut off,
+     * however long it takes. Defaults to 300 000 ms (5 minutes).
+     */
+    timeout?: number;
+    /**
+     * Cancels the download when aborted; the partial file is removed.
+     */
+    signal?: AbortSignal;
 }
 export interface DownloadResult {
     path: string;

package/dist/download.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../src/download.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAM5C,MAAM,WAAW,MAAM;IACrB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC7C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC7C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC5C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC5C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC7C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;CAC9C;AAaD,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CACN,YAAY,EAAE,YAAY,EAC1B,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5B;AAED,qBAAa,sBAAuB,YAAW,UAAU;IAC3C,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,SAAY;IAEhC,QAAQ,CACnB,YAAY,EAAE,YAAY,EAC1B,MAAM,SAAyD,EAC/D,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC;YA0CZ,mBAAmB;CAyBlC"}
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../src/download.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAO5C,MAAM,WAAW,MAAM;IACrB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC7C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC7C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC5C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC5C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC7C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;CAC9C;AAaD,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CACN,YAAY,EAAE,YAAY,EAC1B,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5B;AAED,qBAAa,sBAAuB,YAAW,UAAU;IAC3C,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,SAAY;IAEhC,QAAQ,CACnB,YAAY,EAAE,YAAY,EAC1B,MAAM,SAAyD,EAC/D,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC;YA0EZ,mBAAmB;CAyBlC"}

package/dist/download.js

@@ -1,5 +1,6 @@
 import filenamifyUrl from 'filenamify-url';
 import { dirname, join, resolve, sep } from 'node:path';
+import { Transform } from 'node:stream';
 import { pipeline } from 'node:stream/promises';
 import { createWriteStream } from 'node:fs';
 import { access, mkdir, rm, stat } from 'node:fs/promises';
@@ -30,26 +31,45 @@ export class LastModifiedDownloader {
             logger.debug(`File ${filePath} is up to date, skipping download.`);
             return { path: filePath, headers: new Headers() };
         }
-        const downloadResponse = await fetch(downloadUrl, {
-            signal: AbortSignal.timeout(300_000),
-        });
-        if (!downloadResponse.ok || !downloadResponse.body) {
-            throw new Error(`Failed to download ${downloadUrl}: ${downloadResponse.statusText}`);
-        }
+        const idleTimeout = options?.timeout ?? 300_000;
+        const idleAbortController = new AbortController();
+        let idleTimer;
+        const restartIdleTimer = () => {
+            clearTimeout(idleTimer);
+            idleTimer = setTimeout(() => idleAbortController.abort(new Error(`No data received for ${idleTimeout} ms`)), idleTimeout);
+        };
+        const signal = options?.signal === undefined
+            ? idleAbortController.signal
+            : AbortSignal.any([options.signal, idleAbortController.signal]);
+        restartIdleTimer();
         try {
-            await mkdir(dirname(filePath), { recursive: true });
-            await pipeline(downloadResponse.body, createWriteStream(filePath));
-        }
-        catch (error) {
-            await rm(filePath, { force: true });
-            throw new Error(`Failed to save ${downloadUrl} to ${filePath}: ${error}`);
+            const downloadResponse = await fetch(downloadUrl, { signal });
+            if (!downloadResponse.ok || !downloadResponse.body) {
+                throw new Error(`Failed to download ${downloadUrl}: ${downloadResponse.statusText}`);
+            }
+            try {
+                await mkdir(dirname(filePath), { recursive: true });
+                await pipeline(downloadResponse.body, new Transform({
+                    transform(chunk, _encoding, callback) {
+                        restartIdleTimer();
+                        callback(null, chunk);
+                    },
+                }), createWriteStream(filePath));
+            }
+            catch (error) {
+                await rm(filePath, { force: true });
+                throw new Error(`Failed to save ${downloadUrl} to ${filePath}: ${error}`);
+            }
+            const stats = await stat(filePath);
+            if (stats.size <= 1) {
+                logger.debug(`Distribution download ${downloadUrl} is empty`);
+                throw new Error('Distribution download is empty');
+            }
+            return { path: filePath, headers: downloadResponse.headers };
         }
-        const stats = await stat(filePath);
-        if (stats.size <= 1) {
-            logger.debug(`Distribution download ${downloadUrl} is empty`);
-            throw new Error('Distribution download is empty');
+        finally {
+            clearTimeout(idleTimer);
         }
-        return { path: filePath, headers: downloadResponse.headers };
     }
     async localFileIsUpToDate(filePath, distribution) {
         if (undefined === distribution.lastModified) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lde/distribution-downloader",
-  "version": "0.6.8",
+  "version": "0.6.9",
   "repository": {
     "url": "git+https://github.com/ldelements/lde.git",
     "directory": "packages/distribution-downloader"