Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fix errors for MultiCompilers build #78

Merged
merged 1 commit into from
May 31, 2017
Merged

fix: Fix errors for MultiCompilers build #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,13 @@ class SWPrecacheWebpackPlugin {
// sw-precache needs physical files to reference so we MUST wait until after assets are emitted before generating the service-worker.
compiler.plugin('after-emit', (compilation, callback) => {
this.configure(compiler, compilation); // configure the serviceworker options

const done = () => callback();
const error = (err) => callback(err);
this.checkWarnings(compilation);

// generate service worker then write to file system
this.createServiceWorker()
.then(serviceWorker => this.writeServiceWorker(serviceWorker, compiler, callback))
.then(this.checkWarnings(compilation))
.then(done, error);
.then(serviceWorker => this.writeServiceWorker(serviceWorker, compiler))
.then(() => callback())
.catch(err => callback(err));
});
}

Expand Down Expand Up @@ -196,12 +194,18 @@ class SWPrecacheWebpackPlugin {
});
}

writeServiceWorker(serviceWorker, compiler, callback) {
writeServiceWorker(serviceWorker, compiler) {
const promisify = func => (...args) => new Promise((resolve, reject) => func(...args, (err, result) => {
return err ? reject(err) : resolve(result);
}));
const mkdirp = promisify(compiler.outputFileSystem.mkdirp);
const writeFile = promisify(compiler.outputFileSystem.writeFile);

const {filepath} = this.workerOptions;

// use the outputFileSystem api to manually write service workers rather than adding to the compilation assets
return compiler.outputFileSystem.mkdirp(path.resolve(filepath, '..'),
() => compiler.outputFileSystem.writeFile(filepath, serviceWorker, callback));
return mkdirp(path.resolve(filepath, '..'))
.then(() => writeFile(filepath, serviceWorker));
}

/**
Expand Down
20 changes: 11 additions & 9 deletions test/plugin.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,15 +196,12 @@ test.serial('#createServiceWorker()', async t => {
plugin.configure(compiler, compilation);
return callback();
});

await runCompiler(compiler);

t.truthy(await plugin.createServiceWorker(), 'generate something');
});

test.serial('#writeServiceWorker(serviceWorker, compiler, callback)', async t => {
test.serial('#writeServiceWorker(serviceWorker, compiler)', async t => {
t.plan(2);

const filepath = path.resolve(__dirname, 'tmp/service-worker.js');
const compiler = webpack(webpackConfig());
const plugin = new SWPrecacheWebpackPlugin({filepath});
Expand All @@ -215,10 +212,12 @@ test.serial('#writeServiceWorker(serviceWorker, compiler, callback)', async t =>
plugin.apply(compiler);

compiler.plugin('after-emit', (compilation, callback) => {
plugin.writeServiceWorker(serviceWorker, compiler, callback);
plugin.writeServiceWorker(serviceWorker, compiler)
.then(() => callback())
.catch(err => callback(err));
});
await runCompiler(compiler);

await runCompiler(compiler);
t.truthy(await fsExists(filepath), 'service-worker should exist');

});
Expand Down Expand Up @@ -257,7 +256,7 @@ test.serial('importScripts[<index>] should support entry point & dynamically imp
'some-script-path.js',
{filename: 'some-script-path.[hash].js'},
{chunkName: 'sw'},
{chunkName: 'service-worker-imported-script-2'}
{chunkName: 'service-worker-imported-script-2'},
],
});

Expand Down Expand Up @@ -313,9 +312,11 @@ test.serial('should keep [hash] in importScripts after configuring SW', async t
const plugin = new SWPrecacheWebpackPlugin({filepath, importScripts: ['some_sw-[hash].js']});

plugin.apply(compiler);
compiler.plugin('after-emit', (compilation) => {
compiler.plugin('after-emit', (compilation, callback) => {
plugin.configure(compiler, compilation);
callback();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From what I'm understanding - each compiler must inform that it has ended by calling callback.

Without this await runCompiler hungs because this plugin never called callback to indicate it has finished . This previously worked because SWPrecacheWebpackPlugin has been calling callback two times and webpack has seen that there are no callbacks that have not been called and after-emit phase has finished.

});

await runCompiler(compiler);

t.truthy(plugin.options.importScripts[0] === 'some_sw-[hash].js', 'hash should be preserve after writing the sw');
Expand All @@ -329,8 +330,9 @@ test.serial('should not modify importScripts value when no [hash] is provided',
const plugin = new SWPrecacheWebpackPlugin({filepath, importScripts: ['some_script.js']});

plugin.apply(compiler);
compiler.plugin('after-emit', (compilation) => {
compiler.plugin('after-emit', (compilation, callback) => {
plugin.configure(compiler, compilation);
callback();
});
await runCompiler(compiler);

Expand Down