-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #122705 from cockroachdb/blathers/backport-release…
…-24.1-122151 release-24.1: ui: make custom chart tool work at store level
- Loading branch information
Showing
3 changed files
with
243 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
180 changes: 180 additions & 0 deletions
180
pkg/ui/workspaces/db-console/src/views/reports/containers/customChart/index.spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| // Copyright 2024 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| import { NodesSummary } from "src/redux/nodes"; | ||
| import { INodeStatus } from "src/util/proto"; | ||
| import { GetSources } from "src/views/reports/containers/customChart/index"; | ||
| import * as protos from "src/js/protos"; | ||
| import { CustomMetricState } from "src/views/reports/containers/customChart/customMetric"; | ||
|
|
||
| import TimeSeriesQueryAggregator = protos.cockroach.ts.tspb.TimeSeriesQueryAggregator; | ||
| import TimeSeriesQueryDerivative = protos.cockroach.ts.tspb.TimeSeriesQueryDerivative; | ||
|
|
||
| describe("Custom charts page", function () { | ||
| describe("Getting metric sources", function () { | ||
| it("returns empty when nodesSummary is undefined", function () { | ||
| const metricState = new testCustomMetricStateBuilder().build(); | ||
| expect(GetSources(undefined, metricState)).toStrictEqual([]); | ||
| }); | ||
|
|
||
| it("returns empty when the nodeStatuses collection is empty", function () { | ||
| const nodesSummary = new testNodesSummaryBuilder().build(); | ||
| nodesSummary.nodeStatuses = []; | ||
| const metricState = new testCustomMetricStateBuilder().build(); | ||
| expect(GetSources(nodesSummary, metricState)).toStrictEqual([]); | ||
| }); | ||
|
|
||
| it("returns empty when no specific node source is requested, nor per-source metrics", function () { | ||
| const nodesSummary = new testNodesSummaryBuilder().build(); | ||
| const metricState = new testCustomMetricStateBuilder() | ||
| .setNodeSource("") | ||
| .setIsPerSource(false) | ||
| .build(); | ||
| expect(GetSources(nodesSummary, metricState)).toStrictEqual([]); | ||
| }); | ||
|
|
||
| describe("The metric is at the store-level", function () { | ||
| const storeMetricName = "cr.store.metric"; | ||
|
|
||
| it("returns the store IDs associated with a specific node when a node source is set", function () { | ||
| const expectedSources = ["1", "2", "3"]; | ||
| const metricState = new testCustomMetricStateBuilder() | ||
| .setName(storeMetricName) | ||
| .setNodeSource("1") | ||
| .build(); | ||
| const nodesSummary = new testNodesSummaryBuilder() | ||
| .setStoreIDsByNodeID({ | ||
| "1": expectedSources, | ||
| }) | ||
| .build(); | ||
| expect(GetSources(nodesSummary, metricState)).toStrictEqual( | ||
| expectedSources, | ||
| ); | ||
| }); | ||
|
|
||
| it("returns all known store IDs for the cluster when no node source is set", function () { | ||
| const expectedSources = ["1", "2", "3", "4", "5", "6", "7", "8", "9"]; | ||
| const metricState = new testCustomMetricStateBuilder() | ||
| .setName(storeMetricName) | ||
| .build(); | ||
| const nodesSummary = new testNodesSummaryBuilder() | ||
| .setStoreIDsByNodeID({ | ||
| "1": ["1", "2", "3"], | ||
| "2": ["4", "5", "6"], | ||
| "3": ["7", "8", "9"], | ||
| }) | ||
| .build(); | ||
| const actualSources = GetSources(nodesSummary, metricState).sort(); | ||
| expect(actualSources).toStrictEqual(expectedSources); | ||
| }); | ||
| }); | ||
|
|
||
| describe("The metric is at the node-level", function () { | ||
| const nodeMetricName = "cr.node.metric"; | ||
|
|
||
| it("returns the specified node source when a node source is set", function () { | ||
| const expectedSources = ["1"]; | ||
| const metricState = new testCustomMetricStateBuilder() | ||
| .setName(nodeMetricName) | ||
| .setNodeSource("1") | ||
| .build(); | ||
| const nodesSummary = new testNodesSummaryBuilder().build(); | ||
| expect(GetSources(nodesSummary, metricState)).toStrictEqual( | ||
| expectedSources, | ||
| ); | ||
| }); | ||
|
|
||
| it("returns all known node IDs when no node source is set", function () { | ||
| const expectedSources = ["1", "2", "3"]; | ||
| const metricState = new testCustomMetricStateBuilder() | ||
| .setName(nodeMetricName) | ||
| .build(); | ||
| const nodesSummary = new testNodesSummaryBuilder() | ||
| .setNodeIDs(["1", "2", "3"]) | ||
| .build(); | ||
| expect(GetSources(nodesSummary, metricState)).toStrictEqual( | ||
| expectedSources, | ||
| ); | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| class testCustomMetricStateBuilder { | ||
| name: string; | ||
| nodeSource: string; | ||
| perSource: boolean; | ||
|
|
||
| setName(name: string): testCustomMetricStateBuilder { | ||
| this.name = name; | ||
| return this; | ||
| } | ||
|
|
||
| setNodeSource(nodeSource: string): testCustomMetricStateBuilder { | ||
| this.nodeSource = nodeSource; | ||
| return this; | ||
| } | ||
|
|
||
| setIsPerSource(perSource: boolean): testCustomMetricStateBuilder { | ||
| this.perSource = perSource; | ||
| return this; | ||
| } | ||
|
|
||
| build(): CustomMetricState { | ||
| return { | ||
| metric: this.name, | ||
| downsampler: TimeSeriesQueryAggregator.AVG, | ||
| aggregator: TimeSeriesQueryAggregator.SUM, | ||
| derivative: TimeSeriesQueryDerivative.NONE, | ||
| perSource: this.perSource, | ||
| perTenant: false, | ||
| nodeSource: this.nodeSource, | ||
| tenantSource: "", | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| class testNodesSummaryBuilder { | ||
| nodeStatuses: INodeStatus[]; | ||
| storeIDsByNodeID: { [key: string]: string[] }; | ||
| nodeIDs: string[]; | ||
|
|
||
| setStoreIDsByNodeID(storeIDsByNodeID: { | ||
| [key: string]: string[]; | ||
| }): testNodesSummaryBuilder { | ||
| this.storeIDsByNodeID = storeIDsByNodeID; | ||
| return this; | ||
| } | ||
|
|
||
| setNodeIDs(nodeIDs: string[]): testNodesSummaryBuilder { | ||
| this.nodeIDs = nodeIDs; | ||
| return this; | ||
| } | ||
|
|
||
| build(): NodesSummary { | ||
| return { | ||
| // We normally don't care about the nodeStatuses elements, so long as it's not an empty list. | ||
| // Populate with an empty object. | ||
| nodeStatuses: [ | ||
| { | ||
| // We also need a non-empty list of store_statuses, for the isStoreMetric() call made. | ||
| store_statuses: [{}], | ||
| }, | ||
| ], | ||
| nodeIDs: this.nodeIDs, | ||
| nodeStatusByID: { "": {} }, | ||
| nodeDisplayNameByID: { "": "" }, | ||
| livenessStatusByNodeID: {}, | ||
| livenessByNodeID: {}, | ||
| storeIDsByNodeID: this.storeIDsByNodeID, | ||
| nodeLastError: undefined, | ||
| }; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters