chore(cli): suppress prisma update message

[ymc9]

Summary by CodeRabbit

• Bug Fixes
  • CLI now consistently suppresses Prisma update notifications across all execution paths, ensuring uniform and cleaner CLI output.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Adds a local _options object in packages/cli/src/utils/exec-utils.ts that merges provided options with PRISMA_HIDE_UPDATE_MESSAGE='1' and passes this augmented _options to both the primary Prisma exec path and the npx/bunx fallback path. No public signatures changed.

Changes

Cohort / File(s)	Change Summary
Prisma execution environment propagation packages/cli/src/utils/exec-utils.ts	Introduces a local _options that merges incoming options with env.PRISMA_HIDE_UPDATE_MESSAGE='1'; replaces direct options usage with _options when calling the fallback execPackage and the primary execSync paths so the env var is present in both branches.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Single file change, consistent pattern applied to two call sites.
• Check that _options correctly merges without mutating the original options.
• Verify no behavioral change beyond environment propagation and that tests (if any) covering exec paths still pass.

Possibly related PRs

• fix(cli): add a npx/bunx fallback for running prisma commands #409 — Adds npx/bunx fallback and path-resolution control flow in exec-utils, which this change adapts to propagate the PRISMA_HIDE_UPDATE_MESSAGE env across both paths.

Poem

🐰 A quiet flag I tuck inside,
So Prisma's chatter takes a ride,
Both pathways hummed, the message gone,
I hop along and carry on. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore(cli): suppress prisma update message' accurately describes the main change—adding an environment variable to hide Prisma update messages in the CLI.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/prisma-update

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ad1c6c4 and 2ec13ec.

📒 Files selected for processing (1)

• packages/cli/src/utils/exec-utils.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/cli/src/utils/exec-utils.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). (2)

• GitHub Check: build-test (20.x, sqlite)
• GitHub Check: build-test (20.x, postgresql)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Suppress Prisma Update Message

Todo List

• Read and analyze the changed file
• Review code quality and implementation approach
• Check for potential bugs or issues
• Evaluate performance and security considerations
• Provide comprehensive feedback

---

Summary

This PR modifies the execPrisma function in packages/cli/src/utils/exec-utils.ts:32 to suppress Prisma update messages by setting the PRISMA_HIDE_UPDATE_MESSAGE environment variable.

Code Review

✅ Positive Aspects:

• Clear Intent: The change aligns perfectly with the PR title and addresses a common UX issue where Prisma update messages can clutter CLI output
• Consistent Application: The environment variable is applied to both execution paths (direct node execution and npx/bunx fallback)
• Non-Breaking: The change is additive and doesn't modify existing API surfaces
• Proper Environment Handling: Uses spread syntax to preserve existing environment variables

⚠️ Issues & Concerns:

1. Incorrect Environment Variable Value (packages/cli/src/utils/exec-utils.ts:50):

   PRISMA_HIDE_UPDATE_MESSAGE: '0',

   This sets the value to '0', which typically means "false" or "disabled" in environment variable conventions. To suppress the update message, this should likely be '1' or 'true'.

2. Missing Type Safety:
   The options object merging could benefit from more explicit typing to ensure env properties are properly merged.

3. Potential Environment Variable Conflicts:
   If the calling code explicitly sets PRISMA_HIDE_UPDATE_MESSAGE, this implementation will override it. Consider checking if it's already set:

   env: {
       ...options?.env,
       ...(options?.env?.PRISMA_HIDE_UPDATE_MESSAGE ? {} : { PRISMA_HIDE_UPDATE_MESSAGE: '1' }),
   }

Recommendations

1. Fix the environment variable value:

   PRISMA_HIDE_UPDATE_MESSAGE: '1',  // or 'true'

2. Add JSDoc documentation to explain the suppression behavior:

   /**
    * Utility for running prisma commands
    * @param args - Command arguments to pass to Prisma
    * @param options - Execution options (automatically suppresses update messages)
    */

3. Consider making it configurable if there are cases where users might want to see update messages:

   export function execPrisma(
       args: string, 
       options?: Omit<ExecSyncOptions, 'env'> & { 
           env?: Record<string, string>;
           hideUpdateMessage?: boolean;
       }
   ) {
       const { hideUpdateMessage = true, ...restOptions } = options ?? {};
       // ...
   }

Security Assessment

✅ No security concerns - The change only sets a Prisma-specific environment variable for UI behavior.

Performance Impact

✅ Minimal performance impact - Only adds object spread operations which are negligible.

Test Coverage

❓ Testing Consideration: Consider adding a test to verify that the environment variable is properly set when calling execPrisma. Currently, no tests appear to validate the environment variable behavior.

Overall Assessment

This is a good quality change that addresses a legitimate UX concern. The primary issue is the incorrect environment variable value that would prevent the intended functionality from working. Once fixed, this will improve the developer experience when using ZenStack CLI commands that invoke Prisma.

Verdict: Approve with minor fix required for the environment variable value.

---

[Copilot]

Pull request overview

This PR attempts to suppress Prisma's update notification messages when running Prisma commands through the CLI utility by setting the PRISMA_HIDE_UPDATE_MESSAGE environment variable.

• Sets PRISMA_HIDE_UPDATE_MESSAGE environment variable in the execPrisma function
• Updates both execution paths (direct and fallback) to use the new options object

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/cli/src/utils/exec-utils.ts (1)

46-60: Clarify default flag value and consider keeping PRISMA_HIDE_UPDATE_MESSAGE overridable

