s3-zip 3.3.0 → 3.3.1-a0

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,29 @@
+name: Publish to NPM
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish (leave empty to use package.json version)'
+        required: false
+        type: string
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm i
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  pull_request:
+    branches: [master]
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16, 18, 20]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm i
+
+      - name: Run tests
+        run: npm test

package/README.md

@@ -53,17 +53,19 @@ You can also pass a custom S3 client. For example if you want to zip files from
 ```javascript
 const { S3Client } = require('@aws-sdk/client-s3')
 
-const S3Client = new aws.S3({
-  signatureVersion: 'v4',
-  s3ForcePathStyle: 'true',
+const s3Client = new S3Client({
+  region: 'us-east-1',
   endpoint: 'http://localhost:9000',
+  forcePathStyle: true
 })
 
 s3Zip
-  .archive({ s3: S3Client, bucket: bucket }, folder, [file1, file2])
+  .archive({ s3: s3Client, bucket: bucket }, folder, [file1, file2])
   .pipe(output)
 ```
 
+**Note:** When passing a custom S3 client, it must be an AWS SDK v3 client (from `@aws-sdk/client-s3`). AWS SDK v2 clients are not supported and will result in an error.
+
 ### Zip files with AWS Lambda
 
 Example of s3-zip in combination with [AWS Lambda](aws_lambda.md).
