Lockfile improvements (#148)

* Use absolute file path when locking

* Use md5 of dirname instead of absolute path

* Removed sync versions of lock/unlock

* Updated hook being used to process assets

Use processAssets hook instead of afterProcessAssets
so that async lock/unlock functions can be used.

* Updated min webpack version

* Updated dev dependencies

.github/workflows/node.js.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         node-version: [10.x, 12.x, 14.x]
-        webpack-version: ['5.1.0', 5]
+        webpack-version: ['5.2.0', 5]
         dev-server-version: ['3.6.0', latest]
         css-loader-version: ['3.5.0', latest]
     steps:

package.json

@@ -60,7 +60,7 @@
     "tapable": "^2.0"
   },
   "peerDependencies": {
-    "webpack": "^5.1.0"
+    "webpack": "^5.2.0"
   },
   "devDependencies": {
     "@types/lodash.get": "^4.4.6",
@@ -74,7 +74,7 @@
     "compression-webpack-plugin": "^7.1.2",
     "copy-webpack-plugin": "^8.1.1",
     "cspell": "^5.3.12",
-    "css-loader": "^5.0.2",
+    "css-loader": "^5.2.1",
     "eslint": "^7.19.0",
     "file-loader": "^6.2.0",
     "fs-extra": "^9.1.0",

src/WebpackAssetsManifest.js

@@ -28,8 +28,6 @@ const {
   findMapKeysByValue,
   lock,
   unlock,
-  lockSync,
-  unlockSync,
 } = require('./helpers.js');
 
 /** @type {object} */
@@ -415,17 +413,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 +439,7 @@ class WebpackAssetsManifest
     );
 
     if ( this.options.merge ) {
-      unlockSync( output );
+      await unlock( outputPath );
     }
   }
 
@@ -538,7 +538,7 @@ class WebpackAssetsManifest
    *
    * @param {object} compilation
    */
-  handleAfterProcessAssets( compilation )
+  async handleProcessAssetsReport( compilation )
   {
     // Look in DefaultStatsPresetPlugin.js for options
     const stats = compilation.getStats().toJson({
@@ -630,7 +630,7 @@ class WebpackAssetsManifest
       }
     }
 
-    this.emitAssetsManifest(compilation);
+    await this.emitAssetsManifest(compilation);
   }
 
   /**
@@ -797,15 +797,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),
     );
   }
 

src/helpers.js

@@ -161,16 +161,22 @@ 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
  *
  * @param {string} filename
  */
 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 +189,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 +207,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 +219,5 @@ module.exports = {
   group,
   getLockFilename,
   lock,
-  lockSync,
   unlock,
-  unlockSync,
 };