Extract scheduling to scorecard backend

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

Author: dzemanov

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

@@ -16,8 +16,6 @@
 
 import { ConfigReader } from '@backstage/config';
 import type { Entity } from '@backstage/catalog-model';
-import { mockServices } from '@backstage/backend-test-utils';
-import { catalogServiceMock } from '@backstage/plugin-catalog-node/testUtils';
 import { GithubOpenPRsProvider } from './GithubOpenPRsProvider';
 import { GithubClient } from '../github/GithubClient';
 import { DEFAULT_NUMBER_THRESHOLDS } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
@@ -32,58 +30,9 @@ jest.mock('@backstage/catalog-model', () => ({
 jest.mock('../github/GithubClient');
 
 describe('GithubOpenPRsProvider', () => {
-  const mockOptions = {
-    auth: mockServices.auth(),
-    logger: mockServices.logger.mock(),
-    scheduler: mockServices.scheduler.mock(),
-    catalog: catalogServiceMock(),
-  };
-
-  describe('supportsEntity', () => {
-    let provider: GithubOpenPRsProvider;
-
-    beforeEach(() => {
-      provider = GithubOpenPRsProvider.fromConfig(
-        new ConfigReader({}),
-        mockOptions,
-      );
-    });
-
-    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({}),
-        mockOptions,
-      );
+      const provider = GithubOpenPRsProvider.fromConfig(new ConfigReader({}));
 
       expect(provider.getMetricThresholds()).toEqual(DEFAULT_NUMBER_THRESHOLDS);
     });
@@ -108,10 +57,7 @@ describe('GithubOpenPRsProvider', () => {
           },
         },
       });
-      const provider = GithubOpenPRsProvider.fromConfig(
-        configWithThresholds,
-        mockOptions,
-      );
+      const provider = GithubOpenPRsProvider.fromConfig(configWithThresholds);
 
       expect(provider.getMetricThresholds()).toEqual(customThresholds);
     });
@@ -131,9 +77,9 @@ describe('GithubOpenPRsProvider', () => {
         },
       });
 
-      expect(() =>
-        GithubOpenPRsProvider.fromConfig(invalidConfig, mockOptions),
-      ).toThrow('Cannot parse "!100" as number from expression: ">!100"');
+      expect(() => GithubOpenPRsProvider.fromConfig(invalidConfig)).toThrow(
+        'Cannot parse "!100" as number from expression: ">!100"',
+      );
     });
   });
 
