koa-files 3.1.4 → 3.1.6

package/README.md

@@ -91,7 +91,7 @@ export default function server(root: string, options?: Options): Middleware;
 
 ##### `highWaterMark`
 
-- Defaults to `node:stream.Readable.highWaterMark`.
+- Defaults to `65536` (64 KiB).
 - Set the high water mark for the read stream.
 
 ##### `ignore`

package/cjs/Service.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/fs.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/hash.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/http.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/path.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/cjs/utils/stream.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -15,6 +15,7 @@ const stream = require('stream');
 /**
  * @module stream
  */
+const DISPOSE_EVENT = Symbol('dispose');
 class FileReadStream extends stream.Readable {
   /**
    * @constructor
@@ -23,9 +24,10 @@ class FileReadStream extends stream.Readable {
    * @param options The stream options.
    */
   constructor(path, ranges, options) {
-    const { fs, encoding, highWaterMark } = options;
+    const { fs, encoding, highWaterMark = 65536 } = options;
     super({ encoding, highWaterMark });
     this.bytesRead = 0;
+    this.fd = null;
     this.reading = false;
     this.currentRangeIndex = 0;
     this.readState = 0 /* ReadState.PREFIX */;
@@ -77,6 +79,7 @@ class FileReadStream extends stream.Readable {
     let bytesRead = 0;
     const padding = this.getPadding(range);
     const hasRangePadding = padding != null;
+    // If padding exists.
     if (hasRangePadding) {
       const { length } = padding;
       const begin = this.bytesRead;
@@ -87,9 +90,11 @@ class FileReadStream extends stream.Readable {
         this.bytesRead = end;
       }
     }
+    // If no padding or read completed.
     if (bytesRead <= 0) {
       this.bytesRead = 0;
       const { readState } = this;
+      // Change read state.
       switch (readState) {
         case 0 /* ReadState.PREFIX */:
           this.readState = 1 /* ReadState.RANGE */;
@@ -119,21 +124,27 @@ class FileReadStream extends stream.Readable {
     this.reading = true;
     const { bytesRead } = this;
     const position = range.offset + bytesRead;
-    const buffer$1 = buffer.Buffer.alloc(Math.min(size, range.length - bytesRead));
+    const buffer$1 = buffer.Buffer.allocUnsafeSlow(Math.min(size, range.length - bytesRead));
+    // Read file range.
     this.fs.read(fd, buffer$1, 0, buffer$1.length, position, (readError, bytesRead, buffer) => {
-      if (readError != null) {
-        this.destroy(readError);
+      this.reading = false;
+      // Tell ._destroy() that it's safe to close the fd now.
+      if (this.destroyed) {
+        this.emit(DISPOSE_EVENT, readError);
       } else {
-        if (bytesRead > 0) {
-          this.push(buffer.subarray(0, bytesRead));
-          this.bytesRead += bytesRead;
+        if (readError != null) {
+          this.destroy(readError);
         } else {
-          this.bytesRead = 0;
-          this.readState = 2 /* ReadState.SUFFIX */;
-          this.readFilePadding(fd, range, size);
+          if (bytesRead > 0) {
+            this.push(buffer.subarray(0, bytesRead));
+            this.bytesRead += bytesRead;
+          } else {
+            this.bytesRead = 0;
+            this.readState = 2 /* ReadState.SUFFIX */;
+            this.readFilePadding(fd, range, size);
+          }
         }
       }
-      this.reading = false;
     });
   }
   /**
@@ -145,10 +156,12 @@ class FileReadStream extends stream.Readable {
     if (!this.reading) {
       const { fd } = this;
       const range = this.getRange();
+      // If fd or range is null, finish stream.
       if (fd == null || range == null) {
         this.push(null);
       } else {
         const { readState } = this;
+        // Read bytes from range.
         switch (readState) {
           case 0 /* ReadState.PREFIX */:
           case 2 /* ReadState.SUFFIX */:
@@ -162,14 +175,16 @@ class FileReadStream extends stream.Readable {
     }
   }
   /**
-   * @override
-   * @method _destroy
+   * @private
+   * @method dispose
    * @param error The error.
    * @param callback The callback.
    */
-  _destroy(error, callback) {
+  dispose(error, callback) {
     const { fd } = this;
     if (fd != null) {
+      this.fd = null;
+      // Close the fd.
       this.fs.close(fd, closeError => {
         callback(error !== null && error !== void 0 ? error : closeError);
       });
@@ -177,6 +192,22 @@ class FileReadStream extends stream.Readable {
       callback(error);
     }
   }
+  /**
+   * @override
+   * @method _destroy
+   * @param error The error.
+   * @param callback The callback.
+   */
+  _destroy(error, callback) {
+    // Wait I/O completion.
+    if (this.reading) {
+      this.once(DISPOSE_EVENT, disposeError => {
+        this.dispose(error !== null && error !== void 0 ? error : disposeError, callback);
+      });
+    } else {
+      this.dispose(error, callback);
+    }
+  }
 }
 
 exports.FileReadStream = FileReadStream;

package/esm/Service.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/index.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/fs.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/hash.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/http.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/path.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme

package/esm/utils/stream.js

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 3.1.4
+ * @version 3.1.6
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -13,6 +13,7 @@ import { Readable } from 'stream';
 /**
  * @module stream
  */
+const DISPOSE_EVENT = Symbol('dispose');
 class FileReadStream extends Readable {
   /**
    * @constructor
@@ -21,9 +22,10 @@ class FileReadStream extends Readable {
    * @param options The stream options.
    */
   constructor(path, ranges, options) {
-    const { fs, encoding, highWaterMark } = options;
+    const { fs, encoding, highWaterMark = 65536 } = options;
     super({ encoding, highWaterMark });
     this.bytesRead = 0;
+    this.fd = null;
     this.reading = false;
     this.currentRangeIndex = 0;
     this.readState = 0 /* ReadState.PREFIX */;
@@ -75,6 +77,7 @@ class FileReadStream extends Readable {
     let bytesRead = 0;
     const padding = this.getPadding(range);
     const hasRangePadding = padding != null;
+    // If padding exists.
     if (hasRangePadding) {
       const { length } = padding;
       const begin = this.bytesRead;
@@ -85,9 +88,11 @@ class FileReadStream extends Readable {
         this.bytesRead = end;
       }
     }
+    // If no padding or read completed.
     if (bytesRead <= 0) {
       this.bytesRead = 0;
       const { readState } = this;
+      // Change read state.
       switch (readState) {
         case 0 /* ReadState.PREFIX */:
           this.readState = 1 /* ReadState.RANGE */;
@@ -117,21 +122,27 @@ class FileReadStream extends Readable {
     this.reading = true;
     const { bytesRead } = this;
     const position = range.offset + bytesRead;
-    const buffer = Buffer.alloc(Math.min(size, range.length - bytesRead));
+    const buffer = Buffer.allocUnsafeSlow(Math.min(size, range.length - bytesRead));
+    // Read file range.
     this.fs.read(fd, buffer, 0, buffer.length, position, (readError, bytesRead, buffer) => {
-      if (readError != null) {
-        this.destroy(readError);
+      this.reading = false;
+      // Tell ._destroy() that it's safe to close the fd now.
+      if (this.destroyed) {
+        this.emit(DISPOSE_EVENT, readError);
       } else {
-        if (bytesRead > 0) {
-          this.push(buffer.subarray(0, bytesRead));
-          this.bytesRead += bytesRead;
+        if (readError != null) {
+          this.destroy(readError);
         } else {
-          this.bytesRead = 0;
-          this.readState = 2 /* ReadState.SUFFIX */;
-          this.readFilePadding(fd, range, size);
+          if (bytesRead > 0) {
+            this.push(buffer.subarray(0, bytesRead));
+            this.bytesRead += bytesRead;
+          } else {
+            this.bytesRead = 0;
+            this.readState = 2 /* ReadState.SUFFIX */;
+            this.readFilePadding(fd, range, size);
+          }
         }
       }
-      this.reading = false;
     });
   }
   /**
@@ -143,10 +154,12 @@ class FileReadStream extends Readable {
     if (!this.reading) {
       const { fd } = this;
       const range = this.getRange();
+      // If fd or range is null, finish stream.
       if (fd == null || range == null) {
         this.push(null);
       } else {
         const { readState } = this;
+        // Read bytes from range.
         switch (readState) {
           case 0 /* ReadState.PREFIX */:
           case 2 /* ReadState.SUFFIX */:
@@ -160,14 +173,16 @@ class FileReadStream extends Readable {
     }
   }
   /**
-   * @override
-   * @method _destroy
+   * @private
+   * @method dispose
    * @param error The error.
    * @param callback The callback.
    */
-  _destroy(error, callback) {
+  dispose(error, callback) {
     const { fd } = this;
     if (fd != null) {
+      this.fd = null;
+      // Close the fd.
       this.fs.close(fd, closeError => {
         callback(error !== null && error !== void 0 ? error : closeError);
       });
@@ -175,6 +190,22 @@ class FileReadStream extends Readable {
       callback(error);
     }
   }
+  /**
+   * @override
+   * @method _destroy
+   * @param error The error.
+   * @param callback The callback.
+   */
+  _destroy(error, callback) {
+    // Wait I/O completion.
+    if (this.reading) {
+      this.once(DISPOSE_EVENT, disposeError => {
+        this.dispose(error !== null && error !== void 0 ? error : disposeError, callback);
+      });
+    } else {
+      this.dispose(error, callback);
+    }
+  }
 }
 
 export { FileReadStream };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa-files",
-  "version": "3.1.4",
+  "version": "3.1.6",
   "description": "A static files serving middleware for koa.",
   "type": "module",
   "main": "cjs/index.cjs",

package/types/utils/stream.d.ts

@@ -18,11 +18,11 @@ interface Callback {
   (error?: Error | null): void;
 }
 export declare class FileReadStream extends Readable {
-  private fd?;
   private fs;
   private path;
   private ranges;
   private bytesRead;
+  private fd;
   private reading;
   private currentRangeIndex;
   private readState;
@@ -72,6 +72,13 @@ export declare class FileReadStream extends Readable {
    * @param size The number of bytes to read.
    */
   _read(size: number): void;
+  /**
+   * @private
+   * @method dispose
+   * @param error The error.
+   * @param callback The callback.
+   */
+  private dispose;
   /**
    * @override
    * @method _destroy