Require explicit Project binding for Project-scoped CLI commands#51
Conversation
Summary by CodeRabbitRelease Notes
WalkthroughThis PR refactors the Prisma CLI's project resolution and binding model. It removes implicit project selection via package-name or remembered-local context, replacing it with an explicit binding requirement or unbound success state. The error code ChangesProject Resolution and Binding Semantics
🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
packages/cli/tests/app-env.test.ts (1)
893-906:⚠️ Potential issue | 🔴 Critical | ⚡ Quick winMissing local pin setup will cause test failure.
The test expects a validation error ("requires --role or --branch"), but without calling
await writeLocalPin(cwd);before line 898, the command will fail during project resolution withPROJECT_SETUP_REQUIREDinstead of reaching the validation logic.All similar validation tests in this file (lines 445, 464, 637) correctly set up the local pin before creating the test context.
🐛 Add missing local pin setup
const cwd = await createTempCwd(); + await writeLocalPin(cwd); const { context } = await createTestCommandContext({ cwd });🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/cli/tests/app-env.test.ts` around lines 893 - 906, The test is missing the local pin setup so project resolution fails before validation; call await writeLocalPin(cwd) after obtaining cwd from createTempCwd() and before creating the test context (i.e., before await createTestCommandContext({ cwd })) in the "rejects when --role is not provided (fail-fast on writes)" test so controllers.runEnvRemove reaches its validation logic (use the existing writeLocalPin helper used in other tests).packages/cli/src/controllers/app.ts (1)
2224-2245:⚠️ Potential issue | 🟠 Major | ⚡ Quick winMissing
envProjectIdin options type definition.The
resolveProjectContextfunction accessesoptions?.envProjectIdat line 2242, but the options type (lines 2228-2231) does not declare this property. While TypeScript may not error on accessing an undeclared property, callers likerequireProviderAndProjectContextpassenvProjectId, expecting it to flow through toresolveProjectTarget.🐛 Proposed fix
async function resolveProjectContext( context: CommandContext, client: ManagementApiClient, explicitProject: string | undefined, options?: { branch?: ResolvedDeployBranch; commandName?: string; + envProjectId?: string; }, ): Promise<ResolvedAppProjectContext> {🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/cli/src/controllers/app.ts` around lines 2224 - 2245, The options parameter of resolveProjectContext is missing the envProjectId property, so add envProjectId?: string (or the appropriate type) to the options type in the resolveProjectContext signature so that options?.envProjectId is declared and flows through to resolveProjectTarget; update the function signature near resolveProjectContext and ensure callers like requireProviderAndProjectContext that pass envProjectId continue to compile.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@packages/cli/src/controllers/app.ts`:
- Around line 2224-2245: The options parameter of resolveProjectContext is
missing the envProjectId property, so add envProjectId?: string (or the
appropriate type) to the options type in the resolveProjectContext signature so
that options?.envProjectId is declared and flows through to
resolveProjectTarget; update the function signature near resolveProjectContext
and ensure callers like requireProviderAndProjectContext that pass envProjectId
continue to compile.
In `@packages/cli/tests/app-env.test.ts`:
- Around line 893-906: The test is missing the local pin setup so project
resolution fails before validation; call await writeLocalPin(cwd) after
obtaining cwd from createTempCwd() and before creating the test context (i.e.,
before await createTestCommandContext({ cwd })) in the "rejects when --role is
not provided (fail-fast on writes)" test so controllers.runEnvRemove reaches its
validation logic (use the existing writeLocalPin helper used in other tests).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9876881f-4638-4352-a793-5884d86612a0
📒 Files selected for processing (17)
docs/product/cli-style-guide.mddocs/product/command-spec.mddocs/product/error-conventions.mddocs/product/output-conventions.mddocs/product/resource-model.mdpackages/cli/src/controllers/app-env.tspackages/cli/src/controllers/app.tspackages/cli/src/controllers/project.tspackages/cli/src/lib/project/resolution.tspackages/cli/src/presenters/project.tspackages/cli/src/shell/command-meta.tspackages/cli/src/types/project.tspackages/cli/tests/app-controller.test.tspackages/cli/tests/app-env-vars.test.tspackages/cli/tests/app-env.test.tspackages/cli/tests/project-controller.test.tspackages/cli/tests/project.test.ts
1 participant
Summary
project showto inspect the directory binding and return unbound success with suggestions/candidates instead of selecting by package name.PROJECT_SETUP_REQUIREDwhen unbound.Review
origin/main...HEAD.Validation
corepack pnpm --filter @prisma/cli buildcorepack pnpm --filter @prisma/cli testgit diff --check origin/main...HEADrg -n "PROJECT_UNRESOLVED|remembered-local|projectSource: \"package-name\"|source: package-name|resolved for this directory|re-bootstrap" packages/cli/src packages/cli/tests docs/product