diff --git a/src/main/java/org/prebid/server/bidder/floxis/FloxisBidder.java b/src/main/java/org/prebid/server/bidder/floxis/FloxisBidder.java new file mode 100644 index 00000000000..79bf48dc8d1 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/floxis/FloxisBidder.java @@ -0,0 +1,212 @@ +package org.prebid.server.bidder.floxis; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import io.vertx.core.http.HttpMethod; +import org.apache.commons.collections4.CollectionUtils; +import org.prebid.server.bidder.Bidder; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.exception.PreBidException; +import org.prebid.server.json.DecodeException; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.floxis.ExtImpFloxis; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.regex.Pattern; + +public class FloxisBidder implements Bidder { + + private static final TypeReference> FLOXIS_EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private static final String HOST_MACRO = "{{Host}}"; + private static final String SEAT_MACRO = "{{SeatId}}"; + + private static final String DEFAULT_REGION = "us-e"; + private static final String DEFAULT_PARTNER = "floxis"; + + // region/partner are interpolated into the request host, so each must be a valid DNS label — + // otherwise a value carrying URL delimiters could rewrite the request origin. + private static final Pattern HOST_LABEL = Pattern.compile("^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$"); + + private final String endpointUrl; + private final JacksonMapper mapper; + + public FloxisBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + if (CollectionUtils.isEmpty(request.getImp())) { + return Result.withError(BidderError.badInput("no impressions in the bid request")); + } + + final String uri; + try { + uri = resolveUrl(endpointUrl, resolveCommonImpExt(request.getImp())); + } catch (PreBidException e) { + return Result.withError(BidderError.badInput(e.getMessage())); + } + + // The request body is forwarded unchanged; no caller-owned struct is mutated. + return Result.withValue(HttpRequest.builder() + .method(HttpMethod.POST) + .uri(uri) + .headers(HttpUtil.headers()) + .impIds(BidderUtil.impIds(request)) + .payload(request) + .body(mapper.encodeToBytes(request)) + .build()); + } + + // A single request routes to one Floxis host/seat (the seat is the URL query key, partner+region + // the host). All imps must therefore share the same seat, region and partner; a mismatch is a + // misconfigured request rather than something to silently route on imp[0]'s key. + private ExtImpFloxis resolveCommonImpExt(List imps) { + final ExtImpFloxis first = parseImpExt(imps.getFirst()); + for (Imp imp : imps.subList(1, imps.size())) { + final ExtImpFloxis current = parseImpExt(imp); + if (!Objects.equals(current.getSeat(), first.getSeat()) + || !Objects.equals(current.getRegion(), first.getRegion()) + || !Objects.equals(current.getPartner(), first.getPartner())) { + throw new PreBidException( + "all impressions must target the same Floxis seat, region and partner; " + + "imp %s differs from imp %s" + .formatted(imp.getId(), imps.getFirst().getId())); + } + } + return first; + } + + private ExtImpFloxis parseImpExt(Imp imp) { + try { + return mapper.mapper().convertValue(imp.getExt(), FLOXIS_EXT_TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException("invalid imp.ext.bidder for imp %s: %s".formatted(imp.getId(), e.getMessage())); + } + } + + // Bidding host: the supply partner's regional subdomain (floxis itself has no partner prefix). + private static String resolveBidHost(String region, String partner) { + final String resolvedRegion = isBlank(region) ? DEFAULT_REGION : region; + final String resolvedPartner = isBlank(partner) ? DEFAULT_PARTNER : partner; + if (!HOST_LABEL.matcher(resolvedRegion).matches() || !HOST_LABEL.matcher(resolvedPartner).matches()) { + throw new PreBidException( + "invalid Floxis region or partner; both must be DNS labels: region=%s partner=%s" + .formatted(resolvedRegion, resolvedPartner)); + } + return resolvedPartner.equals(DEFAULT_PARTNER) + ? resolvedRegion + ".floxis.tech" + : resolvedPartner + "-" + resolvedRegion + ".floxis.tech"; + } + + private static boolean isBlank(String value) { + return value == null || value.isEmpty(); + } + + private static String resolveUrl(String endpoint, ExtImpFloxis extImp) { + return endpoint + .replace(HOST_MACRO, resolveBidHost(extImp.getRegion(), extImp.getPartner())) + .replace(SEAT_MACRO, HttpUtil.encodeUrl(extImp.getSeat())); + } + + @Override + public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + final BidResponse bidResponse; + try { + bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Result.empty(); + } + + final List errors = new ArrayList<>(); + final List bids = new ArrayList<>(); + for (SeatBid seatBid : bidResponse.getSeatbid()) { + if (seatBid == null || CollectionUtils.isEmpty(seatBid.getBid())) { + continue; + } + for (Bid bid : seatBid.getBid()) { + try { + bids.add(BidderBid.of(bid, getMediaTypeForBid(bidRequest.getImp(), bid), bidResponse.getCur())); + } catch (PreBidException e) { + errors.add(BidderError.badServerResponse(e.getMessage())); + } + } + } + + return Result.of(bids, errors); + } + + // Resolves the bid's media type. When bid.mtype (OpenRTB 2.6) is set it is treated as + // authoritative. When unset, a single-format imp's media type is used; multi-format imps + // without mtype cannot be disambiguated and surface an error. + private static BidType getMediaTypeForBid(List imps, Bid bid) { + final Integer mtype = bid.getMtype(); + if (mtype != null && mtype != 0) { + return switch (mtype) { + case 1 -> BidType.banner; + case 2 -> BidType.video; + case 3 -> BidType.audio; + case 4 -> BidType.xNative; + default -> throw new PreBidException( + "unsupported bid.mtype %d for impression %s".formatted(mtype, bid.getImpid())); + }; + } + + for (Imp imp : imps) { + if (!Objects.equals(imp.getId(), bid.getImpid())) { + continue; + } + int formats = 0; + BidType resolved = null; + if (imp.getBanner() != null) { + formats++; + resolved = BidType.banner; + } + if (imp.getVideo() != null) { + formats++; + resolved = BidType.video; + } + if (imp.getAudio() != null) { + formats++; + resolved = BidType.audio; + } + if (imp.getXNative() != null) { + formats++; + resolved = BidType.xNative; + } + if (formats == 1) { + return resolved; + } else if (formats > 1) { + throw new PreBidException( + "bid for multi-format imp %s requires bid.mtype to disambiguate".formatted(bid.getImpid())); + } else { + throw new PreBidException( + "unable to resolve media type for impression %s".formatted(bid.getImpid())); + } + } + + throw new PreBidException("unable to find impression %s for bid".formatted(bid.getImpid())); + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/floxis/ExtImpFloxis.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/floxis/ExtImpFloxis.java new file mode 100644 index 00000000000..ff34a22b00a --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/floxis/ExtImpFloxis.java @@ -0,0 +1,16 @@ +package org.prebid.server.proto.openrtb.ext.request.floxis; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpFloxis { + + String seat; + + @JsonProperty("region") + String region; + + @JsonProperty("partner") + String partner; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/FloxisConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/FloxisConfiguration.java new file mode 100644 index 00000000000..7e0eff122bb --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/FloxisConfiguration.java @@ -0,0 +1,43 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.floxis.FloxisBidder; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.spring.config.bidder.model.BidderConfigurationProperties; +import org.prebid.server.spring.config.bidder.util.BidderDepsAssembler; +import org.prebid.server.spring.config.bidder.util.UsersyncerCreator; +import org.prebid.server.spring.env.YamlPropertySourceFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.PropertySource; + +import jakarta.validation.constraints.NotBlank; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/floxis.yaml", + factory = YamlPropertySourceFactory.class) +public class FloxisConfiguration { + + private static final String BIDDER_NAME = "floxis"; + + @Bean("floxisConfigurationProperties") + @ConfigurationProperties("adapters.floxis") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps floxisBidderDeps(BidderConfigurationProperties floxisConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(floxisConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new FloxisBidder(config.getEndpoint(), mapper)) + .assemble(); + } + +} diff --git a/src/main/resources/bidder-config/floxis.yaml b/src/main/resources/bidder-config/floxis.yaml new file mode 100644 index 00000000000..49d5de6f3b5 --- /dev/null +++ b/src/main/resources/bidder-config/floxis.yaml @@ -0,0 +1,25 @@ +adapters: + floxis: + endpoint: https://{{Host}}/pbs?seat={{SeatId}} + ortb-version: "2.6" + modifying-vast-xml-allowed: false + meta-info: + maintainer-email: prebid@floxis.tech + app-media-types: + - banner + - video + - native + - audio + site-media-types: + - banner + - video + - native + - audio + supported-vendors: + vendor-id: 1609 + usersync: + cookie-family-name: floxis + redirect: + url: "https://px-us-e.floxis.tech/sync?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&gpp={{gpp}}&gpp_sid={{gpp_sid}}&us_privacy={{us_privacy}}&dest={{redirect_url}}" + support-cors: false + uid-macro: "${USER_ID}" diff --git a/src/main/resources/static/bidder-params/floxis.json b/src/main/resources/static/bidder-params/floxis.json new file mode 100644 index 00000000000..621f3239533 --- /dev/null +++ b/src/main/resources/static/bidder-params/floxis.json @@ -0,0 +1,25 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Floxis Adapter Params", + "description": "A schema which validates params accepted by the Floxis adapter", + "type": "object", + "additionalProperties": false, + "properties": { + "seat": { + "type": "string", + "minLength": 1, + "description": "The Floxis seat ID this publisher buys through" + }, + "region": { + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$", + "description": "The Floxis region (DNS label, interpolated into the bidding host); defaults to us-e when omitted" + }, + "partner": { + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$", + "description": "The white-label partner (DNS label, interpolated into the bidding host); defaults to floxis when omitted" + } + }, + "required": ["seat"] +} diff --git a/src/test/java/org/prebid/server/bidder/floxis/FloxisBidderTest.java b/src/test/java/org/prebid/server/bidder/floxis/FloxisBidderTest.java new file mode 100644 index 00000000000..a2f29c8bbf4 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/floxis/FloxisBidderTest.java @@ -0,0 +1,537 @@ +package org.prebid.server.bidder.floxis; + +import com.iab.openrtb.request.Audio; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Format; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Native; +import com.iab.openrtb.request.Site; +import com.iab.openrtb.request.Video; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.junit.jupiter.api.Test; +import org.prebid.server.VertxTest; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.HttpResponse; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.floxis.ExtImpFloxis; +import org.prebid.server.proto.openrtb.ext.response.BidType; + +import java.util.List; +import java.util.function.UnaryOperator; + +import static java.util.Arrays.asList; +import static java.util.Collections.singletonList; +import static java.util.function.UnaryOperator.identity; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.assertj.core.api.Assertions.tuple; + +public class FloxisBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://{{Host}}/pbs?seat={{SeatId}}"; + + private final FloxisBidder target = new FloxisBidder(ENDPOINT_URL, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException() + .isThrownBy(() -> new FloxisBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenNoImpressions() { + // given + final BidRequest bidRequest = BidRequest.builder().id("req-1").imp(null).build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badInput("no impressions in the bid request")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenImpExtCouldNotBeParsed() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp + .id("imp-1") + .ext(mapper.valueToTree(ExtPrebid.of(null, mapper.createArrayNode())))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + assertThat(error.getMessage()).startsWith("invalid imp.ext.bidder for imp imp-1:"); + }); + } + + @Test + public void makeHttpRequestsShouldUrlEscapeSeatAndUseEuHost() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("a b&c", "eu"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://eu.floxis.tech/pbs?seat=a+b%26c"); + } + + @Test + public void makeHttpRequestsShouldUseApacHost() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("seat-apac", "apac"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://apac.floxis.tech/pbs?seat=seat-apac"); + } + + @Test + public void makeHttpRequestsShouldUseUseHostForExplicitUsE() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("abc", "us-e"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://us-e.floxis.tech/pbs?seat=abc"); + } + + @Test + public void makeHttpRequestsShouldDefaultToUseHostWhenRegionMissing() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("abc", null))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://us-e.floxis.tech/pbs?seat=abc"); + } + + @Test + public void makeHttpRequestsShouldUseArbitraryValidRegionLabelAsSubdomain() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("abc", "mars"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://mars.floxis.tech/pbs?seat=abc"); + } + + @Test + public void makeHttpRequestsShouldReturnBadInputWhenRegionIsNotAValidHostLabel() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("abc", "evil.com/x?"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input)); + } + + @Test + public void makeHttpRequestsShouldUsePartnerPrefixedHostWhenPartnerProvided() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("abc", "us-e", "acme"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://acme-us-e.floxis.tech/pbs?seat=abc"); + } + + @Test + public void makeHttpRequestsShouldReturnBadInputWhenPartnerIsNotAValidHostLabel() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("abc", "us-e", "evil.com/x?"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input)); + } + + @Test + public void makeHttpRequestsShouldRouteOnceAndForwardAllImpsWhenSeatAndRegionMatch() { + // given + final BidRequest bidRequest = BidRequest.builder() + .id("req-1") + .imp(asList( + givenImp(imp -> imp.id("imp-1").ext(givenImpExt("seat-eu", "eu"))), + givenImp(imp -> imp.id("imp-2").ext(givenImpExt("seat-eu", "eu"))))) + .site(Site.builder().id("271").build()) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://eu.floxis.tech/pbs?seat=seat-eu"); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getId) + .containsExactly("imp-1", "imp-2"); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenImpsTargetDifferentSeat() { + // given + final BidRequest bidRequest = BidRequest.builder() + .id("req-1") + .imp(asList( + givenImp(imp -> imp.id("imp-1").ext(givenImpExt("seat-eu", "eu"))), + givenImp(imp -> imp.id("imp-2").ext(givenImpExt("seat-other", "eu"))))) + .site(Site.builder().id("271").build()) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badInput( + "all impressions must target the same Floxis seat, region and partner; " + + "imp imp-2 differs from imp imp-1")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenImpsTargetDifferentRegion() { + // given + final BidRequest bidRequest = BidRequest.builder() + .id("req-1") + .imp(asList( + givenImp(imp -> imp.id("imp-1").ext(givenImpExt("seat-eu", "eu"))), + givenImp(imp -> imp.id("imp-2").ext(givenImpExt("seat-eu", "apac"))))) + .site(Site.builder().id("271").build()) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badInput( + "all impressions must target the same Floxis seat, region and partner; " + + "imp imp-2 differs from imp imp-1")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenImpsTargetDifferentPartner() { + // given + final BidRequest bidRequest = BidRequest.builder() + .id("req-1") + .imp(asList( + givenImp(imp -> imp.id("imp-1").ext(givenImpExt("seat-eu", "eu", "acme"))), + givenImp(imp -> imp.id("imp-2").ext(givenImpExt("seat-eu", "eu", "other"))))) + .site(Site.builder().id("271").build()) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badInput( + "all impressions must target the same Floxis seat, region and partner; " + + "imp imp-2 differs from imp imp-1")); + } + + @Test + public void makeHttpRequestsShouldForwardRequestBodyUnchanged() { + // given + final BidRequest bidRequest = givenBidRequest(imp -> imp.ext(givenImpExt("abc", "eu"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .containsExactly(bidRequest); + } + + @Test + public void makeBidsShouldReturnErrorWhenResponseBodyCannotBeParsed() { + // given + final BidderCall httpCall = givenHttpCall(givenBidRequest(identity()), "invalid"); + + // when + final Result> result = target.makeBids(httpCall, BidRequest.builder().build()); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response)); + } + + @Test + public void makeBidsShouldReturnEmptyWhenResponseHasNoSeatBid() throws Exception { + // given + final BidderCall httpCall = givenHttpCall(givenBidRequest(identity()), + mapper.writeValueAsString(BidResponse.builder().build())); + + // when + final Result> result = target.makeBids(httpCall, BidRequest.builder().build()); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).isEmpty(); + } + + @Test + public void makeBidsShouldSkipNullSeatBidAndEmptyBids() throws Exception { + // given + final BidResponse bidResponse = BidResponse.builder() + .cur("USD") + .seatbid(asList( + null, + SeatBid.builder().bid(null).build(), + SeatBid.builder() + .bid(singletonList(Bid.builder().impid("imp-1").mtype(1).build())) + .build())) + .build(); + final BidderCall httpCall = givenHttpCall(givenBidRequest(identity()), + mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, givenBidRequest(identity())); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(BidderBid::getType) + .containsExactly(BidType.banner); + } + + @Test + public void makeBidsShouldResolveBidTypeFromMTypeAndPassCurrency() throws Exception { + // given + final BidResponse bidResponse = BidResponse.builder() + .cur("EUR") + .seatbid(singletonList(SeatBid.builder() + .bid(asList( + Bid.builder().impid("imp-1").mtype(1).build(), + Bid.builder().impid("imp-1").mtype(2).build(), + Bid.builder().impid("imp-1").mtype(3).build(), + Bid.builder().impid("imp-1").mtype(4).build())) + .build())) + .build(); + final BidderCall httpCall = givenHttpCall(givenBidRequest(identity()), + mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, givenBidRequest(identity())); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType, BidderBid::getBidCurrency) + .containsExactly( + tuple(BidType.banner, "EUR"), + tuple(BidType.video, "EUR"), + tuple(BidType.audio, "EUR"), + tuple(BidType.xNative, "EUR")); + } + + @Test + public void makeBidsShouldReturnErrorWhenMTypeUnsupported() throws Exception { + // given + final BidResponse bidResponse = givenBidResponse(Bid.builder().impid("imp-1").mtype(7).build()); + final BidderCall httpCall = givenHttpCall(givenBidRequest(identity()), + mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, givenBidRequest(identity())); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badServerResponse( + "unsupported bid.mtype 7 for impression imp-1")); + } + + @Test + public void makeBidsShouldResolveBidTypeFromSingleFormatImpWhenMTypeAbsent() throws Exception { + // given + final BidRequest bidRequest = BidRequest.builder() + .imp(asList( + Imp.builder().id("b").banner(Banner.builder().build()).build(), + Imp.builder().id("v").video(Video.builder().build()).build(), + Imp.builder().id("a").audio(Audio.builder().build()).build(), + Imp.builder().id("n").xNative(Native.builder().build()).build())) + .build(); + final BidResponse bidResponse = BidResponse.builder() + .cur("USD") + .seatbid(singletonList(SeatBid.builder() + .bid(asList( + Bid.builder().impid("b").build(), + Bid.builder().impid("v").build(), + Bid.builder().impid("a").build(), + Bid.builder().impid("n").build())) + .build())) + .build(); + final BidderCall httpCall = givenHttpCall(bidRequest, mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType) + .containsExactly(BidType.banner, BidType.video, BidType.audio, BidType.xNative); + } + + @Test + public void makeBidsShouldReturnErrorForMultiFormatImpWithoutMType() throws Exception { + // given + final BidRequest bidRequest = BidRequest.builder() + .imp(singletonList(Imp.builder() + .id("imp-1") + .banner(Banner.builder().build()) + .video(Video.builder().build()) + .build())) + .build(); + final BidResponse bidResponse = givenBidResponse(Bid.builder().impid("imp-1").build()); + final BidderCall httpCall = givenHttpCall(bidRequest, mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badServerResponse( + "bid for multi-format imp imp-1 requires bid.mtype to disambiguate")); + } + + @Test + public void makeBidsShouldReturnErrorForImpWithoutFormatAndWithoutMType() throws Exception { + // given + final BidRequest bidRequest = BidRequest.builder() + .imp(singletonList(Imp.builder().id("imp-1").build())) + .build(); + final BidResponse bidResponse = givenBidResponse(Bid.builder().impid("imp-1").build()); + final BidderCall httpCall = givenHttpCall(bidRequest, mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badServerResponse( + "unable to resolve media type for impression imp-1")); + } + + @Test + public void makeBidsShouldReturnErrorWhenBidImpIdNotFound() throws Exception { + // given + final BidRequest bidRequest = BidRequest.builder() + .imp(singletonList(Imp.builder().id("imp-1").banner(Banner.builder().build()).build())) + .build(); + final BidResponse bidResponse = givenBidResponse(Bid.builder().impid("no-such-imp").build()); + final BidderCall httpCall = givenHttpCall(bidRequest, mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badServerResponse( + "unable to find impression no-such-imp for bid")); + } + + private static BidRequest givenBidRequest(UnaryOperator impCustomizer) { + return BidRequest.builder() + .id("req-1") + .imp(singletonList(givenImp(impCustomizer))) + .site(Site.builder().id("271").build()) + .build(); + } + + private static Imp givenImp(UnaryOperator impCustomizer) { + return impCustomizer.apply(Imp.builder() + .id("imp-1") + .banner(Banner.builder().format(singletonList(Format.builder().w(300).h(250).build())).build()) + .ext(givenImpExt("pub-seat-1", null))) + .build(); + } + + private static com.fasterxml.jackson.databind.node.ObjectNode givenImpExt(String seat, String region) { + return givenImpExt(seat, region, null); + } + + private static com.fasterxml.jackson.databind.node.ObjectNode givenImpExt(String seat, String region, + String partner) { + return mapper.valueToTree(ExtPrebid.of(null, ExtImpFloxis.of(seat, region, partner))); + } + + private static BidResponse givenBidResponse(Bid bid) { + return BidResponse.builder() + .cur("USD") + .seatbid(singletonList(SeatBid.builder().bid(singletonList(bid)).build())) + .build(); + } + + private static BidderCall givenHttpCall(BidRequest bidRequest, String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, body), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/FloxisTest.java b/src/test/java/org/prebid/server/it/FloxisTest.java new file mode 100644 index 00000000000..8a67859fe12 --- /dev/null +++ b/src/test/java/org/prebid/server/it/FloxisTest.java @@ -0,0 +1,34 @@ +package org.prebid.server.it; + +import io.restassured.response.Response; +import org.json.JSONException; +import org.junit.jupiter.api.Test; +import org.prebid.server.model.Endpoint; + +import java.io.IOException; + +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; +import static java.util.Collections.singletonList; + +public class FloxisTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromFloxis() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/floxis-exchange")) + .withQueryParam("seat", equalTo("pub-seat-1")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/floxis/test-floxis-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/floxis/test-floxis-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/floxis/test-auction-floxis-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/floxis/test-auction-floxis-response.json", response, singletonList("floxis")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-auction-floxis-request.json b/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-auction-floxis-request.json new file mode 100644 index 00000000000..4ce042710fa --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-auction-floxis-request.json @@ -0,0 +1,35 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "floxis": { + "seat": "pub-seat-1" + } + } + } + ], + "source": { + "schain": { + "complete": 1, + "ver": "1.0", + "nodes": [ + { + "asi": "floxis.tech", + "sid": "pub-seat-1", + "hp": 1 + } + ] + } + }, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-auction-floxis-response.json b/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-auction-floxis-response.json new file mode 100644 index 00000000000..07b4c9cb073 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-auction-floxis-response.json @@ -0,0 +1,44 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "adm": "adm001", + "adid": "adid001", + "cid": "cid001", + "crid": "crid001", + "w": 300, + "h": 250, + "exp": 300, + "mtype": 1, + "ext": { + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "floxis" + } + }, + "origbidcpm": 3.33, + "origbidcur": "USD" + } + } + ], + "seat": "floxis", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "floxis": "{{ floxis.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-floxis-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-floxis-bid-request.json new file mode 100644 index 00000000000..ec7ab98fbd5 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-floxis-bid-request.json @@ -0,0 +1,65 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "secure": 1, + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "tid": "${json-unit.any-string}", + "bidder": { + "seat": "pub-seat-1" + } + } + } + ], + "source": { + "tid": "${json-unit.any-string}", + "schain": { + "complete": 1, + "ver": "1.0", + "nodes": [ + { + "asi": "floxis.tech", + "sid": "pub-seat-1", + "hp": 1 + } + ] + } + }, + "site": { + "domain": "www.example.com", + "page": "http://www.example.com", + "publisher": { + "domain": "example.com" + }, + "ext": { + "amp": 0 + } + }, + "device": { + "ua": "userAgent", + "ip": "193.168.244.1" + }, + "at": 1, + "tmax": "${json-unit.any-number}", + "cur": [ + "USD" + ], + "regs": { + "gdpr": 0 + }, + "ext": { + "prebid": { + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "endpoint": "/openrtb2/auction" + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-floxis-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-floxis-bid-response.json new file mode 100644 index 00000000000..c9c23670bfa --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/floxis/test-floxis-bid-response.json @@ -0,0 +1,23 @@ +{ + "id": "request_id", + "cur": "USD", + "seatbid": [ + { + "seat": "floxis", + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "adid": "adid001", + "crid": "crid001", + "cid": "cid001", + "adm": "adm001", + "h": 250, + "w": 300, + "mtype": 1 + } + ] + } + ] +} diff --git a/src/test/resources/org/prebid/server/it/test-application.properties b/src/test/resources/org/prebid/server/it/test-application.properties index 1569de649f5..2f1ad6d9efc 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -261,6 +261,8 @@ adapters.flatads.enabled=true adapters.flatads.endpoint=http://localhost:8090/flatads-exchange adapters.flipp.enabled=true adapters.flipp.endpoint=http://localhost:8090/flipp-exchange +adapters.floxis.enabled=true +adapters.floxis.endpoint=http://localhost:8090/floxis-exchange?seat={{SeatId}} adapters.audiencenetwork.enabled=true adapters.audiencenetwork.endpoint=http://localhost:8090/audienceNetwork-exchange adapters.audiencenetwork.platform-id=101