Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
fix(plugins): hand takeovers back after the plugin is unloaded
Yudhi Armyndharisd9276a8e611f
diff --git a/src/core/plugins/plugin-uninstaller.spec.ts b/src/core/plugins/plugin-uninstaller.spec.tsindex 969792198..10fdc3dfc 100644--- a/src/core/plugins/plugin-uninstaller.spec.ts+++ b/src/core/plugins/plugin-uninstaller.spec.ts@@ -168,20 +168,25 @@ describe('PluginUninstaller — uninstall', () => {});// A takeover the plugin held would keep every other plugin silent on that chat for good.- it('hands the takeovers of the plugin back before it removes anything', async () => {+ it('hands the takeovers of the plugin back once it no longer runs, before it removes anything', async () => {const dir = writeUserPlugin('relay');seedEntry(storage, 'relay');const config = { get: (k: string) => (k === 'plugins.dir' ? pluginsDir : tmpDir) } as unknown as ConfigService;- const onDisk: boolean[] = [];- const withRelease = makeUninstaller(config, storage, pluginsDir, () => {- onDisk.push(fs.existsSync(dir) && storage.getPluginEntry('relay') !== undefined);+ const seen: Array<{ onDisk: boolean; running: boolean }> = [];+ let withRelease!: ReturnType<typeof makeUninstaller>;+ withRelease = makeUninstaller(config, storage, pluginsDir, () => {+ seen.push({+ onDisk: fs.existsSync(dir) && storage.getPluginEntry('relay') !== undefined,+ running: withRelease.plugins.has('relay'),+ });return Promise.resolve();});withRelease.plugins.set('relay', loadedUserPlugin('relay', dir));await withRelease.uninstaller.uninstallPlugin('relay');- expect(onDisk).toEqual([true]);+ // Still running at the release would let it take a chat over again before its worker ends.+ expect(seen).toEqual([{ onDisk: true, running: false }]);expect(fs.existsSync(dir)).toBe(false);});@@ -189,16 +194,24 @@ describe('PluginUninstaller — uninstall', () => {const dir = writeUserPlugin('relay');seedEntry(storage, 'relay');const config = { get: (k: string) => (k === 'plugins.dir' ? pluginsDir : tmpDir) } as unknown as ConfigService;- const failing = makeUninstaller(config, storage, pluginsDir, () =>- Promise.reject(new Error('mapping store unavailable')),+ let storeUp = false;+ const flaky = makeUninstaller(config, storage, pluginsDir, () =>+ storeUp ? Promise.resolve() : Promise.reject(new Error('mapping store unavailable')),);- failing.plugins.set('relay', loadedUserPlugin('relay', dir));+ flaky.plugins.set('relay', loadedUserPlugin('relay', dir));- await expect(failing.uninstaller.uninstallPlugin('relay')).rejects.toThrow('mapping store unavailable');+ await expect(flaky.uninstaller.uninstallPlugin('relay')).rejects.toThrow('mapping store unavailable');+ // Nothing of the plugin was removed, though it no longer runs.expect(fs.existsSync(dir)).toBe(true);expect(storage.getPluginEntry('relay')).toBeDefined();- expect(failing.plugins.has('relay')).toBe(true);+ expect(flaky.plugins.has('relay')).toBe(false);++ // The repeat finds no runtime, retries the release and removes the plugin.+ storeUp = true;+ await flaky.uninstaller.uninstallPlugin('relay');+ expect(fs.existsSync(dir)).toBe(false);+ expect(storage.getPluginEntry('relay')).toBeUndefined();});});diff --git a/src/core/plugins/plugin-uninstaller.ts b/src/core/plugins/plugin-uninstaller.tsindex b8c3ab8ee..055bac43a 100644--- a/src/core/plugins/plugin-uninstaller.ts+++ b/src/core/plugins/plugin-uninstaller.ts@@ -52,11 +52,6 @@ export class PluginUninstaller {throw new Error(`Cannot uninstall built-in plugin ${pluginId}`);}- // A takeover the plugin held keeps every other plugin silent on that chat, and nothing is left to- // hand it back once the plugin is gone. Done first, while the registry entry still exists: a store- // that cannot take it fails the uninstall, which the operator can then repeat.- await this.releaseTakeovers?.(pluginId);-// Read the package location BEFORE unloading: unloadPlugin drops the runtime record that holds// it, and for a plugin loaded from the legacy directory the configured root is the wrong tree —// deleting there removes the ctx.storage directory and leaves the code, so the plugin comes@@ -66,6 +61,12 @@ export class PluginUninstaller {if (this.plugins.has(pluginId)) {await this.unload(pluginId);}++ // A takeover the plugin held keeps every other plugin silent on that chat, and nothing is left to+ // hand it back once the plugin is gone. Done after the unload, because until its worker ends the+ // plugin can still take a chat over again, and before the registry entry goes: a store that cannot+ // take the release fails the uninstall, and a repeat finds no runtime and goes straight to it.+ await this.releaseTakeovers?.(pluginId);this.pluginStorage.deletePluginEntry(pluginId);// A recorded directory came from the boot scan and is already contained. Without one the id is