feat(scorecard)!: add database and schedulers (#1544)

* Introduce metric_values db

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Connect metric providers on schedule

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Add catalog entities processing to providers

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Extract to BaseMetricProvider

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Rename metricValue row

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Integrate db read to metrics endpoint

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Use directly catalogService in CatalogMetricService

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Remove not needed readMetricValues

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Switch db value to json

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Extract scheduling to scorecard backend

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Simplify DatabaseMetricValuesStore

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Add tests

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Update docs

Signed-off-by: Dominika Zemanovicova <[email protected]>

* Increate timeout for db

Signed-off-by: Dominika Zemanovicova <[email protected]>

* feat(scorecard): implement cleanup expired metrics mechanism

Signed-off-by: Ihor Mykhno <[email protected]>

* refactor(scorecard): logic to load and cleanup metrics

Signed-off-by: Ihor Mykhno <[email protected]>

* refactor(scorecard): scorecard metric loading logic

Signed-off-by: Ihor Mykhno <[email protected]>

* Update changeset

Signed-off-by: Dominika Zemanovicova <[email protected]>

---------

Signed-off-by: Dominika Zemanovicova <[email protected]>
Signed-off-by: Ihor Mykhno <[email protected]>
Co-authored-by: Ihor Mykhno <[email protected]>

Author: dzemanov

workspaces/scorecard/.changeset/olive-months-cross.md

@@ -0,0 +1,26 @@
+---
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-github': major
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-jira': major
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend': major
+'@red-hat-developer-hub/backstage-plugin-scorecard-node': major
+'@red-hat-developer-hub/backstage-plugin-scorecard': major
+---
+
+**BREAKING**: The `supportsEntity` function has been replaced with `getCatalogFilter` for `MetricProvider`. The new function returns a catalog filter instead of taking an entity parameter and returning a boolean. This allows the plugin to query the catalog for entities that support the metric provider.
+
+These changes are **required** to your `MyMetricProvider`:
+
+```diff
+export class MyMetricProvider implements MetricProvider {
+
+-  supportsEntity(entity: Entity): boolean {
+-    return entity.metadata.annotations?.['my/annotation'] !== undefined;
+-  }
++  getCatalogFilter(): Record<string, string | symbol | (string | symbol)[]> {
++    return {
++      'metadata.annotations.my/annotation': CATALOG_FILTER_EXISTS,
++    };
++  }
+```
+
+Implemented database support. Implemented scheduler to fetch metrics by provider and to cleanup outdated metrics from database.

workspaces/scorecard/plugins/scorecard-backend-module-github/README.md

@@ -90,3 +90,23 @@ This metric counts all pull requests that are currently in an "open" state for t
 ### Threshold Configuration
 
 Thresholds define conditions that determine which category a metric value belongs to ( `error`, `warning`, or `success`). You can configure custom thresholds for the GitHub metrics. Check out detailed explanation of [threshold configuration](../scorecard-backend/docs/thresholds.md).
+
+## Schedule Configuration
+
+The Scorecard plugin uses Backstage's built-in scheduler service to automatically collect metrics from all registered providers every hour by default. However, this configuration can be changed in the `app-config.yaml` file. Here is an example of how to do that:
+
+```yaml
+scorecard:
+  plugins:
+    github:
+      open_prs:
+        schedule:
+          frequency:
+            cron: '0 6 * * *'
+          timeout:
+            minutes: 5
+          initialDelay:
+            seconds: 5
+```
+
+The schedule configuration follows Backstage's `SchedulerServiceTaskScheduleDefinitionConfig` [schema](https://github.com/backstage/backstage/blob/master/packages/backend-plugin-api/src/services/definitions/SchedulerService.ts#L157).

workspaces/scorecard/plugins/scorecard-backend-module-github/config.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
 
 export interface Config {
   /** Configuration for scorecard plugin */
@@ -29,6 +30,7 @@ export interface Config {
               expression: string;
             }>;
           };
+          schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
         };
       };
     };

workspaces/scorecard/plugins/scorecard-backend-module-github/package.json

