@rapidmx/web-client 0.19.0 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +381 -381
- package/apps/admin/branding/index.tsx +39 -39
- package/apps/admin/data-requests/index.tsx +482 -482
- package/apps/admin/domains/[uid].tsx +166 -166
- package/apps/admin/escrow-scopes/[uid].tsx +350 -350
- package/apps/admin/index.tsx +129 -129
- package/apps/admin/mailboxes/[uid].tsx +271 -271
- package/apps/admin/mailboxes/new/index.tsx +30 -30
- package/apps/admin/plugins/index.tsx +15 -15
- package/apps/admin/retention-policy/index.tsx +39 -39
- package/apps/admin/signing-certificates/index.tsx +343 -343
- package/apps/escrow/audit-log/index.tsx +196 -196
- package/apps/escrow/matters/[uid].tsx +621 -621
- package/apps/shared/auth/adminAccess.ts +99 -99
- package/apps/shared/components/admin/diagnostics/HostCard.tsx +2 -0
- package/apps/shared/components/admin/diagnostics/PressureTiles.tsx +108 -0
- package/apps/shared/components/admin/diagnostics/PvcTable.tsx +20 -6
- package/apps/shared/components/admin/diagnostics/diagnosticsApi.ts +21 -2
- package/apps/shared/components/admin/layout/AdminShell.tsx +384 -384
- package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx +238 -238
- package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx +152 -152
- package/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.tsx +194 -194
- package/apps/shared/components/admin/settings/BrandingForm.tsx +423 -423
- package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -119
- package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -198
- package/apps/shared/components/admin/settings/PluginsManager.tsx +2093 -1620
- package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +182 -182
- package/apps/shared/components/admin/settings/pluginPreferences.ts +34 -0
- package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -288
- package/apps/shared/components/admin/setup/SetupWizard.tsx +446 -446
- package/apps/shared/components/admin/usePagedList.tsx +129 -129
- package/apps/shared/components/calendar/EventModal.tsx +206 -206
- package/apps/shared/components/calendar/MonthView.tsx +185 -185
- package/apps/shared/components/calendar/RecurrenceEditor.tsx +227 -227
- package/apps/shared/components/calendar/SplitDayView.tsx +144 -144
- package/apps/shared/components/calendar/TimeGridView.tsx +246 -246
- package/apps/shared/components/calendar/allDay.ts +124 -124
- package/apps/shared/components/contacts/ContactForm.tsx +383 -383
- package/apps/shared/components/contacts/ContactsToolbar.tsx +103 -103
- package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
- package/apps/shared/components/layout/AppShell.tsx +461 -461
- package/apps/shared/components/layout/KeyEnrollmentGate.tsx +398 -398
- package/apps/shared/components/layout/MailboxProvisioning.tsx +168 -168
- package/apps/shared/components/layout/ResponsiveToolbar.tsx +315 -315
- package/apps/shared/components/layout/ThemeSwitch.tsx +84 -84
- package/apps/shared/components/layout/UserMenu.tsx +439 -439
- package/apps/shared/components/mail/ConversationList.tsx +332 -323
- package/apps/shared/components/mail/ConversationThreadPane.tsx +613 -613
- package/apps/shared/components/mail/MailSelectionBar.tsx +240 -240
- package/apps/shared/components/mail/MenuButton.tsx +404 -404
- package/apps/shared/components/mail/MessageDetailPane.tsx +1757 -1757
- package/apps/shared/components/mail/compose/ComposeContext.tsx +312 -312
- package/apps/shared/components/mail/compose/ComposeToolbar.tsx +422 -422
- package/apps/shared/components/mail/compose/ComposeWindow.tsx +1681 -1681
- package/apps/shared/components/mail/compose/RichTextEditor.tsx +147 -147
- package/apps/shared/components/mail/compose/composeFlushRegistry.ts +60 -60
- package/apps/shared/components/mail/compose/quotedBody.ts +161 -161
- package/apps/shared/components/mail/listPreferences.ts +3 -3
- package/apps/shared/components/mail/reading/MessageMoreMenu.tsx +258 -258
- package/apps/shared/components/mail/reading/MessageSourceDialog.tsx +79 -79
- package/apps/shared/components/mail/reading/messageExport.ts +59 -59
- package/apps/shared/components/mail/reading/printMessage.ts +99 -99
- package/apps/shared/components/mail/reading/useMessageActions.ts +443 -443
- package/apps/shared/components/mail/verificationSeals.ts +125 -125
- package/apps/shared/components/rules/RuleBuilder.tsx +311 -311
- package/apps/shared/components/settings/SigningCertificateCard.tsx +344 -344
- package/apps/shared/keyboard/GlobalShortcuts.tsx +51 -51
- package/apps/shared/keyboard/ShortcutProvider.tsx +62 -62
- package/apps/shared/keyboard/ShortcutsDialog.tsx +84 -84
- package/apps/shared/keyboard/dispatch.ts +124 -124
- package/apps/shared/keyboard/format.ts +89 -89
- package/apps/shared/keyboard/keymap.ts +114 -114
- package/apps/shared/keyboard/registry.ts +65 -65
- package/apps/shared/keyboard/targets.ts +79 -79
- package/apps/shared/mail/folderOfType.ts +49 -49
- package/apps/shared/mail/folderTree.ts +143 -143
- package/apps/shared/mail/listAllPages.ts +39 -39
- package/apps/shared/mail/newMailNotifications.ts +171 -171
- package/apps/shared/mail/outbox/sendJob.ts +445 -445
- package/apps/shared/mail/outbox/sendOutcomes.ts +155 -155
- package/apps/shared/mail/reportNotices.ts +66 -66
- package/apps/shared/mail/senderBlocking.ts +141 -141
- package/apps/shared/mail/useMailConnection.ts +205 -205
- package/apps/shared/mail/useMailLiveUpdates.ts +277 -277
- package/apps/shared/mail/useMailboxUpdateAccess.ts +60 -60
- package/apps/shared/mail/useMarkMessageRead.ts +47 -47
- package/apps/shared/mail/useNewMailNotifications.ts +178 -178
- package/apps/shared/notifications/store.ts +560 -560
- package/apps/shared/search/LocalIndexLifecycle.tsx +114 -114
- package/apps/shared/search/localIndexBuilder.ts +481 -481
- package/apps/shared/signing/enrollmentStorage.ts +33 -33
- package/apps/shared/signing/enrollmentTracker.ts +385 -385
- package/apps/shared/signing/enrollmentView.ts +251 -251
- package/apps/shared/signing/useNow.ts +19 -19
- package/apps/shared/signing/useSigningEnrollmentWatcher.ts +90 -90
- package/apps/shared/styles/app.css +396 -396
- package/apps/www/calendar/index.tsx +581 -581
- package/apps/www/contacts/[uid].tsx +112 -112
- package/apps/www/index.tsx +3012 -2962
- package/apps/www/messages/[uid].tsx +139 -139
- package/apps/www/settings/auto-reply/index.tsx +136 -136
- package/apps/www/settings/blocked-senders/index.tsx +303 -303
- package/apps/www/settings/encryption/index.tsx +1290 -1290
- package/apps/www/settings/filters/[uid].tsx +179 -179
- package/apps/www/settings/filters/index.tsx +105 -105
- package/apps/www/settings/filters/new/index.tsx +165 -165
- package/apps/www/settings/labels/index.tsx +207 -207
- package/apps/www/settings/privacy/index.tsx +495 -495
- package/apps/www/settings/profile/index.tsx +251 -251
- package/apps/www/settings/read-receipts/index.tsx +150 -150
- package/apps/www/settings/sharing/index.tsx +259 -259
- package/apps/www/settings/signatures/[uid].tsx +175 -175
- package/apps/www/settings/signatures/index.tsx +91 -91
- package/apps/www/settings/signatures/new/index.tsx +138 -138
- package/apps/www/tasks/index.tsx +654 -654
- package/dist/apps/shared/components/admin/diagnostics/HostCard.js +2 -1
- package/dist/apps/shared/components/admin/diagnostics/PressureTiles.d.ts +22 -0
- package/dist/apps/shared/components/admin/diagnostics/PressureTiles.js +52 -0
- package/dist/apps/shared/components/admin/diagnostics/PvcTable.js +9 -4
- package/dist/apps/shared/components/admin/diagnostics/diagnosticsApi.d.ts +35 -2
- package/dist/apps/shared/components/admin/settings/BrandingForm.js +3 -3
- package/dist/apps/shared/components/admin/settings/PluginsManager.js +267 -35
- package/dist/apps/shared/components/admin/settings/pluginPreferences.d.ts +2 -0
- package/dist/apps/shared/components/admin/settings/pluginPreferences.js +35 -0
- package/dist/apps/shared/components/mail/ConversationList.d.ts +10 -3
- package/dist/apps/shared/components/mail/ConversationList.js +9 -5
- package/dist/apps/shared/components/mail/listPreferences.d.ts +1 -1
- package/dist/apps/shared/components/mail/reading/printMessage.js +11 -11
- package/dist/apps/shared/styles/app.css +396 -396
- package/dist/apps/www/index.js +51 -10
- package/package.json +2 -2
|
@@ -1,99 +1,99 @@
|
|
|
1
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
-
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
-
import { authApiFetch } from "@rapidmx/react-shared/util/api.js";
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Whether the signed-in user holds an administrator role, learned without elevating.
|
|
9
|
-
*
|
|
10
|
-
* The JWT the browser carries can't say: auth-server strips every trusted role from a token that isn't elevated
|
|
11
|
-
* (`TokenUtils.resolveTokenUser()`), so `trusted` (from the JWT) is false for a real administrator until they confirm
|
|
12
|
-
* their identity on auth-server's elevation page. The role itself lives on the caller's own `User` record, which they may
|
|
13
|
-
* always read - `GET {authServerUrl}/api/users/me` (the same call auth-server's own UI makes "to check for admin access") -
|
|
14
|
-
* so the answer is read from there, with the same cross-origin credentials the profile lookups use.
|
|
15
|
-
*
|
|
16
|
-
* This only decides whether a menu item is shown. The `/admin` pages and API stay authoritative: they check the role and
|
|
17
|
-
* the elevation themselves, and the link only navigates (`/admin` then runs the elevation redirect), so a wrong answer
|
|
18
|
-
* - a stale cache, a tampered `sessionStorage` - can show a link that leads to "no administrator access", never more.
|
|
19
|
-
*/
|
|
20
|
-
|
|
21
|
-
/** The roles the server treats as trusted when it isn't configured otherwise (`trusted_roles`, default `["admin"]`). */
|
|
22
|
-
export const DEFAULT_TRUSTED_ROLES: readonly string[] = ["admin"];
|
|
23
|
-
|
|
24
|
-
/** `sessionStorage` key prefix of a remembered answer; the user's uid follows, so another account signing in in the same
|
|
25
|
-
* tab never inherits it. */
|
|
26
|
-
export const ADMIN_ACCESS_KEY_PREFIX = "rapidmx-admin-access:";
|
|
27
|
-
|
|
28
|
-
/** How long a remembered answer is trusted - long enough that navigating between the apps costs no request, short enough
|
|
29
|
-
* that a role granted or removed shows up within the sitting. */
|
|
30
|
-
export const ADMIN_ACCESS_TTL_MS = 30 * 60 * 1000;
|
|
31
|
-
|
|
32
|
-
/** Lookups in flight, by key, so two components asking at once make one request. */
|
|
33
|
-
const lookups = new Map<string, Promise<boolean | undefined>>();
|
|
34
|
-
|
|
35
|
-
/** Forgets the lookups in flight (tests). */
|
|
36
|
-
export function resetAdminAccessLookups(): void {
|
|
37
|
-
lookups.clear();
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
function readRemembered(key: string, now: number): boolean | undefined {
|
|
41
|
-
try {
|
|
42
|
-
const stored = JSON.parse(sessionStorage.getItem(key) ?? "null") as { admin?: unknown; at?: unknown } | null;
|
|
43
|
-
if (typeof stored?.admin === "boolean" && typeof stored.at === "number" && now - stored.at >= 0 && now - stored.at < ADMIN_ACCESS_TTL_MS) {
|
|
44
|
-
return stored.admin;
|
|
45
|
-
}
|
|
46
|
-
} catch {
|
|
47
|
-
// Unreadable, or storage unavailable - ask again.
|
|
48
|
-
}
|
|
49
|
-
return undefined;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
function remember(key: string, admin: boolean, now: number): void {
|
|
53
|
-
try {
|
|
54
|
-
sessionStorage.setItem(key, JSON.stringify({ admin, at: now }));
|
|
55
|
-
} catch {
|
|
56
|
-
// Storage unavailable - the next page load asks again.
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* Resolves `true` when `userUid`'s own `User` record on auth-server carries one of `trustedRoles`, `false` when it
|
|
62
|
-
* doesn't, and `undefined` when that couldn't be established (unreachable, blocked by CORS, not signed in, an unexpected
|
|
63
|
-
* body, or a record that isn't this user's). Only a real answer is remembered; a failure is asked again on the next page.
|
|
64
|
-
* Never rejects.
|
|
65
|
-
*/
|
|
66
|
-
export function lookUpAdminAccess(
|
|
67
|
-
authServerUrl: string,
|
|
68
|
-
userUid: string,
|
|
69
|
-
trustedRoles: readonly string[] = DEFAULT_TRUSTED_ROLES,
|
|
70
|
-
now: number = Date.now(),
|
|
71
|
-
): Promise<boolean | undefined> {
|
|
72
|
-
const key = `${ADMIN_ACCESS_KEY_PREFIX}${userUid}`;
|
|
73
|
-
const remembered = readRemembered(key, now);
|
|
74
|
-
if (remembered !== undefined) {
|
|
75
|
-
return Promise.resolve(remembered);
|
|
76
|
-
}
|
|
77
|
-
const inFlight = lookups.get(key);
|
|
78
|
-
if (inFlight) {
|
|
79
|
-
return inFlight;
|
|
80
|
-
}
|
|
81
|
-
const lookup = (async (): Promise<boolean | undefined> => {
|
|
82
|
-
try {
|
|
83
|
-
const user = await authApiFetch<{ uid?: unknown; roles?: unknown } | null>(authServerUrl, "/users/me");
|
|
84
|
-
if (!user || user.uid !== userUid || !Array.isArray(user.roles)) {
|
|
85
|
-
return undefined;
|
|
86
|
-
}
|
|
87
|
-
const admin = user.roles.some((role) => typeof role === "string" && trustedRoles.includes(role));
|
|
88
|
-
remember(key, admin, now);
|
|
89
|
-
return admin;
|
|
90
|
-
} catch {
|
|
91
|
-
return undefined;
|
|
92
|
-
} finally {
|
|
93
|
-
// Answered: what was learned is in storage; a failure may be asked again.
|
|
94
|
-
lookups.delete(key);
|
|
95
|
-
}
|
|
96
|
-
})();
|
|
97
|
-
lookups.set(key, lookup);
|
|
98
|
-
return lookup;
|
|
99
|
-
}
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
import { authApiFetch } from "@rapidmx/react-shared/util/api.js";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Whether the signed-in user holds an administrator role, learned without elevating.
|
|
9
|
+
*
|
|
10
|
+
* The JWT the browser carries can't say: auth-server strips every trusted role from a token that isn't elevated
|
|
11
|
+
* (`TokenUtils.resolveTokenUser()`), so `trusted` (from the JWT) is false for a real administrator until they confirm
|
|
12
|
+
* their identity on auth-server's elevation page. The role itself lives on the caller's own `User` record, which they may
|
|
13
|
+
* always read - `GET {authServerUrl}/api/users/me` (the same call auth-server's own UI makes "to check for admin access") -
|
|
14
|
+
* so the answer is read from there, with the same cross-origin credentials the profile lookups use.
|
|
15
|
+
*
|
|
16
|
+
* This only decides whether a menu item is shown. The `/admin` pages and API stay authoritative: they check the role and
|
|
17
|
+
* the elevation themselves, and the link only navigates (`/admin` then runs the elevation redirect), so a wrong answer
|
|
18
|
+
* - a stale cache, a tampered `sessionStorage` - can show a link that leads to "no administrator access", never more.
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
/** The roles the server treats as trusted when it isn't configured otherwise (`trusted_roles`, default `["admin"]`). */
|
|
22
|
+
export const DEFAULT_TRUSTED_ROLES: readonly string[] = ["admin"];
|
|
23
|
+
|
|
24
|
+
/** `sessionStorage` key prefix of a remembered answer; the user's uid follows, so another account signing in in the same
|
|
25
|
+
* tab never inherits it. */
|
|
26
|
+
export const ADMIN_ACCESS_KEY_PREFIX = "rapidmx-admin-access:";
|
|
27
|
+
|
|
28
|
+
/** How long a remembered answer is trusted - long enough that navigating between the apps costs no request, short enough
|
|
29
|
+
* that a role granted or removed shows up within the sitting. */
|
|
30
|
+
export const ADMIN_ACCESS_TTL_MS = 30 * 60 * 1000;
|
|
31
|
+
|
|
32
|
+
/** Lookups in flight, by key, so two components asking at once make one request. */
|
|
33
|
+
const lookups = new Map<string, Promise<boolean | undefined>>();
|
|
34
|
+
|
|
35
|
+
/** Forgets the lookups in flight (tests). */
|
|
36
|
+
export function resetAdminAccessLookups(): void {
|
|
37
|
+
lookups.clear();
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
function readRemembered(key: string, now: number): boolean | undefined {
|
|
41
|
+
try {
|
|
42
|
+
const stored = JSON.parse(sessionStorage.getItem(key) ?? "null") as { admin?: unknown; at?: unknown } | null;
|
|
43
|
+
if (typeof stored?.admin === "boolean" && typeof stored.at === "number" && now - stored.at >= 0 && now - stored.at < ADMIN_ACCESS_TTL_MS) {
|
|
44
|
+
return stored.admin;
|
|
45
|
+
}
|
|
46
|
+
} catch {
|
|
47
|
+
// Unreadable, or storage unavailable - ask again.
|
|
48
|
+
}
|
|
49
|
+
return undefined;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
function remember(key: string, admin: boolean, now: number): void {
|
|
53
|
+
try {
|
|
54
|
+
sessionStorage.setItem(key, JSON.stringify({ admin, at: now }));
|
|
55
|
+
} catch {
|
|
56
|
+
// Storage unavailable - the next page load asks again.
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Resolves `true` when `userUid`'s own `User` record on auth-server carries one of `trustedRoles`, `false` when it
|
|
62
|
+
* doesn't, and `undefined` when that couldn't be established (unreachable, blocked by CORS, not signed in, an unexpected
|
|
63
|
+
* body, or a record that isn't this user's). Only a real answer is remembered; a failure is asked again on the next page.
|
|
64
|
+
* Never rejects.
|
|
65
|
+
*/
|
|
66
|
+
export function lookUpAdminAccess(
|
|
67
|
+
authServerUrl: string,
|
|
68
|
+
userUid: string,
|
|
69
|
+
trustedRoles: readonly string[] = DEFAULT_TRUSTED_ROLES,
|
|
70
|
+
now: number = Date.now(),
|
|
71
|
+
): Promise<boolean | undefined> {
|
|
72
|
+
const key = `${ADMIN_ACCESS_KEY_PREFIX}${userUid}`;
|
|
73
|
+
const remembered = readRemembered(key, now);
|
|
74
|
+
if (remembered !== undefined) {
|
|
75
|
+
return Promise.resolve(remembered);
|
|
76
|
+
}
|
|
77
|
+
const inFlight = lookups.get(key);
|
|
78
|
+
if (inFlight) {
|
|
79
|
+
return inFlight;
|
|
80
|
+
}
|
|
81
|
+
const lookup = (async (): Promise<boolean | undefined> => {
|
|
82
|
+
try {
|
|
83
|
+
const user = await authApiFetch<{ uid?: unknown; roles?: unknown } | null>(authServerUrl, "/users/me");
|
|
84
|
+
if (!user || user.uid !== userUid || !Array.isArray(user.roles)) {
|
|
85
|
+
return undefined;
|
|
86
|
+
}
|
|
87
|
+
const admin = user.roles.some((role) => typeof role === "string" && trustedRoles.includes(role));
|
|
88
|
+
remember(key, admin, now);
|
|
89
|
+
return admin;
|
|
90
|
+
} catch {
|
|
91
|
+
return undefined;
|
|
92
|
+
} finally {
|
|
93
|
+
// Answered: what was learned is in storage; a failure may be asked again.
|
|
94
|
+
lookups.delete(key);
|
|
95
|
+
}
|
|
96
|
+
})();
|
|
97
|
+
lookups.set(key, lookup);
|
|
98
|
+
return lookup;
|
|
99
|
+
}
|
|
@@ -7,6 +7,7 @@ import type { DiagnosticsDiskMetrics, DiagnosticsMetrics } from "./diagnosticsAp
|
|
|
7
7
|
import { formatBytes, formatCores, formatPercent, NO_VALUE, percentOf } from "./format.js";
|
|
8
8
|
import { seriesOf } from "./metricsHistory.js";
|
|
9
9
|
import MetricTile from "./MetricTile.js";
|
|
10
|
+
import PressureTiles from "./PressureTiles.js";
|
|
10
11
|
import UsageMeter from "./UsageMeter.js";
|
|
11
12
|
|
|
12
13
|
const percentLabel = (value: number) => formatPercent(value);
|
|
@@ -91,6 +92,7 @@ export default function HostCard({ host, history }: HostCardProps) {
|
|
|
91
92
|
/>
|
|
92
93
|
<MetricTile label="Load average" value={formatLoad(host.loadAverage)} detail="1, 5 and 15 minutes" />
|
|
93
94
|
</div>
|
|
95
|
+
<PressureTiles host={host} history={history} />
|
|
94
96
|
<h3 className="mt-4 mb-2 text-xs uppercase tracking-wide text-text-muted">Disks</h3>
|
|
95
97
|
{disks.length === 0 ? (
|
|
96
98
|
<p className="text-sm text-text-muted">No disks were reported.</p>
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
import React from "react";
|
|
6
|
+
import type { DiagnosticsMetrics, DiagnosticsPressure } from "./diagnosticsApi.js";
|
|
7
|
+
import { formatBytes, formatPercent, percentOf } from "./format.js";
|
|
8
|
+
import { seriesOf } from "./metricsHistory.js";
|
|
9
|
+
import MetricTile from "./MetricTile.js";
|
|
10
|
+
|
|
11
|
+
/** From this share of the last 10 seconds spent stalled, pressure is called elevated ... */
|
|
12
|
+
export const ELEVATED_PRESSURE_PERCENT = 10;
|
|
13
|
+
|
|
14
|
+
/** ... and from this, high. Kernel documentation treats a few percent as ordinary and tens of percent as a machine that is struggling. */
|
|
15
|
+
export const HIGH_PRESSURE_PERCENT = 30;
|
|
16
|
+
|
|
17
|
+
export type PressureLevel = "Low" | "Elevated" | "High";
|
|
18
|
+
|
|
19
|
+
/** Pressure in words, so that it is never only a number or a colour. */
|
|
20
|
+
export function pressureLevel(percent: number): PressureLevel {
|
|
21
|
+
if (percent >= HIGH_PRESSURE_PERCENT) {
|
|
22
|
+
return "High";
|
|
23
|
+
}
|
|
24
|
+
return percent >= ELEVATED_PRESSURE_PERCENT ? "Elevated" : "Low";
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
type Host = NonNullable<DiagnosticsMetrics["host"]>;
|
|
28
|
+
type Resource = keyof NonNullable<Host["pressure"]>;
|
|
29
|
+
|
|
30
|
+
const RESOURCES: { key: Resource; label: string; waiting: string }[] = [
|
|
31
|
+
{ key: "memory", label: "Memory pressure", waiting: "waiting for memory" },
|
|
32
|
+
{ key: "io", label: "I/O pressure", waiting: "waiting for the disk" },
|
|
33
|
+
{ key: "cpu", label: "CPU pressure", waiting: "waiting for a CPU" },
|
|
34
|
+
];
|
|
35
|
+
|
|
36
|
+
function PressureTile({ label, waiting, stall, history, resource }: { label: string; waiting: string; stall: DiagnosticsPressure; history: DiagnosticsMetrics[]; resource: Resource }) {
|
|
37
|
+
const level = pressureLevel(stall.some.avg10);
|
|
38
|
+
return (
|
|
39
|
+
<MetricTile
|
|
40
|
+
label={label}
|
|
41
|
+
value={formatPercent(stall.some.avg10)}
|
|
42
|
+
detail={`${level}: tasks ${waiting}, last 10 seconds`}
|
|
43
|
+
history={{
|
|
44
|
+
values: seriesOf(history, (sample) => sample.host?.pressure?.[resource]?.some.avg10),
|
|
45
|
+
max: 100,
|
|
46
|
+
format: formatPercent,
|
|
47
|
+
}}
|
|
48
|
+
>
|
|
49
|
+
<div className="mt-2 text-xs text-text-muted">
|
|
50
|
+
Last minute {formatPercent(stall.some.avg60)}, last 5 minutes {formatPercent(stall.some.avg300)}
|
|
51
|
+
{stall.full && ` · every task waiting: ${formatPercent(stall.full.avg10)}`}
|
|
52
|
+
</div>
|
|
53
|
+
</MetricTile>
|
|
54
|
+
);
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export interface PressureTilesProps {
|
|
58
|
+
host: Host;
|
|
59
|
+
history: DiagnosticsMetrics[];
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* How stalled the node is (Linux pressure stall information: the share of recent time tasks spent waiting for memory, the disk or
|
|
64
|
+
* a CPU), and how much memory the hypervisor holds in the machine's balloon. Both explain a node that is slow while nothing on it
|
|
65
|
+
* uses much: a guest counts ballooned memory as used though no process holds it, and a machine short of memory stalls on the disk.
|
|
66
|
+
* Nothing is shown where the kernel gives no such figures.
|
|
67
|
+
*/
|
|
68
|
+
export default function PressureTiles({ host, history }: PressureTilesProps) {
|
|
69
|
+
const tiles = RESOURCES.filter(({ key }) => host.pressure?.[key]);
|
|
70
|
+
const balloon = host.balloon;
|
|
71
|
+
if (tiles.length === 0 && !balloon) {
|
|
72
|
+
return null;
|
|
73
|
+
}
|
|
74
|
+
const heldPercent = percentOf(balloon?.heldBytes, host.memoryTotalBytes);
|
|
75
|
+
return (
|
|
76
|
+
<>
|
|
77
|
+
<h3 className="mt-4 mb-2 text-xs uppercase tracking-wide text-text-muted">Pressure</h3>
|
|
78
|
+
<div className="grid grid-cols-1 gap-3 md:grid-cols-2 lg:grid-cols-4">
|
|
79
|
+
{RESOURCES.map(({ key, label, waiting }) => {
|
|
80
|
+
const stall = host.pressure?.[key];
|
|
81
|
+
return stall && <PressureTile key={key} label={label} waiting={waiting} stall={stall} history={history} resource={key} />;
|
|
82
|
+
})}
|
|
83
|
+
{balloon && (
|
|
84
|
+
<MetricTile
|
|
85
|
+
label="Held by the hypervisor"
|
|
86
|
+
value={formatBytes(balloon.heldBytes)}
|
|
87
|
+
detail={`of ${formatBytes(host.memoryTotalBytes)}`}
|
|
88
|
+
usage={
|
|
89
|
+
heldPercent === undefined
|
|
90
|
+
? undefined
|
|
91
|
+
: { percent: heldPercent, detail: `${formatBytes(balloon.heldBytes)} in the memory balloon`, flag: false }
|
|
92
|
+
}
|
|
93
|
+
history={{
|
|
94
|
+
values: seriesOf(history, (sample) => sample.host?.balloon?.heldBytes),
|
|
95
|
+
max: host.memoryTotalBytes,
|
|
96
|
+
format: formatBytes,
|
|
97
|
+
}}
|
|
98
|
+
>
|
|
99
|
+
<div className="mt-2 text-xs text-text-muted">
|
|
100
|
+
Memory the hypervisor has taken back through the balloon. It counts as used above though no process holds it.{" "}
|
|
101
|
+
{formatBytes(balloon.inflatedTotalBytes)} taken since the node booted.
|
|
102
|
+
</div>
|
|
103
|
+
</MetricTile>
|
|
104
|
+
)}
|
|
105
|
+
</div>
|
|
106
|
+
</>
|
|
107
|
+
);
|
|
108
|
+
}
|
|
@@ -7,26 +7,40 @@ import type { DiagnosticsPvcMetrics } from "./diagnosticsApi.js";
|
|
|
7
7
|
import { formatBytes, NO_VALUE, percentOf } from "./format.js";
|
|
8
8
|
import UsageMeter from "./UsageMeter.js";
|
|
9
9
|
|
|
10
|
-
const HEADINGS = ["Volume", "Phase", "Storage class", "
|
|
10
|
+
const HEADINGS = ["Volume", "Phase", "Storage class", "Allocated", "Usage"];
|
|
11
11
|
|
|
12
12
|
function Usage({ pvc }: { pvc: DiagnosticsPvcMetrics }) {
|
|
13
13
|
if (!pvc.mountedByServer) {
|
|
14
14
|
return <span className="text-text-muted">Usage not available: not mounted in the server pod.</span>;
|
|
15
15
|
}
|
|
16
|
-
|
|
16
|
+
// On the node's disk the filesystem's figures are the disk's, so only a measured directory says what the volume holds (an
|
|
17
|
+
// older server sent the disk's figures without saying so).
|
|
18
|
+
const own = pvc.sharesNodeDisk && pvc.measuredBy !== "directory" ? undefined : pvc.usedBytes;
|
|
19
|
+
const percent = percentOf(own, pvc.capacityBytes);
|
|
17
20
|
if (percent === undefined) {
|
|
18
|
-
return
|
|
21
|
+
return (
|
|
22
|
+
<span className="text-text-muted">
|
|
23
|
+
{pvc.sharesNodeDisk
|
|
24
|
+
? "Shares the node\u2019s disk, and what the volume holds could not be measured."
|
|
25
|
+
: "The server has no usage figures for this volume."}
|
|
26
|
+
</span>
|
|
27
|
+
);
|
|
19
28
|
}
|
|
20
29
|
return (
|
|
21
30
|
<div>
|
|
22
31
|
<UsageMeter
|
|
23
32
|
label={`Usage of volume ${pvc.name}`}
|
|
24
33
|
percent={percent}
|
|
25
|
-
detail={`${formatBytes(
|
|
26
|
-
flag={!pvc.sharesNodeDisk}
|
|
34
|
+
detail={`${pvc.usedPartial ? "At least " : ""}${formatBytes(own)} of ${formatBytes(pvc.capacityBytes)} allocated`}
|
|
27
35
|
/>
|
|
36
|
+
{pvc.usedPartial && (
|
|
37
|
+
<p className="mt-1 text-xs text-text-muted">The volume is too large to measure completely, so this is a lower bound.</p>
|
|
38
|
+
)}
|
|
28
39
|
{pvc.sharesNodeDisk && (
|
|
29
|
-
<p className="mt-1 text-xs text-text-muted">
|
|
40
|
+
<p className="mt-1 text-xs text-text-muted">
|
|
41
|
+
Measured from the volume’s directory. It shares the node’s disk, which has {formatBytes(pvc.availableBytes)} free; the
|
|
42
|
+
volume’s allocation is not enforced.
|
|
43
|
+
</p>
|
|
30
44
|
)}
|
|
31
45
|
</div>
|
|
32
46
|
);
|
|
@@ -124,9 +124,22 @@ export interface DiagnosticsHostMetrics {
|
|
|
124
124
|
memoryTotalBytes: number;
|
|
125
125
|
memoryUsedBytes: number;
|
|
126
126
|
loadAverage: [number, number, number];
|
|
127
|
+
/**
|
|
128
|
+
* Memory the hypervisor holds in the machine's memory balloon. It counts in `memoryUsedBytes` (a guest sees ballooned memory
|
|
129
|
+
* as used) though no process holds it. Absent where no balloon has ever taken any.
|
|
130
|
+
*/
|
|
131
|
+
balloon?: { heldBytes: number; inflatedTotalBytes: number };
|
|
132
|
+
/** How stalled the node is waiting for memory, disk and CPU (Linux pressure stall information). Absent without kernel support. */
|
|
133
|
+
pressure?: { memory?: DiagnosticsPressure; io?: DiagnosticsPressure; cpu?: DiagnosticsPressure };
|
|
127
134
|
disks: DiagnosticsDiskMetrics[];
|
|
128
135
|
}
|
|
129
136
|
|
|
137
|
+
/** The share (0 to 100) of the last 10, 60 and 300 seconds that tasks were stalled. `some`: at least one waited. `full`: every one did. */
|
|
138
|
+
export interface DiagnosticsPressure {
|
|
139
|
+
some: { avg10: number; avg60: number; avg300: number };
|
|
140
|
+
full?: { avg10: number; avg60: number; avg300: number };
|
|
141
|
+
}
|
|
142
|
+
|
|
130
143
|
/** From the metrics API (metrics-server): absent when it is not installed. */
|
|
131
144
|
export interface DiagnosticsPodMetrics {
|
|
132
145
|
name: string;
|
|
@@ -136,8 +149,11 @@ export interface DiagnosticsPodMetrics {
|
|
|
136
149
|
}
|
|
137
150
|
|
|
138
151
|
/**
|
|
139
|
-
* `usedBytes
|
|
140
|
-
*
|
|
152
|
+
* `usedBytes` (what the volume holds) exists only for a volume the server pod mounts (`mountedByServer`), and `measuredBy`
|
|
153
|
+
* says how it was found: from the volume's own filesystem, or - when the volume is a directory of the node's disk
|
|
154
|
+
* (`sharesNodeDisk`, such as k3s's local-path), where the filesystem is the whole disk - by measuring the directory.
|
|
155
|
+
* `capacityBytes` is the volume's allocation, which a volume that shares the node's disk does not enforce; `availableBytes` is
|
|
156
|
+
* what is left of the filesystem it is on.
|
|
141
157
|
*/
|
|
142
158
|
export interface DiagnosticsPvcMetrics {
|
|
143
159
|
name: string;
|
|
@@ -147,6 +163,9 @@ export interface DiagnosticsPvcMetrics {
|
|
|
147
163
|
capacityBytes?: number;
|
|
148
164
|
usedBytes?: number;
|
|
149
165
|
availableBytes?: number;
|
|
166
|
+
measuredBy?: "filesystem" | "directory";
|
|
167
|
+
/** The directory could not be measured completely, so `usedBytes` is a lower bound. */
|
|
168
|
+
usedPartial?: boolean;
|
|
150
169
|
mountedByServer: boolean;
|
|
151
170
|
sharesNodeDisk?: boolean;
|
|
152
171
|
}
|