@nxtedition/lib 19.0.30 → 19.0.31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/lib",
-  "version": "19.0.30",
+  "version": "19.0.31",
   "license": "MIT",
   "author": "Robert Nagy <robert.nagy@boffins.se>",
   "type": "module",

package/s3.js

@@ -20,8 +20,9 @@ class PartUploader {
   #callback
   #hasher
   #signal
+  #logger
 
-  constructor(dir, number, signal) {
+  constructor({ dir, number, signal, logger }) {
     this.#writable = null
     this.#callback = noop
     this.#hasher = crypto.createHash('md5')
@@ -29,6 +30,7 @@ class PartUploader {
     this.#signal = signal
     this.#number = number
     this.#path = path.join(dir, `${this.#number}.part`)
+    this.#logger = logger?.child({ part: this.#number, path: this.#path })
   }
 
   get size() {
@@ -36,16 +38,20 @@ class PartUploader {
   }
 
   async write(chunk) {
-    this.#writable ??= fs
-      .createWriteStream(this.#path, { signal: this.#signal })
-      .on('drain', () => {
-        this.#callback(null)
-        this.#callback = noop
-      })
-      .on('error', (err) => {
-        this.#callback(err)
-        this.callback = noop
-      })
+    if (!this.#writable) {
+      this.#writable = fs
+        .createWriteStream(this.#path, { signal: this.#signal })
+        .on('drain', () => {
+          this.#callback(null)
+          this.#callback = noop
+        })
+        .on('error', (err) => {
+          this.#callback(err)
+          this.callback = noop
+        })
+
+      this.#logger?.debug('created part')
+    }
 
     if (this.#writable.errored) {
       throw this.#writable.errored
@@ -77,6 +83,7 @@ class PartUploader {
 
       assert(this.#writable.bytesWritten === this.#size, 'Expected size to match bytesWritten')
 
+      this.#logger?.debug('uploading part')
       const { ETag } = await s3.send(
         new AWS.UploadPartCommand({
           ...params,
@@ -86,27 +93,28 @@ class PartUploader {
           Body: fs.createReadStream(this.#path, { signal: this.#signal }),
         }),
       )
+      this.#logger?.debug({ etag: ETag }, 'uploaded part')
 
       return { part: { ETag, PartNumber: this.#number } }
     } catch (err) {
       return { error: err }
     } finally {
       await fs.promises.unlink(this.#writable.path)
+      this.#logger?.debug('deleted part')
     }
   }
 }
 
-export async function upload(
-  {
-    client: s3,
-    signal: outerSignal,
-    tmpdir = os.tmpdir(),
-    partSize = 64e6,
-    queueSize = 4,
-    leavePartsOnError = false,
-  },
-  { Body, Key, Bucket, ContentMD5, ContentLength },
-) {
+export async function upload({
+  client: s3,
+  signal: outerSignal,
+  logger,
+  tmpdir = os.tmpdir(),
+  partSize = 64e6,
+  queueSize = 4,
+  leavePartsOnError = false,
+  params,
+}) {
   if (s3 == null) {
     throw new Error('Invalid client')
   }
@@ -119,6 +127,12 @@ export async function upload(
     throw new Error('Invalid queueSize')
   }
 
+  if (params == null || typeof params !== 'object') {
+    throw new Error('Invalid params')
+  }
+
+  const { Body, Key, Bucket, ContentMD5, ContentLength } = params ?? {}
+
   if (ContentMD5 != null && !CONTENT_MD5_EXPR.test(ContentMD5)) {
     throw new Error(`Invalid ContentMD5: ${ContentMD5}`)
   }
@@ -141,6 +155,7 @@ export async function upload(
   let uploadDir
   try {
     uploadDir = await fs.promises.mkdtemp(path.join(tmpdir, 's3-upload-'))
+    logger?.debug({ uploadDir }, 'created upload directory')
     signal.throwIfAborted()
 
     const multipartUploadOutput = await s3.send(
@@ -150,19 +165,26 @@ export async function upload(
       }),
     )
     uploadId = multipartUploadOutput.UploadId
+    logger = logger?.child({ uploadId })
+    logger?.debug('created multipart upload')
     signal.throwIfAborted()
 
     const uploader = {
       size: 0,
       hasher: crypto.createHash('md5'),
-      part: new PartUploader(uploadDir, 1, signal),
+      part: new PartUploader({ dir: uploadDir, number: 1, signal, logger }),
       number: 1,
     }
 
     const maybeFlush = (minSize) => {
       if (uploader.part.size && (minSize == null || uploader.part.size >= minSize)) {
         const part = uploader.part
-        uploader.part = new PartUploader(uploadDir, ++uploader.number, signal)
+        uploader.part = new PartUploader({
+          dir: uploadDir,
+          number: ++uploader.number,
+          logger,
+          signal,
+        })
 
         const promise = queue.add(() => part.end(s3, { Bucket, Key, UploadId: uploadId }))
         promises.push(promise)
@@ -212,7 +234,6 @@ export async function upload(
         MultipartUpload: { Parts: parts },
       }),
     )
-    signal.throwIfAborted()
 
     const result = {
       size: uploader.size,
@@ -221,6 +242,10 @@ export async function upload(
       parts,
     }
 
+    logger?.debug(result, 'completed multipart upload')
+
+    signal.throwIfAborted()
+
     const size = ContentLength != null ? Number(ContentLength) : null
     const hash = ContentMD5
 
@@ -245,6 +270,7 @@ export async function upload(
             UploadId: uploadId,
           }),
         )
+        logger?.warn('aborted multipart upload')
       } catch (er) {
         throw new AggregateError([err, er])
       }