Skip to content
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

Refactoring UserIdentity logics #1097

Draft
wants to merge 174 commits into
base: syw-UID2-4159-token-gen-code-renaming
Choose a base branch
from
Draft

Refactoring UserIdentity logics #1097

wants to merge 174 commits into from

Conversation

sunnywu
Copy link
Contributor

@sunnywu sunnywu commented Oct 16, 2024 •
edited
Loading

  1. Read changes here first
  2. Removed the UserIdentity's refreshedAt field as that's redundant and currently set to the same value as the AdvertisingTokenInput/RefreshTokenInput#createdAt timestamp.
  3. Renamed some token variable names to adTokenInput and refreshTokenInput to make it clearer
  4. Removed privacyBits and establishedAt from UserIdentity/HashedDiidentity/RawUidIdentity but only kept inside FirstLevelHashIdentity - these fields are only relevant when a first level hash is generated for token generation and then passed along into ad token/refresh token generation logic.
  5. As a result, privacyBits and establishedAt are generated from either a. in a brand new token generation call (by default should be 1 and the timestamp at the time of the call) b. or, during token refresh logic, these fields will be inherited from previous refresh token.
  6. RefreshTokenInput, AdvertisingTokenInput and IdentityRequest will now require to store privacyBits and establishedAt itself as a compromise.
  7. generateIdentity will now take in a privacyBits param.
  8. Updated a lot of codes as a result (more refinement required such as not hardcoding the "1, Instant.now()" in a lot of places)
  9. Created verifyFirstLevelHashIdentityAndEstablishedAt method for verifying FirstLevelHashIdentity and added more checks for FirstLevel and check the correctness of raw Uid/First level hash in various unit tests
  10. Added PrivacyBitsTest/IdentityResponseTest/RawUidResponseTest classes and added some extra check for firstLevelHash in existing tests
  11. Replace privacy bits type to PrivacyBits class instance

Ian-Nara and others added 30 commits October 4, 2024 12:58
@Ian-Nara
testing debug config value
e057a84
@Ian-Nara
testing debug config value
a70141b
@github-actions
[CI Pipeline] Released Snapshot version: 5.40.49-alpha-24-SNAPSHOT
ec27533
@Ian-Nara
don't use logback conf in debug mode
b24fbf8
@Ian-Nara
Merge remote-tracking branch 'origin/ian-UID2-4235-enclave-debug-thro…
3f1eb09 
…ugh-config' into ian-UID2-4235-enclave-debug-through-config
@Ian-Nara
add more log information
59d9dd7
@github-actions
[CI Pipeline] Released Snapshot version: 5.40.50-alpha-25-SNAPSHOT
b4aa9c4
@Ian-Nara
fix if statement
da0e058
@Ian-Nara
Merge remote-tracking branch 'origin/ian-UID2-4235-enclave-debug-thro…
7589983 
…ugh-config' into ian-UID2-4235-enclave-debug-through-config
@github-actions
[CI Pipeline] Released Snapshot version: 5.40.51-alpha-27-SNAPSHOT
7ec499f
@Ian-Nara
add debug logback conf
3a377d5
@Ian-Nara
Merge remote-tracking branch 'origin/ian-UID2-4235-enclave-debug-thro…
ea6d9fd 
…ugh-config' into ian-UID2-4235-enclave-debug-through-config
@github-actions
[CI Pipeline] Released Snapshot version: 5.40.52-alpha-28-SNAPSHOT
ba116b3
@Ian-Nara
operator debug
4803b7f
@github-actions
[CI Pipeline] Released Snapshot version: 5.40.53-alpha-29-SNAPSHOT
0de3185
@thomasm-ttd
Adding vsock and dante logging
7772761
@github-actions
[CI Pipeline] Released Snapshot version: 5.40.54-alpha-30-SNAPSHOT
4823823
@thomasm-ttd
Temp change the CID
407e548
@thomasm-ttd
Revert CID change
3b65da6
@cody-constine-ttd
Adding debug port to eks pod
b7dd254
@github-actions
[CI Pipeline] Released Snapshot version: 5.40.55-alpha-31-SNAPSHOT
efbc1ac
@asloobq
Remove assertions used to check argument validity in public methods
579fdc1
@asloobq
Exclude code and assertion from source needed only for tests
44093af
@asloobq
replace assert for refresh token length with exception
b91591b
@asloobq
Replace assert with NPE in statsCollector public methods
0a82473
@thomasm-ttd
Update the handler for shutdown
21555c0
@thomasm-ttd
Turn of the exit on error
d45f4cf
@github-actions
[CI Pipeline] Released Snapshot version: 5.40.56-alpha-34-SNAPSHOT
912a6a9
@asloobq
Convert assert in default switch case to exception. Refactor methods
bd6438a
@asloobq
Refactor error messages to static string
6e964c6
Release Workflow and others added 28 commits November 18, 2024 02:58
@github-actions
[CI Pipeline] Released Patch version: 5.42.5
0a51642
@github-actions
[CI Pipeline] Released Patch version: 5.42.6
1385f2f
@cody-constine-ttd
Added site name as contact for CSTG
75a9c29
@cody-constine-ttd
Added site ID
c20cc48
@cody-constine-ttd
Removing API contact
b2e30d9
@cody-constine-ttd
Merge pull request #1160 from IABTechLab/cbc-UID2-CSTG-log-api-contact
079bfe5 
Added site name as contact for CSTG
@cody-constine-ttd
Upgrading vertx version
4359b3d
@github-actions
[CI Pipeline] Released Snapshot version: 5.42.7-alpha-139-SNAPSHOT
b23dcdc
@cody-constine-ttd
Adding new shared version
3768f82
@cody-constine-ttd
Merge branch 'cbc-UID2-4461-upgrade-vertx-version' of github.com:IABT…
0b1e00a 
…echLab/uid2-operator into cbc-UID2-4461-upgrade-vertx-version
@cody-constine-ttd
Merge pull request #1176 from IABTechLab/cbc-UID2-4461-upgrade-vertx-…
c687ccf 
…version

