Error handling tests and hardening

Author: bencmbrook

src/utils/index.ts

@@ -6,7 +6,6 @@ export { default as getOrigins } from './get-origins.js';
 export { default as blobCache } from './blob-cache.js';
 export { default as isViewableText } from './is-viewable-text.js';
 export { default as isNumber } from './is-number.js';
-export { default as throwOutside } from './throw-outside.js';
 export { default as parseBase64OrUint8Array } from './parse-base64-or-uint8array.js';
 export { default as emitError } from './emit-error.js';
 export { default as onPenumbraEvent } from './forward-events.js';

src/utils/throw-outside.ts

@@ -2,12 +2,7 @@ import { Writer } from '@transcend-io/conflux';
 import mime from 'mime';
 import { StreamSaverInstance } from './streamsaver.js';
 import type { PenumbraFile, ZipOptions } from './types.js';
-import {
-  isNumber,
-  emitZipProgress,
-  emitZipCompletion,
-  throwOutside,
-} from './utils/index.js';
+import { isNumber, emitZipProgress, emitZipCompletion } from './utils/index.js';
 import { logger } from './logger.js';
 
 /**
@@ -34,11 +29,9 @@ const sumWrites = async (writes: Promise<number>[]): Promise<number> => {
       logger.error(error.reason, null);
     }
     // Throw AggregateError to console
-    throwOutside(
-      new AggregateError(
-        errors,
-        `File${errors.length > 1 ? 's' : ''} failed to be written to zip`,
-      ),
+    throw new AggregateError(
+      errors,
+      `File${errors.length > 1 ? 's' : ''} failed to be written to zip`,
     );
   }
 
@@ -66,7 +59,7 @@ export class PenumbraZipWriter extends EventTarget {
   private saveBuffer = false;
 
   /** Zip buffer used for testing */
-  private zipBuffer: Promise<ArrayBuffer> | undefined;
+  private zipBufferPromise: Promise<ArrayBuffer> | undefined;
 
   /** Allow & auto-rename duplicate files sent to writer */
   private allowDuplicates: boolean;
