Skip to content

feat(studio): show the connected OpenViking version in the sidebar footer - #7744

Open
zuoanCo wants to merge 1 commit into
volcengine:mainfrom
zuoanCo:feat/studio-show-server-version
Open

zuoanCo wants to merge 1 commit into
volcengine:mainfrom
zuoanCo:feat/studio-show-server-version

Conversation

@zuoanCo

@zuoanCo zuoanCo commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

Description

The Studio admin console does not show which OpenViking version the deployment is running. The server already reports it on GET /health, and the Studio connection layer already keeps it in the shared health state (useStudioService().version), but no UI consumed it.

This PR renders the connected server version in the Studio sidebar footer, so it is visible in the workbench and in the admin console (management mode) alike.

Human Involvement

  • A human participated in the implementation or review loop
  • This PR was generated entirely by AI agents without human participation in the loop

Related Issue

Fixes #7743

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test update

Changes Made

  • Add StudioVersion (web-studio/src/features/connection/components/studio-version.tsx), a small component that renders the server version from the shared connection state and renders nothing when the server reports no version.
  • Render it in the Studio sidebar footer, next to the collapse toggle (web-studio/src/app/layouts/studio-layout.tsx). The footer is shared by the workbench and the admin console, so both surfaces show the version.
  • Add the appShell.footer.version / appShell.footer.versionTitle messages in en and zh-CN.
  • Add a unit test for the component.

No server-side change and no new request: the version comes from the /health response the Studio already fetches when it connects.

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested this on the following platforms:
    • Linux
    • macOS
    • Windows

Commands run in web-studio:

npx vitest run src/i18n src/app/layouts src/features/connection
# 42 files, 383 tests passed

npx eslint src --ignore-pattern 'src/gen/**' --ignore-pattern 'src/routeTree.gen.ts'
# 0 errors, 8 pre-existing warnings in unrelated files

npx prettier --check <changed files>
# clean

npx vite build
# built successfully

Manual check: with the Studio dev server connected to a server whose /health reports version 0.9.9-mock, the sidebar footer shows OpenViking v0.9.9-mock in the workbench (/home) and in the admin console (/admin/configuration/server).

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Screenshots (if applicable)

The admin console (/admin/configuration/server) now shows the version in the sidebar footer:

OpenViking v0.9.9-mock

Additional Notes

The version badge is hidden when the sidebar is collapsed to icons and when the server reports no version (not connected yet, or offline), so it never shows an empty or stale value.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

[Feature]: show the current OpenViking version in the Studio admin console

1 participant