Merge pull request #140 from IABTechLab/vse-UID2-797-track-advertiser-token-expiry

Track advertiser token expiry

Author: vishalegbert-ttd

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

@@ -5,6 +5,7 @@
 import io.vertx.core.AsyncResult;
 import io.vertx.core.Handler;
 
+import java.time.Duration;
 import java.time.Instant;
 import java.util.List;
 
@@ -27,4 +28,5 @@ public interface IUIDOperatorService {
 
     Instant getLatestOptoutEntry(UserIdentity userIdentity, Instant asOf);
 
+    Duration getIdentityExpiryDuration();
 }

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

@@ -175,6 +175,11 @@ public Instant getLatestOptoutEntry(UserIdentity userIdentity, Instant asOf) {
         return this.optOutStore.getLatestEntry(firstLevelHashIdentity);
     }
 
+    @Override
+    public Duration getIdentityExpiryDuration() {
+        return this.identityExpiresAfter;
+    }
+
     private UserIdentity getFirstLevelHashIdentity(UserIdentity userIdentity, Instant asOf) {
         return getFirstLevelHashIdentity(userIdentity.identityScope, userIdentity.identityType, userIdentity.id, asOf);
     }

src/main/java/com/uid2/operator/vertx/UIDOperatorVerticle.java

@@ -71,7 +71,8 @@ public class UIDOperatorVerticle extends AbstractVerticle{
     private final Clock clock;
     private IUIDOperatorService idService;
     private final Map<String, DistributionSummary> _identityMapMetricSummaries = new HashMap<>();
-    private final Map<String, DistributionSummary> _refreshDurationMetricSummaries = new HashMap<>();
+    private final Map<Tuple.Tuple2<String, Boolean>, DistributionSummary> _refreshDurationMetricSummaries = new HashMap<>();
+    private final Map<Tuple.Tuple3<String, Boolean, Boolean>, Counter> _advertisingTokenExpiryStatus = new HashMap<>();
     private final Map<Tuple.Tuple2<String, TokenGeneratePolicy>, Counter> _tokenGeneratePolicyCounters = new HashMap<>();
     private final Map<Tuple.Tuple2<String, IdentityMapPolicy>, Counter> _identityMapPolicyCounters = new HashMap<>();
     private final Map<String, Tuple.Tuple2<Counter, Counter>> _identityMapUnmappedIdentifiers = new HashMap<>();
@@ -372,7 +373,7 @@ private void handleTokenRefreshV1(RoutingContext rc) {
                 }
             } else {
                 ResponseUtil.Success(rc, toJsonV1(r.getTokens()));
-                this.recordRefreshDurationStats(siteId, getApiContact(rc), r.getDurationSinceLastRefresh());
+                this.recordRefreshDurationStats(siteId, getApiContact(rc), r.getDurationSinceLastRefresh(), rc.request().headers().contains("Origin"));
             }
 
             TokenResponseStatsCollector.record(siteId, TokenResponseStatsCollector.Endpoint.RefreshV1, r);