@@ -194,6 +196,23 @@ If you would like a more fancy coverage report:
 npm run coverage
 ```
 
+## Publishing
+
+This package is automatically published to NPM when a new release is created on GitHub. The publishing workflow:
+
+1. Triggers on GitHub releases
+2. Runs tests to ensure quality
+3. Publishes to NPM using the `NPM_TOKEN` secret
+
+### Setup for Maintainers
+
+To enable automatic publishing, the repository requires an `NPM_TOKEN` secret to be configured in GitHub:
+
+1. Generate an NPM access token with publish permissions
+2. Add it as a repository secret named `NPM_TOKEN` in GitHub Settings > Secrets and variables > Actions
+
+The workflow can also be triggered manually from the Actions tab for testing purposes.
+
 
 
 

package/aws_lambda.md

@@ -7,6 +7,7 @@
 const { Upload } = require("@aws-sdk/lib-storage");
 const { S3 } = require("@aws-sdk/client-s3");
 const s3Zip = require('s3-zip')
+const {Readable} = require('stream')
 
 exports.handler = function (event, context) {
   console.log('event', event)
@@ -21,7 +22,8 @@ exports.handler = function (event, context) {
   // Create body stream
   try {
 
-    const body = s3Zip.archive({ region: region, bucket: bucket}, folder, files)
+    const writable = s3Zip.archive({ region: region, bucket: bucket}, folder, files)
+    const body = Readable.from(writable)
     const zipParams = { params: { Bucket: bucket, Key: folder + zipFileName } }
     const zipFile = new S3(zipParams)
     new Upload({
@@ -29,15 +31,16 @@ exports.handler = function (event, context) {
       params: { Body: body }
     })
       .on('httpUploadProgress', function (evt) { console.log(evt) })
-      .send(function (e, r) { 
-        if (e) {
-          const err = 'zipFile.upload error ' + e
-          console.log(err)         
+      .done().then(
+        (r) => {
+          console.log(r)
+          context.succeed(r)
+        },
+        (e) => {
+          console.log('zipFile.upload error', e)
           context.fail(err)
-        } 
-        console.log(r) 
-        context.succeed(r)
-      })
+        }
+      )
 
   } catch (e) {
     const err = 'catched error: ' + e

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "s3-zip",
-  "version": "3.3.0",
+  "version": "3.3.1-a0",
   "description": "Download selected files from an Amazon S3 bucket as a zip file.",
   "main": "s3-zip.js",
   "scripts": {
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/orangewise/s3-zip.git"
+    "url": "git+https://github.com/orangewise/s3-zip.git"
   },
   "keywords": [
     "amazon",
@@ -26,6 +26,7 @@
   "homepage": "https://github.com/orangewise/s3-zip#readme",
   "dependencies": {
     "archiver": "^6.0.1",
+    "normalize-path": "^3.0.0",
     "s3-files": "^3.0.0"
   },
   "devDependencies": {

package/s3-zip.js

@@ -13,6 +13,11 @@ s3Zip.archive = function (opts, folder, filesS3, filesZip) {
   self.debug = opts.debug || false
 
   if ('s3' in opts) {
+    // Validate that the provided S3 client is compatible with AWS SDK v3
+    if (!opts.s3 || typeof opts.s3.send !== 'function') {
+      throw new Error('The provided S3 client must be an AWS SDK v3 client with a .send() method. ' +
+        'Please use @aws-sdk/client-s3 (v3) instead of aws-sdk (v2).')
+    }
     connectionConfig = {
       s3: opts.s3
     }
@@ -39,7 +44,10 @@ s3Zip.archiveStream = function (stream, filesS3, filesZip) {
   const self = this
   const folder = this.folder || ''
   if (this.registerFormat) {
-    archiver.registerFormat(this.registerFormat, this.formatModule)
+    // Only register the format if it hasn't been registered before
+    if (!archiver.isRegisteredFormat(this.registerFormat)) {
+      archiver.registerFormat(this.registerFormat, this.formatModule)
+    }
   }
   const archive = archiver(this.format || 'zip', this.archiverOpts || {})
   archive.on('error', function (err) {

package/test/test-coverage-missing-lines.js

@@ -0,0 +1,97 @@
+// Test to cover missing lines for full coverage
+
+const t = require('tap')
+const Stream = require('stream')
+const sinon = require('sinon')
+const proxyquire = require('proxyquire')
+
+// Mock s3Files to avoid real S3 calls
+const mockS3Files = {
+  connect: sinon.stub().returns({
+    createKeyStream: sinon.stub().returns(new Stream())
+  }),
+  createFileStream: sinon.stub().returns(new Stream())
+}
+
+const s3Zip = proxyquire('../s3-zip.js', {
+  's3-files': mockS3Files
+})
+
+t.test('test archive with valid AWS SDK v3 client', function (child) {
+  // Mock valid AWS SDK v3 client (has .send method)
+  const awsV3Client = {
+    send: function (command) {
+      return Promise.resolve({ Body: Buffer.from('test data') })
+    }
+  }
+
+  try {
+    // This should work and cover line 21: connectionConfig = { s3: opts.s3 }
+    const archive = s3Zip.archive(
+      { s3: awsV3Client, bucket: 'test-bucket' },
+      'folder/',
+      ['test-file.txt']
+    )
+
+    child.type(archive, 'object', 'Should return archive object')
+    child.end()
+  } catch (error) {
+    child.fail(`Should not throw error with valid SDK v3 client: ${error.message}`)
+    child.end()
+  }
+})
+
+t.test('test archiveStream with debug mode and directory paths', function (child) {
+  const rs = new Stream()
+  rs.readable = true
+
+  // Enable debug mode to cover lines 59-60
+  s3Zip.debug = true
+
+  const archive = s3Zip.archiveStream(rs, [])
+
+  // Emit a directory path to trigger the debug log
+  rs.emit('data', { data: Buffer.alloc(0), path: 'test-folder/' })
+  rs.emit('end')
+
+  child.type(archive, 'object', 'Should return archive object')
+  child.end()
+})
+
+t.test('test archiveStream with file not in filesS3 array', function (child) {
+  const rs = new Stream()
+  rs.readable = true
+
+  // Test the ternary on line 66 - when file is not found in filesS3 array
+  const archive = s3Zip.archiveStream(rs, ['different-file.txt'], ['renamed.txt'])
+
+  // Emit a file that's not in the filesS3 array
+  rs.emit('data', {
+    data: Buffer.from('test content'),
+    path: 'not-in-list.txt'
+  })
+  rs.emit('end')
+
+  child.type(archive, 'object', 'Should return archive object')
+  child.end()
+})
+
+t.test('test archiveStream with debug and archive error', function (child) {
+  const rs = new Stream()
+  rs.readable = true
+
+  // Enable debug mode to cover line 54
+  s3Zip.debug = true
+
+  const archive = s3Zip.archiveStream(rs, [])
+
+  // Force an archive error to trigger the debug log on line 54
+  setImmediate(() => {
+    archive.emit('error', new Error('test error'))
+  })
+
+  rs.emit('end')
+
+  child.type(archive, 'object', 'Should return archive object')
+  child.end()
+})

package/test/test-password-protected-duplicate.js

@@ -0,0 +1,37 @@
+const s3Zip = require('../s3-zip.js')
+const t = require('tap')
+const archiverZipEncryptable = require('archiver-zip-encryptable')
+
+t.test('test duplicate format registration does not error', function (child) {
+  // First registration should work
+  s3Zip.setRegisterFormatOptions('zip-encryptable', archiverZipEncryptable)
+
+  // Try to register the format via archiveStream simulation
+  const mockStream = {
+    on: function (event, callback) {
+      if (event === 'end') {
+        setTimeout(callback, 10) // Simulate async behavior
+      } else if (event === 'data') {
+        // Don't emit any data
+      } else if (event === 'error') {
+        // Don't emit any errors
+      }
+      return this
+    }
+  }
+
+  try {
+    // First call to archiveStream (should register format)
+    const archive1 = s3Zip.archiveStream(mockStream, [], [])
+    child.ok(archive1, 'First archiveStream call succeeded')
+
+    // Second call to archiveStream (should NOT fail due to duplicate registration)
+    const archive2 = s3Zip.archiveStream(mockStream, [], [])
+    child.ok(archive2, 'Second archiveStream call succeeded')
+
+    child.end()
+  } catch (err) {
+    child.fail(`archiveStream calls failed: ${err.message}`)
+    child.end()
+  }
+})

package/test/test-s3-v2-client-error.js

@@ -0,0 +1,55 @@
+// Test s3-zip with AWS SDK v2 client which should produce clear error
+
+const s3Zip = require('../s3-zip.js')
+const t = require('tap')
+
+t.test('test s3-zip with AWS SDK v2 client should fail with clear error', function (child) {
+  // Mock AWS SDK v2 client (no .send method)
+  const awsV2Client = {
+    getObject: function (params) {
+      return {
+        promise: function () {
+          return Promise.resolve({ Body: Buffer.from('test data') })
+        }
+      }
+    }
+  }
+
+  try {
+    // This should fail with a clear error message about AWS SDK compatibility
+    s3Zip.archive(
+      { s3: awsV2Client, bucket: 'test-bucket' },
+      'folder/',
+      ['test-file.txt']
+    )
+
+    // If we get here without an error, the test failed
+    child.fail('Expected an error about AWS SDK compatibility but none was thrown')
+    child.end()
+  } catch (error) {
+    // We should get a clear error about AWS SDK version compatibility
+    child.ok(error.message.includes('AWS SDK v3'), 'Should get clear error about AWS SDK v3 requirement')
+    child.ok(error.message.includes('@aws-sdk/client-s3'), 'Should mention the correct package')
+    child.end()
+  }
+})
+
+t.test('test s3-zip with null s3 client should fail with clear error', function (child) {
+  try {
+    // This should fail with a clear error message about AWS SDK compatibility
+    s3Zip.archive(
+      { s3: null, bucket: 'test-bucket' },
+      'folder/',
+      ['test-file.txt']
+    )
+
+    // If we get here without an error, the test failed
+    child.fail('Expected an error about AWS SDK compatibility but none was thrown')
+    child.end()
+  } catch (error) {
+    // We should get a clear error about AWS SDK version compatibility
+    child.ok(error.message.includes('AWS SDK v3'), 'Should get clear error about AWS SDK v3 requirement')
+    child.ok(error.message.includes('.send() method'), 'Should mention the .send() method requirement')
+    child.end()
+  }
+})