feat: filter out closed issues in dashboard issue mapping #4976
+22
−14
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Neil <neiljar888@gmail.com>
neiljar
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
princerajpoot20 and
sambhavgupta0705
as code owners
Contributor
📝 WalkthroughWalkthroughThe changes enhance the dashboard's good first issues feature to include issue state tracking. A state field is added to the GraphQL query schema, type definitions are extended to include the state property, and the mapping function is updated to filter for OPEN issues only while preserving the state in the output. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
❌ Deploy Preview for asyncapi-website failed.Built without sensitive environment variables
|
![coderabbitai[bot]](https://waps.l3s.uni-hannover.de/live/im_/https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@scripts/dashboard/build-dashboard.ts`:
- Around line 273-288: The new strict filter in mapGoodFirstIssues is dropping
legacy fixtures that omit state; update the function mapGoodFirstIssues to
handle missing state by treating undefined as 'OPEN' (e.g., use (issue.state ??
'OPEN') === 'OPEN') or remove the filter and handle state on MappedIssue
consumers, and update any GoodFirstIssues test fixtures to include state: 'OPEN'
to keep tests deterministic; touch the mapGoodFirstIssues implementation and
related test fixtures (GoodFirstIssues / MappedIssue) accordingly.
Comment on lines
273
to
+288
| async function mapGoodFirstIssues(issues: GoodFirstIssues[]): Promise<MappedIssue[]> { | ||
| return issues.map((issue) => ({ | ||
| id: issue.id, | ||
| title: issue.title, | ||
| isAssigned: !!issue.assignees.totalCount, | ||
| resourcePath: issue.resourcePath, | ||
| repo: `asyncapi/${issue.repository.name}`, | ||
| author: issue.author.login, | ||
| area: getLabel(issue, 'area/') || 'Unknown', | ||
| labels: issue.labels!.nodes.filter( | ||
| (label) => !label.name.startsWith('area/') && !label.name.startsWith('good first issue') | ||
| ) | ||
| })); | ||
| return issues | ||
| .filter((issue) => issue.state === 'OPEN') | ||
| .map((issue) => ({ | ||
| id: issue.id, | ||
| title: issue.title, | ||
| isAssigned: !!issue.assignees.totalCount, | ||
| resourcePath: issue.resourcePath, | ||
| repo: `asyncapi/${issue.repository.name}`, | ||
| author: issue.author.login, | ||
| area: getLabel(issue, 'area/') || 'Unknown', | ||
| labels: issue.labels!.nodes.filter( | ||
| (label) => !label.name.startsWith('area/') && !label.name.startsWith('good first issue') | ||
| ), | ||
| state: issue.state | ||
| })); |
Contributor
There was a problem hiding this comment.
Fix failing tests: new state filter drops items when state is missing.
With the new issue.state === 'OPEN' filter, any fixtures/mocks lacking state will be filtered out, which matches the reported failures (empty/undefined results). Update test fixtures/mocks to include state: 'OPEN' (or adjust expectations), or add a backward‑compatible fallback if legacy data can omit state. Based on pipeline failures, ...
🔧 Optional defensive fallback (keeps legacy fixtures working)
- return issues
- .filter((issue) => issue.state === 'OPEN')
+ return issues
+ .filter((issue) => (issue.state ?? 'OPEN') === 'OPEN')
.map((issue) => ({
id: issue.id,
title: issue.title,
isAssigned: !!issue.assignees.totalCount,
resourcePath: issue.resourcePath,
repo: `asyncapi/${issue.repository.name}`,
author: issue.author.login,
area: getLabel(issue, 'area/') || 'Unknown',
labels: issue.labels!.nodes.filter(
(label) => !label.name.startsWith('area/') && !label.name.startsWith('good first issue')
),
state: issue.state
}));📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| async function mapGoodFirstIssues(issues: GoodFirstIssues[]): Promise<MappedIssue[]> { | |
| return issues.map((issue) => ({ | |
| id: issue.id, | |
| title: issue.title, | |
| isAssigned: !!issue.assignees.totalCount, | |
| resourcePath: issue.resourcePath, | |
| repo: `asyncapi/${issue.repository.name}`, | |
| author: issue.author.login, | |
| area: getLabel(issue, 'area/') || 'Unknown', | |
| labels: issue.labels!.nodes.filter( | |
| (label) => !label.name.startsWith('area/') && !label.name.startsWith('good first issue') | |
| ) | |
| })); | |
| return issues | |
| .filter((issue) => issue.state === 'OPEN') | |
| .map((issue) => ({ | |
| id: issue.id, | |
| title: issue.title, | |
| isAssigned: !!issue.assignees.totalCount, | |
| resourcePath: issue.resourcePath, | |
| repo: `asyncapi/${issue.repository.name}`, | |
| author: issue.author.login, | |
| area: getLabel(issue, 'area/') || 'Unknown', | |
| labels: issue.labels!.nodes.filter( | |
| (label) => !label.name.startsWith('area/') && !label.name.startsWith('good first issue') | |
| ), | |
| state: issue.state | |
| })); | |
| async function mapGoodFirstIssues(issues: GoodFirstIssues[]): Promise<MappedIssue[]> { | |
| return issues | |
| .filter((issue) => (issue.state ?? 'OPEN') === 'OPEN') | |
| .map((issue) => ({ | |
| id: issue.id, | |
| title: issue.title, | |
| isAssigned: !!issue.assignees.totalCount, | |
| resourcePath: issue.resourcePath, | |
| repo: `asyncapi/${issue.repository.name}`, | |
| author: issue.author.login, | |
| area: getLabel(issue, 'area/') || 'Unknown', | |
| labels: issue.labels!.nodes.filter( | |
| (label) => !label.name.startsWith('area/') && !label.name.startsWith('good first issue') | |
| ), | |
| state: issue.state | |
| })); | |
| } |
🤖 Prompt for AI Agents
In `@scripts/dashboard/build-dashboard.ts` around lines 273 - 288, The new strict
filter in mapGoodFirstIssues is dropping legacy fixtures that omit state; update
the function mapGoodFirstIssues to handle missing state by treating undefined as
'OPEN' (e.g., use (issue.state ?? 'OPEN') === 'OPEN') or remove the filter and
handle state on MappedIssue consumers, and update any GoodFirstIssues test
fixtures to include state: 'OPEN' to keep tests deterministic; touch the
mapGoodFirstIssues implementation and related test fixtures (GoodFirstIssues /
MappedIssue) accordingly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR #4940
Summary by CodeRabbit
New Features
Bug Fixes
✏️ Tip: You can customize this high-level summary in your review settings.