@@ -90,7 +83,7 @@ export class PenumbraZipWriter extends EventTarget {
   private bytesWritten = 0;
 
   /** Promise representing completion of the zip stream piping to the file sink */
-  private pipePromise?: Promise<void>;
+  public pipePromise?: Promise<void>;
 
   /**
    * Penumbra zip writer constructor
@@ -119,6 +112,7 @@ export class PenumbraZipWriter extends EventTarget {
       'abort',
       () => {
         this.close().catch((error: unknown) => {
+          logger.error(error, null);
           logger.error(
             `Failed to close zip writer: ${error instanceof Error ? error.message : String(error)}`,
             null,
@@ -158,20 +152,34 @@ export class PenumbraZipWriter extends EventTarget {
     // keep the original promise's rejection for callers that await `done()`.
     // This is intentionally not chained to the `zipStream.pipeTo()` promise, so that `this.pipePromise` throws as normal.
     this.pipePromise.catch((error: unknown) => {
-      const finalError =
+      const asError =
         error instanceof Error
           ? error
           : typeof error === 'string'
             ? new Error(error)
             : new Error('Unknown error');
-      finalError.message = `penumbra.saveZip() failed to create zip: ${finalError.message}`;
+      const finalError = new Error(
+        `penumbra.saveZip() failed to create zip: ${asError.message}`,
+      );
       logger.error(finalError, null);
     });
 
     // Buffer zip stream for debug & testing
     if (saveBuffer && bufferedZipStream) {
       this.saveBuffer = saveBuffer;
-      this.zipBuffer = new Response(bufferedZipStream).arrayBuffer();
+      this.zipBufferPromise = new Response(bufferedZipStream).arrayBuffer();
+      this.zipBufferPromise.catch((error: unknown) => {
+        const asError =
+          error instanceof Error
+            ? error
+            : typeof error === 'string'
+              ? new Error(error)
+              : new Error('Unknown error');
+        const finalError = new Error(
+          `penumbra.saveZip() failed to buffer zip: ${asError.message}`,
+        );
+        logger.error(finalError, null);
+      });
     }
   }
 
@@ -255,7 +263,7 @@ export class PenumbraZipWriter extends EventTarget {
                 null,
               );
             } else {
-              zip.abort();
+              zip.abort(new Error(warning));
               throw new Error(warning);
             }
           }
@@ -316,16 +324,19 @@ export class PenumbraZipWriter extends EventTarget {
                 controller.close();
                 reader.releaseLock();
               },
-              cancel: (reason) => {
-                const error =
+              cancel: (reason: unknown) => {
+                const asError =
                   reason instanceof Error
                     ? reason
                     : typeof reason === 'string'
                       ? new Error(reason)
                       : new Error('Unknown error');
 
-                error.message = `penumbra.saveZip(): stream was cancelled: ${error.message}`;
-                reject(error);
+                const finalError = new Error(
+                  `penumbra.saveZip(): stream was cancelled: ${asError.message}`,
+                );
+                logger.error(finalError, null);
+                reject(finalError);
               },
             });
 
@@ -339,14 +350,17 @@ export class PenumbraZipWriter extends EventTarget {
                 stream: () => completionTrackerStream,
               })
               .catch((error: unknown) => {
-                const finalError =
+                const asError =
                   error instanceof Error
                     ? error
                     : typeof error === 'string'
                       ? new Error(error)
                       : new Error('Unknown error');
 
-                finalError.message = `penumbra.saveZip(): failed to write file ${filePath}: ${finalError.message}`;
+                const finalError = new Error(
+                  `penumbra.saveZip(): failed to write file ${filePath}: ${asError.message}`,
+                );
+                logger.error(finalError, null);
                 reject(finalError);
               });
           });
@@ -369,13 +383,16 @@ export class PenumbraZipWriter extends EventTarget {
       try {
         await this.writer.close();
       } catch (error: unknown) {
-        const finalError =
+        const asError =
           error instanceof Error
             ? error
             : typeof error === 'string'
               ? new Error(error)
               : new Error('Unknown error');
-        finalError.message = `penumbra.saveZip(): failed to close zip writer: ${finalError.message}`;
+        const finalError = new Error(
+          `penumbra.saveZip(): failed to close zip writer: ${asError.message}`,
+        );
+        logger.error(finalError, null);
         throw finalError;
       }
     }
@@ -387,22 +404,25 @@ export class PenumbraZipWriter extends EventTarget {
        */
       await this.pipePromise;
     } catch (error: unknown) {
-      const finalError =
+      const asError =
         error instanceof Error
           ? error
           : typeof error === 'string'
             ? new Error(error)
             : new Error('Unknown error');
-      finalError.message = `penumbra.saveZip(): finished writing zip, but failed to download: ${finalError.message}`;
+      const finalError = new Error(
+        `penumbra.saveZip(): finished writing zip, but failed to download: ${asError.message}`,
+      );
+      logger.error(finalError, null);
       throw finalError;
     }
     return size;
   }
 
   /** Cancel Penumbra zip writer */
-  abort(): void {
+  abort(reason?: Error): void {
     if (!this.controller.signal.aborted) {
-      this.controller.abort();
+      this.controller.abort(reason);
     }
   }
 
@@ -416,12 +436,12 @@ export class PenumbraZipWriter extends EventTarget {
         'getBuffer() can only be called when a PenumbraZipWriter is closed',
       );
     }
-    if (!this.saveBuffer || !this.zipBuffer) {
+    if (!this.saveBuffer || !this.zipBufferPromise) {
       throw new Error(
         'getBuffer() can only be called on a PenumbraZipWriter in buffered mode, e.g. createZip({ saveBuffer: true })',
       );
     }
-    return this.zipBuffer;
+    return this.zipBufferPromise;
   }
 
   /**