Skip to content

fix: parse nested JSON values for body flags #5

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

Merged
EvilFreelancer merged 1 commit into from
Mar 17, 2026
Merged

fix: parse nested JSON values for body flags #5

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
22 changes: 20 additions & 2 deletions src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,11 @@ async function runApiCommand(
const headers = buildHeaders(profile);

const knownOptionNames = new Set(command.options.map((o) => o.name));
const body: Record<string, string> = {};
const body: Record<string, unknown> = {};

Object.keys(flags).forEach((key) => {
if (!knownOptionNames.has(key)) {
body[key] = flags[key];
body[key] = parseBodyFlagValue(flags[key]);
}
});

Expand All @@ -179,6 +179,24 @@ async function runApiCommand(
stdout(`${JSON.stringify(response.data, null, 2)}\n`);
}

function parseBodyFlagValue(value: string): unknown {
const trimmed = value.trim();

if (trimmed === "true") return true;
if (trimmed === "false") return false;
if (trimmed === "null") return null;

if (trimmed.startsWith("{") || trimmed.startsWith("[")) {
try {
return JSON.parse(trimmed);
} catch {
throw new Error(`Invalid JSON body value: ${trimmed}`);
}
}

return value;
}

function parseArgs(args: string[]): { flags: Record<string, string>; positional: string[] } {
const flags: Record<string, string> = {};
const positional: string[] = [];
Expand Down
174 changes: 174 additions & 0 deletions tests/cli.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,6 +576,180 @@ describe("cli", () => {
expect(out).toContain('"ok": true');
});

// --- Body flag JSON parsing tests ---

function createPostApiDeps() {
const localDir = `${cwd}/.ocli`;
const profilesPath = `${localDir}/profiles.ini`;
const cachePath = `${localDir}/specs/body-api.json`;

const spec = {
openapi: "3.0.0",
paths: {
"/{org_slug}/{repo_slug}/ci/workflows/{workflow_name}/trigger": {
post: {
summary: "Trigger workflow",
parameters: [
{ name: "org_slug", in: "path", required: true, schema: { type: "string" } },
{ name: "repo_slug", in: "path", required: true, schema: { type: "string" } },
{ name: "workflow_name", in: "path", required: true, schema: { type: "string" } },
],
},
},
},
};

const iniContent = [
"[body-api]",
"api_base_url = https://api.example.com",
"api_basic_auth = ",
"api_bearer_token = tok",
"openapi_spec_source = /spec.json",
`openapi_spec_cache = ${cachePath}`,
"include_endpoints = ",
"exclude_endpoints = ",
"",
].join("\n");

const capturedConfigs: unknown[] = [];
const fakeHttpClient: HttpClient = {
request: async (config: any) => {
capturedConfigs.push(config);
return { status: 200, statusText: "OK", headers: {}, config, data: { ok: true } };
},
};

const { profileStore, openapiLoader } = createCliDeps(cwd, homeDir, {
[profilesPath]: iniContent,
[cachePath]: JSON.stringify(spec),
[`${localDir}/current`]: "body-api",
});

return { profileStore, openapiLoader, fakeHttpClient, capturedConfigs };
}

it("parses JSON object body flags before sending request", async () => {
const { profileStore, openapiLoader, fakeHttpClient, capturedConfigs } = createPostApiDeps();

await run(
[
"org_slug_repo_slug_ci_workflows_workflow_name_trigger",
"--org_slug", "myorg",
"--repo_slug", "myrepo",
"--workflow_name", "deploy",
"--revision", "main",
"--workflow_revision", "main",
"--input", '{"values":[{"name":"FOO","value":"bar"}]}',
],
{ cwd, profileStore, openapiLoader, httpClient: fakeHttpClient, stdout: () => {} }
);

expect(capturedConfigs).toHaveLength(1);
const config = capturedConfigs[0] as { data: Record<string, unknown> };
expect(config.data).toEqual({
revision: "main",
workflow_revision: "main",
input: {
values: [{ name: "FOO", value: "bar" }],
},
});
});

it("parses boolean body flags before sending request", async () => {
const { profileStore, openapiLoader, fakeHttpClient, capturedConfigs } = createPostApiDeps();

await run(
[
"org_slug_repo_slug_ci_workflows_workflow_name_trigger",
"--org_slug", "myorg",
"--repo_slug", "myrepo",
"--workflow_name", "deploy",
"--shared", "true",
"--draft", "false",
],
{ cwd, profileStore, openapiLoader, httpClient: fakeHttpClient, stdout: () => {} }
);

expect(capturedConfigs).toHaveLength(1);
const config = capturedConfigs[0] as { data: Record<string, unknown> };
expect(config.data.shared).toBe(true);
expect(config.data.draft).toBe(false);
});

it("parses null body flags before sending request", async () => {
const { profileStore, openapiLoader, fakeHttpClient, capturedConfigs } = createPostApiDeps();

await run(
[
"org_slug_repo_slug_ci_workflows_workflow_name_trigger",
"--org_slug", "myorg",
"--repo_slug", "myrepo",
"--workflow_name", "deploy",
"--description", "null",
],
{ cwd, profileStore, openapiLoader, httpClient: fakeHttpClient, stdout: () => {} }
);

expect(capturedConfigs).toHaveLength(1);
const config = capturedConfigs[0] as { data: Record<string, unknown> };
expect(config.data.description).toBeNull();
});

it("parses JSON array body flags before sending request", async () => {
const { profileStore, openapiLoader, fakeHttpClient, capturedConfigs } = createPostApiDeps();

await run(
[
"org_slug_repo_slug_ci_workflows_workflow_name_trigger",
"--org_slug", "myorg",
"--repo_slug", "myrepo",
"--workflow_name", "deploy",
"--tags", '["ci","deploy"]',
],
{ cwd, profileStore, openapiLoader, httpClient: fakeHttpClient, stdout: () => {} }
);

expect(capturedConfigs).toHaveLength(1);
const config = capturedConfigs[0] as { data: Record<string, unknown> };
expect(config.data.tags).toEqual(["ci", "deploy"]);
});

it("preserves plain string body flags", async () => {
const { profileStore, openapiLoader, fakeHttpClient, capturedConfigs } = createPostApiDeps();

await run(
[
"org_slug_repo_slug_ci_workflows_workflow_name_trigger",
"--org_slug", "myorg",
"--repo_slug", "myrepo",
"--workflow_name", "deploy",
"--revision", "main",
],
{ cwd, profileStore, openapiLoader, httpClient: fakeHttpClient, stdout: () => {} }
);

expect(capturedConfigs).toHaveLength(1);
const config = capturedConfigs[0] as { data: Record<string, unknown> };
expect(config.data.revision).toBe("main");
});

it("throws on invalid JSON-like body flags", async () => {
const { profileStore, openapiLoader, fakeHttpClient } = createPostApiDeps();

await expect(
run(
[
"org_slug_repo_slug_ci_workflows_workflow_name_trigger",
"--org_slug", "myorg",
"--repo_slug", "myrepo",
"--workflow_name", "deploy",
"--input", '{"values":',
],
{ cwd, profileStore, openapiLoader, httpClient: fakeHttpClient, stdout: () => {} }
)
).rejects.toThrow("Invalid JSON body value");
});

it("sends custom headers from profile in API requests", async () => {
const localDir = `${cwd}/.ocli`;
const profilesPath = `${localDir}/profiles.ini`;
Expand Down
Loading