add limit on returning number of spaces on dashboard; retrieve invitations as count #4907
+55
−5
Conversation
This file contains 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
WalkthroughThis pull request adds a new resolver method, Changes
Sequence Diagram(s)sequenceDiagram
participant Client as Client
participant Resolver as MeResolverFields
participant Service as MeService
participant Roles as RolesService
Client->>Resolver: Query communityInvitationsCount(agentInfo, states)
Resolver->>Resolver: Validate agentInfo (throw exception if userID is empty)
Resolver->>Service: getCommunityInvitationsCountForUser(userId, states)
Service->>Roles: getCommunityInvitationsForUser(userId, states)
Roles-->>Service: Return invitation list
Service-->>Resolver: Return invitation count
Resolver-->>Client: Return count result
sequenceDiagram
participant Client as Client
participant Resolver as MeResolverFields
participant Service as MeService
Client->>Resolver: Query spaceMembershipsHierarchical(agentInfo, limit)
Resolver->>Service: getCommunityMembershipsHierarchical(agentInfo, limit)
Service-->>Resolver: Return limited hierarchical spaces
Resolver-->>Client: Return memberships result
Possibly related PRs
Suggested reviewers
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
src/services/api/me/me.resolver.fields.ts (1)
58-83: Add input validation for states array.While the userID validation is good, consider adding validation for the states array to ensure it contains valid state values.
public async communityInvitationsCount( @CurrentUser() agentInfo: AgentInfo, @Args({ name: 'states', nullable: true, type: () => [String], description: 'The state names you want to filter on', }) states: string[] ): Promise<number> { if (agentInfo.userID === '') { throw new ValidationException( 'Unable to retrieve invitations as no userID provided.', LogContext.COMMUNITY ); } + if (states?.length > 0) { + const validStates = ['pending', 'accepted', 'rejected']; // Add your valid states here + const invalidStates = states.filter(state => !validStates.includes(state)); + if (invalidStates.length > 0) { + throw new ValidationException( + `Invalid states provided: ${invalidStates.join(', ')}`, + LogContext.COMMUNITY + ); + } + } return this.meService.getCommunityInvitationsCountForUser( agentInfo.userID, states ); }src/services/api/me/me.service.ts (1)
185-198: Use immutable array operations for limiting spaces.The current implementation modifies the original array using splice. Consider using slice instead to avoid potential side effects.
const levelZeroSpacesRaw = this.filterSpacesByLevel( sortedFlatListSpacesWithMembership, SpaceLevel.L0 ); + const limitedLevelZeroSpaces = limit + ? levelZeroSpacesRaw.slice(0, limit) + : levelZeroSpacesRaw; - if (limit) { - levelZeroSpacesRaw.splice(limit); - }
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/services/api/me/me.resolver.fields.ts(2 hunks)src/services/api/me/me.service.ts(3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
src/services/api/me/me.resolver.fields.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/services/api/me/me.service.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
Comment on lines
+33
to
+42
| public async getCommunityInvitationsCountForUser( | ||
| userId: string, | ||
| states?: string[] | ||
| ): Promise<number> { | ||
| const invitations = await this.rolesService.getCommunityInvitationsForUser( | ||
| userId, | ||
| states | ||
| ); | ||
| return invitations.length; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Optimize count retrieval for better performance.
The current implementation fetches all invitations just to get the count. Consider adding a dedicated count method in rolesService to avoid fetching unnecessary data.
public async getCommunityInvitationsCountForUser(
userId: string,
states?: string[]
): Promise<number> {
- const invitations = await this.rolesService.getCommunityInvitationsForUser(
+ return this.rolesService.getCommunityInvitationsCountForUser(
userId,
states
);
- return invitations.length;
}📝 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
| public async getCommunityInvitationsCountForUser( | |
| userId: string, | |
| states?: string[] | |
| ): Promise<number> { | |
| const invitations = await this.rolesService.getCommunityInvitationsForUser( | |
| userId, | |
| states | |
| ); | |
| return invitations.length; | |
| } | |
| public async getCommunityInvitationsCountForUser( | |
| userId: string, | |
| states?: string[] | |
| ): Promise<number> { | |
| return this.rolesService.getCommunityInvitationsCountForUser( | |
| userId, | |
| states | |
| ); | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary by CodeRabbit