fix(backend): Fix attributeMapping field in SamlConnectionAPI params #6381
Conversation
🦋 Changeset detectedLatest commit: 5a9b910 The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 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 |
|
@jaredpiedt is attempting to deploy a commit to the Clerk Production Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThe changes update the Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Note ⚡️ Unit Test Generation - BetaCodeRabbit's unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project's testing patterns. Learn more here, or just try it under ✨ Finishing Touches. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 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). (1)
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. 🪧 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 (1)
packages/backend/src/api/__tests__/SamlConnectionApi.test.ts (1)
111-111: Remove debug console.log statements.The
console.log(body)statements should be removed before merging as they're debug artifacts.- console.log(body);Apply the same removal to line 180.
Also applies to: 180-180
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.changeset/twelve-sides-cheer.md(1 hunks)packages/backend/src/api/__tests__/SamlConnectionApi.test.ts(1 hunks)packages/backend/src/api/endpoints/SamlConnectionApi.ts(3 hunks)
🧰 Additional context used
📓 Path-based instructions (10)
.changeset/**
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/twelve-sides-cheer.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:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/backend/src/api/__tests__/SamlConnectionApi.test.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:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/backend/src/api/__tests__/SamlConnectionApi.test.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/backend/src/api/__tests__/SamlConnectionApi.test.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/backend/src/api/__tests__/SamlConnectionApi.test.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:
packages/backend/src/api/endpoints/SamlConnectionApi.tspackages/backend/src/api/__tests__/SamlConnectionApi.test.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/backend/src/api/endpoints/SamlConnectionApi.tspackages/backend/src/api/__tests__/SamlConnectionApi.test.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.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/backend/src/api/endpoints/SamlConnectionApi.tspackages/backend/src/api/__tests__/SamlConnectionApi.test.ts
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/backend/src/api/__tests__/SamlConnectionApi.test.ts
**/__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/backend/src/api/__tests__/SamlConnectionApi.test.ts
🔇 Additional comments (6)
packages/backend/src/api/endpoints/SamlConnectionApi.ts (3)
41-46: LGTM! Type definition correctly updated for proper serialization.The change from camelCase to snake_case keys in the
attributeMappingobject aligns with the backend API expectations and fixes the serialization issue described in the PR objectives.Security Note: This change affects SAML connection configuration which is security-critical. Please consider tagging
clerk/securityfor review of this authentication-related change.
59-64: LGTM! Consistent type definition update.The
UpdateSamlConnectionParamstype correctly mirrors the same snake_case key changes as inCreateSamlConnectionParams, ensuring consistency across both create and update operations.
105-105: Minor formatting improvement.The added blank line improves code readability by providing visual separation between methods.
.changeset/twelve-sides-cheer.md (1)
1-6: LGTM! Changeset properly documents the fix.The changeset correctly categorizes this as a patch-level change and provides a clear description of the
attributeMappingfield fix.packages/backend/src/api/__tests__/SamlConnectionApi.test.ts (2)
77-144: Good test coverage for createSamlConnection.The test properly validates that the request body contains snake_case keys in the
attributeMappingfield, ensuring the type definition fix works correctly.
146-221: Comprehensive test coverage for updateSamlConnection.The test thoroughly validates the request body structure including the snake_case
attributeMappingkeys, providing good coverage for the update operation.
|
Hi @jaredpiedt! Thank you for this work. The keys are actually intended to be camelCase, and it's our bad that they're not being converted appropriately. I've added a PR here and I'll be sure to add you as a co-author. Thanks again! |
Description
The
requestfunction does not convert nested object fields to snake case in body params. This creates an issue in theSamlConnectionAPI.updateSamlConnectionfunction whereattributeMappingfields are set to null when passed to the function.For example, this function call:
Gets converted to this request body:
{ "attribute_mapping": { "userId": "userId", "emailAddress": "email", "firstName": "firstName", "lastName": "lastName" } }When it should be this:
{ "attribute_mapping": { "user_id": "userId", "email_address": "email", "first_name": "firstName", "last_name": "lastName" } }The backend api sees that
attribute_mappingis passed but none of the snake case fields are set, so it assumes all of the attribute mappings should be set to null.I fixed this issue by converting the typescript field names to snake case so they're properly serialized to JSON.
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Bug Fixes
Tests