@skyhook-io/k8s-ui 1.10.3 → 1.10.5
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/package.json +5 -5
- package/src/components/applications/ApplicationDetail.test.tsx +46 -0
- package/src/components/applications/ApplicationDetail.tsx +14 -15
- package/src/components/topology/K8sResourceNode.tsx +5 -0
- package/src/components/topology/TopologyGraph.tsx +85 -5
- package/src/components/topology/layout.worker.ts +2 -1
- package/src/components/trace/ReachabilityGraph.tsx +503 -0
- package/src/components/trace/ReachabilityView.tsx +972 -0
- package/src/components/trace/TracePanel.test.ts +172 -0
- package/src/components/trace/TracePanel.tsx +558 -0
- package/src/components/trace/TraceSummary.test.ts +213 -0
- package/src/components/trace/TraceSummary.tsx +168 -0
- package/src/components/trace/inClusterSummary.test.ts +98 -0
- package/src/components/trace/inClusterSummary.ts +81 -0
- package/src/components/trace/index.ts +19 -0
- package/src/components/trace/podReach.test.ts +71 -0
- package/src/components/trace/podReach.ts +37 -0
- package/src/components/trace/probe-display.test.ts +107 -0
- package/src/components/trace/probe-display.ts +37 -0
- package/src/components/trace/reachFixtures.ts +261 -0
- package/src/components/trace/reachGraphModel.test.ts +1407 -0
- package/src/components/trace/reachGraphModel.ts +1521 -0
- package/src/components/trace/reachInspector.test.ts +669 -0
- package/src/components/trace/reachInspector.ts +667 -0
- package/src/components/trace/reachMarks.test.ts +667 -0
- package/src/components/trace/reachMarks.ts +579 -0
- package/src/components/trace/reachOrigins.test.ts +392 -0
- package/src/components/trace/reachOrigins.ts +437 -0
- package/src/components/trace/reachVerdict.test.ts +537 -0
- package/src/components/trace/reachVerdict.ts +601 -0
- package/src/components/trace/traceFingerprint.test.ts +214 -0
- package/src/components/trace/traceFingerprint.ts +122 -0
- package/src/components/trace/traceToSubgraph.test.ts +623 -0
- package/src/components/trace/traceToSubgraph.ts +463 -0
- package/src/components/trace/types.ts +389 -0
- package/src/components/ui/InClusterConsentDialog.test.tsx +83 -0
- package/src/components/ui/InClusterConsentDialog.tsx +141 -0
- package/src/components/ui/index.ts +1 -0
- package/src/components/workload/WorkloadView.tsx +58 -5
- package/src/components/workload/index.ts +1 -1
- package/src/components/workload/reachabilityTab.test.ts +47 -0
- package/src/index.ts +5 -0
- package/src/theme/components.css +38 -0
- package/src/theme/variables.css +5 -0
- package/src/types/core.ts +23 -0
- package/src/utils/application-history.test.ts +1 -1
- package/src/utils/applications.test.ts +63 -1
- package/src/utils/applications.ts +27 -0
- package/src/utils/asset-url.test.ts +113 -0
- package/src/utils/asset-url.ts +33 -1
- package/src/utils/inClusterConsent.test.ts +109 -0
- package/src/utils/inClusterConsent.ts +72 -0
- package/src/utils/index.ts +2 -0
- package/src/utils/navigation.test.ts +61 -0
- package/src/utils/navigation.ts +11 -9
- package/src/utils/pluralize.test.ts +80 -1
- package/src/utils/pluralize.ts +34 -0
|
@@ -29,6 +29,7 @@ import {
|
|
|
29
29
|
X,
|
|
30
30
|
BarChart3,
|
|
31
31
|
Network,
|
|
32
|
+
Stethoscope,
|
|
32
33
|
DollarSign,
|
|
33
34
|
} from 'lucide-react'
|
|
34
35
|
import type { TimelineEvent, ResourceRef, Relationships, SelectedResource, ResolvedEnvFrom, Topology, TopologyNode, HPADiagnosis, WorkloadPodInfo } from '../../types'
|
|
@@ -69,7 +70,7 @@ import {
|
|
|
69
70
|
} from '../resources/resource-utils'
|
|
70
71
|
import { ServicePortCards, type ServicePortRenderProps } from '../resources/renderers/ServiceRenderer'
|
|
71
72
|
|
|
72
|
-
export type WorkloadTabType = 'overview' | 'topology' | 'timeline' | 'logs' | 'metrics' | 'cost' | 'yaml'
|
|
73
|
+
export type WorkloadTabType = 'overview' | 'topology' | 'timeline' | 'logs' | 'metrics' | 'reachability' | 'cost' | 'yaml'
|
|
73
74
|
type TabType = WorkloadTabType
|
|
74
75
|
|
|
75
76
|
export interface ResourceOwnershipContext {
|
|
@@ -273,6 +274,17 @@ interface WorkloadViewProps {
|
|
|
273
274
|
}) => ReactNode
|
|
274
275
|
/** Render the metrics tab content */
|
|
275
276
|
renderMetricsTab?: (props: { kind: string; namespace: string; name: string }) => ReactNode
|
|
277
|
+
/** Render the Diagnose tab content - a path-shaped trace for network
|
|
278
|
+
* entry kinds (Service / Ingress / HTTPRoute / GRPCRoute / Gateway). The
|
|
279
|
+
* tab is hidden when this callback is not provided OR when the focused
|
|
280
|
+
* kind is neither a network entry kind nor reachable through one. */
|
|
281
|
+
renderDiagnoseTab?: (props: { kind: string; namespace: string; name: string }) => ReactNode
|
|
282
|
+
/** Set when the focused resource is NOT itself a network entry kind but is
|
|
283
|
+
* served by one - a Deployment behind a Service. Reachability for a workload
|
|
284
|
+
* IS the reachability of the Services in front of it, so the tab opens here
|
|
285
|
+
* instead of sending the operator to another page to start over. Empty or
|
|
286
|
+
* omitted keeps the tab hidden for non-entry kinds. */
|
|
287
|
+
reachableVia?: { kind: string; namespace?: string; name: string }[]
|
|
276
288
|
/** Render the cost tab content */
|
|
277
289
|
renderCostTab?: (props: { kind: string; namespace: string; name: string }) => ReactNode
|
|
278
290
|
/** Render a read-only YAML view for a related object from the workload's
|
|
@@ -285,8 +297,12 @@ interface WorkloadViewProps {
|
|
|
285
297
|
isMetricsAvailable?: (kind: string, resource: any) => boolean
|
|
286
298
|
/** Whether cost is available for this resource kind */
|
|
287
299
|
isCostAvailable?: (kind: string, resource: any) => boolean
|
|
288
|
-
/** Render extra content at the bottom of the overview tab (e.g. audit
|
|
289
|
-
|
|
300
|
+
/** Render extra content at the bottom of the overview tab (e.g. audit
|
|
301
|
+
* findings). `context` lets the host suppress sections that are already
|
|
302
|
+
* surfaced by a dedicated tab in expanded mode - e.g. the Diagnose card
|
|
303
|
+
* belongs inline when there are no tabs (drawer) but would duplicate the
|
|
304
|
+
* Diagnose tab when it is. */
|
|
305
|
+
renderOverviewExtra?: (props: { kind: string; namespace: string; name: string; group?: string; context: 'drawer' | 'expanded' }) => ReactNode
|
|
290
306
|
/** Render lightweight overview intro content before the default renderer. */
|
|
291
307
|
renderOverviewIntro?: (props: { kind: string; namespace: string; name: string }) => ReactNode
|
|
292
308
|
/** Render content at the TOP of the overview tab, above the renderer (e.g. live
|
|
@@ -385,6 +401,8 @@ export function WorkloadView({
|
|
|
385
401
|
onTabChange,
|
|
386
402
|
// Render props
|
|
387
403
|
renderLogsTab,
|
|
404
|
+
renderDiagnoseTab,
|
|
405
|
+
reachableVia,
|
|
388
406
|
renderExpandedOverview,
|
|
389
407
|
renderRelatedYaml,
|
|
390
408
|
renderMetricsTab,
|
|
@@ -695,6 +713,12 @@ export function WorkloadView({
|
|
|
695
713
|
},
|
|
696
714
|
{ id: 'logs', label: 'Logs', icon: <Terminal className="w-4 h-4" />, hidden: !logsTabVisible },
|
|
697
715
|
{ id: 'metrics', label: 'Metrics', icon: <BarChart3 className="w-4 h-4" />, hidden: !metricsTabVisible },
|
|
716
|
+
{
|
|
717
|
+
id: 'reachability',
|
|
718
|
+
label: 'Reachability',
|
|
719
|
+
icon: <Stethoscope className="w-4 h-4" />,
|
|
720
|
+
hidden: !(renderDiagnoseTab && (isDiagnoseKind(apiKind, group) || (reachableVia?.length ?? 0) > 0)),
|
|
721
|
+
},
|
|
698
722
|
{ id: 'cost', label: 'Cost', icon: <DollarSign className="w-4 h-4" />, hidden: !costTabVisible },
|
|
699
723
|
{ id: 'yaml', label: 'YAML', icon: <FileText className="w-4 h-4" /> },
|
|
700
724
|
]
|
|
@@ -861,7 +885,7 @@ export function WorkloadView({
|
|
|
861
885
|
updates={resourceFocusedUpdates}
|
|
862
886
|
eventsError={resourceFocusedK8sError}
|
|
863
887
|
updatesError={resourceFocusedUpdatesError}
|
|
864
|
-
mainFooter={renderOverviewExtra && renderOverviewExtra({ kind, namespace, name })}
|
|
888
|
+
mainFooter={renderOverviewExtra && renderOverviewExtra({ kind, namespace, name, group, context: 'drawer' })}
|
|
865
889
|
/>
|
|
866
890
|
</OperationalIssuesShownContext.Provider>
|
|
867
891
|
)}
|
|
@@ -1028,7 +1052,7 @@ export function WorkloadView({
|
|
|
1028
1052
|
updates={resourceFocusedUpdates}
|
|
1029
1053
|
eventsError={overviewEventsError}
|
|
1030
1054
|
updatesError={resourceFocusedUpdatesError}
|
|
1031
|
-
extraContent={renderOverviewExtra && renderOverviewExtra({ kind, namespace, name })}
|
|
1055
|
+
extraContent={renderOverviewExtra && renderOverviewExtra({ kind, namespace, name, group, context: 'expanded' })}
|
|
1032
1056
|
introContent={overviewIntro}
|
|
1033
1057
|
leadContent={hasOperationalIssues && renderOverviewLead ? renderOverviewLead({ kind, namespace, name }) : undefined}
|
|
1034
1058
|
onEvaluateCapacity={onEvaluateCapacity}
|
|
@@ -1080,6 +1104,11 @@ export function WorkloadView({
|
|
|
1080
1104
|
{renderMetricsTab({ kind: resource?.kind || kind, namespace, name })}
|
|
1081
1105
|
</div>
|
|
1082
1106
|
)}
|
|
1107
|
+
{effectiveTab === 'reachability' && renderDiagnoseTab && (
|
|
1108
|
+
<div className="flex h-full min-h-0 flex-col p-3">
|
|
1109
|
+
{renderDiagnoseTab({ kind: resource?.kind || kind, namespace, name })}
|
|
1110
|
+
</div>
|
|
1111
|
+
)}
|
|
1083
1112
|
{effectiveTab === 'cost' && renderCostTab && (
|
|
1084
1113
|
<div className="h-full overflow-auto p-4">
|
|
1085
1114
|
{renderCostTab({ kind: resource?.kind || kind, namespace, name })}
|
|
@@ -1145,6 +1174,30 @@ export function WorkloadView({
|
|
|
1145
1174
|
// HELPER FUNCTIONS
|
|
1146
1175
|
// ============================================================================
|
|
1147
1176
|
|
|
1177
|
+
// Diagnose tab is only meaningful for the five network entry kinds. The
|
|
1178
|
+
// canonical predicate is internal/trace.IsEntryKind in Go; we mirror the
|
|
1179
|
+
// allowlist here so TypeScript callers don't need a fetch to decide whether
|
|
1180
|
+
// to render the tab. The two MUST stay in sync - when a kind is added on
|
|
1181
|
+
// either side, update both. Exported so the web wrapper can reuse the same
|
|
1182
|
+
// predicate for the inline drawer section.
|
|
1183
|
+
export function isDiagnoseKind(kind: string, group?: string): boolean {
|
|
1184
|
+
const k = kind.toLowerCase()
|
|
1185
|
+
const g = (group ?? '').toLowerCase()
|
|
1186
|
+
// When the API group is known, require it to match - a CRD sharing a core kind
|
|
1187
|
+
// name (Knative Service, Istio Gateway) must NOT enable the trace, which would
|
|
1188
|
+
// fire /trace/<kind> against the wrong (core) object. group===undefined keeps the
|
|
1189
|
+
// legacy kind-only behavior for callers that don't thread the group yet.
|
|
1190
|
+
const groupOk = (expected: string[]): boolean => group === undefined || expected.includes(g)
|
|
1191
|
+
if (k === 'service' || k === 'services') return groupOk([''])
|
|
1192
|
+
if (k === 'ingress' || k === 'ingresses') return groupOk(['', 'networking.k8s.io'])
|
|
1193
|
+
if (
|
|
1194
|
+
k === 'httproute' || k === 'httproutes' ||
|
|
1195
|
+
k === 'grpcroute' || k === 'grpcroutes' ||
|
|
1196
|
+
k === 'gateway' || k === 'gateways'
|
|
1197
|
+
) return groupOk(['gateway.networking.k8s.io'])
|
|
1198
|
+
return false
|
|
1199
|
+
}
|
|
1200
|
+
|
|
1148
1201
|
function extractMetadata(kind: string, resource: any): { label: string; value: string }[] {
|
|
1149
1202
|
if (!resource) return []
|
|
1150
1203
|
const items: { label: string; value: string }[] = []
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { WorkloadView, type ResourceOwnershipContext, type ServingResourceDetail, type WorkloadTabType } from './WorkloadView'
|
|
1
|
+
export { WorkloadView, isDiagnoseKind, type ResourceOwnershipContext, type ServingResourceDetail, type WorkloadTabType } from './WorkloadView'
|
|
2
2
|
export { ResourceDetailDrawer } from './ResourceDetailDrawer'
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest'
|
|
2
|
+
import { isDiagnoseKind } from './WorkloadView'
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* The rule that decides whether a resource gets a Reachability tab.
|
|
6
|
+
*
|
|
7
|
+
* `isDiagnoseKind` alone excluded every workload kind, so a Deployment had no
|
|
8
|
+
* Reachability tab at all - the operator got a link to the Service and had to
|
|
9
|
+
* navigate away and restart the investigation there. The tab now also opens for
|
|
10
|
+
* a resource that is SERVED by an entry kind, which is what makes "reachability
|
|
11
|
+
* for a Service or workload" true of workloads.
|
|
12
|
+
*/
|
|
13
|
+
const tabVisible = (kind: string, group: string | undefined, servingServices: unknown[]): boolean =>
|
|
14
|
+
isDiagnoseKind(kind, group) || servingServices.length > 0
|
|
15
|
+
|
|
16
|
+
const svc = [{ kind: 'Service', namespace: 'prod', name: 'web' }]
|
|
17
|
+
|
|
18
|
+
describe('who gets a Reachability tab', () => {
|
|
19
|
+
it('entry kinds trace themselves, with no Service needed', () => {
|
|
20
|
+
expect(tabVisible('Service', '', [])).toBe(true)
|
|
21
|
+
expect(tabVisible('Ingress', 'networking.k8s.io', [])).toBe(true)
|
|
22
|
+
expect(tabVisible('HTTPRoute', 'gateway.networking.k8s.io', [])).toBe(true)
|
|
23
|
+
})
|
|
24
|
+
|
|
25
|
+
it('a workload behind a Service now gets one', () => {
|
|
26
|
+
for (const kind of ['Deployment', 'StatefulSet', 'DaemonSet', 'Pod']) {
|
|
27
|
+
expect(tabVisible(kind, 'apps', svc)).toBe(true)
|
|
28
|
+
}
|
|
29
|
+
})
|
|
30
|
+
|
|
31
|
+
// Nothing selects it, so there is no path to trace and no honest tab to show.
|
|
32
|
+
it('a workload nothing exposes does not', () => {
|
|
33
|
+
expect(tabVisible('Deployment', 'apps', [])).toBe(false)
|
|
34
|
+
})
|
|
35
|
+
|
|
36
|
+
// A CRD sharing a core kind name must not enable a trace against the wrong
|
|
37
|
+
// object - the group check that guards this is load-bearing, not incidental.
|
|
38
|
+
it('a Knative Service is not a core Service', () => {
|
|
39
|
+
expect(tabVisible('Service', 'serving.knative.dev', [])).toBe(false)
|
|
40
|
+
})
|
|
41
|
+
|
|
42
|
+
// ...but if something does select its pods, it still earns the tab through
|
|
43
|
+
// the serving Service, exactly like any other workload.
|
|
44
|
+
it('a same-named CRD still qualifies via its serving Service', () => {
|
|
45
|
+
expect(tabVisible('Service', 'serving.knative.dev', svc)).toBe(true)
|
|
46
|
+
})
|
|
47
|
+
})
|
package/src/index.ts
CHANGED
|
@@ -40,6 +40,11 @@ export * from './components/topology'
|
|
|
40
40
|
// Cluster audit (AuditCard, AuditAlerts, AuditFindingsTable)
|
|
41
41
|
export * from './components/audit'
|
|
42
42
|
|
|
43
|
+
// Network path trace (ReachabilityView + types) - diagnostics for Service /
|
|
44
|
+
// Ingress / HTTPRoute / GRPCRoute / Gateway. Backed by /api/trace and the
|
|
45
|
+
// internal/trace Go package; the view is presentation-only.
|
|
46
|
+
export * from './components/trace'
|
|
47
|
+
|
|
43
48
|
// Checks remediation queue (ChecksView, shared types + severity vocabulary).
|
|
44
49
|
// Host-agnostic: Hub feeds fleet-resolved data, OSS can feed a single-cluster
|
|
45
50
|
// resolve.
|
package/src/theme/components.css
CHANGED
|
@@ -235,3 +235,41 @@
|
|
|
235
235
|
}
|
|
236
236
|
|
|
237
237
|
} /* end @layer components */
|
|
238
|
+
|
|
239
|
+
/* Brief pulse the trace panel uses to flash the broken hop after the
|
|
240
|
+
verdict banner's "Show me" button scrolls it into view. Outside the
|
|
241
|
+
components layer so it's not subject to specificity tweaks. */
|
|
242
|
+
@keyframes trace-broken-pulse {
|
|
243
|
+
0% { box-shadow: 0 0 0 0 rgba(239, 68, 68, 0); }
|
|
244
|
+
35% { box-shadow: 0 0 0 4px rgba(239, 68, 68, 0.45); }
|
|
245
|
+
100% { box-shadow: 0 0 0 0 rgba(239, 68, 68, 0); }
|
|
246
|
+
}
|
|
247
|
+
.trace-broken-pulse {
|
|
248
|
+
animation: trace-broken-pulse 1.2s ease-out;
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
/* reach-flash: briefly highlights a value that just CHANGED after a probe run, so a
|
|
252
|
+
fast/identical-looking result is still visibly "new". Fades from the accent tint. */
|
|
253
|
+
@keyframes reach-flash {
|
|
254
|
+
0% { background-color: var(--accent-muted); }
|
|
255
|
+
100% { background-color: transparent; }
|
|
256
|
+
}
|
|
257
|
+
.reach-flash {
|
|
258
|
+
animation: reach-flash 1.6s ease-out;
|
|
259
|
+
border-radius: 4px;
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
/* reach-edge-testing: a request is IN FLIGHT along this edge right now.
|
|
263
|
+
The dash pattern flows toward the target, so the graph shows the probe
|
|
264
|
+
travelling the path it is testing rather than the page just saying
|
|
265
|
+
"running" in a button. Semantic, not decorative: only edges the running
|
|
266
|
+
vantage is actually exercising get it. */
|
|
267
|
+
@keyframes reach-edge-flow {
|
|
268
|
+
to { stroke-dashoffset: -24; }
|
|
269
|
+
}
|
|
270
|
+
.reach-edge-testing {
|
|
271
|
+
animation: reach-edge-flow 0.9s linear infinite;
|
|
272
|
+
}
|
|
273
|
+
@media (prefers-reduced-motion: reduce) {
|
|
274
|
+
.reach-edge-testing { animation: none; }
|
|
275
|
+
}
|
package/src/theme/variables.css
CHANGED
|
@@ -29,6 +29,11 @@
|
|
|
29
29
|
--color-error-light: #F87171;
|
|
30
30
|
--color-error-dark: #DC2626;
|
|
31
31
|
--color-info: #3B82F6;
|
|
32
|
+
/* alert = the orange tier between warning (amber) and error (red). The
|
|
33
|
+
.status-alert class predates these tokens and inlines the same hues. */
|
|
34
|
+
--color-alert: #F97316;
|
|
35
|
+
--color-alert-light: #FB923C;
|
|
36
|
+
--color-alert-dark: #EA580C;
|
|
32
37
|
|
|
33
38
|
/* ── Backgrounds (elevation scale) ──
|
|
34
39
|
sidebar = primary nav rail — the DEEPEST layer, its own token so the rail
|
package/src/types/core.ts
CHANGED
|
@@ -92,6 +92,21 @@ export interface Capabilities {
|
|
|
92
92
|
resources?: ResourcePermissions // Per-resource-type permissions
|
|
93
93
|
authEnabled?: boolean // Auth is enabled on the backend
|
|
94
94
|
username?: string // Authenticated user's username (when auth enabled)
|
|
95
|
+
// Which Cloud-connect lane this deployment gets. Optional on the wire:
|
|
96
|
+
// older backends don't advertise it — consumers fall back to wizard links.
|
|
97
|
+
cloudConnect?: CloudConnectCapability
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
// CloudConnectCapability picks the Cloud funnel's connect lane: 'driver'
|
|
101
|
+
// means the in-product connect flow can run on this server (local, no auth,
|
|
102
|
+
// no existing tunnel); 'wizard' routes to the Hub's connect wizard at appUrl.
|
|
103
|
+
export interface CloudConnectCapability {
|
|
104
|
+
lane: 'driver' | 'wizard'
|
|
105
|
+
appUrl: string
|
|
106
|
+
// Hub API origin the connect dialog reads its live copy from. Absent means
|
|
107
|
+
// the server decided this deployment must not fetch — consumers render their
|
|
108
|
+
// compiled-in copy instead.
|
|
109
|
+
apiUrl?: string
|
|
95
110
|
}
|
|
96
111
|
|
|
97
112
|
export interface FeatureCapabilities {
|
|
@@ -243,8 +258,16 @@ export interface TopologyEdge {
|
|
|
243
258
|
target: string
|
|
244
259
|
type: EdgeType
|
|
245
260
|
label?: string
|
|
261
|
+
/** Hover tooltip for the edge label. Used by the Reachability view to keep the
|
|
262
|
+
* DECLARED route path available when the label shows an overridden tested path. */
|
|
263
|
+
labelTitle?: string
|
|
246
264
|
skipIfKindVisible?: string // Hide this edge if this kind is visible (for shortcut edges)
|
|
247
265
|
policyEffect?: 'allowed' | 'blocked' | 'unprotected'
|
|
266
|
+
/** Reachability outcome for THIS route/hop edge (distinct from policyEffect, a
|
|
267
|
+
* NetworkPolicy concept). When set, the topology renderer colors the edge by
|
|
268
|
+
* reachability: verified/reached = green, unreachable = red, blocked (downstream
|
|
269
|
+
* of a break) = dashed gray, not-tested = neutral. Used by the Reachability view. */
|
|
270
|
+
reachOutcome?: 'verified' | 'reached' | 'unreachable' | 'blocked' | 'not-tested'
|
|
248
271
|
}
|
|
249
272
|
|
|
250
273
|
export interface Topology {
|
|
@@ -200,7 +200,7 @@ describe('buildApplicationHistoryItems', () => {
|
|
|
200
200
|
name: 'shop-config',
|
|
201
201
|
diff: {
|
|
202
202
|
summary: 'Added keys: API_URL',
|
|
203
|
-
fields: [{ path: 'data (added keys)', newValue: 'API_URL' }],
|
|
203
|
+
fields: [{ path: 'data (added keys)', oldValue: undefined, newValue: 'API_URL' }],
|
|
204
204
|
},
|
|
205
205
|
}),
|
|
206
206
|
event({
|
|
@@ -1,5 +1,67 @@
|
|
|
1
1
|
import { describe, it, expect } from 'vitest'
|
|
2
|
-
import { compareVersions, appGroupingExplainer, APP_IDENTITY_ANNOTATION, appGroupLagMessage, matchWorkloadAcrossInstances, foldAppGroups, identityEnvInferred, worstHealth, buildAppMembershipIndex, batchActivityForApp, batchRuntimeForApp, servingReadiness, type AppGroupFoldEntry, type AppRow, type AppWorkload } from './applications'
|
|
2
|
+
import { compareVersions, appGroupingExplainer, APP_IDENTITY_ANNOTATION, appGroupLagMessage, matchWorkloadAcrossInstances, foldAppGroups, identityEnvInferred, worstHealth, buildAppMembershipIndex, batchActivityForApp, batchRuntimeForApp, servingReadiness, resolveAppWorkloadSelection, type AppGroupFoldEntry, type AppRow, type AppWorkload } from './applications'
|
|
3
|
+
|
|
4
|
+
describe('application workload scope resolution', () => {
|
|
5
|
+
const sole = ['Deployment/prod/api']
|
|
6
|
+
const many = ['Deployment/prod/api', 'Deployment/prod/worker']
|
|
7
|
+
|
|
8
|
+
it('resolves application scope to the sole workload — a one-workload app has none', () => {
|
|
9
|
+
expect(resolveAppWorkloadSelection(sole, null)).toEqual({
|
|
10
|
+
selected: 'Deployment/prod/api',
|
|
11
|
+
hostKeyIsStale: false,
|
|
12
|
+
})
|
|
13
|
+
})
|
|
14
|
+
|
|
15
|
+
it('keeps application scope for a multi-workload app', () => {
|
|
16
|
+
expect(resolveAppWorkloadSelection(many, null)).toEqual({
|
|
17
|
+
selected: null,
|
|
18
|
+
hostKeyIsStale: false,
|
|
19
|
+
})
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
it('passes a key that names a current workload straight through', () => {
|
|
23
|
+
expect(resolveAppWorkloadSelection(many, 'Deployment/prod/worker')).toEqual({
|
|
24
|
+
selected: 'Deployment/prod/worker',
|
|
25
|
+
hostKeyIsStale: false,
|
|
26
|
+
})
|
|
27
|
+
})
|
|
28
|
+
|
|
29
|
+
// The stale key still has to leave the URL even though the sole workload
|
|
30
|
+
// renders in its place — the two outcomes are deliberately independent.
|
|
31
|
+
it('renders the sole workload from a stale key and still reports the key stale', () => {
|
|
32
|
+
expect(resolveAppWorkloadSelection(sole, 'Deployment/prod/gone')).toEqual({
|
|
33
|
+
selected: 'Deployment/prod/api',
|
|
34
|
+
hostKeyIsStale: true,
|
|
35
|
+
})
|
|
36
|
+
})
|
|
37
|
+
|
|
38
|
+
it('falls back to application scope when a stale key has no sole workload to land on', () => {
|
|
39
|
+
expect(resolveAppWorkloadSelection(many, 'Deployment/prod/gone')).toEqual({
|
|
40
|
+
selected: null,
|
|
41
|
+
hostKeyIsStale: true,
|
|
42
|
+
})
|
|
43
|
+
})
|
|
44
|
+
|
|
45
|
+
it('reports no stale key when none was supplied', () => {
|
|
46
|
+
expect(resolveAppWorkloadSelection([], null)).toEqual({
|
|
47
|
+
selected: null,
|
|
48
|
+
hostKeyIsStale: false,
|
|
49
|
+
})
|
|
50
|
+
})
|
|
51
|
+
|
|
52
|
+
// A bare `?workload=` reaches a host as '' rather than null, and names no
|
|
53
|
+
// workload — it has to leave the URL like any other unusable key.
|
|
54
|
+
it('treats the empty string a bare query param yields as a stale key', () => {
|
|
55
|
+
expect(resolveAppWorkloadSelection(sole, '')).toEqual({
|
|
56
|
+
selected: 'Deployment/prod/api',
|
|
57
|
+
hostKeyIsStale: true,
|
|
58
|
+
})
|
|
59
|
+
expect(resolveAppWorkloadSelection(many, '')).toEqual({
|
|
60
|
+
selected: null,
|
|
61
|
+
hostKeyIsStale: true,
|
|
62
|
+
})
|
|
63
|
+
})
|
|
64
|
+
})
|
|
3
65
|
|
|
4
66
|
describe('batch application runtime', () => {
|
|
5
67
|
it('uses the latest retained outcome instead of historical failure count', () => {
|
|
@@ -1364,6 +1364,33 @@ export function applicationDisplayHealth(app: AppRow): AppHealth {
|
|
|
1364
1364
|
]);
|
|
1365
1365
|
}
|
|
1366
1366
|
|
|
1367
|
+
/** Which workload an application detail view renders, and whether the host's
|
|
1368
|
+
* key should be dropped from the URL.
|
|
1369
|
+
*
|
|
1370
|
+
* A single-workload app has no application scope, so it resolves to its sole
|
|
1371
|
+
* workload even when the caller asks for application scope (`null`) or names a
|
|
1372
|
+
* workload the app no longer has. Deciding this here rather than in each host
|
|
1373
|
+
* is the point: a controlled host's only way to say "no workload in the URL"
|
|
1374
|
+
* is `null`, so leaving the rule to hosts makes the forbidden state their
|
|
1375
|
+
* default. `hostKeyIsStale` stays independent of what gets rendered — a key
|
|
1376
|
+
* naming no current workload must leave the URL even when the sole workload
|
|
1377
|
+
* renders in its place. */
|
|
1378
|
+
export function resolveAppWorkloadSelection(
|
|
1379
|
+
workloadKeys: readonly string[],
|
|
1380
|
+
hostSelected: string | null,
|
|
1381
|
+
): { selected: string | null; hostKeyIsStale: boolean } {
|
|
1382
|
+
const matched =
|
|
1383
|
+
hostSelected && workloadKeys.includes(hostSelected) ? hostSelected : null;
|
|
1384
|
+
const soleWorkload = workloadKeys.length === 1 ? workloadKeys[0] : null;
|
|
1385
|
+
return {
|
|
1386
|
+
selected: matched ?? soleWorkload,
|
|
1387
|
+
// Any non-null value counts as a key the host supplied, including the empty
|
|
1388
|
+
// string a bare `?workload=` yields — that names no workload either, and
|
|
1389
|
+
// leaving it in the URL would strand a param nothing can act on.
|
|
1390
|
+
hostKeyIsStale: hostSelected !== null && !matched,
|
|
1391
|
+
};
|
|
1392
|
+
}
|
|
1393
|
+
|
|
1367
1394
|
export function servingReadiness(workloads: AppWorkload[]): {
|
|
1368
1395
|
ready: number;
|
|
1369
1396
|
desired: number;
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { describe, it, expect, afterEach } from 'vitest'
|
|
2
|
+
import { assetUrl } from './asset-url'
|
|
3
|
+
|
|
4
|
+
type RuntimeGlobal = typeof globalThis & {
|
|
5
|
+
__RADAR_RUNTIME_CONFIG__?: { assetBase?: string }
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
function setAssetBase(assetBase: string) {
|
|
9
|
+
;(globalThis as RuntimeGlobal).__RADAR_RUNTIME_CONFIG__ = { assetBase }
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Simulates a Worker scope, where `window` is absent and `location` is the
|
|
14
|
+
* worker script's own URL. jsdom defines `window`, so it has to be removed.
|
|
15
|
+
*/
|
|
16
|
+
function asWorkerAt(pathname: string, run: () => void) {
|
|
17
|
+
const realWindow = globalThis.window
|
|
18
|
+
// @ts-expect-error — deliberately emulating a scope without `window`
|
|
19
|
+
delete globalThis.window
|
|
20
|
+
const realLocation = globalThis.location
|
|
21
|
+
Object.defineProperty(globalThis, 'location', {
|
|
22
|
+
value: { pathname },
|
|
23
|
+
configurable: true,
|
|
24
|
+
writable: true,
|
|
25
|
+
})
|
|
26
|
+
try {
|
|
27
|
+
run()
|
|
28
|
+
} finally {
|
|
29
|
+
Object.defineProperty(globalThis, 'location', {
|
|
30
|
+
value: realLocation,
|
|
31
|
+
configurable: true,
|
|
32
|
+
writable: true,
|
|
33
|
+
})
|
|
34
|
+
globalThis.window = realWindow
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
afterEach(() => {
|
|
39
|
+
delete (globalThis as RuntimeGlobal).__RADAR_RUNTIME_CONFIG__
|
|
40
|
+
})
|
|
41
|
+
|
|
42
|
+
describe('assetUrl at the root (no base path)', () => {
|
|
43
|
+
it('leaves absolute paths untouched', () => {
|
|
44
|
+
expect(assetUrl('/images/radar/radar-icon.svg')).toBe('/images/radar/radar-icon.svg')
|
|
45
|
+
})
|
|
46
|
+
|
|
47
|
+
it('makes Vite-relative asset paths absolute', () => {
|
|
48
|
+
expect(assetUrl('./assets/index-abc.js')).toBe('/assets/index-abc.js')
|
|
49
|
+
expect(assetUrl('assets/index-abc.js')).toBe('/assets/index-abc.js')
|
|
50
|
+
})
|
|
51
|
+
|
|
52
|
+
it('unwraps the webpack/Next StaticImageData shape', () => {
|
|
53
|
+
expect(assetUrl({ src: '/_next/static/x.png' })).toBe('/_next/static/x.png')
|
|
54
|
+
})
|
|
55
|
+
|
|
56
|
+
// An app route may contain an "/assets/" segment (e.g. a namespace named
|
|
57
|
+
// "assets"). That must not be mistaken for a base path.
|
|
58
|
+
it('ignores an /assets/ segment in the current app route', () => {
|
|
59
|
+
expect(assetUrl('/images/radar/radar-icon.svg')).toBe('/images/radar/radar-icon.svg')
|
|
60
|
+
})
|
|
61
|
+
})
|
|
62
|
+
|
|
63
|
+
describe('assetUrl under a base path', () => {
|
|
64
|
+
it('prefixes absolute and relative asset paths', () => {
|
|
65
|
+
setAssetBase('/radar')
|
|
66
|
+
expect(assetUrl('/images/radar/radar-icon.svg')).toBe('/radar/images/radar/radar-icon.svg')
|
|
67
|
+
expect(assetUrl('./assets/index-abc.js')).toBe('/radar/assets/index-abc.js')
|
|
68
|
+
expect(assetUrl('assets/index-abc.js')).toBe('/radar/assets/index-abc.js')
|
|
69
|
+
})
|
|
70
|
+
|
|
71
|
+
it('is idempotent for already-prefixed paths', () => {
|
|
72
|
+
setAssetBase('/radar')
|
|
73
|
+
expect(assetUrl('/radar/assets/index-abc.js')).toBe('/radar/assets/index-abc.js')
|
|
74
|
+
})
|
|
75
|
+
|
|
76
|
+
it('leaves protocol-relative URLs alone', () => {
|
|
77
|
+
setAssetBase('/radar')
|
|
78
|
+
expect(assetUrl('//cdn.example.com/x.png')).toBe('//cdn.example.com/x.png')
|
|
79
|
+
})
|
|
80
|
+
|
|
81
|
+
it('handles a nested base path', () => {
|
|
82
|
+
setAssetBase('/tools/radar')
|
|
83
|
+
expect(assetUrl('/favicon.svg')).toBe('/tools/radar/favicon.svg')
|
|
84
|
+
})
|
|
85
|
+
})
|
|
86
|
+
|
|
87
|
+
describe('assetUrl inside a Worker', () => {
|
|
88
|
+
it('recovers the base path from the worker script URL', () => {
|
|
89
|
+
asWorkerAt('/radar/assets/layout.worker-abc.js', () => {
|
|
90
|
+
expect(assetUrl('/images/x.svg')).toBe('/radar/images/x.svg')
|
|
91
|
+
})
|
|
92
|
+
})
|
|
93
|
+
|
|
94
|
+
it('resolves to the root when the worker is served from the root', () => {
|
|
95
|
+
asWorkerAt('/assets/layout.worker-abc.js', () => {
|
|
96
|
+
expect(assetUrl('/images/x.svg')).toBe('/images/x.svg')
|
|
97
|
+
})
|
|
98
|
+
})
|
|
99
|
+
|
|
100
|
+
// The base path may itself contain "/assets/" — split on the last one.
|
|
101
|
+
it('splits on the last /assets/ segment', () => {
|
|
102
|
+
asWorkerAt('/host/assets/radar/assets/layout.worker-abc.js', () => {
|
|
103
|
+
expect(assetUrl('/images/x.svg')).toBe('/host/assets/radar/images/x.svg')
|
|
104
|
+
})
|
|
105
|
+
})
|
|
106
|
+
|
|
107
|
+
it('prefers the injected config over the URL heuristic', () => {
|
|
108
|
+
setAssetBase('/radar')
|
|
109
|
+
asWorkerAt('/somewhere/assets/worker.js', () => {
|
|
110
|
+
expect(assetUrl('/images/x.svg')).toBe('/radar/images/x.svg')
|
|
111
|
+
})
|
|
112
|
+
})
|
|
113
|
+
})
|
package/src/utils/asset-url.ts
CHANGED
|
@@ -9,5 +9,37 @@
|
|
|
9
9
|
export type AssetImport = string | { src: string }
|
|
10
10
|
|
|
11
11
|
export function assetUrl(asset: AssetImport): string {
|
|
12
|
-
|
|
12
|
+
const url = typeof asset === 'string' ? asset : asset.src
|
|
13
|
+
const assetBase = getRuntimeAssetBase()
|
|
14
|
+
if (!assetBase || url.startsWith('//') || url === assetBase || url.startsWith(`${assetBase}/`)) {
|
|
15
|
+
if (url.startsWith('./assets/')) return `/assets/${url.slice('./assets/'.length)}`
|
|
16
|
+
if (url.startsWith('assets/')) return `/${url}`
|
|
17
|
+
return url
|
|
18
|
+
}
|
|
19
|
+
if (url.startsWith('./')) return `${assetBase}/${url.slice(2)}`
|
|
20
|
+
if (!url.startsWith('/') && url.startsWith('assets/')) return `${assetBase}/${url}`
|
|
21
|
+
if (!url.startsWith('/')) return url
|
|
22
|
+
return `${assetBase}${url}`
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
function getRuntimeAssetBase(): string {
|
|
26
|
+
if (typeof globalThis === 'undefined') return ''
|
|
27
|
+
const runtime = (globalThis as typeof globalThis & {
|
|
28
|
+
__RADAR_RUNTIME_CONFIG__?: { assetBase?: string }
|
|
29
|
+
}).__RADAR_RUNTIME_CONFIG__
|
|
30
|
+
const configured = runtime?.assetBase?.replace(/\/+$/, '')
|
|
31
|
+
if (configured) return configured
|
|
32
|
+
|
|
33
|
+
// A Worker has its own global scope, so it never sees the runtime config the
|
|
34
|
+
// server injects into index.html — but its own script URL sits at
|
|
35
|
+
// `<base>/assets/<chunk>.js`, so the base can be recovered from it. Restricted
|
|
36
|
+
// to worker scopes on purpose: on the main thread `pathname` is an app route,
|
|
37
|
+
// which may legitimately contain an "/assets/" segment (a namespace or
|
|
38
|
+
// resource named "assets") and would yield a bogus prefix for every asset.
|
|
39
|
+
if (typeof window !== 'undefined') return ''
|
|
40
|
+
const pathname = globalThis.location?.pathname ?? ''
|
|
41
|
+
// lastIndexOf, not indexOf: the base path itself may contain "/assets/".
|
|
42
|
+
const assetsIndex = pathname.lastIndexOf('/assets/')
|
|
43
|
+
if (assetsIndex > 0) return pathname.slice(0, assetsIndex)
|
|
44
|
+
return ''
|
|
13
45
|
}
|