DATA-22937: LI analytics adapter

extra/modules/live-intent-omni-channel-identity/src/main/java/org/prebid/server/hooks/modules/liveintent/omni/channel/identity/model/config/ModuleConfig.java

@@ -0,0 +1,15 @@
+package org.prebid.server.hooks.modules.liveintent.omni.channel.identity.model.config;
+
+import lombok.Data;
+
+@Data
+public final class ModuleConfig {
+
+    long requestTimeoutMs;
+
+    String identityResolutionEndpoint;
+
+    String authToken;
+
+    float treatmentRate;
+}

extra/modules/live-intent-omni-channel-identity/src/main/java/org/prebid/server/hooks/modules/liveintent/omni/channel/identity/v1/hooks/LiveIntentOmniChannelIdentityProcessedAuctionRequestHook.java

@@ -7,6 +7,8 @@
 import io.vertx.core.MultiMap;
 import org.apache.commons.collections4.ListUtils;
 import org.prebid.server.hooks.execution.v1.InvocationResultImpl;
+import org.prebid.server.hooks.execution.v1.analytics.ActivityImpl;
+import org.prebid.server.hooks.execution.v1.analytics.TagsImpl;
 import org.prebid.server.hooks.execution.v1.auction.AuctionRequestPayloadImpl;
 import org.prebid.server.hooks.modules.liveintent.omni.channel.identity.model.IdResResponse;
 import org.prebid.server.hooks.modules.liveintent.omni.channel.identity.model.config.LiveIntentOmniChannelProperties;
@@ -40,6 +42,8 @@ public class LiveIntentOmniChannelIdentityProcessedAuctionRequestHook implements
     private final JacksonMapper mapper;
     private final HttpClient httpClient;
     private final double logSamplingRate;
