Add Greenbids Real Time Data Module

extra/bundle/pom.xml

@@ -40,6 +40,11 @@
             <artifactId>pb-richmedia-filter</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.prebid.server.hooks.modules</groupId>
+            <artifactId>greenbids-real-time-data</artifactId>
+            <version>${project.version}</version>
+        </dependency>
     </dependencies>
 
     <build>

extra/modules/greenbids-real-time-data/pom.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.prebid.server.hooks.modules</groupId>
+        <artifactId>all-modules</artifactId>
+        <version>3.12.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>greenbids-real-time-data</artifactId>
+
+    <name>greenbids-real-time-data</name>
+    <description>Greenbids Real Time Data</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.github.ua-parser</groupId>
+            <artifactId>uap-java</artifactId>
+            <version>1.6.1</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.microsoft.onnxruntime</groupId>
+            <artifactId>onnxruntime</artifactId>
+            <version>1.16.1</version> <!-- Use the latest available version -->
+        </dependency>
+
+        <dependency>
+            <groupId>com.google.cloud</groupId>
+            <artifactId>google-cloud-storage</artifactId>
+            <version>2.41.0</version>
+        </dependency>
+    </dependencies>
+
+</project>

extra/modules/greenbids-real-time-data/src/lombok.config

@@ -0,0 +1 @@
+lombok.anyConstructor.addConstructorProperties = true

extra/modules/greenbids-real-time-data/src/main/java/org/prebid/server/hooks/modules/greenbids/real/time/data/config/GreenbidsRealTimeDataConfiguration.java

@@ -0,0 +1,128 @@
+package org.prebid.server.hooks.modules.greenbids.real.time.data.config;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.github.benmanes.caffeine.cache.Cache;
+import com.github.benmanes.caffeine.cache.Caffeine;
+import com.google.cloud.storage.Storage;
+import com.google.cloud.storage.StorageOptions;
+import com.maxmind.geoip2.DatabaseReader;
+import io.vertx.core.Vertx;
+import org.prebid.server.exception.PreBidException;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.core.ThrottlingThresholds;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.model.config.GreenbidsRealTimeDataProperties;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.model.data.GreenbidsInferenceDataService;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.model.predictor.FilterService;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.model.predictor.ModelCache;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.model.predictor.OnnxModelRunner;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.model.predictor.OnnxModelRunnerWithThresholds;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.model.predictor.ThresholdCache;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.model.result.GreenbidsInvocationService;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.v1.GreenbidsRealTimeDataModule;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.v1.GreenbidsRealTimeDataProcessedAuctionRequestHook;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
+@ConditionalOnProperty(prefix = "hooks." + GreenbidsRealTimeDataModule.CODE, name = "enabled", havingValue = "true")
+@Configuration
+@EnableConfigurationProperties(GreenbidsRealTimeDataProperties.class)
+public class GreenbidsRealTimeDataConfiguration {
+
+    @Bean
+    public DatabaseReader dbReader(GreenbidsRealTimeDataProperties properties) {
+        final File database = new File(properties.getGeoLiteCountryPath());
+        try {
+            return new DatabaseReader.Builder(database).build();
+        } catch (IOException e) {
+            throw new PreBidException("Failed build DatabaseReader from DB", e);
+        }
+    }
+
+    @Bean
+    public GreenbidsInferenceDataService greenbidsInferenceDataService(
+            DatabaseReader dbReader,
+            ObjectMapper mapper) {
+        return new GreenbidsInferenceDataService(dbReader, mapper);
+    }
+
+    @Bean
+    GreenbidsRealTimeDataModule greenbidsRealTimeDataModule(
+            FilterService filterService,
+            OnnxModelRunnerWithThresholds onnxModelRunnerWithThresholds,
+            GreenbidsInferenceDataService greenbidsInferenceDataService,
+            ObjectMapper mapper,
+            GreenbidsInvocationService greenbidsInvocationService) {
+
+        return new GreenbidsRealTimeDataModule(List.of(
+                new GreenbidsRealTimeDataProcessedAuctionRequestHook(
+                        mapper,
+                        filterService,
+                        onnxModelRunnerWithThresholds,
+                        greenbidsInferenceDataService,
+                        greenbidsInvocationService)));
+    }
+
+    @Bean
+    public FilterService filterService() {
+        return new FilterService();
+    }
+
+    @Bean
+    public Storage storage(GreenbidsRealTimeDataProperties properties) {
+        return StorageOptions.newBuilder()
+                .setProjectId(properties.getGoogleCloudGreenbidsProject()).build().getService();
+    }
+
+    @Bean
+    public ModelCache modelCache(GreenbidsRealTimeDataProperties properties, Vertx vertx, Storage storage) {
+        final Cache<String, OnnxModelRunner> modelCacheWithExpiration = Caffeine.newBuilder()
+                .expireAfterWrite(properties.getCacheExpirationMinutes(), TimeUnit.MINUTES)
+                .build();
+
+        return new ModelCache(
+                storage,
+                properties.getGcsBucketName(),
+                modelCacheWithExpiration,
+                properties.getOnnxModelCacheKeyPrefix(),
+                vertx);
+    }
+
+    @Bean
+    public ThresholdCache thresholdCache(
+            GreenbidsRealTimeDataProperties properties,
+            Vertx vertx,
+            Storage storage,
+            ObjectMapper mapper) {
+
+        final Cache<String, ThrottlingThresholds> thresholdsCacheWithExpiration = Caffeine.newBuilder()
+                .expireAfterWrite(properties.getCacheExpirationMinutes(), TimeUnit.MINUTES)
+                .build();
+
+        return new ThresholdCache(
+                storage,
+                properties.getGcsBucketName(),
+                mapper,
+                thresholdsCacheWithExpiration,
+                properties.getThresholdsCacheKeyPrefix(),
+                vertx);
+    }
+
+    @Bean
+    public OnnxModelRunnerWithThresholds onnxModelRunnerWithThresholds(
+            ModelCache modelCache,
+            ThresholdCache thresholdCache) {
+
+        return new OnnxModelRunnerWithThresholds(modelCache, thresholdCache);
+    }
+
+    @Bean
+    public GreenbidsInvocationService greenbidsInvocationService() {
+        return new GreenbidsInvocationService();
+    }
+}

