tech-insights: ability to add filters on the checks by surajnarwade · Pull Request #6697 · backstage/community-plugins

surajnarwade · 2025-12-31T12:26:02Z

This PR solves this issue: #4259

Hey, I just made a Pull Request!

✔️ 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)
All your commits have a Signed-off-by line in the message. (more info)

backstage-goalie · 2025-12-31T12:26:26Z

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
backend	workspaces/tech-insights/packages/backend	none	`v0.0.11`
@backstage-community/plugin-tech-insights-backend-module-jsonfc	workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc	patch	`v0.7.1`
@backstage-community/plugin-tech-insights-common	workspaces/tech-insights/plugins/tech-insights-common	patch	`v0.8.1`

...ghts-backend-module-jsonfc/src/module/techInsightsModuleJsonRulesEngineFactCheckerFactory.ts

...sights/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.ts

PatrickFrueh

Solved from the tag-filtering use-case perspective. The changes in src/service/JsonRulesEngineFactChecker.ts:L181-184 correctly handle array values via contains semantics. LGTM 👍

Thanks again for the quick update!

kurtaking · 2026-01-10T15:30:18Z

@surajnarwade, I see dependency updates, along with other updates now. Assuming that's to make CI happy?

It would be better if the plugin owners would upgrade to latest version of backstage and solve node24 issues outside of this feature request.

awanlin · 2026-01-10T15:47:49Z

@surajnarwade, the Tech insights version bump to 1.46.x has been merged, please rebase as that should help with some of the errors you are running into.

surajnarwade · 2026-01-10T23:44:22Z

@kurtaking @awanlin thank you so much for the comments 🙏 I have rebased my PR, can you please review again :)

workspaces/tech-insights/package.json

workspaces/tech-insights/plugins/tech-insights-common/src/types/checks.ts

Earlier I tried this in my other PR: backstage#6697 but to make that PR smaller and easier to review I have raised this separate PR to upgrade typescript version. This PR upgrades typescript version and updates respective api report and knip report. once this is merged, I will rebase my other PR. Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

surajnarwade · 2026-01-17T17:53:55Z

I have added typescript version in separate PR: #6956 once its merged. I will rebase this current PR so hopefully it's easy to review :)

Copilot

Pull request overview

This PR adds the ability to filter tech-insights checks based on entity criteria, addressing issue #4259. The feature allows users to selectively apply checks only to entities that match specific filter conditions (e.g., only production components, only APIs, etc.), improving flexibility and reducing unnecessary check executions.

Changes:

Added optional filter property to the Check interface supporting entity property matching with dot notation for nested fields
Implemented filter evaluation logic with case-insensitive string comparison and support for OR/AND logic
Integrated catalog service to fetch entity metadata for filter matching with graceful fallback when unavailable
Added comprehensive test coverage for various filter scenarios including edge cases

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
workspaces/tech-insights/plugins/tech-insights-common/src/types/checks.ts	Added optional `filter` property to Check interface type definition
workspaces/tech-insights/plugins/tech-insights-common/report.api.md	Updated API report with new filter property
workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/src/service/config.ts	Added filter reading logic from configuration
workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.ts	Implemented filter matching logic with catalog integration and fallback behavior
workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.test.ts	Added comprehensive test coverage for filter functionality
workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/src/module/techInsightsModuleJsonRulesEngineFactCheckerFactory.ts	Injected catalog and auth services into module
workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/package.json	Added required dependencies for catalog integration
workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/README.md	Documented filter feature with usage examples
workspaces/tech-insights/packages/backend/src/index.ts	Updated example backend to include catalog and auth services
workspaces/tech-insights/packages/backend/package.json	Added catalog-node dependency
workspaces/tech-insights/.changeset/brave-radios-breathe.md	Added changeset documenting the feature
workspaces/tech-insights/yarn.lock	Updated lockfile with new dependencies

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/README.md

workspaces/tech-insights/plugins/tech-insights-common/src/types/checks.ts

workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/src/service/config.ts

...sights/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.ts

Copilot · 2026-01-23T21:14:16Z

workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/README.md

