From 89eb2a30697f409448094112e4bcd92e1a41cafd Mon Sep 17 00:00:00 2001 From: Mark Lagae Date: Wed, 29 Apr 2026 11:09:25 -0700 Subject: [PATCH] Add HypeLab bidder adapter --- .../server/bidder/hypelab/HypeLabBidder.java | 241 ++++++++++++ .../ext/request/hypelab/ExtImpHypeLab.java | 14 + .../config/bidder/HypeLabConfiguration.java | 46 +++ src/main/resources/bidder-config/hypelab.yaml | 21 + .../static/bidder-params/hypelab.json | 19 + .../bidder/hypelab/HypeLabBidderTest.java | 359 ++++++++++++++++++ .../org/prebid/server/it/HypeLabTest.java | 34 ++ .../hypelab/test-auction-hypelab-request.json | 28 ++ .../test-auction-hypelab-response.json | 47 +++ .../hypelab/test-hypelab-bid-request.json | 63 +++ .../hypelab/test-hypelab-bid-response.json | 28 ++ .../server/it/test-application.properties | 2 + 12 files changed, 902 insertions(+) create mode 100644 src/main/java/org/prebid/server/bidder/hypelab/HypeLabBidder.java create mode 100644 src/main/java/org/prebid/server/proto/openrtb/ext/request/hypelab/ExtImpHypeLab.java create mode 100644 src/main/java/org/prebid/server/spring/config/bidder/HypeLabConfiguration.java create mode 100644 src/main/resources/bidder-config/hypelab.yaml create mode 100644 src/main/resources/static/bidder-params/hypelab.json create mode 100644 src/test/java/org/prebid/server/bidder/hypelab/HypeLabBidderTest.java create mode 100644 src/test/java/org/prebid/server/it/HypeLabTest.java create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-auction-hypelab-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-auction-hypelab-response.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-hypelab-bid-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-hypelab-bid-response.json diff --git a/src/main/java/org/prebid/server/bidder/hypelab/HypeLabBidder.java b/src/main/java/org/prebid/server/bidder/hypelab/HypeLabBidder.java new file mode 100644 index 00000000000..0f8c16e2a95 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/hypelab/HypeLabBidder.java @@ -0,0 +1,241 @@ +package org.prebid.server.bidder.hypelab; + +import com.fasterxml.jackson.databind.JsonNode; +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.MultiMap; +import io.vertx.core.http.HttpMethod; +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.ExtRequest; +import org.prebid.server.proto.openrtb.ext.request.hypelab.ExtImpHypeLab; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; +import org.prebid.server.version.PrebidVersionProvider; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.stream.Collectors; + +public class HypeLabBidder implements Bidder { + + private static final String DISPLAY_MANAGER = "HypeLab Prebid Server"; + private static final String SOURCE = "prebid-server"; + private static final String UNKNOWN_VERSION = "unknown"; + + private final String endpointUrl; + private final JacksonMapper mapper; + private final PrebidVersionProvider prebidVersionProvider; + + public HypeLabBidder(String endpointUrl, JacksonMapper mapper, PrebidVersionProvider prebidVersionProvider) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + this.prebidVersionProvider = Objects.requireNonNull(prebidVersionProvider); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + final List errors = new ArrayList<>(); + final List validImps = new ArrayList<>(); + + for (Imp imp : request.getImp()) { + try { + validImps.add(makeOutgoingImp(imp)); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + if (validImps.isEmpty()) { + return Result.of(Collections.emptyList(), errors); + } + + final BidRequest outgoingRequest = request.toBuilder() + .imp(validImps) + .ext(makeOutgoingRequestExt(request.getExt())) + .build(); + + return Result.of(Collections.singletonList( + HttpRequest.builder() + .method(HttpMethod.POST) + .uri(endpointUrl) + .headers(headers()) + .impIds(BidderUtil.impIds(outgoingRequest)) + .body(mapper.encodeToBytes(outgoingRequest)) + .payload(outgoingRequest) + .build()), + errors); + } + + private Imp makeOutgoingImp(Imp imp) { + final ExtImpHypeLab extImp = parseImpExt(imp); + final String pbsVersion = pbsVersion(); + + return imp.toBuilder() + .tagid(extImp.getPlacementSlug()) + .displaymanager(DISPLAY_MANAGER) + .displaymanagerver(pbsVersion) + .ext(mapper.mapper().valueToTree(ExtPrebid.of(null, extImp))) + .build(); + } + + private ExtImpHypeLab parseImpExt(Imp imp) { + if (imp.getExt() == null) { + throw new PreBidException("imp %s: unable to unmarshal ext".formatted(imp.getId())); + } + + final JsonNode bidderNode = imp.getExt().get("bidder"); + if (bidderNode == null || bidderNode.isNull()) { + throw new PreBidException("imp %s: unable to unmarshal ext.bidder".formatted(imp.getId())); + } + + final ExtImpHypeLab extImp; + try { + extImp = mapper.mapper().convertValue(bidderNode, ExtImpHypeLab.class); + } catch (IllegalArgumentException e) { + throw new PreBidException("imp %s: unable to unmarshal ext.bidder".formatted(imp.getId()), e); + } + + if (StringUtils.isBlank(extImp.getPropertySlug()) || StringUtils.isBlank(extImp.getPlacementSlug())) { + throw new PreBidException("imp %s: property_slug and placement_slug are required".formatted(imp.getId())); + } + + return extImp; + } + + private ExtRequest makeOutgoingRequestExt(ExtRequest ext) { + final ExtRequest outgoingExt = ext != null ? ExtRequest.of(ext.getPrebid()) : ExtRequest.empty(); + if (ext != null) { + outgoingExt.addProperties(ext.getProperties()); + } + + outgoingExt.addProperty("source", mapper.mapper().valueToTree(SOURCE)); + outgoingExt.addProperty("provider_version", mapper.mapper().valueToTree(pbsVersion())); + + return outgoingExt; + } + + private static MultiMap headers() { + return HttpUtil.headers() + .add(HttpUtil.X_OPENRTB_VERSION_HEADER, "2.6"); + } + + @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<>(); + return Result.of(extractBids(httpCall.getRequest().getPayload(), bidResponse, errors), errors); + } + + private static List extractBids(BidRequest request, BidResponse response, List errors) { + if (response == null || CollectionUtils.isEmpty(response.getSeatbid())) { + return Collections.emptyList(); + } + + final Map impIdToImp = request.getImp().stream() + .collect(Collectors.toMap(Imp::getId, imp -> imp)); + + return response.getSeatbid().stream() + .filter(Objects::nonNull) + .map(seatBid -> bidsFromSeatBid(seatBid, impIdToImp, response.getCur(), errors)) + .flatMap(Collection::stream) + .toList(); + } + + private static List bidsFromSeatBid(SeatBid seatBid, Map impIdToImp, String currency, + List errors) { + + final List bids = seatBid.getBid(); + if (CollectionUtils.isEmpty(bids)) { + return Collections.emptyList(); + } + + return bids.stream() + .filter(Objects::nonNull) + .map(bid -> makeBidderBid(bid, seatBid.getSeat(), impIdToImp, currency, errors)) + .filter(Objects::nonNull) + .toList(); + } + + private static BidderBid makeBidderBid(Bid bid, String seat, Map impIdToImp, String currency, + List errors) { + + try { + return BidderBid.of(bid, resolveBidType(bid, impIdToImp), seat, currency); + } catch (PreBidException e) { + errors.add(BidderError.badServerResponse(e.getMessage())); + return null; + } + } + + private static BidType resolveBidType(Bid bid, Map impIdToImp) { + final BidType bidTypeFromMtype = bidTypeFromMtype(bid.getMtype()); + if (bidTypeFromMtype != null) { + return bidTypeFromMtype; + } + + final BidType bidTypeFromExt = bidTypeFromExt(bid); + if (bidTypeFromExt != null) { + return bidTypeFromExt; + } + + if (StringUtils.startsWith(StringUtils.trimToEmpty(bid.getAdm()), " BidType.banner; + case 2 -> BidType.video; + case 4 -> BidType.xNative; + default -> null; + }; + } + + private static BidType bidTypeFromExt(Bid bid) { + final JsonNode hypelabExt = bid.getExt() != null ? bid.getExt().get("hypelab") : null; + final String creativeType = hypelabExt != null ? hypelabExt.path("creative_type").asText() : null; + + return switch (StringUtils.defaultString(creativeType)) { + case "display" -> BidType.banner; + case "video" -> BidType.video; + default -> null; + }; + } + + private String pbsVersion() { + return StringUtils.defaultIfBlank(prebidVersionProvider.getNameVersionRecord(), UNKNOWN_VERSION); + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/hypelab/ExtImpHypeLab.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/hypelab/ExtImpHypeLab.java new file mode 100644 index 00000000000..28a73b74aa1 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/hypelab/ExtImpHypeLab.java @@ -0,0 +1,14 @@ +package org.prebid.server.proto.openrtb.ext.request.hypelab; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpHypeLab { + + @JsonProperty("property_slug") + String propertySlug; + + @JsonProperty("placement_slug") + String placementSlug; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/HypeLabConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/HypeLabConfiguration.java new file mode 100644 index 00000000000..a5e4e31ddf4 --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/HypeLabConfiguration.java @@ -0,0 +1,46 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.hypelab.HypeLabBidder; +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.prebid.server.version.PrebidVersionProvider; +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/hypelab.yaml", factory = YamlPropertySourceFactory.class) +public class HypeLabConfiguration { + + private static final String BIDDER_NAME = "hypelab"; + + @Bean("hypelabConfigurationProperties") + @ConfigurationProperties("adapters.hypelab") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps hypelabBidderDeps(BidderConfigurationProperties hypelabConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + PrebidVersionProvider prebidVersionProvider, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(hypelabConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new HypeLabBidder( + config.getEndpoint(), + mapper, + prebidVersionProvider)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/hypelab.yaml b/src/main/resources/bidder-config/hypelab.yaml new file mode 100644 index 00000000000..2d8d59e5c03 --- /dev/null +++ b/src/main/resources/bidder-config/hypelab.yaml @@ -0,0 +1,21 @@ +adapters: + hypelab: + endpoint: https://api.hypelab.com/v1/rtb_requests + ortb-version: "2.6" + aliases: + hype: ~ + meta-info: + maintainer-email: sdk@hypelab.com + app-media-types: [] + site-media-types: + - banner + - native + - video + supported-vendors: + vendor-id: 0 + usersync: + cookie-family-name: hypelab + redirect: + url: https://api.hypelab.com/v1/i?redirect_url={{redirect_url}}&gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&gpp={{gpp}}&gpp_sid={{gpp_sid}} + support-cors: false + uid-macro: '$UID' diff --git a/src/main/resources/static/bidder-params/hypelab.json b/src/main/resources/static/bidder-params/hypelab.json new file mode 100644 index 00000000000..fd90f96adfc --- /dev/null +++ b/src/main/resources/static/bidder-params/hypelab.json @@ -0,0 +1,19 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "HypeLab Adapter Params", + "description": "A schema which validates params accepted by the HypeLab adapter", + "type": "object", + "properties": { + "property_slug": { + "type": "string", + "minLength": 1, + "description": "HypeLab property slug" + }, + "placement_slug": { + "type": "string", + "minLength": 1, + "description": "HypeLab placement slug" + } + }, + "required": ["property_slug", "placement_slug"] +} diff --git a/src/test/java/org/prebid/server/bidder/hypelab/HypeLabBidderTest.java b/src/test/java/org/prebid/server/bidder/hypelab/HypeLabBidderTest.java new file mode 100644 index 00000000000..fb04a03de34 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/hypelab/HypeLabBidderTest.java @@ -0,0 +1,359 @@ +package org.prebid.server.bidder.hypelab; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Native; +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.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.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.ExtRequest; +import org.prebid.server.proto.openrtb.ext.request.hypelab.ExtImpHypeLab; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.HttpUtil; +import org.prebid.server.version.PrebidVersionProvider; + +import java.math.BigDecimal; +import java.util.Arrays; +import java.util.List; +import java.util.function.UnaryOperator; + +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.mockito.BDDMockito.given; +import static org.mockito.Mock.Strictness.LENIENT; + +@ExtendWith(MockitoExtension.class) +public class HypeLabBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://api.hypelab.com/v1/rtb_requests"; + private static final String PBS_VERSION = "pbs-java/1.0"; + + @Mock(strictness = LENIENT) + private PrebidVersionProvider prebidVersionProvider; + + private HypeLabBidder target; + + @BeforeEach + public void setUp() { + given(prebidVersionProvider.getNameVersionRecord()).willReturn(PBS_VERSION); + target = new HypeLabBidder(ENDPOINT_URL, jacksonMapper, prebidVersionProvider); + } + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException() + .isThrownBy(() -> new HypeLabBidder("invalid_url", jacksonMapper, prebidVersionProvider)); + } + + @Test + public void makeHttpRequestsShouldCreateExpectedRequest() { + // given + final ExtRequest requestExt = ExtRequest.empty(); + requestExt.addProperty("existing", mapper.valueToTree("value")); + + final BidRequest bidRequest = givenBidRequestWithExt(requestExt, + imp -> imp.id("imp1").banner(Banner.builder().w(300).h(250).build()) + .ext(givenImpExt("property", "placement"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + final HttpRequest request = result.getValue().getFirst(); + final BidRequest payload = request.getPayload(); + final Imp imp = payload.getImp().getFirst(); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + + assertThat(request.getMethod()).isEqualTo(HttpMethod.POST); + assertThat(request.getUri()).isEqualTo(ENDPOINT_URL); + assertThat(request.getImpIds()).containsExactly("imp1"); + assertThat(request.getHeaders().get(HttpUtil.ACCEPT_HEADER)).isEqualTo("application/json"); + assertThat(request.getHeaders().get(HttpUtil.CONTENT_TYPE_HEADER)) + .isEqualTo("application/json;charset=utf-8"); + assertThat(request.getHeaders().get(HttpUtil.X_OPENRTB_VERSION_HEADER)).isEqualTo("2.6"); + + assertThat(imp.getTagid()).isEqualTo("placement"); + assertThat(imp.getDisplaymanager()).isEqualTo("HypeLab Prebid Server"); + assertThat(imp.getDisplaymanagerver()).isEqualTo(PBS_VERSION); + assertThat(imp.getExt()).isEqualTo(mapper.valueToTree( + ExtPrebid.of(null, ExtImpHypeLab.of("property", "placement")))); + + assertThat(payload.getExt().getProperty("existing")).isEqualTo(mapper.valueToTree("value")); + assertThat(payload.getExt().getProperty("source")).isEqualTo(mapper.valueToTree("prebid-server")); + assertThat(payload.getExt().getProperty("provider_version")).isEqualTo(mapper.valueToTree(PBS_VERSION)); + assertThat(jacksonMapper.decodeValue(request.getBody(), BidRequest.class)).isEqualTo(payload); + } + + @Test + public void makeHttpRequestsShouldUseUnknownVersionWhenPbsVersionIsBlank() { + // given + given(prebidVersionProvider.getNameVersionRecord()).willReturn(" "); + + // when + final Result>> result = target.makeHttpRequests(givenBidRequest()); + + // then + final BidRequest payload = result.getValue().getFirst().getPayload(); + + assertThat(result.getErrors()).isEmpty(); + assertThat(payload.getImp().getFirst().getDisplaymanagerver()).isEqualTo("unknown"); + assertThat(payload.getExt().getProperty("provider_version")).isEqualTo(mapper.valueToTree("unknown")); + } + + @Test + public void makeHttpRequestsShouldSkipImpWhenExtIsMissing() { + // given + final BidRequest bidRequest = givenBidRequestWithExt(null, imp -> imp.ext(null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .containsExactly(BidderError.badInput("imp impId: unable to unmarshal ext")); + } + + @Test + public void makeHttpRequestsShouldSkipImpWhenBidderExtCanNotBeParsed() { + // given + final BidRequest bidRequest = givenBidRequestWithExt(null, + imp -> imp.ext(mapper.valueToTree(ExtPrebid.of(null, mapper.createArrayNode())))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .containsExactly(BidderError.badInput("imp impId: unable to unmarshal ext.bidder")); + } + + @Test + public void makeHttpRequestsShouldSkipImpWhenRequiredParamsAreBlank() { + // given + final BidRequest bidRequest = givenBidRequestWithExt(null, + imp -> imp.ext(givenImpExt(" ", "placement"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .containsExactly(BidderError.badInput( + "imp impId: property_slug and placement_slug are required")); + } + + @Test + public void makeHttpRequestsShouldSendValidImpsAndReturnErrorsForInvalidImps() { + // given + final BidRequest bidRequest = givenBidRequestWithExt(null, + imp -> imp.id("valid"), + imp -> imp.id("invalid").ext(givenImpExt("property", ""))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getId) + .containsExactly("valid"); + assertThat(result.getErrors()) + .containsExactly(BidderError.badInput( + "imp invalid: property_slug and placement_slug are required")); + } + + @Test + public void makeBidsShouldReturnErrorWhenResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = givenHttpCall(givenBidRequest(), "invalid_json"); + + // 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 makeBidsShouldReturnEmptyBidsWhenResponseIsNull() { + // given + final BidderCall httpCall = givenHttpCall(givenBidRequest(), "null"); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldUseMtypeForBidType() throws JsonProcessingException { + // given + final Bid bannerBid = givenBid(bid -> bid.id("banner").mtype(1)); + final Bid videoBid = givenBid(bid -> bid.id("video").mtype(2)); + final Bid nativeBid = givenBid(bid -> bid.id("native").mtype(4)); + final BidderCall httpCall = givenHttpCall( + givenBidRequest(), + givenBidResponse(bannerBid, videoBid, nativeBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly( + BidderBid.of(bannerBid, BidType.banner, "hypelab", "USD"), + BidderBid.of(videoBid, BidType.video, "hypelab", "USD"), + BidderBid.of(nativeBid, BidType.xNative, "hypelab", "USD")); + } + + @Test + public void makeBidsShouldUseHypeLabBidExtForBidType() throws JsonProcessingException { + // given + final Bid videoBid = givenBid(bid -> bid.ext(givenBidExt("video"))); + final BidderCall httpCall = givenHttpCall( + givenBidRequest(), + givenBidResponse(videoBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(BidderBid.of(videoBid, BidType.video, "hypelab", "USD")); + } + + @Test + public void makeBidsShouldUseVastMarkupForBidType() throws JsonProcessingException { + // given + final Bid videoBid = givenBid(bid -> bid.adm(" ")); + final BidderCall httpCall = givenHttpCall( + givenBidRequest(), + givenBidResponse(videoBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(BidderBid.of(videoBid, BidType.video, "hypelab", "USD")); + } + + @Test + public void makeBidsShouldInferBidTypeFromImp() throws JsonProcessingException { + // given + final Bid nativeBid = givenBid(UnaryOperator.identity()); + final BidRequest bidRequest = givenBidRequestWithExt(null, + imp -> imp.id("impId").banner(null).xNative(Native.builder().build())); + final BidderCall httpCall = givenHttpCall(bidRequest, givenBidResponse(nativeBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(BidderBid.of(nativeBid, BidType.xNative, "hypelab", "USD")); + } + + @Test + public void makeBidsShouldReturnErrorWhenBidTypeCanNotBeInferred() throws JsonProcessingException { + // given + final Bid bid = givenBid(bidBuilder -> bidBuilder.impid("unknown")); + final BidderCall httpCall = givenHttpCall(givenBidRequest(), givenBidResponse(bid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).containsExactly(BidderError.badServerResponse( + "unable to determine media type for bid bidId on imp unknown")); + } + + private static BidRequest givenBidRequest(UnaryOperator... impCustomizers) { + return givenBidRequestWithExt(null, impCustomizers); + } + + private static BidRequest givenBidRequestWithExt(ExtRequest ext, UnaryOperator... impCustomizers) { + final List imps = impCustomizers.length == 0 + ? singletonList(givenImp(UnaryOperator.identity())) + : Arrays.stream(impCustomizers) + .map(HypeLabBidderTest::givenImp) + .toList(); + + return BidRequest.builder() + .id("requestId") + .imp(imps) + .ext(ext) + .build(); + } + + private static Imp givenImp(UnaryOperator impCustomizer) { + return impCustomizer.apply(Imp.builder() + .id("impId") + .banner(Banner.builder().build()) + .ext(givenImpExt("property", "placement"))) + .build(); + } + + private static ObjectNode givenImpExt(String propertySlug, String placementSlug) { + return mapper.valueToTree(ExtPrebid.of(null, ExtImpHypeLab.of(propertySlug, placementSlug))); + } + + private static Bid givenBid(UnaryOperator bidCustomizer) { + return bidCustomizer.apply(Bid.builder() + .id("bidId") + .impid("impId") + .price(BigDecimal.ONE)) + .build(); + } + + private static ObjectNode givenBidExt(String creativeType) { + return mapper.createObjectNode() + .set("hypelab", mapper.createObjectNode().put("creative_type", creativeType)); + } + + private static String givenBidResponse(Bid... bids) throws JsonProcessingException { + return mapper.writeValueAsString(BidResponse.builder() + .cur("USD") + .seatbid(singletonList(SeatBid.builder().seat("hypelab").bid(List.of(bids)).build())) + .build()); + } + + private static BidderCall givenHttpCall(BidRequest bidRequest, String responseBody) { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, responseBody), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/HypeLabTest.java b/src/test/java/org/prebid/server/it/HypeLabTest.java new file mode 100644 index 00000000000..491a02cdc04 --- /dev/null +++ b/src/test/java/org/prebid/server/it/HypeLabTest.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.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 HypeLabTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromHypeLab() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/hypelab-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/hypelab/test-hypelab-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/hypelab/test-hypelab-bid-response.json")))); + + // when + final Response response = responseFor( + "openrtb2/hypelab/test-auction-hypelab-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/hypelab/test-auction-hypelab-response.json", response, + singletonList("hypelab")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-auction-hypelab-request.json b/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-auction-hypelab-request.json new file mode 100644 index 00000000000..c48b1b6e572 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-auction-hypelab-request.json @@ -0,0 +1,28 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "hypelab": { + "property_slug": "test-property", + "placement_slug": "test-placement" + } + } + } + ], + "tmax": 5000, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-auction-hypelab-response.json b/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-auction-hypelab-response.json new file mode 100644 index 00000000000..632136edd2e --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-auction-hypelab-response.json @@ -0,0 +1,47 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "exp": 300, + "price": 0.5, + "adm": "ad", + "adomain": [ + "advertiser.example" + ], + "cid": "test-campaign", + "crid": "test-creative", + "w": 300, + "h": 250, + "ext": { + "curl": "https://api.hypelab.com/click", + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "hypelab" + } + }, + "origbidcpm": 0.5, + "origbidcur": "USD" + }, + "mtype": 1 + } + ], + "seat": "hypelab", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "hypelab": "{{ hypelab.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-hypelab-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-hypelab-bid-request.json new file mode 100644 index 00000000000..81bf93bf681 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-hypelab-bid-request.json @@ -0,0 +1,63 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "tagid": "test-placement", + "displaymanager": "HypeLab Prebid Server", + "displaymanagerver": "${json-unit.any-string}", + "secure": 1, + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "bidder": { + "property_slug": "test-property", + "placement_slug": "test-placement" + } + } + } + ], + "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" + } + }, + "source": "prebid-server", + "provider_version": "${json-unit.any-string}" + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-hypelab-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-hypelab-bid-response.json new file mode 100644 index 00000000000..11dfa80bf40 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/hypelab/test-hypelab-bid-response.json @@ -0,0 +1,28 @@ +{ + "id": "request_id", + "seatbid": [ + { + "seat": "hypelab", + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 0.5, + "adm": "ad", + "adomain": [ + "advertiser.example" + ], + "cid": "test-campaign", + "crid": "test-creative", + "w": 300, + "h": 250, + "mtype": 1, + "ext": { + "curl": "https://api.hypelab.com/click" + } + } + ] + } + ], + "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 fa87311010b..ff964d944bd 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -287,6 +287,8 @@ adapters.huaweiads.extra-info.chineseEndpoint=http://localhost:8090/huaweiads-ex adapters.huaweiads.extra-info.russianEndpoint=http://localhost:8090/huaweiads-exchange-ru adapters.huaweiads.extra-info.europeanEndpoint=http://localhost:8090/huaweiads-exchange-eu adapters.huaweiads.extra-info.asianEndpoint=http://localhost:8090/huaweiads-exchange-as +adapters.hypelab.enabled=true +adapters.hypelab.endpoint=http://localhost:8090/hypelab-exchange adapters.imds.enabled=true adapters.imds.endpoint=http://localhost:8090/imds-exchange adapters.impactify.enabled=true