Skip to content

fix: Use Memberships with OWNER role for platform owner lookup #22475

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 17 commits into
base: main
Choose a base branch
from

Conversation

sahitya-chandra
Copy link
Contributor

@sahitya-chandra sahitya-chandra commented Jul 14, 2025

What does this PR do?

Replaced the logic for identifying the platform owner from the Profiles table (ordered by createdAt) with a direct lookup in the Memberships table using the 'OWNER' role. This prevents managed users from being mistakenly treated as platform owners if the original owner is deleted.

Visual Demo (For contributors especially)

A visual demonstration is strongly recommended, for both the original and new change (video / image - any one).

Video Demo (if applicable):

  • Show screen recordings of the issue or feature.
  • Demonstrate how to reproduce the issue, the behavior before and after the change.

Image Demo (if applicable):

  • Add side-by-side screenshots of the original and updated change.
  • Highlight any significant change(s).

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
  • I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

  • Are there environment variables that should be set?
  • What are the minimal test data to have?
  • What is expected (happy path) to have (input and output)?
  • Any other important info that could help to test that PR

Checklist

  • I haven't read the contributing guide
  • My code doesn't follow the style guidelines of this project
  • I haven't commented my code, particularly in hard-to-understand areas
  • I haven't checked if my changes generate no new warnings

Summary by cubic

Changed platform owner lookup to use the Memberships table with the OWNER role instead of Profiles, ensuring only valid owners are identified.

  • Bug Fixes
    • Prevents managed users from being set as platform owners if the original owner is deleted.

@sahitya-chandra sahitya-chandra requested review from a team as code owners July 14, 2025 11:49
Copy link

vercel bot commented Jul 14, 2025

@sahitya-chandra is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented Jul 14, 2025

CLA assistant check
All committers have signed the CLA.

@graphite-app graphite-app bot added the community Created by Linear-GitHub Sync label Jul 14, 2025
@graphite-app graphite-app bot requested a review from a team July 14, 2025 11:49
@github-actions github-actions bot added api area: API, enterprise API, access token, OAuth platform Anything related to our platform plan 💻 refactor labels Jul 14, 2025
Copy link

graphite-app bot commented Jul 14, 2025

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (07/14/25)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add community label" took an action on this PR • (07/14/25)

1 label was added to this PR based on Keith Williams's automation.

cubic-dev-ai[bot]
cubic-dev-ai bot previously approved these changes Jul 14, 2025
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

cubic reviewed 2 files and found no issues. Review PR in cubic.dev.

@sahitya-chandra sahitya-chandra changed the title refactor: Fix platform owner lookup to use Memberships with OWNER role fix: Use Memberships with OWNER role for platform owner lookup Jul 14, 2025
Copy link
Contributor

coderabbitai bot commented Jul 15, 2025

Walkthrough

ApiAuthStrategy now injects MembershipsRepository and uses membershipsRepository.findPlatformOwnerUserId(client.organizationId) (falling back to findPlatformAdminUserId) in oAuthClientStrategy instead of profilesRepository.getPlatformOwnerUserId(...). MembershipsRepository gained two methods: findPlatformOwnerUserId(organizationId) and findPlatformAdminUserId(organizationId), each querying memberships for teamId = organizationId, role = OWNER/ADMIN and accepted = true and returning the userId or null. The ApiAuthStrategy constructor parameter order changed and the owner-not-found error message was updated.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Assessment against linked issues

