@koishi-ce/plugin-config 1.0.8 → 1.0.9

package/src/browser/index.ts

@@ -12,7 +12,10 @@
  *    client 源码（供开发调试用）。
  */
 import { type Context, Schema } from "@koishi-ce/koishi";
-import { ConfigWriter, ServiceProvider } from "../shared/index.ts";
+import {
+	ConfigWriter,
+	ServiceProvider,
+} from "../shared/index.ts";
 import { PackageProvider } from "./packages.ts";
 
 export * from "../shared/index.ts";
@@ -35,6 +38,11 @@ export function apply(ctx: Context) {
 					`${process.env["KOISHI_BASE"]}/dist/index.js`,
 					`${process.env["KOISHI_BASE"]}/dist/style.css`,
 				]
-			: [import.meta.url.replace(/\/src\/[^/]+\/[^/]+$/, "/client/index.ts")],
+			: [
+					import.meta.url.replace(
+						/\/src\/[^/]+\/[^/]+$/,
+						"/client/index.ts",
+					),
+				],
 	);
 }

package/src/node/index.ts

@@ -12,13 +12,21 @@
 
 import { resolve } from "node:path";
 import { type Context, Schema } from "@koishi-ce/koishi";
-import { ConfigWriter, ServiceProvider } from "../shared/index.ts";
+import {
+	ConfigWriter,
+	ServiceProvider,
+} from "../shared/index.ts";
 import { PackageProvider } from "./packages.ts";
 
 export * from "../shared/index.ts";
 
 export const name = "config";
-export const inject = ["console"];
+// loader 由宿主以 builtin 服务提供，生产恒存在；测试等裸 App 环境可缺席，
+// 声明为非必需注入以免 cordis 报「property loader is not registered」
+export const inject = {
+	console: { required: true },
+	loader: { required: false },
+};
 
 export type Config = Record<never, never>;
 

package/src/node/packages.ts