@@ -39,8 +39,10 @@
   },
   "dependencies": {
     "@backstage/backend-plugin-api": "^1.4.2",
+    "@backstage/catalog-client": "^1.11.0",
     "@backstage/catalog-model": "^1.7.5",
     "@backstage/integration": "^1.17.1",
+    "@backstage/plugin-catalog-node": "^1.18.0",
     "@octokit/graphql": "^9.0.1",
     "@red-hat-developer-hub/backstage-plugin-scorecard-common": "workspace:^",
     "@red-hat-developer-hub/backstage-plugin-scorecard-node": "workspace:^"

workspaces/scorecard/plugins/scorecard-backend-module-github/src/metricProviders/GithubOpenPRsProvider.test.ts

@@ -30,42 +30,6 @@ jest.mock('@backstage/catalog-model', () => ({
 jest.mock('../github/GithubClient');
 
 describe('GithubOpenPRsProvider', () => {
-  describe('supportsEntity', () => {
-    let provider: GithubOpenPRsProvider;
-
-    beforeEach(() => {
-      provider = GithubOpenPRsProvider.fromConfig(new ConfigReader({}));
-    });
-
-    it.each([
-      [
-        'should return true for entity with github.com/project-slug annotation',
-        {
-          'github.com/project-slug': 'org/repo',
-        },
-        true,
-      ],
-      [
-        'should return false for entity without github.com/project-slug annotation',
-        {
-          'some.other/annotation': 'value',
-        },
-        false,
-      ],
-      ['should return false for entity with no annotations', undefined, false],
-    ])('%s', (_, annotations, expected) => {
-      const entity: Entity = {
-        apiVersion: 'backstage.io/v1alpha1',
-        kind: 'Component',
-        metadata: {
-          name: 'test-component',
-          annotations,
-        },
-      };
-      expect(provider.supportsEntity(entity)).toBe(expected);
-    });
-  });
-
   describe('fromConfig', () => {
     it('should create provider with default thresholds when no thresholds are configured', () => {
       const provider = GithubOpenPRsProvider.fromConfig(new ConfigReader({}));

workspaces/scorecard/plugins/scorecard-backend-module-github/src/metricProviders/GithubOpenPRsProvider.ts

@@ -16,22 +16,22 @@
 
 import type { Config } from '@backstage/config';
 import { getEntitySourceLocation, type Entity } from '@backstage/catalog-model';
+import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
 import {
   DEFAULT_NUMBER_THRESHOLDS,
   Metric,
   ThresholdConfig,
 } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
 import {
+  getThresholdsFromConfig,
   MetricProvider,
-  validateThresholds,
 } from '@red-hat-developer-hub/backstage-plugin-scorecard-node';
 import { GithubClient } from '../github/GithubClient';
 import { getRepositoryInformationFromEntity } from '../github/utils';
-import { GITHUB_PROJECT_ANNOTATION } from '../github/constants';
 
 export class GithubOpenPRsProvider implements MetricProvider<'number'> {
-  private readonly thresholds: ThresholdConfig;
   private readonly githubClient: GithubClient;
+  private readonly thresholds: ThresholdConfig;
 
   private constructor(config: Config, thresholds?: ThresholdConfig) {
     this.githubClient = new GithubClient(config);
@@ -61,20 +61,20 @@ export class GithubOpenPRsProvider implements MetricProvider<'number'> {
     return this.thresholds;
   }
 
-  supportsEntity(entity: Entity): boolean {
-    return (
-      entity.metadata.annotations?.[GITHUB_PROJECT_ANNOTATION] !== undefined
-    );
+  getCatalogFilter(): Record<string, string | symbol | (string | symbol)[]> {
+    return {
+      'metadata.annotations.github.com/project-slug': CATALOG_FILTER_EXISTS,
+    };
   }
 
   static fromConfig(config: Config): GithubOpenPRsProvider {
-    const configPath = 'scorecard.plugins.github.open_prs.thresholds';
-    const configuredThresholds = config.getOptional(configPath);
-    if (configuredThresholds !== undefined) {
-      validateThresholds(configuredThresholds, 'number');
-    }
+    const thresholds = getThresholdsFromConfig(
+      config,
+      'scorecard.plugins.github.open_prs.thresholds',
+      'number',
+    );
 
-    return new GithubOpenPRsProvider(config, configuredThresholds);
+    return new GithubOpenPRsProvider(config, thresholds);
   }
 
   async calculateMetric(entity: Entity): Promise<number> {

workspaces/scorecard/plugins/scorecard-backend-module-jira/README.md

@@ -15,7 +15,7 @@ This module also requires a Jira integration to be configured in your `app-confi
 
 ## Configuration
 
-### Authentification `token`
+### Authentication `token`
 
 - For the `cloud` product:
 
@@ -98,6 +98,26 @@ scorecard:
           customFilter: priority in ("Critical", "Blocker")
 ```
 
+## Schedule Configuration
+
+The Scorecard plugin uses Backstage's built-in scheduler service to automatically collect metrics from all registered providers every hour by default. However, this configuration can be changed in the `app-config.yaml` file. Here is an example of how to do that:
+
+```yaml
+scorecard:
+  plugins:
+    jira:
+      open_issues:
+        schedule:
+          frequency:
+            cron: '0 6 * * *'
+          timeout:
+            minutes: 5
+          initialDelay:
+            seconds: 5
+```
+
+The schedule configuration follows Backstage's `SchedulerServiceTaskScheduleDefinitionConfig` [schema](https://github.com/backstage/backstage/blob/master/packages/backend-plugin-api/src/services/definitions/SchedulerService.ts#L157).
+
 ## Installation
 
 To install this backend module:

workspaces/scorecard/plugins/scorecard-backend-module-jira/config.d.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
+
 export interface Config {
   /** Configuration for jira plugin */
   jira: (
@@ -48,6 +50,7 @@ export interface Config {
               expression: string;
             }>;
           };
+          schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
         };
       };
     };

workspaces/scorecard/plugins/scorecard-backend-module-jira/package.json

@@ -39,12 +39,14 @@
   },
   "dependencies": {
     "@backstage/backend-plugin-api": "^1.4.2",
+    "@backstage/catalog-client": "^1.11.0",
+    "@backstage/catalog-model": "^1.7.5",
+    "@backstage/plugin-catalog-node": "^1.18.0",
     "@red-hat-developer-hub/backstage-plugin-scorecard-common": "workspace:^",
     "@red-hat-developer-hub/backstage-plugin-scorecard-node": "workspace:^"
   },
   "devDependencies": {
     "@backstage/backend-test-utils": "^1.8.0",
-    "@backstage/catalog-model": "^1.7.5",
     "@backstage/cli": "^0.34.1",
     "@backstage/config": "^1.3.3"
   },

workspaces/scorecard/plugins/scorecard-backend-module-jira/src/clients/base.ts

@@ -17,7 +17,7 @@
 import type { Config } from '@backstage/config';
 import type { Entity } from '@backstage/catalog-model';
 import { JiraEntityFilters, JiraOptions, RequestOptions } from './types';
-import { JIRA_OPTIONS_PATH, JIRA_MANDATORY_FILTER } from '../constants';
+import { JIRA_MANDATORY_FILTER, OPEN_ISSUES_CONFIG_PATH } from '../constants';
 import { ScorecardJiraAnnotations } from '../annotations';
 import { sanitizeValue, validateIdentifier, validateJQLValue } from './utils';
 import { ConnectionStrategy } from '../strategies/ConnectionStrategy';
@@ -32,7 +32,9 @@ export abstract class JiraClient {
   constructor(rootConfig: Config, connectionStrategy: ConnectionStrategy) {
     this.connectionStrategy = connectionStrategy;
 
-    const jiraOptions = rootConfig.getOptionalConfig(JIRA_OPTIONS_PATH);
+    const jiraOptions = rootConfig.getOptionalConfig(
+      `${OPEN_ISSUES_CONFIG_PATH}.options`,
+    );
     if (jiraOptions) {
       this.options = {
         mandatoryFilter: jiraOptions.getOptionalString('mandatoryFilter'),