chore(clerk-js,localizations): Deprecate Personal Account semantics with Personal Workspace
#6402
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
🦋 Changeset detectedLatest commit: f5606a6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 22 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 |
📝 WalkthroughWalkthroughThis change set standardizes terminology across the codebase, replacing references to "personal account" with "personal workspace" in UI text, localization strings, test descriptions, and documentation comments. Updates span application components, test suites, localization files, and type documentation. In the testing utilities, a new method Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Complexity label: Simple 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (2)
🚧 Files skipped from review as they are similar to previous changes (3)
⏰ 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). (5)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/localizations/src/en-GB.ts (1)
471-478: Confirm intended capitalization of “workspace”.The PR description states the new terminology is “Personal Workspace” (capital W), but the localized value is
"Personal workspace"(lower-case w).
Please double-check the product copy guide for title-case vs sentence-case and align accordingly across all locales to avoid UI inconsistency.packages/localizations/src/en-US.ts (1)
465-472: Verify consistency with en-GB and Docs.Same capitalization question as in en-GB: the string is
"Personal workspace"while the PR objective cites “Personal Workspace”.
Ensure both locales – and any other that were updated – use the approved casing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
integration/templates/next-app-router/src/app/personal-account/page.tsx(1 hunks)packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx(7 hunks)packages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx(5 hunks)packages/localizations/src/en-GB.ts(1 hunks)packages/localizations/src/en-US.ts(1 hunks)packages/localizations/src/utils/enUS_v4.ts(1 hunks)packages/testing/src/playwright/unstable/page-objects/organizationSwitcher.ts(1 hunks)packages/types/src/clerk.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (18)
**/*.{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/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.tsintegration/templates/next-app-router/src/app/personal-account/page.tsxpackages/types/src/clerk.tspackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/testing/src/playwright/unstable/page-objects/organizationSwitcher.tspackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.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/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.tsintegration/templates/next-app-router/src/app/personal-account/page.tsxpackages/types/src/clerk.tspackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/testing/src/playwright/unstable/page-objects/organizationSwitcher.tspackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.tspackages/types/src/clerk.tspackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/testing/src/playwright/unstable/page-objects/organizationSwitcher.tspackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.tspackages/types/src/clerk.tspackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/testing/src/playwright/unstable/page-objects/organizationSwitcher.tspackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.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/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.tsintegration/templates/next-app-router/src/app/personal-account/page.tsxpackages/types/src/clerk.tspackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/testing/src/playwright/unstable/page-objects/organizationSwitcher.tspackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
packages/localizations/**/*
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Localization files must be placed in 'packages/localizations/'.
Files:
packages/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.ts
**/*.{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/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.tsintegration/templates/next-app-router/src/app/personal-account/page.tsxpackages/types/src/clerk.tspackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/testing/src/playwright/unstable/page-objects/organizationSwitcher.tspackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
**/*
⚙️ CodeRabbit Configuration File
**/*: If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.Whenever reviewing a pull request, if there are any changes that could impact security, always tag
@clerk/securityin the PR.Security-impacting changes include, but are not limited to:
- Changes to authentication logic or mechanisms (e.g. login, session handling, token issuance)
- Any modification to access control, authorization checks, or role-based permissions
- Introduction or modification of hashing algorithms, signature verification, or cryptographic primitives
- Handling of sensitive data (e.g. passwords, tokens, secrets, PII)
- Integration with external identity providers (e.g. SSO, OAuth, OpenID Connect)
- Modifications to security headers, cookie flags, CORS policies, or CSRF protections
- Bypass mechanisms (e.g. feature flags, testing overrides) that could weaken protections
- Changes to rate limiting, abuse prevention, or input validation
If you're unsure whether a change is security-relevant, err on the side of caution and tag
@clerk/security.Any time that you tag
@clerk/security, please do so explicitly in a code comment, rather than within a collapsed section in a coderabbit comment, such as the "recent review details" section. If you do use the team name in any thinking or non-direct-code-comment content, it can be referred to as "clerk security team" to avoid accidentally printing the tag which sends a notification to the team.
Files:
packages/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.tsintegration/templates/next-app-router/src/app/personal-account/page.tsxpackages/types/src/clerk.tspackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/testing/src/playwright/unstable/page-objects/organizationSwitcher.tspackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
**/localizations/**/*.ts
⚙️ CodeRabbit Configuration File
**/localizations/**/*.ts: Review the changes to localization files with the following guidelines:
- Ensure that no existing translations are accidentally removed unless they are being replaced or fixed. If a string is removed, verify that it is intentional and justified.
- Check that all translations are friendly, formal, or semi-formal. Explicit, offensive, or inappropriate language is not allowed. If you find any potentially offensive language or are unsure, tag the @clerk/sdk-infra team in a separate comment. If you do not intend to tag the team, refer to it as "Clerk SDK Infra team" instead.
- Use the most up-to-date base localization file (https://github.com/clerk/javascript/blob/main/packages/localizations/src/en-US.ts) to validate changes, ensuring consistency and completeness.
- Confirm that new translations are accurate, contextually appropriate, and match the intent of the original English strings.
- Check for formatting issues, such as missing placeholders, incorrect variable usage, or syntax errors.
- Ensure that all keys are unique and that there are no duplicate or conflicting entries.
- If you notice missing translations for new keys, flag them for completion.
Files:
packages/localizations/src/utils/enUS_v4.tspackages/localizations/src/en-US.tspackages/localizations/src/en-GB.ts
**/*.{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:
integration/templates/next-app-router/src/app/personal-account/page.tsxpackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
integration/**
📄 CodeRabbit Inference Engine (.cursor/rules/global.mdc)
Framework integration templates and E2E tests should be placed under the integration/ directory
Files:
integration/templates/next-app-router/src/app/personal-account/page.tsx
integration/**/*
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
End-to-end tests and integration templates must be located in the 'integration/' directory.
Files:
integration/templates/next-app-router/src/app/personal-account/page.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:
integration/templates/next-app-router/src/app/personal-account/page.tsxpackages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
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/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
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/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.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/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
**/*.test.{jsx,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/react.mdc)
**/*.test.{jsx,tsx}: Use React Testing Library
Test component behavior, not implementation
Use proper test queries
Implement proper test isolation
Use proper test coverage
Test component interactions
Use proper test data
Implement proper test setup
Use proper test cleanup
Implement proper test assertions
Use proper test structure
Files:
packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.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/components/OrganizationList/__tests__/OrganizationList.test.tsxpackages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
🔇 Additional comments (19)
packages/localizations/src/utils/enUS_v4.ts (1)
532-532: LGTM: Terminology update aligns with key namingThe change from "Personal account" to "Personal workspace" correctly aligns the display text with the
personalWorkspacekey name, ensuring consistency in the organization switcher interface.integration/templates/next-app-router/src/app/personal-account/page.tsx (2)
7-7: LGTM: Console log message updated for consistencyThe debug message correctly reflects the new "personal workspace" terminology while maintaining the same logical meaning.
12-12: LGTM: User-facing text updated appropriatelyThe welcome message properly implements the terminology change from "personal account" to "personal workspace" for consistency across the application.
packages/testing/src/playwright/unstable/page-objects/organizationSwitcher.ts (1)
21-23: LGTM: Test utility method updated consistentlyThe method rename from
expectPersonalAccounttoexpectPersonalWorkspaceand the corresponding text expectation correctly implement the terminology change while maintaining the same testing functionality.packages/clerk-js/src/ui/components/OrganizationList/__tests__/OrganizationList.test.tsx (8)
31-31: LGTM: Test assertion updated for new terminologyThe expectation correctly checks for "Personal workspace" text in the rendered component, maintaining test accuracy with the updated terminology.
36-37: LGTM: Test suite organization updated consistentlyThe describe block title and test description accurately reflect the "Personal workspace" terminology being tested.
75-75: LGTM: Negative assertion updated appropriatelyThe test correctly verifies that "Personal workspace" text is not present when
hidePersonalis true, maintaining proper test coverage.
83-83: LGTM: Test description reflects updated functionalityThe test description accurately describes testing the hiding of "personal workspace" functionality.
98-98: LGTM: Assertion maintains test accuracyThe negative assertion correctly verifies that "Personal workspace" is not displayed when hidden, preserving test integrity.
189-189: LGTM: Test description updated for consistencyThe test description properly reflects that the personal workspace should not be shown with force organization selection.
201-201: LGTM: Force organization test assertion updatedThe assertion correctly verifies that "Personal workspace" is not displayed when organization selection is forced.
342-342: LGTM: User interaction updated for new textThe click interaction correctly targets the updated "Personal workspace" text, ensuring the test continues to simulate proper user behavior.
packages/types/src/clerk.ts (2)
1611-1613: Documentation terminology update looks good.The JSDoc comment accurately reflects the updated terminology from "personal account" to "personal workspace" while maintaining clear documentation of the
hidePersonalproperty's functionality.
1703-1705: Consistent terminology update in documentation.The JSDoc comment properly updates the terminology to match the change in
OrganizationSwitcherProps, ensuring consistent documentation across related interfaces.packages/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx (5)
5-5: Minor import organization improvement.The import statement reordering improves code organization without affecting functionality.
34-34: Test assertion updated to match new UI terminology.The test correctly expects 'Personal workspace' text to match the updated UI component terminology.
151-151: Standalone mode test assertion properly updated.The test assertion correctly reflects the updated terminology while maintaining the test's purpose of verifying standalone rendering functionality.
198-198: Organization listing test assertion correctly updated.The test properly expects 'Personal workspace' to appear in the organization list, maintaining test accuracy with the updated UI terminology.
453-453: Personal workspace switching test properly updated.The user interaction test correctly targets the updated 'Personal workspace' text using an appropriate regex pattern, ensuring the switching functionality test remains accurate.
LauraBeatris
force-pushed
the
laura/replace-personal-account-with-personal-workspace-2
branch
3 times, most recently
from
8447c28 to
9333d5d
Compare
LauraBeatris
changed the title
Personal Account with Personal WorkspacePersonal Account semantics with Personal Workspace
@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: |
| expectPersonalAccount: () => { | ||
| return expect(page.getByText(/personal account/i)).toBeVisible(); | ||
| return expect(page.getByText(/personal (workspace|account)/i)).toBeVisible(); |
There was a problem hiding this comment.
Targeting both to avoid breaking changes if clerk-js is not released first or if the app has an older version.
LauraBeatris
force-pushed
the
laura/replace-personal-account-with-personal-workspace-2
branch
from
9333d5d to
683f9ed
Compare
LauraBeatris
force-pushed
the
laura/replace-personal-account-with-personal-workspace-2
branch
from
683f9ed to
f5606a6
Compare
Description
Context
We're launching after-auth soon, and aim to get our product aligned with the nomenclature for accounts that aren't tied to orgs.
Our Docs & Dashboard are being updated to mention "Personal Workspace" and therefore the SDK needs to be consistent with it as well.
Changes
organizationSwitcher['personalWorkspace']toPersonal accounthidePersonalpropexpectPersonalAccountin favor ofexpectPersonalWorkspaceChecklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Summary by CodeRabbit
Style
Documentation
expectPersonalAccountin favor ofexpectPersonalWorkspacein testing documentation.Tests