Files
LocalAI/core/http/react-ui/e2e/usage-dashboard.spec.js
LocalAI [bot] 5ac864dbed feat(ui): console-based navigation + drop-in API endpoint section (#10377)
* feat(ui): restructure sidebar into Create/Recognition/Build tiers

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* fix(ui): preserve exact sidebar gating for agent items and fine-tune/quantize

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* i18n(ui): add nav tier + console keys to all locales

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(ui): add grouped admin console via pathless layout route

Wrap the existing admin pages in a pathless AdminConsoleLayout route so
they keep their exact flat URLs while gaining a grouped left rail
(Inference / Cluster / Observability / Access / System). Rail item gating
mirrors the sidebar (adminOnly / authOnly / feature + /api/features). The
layout forwards the App-level outlet context (addToast) to the wrapped
pages, which read it via useOutletContext().

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(ui): fold Audio Transform into Studio as a tab

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* test(ui): update e2e specs for tiered nav + admin console

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* fix(ui): gate embedded Studio transform view on audio_transform feature

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(ui): visual polish + console-ize Build/Recognition tiers

Generalize the one-off admin console into a reusable ConsoleLayout driven by
a shared consoleConfig (single source of truth for the rail, its gating, and
the sidebar entry that opens it — removes the prior rail/sidebar drift).

- Promote Install Models to the top menu next to Home.
- Build and Operate are now console tiers (secondary rail); Create stays inline.
- Fold Recognition (Faces/Voices) into the Build console as a group alongside
  Automation and Training so it no longer feels split off.
- Style the console rail as a panel (header, grouped dividers, rounded active
  pills) with a hover nudge; sidebar items become inset rounded pills. The rail
  slide-in plays only when entering a console, not on item-to-item sub-nav
  (which remounts the layout), so switching no longer flashes the menu. All
  token-based (light + dark), respects reduced-motion.
- Add a delayed RouteFallback loader so lazy routes no longer flash blank;
  scoped inside ConsoleLayout so the rail stays put while the body loads.
- Update e2e specs for the new structure (.console-* classes, console entries).

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* feat(ui): persist console layout across sub-nav + add drop-in endpoint section

- Keep the page-transition key stable within a console (derived from the
  shared console config) so the ConsoleLayout and its rail persist across
  item-to-item navigation instead of remounting — fixes the submenu flash.
  Cache /api/features across mounts and play the rail entrance animation only
  when actually entering a console.
- Add a "One endpoint, every API" section to Home: leads with LocalAI's own
  native API (images, video, realtime voice over WebRTC/WS, depth, object
  detection, rerank, audio/TTS, face & voice recognition) plus a Full API
  reference link, then the drop-in compatibility layer (OpenAI, Anthropic,
  Ollama, OpenAI Responses) with the live copyable base URL. All 7 locales.

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

* fix(ui): revert Middleware nav label rename (keep Middleware in all locales)

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

---------

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
2026-06-18 00:09:17 +02:00

149 lines
5.0 KiB
JavaScript

import { test, expect } from '@playwright/test'
// Mock usage payload as the new /api/usage endpoint returns it.
const MOCK_USAGE = {
viewer: { id: 'local-uuid', name: 'local', role: 'admin', provider: 'local' },
totals: {
prompt_tokens: 1234,
completion_tokens: 567,
total_tokens: 1801,
request_count: 42,
},
usage: [
{
bucket: '2026-05-05',
model: 'qwen-7b',
user_id: 'local-uuid',
user_name: 'local',
prompt_tokens: 1234,
completion_tokens: 567,
total_tokens: 1801,
request_count: 42,
},
],
}
const MOCK_USAGE_AUTH_USER = {
...MOCK_USAGE,
viewer: { id: 'alice-uuid', name: 'Alice', role: 'user', provider: 'local' },
}
// Two scenarios:
// 1. No-auth single-user box: /api/auth/status returns authEnabled:false
// and the page must call /api/usage and render the local user's data.
// 2. Auth-on regular user: status returns authEnabled:true and the page
// keeps using /api/auth/usage as before.
//
// The point of these specs is the "prevent accidental removal" guarantee
// the user asked for: if anyone gates the Usage page behind auth again,
// scenario 1 fails immediately.
test.describe('Usage page — single-user no-auth mode', () => {
test.beforeEach(async ({ page }) => {
await page.route('**/api/auth/status', (route) =>
route.fulfill({
contentType: 'application/json',
body: JSON.stringify({
authEnabled: false,
staticApiKeyRequired: false,
providers: [],
}),
})
)
// The new no-auth code path. If anyone reverts Usage.jsx to
// /api/auth/usage in single-user mode, this route is never hit and
// the test fails because no usage data renders.
let usageHits = 0
await page.route('**/api/usage?**', (route) => {
usageHits++
route.fulfill({
contentType: 'application/json',
body: JSON.stringify(MOCK_USAGE),
})
})
// The synthetic local user has admin role, so Usage.jsx also pulls
// the cluster-wide view from /api/usage/all to populate displayTotals.
await page.route('**/api/usage/all?**', (route) =>
route.fulfill({
contentType: 'application/json',
body: JSON.stringify(MOCK_USAGE),
})
)
page.usageHits = () => usageHits
})
test('Usage entry is visible in the console without auth', async ({ page }) => {
// Usage lives in the Operate admin-console rail under Observability. In
// no-auth (single-user) mode isAdmin is true, so the console renders and
// the Usage rail link is reachable.
await page.goto('/app/usage')
await expect(page.locator('.console-rail a.nav-item[href="/app/usage"]')).toBeVisible()
})
test('navigating to /app/usage renders the dashboard with local-user data', async ({ page }) => {
await page.goto('/app/usage')
// The page used to bail with "Usage tracking unavailable" when authEnabled=false.
// We assert the *opposite*: data is rendered and the empty-state text is absent.
await expect(page.getByText('Usage tracking unavailable')).toHaveCount(0)
// The total-tokens stat card is one of the first things rendered after
// a successful /api/usage call. We assert the formatted number "1.8K"
// is present (formatNumber in Usage.jsx renders 1801 as "1.8K").
await expect(page.getByText('1.8K').first()).toBeVisible()
})
})
test.describe('Usage page — auth on', () => {
test.beforeEach(async ({ page }) => {
// RequireAuth redirects to /login when user is null, so the status
// response must include a resolved user for auth-on specs to reach
// the Usage page at all.
await page.route('**/api/auth/status', (route) =>
route.fulfill({
contentType: 'application/json',
body: JSON.stringify({
authEnabled: true,
staticApiKeyRequired: false,
providers: ['local'],
user: { id: 'alice-uuid', name: 'Alice', role: 'user', provider: 'local' },
}),
})
)
await page.route('**/api/auth/me', (route) =>
route.fulfill({
contentType: 'application/json',
body: JSON.stringify({
user: { id: 'alice-uuid', name: 'Alice', role: 'user', provider: 'local' },
permissions: {},
}),
})
)
await page.route('**/api/auth/usage?**', (route) =>
route.fulfill({
contentType: 'application/json',
body: JSON.stringify(MOCK_USAGE_AUTH_USER),
})
)
await page.route('**/api/auth/quota', (route) =>
route.fulfill({ contentType: 'application/json', body: JSON.stringify({ quotas: [] }) })
)
})
test('Usage page calls /api/auth/usage when auth is on', async ({ page }) => {
let authUsageHit = false
await page.route('**/api/auth/usage?**', (route) => {
authUsageHit = true
route.fulfill({
contentType: 'application/json',
body: JSON.stringify(MOCK_USAGE_AUTH_USER),
})
})
await page.goto('/app/usage')
await expect(page.getByText('1.8K').first()).toBeVisible()
expect(authUsageHit).toBe(true)
})
})