Skip to content

Reject unknown top-level qm.config.jsonc fields #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
salluexez wants to merge 1 commit into from
Closed

Reject unknown top-level qm.config.jsonc fields #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions cli/src/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,10 +478,42 @@ export function readConfigOrgId(path: string): string | undefined {
}
}

const VALID_TOP_LEVEL_KEYS: ReadonlySet<string> = new Set([
"contract",
"orgId",
"publicUrl",
"apiUrl",
"target",
"model",
"modelProvider",
"basePort",
"services",
"plugins",
"skills",
"env",
"secretEnv",
"securityScreen",
"vms",
"imageOverrides",
"sandbox",
"appPrefix",
"region",
"flyOrg",
"imageFrom",
"deployAppPrefix",
"aws",
]);

function validate(raw: unknown, path: string): QmConfig {
if (!isPlainObject(raw)) throw new CliError(`${path}: expected a JSON object`);
const o = raw;

for (const key of Object.keys(o)) {
if (!VALID_TOP_LEVEL_KEYS.has(key)) {
throw new CliError(`${path}: unknown top-level field ${JSON.stringify(key)}`);
}
}

const contract = o["contract"];
if (contract !== CONTRACT_VERSION) {
if (typeof contract === "number" && Number.isInteger(contract)) {
Expand Down
6 changes: 6 additions & 0 deletions cli/test/config.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ test("required fields: orgId, target, services (must include core), valid servic
const { config } = loadConfigAt(path);
assert.deepEqual(config.services, ["core", "web-ui", "admin", "portal"]);
});
withConfig({ unknownField: "bad" }, ({ path }) =>
assert.throws(() => loadConfigAt(path), /unknown top-level field "unknownField"/),
);
withConfig({ org_id: "acme" }, ({ path }) =>
assert.throws(() => loadConfigAt(path), /unknown top-level field "org_id"/),
);
});

test("apiUrl must be an http(s) origin URL; the trailing slash is stripped", () => {
Expand Down