Skip to content

Add fides_external_id option to FidesJS SDK to provide a custom ID on preferences #7094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
NevilleS wants to merge 20 commits into
base: main
Choose a base branch
from
Draft

Add fides_external_id option to FidesJS SDK to provide a custom ID on preferences #7094

NevilleS wants to merge 20 commits into from

Conversation

@NevilleS
Copy link
Contributor

@NevilleS NevilleS commented Dec 9, 2025

Ticket []

Description Of Changes

Code Changes

Steps to Confirm

Pre-Merge Checklist

  • Issue requirements met
  • All CI pipelines succeeded
  • CHANGELOG.md updated
    • Add a db-migration This indicates that a change includes a database migration label to the entry if your change includes a DB migration
    • Add a high-risk This issue suggests changes that have a high-probability of breaking existing code label to the entry if your change includes a high-risk change (i.e. potential for performance impact or unexpected regression) that should be flagged
    • Updates unreleased work already in Changelog, no new entry necessary
  • UX feedback:
    • All UX related changes have been reviewed by a designer
    • No UX review needed
  • Followup issues:
    • Followup issues created
    • No followup issues
  • Database migrations:
    • Ensure that your downrev is up to date with the latest revision on main
    • Ensure that your downgrade() migration is correct and works
      • If a downgrade migration is not possible for this change, please call this out in the PR description!
    • No migrations
  • Documentation:
    • Documentation complete, PR opened in fidesdocs
    • Documentation issue created in fidesdocs
    • If there are any new client scopes created as part of the pull request, remember to update public-facing documentation that references our scope registry
    • No documentation updates required

NevilleS added 19 commits December 9, 2025 13:28
@NevilleS
Add initially failing Cypress test for fides_external_id feature
6c4f0b9
@NevilleS
Add fidesExternalId to type definitions and override support
53f0b12
@NevilleS
Add fides_external_id documentation and test mock default
75655a0
@NevilleS
Update cookie management to store and preserve external_id
3a3747f
@NevilleS
Complete fides-js core implementation for fides_external_id - builds …
9091521 
…successfully
@NevilleS
Add unit tests for external_id cookie storage and persistence
cdd14c5
@NevilleS
Add FIDES_EXTERNAL_ID support to privacy-center environment and API
f46c0cc
@NevilleS
Update consent page to read fides_external_id from window.fides_overr…
e45e2fb 
…ides and include in browser_identity
@NevilleS
Fix prettier formatting in NoticeDrivenConsent
ab58610
@NevilleS
Simplify external_id implementation: remove from fides_meta, store on…
6a067e4 
…ly in identity
@NevilleS
Refactor external_id handling: extract helper function and consolidat…
b41fc54 
…e logic
@NevilleS
Refactor external_id handling: apply once at end, remove helper function
8001177
@NevilleS
Refactor makeFidesCookie to accept defaultIdentity parameter, remove …
81655d2 
…applyExternalIdToCookie helper
@NevilleS
Refactor getOrMakeFidesCookie to match makeFidesCookie signature, add…
ee15da5 
… makeDefaultIdentity helper
@NevilleS
Fix prettier formatting
c4b496e
@NevilleS
Add tests for makeDefaultIdentity helper function
f8a36da
@NevilleS
Refactor cookie identity functions to use consistent options object p…
04eea02 
…attern

- Refactor makeDefaultIdentity to accept options object with fidesUserDeviceId and fidesExternalId
- Update getOrMakeFidesCookie and makeFidesCookie to use Pick<FidesInitOptions, ...> for type safety
- Move fidesExternalId to options object alongside fidesClearCookie and fidesCookieSuffix
- Add comprehensive test coverage for makeDefaultIdentity
- Update all call sites to use new function signatures
- Streamline and remove duplicate tests
- Fix identity merging to handle undefined parsedCookie.identity gracefully
@NevilleS
Require at least one character for fides_external_id validation
aa1d1c4 
Update validation regex from /(.*)/ to /.+/ to explicitly reject empty strings.
This makes the validation more explicit and self-documenting, requiring
at least one character for the external ID.
@NevilleS
Simplify identity handling in getOrMakeFidesCookie
b501429 
- Remove redundant branch for handling missing device ID
- Streamline logic to handle undefined identity first, then update external_id
- Add test coverage for undefined identity with and without fidesExternalId
@vercel
Copy link

vercel bot commented Dec 9, 2025

Deployment failed with the following error:

You must set up Two-Factor Authentication before accessing this team.

View Documentation: https://vercel.com/docs/two-factor-authentication

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@NevilleS