feat(scorecard): add database and schedulers #1544

dzemanov · 2025-09-29T11:30:31Z

Hey, I just made a Pull Request!

Adds database.
Adds schedulers.

Fixes

https://issues.redhat.com/browse/RHIDP-8717

How to test

Use sqllite database

backend:
  database:
    client: better-sqlite3
    connection:
      directory: './db'

Creates db directory under scorecard/packages
Or:

backend:
  database:
    client: better-sqlite3
    connection: ':memory:'

Use Postgres db

backend:
  database:
    client: pg
    connection:
      host: localhost
      port: 5432
      user: ${POSTGRES_USER}
      password:${POSTGRES_PASSWORD}

For testing purposes, you can update schedule to fetch metrics more often:

scorecard:
  dataRetentionDays: 1
  plugins:
    jira:
      open_issues:
        schedule:
          frequency: { minutes: 2 }
          timeout: { minutes: 15 }
          initialDelay: { seconds: 3 }
    github:
      open_prs:
        schedule:
          frequency: { minutes: 2 }
          timeout: { minutes: 15 }
          initialDelay: { seconds: 3 }

You should see in logs:

2025-10-03T19:46:36.590Z scorecard info Task worker starting: github.open_prs, {"version":2,"cadence":"PT2M","initialDelayDuration":"PT3S","timeoutAfterDuration":"PT15M"} task="github.open_prs"
2025-10-03T19:46:36.591Z scorecard info Task worker starting: jira.open_issues, {"version":2,"cadence":"PT2M","initialDelayDuration":"PT3S","timeoutAfterDuration":"PT15M"} task="jira.open_issues"
2025-10-03T19:46:36.591Z scorecard info Scheduled 2/2 metric providers 

2025-10-03T19:46:39.595Z scorecard info Refreshing metrics for github.open_prs class="MetricProvidersScheduler" taskId="github.open_prs:refresh" taskInstanceId="8ba58bad-08e8-4005-8b7f-314fde6e3bb9"
2025-10-03T19:46:39.596Z scorecard info Refreshing metrics for jira.open_issues class="MetricProvidersScheduler" taskId="jira.open_issues:refresh" taskInstanceId="026e7e65-085a-4592-956d-df554f697b4c"

2025-10-03T19:46:40.543Z scorecard info Completed metric refresh for jira.open_issues: processed 2 entities class="MetricProvidersScheduler" taskId="jira.open_issues:refresh" taskInstanceId="026e7e65-085a-4592-956d-df554f697b4c"
2025-10-03T19:46:40.758Z scorecard info Completed metric refresh for github.open_prs: processed 3 entities class="MetricProvidersScheduler" taskId="github.open_prs:refresh" taskInstanceId="8ba58bad-08e8-4005-8b7f-314fde6e3bb9"

✔️ Checklist

A changeset describing the change and affected packages. (more info)
Added or Updated documentation
Tests for new functionality and regression tests for bug fixes
Screenshots attached (for UI changes)

rhdh-gh-app · 2025-09-29T13:29:55Z

Important

This PR includes changes that affect public-facing API. Please ensure you are adding/updating documentation for new features or behavior.

Unexpected Changesets

The following changeset(s) reference packages that have not been changed in this PR:

/home/runner/work/rhdh-plugins/rhdh-plugins/workspaces/scorecard/.changeset/olive-months-cross.md: @red-hat-developer-hub/backstage-plugin-scorecard

Note that only changes that affect the published package require changesets, for example changes to tests and storybook stories do not require changesets.

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-github	workspaces/scorecard/plugins/scorecard-backend-module-github	minor	`v1.0.0`
@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-jira	workspaces/scorecard/plugins/scorecard-backend-module-jira	minor	`v1.0.1`
@red-hat-developer-hub/backstage-plugin-scorecard-backend	workspaces/scorecard/plugins/scorecard-backend	minor	`v1.0.0`
@red-hat-developer-hub/backstage-plugin-scorecard-node	workspaces/scorecard/plugins/scorecard-node	minor	`v1.0.0`

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Signed-off-by: Ihor Mykhno <imykhno@redhat.com>

dzemanov · 2025-10-27T09:13:51Z

workspaces/scorecard/plugins/scorecard-backend/src/scheduler/index.ts

Would rename to Scheduler since you already have scheduler.test.ts

I propose renaming the tests from scheduler.test.ts to index.test.ts for better code consistency. The reason is that if we rename the file as you propose, the imports will look strange. For example: import { Scheduler } from './scheduler/scheduler'. I think we can avoid this awkward import

dzemanov · 2025-10-27T14:54:53Z

workspaces/scorecard/plugins/scorecard-backend/src/scheduler/constants.ts

+ * limitations under the License.
+ */
+
+export const CLEANUP_EXPIRED_METRICS_ID = 'cleanup-expired-metrics' as const;


Would maybe prefix it with scorecard: just to be sure it doesn't intersect anything.

dzemanov · 2025-10-27T15:01:15Z

workspaces/scorecard/plugins/scorecard-backend/src/scheduler/tasks/PullMetricsByProviderTask.ts

+    private readonly scheduler: SchedulerService,
+    private readonly logger: LoggerService,
+    private readonly database: DatabaseMetricValues,
+    private readonly config: Config,
+    private readonly catalog: CatalogService,
+    private readonly auth: AuthService,
+    private readonly provider: MetricProvider,


