import { TypedEventEmitter } from '@revenge-mod/discord/common/utils' import { getErrorStack } from '@revenge-mod/utils/error' import { allSettled, sleepReject } from '@revenge-mod/utils/promise' import { pUnscopedApi as uapi } from './apis' import { PluginFlags as Flag, PluginStatus as Status } from './constants' import type { InitPluginApi, Plugin, PluginApi, PluginApiExtensionsOptions, PluginCleanup, PluginManifest, PluginOptions, PreInitPluginApi, } from './types' export const pUnscopedApi = uapi export const pEmitter = new TypedEventEmitter<{ register: [InternalPlugin, PluginOptions] disabled: [InternalPlugin] enabled: [InternalPlugin] // Add preInit API extensions preInit: [InternalPlugin, PreInitPluginApi] preInited: [InternalPlugin] // Add init API extensions init: [InternalPlugin, InitPluginApi] inited: [InternalPlugin] // Add start API extensions start: [InternalPlugin, PluginApi] started: [InternalPlugin] stopped: [InternalPlugin] errored: [InternalPlugin, unknown] }>() export const pList = new Map() export const pMetadata = new Map< PluginManifest['id'], [ api: PreInitPluginApi | InitPluginApi | PluginApi | undefined, promises: Promise[], iflags: number, apiLevel: number, ] >() export function registerPlugin( manifest: PluginManifest, options: PluginOptions, flags: number, iflags: number, ) { // TODO(plugins): verify plugin manifest if (pList.has(manifest.id)) throw new Error(`Plugin with ID "${manifest.id}" already registered`) const plugin: InternalPlugin = { _c: [], errors: [], manifest, lifecycles: { preInit: options.preInit, init: options.init, start: options.start, stop: options.stop, }, SettingsComponent: options.SettingsComponent, status: 0, flags, disable: () => disablePlugin(plugin), stop: () => stopPlugin(plugin), } pMetadata.set(manifest.id, [undefined, [], iflags, PluginApiLevel.None]) pList.set(manifest.id, plugin) pEmitter.emit('register', plugin, options) } function handlePluginError(e: unknown, plugin: InternalPlugin) { plugin.errors.push(e) plugin.flags |= Flag.Errored const [api, , iflags] = pMetadata.get(plugin.manifest.id)! ;(api as InitPluginApi).logger.error('Plugin encountered an error', e) nativeLoggingHook( `\u001b[31mPlugin "${plugin.manifest.id}" encountered an error: ${getErrorStack(e)}\u001b[0m`, 2, ) pEmitter.emit('errored', plugin, e) if (!(iflags & InternalPluginFlags.Essential)) return plugin.disable() } function preparePluginPreInit(plugin: InternalPlugin) { const meta = pMetadata.get(plugin.manifest.id)! // Clear errors from previous runs plugin.errors = [] plugin.status &= ~Flag.Errored const api = (meta[0] = { cleanup: (...items) => { plugin._c.push(...items) }, plugin, unscoped: pUnscopedApi, }) pEmitter.emit('preInit', plugin, api) meta[3] = PluginApiLevel.PreInit } function preparePluginInit(plugin: InternalPlugin) { const meta = pMetadata.get(plugin.manifest.id)! pEmitter.emit('init', plugin, meta[0] as InitPluginApi) meta[3] = PluginApiLevel.Init } function preparePluginStart(plugin: InternalPlugin) { const meta = pMetadata.get(plugin.manifest.id)! pEmitter.emit('start', plugin, meta[0] as PluginApi) meta[3] = PluginApiLevel.Start } async function disablePlugin(plugin: InternalPlugin) { if (!(plugin.flags & Flag.Enabled)) throw new Error(`Plugin "${plugin.manifest.id}" is not enabled`) const iflags = pMetadata.get(plugin.manifest.id)![2] ?? 0 if (iflags & InternalPluginFlags.Essential) throw new Error( `Plugin "${plugin.manifest.id}" is essential and cannot be disabled`, ) // If plugin is not stopped, and is also not stopping, we need to stop it if (plugin.status && !(plugin.status & Status.Stopping)) await stopPlugin(plugin) // TODO(plugins): write to storage plugin.flags &= ~Flag.Enabled pEmitter.emit('disabled', plugin) } export function enablePlugin(plugin: InternalPlugin, late: boolean) { if (plugin.flags & Flag.Enabled) throw new Error(`Plugin "${plugin.manifest.id}" is already enabled`) // TODO(plugins): write to storage plugin.flags |= Flag.Enabled if (late) plugin.flags |= Flag.EnabledLate pEmitter.emit('enabled', plugin) } export async function preInitPlugin(plugin: InternalPlugin) { const { manifest: { id }, lifecycles, } = plugin try { if (!lifecycles.preInit) return const meta = pMetadata.get(id)! const [, promises] = meta if (!(plugin.flags & Flag.Enabled)) throw new Error(`Plugin "${id}" is not enabled`) if (plugin.status & (Status.PreIniting | Status.PreInited)) throw new Error( `Plugin preInit lifecycle for "${id}" is already running`, ) preparePluginPreInit(plugin) plugin.status |= Status.PreIniting try { const prom = lifecycles.preInit(meta[0] as PreInitPluginApi) promises.push(prom) await prom // plugin.disable() already handles, so it's in the try block plugin.status |= Status.PreInited plugin.status &= ~Status.PreIniting } catch (e) { await handlePluginError(e, plugin) } } finally { pEmitter.emit('preInited', plugin) } } export async function initPlugin(plugin: InternalPlugin) { const { manifest: { id }, lifecycles, } = plugin try { if (!lifecycles.init) return const meta = pMetadata.get(id)! const [, promises, , apiLevel] = meta if (!(plugin.flags & Flag.Enabled)) throw new Error(`Plugin "${id}" is not enabled`) if (plugin.status & (Status.Initing | Status.Inited)) throw new Error( `Plugin init lifecycle for "${id}" is already running`, ) if (apiLevel < PluginApiLevel.PreInit) preparePluginPreInit(plugin) if (apiLevel < PluginApiLevel.Init) preparePluginInit(plugin) plugin.status |= Status.Initing try { const prom = lifecycles.init(meta[0] as InitPluginApi) promises.push(prom) await prom // plugin.disable() already handles, so it's in the try block plugin.status |= Status.Inited plugin.status &= ~Status.Initing } catch (e) { await handlePluginError(e, plugin) } } finally { pEmitter.emit('inited', plugin) } } export async function startPlugin(plugin: InternalPlugin) { const { manifest: { id }, lifecycles, } = plugin try { if (!lifecycles.start) return const meta = pMetadata.get(id)! const [, promises, , apiLevel] = meta if (!(plugin.flags & Flag.Enabled)) throw new Error(`Plugin "${id}" is not enabled`) if (plugin.status & (Status.Starting | Status.Started)) throw new Error( `Plugin start lifecycle for "${id}" is already running`, ) if (apiLevel < PluginApiLevel.PreInit) preparePluginPreInit(plugin) if (apiLevel < PluginApiLevel.Init) preparePluginInit(plugin) if (apiLevel < PluginApiLevel.Start) preparePluginStart(plugin) plugin.status |= Status.Starting try { const prom = lifecycles.start(meta[0] as PluginApi) promises.push(prom) await prom // disablePlugin() already handles cleaning up statuses, so it's in the try block plugin.status |= Status.Started plugin.status &= ~Status.Starting } catch (e) { await handlePluginError(e, plugin) } } finally { pEmitter.emit('started', plugin) } } const MaxWaitTime = 5000 export async function stopPlugin(plugin: InternalPlugin) { const { manifest: { id }, lifecycles, } = plugin const meta = pMetadata.get(id)! const [, promises, iflags, apiLevel] = meta if (iflags & InternalPluginFlags.Essential) throw new Error(`Plugin "${id}" is essential and cannot be stopped`) if (!(plugin.flags & Flag.Enabled)) throw new Error(`Plugin "${id}" is not enabled`) if (plugin.status & Status.Stopping) throw new Error(`Plugin "${id}" is stopping`) // If the plugin is running its lifecycles, we need to wait for it to finish, then we'll stop it // We want to wait at max 5 seconds for the lifecycles to finish if (plugin.status & (Status.PreIniting | Status.Initing | Status.Starting)) await Promise.race([ Promise.all(promises), sleepReject( MaxWaitTime, 'Plugin lifecycles timed out, force stopping', ), ]) .then(finished => { // If the lifecycles don't finish in 5 seconds, a reload is probably required to unapply the changes if (!finished) plugin.flags |= Flag.ReloadRequired }) .catch(e => { handlePluginError(e, plugin) }) else if ( !(plugin.status & (Status.PreInited | Status.Inited | Status.Started)) ) throw new Error(`Plugin "${id}" is not running`) if (apiLevel < PluginApiLevel.PreInit) preparePluginPreInit(plugin) if (apiLevel < PluginApiLevel.Init) preparePluginInit(plugin) if (apiLevel < PluginApiLevel.Start) preparePluginStart(plugin) plugin.status |= Status.Stopping try { if (!lifecycles.stop) return await Promise.race([ lifecycles.stop(meta[0] as PluginApi), sleepReject( MaxWaitTime, 'Plugin stop lifecycle timed out, force stopping', ), ]) } catch (e) { await handlePluginError(e, plugin) } finally { // Run cleanups function handleStopError(e: unknown) { // Some cleanup was unsuccessful, so we need to reload the app plugin.flags |= Flag.ReloadRequired return handlePluginError(e, plugin) } try { const results = await allSettled( plugin._c.map(cleanup => cleanup()), ) await Promise.all( results.map( result => result.status === 'rejected' && handleStopError(result.reason), ), ) } catch (e) { await handleStopError(e) } // Reset APIs meta[0] = undefined meta[3] = PluginApiLevel.None // Clear temp data meta[1] = [] plugin._c = [] // Reset status plugin.status = 0 pEmitter.emit('stopped', plugin) } } export interface InternalPlugin extends Plugin { _c: PluginCleanup[] } export const InternalPluginFlags = { /** * Marks the plugin as internal. */ Internal: 1 << 0, /** * Marks the plugin as essential. This means it should not be removed, disabled, or stopped by normal means. */ Essential: 1 << 1, } const PluginApiLevel = { None: 0, PreInit: 1, Init: 2, Start: 3, } as const