[FEATURE] 🧩 Plugins

[ziggycreatures]

[FEATURE] 🧩 Plugins

[jodydonetti]

Pinging @JoeShook because of course 😄

[jodydonetti]

The plugins subsystem has been released with v0.1.5 🎉

[jodydonetti]

I just published a new branch with the plugins subsystem here.

How to create a plugin

Write a class that implements the IFusionCachePlugin interface, basically just the Start and Stop methods, like this.

Of course it can also accept its own set of options, typically modelled via IOptions<MyPluginType> and friends.

How to use a plugin via DI

Register your plugin type in the DI container (better before registering FusionCache itself) to respond to the IFusionCachePlugin service as a singleton, like here: when a FusionCache instance will be requested, all plugin types registered will be auto-discovered, added (and started) automatically.

Of course you can also define your own custom ext method (like this one) to be a better .NET citizen.

Example:

[...]
services.AddSingleton<IFusionCachePlugin, MyPlugin>();
services.AddFusionCache();
[...]

or with a custom ext method + custom options:

[...]
services.AddMyFusionCachePlugin(options => {
  options.Whatever = 42;
});
services.AddFusionCache();
[...]

How to use a plugin without DI

Just create an instance of your plugin and pass it to the cache.AddPlugin method, like here.

Remember that, in case the Start method of your plugin throws and exception, an InvalidOperationException would also be thrown by the AddPlugin method itself (with the original exception as the inner one).

Removing a plugin

If you need continue using a FusionCache instance but want to remove a plugin you've previously added, you can call the cache.RemovePlugin method: it will automatically call the Stop method of the plugin and then remove it.

If instead you just want to clean things up "at the end" (and you should do it), you don't have to do anything because when the FusionCache instance will be disposed, all added plugins will be stopped and removed automatically.

Opinions?

Anything would be appreciated, thanks!