@red-hat-developer-hub/backstage-plugin-scorecard-backend 2.5.2 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @red-hat-developer-hub/backstage-plugin-scorecard-backend
 
+## 2.7.0
+
+### Minor Changes
+
+- 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.
+
+### Patch Changes
+
+- Updated dependencies [bf72ffc]
+  - @red-hat-developer-hub/backstage-plugin-scorecard-common@2.7.0
+  - @red-hat-developer-hub/backstage-plugin-scorecard-node@2.7.0
+
+## 2.6.0
+
+### Minor Changes
+
+- 4ecaacd: Add support for batch metric providers, allowing a single provider to handle multiple metrics efficiently. Introduce a new backend module for configurable file existence checks (filecheck.\*) that verify whether required files (like README, LICENSE, or CODEOWNERS) are present in a repository.
+
+### Patch Changes
+
+- Updated dependencies [4ecaacd]
+  - @red-hat-developer-hub/backstage-plugin-scorecard-node@2.6.0
+  - @red-hat-developer-hub/backstage-plugin-scorecard-common@2.6.0
+
 ## 2.5.2
 
 ### Patch Changes

package/README.md

@@ -88,12 +88,13 @@ For more information about schedule configuration options, see the [Metric Colle
 
 The following metric providers are available:
 
-| Provider       | Metric ID          | Title                       | Description                                                                                                                      | Type   |
-| -------------- | ------------------ | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------ |
-| **GitHub**     | `github.open_prs`  | GitHub open PRs             | Count of open Pull Requests in GitHub                                                                                            | number |
-| **Jira**       | `jira.open_issues` | Jira open issues            | The number of opened issues in Jira                                                                                              | number |
-| **OpenSSF**    | `openssf.*`        | OpenSSF Security Scorecards | 18 security metrics from OpenSSF Scorecards (e.g., `openssf.code_review`, `openssf.maintained`). Each returns a score from 0-10. | number |
-| **Dependabot** | `dependabot.*`     | Dependabot Alerts           | Critical, High, Medium and Low CVE Alerts                                                                                        | number |
+| Provider       | Metric ID          | Title                       | Description                                                                                                                      | Type    |
+| -------------- | ------------------ | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| **GitHub**     | `github.open_prs`  | GitHub open PRs             | Count of open Pull Requests in GitHub                                                                                            | number  |
+| **Filecheck**  | `filecheck.*`      | File Checks                 | Checks whether specific files (e.g., `README.md`, `LICENSE`, `CODEOWNERS`) exist in a repository.                                | boolean |
+| **Jira**       | `jira.open_issues` | Jira open issues            | The number of opened issues in Jira                                                                                              | number  |
+| **OpenSSF**    | `openssf.*`        | OpenSSF Security Scorecards | 18 security metrics from OpenSSF Scorecards (e.g., `openssf.code_review`, `openssf.maintained`). Each returns a score from 0-10. | number  |
+| **Dependabot** | `dependabot.*`     | Dependabot Alerts           | Critical, High, Medium and Low CVE Alerts                                                                                        | number  |
 
 To use these providers, install the corresponding backend modules:
 
@@ -101,6 +102,7 @@ To use these providers, install the corresponding backend modules:
 - Jira: [`@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-jira`](../scorecard-backend-module-jira/README.md)
 - OpenSSF: [`@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-openssf`](../scorecard-backend-module-openssf/README.md)
 - Dependabot: [`@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-dependabot`](../scorecard-backend-module-dependabot/README.md)
+- Filecheck: [`@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-filecheck`](../scorecard-backend-module-filecheck/README.md)
 
 ### Disabling Metrics
 
@@ -116,7 +118,7 @@ Thresholds define conditions to assign metric values to specific visual categori
 
 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 (`==`, `!=`).
 
-For comprehensive threshold configuration guide, examples, and best practices, see [thresholds.md](./docs/thresholds.md).
+For comprehensive threshold configuration guide, examples, best practices, and **aggregation KPI result thresholds** for **`type: average`**, see [thresholds.md](./docs/thresholds.md).
 
 ## Aggregation KPIs (homepage and `GET /aggregations`)
 
@@ -135,18 +137,41 @@ scorecard:
       description: 'Open pull requests grouped by status.'
       type: statusGrouped
       metricId: github.open_prs
+    openPrsWeightedKpi:
+      title: 'GitHub open PRs (weighted health)'
+      description: 'Weighted health from status counts using configurable scores.'
+      type: average
+      metricId: github.open_prs
+      options:
+        statusScores:
+          success: 100
+          warning: 50
+          error: 0
+        # Optional: colors for the average-score donut (expressions apply to percentage 0–100)
+        thresholds:
+          rules:
+            - key: success
+              expression: '>=75'
+              color: success.main
+            - key: warning
+              expression: '10-74'
+              color: warning.main
+            - key: error
+              expression: '<10'
+              color: error.main
 ```
 
-| Field         | Description                                                    |
-| ------------- | -------------------------------------------------------------- |
-| `title`       | Display title for this aggregation (returned in API metadata). |
-| `description` | Display description for this aggregation.                      |
-| `type`        | Aggregation algorithm; currently `statusGrouped`.              |
-| `metricId`    | Metric provider id used to load thresholds and compute counts. |
+| Field         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `title`       | Display title for this aggregation (returned in API metadata).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| `description` | Display description for this aggregation.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| `type`        | Aggregation algorithm: `statusGrouped` (counts per threshold status) or `average` (normalized weighted score).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| `metricId`    | Metric provider id used to load thresholds and compute counts.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| `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). |
 
 - **Path**: `scorecard.aggregationKPIs.<aggregationId>`.
 - 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.
