Repository navigation
Extended "plugin" interface #24
Description
Activity
new Load method:
loadConfigurable({ configure(app:App):void; create(app:App) => void})
Not sure if good idea to give access to the entire app in
configure. Maybe just envaridator?If its just envaridator, you'd probably need this interface:
interface ConfigururablePlugin<T, U> { configure(env: Envaridator):T; create(app: App, config:T):U; }
Another alternative making it easier to fetch this
class EnvConfig extends AppSingleton { protected env = this.getSingleton(Envaridator); } class App { addConfigurablePlugin(item) { this.getSingleton(item.envConfig); this.uninitialized.push(item.create); } addPlugin(item) { this.uninitialized.push(item); } setupPlugins() { this.uninitialized.forEach(item => this.getSingleton(item)); } }
Plugin:
class MyEnvConfig extends EnvConfig { myvar1 = this.env.register('name', {...}) myvar2 = this.env.register('othername', {...}) myvar3 = this.env.register('thirdname', {...}) } let ConfigurablePlugin = { config: MyEnvConfig, create: app => { let serviceInstallName = app.getSingleton(MyEnvConfig).serviceName.value; app.getSingleton(RPCServiceRegistry).add(serviceInstallNamevalue, MyService) } };
App:
class MyApp extends App { setupPlugins() { this.addPlugin(z); this.addConfigurablePlugin(ConfigurablePlugin); } // Maybe instead: // app.overrideSingleton(Envaridator, TestEnvaridator); // where validate is always OK? initializeForTests() { this.setupPlugins() this.loadPlugins(); } start() { this.setupPlugins(); this.getSingleton(Envaridator).validateEnv(); this.loadPlugins(); } help() { this.getSingleton(Envaridator).showHelpSomething() } }
We can extend the plugin interface in a backward compatible way to support several application phases:
Support
app.initialize(). Once all plugins are loaded, the initialize method can be called. This method will in turn call every plugin which returned a method calledinitializefrom its construction function. The method can return a promise.Support
app.terminate(). Similar to initialize but it will shut all plugins down. Analogously to initialize it will call a termination method on all plugins that have oneMy main doubt about this design is how to make it clear which things go where, especially the config vs initialization phases. Perhaps we could support passing an object to
load()in addition to a function - if an object is passed, it has to at least have aninitializemethod (that can return a promise), and it can optionally have aconfigurationgetter that returns the env variables specs (once loaded it will be replaced with a cached property) as well as aterminatemethod (that can return a promise)