ContextQMD
Back to Activepieces

EE Projects & RBAC

brain/knowledge/platform-editions-ee/ee-projects-rbac.md

0.88.35.2 KB
Original Source

EE Projects & RBAC

The EE Projects module adds team collaboration, role-based access control, git-based environment sync, and per-project piece filtering on top of the base project. CE is single-user only; EE gates the feature set behind projectRolesEnabled and environmentsEnabled plan flags.

Members & roles

  • ProjectMember entity: (projectId, userId, projectRoleId, platformId), unique on (projectId, userId, platformId). Service: upsert, list, getRole (returns ADMIN if owner/platform admin), update, delete, getIdsOfProjects.
  • ProjectRole: named permission set, platform-scoped, type DEFAULT/CUSTOM. Built-in: ADMIN (every permission), EDITOR (read + write flows/folders/tables, update flow status), VIEWER (read-only). Custom roles behind customRolesEnabled.
  • Permission: one granular capability (READ_FLOW, WRITE_CONNECTION, etc.), almost all of them READ/WRITE pairs per feature area.

RBAC enforcement

Yes, RBAC is a middleware layer. rbacMiddleware is registered once as a Fastify preHandler in app.ts, so every route passes through it. It resolves the route's project + permission and delegates to rbacService, which routes by principal type: USER goes to the member's role permission check; ENGINE checks principal.projectId === requestedProjectId; SERVICE checks project.platformId === principal.platform.id. UNKNOWN, WORKER and ONBOARDING are rejected outright.

The service method is spelled assertPrinicpalAccessToProject(), with the typo, in the code. Grep that spelling, not the corrected one, or you get zero hits. Flow-level checks use a separate assertUserHasPermissionToFlow().

Note it lives under ee/authentication/, not ee/projects/, which is where most people look first.

Releases & git sync

  • ProjectRelease: snapshot of flow/table/connection state, applied atomically, type GIT_BRANCH/MANUAL/ROLLBACK. Workflow: releasePlan() computes a ProjectSyncPlan diff (including exact piece version changes), create() applies + serializes to a File. Memory lock prevents concurrent releases.
  • Git Sync: SSH repo URL + branch + folder path; push exports published flows/tables, pull imports as a release source; individual-item push supported.

Gotchas

  • A new Permission needs a row in the role dialog, or custom roles can never grant it. The toggle list is a hardcoded array, initialPermissions in packages/web/src/app/routes/platform/security/project-role/project-role-dialog.tsx, and the dialog is a plain .map() over it. Default-role grants are hardcoded separately in access-control-list.ts, so a permission added there but not here is invisible: ADMIN/EDITOR/VIEWER have it, custom roles cannot be given it, and the feature's tab just never appears for those members. This has already shipped twice — Variables + Knowledge Base (GIT-1751), then Agents. Nothing catches the drift: CI neither typechecks nor unit-tests web, so add the row in the same PR as the enum entry.
  • Piece filtering now via piece sets — project.pieceSetId (nullable FK, SET NULL). When managePiecesEnabled, new EE projects get the Default set on create; unassigned resolves to Default at filter time. This supersedes the legacy project-plan allow/block list.
  • Worker routing: workerGroupId (bare label, ^[a-z0-9_-]+$) gated by workerGroupsEnabled. When set, the project's EXECUTE_FLOW/EXECUTE_WEBHOOK jobs route to project-<label>-jobs; other job types unaffected. Set via POST /v1/projects/:id; GET /v1/projects/worker-groups (platform-admin) lists online project-scope workers, 402 when flag off.
  • platformProjectService.getForPlatform(): admins see all, operators see all except others' personal, users see own personal + team projects they're a member of.

Key files

Entry point: rbacMiddleware, registered as a preHandler hook in app.ts.

  • packages/server/api/src/app/ee/authentication/project-role/ — where RBAC actually lives: rbac-middleware.ts and rbac-service.ts
  • packages/server/api/src/app/ee/projects/ — the projects module; members, roles and releases all sit under it
  • packages/server/api/src/app/ee/projects/project-members/ — member CRUD, role lookup
  • packages/server/api/src/app/ee/projects/project-role/ — built-in and custom roles
  • packages/server/api/src/app/ee/projects/project-release/ — release create, diff, apply
  • packages/server/api/src/app/ee/projects/project-release/git-sync/ — SSH repo push/pull
  • packages/server/api/src/app/core/security/v2/authz/ — calls into rbacService from the authz layer
  • packages/core/shared/src/lib/ee/project-members/ — ProjectMember types
  • packages/core/shared/src/lib/automation/project-release/ — ProjectRelease, ProjectSyncPlan
  • packages/web/src/features/members/ — members UI
  • packages/web/src/app/routes/platform/security/project-role/ — platform-admin role list and the permission-toggle dialog
  • packages/web/src/features/project-releases/ — releases + git sync UI

Paths verified 2026-07-17. An earlier version of this list pointed at ee/project-members/, ee/project-role/, ee/project-release/ and ee/git-sync/; all four moved under ee/projects/.