Sparteo: add required query params to adapter endpoint

Author: t-sormonte

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

@@ -38,14 +38,16 @@
 
 public class SparteoBidder implements Bidder<BidRequest> {
 
+    private static final String NETWORK_ID_MACRO = "{{NetworkId}}";
+    private static final String DOMAIN_MACRO = "{{Domain}}";
     private static final TypeReference<ExtPrebid<?, ExtImpSparteo>> TYPE_REFERENCE =
             new TypeReference<>() { };
 
     private final String endpointUrl;
     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 = replaceMacros(request.getSite(), siteNetworkId);
+        final HttpRequest<BidRequest> call = BidderUtil.defaultRequest(outgoingRequest, finalEndpointUrl, mapper);
 
         return Result.of(Collections.singletonList(call), errors);
     }
@@ -92,7 +95,7 @@ private ExtImpSparteo parseExtImp(Imp imp) {
         }
     }
 
-    private static ObjectNode modifyImpExt(Imp imp) {
+    private ObjectNode modifyImpExt(Imp imp) {
         final ObjectNode modifiedImpExt = imp.getExt().deepCopy();
         final ObjectNode sparteoNode = modifiedImpExt.putObject("sparteo");
         final JsonNode bidderJsonNode = modifiedImpExt.remove("bidder");
@@ -138,6 +141,28 @@ private Site modifySite(Site site, String siteNetworkId, JacksonMapper mapper) {
                 .build();
     }
 
+    private String replaceMacros(Site site, String siteNetworkId) {
+        final String domain = Optional.ofNullable(site)
+                .map(s -> Optional.ofNullable(s.getPublisher()).map(Publisher::getDomain).orElse(s.getDomain()))
+                .orElse(null);
+
+        return resolveEndpoint(domain, siteNetworkId);
+    }
+
+    private String resolveEndpoint(String domain, String networkId) {
+        if (networkId == null) {
+            return endpointUrl;
+        }
+
+        final String uri = endpointUrl.replace(NETWORK_ID_MACRO, HttpUtil.encodeUrl(networkId));
+
+        if (domain == null) {
+            return uri;
+        }
+
+        return uri.replace(DOMAIN_MACRO, HttpUtil.encodeUrl(domain));
+    }
+
     @Override
     public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
         try {

src/main/resources/bidder-config/sparteo.yaml

@@ -1,6 +1,6 @@
 adapters:
   sparteo:
-    endpoint: https://bid.sparteo.com/s2s-auction
+    endpoint: https://bid.sparteo.com/s2s-auction?network_id={{NetworkId}}&domain={{Domain}}
     meta-info: 
       maintainer-email: prebid@sparteo.com
       app-media-types:

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

@@ -39,7 +39,7 @@
 
 public class SparteoBidderTest extends VertxTest {
 
-    private static final String ENDPOINT_URL = "https://test.sparteo.com/endpoint";
+    private static final String ENDPOINT_URL = "https://test.sparteo.com/endpoint?network_id={{NetworkId}}&domain={{Domain}}";
     private final SparteoBidder sparteoBidder = new SparteoBidder(ENDPOINT_URL, jacksonMapper);
 
     @Test
@@ -121,7 +121,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, "https://test.sparteo.com/endpoint?network_id=testNetworkId&domain={{Domain}}"));
 
         assertThat(result.getValue())
                 .extracting(HttpRequest::getPayload)
@@ -857,6 +857,55 @@ 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();
+
+        assertThat(uri).isEqualTo("https://test.sparteo.com/endpoint?network_id=testNetworkId&domain=dev.sparteo.com");
+    }
+
+    @Test
+    public void makeHttpRequestsShouldUseSiteDomainWhenPublisherDomainIsMissing() {
+        // given
+        final ObjectNode impExt = mapper.createObjectNode();
+        impExt.set("bidder", mapper.createObjectNode()
+                .put("networkId", "testNetworkId"));
+
+        final BidRequest bidRequest = givenBidRequest(
+                request -> request.site(Site.builder()
+                        .domain("dev.sparteo.com")
+                        .publisher(Publisher.builder().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)
+                .extracting(HttpRequest::getUri)
+                .containsExactly("https://test.sparteo.com/endpoint?network_id=testNetworkId&domain=dev.sparteo.com");
+    }
+
     private BidRequest givenBidRequest(UnaryOperator<BidRequest.BidRequestBuilder> customizer, Imp... imps) {
         return customizer.apply(BidRequest.builder().imp(asList(imps))).build();
     }

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