Objective Addressed Explanation
Replace profilesRepository.getPlatformOwnerUserId usage in oAuthClientStrategy (#22466, CAL-6090)
Add repository method to find platform owner by role+membership status (MembershipsRepository.findPlatformOwnerUserId) (#22466, CAL-6090)

Out-of-scope changes

Code Change Explanation
Added findPlatformAdminUserId method (apps/api/v2/src/modules/memberships/memberships.repository.ts) The linked issues request changing owner lookup; adding an ADMIN lookup method is not specified and appears unrelated to the stated objectives.

📜 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 e4f66b2 and f0db84d.

📒 Files selected for processing (1)
  • apps/api/v2/src/modules/auth/auth.module.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • apps/api/v2/src/modules/auth/auth.module.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Install dependencies / Yarn install & cache
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8ee7b12 and 764ab75.

📒 Files selected for processing (2)
  • apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (3 hunks)
  • apps/api/v2/src/modules/memberships/memberships.repository.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Install dependencies / Yarn install & cache
  • GitHub Check: Security Check
🔇 Additional comments (3)
apps/api/v2/src/modules/memberships/memberships.repository.ts (1)

23-36: LGTM! The method correctly implements platform owner lookup.

The implementation properly queries the membership table with the correct filters (teamId, role, accepted) and handles the null case appropriately. This addresses the issue where the previous approach could incorrectly identify managed users as platform owners.

apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (2)

7-7: LGTM! Dependency injection implemented correctly.

The MembershipsRepository is properly imported and injected following the established patterns in the codebase.

Also applies to: 62-62


188-188: LGTM! Method call change correctly implements the fix.

The change from profilesRepository.getPlatformOwnerUserId to membershipsRepository.findPlatformOwnerUserId properly addresses the issue where managed users could be incorrectly identified as platform owners. The new approach correctly validates actual ownership through membership roles.

Copy link
Contributor

@Devanshusharma2005 Devanshusharma2005 left a comment

Choose a reason for hiding this comment

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

hey @sahitya-chandra thanks for the pr, can you please address the unit test failing. Also it will be good to add a loom.

@sahitya-chandra
Copy link
Contributor Author

@Devanshusharma2005 unit tests have been passed, and the changes are also not complex.

@sahitya-chandra
Copy link
Contributor Author

@anikdhabal can you review this sir...

@kart1ka
Copy link
Contributor

kart1ka commented Jul 28, 2025

@sahitya-chandra We will review it. Can you pls add a loom video?

@sahitya-chandra
Copy link
Contributor Author

@kart1ka sir, I am unable to create a loom video of this fix because locally running the api needs x_cal_secret which I don't have...

@Ryukemeister
Copy link
Contributor

other than the one small change looks good to me, @supalarry can you have a look at this as well?

Copy link
Contributor

@supalarry supalarry left a comment

Choose a reason for hiding this comment

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

Great stuff and thank you for the PR! Have one note below:

@@ -172,7 +174,7 @@ export class ApiAuthStrategy extends PassportStrategy(BaseStrategy, "api-auth")
throw new UnauthorizedException("ApiAuthStrategy - oAuth client - Invalid client secret");
}

const platformCreatorId = await this.profilesRepository.getPlatformOwnerUserId(client.organizationId);
const platformCreatorId = await this.membershipsRepository.findPlatformOwnerUserId(client.organizationId);
Copy link
Contributor

Choose a reason for hiding this comment

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

I would add a new function 'findPlatformAdminUserId' that does the same thing as 'findPlatformOwnerUserId' but with role 'MembershipRole.ADMIN' and then have

const platformCreatorId = await this.membershipsRepository.findPlatformOwnerUserId(client.organizationId) || await this.membershipsRepository.findPlatformAdminUserId(client.organizationId;

as a fallback just in case owner of platform is not part of the platform anymore and rest of people who were added were added as admins.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@supalarry added the admin fallback

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🔭 Outside diff range comments (1)
apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (1)

7-12: Import MembershipsRepository: good direction; remove now-unused ProfilesRepository import

Switching to MembershipsRepository aligns with the PR objective. ProfilesRepository is no longer used in this file—clean it up to avoid dead dependencies and potential lint failures.

Apply this diff to drop the unused import:

@@
-import { ProfilesRepository } from "@/modules/profiles/profiles.repository";
🧹 Nitpick comments (1)
apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (1)

177-185: Use nullish coalescing for fallback and update error message to reflect admin fallback

  • Prefer ?? over || to avoid treating a legitimate userId 0 as falsy (defensive correctness).
  • Error message should mention owner/admin since we now fallback to admin.

Apply this diff:

@@
-    const platformCreatorId =
-      (await this.membershipsRepository.findPlatformOwnerUserId(client.organizationId)) ||
-      (await this.membershipsRepository.findPlatformAdminUserId(client.organizationId));
+    const platformCreatorId =
+      (await this.membershipsRepository.findPlatformOwnerUserId(client.organizationId)) ??
+      (await this.membershipsRepository.findPlatformAdminUserId(client.organizationId));
@@
-    if (!platformCreatorId) {
-      throw new UnauthorizedException(
-        "ApiAuthStrategy - oAuth client - No owner ID found for this OAuth client"
-      );
-    }
+    if (!platformCreatorId) {
+      throw new UnauthorizedException(
+        "ApiAuthStrategy - oAuth client - No owner or admin found for this OAuth client"
+      );
+    }

Happy to add unit tests covering:

  • Owner present
  • Owner absent, admin present (fallback)
  • Owner/admin both absent (Unauthorized)
  • Regression: managed user not selected
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dac6353 and 1b35049.

📒 Files selected for processing (2)
  • apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (3 hunks)
  • apps/api/v2/src/modules/memberships/memberships.repository.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/api/v2/src/modules/memberships/memberships.repository.ts
🧰 Additional context used
📓 Path-based instructions (2)
**/*.ts

📄 CodeRabbit Inference Engine (.cursor/rules/review.mdc)

**/*.ts: For Prisma queries, only select data you need; never use include, always use select
Ensure the credential.key field is never returned from tRPC endpoints or APIs

Files:

  • apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/review.mdc)

Flag excessive Day.js use in performance-critical code; prefer native Date or Day.js .utc() in hot paths like loops

Files:

  • apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Install dependencies / Yarn install & cache
🔇 Additional comments (3)
apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (3)

177-179: LGTM: Owner/Admin lookup via Memberships fixes the managed-user bug

Using Memberships with OWNER (and ADMIN as fallback) correctly resolves the platform owner deterministically and prevents managed users from being misidentified.


177-179: Repository methods comply with Prisma select-only guideline
Both findPlatformOwnerUserId and findPlatformAdminUserId in apps/api/v2/src/modules/memberships/memberships.repository.ts already:

  • Filter by accepted: true and the correct MembershipRole
  • Use select: { userId: true }
  • Do not use any include

No changes required.


7-12: AuthModule correctly imports MembershipsModule

AuthModule (apps/api/v2/src/modules/auth/auth.module.ts) imports MembershipsModule, which exports MembershipsRepository. Dependency injection for MembershipsRepository in ApiAuthStrategy will work at runtime—no changes needed.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🔭 Outside diff range comments (1)
apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (1)

175-183: Use nullish coalescing and update exception message in ApiAuthStrategy

  • File: apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (lines 175–183)

Switch the fallback from || to ?? so a valid userId (even if ever 0) isn’t treated as falsy, and tweak the error text to mention both owner and admin.

-    const platformCreatorId =
-      (await this.membershipsRepository.findPlatformOwnerUserId(client.organizationId)) ||
-      (await this.membershipsRepository.findPlatformAdminUserId(client.organizationId));
+    const platformCreatorId =
+      (await this.membershipsRepository.findPlatformOwnerUserId(client.organizationId)) ??
+      (await this.membershipsRepository.findPlatformAdminUserId(client.organizationId));

-    if (!platformCreatorId) {
-      throw new UnauthorizedException(
-        "ApiAuthStrategy - oAuth client - No owner ID found for this OAuth client"
-      );
-    }
+    if (!platformCreatorId) {
+      throw new UnauthorizedException(
+        "ApiAuthStrategy - oAuth client - No owner or admin found for this OAuth client"
+      );
+    }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1b35049 and e4f66b2.

📒 Files selected for processing (1)
  • apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.ts

📄 CodeRabbit Inference Engine (.cursor/rules/review.mdc)

**/*.ts: For Prisma queries, only select data you need; never use include, always use select
Ensure the credential.key field is never returned from tRPC endpoints or APIs

Files:

  • apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/review.mdc)

Flag excessive Day.js use in performance-critical code; prefer native Date or Day.js .utc() in hot paths like loops

Files:

  • apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Install dependencies / Yarn install & cache
🔇 Additional comments (1)
apps/api/v2/src/modules/auth/strategies/api-auth/api-auth.strategy.ts (1)

7-7: Switch to MembershipsRepository import is appropriate

Importing MembershipsRepository aligns with the new owner resolution logic and prevents false-positives from Profiles-based lookups. No concerns here.

Copy link
Contributor

@supalarry supalarry left a comment

Choose a reason for hiding this comment

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

amazing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api area: API, enterprise API, access token, OAuth community Created by Linear-GitHub Sync Medium priority Created by Linear-GitHub Sync platform Anything related to our platform plan 💻 refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

refactor: v2 get platform owner id
7 participants