@@ -402,7 +403,7 @@ private void handleTokenRefreshV2(RoutingContext rc) {
                 }
             } else {
                 ResponseUtil.SuccessV2(rc, toJsonV1(r.getTokens()));
-                this.recordRefreshDurationStats(siteId, getApiContact(rc), r.getDurationSinceLastRefresh());
+                this.recordRefreshDurationStats(siteId, getApiContact(rc), r.getDurationSinceLastRefresh(), rc.request().headers().contains("Origin"));
             }
             TokenResponseStatsCollector.record(siteId, TokenResponseStatsCollector.Endpoint.RefreshV2, r);
         } catch (Exception e) {
@@ -589,7 +590,7 @@ private void handleTokenRefresh(RoutingContext rc) {
 
             Integer siteId = rc.get(Const.RoutingContextData.SiteId);
             if (r.isRefreshed()) {
-                this.recordRefreshDurationStats(siteId, getApiContact(rc), r.getDurationSinceLastRefresh());
+                this.recordRefreshDurationStats(siteId, getApiContact(rc), r.getDurationSinceLastRefresh(), rc.request().headers().contains("Origin"));
             }
             TokenResponseStatsCollector.record(siteId, TokenResponseStatsCollector.Endpoint.RefreshV0, r);
         } catch (Exception e) {
@@ -1254,16 +1255,29 @@ private RefreshResponse refreshIdentity(RoutingContext rc, String tokenStr) {
         return this.idService.refreshIdentity(refreshToken);
     }
 
-    private void recordRefreshDurationStats(Integer siteId, String apiContact, Duration durationSinceLastRefresh) {
-        DistributionSummary ds = _refreshDurationMetricSummaries.computeIfAbsent(apiContact, k ->
+    private void recordRefreshDurationStats(Integer siteId, String apiContact, Duration durationSinceLastRefresh, boolean hasOriginHeader) {
+        DistributionSummary ds = _refreshDurationMetricSummaries.computeIfAbsent(new Tuple.Tuple2<>(apiContact, hasOriginHeader), k ->
                 DistributionSummary
                         .builder("uid2.token_refresh_duration_seconds")
                         .description("duration between token refreshes")
                         .tag("site_id", String.valueOf(siteId))
                         .tag("api_contact", apiContact)
+                        .tag("has_origin_header", hasOriginHeader ? "true" : "false")
                         .register(Metrics.globalRegistry)
         );
         ds.record(durationSinceLastRefresh.getSeconds());
+
+        boolean isExpired = durationSinceLastRefresh.compareTo(this.idService.getIdentityExpiryDuration()) > 0;
+        Counter c = _advertisingTokenExpiryStatus.computeIfAbsent(new Tuple.Tuple3<>(String.valueOf(siteId), hasOriginHeader, isExpired), k ->
+                Counter
+                        .builder("uid2.advertising_token_expired_on_refresh")
+                        .description("status of advertiser token expiry")
+                        .tag("site_id", String.valueOf(siteId))
+                        .tag("has_origin_header", hasOriginHeader ? "true" : "false")
+                        .tag("is_expired", isExpired ? "true" : "false")
+                        .register(Metrics.globalRegistry)
+        );
+        c.increment();
     }
 
     private InputUtil.InputVal[] createInputList(JsonArray a, boolean inputAsHash) {
@@ -1458,6 +1472,4 @@ public static enum UserConsentStatus {
         INSUFFICIENT,
         INVALID,
     }
-
-
 }

src/test/java/com/uid2/operator/UIDOperatorVerticleTest.java

@@ -1102,6 +1102,38 @@ void captureDurationsBetweenRefresh(String apiVersion, Vertx vertx, VertxTestCon
                         .tag("api_contact", "test-contact")
                         .tag("site_id", String.valueOf(clientSiteId))
                         .summary().mean());
+
+                assertEquals(1, Metrics.globalRegistry
+                        .get("uid2.advertising_token_expired_on_refresh")
+                        .tag("site_id", String.valueOf(clientSiteId))
+                        .tag("is_expired", "false")
+                        .counter().count());
+
+                testContext.completeNow();
+            });
+        });
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"v1", "v2"})
+    void captureExpiredAdvertisingTokenStatus(String apiVersion, Vertx vertx, VertxTestContext testContext) {
+        final int clientSiteId = 201;
+        fakeAuth(clientSiteId, Role.GENERATOR);
+        final String emailAddress = "[email protected]";
+        generateRefreshToken(apiVersion, vertx, "email", emailAddress, clientSiteId, genRespJson -> {
+            JsonObject bodyJson = genRespJson.getJsonObject("body");
+            String refreshToken = bodyJson.getString("refresh_token");
+            when(clock.instant()).thenAnswer(i -> Instant.now().plusSeconds(identityExpiresAfter.toSeconds() + 1));
+
+            sendTokenRefresh(apiVersion, vertx, refreshToken, bodyJson.getString("refresh_response_key"), 200, refreshRespJson-> {
+                assertEquals("success", refreshRespJson.getString("status"));
+
+                assertEquals(1, Metrics.globalRegistry
+                        .get("uid2.advertising_token_expired_on_refresh")
+                        .tag("site_id", String.valueOf(clientSiteId))
+                        .tag("is_expired", "true")
+                        .counter().count());
+
                 testContext.completeNow();
             });
         });