Spaces:
Sleeping
Sleeping
File size: 10,600 Bytes
525d39f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 | import { Injectable, OnModuleInit } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import * as fs from 'fs';
import * as path from 'path';
import { createLogger } from '../../common/services/logger.service';
import { HookManager } from '../hooks';
import {
PluginManifest,
PluginInstance,
PluginStatus,
PluginContext,
IPlugin,
PluginType,
PluginLogger,
} from './plugin.interfaces';
import { PluginStorageService } from './plugin-storage.service';
@Injectable()
export class PluginLoaderService implements OnModuleInit {
private readonly logger = createLogger('PluginLoaderService');
private readonly plugins = new Map<string, PluginInstance>();
private readonly pluginsDir: string;
constructor(
private readonly configService: ConfigService,
private readonly hookManager: HookManager,
private readonly pluginStorage: PluginStorageService,
) {
this.pluginsDir = this.configService.get<string>('plugins.dir') ?? './plugins';
}
onModuleInit(): void {
// Load built-in plugins first (synchronous registration)
this.loadBuiltInPlugins();
// Then load user plugins if directory exists
if (fs.existsSync(this.pluginsDir)) {
this.loadPluginsFromDirectory(this.pluginsDir);
}
this.logger.log(`Loaded ${this.plugins.size} plugins`, {
action: 'plugins_loaded',
count: this.plugins.size,
});
}
private loadBuiltInPlugins(): void {
// Built-in plugins are registered programmatically
// This will be used by Phase 4 to register engine plugins
this.logger.debug('Built-in plugins loading point (Phase 4)', {
action: 'builtin_plugins_init',
});
}
private loadPluginsFromDirectory(dir: string): void {
const entries = fs.readdirSync(dir, { withFileTypes: true });
for (const entry of entries) {
if (!entry.isDirectory()) continue;
const pluginPath = path.join(dir, entry.name);
const manifestPath = path.join(pluginPath, 'manifest.json');
if (!fs.existsSync(manifestPath)) {
this.logger.warn(`Plugin ${entry.name} missing manifest.json`, {
pluginPath,
action: 'manifest_missing',
});
continue;
}
try {
this.loadPlugin(pluginPath);
} catch (error) {
this.logger.error(
`Failed to load plugin ${entry.name}`,
error instanceof Error ? error.message : String(error),
{ pluginPath, action: 'plugin_load_failed' },
);
}
}
}
loadPlugin(pluginPath: string): PluginInstance {
const manifestPath = path.join(pluginPath, 'manifest.json');
const manifestContent = fs.readFileSync(manifestPath, 'utf-8');
const manifest = JSON.parse(manifestContent) as PluginManifest;
// Validate manifest
if (!manifest.id || !manifest.name || !manifest.version || !manifest.type || !manifest.main) {
throw new Error(`Invalid manifest: missing required fields`);
}
// Check if plugin already loaded
if (this.plugins.has(manifest.id)) {
throw new Error(`Plugin ${manifest.id} is already loaded`);
}
// Load stored config
const storedConfig = this.pluginStorage.getPluginConfig(manifest.id);
const pluginInstance: PluginInstance = {
manifest,
status: PluginStatus.INSTALLED,
config: storedConfig ?? {},
instance: null,
loadedAt: new Date(),
};
this.plugins.set(manifest.id, pluginInstance);
this.logger.log(`Plugin loaded: ${manifest.name} v${manifest.version}`, {
pluginId: manifest.id,
type: manifest.type,
action: 'plugin_loaded',
});
return pluginInstance;
}
async enablePlugin(pluginId: string): Promise<void> {
const plugin = this.plugins.get(pluginId);
if (!plugin) {
throw new Error(`Plugin ${pluginId} not found`);
}
if (plugin.status === PluginStatus.ENABLED) {
return; // Already enabled
}
try {
// Create plugin context
const context = this.createPluginContext(plugin);
// Load the plugin instance if not already loaded
if (!plugin.instance) {
const mainPath = path.join(this.pluginsDir, pluginId, plugin.manifest.main);
// Dynamic require for user plugins
// eslint-disable-next-line @typescript-eslint/no-require-imports
const pluginModule = require(mainPath) as { default?: new () => IPlugin };
if (pluginModule.default) {
plugin.instance = new pluginModule.default();
} else {
throw new Error(`Plugin ${pluginId} does not export a default class`);
}
}
// Call lifecycle hooks
if (plugin.instance.onLoad) {
await plugin.instance.onLoad(context);
}
if (plugin.instance.onEnable) {
await plugin.instance.onEnable(context);
}
plugin.status = PluginStatus.ENABLED;
plugin.enabledAt = new Date();
plugin.error = undefined;
// Persist status
this.pluginStorage.setPluginStatus(pluginId, PluginStatus.ENABLED);
this.logger.log(`Plugin enabled: ${plugin.manifest.name}`, {
pluginId,
action: 'plugin_enabled',
});
} catch (error) {
plugin.status = PluginStatus.ERROR;
plugin.error = error instanceof Error ? error.message : String(error);
this.pluginStorage.setPluginStatus(pluginId, PluginStatus.ERROR);
throw error;
}
}
async disablePlugin(pluginId: string): Promise<void> {
const plugin = this.plugins.get(pluginId);
if (!plugin) {
throw new Error(`Plugin ${pluginId} not found`);
}
if (plugin.status !== PluginStatus.ENABLED) {
return; // Not enabled
}
try {
const context = this.createPluginContext(plugin);
if (plugin.instance?.onDisable) {
await plugin.instance.onDisable(context);
}
// Unregister all hooks for this plugin
this.hookManager.unregisterPlugin(pluginId);
plugin.status = PluginStatus.DISABLED;
this.pluginStorage.setPluginStatus(pluginId, PluginStatus.DISABLED);
this.logger.log(`Plugin disabled: ${plugin.manifest.name}`, {
pluginId,
action: 'plugin_disabled',
});
} catch (error) {
plugin.status = PluginStatus.ERROR;
plugin.error = error instanceof Error ? error.message : String(error);
throw error;
}
}
async unloadPlugin(pluginId: string): Promise<void> {
const plugin = this.plugins.get(pluginId);
if (!plugin) {
throw new Error(`Plugin ${pluginId} not found`);
}
// Disable first if enabled
if (plugin.status === PluginStatus.ENABLED) {
await this.disablePlugin(pluginId);
}
// Call onUnload
if (plugin.instance?.onUnload) {
const context = this.createPluginContext(plugin);
await plugin.instance.onUnload(context);
}
this.plugins.delete(pluginId);
this.logger.log(`Plugin unloaded: ${plugin.manifest.name}`, {
pluginId,
action: 'plugin_unloaded',
});
}
updatePluginConfig(pluginId: string, config: Record<string, unknown>): void {
const plugin = this.plugins.get(pluginId);
if (!plugin) {
throw new Error(`Plugin ${pluginId} not found`);
}
plugin.config = { ...plugin.config, ...config };
// Persist config
this.pluginStorage.setPluginConfig(pluginId, plugin.config);
// Notify plugin of config change (async, fire and forget)
if (plugin.instance?.onConfigChange && plugin.status === PluginStatus.ENABLED) {
const context = this.createPluginContext(plugin);
void plugin.instance.onConfigChange(context, plugin.config);
}
this.logger.debug(`Plugin config updated: ${pluginId}`, {
pluginId,
action: 'plugin_config_updated',
});
}
private createPluginContext(plugin: PluginInstance): PluginContext {
const pluginLogger: PluginLogger = {
log: (message, meta) =>
this.logger.log(`[${plugin.manifest.id}] ${message}`, { ...meta, pluginId: plugin.manifest.id }),
debug: (message, meta) =>
this.logger.debug(`[${plugin.manifest.id}] ${message}`, { ...meta, pluginId: plugin.manifest.id }),
warn: (message, meta) =>
this.logger.warn(`[${plugin.manifest.id}] ${message}`, { ...meta, pluginId: plugin.manifest.id }),
error: (message, error, meta) =>
this.logger.error(
`[${plugin.manifest.id}] ${message}`,
error instanceof Error ? error.message : String(error),
{ ...meta, pluginId: plugin.manifest.id },
),
};
return {
pluginId: plugin.manifest.id,
manifest: plugin.manifest,
config: plugin.config,
hookManager: this.hookManager,
logger: pluginLogger,
storage: this.pluginStorage.createPluginStorage(plugin.manifest.id),
registerHook: (event, handler, priority) => {
this.hookManager.register(plugin.manifest.id, event, handler, priority);
},
getService: <T>(): T | undefined => {
// Limited service access for sandboxing
// Only expose safe services
return undefined;
},
};
}
// ============================================================================
// Query Methods
// ============================================================================
getPlugin(pluginId: string): PluginInstance | undefined {
return this.plugins.get(pluginId);
}
getAllPlugins(): PluginInstance[] {
return Array.from(this.plugins.values());
}
getPluginsByType(type: PluginType): PluginInstance[] {
return this.getAllPlugins().filter(p => p.manifest.type === type);
}
getEnabledPlugins(): PluginInstance[] {
return this.getAllPlugins().filter(p => p.status === PluginStatus.ENABLED);
}
isPluginEnabled(pluginId: string): boolean {
const plugin = this.plugins.get(pluginId);
return plugin?.status === PluginStatus.ENABLED;
}
// ============================================================================
// Built-in Plugin Registration (for Phase 4)
// ============================================================================
registerBuiltInPlugin(manifest: PluginManifest, instance: IPlugin): void {
const pluginInstance: PluginInstance = {
manifest,
status: PluginStatus.INSTALLED,
config: {},
instance,
loadedAt: new Date(),
};
this.plugins.set(manifest.id, pluginInstance);
this.logger.debug(`Built-in plugin registered: ${manifest.name}`, {
pluginId: manifest.id,
action: 'builtin_plugin_registered',
});
}
}
|