Sparteo: add required query params to adapter endpoint

Author: t-sormonte

src/main/java/org/prebid/server/bidder/sparteo/SparteoBidder.java

@@ -29,6 +29,8 @@
 import org.prebid.server.util.BidderUtil;
 import org.prebid.server.util.HttpUtil;
 
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -45,7 +47,7 @@ public class SparteoBidder implements Bidder<BidRequest> {
     private final JacksonMapper mapper;
 
     public SparteoBidder(String endpointUrl, JacksonMapper mapper) {
-        this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
+        this.endpointUrl = HttpUtil.validateUrlSyntax(Objects.requireNonNull(endpointUrl));
         this.mapper = Objects.requireNonNull(mapper);
     }
 
@@ -79,7 +81,8 @@ public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest request
                 .site(modifySite(request.getSite(), siteNetworkId, mapper))
                 .build();
 
-        final HttpRequest<BidRequest> call = BidderUtil.defaultRequest(outgoingRequest, endpointUrl, mapper);
+        final String finalEndpointUrl = enrichUrlWithQueryParams(endpointUrl, request.getSite(), siteNetworkId);
+        final HttpRequest<BidRequest> call = BidderUtil.defaultRequest(outgoingRequest, finalEndpointUrl, mapper);
 
         return Result.of(Collections.singletonList(call), errors);
     }
@@ -138,6 +141,29 @@ private Site modifySite(Site site, String siteNetworkId, JacksonMapper mapper) {
                 .build();
     }
 
+    private static String enrichUrlWithQueryParams(String baseUrl, Site site, String siteNetworkId) {
+        String url = baseUrl;
+
+        final String domain = Optional.ofNullable(site)
+                .map(Site::getPublisher)
+                .map(Publisher::getDomain)
+                .orElse(null);
+
+        if (domain != null && !domain.isBlank()) {
+            url = appendQueryParam(url, "domain", domain);
+        }
+        if (siteNetworkId != null && !siteNetworkId.isBlank()) {
+            url = appendQueryParam(url, "networkId", siteNetworkId);
+        }
+
+        return url;
+    }
+
+    private static String appendQueryParam(String url, String name, String value) {
+        final String sep = url.contains("?") ? "&" : "?";
+        return url + sep + name + "=" + URLEncoder.encode(value, StandardCharsets.UTF_8);
+    }
+
     @Override
     public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
         try {

src/test/java/org/prebid/server/bidder/sparteo/SparteoBidderTest.java

@@ -25,9 +25,14 @@
 import org.prebid.server.proto.openrtb.ext.response.BidType;
 
 import java.math.BigDecimal;
+import java.net.URI;
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.function.UnaryOperator;
 
 import static java.util.Arrays.asList;
@@ -121,7 +126,7 @@ public void makeHttpRequestsShouldSetNetworkIdOnSitePublisherExtWhenPresentInImp
         assertThat(result.getErrors()).isEmpty();
         assertThat(result.getValue())
                 .extracting(HttpRequest::getMethod, HttpRequest::getUri)
-                .containsExactly(tuple(HttpMethod.POST, ENDPOINT_URL));
+                .containsExactly(tuple(HttpMethod.POST, ENDPOINT_URL + "?networkId=testNetworkId"));
 
         assertThat(result.getValue())
                 .extracting(HttpRequest::getPayload)
@@ -857,6 +862,34 @@ public void makeBidsShouldReturnEmptyResultWhenSeatBidHasEmptyBidList() throws J
         assertThat(result.getValue()).isEmpty();
     }
 
+    @Test
+    public void makeHttpRequestsShouldAppendDomainAndNetworkIdAsQueryParams() {
+        // given
+        final ObjectNode impExt = mapper.createObjectNode();
+        impExt.set("bidder", mapper.createObjectNode()
+                .put("networkId", "testNetworkId"));
+
+        final BidRequest bidRequest = givenBidRequest(
+                request -> request.site(Site.builder()
+                        .publisher(Publisher.builder().domain("dev.sparteo.com").build())
+                        .build()),
+                givenImp(imp -> imp.ext(impExt)));
+
+        // when
+        final Result<List<HttpRequest<BidRequest>>> result = sparteoBidder.makeHttpRequests(bidRequest);
+
+        // then
+        assertThat(result.getErrors()).isEmpty();
+        assertThat(result.getValue()).hasSize(1);
+
+        final String uri = result.getValue().get(0).getUri();
+        final Map<String, String> qp = parseQueryParams(uri);
+
+        assertThat(qp)
+                .containsEntry("domain", "dev.sparteo.com")
+                .containsEntry("networkId", "testNetworkId");
+    }
+
     private BidRequest givenBidRequest(UnaryOperator<BidRequest.BidRequestBuilder> customizer, Imp... imps) {
         return customizer.apply(BidRequest.builder().imp(asList(imps))).build();
     }
@@ -916,4 +949,22 @@ private ObjectNode createBidExtWithEmptyPrebid() {
         bidExt.set("prebid", mapper.createObjectNode());
         return bidExt;
     }
+
+    private static Map<String, String> parseQueryParams(String uri) {
+        final String raw = URI.create(uri).getRawQuery();
+        final Map<String, String> out = new HashMap<>();
+        if (raw == null || raw.isEmpty()) {
+            return out;
+        }
+        for (String pair : raw.split("&")) {
+            final int idx = pair.indexOf('=');
+            final String name = idx >= 0 ? pair.substring(0, idx) : pair;
+            final String value = idx >= 0 ? pair.substring(idx + 1) : "";
+            out.put(
+                    URLDecoder.decode(name, StandardCharsets.UTF_8),
+                    URLDecoder.decode(value, StandardCharsets.UTF_8)
+            );
+        }
+        return out;
+    }
 }

src/test/java/org/prebid/server/it/SparteoTest.java

@@ -5,6 +5,7 @@
 import org.prebid.server.model.Endpoint;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
 import static com.github.tomakehurst.wiremock.client.WireMock.equalToJson;
 import static com.github.tomakehurst.wiremock.client.WireMock.post;
 import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
@@ -15,6 +16,8 @@ public class SparteoTest extends IntegrationTest {
     @Test
     public void openrtb2AuctionShouldRespondWithBidsFromSparteoBanner() throws Exception {
         WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/sparteo-exchange"))
+                .withQueryParam("domain", equalTo("dev.sparteo.com"))
+                .withQueryParam("networkId", equalTo("networkId"))
                 .withRequestBody(equalToJson(
                     jsonFrom("openrtb2/sparteo/test-sparteo-bid-request.json")))
                 .willReturn(aResponse().withBody(

src/test/resources/org/prebid/server/it/test-application.properties

@@ -534,7 +534,7 @@ adapters.sovrn.endpoint=http://localhost:8090/sovrn-exchange
 adapters.sovrnXsp.enabled=true
 adapters.sovrnXsp.endpoint=http://localhost:8090/sovrnxsp-exchange
 adapters.sparteo.enabled=true
-adapters.sparteo.endpoint=http://localhost:8090/sparteo-exchange
+adapters.sparteo.endpoint=http://localhost:8090/sparteo-exchange?domain={{Domain}}&networkId={{NetworkId}}
 adapters.sspbc.enabled=true
 adapters.sspbc.endpoint=http://localhost:8090/sspbc-exchange
 adapters.sharethrough.enabled=true