mirror of
https://github.com/openobserve/openobserve.git
synced 2026-11-04 00:08:55 +00:00
Ashish Kolheandktx-abhay
c07e4a6879
## What Lets an org pin a single dashboard as a tab on the **Home** page for the whole organization. The chosen dashboard is stored server-side (per org) so it persists across devices/browsers, and every member of the org sees the same home tab. ## How - **New `useHomeDashboard` composable** — single-value, server-backed store using the existing `settings/v2` KV API (`setting_key: "home_dashboard"`, org scope). Optimistic writes with revert-on-failure (403 → permission toast), a falsy-org guard, and label auto-sync that persists. - **Loads in the existing `getOrganizationSettings()` hook** (boot + org switch), so it is naturally **org-scoped** — switching orgs shows that org's home dashboard, with no cross-org leak. - **HomeView** renders the single home tab (read-only `PinnedDashboardTab` embedding `RenderDashboardCharts` with its own time picker); the tab × removes it. - **Set / remove** from the dashboard list ⋮ overflow menu and the ViewDashboard header button, with an at-a-glance indicator on the home dashboard. ## Scope - **Frontend only — no backend changes.** Reuses the existing `system_settings` table + `settings/v2` handler + its RBAC gate. - Single value (max 1); pinning a new dashboard replaces the previous one. - Permissions are enforced by the settings API (a 403 reverts the optimistic change + toasts) — no client-side RBAC logic. ## Testing - **74 unit tests**: composable (optimistic/revert/403/falsy-org guard/label persist), HomeView (single tab render, × pointerdown-activation regression), PinnedDashboardTab (time/panel contracts, µs time shape, tab-id provide). - **Verified live against a local server**: set → server persists → **fresh browser context with no localStorage** renders the tab → replace swaps the single value → remove clears it. **Org isolation confirmed** (`default` vs `demo` resolve independent values). - 0 type errors in touched files. Single squashed commit; 10 files, +1154/-11. --------- Co-authored-by: ktx-abhay <abhay.padamani@kiara.tech>
web
This template should help get you started developing with Vue 3 in Vite.
Recommended IDE Setup
VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).
Type Support for .vue Imports in TS
TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:
- Disable the built-in TypeScript Extension
- Run
Extensions: Show Built-in Extensionsfrom VSCode's command palette - Find
TypeScript and JavaScript Language Features, right click and selectDisable (Workspace)
- Run
- Reload the VSCode window by running
Developer: Reload Windowfrom the command palette.
Customize configuration
See Vite Configuration Reference.
Project Setup
npm install
Compile and Hot-Reload for Development
For stand-alone UI development environment, create .env file and which contains below environment variable
VITE_OPENOBSERVE_ENDPOINT=http://localhost:5080/
npm run dev
Type-Check, Compile and Minify for Production
npm run build
Run Unit Tests with Vitest
npm run test:unit
Run End-to-End Tests with Cypress
npm run test:e2e:dev
This runs the end-to-end tests against the Vite development server. It is much faster than the production build.
But it's still recommended to test the production build with test:e2e before deploying (e.g. in CI environments):
npm run build
npm run test:e2e
Lint with ESLint
npm run lint