Skip to content

fix(entity-feedback): Add link to feedback notifications #6611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kuangp merged 10 commits into from
Dec 24, 2025
Merged

fix(entity-feedback): Add link to feedback notifications #6611

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fe105e7
fix(entity-feedback): Add link to feedback notifications
west-david Dec 23, 2025
92b7cd7
Add changeset for notification link fix
west-david Dec 23, 2025
8673378
test: Update tests to expect link field in notification payload
west-david Dec 23, 2025
a6d6143
feat: Make feedback notification URL configurable
west-david Dec 23, 2025
8875224
refactor: Derive entity URL from frontend routing for feedback notifi…
west-david Dec 23, 2025
bb144b6
style: Fix prettier formatting in FeedbackResponseDialog
west-david Dec 23, 2025
c7a27cf
chore: Update API report for FeedbackResponse link field
west-david Dec 24, 2025
fd04afb
test: Update DatabaseHandler test to expect link field in responses
west-david Dec 24, 2025
51b5aea
test: Add entityRouteRef to FeedbackResponseDialog test
west-david Dec 24, 2025
178f1ab
test: Update FeedbackResponseDialog test to expect link field
west-david Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/feedback-notification-links.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@backstage-community/plugin-entity-feedback-backend': patch
---

Add clickable link to feedback notifications. When entity owners receive notifications about new feedback, the notification now includes a link to navigate directly to the entity's feedback page.
2 changes: 2 additions & 0 deletions workspaces/entity-feedback/plugins/entity-feedback-backend/src/service/router.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,7 @@ describe('createRouter', () => {
payload: {
title: 'New feedback for component:default/service',
description: 'Comments: feedback',
link: '/catalog/default/component/service',
},
});
expect(response.status).toEqual(201);
Expand Down Expand Up @@ -357,6 +358,7 @@ describe('createRouter', () => {
payload: {
title: 'New feedback for component:default/service',
description: 'Comments: feedback',
link: '/catalog/default/component/service',
},
});
expect(response.status).toEqual(201);
Expand Down
17 changes: 17 additions & 0 deletions workspaces/entity-feedback/plugins/entity-feedback-backend/src/service/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import {
Entity,
RELATION_OWNED_BY,
stringifyEntityRef,
parseEntityRef,
} from '@backstage/catalog-model';
import { IdentityApi } from '@backstage/plugin-auth-node';
import {
Expand Down Expand Up @@ -227,9 +228,25 @@ export async function createRouter(
type: 'entity',
entityRef: entityOwner,
};

// Construct entity URL from entityRef using configurable pattern
const { kind, namespace, name } = parseEntityRef(req.params.entityRef);

// Allow customization of the feedback URL pattern via config
// Default: /catalog/:namespace/:kind/:name
const feedbackUrlPattern =
config.getOptionalString('entityFeedback.feedbackUrlPattern') ||
Copy link
Member

@kuangp kuangp Dec 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also define and document the new config - see https://backstage.io/docs/conf/defining for more info and the playlist plugin for an example: https://github.com/backstage/community-plugins/blob/main/workspaces/playlist/plugins/playlist/config.d.ts, https://github.com/backstage/community-plugins/blob/main/workspaces/playlist/plugins/playlist/package.json#L85 see comment below

Copy link
Member

@kuangp kuangp Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually another option which may be more robust is to send this info from the frontend plugin since the routing can be derived there automatically:

if you can emulate what's done here to derive the route of the entity: https://github.com/backstage/backstage/blob/fea3e3972daf42fc75c107568a693eeb14a4d672/plugins/catalog-react/src/components/EntityRefLink/EntityRefLink.tsx#L84-L88, then pass it along in the request to the backend here:

community-plugins/workspaces/entity-feedback/plugins/entity-feedback/src/components/FeedbackResponseDialog/FeedbackResponseDialog.tsx

Line 132 in 4d58c3f

await feedbackApi.recordResponse(stringifyEntityRef(entity), {
, it would be available in this express route for it to be included in the notification payload

The benefit of the above is that it will always consistently construct the appropriate entity url (including custom ones) without any additional configuration from the consumer

'/catalog/:namespace/:kind/:name';

const entityUrl = feedbackUrlPattern
.replace(':kind', kind)
.replace(':namespace', namespace)
.replace(':name', name);

const payload: NotificationPayload = {
title: `New feedback for ${req.params.entityRef}`,
description: `Comments: ${JSON.parse(comments).additionalComments}`,
link: entityUrl,
};
await notificationService.send({
recipients,
Expand Down
Loading