This correctly ensures the hide-update flag is set for both the direct node prisma path and the npx/bunx fallback. Two small points you might want to consider:

1. Value choice for the flag
   Prisma treats PRISMA_HIDE_UPDATE_MESSAGE as truthy/falsey, so any non-empty string (including '0') hides the message. Using '1' or 'true' instead would better reflect intent and avoid confusion for readers who associate 0 with “off”.

2. Allowing callers to override the default
   Right now, _options.env always overwrites any PRISMA_HIDE_UPDATE_MESSAGE coming from options.env or process.env. If you ever want consumers of execPrisma to be able to re-enable the update message, you could flip the merge order so explicit env wins over the default, e.g.:

• const _options = {

•    ...options,
  

•    env: {
  

•        ...options?.env,
  

•        PRISMA_HIDE_UPDATE_MESSAGE: '0',
  

•    },
  

• };

• const _options = {

•    ...options,
  

•    env: {
  

•        PRISMA_HIDE_UPDATE_MESSAGE: '1',
  

•        ...options?.env,
  

•    },
  

• };

That keeps your default behavior (hidden by default) but still lets a caller intentionally override the flag if needed.

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: Path: .coderabbit.yaml

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 09dabd8387861dff1d5b8f94a7b494782c089ecf and ad1c6c4bb1dedb43f57d92c7473756c3b8c76b25.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `packages/cli/src/utils/exec-utils.ts` (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🧠 Learnings (1)</summary>

<details>
<summary>📚 Learning: 2025-11-26T01:55:04.540Z</summary>

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Database migrations should use Prisma CLI under the hood via ZenStack commands

**Applied to files:**
- `packages/cli/src/utils/exec-utils.ts`

</details>

</details>

</details>

<details>
<summary>⏰ 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)</summary>

* GitHub Check: build-test (20.x, sqlite)
* GitHub Check: build-test (20.x, postgresql)

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Suppress Prisma Update Message

Todo List

• Read and analyze the changed file
• Review code quality and implementation approach
• Check for potential bugs or issues
• Evaluate performance and security considerations
• Provide comprehensive feedback

---

Summary

This PR modifies the execPrisma function in packages/cli/src/utils/exec-utils.ts:32 to suppress Prisma update messages by setting the PRISMA_HIDE_UPDATE_MESSAGE environment variable.

Code Review

✅ Positive Aspects:

• Clear Intent: The change aligns perfectly with the PR title and addresses a common UX issue where Prisma update messages can clutter CLI output
• Consistent Application: The environment variable is applied to both execution paths (direct node execution and npx/bunx fallback)
• Non-Breaking: The change is additive and doesn't modify existing API surfaces
• Proper Environment Handling: Uses spread syntax to preserve existing environment variables

⚠️ Issues & Concerns:

1. Environment Variable Value (packages/cli/src/utils/exec-utils.ts:50):

   PRISMA_HIDE_UPDATE_MESSAGE: '1',

   ✅ Correct! The current implementation uses '1' which properly suppresses the update message. Previous reviewers suggested this was incorrect, but upon analysis of the actual code, it's already set correctly.

2. Missing Process Environment Inheritance:
   The current implementation only inherits from options?.env but not from process.env. This means standard environment variables won't be available to the Prisma process:

   env: {
       ...options?.env,  // Only inherits from passed options
       PRISMA_HIDE_UPDATE_MESSAGE: '1',
   }

   Should be:

   env: {
       ...process.env,    // Inherit system environment
       ...options?.env,   // Override with passed options
       PRISMA_HIDE_UPDATE_MESSAGE: '1',
   }

3. Potential Override Conflict:
   If calling code explicitly sets PRISMA_HIDE_UPDATE_MESSAGE in options.env, this implementation will always override it. Consider preserving explicit user settings:

   env: {
       ...process.env,
       PRISMA_HIDE_UPDATE_MESSAGE: '1',  // Default
       ...options?.env,  // Allow user override
   }

Recommendations

1. Fix environment inheritance - Most Critical:

   const _options = {
       ...options,
       env: {
           ...process.env,
           ...options?.env,
           PRISMA_HIDE_UPDATE_MESSAGE: '1',
       },
   };

2. Consider making configurable (optional enhancement):

   export function execPrisma(
       args: string, 
       options?: Omit<ExecSyncOptions, 'env'> & { 
           env?: Record<string, string>;
           hideUpdateMessage?: boolean;
       }
   ) {
       const { hideUpdateMessage = true, ...restOptions } = options ?? {};
       // ...
   }

3. Add JSDoc documentation:

   /**
    * Utility for running prisma commands
    * @param args - Command arguments to pass to Prisma
    * @param options - Execution options (automatically suppresses update messages)
    */

Security Assessment

✅ No security concerns - The change only sets a Prisma-specific environment variable for UI behavior.

Performance Impact

✅ Minimal performance impact - Only adds object spread operations which are negligible.

Test Coverage

❓ Testing Consideration: Consider adding a test to verify that the environment variable is properly set when calling execPrisma. Currently, no tests appear to validate the environment variable behavior.

Overall Assessment

This is a good quality change that addresses a legitimate UX concern. The main issue is the missing process.env inheritance which could cause Prisma commands to fail in environments that rely on system environment variables. Once fixed, this will improve the developer experience when using ZenStack CLI commands that invoke Prisma.

Verdict: Approve with fix required for environment variable inheritance.

---