feat: add credit balance check to WorkflowRunForm for modal display #1866

Siri-Ray · 2025-12-17T10:12:02Z

Implemented a pre-check for credit balance in the WorkflowRunForm component to display a modal if the user's credit balance is insufficient for the required credits.
Integrated subscription usage hooks to manage credit balance state and modal visibility.
Enhanced user experience by preventing submission when credit requirements are not met.

Summary by CodeRabbit

New Features
- Workflow runs now validate credit balance before execution. If insufficient credits are detected, a notification is displayed and the workflow is prevented from running until credits are added.

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

- Implemented a pre-check for credit balance in the WorkflowRunForm component to display a modal if the user's credit balance is insufficient for the required credits. - Integrated subscription usage hooks to manage credit balance state and modal visibility. - Enhanced user experience by preventing submission when credit requirements are not met.

coderabbitai · 2025-12-17T10:12:14Z

Walkthrough

This change adds a frontend credit-balance validation check to the workflow run form. The component now imports subscription-related hooks, consumes credit balance data and insufficient balance modal state, and implements pre-run checks in two locations to verify sufficient credits before execution, aborting and showing a modal if balance is insufficient.

Changes

Cohort / File(s)	Change Summary
Credit Balance Pre-Run Validation `packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx`	Added imports for `useSubscriptionStoreShallow` and `useSubscriptionUsage`. Component now consumes `creditBalance`, `isBalanceSuccess`, and `setCreditInsufficientModalVisible` to perform frontend validation before workflow execution. Pre-run balance checks implemented in two locations: during initial render setup and within the `handleRun` flow. Both checks are guarded by balance data availability and abort execution by opening the credit-insufficient modal if balance is insufficient.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Verify imports and hook consumption are correctly integrated
Validate that balance check logic is sound and applied consistently in both implementation sites
Confirm modal trigger and abort behavior work as intended
Ensure guarding conditions (balance data availability, required credits > 0) are properly implemented

Possibly related PRs

Feat/app credit merchant #1497: Modifies the same file with direct changes to how execution/credit usage is sourced and handled in the run flow
feat: enhance subscription store and workflow app integration #1837: Adds front-end credit-balance pre-run checks and uses the subscription store's credit-insufficient-modal visibility in workflow run forms

Suggested reviewers

mrcfps
lefarcen

Poem

🐰 A credit check before we run,

Prevents the workflow from the fund!

Modal pops when coins run thin,

Smart prevention wins within! ✨

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 accurately describes the main change: adding a credit balance check to WorkflowRunForm that displays a modal when credits are insufficient.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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 fix/credit-modal

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6a6eb4f and 64e1c29.

📒 Files selected for processing (1)

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx (3 hunks)

🧰 Additional context used

📓 Path-based instructions (19)

**/*.{jsx,tsx}

📄 CodeRabbit inference engine (.cursorrules)

**/*.{jsx,tsx}: Always use tailwind css to style the component
Always wrap pure components with React.memo to prevent unnecessary re-renders
Always use useMemo for expensive computations or complex object creation
Always use useCallback for function props to maintain referential equality
Always specify proper dependency arrays in useEffect to prevent infinite loops
Always avoid inline object/array creation in render to prevent unnecessary re-renders
Always use proper key props when rendering lists
Always split nested components with closures into separate components to avoid performance issues and improve code maintainability

**/*.{jsx,tsx}: Always wrap pure components with React.memo to prevent unnecessary re-renders
Always use useMemo for expensive computations or complex object creation in React
Always use useCallback for function props to maintain referential equality in React
Always specify proper dependency arrays in useEffect to prevent infinite loops in React
Always avoid inline object/array creation in render to prevent unnecessary re-renders in React
Always use proper key props when rendering lists in React (avoid using index when possible)
Always split nested components with closures into separate components in React
Use lazy loading for components that are not immediately needed in React
Debounce handlers for events that might fire rapidly (resize, scroll, input) in React
Implement fallback UI for components that might fail in React
Use error boundaries to catch and handle runtime errors in React

**/*.{jsx,tsx}: Place each attribute on a new line when a component has multiple attributes in JSX
Use self-closing tags for elements without children in JSX
Keep JSX expressions simple, extract complex logic to variables
Put closing brackets for multi-line JSX on a new line

**/*.{jsx,tsx}: Component file names should match the component name
Organize function components in order: imports, type definitions, constants, component function, hook calls, e...

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{js,ts,jsx,tsx}

📄 CodeRabbit inference engine (.cursorrules)

**/*.{js,ts,jsx,tsx}: Always use optional chaining (?.) when accessing object properties
Always use nullish coalescing (??) or default values for potentially undefined values
Always check array existence before using array methods
Always validate object properties before destructuring
Always use single quotes for string literals in JavaScript/TypeScript code

