Added operator environment in remote config and removed from UserIdentity

Author: sophia-chen-ttd

src/main/java/com/uid2/operator/Const.java

@@ -36,5 +36,7 @@ public class Config extends com.uid2.shared.Const.Config {
         public static final String DisableOptoutTokenProp = "disable_optout_token";
         public static final String EnableRemoteConfigProp = "enable_remote_config";
         public static final String RuntimeConfigMetadataPathProp = "runtime_config_metadata_path";
+
+        public static final String IdentityEnvironmentProp = "identity_environment";
     }
 }

src/main/java/com/uid2/operator/model/IdentityRequest.java

@@ -4,15 +4,18 @@ public final class IdentityRequest {
     public final PublisherIdentity publisherIdentity;
     public final UserIdentity userIdentity;
     public final OptoutCheckPolicy optoutCheckPolicy;
+    public final IdentityEnvironment identityEnvironment;
 
     public IdentityRequest(
             PublisherIdentity publisherIdentity,
             UserIdentity userIdentity,
-            OptoutCheckPolicy tokenGeneratePolicy)
+            OptoutCheckPolicy tokenGeneratePolicy,
+            IdentityEnvironment identityEnvironment)
     {
         this.publisherIdentity = publisherIdentity;
         this.userIdentity = userIdentity;
         this.optoutCheckPolicy = tokenGeneratePolicy;
+        this.identityEnvironment = identityEnvironment;
     }
 
     public boolean shouldCheckOptOut() {

src/main/java/com/uid2/operator/model/MapRequest.java

@@ -4,15 +4,18 @@
 
 public final class MapRequest {
     public final UserIdentity userIdentity;
+    public final IdentityEnvironment identityEnvironment;
     public final OptoutCheckPolicy optoutCheckPolicy;
     public final Instant asOf;
 
     public MapRequest(
             UserIdentity userIdentity,
+            IdentityEnvironment identityEnvironment,
             OptoutCheckPolicy optoutCheckPolicy,
             Instant asOf)
     {
         this.userIdentity = userIdentity;
+        this.identityEnvironment = identityEnvironment;
         this.optoutCheckPolicy = optoutCheckPolicy;
         this.asOf = asOf;
     }

src/main/java/com/uid2/operator/model/UserIdentity.java

@@ -6,18 +6,16 @@
 public class UserIdentity {
     public final IdentityScope identityScope;
     public final IdentityType identityType;
-    public final IdentityEnvironment identityEnvironment;
     public final byte[] id;
     public final int privacyBits;
     public final Instant establishedAt;
     public final Instant refreshedAt;
 
-    public UserIdentity(IdentityScope identityScope, IdentityType identityType, IdentityEnvironment identityEnvironment,
+    public UserIdentity(IdentityScope identityScope, IdentityType identityType,
                         byte[] id, int privacyBits,
                         Instant establishedAt, Instant refreshedAt) {
         this.identityScope = identityScope;
         this.identityType = identityType;
-        this.identityEnvironment = identityEnvironment;
         this.id = id;
         this.privacyBits = privacyBits;
         this.establishedAt = establishedAt;
@@ -27,7 +25,6 @@ public UserIdentity(IdentityScope identityScope, IdentityType identityType, Iden
     public boolean matches(UserIdentity that) {
         return this.identityScope.equals(that.identityScope) &&
                 this.identityType.equals(that.identityType) &&
-                this.identityEnvironment.equals(that.identityEnvironment) &&
                 Arrays.equals(this.id, that.id);
     }
 }

src/main/java/com/uid2/operator/service/EncryptedTokenEncoder.java

@@ -17,11 +17,8 @@
 
 public class EncryptedTokenEncoder implements ITokenEncoder {
     private final KeyManager keyManager;
-    private final IdentityEnvironment identityEnvironment;
-
-    public EncryptedTokenEncoder(KeyManager keyManager, IdentityEnvironment identityEnvironment) {
+    public EncryptedTokenEncoder(KeyManager keyManager) {
         this.keyManager = keyManager;
-        this.identityEnvironment = identityEnvironment;
     }
 
     public byte[] encode(AdvertisingToken t, Instant asOf) {
@@ -126,7 +123,7 @@ private RefreshToken decodeRefreshTokenV2(Buffer b) {
                 TokenVersion.V2, createdAt, validTill,
                 new OperatorIdentity(0, OperatorType.Service, 0, 0),
                 new PublisherIdentity(siteId, 0, 0),
-                new UserIdentity(IdentityScope.UID2, IdentityType.Email, this.identityEnvironment, identity, privacyBits, Instant.ofEpochMilli(establishedMillis), null));
+                new UserIdentity(IdentityScope.UID2, IdentityType.Email, identity, privacyBits, Instant.ofEpochMilli(establishedMillis), null));
     }
 
     private RefreshToken decodeRefreshTokenV3(Buffer b, byte[] bytes) {
@@ -148,6 +145,7 @@ private RefreshToken decodeRefreshTokenV3(Buffer b, byte[] bytes) {
         final Instant establishedAt = Instant.ofEpochMilli(b2.getLong(49));
         final IdentityScope identityScope = decodeIdentityScopeV3(b2.getByte(57));
         final IdentityType identityType = decodeIdentityTypeV3(b2.getByte(57));
+
         final byte[] id = b2.getBytes(58, 90);
 
         if (identityScope != decodeIdentityScopeV3(b.getByte(0))) {
@@ -159,7 +157,7 @@ private RefreshToken decodeRefreshTokenV3(Buffer b, byte[] bytes) {
 
         return new RefreshToken(
                 TokenVersion.V3, createdAt, expiresAt, operatorIdentity, publisherIdentity,
-                new UserIdentity(identityScope, identityType, this.identityEnvironment, id, privacyBits, establishedAt, null));
+                new UserIdentity(identityScope, identityType, id, privacyBits, establishedAt, null));
     }
 
     @Override
@@ -227,7 +225,7 @@ public AdvertisingToken decodeAdvertisingTokenV2(Buffer b) {
                     Instant.ofEpochMilli(expiresMillis),
                     new OperatorIdentity(0, OperatorType.Service, 0, masterKeyId),
                     new PublisherIdentity(siteId, siteKeyId, 0),
-                    new UserIdentity(IdentityScope.UID2, IdentityType.Email, this.identityEnvironment, advertisingId, privacyBits, Instant.ofEpochMilli(establishedMillis), null)
+                    new UserIdentity(IdentityScope.UID2, IdentityType.Email, advertisingId, privacyBits, Instant.ofEpochMilli(establishedMillis), null)
             );
 
         } catch (Exception e) {
@@ -265,7 +263,7 @@ public AdvertisingToken decodeAdvertisingTokenV3orV4(Buffer b, byte[] bytes, Tok
 
         return new AdvertisingToken(
                 tokenVersion, createdAt, expiresAt, operatorIdentity, publisherIdentity,
-                new UserIdentity(identityScope, identityType, this.identityEnvironment, id, privacyBits, establishedAt, refreshedAt)
+                new UserIdentity(identityScope, identityType, id, privacyBits, establishedAt, refreshedAt)
         );
     }
 

src/main/java/com/uid2/operator/service/IUIDOperatorService.java

@@ -12,16 +12,16 @@
 public interface IUIDOperatorService {
     IdentityTokens generateIdentity(IdentityRequest request, Duration refreshIdentityAfter, Duration refreshExpiresAfter, Duration identityExpiresAfter);
 
-    RefreshResponse refreshIdentity(RefreshToken token, Duration refreshIdentityAfter, Duration refreshExpiresAfter, Duration identityExpiresAfter);
+    RefreshResponse refreshIdentity(RefreshToken token, Duration refreshIdentityAfter, Duration refreshExpiresAfter, Duration identityExpiresAfter, IdentityEnvironment identityEnvironment);
 
     MappedIdentity mapIdentity(MapRequest request);
 
     @Deprecated
-    MappedIdentity map(UserIdentity userIdentity, Instant asOf);
+    MappedIdentity map(UserIdentity userIdentity, Instant asOf, IdentityEnvironment identityEnvironment);
 
     List<SaltEntry> getModifiedBuckets(Instant sinceTimestamp);
 
-    void invalidateTokensAsync(UserIdentity userIdentity, Instant asOf, String uidTraceId, Handler<AsyncResult<Instant>> handler);
+    void invalidateTokensAsync(UserIdentity userIdentity, Instant asOf, String uidTraceId, IdentityEnvironment identityEnvironment, Handler<AsyncResult<Instant>> handler);
 
-    boolean advertisingTokenMatches(String advertisingToken, UserIdentity userIdentity, Instant asOf);
+    boolean advertisingTokenMatches(String advertisingToken, UserIdentity userIdentity, Instant asOf, IdentityEnvironment identityEnvironment);
 }

src/main/java/com/uid2/operator/service/InputUtil.java

@@ -264,11 +264,10 @@ public boolean isValid() {
             return valid;
         }
 
-        public UserIdentity toUserIdentity(IdentityScope identityScope, IdentityEnvironment identityEnvironment, int privacyBits, Instant establishedAt) {
+        public UserIdentity toUserIdentity(IdentityScope identityScope, int privacyBits, Instant establishedAt) {
             return new UserIdentity(
                     identityScope,
                     this.identityType,
-                    identityEnvironment,
                     getIdentityInput(),
                     privacyBits,
                     establishedAt,

src/main/java/com/uid2/operator/service/TokenUtils.java

@@ -69,7 +69,7 @@ public static byte encodeIdentityType(IdentityType identityType) {
         return (byte) (identityType.value << 2);
     }
 
-    public static byte encodeIdentityVersion(IdentityVersion identityVersion) { return (byte) (identityVersion.value << 6); }
+    public static byte encodeIdentityVersion(IdentityVersion identityVersion) { return (byte) (identityVersion.value << 5); }
 
-    public static byte encodeIdentityEnvironment(IdentityEnvironment identityEnvironment) { return (byte) (identityEnvironment.value); }
+    public static byte encodeIdentityEnvironment(IdentityEnvironment identityEnvironment) { return (byte) (identityEnvironment.value << 6); }
 }