Merge pull request #49 from kevlened/remove-filesystem-write

Don't write to filesystem directly

Author: kevlened

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.0.0 (May 14, 2016)
+
+BREAKING CHANGE
+
+* No longer writing to filesystem when webpack-dev-server is running
+  Use the [write-file-webpack-plugin](https://www.npmjs.com/package/write-file-webpack-plugin) to force writing files to the filesystem
+
 ## 2.1.6 (May 14, 2016)
 
 * Readded Node v6.0.0 compatibility after finding root cause

README.md

@@ -67,8 +67,8 @@ var path = require('path');
 module.exports = {
     context: path.join(__dirname, 'app'),
     devServer: {
-        // This is required for webpack-dev-server. The path should 
-        // be an absolute path to your build destination.
+        // This is required for webpack-dev-server if using a version <3.0.0.
+        // The path should be an absolute path to your build destination.
         outputPath: path.join(__dirname, 'build')
     },
     plugins: [

package.json

@@ -1,6 +1,6 @@
 {
   "name": "copy-webpack-plugin",
-  "version": "2.1.6",
+  "version": "3.0.0",
   "description": "Copy files and directories in webpack",
   "main": "dist/index.js",
   "repository": {

src/index.js

@@ -11,47 +11,21 @@ const globAsync = Promise.promisify(require('glob'));
 const fs = Promise.promisifyAll(require('fs-extra'));
 /* eslint-enable */
 
-const union = (set1, set2) => {
-    return new Set([...set1, ...set2]);
-};
-
-const isDevServer = (compiler) => {
-    return compiler.outputFileSystem.constructor.name === 'MemoryFileSystem';
-};
-
-const getOutputDir = (compiler) => {
-    if (compiler.options.output.path && compiler.options.output.path !== '/') {
-        return compiler.options.output.path;
-    }
-
-    const devServer = compiler.options.devServer;
-
-    if (!devServer || !devServer.outputPath || devServer.outputPath === '/') {
-        throw new Error('CopyWebpackPlugin: to use webpack-dev-server, devServer.outputPath must be defined in the webpack config');
-    }
-
-    return devServer.outputPath;
-};
-
 function CopyWebpackPlugin(patterns = [], options = {}) {
     if (!_.isArray(patterns)) {
         throw new Error('CopyWebpackPlugin: patterns must be an array');
     }
 
     const apply = (compiler) => {
         const webpackContext = compiler.options.context;
-        const outputPath = getOutputDir(compiler);
+        const outputPath = compiler.options.output.path;
         const fileDependencies = [];
         const contextDependencies = [];
         const webpackIgnore = options.ignore || [];
         const copyUnmodified = options.copyUnmodified;
-        let writtenAssets;
-        let lastGlobalUpdate;
-
-        lastGlobalUpdate = 0;
+        const writtenAssetHashes = {};
 
         compiler.plugin('emit', (compilation, cb) => {
-            writtenAssets = new Set();
 
             Promise.each(patterns, (pattern) => {
                 let relDest;
@@ -102,11 +76,8 @@ function CopyWebpackPlugin(patterns = [], options = {}) {
                                 flatten: pattern.flatten,
                                 forceWrite,
                                 ignoreList,
-                                lastGlobalUpdate,
-                                relDirDest: relDest
-                            })
-                            .then((assets) => {
-                                writtenAssets = union(writtenAssets, assets);
+                                relDirDest: relDest,
+                                writtenAssetHashes
                             });
                         }
 
@@ -166,18 +137,12 @@ function CopyWebpackPlugin(patterns = [], options = {}) {
                                     compilation,
                                     copyUnmodified,
                                     forceWrite,
-                                    lastGlobalUpdate,
-                                    relFileDest
-                                })
-                                .then((asset) => {
-                                    writtenAssets.add(asset);
+                                    relFileDest,
+                                    writtenAssetHashes
                                 });
                             });
                     });
             })
-            .then(() => {
-                lastGlobalUpdate = _.now();
-            })
             .catch((err) => {
                 compilation.errors.push(err);
             })
@@ -201,35 +166,7 @@ function CopyWebpackPlugin(patterns = [], options = {}) {
                 }
             });
 
-            // Write files to file system if webpack-dev-server
-
-            if (!isDevServer(compiler)) {
-                callback();
-
-                return;
-            }
-
-            const writeFilePromises = [];
-
-            _.forEach(compilation.assets, (asset, assetPath) => {
-                // If this is not our asset, ignore it
-                if (!writtenAssets.has(assetPath)) {
-                    return;
-                }
-
-                const outputFilePath = path.join(outputPath, assetPath);
-                const absOutputPath = path.resolve(process.cwd(), outputFilePath);
-
-                writeFilePromises.push(fs.mkdirsAsync(path.dirname(absOutputPath))
-                    .then(() => {
-                        return fs.writeFileAsync(absOutputPath, asset.source());
-                    }));
-            });
-
-            Promise.all(writeFilePromises)
-                .then(() => {
-                    callback();
-                });
+            callback();
         });
     };
 

src/writeDirectoryToAssets.js

@@ -16,7 +16,7 @@ export default (opts) => {
     const forceWrite = opts.forceWrite;
     const ignoreList = opts.ignoreList;
     const copyUnmodified = opts.copyUnmodified;
-    const lastGlobalUpdate = opts.lastGlobalUpdate;
+    const writtenAssetHashes = opts.writtenAssetHashes;
 
     return dir.filesAsync(absDirSrc)
         .map((absFileSrc) => {
@@ -46,8 +46,8 @@ export default (opts) => {
                 compilation,
                 copyUnmodified,
                 forceWrite,
-                lastGlobalUpdate,
-                relFileDest
+                relFileDest,
+                writtenAssetHashes
             });
         });
 };

src/writeFileToAssets.js

@@ -4,14 +4,18 @@ import Promise from 'bluebird';
 const fs = Promise.promisifyAll(require('fs-extra'));
 /* eslint-enable */
 
+import {
+    createHash
+} from 'crypto';
+
 export default (opts) => {
     const compilation = opts.compilation;
     // ensure forward slashes
     const relFileDest = opts.relFileDest.replace(/\\/g, '/');
     const absFileSrc = opts.absFileSrc;
     const forceWrite = opts.forceWrite;
-    const lastGlobalUpdate = opts.lastGlobalUpdate;
     const copyUnmodified = opts.copyUnmodified;
+    const writtenAssetHashes = opts.writtenAssetHashes;
 
     if (compilation.assets[relFileDest] && !forceWrite) {
         return Promise.resolve();
@@ -20,19 +24,33 @@ export default (opts) => {
     return fs
     .statAsync(absFileSrc)
     .then((stat) => {
-        if (stat.isDirectory() || !copyUnmodified && stat.mtime.getTime() < lastGlobalUpdate) {
-            return null;
+
+        function addToAssets() {
+            compilation.assets[relFileDest] = {
+                size () {
+                    return stat.size;
+                },
+                source () {
+                    return fs.readFileSync(absFileSrc);
+                }
+            };
+
+            return relFileDest;
+        }
+
+        if (copyUnmodified) {
+            return addToAssets();
         }
 
-        compilation.assets[relFileDest] = {
-            size () {
-                return stat.size;
-            },
-            source () {
-                return fs.readFileSync(absFileSrc);
+        return fs.readFileAsync(absFileSrc)
+        .then((contents) => {
+            const hash = createHash('sha256').update(contents).digest('hex');
+            if (writtenAssetHashes[relFileDest] && writtenAssetHashes[relFileDest] === hash) {
+                return;
             }
-        };
 
-        return relFileDest;
+            writtenAssetHashes[relFileDest] = hash;
+            return addToAssets();
+        });
     });
 };

tests/index.js

@@ -132,8 +132,6 @@ describe('apply function', () => {
             options: opts.options,
             patterns: opts.patterns
         })
-        // mtime is only measured in whole seconds
-        .delay(1000)
         .then(() => {
             // Change a file
             fs.appendFileSync(opts.newFileLoc1, 'extra');