@verdaccio/tarball 12.0.0-next-7.13 → 12.0.0-next-7.14

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 12.0.0-next-7.14
+
+### Patch Changes
+
+- 253cc13: feat: add tarball details for published packages
+- Updated dependencies [b0946b2]
+  - @verdaccio/url@12.0.0-next-7.14
+  - @verdaccio/core@7.0.0-next-7.14
+  - @verdaccio/utils@7.0.0-next-7.14
+
 ## 12.0.0-next-7.13
 
 ### Patch Changes

package/build/getTarballDetails.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+export type TarballDetails = {
+    fileCount: number;
+    unpackedSize: number;
+};
+export declare function getTarballDetails(readable: Readable): Promise<TarballDetails>;

package/build/getTarballDetails.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getTarballDetails = getTarballDetails;
+var _gunzipMaybe = _interopRequireDefault(require("gunzip-maybe"));
+var tarStream = _interopRequireWildcard(require("tar-stream"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+async function getTarballDetails(readable) {
+  let fileCount = 0;
+  let unpackedSize = 0;
+  const unpack = tarStream.extract();
+  return new Promise((resolve, reject) => {
+    readable.pipe((0, _gunzipMaybe.default)()).pipe(unpack).on('entry', (header, stream, next) => {
+      fileCount++;
+      unpackedSize += Number(header.size);
+      stream.resume(); // important to ensure that "entry" events keep firing
+      next();
+    }).on('finish', () => {
+      resolve({
+        fileCount,
+        unpackedSize
+      });
+    }).on('error', reject);
+  });
+}
+//# sourceMappingURL=getTarballDetails.js.map

package/build/getTarballDetails.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getTarballDetails.js","names":["_gunzipMaybe","_interopRequireDefault","require","tarStream","_interopRequireWildcard","_getRequireWildcardCache","e","WeakMap","r","t","__esModule","default","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","prototype","hasOwnProperty","call","i","set","obj","getTarballDetails","readable","fileCount","unpackedSize","unpack","extract","Promise","resolve","reject","pipe","gunzipMaybe","on","header","stream","next","Number","size","resume"],"sources":["../src/getTarballDetails.ts"],"sourcesContent":["import gunzipMaybe from 'gunzip-maybe';\nimport { Readable } from 'stream';\nimport * as tarStream from 'tar-stream';\n\nexport type TarballDetails = {\n  fileCount: number;\n  unpackedSize: number; // in bytes\n};\n\nexport async function getTarballDetails(readable: Readable): Promise<TarballDetails> {\n  let fileCount = 0;\n  let unpackedSize = 0;\n\n  const unpack = tarStream.extract();\n\n  return new Promise((resolve, reject) => {\n    readable\n      .pipe(gunzipMaybe())\n      .pipe(unpack)\n      .on('entry', (header, stream, next) => {\n        fileCount++;\n        unpackedSize += Number(header.size);\n        stream.resume(); // important to ensure that \"entry\" events keep firing\n        next();\n      })\n      .on('finish', () => {\n        resolve({\n          fileCount,\n          unpackedSize,\n        });\n      })\n      .on('error', reject);\n  });\n}\n"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,SAAA,GAAAC,uBAAA,CAAAF,OAAA;AAAwC,SAAAG,yBAAAC,CAAA,6BAAAC,OAAA,mBAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAF,wBAAAE,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,WAAAK,OAAA,EAAAL,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAG,GAAA,CAAAN,CAAA,UAAAG,CAAA,CAAAI,GAAA,CAAAP,CAAA,OAAAQ,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAjB,CAAA,EAAAc,CAAA,SAAAI,CAAA,GAAAR,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAI,CAAA,KAAAA,CAAA,CAAAX,GAAA,IAAAW,CAAA,CAAAC,GAAA,IAAAR,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAI,CAAA,IAAAV,CAAA,CAAAM,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAN,CAAA,CAAAH,OAAA,GAAAL,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAgB,GAAA,CAAAnB,CAAA,EAAAQ,CAAA,GAAAA,CAAA;AAAA,SAAAb,uBAAAyB,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAhB,UAAA,GAAAgB,GAAA,KAAAf,OAAA,EAAAe,GAAA;AAOjC,eAAeC,iBAAiBA,CAACC,QAAkB,EAA2B;EACnF,IAAIC,SAAS,GAAG,CAAC;EACjB,IAAIC,YAAY,GAAG,CAAC;EAEpB,MAAMC,MAAM,GAAG5B,SAAS,CAAC6B,OAAO,CAAC,CAAC;EAElC,OAAO,IAAIC,OAAO,CAAC,CAACC,OAAO,EAAEC,MAAM,KAAK;IACtCP,QAAQ,CACLQ,IAAI,CAAC,IAAAC,oBAAW,EAAC,CAAC,CAAC,CACnBD,IAAI,CAACL,MAAM,CAAC,CACZO,EAAE,CAAC,OAAO,EAAE,CAACC,MAAM,EAAEC,MAAM,EAAEC,IAAI,KAAK;MACrCZ,SAAS,EAAE;MACXC,YAAY,IAAIY,MAAM,CAACH,MAAM,CAACI,IAAI,CAAC;MACnCH,MAAM,CAACI,MAAM,CAAC,CAAC,CAAC,CAAC;MACjBH,IAAI,CAAC,CAAC;IACR,CAAC,CAAC,CACDH,EAAE,CAAC,QAAQ,EAAE,MAAM;MAClBJ,OAAO,CAAC;QACNL,SAAS;QACTC;MACF,CAAC,CAAC;IACJ,CAAC,CAAC,CACDQ,EAAE,CAAC,OAAO,EAAEH,MAAM,CAAC;EACxB,CAAC,CAAC;AACJ"}

package/build/index.d.ts

@@ -1,4 +1,5 @@
 import { RequestOptions } from '@verdaccio/url';
 export { convertDistRemoteToLocalTarballUrls, convertDistVersionToLocalTarballsUrl, } from './convertDistRemoteToLocalTarballUrls';
 export { extractTarballFromUrl, getLocalRegistryTarballUri } from './getLocalRegistryTarballUri';
+export { TarballDetails, getTarballDetails } from './getTarballDetails';
 export { RequestOptions };

package/build/index.js

@@ -9,6 +9,12 @@ Object.defineProperty(exports, "RequestOptions", {
     return _url.RequestOptions;
   }
 });
+Object.defineProperty(exports, "TarballDetails", {
+  enumerable: true,
+  get: function () {
+    return _getTarballDetails.TarballDetails;
+  }
+});
 Object.defineProperty(exports, "convertDistRemoteToLocalTarballUrls", {
   enumerable: true,
   get: function () {
@@ -33,7 +39,14 @@ Object.defineProperty(exports, "getLocalRegistryTarballUri", {
     return _getLocalRegistryTarballUri.getLocalRegistryTarballUri;
   }
 });
+Object.defineProperty(exports, "getTarballDetails", {
+  enumerable: true,
+  get: function () {
+    return _getTarballDetails.getTarballDetails;
+  }
+});
 var _url = require("@verdaccio/url");
 var _convertDistRemoteToLocalTarballUrls = require("./convertDistRemoteToLocalTarballUrls");
 var _getLocalRegistryTarballUri = require("./getLocalRegistryTarballUri");
+var _getTarballDetails = require("./getTarballDetails");
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["_url","require","_convertDistRemoteToLocalTarballUrls","_getLocalRegistryTarballUri"],"sources":["../src/index.ts"],"sourcesContent":["import { RequestOptions } from '@verdaccio/url';\n\nexport {\n  convertDistRemoteToLocalTarballUrls,\n  convertDistVersionToLocalTarballsUrl,\n} from './convertDistRemoteToLocalTarballUrls';\nexport { extractTarballFromUrl, getLocalRegistryTarballUri } from './getLocalRegistryTarballUri';\n\nexport { RequestOptions };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,IAAA,GAAAC,OAAA;AAEA,IAAAC,oCAAA,GAAAD,OAAA;AAIA,IAAAE,2BAAA,GAAAF,OAAA"}
+{"version":3,"file":"index.js","names":["_url","require","_convertDistRemoteToLocalTarballUrls","_getLocalRegistryTarballUri","_getTarballDetails"],"sources":["../src/index.ts"],"sourcesContent":["import { RequestOptions } from '@verdaccio/url';\n\nexport {\n  convertDistRemoteToLocalTarballUrls,\n  convertDistVersionToLocalTarballsUrl,\n} from './convertDistRemoteToLocalTarballUrls';\nexport { extractTarballFromUrl, getLocalRegistryTarballUri } from './getLocalRegistryTarballUri';\nexport { TarballDetails, getTarballDetails } from './getTarballDetails';\n\nexport { RequestOptions };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,IAAA,GAAAC,OAAA;AAEA,IAAAC,oCAAA,GAAAD,OAAA;AAIA,IAAAE,2BAAA,GAAAF,OAAA;AACA,IAAAG,kBAAA,GAAAH,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/tarball",
-  "version": "12.0.0-next-7.13",
+  "version": "12.0.0-next-7.14",
   "description": "tarball utilities resolver",
   "keywords": [
     "private",
@@ -24,7 +24,7 @@
   "repository": {
     "type": "https",
     "url": "https://github.com/verdaccio/verdaccio",
-    "directory": "packages/core/url-resolver"
+    "directory": "packages/core/tarball"
   },
   "bugs": {
     "url": "https://github.com/verdaccio/verdaccio/issues"
@@ -33,11 +33,13 @@
     "access": "public"
   },
   "dependencies": {
+    "@verdaccio/core": "7.0.0-next-7.14",
+    "@verdaccio/url": "12.0.0-next-7.14",
+    "@verdaccio/utils": "7.0.0-next-7.14",
     "debug": "4.3.4",
-    "@verdaccio/core": "7.0.0-next-7.13",
-    "@verdaccio/url": "12.0.0-next-7.13",
-    "@verdaccio/utils": "7.0.0-next-7.13",
-    "lodash": "4.17.21"
+    "gunzip-maybe": "^1.4.2",
+    "lodash": "4.17.21",
+    "tar-stream": "^3.1.7"
   },
   "devDependencies": {
     "@verdaccio/types": "12.0.0-next.2",

package/src/getTarballDetails.ts

@@ -0,0 +1,34 @@
+import gunzipMaybe from 'gunzip-maybe';
+import { Readable } from 'stream';
+import * as tarStream from 'tar-stream';
+
+export type TarballDetails = {
+  fileCount: number;
+  unpackedSize: number; // in bytes
+};
+
+export async function getTarballDetails(readable: Readable): Promise<TarballDetails> {
+  let fileCount = 0;
+  let unpackedSize = 0;
+
+  const unpack = tarStream.extract();
+
+  return new Promise((resolve, reject) => {
+    readable
+      .pipe(gunzipMaybe())
+      .pipe(unpack)
+      .on('entry', (header, stream, next) => {
+        fileCount++;
+        unpackedSize += Number(header.size);
+        stream.resume(); // important to ensure that "entry" events keep firing
+        next();
+      })
+      .on('finish', () => {
+        resolve({
+          fileCount,
+          unpackedSize,
+        });
+      })
+      .on('error', reject);
+  });
+}

package/src/index.ts

@@ -5,5 +5,6 @@ export {
   convertDistVersionToLocalTarballsUrl,
 } from './convertDistRemoteToLocalTarballUrls';
 export { extractTarballFromUrl, getLocalRegistryTarballUri } from './getLocalRegistryTarballUri';
+export { TarballDetails, getTarballDetails } from './getTarballDetails';
 
 export { RequestOptions };

package/tests/getTarballDetails.spec.ts

@@ -0,0 +1,37 @@
+import fs from 'fs';
+import path from 'path';
+import { Readable } from 'stream';
+
+import { getTarballDetails } from '../src/getTarballDetails.ts';
+
+const getFilePath = (filename: string): string => {
+  return path.resolve(__dirname, `assets/${filename}`);
+};
+
+const getFileBuffer = async (filename: string): Promise<Buffer> => {
+  return fs.promises.readFile(getFilePath(filename));
+};
+
+describe('getTarballDetails', () => {
+  test('should return stats of tarball (gzipped)', async () => {
+    const buffer = await getFileBuffer('tarball.tgz');
+    const readable = Readable.from(buffer);
+    const details = await getTarballDetails(readable);
+    expect(details.fileCount).toBe(2);
+    expect(details.unpackedSize).toBe(1280);
+  });
+
+  test('should return stats of tarball (uncompressed)', async () => {
+    const buffer = await getFileBuffer('tarball.tar');
+    const readable = Readable.from(buffer);
+    const details = await getTarballDetails(readable);
+    expect(details.fileCount).toBe(2);
+    expect(details.unpackedSize).toBe(1280);
+  });
+
+  test('should throw an error if the buffer is corrupt', async () => {
+    const corruptBuffer = Buffer.from('this is not a tarball');
+    const readable = Readable.from(corruptBuffer);
+    await expect(getTarballDetails(readable)).rejects.toThrow();
+  });
+});