This to me looks like a lot of params. Just a recommendation, we could group under options or similiar name all except provider.

dzemanov · 2025-10-27T15:06:57Z

workspaces/scorecard/.changeset/free-rice-pick.md

+'@red-hat-developer-hub/backstage-plugin-scorecard': minor
+---
+
+Adds database persistence and scheduled metric collection.


I would add breaking here since we are now requiring getCatalogFilter
**BREAKING**: ...

Add information about what is breaking - getCatalogFilter

gashcrumb · 2025-10-27T17:30:43Z

workspaces/scorecard/plugins/scorecard-backend/src/scheduler/tasks/CleanupExpiredMetricsTask.ts

+        `Deleted ${deletedCount} expired metrics older than ${dataRetentionDays} days`,
+      );
+    } catch (error) {
+      logger.error(`Failed to cleanup expired metrics:`, error);


Do we need this line here, as it's already on line 61? Or is there another spot where this function is called from that could expect to receive the exception thrown on the next line?

Thank you for your comment, this logger is not necessary I will remove it

Signed-off-by: Ihor Mykhno <imykhno@redhat.com>

sonarqubecloud · 2025-10-30T17:16:35Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

openshift-ci bot added the do-not-merge/work-in-progress label Sep 29, 2025

dzemanov force-pushed the scorecard-db-schedulers branch from 2d44cf7 to 7449254 Compare September 29, 2025 13:29

dzemanov force-pushed the scorecard-db-schedulers branch from 7449254 to 97b6ba1 Compare October 3, 2025 18:10

imykhno force-pushed the scorecard-db-schedulers branch 5 times, most recently from 07a5a55 to 5e87ead Compare October 20, 2025 10:03

imykhno marked this pull request as ready for review October 20, 2025 10:12

imykhno requested review from a team, Eswaraiahsapram, christoph-jerolimov and its-mitesh-kumar as code owners October 20, 2025 10:12

openshift-ci bot removed the do-not-merge/work-in-progress label Oct 20, 2025

dzemanov added 14 commits October 24, 2025 14:47

Introduce metric_values db

ee72466

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Connect metric providers on schedule

1ba8e5d

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Add catalog entities processing to providers

dc681f1

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Extract to BaseMetricProvider

4bc3731

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Rename metricValue row

34cc322

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Integrate db read to metrics endpoint

37d260e

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Use directly catalogService in CatalogMetricService

46cb16b

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Remove not needed readMetricValues

2e20064

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Switch db value to json

9e7dd06

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Extract scheduling to scorecard backend

dd7b15c

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Simplify DatabaseMetricValuesStore

23ddda4

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Add tests

59dfc1a

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Update docs

88f4c12

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Increate timeout for db

f7fc377

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

feat(scorecard): implement cleanup expired metrics mechanism

d4b800b

Signed-off-by: Ihor Mykhno <imykhno@redhat.com>

imykhno force-pushed the scorecard-db-schedulers branch from 5e87ead to 2883b1d Compare October 24, 2025 12:49

refactor(scorecard): logic to load and cleanup metrics

2964f31

Signed-off-by: Ihor Mykhno <imykhno@redhat.com>

imykhno force-pushed the scorecard-db-schedulers branch from 2883b1d to 2964f31 Compare October 24, 2025 14:18

dzemanov commented Oct 27, 2025

View reviewed changes

gashcrumb reviewed Oct 27, 2025

View reviewed changes

gashcrumb approved these changes Oct 27, 2025

View reviewed changes

imykhno force-pushed the scorecard-db-schedulers branch from 1747733 to a127942 Compare October 30, 2025 17:09

refactor(scorecard): scorecard metric loading logic

12fae92

Signed-off-by: Ihor Mykhno <imykhno@redhat.com>

imykhno force-pushed the scorecard-db-schedulers branch from a127942 to 12fae92 Compare October 30, 2025 17:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(scorecard): add database and schedulers #1544

feat(scorecard): add database and schedulers #1544

Uh oh!

dzemanov commented Sep 29, 2025 •

edited by imykhno

Loading

Uh oh!

rhdh-gh-app bot commented Sep 29, 2025 •

edited

Loading

Uh oh!

dzemanov Oct 27, 2025

Uh oh!

imykhno Oct 30, 2025

Uh oh!

dzemanov Oct 27, 2025

Uh oh!

dzemanov Oct 27, 2025

Uh oh!

dzemanov Oct 27, 2025

Uh oh!

gashcrumb Oct 27, 2025

Uh oh!

imykhno Oct 30, 2025

Uh oh!

sonarqubecloud bot commented Oct 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat(scorecard): add database and schedulers #1544

Are you sure you want to change the base?

feat(scorecard): add database and schedulers #1544

Uh oh!

Conversation

dzemanov commented Sep 29, 2025 • edited by imykhno Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Hey, I just made a Pull Request!

Fixes

How to test

✔️ Checklist

Uh oh!

rhdh-gh-app bot commented Sep 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unexpected Changesets

Changed Packages

Uh oh!

dzemanov Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

imykhno Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

dzemanov Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

dzemanov Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

dzemanov Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

gashcrumb Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

imykhno Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Oct 30, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dzemanov commented Sep 29, 2025 •

edited by imykhno

Loading

rhdh-gh-app bot commented Sep 29, 2025 •

edited

Loading