Easy way to handle cleanup on user initiated premature termination

[RichiCoder1]

I'm not sure of the API shape of this, but it would be nice for gluegun to expose a way either through the toolbox (like https://developer.mozilla.org/en-US/docs/Web/API/AbortController) or in the command definition to have a "cleanup" command that would be run on SIGINT or other user initiated polite terminations. Basically to allow any quick cleanup that might be necessary.

[jamonholmgren]

Excellent idea. I'd love to hear other's thoughts on it.

[RichiCoder1]

I think the right API might be to change

export interface GluegunCommand<TContext extends Toolbox = Toolbox> {
  /** The name of your command */
  name?: string
  /** A tweet-sized summary of your command */
  description?: string
  /** The function for running your command, can be async */
-  run: (toolbox: TContext) => void
+  run: (toolbox: TContext, abortToken: AbortToken) => void
  /** Should your command be shown in the listings  */
  hidden?: boolean
  /** The command path, an array that describes how to get to this command */
  commandPath?: string[]
  /** Potential other names for this command */
  alias?: string | string[]

Where AbortToken is:

class AbortToken extends EventEmitter {
    constructor() {
        super();
    }
}

And run and/or runtime handles wiring up the approriate events.

const token = new AbortToken();
process.on('SIGINT', () => {
    token.emit('abort');
});
//...
if (command.run) {
    await command.run(toolbox, token);
}

with a command being able to do:

run: (toolbox, abortToken) => {
    const otherProcess = exec('do this thing', () => { /* do stuff */ });
    abortToken.on('abort', () => otherProcess.kill());
}

[jamonholmgren]

I'm not super keen on changing the run function signature. I'd rather hang it on the toolbox itself. Perhaps on meta.

Something like:

run: (toolbox) => {
  const otherProcess = exec('do this thing', () => { /* do stuff */ });
  toolbox.meta.onAbort(() => otherProcess.kill())
}

[infinitered-circleci]

🎉 This issue has been resolved in version 5.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