diff --git a/.github/workflows/scripts/codepath-notification b/.github/workflows/scripts/codepath-notification index 371c86fc652..7884219ef5b 100644 --- a/.github/workflows/scripts/codepath-notification +++ b/.github/workflows/scripts/codepath-notification @@ -24,3 +24,4 @@ medianet|Medianet: prebid@media.net thetradedesk|TheTradeDesk: Prebid-Maintainers@thetradedesk.com gumgum|GumGum: prebid@gumgum.com kargo|Kargo: kraken@kargo.com +bidwave|Bidwave: prebid@bidwave.net diff --git a/src/main/java/org/prebid/server/bidder/bidwave/BidwaveBidder.java b/src/main/java/org/prebid/server/bidder/bidwave/BidwaveBidder.java new file mode 100644 index 00000000000..49d94bc632c --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/bidwave/BidwaveBidder.java @@ -0,0 +1,237 @@ +package org.prebid.server.bidder.bidwave; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.node.ObjectNode; +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 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.Price; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.currency.CurrencyConversionService; +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.ExtRequest; +import org.prebid.server.proto.openrtb.ext.request.bidwave.ExtImpBidwave; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.function.Function; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +public class BidwaveBidder implements Bidder { + + private static final String BIDWAVE_EXT = "bidwave"; + private static final String PUBLISHER_ID_EXT = "pid"; + private static final String BIDDER_CURRENCY = "USD"; + private static final List DEFAULT_CURRENCY = List.of(BIDDER_CURRENCY); + private static final Pattern UUID_PATTERN = Pattern.compile( + "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", + Pattern.CASE_INSENSITIVE); + private static final TypeReference> BIDWAVE_EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private final String endpointUrl; + private final CurrencyConversionService currencyConversionService; + private final JacksonMapper mapper; + + public BidwaveBidder(String endpointUrl, + CurrencyConversionService currencyConversionService, + JacksonMapper mapper) { + + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.currencyConversionService = Objects.requireNonNull(currencyConversionService); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest bidRequest) { + final List errors = new ArrayList<>(); + final Map> impsByPublisherId = new LinkedHashMap<>(); + + for (Imp imp : bidRequest.getImp()) { + try { + final String publisherId = parsePublisherId(imp); + final Imp modifiedImp = modifyImpCurrency(imp, bidRequest); + impsByPublisherId.computeIfAbsent(publisherId, ignored -> new ArrayList<>()).add(modifiedImp); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + final List> requests = impsByPublisherId.entrySet().stream() + .map(entry -> BidderUtil.defaultRequest( + createRequest(bidRequest, entry.getValue(), entry.getKey()), endpointUrl, mapper)) + .toList(); + + return Result.of(requests, errors); + } + + private String parsePublisherId(Imp imp) { + final ExtImpBidwave extImpBidwave; + try { + extImpBidwave = mapper.mapper().convertValue(imp.getExt(), BIDWAVE_EXT_TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException("Invalid imp.ext for impression %s. Error Information: %s" + .formatted(imp.getId(), e.getMessage())); + } + + final String publisherId = extImpBidwave != null ? extImpBidwave.getPublisherId() : null; + if (publisherId == null || !UUID_PATTERN.matcher(publisherId).matches()) { + throw new PreBidException("Invalid publisherId for impression %s".formatted(imp.getId())); + } + + return publisherId; + } + + private Imp modifyImpCurrency(Imp imp, BidRequest bidRequest) { + final Price initialBidFloorPrice = Price.of(imp.getBidfloorcur(), imp.getBidfloor()); + if (!BidderUtil.shouldConvertBidFloor(initialBidFloorPrice, BIDDER_CURRENCY)) { + return imp; + } + + try { + final BigDecimal convertedBidFloor = currencyConversionService.convertCurrency( + initialBidFloorPrice.getValue(), + bidRequest, + initialBidFloorPrice.getCurrency(), + BIDDER_CURRENCY); + return imp.toBuilder() + .bidfloor(convertedBidFloor) + .bidfloorcur(BIDDER_CURRENCY) + .build(); + } catch (PreBidException e) { + throw new PreBidException( + "expected currency USD for bid floor; unable to convert from %s for imp `%s`" + .formatted(initialBidFloorPrice.getCurrency(), imp.getId())); + } + } + + private BidRequest createRequest(BidRequest bidRequest, List imps, String publisherId) { + return bidRequest.toBuilder() + .imp(imps) + .cur(DEFAULT_CURRENCY) + .ext(createRequestExt(bidRequest.getExt(), publisherId)) + .build(); + } + + private ExtRequest createRequestExt(ExtRequest requestExt, String publisherId) { + final ExtRequest updatedExt = ExtRequest.of(requestExt != null ? requestExt.getPrebid() : null); + if (requestExt != null) { + updatedExt.addProperties(requestExt.getProperties()); + } + + final ObjectNode bidwaveExt = mapper.mapper().createObjectNode().put(PUBLISHER_ID_EXT, publisherId); + updatedExt.addProperty(BIDWAVE_EXT, bidwaveExt); + return updatedExt; + } + + @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())); + } + + final List errors = new ArrayList<>(); + final List bids = extractBids(httpCall.getRequest().getPayload(), bidResponse, errors); + return Result.of(bids, errors); + } + + private static List extractBids(BidRequest bidRequest, BidResponse bidResponse, + List errors) { + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + + final Map impsById = bidRequest.getImp().stream() + .collect(Collectors.toMap(Imp::getId, Function.identity(), (first, second) -> first)); + final String currency = bidResponse.getCur(); + + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(Collection::stream) + .filter(Objects::nonNull) + .map(bid -> makeBidderBid(bid, impsById, currency, errors)) + .filter(Objects::nonNull) + .toList(); + } + + private static BidderBid makeBidderBid(Bid bid, Map impsById, String currency, + List errors) { + final BidType bidType; + try { + bidType = resolveBidType(bid, impsById); + } catch (PreBidException e) { + errors.add(BidderError.badServerResponse(e.getMessage())); + return null; + } + + return BidderBid.of(bid, bidType, currency); + } + + private static BidType resolveBidType(Bid bid, Map impsById) { + final Integer markupType = bid.getMtype(); + if (markupType == null) { + return resolveBidTypeFromImp(bid.getImpid(), impsById); + } + + return switch (markupType) { + case 1 -> BidType.banner; + case 2 -> BidType.video; + default -> throw new PreBidException("Unsupported mtype %d for imp %s" + .formatted(markupType, bid.getImpid())); + }; + } + + private static BidType resolveBidTypeFromImp(String impId, Map impsById) { + final Imp imp = impsById.get(impId); + if (imp == null) { + throw new PreBidException("Failed to find impression for ID: \"%s\"".formatted(impId)); + } + if (isMultiFormat(imp)) { + throw new PreBidException( + "Bid must have non-null mtype for multi format impression with ID: \"%s\"".formatted(impId)); + } + if (imp.getBanner() != null) { + return BidType.banner; + } + if (imp.getVideo() != null) { + return BidType.video; + } + throw new PreBidException("Could not determine bid type for impression with ID: \"%s\"".formatted(impId)); + } + + private static boolean isMultiFormat(Imp imp) { + int formatCount = 0; + formatCount += imp.getBanner() == null ? 0 : 1; + formatCount += imp.getVideo() == null ? 0 : 1; + formatCount += imp.getAudio() == null ? 0 : 1; + formatCount += imp.getXNative() == null ? 0 : 1; + return formatCount > 1; + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/bidwave/ExtImpBidwave.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/bidwave/ExtImpBidwave.java new file mode 100644 index 00000000000..83d38e74702 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/bidwave/ExtImpBidwave.java @@ -0,0 +1,11 @@ +package org.prebid.server.proto.openrtb.ext.request.bidwave; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpBidwave { + + @JsonProperty("publisherId") + String publisherId; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/BidwaveConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/BidwaveConfiguration.java new file mode 100644 index 00000000000..6f45d743ccd --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/BidwaveConfiguration.java @@ -0,0 +1,43 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.bidwave.BidwaveBidder; +import org.prebid.server.currency.CurrencyConversionService; +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/bidwave.yaml", factory = YamlPropertySourceFactory.class) +public class BidwaveConfiguration { + + private static final String BIDDER_NAME = "bidwave"; + + @Bean("bidwaveConfigurationProperties") + @ConfigurationProperties("adapters.bidwave") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps bidwaveBidderDeps(BidderConfigurationProperties bidwaveConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + CurrencyConversionService currencyConversionService, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(bidwaveConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new BidwaveBidder(config.getEndpoint(), currencyConversionService, mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/bidwave.yaml b/src/main/resources/bidder-config/bidwave.yaml new file mode 100644 index 00000000000..65bd02fb891 --- /dev/null +++ b/src/main/resources/bidder-config/bidwave.yaml @@ -0,0 +1,14 @@ +adapters: + bidwave: + endpoint: https://rtb.bidwave.net/rtb/v1/bid + ortb-version: "2.6" + meta-info: + maintainer-email: prebid@bidwave.net + app-media-types: + - banner + - video + site-media-types: + - banner + - video + supported-vendors: + vendor-id: 0 diff --git a/src/main/resources/static/bidder-params/bidwave.json b/src/main/resources/static/bidder-params/bidwave.json new file mode 100644 index 00000000000..d7edfaed1ad --- /dev/null +++ b/src/main/resources/static/bidder-params/bidwave.json @@ -0,0 +1,16 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "BidWave Adapter Params", + "description": "A schema which validates params accepted by the BidWave adapter", + "type": "object", + "properties": { + "publisherId": { + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", + "description": "Publisher ID" + } + }, + "required": [ + "publisherId" + ] +} diff --git a/src/test/java/org/prebid/server/bidder/bidwave/BidwaveBidderTest.java b/src/test/java/org/prebid/server/bidder/bidwave/BidwaveBidderTest.java new file mode 100644 index 00000000000..5e26dbe958e --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/bidwave/BidwaveBidderTest.java @@ -0,0 +1,349 @@ +package org.prebid.server.bidder.bidwave; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Device; +import com.iab.openrtb.request.Format; +import com.iab.openrtb.request.Geo; +import com.iab.openrtb.request.Imp; +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.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +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.currency.CurrencyConversionService; +import org.prebid.server.exception.PreBidException; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.bidwave.ExtImpBidwave; + +import java.io.IOException; +import java.math.BigDecimal; +import java.util.List; + +import static java.util.Collections.singletonList; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.assertj.core.api.BDDAssertions.tuple; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.BDDMockito.given; +import static org.prebid.server.proto.openrtb.ext.response.BidType.banner; +import static org.prebid.server.proto.openrtb.ext.response.BidType.video; + +@ExtendWith(MockitoExtension.class) +public class BidwaveBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://rtb.bidwave.net/rtb/v1/bid"; + private static final String PUBLISHER_ID = "11111111-1111-4111-8111-111111111111"; + private static final String OTHER_PUBLISHER_ID = "22222222-2222-4222-8222-222222222222"; + + @Mock + private CurrencyConversionService currencyConversionService; + + private BidwaveBidder target; + + @BeforeEach + public void setUp() { + target = new BidwaveBidder(ENDPOINT_URL, currencyConversionService, jacksonMapper); + } + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException() + .isThrownBy(() -> new BidwaveBidder("invalid_url", currencyConversionService, jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldSetBidwaveExtDefaultCurrencyAndPreserveDeviceGeo() + throws IOException { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp-1").banner(givenBanner()).ext(givenImpExt(PUBLISHER_ID)))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + + final HttpRequest httpRequest = result.getValue().getFirst(); + final BidRequest payload = httpRequest.getPayload(); + + assertThat(httpRequest.getUri()).isEqualTo(ENDPOINT_URL); + assertThat(httpRequest.getImpIds()).containsOnly("imp-1"); + assertThat(mapper.readValue(httpRequest.getBody(), BidRequest.class)).isEqualTo(payload); + assertThat(payload.getCur()).containsExactly("USD"); + assertThat(payload.getExt().getProperty("bidwave").get("pid").asText()).isEqualTo(PUBLISHER_ID); + assertThat(payload.getDevice()).isEqualTo(bidRequest.getDevice()); + } + + @Test + public void makeHttpRequestsShouldGroupImpsByPublisherIdAndNormalizeCurrency() { + // given + final Imp firstImp = givenImp(imp -> imp.id("imp-1").banner(givenBanner()).ext(givenImpExt(PUBLISHER_ID))); + final Imp secondImp = givenImp(imp -> imp.id("imp-2").video(givenVideo()).ext(givenImpExt(OTHER_PUBLISHER_ID))); + final Imp thirdImp = givenImp(imp -> imp.id("imp-3").banner(givenBanner()).ext(givenImpExt(PUBLISHER_ID))); + final BidRequest bidRequest = givenBidRequest(firstImp, secondImp, thirdImp) + .toBuilder() + .cur(List.of("EUR")) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(2); + assertThat(result.getValue().get(0).getPayload().getImp()).containsExactly(firstImp, thirdImp); + assertThat(result.getValue().get(0).getPayload().getExt().getProperty("bidwave").get("pid").asText()) + .isEqualTo(PUBLISHER_ID); + assertThat(result.getValue().get(0).getPayload().getCur()).containsExactly("USD"); + assertThat(result.getValue().get(1).getPayload().getImp()).containsExactly(secondImp); + assertThat(result.getValue().get(1).getPayload().getExt().getProperty("bidwave").get("pid").asText()) + .isEqualTo(OTHER_PUBLISHER_ID); + assertThat(result.getValue().get(1).getPayload().getCur()).containsExactly("USD"); + } + + @Test + public void makeHttpRequestsShouldConvertBidFloorCurrency() { + // given + given(currencyConversionService.convertCurrency(any(), any(), anyString(), anyString())) + .willReturn(BigDecimal.TEN); + + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .id("imp-1") + .banner(givenBanner()) + .bidfloor(BigDecimal.ONE) + .bidfloorcur("EUR") + .ext(givenImpExt(PUBLISHER_ID)))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getBidfloor, Imp::getBidfloorcur) + .containsExactly(tuple(BigDecimal.TEN, "USD")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenBidFloorCurrencyCannotBeConverted() { + // given + given(currencyConversionService.convertCurrency(any(), any(), anyString(), anyString())) + .willThrow(new PreBidException("missing conversion rate")); + + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .id("imp-1") + .banner(givenBanner()) + .bidfloor(BigDecimal.ONE) + .bidfloorcur("EUR") + .ext(givenImpExt(PUBLISHER_ID)))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly(BidderError.badInput( + "expected currency USD for bid floor; unable to convert from EUR for imp `imp-1`")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorForInvalidPublisherId() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp-1").banner(givenBanner()).ext(givenImpExt("publisher-1")))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly( + BidderError.badInput("Invalid publisherId for impression imp-1")); + } + + @Test + public void makeBidsShouldReturnBannerAndVideoBids() throws JsonProcessingException { + // given + final Bid bannerBid = Bid.builder().impid("imp-1").mtype(1).build(); + final Bid videoBid = Bid.builder().impid("imp-2").mtype(2).build(); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp-1").banner(givenBanner()).ext(givenImpExt(PUBLISHER_ID))), + givenImp(imp -> imp.id("imp-2").video(givenVideo()).ext(givenImpExt(PUBLISHER_ID)))); + final BidderCall httpCall = sampleHttpCall( + bidRequest, + mapper.writeValueAsString(givenBidResponse(bannerBid, videoBid))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly( + BidderBid.of(bannerBid, banner, "USD"), + BidderBid.of(videoBid, video, "USD")); + } + + @Test + public void makeBidsShouldInferBidTypeFromImpWhenMtypeIsAbsent() throws JsonProcessingException { + // given + final Bid bid = Bid.builder().impid("imp-1").build(); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp-1").video(givenVideo()).ext(givenImpExt(PUBLISHER_ID)))); + final BidderCall httpCall = sampleHttpCall( + bidRequest, + mapper.writeValueAsString(givenBidResponse(bid))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(BidderBid.of(bid, video, "USD")); + } + + @Test + public void makeBidsShouldReturnErrorWhenMtypeIsAbsentForMultiFormatImp() throws JsonProcessingException { + // given + final Bid bid = Bid.builder().impid("imp-1").build(); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .id("imp-1") + .banner(givenBanner()) + .video(givenVideo()) + .ext(givenImpExt(PUBLISHER_ID)))); + final BidderCall httpCall = sampleHttpCall( + bidRequest, + mapper.writeValueAsString(givenBidResponse(bid))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly( + BidderError.badServerResponse( + "Bid must have non-null mtype for multi format impression with ID: \"imp-1\"")); + } + + @Test + public void makeBidsShouldReturnErrorWhenMtypeIsAbsentForUnknownImp() throws JsonProcessingException { + // given + final Bid bid = Bid.builder().impid("imp-2").build(); + final BidderCall httpCall = sampleHttpCall( + givenBidRequest(givenImp(imp -> imp.id("imp-1").banner(givenBanner()).ext(givenImpExt(PUBLISHER_ID)))), + mapper.writeValueAsString(givenBidResponse(bid))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly( + BidderError.badServerResponse("Failed to find impression for ID: \"imp-2\"")); + } + + @Test + public void makeBidsShouldReturnErrorIfMtypeIsUnsupported() throws JsonProcessingException { + // given + final Bid bid = Bid.builder().impid("imp-1").mtype(3).build(); + final BidderCall httpCall = sampleHttpCall( + givenBidRequest(givenImp(imp -> imp.id("imp-1").banner(givenBanner()).ext(givenImpExt(PUBLISHER_ID)))), + mapper.writeValueAsString(givenBidResponse(bid))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly( + BidderError.badServerResponse("Unsupported mtype 3 for imp imp-1")); + } + + @Test + public void makeBidsShouldReturnErrorIfResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = sampleHttpCall(givenBidRequest(), "invalid response"); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).hasSize(1) + .allMatch(error -> error.getType() == BidderError.Type.bad_server_response + && error.getMessage().startsWith("Failed to decode: Unrecognized token")); + } + + private static BidRequest givenBidRequest(Imp... imps) { + return BidRequest.builder() + .id("request-id") + .site(Site.builder().domain("publisher.example.com").build()) + .device(Device.builder() + .ip("203.0.113.42") + .geo(Geo.builder().country("USA").region("CA").city("San Francisco").build()) + .build()) + .imp(List.of(imps)) + .build(); + } + + private static BidRequest givenBidRequest() { + return givenBidRequest(givenImp(imp -> imp.id("imp-1").banner(givenBanner()).ext(givenImpExt(PUBLISHER_ID)))); + } + + private static Imp givenImp(java.util.function.Function impCustomizer) { + return impCustomizer.apply(Imp.builder()).build(); + } + + private static Banner givenBanner() { + return Banner.builder() + .format(singletonList(Format.builder().w(300).h(250).build())) + .build(); + } + + private static Video givenVideo() { + return Video.builder() + .mimes(singletonList("video/mp4")) + .protocols(List.of(2, 3)) + .w(640) + .h(360) + .build(); + } + + private static com.fasterxml.jackson.databind.node.ObjectNode givenImpExt(String publisherId) { + return mapper.valueToTree(ExtPrebid.of(null, ExtImpBidwave.of(publisherId))); + } + + private static BidResponse givenBidResponse(Bid... bids) { + return BidResponse.builder() + .cur("USD") + .seatbid(singletonList(SeatBid.builder().bid(List.of(bids)).build())) + .build(); + } + + private static BidderCall sampleHttpCall(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/BidwaveTest.java b/src/test/java/org/prebid/server/it/BidwaveTest.java new file mode 100644 index 00000000000..3ad87828e83 --- /dev/null +++ b/src/test/java/org/prebid/server/it/BidwaveTest.java @@ -0,0 +1,32 @@ +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.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 BidwaveTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromBidwave() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/bidwave-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/bidwave/test-bidwave-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/bidwave/test-bidwave-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/bidwave/test-auction-bidwave-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/bidwave/test-auction-bidwave-response.json", response, singletonList("bidwave")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-auction-bidwave-request.json b/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-auction-bidwave-request.json new file mode 100644 index 00000000000..26df715cbd5 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-auction-bidwave-request.json @@ -0,0 +1,23 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "bidwave": { + "publisherId": "11111111-1111-4111-8111-111111111111" + } + } + } + ], + "tmax": 5000, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-auction-bidwave-response.json b/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-auction-bidwave-response.json new file mode 100644 index 00000000000..59c661d9251 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-auction-bidwave-response.json @@ -0,0 +1,44 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "exp": 300, + "price": 3.33, + "adm": "adm001", + "adid": "adid001", + "cid": "cid001", + "crid": "crid001", + "mtype": 1, + "w": 300, + "h": 250, + "ext": { + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "bidwave" + } + }, + "origbidcpm": 3.33, + "origbidcur": "USD" + } + } + ], + "seat": "bidwave", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "bidwave": "{{ bidwave.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-bidwave-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-bidwave-bid-request.json new file mode 100644 index 00000000000..0ad03d79814 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-bidwave-bid-request.json @@ -0,0 +1,57 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "secure": 1, + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "tid": "${json-unit.any-string}", + "bidder": { + "publisherId": "11111111-1111-4111-8111-111111111111" + } + } + } + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "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" + } + }, + "bidwave": { + "pid": "11111111-1111-4111-8111-111111111111" + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-bidwave-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-bidwave-bid-response.json new file mode 100644 index 00000000000..6df6c15a57d --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/bidwave/test-bidwave-bid-response.json @@ -0,0 +1,22 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "adid": "adid001", + "crid": "crid001", + "cid": "cid001", + "adm": "adm001", + "mtype": 1, + "h": 250, + "w": 300 + } + ] + } + ], + "cur": "USD" +} 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..8e3ef17427a 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -171,6 +171,8 @@ adapters.bidstack.enabled=true adapters.bidstack.endpoint=http://localhost:8090/bidstack-exchange adapters.bidtheatre.enabled=true adapters.bidtheatre.endpoint=http://localhost:8090/bidtheatre-exchange +adapters.bidwave.enabled=true +adapters.bidwave.endpoint=http://localhost:8090/bidwave-exchange adapters.bigoad.enabled=true adapters.bigoad.endpoint=http://localhost:8090/bigoad-exchange adapters.blasto.enabled=true