@red-hat-developer-hub/backstage-plugin-scorecard-backend 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @red-hat-developer-hub/backstage-plugin-scorecard-backend
 
+## 2.1.0
+
+### Minor Changes
+
+- 54465f3: Backstage version bump to v1.44.2
+
+### Patch Changes
+
+- Updated dependencies [54465f3]
+  - @red-hat-developer-hub/backstage-plugin-scorecard-common@2.1.0
+  - @red-hat-developer-hub/backstage-plugin-scorecard-node@2.1.0
+
+## 2.0.1
+
+### Patch Changes
+
+- 94050aa: Fixes scorecard conditional permissions and conditional access check for Catalog entity.
+  - @red-hat-developer-hub/backstage-plugin-scorecard-common@2.0.1
+  - @red-hat-developer-hub/backstage-plugin-scorecard-node@2.0.1
+
 ## 2.0.0
 
 ### Major Changes

package/dist/plugin.cjs.js

@@ -51,6 +51,9 @@ const scorecardPlugin = backendPluginApi.createBackendPlugin({
       }) {
         permissionsRegistry.addResourceType({
           resourceRef: rules.scorecardMetricPermissionResourceRef,
+          getResources: async (resourceRefs) => {
+            return metricProvidersRegistry.listMetrics(resourceRefs);
+          },
           permissions: backstagePluginScorecardCommon.scorecardPermissions,
           rules: Object.values(rules.rules)
         });

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';\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          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          thresholdEvaluator: new ThresholdEvaluator(),\n          database: dbMetricValues,\n        });\n\n        Scheduler.create({\n          auth,\n          catalog,\n          config,\n          logger,\n          scheduler,\n          database: dbMetricValues,\n          metricProvidersRegistry,\n        }).start();\n\n        httpRouter.use(\n          await createRouter({\n            metricProvidersRegistry,\n            catalogMetricService,\n            httpAuth,\n            permissions,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","MetricProvidersRegistry","scorecardMetricsExtensionPoint","coreServices","catalogServiceRef","scorecardMetricPermissionResourceRef","scorecardPermissions","scorecardRules","migrate","DatabaseMetricValues","CatalogMetricService","ThresholdEvaluator","Scheduler","createRouter"],"mappings":";;;;;;;;;;;;;;;AA0CO,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,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,kBAAA,EAAoB,IAAIC,qCAAmB,EAAA;AAAA,UAC3C,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;AAAA,SACD,EAAE,KAAM,EAAA;AAET,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,uBAAA;AAAA,YACA,oBAAA;AAAA,YACA,QAAA;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';\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          thresholdEvaluator: new ThresholdEvaluator(),\n          database: dbMetricValues,\n        });\n\n        Scheduler.create({\n          auth,\n          catalog,\n          config,\n          logger,\n          scheduler,\n          database: dbMetricValues,\n          metricProvidersRegistry,\n        }).start();\n\n        httpRouter.use(\n          await createRouter({\n            metricProvidersRegistry,\n            catalogMetricService,\n            httpAuth,\n            permissions,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","MetricProvidersRegistry","scorecardMetricsExtensionPoint","coreServices","catalogServiceRef","scorecardMetricPermissionResourceRef","scorecardPermissions","scorecardRules","migrate","DatabaseMetricValues","CatalogMetricService","ThresholdEvaluator","Scheduler","createRouter"],"mappings":";;;;;;;;;;;;;;;AA0CO,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,kBAAA,EAAoB,IAAIC,qCAAmB,EAAA;AAAA,UAC3C,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;AAAA,SACD,EAAE,KAAM,EAAA;AAET,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,uBAAA;AAAA,YACA,oBAAA;AAAA,YACA,QAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/dist/providers/MetricProvidersRegistry.cjs.js

@@ -63,7 +63,10 @@ class MetricProvidersRegistry {
   listProviders() {
     return Array.from(this.metricProviders.values());
   }
-  listMetrics() {
+  listMetrics(providerIds) {
+    if (providerIds && providerIds.length !== 0) {
+      return providerIds.map((providerId) => this.metricProviders.get(providerId)?.getMetric()).filter((m) => m !== void 0);
+    }
     return [...this.metricProviders.values()].map(
       (provider) => 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 metricId = metricProvider.getMetric().id;\n\n    if (providerId !== metricId) {\n      throw new Error(\n        `Invalid metric provider with ID ${providerId}, provider ID must match metric ID '${metricId}'`,\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    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  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(): Metric[] {\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    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,QAAA,GAAW,cAAe,CAAA,SAAA,EAAY,CAAA,EAAA;AAE5C,IAAA,IAAI,eAAe,QAAU,EAAA;AAC3B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gCAAA,EAAmC,UAAU,CAAA,oCAAA,EAAuC,QAAQ,CAAA,CAAA;AAAA,OAC9F;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;AACnD,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,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,WAAwB,GAAA;AACtB,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;AACrE,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 providerId = metricProvider.getProviderId();\n    const providerDatasource = metricProvider.getProviderDatasourceId();\n    const metricId = metricProvider.getMetric().id;\n\n    if (providerId !== metricId) {\n      throw new Error(\n        `Invalid metric provider with ID ${providerId}, provider ID must match metric ID '${metricId}'`,\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    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  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    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,QAAA,GAAW,cAAe,CAAA,SAAA,EAAY,CAAA,EAAA;AAE5C,IAAA,IAAI,eAAe,QAAU,EAAA;AAC3B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gCAAA,EAAmC,UAAU,CAAA,oCAAA,EAAuC,QAAQ,CAAA,CAAA;AAAA,OAC9F;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;AACnD,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,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;AACrE,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;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@red-hat-developer-hub/backstage-plugin-scorecard-backend",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "Apache-2.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
@@ -38,17 +38,17 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-defaults": "^0.12.0",
-    "@backstage/backend-plugin-api": "^1.4.2",
-    "@backstage/catalog-client": "^1.11.0",
+    "@backstage/backend-defaults": "^0.13.0",
+    "@backstage/backend-plugin-api": "^1.4.4",
+    "@backstage/catalog-client": "^1.12.0",
     "@backstage/catalog-model": "^1.7.5",
     "@backstage/errors": "^1.2.7",
-    "@backstage/plugin-catalog-common": "^1.1.5",
-    "@backstage/plugin-catalog-node": "^1.18.0",
-    "@backstage/plugin-permission-common": "^0.9.1",
-    "@backstage/plugin-permission-node": "^0.10.3",
-    "@red-hat-developer-hub/backstage-plugin-scorecard-common": "^2.0.0",
-    "@red-hat-developer-hub/backstage-plugin-scorecard-node": "^2.0.0",
+    "@backstage/plugin-catalog-common": "^1.1.6",
+    "@backstage/plugin-catalog-node": "^1.19.1",
+    "@backstage/plugin-permission-common": "^0.9.2",
+    "@backstage/plugin-permission-node": "^0.10.5",
+    "@red-hat-developer-hub/backstage-plugin-scorecard-common": "^2.1.0",
+    "@red-hat-developer-hub/backstage-plugin-scorecard-node": "^2.1.0",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
     "knex": "^3.1.0",
@@ -56,8 +56,8 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.8.0",
-    "@backstage/cli": "^0.34.1",
+    "@backstage/backend-test-utils": "^1.9.1",
+    "@backstage/cli": "^0.34.4",
     "@types/express": "^4.17.6",
     "@types/supertest": "^2.0.12",
     "supertest": "^6.2.4"