-- Invalid KPI entries may be logged and skipped at runtime; prefer fixing config per backend validation.
+- **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).
 
 **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).
 

package/config.d.ts

@@ -15,7 +15,11 @@
  */
 
 import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
-import { AggregationType } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
+import {
+  AggregationType,
+  ThresholdConfig,
+  AggregationThresholdRule,
+} from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
 
 export interface Config {
   /** Configuration for scorecard plugin */
@@ -32,6 +36,20 @@ export interface Config {
         type: AggregationType;
         /** Metric ID for which the aggregation is calculated */
         metricId: string;
+        /** Type-specific settings */
+        options?: {
+          /** Required under `options` when `type` is `average` */
+          statusScores?: {
+            [thresholdRuleKey: string]: number;
+          };
+          /**
+           * Optional: threshold rules for coloring the KPI headline value from the aggregation result
+           * (e.g. average percentage 0–100 for `average` KPIs).
+           */
+          thresholds?: {
+            rules: AggregationThresholdRule[];
+          };
+        };
       };
     };
     /** 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 {
          */
         [metricName: string]: {
           /** Threshold configuration for the metric */
-          thresholds?: {
-            /**
-             * Rules describe how metric values are categorized and how that category is presented in the UI.
-             * They are evaluated in order and the first matching rule is applied.
-             */
-            rules?: Array<{
-              /**
-               * Threshold category key that a metric value is assigned to when this rule
-               * matches (for example `success`, `warning`, `error`, or a custom key).
-               */
-              key: string;
-              /**
-               * Threshold expression that determines whether a metric value matches this
-               * rule. Supports:`>=`, `<=`, `>`, `<`, `==`, `!=`, `-` (range).
-               *
-               * @example `<= 10` - Metric value must be less than or equal to 10.
-               * @example `10-60` - Metric value must be between 10 and 60 (inclusive).
-               */
-              expression: string;
-              /**
-               * Color configuration - supports multiple formats:
-               * - theme palette reference (`success.main` / `warning.main` / `error.main`)
-               * - HEX code (e.g. '#FFA500')
-               * - RGB/RGBA (e.g. 'rgb(255, 0, 0)')
-               *
-               * Threshold rules 'success', 'warning' and 'error' have default colors.
-               */
-              color?: string;
-              /**
-               * Icon configuration - supports multiple formats:
-               * - Backstage system icons: 'kind:component', 'kind:api', etc.
-               * - Material Design icons: 'settings', 'home', 'build', etc.
-               * - SVG strings: '<svg xmlns="http://www.w3.org/2000/svg">...</svg>'
-               * - URLs: 'https://example.com/icon.png', '/assets/icon.svg'
-               * - Data URIs: 'data:image/svg+xml;base64,...'
-               *
-               * Threshold rules 'success', 'warning' and 'error' have default icons.
-               */
-              icon?: string;
-            }>;
-          };
+          thresholds?: ThresholdConfig;
           /**
            * Schedule for collecting this metric. If not set, the default hourly schedule is used.
            *

package/dist/constants/aggregationKPIs.cjs.js

@@ -1,6 +1,28 @@
 'use strict';
 
+var backstagePluginScorecardCommon = require('@red-hat-developer-hub/backstage-plugin-scorecard-common');
+
 const AGGREGATION_KPIS_CONFIG_PATH = "scorecard.aggregationKPIs";
+const DEFAULT_AVERAGE_KPI_RESULT_THRESHOLDS = {
+  rules: [
+    {
+      key: "success",
+      expression: ">=80",
+      color: backstagePluginScorecardCommon.ScorecardThresholdRuleColors.SUCCESS
+    },
+    {
+      key: "warning",
+      expression: "30-79",
+      color: backstagePluginScorecardCommon.ScorecardThresholdRuleColors.WARNING
+    },
+    {
+      key: "error",
+      expression: "<30",
+      color: backstagePluginScorecardCommon.ScorecardThresholdRuleColors.ERROR
+    }
+  ]
+};
 
 exports.AGGREGATION_KPIS_CONFIG_PATH = AGGREGATION_KPIS_CONFIG_PATH;
+exports.DEFAULT_AVERAGE_KPI_RESULT_THRESHOLDS = DEFAULT_AVERAGE_KPI_RESULT_THRESHOLDS;
 //# sourceMappingURL=aggregationKPIs.cjs.js.map

package/dist/constants/aggregationKPIs.cjs.js.map

@@ -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":";;AAgBO,MAAM,4BACX,GAAA;;;;"}
+{"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;;;;;"}

package/dist/plugin.cjs.js

@@ -13,6 +13,7 @@ var migration = require('./database/migration.cjs.js');
 var DatabaseMetricValues = require('./database/DatabaseMetricValues.cjs.js');
 var index = require('./scheduler/index.cjs.js');
 var validateAggregationConfig = require('./validation/validateAggregationConfig.cjs.js');
+var AggregationService = require('./service/aggregations/AggregationService.cjs.js');
 
 const scorecardPlugin = backendPluginApi.createBackendPlugin({
   pluginId: "scorecard",
@@ -66,8 +67,12 @@ const scorecardPlugin = backendPluginApi.createBackendPlugin({
           auth,
           registry: metricProvidersRegistry,
           database: dbMetricValues,
-          logger,
-          config
+          logger
+        });
+        const aggregationsService = new AggregationService.AggregationsService({
+          config,
+          database: dbMetricValues,
+          logger
         });
         validateAggregationConfig.validateAggregationConfig({
           rootConfig: config,
@@ -83,10 +88,14 @@ const scorecardPlugin = backendPluginApi.createBackendPlugin({
           metricProvidersRegistry,
           thresholdEvaluator: new ThresholdEvaluator.ThresholdEvaluator()
         }).start();
+        const service = {
+          aggregationsService,
+          catalogMetricService
+        };
         httpRouter.use(
           await router.createRouter({
             metricProvidersRegistry,
-            catalogMetricService,
+            service,
             catalog,
             httpAuth,
             permissions,

package/dist/plugin.cjs.js.map

@@ -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            catalogMetricService,\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","validateAggregationConfig","Scheduler","ThresholdEvaluator","createRouter"],"mappings":";;;;;;;;;;;;;;;;AA2CO,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,MAAA;AAAA,UACA;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,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,uBAAA;AAAA,YACA,oBAAA;AAAA,YACA,OAAA;AAAA,YACA,QAAA;AAAA,YACA,WAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
+{"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;;;;"}

package/dist/providers/MetricProvidersRegistry.cjs.js

@@ -6,44 +6,51 @@ class MetricProvidersRegistry {
   metricProviders = /* @__PURE__ */ new Map();
   datasourceIndex = /* @__PURE__ */ new Map();
   register(metricProvider) {
-    const providerId = metricProvider.getProviderId();
     const providerDatasource = metricProvider.getProviderDatasourceId();
-    const metric = metricProvider.getMetric();
     const metricType = metricProvider.getMetricType();
-    if (providerId !== metric.id) {
-      throw new Error(
-        `Invalid metric provider with ID ${providerId}, provider ID must match metric ID '${metric.id}'`
-      );
-    }
-    if (metricType !== metric.type) {
-      throw new Error(
-        `Invalid metric provider with ID ${providerId}, getMetricType() must match getMetric().type. Expected '${metricType}', but got '${metric.type}'`
-      );
-    }
-    const expectedPrefix = `${providerDatasource}.`;
-    if (!providerId.startsWith(expectedPrefix) || providerId === expectedPrefix) {
-      throw new Error(
-        `Invalid metric provider with ID ${providerId}, must have format '${providerDatasource}.<metric_name>' where metric name is not empty`
-      );
-    }
-    if (this.metricProviders.has(providerId)) {
-      throw new errors.ConflictError(
-        `Metric provider with ID '${providerId}' has already been registered`
-      );
-    }
-    this.metricProviders.set(providerId, metricProvider);
-    let datasourceProviders = this.datasourceIndex.get(providerDatasource);
-    if (!datasourceProviders) {
-      datasourceProviders = /* @__PURE__ */ new Set();
-      this.datasourceIndex.set(providerDatasource, datasourceProviders);
+    const metricIds = metricProvider.getMetricIds?.() ?? [
+      metricProvider.getProviderId()
+    ];
+    const metrics = metricProvider.getMetrics?.() ?? [
+      metricProvider.getMetric()
+    ];
+    for (const metricId of metricIds) {
+      const metric = metrics.find((m) => m.id === metricId);
+      if (!metric) {
+        throw new Error(
+          `Invalid metric provider: metric ID '${metricId}' returned by getMetricIds() does not have a corresponding metric in getMetrics()`
+        );
+      }
+      if (metricType !== metric.type) {
+        throw new Error(
+          `Invalid metric provider with ID ${metricId}, getMetricType() must match getMetric().type. Expected '${metricType}', but got '${metric.type}'`
+        );
+      }
+      const expectedPrefix = `${providerDatasource}.`;
+      if (!metricId.startsWith(expectedPrefix) || metricId === expectedPrefix) {
+        throw new Error(
+          `Invalid metric provider with ID ${metricId}, must have format '${providerDatasource}.<metric_name>' where metric name is not empty`
+        );
+      }
+      if (this.metricProviders.has(metricId)) {
+        throw new errors.ConflictError(
+          `Metric provider with ID '${metricId}' has already been registered`
+        );
+      }
+      this.metricProviders.set(metricId, metricProvider);
+      let datasourceProviders = this.datasourceIndex.get(providerDatasource);
+      if (!datasourceProviders) {
+        datasourceProviders = /* @__PURE__ */ new Set();
+        this.datasourceIndex.set(providerDatasource, datasourceProviders);
+      }
+      datasourceProviders.add(metricId);
     }
-    datasourceProviders.add(providerId);
   }
-  getProvider(providerId) {
-    const metricProvider = this.metricProviders.get(providerId);
+  getProvider(metricId) {
+    const metricProvider = this.metricProviders.get(metricId);
     if (!metricProvider) {
       throw new errors.NotFoundError(
-        `Metric provider with ID '${providerId}' is not registered.`
+        `No metric provider registered for metric ID '${metricId}'.`
       );
     }
     return metricProvider;
@@ -51,33 +58,49 @@ class MetricProvidersRegistry {
   hasProvider(providerId) {
     return this.metricProviders.has(providerId);
   }
-  getMetric(providerId) {
-    return this.getProvider(providerId).getMetric();
+  getMetric(metricId) {
+    const provider = this.getProvider(metricId);
+    if (provider.getMetrics) {
+      const metrics = provider.getMetrics();
+      const metric = metrics.find((m) => m.id === metricId);
+      if (metric) {
+        return metric;
+      }
+    }
+    return provider.getMetric();
   }
-  async calculateMetric(providerId, entity) {
-    return this.getProvider(providerId).calculateMetric(entity);
+  async calculateMetric(metricId, entity) {
+    return this.getProvider(metricId).calculateMetric(entity);
   }
-  async calculateMetrics(providerIds, entity) {
+  async calculateMetrics(metricIds, entity) {
     const results = await Promise.allSettled(
-      providerIds.map((providerId) => this.calculateMetric(providerId, entity))
+      metricIds.map((metricId) => this.calculateMetric(metricId, entity))
     );
     return results.map((result, index) => {
-      const providerId = providerIds[index];
+      const metricId = metricIds[index];
       if (result.status === "fulfilled") {
-        return { providerId, value: result.value };
+        return { metricId, value: result.value };
       }
-      return { providerId, error: result.reason };
+      return { metricId, error: result.reason };
     });
   }
   listProviders() {
-    return Array.from(this.metricProviders.values());
+    return [...new Set(this.metricProviders.values())];
   }
-  listMetrics(providerIds) {
-    if (providerIds && providerIds.length !== 0) {
-      return providerIds.map((providerId) => this.metricProviders.get(providerId)?.getMetric()).filter((m) => m !== void 0);
+  listMetrics(metricIds) {
+    if (metricIds && metricIds.length !== 0) {
+      return metricIds.map((metricId) => {
+        const provider = this.metricProviders.get(metricId);
+        if (!provider) return void 0;
+        if (provider.getMetrics) {
+          const metrics = provider.getMetrics();
+          return metrics.find((m) => m.id === metricId);
+        }
+        return provider.getMetric();
+      }).filter((m) => m !== void 0);
     }
-    return [...this.metricProviders.values()].map(
-      (provider) => provider.getMetric()
+    return this.listProviders().flatMap(
+      (provider) => provider.getMetrics?.() ?? [provider.getMetric()]
     );
   }
   listMetricsByDatasource(datasourceId) {
@@ -85,7 +108,10 @@ class MetricProvidersRegistry {
     if (!providerIdsOfDatasource) {
       return [];
     }
-    return Array.from(providerIdsOfDatasource).map((providerId) => this.metricProviders.get(providerId)).filter((provider) => provider !== void 0).map((provider) => provider.getMetric());
+    const providers = [...providerIdsOfDatasource].map((id) => this.metricProviders.get(id)).filter((p) => p !== void 0);
+    return [...new Set(providers)].flatMap(
+      (provider) => provider.getMetrics?.() ?? [provider.getMetric()]
+    );
   }
 }
 

package/dist/providers/MetricProvidersRegistry.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"MetricProvidersRegistry.cjs.js","sources":["../../src/providers/MetricProvidersRegistry.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 { ConflictError, NotFoundError } from '@backstage/errors';\nimport {\n  Metric,\n  MetricValue,\n} from '@red-hat-developer-hub/backstage-plugin-scorecard-common';\nimport type { Entity } from '@backstage/catalog-model';\nimport { MetricProvider } from '@red-hat-developer-hub/backstage-plugin-scorecard-node';\n\n/**\n * Registry of all registered metric providers.\n */\nexport class MetricProvidersRegistry {\n  private readonly metricProviders = new Map<string, MetricProvider>();\n  private readonly datasourceIndex = new Map<string, Set<string>>();\n\n  register(metricProvider: MetricProvider): void {\n    const providerId = metricProvider.getProviderId();\n    const providerDatasource = metricProvider.getProviderDatasourceId();\n    const metric = metricProvider.getMetric();\n    const metricType = metricProvider.getMetricType();\n\n    if (providerId !== metric.id) {\n      throw new Error(\n        `Invalid metric provider with ID ${providerId}, provider ID must match metric ID '${metric.id}'`,\n      );\n    }\n\n    if (metricType !== metric.type) {\n      throw new Error(\n        `Invalid metric provider with ID ${providerId}, getMetricType() must match getMetric().type. Expected '${metricType}', but got '${metric.type}'`,\n      );\n    }\n\n    const expectedPrefix = `${providerDatasource}.`;\n    if (\n      !providerId.startsWith(expectedPrefix) ||\n      providerId === expectedPrefix\n    ) {\n      throw new Error(\n        `Invalid metric provider with ID ${providerId}, must have format '${providerDatasource}.<metric_name>' where metric name is not empty`,\n      );\n    }\n\n    if (this.metricProviders.has(providerId)) {\n      throw new ConflictError(\n        `Metric provider with ID '${providerId}' has already been registered`,\n      );\n    }\n\n    this.metricProviders.set(providerId, metricProvider);\n\n    let datasourceProviders = this.datasourceIndex.get(providerDatasource);\n    if (!datasourceProviders) {\n      datasourceProviders = new Set();\n      this.datasourceIndex.set(providerDatasource, datasourceProviders);\n    }\n    datasourceProviders.add(providerId);\n  }\n\n  getProvider(providerId: string): MetricProvider {\n    const metricProvider = this.metricProviders.get(providerId);\n    if (!metricProvider) {\n      throw new NotFoundError(\n        `Metric provider with ID '${providerId}' is not registered.`,\n      );\n    }\n    return metricProvider;\n  }\n\n  hasProvider(providerId: string): boolean {\n    return this.metricProviders.has(providerId);\n  }\n\n  getMetric(providerId: string): Metric {\n    return this.getProvider(providerId).getMetric();\n  }\n\n  async calculateMetric(\n    providerId: string,\n    entity: Entity,\n  ): Promise<MetricValue> {\n    return this.getProvider(providerId).calculateMetric(entity);\n  }\n\n  async calculateMetrics(\n    providerIds: string[],\n    entity: Entity,\n  ): Promise<{ providerId: string; value?: MetricValue; error?: Error }[]> {\n    const results = await Promise.allSettled(\n      providerIds.map(providerId => this.calculateMetric(providerId, entity)),\n    );\n\n    return results.map((result, index) => {\n      const providerId = providerIds[index];\n      if (result.status === 'fulfilled') {\n        return { providerId, value: result.value };\n      }\n      return { providerId, error: result.reason as Error };\n    });\n  }\n\n  listProviders(): MetricProvider[] {\n    return Array.from(this.metricProviders.values());\n  }\n\n  listMetrics(providerIds?: string[]): Metric[] {\n    if (providerIds && providerIds.length !== 0) {\n      return providerIds\n        .map(providerId => this.metricProviders.get(providerId)?.getMetric())\n        .filter((m): m is Metric => m !== undefined);\n    }\n    return [...this.metricProviders.values()].map(provider =>\n      provider.getMetric(),\n    );\n  }\n\n  listMetricsByDatasource(datasourceId: string): Metric[] {\n    const providerIdsOfDatasource = this.datasourceIndex.get(datasourceId);\n\n    if (!providerIdsOfDatasource) {\n      return [];\n    }\n\n    return Array.from(providerIdsOfDatasource)\n      .map(providerId => this.metricProviders.get(providerId))\n      .filter((provider): provider is MetricProvider => provider !== undefined)\n      .map(provider => provider.getMetric());\n  }\n}\n"],"names":["ConflictError","NotFoundError"],"mappings":";;;;AA2BO,MAAM,uBAAwB,CAAA;AAAA,EAClB,eAAA,uBAAsB,GAA4B,EAAA;AAAA,EAClD,eAAA,uBAAsB,GAAyB,EAAA;AAAA,EAEhE,SAAS,cAAsC,EAAA;AAC7C,IAAM,MAAA,UAAA,GAAa,eAAe,aAAc,EAAA;AAChD,IAAM,MAAA,kBAAA,GAAqB,eAAe,uBAAwB,EAAA;AAClE,IAAM,MAAA,MAAA,GAAS,eAAe,SAAU,EAAA;AACxC,IAAM,MAAA,UAAA,GAAa,eAAe,aAAc,EAAA;AAEhD,IAAI,IAAA,UAAA,KAAe,OAAO,EAAI,EAAA;AAC5B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAmC,gCAAA,EAAA,UAAU,CAAuC,oCAAA,EAAA,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA,OAC/F;AAAA;AAGF,IAAI,IAAA,UAAA,KAAe,OAAO,IAAM,EAAA;AAC9B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,mCAAmC,UAAU,CAAA,yDAAA,EAA4D,UAAU,CAAA,YAAA,EAAe,OAAO,IAAI,CAAA,CAAA;AAAA,OAC/I;AAAA;AAGF,IAAM,MAAA,cAAA,GAAiB,GAAG,kBAAkB,CAAA,CAAA,CAAA;AAC5C,IAAA,IACE,CAAC,UAAW,CAAA,UAAA,CAAW,cAAc,CAAA,IACrC,eAAe,cACf,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gCAAA,EAAmC,UAAU,CAAA,oBAAA,EAAuB,kBAAkB,CAAA,8CAAA;AAAA,OACxF;AAAA;AAGF,IAAA,IAAI,IAAK,CAAA,eAAA,CAAgB,GAAI,CAAA,UAAU,CAAG,EAAA;AACxC,MAAA,MAAM,IAAIA,oBAAA;AAAA,QACR,4BAA4B,UAAU,CAAA,6BAAA;AAAA,OACxC;AAAA;AAGF,IAAK,IAAA,CAAA,eAAA,CAAgB,GAAI,CAAA,UAAA,EAAY,cAAc,CAAA;AAEnD,IAAA,IAAI,mBAAsB,GAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,kBAAkB,CAAA;AACrE,IAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,MAAA,mBAAA,uBAA0B,GAAI,EAAA;AAC9B,MAAK,IAAA,CAAA,eAAA,CAAgB,GAAI,CAAA,kBAAA,EAAoB,mBAAmB,CAAA;AAAA;AAElE,IAAA,mBAAA,CAAoB,IAAI,UAAU,CAAA;AAAA;AACpC,EAEA,YAAY,UAAoC,EAAA;AAC9C,IAAA,MAAM,cAAiB,GAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,UAAU,CAAA;AAC1D,IAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,4BAA4B,UAAU,CAAA,oBAAA;AAAA,OACxC;AAAA;AAEF,IAAO,OAAA,cAAA;AAAA;AACT,EAEA,YAAY,UAA6B,EAAA;AACvC,IAAO,OAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,UAAU,CAAA;AAAA;AAC5C,EAEA,UAAU,UAA4B,EAAA;AACpC,IAAA,OAAO,IAAK,CAAA,WAAA,CAAY,UAAU,CAAA,CAAE,SAAU,EAAA;AAAA;AAChD,EAEA,MAAM,eACJ,CAAA,UAAA,EACA,MACsB,EAAA;AACtB,IAAA,OAAO,IAAK,CAAA,WAAA,CAAY,UAAU,CAAA,CAAE,gBAAgB,MAAM,CAAA;AAAA;AAC5D,EAEA,MAAM,gBACJ,CAAA,WAAA,EACA,MACuE,EAAA;AACvE,IAAM,MAAA,OAAA,GAAU,MAAM,OAAQ,CAAA,UAAA;AAAA,MAC5B,YAAY,GAAI,CAAA,CAAA,UAAA,KAAc,KAAK,eAAgB,CAAA,UAAA,EAAY,MAAM,CAAC;AAAA,KACxE;AAEA,IAAA,OAAO,OAAQ,CAAA,GAAA,CAAI,CAAC,MAAA,EAAQ,KAAU,KAAA;AACpC,MAAM,MAAA,UAAA,GAAa,YAAY,KAAK,CAAA;AACpC,MAAI,IAAA,MAAA,CAAO,WAAW,WAAa,EAAA;AACjC,QAAA,OAAO,EAAE,UAAA,EAAY,KAAO,EAAA,MAAA,CAAO,KAAM,EAAA;AAAA;AAE3C,MAAA,OAAO,EAAE,UAAA,EAAY,KAAO,EAAA,MAAA,CAAO,MAAgB,EAAA;AAAA,KACpD,CAAA;AAAA;AACH,EAEA,aAAkC,GAAA;AAChC,IAAA,OAAO,KAAM,CAAA,IAAA,CAAK,IAAK,CAAA,eAAA,CAAgB,QAAQ,CAAA;AAAA;AACjD,EAEA,YAAY,WAAkC,EAAA;AAC5C,IAAI,IAAA,WAAA,IAAe,WAAY,CAAA,MAAA,KAAW,CAAG,EAAA;AAC3C,MAAA,OAAO,WACJ,CAAA,GAAA,CAAI,CAAc,UAAA,KAAA,IAAA,CAAK,gBAAgB,GAAI,CAAA,UAAU,CAAG,EAAA,SAAA,EAAW,CACnE,CAAA,MAAA,CAAO,CAAC,CAAA,KAAmB,MAAM,MAAS,CAAA;AAAA;AAE/C,IAAA,OAAO,CAAC,GAAG,IAAA,CAAK,eAAgB,CAAA,MAAA,EAAQ,CAAE,CAAA,GAAA;AAAA,MAAI,CAAA,QAAA,KAC5C,SAAS,SAAU;AAAA,KACrB;AAAA;AACF,EAEA,wBAAwB,YAAgC,EAAA;AACtD,IAAA,MAAM,uBAA0B,GAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,YAAY,CAAA;AAErE,IAAA,IAAI,CAAC,uBAAyB,EAAA;AAC5B,MAAA,OAAO,EAAC;AAAA;AAGV,IAAO,OAAA,KAAA,CAAM,KAAK,uBAAuB,CAAA,CACtC,IAAI,CAAc,UAAA,KAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,UAAU,CAAC,EACtD,MAAO,CAAA,CAAC,aAAyC,QAAa,KAAA,MAAS,EACvE,GAAI,CAAA,CAAA,QAAA,KAAY,QAAS,CAAA,SAAA,EAAW,CAAA;AAAA;AAE3C;;;;"}
+{"version":3,"file":"MetricProvidersRegistry.cjs.js","sources":["../../src/providers/MetricProvidersRegistry.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 { ConflictError, NotFoundError } from '@backstage/errors';\nimport {\n  Metric,\n  MetricValue,\n} from '@red-hat-developer-hub/backstage-plugin-scorecard-common';\nimport type { Entity } from '@backstage/catalog-model';\nimport { MetricProvider } from '@red-hat-developer-hub/backstage-plugin-scorecard-node';\n\n/**\n * Registry of all registered metric providers.\n */\nexport class MetricProvidersRegistry {\n  private readonly metricProviders = new Map<string, MetricProvider>();\n  private readonly datasourceIndex = new Map<string, Set<string>>();\n\n  register(metricProvider: MetricProvider): void {\n    const providerDatasource = metricProvider.getProviderDatasourceId();\n    const metricType = metricProvider.getMetricType();\n\n    // Support both single and batch providers\n    const metricIds = metricProvider.getMetricIds?.() ?? [\n      metricProvider.getProviderId(),\n    ];\n    const metrics = metricProvider.getMetrics?.() ?? [\n      metricProvider.getMetric(),\n    ];\n\n    // Validate: Each metric ID must have a corresponding metric definition\n    for (const metricId of metricIds) {\n      const metric = metrics.find(m => m.id === metricId);\n      if (!metric) {\n        throw new Error(\n          `Invalid metric provider: metric ID '${metricId}' returned by getMetricIds() ` +\n            `does not have a corresponding metric in getMetrics()`,\n        );\n      }\n\n      if (metricType !== metric.type) {\n        throw new Error(\n          `Invalid metric provider with ID ${metricId}, getMetricType() must match ` +\n            `getMetric().type. Expected '${metricType}', but got '${metric.type}'`,\n        );\n      }\n\n      // Validate: Provider ID format (datasource.metric_name)\n      const expectedPrefix = `${providerDatasource}.`;\n      if (!metricId.startsWith(expectedPrefix) || metricId === expectedPrefix) {\n        throw new Error(\n          `Invalid metric provider with ID ${metricId}, must have format ` +\n            `'${providerDatasource}.<metric_name>' where metric name is not empty`,\n        );\n      }\n\n      if (this.metricProviders.has(metricId)) {\n        throw new ConflictError(\n          `Metric provider with ID '${metricId}' has already been registered`,\n        );\n      }\n\n      this.metricProviders.set(metricId, metricProvider);\n\n      // Index by datasource\n      let datasourceProviders = this.datasourceIndex.get(providerDatasource);\n      if (!datasourceProviders) {\n        datasourceProviders = new Set();\n        this.datasourceIndex.set(providerDatasource, datasourceProviders);\n      }\n      datasourceProviders.add(metricId);\n    }\n  }\n\n  getProvider(metricId: string): MetricProvider {\n    const metricProvider = this.metricProviders.get(metricId);\n    if (!metricProvider) {\n      throw new NotFoundError(\n        `No metric provider registered for metric ID '${metricId}'.`,\n      );\n    }\n    return metricProvider;\n  }\n\n  hasProvider(providerId: string): boolean {\n    return this.metricProviders.has(providerId);\n  }\n\n  getMetric(metricId: string): Metric {\n    const provider = this.getProvider(metricId);\n\n    // For batch providers, find the specific metric by ID\n    if (provider.getMetrics) {\n      const metrics = provider.getMetrics();\n      const metric = metrics.find(m => m.id === metricId);\n      if (metric) {\n        return metric;\n      }\n    }\n\n    return provider.getMetric();\n  }\n\n  async calculateMetric(\n    metricId: string,\n    entity: Entity,\n  ): Promise<MetricValue> {\n    return this.getProvider(metricId).calculateMetric(entity);\n  }\n\n  async calculateMetrics(\n    metricIds: string[],\n    entity: Entity,\n  ): Promise<{ metricId: string; value?: MetricValue; error?: Error }[]> {\n    const results = await Promise.allSettled(\n      metricIds.map(metricId => this.calculateMetric(metricId, entity)),\n    );\n\n    return results.map((result, index) => {\n      const metricId = metricIds[index];\n      if (result.status === 'fulfilled') {\n        return { metricId, value: result.value };\n      }\n      return { metricId, error: result.reason as Error };\n    });\n  }\n\n  listProviders(): MetricProvider[] {\n    // Deduplicate providers since batch providers are stored under multiple metric IDs\n    return [...new Set(this.metricProviders.values())];\n  }\n\n  listMetrics(metricIds?: string[]): Metric[] {\n    if (metricIds && metricIds.length !== 0) {\n      return metricIds\n        .map(metricId => {\n          const provider = this.metricProviders.get(metricId);\n          if (!provider) return undefined;\n\n          if (provider.getMetrics) {\n            const metrics = provider.getMetrics();\n            return metrics.find(m => m.id === metricId);\n          }\n\n          return provider.getMetric();\n        })\n        .filter((m): m is Metric => m !== undefined);\n    }\n\n    // List all metrics from all providers (deduplicate batch providers)\n    return this.listProviders().flatMap(\n      provider => provider.getMetrics?.() ?? [provider.getMetric()],\n    );\n  }\n\n  listMetricsByDatasource(datasourceId: string): Metric[] {\n    const providerIdsOfDatasource = this.datasourceIndex.get(datasourceId);\n\n    if (!providerIdsOfDatasource) {\n      return [];\n    }\n\n    // Get unique providers for this datasource, then get their metrics\n    const providers = [...providerIdsOfDatasource]\n      .map(id => this.metricProviders.get(id))\n      .filter((p): p is MetricProvider => p !== undefined);\n\n    return [...new Set(providers)].flatMap(\n      provider => provider.getMetrics?.() ?? [provider.getMetric()],\n    );\n  }\n}\n"],"names":["ConflictError","NotFoundError"],"mappings":";;;;AA2BO,MAAM,uBAAwB,CAAA;AAAA,EAClB,eAAA,uBAAsB,GAA4B,EAAA;AAAA,EAClD,eAAA,uBAAsB,GAAyB,EAAA;AAAA,EAEhE,SAAS,cAAsC,EAAA;AAC7C,IAAM,MAAA,kBAAA,GAAqB,eAAe,uBAAwB,EAAA;AAClE,IAAM,MAAA,UAAA,GAAa,eAAe,aAAc,EAAA;AAGhD,IAAM,MAAA,SAAA,GAAY,cAAe,CAAA,YAAA,IAAoB,IAAA;AAAA,MACnD,eAAe,aAAc;AAAA,KAC/B;AACA,IAAM,MAAA,OAAA,GAAU,cAAe,CAAA,UAAA,IAAkB,IAAA;AAAA,MAC/C,eAAe,SAAU;AAAA,KAC3B;AAGA,IAAA,KAAA,MAAW,YAAY,SAAW,EAAA;AAChC,MAAA,MAAM,SAAS,OAAQ,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA;AAClD,MAAA,IAAI,CAAC,MAAQ,EAAA;AACX,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,uCAAuC,QAAQ,CAAA,iFAAA;AAAA,SAEjD;AAAA;AAGF,MAAI,IAAA,UAAA,KAAe,OAAO,IAAM,EAAA;AAC9B,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,mCAAmC,QAAQ,CAAA,yDAAA,EACV,UAAU,CAAA,YAAA,EAAe,OAAO,IAAI,CAAA,CAAA;AAAA,SACvE;AAAA;AAIF,MAAM,MAAA,cAAA,GAAiB,GAAG,kBAAkB,CAAA,CAAA,CAAA;AAC5C,MAAA,IAAI,CAAC,QAAS,CAAA,UAAA,CAAW,cAAc,CAAA,IAAK,aAAa,cAAgB,EAAA;AACvE,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,gCAAA,EAAmC,QAAQ,CAAA,oBAAA,EACrC,kBAAkB,CAAA,8CAAA;AAAA,SAC1B;AAAA;AAGF,MAAA,IAAI,IAAK,CAAA,eAAA,CAAgB,GAAI,CAAA,QAAQ,CAAG,EAAA;AACtC,QAAA,MAAM,IAAIA,oBAAA;AAAA,UACR,4BAA4B,QAAQ,CAAA,6BAAA;AAAA,SACtC;AAAA;AAGF,MAAK,IAAA,CAAA,eAAA,CAAgB,GAAI,CAAA,QAAA,EAAU,cAAc,CAAA;AAGjD,MAAA,IAAI,mBAAsB,GAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,kBAAkB,CAAA;AACrE,MAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,QAAA,mBAAA,uBAA0B,GAAI,EAAA;AAC9B,QAAK,IAAA,CAAA,eAAA,CAAgB,GAAI,CAAA,kBAAA,EAAoB,mBAAmB,CAAA;AAAA;AAElE,MAAA,mBAAA,CAAoB,IAAI,QAAQ,CAAA;AAAA;AAClC;AACF,EAEA,YAAY,QAAkC,EAAA;AAC5C,IAAA,MAAM,cAAiB,GAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,QAAQ,CAAA;AACxD,IAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,gDAAgD,QAAQ,CAAA,EAAA;AAAA,OAC1D;AAAA;AAEF,IAAO,OAAA,cAAA;AAAA;AACT,EAEA,YAAY,UAA6B,EAAA;AACvC,IAAO,OAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,UAAU,CAAA;AAAA;AAC5C,EAEA,UAAU,QAA0B,EAAA;AAClC,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,WAAA,CAAY,QAAQ,CAAA;AAG1C,IAAA,IAAI,SAAS,UAAY,EAAA;AACvB,MAAM,MAAA,OAAA,GAAU,SAAS,UAAW,EAAA;AACpC,MAAA,MAAM,SAAS,OAAQ,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA;AAClD,MAAA,IAAI,MAAQ,EAAA;AACV,QAAO,OAAA,MAAA;AAAA;AACT;AAGF,IAAA,OAAO,SAAS,SAAU,EAAA;AAAA;AAC5B,EAEA,MAAM,eACJ,CAAA,QAAA,EACA,MACsB,EAAA;AACtB,IAAA,OAAO,IAAK,CAAA,WAAA,CAAY,QAAQ,CAAA,CAAE,gBAAgB,MAAM,CAAA;AAAA;AAC1D,EAEA,MAAM,gBACJ,CAAA,SAAA,EACA,MACqE,EAAA;AACrE,IAAM,MAAA,OAAA,GAAU,MAAM,OAAQ,CAAA,UAAA;AAAA,MAC5B,UAAU,GAAI,CAAA,CAAA,QAAA,KAAY,KAAK,eAAgB,CAAA,QAAA,EAAU,MAAM,CAAC;AAAA,KAClE;AAEA,IAAA,OAAO,OAAQ,CAAA,GAAA,CAAI,CAAC,MAAA,EAAQ,KAAU,KAAA;AACpC,MAAM,MAAA,QAAA,GAAW,UAAU,KAAK,CAAA;AAChC,MAAI,IAAA,MAAA,CAAO,WAAW,WAAa,EAAA;AACjC,QAAA,OAAO,EAAE,QAAA,EAAU,KAAO,EAAA,MAAA,CAAO,KAAM,EAAA;AAAA;AAEzC,MAAA,OAAO,EAAE,QAAA,EAAU,KAAO,EAAA,MAAA,CAAO,MAAgB,EAAA;AAAA,KAClD,CAAA;AAAA;AACH,EAEA,aAAkC,GAAA;AAEhC,IAAO,OAAA,CAAC,GAAG,IAAI,GAAA,CAAI,KAAK,eAAgB,CAAA,MAAA,EAAQ,CAAC,CAAA;AAAA;AACnD,EAEA,YAAY,SAAgC,EAAA;AAC1C,IAAI,IAAA,SAAA,IAAa,SAAU,CAAA,MAAA,KAAW,CAAG,EAAA;AACvC,MAAO,OAAA,SAAA,CACJ,IAAI,CAAY,QAAA,KAAA;AACf,QAAA,MAAM,QAAW,GAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,QAAQ,CAAA;AAClD,QAAI,IAAA,CAAC,UAAiB,OAAA,MAAA;AAEtB,QAAA,IAAI,SAAS,UAAY,EAAA;AACvB,UAAM,MAAA,OAAA,GAAU,SAAS,UAAW,EAAA;AACpC,UAAA,OAAO,OAAQ,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA;AAAA;AAG5C,QAAA,OAAO,SAAS,SAAU,EAAA;AAAA,OAC3B,CACA,CAAA,MAAA,CAAO,CAAC,CAAA,KAAmB,MAAM,MAAS,CAAA;AAAA;AAI/C,IAAO,OAAA,IAAA,CAAK,eAAgB,CAAA,OAAA;AAAA,MAC1B,cAAY,QAAS,CAAA,UAAA,QAAkB,CAAC,QAAA,CAAS,WAAW;AAAA,KAC9D;AAAA;AACF,EAEA,wBAAwB,YAAgC,EAAA;AACtD,IAAA,MAAM,uBAA0B,GAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,YAAY,CAAA;AAErE,IAAA,IAAI,CAAC,uBAAyB,EAAA;AAC5B,MAAA,OAAO,EAAC;AAAA;AAIV,IAAA,MAAM,YAAY,CAAC,GAAG,uBAAuB,CAAA,CAC1C,IAAI,CAAM,EAAA,KAAA,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,EAAE,CAAC,CAAA,CACtC,OAAO,CAAC,CAAA,KAA2B,MAAM,MAAS,CAAA;AAErD,IAAA,OAAO,CAAC,GAAG,IAAI,GAAI,CAAA,SAAS,CAAC,CAAE,CAAA,OAAA;AAAA,MAC7B,cAAY,QAAS,CAAA,UAAA,QAAkB,CAAC,QAAA,CAAS,WAAW;AAAA,KAC9D;AAAA;AAEJ;;;;"}