compressing 1.10.2 → 2.0.0

package/README.md

@@ -3,6 +3,9 @@
 [![NPM version][npm-image]][npm-url]
 [![Test coverage][codecov-image]][codecov-url]
 [![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/compressing.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/node-modules/compressing)
 
 [npm-image]: https://img.shields.io/npm/v/compressing.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/compressing
@@ -72,7 +75,7 @@ fs.createReadStream('file/path/to/compress')
   .on('error', handleError);
 
 // You should take care of stream errors in caution, use pump to handle error in one place
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 const sourceStream = fs.createReadStream('file/path/to/compress');
 const gzipStream = new compressing.gzip.FileStream();
 const destStream = fs.createWriteStream('path/to/destination.gz');
@@ -190,7 +193,7 @@ function onEntry(header, stream, next) => {
   if (header.type === 'file') {
     stream.pipe(fs.createWriteStream(path.join(destDir, header.name)));
   } else { // directory
-    mkdirp(path.join(destDir, header.name), err => {
+    fs.mkdir(path.join(destDir, header.name), { recursive: true }, err => {
       if (err) return handleError(err);
       stream.resume();
     });
@@ -364,15 +367,9 @@ Due to the design of the .zip file format, it's impossible to interpret a .zip f
 Although the API is streaming style(try to keep it handy), it still loads all data into memory.
 
 <https://github.com/thejoshwolfe/yauzl#no-streaming-unzip-api>
-<!-- GITCONTRIBUTOR_START -->
 
 ## Contributors
 
-|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/456108?v=4" width="100px;"/><br/><sub><b>shaoshuai0102</b></sub>](https://github.com/shaoshuai0102)<br/>|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/9692408?v=4" width="100px;"/><br/><sub><b>DiamondYuan</b></sub>](https://github.com/DiamondYuan)<br/>|[<img src="https://avatars.githubusercontent.com/u/101238421?v=4" width="100px;"/><br/><sub><b>acyza</b></sub>](https://github.com/acyza)<br/>|
-| :---: | :---: | :---: | :---: | :---: | :---: |
-|[<img src="https://avatars.githubusercontent.com/u/13938334?v=4" width="100px;"/><br/><sub><b>bytemain</b></sub>](https://github.com/bytemain)<br/>|[<img src="https://avatars.githubusercontent.com/u/20432815?v=4" width="100px;"/><br/><sub><b>rickyes</b></sub>](https://github.com/rickyes)<br/>|[<img src="https://avatars.githubusercontent.com/u/8382136?v=4" width="100px;"/><br/><sub><b>Ryqsky</b></sub>](https://github.com/Ryqsky)<br/>|[<img src="https://avatars.githubusercontent.com/u/47357585?v=4" width="100px;"/><br/><sub><b>songhn233</b></sub>](https://github.com/songhn233)<br/>|[<img src="https://avatars.githubusercontent.com/u/160386?v=4" width="100px;"/><br/><sub><b>Infiltrator</b></sub>](https://github.com/Infiltrator)<br/>|[<img src="https://avatars.githubusercontent.com/u/13861843?v=4" width="100px;"/><br/><sub><b>ZeekoZhu</b></sub>](https://github.com/ZeekoZhu)<br/>|
-[<img src="https://avatars.githubusercontent.com/u/6897780?v=4" width="100px;"/><br/><sub><b>killagu</b></sub>](https://github.com/killagu)<br/>|[<img src="https://avatars.githubusercontent.com/u/59508678?v=4" width="100px;"/><br/><sub><b>okaponta</b></sub>](https://github.com/okaponta)<br/>|[<img src="https://avatars.githubusercontent.com/u/9857273?v=4" width="100px;"/><br/><sub><b>ShadyZOZ</b></sub>](https://github.com/ShadyZOZ)<br/>
+[![Contributors](https://contrib.rocks/image?repo=node-modules/compressing)](https://github.com/node-modules/compressing/graphs/contributors)
 
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Thu Aug 03 2023 01:39:37 GMT+0800`.
-
-<!-- GITCONTRIBUTOR_END -->
+Made with [contributors-img](https://contrib.rocks).

package/lib/tgz/file_stream.js

@@ -4,7 +4,7 @@ const tar = require('../tar');
 const gzip = require('../gzip');
 const utils = require('../utils');
 const stream = require('stream');
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 const ready = require('get-ready');
 
 class TgzFileStream extends stream.Transform {

package/lib/utils.js

@@ -2,8 +2,7 @@
 
 const fs = require('fs');
 const path = require('path');
-const mkdirp = require('mkdirp');
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 
 // file/fileBuffer/stream
 exports.sourceType = source => {
@@ -90,7 +89,7 @@ exports.makeUncompressFn = StreamClass => {
     }
 
     return new Promise((resolve, reject) => {
-      mkdirp(destDir, err => {
+      fs.mkdir(destDir, { recursive: true }, err => {
         if (err) return reject(err);
 
         let entryCount = 0;
@@ -109,31 +108,37 @@ exports.makeUncompressFn = StreamClass => {
           .on('error', reject)
           .on('entry', (header, stream, next) => {
             stream.on('end', next);
+            const destFilePath = path.join(destDir, header.name);
 
             if (header.type === 'file') {
-              const fullpath = path.join(destDir, header.name);
-              mkdirp(path.dirname(fullpath), err => {
+              const dir = path.dirname(destFilePath);
+              fs.mkdir(dir, { recursive: true }, err => {
                 if (err) return reject(err);
 
                 entryCount++;
-                pump(stream, fs.createWriteStream(fullpath, { mode: opts.mode || header.mode }), err => {
+                pump(stream, fs.createWriteStream(destFilePath, { mode: opts.mode || header.mode }), err => {
                   if (err) return reject(err);
                   successCount++;
                   done();
                 });
               });
             } else if (header.type === 'symlink') {
-              // symlink
-              const src = path.join(destDir, header.name);
-              const target = path.resolve(path.dirname(src), header.linkname);
+              const dir = path.dirname(destFilePath);
+              const target = path.resolve(dir, header.linkname);
               entryCount++;
-              fs.symlink(target, src, err => {
+
+              fs.mkdir(dir, { recursive: true }, err => {
                 if (err) return reject(err);
-                successCount++;
-                stream.resume();
+
+                const relativeTarget = path.relative(dir, target);
+                fs.symlink(relativeTarget, destFilePath, err => {
+                  if (err) return reject(err);
+                  successCount++;
+                  stream.resume();
+                });
               });
             } else { // directory
-              mkdirp(path.join(destDir, header.name), err => {
+              fs.mkdir(destFilePath, { recursive: true }, err => {
                 if (err) return reject(err);
                 stream.resume();
               });
@@ -175,7 +180,7 @@ function normalizePath(fileName) {
   return fileName;
 }
 
-exports.stripFileName = (strip, fileName, type) => {
+function stripFileName(strip, fileName, type) {
   // before
   // node/package.json
   // node/lib/index.js
@@ -218,4 +223,6 @@ exports.stripFileName = (strip, fileName, type) => {
 
   strip = Math.min(strip, s.length - 1);
   return s.slice(strip).join('/') || '/';
-};
+}
+
+exports.stripFileName = stripFileName;

package/lib/zip/uncompress_stream.js

@@ -2,6 +2,7 @@
 
 // https://github.com/thejoshwolfe/yauzl#no-streaming-unzip-api
 
+const debug = require('util').debuglog('compressing/zip/uncompress_stream');
 const yauzl = require('@eggjs/yauzl');
 const stream = require('stream');
 const UncompressBaseStream = require('../base_write_stream');
@@ -38,12 +39,20 @@ class ZipUncompressStream extends UncompressBaseStream {
     if (this._zipFileNameEncoding === 'utf-8') {
       this._zipFileNameEncoding = 'utf8';
     }
+    this._finalCallback = err => {
+      if (err) {
+        debug('finalCallback, error: %j', err);
+        return this.emit('error', err);
+      }
+      this.emit('finish');
+    };
 
     this[YAUZL_CALLBACK] = this[YAUZL_CALLBACK].bind(this);
 
     const sourceType = utils.sourceType(opts.source);
 
     const yauzlOpts = this._yauzlOpts = Object.assign({}, DEFAULTS, opts.yauzl);
+    debug('sourceType: %s, yauzlOpts: %j', sourceType, yauzlOpts);
     if (sourceType === 'file') {
       yauzl.open(opts.source, yauzlOpts, this[YAUZL_CALLBACK]);
       return;
@@ -60,27 +69,26 @@ class ZipUncompressStream extends UncompressBaseStream {
         .catch(e => this.emit('error', e));
       return;
     }
-
-    this.on('pipe', srcStream => {
-      srcStream.unpipe(srcStream);
-
-      utils.streamToBuffer(srcStream)
-        .then(buf => {
-          this._chunks.push(buf);
-          buf = Buffer.concat(this._chunks);
-          yauzl.fromBuffer(buf, yauzlOpts, this[YAUZL_CALLBACK]);
-        })
-        .catch(e => this.emit('error', e));
-    });
   }
 
-  _write(chunk) {
-    // push to _chunks array, this will only happen once, for stream will be unpiped.
+  _write(chunk, _encoding, callback) {
     this._chunks.push(chunk);
+    debug('write size: %d, chunks: %d', chunk.length, this._chunks.length);
+    callback();
+  }
+
+  _final(callback) {
+    const buf = Buffer.concat(this._chunks);
+    debug('final, buf size: %d, chunks: %d', buf.length, this._chunks.length);
+    this._finalCallback = callback;
+    yauzl.fromBuffer(buf, this._yauzlOpts, this[YAUZL_CALLBACK]);
   }
 
   [YAUZL_CALLBACK](err, zipFile) {
-    if (err) return this.emit('error', err);
+    if (err) {
+      debug('yauzl error', err);
+      return this._finalCallback(err);
+    }
 
     zipFile.readEntry();
 
@@ -106,17 +114,22 @@ class ZipUncompressStream extends UncompressBaseStream {
 
         if (type === 'file') {
           zipFile.openReadStream(entry, (err, readStream) => {
-            if (err) return this.emit('error', err);
+            if (err) {
+              debug('file, error: %j', err);
+              return this._finalCallback(err);
+            }
+            debug('file, header: %j', header);
             this.emit('entry', header, readStream, next);
           });
         } else { // directory
           const placeholder = new stream.Readable({ read() {} });
+          debug('directory, header: %j', header);
           this.emit('entry', header, placeholder, next);
           setImmediate(() => placeholder.emit('end'));
         }
       })
-      .on('end', () => this.emit('finish'))
-      .on('error', err => this.emit('error', err));
+      .on('end', () => this._finalCallback())
+      .on('error', err => this._finalCallback(err));
 
     function next() {
       zipFile.readEntry();

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "compressing",
-  "version": "1.10.2",
+  "version": "2.0.0",
   "description": "Everything you need for compressing and uncompressing",
   "main": "index.js",
   "scripts": {
-    "contributor": "git-contributor",
     "test:ts": "tsc -p ./test/fixtures/types/tsconfig.json",
     "test:js": "egg-bin test --ts false",
     "test": "npm run test:js && npm run test:ts",
@@ -40,14 +39,12 @@
   },
   "homepage": "https://github.com/node-modules/compressing#readme",
   "dependencies": {
+    "@eggjs/yauzl": "^2.11.0",
     "flushwritable": "^1.0.0",
     "get-ready": "^1.0.0",
     "iconv-lite": "^0.5.0",
-    "mkdirp": "^0.5.1",
-    "pump": "^3.0.0",
     "streamifier": "^0.1.1",
     "tar-stream": "^1.5.2",
-    "@eggjs/yauzl": "^2.11.0",
     "yazl": "^2.4.2"
   },
   "devDependencies": {
@@ -57,13 +54,12 @@
     "egg-bin": "6",
     "eslint": "8",
     "eslint-config-egg": "12",
-    "git-contributor": "2",
     "mm": "^2.0.0",
     "mz-modules": "^2.1.0",
     "typescript": "5",
     "uuid": "^3.0.1"
   },
   "engines": {
-    "node": ">= 4.0.0"
+    "node": ">= 18.0.0"
   }
 }