extra/modules/greenbids-real-time-data/src/main/java/org/prebid/server/hooks/modules/greenbids/real/time/data/core/Partner.java

@@ -0,0 +1,30 @@
+package org.prebid.server.hooks.modules.greenbids.real.time.data.core;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Value;
+
+import java.util.Comparator;
+import java.util.List;
+
+@Value(staticConstructor = "of")
+public class Partner {
+
+    String pbuid;
+
+    @JsonProperty("targetTpr")
+    Double targetTpr;
+
+    @JsonProperty("explorationRate")
+    Double explorationRate;
+
+    public Double getThreshold(ThrottlingThresholds throttlingThresholds) {
+        final List<Double> truePositiveRates = throttlingThresholds.getTpr();
+        final List<Double> thresholds = throttlingThresholds.getThresholds();
+
+        return truePositiveRates.stream()
+                .filter(truePositiveRate -> truePositiveRate >= targetTpr)
+                .map(truePositiveRate -> thresholds.get(truePositiveRates.indexOf(truePositiveRate)))
+                .max(Comparator.naturalOrder())
+                .orElse(0.0);
+    }
+}

extra/modules/greenbids-real-time-data/src/main/java/org/prebid/server/hooks/modules/greenbids/real/time/data/core/ThrottlingThresholds.java

@@ -0,0 +1,15 @@
+package org.prebid.server.hooks.modules.greenbids.real.time.data.core;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import lombok.Value;
+
+import java.util.List;
+
+@Value(staticConstructor = "of")
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ThrottlingThresholds {
+
+    List<Double> thresholds;
+
+    List<Double> tpr;
+}

extra/modules/greenbids-real-time-data/src/main/java/org/prebid/server/hooks/modules/greenbids/real/time/data/model/config/GreenbidsRealTimeDataProperties.java

@@ -0,0 +1,22 @@
+package org.prebid.server.hooks.modules.greenbids.real.time.data.model.config;
+
+import lombok.Data;
+import org.prebid.server.hooks.modules.greenbids.real.time.data.v1.GreenbidsRealTimeDataModule;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties(prefix = "hooks.modules." + GreenbidsRealTimeDataModule.CODE)
+@Data
+public class GreenbidsRealTimeDataProperties {
+
+    String googleCloudGreenbidsProject;
+
+    String geoLiteCountryPath;
+
+    String gcsBucketName;
+
+    Integer cacheExpirationMinutes;
+
+    String onnxModelCacheKeyPrefix;
+
+    String thresholdsCacheKeyPrefix;
+}