@@ -90,13 +90,21 @@ export class PackageProvider extends shared.PackageProvider {
 		shared.PackageProvider.Data[]
 	> {
 		// 以完整包名为键索引全部条目（浅拷贝，避免跨 forced 扫描累积 paths）
-		const index = new Map<string, shared.PackageProvider.Data>();
+		const index = new Map<
+			string,
+			shared.PackageProvider.Data
+		>();
 		for (const object of this.scanner.objects) {
-			index.set(object.package.name, { ...object, paths: [] });
+			index.set(object.package.name, {
+				...object,
+				paths: [],
+			});
 		}
 		try {
 			await walkPlugins(
-				this.ctx.loader?.config?.plugins as Record<string, unknown> | undefined,
+				this.ctx.loader?.config?.plugins as
+					| Record<string, unknown>
+					| undefined,
 				async (key) => {
 					// 配置键形如 ./plugins/webui/config:uid，取 : 前的路径部分
 					const path = key.split(":", 1)[0];
@@ -106,14 +114,19 @@ export class PackageProvider extends shared.PackageProvider {
 					);
 					if (!object) return;
 					const name = object.package.name;
-					const entry = index.get(name) ?? { ...object, paths: [] };
+					const entry = index.get(name) ?? {
+						...object,
+						paths: [],
+					};
 					entry.paths ||= [];
-					if (!entry.paths.includes(path)) entry.paths.push(path);
+					if (!entry.paths.includes(path))
+						entry.paths.push(path);
 					index.set(name, entry);
 					// 登记「包名 → 配置键」反查，供 request-runtime 按路径解析
 					this.pathKeys[name] ||= path;
 					// 顺带解析运行时信息（loader.resolve 对路径键原生支持）
-					this.cache[path] ||= await this.parseExports(path);
+					this.cache[path] ||=
+						await this.parseExports(path);
 				},
 			);
 		} catch (error) {
@@ -136,7 +149,9 @@ async function walkPlugins(
 		if (key.split(":", 1)[0] === "group") {
 			const value = plugins?.[key];
 			await walkPlugins(
-				(value ?? {}) as Record<string, unknown> | undefined,
+				(value ?? {}) as
+					| Record<string, unknown>
+					| undefined,
 				handler,
 			);
 		} else {

package/src/shared/packages.ts

@@ -50,6 +50,8 @@ export abstract class PackageProvider extends DataService<
 	Dict<PackageProvider.Data>
 > {
 	cache: Dict<PackageProvider.RuntimeData> = {};
+	/** 进行中的解析（键 → 共享 promise），同键并发请求合并为一次模块加载 */
+	inflight: Dict<Promise<PackageProvider.RuntimeData>> = {};
 	debouncedRefresh: () => void;
 
 	/** 完整包名 → 引用它的首个配置键（workspace 相对路径），由 node 端 collect 填充 */
@@ -64,11 +66,20 @@ export abstract class PackageProvider extends DataService<
 		super(ctx, "packages", { authority: 4 });
 		this.ctx = ctx;
 
-		this.debouncedRefresh = ctx.debounce(() => this.refresh(false), 0);
+		this.debouncedRefresh = ctx.debounce(
+			() => this.refresh(false),
+			0,
+		);
 		// 插件的加载 / fork / 状态变化都可能影响运行时信息，统一走 update
-		ctx.on("internal/runtime", (scope) => this.update(scope.runtime.plugin));
-		ctx.on("internal/fork", (scope) => this.update(scope.runtime.plugin));
-		ctx.on("internal/status", (scope) => this.update(scope.runtime.plugin));
+		ctx.on("internal/runtime", (scope) =>
+			this.update(scope.runtime.plugin),
+		);
+		ctx.on("internal/fork", (scope) =>
+			this.update(scope.runtime.plugin),
+		);
+		ctx.on("internal/status", (scope) =>
+			this.update(scope.runtime.plugin),
+		);
 		ctx.on("hmr/reload", (reloads) => {
 			for (const [plugin] of reloads) {
 				this.update(plugin);
@@ -76,25 +87,27 @@ export abstract class PackageProvider extends DataService<
 		});
 
 		// 前端按需请求：某插件缺少运行时信息时（如刚安装尚未解析），
-		// 按其配置键（workspace 相对路径）或短名解析其导出并立即推送
+		// 按其配置键（workspace 相对路径）或短名解析其导出并立即推送。
+		// 解析失败同样写入缓存（failed 标记随数据下发）：前端展示失败
+		// 提示后不再重发请求——否则「请求 → 失败 → 广播 → 前端再请求」
+		// 互相喂养成活锁，加载即崩的插件会把日志瞬间打爆
 		ctx.console.addListener(
 			"config/request-runtime",
 			async (name) => {
-				// 依次尝试：路径配置键 → 短名 → 原名，首个解析成功的为准
+				// 依次尝试：路径配置键 → 短名 → 原名，首个解析成功的为准；
+				// 已有结果（含失败标记）的键直接复用，不重新解析
 				const candidates = [
 					this.pathKeys[name],
 					getPluginShortname(name),
 					name,
 				];
-				for (const key of candidates) {
+				for (const key of new Set(candidates)) {
 					if (!key) continue;
-					const result = await this.parseExports(key);
-					if (!result.failed) {
-						this.cache[key] = result;
-						break;
-					}
+					const result = (this.cache[key] ??=
+						await this.parseExports(key));
+					if (!result.failed) break;
 				}
-				this.refresh(false);
+				this.debouncedRefresh();
 			},
 			{ authority: 4 },
 		);
@@ -106,7 +119,9 @@ export abstract class PackageProvider extends DataService<
 	 *
 	 * @param forced 是否强制重新收集（绕过缓存）
 	 */
-	abstract collect(forced: boolean): Promise<PackageProvider.Data[]>;
+	abstract collect(
+		forced: boolean,
+	): Promise<PackageProvider.Data[]>;
 
 	/**
 	 * 某插件的运行时状态发生变化时，重新解析其导出并去抖刷新服务。
@@ -126,7 +141,10 @@ export abstract class PackageProvider extends DataService<
 	 * @param state 插件的主作用域
 	 * @param result 待填充的运行时数据（原地修改）
 	 */
-	parseRuntime(state: MainScope, result: PackageProvider.RuntimeData) {
+	parseRuntime(
+		state: MainScope,
+		result: PackageProvider.RuntimeData,
+	) {
 		// 已销毁的 runtime(uid 为 null)不展示 id
 		if (state.runtime.uid !== null) {
 			result.id = state.runtime.uid;
@@ -152,7 +170,10 @@ export abstract class PackageProvider extends DataService<
 			object.name = object.package?.name || "";
 			// 运行时缓存的键与写入方一致：workspace 包用配置键（./...），
 			// npm 包用短名；paths 为空时退回短名查找
-			const cached = [...(object.paths ?? []), object.shortname]
+			const cached = [
+				...(object.paths ?? []),
+				object.shortname,
+			]
 				.map((key) => this.cache[key])
 				.find(Boolean);
 			if (!cached) continue;
@@ -168,18 +189,32 @@ export abstract class PackageProvider extends DataService<
 			package: { name: "" },
 			// 全局设置条目不带市场元数据字段，用双断言放宽必填约束
 		} as unknown as PackageProvider.Data);
-		return Object.fromEntries(objects.map((data) => [data.name, data]));
+		return Object.fromEntries(
+			objects.map((data) => [data.name, data]),
+		);
 	}
 
 	/**
 	 * 解析插件模块的导出，提取配置 schema、用法文档、过滤器开关与
 	 * 注入的服务依赖（required / optional），并附带运行时 fork 状态。
-	 * 解析失败时返回 `{ failed: true }` 而不是抛错。
+	 * 解析失败时返回 `{ failed: true }` 而不是抛错。同键并发调用共享
+	 * 一次模块加载（抛错的模块不进 require.cache，每次都重新求值，
+	 * 并发即多份重复求值与告警）。
 	 *
 	 * @param name 插件短名（不含 koishi-plugin- 前缀）
 	 * @returns 可序列化的运行时数据
 	 */
-	async parseExports(name: string) {
+	parseExports(
+		name: string,
+	): Promise<PackageProvider.RuntimeData> {
+		const pending = (this.inflight[name] ??=
+			this.resolveExports(name).finally(() => {
+				delete this.inflight[name];
+			}));
+		return pending;
+	}
+
+	private async resolveExports(name: string) {
 		try {
 			// 插件本体之外的附加导出（配置面板消费的元信息）
 			type Extras = {
@@ -187,19 +222,25 @@ export abstract class PackageProvider extends DataService<
 				schema?: Schema;
 				usage?: string;
 				filter?: boolean;
-				using?: string[] | { required?: string[]; optional?: string[] };
-				inject?: string[] | { required?: string[]; optional?: string[] };
+				using?:
+					| string[]
+					| { required?: string[]; optional?: string[] };
+				inject?:
+					| string[]
+					| { required?: string[]; optional?: string[] };
 			};
-			const exports = (await this.ctx.loader.resolve(name)) as
-				| (Plugin & Extras)
-				| undefined;
+			const exports = (await this.ctx.loader.resolve(
+				name,
+			)) as (Plugin & Extras) | undefined;
 			const result: PackageProvider.RuntimeData = {};
 			const schema = exports?.Config || exports?.schema;
 			if (schema) result.schema = schema;
 			if (exports?.usage) result.usage = exports.usage;
-			if (exports?.filter !== undefined) result.filter = exports.filter;
+			if (exports?.filter !== undefined)
+				result.filter = exports.filter;
 			// using 与 inject 是新旧两种声明注入服务的方式
-			const inject = exports?.using || exports?.inject || [];
+			const inject =
+				exports?.using || exports?.inject || [];
 			if (Array.isArray(inject)) {
 				result.required = inject;
 				result.optional = [];
@@ -211,7 +252,9 @@ export abstract class PackageProvider extends DataService<
 			// 确保 result 可以被 JSON 序列化（schema 中可能混入不可序列化的值）
 			JSON.stringify(result);
 
-			const runtime = exports ? this.ctx.registry.get(exports) : undefined;
+			const runtime = exports
+				? this.ctx.registry.get(exports)
+				: undefined;
 			if (runtime) this.parseRuntime(runtime, result);
 			return result;
 		} catch (error) {
@@ -241,7 +284,10 @@ export namespace PackageProvider {
 		runtime?: RuntimeData;
 		package: Pick<
 			PackageJson,
-			"name" | "version" | "peerDependencies" | "peerDependenciesMeta"
+			| "name"
+			| "version"
+			| "peerDependencies"
+			| "peerDependenciesMeta"
 		>;
 	}
 

package/src/shared/services.ts

@@ -14,7 +14,9 @@
 import { DataService } from "@koishi-ce/console";
 import { Context, type Dict } from "@koishi-ce/koishi";
 
-export class ServiceProvider extends DataService<Dict<number>> {
+export class ServiceProvider extends DataService<
+	Dict<number>
+> {
 	constructor(ctx: Context) {
 		super(ctx, "services");
 		// 任何服务的注册 / 注销都会改变统计结果
@@ -28,21 +30,28 @@ export class ServiceProvider extends DataService<Dict<number>> {
 		 *
 		 * @param internal 当前层级的 internal 对象
 		 */
-		const attach = (internal: Context[typeof Context.internal]) => {
+		const attach = (
+			internal: Context[typeof Context.internal],
+		) => {
 			if (!internal) return;
 			attach(Object.getPrototypeOf(internal));
-			for (const [key, { type }] of Object.entries(internal)) {
+			for (const [key, { type }] of Object.entries(
+				internal,
+			)) {
 				if (type !== "service") continue;
 				const instance = this.ctx.get(key);
 				if (!(instance instanceof Object)) continue;
 				// Context.current 是个访问器属性，其值即服务实例所属的上下文
-				const ctx: Context = Reflect.getOwnPropertyDescriptor(
-					instance,
-					Context.current,
-				)?.value;
+				const ctx: Context =
+					Reflect.getOwnPropertyDescriptor(
+						instance,
+						Context.current,
+					)?.value;
 				if (!ctx) continue;
 				// 服务内部名形如 __foo__，对外展示时去掉首尾下划线
-				const name = key.replace(/^__/, "").replace(/__$/, "");
+				const name = key
+					.replace(/^__/, "")
+					.replace(/__$/, "");
 				// 已销毁的 scope(uid 为 null)不参与统计
 				if (ctx.scope.uid !== null) {
 					services[name] = ctx.scope.uid;

package/src/shared/writer.ts

@@ -15,8 +15,15 @@
  * 前提下增删改键"这一目标实现。
  */
 import { DataService } from "@koishi-ce/console";
-import { type Context, Logger, remove } from "@koishi-ce/koishi";
-import { Loader, type LoaderScope } from "@koishi-ce/loader";
+import {
+	type Context,
+	Logger,
+	remove,
+} from "@koishi-ce/koishi";
+import {
+	Loader,
+	type LoaderScope,
+} from "@koishi-ce/loader";
 
 // 声明合并：浏览器端通过 WebSocket 发送的 manager/* 事件及其载荷类型。
 // 服务端在构造函数中为每个事件注册监听器，见下方 ConfigWriter 构造函数。
@@ -29,7 +36,11 @@ declare module "@koishi-ce/console" {
 			target: string,
 			index: number,
 		): void;
-		"manager/reload"(parent: string, key: string, config: unknown): void;
+		"manager/reload"(
+			parent: string,
+			key: string,
+			config: unknown,
+		): void;
 		"manager/unload"(
 			parent: string,
 			key: string,
@@ -80,7 +91,9 @@ function rename(
 	value: unknown,
 ) {
 	const keys = Object.keys(object);
-	const index = keys.findIndex((key) => key === old || key === `~${old}`);
+	const index = keys.findIndex(
+		(key) => key === old || key === `~${old}`,
+	);
 	const rest = index < 0 ? [] : keys.slice(index + 1);
 	const temp = { [neo]: value };
 	delete object[old];
@@ -95,7 +108,10 @@ function rename(
  * @param plugins 插件配置对象
  * @param name 插件键名
  */
-function dropKey(plugins: Record<string, unknown>, name: string) {
+function dropKey(
+	plugins: Record<string, unknown>,
+	name: string,
+) {
 	if (!(name in plugins)) {
 		name = `~${name}`;
 	}
@@ -139,7 +155,9 @@ export class ConfigWriter extends DataService<Context.Config> {
 				async (...args: unknown[]) => {
 					try {
 						// 五个方法签名各异,统一视为泛化调用目标后 apply
-						const action = this[key] as (...args: unknown[]) => Promise<void>;
+						const action = this[key] as (
+							...args: unknown[]
+						) => Promise<void>;
 						await action.apply(this, args);
 					} catch (error) {
 						logger.error(error);
@@ -164,13 +182,21 @@ export class ConfigWriter extends DataService<Context.Config> {
 	 * @param plugins 某层上下文的 plugins 配置对象
 	 * @param ctx 该层对应的运行时上下文（用于查找 fork 记录）
 	 */
-	getGroup(plugins: Record<string, unknown> | undefined, ctx: Context) {
+	getGroup(
+		plugins: Record<string, unknown> | undefined,
+		ctx: Context,
+	) {
 		const result = { ...plugins };
 		for (const key in plugins ?? {}) {
 			if (key.startsWith("$")) continue;
 			// 配置值本质是任意 JSON 对象（插件配置或嵌套分组），此处按字典收窄使用
-			const value = plugins?.[key] as Record<string, unknown> | undefined;
-			const name = (key.split(":", 1)[0] ?? "").replace(/^~/, "");
+			const value = plugins?.[key] as
+				| Record<string, unknown>
+				| undefined;
+			const name = (key.split(":", 1)[0] ?? "").replace(
+				/^~/,
+				"",
+			);
 
 			if (!this.loader.isTruthyLike(value?.["$if"])) {
 				// $if-disabled 的插件不应显示在配置树中
@@ -180,7 +206,9 @@ export class ConfigWriter extends DataService<Context.Config> {
 			}
 
 			// 处理插件分组：分组本身是个子上下文，需要递归
-			const fork = (ctx.scope as LoaderScope)[Loader.kRecord]?.[key];
+			const fork = (ctx.scope as LoaderScope)[
+				Loader.kRecord
+			]?.[key];
 			if (!fork) continue;
 			if (name === "group") {
 				result[key] = this.getGroup(value, fork.ctx);
@@ -191,8 +219,13 @@ export class ConfigWriter extends DataService<Context.Config> {
 
 	/** 数据服务读取入口：返回去除敏感内部键后的整份应用配置。 */
 	override async get() {
-		const result: Context.Config = { ...this.loader.config };
-		result.plugins = this.getGroup(result.plugins, this.loader.entry);
+		const result: Context.Config = {
+			...this.loader.config,
+		};
+		result.plugins = this.getGroup(
+			result.plugins,
+			this.loader.entry,
+		);
 		return result;
 	}
 
@@ -227,7 +260,8 @@ export class ConfigWriter extends DataService<Context.Config> {
 		for (const main of this.ctx.registry.values()) {
 			for (const fork of main.children) {
 				// fork 的 key 由 loader 写入(ForkScope 类型上没有该属性)
-				if ((fork as LoaderScope).key === ident) return fork;
+				if ((fork as LoaderScope).key === ident)
+					return fork;
 			}
 		}
 		return;
@@ -243,17 +277,21 @@ export class ConfigWriter extends DataService<Context.Config> {
 	 */
 	private resolveConfig(
 		ident: string,
-		config: Record<string, unknown> | undefined = this.loader.config.plugins,
+		config: Record<string, unknown> | undefined = this
+			.loader.config.plugins,
 	): [Record<string, unknown>, string] {
 		if (config) {
 			for (const key in config) {
 				const name = key.split(":", 1)[0] ?? "";
-				if (key.slice(name.length + 1) === ident) return [config, key];
+				if (key.slice(name.length + 1) === ident)
+					return [config, key];
 				if (name === "group" || name === "~group") {
 					try {
 						return this.resolveConfig(
 							ident,
-							config[key] as Record<string, unknown> | undefined,
+							config[key] as
+								| Record<string, unknown>
+								| undefined,
 						);
 					} catch {}
 				}
@@ -271,7 +309,10 @@ export class ConfigWriter extends DataService<Context.Config> {
 	 * @param ident 插件路径标识
 	 * @param config 待合并的元数据键值对
 	 */
-	async meta(ident: string, config: Record<string, unknown>) {
+	async meta(
+		ident: string,
+		config: Record<string, unknown>,
+	) {
 		const [parent, key] = this.resolveConfig(ident);
 		const target = parent[key] as Record<string, unknown>;
 		for (const key of Object.keys(config)) {
@@ -291,7 +332,11 @@ export class ConfigWriter extends DataService<Context.Config> {
 	 * @param key 插件键名（形如 `name:ident`）
 	 * @param config 新的插件配置
 	 */
-	async reload(parent: string, key: string, config: unknown) {
+	async reload(
+		parent: string,
+		key: string,
+		config: unknown,
+	) {
 		const scope = this.resolveFork(parent);
 		if (!scope) throw new Error("plugin not found");
 		await this.loader.reload(scope.ctx, key, config);
@@ -320,7 +365,11 @@ export class ConfigWriter extends DataService<Context.Config> {
 		this.loader.unload(scope.ctx, key);
 		if (index) {
 			const rest = Object.keys(scope.config).slice(index);
-			insertKey(scope.config, { [`~${key}`]: config }, rest);
+			insertKey(
+				scope.config,
+				{ [`~${key}`]: config },
+				rest,
+			);
 		} else {
 			rename(scope.config, key, `~${key}`, config);
 		}
@@ -356,19 +405,29 @@ export class ConfigWriter extends DataService<Context.Config> {
 	 * @param target 目标分组的路径标识
 	 * @param index 目标插入位置（目标分组键序列中的序号）
 	 */
-	async teleport(source: string, key: string, target: string, index: number) {
+	async teleport(
+		source: string,
+		key: string,
+		target: string,
+		index: number,
+	) {
 		const parentS = this.resolveFork(source);
 		const parentT = this.resolveFork(target);
-		if (!parentS || !parentT) throw new Error("plugin not found");
+		if (!parentS || !parentT)
+			throw new Error("plugin not found");
 
 		// 第一步：迁移运行时 fork（仅在跨分组时需要）
-		const fork = (parentS as LoaderScope)[Loader.kRecord]?.[key];
+		const fork = (parentS as LoaderScope)[Loader.kRecord]?.[
+			key
+		];
 		if (fork && parentS !== parentT) {
-			const sourceRecord = ((parentS as LoaderScope)[Loader.kRecord] ??=
-				Object.create(null));
+			const sourceRecord = ((parentS as LoaderScope)[
+				Loader.kRecord
+			] ??= Object.create(null));
 			delete sourceRecord[key];
-			const targetRecord = ((parentT as LoaderScope)[Loader.kRecord] ??=
-				Object.create(null));
+			const targetRecord = ((parentT as LoaderScope)[
+				Loader.kRecord
+			] ??= Object.create(null));
 			targetRecord[key] = fork;
 			remove(parentS.disposables, fork.dispose);
 			parentT.disposables.push(fork.dispose);
@@ -378,7 +437,9 @@ export class ConfigWriter extends DataService<Context.Config> {
 			// scope 实例是转发到 config 的 Proxy,用 Reflect.get 保持原读取语义
 			if (
 				Object.keys(fork.runtime.inject).some(
-					(name) => Reflect.get(parentS, name) !== Reflect.get(parentT, name),
+					(name) =>
+						Reflect.get(parentS, name) !==
+						Reflect.get(parentT, name),
 				)
 			) {
 				fork.restart();