@koishi-ce/plugin-config 1.1.3 → 1.1.5

package/src/__tests__/services.test.ts

@@ -0,0 +1,105 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// Copyright (c) 2019-present Shigma and Koishijs contributors.
+// Copyright (c) 2026-present Koishi-CE contributors.
+
+import {
+	afterAll,
+	beforeAll,
+	describe,
+	expect,
+	it,
+} from "bun:test";
+import {
+	App,
+	type Dict,
+	type Plugin,
+} from "@koishi-ce/koishi";
+import * as configPlugin from "@koishi-ce/plugin-config";
+import {
+	app,
+	itQuiet,
+	readSent,
+	socket,
+	startApp,
+	stopApp,
+	TestConsole,
+	tick,
+} from "./helpers.ts";
+
+beforeAll(startApp);
+afterAll(stopApp);
+
+describe("@koishi-ce/plugin-config", () => {
+	itQuiet(
+		["app"],
+		"无可写 loader 时仅告警并跳过装配",
+		async () => {
+			const bare = new App();
+			bare.plugin(
+				TestConsole as unknown as Plugin.Constructor<App>,
+			);
+			bare.plugin(configPlugin);
+			await bare.start();
+			expect(
+				bare.get("console.services.config"),
+			).toBeUndefined();
+			expect(
+				bare.get("console.services.packages"),
+			).toBeUndefined();
+			expect(
+				bare.get("console.services.services"),
+			).toBeUndefined();
+			await bare.stop();
+		},
+	);
+
+	it("挂载 packages / services / config 三个数据服务", () => {
+		expect(
+			app.get("console.services.packages"),
+		).toBeTruthy();
+		expect(
+			app.get("console.services.services"),
+		).toBeTruthy();
+		expect(app.get("console.services.config")).toBeTruthy();
+	});
+
+	describe("ServiceProvider", () => {
+		it("上报各服务的提供者上下文并在服务变动时刷新", async () => {
+			const provider = app.get(
+				"console.services.services",
+			) as unknown as {
+				get(): Promise<Dict<number>>;
+			};
+			const data = await provider.get();
+			expect(data["console"]).toBeGreaterThanOrEqual(0);
+			// 服务注册（set 会广播 internal/service）→ refresh → 客户端收到 services 数据
+			socket.sent.length = 0;
+			app.set(
+				"probe.svc" as never,
+				{ marker: true } as never,
+			);
+			await tick(30);
+			const messages = readSent().filter(
+				(msg) =>
+					msg.type === "data" &&
+					msg.body.key === "services",
+			);
+			expect(messages.length).toBeGreaterThan(0);
+		});
+
+		it("provide() 注册的服务同样上报（loader / watcher 形态）", async () => {
+			const provider = app.get(
+				"console.services.services",
+			) as unknown as {
+				get(): Promise<Dict<number>>;
+			};
+			// cordis 3.18 的 ctx.provide() 不给值定义自有 "ctx" 属性
+			// （只有 tracker 符号，经 traceable 代理的属性访问可达），
+			// descriptor 查询落空时须以属性访问兜底，否则配置页
+			// 恒显示「必需服务未加载」
+			app.provide("probe.plain", { marker: 1 });
+			const data = await provider.get();
+			expect(data["probe.plain"]).toBeGreaterThanOrEqual(0);
+		});
+	});
+});

package/src/__tests__/writer-events.test.ts

