webpack-assets-manifest 5.0.3 → 5.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-assets-manifest",
-  "version": "5.0.3",
+  "version": "5.1.0",
   "description": "This Webpack plugin will generate a JSON file that matches the original filename with the hashed version.",
   "license": "MIT",
   "repository": {
@@ -60,36 +60,35 @@
     "tapable": "^2.0"
   },
   "peerDependencies": {
-    "webpack": "^5.1.0"
+    "webpack": "^5.2.0"
   },
   "devDependencies": {
-    "@types/lodash.escaperegexp": "^4.1.6",
     "@types/lodash.get": "^4.4.6",
     "@types/lodash.has": "^4.5.6",
-    "@types/node": "^14.14.27",
+    "@types/node": "^17.0.8",
     "@types/tapable": "^2.2.2",
-    "@types/webpack-sources": "^2.1.0",
-    "@webdeveric/eslint-config": "^0.1.0",
+    "@types/webpack-sources": "^3.2.0",
+    "@webdeveric/eslint-config": "^0.2.3",
     "chai": "^4.3.0",
     "chai-spies": "^1.0.0",
     "compression-webpack-plugin": "^7.1.2",
     "copy-webpack-plugin": "^8.1.1",
-    "cspell": "^5.3.12",
-    "css-loader": "^5.0.2",
-    "eslint": "^7.19.0",
+    "cspell": "^5.5.2",
+    "css-loader": "^5.2.4",
+    "eslint": "^7.26.0",
     "file-loader": "^6.2.0",
     "fs-extra": "^9.1.0",
     "husky": "^6.0.0",
     "lint-staged": "^10.5.4",
     "memory-fs": "^0.5.0",
-    "mini-css-extract-plugin": "^1.3.6",
+    "mini-css-extract-plugin": "^1.6.0",
     "mkdirp": "^1.0.4",
-    "mocha": "^8.3.0",
+    "mocha": "^8.4.0",
     "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
     "superagent": "^6.1.0",
-    "typescript": "^4.1.5",
-    "webpack": "^5.30.0",
+    "typescript": "^4.4.2",
+    "webpack": "^5.66.0",
     "webpack-dev-server": "^3.11.2",
     "webpack-subresource-integrity": "^1.5.2"
   }

package/src/WebpackAssetsManifest.js

@@ -28,8 +28,6 @@ const {
   findMapKeysByValue,
   lock,
   unlock,
-  lockSync,
-  unlockSync,
 } = require('./helpers.js');
 
 /** @type {object} */
@@ -55,33 +53,33 @@ class WebpackAssetsManifest
       transform: new SyncWaterfallHook([ 'assets', 'manifest' ]),
       done: new AsyncSeriesHook([ 'manifest', 'stats' ]),
       options: new SyncWaterfallHook([ 'options' ]),
-      afterOptions: new SyncHook([ 'options' ]),
+      afterOptions: new SyncHook([ 'options', 'manifest' ]),
     });
 