+    private final ActivityImpl enriched = ActivityImpl.of("liveintent-enriched", "success", List.of());
+    private final ActivityImpl treatmentRate;
 
     public LiveIntentOmniChannelIdentityProcessedAuctionRequestHook(LiveIntentOmniChannelProperties config,
                                                                     JacksonMapper mapper,
@@ -51,6 +55,11 @@ public LiveIntentOmniChannelIdentityProcessedAuctionRequestHook(LiveIntentOmniCh
         this.mapper = Objects.requireNonNull(mapper);
         this.httpClient = Objects.requireNonNull(httpClient);
         this.logSamplingRate = logSamplingRate;
+        this.treatmentRate = ActivityImpl.of(
+                "liveintent-treatment-rate",
+                String.valueOf(config.getTreatmentRate()),
+                List.of()
+        );
     }
 
     @Override
@@ -95,6 +104,7 @@ private InvocationResultImpl<AuctionRequestPayload> update(IdResResponse resolut
                 .status(InvocationStatus.success)
                 .action(InvocationAction.update)
                 .payloadUpdate(payload -> updatedPayload(payload, resolutionResult.getEids()))
+                .analyticsTags(TagsImpl.of(List.of(enriched, treatmentRate)))
                 .build();
     }
 

extra/modules/live-intent-omni-channel-identity/src/test/java/org/prebid/server/hooks/modules/liveintent/omni/channel/identity/model/config/IdResResponseTest.java

@@ -0,0 +1,40 @@
+package org.prebid.server.hooks.modules.liveintent.omni.channel.identity.model.config;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.iab.openrtb.request.Eid;
+import com.iab.openrtb.request.Uid;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.prebid.server.hooks.modules.liveintent.omni.channel.identity.model.IdResResponse;
+import org.prebid.server.json.JacksonMapper;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class IdResResponseTest {
+
+    private JacksonMapper jacksonMapper;
+
+    @BeforeEach
+    public void setUp() {
+        final ObjectMapper mapper = new ObjectMapper();
+        jacksonMapper = new JacksonMapper(mapper);
+    }
+
+    @Test
+    public void shouldDecodeFromString() {
+        // given
+        final IdResResponse result = jacksonMapper.decodeValue(
+                "{\"eids\": [ { \"source\": \"liveintent.com\", "
+                        + "\"uids\": [ { \"atype\": 3, \"id\" : \"some_id\" } ] } ] }",
+                IdResResponse.class);
+
+        // when and then
+        assertThat(result.getEids()).isEqualTo(List.of(
+                Eid.builder()
+                    .source("liveintent.com")
+                    .uids(List.of(Uid.builder().atype(3).id("some_id").build()))
+                    .build()));
+    }
+}

extra/modules/live-intent-omni-channel-identity/src/test/java/org/prebid/server/hooks/modules/liveintent/omni/channel/identity/model/config/ModuleConfigTest.java

@@ -0,0 +1,35 @@
+package org.prebid.server.hooks.modules.liveintent.omni.channel.identity.model.config;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class ModuleConfigTest {
+
+    @Test
+    public void shouldReturnRequestTimeoutMs() {
+        final ModuleConfig moduleConfig = new ModuleConfig();
+        moduleConfig.setRequestTimeoutMs(5);
+        assertThat(moduleConfig.getRequestTimeoutMs()).isEqualTo(5);
+    }
+
+    @Test
+    public void shouldReturnIdentityResolutionEndpoint() {
+        // given
+        final ModuleConfig moduleConfig = new ModuleConfig();
+        moduleConfig.setIdentityResolutionEndpoint("https://test.com/idres");
+
+        // when and then
+        assertThat(moduleConfig.getIdentityResolutionEndpoint()).isEqualTo("https://test.com/idres");
+    }
+
+    @Test
+    public void shouldReturnAuthToken() {
+        // given
+        final ModuleConfig moduleConfig = new ModuleConfig();
+        moduleConfig.setAuthToken("secret_token");
+
+        // when and then
+        assertThat(moduleConfig.getAuthToken()).isEqualTo("secret_token");
+    }
+}

src/main/java/org/prebid/server/analytics/reporter/liveintent/LiveIntentAnalyticsReporter.java

@@ -0,0 +1,159 @@
+package org.prebid.server.analytics.reporter.liveintent;
+
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.response.BidResponse;
+import io.vertx.core.Future;
+import org.prebid.server.analytics.AnalyticsReporter;
+import org.prebid.server.analytics.model.AuctionEvent;
+import org.prebid.server.analytics.model.NotificationEvent;
+import org.prebid.server.analytics.reporter.liveintent.model.LiveIntentAnalyticsProperties;
+import org.prebid.server.analytics.reporter.liveintent.model.PbsjBid;
+import org.prebid.server.auction.model.AuctionContext;
+import org.prebid.server.exception.PreBidException;
+import org.prebid.server.hooks.execution.model.ExecutionStatus;
+import org.prebid.server.hooks.execution.model.GroupExecutionOutcome;
+import org.prebid.server.hooks.execution.model.HookExecutionContext;
+import org.prebid.server.hooks.execution.model.HookExecutionOutcome;
+import org.prebid.server.hooks.execution.model.Stage;
+import org.prebid.server.hooks.execution.model.StageExecutionOutcome;
+import org.prebid.server.hooks.v1.analytics.Activity;
+import org.prebid.server.hooks.v1.analytics.Tags;
+import org.prebid.server.json.JacksonMapper;
+import org.prebid.server.log.Logger;
+import org.prebid.server.log.LoggerFactory;
+import org.prebid.server.proto.openrtb.ext.request.ExtRequestPrebid;
+import org.prebid.server.vertx.httpclient.HttpClient;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+
+public class LiveIntentAnalyticsReporter implements AnalyticsReporter {
+
+    private final HttpClient httpClient;
+    private final LiveIntentAnalyticsProperties properties;
+    private final JacksonMapper jacksonMapper;
+
+    private static final Logger logger = LoggerFactory.getLogger(LiveIntentAnalyticsReporter.class);
+
+    public LiveIntentAnalyticsReporter(
+            LiveIntentAnalyticsProperties properties,
+            HttpClient httpClient,
+            JacksonMapper jacksonMapper
+    ) {
+        this.httpClient = Objects.requireNonNull(httpClient);
+        this.properties = Objects.requireNonNull(properties);
+        this.jacksonMapper = Objects.requireNonNull(jacksonMapper);
+    }
+
+    @Override
+    public <T> Future<Void> processEvent(T event) {
+        if (event instanceof AuctionEvent auctionEvent) {
+            return processAuctionEvent(auctionEvent.getAuctionContext());
+        } else if (event instanceof NotificationEvent notificationEvent) {
+            return processNotificationEvent(notificationEvent);
+        }
+
+        return Future.succeededFuture();
+    }
+
+    private Future<Void> processNotificationEvent(NotificationEvent notificationEvent) {
+        final String url = properties.getAnalyticsEndpoint() + "/analytic-events/pbsj-winning-bid?"
+                + "b=" + notificationEvent.getBidder()
+                + "&bidId=" + notificationEvent.getBidId();
+        return httpClient.get(url, properties.getTimeoutMs()).mapEmpty();
+    }
+
+    private Future<Void> processAuctionEvent(AuctionContext auctionContext) {
+        try {
+            final BidRequest bidRequest = Optional.ofNullable(auctionContext.getBidRequest())
+                    .orElseThrow(() -> new PreBidException("Bid request should not be empty"));
+            final BidResponse bidResponse = Optional.ofNullable(auctionContext.getBidResponse())
+                    .orElseThrow(() -> new PreBidException("Bid response should not be empty"));
+            final Optional<ExtRequestPrebid> requestPrebid = Optional.ofNullable(bidRequest.getExt())
+                    .flatMap(ext -> Optional.of(ext.getPrebid()));
+
+            final List<Activity> activities = getActivities(auctionContext);
+
+            final List<PbsjBid> pbsjBids = bidResponse.getSeatbid().stream()
+                    .flatMap(seatBid -> seatBid.getBid().stream())
+                    .flatMap(bid ->
+                        bidRequest.getImp().stream()
+                            .filter(impItem -> impItem.getId().equals(bid.getImpid()))
+                            .map(imp ->
+                                PbsjBid.builder()
+                                    .bidId(bid.getId())
+                                    .price(bid.getPrice())
+                                    .adUnitId(imp.getTagid())
+                                    .enriched(isEnriched(activities))
+                                    .currency(bidResponse.getCur())
+                                    .treatmentRate(getTreatmentRate(activities))
+                                    .timestamp(requestPrebid.map(ExtRequestPrebid::getAuctiontimestamp).orElse(0L))
+                                    .partnerId(properties.getPartnerId())
+                                    .build()
+                            )
+            ).toList();
+
+            return httpClient.post(
+                    properties.getAnalyticsEndpoint() + "/analytic-events/pbsj-bids",
+                    jacksonMapper.encodeToString(pbsjBids),
+                    properties.getTimeoutMs()
+                 ).mapEmpty();
+        } catch (Exception e) {
+            logger.error("Error processing event: {}", e.getMessage());
+            return Future.failedFuture(e);
+        }
+    }
+
+    private List<Activity> getActivities(AuctionContext auctionContext) {
+        return Optional.ofNullable(auctionContext)
+                .map(AuctionContext::getHookExecutionContext)
+                .map(HookExecutionContext::getStageOutcomes)
+                .map(stages -> stages.get(Stage.processed_auction_request)).stream()
+                .flatMap(Collection::stream)
+                .filter(stageExecutionOutcome -> "auction-request".equals(stageExecutionOutcome.getEntity()))
+                .map(StageExecutionOutcome::getGroups)
+                .flatMap(Collection::stream)
+                .map(GroupExecutionOutcome::getHooks)
+                .flatMap(Collection::stream)
+                .filter(hook ->
+                        "liveintent-omni-channel-identity-enrichment-hook".equals(hook.getHookId().getModuleCode())
+                                && hook.getStatus() == ExecutionStatus.success
+                )
+                .map(HookExecutionOutcome::getAnalyticsTags)
+                .map(Tags::activities)
+                .flatMap(Collection::stream)
+                .toList();
+    }
+
+    private Float getTreatmentRate(List<Activity> activities) {
+        return activities
+                .stream()
+                .filter(activity -> "liveintent-treatment-rate".equals(activity.name()))
+                .findFirst()
+                .map(activity -> {
+                    try {
+                        return Float.parseFloat(activity.status());
+                    } catch (NumberFormatException e) {
+                        logger.warn("Invalid treatment rate value: {}", activity.status());
+                        throw e;
+                    }
+                })
+                .orElse(null);
+    }
+
+    private boolean isEnriched(List<Activity> activities) {
+        return activities.stream().anyMatch(activity -> "liveintent-enriched".equals(activity.name()));
+    }
+
+    @Override
+    public int vendorId() {
+        return 0;
+    }
+
+    @Override
+    public String name() {
+        return "liveintentAnalytics";
+    }
+}

src/main/java/org/prebid/server/analytics/reporter/liveintent/model/LiveIntentAnalyticsProperties.java

@@ -0,0 +1,15 @@
+package org.prebid.server.analytics.reporter.liveintent.model;
+
+import lombok.Builder;
+import lombok.Data;
+import lombok.Value;
+
+@Data
+@Builder(toBuilder = true)
+@Value
+public class LiveIntentAnalyticsProperties {
+
+    String partnerId;
+    String analyticsEndpoint;
+    long timeoutMs;
+}

src/main/java/org/prebid/server/analytics/reporter/liveintent/model/PbsjBid.java

@@ -0,0 +1,22 @@
+package org.prebid.server.analytics.reporter.liveintent.model;
+
+import lombok.Builder;
+import lombok.Data;
+import lombok.Value;
+
+import java.math.BigDecimal;
+
+@Data
+@Builder(toBuilder = true)
+@Value
+public class PbsjBid {
+
+    String bidId;
+    boolean enriched;
+    BigDecimal price;
+    String adUnitId;
+    String currency;
+    Float treatmentRate;
+    Long timestamp;
+    String partnerId;
+}

src/main/java/org/prebid/server/spring/config/AnalyticsConfiguration.java

@@ -12,6 +12,8 @@
 import org.prebid.server.analytics.reporter.agma.model.AgmaAnalyticsProperties;
 import org.prebid.server.analytics.reporter.greenbids.GreenbidsAnalyticsReporter;
 import org.prebid.server.analytics.reporter.greenbids.model.GreenbidsAnalyticsProperties;
+import org.prebid.server.analytics.reporter.liveintent.LiveIntentAnalyticsReporter;
+import org.prebid.server.analytics.reporter.liveintent.model.LiveIntentAnalyticsProperties;
 import org.prebid.server.analytics.reporter.log.LogAnalyticsReporter;
 import org.prebid.server.analytics.reporter.pubstack.PubstackAnalyticsReporter;
 import org.prebid.server.analytics.reporter.pubstack.model.PubstackAnalyticsProperties;
@@ -302,4 +304,46 @@ private static class PubstackBufferProperties {
             Long reportTtlMs;
         }
     }
