Core: Support bidder specific device data

src/main/java/org/prebid/server/auction/ExchangeService.java

@@ -5,6 +5,7 @@
 import com.iab.openrtb.request.App;
 import com.iab.openrtb.request.BidRequest;
 import com.iab.openrtb.request.Content;
+import com.iab.openrtb.request.Device;
 import com.iab.openrtb.request.Dooh;
 import com.iab.openrtb.request.Eid;
 import com.iab.openrtb.request.Imp;
@@ -97,6 +98,7 @@
 import org.prebid.server.util.ListUtil;
 import org.prebid.server.util.PbsUtil;
 import org.prebid.server.util.StreamUtil;
+import org.apache.commons.lang3.tuple.Pair;
 
 import java.math.BigDecimal;
 import java.time.Clock;
@@ -502,10 +504,10 @@ private Future<List<AuctionParticipation>> makeAuctionParticipation(
         final ExtRequestPrebid prebid = requestExt == null ? null : requestExt.getPrebid();
         final Map<String, ExtBidderConfigOrtb> biddersToConfigs = getBiddersToConfigs(prebid);
         final Map<String, List<String>> eidPermissions = getEidPermissions(prebid);
-        final Map<String, User> bidderToUser =
-                prepareUsers(bidders, context, aliases, biddersToConfigs, eidPermissions);
+        final Map<String, Pair<User, Device>> bidderToUserAndDevice =
+                prepareUsersAndDevices(bidders, context, aliases, biddersToConfigs, eidPermissions);
 
-        return privacyEnforcementService.mask(context, bidderToUser, aliases)
+        return privacyEnforcementService.mask(context, bidderToUserAndDevice, aliases)
                 .map(bidderToPrivacyResult -> getAuctionParticipation(
                         bidderToPrivacyResult,
                         bidRequest,
@@ -557,7 +559,7 @@ private static List<String> firstPartyDataBidders(ExtRequest requestExt) {
         return data == null ? null : data.getBidders();
     }
 
-    private Map<String, User> prepareUsers(List<String> bidders,
+    private Map<String, Pair<User, Device>> prepareUsersAndDevices(List<String> bidders,
                                            AuctionContext context,
                                            BidderAliases aliases,
                                            Map<String, ExtBidderConfigOrtb> biddersToConfigs,
@@ -566,17 +568,19 @@ private Map<String, User> prepareUsers(List<String> bidders,
         final BidRequest bidRequest = context.getBidRequest();
         final List<String> firstPartyDataBidders = firstPartyDataBidders(bidRequest.getExt());
 
-        final Map<String, User> bidderToUser = new HashMap<>();
+        final Map<String, Pair<User, Device>> bidderToUserAndDevice = new HashMap<>();
         for (String bidder : bidders) {
             final ExtBidderConfigOrtb fpdConfig = ObjectUtils.defaultIfNull(biddersToConfigs.get(bidder),
                     biddersToConfigs.get(ALL_BIDDERS_CONFIG));
             final boolean useFirstPartyData = firstPartyDataBidders == null || firstPartyDataBidders.stream()
                     .anyMatch(fpdBidder -> StringUtils.equalsIgnoreCase(fpdBidder, bidder));
             final User preparedUser = prepareUser(
                     bidder, context, aliases, useFirstPartyData, fpdConfig, eidPermissions);
-            bidderToUser.put(bidder, preparedUser);
+            final Device preparedDevice = prepareDevice(
+                    bidRequest.getDevice(), fpdConfig, useFirstPartyData);
+            bidderToUserAndDevice.put(bidder, Pair.of(preparedUser, preparedDevice));
         }
-        return bidderToUser;
+        return bidderToUserAndDevice;
     }
 
     private User prepareUser(String bidder,
@@ -813,7 +817,6 @@ private BidRequest prepareBidRequest(BidderPrivacyResult bidderPrivacyResult,
         final boolean isApp = preparedApp != null;
         final boolean isDooh = !isApp && preparedDooh != null;
         final boolean isSite = !isApp && !isDooh && preparedSite != null;
-
         final List<Imp> preparedImps = prepareImps(
                 bidder,
                 bidRequest,
@@ -945,6 +948,13 @@ private App prepareApp(App app, ObjectNode fpdApp, boolean useFirstPartyData) {
         return useFirstPartyData ? fpdResolver.resolveApp(maskedApp, fpdApp) : maskedApp;
     }
 
+    private Device prepareDevice(Device device, ExtBidderConfigOrtb fpdConfig, boolean useFirstPartyData) {
+        if (fpdConfig == null) {
+            return device;
+        }
+        return useFirstPartyData ? fpdResolver.resolveDevice(device, fpdConfig.getDevice()) : device;
+    }
+
     private static ExtApp maskExtApp(ExtApp appExt) {
         final ExtApp maskedExtApp = ExtApp.of(appExt.getPrebid(), null);
         return maskedExtApp.isEmpty() ? null : maskedExtApp;

src/main/java/org/prebid/server/auction/FpdResolver.java

@@ -6,6 +6,7 @@
 import com.fasterxml.jackson.databind.node.NullNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.iab.openrtb.request.App;
+import com.iab.openrtb.request.Device;
 import com.iab.openrtb.request.Dooh;
 import com.iab.openrtb.request.Site;
 import com.iab.openrtb.request.User;
@@ -23,7 +24,8 @@ public class FpdResolver {
     private static final String BIDDERS = "bidders";
     private static final String APP = "app";
     private static final String DOOH = "dooh";
-    private static final Set<String> KNOWN_FPD_ATTRIBUTES = Set.of(USER, SITE, APP, DOOH, BIDDERS);
+    private static final String DEVICE = "device";
+    private static final Set<String> KNOWN_FPD_ATTRIBUTES = Set.of(USER, SITE, APP, DOOH, DEVICE, BIDDERS);
     private static final String CONTEXT = "context";
     private static final String DATA = "data";
 
@@ -51,6 +53,10 @@ public Dooh resolveDooh(Dooh originDooh, ObjectNode fpdDooh) {
         return mergeFpd(originDooh, fpdDooh, Dooh.class);
     }
 
+    public Device resolveDevice(Device originDevice, ObjectNode fpdDevice) {
+        return mergeFpd(originDevice, fpdDevice, Device.class);
+    }
+
     private <T> T mergeFpd(T original, ObjectNode fpd, Class<T> tClass) {
         if (fpd == null || fpd.isNull() || fpd.isMissingNode()) {
             return original;

src/main/java/org/prebid/server/auction/privacy/enforcement/PrivacyEnforcementService.java

@@ -1,10 +1,12 @@
 package org.prebid.server.auction.privacy.enforcement;
 
+import com.iab.openrtb.request.Device;
 import com.iab.openrtb.request.User;
 import io.vertx.core.Future;
 import org.prebid.server.auction.aliases.BidderAliases;
 import org.prebid.server.auction.model.AuctionContext;
 import org.prebid.server.auction.model.BidderPrivacyResult;
+import org.apache.commons.lang3.tuple.Pair;
 
 import java.util.List;
 import java.util.Map;
@@ -22,14 +24,14 @@ public PrivacyEnforcementService(final List<PrivacyEnforcement> enforcements) {
     }
 
     public Future<List<BidderPrivacyResult>> mask(AuctionContext auctionContext,
-                                                  Map<String, User> bidderToUser,
+                                                  Map<String, Pair<User, Device>> bidderToUserAndDevice,
                                                   BidderAliases aliases) {
 
-        final List<BidderPrivacyResult> initialResults = bidderToUser.entrySet().stream()
+        final List<BidderPrivacyResult> initialResults = bidderToUserAndDevice.entrySet().stream()
                 .map(entry -> BidderPrivacyResult.builder()
                         .requestBidder(entry.getKey())
-                        .user(entry.getValue())
-                        .device(auctionContext.getBidRequest().getDevice())
+                        .user(entry.getValue().getLeft())
+                        .device(entry.getValue().getRight())
                         .build())
                 .toList();
 

src/main/java/org/prebid/server/proto/openrtb/ext/request/ExtBidderConfigOrtb.java

@@ -25,4 +25,9 @@ public class ExtBidderConfigOrtb {
      * Defines the contract for bidrequest.ext.prebid.bidderconfig.config.ortb2.user
      */
     ObjectNode user;
+
+    /**
+     * Defines the contract for bidrequest.ext.prebid.bidderconfig.config.ortb2.device
+     */
+    ObjectNode device;
 }

src/test/java/org/prebid/server/auction/ExchangeServiceTest.java

@@ -322,10 +322,12 @@ public void setUp() {
 
         given(privacyEnforcementService.mask(any(), argThat(MapUtils::isNotEmpty), any()))
                 .willAnswer(inv ->
-                        Future.succeededFuture(((Map<String, User>) inv.getArgument(1)).entrySet().stream()
+                        Future.succeededFuture(((Map<String, Pair<User, Device>>) inv.getArgument(1)).entrySet()
+                                .stream()
                                 .map(bidderAndUser -> BidderPrivacyResult.builder()
                                         .requestBidder(bidderAndUser.getKey())
-                                        .user(bidderAndUser.getValue())
+                                        .user(bidderAndUser.getValue().getLeft())
+                                        .device(bidderAndUser.getValue().getRight())
                                         .build())
                                 .toList()));
 
@@ -2691,12 +2693,12 @@ public void shouldUseConcreteOverGeneralSiteWithExtPrebidBidderConfigIgnoringCas
 
         final ObjectNode siteWithPage = mapper.valueToTree(Site.builder().page("testPage").build());
         final ExtBidderConfig extBidderConfig = ExtBidderConfig.of(
-                ExtBidderConfigOrtb.of(siteWithPage, null, null, null));
+                ExtBidderConfigOrtb.of(siteWithPage, null, null, null, null));
         final ExtRequestPrebidBidderConfig concreteFpdConfig = ExtRequestPrebidBidderConfig.of(
                 singletonList("SoMeBiDdEr"), extBidderConfig);
         final ObjectNode siteWithDomain = mapper.valueToTree(Site.builder().domain("notUsed").build());
         final ExtBidderConfig allExtBidderConfig = ExtBidderConfig.of(
-                ExtBidderConfigOrtb.of(siteWithDomain, null, null, null));
+                ExtBidderConfigOrtb.of(siteWithDomain, null, null, null, null));
         final ExtRequestPrebidBidderConfig allFpdConfig = ExtRequestPrebidBidderConfig.of(singletonList("*"),
                 allExtBidderConfig);
 
@@ -2738,12 +2740,12 @@ public void shouldUseConcreteOverGeneralDoohWithExtPrebidBidderConfig() {
 
         final ObjectNode doohWithVenueType = mapper.valueToTree(Dooh.builder().venuetype(List.of("venuetype")).build());
         final ExtBidderConfig extBidderConfig = ExtBidderConfig.of(
-                ExtBidderConfigOrtb.of(null, null, doohWithVenueType, null));
+                ExtBidderConfigOrtb.of(null, null, doohWithVenueType, null, null));
         final ExtRequestPrebidBidderConfig concreteFpdConfig = ExtRequestPrebidBidderConfig.of(
                 singletonList("someBidder"), extBidderConfig);
         final ObjectNode doohWithDomain = mapper.valueToTree(Dooh.builder().domain("notUsed").build());
         final ExtBidderConfig allExtBidderConfig = ExtBidderConfig.of(
-                ExtBidderConfigOrtb.of(null, null, doohWithDomain, null));
+                ExtBidderConfigOrtb.of(null, null, doohWithDomain, null, null));
         final ExtRequestPrebidBidderConfig allFpdConfig = ExtRequestPrebidBidderConfig.of(
                 singletonList("*"),
                 allExtBidderConfig);
@@ -2787,15 +2789,15 @@ public void shouldUseConcreteOverGeneralAppWithExtPrebidBidderConfigIgnoringCase
         final Publisher publisherWithId = Publisher.builder().id("testId").build();
         final ObjectNode appWithPublisherId = mapper.valueToTree(App.builder().publisher(publisherWithId).build());
         final ExtBidderConfig extBidderConfig = ExtBidderConfig.of(
-                ExtBidderConfigOrtb.of(null, appWithPublisherId, null, null));
+                ExtBidderConfigOrtb.of(null, appWithPublisherId, null, null, null));
         final ExtRequestPrebidBidderConfig concreteFpdConfig = ExtRequestPrebidBidderConfig.of(
                 singletonList("SoMeBiDdEr"), extBidderConfig);
 
         final Publisher publisherWithIdAndDomain = Publisher.builder().id("notUsed").domain("notUsed").build();
         final ObjectNode appWithUpdatedPublisher = mapper.valueToTree(
                 App.builder().publisher(publisherWithIdAndDomain).build());
         final ExtBidderConfig allExtBidderConfig = ExtBidderConfig.of(
-                ExtBidderConfigOrtb.of(null, appWithUpdatedPublisher, null, null));
+                ExtBidderConfigOrtb.of(null, appWithUpdatedPublisher, null, null, null));
         final ExtRequestPrebidBidderConfig allFpdConfig = ExtRequestPrebidBidderConfig.of(singletonList("*"),
                 allExtBidderConfig);
 
@@ -2834,13 +2836,13 @@ public void shouldUseConcreteOverGeneralUserWithExtPrebidBidderConfig() {
         givenBidder("someBidder", bidder, givenEmptySeatBid());
         final ObjectNode bidderConfigUser = mapper.valueToTree(User.builder().id("userFromConfig").build());
         final ExtBidderConfig extBidderConfig = ExtBidderConfig.of(
-                ExtBidderConfigOrtb.of(null, null, null, bidderConfigUser));
+                ExtBidderConfigOrtb.of(null, null, null, bidderConfigUser, null));
         final ExtRequestPrebidBidderConfig concreteFpdConfig = ExtRequestPrebidBidderConfig.of(
                 singletonList("SomMeBiDdEr"), extBidderConfig);
 
         final ObjectNode emptyUser = mapper.valueToTree(User.builder().build());
         final ExtBidderConfig allExtBidderConfig = ExtBidderConfig.of(
-                ExtBidderConfigOrtb.of(null, null, null, emptyUser));
+                ExtBidderConfigOrtb.of(null, null, null, emptyUser, null));
         final ExtRequestPrebidBidderConfig allFpdConfig = ExtRequestPrebidBidderConfig.of(singletonList("*"),
                 allExtBidderConfig);
         final User requestUser = User.builder().id("erased").buyeruid("testBuyerId").build();
@@ -2870,6 +2872,44 @@ public void shouldUseConcreteOverGeneralUserWithExtPrebidBidderConfig() {
                 .containsOnly(mergedUser);
     }
 
+    @Test
+    public void shouldUseBidderSpecificDeviceDataInBidderRequest() {
+        // given
+        final Bidder<?> bidder = mock(Bidder.class);
+        givenBidder("someBidder", bidder, givenEmptySeatBid());
+
+        final ObjectNode deviceWithMakeAndModel = mapper.valueToTree(
+                Device.builder().make("TestMake_001").model("TestModel_001").build());
+        final ExtBidderConfig extBidderConfig = ExtBidderConfig.of(
+                ExtBidderConfigOrtb.of(null, null, null, null, deviceWithMakeAndModel));
+        final ExtRequestPrebidBidderConfig concreteFpdConfig = ExtRequestPrebidBidderConfig.of(
+                singletonList("someBidder"), extBidderConfig);
+        final Device requestDevice = Device.builder().build();
+        final ExtRequestPrebid extRequestPrebid = ExtRequestPrebid.builder()
+                .bidderconfig(singletonList(concreteFpdConfig))
+                .build();
+        final BidRequest bidRequest = givenBidRequest(givenSingleImp(singletonMap("someBidder", 1)),
+                builder -> builder.device(requestDevice).ext(ExtRequest.of(extRequestPrebid)));
+        final Device mergedDevice = Device.builder()
+                .make("TestMake_001").model("TestModel_001").build();
+
+        given(fpdResolver.resolveDevice(any(), any())).willReturn(mergedDevice);
+
+        // when
+        target.holdAuction(givenRequestContext(bidRequest));
+
+        // then
+        final ArgumentCaptor<BidderRequest> bidderRequestCaptor = ArgumentCaptor.forClass(BidderRequest.class);
+        verify(httpBidderRequester)
+                .requestBids(any(), bidderRequestCaptor.capture(), any(), any(), any(), any(), anyBoolean());
+        final List<BidderRequest> capturedBidRequests = bidderRequestCaptor.getAllValues();
+
+        assertThat(capturedBidRequests)
+                .extracting(BidderRequest::getBidRequest)
+                .extracting(BidRequest::getDevice)
+                .containsOnly(mergedDevice);
+    }
+
     @Test
     public void shouldAddBuyeridToUserFromRequest() {
         // given

src/test/java/org/prebid/server/auction/FpdResolverTest.java

@@ -4,6 +4,7 @@
 import com.iab.openrtb.request.App;
 import com.iab.openrtb.request.Content;
 import com.iab.openrtb.request.Data;
+import com.iab.openrtb.request.Device;
 import com.iab.openrtb.request.Dooh;
 import com.iab.openrtb.request.Geo;
 import com.iab.openrtb.request.Publisher;
@@ -17,6 +18,9 @@
 import org.prebid.server.json.JsonMerger;
 import org.prebid.server.proto.openrtb.ext.request.ExtApp;
 import org.prebid.server.proto.openrtb.ext.request.ExtAppPrebid;
+import org.prebid.server.proto.openrtb.ext.request.ExtDevice;
+import org.prebid.server.proto.openrtb.ext.request.ExtDeviceInt;
+import org.prebid.server.proto.openrtb.ext.request.ExtDevicePrebid;
 import org.prebid.server.proto.openrtb.ext.request.ExtDooh;
 import org.prebid.server.proto.openrtb.ext.request.ExtSite;
 import org.prebid.server.proto.openrtb.ext.request.ExtUser;
@@ -134,6 +138,80 @@ public void resolveUserShouldReturnCopyOfUserExtDataIfFPDUserExtDataIsMissing()
         assertThat(resultUser.getExt().getData().equals(originExtUserData)).isTrue(); // but the same by value
     }
 
+    @Test
+    public void resolveDeviceShouldOverrideFpdFieldsFromFpdDevice() {
+        // given
+        final Device originDevice = Device.builder()
+                .devicetype(1)
+                .make("original_make")
+                .model("original_model")
+                .os("original_os")
+                .osv("original_osv")
+                .hwv("original_hwv")
+                .language("original_language")
+                .h(1111)
+                .js(1)
+                .ip("original_ip")
+                .build();
+
+        final Device fpdDevice = Device.builder()
+                .devicetype(2)
+                .make("fpd_make")
+                .model("fpd_model")
+                .os("fpd_os")
+                .osv("fpd_osv")
+                .hwv("fpd_hwv")
+                .ip("new_ip")
+                .build();
+
+        // when
+        final Device resultDevice = target.resolveDevice(originDevice, mapper.valueToTree(fpdDevice));
+
+        // then
+        assertThat(resultDevice).isEqualTo(Device.builder()
+                .devicetype(2)
+                .make("fpd_make")
+                .model("fpd_model")
+                .os("fpd_os")
+                .osv("fpd_osv")
+                .hwv("fpd_hwv")
+                .language("original_language")
+                .h(1111)
+                .js(1)
+                .ip("new_ip")
+                .build());
+    }
+
+    @Test
+    public void resolveDeviceShouldReturnOriginDeviceIfFpdDeviceIsNull() {
+        assertThat(target.resolveDevice(Device.builder().make("test_make").build(), null))
+                .isEqualTo(Device.builder().make("test_make").build());
+    }
+
+    @Test
+    public void resolveDeviceShouldReturnFpdDeviceIfOriginDeviceIsNull() {
+        assertThat(target.resolveDevice(null, mapper.valueToTree(Device.builder().model("test_model").build())))
+                .isEqualTo(Device.builder().model("test_model").build());
+    }
+
+    @Test
+    public void resolveDeviceShouldNotChangeOriginExtDataIfFPDDoesNotHaveExt() {
+        // given
+        final Device originDevice = Device.builder()
+                .ext(ExtDevice.of(1, ExtDevicePrebid.of(ExtDeviceInt.of(10, 20))))
+                .build();
+
+        final Device fpdDevice = Device.builder().build();
+
+        // when
+        final Device resultDevice = target.resolveDevice(originDevice, mapper.valueToTree(fpdDevice));
+
+        // then
+        assertThat(resultDevice).isEqualTo(Device.builder()
+                .ext(ExtDevice.of(1, ExtDevicePrebid.of(ExtDeviceInt.of(10, 20))))
+                .build());
+    }
+
     @Test
     public void resolveAppShouldOverrideFpdFieldsFromFpdApp() {
         // given