-    this.hooks.transform.tap(PLUGIN_NAME, assets => {
-      const { sortManifest } = this.options;
+    this.hooks.transform.tap(PLUGIN_NAME, (assets, manifest) => {
+      const { sortManifest } = manifest.options;
 
       return sortManifest ? getSortedObject(
         assets,
-        typeof sortManifest === 'function' ? sortManifest.bind(this) : undefined,
+        typeof sortManifest === 'function' ? sortManifest.bind(manifest) : undefined,
       ) : assets;
     });
 
-    this.hooks.afterOptions.tap(PLUGIN_NAME, options => {
-      this.options = Object.assign( this.defaultOptions, options );
-      this.options.integrityHashes = filterHashes( this.options.integrityHashes );
+    this.hooks.afterOptions.tap(PLUGIN_NAME, (options, manifest) => {
+      manifest.options = Object.assign( manifest.defaultOptions, options );
+      manifest.options.integrityHashes = filterHashes( manifest.options.integrityHashes );
 
-      validate(optionsSchema, this.options, { name: PLUGIN_NAME });
+      validate(optionsSchema, manifest.options, { name: PLUGIN_NAME });
 
-      this.options.output = path.normalize( this.options.output );
+      manifest.options.output = path.normalize( manifest.options.output );
 
       // Copy over any entries that may have been added to the manifest before apply() was called.
       // If the same key exists in assets and options.assets, options.assets should be used.
-      this.assets = Object.assign(this.options.assets, this.assets, this.options.assets);
+      manifest.assets = Object.assign(manifest.options.assets, manifest.assets, manifest.options.assets);
 
       [ 'apply', 'customize', 'transform', 'done' ].forEach( hookName => {
-        if ( typeof this.options[ hookName ] === 'function' ) {
-          this.hooks[ hookName ].tap(`${PLUGIN_NAME}.option.${hookName}`, this.options[ hookName ] );
+        if ( typeof manifest.options[ hookName ] === 'function' ) {
+          manifest.hooks[ hookName ].tap(`${PLUGIN_NAME}.option.${hookName}`, manifest.options[ hookName ] );
         }
       });
     });
@@ -111,17 +109,17 @@ class WebpackAssetsManifest
    */
   apply(compiler)
   {
-    if ( ! this.options.enabled ) {
-      return;
-    }
-
     this.compiler = compiler;
 
     // Allow hooks to modify options
     this.options = this.hooks.options.call(this.options);
 
     // Ensure options contain defaults and are valid
-    this.hooks.afterOptions.call(this.options);
+    this.hooks.afterOptions.call(this.options, this);
+
+    if ( ! this.options.enabled ) {
+      return;
+    }
 
     compiler.hooks.watchRun.tap(PLUGIN_NAME, this.handleWatchRun.bind(this));
 
@@ -153,7 +151,7 @@ class WebpackAssetsManifest
       replacer: null, // Its easier to use the transform hook instead.
       space: 2,
       writeToDisk: 'auto',
-      fileExtRegex: /\.\w{2,4}\.(?:map|gz)$|\.\w+$/i,
+      fileExtRegex: /\.\w{2,4}\.(?:map|gz|br)$|\.\w+$/i,
       sortManifest: true,
       merge: false,
       publicPath: null,
@@ -174,6 +172,9 @@ class WebpackAssetsManifest
       integrity: false,
       integrityHashes: [ 'sha256', 'sha384', 'sha512' ],
       integrityPropertyName: 'integrity',
+
+      // Store arbitrary data here for use in customize/transform
+      extra: Object.create(null),
     };
   }
 
@@ -388,7 +389,7 @@ class WebpackAssetsManifest
 
         const deepmerge = require('deepmerge');
 
-        const arrayMerge = (destArray, srcArray) => srcArray;
+        const arrayMerge = (_destArray, srcArray) => srcArray;
 
         for ( const [ key, oldValue ] of Object.entries( data ) ) {
           if ( this.has( key ) ) {
@@ -415,17 +416,19 @@ class WebpackAssetsManifest
    *
    * @param {object} compilation
    */
-  emitAssetsManifest(compilation)
+  async emitAssetsManifest(compilation)
   {
+    const outputPath = this.getOutputPath();
+
     const output = this.getManifestPath(
       compilation,
       this.inDevServer() ?
         path.basename( this.options.output ) :
-        path.relative( compilation.compiler.outputPath, this.getOutputPath() ),
+        path.relative( compilation.compiler.outputPath, outputPath ),
     );
 
     if ( this.options.merge ) {
-      lockSync( output );
+      await lock( outputPath );
     }
 
     this.maybeMerge();
@@ -439,7 +442,7 @@ class WebpackAssetsManifest
     );
 
     if ( this.options.merge ) {
-      unlockSync( output );
+      await unlock( outputPath );
     }
   }
 
@@ -451,25 +454,28 @@ class WebpackAssetsManifest
   handleProcessAssetsAnalyse( compilation /* , assets */ )
   {
     const { contextRelativeKeys } = this.options;
+    const { assetsInfo, chunkGraph, chunks, compiler, codeGenerationResults } = compilation;
 
-    for ( const chunk of compilation.chunks ) {
-      const modules = compilation.chunkGraph.getChunkModulesIterableBySourceType(
-        chunk,
-        'asset',
-      );
+    for (const chunk of chunks) {
+      const modules = chunkGraph.getChunkModulesIterableBySourceType(chunk, 'asset');
 
-      if ( modules ) {
-        for ( const module of modules ) {
-          const { assetInfo, filename } = module.buildInfo;
+      if (modules) {
+        for (const module of modules) {
+          const codeGenData = codeGenerationResults.get(module, chunk.runtime).data;
+
+          const {
+            assetInfo = codeGenData.get('assetInfo'),
+            filename = codeGenData.get('filename'),
+          } = module.buildInfo;
 
           const info = Object.assign(
             {
-              sourceFilename: path.relative( compilation.compiler.context, module.userRequest ),
+              sourceFilename: path.relative(compiler.context, module.userRequest),
             },
             assetInfo,
           );
 
-          compilation.assetsInfo.set(filename, info);
+          assetsInfo.set(filename, info);
 
           this.assetNames.set(
             contextRelativeKeys ?
@@ -538,7 +544,7 @@ class WebpackAssetsManifest
    *
    * @param {object} compilation
    */
-  handleAfterProcessAssets( compilation )
+  async handleProcessAssetsReport( compilation )
   {
     // Look in DefaultStatsPresetPlugin.js for options
     const stats = compilation.getStats().toJson({
@@ -630,7 +636,7 @@ class WebpackAssetsManifest
       }
     }
 
-    this.emitAssetsManifest(compilation);
+    await this.emitAssetsManifest(compilation);
   }
 
   /**
@@ -797,15 +803,21 @@ class WebpackAssetsManifest
   handleThisCompilation(compilation)
   {
     if ( this.options.integrity ) {
-      compilation.hooks.afterProcessAssets.tap(
-        PLUGIN_NAME,
+      compilation.hooks.processAssets.tap(
+        {
+          name: PLUGIN_NAME,
+          stage: Compilation.PROCESS_ASSETS_STAGE_ANALYSE,
+        },
         this.recordSubresourceIntegrity.bind(this, compilation),
       );
     }
 
-    compilation.hooks.afterProcessAssets.tap(
-      PLUGIN_NAME,
-      this.handleAfterProcessAssets.bind(this, compilation),
+    compilation.hooks.processAssets.tapPromise(
+      {
+        name: PLUGIN_NAME,
+        stage: Compilation.PROCESS_ASSETS_STAGE_REPORT,
+      },
+      this.handleProcessAssetsReport.bind(this, compilation),
     );
   }
 
@@ -829,7 +841,7 @@ class WebpackAssetsManifest
       return true;
     }
 
-    return has(this, 'compiler.outputFileSystem') && this.compiler.outputFileSystem.constructor.name === 'MemoryFileSystem';
+    return get(this, 'compiler.outputFileSystem.constructor.name') === 'MemoryFileSystem';
   }
 
   /**

package/src/helpers.js

@@ -72,7 +72,7 @@ function filterHashes( hashes )
 /**
  * See {@link https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity|Subresource Integrity} at MDN
  *
- * @param  {array} hashes - The algorithms you want to use when hashing `content`
+ * @param  {string[]} hashes - The algorithms you want to use when hashing `content`
  * @param  {string} content - File contents you want to hash
  * @return {string} SRI hash
  */
@@ -88,14 +88,12 @@ function getSRIHash( hashes, content )
 /**
  * Get the data type of an argument.
  *
- * @param  {*} v - Some variable
+ * @param  {*} input - Some variable
  * @return {string} Data type
  */
-function varType( v )
+function varType( input )
 {
-  const [ , type ] = Object.prototype.toString.call( v ).match(/^\[object (\w+)\]$/);
-
-  return type;
+  return Object.prototype.toString.call(input).slice(8, -1);
 }
 
 /**
@@ -161,6 +159,11 @@ function group( arr, getGroup, mapper = item => item )
   );
 }
 
+function md5( data )
+{
+  return crypto.createHash('md5').update( data ).digest('hex');
+}
+
 /**
  * Build a file path to a lock file in the tmp directory
  *
@@ -168,9 +171,10 @@ function group( arr, getGroup, mapper = item => item )
  */
 function getLockFilename( filename )
 {
-  const name = filename.replace(/[^\w]+/g, '-');
+  const name = path.basename( filename );
+  const dirHash = md5( path.dirname( filename ) );
 
-  return path.join( os.tmpdir(), `${name}.lock` );
+  return path.join( os.tmpdir(), `${dirHash}-${name}.lock` );
 }
 
 /**
@@ -183,26 +187,10 @@ async function lock( filename )
   await lfLock(
     getLockFilename( filename ),
     {
-      wait: 10000,
-      stale: 20000,
-      retries: 100,
+      wait: 6000,
       retryWait: 100,
-    },
-  );
-}
-
-/**
- * Create a lockfile
- *
- * @param {string} filename
- */
-function lockSync( filename )
-{
-  return lockfile.lockSync(
-    getLockFilename( filename ),
-    {
-      stale: 20000,
-      retries: 200,
+      stale: 5000,
+      retries: 100,
     },
   );
 }
@@ -217,16 +205,6 @@ async function unlock( filename )
   await lfUnlock( getLockFilename( filename ) );
 }
 
-/**
- * Remove a lockfile
- *
- * @param {string} filename
- */
-function unlockSync( filename )
-{
-  return lockfile.unlockSync( getLockFilename( filename ) );
-}
-
 module.exports = {
   maybeArrayWrap,
   filterHashes,
@@ -239,7 +217,5 @@ module.exports = {
   group,
   getLockFilename,
   lock,
-  lockSync,
   unlock,
-  unlockSync,
 };

package/src/options-schema.json

@@ -17,6 +17,7 @@
       "default": "assets-manifest.json"
     },
     "replacer": {
+      "default": null,
       "oneOf": [
         {
           "$ref": "#/definitions/functionOrNull"
@@ -27,9 +28,17 @@
       ]
     },
     "space": {
-      "type": "integer",
-      "multipleOf": 1.0,
-      "minimum": 0,
+      "oneOf": [
+        {
+          "type": "integer",
+          "multipleOf": 1.0,
+          "minimum": 0
+        },
+        {
+          "type": "string",
+          "minLength": 1
+        }
+      ],
       "default": 2
     },
     "writeToDisk": {
@@ -149,6 +158,11 @@
       "type": "string",
       "minLength": 1,
       "default": "integrity"
+    },
+    "extra": {
+      "description": "A place to put your arbitrary data",
+      "type": "object",
+      "default": {}
     }
   },
   "definitions": {