mirror of
https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
synced 2026-10-02 04:52:50 +08:00
feat(config): add default-off guestMode block with deep-merge
This commit is contained in:
1 parent
1fd5dbaba3
commit
fb7f187ede
2 files changed
+58
-1
No files matched your search
@@ -106,3 +106,28 @@ describe("config", () => {
|
|||||||
expect(migrated).toBe(false);
|
expect(migrated).toBe(false);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("guestMode config", () => {
|
||||||
|
it("defaults to disabled, all-bots, append-only", () => {
|
||||||
|
const c = getDefaultConfig();
|
||||||
|
expect(c.guestMode.enabled).toBe(false);
|
||||||
|
expect(c.guestMode.bots).toBe("all");
|
||||||
|
expect(c.guestMode.permissions).toEqual({
|
||||||
|
addToQueue: true, playNext: false, playNow: false,
|
||||||
|
skip: false, transport: false, removeClear: false, playMode: false,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("deep-merges a partial guestMode so missing sub-keys are back-filled", () => {
|
||||||
|
const dir = mkdtempSync(join(tmpdir(), "tsmb-cfg-"));
|
||||||
|
const p = join(dir, "config.json");
|
||||||
|
writeFileSync(p, JSON.stringify({ guestMode: { enabled: true, permissions: { playNext: true } } }));
|
||||||
|
const c = loadConfig(p);
|
||||||
|
expect(c.guestMode.enabled).toBe(true);
|
||||||
|
expect(c.guestMode.bots).toBe("all"); // back-filled
|
||||||
|
expect(c.guestMode.permissions.playNext).toBe(true);
|
||||||
|
expect(c.guestMode.permissions.addToQueue).toBe(true); // back-filled default
|
||||||
|
expect(c.guestMode.permissions.skip).toBe(false); // back-filled default
|
||||||
|
rmSync(dir, { recursive: true, force: true });
|
||||||
|
});
|
||||||
|
});
|
||||||
+33
-1
@@ -1,5 +1,12 @@
|
|||||||
import { readFileSync, writeFileSync, mkdirSync, existsSync, copyFileSync, rmSync } from "node:fs";
|
import { readFileSync, writeFileSync, mkdirSync, existsSync, copyFileSync, rmSync } from "node:fs";
|
||||||
import { dirname } from "node:path";
|
import { dirname } from "node:path";
|
||||||
|
import type { BotAccess, GuestPermissions } from "./permissions.js";
|
||||||
|
|
||||||
|
export interface GuestModeConfig {
|
||||||
|
enabled: boolean;
|
||||||
|
bots: BotAccess; // "all" | string[]
|
||||||
|
permissions: GuestPermissions;
|
||||||
|
}
|
||||||
|
|
||||||
export interface BotConfig {
|
export interface BotConfig {
|
||||||
webPort: number;
|
webPort: number;
|
||||||
@@ -22,6 +29,7 @@ export interface BotConfig {
|
|||||||
// (nginx/Caddy/Cloudflare). Required for correct protocol/host detection
|
// (nginx/Caddy/Cloudflare). Required for correct protocol/host detection
|
||||||
// behind HTTPS-terminating proxies.
|
// behind HTTPS-terminating proxies.
|
||||||
trustProxy: boolean;
|
trustProxy: boolean;
|
||||||
|
guestMode: GuestModeConfig;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getDefaultConfig(): BotConfig {
|
export function getDefaultConfig(): BotConfig {
|
||||||
@@ -43,6 +51,19 @@ export function getDefaultConfig(): BotConfig {
|
|||||||
idleTimeoutMinutes: 0,
|
idleTimeoutMinutes: 0,
|
||||||
publicUrl: "",
|
publicUrl: "",
|
||||||
trustProxy: false,
|
trustProxy: false,
|
||||||
|
guestMode: {
|
||||||
|
enabled: false,
|
||||||
|
bots: "all",
|
||||||
|
permissions: {
|
||||||
|
addToQueue: true,
|
||||||
|
playNext: false,
|
||||||
|
playNow: false,
|
||||||
|
skip: false,
|
||||||
|
transport: false,
|
||||||
|
removeClear: false,
|
||||||
|
playMode: false,
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -51,7 +72,18 @@ export function loadConfig(path: string): BotConfig {
|
|||||||
try {
|
try {
|
||||||
const raw = readFileSync(path, "utf-8");
|
const raw = readFileSync(path, "utf-8");
|
||||||
const partial = JSON.parse(raw) as Partial<BotConfig>;
|
const partial = JSON.parse(raw) as Partial<BotConfig>;
|
||||||
return { ...defaults, ...partial };
|
return {
|
||||||
|
...defaults,
|
||||||
|
...partial,
|
||||||
|
guestMode: {
|
||||||
|
...defaults.guestMode,
|
||||||
|
...(partial.guestMode ?? {}),
|
||||||
|
permissions: {
|
||||||
|
...defaults.guestMode.permissions,
|
||||||
|
...(partial.guestMode?.permissions ?? {}),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
} catch {
|
} catch {
|
||||||
return defaults;
|
return defaults;
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in new issue
Block a user