@@ -0,0 +1,270 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// Copyright (c) 2019-present Shigma and Koishijs contributors.
+// Copyright (c) 2026-present Koishi-CE contributors.
+
+import {
+	afterAll,
+	beforeAll,
+	describe,
+	expect,
+	it,
+} from "bun:test";
+import type { Plugin } from "@koishi-ce/koishi";
+import {
+	app,
+	client,
+	flushWrites,
+	itQuiet,
+	loader,
+	readSent,
+	startApp,
+	stopApp,
+	writer,
+} from "./helpers.ts";
+
+beforeAll(startApp);
+afterAll(stopApp);
+
+describe("@koishi-ce/plugin-config", () => {
+	describe("ConfigWriter.get()", () => {
+		it("过滤未加载项，分组递归展开，$ 与 ~ 键原样保留", async () => {
+			const result = await writer().get();
+			const plugins = result.plugins as Record<
+				string,
+				unknown
+			>;
+			// $if 为假的键不出现；$ 内部键与 ~ 停用键保留
+			expect("gone:xyz" in plugins).toBe(false);
+			expect(plugins["$sfolded"]).toBe(true);
+			expect(plugins["~disabled:q"]).toEqual({ a: 1 });
+			expect(plugins["keep:abc"]).toEqual({ v: 1 });
+			expect(plugins["group:g1"]).toEqual({
+				"./plugins/webui/auth": {},
+				"./missing-pkg": {},
+				"inner:two": { t: 2 },
+				"mov:me": { m: 1 },
+			});
+		});
+	});
+
+	describe("ConfigWriter 事件", () => {
+		it("manager/meta 更新元数据键（含 null 删除）", async () => {
+			const listener =
+				app.console.listeners["manager/meta"];
+			await listener?.callback.call(
+				client as never,
+				"abc",
+				{
+					$label: "L",
+					$collapsed: null,
+				},
+			);
+			await flushWrites();
+			const plugins = loader.config.plugins as Record<
+				string,
+				Record<string, unknown>
+			>;
+			expect(plugins["keep:abc"]?.["$label"]).toBe("L");
+			expect(
+				"$collapsed" in (plugins["keep:abc"] ?? {}),
+			).toBe(false);
+			// 元数据键置于配置开头
+			expect(
+				Object.keys(plugins["keep:abc"] ?? {})[0],
+			).toBe("$label");
+			// 分组内插件的 meta（按 ident 递归定位）
+			await listener?.callback.call(
+				client as never,
+				"two",
+				{
+					$label: "G",
+				},
+			);
+			await flushWrites();
+			const group = plugins["group:g1"] as Record<
+				string,
+				Record<string, unknown>
+			>;
+			expect(group["inner:two"]?.["$label"]).toBe("G");
+		});
+
+		it("manager/reload 更新插件配置并保持键位置", async () => {
+			const listener =
+				app.console.listeners["manager/reload"];
+			await listener?.callback.call(
+				client as never,
+				"",
+				"keep:abc",
+				{
+					v: 2,
+				},
+			);
+			await flushWrites();
+			const plugins = loader.config.plugins as Record<
+				string,
+				unknown
+			>;
+			expect(plugins["keep:abc"]).toEqual({ v: 2 });
+			const dummy = loader.data["keep"] as Plugin;
+			expect(app.registry.get(dummy)?.config).toEqual({
+				v: 2,
+			});
+			// 运行期更新触发回写
+			expect(loader.writes.length).toBeGreaterThan(0);
+		});
+
+		it("manager/unload 停用插件（原位改 ~ 与按位置插入）", async () => {
+			const listener =
+				app.console.listeners["manager/unload"];
+			// 原位重命名
+			await listener?.callback.call(
+				client as never,
+				"",
+				"keep:abc",
+				{
+					v: 3,
+				},
+			);
+			await flushWrites();
+			const plugins = loader.config.plugins as Record<
+				string,
+				unknown
+			>;
+			expect("keep:abc" in plugins).toBe(false);
+			expect(plugins["~keep:abc"]).toEqual({ v: 3 });
+			const dummy = loader.data["keep"] as Plugin;
+			expect(app.registry.get(dummy)).toBeUndefined();
+
+			// 先补一个可停用键，再按 index 插入到指定位置
+			const reload =
+				app.console.listeners["manager/reload"];
+			await reload?.callback.call(
+				client as never,
+				"",
+				"back:two",
+				{
+					b: 1,
+				},
+			);
+			await flushWrites();
+			await listener?.callback.call(
+				client as never,
+				"",
+				"back:two",
+				{},
+				1,
+			);
+			await flushWrites();
+			const keys = Object.keys(
+				loader.config.plugins as object,
+			);
+			expect(keys.indexOf("~back:two")).toBe(1);
+		});
+
+		it("manager/remove 彻底移除插件（含 ~ 停用态键）", async () => {
+			const listener =
+				app.console.listeners["manager/remove"];
+			await listener?.callback.call(
+				client as never,
+				"",
+				"~keep:abc",
+			);
+			await flushWrites();
+			const plugins = loader.config.plugins as Record<
+				string,
+				unknown
+			>;
+			expect("keep:abc" in plugins).toBe(false);
+			expect("~keep:abc" in plugins).toBe(false);
+			await listener?.callback.call(
+				client as never,
+				"",
+				"pos:one",
+			);
+			await flushWrites();
+			expect("pos:one" in plugins).toBe(false);
+		});
+
+		it("manager/teleport 跨分组迁移与同分组重排", async () => {
+			const listener =
+				app.console.listeners["manager/teleport"];
+			const plugins = loader.config.plugins as Record<
+				string,
+				unknown
+			>;
+			// 跨分组：group:g1 → 根（index 0）
+			await listener?.callback.call(
+				client as never,
+				"g1",
+				"mov:me",
+				"",
+				0,
+			);
+			await flushWrites();
+			expect(plugins["mov:me"]).toEqual({ m: 1 });
+			const group = plugins["group:g1"] as Record<
+				string,
+				unknown
+			>;
+			expect("mov:me" in group).toBe(false);
+			// 运行时 fork 已改挂根作用域
+			const dummy = loader.data["mov"] as Plugin;
+			const fork = app.registry.get(dummy)?.children[0];
+			expect(fork?.parent.scope.uid).toBe(
+				loader.entry.scope.uid,
+			);
+
+			// 同分组：仅重排键位置
+			await listener?.callback.call(
+				client as never,
+				"",
+				"mov:me",
+				"",
+				0,
+			);
+			await flushWrites();
+			expect(Object.keys(plugins)[0]).toBe("mov:me");
+		});
+
+		itQuiet(
+			["loader"],
+			"manager/* 失败统一回执 failed",
+			async () => {
+				const listener =
+					app.console.listeners["manager/teleport"];
+				await expect(
+					listener?.callback.call(
+						client as never,
+						"no-such-group",
+						"k",
+						"",
+						0,
+					),
+				).rejects.toThrow("failed");
+			},
+		);
+
+		it("manager/app-reload 替换全局配置并整进程重载", async () => {
+			const listener =
+				app.console.listeners["manager/app-reload"];
+			const writesBefore = loader.writes.length;
+			await listener?.callback.call(client as never, {
+				prefix: ["."],
+			});
+			await flushWrites();
+			expect(loader.config.prefix).toEqual(["."]);
+			// plugins 部分被保留
+			expect(loader.config.plugins).toBeTruthy();
+			expect(loader.writes.length).toBeGreaterThan(
+				writesBefore,
+			);
+			expect(loader.fullReloadCount).toBe(1);
+			// 非静默写盘触发 config 事件 → config 服务刷新推送
+			const messages = readSent().filter(
+				(msg) =>
+					msg.type === "data" && msg.body.key === "config",
+			);
+			expect(messages.length).toBeGreaterThan(0);
+		});
+	});
+});

package/src/shared/console-events.ts

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// Copyright (c) 2019-present Shigma and Koishijs contributors.
+// Copyright (c) 2026-present Koishi-CE contributors.
+
+/**
+ * config 插件的 manager/* 控制台事件签名（唯一权威定义）。
+ *
+ * 服务端（writer.ts）与浏览器端（client/components/utils.ts）分别对
+ * "@koishi-ce/console" 与 "@koishi-ce/plugin-console" 做同名声明合并：
+ * 浏览器端 tsconfig 无 paths，console 的类型来自宿主 shims 的手写环境
+ * 声明，模块名必须分开挂载。Events 文本以本文件的 ManagerEvents 为
+ * 唯一来源，两端经 extends 引用，避免双份镜像漂移。本文件须被两端
+ * import（type-only 即可）才会进入各自的类型程序。
+ */
+
+/** manager/* 事件的载荷签名（配置的重载 / 停用 / 移除 / 改名 / 拖拽）。 */
+interface ManagerEvents {
+	"manager/app-reload"(config: unknown): void;
+	"manager/teleport"(
+		source: string,
+		key: string,
+		target: string,
+		index: number,
+	): void;
+	"manager/reload"(
+		parent: string,
+		key: string,
+		config: unknown,
+	): void;
+	"manager/unload"(
+		parent: string,
+		key: string,
+		config: unknown,
+		index?: number,
+	): void;
+	"manager/remove"(parent: string, key: string): void;
+	"manager/meta"(ident: string, config: unknown): void;
+}
+
+declare module "@koishi-ce/console" {
+	interface Events extends ManagerEvents {}
+}
+
+declare module "@koishi-ce/plugin-console" {
+	interface Events extends ManagerEvents {}
+}

