uid2: add refreshUid2Token protocol client - #328
Open
mosherBT wants to merge 3 commits into
Open
Conversation
PRODUCT-3938
Contributor
|
Other addons had an update to the README.md. We probably want one here also |
Contributor
Author
Will do this when feature is full ready. More PRs will follow |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
UID2 tokens expire and must be refreshed client-side against the UID2 operator. web-sdk has no refresh client;
refreshUid2Tokenis duplicated in 18 solutions bundles.UID2 documentation reference for this API - https://unifiedid.com/docs/endpoints/post-token-refresh
What Changed
lib/addons/uid2-refresh.tsexportingrefreshUid2Token(refreshToken, refreshResponseKey)— POSTs the refresh token to the UID2 operator, AES-GCM-decrypts the response (12-byte nonce prefix,refresh_response_key), returns the body or null on non-OK / opt-out / missingadvertising_token. Malformed responses throw; error policy stays with the caller.Uid2RefDatatype — the response body and the_refshape on cached EIDs.How to Test
Unit tests cover a webcrypto round-trip, raw-body POST, non-OK, opt-out, missing token, and undecryptable payload.
Notes
First of three PRs for the addon: protocol client, then cache apply, then the
refreshStaleUid2sorchestrator.Breaking change
Requires release