@red-hat-developer-hub/backstage-plugin-scorecard 1.0.0 → 2.0.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 +34 -0
- package/dist/components/Scorecard/EntityScorecardContent.esm.js +4 -9
- package/dist/components/Scorecard/EntityScorecardContent.esm.js.map +1 -1
- package/package.json +2 -2
- package/dist/hooks/useScorecardMetricsReadPermission.esm.js +0 -16
- package/dist/hooks/useScorecardMetricsReadPermission.esm.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,39 @@
|
|
|
1
1
|
# @red-hat-developer-hub/backstage-plugin-scorecard
|
|
2
2
|
|
|
3
|
+
## 2.0.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 94050aa: Fixes scorecard conditional permissions and conditional access check for Catalog entity.
|
|
8
|
+
- @red-hat-developer-hub/backstage-plugin-scorecard-common@2.0.1
|
|
9
|
+
|
|
10
|
+
## 2.0.0
|
|
11
|
+
|
|
12
|
+
### Major Changes
|
|
13
|
+
|
|
14
|
+
- 5d447f1: **BREAKING**: The `supportsEntity` function has been replaced with `getCatalogFilter` for `MetricProvider`. The new function returns a catalog filter instead of taking an entity parameter and returning a boolean. This allows the plugin to query the catalog for entities that support the metric provider.
|
|
15
|
+
|
|
16
|
+
These changes are **required** to your `MyMetricProvider`:
|
|
17
|
+
|
|
18
|
+
```diff
|
|
19
|
+
export class MyMetricProvider implements MetricProvider {
|
|
20
|
+
|
|
21
|
+
- supportsEntity(entity: Entity): boolean {
|
|
22
|
+
- return entity.metadata.annotations?.['my/annotation'] !== undefined;
|
|
23
|
+
- }
|
|
24
|
+
+ getCatalogFilter(): Record<string, string | symbol | (string | symbol)[]> {
|
|
25
|
+
+ return {
|
|
26
|
+
+ 'metadata.annotations.my/annotation': CATALOG_FILTER_EXISTS,
|
|
27
|
+
+ };
|
|
28
|
+
+ }
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Implemented database support. Implemented scheduler to fetch metrics by provider and to cleanup outdated metrics from database.
|
|
32
|
+
|
|
33
|
+
### Patch Changes
|
|
34
|
+
|
|
35
|
+
- @red-hat-developer-hub/backstage-plugin-scorecard-common@2.0.0
|
|
36
|
+
|
|
3
37
|
## 1.0.0
|
|
4
38
|
|
|
5
39
|
### Major Changes
|
|
@@ -6,18 +6,13 @@ import NoScorecardsState from '../Common/NoScorecardsState.esm.js';
|
|
|
6
6
|
import Scorecard from './Scorecard.esm.js';
|
|
7
7
|
import { useScorecards } from '../../hooks/useScorecards.esm.js';
|
|
8
8
|
import { getStatusConfig } from '../../utils/utils.esm.js';
|
|
9
|
-
import { useScorecardMetricsReadPermission } from '../../hooks/useScorecardMetricsReadPermission.esm.js';
|
|
10
9
|
import PermissionRequiredState from '../Common/PermissionRequiredState.esm.js';
|
|
11
10
|
import { useTranslation } from '../../hooks/useTranslation.esm.js';
|
|
12
11
|
|
|
13
12
|
const EntityScorecardContent = () => {
|
|
14
13
|
const { scorecards, loadingData, error } = useScorecards();
|
|
15
14
|
const { t } = useTranslation();
|
|
16
|
-
|
|
17
|
-
allowed: hasReadScorecardMetricsPermission,
|
|
18
|
-
loading: loadingPermission
|
|
19
|
-
} = useScorecardMetricsReadPermission();
|
|
20
|
-
if (loadingData || loadingPermission) {
|
|
15
|
+
if (loadingData) {
|
|
21
16
|
return /* @__PURE__ */ jsx(
|
|
22
17
|
Box,
|
|
23
18
|
{
|
|
@@ -29,10 +24,10 @@ const EntityScorecardContent = () => {
|
|
|
29
24
|
}
|
|
30
25
|
);
|
|
31
26
|
}
|
|
32
|
-
if (!hasReadScorecardMetricsPermission) {
|
|
33
|
-
return /* @__PURE__ */ jsx(PermissionRequiredState, {});
|
|
34
|
-
}
|
|
35
27
|
if (error) {
|
|
28
|
+
if (error.message?.includes("NotAllowedError")) {
|
|
29
|
+
return /* @__PURE__ */ jsx(PermissionRequiredState, {});
|
|
30
|
+
}
|
|
36
31
|
return /* @__PURE__ */ jsx(ResponseErrorPanel, { error });
|
|
37
32
|
}
|
|
38
33
|
if (!loadingData && scorecards?.length === 0) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EntityScorecardContent.esm.js","sources":["../../../src/components/Scorecard/EntityScorecardContent.tsx"],"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 { MetricResult } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';\nimport { ResponseErrorPanel } from '@backstage/core-components';\n\nimport Box from '@mui/material/Box';\nimport CircularProgress from '@mui/material/CircularProgress';\n\nimport NoScorecardsState from '../Common/NoScorecardsState';\nimport Scorecard from './Scorecard';\nimport { useScorecards } from '../../hooks/useScorecards';\nimport { getStatusConfig } from '../../utils/utils';\nimport
|
|
1
|
+
{"version":3,"file":"EntityScorecardContent.esm.js","sources":["../../../src/components/Scorecard/EntityScorecardContent.tsx"],"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 { MetricResult } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';\nimport { ResponseErrorPanel } from '@backstage/core-components';\n\nimport Box from '@mui/material/Box';\nimport CircularProgress from '@mui/material/CircularProgress';\n\nimport NoScorecardsState from '../Common/NoScorecardsState';\nimport Scorecard from './Scorecard';\nimport { useScorecards } from '../../hooks/useScorecards';\nimport { getStatusConfig } from '../../utils/utils';\nimport PermissionRequiredState from '../Common/PermissionRequiredState';\nimport { useTranslation } from '../../hooks/useTranslation';\n\nexport const EntityScorecardContent = () => {\n const { scorecards, loadingData, error } = useScorecards();\n const { t } = useTranslation();\n\n if (loadingData) {\n return (\n <Box\n display=\"flex\"\n justifyContent=\"center\"\n alignItems=\"center\"\n minHeight=\"200px\"\n >\n <CircularProgress />\n </Box>\n );\n }\n\n if (error) {\n if (error.message?.includes('NotAllowedError')) {\n return <PermissionRequiredState />;\n }\n return <ResponseErrorPanel error={error} />;\n }\n\n if (!loadingData && scorecards?.length === 0) {\n return <NoScorecardsState />;\n }\n\n return (\n <Box\n display=\"flex\"\n flexWrap=\"wrap\"\n gap={2}\n sx={{ alignItems: 'flex-start' }}\n >\n {scorecards?.map((metric: MetricResult) => {\n // Check if metric data unavailable\n const isMetricDataError =\n metric.status === 'error' || metric.result?.value === undefined;\n\n // Check if threshold has an error\n const isThresholdError =\n metric.result?.thresholdResult?.status === 'error';\n\n const statusConfig = getStatusConfig({\n evaluation: metric.result?.thresholdResult?.evaluation,\n thresholdStatus: metric.result?.thresholdResult?.status,\n metricStatus: metric.status,\n });\n\n // Use metric ID to construct translation keys, fallback to original title/description\n const titleKey = `metric.${metric.id}.title`;\n const descriptionKey = `metric.${metric.id}.description`;\n\n const title = t(titleKey as any, {});\n const description = t(descriptionKey as any, {});\n\n // If translation returns the key itself, fallback to original title/description\n const finalTitle = title === titleKey ? metric.metadata.title : title;\n const finalDescription =\n description === descriptionKey\n ? metric.metadata.description\n : description;\n\n return (\n <Scorecard\n key={metric.id}\n cardTitle={finalTitle}\n description={finalDescription}\n loading={false}\n statusColor={statusConfig.color}\n StatusIcon={statusConfig.icon ?? (() => null)}\n value={metric.result?.value}\n thresholds={metric.result?.thresholdResult}\n isMetricDataError={isMetricDataError}\n metricDataError={metric?.error}\n isThresholdError={isThresholdError}\n thresholdError={metric.result?.thresholdResult?.error}\n />\n );\n })}\n </Box>\n );\n};\n"],"names":[],"mappings":";;;;;;;;;;;AA6BO,MAAM,yBAAyB,MAAM;AAC1C,EAAA,MAAM,EAAE,UAAA,EAAY,WAAa,EAAA,KAAA,KAAU,aAAc,EAAA;AACzD,EAAM,MAAA,EAAE,CAAE,EAAA,GAAI,cAAe,EAAA;AAE7B,EAAA,IAAI,WAAa,EAAA;AACf,IACE,uBAAA,GAAA;AAAA,MAAC,GAAA;AAAA,MAAA;AAAA,QACC,OAAQ,EAAA,MAAA;AAAA,QACR,cAAe,EAAA,QAAA;AAAA,QACf,UAAW,EAAA,QAAA;AAAA,QACX,SAAU,EAAA,OAAA;AAAA,QAEV,8BAAC,gBAAiB,EAAA,EAAA;AAAA;AAAA,KACpB;AAAA;AAIJ,EAAA,IAAI,KAAO,EAAA;AACT,IAAA,IAAI,KAAM,CAAA,OAAA,EAAS,QAAS,CAAA,iBAAiB,CAAG,EAAA;AAC9C,MAAA,2BAAQ,uBAAwB,EAAA,EAAA,CAAA;AAAA;AAElC,IAAO,uBAAA,GAAA,CAAC,sBAAmB,KAAc,EAAA,CAAA;AAAA;AAG3C,EAAA,IAAI,CAAC,WAAA,IAAe,UAAY,EAAA,MAAA,KAAW,CAAG,EAAA;AAC5C,IAAA,2BAAQ,iBAAkB,EAAA,EAAA,CAAA;AAAA;AAG5B,EACE,uBAAA,GAAA;AAAA,IAAC,GAAA;AAAA,IAAA;AAAA,MACC,OAAQ,EAAA,MAAA;AAAA,MACR,QAAS,EAAA,MAAA;AAAA,MACT,GAAK,EAAA,CAAA;AAAA,MACL,EAAA,EAAI,EAAE,UAAA,EAAY,YAAa,EAAA;AAAA,MAE9B,QAAA,EAAA,UAAA,EAAY,GAAI,CAAA,CAAC,MAAyB,KAAA;AAEzC,QAAA,MAAM,oBACJ,MAAO,CAAA,MAAA,KAAW,OAAW,IAAA,MAAA,CAAO,QAAQ,KAAU,KAAA,MAAA;AAGxD,QAAA,MAAM,gBACJ,GAAA,MAAA,CAAO,MAAQ,EAAA,eAAA,EAAiB,MAAW,KAAA,OAAA;AAE7C,QAAA,MAAM,eAAe,eAAgB,CAAA;AAAA,UACnC,UAAA,EAAY,MAAO,CAAA,MAAA,EAAQ,eAAiB,EAAA,UAAA;AAAA,UAC5C,eAAA,EAAiB,MAAO,CAAA,MAAA,EAAQ,eAAiB,EAAA,MAAA;AAAA,UACjD,cAAc,MAAO,CAAA;AAAA,SACtB,CAAA;AAGD,QAAM,MAAA,QAAA,GAAW,CAAU,OAAA,EAAA,MAAA,CAAO,EAAE,CAAA,MAAA,CAAA;AACpC,QAAM,MAAA,cAAA,GAAiB,CAAU,OAAA,EAAA,MAAA,CAAO,EAAE,CAAA,YAAA,CAAA;AAE1C,QAAA,MAAM,KAAQ,GAAA,CAAA,CAAE,QAAiB,EAAA,EAAE,CAAA;AACnC,QAAA,MAAM,WAAc,GAAA,CAAA,CAAE,cAAuB,EAAA,EAAE,CAAA;AAG/C,QAAA,MAAM,UAAa,GAAA,KAAA,KAAU,QAAW,GAAA,MAAA,CAAO,SAAS,KAAQ,GAAA,KAAA;AAChE,QAAA,MAAM,gBACJ,GAAA,WAAA,KAAgB,cACZ,GAAA,MAAA,CAAO,SAAS,WAChB,GAAA,WAAA;AAEN,QACE,uBAAA,GAAA;AAAA,UAAC,SAAA;AAAA,UAAA;AAAA,YAEC,SAAW,EAAA,UAAA;AAAA,YACX,WAAa,EAAA,gBAAA;AAAA,YACb,OAAS,EAAA,KAAA;AAAA,YACT,aAAa,YAAa,CAAA,KAAA;AAAA,YAC1B,UAAA,EAAY,YAAa,CAAA,IAAA,KAAS,MAAM,IAAA,CAAA;AAAA,YACxC,KAAA,EAAO,OAAO,MAAQ,EAAA,KAAA;AAAA,YACtB,UAAA,EAAY,OAAO,MAAQ,EAAA,eAAA;AAAA,YAC3B,iBAAA;AAAA,YACA,iBAAiB,MAAQ,EAAA,KAAA;AAAA,YACzB,gBAAA;AAAA,YACA,cAAA,EAAgB,MAAO,CAAA,MAAA,EAAQ,eAAiB,EAAA;AAAA,WAAA;AAAA,UAX3C,MAAO,CAAA;AAAA,SAYd;AAAA,OAEH;AAAA;AAAA,GACH;AAEJ;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@red-hat-developer-hub/backstage-plugin-scorecard",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"main": "./dist/index.esm.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
"@backstage/theme": "^0.6.8",
|
|
64
64
|
"@mui/icons-material": "5.18.0",
|
|
65
65
|
"@mui/material": "5.18.0",
|
|
66
|
-
"@red-hat-developer-hub/backstage-plugin-scorecard-common": "^
|
|
66
|
+
"@red-hat-developer-hub/backstage-plugin-scorecard-common": "^2.0.1",
|
|
67
67
|
"react-use": "^17.2.4"
|
|
68
68
|
},
|
|
69
69
|
"peerDependencies": {
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { usePermission } from '@backstage/plugin-permission-react';
|
|
2
|
-
import { scorecardMetricReadPermission } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
|
|
3
|
-
|
|
4
|
-
const useScorecardMetricsReadPermission = () => {
|
|
5
|
-
const canReadScorecardMetrics = usePermission({
|
|
6
|
-
permission: scorecardMetricReadPermission,
|
|
7
|
-
resourceRef: "scorecard-metric"
|
|
8
|
-
});
|
|
9
|
-
return {
|
|
10
|
-
loading: canReadScorecardMetrics.loading,
|
|
11
|
-
allowed: canReadScorecardMetrics.allowed
|
|
12
|
-
};
|
|
13
|
-
};
|
|
14
|
-
|
|
15
|
-
export { useScorecardMetricsReadPermission };
|
|
16
|
-
//# sourceMappingURL=useScorecardMetricsReadPermission.esm.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useScorecardMetricsReadPermission.esm.js","sources":["../../src/hooks/useScorecardMetricsReadPermission.tsx"],"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 { usePermission } from '@backstage/plugin-permission-react';\nimport { scorecardMetricReadPermission } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';\n\nexport const useScorecardMetricsReadPermission = () => {\n const canReadScorecardMetrics = usePermission({\n permission: scorecardMetricReadPermission,\n resourceRef: 'scorecard-metric',\n });\n\n return {\n loading: canReadScorecardMetrics.loading,\n allowed: canReadScorecardMetrics.allowed,\n };\n};\n"],"names":[],"mappings":";;;AAmBO,MAAM,oCAAoC,MAAM;AACrD,EAAA,MAAM,0BAA0B,aAAc,CAAA;AAAA,IAC5C,UAAY,EAAA,6BAAA;AAAA,IACZ,WAAa,EAAA;AAAA,GACd,CAAA;AAED,EAAO,OAAA;AAAA,IACL,SAAS,uBAAwB,CAAA,OAAA;AAAA,IACjC,SAAS,uBAAwB,CAAA;AAAA,GACnC;AACF;;;;"}
|