jobs: 0.89.0 changed jobs result shapes from snake_case to camelCase

Open
  • Is something wrong?
#699 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript
Domain
api, backend-api-design

Research direction

Start with packages/appkit/src/connectors/jobs/client.ts and reproduce the runNow() result using the TypeScript snippet in the issue; compare the affected methods and status payloads with the documented behavior. The issue offers two possible resolutions, so confirm which is intended before changing code; done means either restoring the described snake_case shapes or documenting the breaking change and affected fields in the 0.89.0 release notes.

Written by the indexing model from the issue text.

Description

Summary

In 0.89.0, the jobs plugin returns camelCase keys wherever it passes Jobs API objects through: the programmatic API, two routes, and the run object in status payloads. Through 0.88.1 these were snake_case. #647 says "Translate camelCase/bigint models back to the snake_case/number wire shape at the connector boundary, so the plugin's HTTP, SSE and cache output is unchanged", but the merged connector doesn't do that. The release notes list it as a feature, with no breaking-change note. Verified live against a real job on both versions.

Not affected (the common path)

Apps that trigger jobs and react to the status string see no change:

  • POST /api/jobs/:jobKey/run returns { runId } in both versions (confirmed from source).
  • GET /api/jobs/:jobKey/status and the runAndWait() / POST /run?stream=true updates keep the same status values (RUNNING, TERMINATED, and so on).
  • Failure results keep the same shape ({ ok: false, status, message }).
  • @databricks/appkit-ui doesn't read jobs results, so no built-in UI is affected.

Affected

Code that reads fields from a run or job object:

  • appkit.jobs(key).runNow(): data was { run_id, number_in_job, wait } and is now { runId }.
  • getRun, listRuns, lastRun, getRunOutput, getJob: all keys are camelCase. For example, run_id is now runId, run_page_url is now runPageUrl, and state.life_cycle_state is now state.lifeCycleState. TypeScript flags these at compile time; JavaScript gets undefined.
  • GET /runs and GET /runs/:runId: they return result.data directly, so their JSON keys changed. Client code breaks silently.
  • The run object in GET /status and in runAndWait() / streamed status updates: same key change.

Cause

packages/appkit/src/connectors/jobs/client.ts:

  • runNow returns { runId: Number(waiter.runId) }.
  • The other methods pass the modular SDK models through toNumbers. That helper converts bigints to numbers but keeps the SDK's camelCase keys.

Repro

const result = await appkit.jobs("default").runNow();
console.log(Object.keys(result.data));
// 0.88.1: ["run_id", "number_in_job", "wait"]
// 0.89.0: ["runId"]

Why it matters

jobs is exported from the package root, not /beta. The stability doc says only /beta APIs "may change between minor releases".

Ask

Either restore the snake_case shape that #647 describes, or keep camelCase and add a breaking-change note to the 0.89.0 release notes listing the affected methods and fields. Related: docs/plugins/jobs.md already changed to result.data.runId in 0.89.0.

This issue was written by Isaac.

Dominant language
TypeScript
Stars
119
Forks
36
Avg merge
4d 16h
Merged PRs (30d)
37

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from databricks/appkit

All issues in databricks/appkit

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.