diff --git a/src/main/java/org/prebid/server/bidder/adswag/AdswagBidder.java b/src/main/java/org/prebid/server/bidder/adswag/AdswagBidder.java new file mode 100644 index 00000000000..065e946d335 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/adswag/AdswagBidder.java @@ -0,0 +1,331 @@ +package org.prebid.server.bidder.adswag; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.App; +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.Publisher; +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.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.StringUtils; +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.adswag.ExtImpAdswag; +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.Collections; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.regex.Pattern; + +public class AdswagBidder implements Bidder { + + private static final TypeReference> TYPE_REFERENCE = new TypeReference<>() { + }; + + private static final String DEFAULT_CURRENCY = "EUR"; + private static final Pattern VAST_MARKUP = Pattern.compile("<\\s*VAST[\\s/>]", Pattern.CASE_INSENSITIVE); + + private final String endpointUrl; + private final JacksonMapper mapper; + + public AdswagBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + final Map> impsByPublisher = new LinkedHashMap<>(); + final List errors = new ArrayList<>(); + + for (Imp imp : request.getImp()) { + final ExtImpAdswag extImpAdswag; + try { + extImpAdswag = parseImpExt(imp); + validateImpExt(extImpAdswag, imp.getId()); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + continue; + } + + impsByPublisher + .computeIfAbsent(extImpAdswag.getPublisherId(), _ -> new ArrayList<>()) + .add(modifyImp(imp, extImpAdswag.getPlacementId())); + } + + if (impsByPublisher.isEmpty()) { + return Result.withErrors(errors); + } + + if (request.getSite() == null && request.getApp() == null) { + errors.add(BidderError.badInput("request must contain either site or app")); + return Result.withErrors(errors); + } + + final List> httpRequests = impsByPublisher.entrySet().stream() + .map(group -> modifyBidRequest(request, group.getKey(), group.getValue())) + .map(modifiedRequest -> BidderUtil.defaultRequest(modifiedRequest, endpointUrl, mapper)) + .toList(); + + return Result.of(httpRequests, errors); + } + + private ExtImpAdswag parseImpExt(Imp imp) { + try { + return mapper.mapper().convertValue(imp.getExt(), TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException("Error parsing imp.ext for impression " + imp.getId()); + } + } + + private static void validateImpExt(ExtImpAdswag extImpAdswag, String impId) { + if (StringUtils.isBlank(extImpAdswag.getPublisherId())) { + throw new PreBidException("missing publisherId for imp " + impId); + } + } + + private static Imp modifyImp(Imp imp, String placementId) { + final ObjectNode modifiedExt = imp.getExt().deepCopy(); + modifiedExt.remove("bidder"); + modifiedExt.remove("prebid"); + if (StringUtils.isNotBlank(placementId)) { + modifiedExt.putObject("adswag").put("placement_id", placementId); + } + + return imp.toBuilder().ext(modifiedExt.isEmpty() ? null : modifiedExt).build(); + } + + private static BidRequest modifyBidRequest(BidRequest request, String publisherId, List modifiedImps) { + return request.toBuilder() + .site(modifySite(request.getSite(), publisherId)) + .app(modifyApp(request.getApp(), publisherId)) + .imp(modifiedImps) + .build(); + } + + private static Site modifySite(Site site, String publisherId) { + return site != null + ? site.toBuilder().publisher(modifyPublisher(site.getPublisher(), publisherId)).build() + : null; + } + + private static App modifyApp(App app, String publisherId) { + return app != null + ? app.toBuilder().publisher(modifyPublisher(app.getPublisher(), publisherId)).build() + : null; + } + + private static Publisher modifyPublisher(Publisher publisher, String publisherId) { + return Optional.ofNullable(publisher) + .map(Publisher::toBuilder) + .orElseGet(Publisher::builder) + .id(publisherId) + .build(); + } + + @Override + public final Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + final String body = httpCall.getResponse().getBody(); + if (StringUtils.isBlank(body)) { + return Result.empty(); + } + + try { + final BidResponse bidResponse = mapper.decodeValue(body, BidResponse.class); + final List errors = new ArrayList<>(); + final List bids = extractBids(httpCall.getRequest().getPayload(), bidResponse, errors); + return Result.of(bids, errors); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private List extractBids(BidRequest bidRequest, BidResponse bidResponse, List errors) { + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + + final String currency = StringUtils.defaultIfBlank(bidResponse.getCur(), DEFAULT_CURRENCY); + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(List::stream) + .filter(Objects::nonNull) + .map(bid -> makeBidderBid(bid, bidRequest.getImp(), currency, errors)) + .filter(Objects::nonNull) + .toList(); + } + + private BidderBid makeBidderBid(Bid bid, List imps, String currency, List errors) { + final Imp imp = findImp(imps, bid.getImpid()); + if (imp == null) { + errors.add(BidderError.badServerResponse( + "bid %s references unknown imp %s".formatted(bid.getId(), bid.getImpid()))); + return null; + } + + final String serveUrl = serveUrl(bid); + if (StringUtils.isBlank(bid.getAdm()) && StringUtils.isBlank(serveUrl)) { + errors.add(BidderError.badServerResponse( + "bid %s has neither adm nor ext.adswag.serve_url".formatted(bid.getId()))); + return null; + } + + final BidType bidType; + try { + bidType = resolveBidType(imp, bid); + } catch (PreBidException e) { + errors.add(BidderError.badServerResponse(e.getMessage())); + return null; + } + + final Bid modifiedBid = switch (bidType) { + case banner -> makeBannerBid(bid, serveUrl, imp.getBanner()); + case video -> makeVideoBid(bid, serveUrl, imp.getVideo()); + case audio -> makeAudioBid(bid, serveUrl); + // should never happen + default -> throw new AssertionError(); + }; + + return BidderBid.of(modifiedBid, bidType, currency); + } + + private static Imp findImp(List imps, String impId) { + return imps.stream() + .filter(imp -> Objects.equals(imp.getId(), impId)) + .findFirst() + .orElse(null); + } + + private static String serveUrl(Bid bid) { + final JsonNode serveUrlNode = bid.getExt() != null + ? bid.getExt().path("adswag").path("serve_url") + : null; + return serveUrlNode != null && serveUrlNode.isTextual() ? serveUrlNode.textValue() : null; + } + + private static BidType resolveBidType(Imp imp, Bid bid) { + final Integer mtype = bid.getMtype(); + if (mtype != null) { + return switch (mtype) { + case 1 -> BidType.banner; + case 2 -> BidType.video; + case 3 -> BidType.audio; + default -> throw new PreBidException( + "unsupported bid.mtype %d for impression %s".formatted(mtype, bid.getImpid())); + }; + } + + final boolean isVast = bid.getAdm() != null && VAST_MARKUP.matcher(bid.getAdm()).find(); + if (imp.getAudio() != null && (isVast || imp.getBanner() == null)) { + return BidType.audio; + } + if (imp.getVideo() != null && (isVast || imp.getBanner() == null)) { + return BidType.video; + } + if (imp.getBanner() != null) { + return BidType.banner; + } + throw new PreBidException("unable to resolve media type for impression " + bid.getImpid()); + } + + private static Bid makeBannerBid(Bid bid, String serveUrl, Banner banner) { + final Format size = bannerSize(banner); + final boolean updateSize = hasNoSize(bid) && size != null; + + return bid.toBuilder() + .adm(StringUtils.isBlank(bid.getAdm()) ? iframeMarkup(serveUrl, size) : bid.getAdm()) + .w(updateSize ? size.getW() : bid.getW()) + .h(updateSize ? size.getH() : bid.getH()) + .mtype(1) + .build(); + } + + private static Format bannerSize(Banner banner) { + if (banner == null) { + return null; + } + if (CollectionUtils.isNotEmpty(banner.getFormat())) { + return banner.getFormat().getFirst(); + } + if (banner.getW() != null && banner.getH() != null) { + return Format.builder().w(banner.getW()).h(banner.getH()).build(); + } + return null; + } + + private static String iframeMarkup(String serveUrl, Format size) { + final StringBuilder markup = new StringBuilder() + .append(""""); + + return markup.toString(); + } + + // Mirrors Go's html.EscapeString so both server adapters emit identical markup. + private static String escapeHtmlAttribute(String value) { + return value + .replace("&", "&") + .replace("'", "'") + .replace("<", "<") + .replace(">", ">") + .replace("\"", """); + } + + private static boolean hasNoSize(Bid bid) { + return bid.getW() == null || bid.getW() <= 0 || bid.getH() == null || bid.getH() <= 0; + } + + private static Bid makeVideoBid(Bid bid, String serveUrl, Video video) { + final boolean updateSize = hasNoSize(bid) && video != null && video.getW() != null && video.getH() != null; + return bid.toBuilder() + .nurl(StringUtils.isBlank(bid.getAdm()) ? serveUrl : bid.getNurl()) + .w(updateSize ? video.getW() : bid.getW()) + .h(updateSize ? video.getH() : bid.getH()) + .mtype(2) + .build(); + } + + private static Bid makeAudioBid(Bid bid, String serveUrl) { + return bid.toBuilder() + .nurl(StringUtils.isBlank(bid.getAdm()) ? serveUrl : bid.getNurl()) + .mtype(3) + .build(); + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/adswag/ExtImpAdswag.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/adswag/ExtImpAdswag.java new file mode 100644 index 00000000000..2de23e9340f --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/adswag/ExtImpAdswag.java @@ -0,0 +1,14 @@ +package org.prebid.server.proto.openrtb.ext.request.adswag; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpAdswag { + + @JsonProperty("publisherId") + String publisherId; + + @JsonProperty("placementId") + String placementId; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/AdswagConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/AdswagConfiguration.java new file mode 100644 index 00000000000..4a6e4d5bc53 --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/AdswagConfiguration.java @@ -0,0 +1,35 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.adswag.AdswagBidder; +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.env.YamlPropertySourceFactory; +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; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/adswag.yaml", factory = YamlPropertySourceFactory.class) +public class AdswagConfiguration { + + private static final String BIDDER_NAME = "adswag"; + + @Bean("adswagConfigurationProperties") + @ConfigurationProperties("adapters.adswag") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps adswagBidderDeps(BidderConfigurationProperties adswagConfigurationProperties, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(adswagConfigurationProperties) + .bidderCreator(config -> new AdswagBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/adswag.yaml b/src/main/resources/bidder-config/adswag.yaml new file mode 100644 index 00000000000..0f40b19e4d2 --- /dev/null +++ b/src/main/resources/bidder-config/adswag.yaml @@ -0,0 +1,26 @@ +adapters: + adswag: + ortb-version: "2.6" + endpoint: https://bid.adswag.ai/prebid/bid + modifying-vast-xml-allowed: false + geoscope: + - EEA + ortb: + multiformat-supported: true + usersync: + cookie-family-name: adswag + redirect: + url: https://ev.adswag.ai/sync/pixel?gdpr={gdpr}&gdpr_consent={gdpr_consent}&us_privacy={us_privacy}&gpp={gpp}&gpp_sid={gpp_sid}&redirect={redirect_url} + uid-macro: '$UID' + meta-info: + maintainer-email: prebid@adswag.ai + app-media-types: + - banner + - video + - audio + site-media-types: + - banner + - video + - audio + supported-vendors: + vendor-id: 1417 diff --git a/src/main/resources/static/bidder-params/adswag.json b/src/main/resources/static/bidder-params/adswag.json new file mode 100644 index 00000000000..4a3b70230d1 --- /dev/null +++ b/src/main/resources/static/bidder-params/adswag.json @@ -0,0 +1,19 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Adswag Adapter Params", + "description": "A schema which validates params accepted by the Adswag adapter", + "type": "object", + "properties": { + "publisherId": { + "type": "string", + "minLength": 1, + "description": "Adswag publisher id (issued at onboarding)" + }, + "placementId": { + "type": "string", + "minLength": 1, + "description": "Explicit placement override; omit to let Adswag discover the placement from GPID or the ad unit code" + } + }, + "required": ["publisherId"] +} diff --git a/src/test/java/org/prebid/server/bidder/adswag/AdswagBidderTest.java b/src/test/java/org/prebid/server/bidder/adswag/AdswagBidderTest.java new file mode 100644 index 00000000000..9451efc6247 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/adswag/AdswagBidderTest.java @@ -0,0 +1,555 @@ +package org.prebid.server.bidder.adswag; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.App; +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.Publisher; +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.adswag.ExtImpAdswag; +import org.prebid.server.proto.openrtb.ext.response.BidType; + +import java.math.BigDecimal; +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 AdswagBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://test.endpoint.com/prebid/bid"; + private static final String SERVE_URL = "https://ads.adswag.ai/v1/ad?sc=c2ln&sig=YWJj"; + private static final String VAST_ADM = """ + \ + Adswag\ + \ + """; + private static final String IFRAME_ADM = """ + """; + + private final AdswagBidder target = new AdswagBidder(ENDPOINT_URL, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException().isThrownBy(() -> new AdswagBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldReturnErrorIfImpExtCouldNotBeParsed() { + // given + final BidRequest bidRequest = givenBidRequest(givenImp( + imp -> imp.id("imp1").ext(mapper.valueToTree(ExtPrebid.of(null, mapper.createArrayNode()))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + assertThat(error.getMessage()).startsWith("Error parsing imp.ext for impression imp1"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldReturnErrorIfPublisherIdIsMissing() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp1").ext(givenImpExt(" ", "placement")))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + assertThat(error.getMessage()).isEqualTo("missing publisherId for imp imp1"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldReturnErrorIfNeitherSiteNorAppIsPresent() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp1").ext(givenImpExt("pub-1", null)))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + assertThat(error.getMessage()).isEqualTo("request must contain either site or app"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldPromotePublisherIdAndRewriteImpExt() { + // given + final ObjectNode impExt = givenImpExt("pub-1", "plc-1"); + impExt.put("gpid", "/1111/homepage#div-1"); + final BidRequest bidRequest = givenBidRequest( + request -> request.site(Site.builder() + .publisher(Publisher.builder().name("Example").build()) + .build()), + givenImp(imp -> imp.id("imp1").ext(impExt))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .extracting(Site::getPublisher) + .extracting(Publisher::getId, Publisher::getName) + .containsExactly(tuple("pub-1", "Example")); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getExt) + .allSatisfy(ext -> { + assertThat(ext.has("bidder")).isFalse(); + assertThat(ext.get("gpid").textValue()).isEqualTo("/1111/homepage#div-1"); + assertThat(ext.get("adswag").get("placement_id").textValue()).isEqualTo("plc-1"); + }); + } + + @Test + public void makeHttpRequestsShouldRemoveImpExtWhenOnlyBidderParamsPresent() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.site(Site.builder().domain("example.nl").build()), + givenImp(imp -> imp.id("imp1").ext(givenImpExt("pub-1", null)))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getExt) + .containsOnlyNulls(); + } + + @Test + public void makeHttpRequestsShouldPromotePublisherIdToApp() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.app(App.builder().bundle("com.example.app").build()), + givenImp(imp -> imp.id("imp1").ext(givenImpExt("pub-1", null)))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getApp) + .extracting(App::getPublisher) + .extracting(Publisher::getId) + .containsExactly("pub-1"); + } + + @Test + public void makeHttpRequestsShouldDropImpsWithInvalidExtAndKeepValidOnes() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.site(Site.builder().domain("example.nl").build()), + givenImp(imp -> imp.id("imp1").ext(givenImpExt("pub-1", null))), + givenImp(imp -> imp.id("imp2").ext(givenImpExt(null, "plc-2")))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> assertThat(error.getMessage()).isEqualTo("missing publisherId for imp imp2")); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getId) + .containsExactly("imp1"); + } + + @Test + public void makeHttpRequestsShouldSplitImpsByPublisherId() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.site(Site.builder().domain("example.nl").build()), + givenImp(imp -> imp.id("imp-a").ext(givenImpExt("pub-a", null))), + givenImp(imp -> imp.id("imp-b").ext(givenImpExt("pub-b", null))), + givenImp(imp -> imp.id("imp-a-2").ext(givenImpExt("pub-a", null)))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(2); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(payload -> payload.getSite().getPublisher().getId()) + .containsExactly("pub-a", "pub-b"); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(payload -> payload.getImp().stream().map(Imp::getId).toList()) + .containsExactly(List.of("imp-a", "imp-a-2"), List.of("imp-b")); + } + + @Test + public void makeBidsShouldReturnEmptyResultForEmptyBody() { + // given + final BidderCall httpCall = BidderCall.succeededHttp( + HttpRequest.builder().build(), + HttpResponse.of(200, null, ""), + null); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnErrorWhenResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = BidderCall.succeededHttp( + HttpRequest.builder().build(), + HttpResponse.of(200, null, "invalid_json"), + null); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + assertThat(error.getMessage()).startsWith("Failed to decode: Unrecognized token 'invalid_json'"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldSynthesizeIframeMarkupForBannerServeUrlBid() throws JsonProcessingException { + // given + final Bid responseBid = givenServeUrlBid("imp1"); + final BidRequest bidRequest = givenBidRequest(givenImp(imp -> imp.id("imp1").banner(givenBanner()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType, BidderBid::getBidCurrency) + .containsExactly(tuple(BidType.banner, "EUR")); + assertThat(result.getValue()) + .extracting(BidderBid::getBid) + .extracting(Bid::getAdm, Bid::getW, Bid::getH, Bid::getMtype) + .containsExactly(tuple(IFRAME_ADM, 300, 250, 1)); + } + + @Test + public void makeBidsShouldPassThroughAdmWhenMarkupIsPresent() throws JsonProcessingException { + // given + final String loaderAdm = ""; + final Bid responseBid = givenServeUrlBid("imp1").toBuilder().adm(loaderAdm).build(); + final BidRequest bidRequest = givenBidRequest(givenImp(imp -> imp.id("imp1").banner(givenBanner()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getBid) + .extracting(Bid::getAdm) + .containsExactly(loaderAdm); + } + + @Test + public void makeBidsShouldReturnVideoBidForVastMarkup() throws JsonProcessingException { + // given + final Bid responseBid = givenVastBid("imp1"); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp1").video(Video.builder().w(640).h(360).build()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType) + .containsExactly(BidType.video); + assertThat(result.getValue()) + .extracting(BidderBid::getBid) + .extracting(Bid::getAdm, Bid::getW, Bid::getH, Bid::getMtype) + .containsExactly(tuple(VAST_ADM, 640, 360, 2)); + } + + @Test + public void makeBidsShouldReturnAudioBidForVastMarkupOnAudioImp() throws JsonProcessingException { + // given + final Bid responseBid = givenVastBid("imp1"); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp1") + .banner(givenBanner()) + .audio(Audio.builder().mimes(singletonList("audio/mpeg")).build()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType) + .containsExactly(BidType.audio); + assertThat(result.getValue()) + .extracting(BidderBid::getBid) + .extracting(Bid::getMtype) + .containsExactly(3); + } + + @Test + public void makeBidsShouldResolveServeUrlBidOnMultiFormatImpAsBanner() throws JsonProcessingException { + // given + final Bid responseBid = givenServeUrlBid("imp1"); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp1").banner(givenBanner()).video(Video.builder().w(640).h(360).build()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType) + .containsExactly(BidType.banner); + } + + @Test + public void makeBidsShouldSetNurlForVideoServeUrlBidWithoutAdm() throws JsonProcessingException { + // given + final Bid responseBid = givenServeUrlBid("imp1"); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp1").video(Video.builder().w(640).h(360).build()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getBid) + .extracting(Bid::getNurl, Bid::getMtype) + .containsExactly(tuple(SERVE_URL, 2)); + } + + @Test + public void makeBidsShouldHonorMtypeWhenPresent() throws JsonProcessingException { + // given + final Bid responseBid = givenVastBid("imp1").toBuilder().mtype(2).build(); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.id("imp1") + .audio(Audio.builder().mimes(singletonList("audio/mpeg")).build()) + .video(Video.builder().w(640).h(360).build()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getType) + .containsExactly(BidType.video); + } + + @Test + public void makeBidsShouldReturnErrorForUnsupportedMtype() throws JsonProcessingException { + // given + final Bid responseBid = givenVastBid("imp1").toBuilder().mtype(4).build(); + final BidRequest bidRequest = givenBidRequest(givenImp(imp -> imp.id("imp1").banner(givenBanner()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + assertThat(error.getMessage()).isEqualTo("unsupported bid.mtype 4 for impression imp1"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnErrorForUnknownImp() throws JsonProcessingException { + // given + final Bid responseBid = givenServeUrlBid("unknown-imp"); + final BidRequest bidRequest = givenBidRequest(givenImp(imp -> imp.id("imp1").banner(givenBanner()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + assertThat(error.getMessage()) + .isEqualTo("bid adswag-unknown-imp references unknown imp unknown-imp"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnErrorForBidWithoutAdmOrServeUrl() throws JsonProcessingException { + // given + final Bid responseBid = Bid.builder() + .id("adswag-imp1") + .impid("imp1") + .price(BigDecimal.valueOf(2.5)) + .build(); + final BidRequest bidRequest = givenBidRequest(givenImp(imp -> imp.id("imp1").banner(givenBanner()))); + final BidderCall httpCall = givenHttpCall(bidRequest, singletonList(responseBid)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + assertThat(error.getMessage()) + .isEqualTo("bid adswag-imp1 has neither adm nor ext.adswag.serve_url"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldDefaultCurrencyToEur() throws JsonProcessingException { + // given + final BidResponse bidResponse = BidResponse.builder() + .seatbid(singletonList(SeatBid.builder().bid(singletonList(givenServeUrlBid("imp1"))).build())) + .build(); + final BidRequest bidRequest = givenBidRequest(givenImp(imp -> imp.id("imp1").banner(givenBanner()))); + final BidderCall httpCall = BidderCall.succeededHttp( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, mapper.writeValueAsString(bidResponse)), + null); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getBidCurrency) + .containsExactly("EUR"); + } + + private static BidRequest givenBidRequest(UnaryOperator bidRequestCustomizer, + Imp... imps) { + + return bidRequestCustomizer.apply(BidRequest.builder().imp(asList(imps))).build(); + } + + private static BidRequest givenBidRequest(Imp... imps) { + return givenBidRequest(identity(), imps); + } + + private static Imp givenImp(UnaryOperator impCustomizer) { + return impCustomizer.apply(Imp.builder()).build(); + } + + private static ObjectNode givenImpExt(String publisherId, String placementId) { + return mapper.valueToTree(ExtPrebid.of(null, ExtImpAdswag.of(publisherId, placementId))); + } + + private static Banner givenBanner() { + return Banner.builder().format(singletonList(Format.builder().w(300).h(250).build())).build(); + } + + private static Bid givenServeUrlBid(String impId) { + final ObjectNode bidExt = mapper.createObjectNode(); + bidExt.putObject("adswag").put("serve_url", SERVE_URL); + return Bid.builder() + .id("adswag-" + impId) + .impid(impId) + .price(BigDecimal.valueOf(2.5)) + .crid("cr-1") + .ext(bidExt) + .build(); + } + + private static Bid givenVastBid(String impId) { + return Bid.builder() + .id("adswag-" + impId) + .impid(impId) + .price(BigDecimal.valueOf(2.5)) + .crid("cr-1") + .adm(VAST_ADM) + .build(); + } + + private static BidResponse givenBidResponse(List bids) { + return BidResponse.builder() + .cur("EUR") + .seatbid(singletonList(SeatBid.builder().bid(bids).build())) + .build(); + } + + private static BidderCall givenHttpCall(BidRequest bidRequest, List bids) + throws JsonProcessingException { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, mapper.writeValueAsString(givenBidResponse(bids))), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/AdswagTest.java b/src/test/java/org/prebid/server/it/AdswagTest.java new file mode 100644 index 00000000000..a80748e57ad --- /dev/null +++ b/src/test/java/org/prebid/server/it/AdswagTest.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 AdswagTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromAdswag() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/adswag-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/adswag/test-adswag-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/adswag/test-adswag-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/adswag/test-auction-adswag-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/adswag/test-auction-adswag-response.json", response, singletonList("adswag")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-adswag-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-adswag-bid-request.json new file mode 100644 index 00000000000..152741f4075 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-adswag-bid-request.json @@ -0,0 +1,69 @@ +{ + "id": "test-request-banner", + "imp": [ + { + "id": "test-imp-banner", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "secure": 1, + "ext": { + "tid": "${json-unit.any-string}", + "adswag": { + "placement_id": "prebid-test-display" + } + } + } + ], + "site": { + "id": "demo-site", + "domain": "example.com", + "page": "https://example.com/demo", + "publisher": { + "id": "prebid-test", + "domain": "example.com" + }, + "ext": { + "amp": 0 + } + }, + "device": { + "dnt": 0, + "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36", + "ip": "192.0.2.1", + "language": "en" + }, + "user": { + "id": "demo-user" + }, + "at": 1, + "tmax": "${json-unit.any-number}", + "cur": [ + "EUR" + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "regs": { + "gdpr": 0 + }, + "ext": { + "prebid": { + "channel": { + "name": "web" + }, + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "http_method": "POST", + "endpoint": "/openrtb2/auction" + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-adswag-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-adswag-bid-response.json new file mode 100644 index 00000000000..a78750b9c94 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-adswag-bid-response.json @@ -0,0 +1,25 @@ +{ + "id": "test-request-banner", + "cur": "EUR", + "seatbid": [ + { + "seat": "adswag", + "bid": [ + { + "id": "req-abc-1", + "impid": "test-imp-banner", + "price": 2.50, + "burl": "https://ads.adswag.ai/v1/win?sc=c2ln&sig=YWJj&price=${AUCTION_PRICE}", + "cid": "cmp-test-1", + "crid": "cr-test-1", + "adomain": ["advertiser.example"], + "ext": { + "adswag": { + "serve_url": "https://ads.adswag.ai/v1/ad?sc=c2ln&sig=YWJj" + } + } + } + ] + } + ] +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-auction-adswag-request.json b/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-auction-adswag-request.json new file mode 100644 index 00000000000..f4573456514 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-auction-adswag-request.json @@ -0,0 +1,45 @@ +{ + "id": "test-request-banner", + "imp": [ + { + "id": "test-imp-banner", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "adswag": { + "publisherId": "prebid-test", + "placementId": "prebid-test-display" + } + } + } + ], + "site": { + "id": "demo-site", + "domain": "example.com", + "page": "https://example.com/demo", + "publisher": { + "id": "demo-publisher" + } + }, + "device": { + "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36", + "ip": "192.0.2.1", + "language": "en", + "dnt": 0 + }, + "user": { + "id": "demo-user" + }, + "cur": ["EUR"], + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-auction-adswag-response.json b/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-auction-adswag-response.json new file mode 100644 index 00000000000..4dac5a13406 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/adswag/test-auction-adswag-response.json @@ -0,0 +1,48 @@ +{ + "id": "test-request-banner", + "seatbid": [ + { + "seat": "adswag", + "bid": [ + { + "id": "req-abc-1", + "impid": "test-imp-banner", + "price": 2.50, + "burl": "https://ads.adswag.ai/v1/win?sc=c2ln&sig=YWJj&price=${AUCTION_PRICE}", + "cid": "cmp-test-1", + "crid": "cr-test-1", + "adomain": ["advertiser.example"], + "adm": "", + "w": 300, + "h": 250, + "exp": 300, + "mtype": 1, + "ext": { + "adswag": { + "serve_url": "https://ads.adswag.ai/v1/ad?sc=c2ln&sig=YWJj" + }, + "origbidcpm": 2.50, + "origbidcur": "EUR", + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "adswag" + } + } + } + } + ], + "group": 0 + } + ], + "cur": "EUR", + "ext": { + "responsetimemillis": { + "adswag": "{{ adswag.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} 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 c8dc5ef74fa..e9a67976b53 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -82,6 +82,8 @@ adapters.adprime.enabled=true adapters.adprime.endpoint=http://localhost:8090/adprime-exchange adapters.adquery.enabled=true adapters.adquery.endpoint=http://localhost:8090/adquery-exchange +adapters.adswag.enabled=true +adapters.adswag.endpoint=http://localhost:8090/adswag-exchange adapters.adtarget.enabled=true adapters.adtarget.endpoint=http://localhost:8090/adtarget-exchange adapters.adtelligent.enabled=true