+
+    @Configuration
+    @ConditionalOnProperty(prefix = "analytics.liveintent", name = "enabled", havingValue = "true")
+    public static class LiveIntentAnalyticsConfiguration {
+
+        @Bean
+        LiveIntentAnalyticsReporter liveIntentAnalyticsReporter(
+                LiveIntentAnalyticsConfigurationProperties properties,
+                HttpClient httpClient,
+                JacksonMapper jacksonMapper
+        ) {
+            return new LiveIntentAnalyticsReporter(
+                    properties.toComponentProperties(),
+                    httpClient,
+                    jacksonMapper
+            );
+        }
+
+        @Bean
+        @ConfigurationProperties(prefix = "analytics.liveintent")
+        LiveIntentAnalyticsConfigurationProperties liveIntentAnalyticsConfigurationProperties() {
+            return new LiveIntentAnalyticsConfigurationProperties();
+        }
+
+        @Validated
+        @NoArgsConstructor
+        @Data
+        private static class LiveIntentAnalyticsConfigurationProperties {
+
+            String partnerId;
+            String analyticsEndpoint;
+            long timeoutMs;
+
+            public LiveIntentAnalyticsProperties toComponentProperties() {
+                return LiveIntentAnalyticsProperties.builder()
+                        .partnerId(this.partnerId)
+                        .analyticsEndpoint(this.analyticsEndpoint)
+                        .timeoutMs(this.timeoutMs)
+                        .build();
+            }
+        }
+    }
 }