**/*.{js,ts,jsx,tsx}: Use semicolons at the end of statements
Include spaces around operators (e.g., a + b instead of a+b)
Always use curly braces for control statements
Place opening braces on the same line as their statement

**/*.{js,ts,jsx,tsx}: Group import statements in order: React/framework libraries, third-party libraries, internal modules, relative path imports, type imports, style imports
Sort imports alphabetically within each import group
Leave a blank line between import groups
Extract complex logic into custom hooks
Use functional updates for state (e.g., setCount(prev => prev + 1))
Split complex state into multiple state variables rather than single large objects
Use useReducer for complex state logic instead of multiple useState calls

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{js,ts,tsx,jsx,py,java,cpp,c,cs,rb,go,rs,php,swift,kt,scala,r,m,mm,sql}

📄 CodeRabbit inference engine (.cursor/rules/00-language-priority.mdc)

**/*.{js,ts,tsx,jsx,py,java,cpp,c,cs,rb,go,rs,php,swift,kt,scala,r,m,mm,sql}: All code comments MUST be written in English
All variable names, function names, class names, and other identifiers MUST use English words
Comments should be concise and explain 'why' rather than 'what'
Use proper grammar and punctuation in comments
Keep comments up-to-date when code changes
Document complex logic, edge cases, and important implementation details
Use clear, descriptive names that indicate purpose
Avoid abbreviations unless they are universally understood

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{js,ts,tsx,jsx}

📄 CodeRabbit inference engine (.cursor/rules/00-language-priority.mdc)

Use JSDoc style comments for functions and classes in JavaScript/TypeScript

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/01-code-style.mdc)

**/*.{js,jsx,ts,tsx}: Use single quotes for string literals in TypeScript/JavaScript
Always use optional chaining (?.) when accessing object properties in TypeScript/JavaScript
Always use nullish coalescing (??) or default values for potentially undefined values in TypeScript/JavaScript
Always check array existence before using array methods in TypeScript/JavaScript
Validate object properties before destructuring in TypeScript/JavaScript
Use ES6+ features like arrow functions, destructuring, and spread operators in TypeScript/JavaScript
Avoid magic numbers and strings - use named constants in TypeScript/JavaScript
Use async/await instead of raw promises for asynchronous code in TypeScript/JavaScript

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{jsx,tsx,css}

📄 CodeRabbit inference engine (.cursor/rules/01-code-style.mdc)

**/*.{jsx,tsx,css}: Use Tailwind CSS for styling components
Follow the utility-first approach with Tailwind CSS
Group related utility classes together in Tailwind CSS
Prefer Tailwind utilities over custom CSS when possible

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/03-typescript-guidelines.mdc)

**/*.{ts,tsx}: Avoid using any type whenever possible - use unknown type instead with proper type guards
Always define explicit return types for functions, especially for public APIs
Prefer extending existing types over creating entirely new types
Use TypeScript utility types (Partial<T>, Pick<T, K>, Omit<T, K>, Readonly<T>, Record<K, T>) to derive new types
Use union types and intersection types to combine existing types
Always import types explicitly using the import type syntax
Group type imports separately from value imports
Minimize creating local type aliases for imported types

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{js,ts,jsx,tsx,css,json}

📄 CodeRabbit inference engine (.cursor/rules/04-code-formatting.mdc)

Maximum line length of 100 characters

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{js,ts,jsx,tsx,css,json,yml,yaml}

📄 CodeRabbit inference engine (.cursor/rules/04-code-formatting.mdc)

Use 2 spaces for indentation, no tabs

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{js,ts,jsx,tsx,css,json,yml,yaml,md}

📄 CodeRabbit inference engine (.cursor/rules/04-code-formatting.mdc)

No trailing whitespace at the end of lines

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{jsx,tsx,js}

📄 CodeRabbit inference engine (.cursor/rules/05-code-organization.mdc)

Each component file should contain only one main component

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.tsx

📄 CodeRabbit inference engine (.cursor/rules/05-code-organization.mdc)

Explicitly type props with interfaces or types in React components

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{css,scss,sass,less,js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/09-design-system.mdc)

**/*.{css,scss,sass,less,js,jsx,ts,tsx}: Primary color (#155EEF) should be used for main brand color in buttons, links, and accents
Error color (#F04438) should be used for error states and destructive actions
Success color (#12B76A) should be used for success states and confirmations
Warning color (#F79009) should be used for warnings and important notifications
Info color (#0BA5EC) should be used for informational elements

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{tsx,ts}

📄 CodeRabbit inference engine (.cursor/rules/09-i18n-guidelines.mdc)

**/*.{tsx,ts}: Use the translation wrapper component and useTranslation hook in components
Ensure all user-facing text is translatable

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{tsx,ts,json}

📄 CodeRabbit inference engine (.cursor/rules/09-i18n-guidelines.mdc)

Support dynamic content with placeholders in translations

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{tsx,ts,jsx,js,vue,css,scss,less}

📄 CodeRabbit inference engine (.cursor/rules/11-ui-design-patterns.mdc)

**/*.{tsx,ts,jsx,js,vue,css,scss,less}: Use the primary blue (#155EEF) for main UI elements, CTAs, and active states
Use red (#F04438) only for errors, warnings, and destructive actions
Use green (#12B76A) for success states and confirmations
Use orange (#F79009) for warning states and important notifications
Use blue (#0BA5EC) for informational elements
Primary buttons should be solid with the primary color
Secondary buttons should have a border with transparent or light background
Danger buttons should use the error color
Use consistent padding, border radius, and hover states for all buttons
Follow fixed button sizes based on their importance and context
Use consistent border radius (rounded-lg) for all cards
Apply light shadows (shadow-sm) for card elevation
Maintain consistent padding inside cards (p-4 or p-6)
Use subtle borders for card separation
Ensure proper spacing between card elements
Apply consistent styling to all form inputs
Use clear visual indicators for focus, hover, and error states in form elements
Apply proper spacing between elements using 8px, 16px, 24px increments
Ensure proper alignment of elements (left, center, or right)
Use responsive layouts that work across different device sizes
Maintain a minimum contrast ratio of 4.5:1 for text

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{tsx,ts,jsx,js,vue}

📄 CodeRabbit inference engine (.cursor/rules/11-ui-design-patterns.mdc)

**/*.{tsx,ts,jsx,js,vue}: Include appropriate loading states for async actions in buttons
Group related form elements with appropriate spacing
Provide clear validation feedback for forms
Ensure proper labeling and accessibility for form elements
Ensure all interactive elements are keyboard accessible
Include appropriate ARIA attributes for complex components
Provide alternative text for images and icons
Support screen readers with semantic HTML elements

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.cursor/rules/08-contributing-guidelines.mdc)

**/*.{ts,tsx,js,jsx}: Follow the TypeScript/JavaScript style guidelines
Ensure code is well-tested and documented

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

**/*.{tsx,jsx}

📄 CodeRabbit inference engine (.cursor/rules/08-contributing-guidelines.mdc)

Use React best practices for frontend code

Files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

🧠 Learnings (2)

📚 Learning: 2025-11-25T03:04:05.715Z

Learnt from: CR
Repo: refly-ai/refly PR: 0
File: .cursor/rules/05-code-organization.mdc:0-0
Timestamp: 2025-11-25T03:04:05.715Z
Learning: Applies to **/*.{jsx,tsx} : Use React state hooks for component internal state

Applied to files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

📚 Learning: 2025-11-25T03:04:05.715Z

Learnt from: CR
Repo: refly-ai/refly PR: 0
File: .cursor/rules/05-code-organization.mdc:0-0
Timestamp: 2025-11-25T03:04:05.715Z
Learning: Applies to **/*.{js,ts,jsx,tsx} : Use useReducer for complex state logic instead of multiple useState calls

Applied to files:

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx

🧬 Code graph analysis (1)

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx (1)

packages/ai-workspace-common/src/hooks/use-subscription-usage.ts (1)

useSubscriptionUsage (6-60)

⏰ 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: build / Build

🔇 Additional comments (3)

packages/ai-workspace-common/src/components/canvas/workflow-run/workflow-run-form.tsx (3)

18-19: LGTM! Clean imports for credit balance functionality.

The new imports are properly organized and necessary for the credit balance checking feature.

97-100: LGTM! Proper subscription hook integration.

The credit balance and modal visibility state are correctly consumed from the subscription hooks.

435-442: Excellent credit balance validation logic.

The implementation correctly:

Validates that required credits is a finite positive number

Guards against false negatives by checking isBalanceSuccess before validation

Uses proper null coalescing for optional creditUsage prop

Prevents workflow execution and shows appropriate modal when balance is insufficient

Includes clear comments explaining the best-effort nature of the check

The placement after login verification and before form validation is optimal for user experience.

Note: The AI summary states the check is implemented in two places (initial render setup + handleRun), but the code only contains the check inside the handleRun function. No credit balance check exists during initial render or in any useEffect hooks.

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

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

mrcfps approved these changes Dec 18, 2025

View reviewed changes

mrcfps merged commit e68a790 into main Dec 18, 2025
2 checks passed

mrcfps deleted the fix/credit-modal branch December 18, 2025 06:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add credit balance check to WorkflowRunForm for modal display #1866

feat: add credit balance check to WorkflowRunForm for modal display #1866

Uh oh!

Siri-Ray commented Dec 17, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add credit balance check to WorkflowRunForm for modal display #1866

feat: add credit balance check to WorkflowRunForm for modal display #1866

Uh oh!

Conversation

Siri-Ray commented Dec 17, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Siri-Ray commented Dec 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 17, 2025 •

edited

Loading