[KYUUBI #7504][UI] Add a Batch management page to the Web UI

[wangzhigang1999]

Why are the changes needed?

The Web UI has Session/Operation/Engine/Server pages but none for batch jobs (#7504), so batches can only be inspected via raw REST. This adds a Batch page to list / filter / paginate batches, view their details, open a running batch's Spark UI (direct, or via the engine-UI proxy when enabled), tail the batch log live, and cancel a non-terminal batch.

How was this patch tested?

• Unit tests (vitest) in src/test/unit/views/management/batch/index.spec.ts: driver-UI link gating by batch state, getAppUI proxy/direct URL building, and the log live-tail (incremental offset cursor, stop-on-terminal, buffer cap). cd kyuubi-server/web-ui && npx vitest run → 13/13; npm run lint clean.
• Manually verified against a running Kyuubi (Spark on Kubernetes and YARN): list / filter / cancel, the driver-UI link showing only for live batches and opening the proxied Spark UI, and the live log tail with auto-scroll.

Was this patch authored or co-authored using generative AI tooling?

Assisted-by: Claude:claude-opus-4-8

[wangzhigang1999]

[wangzhigang1999]

[wangzhigang1999]

[Copilot]

Pull request overview

Adds a new Batch management page to the Kyuubi Web UI (backed by existing /api/v1/batches APIs), including listing/filtering, viewing details, opening the running batch’s Spark UI (direct or via engine-UI proxy), tailing logs, and canceling non-terminal batches. It also factors out Engine UI URL building into a shared utility and aligns some UI state handling.

Changes:

• Add Batch management view, route, nav entry, REST client bindings, and unit tests.
• Introduce utils/engine-ui helper and refactor Engine page to use it.
• Update Operation page terminal-state strings.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
kyuubi-server/web-ui/src/views/management/operation/index.vue	Adjust terminal operation state names used by the UI.
kyuubi-server/web-ui/src/views/management/engine/index.vue	Use shared engine-UI URL builder for tooltip/link behavior.
kyuubi-server/web-ui/src/views/management/batch/index.vue	New Batch management page (list/filter/paginate, Spark UI link gating, log tailing, cancel).
kyuubi-server/web-ui/src/utils/use-table.ts	Changes error handling behavior for useTable() list fetching.
kyuubi-server/web-ui/src/utils/engine-ui.ts	New shared helper for direct vs proxied Engine UI URL building.
kyuubi-server/web-ui/src/test/unit/views/management/engine/index.spec.ts	Adjust engine UI URL test setup for proxy-enabled flag.
kyuubi-server/web-ui/src/test/unit/views/management/batch/index.spec.ts	Add unit tests for Batch UI link gating and log tail behavior.
kyuubi-server/web-ui/src/test/unit/utils/engine-ui.spec.ts	Add unit tests for engine-ui helper URL construction.
kyuubi-server/web-ui/src/router/management/index.ts	Add /management/batch route.
kyuubi-server/web-ui/src/locales/zh_CN/index.ts	Add Batch/log/pagination-related i18n strings.
kyuubi-server/web-ui/src/locales/en_US/index.ts	Add Batch/log/pagination-related i18n strings.
kyuubi-server/web-ui/src/layout/components/aside/types.ts	Add Batch entry to Management menu.
kyuubi-server/web-ui/src/api/batch/types.ts	Add batch API TypeScript types.
kyuubi-server/web-ui/src/api/batch/index.ts	Add batch REST API client functions.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[wangzhigang1999]

The pagination comments don't apply: total is the per-request page count, not a grand total (BatchesResource.scala:449 returns batches.size), so the existing tableData.length === pageSize check is correct.

[pan3793]

when ha is enabled, the batch list displays all batches across Kyuubi instances, or just from a single instance?

[wangzhigang1999]

when ha is enabled, the batch list displays all batches across Kyuubi instances, or just from a single instance?

It shows all batches recorded in the shared metadata store.

In HA mode, Kyuubi instances share the same metadata store, so the batch list is cluster-wide rather than limited to the current Kyuubi instance.

[aajisaka]

Thanks. Do we need to write a doc similar to engine UI: https://kyuubi.readthedocs.io/en/master/client/ui/engine_ui.html?

[wangzhigang1999]

Thanks. Do we need to write a doc similar to engine UI: https://kyuubi.readthedocs.io/en/master/client/ui/engine_ui.html?

Good idea — added docs/client/ui/batch_ui.md (modeled on the engine UI doc) in eec9971.

[wangzhigang1999]

Thank you for your review.

Merged to master.