Skip to content

Expose Project.membership(user: ID) #3508

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.

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

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

CarsonF
Copy link
Member

@CarsonF CarsonF commented Jun 20, 2025

This should allow an enriched project list on the user page.

query UserProjects($user: ID!) {
  user(id: $user) {
    projects(input: { filter: { members: { user: { id: $user } } } }) {
      ...normalProjectColumns
      membership(user: $user) {
        roles {
          value
        }
      }
    }
  }
}

Copy link

coderabbitai bot commented Jun 20, 2025

📝 Walkthrough

Walkthrough

This change introduces a new mechanism for efficiently resolving project membership by project and user IDs. It adds a data loader, a corresponding repository method, and a GraphQL resolver for batch loading project membership information. The ProjectMember DTO is extended with a typed project link, and supporting methods are added to the repository and service layers.

Changes

File(s) Change Summary
project-member.dto.ts Added readonly project: LinkTo<'Project'> property to ProjectMember class; updated import for LinkTo type.
member-project-connection.resolver.ts Introduced MemberProjectConnectionResolver GraphQL resolver for membership field resolution by project/user IDs.
membership-by-project-and-user.loader.ts Added MembershipByProjectAndUserLoader for batching/caching membership fetches; defined related input interface.
project-member.gel.repository.ts Added readManyByProjectAndUser method for batch GEL queries by project/user pairs; updated hydration logic.
project-member.module.ts Registered MemberProjectConnectionResolver as a provider in the module.
project-member.repository.ts Added readManyByProjectAndUser method for batch DB queries; hydrate now merges project ID with user DTO.
project-member.service.ts Added readManyByProjectAndUser method for batch membership fetch and secure mapping; updated imports.
user/dto/list-users.dto.ts Decorated id property in UserFilters class with @IdField({ optional: true }) replacing plain optional field.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4959099 and b3895f3.

📒 Files selected for processing (7)
  • src/components/project/project-member/member-project-connection.resolver.ts (1 hunks)
  • src/components/project/project-member/membership-by-project-and-user.loader.ts (1 hunks)
  • src/components/project/project-member/project-member.gel.repository.ts (2 hunks)
  • src/components/project/project-member/project-member.module.ts (2 hunks)
  • src/components/project/project-member/project-member.repository.ts (2 hunks)
  • src/components/project/project-member/project-member.service.ts (2 hunks)
  • src/components/user/dto/list-users.dto.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (6)
  • src/components/project/project-member/project-member.module.ts
  • src/components/project/project-member/project-member.gel.repository.ts
  • src/components/project/project-member/member-project-connection.resolver.ts
  • src/components/project/project-member/project-member.repository.ts
  • src/components/project/project-member/membership-by-project-and-user.loader.ts
  • src/components/project/project-member/project-member.service.ts
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/components/user/dto/list-users.dto.ts (1)
src/common/id-field.ts (1)
  • IdField (9-19)
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: E2E Tests (neo4j 1/6)
  • GitHub Check: E2E Tests (neo4j 2/6)
  • GitHub Check: E2E Tests (neo4j 6/6)
  • GitHub Check: E2E Tests (neo4j 4/6)
  • GitHub Check: E2E Tests (neo4j 5/6)
  • GitHub Check: E2E Tests (neo4j 3/6)
  • GitHub Check: Unit
  • GitHub Check: lint
  • GitHub Check: Generate (base)
  • GitHub Check: Clean
  • GitHub Check: Generate (head)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
src/components/user/dto/list-users.dto.ts (1)

5-5: LGTM! Good standardization of ID field handling.

The addition of the IdField decorator improves consistency across the codebase and adds proper validation via the IsId decorator. The optional: true parameter correctly matches the TypeScript type definition.

Also applies to: 16-16

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Jun 20, 2025

🗞 GraphQL Summary

View schema changes
@@ -2318,8 +2318,9 @@
     includeInactive: Boolean
   ): Boolean!
   marketingLocation: SecuredLocation!
   marketingRegionOverride: SecuredLocation!
+  membership(user: ID!): ProjectMember!
   modifiedAt: DateTime!
   mouEnd: SecuredDateNullable!
   mouRange: SecuredDateRange!
   mouStart: SecuredDateNullable!
@@ -2861,8 +2862,9 @@
   """
   languageEngagements(input: EngagementListInput = {count: 25, order: ASC, page: 1, sort: "createdAt"}): SecuredLanguageEngagementList!
   marketingLocation: SecuredLocation!
   marketingRegionOverride: SecuredLocation!
+  membership(user: ID!): ProjectMember!
   modifiedAt: DateTime!
   mouEnd: SecuredDateNullable!
   mouRange: SecuredDateRange!
   mouStart: SecuredDateNullable!
@@ -2987,8 +2989,9 @@
   """
   languageEngagements(input: EngagementListInput = {count: 25, order: ASC, page: 1, sort: "createdAt"}): SecuredLanguageEngagementList!
   marketingLocation: SecuredLocation!
   marketingRegionOverride: SecuredLocation!
+  membership(user: ID!): ProjectMember!
   modifiedAt: DateTime!
   mouEnd: SecuredDateNullable!
   mouRange: SecuredDateRange!
   mouStart: SecuredDateNullable!
@@ -4729,8 +4732,9 @@
     includeInactive: Boolean
   ): Boolean!
   marketingLocation: SecuredLocation!
   marketingRegionOverride: SecuredLocation!
+  membership(user: ID!): ProjectMember!
   modifiedAt: DateTime!
   mouEnd: SecuredDateNullable!
   mouRange: SecuredDateRange!
   mouStart: SecuredDateNullable!
@@ -7171,8 +7175,9 @@
   """
   languageEngagements(input: EngagementListInput = {count: 25, order: ASC, page: 1, sort: "createdAt"}): SecuredLanguageEngagementList!
   marketingLocation: SecuredLocation!
   marketingRegionOverride: SecuredLocation!
+  membership(user: ID!): ProjectMember!
   modifiedAt: DateTime!
   mouEnd: SecuredDateNullable!
   mouRange: SecuredDateRange!
   mouStart: SecuredDateNullable!
@@ -7989,8 +7994,9 @@
   unavailabilities(input: UnavailabilityListInput = {count: 25, order: DESC, page: 1, sort: "start"}): SecuredUnavailabilityList!
 }
 
 input UserFilters {
+  id: ID
   name: String
 
   """Only users that are pinned/unpinned by the requesting user"""
   pinned: Boolean

⚠️ Dangerous Changes

  • An optional field id on input type UserFilters was added.

@CarsonF CarsonF force-pushed the project-member/project-membership-by-user branch from 4959099 to b3895f3 Compare June 20, 2025 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant