@red-hat-developer-hub/backstage-plugin-scorecard-backend 2.6.0 → 2.7.1
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/CHANGELOG.md +21 -0
- package/README.md +31 -8
- package/config.d.ts +20 -42
- package/dist/constants/aggregationKPIs.cjs.js +22 -0
- package/dist/constants/aggregationKPIs.cjs.js.map +1 -1
- package/dist/database/DatabaseMetricValues.cjs.js +39 -5
- package/dist/database/DatabaseMetricValues.cjs.js.map +1 -1
- package/dist/plugin.cjs.js +12 -3
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/service/CatalogMetricService.cjs.js +29 -40
- package/dist/service/CatalogMetricService.cjs.js.map +1 -1
- package/dist/service/aggregations/AggregatedMetricLoader.cjs.js +23 -0
- package/dist/service/aggregations/AggregatedMetricLoader.cjs.js.map +1 -0
- package/dist/service/aggregations/AggregationService.cjs.js +54 -0
- package/dist/service/aggregations/AggregationService.cjs.js.map +1 -0
- package/dist/service/aggregations/strategies/AverageAggregationStrategy.cjs.js +112 -0
- package/dist/service/aggregations/strategies/AverageAggregationStrategy.cjs.js.map +1 -0
- package/dist/service/aggregations/strategies/StatusGroupedAggregationStrategy.cjs.js +36 -0
- package/dist/service/aggregations/strategies/StatusGroupedAggregationStrategy.cjs.js.map +1 -0
- package/dist/service/aggregations/strategies/registerStrategies.cjs.js +18 -0
- package/dist/service/aggregations/strategies/registerStrategies.cjs.js.map +1 -0
- package/dist/service/mappers.cjs.js +5 -11
- package/dist/service/mappers.cjs.js.map +1 -1
- package/dist/service/router.cjs.js +14 -26
- package/dist/service/router.cjs.js.map +1 -1
- package/dist/utils/buildAggregationConfig.cjs.js +31 -1
- package/dist/utils/buildAggregationConfig.cjs.js.map +1 -1
- package/dist/utils/mergeEntityAndProviderThresholds.cjs.js +1 -1
- package/dist/utils/mergeEntityAndProviderThresholds.cjs.js.map +1 -1
- package/dist/utils/metricCalculationError.cjs.js +8 -0
- package/dist/utils/metricCalculationError.cjs.js.map +1 -0
- package/dist/validation/schemas/aggregationConfigSchemas.cjs.js +40 -0
- package/dist/validation/schemas/aggregationConfigSchemas.cjs.js.map +1 -0
- package/dist/validation/validateAggregationConfig.cjs.js +7 -10
- package/dist/validation/validateAggregationConfig.cjs.js.map +1 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @red-hat-developer-hub/backstage-plugin-scorecard-backend
|
|
2
2
|
|
|
3
|
+
## 2.7.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 91e724f: Expose scorecard entity calculation health on drill-down and aggregation APIs, and align the drill-down warning plus homepage subheader with those counts.
|
|
8
|
+
- Updated dependencies [91e724f]
|
|
9
|
+
- @red-hat-developer-hub/backstage-plugin-scorecard-common@2.7.1
|
|
10
|
+
- @red-hat-developer-hub/backstage-plugin-scorecard-node@2.7.1
|
|
11
|
+
|
|
12
|
+
## 2.7.0
|
|
13
|
+
|
|
14
|
+
### Minor Changes
|
|
15
|
+
|
|
16
|
+
- bf72ffc: Adds `**average**` as an aggregation KPI type alongside `**statusGrouped**`, with configurable `**options.statusScores**` and optional `**options.thresholds**` (same shape as metric thresholds) for homepage donut coloring against `**averageScore × 100**`, with built-in defaults when omitted.
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- Updated dependencies [bf72ffc]
|
|
21
|
+
- @red-hat-developer-hub/backstage-plugin-scorecard-common@2.7.0
|
|
22
|
+
- @red-hat-developer-hub/backstage-plugin-scorecard-node@2.7.0
|
|
23
|
+
|
|
3
24
|
## 2.6.0
|
|
4
25
|
|
|
5
26
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -118,7 +118,7 @@ Thresholds define conditions to assign metric values to specific visual categori
|
|
|
118
118
|
|
|
119
119
|
Thresholds are evaluated in order, and the first matching rule determines the category. The plugin supports various operators for number metrics (`>`, `>=`, `<`, `<=`, `==`, `!=`, `-` (range)) and boolean metrics (`==`, `!=`).
|
|
120
120
|
|
|
121
|
-
For comprehensive threshold configuration guide, examples,
|
|
121
|
+
For comprehensive threshold configuration guide, examples, best practices, and **aggregation KPI result thresholds** for **`type: average`**, see [thresholds.md](./docs/thresholds.md).
|
|
122
122
|
|
|
123
123
|
## Aggregation KPIs (homepage and `GET /aggregations`)
|
|
124
124
|
|
|
@@ -137,18 +137,41 @@ scorecard:
|
|
|
137
137
|
description: 'Open pull requests grouped by status.'
|
|
138
138
|
type: statusGrouped
|
|
139
139
|
metricId: github.open_prs
|
|
140
|
+
openPrsWeightedKpi:
|
|
141
|
+
title: 'GitHub open PRs (weighted health)'
|
|
142
|
+
description: 'Weighted health from status counts using configurable scores.'
|
|
143
|
+
type: average
|
|
144
|
+
metricId: github.open_prs
|
|
145
|
+
options:
|
|
146
|
+
statusScores:
|
|
147
|
+
success: 100
|
|
148
|
+
warning: 50
|
|
149
|
+
error: 0
|
|
150
|
+
# Optional: colors for the average-score donut (expressions apply to percentage 0–100)
|
|
151
|
+
thresholds:
|
|
152
|
+
rules:
|
|
153
|
+
- key: success
|
|
154
|
+
expression: '>=75'
|
|
155
|
+
color: success.main
|
|
156
|
+
- key: warning
|
|
157
|
+
expression: '10-74'
|
|
158
|
+
color: warning.main
|
|
159
|
+
- key: error
|
|
160
|
+
expression: '<10'
|
|
161
|
+
color: error.main
|
|
140
162
|
```
|
|
141
163
|
|
|
142
|
-
| Field | Description
|
|
143
|
-
| ------------- |
|
|
144
|
-
| `title` | Display title for this aggregation (returned in API metadata).
|
|
145
|
-
| `description` | Display description for this aggregation.
|
|
146
|
-
| `type` | Aggregation algorithm
|
|
147
|
-
| `metricId` | Metric provider id used to load thresholds and compute counts.
|
|
164
|
+
| Field | Description |
|
|
165
|
+
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
166
|
+
| `title` | Display title for this aggregation (returned in API metadata). |
|
|
167
|
+
| `description` | Display description for this aggregation. |
|
|
168
|
+
| `type` | Aggregation algorithm: `statusGrouped` (counts per threshold status) or `average` (normalized weighted score). |
|
|
169
|
+
| `metricId` | Metric provider id used to load thresholds and compute counts. |
|
|
170
|
+
| `options` | Optional for `statusGrouped`. **Required** for `average`: must include **`options.statusScores`** — map status keys to numeric weights (typically one entry per **metric threshold rule key**). Optionally **`options.thresholds`** (same shape as metric thresholds; see [thresholds.md — Aggregation KPI result thresholds](./docs/thresholds.md#4-aggregation-kpi-result-thresholds-average-type)); evaluated on **`averageScore × 100`**; first match sets **`aggregationChartDisplayColor`**. The API includes **`averageScore`** (ratio **0–1**, **one decimal**), **`averageWeightedSum`**, **`averageMaxPossible`**, and **`aggregationChartDisplayColor`** (from configured or default result thresholds). |
|
|
148
171
|
|
|
149
172
|
- **Path**: `scorecard.aggregationKPIs.<aggregationId>`.
|
|
150
173
|
- If **`aggregationKPIs` is omitted** or a given id is not listed, **`GET /aggregations/:aggregationId`** still works when **`aggregationId` equals the metric id** (e.g. `github.open_prs`): the backend uses that metric with the default `statusGrouped` aggregation and metric-defined title/description.
|
|
151
|
-
- Invalid
|
|
174
|
+
- **Startup validation**: the backend validates every **`scorecard.aggregationKPIs`** entry when the plugin loads. Invalid configuration (including **`average`** KPIs without **`options.statusScores`**, bad expressions, or unregistered **`metricId`**) causes the backend to **fail to start** with a clear error. At runtime, some edge cases may still be logged (for example skipping a KPI with unusable weights); prefer correcting app-config. See [aggregation.md](./docs/aggregation.md#configuration-validation).
|
|
152
175
|
|
|
153
176
|
**Homepage cards** are configured in the app (for example Dynamic Home Page mount points). They should pass **`aggregationId`** matching a key in `aggregationKPIs` or the metric id for the default case. See the [Scorecard frontend plugin README](../scorecard/README.md#homepage-scorecard-cards).
|
|
154
177
|
|
package/config.d.ts
CHANGED
|
@@ -15,7 +15,11 @@
|
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
17
|
import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
|
|
18
|
-
import {
|
|
18
|
+
import {
|
|
19
|
+
AggregationType,
|
|
20
|
+
ThresholdConfig,
|
|
21
|
+
AggregationThresholdRule,
|
|
22
|
+
} from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
|
|
19
23
|
|
|
20
24
|
export interface Config {
|
|
21
25
|
/** Configuration for scorecard plugin */
|
|
@@ -32,6 +36,20 @@ export interface Config {
|
|
|
32
36
|
type: AggregationType;
|
|
33
37
|
/** Metric ID for which the aggregation is calculated */
|
|
34
38
|
metricId: string;
|
|
39
|
+
/** Type-specific settings */
|
|
40
|
+
options?: {
|
|
41
|
+
/** Required under `options` when `type` is `average` */
|
|
42
|
+
statusScores?: {
|
|
43
|
+
[thresholdRuleKey: string]: number;
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* Optional: threshold rules for coloring the KPI headline value from the aggregation result
|
|
47
|
+
* (e.g. average percentage 0–100 for `average` KPIs).
|
|
48
|
+
*/
|
|
49
|
+
thresholds?: {
|
|
50
|
+
rules: AggregationThresholdRule[];
|
|
51
|
+
};
|
|
52
|
+
};
|
|
35
53
|
};
|
|
36
54
|
};
|
|
37
55
|
/** Number of days to retain metric data in the database. Older data will be automatically cleaned up. Default: 365 days */
|
|
@@ -57,47 +75,7 @@ export interface Config {
|
|
|
57
75
|
*/
|
|
58
76
|
[metricName: string]: {
|
|
59
77
|
/** Threshold configuration for the metric */
|
|
60
|
-
thresholds?:
|
|
61
|
-
/**
|
|
62
|
-
* Rules describe how metric values are categorized and how that category is presented in the UI.
|
|
63
|
-
* They are evaluated in order and the first matching rule is applied.
|
|
64
|
-
*/
|
|
65
|
-
rules?: Array<{
|
|
66
|
-
/**
|
|
67
|
-
* Threshold category key that a metric value is assigned to when this rule
|
|
68
|
-
* matches (for example `success`, `warning`, `error`, or a custom key).
|
|
69
|
-
*/
|
|
70
|
-
key: string;
|
|
71
|
-
/**
|
|
72
|
-
* Threshold expression that determines whether a metric value matches this
|
|
73
|
-
* rule. Supports:`>=`, `<=`, `>`, `<`, `==`, `!=`, `-` (range).
|
|
74
|
-
*
|
|
75
|
-
* @example `<= 10` - Metric value must be less than or equal to 10.
|
|
76
|
-
* @example `10-60` - Metric value must be between 10 and 60 (inclusive).
|
|
77
|
-
*/
|
|
78
|
-
expression: string;
|
|
79
|
-
/**
|
|
80
|
-
* Color configuration - supports multiple formats:
|
|
81
|
-
* - theme palette reference (`success.main` / `warning.main` / `error.main`)
|
|
82
|
-
* - HEX code (e.g. '#FFA500')
|
|
83
|
-
* - RGB/RGBA (e.g. 'rgb(255, 0, 0)')
|
|
84
|
-
*
|
|
85
|
-
* Threshold rules 'success', 'warning' and 'error' have default colors.
|
|
86
|
-
*/
|
|
87
|
-
color?: string;
|
|
88
|
-
/**
|
|
89
|
-
* Icon configuration - supports multiple formats:
|
|
90
|
-
* - Backstage system icons: 'kind:component', 'kind:api', etc.
|
|
91
|
-
* - Material Design icons: 'settings', 'home', 'build', etc.
|
|
92
|
-
* - SVG strings: '<svg xmlns="http://www.w3.org/2000/svg">...</svg>'
|
|
93
|
-
* - URLs: 'https://example.com/icon.png', '/assets/icon.svg'
|
|
94
|
-
* - Data URIs: 'data:image/svg+xml;base64,...'
|
|
95
|
-
*
|
|
96
|
-
* Threshold rules 'success', 'warning' and 'error' have default icons.
|
|
97
|
-
*/
|
|
98
|
-
icon?: string;
|
|
99
|
-
}>;
|
|
100
|
-
};
|
|
78
|
+
thresholds?: ThresholdConfig;
|
|
101
79
|
/**
|
|
102
80
|
* Schedule for collecting this metric. If not set, the default hourly schedule is used.
|
|
103
81
|
*
|
|
@@ -1,6 +1,28 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
+
var backstagePluginScorecardCommon = require('@red-hat-developer-hub/backstage-plugin-scorecard-common');
|
|
4
|
+
|
|
3
5
|
const AGGREGATION_KPIS_CONFIG_PATH = "scorecard.aggregationKPIs";
|
|
6
|
+
const DEFAULT_AVERAGE_KPI_RESULT_THRESHOLDS = {
|
|
7
|
+
rules: [
|
|
8
|
+
{
|
|
9
|
+
key: "success",
|
|
10
|
+
expression: ">=80",
|
|
11
|
+
color: backstagePluginScorecardCommon.ScorecardThresholdRuleColors.SUCCESS
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
key: "warning",
|
|
15
|
+
expression: "30-79",
|
|
16
|
+
color: backstagePluginScorecardCommon.ScorecardThresholdRuleColors.WARNING
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
key: "error",
|
|
20
|
+
expression: "<30",
|
|
21
|
+
color: backstagePluginScorecardCommon.ScorecardThresholdRuleColors.ERROR
|
|
22
|
+
}
|
|
23
|
+
]
|
|
24
|
+
};
|
|
4
25
|
|
|
5
26
|
exports.AGGREGATION_KPIS_CONFIG_PATH = AGGREGATION_KPIS_CONFIG_PATH;
|
|
27
|
+
exports.DEFAULT_AVERAGE_KPI_RESULT_THRESHOLDS = DEFAULT_AVERAGE_KPI_RESULT_THRESHOLDS;
|
|
6
28
|
//# sourceMappingURL=aggregationKPIs.cjs.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"aggregationKPIs.cjs.js","sources":["../../src/constants/aggregationKPIs.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const AGGREGATION_KPIS_CONFIG_PATH =\n 'scorecard.aggregationKPIs' as const;\n"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"aggregationKPIs.cjs.js","sources":["../../src/constants/aggregationKPIs.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n type ThresholdConfig,\n ScorecardThresholdRuleColors,\n} from '@red-hat-developer-hub/backstage-plugin-scorecard-common';\n\nexport const AGGREGATION_KPIS_CONFIG_PATH =\n 'scorecard.aggregationKPIs' as const;\n\n/**\n * Default applied by `AverageAggregationStrategy` when `options.thresholds` is omitted\n * from app-config. Higher headline percentage (0–100) = better. Evaluated in order; first match wins.\n */\nexport const DEFAULT_AVERAGE_KPI_RESULT_THRESHOLDS: ThresholdConfig = {\n rules: [\n {\n key: 'success',\n expression: '>=80',\n color: ScorecardThresholdRuleColors.SUCCESS,\n },\n {\n key: 'warning',\n expression: '30-79',\n color: ScorecardThresholdRuleColors.WARNING,\n },\n {\n key: 'error',\n expression: '<30',\n color: ScorecardThresholdRuleColors.ERROR,\n },\n ],\n};\n"],"names":["ScorecardThresholdRuleColors"],"mappings":";;;;AAqBO,MAAM,4BACX,GAAA;AAMK,MAAM,qCAAyD,GAAA;AAAA,EACpE,KAAO,EAAA;AAAA,IACL;AAAA,MACE,GAAK,EAAA,SAAA;AAAA,MACL,UAAY,EAAA,MAAA;AAAA,MACZ,OAAOA,2DAA6B,CAAA;AAAA,KACtC;AAAA,IACA;AAAA,MACE,GAAK,EAAA,SAAA;AAAA,MACL,UAAY,EAAA,OAAA;AAAA,MACZ,OAAOA,2DAA6B,CAAA;AAAA,KACtC;AAAA,IACA;AAAA,MACE,GAAK,EAAA,OAAA;AAAA,MACL,UAAY,EAAA,KAAA;AAAA,MACZ,OAAOA,2DAA6B,CAAA;AAAA;AACtC;AAEJ;;;;;"}
|
|
@@ -34,19 +34,50 @@ class DatabaseMetricValues {
|
|
|
34
34
|
* Get aggregated metrics by status for multiple entities and metrics.
|
|
35
35
|
*/
|
|
36
36
|
async readAggregatedMetricByEntityRefs(catalog_entity_refs, metric_id) {
|
|
37
|
+
if (catalog_entity_refs.length === 0) {
|
|
38
|
+
return void 0;
|
|
39
|
+
}
|
|
37
40
|
const latestIdsSubquery = this.dbClient(this.tableName).max("id").where("metric_id", metric_id).whereIn("catalog_entity_ref", catalog_entity_refs).groupBy("catalog_entity_ref");
|
|
38
|
-
const
|
|
39
|
-
|
|
41
|
+
const metricValueIsMissingExpr = "(value IS NULL OR CAST(value AS TEXT) = 'null')";
|
|
42
|
+
const statsRow = await this.dbClient(this.tableName).whereIn("id", latestIdsSubquery).select(
|
|
43
|
+
this.dbClient.raw("COUNT(*) as latest_row_count"),
|
|
44
|
+
this.dbClient.raw(
|
|
45
|
+
`SUM(CASE WHEN error_message IS NOT NULL AND ${metricValueIsMissingExpr} THEN 1 ELSE 0 END) as calculation_error_count`
|
|
46
|
+
),
|
|
47
|
+
this.dbClient.raw("MAX(timestamp) as max_timestamp")
|
|
48
|
+
).first();
|
|
49
|
+
const latestRowCount = Number(
|
|
50
|
+
statsRow?.latest_row_count ?? 0
|
|
51
|
+
);
|
|
52
|
+
if (latestRowCount === 0) {
|
|
40
53
|
return void 0;
|
|
41
54
|
}
|
|
55
|
+
const calculation_error_count = Number(
|
|
56
|
+
statsRow?.calculation_error_count ?? 0
|
|
57
|
+
);
|
|
42
58
|
const normalizeTimestamp = (timestamp) => {
|
|
43
59
|
if (timestamp instanceof Date) {
|
|
44
60
|
return timestamp;
|
|
45
|
-
}
|
|
61
|
+
}
|
|
62
|
+
if (typeof timestamp === "number" || typeof timestamp === "string") {
|
|
46
63
|
return new Date(timestamp);
|
|
47
64
|
}
|
|
48
65
|
return /* @__PURE__ */ new Date();
|
|
49
66
|
};
|
|
67
|
+
const maxTimestampAllLatest = normalizeTimestamp(
|
|
68
|
+
statsRow?.max_timestamp
|
|
69
|
+
);
|
|
70
|
+
const statusRows = await this.dbClient(this.tableName).select("status").count("* as count").max("timestamp as max_timestamp").whereIn("id", latestIdsSubquery).whereNotNull("status").whereRaw(`NOT ${metricValueIsMissingExpr}`).groupBy("status");
|
|
71
|
+
if (!statusRows || statusRows.length === 0) {
|
|
72
|
+
return {
|
|
73
|
+
metric_id,
|
|
74
|
+
total: 0,
|
|
75
|
+
max_timestamp: maxTimestampAllLatest,
|
|
76
|
+
statusCounts: {},
|
|
77
|
+
calculation_error_count,
|
|
78
|
+
latest_entity_count: latestRowCount
|
|
79
|
+
};
|
|
80
|
+
}
|
|
50
81
|
let maxTimestamp = /* @__PURE__ */ new Date(0);
|
|
51
82
|
let total = 0;
|
|
52
83
|
const statusCounts = {};
|
|
@@ -60,11 +91,14 @@ class DatabaseMetricValues {
|
|
|
60
91
|
statusCounts[name] = count;
|
|
61
92
|
total += count;
|
|
62
93
|
}
|
|
94
|
+
const mergedMax = maxTimestampAllLatest.getTime() >= maxTimestamp.getTime() ? maxTimestampAllLatest : maxTimestamp;
|
|
63
95
|
return {
|
|
64
96
|
metric_id,
|
|
65
97
|
total,
|
|
66
|
-
max_timestamp:
|
|
67
|
-
statusCounts
|
|
98
|
+
max_timestamp: mergedMax,
|
|
99
|
+
statusCounts,
|
|
100
|
+
calculation_error_count,
|
|
101
|
+
latest_entity_count: latestRowCount
|
|
68
102
|
};
|
|
69
103
|
}
|
|
70
104
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DatabaseMetricValues.cjs.js","sources":["../../src/database/DatabaseMetricValues.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Knex } from 'knex';\nimport {\n DbMetricValueCreate,\n DbMetricValue,\n DbAggregatedMetric,\n} from './types';\n\ntype ReadEntityMetricsWithFiltersOptions = {\n status?: string;\n entityName?: string;\n entityKind?: string;\n entityNamespace?: string;\n entityOwner?: string[];\n sortBy?:\n | 'entityName'\n | 'owner'\n | 'entityKind'\n | 'timestamp'\n | 'metricValue'\n | 'namespace'\n | 'status';\n sortOrder?: 'asc' | 'desc';\n pagination?: { limit: number; offset: number };\n};\n\nexport class DatabaseMetricValues {\n private readonly tableName = 'metric_values';\n\n constructor(private readonly dbClient: Knex<any, any[]>) {}\n\n /**\n * Insert multiple metric values\n */\n async createMetricValues(metricValues: DbMetricValueCreate[]): Promise<void> {\n if (metricValues.length === 0) {\n return;\n }\n await this.dbClient(this.tableName).insert(metricValues);\n }\n\n /**\n * Get the latest metric values for a specific entity and metrics\n */\n async readLatestEntityMetricValues(\n catalog_entity_ref: string,\n metric_ids: string[],\n ): Promise<DbMetricValue[]> {\n return await this.dbClient(this.tableName)\n .select('*')\n .whereIn(\n 'id',\n this.dbClient(this.tableName)\n .max('id')\n .whereIn('metric_id', metric_ids)\n .where('catalog_entity_ref', catalog_entity_ref)\n .groupBy('metric_id'),\n );\n }\n\n /**\n * Delete metric values that are older than the given date\n */\n async cleanupExpiredMetrics(olderThan: Date): Promise<number> {\n return await this.dbClient(this.tableName)\n .where('timestamp', '<', olderThan)\n .del();\n }\n\n /**\n * Get aggregated metrics by status for multiple entities and metrics.\n */\n async readAggregatedMetricByEntityRefs(\n catalog_entity_refs: string[],\n metric_id: string,\n ): Promise<DbAggregatedMetric | undefined> {\n const latestIdsSubquery = this.dbClient(this.tableName)\n .max('id')\n .where('metric_id', metric_id)\n .whereIn('catalog_entity_ref', catalog_entity_refs)\n .groupBy('catalog_entity_ref');\n\n const statusRows = await this.dbClient(this.tableName)\n .select('status')\n .count('* as count')\n .max('timestamp as max_timestamp')\n .whereIn('id', latestIdsSubquery)\n .whereNotNull('status')\n .whereNotNull('value')\n .groupBy('status');\n\n if (!statusRows || statusRows.length === 0) {\n return undefined;\n }\n\n // Normalize types for cross-database compatibility\n // PostgreSQL returns COUNT/SUM as strings, SQLite returns numbers\n // PostgreSQL returns MAX(timestamp) as Date, SQLite returns number (milliseconds)\n const normalizeTimestamp = (timestamp: any): Date => {\n if (timestamp instanceof Date) {\n return timestamp;\n } else if (\n typeof timestamp === 'number' ||\n typeof timestamp === 'string'\n ) {\n return new Date(timestamp);\n }\n return new Date();\n };\n\n let maxTimestamp = new Date(0);\n let total = 0;\n const statusCounts: Record<string, number> = {};\n for (const row of statusRows) {\n const rowTimestamp = normalizeTimestamp(row.max_timestamp);\n if (rowTimestamp > maxTimestamp) {\n maxTimestamp = rowTimestamp;\n }\n const name = row.status as string;\n const count = Number(row.count);\n statusCounts[name] = count;\n total += count;\n }\n\n return {\n metric_id,\n total,\n max_timestamp: maxTimestamp,\n statusCounts,\n };\n }\n\n /**\n * Fetch the latest entity metric values for a given metric, with optional filtering\n * by status, name, kind, namespace, or owner, plus sorting and pagination.\n */\n async readEntityMetricsWithFilters(\n metric_id: string,\n options: ReadEntityMetricsWithFiltersOptions,\n ): Promise<DbMetricValue[]> {\n const clientName: string =\n (this.dbClient as any).client?.config?.client ?? '';\n const isPostgres = clientName === 'pg' || clientName.includes('postgres');\n\n const latestIdsSubquery = this.dbClient(this.tableName)\n .max('id')\n .where('metric_id', metric_id)\n .groupBy('catalog_entity_ref');\n\n const query = this.dbClient(this.tableName)\n .select('*')\n .whereIn('id', latestIdsSubquery);\n\n const sortColumnMap: Record<string, string> = {\n entityName: 'catalog_entity_ref',\n owner: 'entity_owner',\n entityKind: 'entity_kind',\n timestamp: 'timestamp',\n metricValue: 'value',\n namespace: 'entity_namespace',\n status: 'status',\n };\n\n const column =\n (options.sortBy && sortColumnMap[options.sortBy]) ?? 'timestamp';\n const direction = options.sortOrder === 'asc' ? 'asc' : 'desc';\n\n this.applySort(query, options.sortBy, column, direction, isPostgres);\n\n if (options.status) {\n query.where('status', options.status);\n }\n\n if (options.entityName) {\n const escaped = options.entityName.replace(/[%_\\\\]/g, '\\\\$&');\n query.whereRaw(\"catalog_entity_ref LIKE ? ESCAPE '\\\\'\", [`%${escaped}%`]);\n }\n\n if (options.entityKind) {\n query.where('entity_kind', options.entityKind);\n }\n\n if (options.entityNamespace) {\n query.where('entity_namespace', options.entityNamespace);\n }\n\n if (options.entityOwner && options.entityOwner.length > 0) {\n query.whereIn('entity_owner', options.entityOwner);\n }\n\n if (options.pagination) {\n query.limit(options.pagination.limit).offset(options.pagination.offset);\n }\n\n return await query;\n }\n\n private applySort(\n query: any,\n sortBy: string | undefined,\n column: string,\n direction: string,\n isPostgres: boolean,\n ): void {\n if (sortBy === 'metricValue') {\n // value is JSON and nullable; cast for numeric sort with NULLs last\n if (isPostgres) {\n query.orderByRaw(\n `CAST(value::text AS DOUBLE PRECISION) ${direction} NULLS LAST, id ASC`,\n );\n } else {\n // SQLite: \"value IS NULL\" puts nulls last; double-cast handles JSON-stored values\n query.orderByRaw(\n `value IS NULL, CAST(CAST(value AS TEXT) AS REAL) ${direction}, id ASC`,\n );\n }\n } else if (sortBy === 'status') {\n // status is nullable; NULLs always sort last regardless of direction\n if (isPostgres) {\n query.orderByRaw(`status ${direction} NULLS LAST, id ASC`);\n } else {\n // SQLite: \"status IS NULL\" evaluates to 1 for NULLs, pushing them to the end\n query.orderByRaw(`status IS NULL, status ${direction}, id ASC`);\n }\n } else {\n query.orderBy(column, direction);\n // Ensure a stable sort when two metrics share the same primary sort value\n query.orderBy('id', 'asc');\n }\n }\n}\n"],"names":[],"mappings":";;AAyCO,MAAM,oBAAqB,CAAA;AAAA,EAGhC,YAA6B,QAA4B,EAAA;AAA5B,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AAAA;AAA6B,EAA7B,QAAA;AAAA,EAFZ,SAAY,GAAA,eAAA;AAAA;AAAA;AAAA;AAAA,EAO7B,MAAM,mBAAmB,YAAoD,EAAA;AAC3E,IAAI,IAAA,YAAA,CAAa,WAAW,CAAG,EAAA;AAC7B,MAAA;AAAA;AAEF,IAAA,MAAM,KAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CAAA,CAAE,OAAO,YAAY,CAAA;AAAA;AACzD;AAAA;AAAA;AAAA,EAKA,MAAM,4BACJ,CAAA,kBAAA,EACA,UAC0B,EAAA;AAC1B,IAAO,OAAA,MAAM,KAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CACtC,CAAA,MAAA,CAAO,GAAG,CACV,CAAA,OAAA;AAAA,MACC,IAAA;AAAA,MACA,KAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CAAA,CACzB,IAAI,IAAI,CAAA,CACR,OAAQ,CAAA,WAAA,EAAa,UAAU,CAC/B,CAAA,KAAA,CAAM,sBAAsB,kBAAkB,CAAA,CAC9C,QAAQ,WAAW;AAAA,KACxB;AAAA;AACJ;AAAA;AAAA;AAAA,EAKA,MAAM,sBAAsB,SAAkC,EAAA;AAC5D,IAAO,OAAA,MAAM,IAAK,CAAA,QAAA,CAAS,IAAK,CAAA,SAAS,CACtC,CAAA,KAAA,CAAM,WAAa,EAAA,GAAA,EAAK,SAAS,CAAA,CACjC,GAAI,EAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,MAAM,gCACJ,CAAA,mBAAA,EACA,SACyC,EAAA;AACzC,IAAA,MAAM,oBAAoB,IAAK,CAAA,QAAA,CAAS,KAAK,SAAS,CAAA,CACnD,IAAI,IAAI,CAAA,CACR,KAAM,CAAA,WAAA,EAAa,SAAS,CAC5B,CAAA,OAAA,CAAQ,sBAAsB,mBAAmB,CAAA,CACjD,QAAQ,oBAAoB,CAAA;AAE/B,IAAM,MAAA,UAAA,GAAa,MAAM,IAAA,CAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CAAA,CAClD,MAAO,CAAA,QAAQ,CACf,CAAA,KAAA,CAAM,YAAY,CAAA,CAClB,GAAI,CAAA,4BAA4B,CAChC,CAAA,OAAA,CAAQ,IAAM,EAAA,iBAAiB,CAC/B,CAAA,YAAA,CAAa,QAAQ,CAAA,CACrB,YAAa,CAAA,OAAO,CACpB,CAAA,OAAA,CAAQ,QAAQ,CAAA;AAEnB,IAAA,IAAI,CAAC,UAAA,IAAc,UAAW,CAAA,MAAA,KAAW,CAAG,EAAA;AAC1C,MAAO,OAAA,MAAA;AAAA;AAMT,IAAM,MAAA,kBAAA,GAAqB,CAAC,SAAyB,KAAA;AACnD,MAAA,IAAI,qBAAqB,IAAM,EAAA;AAC7B,QAAO,OAAA,SAAA;AAAA,iBAEP,OAAO,SAAA,KAAc,QACrB,IAAA,OAAO,cAAc,QACrB,EAAA;AACA,QAAO,OAAA,IAAI,KAAK,SAAS,CAAA;AAAA;AAE3B,MAAA,2BAAW,IAAK,EAAA;AAAA,KAClB;AAEA,IAAI,IAAA,YAAA,mBAAmB,IAAA,IAAA,CAAK,CAAC,CAAA;AAC7B,IAAA,IAAI,KAAQ,GAAA,CAAA;AACZ,IAAA,MAAM,eAAuC,EAAC;AAC9C,IAAA,KAAA,MAAW,OAAO,UAAY,EAAA;AAC5B,MAAM,MAAA,YAAA,GAAe,kBAAmB,CAAA,GAAA,CAAI,aAAa,CAAA;AACzD,MAAA,IAAI,eAAe,YAAc,EAAA;AAC/B,QAAe,YAAA,GAAA,YAAA;AAAA;AAEjB,MAAA,MAAM,OAAO,GAAI,CAAA,MAAA;AACjB,MAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,GAAA,CAAI,KAAK,CAAA;AAC9B,MAAA,YAAA,CAAa,IAAI,CAAI,GAAA,KAAA;AACrB,MAAS,KAAA,IAAA,KAAA;AAAA;AAGX,IAAO,OAAA;AAAA,MACL,SAAA;AAAA,MACA,KAAA;AAAA,MACA,aAAe,EAAA,YAAA;AAAA,MACf;AAAA,KACF;AAAA;AACF;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,4BACJ,CAAA,SAAA,EACA,OAC0B,EAAA;AAC1B,IAAA,MAAM,UACH,GAAA,IAAA,CAAK,QAAiB,CAAA,MAAA,EAAQ,QAAQ,MAAU,IAAA,EAAA;AACnD,IAAA,MAAM,UAAa,GAAA,UAAA,KAAe,IAAQ,IAAA,UAAA,CAAW,SAAS,UAAU,CAAA;AAExE,IAAA,MAAM,iBAAoB,GAAA,IAAA,CAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CACnD,CAAA,GAAA,CAAI,IAAI,CAAA,CACR,KAAM,CAAA,WAAA,EAAa,SAAS,CAAA,CAC5B,QAAQ,oBAAoB,CAAA;AAE/B,IAAM,MAAA,KAAA,GAAQ,IAAK,CAAA,QAAA,CAAS,IAAK,CAAA,SAAS,CACvC,CAAA,MAAA,CAAO,GAAG,CAAA,CACV,OAAQ,CAAA,IAAA,EAAM,iBAAiB,CAAA;AAElC,IAAA,MAAM,aAAwC,GAAA;AAAA,MAC5C,UAAY,EAAA,oBAAA;AAAA,MACZ,KAAO,EAAA,cAAA;AAAA,MACP,UAAY,EAAA,aAAA;AAAA,MACZ,SAAW,EAAA,WAAA;AAAA,MACX,WAAa,EAAA,OAAA;AAAA,MACb,SAAW,EAAA,kBAAA;AAAA,MACX,MAAQ,EAAA;AAAA,KACV;AAEA,IAAA,MAAM,UACH,OAAQ,CAAA,MAAA,IAAU,aAAc,CAAA,OAAA,CAAQ,MAAM,CAAM,KAAA,WAAA;AACvD,IAAA,MAAM,SAAY,GAAA,OAAA,CAAQ,SAAc,KAAA,KAAA,GAAQ,KAAQ,GAAA,MAAA;AAExD,IAAA,IAAA,CAAK,UAAU,KAAO,EAAA,OAAA,CAAQ,MAAQ,EAAA,MAAA,EAAQ,WAAW,UAAU,CAAA;AAEnE,IAAA,IAAI,QAAQ,MAAQ,EAAA;AAClB,MAAM,KAAA,CAAA,KAAA,CAAM,QAAU,EAAA,OAAA,CAAQ,MAAM,CAAA;AAAA;AAGtC,IAAA,IAAI,QAAQ,UAAY,EAAA;AACtB,MAAA,MAAM,OAAU,GAAA,OAAA,CAAQ,UAAW,CAAA,OAAA,CAAQ,WAAW,MAAM,CAAA;AAC5D,MAAA,KAAA,CAAM,SAAS,uCAAyC,EAAA,CAAC,CAAI,CAAA,EAAA,OAAO,GAAG,CAAC,CAAA;AAAA;AAG1E,IAAA,IAAI,QAAQ,UAAY,EAAA;AACtB,MAAM,KAAA,CAAA,KAAA,CAAM,aAAe,EAAA,OAAA,CAAQ,UAAU,CAAA;AAAA;AAG/C,IAAA,IAAI,QAAQ,eAAiB,EAAA;AAC3B,MAAM,KAAA,CAAA,KAAA,CAAM,kBAAoB,EAAA,OAAA,CAAQ,eAAe,CAAA;AAAA;AAGzD,IAAA,IAAI,OAAQ,CAAA,WAAA,IAAe,OAAQ,CAAA,WAAA,CAAY,SAAS,CAAG,EAAA;AACzD,MAAM,KAAA,CAAA,OAAA,CAAQ,cAAgB,EAAA,OAAA,CAAQ,WAAW,CAAA;AAAA;AAGnD,IAAA,IAAI,QAAQ,UAAY,EAAA;AACtB,MAAM,KAAA,CAAA,KAAA,CAAM,QAAQ,UAAW,CAAA,KAAK,EAAE,MAAO,CAAA,OAAA,CAAQ,WAAW,MAAM,CAAA;AAAA;AAGxE,IAAA,OAAO,MAAM,KAAA;AAAA;AACf,EAEQ,SACN,CAAA,KAAA,EACA,MACA,EAAA,MAAA,EACA,WACA,UACM,EAAA;AACN,IAAA,IAAI,WAAW,aAAe,EAAA;AAE5B,MAAA,IAAI,UAAY,EAAA;AACd,QAAM,KAAA,CAAA,UAAA;AAAA,UACJ,yCAAyC,SAAS,CAAA,mBAAA;AAAA,SACpD;AAAA,OACK,MAAA;AAEL,QAAM,KAAA,CAAA,UAAA;AAAA,UACJ,oDAAoD,SAAS,CAAA,QAAA;AAAA,SAC/D;AAAA;AACF,KACF,MAAA,IAAW,WAAW,QAAU,EAAA;AAE9B,MAAA,IAAI,UAAY,EAAA;AACd,QAAM,KAAA,CAAA,UAAA,CAAW,CAAU,OAAA,EAAA,SAAS,CAAqB,mBAAA,CAAA,CAAA;AAAA,OACpD,MAAA;AAEL,QAAM,KAAA,CAAA,UAAA,CAAW,CAA0B,uBAAA,EAAA,SAAS,CAAU,QAAA,CAAA,CAAA;AAAA;AAChE,KACK,MAAA;AACL,MAAM,KAAA,CAAA,OAAA,CAAQ,QAAQ,SAAS,CAAA;AAE/B,MAAM,KAAA,CAAA,OAAA,CAAQ,MAAM,KAAK,CAAA;AAAA;AAC3B;AAEJ;;;;"}
|
|
1
|
+
{"version":3,"file":"DatabaseMetricValues.cjs.js","sources":["../../src/database/DatabaseMetricValues.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Knex } from 'knex';\nimport {\n DbMetricValueCreate,\n DbMetricValue,\n DbAggregatedMetric,\n} from './types';\n\ntype ReadEntityMetricsWithFiltersOptions = {\n status?: string;\n entityName?: string;\n entityKind?: string;\n entityNamespace?: string;\n entityOwner?: string[];\n sortBy?:\n | 'entityName'\n | 'owner'\n | 'entityKind'\n | 'timestamp'\n | 'metricValue'\n | 'namespace'\n | 'status';\n sortOrder?: 'asc' | 'desc';\n pagination?: { limit: number; offset: number };\n};\n\nexport class DatabaseMetricValues {\n private readonly tableName = 'metric_values';\n\n constructor(private readonly dbClient: Knex<any, any[]>) {}\n\n /**\n * Insert multiple metric values\n */\n async createMetricValues(metricValues: DbMetricValueCreate[]): Promise<void> {\n if (metricValues.length === 0) {\n return;\n }\n await this.dbClient(this.tableName).insert(metricValues);\n }\n\n /**\n * Get the latest metric values for a specific entity and metrics\n */\n async readLatestEntityMetricValues(\n catalog_entity_ref: string,\n metric_ids: string[],\n ): Promise<DbMetricValue[]> {\n return await this.dbClient(this.tableName)\n .select('*')\n .whereIn(\n 'id',\n this.dbClient(this.tableName)\n .max('id')\n .whereIn('metric_id', metric_ids)\n .where('catalog_entity_ref', catalog_entity_ref)\n .groupBy('metric_id'),\n );\n }\n\n /**\n * Delete metric values that are older than the given date\n */\n async cleanupExpiredMetrics(olderThan: Date): Promise<number> {\n return await this.dbClient(this.tableName)\n .where('timestamp', '<', olderThan)\n .del();\n }\n\n /**\n * Get aggregated metrics by status for multiple entities and metrics.\n */\n async readAggregatedMetricByEntityRefs(\n catalog_entity_refs: string[],\n metric_id: string,\n ): Promise<DbAggregatedMetric | undefined> {\n if (catalog_entity_refs.length === 0) {\n return undefined;\n }\n\n const latestIdsSubquery = this.dbClient(this.tableName)\n .max('id')\n .where('metric_id', metric_id)\n .whereIn('catalog_entity_ref', catalog_entity_refs)\n .groupBy('catalog_entity_ref');\n\n // `value` is a JSON column. Depending on database/driver, a \"missing\" metric value can\n // arrive either as SQL NULL or as JSON literal null (`CAST(value AS TEXT) = 'null'`).\n const metricValueIsMissingExpr =\n \"(value IS NULL OR CAST(value AS TEXT) = 'null')\";\n\n // One round-trip for latest-row count, calculation-error count, and max timestamp\n // (same latest-id set as the status breakdown query below).\n const statsRow = await this.dbClient(this.tableName)\n .whereIn('id', latestIdsSubquery)\n .select(\n this.dbClient.raw('COUNT(*) as latest_row_count'),\n this.dbClient.raw(\n `SUM(CASE WHEN error_message IS NOT NULL AND ${metricValueIsMissingExpr} THEN 1 ELSE 0 END) as calculation_error_count`,\n ),\n this.dbClient.raw('MAX(timestamp) as max_timestamp'),\n )\n .first();\n\n const latestRowCount = Number(\n (statsRow as { latest_row_count?: string | number } | undefined)\n ?.latest_row_count ?? 0,\n );\n if (latestRowCount === 0) {\n return undefined;\n }\n\n const calculation_error_count = Number(\n (statsRow as { calculation_error_count?: string | number } | undefined)\n ?.calculation_error_count ?? 0,\n );\n\n // Normalize types for cross-database compatibility\n // PostgreSQL returns COUNT/SUM as strings, SQLite returns numbers\n // PostgreSQL returns MAX(timestamp) as Date, SQLite returns number (milliseconds)\n const normalizeTimestamp = (timestamp: unknown): Date => {\n if (timestamp instanceof Date) {\n return timestamp;\n }\n if (typeof timestamp === 'number' || typeof timestamp === 'string') {\n return new Date(timestamp);\n }\n return new Date();\n };\n\n const maxTimestampAllLatest = normalizeTimestamp(\n (statsRow as { max_timestamp?: unknown })?.max_timestamp,\n );\n\n const statusRows = await this.dbClient(this.tableName)\n .select('status')\n .count('* as count')\n .max('timestamp as max_timestamp')\n .whereIn('id', latestIdsSubquery)\n .whereNotNull('status')\n .whereRaw(`NOT ${metricValueIsMissingExpr}`)\n .groupBy('status');\n\n if (!statusRows || statusRows.length === 0) {\n return {\n metric_id,\n total: 0,\n max_timestamp: maxTimestampAllLatest,\n statusCounts: {},\n calculation_error_count,\n latest_entity_count: latestRowCount,\n };\n }\n\n let maxTimestamp = new Date(0);\n let total = 0;\n const statusCounts: Record<string, number> = {};\n for (const row of statusRows) {\n const rowTimestamp = normalizeTimestamp(row.max_timestamp);\n if (rowTimestamp > maxTimestamp) {\n maxTimestamp = rowTimestamp;\n }\n const name = row.status as string;\n const count = Number(row.count);\n statusCounts[name] = count;\n total += count;\n }\n\n const mergedMax =\n maxTimestampAllLatest.getTime() >= maxTimestamp.getTime()\n ? maxTimestampAllLatest\n : maxTimestamp;\n\n return {\n metric_id,\n total,\n max_timestamp: mergedMax,\n statusCounts,\n calculation_error_count,\n latest_entity_count: latestRowCount,\n };\n }\n\n /**\n * Fetch the latest entity metric values for a given metric, with optional filtering\n * by status, name, kind, namespace, or owner, plus sorting and pagination.\n */\n async readEntityMetricsWithFilters(\n metric_id: string,\n options: ReadEntityMetricsWithFiltersOptions,\n ): Promise<DbMetricValue[]> {\n const clientName: string =\n (this.dbClient as any).client?.config?.client ?? '';\n const isPostgres = clientName === 'pg' || clientName.includes('postgres');\n\n const latestIdsSubquery = this.dbClient(this.tableName)\n .max('id')\n .where('metric_id', metric_id)\n .groupBy('catalog_entity_ref');\n\n const query = this.dbClient(this.tableName)\n .select('*')\n .whereIn('id', latestIdsSubquery);\n\n const sortColumnMap: Record<string, string> = {\n entityName: 'catalog_entity_ref',\n owner: 'entity_owner',\n entityKind: 'entity_kind',\n timestamp: 'timestamp',\n metricValue: 'value',\n namespace: 'entity_namespace',\n status: 'status',\n };\n\n const column =\n (options.sortBy && sortColumnMap[options.sortBy]) ?? 'timestamp';\n const direction = options.sortOrder === 'asc' ? 'asc' : 'desc';\n\n this.applySort(query, options.sortBy, column, direction, isPostgres);\n\n if (options.status) {\n query.where('status', options.status);\n }\n\n if (options.entityName) {\n const escaped = options.entityName.replace(/[%_\\\\]/g, '\\\\$&');\n query.whereRaw(\"catalog_entity_ref LIKE ? ESCAPE '\\\\'\", [`%${escaped}%`]);\n }\n\n if (options.entityKind) {\n query.where('entity_kind', options.entityKind);\n }\n\n if (options.entityNamespace) {\n query.where('entity_namespace', options.entityNamespace);\n }\n\n if (options.entityOwner && options.entityOwner.length > 0) {\n query.whereIn('entity_owner', options.entityOwner);\n }\n\n if (options.pagination) {\n query.limit(options.pagination.limit).offset(options.pagination.offset);\n }\n\n return await query;\n }\n\n private applySort(\n query: any,\n sortBy: string | undefined,\n column: string,\n direction: string,\n isPostgres: boolean,\n ): void {\n if (sortBy === 'metricValue') {\n // value is JSON and nullable; cast for numeric sort with NULLs last\n if (isPostgres) {\n query.orderByRaw(\n `CAST(value::text AS DOUBLE PRECISION) ${direction} NULLS LAST, id ASC`,\n );\n } else {\n // SQLite: \"value IS NULL\" puts nulls last; double-cast handles JSON-stored values\n query.orderByRaw(\n `value IS NULL, CAST(CAST(value AS TEXT) AS REAL) ${direction}, id ASC`,\n );\n }\n } else if (sortBy === 'status') {\n // status is nullable; NULLs always sort last regardless of direction\n if (isPostgres) {\n query.orderByRaw(`status ${direction} NULLS LAST, id ASC`);\n } else {\n // SQLite: \"status IS NULL\" evaluates to 1 for NULLs, pushing them to the end\n query.orderByRaw(`status IS NULL, status ${direction}, id ASC`);\n }\n } else {\n query.orderBy(column, direction);\n // Ensure a stable sort when two metrics share the same primary sort value\n query.orderBy('id', 'asc');\n }\n }\n}\n"],"names":[],"mappings":";;AAyCO,MAAM,oBAAqB,CAAA;AAAA,EAGhC,YAA6B,QAA4B,EAAA;AAA5B,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AAAA;AAA6B,EAA7B,QAAA;AAAA,EAFZ,SAAY,GAAA,eAAA;AAAA;AAAA;AAAA;AAAA,EAO7B,MAAM,mBAAmB,YAAoD,EAAA;AAC3E,IAAI,IAAA,YAAA,CAAa,WAAW,CAAG,EAAA;AAC7B,MAAA;AAAA;AAEF,IAAA,MAAM,KAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CAAA,CAAE,OAAO,YAAY,CAAA;AAAA;AACzD;AAAA;AAAA;AAAA,EAKA,MAAM,4BACJ,CAAA,kBAAA,EACA,UAC0B,EAAA;AAC1B,IAAO,OAAA,MAAM,KAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CACtC,CAAA,MAAA,CAAO,GAAG,CACV,CAAA,OAAA;AAAA,MACC,IAAA;AAAA,MACA,KAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CAAA,CACzB,IAAI,IAAI,CAAA,CACR,OAAQ,CAAA,WAAA,EAAa,UAAU,CAC/B,CAAA,KAAA,CAAM,sBAAsB,kBAAkB,CAAA,CAC9C,QAAQ,WAAW;AAAA,KACxB;AAAA;AACJ;AAAA;AAAA;AAAA,EAKA,MAAM,sBAAsB,SAAkC,EAAA;AAC5D,IAAO,OAAA,MAAM,IAAK,CAAA,QAAA,CAAS,IAAK,CAAA,SAAS,CACtC,CAAA,KAAA,CAAM,WAAa,EAAA,GAAA,EAAK,SAAS,CAAA,CACjC,GAAI,EAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,MAAM,gCACJ,CAAA,mBAAA,EACA,SACyC,EAAA;AACzC,IAAI,IAAA,mBAAA,CAAoB,WAAW,CAAG,EAAA;AACpC,MAAO,OAAA,MAAA;AAAA;AAGT,IAAA,MAAM,oBAAoB,IAAK,CAAA,QAAA,CAAS,KAAK,SAAS,CAAA,CACnD,IAAI,IAAI,CAAA,CACR,KAAM,CAAA,WAAA,EAAa,SAAS,CAC5B,CAAA,OAAA,CAAQ,sBAAsB,mBAAmB,CAAA,CACjD,QAAQ,oBAAoB,CAAA;AAI/B,IAAA,MAAM,wBACJ,GAAA,iDAAA;AAIF,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CAChD,CAAA,OAAA,CAAQ,IAAM,EAAA,iBAAiB,CAC/B,CAAA,MAAA;AAAA,MACC,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,8BAA8B,CAAA;AAAA,MAChD,KAAK,QAAS,CAAA,GAAA;AAAA,QACZ,+CAA+C,wBAAwB,CAAA,8CAAA;AAAA,OACzE;AAAA,MACA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,iCAAiC;AAAA,MAEpD,KAAM,EAAA;AAET,IAAA,MAAM,cAAiB,GAAA,MAAA;AAAA,MACpB,UACG,gBAAoB,IAAA;AAAA,KAC1B;AACA,IAAA,IAAI,mBAAmB,CAAG,EAAA;AACxB,MAAO,OAAA,MAAA;AAAA;AAGT,IAAA,MAAM,uBAA0B,GAAA,MAAA;AAAA,MAC7B,UACG,uBAA2B,IAAA;AAAA,KACjC;AAKA,IAAM,MAAA,kBAAA,GAAqB,CAAC,SAA6B,KAAA;AACvD,MAAA,IAAI,qBAAqB,IAAM,EAAA;AAC7B,QAAO,OAAA,SAAA;AAAA;AAET,MAAA,IAAI,OAAO,SAAA,KAAc,QAAY,IAAA,OAAO,cAAc,QAAU,EAAA;AAClE,QAAO,OAAA,IAAI,KAAK,SAAS,CAAA;AAAA;AAE3B,MAAA,2BAAW,IAAK,EAAA;AAAA,KAClB;AAEA,IAAA,MAAM,qBAAwB,GAAA,kBAAA;AAAA,MAC3B,QAA0C,EAAA;AAAA,KAC7C;AAEA,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,QAAA,CAAS,IAAK,CAAA,SAAS,CAClD,CAAA,MAAA,CAAO,QAAQ,CAAA,CACf,KAAM,CAAA,YAAY,CAClB,CAAA,GAAA,CAAI,4BAA4B,CAAA,CAChC,OAAQ,CAAA,IAAA,EAAM,iBAAiB,CAAA,CAC/B,YAAa,CAAA,QAAQ,CACrB,CAAA,QAAA,CAAS,CAAO,IAAA,EAAA,wBAAwB,CAAE,CAAA,CAAA,CAC1C,QAAQ,QAAQ,CAAA;AAEnB,IAAA,IAAI,CAAC,UAAA,IAAc,UAAW,CAAA,MAAA,KAAW,CAAG,EAAA;AAC1C,MAAO,OAAA;AAAA,QACL,SAAA;AAAA,QACA,KAAO,EAAA,CAAA;AAAA,QACP,aAAe,EAAA,qBAAA;AAAA,QACf,cAAc,EAAC;AAAA,QACf,uBAAA;AAAA,QACA,mBAAqB,EAAA;AAAA,OACvB;AAAA;AAGF,IAAI,IAAA,YAAA,mBAAmB,IAAA,IAAA,CAAK,CAAC,CAAA;AAC7B,IAAA,IAAI,KAAQ,GAAA,CAAA;AACZ,IAAA,MAAM,eAAuC,EAAC;AAC9C,IAAA,KAAA,MAAW,OAAO,UAAY,EAAA;AAC5B,MAAM,MAAA,YAAA,GAAe,kBAAmB,CAAA,GAAA,CAAI,aAAa,CAAA;AACzD,MAAA,IAAI,eAAe,YAAc,EAAA;AAC/B,QAAe,YAAA,GAAA,YAAA;AAAA;AAEjB,MAAA,MAAM,OAAO,GAAI,CAAA,MAAA;AACjB,MAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,GAAA,CAAI,KAAK,CAAA;AAC9B,MAAA,YAAA,CAAa,IAAI,CAAI,GAAA,KAAA;AACrB,MAAS,KAAA,IAAA,KAAA;AAAA;AAGX,IAAA,MAAM,YACJ,qBAAsB,CAAA,OAAA,MAAa,YAAa,CAAA,OAAA,KAC5C,qBACA,GAAA,YAAA;AAEN,IAAO,OAAA;AAAA,MACL,SAAA;AAAA,MACA,KAAA;AAAA,MACA,aAAe,EAAA,SAAA;AAAA,MACf,YAAA;AAAA,MACA,uBAAA;AAAA,MACA,mBAAqB,EAAA;AAAA,KACvB;AAAA;AACF;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,4BACJ,CAAA,SAAA,EACA,OAC0B,EAAA;AAC1B,IAAA,MAAM,UACH,GAAA,IAAA,CAAK,QAAiB,CAAA,MAAA,EAAQ,QAAQ,MAAU,IAAA,EAAA;AACnD,IAAA,MAAM,UAAa,GAAA,UAAA,KAAe,IAAQ,IAAA,UAAA,CAAW,SAAS,UAAU,CAAA;AAExE,IAAA,MAAM,iBAAoB,GAAA,IAAA,CAAK,QAAS,CAAA,IAAA,CAAK,SAAS,CACnD,CAAA,GAAA,CAAI,IAAI,CAAA,CACR,KAAM,CAAA,WAAA,EAAa,SAAS,CAAA,CAC5B,QAAQ,oBAAoB,CAAA;AAE/B,IAAM,MAAA,KAAA,GAAQ,IAAK,CAAA,QAAA,CAAS,IAAK,CAAA,SAAS,CACvC,CAAA,MAAA,CAAO,GAAG,CAAA,CACV,OAAQ,CAAA,IAAA,EAAM,iBAAiB,CAAA;AAElC,IAAA,MAAM,aAAwC,GAAA;AAAA,MAC5C,UAAY,EAAA,oBAAA;AAAA,MACZ,KAAO,EAAA,cAAA;AAAA,MACP,UAAY,EAAA,aAAA;AAAA,MACZ,SAAW,EAAA,WAAA;AAAA,MACX,WAAa,EAAA,OAAA;AAAA,MACb,SAAW,EAAA,kBAAA;AAAA,MACX,MAAQ,EAAA;AAAA,KACV;AAEA,IAAA,MAAM,UACH,OAAQ,CAAA,MAAA,IAAU,aAAc,CAAA,OAAA,CAAQ,MAAM,CAAM,KAAA,WAAA;AACvD,IAAA,MAAM,SAAY,GAAA,OAAA,CAAQ,SAAc,KAAA,KAAA,GAAQ,KAAQ,GAAA,MAAA;AAExD,IAAA,IAAA,CAAK,UAAU,KAAO,EAAA,OAAA,CAAQ,MAAQ,EAAA,MAAA,EAAQ,WAAW,UAAU,CAAA;AAEnE,IAAA,IAAI,QAAQ,MAAQ,EAAA;AAClB,MAAM,KAAA,CAAA,KAAA,CAAM,QAAU,EAAA,OAAA,CAAQ,MAAM,CAAA;AAAA;AAGtC,IAAA,IAAI,QAAQ,UAAY,EAAA;AACtB,MAAA,MAAM,OAAU,GAAA,OAAA,CAAQ,UAAW,CAAA,OAAA,CAAQ,WAAW,MAAM,CAAA;AAC5D,MAAA,KAAA,CAAM,SAAS,uCAAyC,EAAA,CAAC,CAAI,CAAA,EAAA,OAAO,GAAG,CAAC,CAAA;AAAA;AAG1E,IAAA,IAAI,QAAQ,UAAY,EAAA;AACtB,MAAM,KAAA,CAAA,KAAA,CAAM,aAAe,EAAA,OAAA,CAAQ,UAAU,CAAA;AAAA;AAG/C,IAAA,IAAI,QAAQ,eAAiB,EAAA;AAC3B,MAAM,KAAA,CAAA,KAAA,CAAM,kBAAoB,EAAA,OAAA,CAAQ,eAAe,CAAA;AAAA;AAGzD,IAAA,IAAI,OAAQ,CAAA,WAAA,IAAe,OAAQ,CAAA,WAAA,CAAY,SAAS,CAAG,EAAA;AACzD,MAAM,KAAA,CAAA,OAAA,CAAQ,cAAgB,EAAA,OAAA,CAAQ,WAAW,CAAA;AAAA;AAGnD,IAAA,IAAI,QAAQ,UAAY,EAAA;AACtB,MAAM,KAAA,CAAA,KAAA,CAAM,QAAQ,UAAW,CAAA,KAAK,EAAE,MAAO,CAAA,OAAA,CAAQ,WAAW,MAAM,CAAA;AAAA;AAGxE,IAAA,OAAO,MAAM,KAAA;AAAA;AACf,EAEQ,SACN,CAAA,KAAA,EACA,MACA,EAAA,MAAA,EACA,WACA,UACM,EAAA;AACN,IAAA,IAAI,WAAW,aAAe,EAAA;AAE5B,MAAA,IAAI,UAAY,EAAA;AACd,QAAM,KAAA,CAAA,UAAA;AAAA,UACJ,yCAAyC,SAAS,CAAA,mBAAA;AAAA,SACpD;AAAA,OACK,MAAA;AAEL,QAAM,KAAA,CAAA,UAAA;AAAA,UACJ,oDAAoD,SAAS,CAAA,QAAA;AAAA,SAC/D;AAAA;AACF,KACF,MAAA,IAAW,WAAW,QAAU,EAAA;AAE9B,MAAA,IAAI,UAAY,EAAA;AACd,QAAM,KAAA,CAAA,UAAA,CAAW,CAAU,OAAA,EAAA,SAAS,CAAqB,mBAAA,CAAA,CAAA;AAAA,OACpD,MAAA;AAEL,QAAM,KAAA,CAAA,UAAA,CAAW,CAA0B,uBAAA,EAAA,SAAS,CAAU,QAAA,CAAA,CAAA;AAAA;AAChE,KACK,MAAA;AACL,MAAM,KAAA,CAAA,OAAA,CAAQ,QAAQ,SAAS,CAAA;AAE/B,MAAM,KAAA,CAAA,OAAA,CAAQ,MAAM,KAAK,CAAA;AAAA;AAC3B;AAEJ;;;;"}
|
package/dist/plugin.cjs.js
CHANGED
|
@@ -13,6 +13,7 @@ var migration = require('./database/migration.cjs.js');
|
|
|
13
13
|
var DatabaseMetricValues = require('./database/DatabaseMetricValues.cjs.js');
|
|
14
14
|
var index = require('./scheduler/index.cjs.js');
|
|
15
15
|
var validateAggregationConfig = require('./validation/validateAggregationConfig.cjs.js');
|
|
16
|
+
var AggregationService = require('./service/aggregations/AggregationService.cjs.js');
|
|
16
17
|
|
|
17
18
|
const scorecardPlugin = backendPluginApi.createBackendPlugin({
|
|
18
19
|
pluginId: "scorecard",
|
|
@@ -66,8 +67,12 @@ const scorecardPlugin = backendPluginApi.createBackendPlugin({
|
|
|
66
67
|
auth,
|
|
67
68
|
registry: metricProvidersRegistry,
|
|
68
69
|
database: dbMetricValues,
|
|
69
|
-
logger
|
|
70
|
-
|
|
70
|
+
logger
|
|
71
|
+
});
|
|
72
|
+
const aggregationsService = new AggregationService.AggregationsService({
|
|
73
|
+
config,
|
|
74
|
+
database: dbMetricValues,
|
|
75
|
+
logger
|
|
71
76
|
});
|
|
72
77
|
validateAggregationConfig.validateAggregationConfig({
|
|
73
78
|
rootConfig: config,
|
|
@@ -83,10 +88,14 @@ const scorecardPlugin = backendPluginApi.createBackendPlugin({
|
|
|
83
88
|
metricProvidersRegistry,
|
|
84
89
|
thresholdEvaluator: new ThresholdEvaluator.ThresholdEvaluator()
|
|
85
90
|
}).start();
|
|
91
|
+
const service = {
|
|
92
|
+
aggregationsService,
|
|
93
|
+
catalogMetricService
|
|
94
|
+
};
|
|
86
95
|
httpRouter.use(
|
|
87
96
|
await router.createRouter({
|
|
88
97
|
metricProvidersRegistry,
|
|
89
|
-
|
|
98
|
+
service,
|
|
90
99
|
catalog,
|
|
91
100
|
httpAuth,
|
|
92
101
|
permissions,
|
package/dist/plugin.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport {\n MetricProvider,\n scorecardMetricsExtensionPoint,\n} from '@red-hat-developer-hub/backstage-plugin-scorecard-node';\nimport { MetricProvidersRegistry } from './providers/MetricProvidersRegistry';\nimport { CatalogMetricService } from './service/CatalogMetricService';\nimport { ThresholdEvaluator } from './threshold/ThresholdEvaluator';\nimport { scorecardPermissions } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';\nimport {\n scorecardMetricPermissionResourceRef,\n rules as scorecardRules,\n} from './permissions/rules';\nimport { migrate } from './database/migration';\nimport { DatabaseMetricValues } from './database/DatabaseMetricValues';\nimport { Scheduler } from './scheduler';\nimport { validateAggregationConfig } from './validation/validateAggregationConfig';\n\n/**\n * scorecardPlugin backend plugin\n *\n * @public\n */\nexport const scorecardPlugin = createBackendPlugin({\n pluginId: 'scorecard',\n register(env) {\n const metricProvidersRegistry = new MetricProvidersRegistry();\n\n env.registerExtensionPoint(scorecardMetricsExtensionPoint, {\n addMetricProvider(...newMetricProviders: MetricProvider[]) {\n newMetricProviders.forEach(metricProvider => {\n metricProvidersRegistry.register(metricProvider);\n });\n },\n });\n\n env.registerInit({\n deps: {\n auth: coreServices.auth,\n catalog: catalogServiceRef,\n config: coreServices.rootConfig,\n database: coreServices.database,\n httpRouter: coreServices.httpRouter,\n httpAuth: coreServices.httpAuth,\n logger: coreServices.logger,\n permissions: coreServices.permissions,\n permissionsRegistry: coreServices.permissionsRegistry,\n scheduler: coreServices.scheduler,\n },\n async init({\n auth,\n catalog,\n config,\n database,\n httpRouter,\n httpAuth,\n logger,\n permissions,\n permissionsRegistry,\n scheduler,\n }) {\n permissionsRegistry.addResourceType({\n resourceRef: scorecardMetricPermissionResourceRef,\n getResources: async (resourceRefs: string[]) => {\n return metricProvidersRegistry.listMetrics(resourceRefs);\n },\n permissions: scorecardPermissions,\n rules: Object.values(scorecardRules),\n });\n\n // Run database migrations\n await migrate(database);\n\n const client = await database.getClient();\n const dbMetricValues = new DatabaseMetricValues(client);\n\n const catalogMetricService = new CatalogMetricService({\n catalog,\n auth,\n registry: metricProvidersRegistry,\n database: dbMetricValues,\n logger: logger,\n config,\n });\n\n validateAggregationConfig({\n rootConfig: config,\n registry: metricProvidersRegistry,\n });\n\n Scheduler.create({\n auth,\n catalog,\n config,\n logger,\n scheduler,\n database: dbMetricValues,\n metricProvidersRegistry,\n thresholdEvaluator: new ThresholdEvaluator(),\n }).start();\n\n httpRouter.use(\n await createRouter({\n metricProvidersRegistry,\n
|
|
1
|
+
{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport {\n MetricProvider,\n scorecardMetricsExtensionPoint,\n} from '@red-hat-developer-hub/backstage-plugin-scorecard-node';\nimport { MetricProvidersRegistry } from './providers/MetricProvidersRegistry';\nimport { CatalogMetricService } from './service/CatalogMetricService';\nimport { ThresholdEvaluator } from './threshold/ThresholdEvaluator';\nimport { scorecardPermissions } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';\nimport {\n scorecardMetricPermissionResourceRef,\n rules as scorecardRules,\n} from './permissions/rules';\nimport { migrate } from './database/migration';\nimport { DatabaseMetricValues } from './database/DatabaseMetricValues';\nimport { Scheduler } from './scheduler';\nimport { validateAggregationConfig } from './validation/validateAggregationConfig';\nimport { AggregationsService } from './service/aggregations/AggregationService';\n\n/**\n * scorecardPlugin backend plugin\n *\n * @public\n */\nexport const scorecardPlugin = createBackendPlugin({\n pluginId: 'scorecard',\n register(env) {\n const metricProvidersRegistry = new MetricProvidersRegistry();\n\n env.registerExtensionPoint(scorecardMetricsExtensionPoint, {\n addMetricProvider(...newMetricProviders: MetricProvider[]) {\n newMetricProviders.forEach(metricProvider => {\n metricProvidersRegistry.register(metricProvider);\n });\n },\n });\n\n env.registerInit({\n deps: {\n auth: coreServices.auth,\n catalog: catalogServiceRef,\n config: coreServices.rootConfig,\n database: coreServices.database,\n httpRouter: coreServices.httpRouter,\n httpAuth: coreServices.httpAuth,\n logger: coreServices.logger,\n permissions: coreServices.permissions,\n permissionsRegistry: coreServices.permissionsRegistry,\n scheduler: coreServices.scheduler,\n },\n async init({\n auth,\n catalog,\n config,\n database,\n httpRouter,\n httpAuth,\n logger,\n permissions,\n permissionsRegistry,\n scheduler,\n }) {\n permissionsRegistry.addResourceType({\n resourceRef: scorecardMetricPermissionResourceRef,\n getResources: async (resourceRefs: string[]) => {\n return metricProvidersRegistry.listMetrics(resourceRefs);\n },\n permissions: scorecardPermissions,\n rules: Object.values(scorecardRules),\n });\n\n // Run database migrations\n await migrate(database);\n\n const client = await database.getClient();\n const dbMetricValues = new DatabaseMetricValues(client);\n\n const catalogMetricService = new CatalogMetricService({\n catalog,\n auth,\n registry: metricProvidersRegistry,\n database: dbMetricValues,\n logger: logger,\n });\n\n const aggregationsService = new AggregationsService({\n config,\n database: dbMetricValues,\n logger: logger,\n });\n\n validateAggregationConfig({\n rootConfig: config,\n registry: metricProvidersRegistry,\n });\n\n Scheduler.create({\n auth,\n catalog,\n config,\n logger,\n scheduler,\n database: dbMetricValues,\n metricProvidersRegistry,\n thresholdEvaluator: new ThresholdEvaluator(),\n }).start();\n\n const service = {\n aggregationsService: aggregationsService,\n catalogMetricService: catalogMetricService,\n };\n\n httpRouter.use(\n await createRouter({\n metricProvidersRegistry,\n service,\n catalog,\n httpAuth,\n permissions,\n logger,\n }),\n );\n },\n });\n },\n});\n"],"names":["createBackendPlugin","MetricProvidersRegistry","scorecardMetricsExtensionPoint","coreServices","catalogServiceRef","scorecardMetricPermissionResourceRef","scorecardPermissions","scorecardRules","migrate","DatabaseMetricValues","CatalogMetricService","AggregationsService","validateAggregationConfig","Scheduler","ThresholdEvaluator","createRouter"],"mappings":";;;;;;;;;;;;;;;;;AA4CO,MAAM,kBAAkBA,oCAAoB,CAAA;AAAA,EACjD,QAAU,EAAA,WAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,uBAAA,GAA0B,IAAIC,+CAAwB,EAAA;AAE5D,IAAA,GAAA,CAAI,uBAAuBC,2DAAgC,EAAA;AAAA,MACzD,qBAAqB,kBAAsC,EAAA;AACzD,QAAA,kBAAA,CAAmB,QAAQ,CAAkB,cAAA,KAAA;AAC3C,UAAA,uBAAA,CAAwB,SAAS,cAAc,CAAA;AAAA,SAChD,CAAA;AAAA;AACH,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,QACnB,OAAS,EAAAC,mCAAA;AAAA,QACT,QAAQD,6BAAa,CAAA,UAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,aAAaA,6BAAa,CAAA,WAAA;AAAA,QAC1B,qBAAqBA,6BAAa,CAAA,mBAAA;AAAA,QAClC,WAAWA,6BAAa,CAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,IAAA;AAAA,QACA,OAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA;AAAA,QACA,UAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,WAAA;AAAA,QACA,mBAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAA,mBAAA,CAAoB,eAAgB,CAAA;AAAA,UAClC,WAAa,EAAAE,0CAAA;AAAA,UACb,YAAA,EAAc,OAAO,YAA2B,KAAA;AAC9C,YAAO,OAAA,uBAAA,CAAwB,YAAY,YAAY,CAAA;AAAA,WACzD;AAAA,UACA,WAAa,EAAAC,mDAAA;AAAA,UACb,KAAA,EAAO,MAAO,CAAA,MAAA,CAAOC,WAAc;AAAA,SACpC,CAAA;AAGD,QAAA,MAAMC,kBAAQ,QAAQ,CAAA;AAEtB,QAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA;AACxC,QAAM,MAAA,cAAA,GAAiB,IAAIC,yCAAA,CAAqB,MAAM,CAAA;AAEtD,QAAM,MAAA,oBAAA,GAAuB,IAAIC,yCAAqB,CAAA;AAAA,UACpD,OAAA;AAAA,UACA,IAAA;AAAA,UACA,QAAU,EAAA,uBAAA;AAAA,UACV,QAAU,EAAA,cAAA;AAAA,UACV;AAAA,SACD,CAAA;AAED,QAAM,MAAA,mBAAA,GAAsB,IAAIC,sCAAoB,CAAA;AAAA,UAClD,MAAA;AAAA,UACA,QAAU,EAAA,cAAA;AAAA,UACV;AAAA,SACD,CAAA;AAED,QAA0BC,mDAAA,CAAA;AAAA,UACxB,UAAY,EAAA,MAAA;AAAA,UACZ,QAAU,EAAA;AAAA,SACX,CAAA;AAED,QAAAC,eAAA,CAAU,MAAO,CAAA;AAAA,UACf,IAAA;AAAA,UACA,OAAA;AAAA,UACA,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,QAAU,EAAA,cAAA;AAAA,UACV,uBAAA;AAAA,UACA,kBAAA,EAAoB,IAAIC,qCAAmB;AAAA,SAC5C,EAAE,KAAM,EAAA;AAET,QAAA,MAAM,OAAU,GAAA;AAAA,UACd,mBAAA;AAAA,UACA;AAAA,SACF;AAEA,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,uBAAA;AAAA,YACA,OAAA;AAAA,YACA,OAAA;AAAA,YACA,QAAA;AAAA,YACA,WAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
|
|
@@ -5,17 +5,25 @@ var normalizeOwnerRef = require('../utils/normalizeOwnerRef.cjs.js');
|
|
|
5
5
|
var errors = require('@backstage/errors');
|
|
6
6
|
var permissionUtils = require('../permissions/permissionUtils.cjs.js');
|
|
7
7
|
var mergeEntityAndProviderThresholds = require('../utils/mergeEntityAndProviderThresholds.cjs.js');
|
|
8
|
+
var metricCalculationError = require('../utils/metricCalculationError.cjs.js');
|
|
8
9
|
var mappers = require('./mappers.cjs.js');
|
|
9
|
-
var buildAggregationConfig = require('../utils/buildAggregationConfig.cjs.js');
|
|
10
|
-
var aggregationKPIs = require('../constants/aggregationKPIs.cjs.js');
|
|
11
10
|
|
|
12
11
|
class CatalogMetricService {
|
|
12
|
+
static entityHealthSummary(accessibleRows, countsArePartial) {
|
|
13
|
+
const calculationErrorCount = accessibleRows.filter(
|
|
14
|
+
(row) => metricCalculationError.isMetricCalculationError(row)
|
|
15
|
+
).length;
|
|
16
|
+
return {
|
|
17
|
+
totalEntities: accessibleRows.length,
|
|
18
|
+
calculationErrorCount,
|
|
19
|
+
countsArePartial
|
|
20
|
+
};
|
|
21
|
+
}
|
|
13
22
|
logger;
|
|
14
23
|
catalog;
|
|
15
24
|
auth;
|
|
16
25
|
registry;
|
|
17
26
|
database;
|
|
18
|
-
config;
|
|
19
27
|
static MAX_FETCHABLE_ROWS = 1e4;
|
|
20
28
|
static BATCH_SIZE = 100;
|
|
21
29
|
constructor(options) {
|
|
@@ -24,7 +32,6 @@ class CatalogMetricService {
|
|
|
24
32
|
this.registry = options.registry;
|
|
25
33
|
this.database = options.database;
|
|
26
34
|
this.logger = options.logger;
|
|
27
|
-
this.config = options.config;
|
|
28
35
|
}
|
|
29
36
|
/**
|
|
30
37
|
* Get latest metric results for a specific catalog entity.
|
|
@@ -67,7 +74,10 @@ class CatalogMetricService {
|
|
|
67
74
|
} catch (error) {
|
|
68
75
|
thresholdError = errors.stringifyError(error);
|
|
69
76
|
}
|
|
70
|
-
const isMetricCalcError =
|
|
77
|
+
const isMetricCalcError = metricCalculationError.isMetricCalculationError({
|
|
78
|
+
value,
|
|
79
|
+
error_message
|
|
80
|
+
});
|
|
71
81
|
return {
|
|
72
82
|
id: metric.id,
|
|
73
83
|
status: isMetricCalcError ? "error" : "success",
|
|
@@ -163,7 +173,8 @@ class CatalogMetricService {
|
|
|
163
173
|
total: 0,
|
|
164
174
|
totalPages: 0,
|
|
165
175
|
isCapped: false
|
|
166
|
-
}
|
|
176
|
+
},
|
|
177
|
+
entityHealth: CatalogMetricService.entityHealthSummary([], false)
|
|
167
178
|
};
|
|
168
179
|
}
|
|
169
180
|
const rows = await this.database.readEntityMetricsWithFilters(metricId, {
|
|
@@ -219,7 +230,8 @@ class CatalogMetricService {
|
|
|
219
230
|
total: 0,
|
|
220
231
|
totalPages: 0,
|
|
221
232
|
isCapped: false
|
|
222
|
-
}
|
|
233
|
+
},
|
|
234
|
+
entityHealth: CatalogMetricService.entityHealthSummary([], false)
|
|
223
235
|
};
|
|
224
236
|
}
|
|
225
237
|
const isCapped = rows.length === CatalogMetricService.MAX_FETCHABLE_ROWS;
|
|
@@ -243,7 +255,11 @@ class CatalogMetricService {
|
|
|
243
255
|
total: totalFiltered,
|
|
244
256
|
totalPages: Math.ceil(totalFiltered / options.limit),
|
|
245
257
|
isCapped
|
|
246
|
-
}
|
|
258
|
+
},
|
|
259
|
+
entityHealth: CatalogMetricService.entityHealthSummary(
|
|
260
|
+
accessibleRows,
|
|
261
|
+
isCapped
|
|
262
|
+
)
|
|
247
263
|
};
|
|
248
264
|
}
|
|
249
265
|
const enrichedEntities = [];
|
|
@@ -275,40 +291,13 @@ class CatalogMetricService {
|
|
|
275
291
|
total: totalFiltered,
|
|
276
292
|
totalPages: Math.ceil(totalFiltered / options.limit),
|
|
277
293
|
isCapped
|
|
278
|
-
}
|
|
294
|
+
},
|
|
295
|
+
entityHealth: CatalogMetricService.entityHealthSummary(
|
|
296
|
+
accessibleRows,
|
|
297
|
+
isCapped
|
|
298
|
+
)
|
|
279
299
|
};
|
|
280
300
|
}
|
|
281
|
-
/**
|
|
282
|
-
* Get the aggregation configs for a given aggregation IDs filtered by metric IDs.
|
|
283
|
-
* If no aggregation IDs are provided, all aggregation configs will be returned.
|
|
284
|
-
* If no metric IDs are provided, all metrics will be included.
|
|
285
|
-
*
|
|
286
|
-
* @param aggregationIds - Optional array of aggregation IDs to fetch the configs for.
|
|
287
|
-
* @param metricIds - Optional array of metric IDs, when provided, only aggregations whose config metricId is in this array will be returned.
|
|
288
|
-
* @returns Aggregation configs
|
|
289
|
-
*/
|
|
290
|
-
getAggregationConfigs(aggregationIds = [], metricIds = []) {
|
|
291
|
-
const aggregationKPIsConfig = this.config.getOptionalConfig(
|
|
292
|
-
aggregationKPIs.AGGREGATION_KPIS_CONFIG_PATH
|
|
293
|
-
);
|
|
294
|
-
if (!aggregationKPIsConfig) {
|
|
295
|
-
return [];
|
|
296
|
-
}
|
|
297
|
-
const aggregations = [];
|
|
298
|
-
const aggregationConfigIds = aggregationIds.length > 0 ? aggregationIds : aggregationKPIsConfig.keys();
|
|
299
|
-
for (const aggregationId of aggregationConfigIds) {
|
|
300
|
-
const config = aggregationKPIsConfig.getOptionalConfig(aggregationId);
|
|
301
|
-
if (config) {
|
|
302
|
-
const aggregationConfig = buildAggregationConfig.buildAggregationConfig(aggregationId, {
|
|
303
|
-
config
|
|
304
|
-
});
|
|
305
|
-
if (metricIds.length === 0 || metricIds.includes(aggregationConfig.metricId)) {
|
|
306
|
-
aggregations.push(aggregationConfig);
|
|
307
|
-
}
|
|
308
|
-
}
|
|
309
|
-
}
|
|
310
|
-
return aggregations;
|
|
311
|
-
}
|
|
312
301
|
}
|
|
313
302
|
|
|
314
303
|
exports.CatalogMetricService = CatalogMetricService;
|