fix(clerk-js): Prevent leak of data-component-status
#6884
Conversation
🦋 Changeset detectedLatest commit: b6b0bcf The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdds a changeset for a patch release, conditions application of the data-component-status attribute on presence of isFlowReady, updates FlowMetadataProvider memoization to use props directly, and adds tests for Flow.Root status behavior (one test marked .only). Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor App as App/Test
participant AP as AppearanceProvider
participant Flow as Flow.Root
participant IRB as InvisibleRootBox (DOM)
App->>AP: Render with children
AP->>Flow: Render Flow.Root props { isFlowReady? }
Flow->>IRB: Mount InvisibleRootBox
alt isFlowReady is undefined
note right of IRB #DDDDDD: Do not set data-component-status
else isFlowReady === false
IRB->>IRB: Set data-component-status="awaiting-data"
else isFlowReady === true
IRB->>IRB: Set data-component-status="ready"
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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). (4)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
packages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx (3)
10-16: Drop stray commas after JSX blocksThe trailing commas render as text nodes; remove them for cleanliness and to avoid snapshot noise.
- </Flow.Root> - , + </Flow.Root>Apply similarly in all three tests.
As per coding guidelines.Also applies to: 25-35, 43-53
37-40: Same host selection fix for the other testsUpdate the other assertions to query
container.firstElementChild.- const host = container as HTMLElement | null; + const host = container.firstElementChild as HTMLElement | null;Apply in both tests.
Also applies to: 55-58
1-59: Add a transition test to prevent regressions (prop present → omitted)To ensure the leak is fixed when
isFlowReadyis later omitted, add a test like:+ it('removes data-component-status when isFlowReady is later omitted', async () => { + const { container, rerender } = render( + <AppearanceProvider appearanceKey='signIn'> + <Flow.Root flow='signIn' isFlowReady> + <div data-testid='child' /> + </Flow.Root> + </AppearanceProvider>, + ); + const host = container.firstElementChild as HTMLElement; + expect(host.getAttribute('data-component-status')).toBe('ready'); + + rerender( + <AppearanceProvider appearanceKey='signIn'> + <Flow.Root flow='signIn'> + <div data-testid='child' /> + </Flow.Root> + </AppearanceProvider>, + ); + expect(host.getAttribute('data-component-status')).toBeNull(); + });I can open a follow-up PR with this test if you prefer.
packages/clerk-js/src/ui/elements/contexts/index.tsx (1)
130-134: Tighten context value and declare explicit return type
Pass only{ flow, part }into the memo to avoid capturingchildren, and annotate the component return type.export const FlowMetadataProvider = (props: React.PropsWithChildren<FlowMetadata>) => { const { flow, part } = props; - const value = React.useMemo(() => ({ value: props }), [flow, part]); - return <FlowMetadataCtx.Provider value={value}>{props.children}</FlowMetadataCtx.Provider>; + const value = React.useMemo(() => ({ value: { flow, part } }), [flow, part]); + return <FlowMetadataCtx.Provider value={value}>{props.children}</FlowMetadataCtx.Provider>; };Optionally:
-export const FlowMetadataProvider = (props: React.PropsWithChildren<FlowMetadata>) => { +export const FlowMetadataProvider = (props: React.PropsWithChildren<FlowMetadata>): React.JSX.Element => {
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
.changeset/rich-peaches-yawn.md(1 hunks)packages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx(1 hunks)packages/clerk-js/src/ui/elements/InvisibleRootBox.tsx(1 hunks)packages/clerk-js/src/ui/elements/contexts/index.tsx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (13)
packages/clerk-js/src/ui/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/clerk-js-ui.mdc)
packages/clerk-js/src/ui/**/*.{ts,tsx}: Element descriptors should always be camelCase
Use element descriptors in UI components to enable consistent theming and styling via appearance.elements
Element descriptors should generate unique, stable CSS classes for theming
Element descriptors should handle state classes (e.g., cl-loading, cl-active, cl-error, cl-open) automatically based on component state
Do not render hard-coded values; all user-facing strings must be localized using provided localization methods
Use the useLocalizations hook and localizationKeys utility for all text and error messages
Use the styled system (sx prop, theme tokens, responsive values) for custom component styling
Use useCardState for card-level state, useFormState for form-level state, and useLoadingStatus for loading states
Always use handleError utility for API errors and use translateError for localized error messages
Use useFormControl for form field state, implement proper validation, and handle loading and error states in forms
Use localization keys for all form labels and placeholders
Use element descriptors for consistent styling and follow the theme token system
Use the Card and FormContainer patterns for consistent UI structure
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
**/*.{jsx,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{jsx,tsx}: Use error boundaries in React components
Minimize re-renders in React components
**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components:UserProfile,NavigationMenu
Keep components focused on a single responsibility - split large components
Limit component size to 150-200 lines; extract logic into custom hooks
Use composition over inheritance - prefer smaller, composable components
Export components as named exports for better tree-shaking
One component per file with matching filename and component name
Use useState for simple state management
Use useReducer for complex state logic
Implement proper state initialization
Use proper state updates with callbacks
Implement proper state cleanup
Use Context API for theme/authentication
Implement proper state selectors
Use proper state normalization
Implement proper state persistence
Use React.memo for expensive components
Implement proper useCallback for handlers
Use proper useMemo for expensive computations
Implement proper virtualization for lists
Use proper code splitting with React.lazy
Implement proper cleanup in useEffect
Use proper refs for DOM access
Implement proper event listener cleanup
Use proper abort controllers for fetch
Implement proper subscription cleanup
Use proper HTML elements
Implement proper ARIA attributes
Use proper heading hierarchy
Implement proper form labels
Use proper button types
Implement proper focus management
Use proper keyboard shortcuts
Implement proper tab order
Use proper skip links
Implement proper focus traps
Implement proper error boundaries
Use proper error logging
Implement proper error recovery
Use proper error messages
Implement proper error fallbacks
Use proper form validation
Implement proper error states
Use proper error messages
Implement proper form submission
Use proper form reset
Use proper component naming
Implement proper file naming
Use proper prop naming
Implement proper...
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
**/*.tsx
📄 CodeRabbit inference engine (.cursor/rules/react.mdc)
**/*.tsx: Use proper type definitions for props and state
Leverage TypeScript's type inference where possible
Use proper event types for handlers
Implement proper generic types for reusable components
Use proper type guards for conditional rendering
Files:
packages/clerk-js/src/ui/elements/contexts/index.tsxpackages/clerk-js/src/ui/elements/InvisibleRootBox.tsxpackages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/rich-peaches-yawn.md
packages/**/*.{test,spec}.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Unit tests should use Jest or Vitest as the test runner.
Files:
packages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
packages/{clerk-js,elements,themes}/**/*.{test,spec}.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Visual regression testing should be performed for UI components.
Files:
packages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
**/__tests__/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
**/__tests__/**/*.{ts,tsx}: Create type-safe test builders/factories
Use branded types for test isolation
Implement proper mock types that match interfaces
Files:
packages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
🧬 Code graph analysis (1)
packages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx (2)
packages/clerk-js/src/ui/customizables/index.ts (1)
AppearanceProvider(9-9)packages/clerk-js/src/ui/customizables/Flow.tsx (1)
Flow(41-44)
⏰ 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). (6)
- GitHub Check: Build Packages
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.changeset/rich-peaches-yawn.md (1)
1-6: Changeset looks goodFrontmatter and scope are correct; message is concise and matches the behavioral change.
packages/clerk-js/src/ui/customizables/__tests__/FlowRoot.spec.tsx
Outdated
Show resolved
Hide resolved
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
panteliselef
deleted the
elef/bill-1295-prevent-leak-of-data-component-status-for-aios
branch
Description
In #6644 we introduced a regression. This PR attempts to fix that and ensures that only the components using the specific prop, will update the DOM.
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Bug Fixes
Refactor
Tests
Chores