+                operator: equal
+                value: true
+```
+


The filter documentation should explain the fallback behavior when the catalog service is unavailable. Currently, if catalog/auth services are not provided or entity fetch fails, all checks run without filtering. This is a sensible fallback but should be documented so users understand the behavior and don't assume checks are being filtered when they aren't.

Consider adding a note like: "Note: If the catalog service is unavailable, checks with filters will run against all entities as a fallback to ensure checks continue to function."

Suggested change

> Note: If the catalog (or auth) service is unavailable, or if entity fetching fails, checks that are configured with filters will run against all entities as a fallback to ensure checks continue to function. In this scenario, no filtering is applied.

@surajnarwade - this would be nice.

I have updated the README :)

Copilot

Pull request overview

Copilot reviewed 12 out of 13 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

workspaces/tech-insights/plugins/tech-insights-backend-module-jsonfc/src/service/config.ts

...sights/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.ts

...s/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.test.ts

kurtaking · 2026-01-28T18:57:27Z

@Xantier, @punkle - this is ready for an additional set of eyes. Ready to approve on my end.

Xantier · 2026-01-29T07:34:37Z

...sights/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.ts

+    // Only fetch entity from catalog if there are checks with filter criteria
+    // This optimization avoids unnecessary catalog API calls
+    if (checksWithFilters.length > 0) {
+      const catalogEntity = await this.fetchEntityFromCatalog(entity);


We should be able to simplify this quite a bit if we, instead of getting the entity by ref, get entities based on the filter and assert that the entity is found. That would move the filtering logic to match whatever catalog does and would be automatically receiving the updates if the catalog filtering logic changes. I think this is good enough for now though

do you mean instead of using:

this.catalog.getEntityByRef

I should use this, provide filter argument, instead of implementing filter logic ourselves?

this.catalog.getEntities

That would be though process here. There are downsides on both approaches (DB load <> maintainability) I don't know if Backstage currently exposes the filtering logic for this kind of reverse entity filtering that you constructed but if it that is available in a public library, that could be a case. Either way, if you add the test cases and modify your reverse entity filter implementation to match what is documented here: https://backstage.io/docs/features/software-catalog/catalog-customization/#entity-filters we should be golden.

I had a chat with @kurtaking previously on this PR (link to chat) regarding the predicate based filtering. I think there's PR upstream: backstage/backstage#32282 for the same.

I think we can go ahead with current implementation for now and then update the filtering once upstream one is merged?

current link which you had linked is only available in the frontend atm?

yup, sounds good

Xantier · 2026-01-29T07:36:11Z

...s/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.test.ts

      },
    },
  ],
+


Can you add test cases for annotation value matching, "contains annotation" (value doesn't matter), and the negative cases ($not, $all etc.)

sure thing, I will add more test cases, thank you :)

these new tests would be for the predicate based filtering right?

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

surajnarwade · 2026-01-29T14:07:57Z

Hi @Xantier @kurtaking I have added annotations related tests and as discussed earlier, we can skip the predicate based filtering for now :)

* tech-insights: ability to add filters on the checks Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * auth & catalog should not be optional Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * pass filtered checks array to ruleEngineResultsToCheckResponse Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * update the test Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * update api report Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * remove unnecessary code Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * update changeset Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * make auth and catalog optional Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * update report and add test Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * update tests Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * remove commented test Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * update README.md Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * update lockfile Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * update dependencies to use backstage versions Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> * add annotations related tests Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk> --------- Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

backstage-service added the workspace/tech-insights Used to tag tech-insights workspace issues and pull requests label Dec 31, 2025

surajnarwade changed the title ~~Feat checks filter~~ tech-insights: ability to add filters on the checks Dec 31, 2025

surajnarwade force-pushed the feat-checks-filter branch 2 times, most recently from cf031e1 to d16ac69 Compare December 31, 2025 12:29

surajnarwade mentioned this pull request Dec 31, 2025

🚀 tech-insights: Ability to add filters on the checks under techInsights.factChecker #4259

Closed

2 tasks

surajnarwade marked this pull request as ready for review December 31, 2025 12:30

surajnarwade requested review from a team, Xantier and punkle as code owners December 31, 2025 12:30

surajnarwade requested review from awanlin and removed request for a team December 31, 2025 12:30

kurtaking reviewed Dec 31, 2025

View reviewed changes

...ghts-backend-module-jsonfc/src/module/techInsightsModuleJsonRulesEngineFactCheckerFactory.ts Outdated Show resolved Hide resolved

surajnarwade requested a review from kurtaking January 2, 2026 10:30

surajnarwade force-pushed the feat-checks-filter branch from e9054bb to d4ab081 Compare January 4, 2026 15:48

PatrickFrueh reviewed Jan 7, 2026

View reviewed changes

...sights/plugins/tech-insights-backend-module-jsonfc/src/service/JsonRulesEngineFactChecker.ts Show resolved Hide resolved

surajnarwade requested a review from PatrickFrueh January 7, 2026 14:41

surajnarwade force-pushed the feat-checks-filter branch from 57a994d to 2a73106 Compare January 7, 2026 14:42

PatrickFrueh approved these changes Jan 9, 2026

View reviewed changes

kurtaking mentioned this pull request Jan 10, 2026

update tech insights to more recent backstage version #6833

Closed

5 tasks

surajnarwade force-pushed the feat-checks-filter branch from 2a73106 to a8ca195 Compare January 10, 2026 23:38

kurtaking reviewed Jan 14, 2026

View reviewed changes

workspaces/tech-insights/package.json Outdated Show resolved Hide resolved

kurtaking reviewed Jan 14, 2026

View reviewed changes

workspaces/tech-insights/plugins/tech-insights-common/src/types/checks.ts Show resolved Hide resolved

surajnarwade mentioned this pull request Jan 17, 2026

tech-insights: update typescript version #6956

Closed

5 tasks

surajnarwade requested a review from kurtaking January 17, 2026 17:54

kurtaking requested a review from Copilot January 23, 2026 21:09

kurtaking assigned surajnarwade Jan 23, 2026

Copilot started reviewing on behalf of kurtaking January 23, 2026 21:09 View session

Copilot AI reviewed Jan 23, 2026

View reviewed changes

surajnarwade requested review from Copilot and kurtaking January 24, 2026 16:19

Copilot AI reviewed Jan 24, 2026

View reviewed changes

Xantier reviewed Jan 29, 2026

View reviewed changes

surajnarwade added 12 commits January 29, 2026 12:22

tech-insights: ability to add filters on the checks

6b87122

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

auth & catalog should not be optional

2216dc7

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

pass filtered checks array to ruleEngineResultsToCheckResponse

c0eef87

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

update the test

01996c0

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

update api report

b48b8fd

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

remove unnecessary code

3536272

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

update changeset

34d35db

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

make auth and catalog optional

a95f429

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

update report and add test

0e91b11

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

update tests

71b65df

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

remove commented test

1b366b4

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

update README.md

44d18e8

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

surajnarwade force-pushed the feat-checks-filter branch from 17f9ddf to 44d18e8 Compare January 29, 2026 12:27

surajnarwade added 3 commits January 29, 2026 12:29

update lockfile

e3d74e7

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

update dependencies to use backstage versions

6b39063

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

add annotations related tests

58e64ec

Signed-off-by: surajnarwade <suraj.narwade@mettle.co.uk>

Xantier approved these changes Jan 29, 2026

View reviewed changes

kurtaking merged commit 2d9ce90 into backstage:main Jan 30, 2026
13 checks passed



	> Note: If the catalog (or auth) service is unavailable, or if entity fetching fails, checks that are configured with filters will run against all entities as a fallback to ensure checks continue to function. In this scenario, no filtering is applied.

Conversation

surajnarwade commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Hey, I just made a Pull Request!

✔️ Checklist

Uh oh!

backstage-goalie bot commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changed Packages

Uh oh!

Uh oh!

Uh oh!

PatrickFrueh left a comment

Choose a reason for hiding this comment

Uh oh!

kurtaking commented Jan 10, 2026

Uh oh!

awanlin commented Jan 10, 2026

Uh oh!

surajnarwade commented Jan 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

surajnarwade commented Jan 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kurtaking commented Jan 28, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

surajnarwade Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

surajnarwade commented Jan 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

surajnarwade commented Dec 31, 2025 •

edited

Loading

backstage-goalie bot commented Dec 31, 2025 •

edited

Loading

surajnarwade commented Jan 10, 2026 •

edited

Loading

surajnarwade Jan 29, 2026 •

edited

Loading