Scheduling infrastructure for absolutely everyone.
refactor: implement PBAC for team member listing in listSimpleMembers handler (#24005)
Eunjae Lee788fbdbe5e77
diff --git a/packages/features/pbac/PBAC_REFACTORING_GUIDE.md b/packages/features/pbac/PBAC_REFACTORING_GUIDE.mdnew file mode 100644index 00000000000..dba73fc0c1f--- /dev/null+++ b/packages/features/pbac/PBAC_REFACTORING_GUIDE.md@@ -0,0 +1,86 @@+# PBAC Refactoring Guide++Quick guide for refactoring Cal.com handlers to use Permission-Based Access Control (PBAC) instead of membership-based queries.++## Core Pattern: Team Filtering with PBAC++**Before (Membership-based)**:+```typescript+const teamsToQuery = (+ await prisma.membership.findMany({+ where: {+ userId: ctx.user.id,+ accepted: true,+ NOT: [+ {+ role: MembershipRole.MEMBER,+ team: { isPrivate: true },+ },+ ],+ },+ select: { teamId: true },+ })+).map((membership) => membership.teamId);+```++**After (PBAC-based)**:+```typescript+import { PermissionCheckService } from "@calcom/features/pbac/services/permission-check.service";++const permissionCheckService = new PermissionCheckService();+const teamsToQuery = await permissionCheckService.getTeamIdsWithPermission(+ ctx.user.id,+ "team.listMembers"+);+```++## Key Points++### 1. Use Direct Permission Strings+- Use `"team.listMembers"` directly instead of `PermissionMapper.toPermissionString()`+- Simpler and more readable++### 2. No Fallback Logic Needed+- `getTeamIdsWithPermission()` handles errors internally+- Returns empty array `[]` when user has no permissions (this is legitimate)+- Don't assume empty array means PBAC failure++### 3. Common Team Permissions+- `"team.listMembers"` - List team members+- `"team.read"` - View team details+- `"team.update"` - Edit team settings+- `"team.invite"` - Invite members+- `"team.remove"` - Remove members++## Step-by-Step Refactoring++1. **Add import**:+ ```typescript+ import { PermissionCheckService } from "@calcom/features/pbac/services/permission-check.service";+ ```++2. **Replace membership query**:+ ```typescript+ const permissionCheckService = new PermissionCheckService();+ const teamsToQuery = await permissionCheckService.getTeamIdsWithPermission(+ ctx.user.id,+ "team.listMembers"+ );+ ```++3. **Keep existing privacy checks** - PBAC doesn't replace organization-level privacy logic++## Example: listSimpleMembers.handler.ts++**What changed**:+- Replaced 17 lines of membership query with 2 lines of PBAC+- Removed unnecessary imports and fallback logic+- Used direct permission string `"team.listMembers"`++**Result**: Cleaner, more maintainable code that respects fine-grained permissions.++## Verification++- Run `yarn type-check:ci --force`+- Ensure existing privacy checks remain intact+- Test with users who have different permission levelsdiff --git a/packages/trpc/server/routers/viewer/teams/listSimpleMembers.handler.ts b/packages/trpc/server/routers/viewer/teams/listSimpleMembers.handler.tsindex b4d0cf0cbbd..6c22550984d 100644--- a/packages/trpc/server/routers/viewer/teams/listSimpleMembers.handler.ts+++ b/packages/trpc/server/routers/viewer/teams/listSimpleMembers.handler.ts@@ -2,8 +2,8 @@* Simplified version of legacyListMembers.handler.ts that returns basic member info.* Used for filtering people on /bookings.*/+import { PermissionCheckService } from "@calcom/features/pbac/services/permission-check.service";import type { PrismaClient } from "@calcom/prisma";-import { MembershipRole } from "@calcom/prisma/enums";import type { TrpcSessionUser } from "@calcom/trpc/server/types";type ListSimpleMembersOptions = {@@ -22,24 +22,8 @@ export const listSimpleMembers = async ({ ctx }: ListSimpleMembersOptions) => {return [];}- // query all teams the user is a member of and the team is not private- const teamsToQuery = (- await prisma.membership.findMany({- where: {- userId: ctx.user.id,- accepted: true,- NOT: [- {- role: MembershipRole.MEMBER,- team: {- isPrivate: true,- },- },- ],- },- select: { teamId: true },- })- ).map((membership) => membership.teamId);+ const permissionCheckService = new PermissionCheckService();+ const teamsToQuery = await permissionCheckService.getTeamIdsWithPermission(ctx.user.id, "team.listMembers");if (!teamsToQuery.length) {return [];