feat(runtime-core): Plugins can return cleanup function

LinusBorg · LinusBorg · commit 55c3c8d7a6ed · 2021-09-17T10:37:36.000+02:00
which is ran at unmount
diff --git a/packages/runtime-core/__tests__/apiCreateApp.spec.ts b/packages/runtime-core/__tests__/apiCreateApp.spec.ts
@@ -313,6 +313,37 @@ describe('api: createApp', () => {
     ).toHaveBeenWarnedTimes(1)
   })
 
+  test('use: call cleanup plugin on unmount', () => {
+    const cleanup = jest.fn().mockName('plugin cleanup')
+    const PluginA: Plugin = app => {
+      app.provide('foo', 1)
+      return cleanup
+    }
+    const PluginB: Plugin = {
+      install: (app, arg1, arg2) => {
+        app.provide('bar', arg1 + arg2)
+        return cleanup
+      }
+    }
+
+    // should ignore non-function return values
+    const PluginC: Plugin = app => ({})
+
+    const app = createApp({
+      render: () => `Test`
+    })
+    app.use(PluginA)
+    app.use(PluginB)
+    app.use(PluginC)
+
+    const root = nodeOps.createElement('div')
+    app.mount(root)
+
+    app.unmount()
+
+    expect(cleanup).toHaveBeenCalledTimes(2)
+  })
+
   test('config.errorHandler', () => {
     const error = new Error()
     const count = ref(0)
diff --git a/packages/runtime-core/src/apiCreateApp.ts b/packages/runtime-core/src/apiCreateApp.ts
@@ -185,6 +185,7 @@ export function createAppAPI<HostElement>(
 
     const context = createAppContext()
     const installedPlugins = new Set()
+    const pluginCleanupFns: Array<() => any> = []
 
     let isMounted = false
 
@@ -211,20 +212,28 @@ export function createAppAPI<HostElement>(
       },
 
       use(plugin: Plugin, ...options: any[]) {
+        let cleanupFn: (() => any) | undefined = undefined
         if (installedPlugins.has(plugin)) {
           __DEV__ && warn(`Plugin has already been applied to target app.`)
         } else if (plugin && isFunction(plugin.install)) {
           installedPlugins.add(plugin)
-          plugin.install(app, ...options)
+          cleanupFn = plugin.install(app, ...options)
         } else if (isFunction(plugin)) {
           installedPlugins.add(plugin)
-          plugin(app, ...options)
+          cleanupFn = plugin(app, ...options)
         } else if (__DEV__) {
           warn(
             `A plugin must either be a function or an object with an "install" ` +
               `function.`
           )
         }
+        if (
+          cleanupFn &&
+          typeof cleanupFn === 'function' &&
+          cleanupFn.length === 0
+        ) {
+          pluginCleanupFns.push(cleanupFn)
+        }
         return app
       },
 
@@ -323,6 +332,7 @@ export function createAppAPI<HostElement>(
       unmount() {
         if (isMounted) {
           render(null, app._container)
+          pluginCleanupFns.map(fn => fn())
           if (__DEV__ || __FEATURE_PROD_DEVTOOLS__) {
             app._instance = null
             devtoolsUnmountApp(app)