package/src/shared/writer.ts

@@ -21,86 +21,17 @@ import {
 	remove,
 } from "@koishi-ce/koishi";
 import {
+	insertKey,
 	Loader,
 	type LoaderScope,
+	rename,
 } from "@koishi-ce/loader";
 
-// 声明合并：浏览器端通过 WebSocket 发送的 manager/* 事件及其载荷类型。
-// 服务端在构造函数中为每个事件注册监听器，见下方 ConfigWriter 构造函数。
-declare module "@koishi-ce/console" {
-	interface Events {
-		"manager/app-reload"(config: unknown): void;
-		"manager/teleport"(
-			source: string,
-			key: string,
-			target: string,
-			index: number,
-		): void;
-		"manager/reload"(
-			parent: string,
-			key: string,
-			config: unknown,
-		): void;
-		"manager/unload"(
-			parent: string,
-			key: string,
-			config: unknown,
-			index?: number,
-		): void;
-		"manager/remove"(parent: string, key: string): void;
-		"manager/meta"(ident: string, config: unknown): void;
-	}
-}
+// manager/* 事件的签名合并见同目录 console-events.ts（唯一权威定义）
+import type {} from "./console-events.ts";
 
 const logger = new Logger("loader");
 
-/**
- * 把 temp 中的键插入到 object 的开头（原有 rest 键依次后移），用于在
- * 不破坏其它键相对顺序的前提下完成"插入到指定位置"的配置操作。
- *
- * 实现方式是先把 rest 中的键全部搬到 temp 里，再用 Object.assign 合并回来。
- *
- * @param object 目标配置对象（会被原地修改）
- * @param temp 待插入的键值对
- * @param rest 需要让位的既有键名列表
- */
-function insertKey(
-	object: Record<string, unknown>,
-	temp: Record<string, unknown>,
-	rest: string[],
-) {
-	for (const key of rest) {
-		temp[key] = object[key];
-		delete object[key];
-	}
-	Object.assign(object, temp);
-}
-
-/**
- * 在对象中把键 old 重命名为 neo（并可顺带替换其值），且保持键原有的位置。
- *
- * @param object 目标配置对象
- * @param old 旧键名（可为 `"~" + name` 形式的停用态键）
- * @param neo 新键名
- * @param value 新键对应的值
- */
-function rename(
-	object: Record<string, unknown>,
-	old: string,
-	neo: string,
-	value: unknown,
-) {
-	const keys = Object.keys(object);
-	const index = keys.findIndex(
-		(key) => key === old || key === `~${old}`,
-	);
-	const rest = index < 0 ? [] : keys.slice(index + 1);
-	const temp = { [neo]: value };
-	delete object[old];
-	delete object[`~${old}`];
-	insertKey(object, temp, rest);
-}
-
 /**
  * 从 plugins 配置中摘除指定的键（兼容 `~` 前缀的停用态键），返回以该键
  * 为唯一成员的对象，便于随后通过 insertKey 插入到别处（teleport 场景）。