fix(e2e): Narrow range of fake phone numbers #6489
Conversation
🦋 Changeset detectedLatest commit: 0c3a466 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types 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 Git ↗︎
|
@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: |
📝 WalkthroughWalkthroughA new empty changeset file named Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
.changeset/afraid-planets-fly.md (1)
1-3: Complete the changeset with package information and description.The changeset file is missing essential information. According to the coding guidelines, automated releases must use Changesets properly.
A proper changeset should include:
- Package names and version bump types in the YAML front matter
- A description of the changes
Apply this diff to complete the changeset:
--- +packages: + - "@clerk/testing" # or appropriate package name +version: patch # or minor/major as appropriate --- + +fix(e2e): Narrow range of fake phone numbers + +Temporarily restricts the range of area codes used in end-to-end tests because FAPI currently does not support any area code when used with phone number patterns starting with `55501XX`.
🧹 Nitpick comments (3)
integration/testUtils/usersService.ts (3)
81-91: Add explicit return type and improve code organization.The function logic is correct, but it can be improved for better TypeScript compliance and maintainability.
Apply this diff to add explicit return type and extract the constants:
+/** + * Valid 9xx area codes for testing purposes + */ +const VALID_9XX_AREA_CODES = [ + 901, 902, 903, 904, 905, 906, 907, 908, 909, 910, 912, 913, 914, 915, 916, 917, 918, 919, 920, 925, 927, 928, 929, + 930, 931, 934, 935, 936, 937, 938, 939, 940, 941, 945, 947, 948, 949, 951, 952, 954, 956, 959, 970, 971, 972, 973, + 978, 979, 980, 984, 985, 986, 989, +] as const; + /** * Temporary limited range of area codes until FAPI is updated to allow all area codes when used with a test phone number. */ -function random9xxAreaCode() { - const codes = [ - 901, 902, 903, 904, 905, 906, 907, 908, 909, 910, 912, 913, 914, 915, 916, 917, 918, 919, 920, 925, 927, 928, 929, - 930, 931, 934, 935, 936, 937, 938, 939, 940, 941, 945, 947, 948, 949, 951, 952, 954, 956, 959, 970, 971, 972, 973, - 978, 979, 980, 984, 985, 986, 989, - ]; - return codes[Math.floor(Math.random() * codes.length)]; +function random9xxAreaCode(): number { + return VALID_9XX_AREA_CODES[Math.floor(Math.random() * VALID_9XX_AREA_CODES.length)]; }
97-99: LGTM! Consider adding explicit return type.The function correctly uses the new helper to generate phone numbers with valid area codes, addressing the FAPI limitation.
Consider adding an explicit return type for better TypeScript compliance:
-export function fakerPhoneNumber() { +export function fakerPhoneNumber(): string { return `+1${random9xxAreaCode()}55501${faker.string.numeric(2)}`; }
81-99: Consider adding unit tests for the new functionality.The changes look good and address the stated PR objective. However, no tests were added to cover the new
random9xxAreaCodefunction and the modifiedfakerPhoneNumberbehavior.Consider adding unit tests to verify:
random9xxAreaCode()returns valid area codes from the expected rangefakerPhoneNumber()generates phone numbers with the correct format- Generated phone numbers use area codes from the restricted set
Example test structure:
describe('Phone number generation', () => { it('should generate area codes from valid 9xx range', () => { const areaCode = random9xxAreaCode(); expect(areaCode).toBeGreaterThanOrEqual(901); expect(areaCode).toBeLessThanOrEqual(989); }); it('should generate phone numbers with correct format', () => { const phoneNumber = fakerPhoneNumber(); expect(phoneNumber).toMatch(/^\+19\d{2}55501\d{2}$/); }); });
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.changeset/afraid-planets-fly.md(1 hunks)integration/testUtils/usersService.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
.changeset/**
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/afraid-planets-fly.md
**/*.{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:
integration/testUtils/usersService.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
integration/testUtils/usersService.ts
**/*.{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:
integration/testUtils/usersService.ts
integration/**
📄 CodeRabbit Inference Engine (.cursor/rules/global.mdc)
Framework integration templates and E2E tests should be placed under the integration/ directory
Files:
integration/testUtils/usersService.ts
integration/**/*
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
End-to-end tests and integration templates must be located in the 'integration/' directory.
Files:
integration/testUtils/usersService.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:
integration/testUtils/usersService.ts
**/*
⚙️ 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.
Files:
integration/testUtils/usersService.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). (4)
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
Description
This PR temporarily narrows the range of area codes used in e2e tests until FAPI is updated to allow any area code when used with a
55501XXnumber.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit