Repository navigation
Question: hooks *after* compile – but *before* run #315
Description
This is a Question
Description
New to plugin development, so apologies if we're missing something incredibly obvious. We're attempting to write a plugin that runs after webpack but before deploy / offline / etc, but can't seem to hit the hook. We can run after validate, just fine (with after:webpack:validate:validate)
Plugin thus far is dead simple. Uncomment the validate hook to see it in action. So far the plugin is just running in .serverless_plugins – and is imported after serverless-webpack (though we've tried before as well)
Are we missing something obvious? Or is there not a hook for the compilation?
Thanks
'use strict';
class ServerlessPlugin {
constructor(serverless, options) {
this.serverless = serverless;
this.options = options;
this.commands = {
welcome: {
usage: 'Helps you start your first Serverless plugin',
lifecycleEvents: [
'hello',
],
commands: {
compile: {
type: 'entrypoint',
lifecycleEvents: [
'compile',
],
},
}
},
};
this.hooks = {
// 'after:webpack:validate:validate': this.validate.bind(this),
'webpack:compile:compile': this.debug.bind(this),
// 'before:offline:start': this.debug.bind(this),
// 'offline:start': this.debug.bind(this),
'before:offline:start': this.debug.bind(this),
// 'before:offline:start:init': this.debug.bind(this),
};
}
validate(){
for(let i = 0; i < 15; i++){
console.log('validate')
}
}
debug(){
throw new Error('i should blow up here debug')
}
compile(){
throw new Error('i should blow up here compile')
}
}
module.exports = ServerlessPlugin;Additional Data
- Serverless-Webpack Version you're using:
^4.2.0 - Webpack version you're using:
^3.10.0 - Serverless Framework Version you're using:
^1.25.0 - Operating System:
Mac OS X - Sierra (scared to upgrade to High Sierra)
Activity
HyperBrain commentedon Jan 31, 2018
Hi @dwelch2344 , thanks for asking.
This hook is wrong:
'webpack:compile:compile': this.debug.bind(this),because it "overwrites" the compile step (in fact the bahavior is undefined in this case because an overwrite/replacement is currently not supported by Serverless).
In case you want to hook into some serverless lifecycle event, you always have to hook besides the offered hook. In your case this would be:
before:webpack:compile:compileorafter:webpack:compile:compiledepending if you want to be invoked before or after the webpack compile step. This is true for all hooks you implement, regardless if they hook Serverless or plugin events.The order of the plugin array in your
serverless.ymldefines the order of invocations. Plugin hooks are invoked exactly in the order given there. What is important for your plugin is, that it should be listed AFTER the webpack plugin, because it hooks its events.Additionally, you can invoke Serverless with
SLS_DEBUG="*" serverless ...during debugging. It will print all invoked commands then and you can check what's going on in regards to liefecycles.dwelch2344 commentedon Jan 31, 2018
Hi @HyperBrain – thanks for your quick reply and (obviously) all your awesome work :)
So, I'd actually tried that as well but had adjusted it from my sample plugin as I was hammering on it. Changing the example at hand to the suggested
after:webpack:compile:compileonly seems to run when runningserverless webpackfrom the CLI.Is there another event / hook to listen to for running in offline (i.e. to see the latest source after webpack runs again, but before offline is updated)
Below's my console output with debug enabled and
after:webpack:compile:compileset, if it might be helpful.serverless-heaven#315 - Add watch-compile event for more fine grain e…
dwelch2344 commentedon Feb 5, 2018
Sorry it took me so long to file a PR / update the issue. So, as usual, the plugin's working great and doing exactly what it should :) However, now that we know how things work, we'd like to suggest a simple enhancement.
Just opened PR #319 to address what we'd like. Hopefully closing this is the right move :)
Merge pull request #319 from dwelch2344/watch-compile-hook
serverless-heaven#315 - Add watch-compile event for more fine grain e…
Merge pull request serverless-heaven#319 from dwelch2344/watch-compil…