@@ -149,10 +95,7 @@ describe('GithubOpenPRsProvider', () => {
 
     beforeEach(() => {
       jest.clearAllMocks();
-      provider = GithubOpenPRsProvider.fromConfig(
-        new ConfigReader({}),
-        mockOptions,
-      );
+      provider = GithubOpenPRsProvider.fromConfig(new ConfigReader({}));
     });
 
     it('should calculate metric', async () => {

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

@@ -17,43 +17,25 @@
 import type { Config } from '@backstage/config';
 import { getEntitySourceLocation, type Entity } from '@backstage/catalog-model';
 import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
-import {
-  AuthService,
-  LoggerService,
-  SchedulerService,
-  SchedulerServiceTaskRunner,
-} from '@backstage/backend-plugin-api';
-import { CatalogService } from '@backstage/plugin-catalog-node';
 import {
   DEFAULT_NUMBER_THRESHOLDS,
   Metric,
   ThresholdConfig,
 } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
-import { BaseMetricProvider } from '@red-hat-developer-hub/backstage-plugin-scorecard-node';
+import {
+  getThresholdsFromConfig,
+  MetricProvider,
+} 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 extends BaseMetricProvider<'number'> {
+export class GithubOpenPRsProvider implements MetricProvider<'number'> {
   private readonly githubClient: GithubClient;
+  private readonly thresholds: ThresholdConfig;
 
-  private constructor(
-    config: Config,
-    auth: AuthService,
-    logger: LoggerService,
-    catalog: CatalogService,
-    taskRunner: SchedulerServiceTaskRunner,
-    thresholds?: ThresholdConfig,
-  ) {
-    super(
-      auth,
-      logger,
-      catalog,
-      taskRunner,
-      { 'metadata.annotations.github.com/project-slug': CATALOG_FILTER_EXISTS },
-      thresholds ?? DEFAULT_NUMBER_THRESHOLDS,
-    );
+  private constructor(config: Config, thresholds?: ThresholdConfig) {
     this.githubClient = new GithubClient(config);
+    this.thresholds = thresholds ?? DEFAULT_NUMBER_THRESHOLDS;
   }
 
   getProviderDatasourceId(): string {
@@ -75,40 +57,24 @@ export class GithubOpenPRsProvider extends BaseMetricProvider<'number'> {
     };
   }
 
-  supportsEntity(entity: Entity): boolean {
-    return (
-      entity.metadata.annotations?.[GITHUB_PROJECT_ANNOTATION] !== undefined
-    );
+  getMetricThresholds(): ThresholdConfig {
+    return this.thresholds;
   }
 
-  static fromConfig(
-    config: Config,
-    options: {
-      auth: AuthService;
-      logger: LoggerService;
-      scheduler: SchedulerService;
-      catalog: CatalogService;
-    },
-  ): GithubOpenPRsProvider {
-    const thresholds = this.getThresholdsFromConfig(
+  getCatalogFilter(): Record<string, string | symbol | (string | symbol)[]> {
+    return {
+      'metadata.annotations.github.com/project-slug': CATALOG_FILTER_EXISTS,
+    };
+  }
+
+  static fromConfig(config: Config): GithubOpenPRsProvider {
+    const thresholds = getThresholdsFromConfig(
       config,
       'scorecard.plugins.github.open_prs.thresholds',
-    );
-    const schedule = this.getScheduleFromConfig(
-      config,
-      'scorecard.plugins.github.open_prs.schedule',
+      'number',
     );
 
-    const taskRunner = options.scheduler.createScheduledTaskRunner(schedule);
-
-    return new GithubOpenPRsProvider(
-      config,
-      options.auth,
-      options.logger,
-      options.catalog,
-      taskRunner,
-      thresholds,
-    );
+    return new GithubOpenPRsProvider(config, thresholds);
   }
 
   async calculateMetric(entity: Entity): Promise<number> {

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

@@ -17,7 +17,6 @@ import {
   coreServices,
   createBackendModule,
 } from '@backstage/backend-plugin-api';
-import { catalogServiceRef } from '@backstage/plugin-catalog-node';
 import { scorecardMetricsExtensionPoint } from '@red-hat-developer-hub/backstage-plugin-scorecard-node';
 import { GithubOpenPRsProvider } from './metricProviders/GithubOpenPRsProvider';
 
@@ -27,22 +26,11 @@ export const scorecardModuleGithub = createBackendModule({
   register(reg) {
     reg.registerInit({
       deps: {
-        auth: coreServices.auth,
         config: coreServices.rootConfig,
-        logger: coreServices.logger,
-        scheduler: coreServices.scheduler,
         metrics: scorecardMetricsExtensionPoint,
-        catalog: catalogServiceRef,
       },
-      async init({ auth, config, logger, scheduler, metrics, catalog }) {
-        metrics.addMetricProvider(
-          GithubOpenPRsProvider.fromConfig(config, {
-            auth,
-            logger,
-            scheduler,
-            catalog,
-          }),
-        );
+      async init({ config, metrics }) {
+        metrics.addMetricProvider(GithubOpenPRsProvider.fromConfig(config));
       },
     });
   },

workspaces/scorecard/plugins/scorecard-backend-module-jira/src/metricProviders/JiraOpenIssuesProvider.test.ts

@@ -16,8 +16,6 @@
 
 import { ConfigReader } from '@backstage/config';
 import type { Entity } from '@backstage/catalog-model';
-import { mockServices } from '@backstage/backend-test-utils';
-import { catalogServiceMock } from '@backstage/plugin-catalog-node/testUtils';
 import { ThresholdConfig } from '@red-hat-developer-hub/backstage-plugin-scorecard-common';
 import { validateThresholds } from '@red-hat-developer-hub/backstage-plugin-scorecard-node';
 import { JiraOpenIssuesProvider } from './JiraOpenIssuesProvider';
@@ -63,44 +61,28 @@ const customThresholds: ThresholdConfig = {
 };
 
 describe('JiraOpenIssuesProvider', () => {
-  const mockOptions = {
-    auth: mockServices.auth(),
-    logger: mockServices.logger.mock(),
-    scheduler: mockServices.scheduler.mock(),
-    catalog: catalogServiceMock(),
-  };
-
   beforeEach(() => {
     jest.clearAllMocks();
     MockedJiraClientFactory.create.mockReturnValue(mockJiraClient);
   });
 
   describe('getProviderDatasourceId', () => {
     it('should return "jira"', () => {
-      const provider = JiraOpenIssuesProvider.fromConfig(
-        new ConfigReader({}),
-        mockOptions,
-      );
+      const provider = JiraOpenIssuesProvider.fromConfig(new ConfigReader({}));
       expect(provider.getProviderDatasourceId()).toEqual('jira');
     });
   });
 
   describe('getProviderId', () => {
     it('should return "jira.open-issues"', () => {
-      const provider = JiraOpenIssuesProvider.fromConfig(
-        new ConfigReader({}),
-        mockOptions,
-      );
+      const provider = JiraOpenIssuesProvider.fromConfig(new ConfigReader({}));
       expect(provider.getProviderId()).toEqual('jira.open-issues');
     });
   });
 
   describe('getMetric', () => {
     it('should return correct metric metadata', () => {
-      const provider = JiraOpenIssuesProvider.fromConfig(
-        new ConfigReader({}),
-        mockOptions,
-      );
+      const provider = JiraOpenIssuesProvider.fromConfig(new ConfigReader({}));
       expect(provider.getMetric()).toEqual({
         id: 'jira.open-issues',
         title: 'Jira open blocking tickets',
@@ -117,7 +99,6 @@ describe('JiraOpenIssuesProvider', () => {
       it('should return default config', () => {
         const provider = JiraOpenIssuesProvider.fromConfig(
           new ConfigReader({}),
-          mockOptions,
         );
         expect(provider.getMetricThresholds()).toEqual({
           rules: [
@@ -142,10 +123,8 @@ describe('JiraOpenIssuesProvider', () => {
             },
           },
         });
-        const provider = JiraOpenIssuesProvider.fromConfig(
-          configWithThresholds,
-          mockOptions,
-        );
+        const provider =
+          JiraOpenIssuesProvider.fromConfig(configWithThresholds);
         expect(provider.getMetricThresholds()).toEqual(customThresholds);
       });
     });
@@ -156,7 +135,6 @@ describe('JiraOpenIssuesProvider', () => {
       it('should create provider with default config', () => {
         const provider = JiraOpenIssuesProvider.fromConfig(
           new ConfigReader({}),
-          mockOptions,
         );
 
         expect(MockedJiraClientFactory.create).toHaveBeenCalledWith(
@@ -187,10 +165,8 @@ describe('JiraOpenIssuesProvider', () => {
           },
         });
 
-        const provider = JiraOpenIssuesProvider.fromConfig(
-          configWithThresholds,
-          mockOptions,
-        );
+        const provider =
+          JiraOpenIssuesProvider.fromConfig(configWithThresholds);
 
         expect(MockedJiraClientFactory.create).toHaveBeenCalledWith(
           configWithThresholds,
@@ -227,9 +203,9 @@ describe('JiraOpenIssuesProvider', () => {
           },
         });
 
-        expect(() =>
-          JiraOpenIssuesProvider.fromConfig(invalidConfig, mockOptions),
-        ).toThrow('Invalid thresholds');
+        expect(() => JiraOpenIssuesProvider.fromConfig(invalidConfig)).toThrow(
+          'Invalid thresholds',
+        );
         expect(mockedValidateThresholds).toHaveBeenCalledWith(
           invalidThresholds,
           'number',
@@ -247,7 +223,6 @@ describe('JiraOpenIssuesProvider', () => {
       it('should return the count of open issues', async () => {
         const provider = JiraOpenIssuesProvider.fromConfig(
           new ConfigReader({}),
-          mockOptions,
         );
 
         const result = await provider.calculateMetric(mockEntity);
@@ -269,7 +244,6 @@ describe('JiraOpenIssuesProvider', () => {
       it('should propagate errors from Jira client', async () => {
         const provider = JiraOpenIssuesProvider.fromConfig(
           new ConfigReader({}),
-          mockOptions,
         );
 
         await expect(provider.calculateMetric(mockEntity)).rejects.toThrow(