add plugin uninstaller logic

src/mod.ts

@@ -38,12 +38,15 @@ export {
 export {
   Wechaty,
   WechatyOptions,
+}                             from './wechaty'
+export {
   WechatyPlugin,
-}                     from './wechaty'
+  WechatyPluginUninstaller,
+}                             from './plugin'
 
 export {
   PuppetModuleName,
-}                     from './puppet-config'
+}                             from './puppet-config'
 
 export {
   Contact,

src/plugin.spec.ts

+#!/usr/bin/env ts-node
+
+/**
+ *   Wechaty Chatbot SDK - https://github.com/wechaty/wechaty
+ *
+ *   @copyright 2016 Huan LI (李卓桓) <https://github.com/huan>, and
+ *                   Wechaty Contributors <https://github.com/wechaty>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+import test  from 'blue-tape'
+import sinon from 'sinon'
+
+import { PuppetMock } from 'wechaty-puppet-mock'
+
+import {
+  Wechaty,
+}                             from './wechaty'
+import { WechatyPlugin } from './plugin'
+
+test('Wechaty Plugin uninstaller should be called after wechaty.stop()', async t => {
+  const spyPluginInstall  = sinon.spy()
+  const spyPluginUninstall = sinon.spy()
+
+  const bot = new Wechaty({ puppet: new PuppetMock() })
+
+  const plugin: WechatyPlugin = (_bot: Wechaty) => {
+    spyPluginInstall()
+    return () => {
+      spyPluginUninstall()
+    }
+  }
+
+  t.true(spyPluginInstall.notCalled, 'should be clean for install spy')
+  t.true(spyPluginUninstall.notCalled, 'should be clean for uninstall spy')
+
+  bot.use(plugin)
+  t.true(spyPluginInstall.called, 'should called install spy after use()')
+  t.true(spyPluginUninstall.notCalled, 'should not call uninstall spy after use()')
+
+  await bot.start()
+  await bot.stop()
+
+  t.true(spyPluginUninstall.called, 'should called uninstall spy after stop()')
+})

src/plugin.ts

+import { Wechaty } from './wechaty'
+
+export type WechatyPluginUninstaller = () => void
+
+export type WechatyPluginReturn = void | WechatyPluginUninstaller
+
+export interface WechatyPlugin {
+  (bot: Wechaty): WechatyPluginReturn
+}
+
+function isWechatyPluginUninstaller (
+  pluginReturn: WechatyPluginReturn,
+): pluginReturn is WechatyPluginUninstaller {
+  return !!pluginReturn
+}
+
+export {
+  isWechatyPluginUninstaller,
+}

src/wechaty.ts

@@ -20,8 +20,8 @@
 import cuid             from 'cuid'
 import os               from 'os'
 
-import { StateSwitch }    from 'state-switch'
-
+import { StateSwitch }      from 'state-switch'
+import { instanceToClass }  from 'clone-class'
 import {
   Puppet,
 
@@ -88,7 +88,13 @@ import { timestampToDate } from './helper-functions/pure/timestamp-to-date'
 import {
   WechatyEventEmitter,
   WechatyEventName,
-}                         from './events/wechaty-events'
+}                             from './events/wechaty-events'
+
+import {
+  WechatyPlugin,
+  WechatyPluginUninstaller,
+  isWechatyPluginUninstaller,
+}                             from './plugin'
 
 export interface WechatyOptions {
   memory?        : MemoryCard,
@@ -102,11 +108,6 @@ export interface WechatyOptions {
   ioToken?       : string,                    // Io TOKEN
 }
 
-type WechatyPluginUninstaller = () => void
-export interface WechatyPlugin {
-  (bot: Wechaty): void | WechatyPluginUninstaller
-}
-
 const PUPPET_MEMORY_NAME = 'puppet'
 
 /**
@@ -148,6 +149,8 @@ export class Wechaty extends WechatyEventEmitter implements Sayable {
 
   private static globalPluginList: WechatyPlugin[] = []
 
+  private pluginUninstallerList: WechatyPluginUninstaller[]
+
   private memory?: MemoryCard
 
   private lifeTimer? : NodeJS.Timer
@@ -307,6 +310,7 @@ export class Wechaty extends WechatyEventEmitter implements Sayable {
      */
     super.setMaxListeners(1024)
 
+    this.pluginUninstallerList = []
     this.installGlobalPlugin()
   }
 
@@ -356,13 +360,27 @@ export class Wechaty extends WechatyEventEmitter implements Sayable {
    *
    */
   public use (...plugins: (WechatyPlugin | WechatyPlugin[])[]) {
-    const pluginList = plugins.flat()
-    pluginList.forEach(plugin => plugin(this))
+    const pluginList = plugins.flat() as WechatyPlugin[]
+    const uninstallerList = pluginList
+      .map(plugin => plugin(this))
+      .filter(isWechatyPluginUninstaller)
+
+    this.pluginUninstallerList.push(
+      ...uninstallerList,
+    )
     return this
   }
 
   private installGlobalPlugin () {
-    (this.constructor as typeof Wechaty).globalPluginList.forEach(plugin => plugin(this))
+
+    const uninstallerList = instanceToClass(this, Wechaty)
+      .globalPluginList
+      .map(plugin => plugin(this))
+      .filter(isWechatyPluginUninstaller)
+
+    this.pluginUninstallerList.push(
+      ...uninstallerList,
+    )
   }
 
   private async initPuppet (): Promise<void> {
@@ -710,6 +728,11 @@ export class Wechaty extends WechatyEventEmitter implements Sayable {
       this.lifeTimer = undefined
     }
 
+    while (this.pluginUninstallerList.length > 0) {
+      const uninstaller = this.pluginUninstallerList.pop()
+      if (uninstaller) uninstaller()
+    }
+
     try {
       await this.puppet.stop()
     } catch (e) {