Upgrading vertx version
@cYKatherine
Remove siteIdsUsingV4Tokens (#1178)
3954046 
* Remove siteIdsUsingV4Tokens

* Remove site_ids_using_v4_tokens

* Remove v4 variable

* Remove test case which generate v2 token

* Set advertising_token_v4_percentage to be 100

* Remove siteId param
@cYKatherine
UID2-3804 Remove advertising_token_v4_percentage env var (#1180)
9f0f28b 
* Remove `advertising_token_v4_percentage` env var

* Always return advertising token v4 in tests

* Return token version v4 for EUID as well

* Remove duplicated code

* Remove PRNG

* Remove advertising_token_v3
[CI Pipeline] Released Patch version: 5.42.17
7d2ad65
@github-actions
Merge pull request #1182 from IABTechLab/ci-9f0f28b58612bc74206fb667e…
eed0b69 
…3df09ad1cc8e840

[CI Pipeline] Released Patch version: 5.42.17
@sunnywu
Code review feedback,
a002ad1 
Mainly renaming RefreshTokenRequest/RefreshResponse to
TokenRefreshRequest/TokenRefreshResponse
@clarkxuyang
xuy-UID2-4341-change-log-level Refine response logging (#1183)
242b08d 
Refine response logging, client error, invalid http origin, and invalid app name responses are logged at info level
@clarkxuyang
Xuy UI d2 2578 update share lib to add site name to metrics (#1179)
4a1af7d 
* Xuy UI d2 2578 Update share uid2 lib to 8.0.9, which added site name into metrics
[CI Pipeline] Released Minor version: 5.43.0
06d49c8
@github-actions
Merge pull request #1184 from IABTechLab/ci-4a1af7de1ed658dc0ea6f76ba…
e148266 
…98db5cf400de8d7

[CI Pipeline] Released Minor version: 5.43.0
@sunnywu
Renamed IdentityRequest/IdentityResponse to TokenGenerateRequest/Resp…
ea0b247 
…onse
@sunnywu
- Renamed RawUidResponse to IdentityMapResponseItem, MapRequest to Id…
4476ee1 
…entityMapRequestItem

- Renamed IUIDOperatorService.mapHashedDiiIdentity to mapHashedDii
@sunnywu
1. Renamed FirstLevelHashIdentity/HashedDiiIdentity/RawUidIdentity to…
6bb1fb9 
… FirstLevelHash/HashedDii/RawUid

2. Removed the abstract class UserIdentity
3. fixed a unit test as removing UserIdentity broke it
@sunnywu
1. Renamed IdentityType to DiiType
a8f0915 
2. In InputUtil, renamed Identity* member variable/methods to Dii* to indicate it's Dii
3. Change TokenUtils class getIdentityHash to getDiiHash and same for getDiiHashString
@vishalegbert-ttd
Increase max form buffer
e5dea0e
@vishalegbert-ttd
Merge pull request #1195 from IABTechLab/vse-UID2-4593-increase-max-f…
382facf 
…orm-buffer-bytes

Increase max form buffer
@github-actions
[CI Pipeline] Released Patch version: 5.43.4
1b72e55
@sunnywu
Use correct raw UID version for UID2 UIDOperatorVerticleTest and rena…
b792232 
…me identityV3Enabled to rawUidV3Enabled (#1190)

* Use correct raw UID version for UID2's UIDOperatorVerticleTest 
* renamed the variable/method useIdentityV3/identityV3Enabled to useRawUidV3/rawUidV3Enabled to be up to date with latest terminlogies
* Improved TokenEncodingTest#testAdvertisingTokenEncodings to tests all combo's of raw UID and ad token versions
@sunnywu sunnywu force-pushed the syw-UID2-4159-token-gen-code-refactoring-UserIdentity branch from 78a70d4 to a8f0915 Compare December 10, 2024 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcollins-ttd mcollins-ttd mcollins-ttd left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.