From 4f2b2dde1e35d016ee359c9f8f79cfdcf0682631 Mon Sep 17 00:00:00 2001 From: tradplus <58809719+tradplus@users.noreply.github.com> Date: Wed, 7 Aug 2024 15:17:27 +0800 Subject: [PATCH 1/3] New Adapter: TradPlus --- .../bidder/tradplus/TradPlusBidder.java | 152 +++++++++++++ .../ext/request/tradplus/ExtImpTradPlus.java | 14 ++ .../bidder/TradPlusBidderConfiguration.java | 41 ++++ .../resources/bidder-config/tradplus.yaml | 11 + .../static/bidder-params/tradplus.json | 21 ++ .../bidder/tradplus/TradPlusBidderTest.java | 215 ++++++++++++++++++ .../org/prebid/server/it/TradPlusTest.java | 29 +++ .../test-auction-tradplus-request.json | 24 ++ .../test-auction-tradplus-response.json | 39 ++++ .../tradplus/test-tradplus-bid-request.json | 50 ++++ .../tradplus/test-tradplus-bid-response.json | 21 ++ .../server/it/test-application.properties | 2 + 12 files changed, 619 insertions(+) create mode 100644 src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java create mode 100644 src/main/java/org/prebid/server/proto/openrtb/ext/request/tradplus/ExtImpTradPlus.java create mode 100644 src/main/java/org/prebid/server/spring/config/bidder/TradPlusBidderConfiguration.java create mode 100644 src/main/resources/bidder-config/tradplus.yaml create mode 100644 src/main/resources/static/bidder-params/tradplus.json create mode 100644 src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java create mode 100644 src/test/java/org/prebid/server/it/TradPlusTest.java create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-auction-tradplus-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-auction-tradplus-response.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-tradplus-bid-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-tradplus-bid-response.json diff --git a/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java b/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java new file mode 100644 index 00000000000..67de77c91ff --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java @@ -0,0 +1,152 @@ +package org.prebid.server.bidder.tradplus; + +import com.fasterxml.jackson.core.JsonProcessingException; +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.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.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.ObjectUtils; +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.model.UpdateResult; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.tradplus.ExtImpTradPlus; +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.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.stream.IntStream; + +public class TradPlusBidder implements Bidder { + + private static final TypeReference> EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private static final String ZONE_ID = "{{ZoneID}}"; + private static final String ACCOUNT_ID = "{{AccountID}}"; + + private final String endpointUrl; + private final JacksonMapper mapper; + + public TradPlusBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest bidRequest) { + final Map> extToImps = new HashMap<>(); + for (Imp imp : bidRequest.getImp()) { + try { + final ExtImpTradPlus extImpTradPlus = parseAndValidateImpExt(imp.getExt()); + extToImps.computeIfAbsent(extImpTradPlus, ext -> new ArrayList<>()).add(imp); + } catch (PreBidException e) { + return Result.withError(BidderError.badInput(e.getMessage())); + } + } + + final List> httpRequests = extToImps.entrySet().stream() + .map(entry -> makeHttpRequest(entry.getKey(), entry.getValue(), bidRequest)) + .toList(); + + return Result.of(httpRequests, Collections.emptyList()); + } + + private ExtImpTradPlus parseAndValidateImpExt(ObjectNode extNode) { + final ExtImpTradPlus extImpTradPlus; + try { + extImpTradPlus = mapper.mapper().convertValue(extNode, EXT_TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException(e.getMessage()); + } + if (StringUtils.isBlank(extImpTradPlus.getAccountId())) { + throw new PreBidException("Invalid/Missing AccountID"); + } + + return extImpTradPlus; + } + + private HttpRequest makeHttpRequest(ExtImpTradPlus extImpTradPlus, List imps, + BidRequest bidRequest) { + final String uri = endpointUrl + .replace(ZONE_ID, extImpTradPlus.getZoneId()) + .replace(ACCOUNT_ID, extImpTradPlus.getAccountId()); + + final BidRequest outgoingRequest = bidRequest.toBuilder().imp(removeFirstImpExt(imps)).build(); + + return BidderUtil.defaultRequest(outgoingRequest, uri, mapper); + } + + private static List removeFirstImpExt(List imps) { + return IntStream.range(0, imps.size()) + .mapToObj(impIndex -> impIndex == 0 + ? imps.get(impIndex).toBuilder().ext(null).build() + : imps.get(impIndex)) + .toList(); + } + + @Override + public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + try { + final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); + return Result.of(extractBids(bidResponse, httpCall.getRequest().getPayload()), Collections.emptyList()); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private static List extractBids(BidResponse bidResponse, BidRequest bidRequest) { + return bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid()) + ? Collections.emptyList() + : bidsFromResponse(bidResponse, bidRequest.getImp()); + } + + private static List bidsFromResponse(BidResponse bidResponse, List imps) { + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(Collection::stream) + .map(bid -> BidderBid.of(bid, getBidType(bid.getImpid(), imps), bidResponse.getCur())) + .toList(); + } + + private static BidType getBidType(String impId, List imps) { + for (Imp imp : imps) { + if (imp.getId().equals(impId)) { + if (imp.getVideo() != null) { + return BidType.video; + } + if (imp.getXNative() != null) { + return BidType.xNative; + } + return BidType.banner; + } + } + return BidType.banner; + } + +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/tradplus/ExtImpTradPlus.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/tradplus/ExtImpTradPlus.java new file mode 100644 index 00000000000..5f20441f9cd --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/tradplus/ExtImpTradPlus.java @@ -0,0 +1,14 @@ +package org.prebid.server.proto.openrtb.ext.request.tradplus; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpTradPlus { + + @JsonProperty("accountId") + String accountId; + + @JsonProperty("zoneId") + String zoneId; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/TradPlusBidderConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/TradPlusBidderConfiguration.java new file mode 100644 index 00000000000..8bd04ffd8f3 --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/TradPlusBidderConfiguration.java @@ -0,0 +1,41 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.tradplus.TradPlusBidder; +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 javax.validation.constraints.NotBlank; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/tradplus.yaml", factory = YamlPropertySourceFactory.class) +public class TradPlusBidderConfiguration { + + private static final String BIDDER_NAME = "tradplus"; + + @Bean("tradplusConfigurationProperties") + @ConfigurationProperties("adapters.tradplus") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps tradplusBidderDeps(BidderConfigurationProperties tradplusConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(tradplusConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new TradPlusBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/tradplus.yaml b/src/main/resources/bidder-config/tradplus.yaml new file mode 100644 index 00000000000..9644f025c45 --- /dev/null +++ b/src/main/resources/bidder-config/tradplus.yaml @@ -0,0 +1,11 @@ +adapters: + tradplus: + endpoint: "https://{{ZoneID}}adx.tradplusad.com/{{AccountID}}/pserver" + meta-info: + maintainer-email: "tpxcontact@tradplus.com" + app-media-types: + - banner + - video + - native + supported-vendors: + vendor-id: 0 diff --git a/src/main/resources/static/bidder-params/tradplus.json b/src/main/resources/static/bidder-params/tradplus.json new file mode 100644 index 00000000000..deae1392d1d --- /dev/null +++ b/src/main/resources/static/bidder-params/tradplus.json @@ -0,0 +1,21 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "TradPlus Adapter Params", + "description": "A schema which validates params accepted by the TradPlus adapter", + "type": "object", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID", + "minLength": 1 + }, + "zoneId": { + "type": "string", + "description": "Zone ID" + } + }, + "required": [ + "accountId", + "zoneId" + ] +} diff --git a/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java b/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java new file mode 100644 index 00000000000..f8c4a80c235 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java @@ -0,0 +1,215 @@ +package org.prebid.server.bidder.tradplus; + + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Native; +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.tradplus.ExtImpTradPlus; + +import java.util.List; +import java.util.function.Function; + +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.prebid.server.proto.openrtb.ext.response.BidType.banner; +import static org.prebid.server.proto.openrtb.ext.response.BidType.video; +import static org.prebid.server.proto.openrtb.ext.response.BidType.xNative; + +public class TradPlusBidderTest extends VertxTest { + + private static final String ENDPOINT_TEMPLATE = "http://{{ZoneID}}/openrtb2?sid={{AccountID}}"; + + private final TradPlusBidder target = new TradPlusBidder(ENDPOINT_TEMPLATE, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException().isThrownBy(() -> new TradPlusBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldCreateCorrectURL() { + // given + final BidRequest bidRequest = givenBidRequest(ExtImpTradPlus.of("accountId", "zoneId")); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + assertThat(result.getValue().getFirst().getUri()).isEqualTo("http://zoneId/openrtb2?sid=accountId"); + } + + @Test + public void makeHttpRequestsShouldReturnErrorIfImpExtCouldNotBeParsed() { + // given + final BidRequest bidRequest = givenBidRequest(mapper.createArrayNode()); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1); + assertThat(result.getErrors().getFirst().getMessage()).startsWith("Cannot deserialize value"); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenSourceIdIsNull() { + // given + final BidRequest bidRequest = givenBidRequest(ExtImpTradPlus.of(null, "zoneId")); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badInput("Invalid/Missing AccountID")); + } + + @Test + public void makeBidsShouldReturnErrorIfResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = givenHttpCall(null, "invalid"); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).hasSize(1); + assertThat(result.getErrors().getFirst().getMessage()).startsWith("Failed to decode: Unrecognized token"); + assertThat(result.getErrors().getFirst().getType()).isEqualTo(BidderError.Type.bad_server_response); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnEmptyListIfBidResponseIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall(null, + mapper.writeValueAsString(null)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnEmptyListIfBidResponseSeatBidIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall(null, + mapper.writeValueAsString(BidResponse.builder().build())); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnBannerBidByDeault() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + BidRequest.builder() + .imp(singletonList(Imp.builder().id("123").build())) + .build(), + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123")))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .containsOnly(BidderBid.of(Bid.builder().impid("123").build(), banner, "USD")); + } + + @Test + public void makeBidsShouldReturnVideoBidIfVideoIsPresent() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + BidRequest.builder() + .imp(singletonList(Imp.builder() + .video(Video.builder().build()) + .id("123") + .build())) + .build(), + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123")))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .containsOnly(BidderBid.of(Bid.builder().impid("123").build(), video, "USD")); + } + + @Test + public void makeBidsShouldReturnNativeBidIfNativeIsPresent() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + BidRequest.builder() + .imp(singletonList(Imp.builder() + .xNative(Native.builder().build()) + .id("123") + .build())) + .build(), + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123")))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .containsOnly(BidderBid.of(Bid.builder().impid("123").build(), xNative, "USD")); + } + + private static BidRequest givenBidRequest(Object extImpDatablocks) { + return BidRequest.builder() + .imp(singletonList(Imp.builder() + .ext(mapper.valueToTree(ExtPrebid.of(null, extImpDatablocks))) + .build())) + .build(); + } + + private static BidResponse givenBidResponse(Function bidCustomizer) { + return BidResponse.builder() + .cur("USD") + .seatbid(singletonList(SeatBid.builder() + .bid(singletonList(bidCustomizer.apply(Bid.builder()).build())) + .build())) + .build(); + } + + private static BidderCall givenHttpCall(BidRequest bidRequest, String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, body), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/TradPlusTest.java b/src/test/java/org/prebid/server/it/TradPlusTest.java new file mode 100644 index 00000000000..20af8398e9d --- /dev/null +++ b/src/test/java/org/prebid/server/it/TradPlusTest.java @@ -0,0 +1,29 @@ +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.*; +import static java.util.Collections.singletonList; + +public class TradPlusTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromTradPlus() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/tradplus-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/tradplus/test-tradplus-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/tradplus/test-tradplus-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/tradplus/test-auction-tradplus-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/tradplus/test-auction-tradplus-response.json", response, singletonList("tradplus")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-auction-tradplus-request.json b/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-auction-tradplus-request.json new file mode 100644 index 00000000000..bea2848cd57 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-auction-tradplus-request.json @@ -0,0 +1,24 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "tradplus": { + "accountId": "accountTestID", + "zoneId": "" + } + } + } + ], + "tmax": 5000, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-auction-tradplus-response.json b/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-auction-tradplus-response.json new file mode 100644 index 00000000000..9a101b0e81e --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-auction-tradplus-response.json @@ -0,0 +1,39 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "mtype": 1, + "adm": "adm001", + "adid": "adid001", + "cid": "cid001", + "crid": "crid001", + "w": 300, + "h": 250, + "ext": { + "prebid": { + "type": "banner" + }, + "origbidcpm": 3.33 + } + } + ], + "seat": "tradplus", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "tradplus": "{{ tradplus.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-tradplus-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-tradplus-bid-request.json new file mode 100644 index 00000000000..669311b0146 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-tradplus-bid-request.json @@ -0,0 +1,50 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "secure": 1 + } + ], + "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": { + "ext": { + "gdpr": 0 + } + }, + "ext": { + "prebid": { + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "endpoint": "/openrtb2/auction" + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-tradplus-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-tradplus-bid-response.json new file mode 100644 index 00000000000..891438f2401 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/tradplus/test-tradplus-bid-response.json @@ -0,0 +1,21 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "mtype": 1, + "adid": "adid001", + "crid": "crid001", + "cid": "cid001", + "adm": "adm001", + "h": 250, + "w": 300 + } + ] + } + ] +} 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 2a06064defa..c3d7486a718 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -421,6 +421,8 @@ adapters.telaria.enabled=true adapters.telaria.endpoint=http://localhost:8090/telaria-exchange/ adapters.theadx.enabled=true adapters.theadx.endpoint=http://localhost:8090/theadx-exchange +adapters.tradplus.enabled=true +adapters.tradplus.endpoint=http://localhost:8090/tradplus-exchange adapters.triplelift.enabled=true adapters.triplelift.endpoint=http://localhost:8090/triplelift-exchange adapters.tripleliftnative.enabled=true From 6ee24b5b93b9a24ec7869707c661c5d7873513bf Mon Sep 17 00:00:00 2001 From: tradplus <58809719+tradplus@users.noreply.github.com> Date: Wed, 7 Aug 2024 16:47:26 +0800 Subject: [PATCH 2/3] TradPlus: Update bidder --- .../org/prebid/server/bidder/tradplus/TradPlusBidder.java | 7 ------- .../prebid/server/bidder/tradplus/TradPlusBidderTest.java | 3 +-- src/test/java/org/prebid/server/it/TradPlusTest.java | 5 ++++- 3 files changed, 5 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java b/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java index 67de77c91ff..d80306fe5aa 100644 --- a/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java +++ b/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java @@ -1,18 +1,12 @@ package org.prebid.server.bidder.tradplus; -import com.fasterxml.jackson.core.JsonProcessingException; 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.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.apache.commons.collections4.CollectionUtils; -import org.apache.commons.lang3.ObjectUtils; import org.apache.commons.lang3.StringUtils; import org.prebid.server.bidder.Bidder; import org.prebid.server.bidder.model.BidderBid; @@ -23,7 +17,6 @@ import org.prebid.server.exception.PreBidException; import org.prebid.server.json.DecodeException; import org.prebid.server.json.JacksonMapper; -import org.prebid.server.model.UpdateResult; import org.prebid.server.proto.openrtb.ext.ExtPrebid; import org.prebid.server.proto.openrtb.ext.request.tradplus.ExtImpTradPlus; import org.prebid.server.proto.openrtb.ext.response.BidType; diff --git a/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java b/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java index f8c4a80c235..ea68e3b93f5 100644 --- a/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java +++ b/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java @@ -1,6 +1,5 @@ package org.prebid.server.bidder.tradplus; - import com.fasterxml.jackson.core.JsonProcessingException; import com.iab.openrtb.request.BidRequest; import com.iab.openrtb.request.Imp; @@ -30,7 +29,7 @@ import static org.prebid.server.proto.openrtb.ext.response.BidType.video; import static org.prebid.server.proto.openrtb.ext.response.BidType.xNative; -public class TradPlusBidderTest extends VertxTest { +public class TradPlusBidderTest extends VertxTest { private static final String ENDPOINT_TEMPLATE = "http://{{ZoneID}}/openrtb2?sid={{AccountID}}"; diff --git a/src/test/java/org/prebid/server/it/TradPlusTest.java b/src/test/java/org/prebid/server/it/TradPlusTest.java index 20af8398e9d..8893ebed482 100644 --- a/src/test/java/org/prebid/server/it/TradPlusTest.java +++ b/src/test/java/org/prebid/server/it/TradPlusTest.java @@ -7,7 +7,10 @@ import java.io.IOException; -import static com.github.tomakehurst.wiremock.client.WireMock.*; +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 TradPlusTest extends IntegrationTest { From cef48a159ad3f25775c0af00dc22700b269911cc Mon Sep 17 00:00:00 2001 From: tradplus <58809719+tradplus@users.noreply.github.com> Date: Thu, 10 Oct 2024 10:36:28 +0800 Subject: [PATCH 3/3] feat: change some code by reviewer commment --- .../bidder/tradplus/TradPlusBidder.java | 36 +++++++-------- .../bidder/tradplus/TradPlusBidderTest.java | 44 ++++++++++++++++--- 2 files changed, 56 insertions(+), 24 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java b/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java index d80306fe5aa..cb899b33fa6 100644 --- a/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java +++ b/src/main/java/org/prebid/server/bidder/tradplus/TradPlusBidder.java @@ -30,7 +30,6 @@ import java.util.List; import java.util.Map; import java.util.Objects; -import java.util.stream.IntStream; public class TradPlusBidder implements Bidder { @@ -52,34 +51,35 @@ public TradPlusBidder(String endpointUrl, JacksonMapper mapper) { @Override public Result>> makeHttpRequests(BidRequest bidRequest) { final Map> extToImps = new HashMap<>(); - for (Imp imp : bidRequest.getImp()) { - try { - final ExtImpTradPlus extImpTradPlus = parseAndValidateImpExt(imp.getExt()); - extToImps.computeIfAbsent(extImpTradPlus, ext -> new ArrayList<>()).add(imp); - } catch (PreBidException e) { - return Result.withError(BidderError.badInput(e.getMessage())); - } + try { + final ExtImpTradPlus extImpTradPlus = parseImpExt(bidRequest.getImp().getFirst().getExt()); + validateImpExt(extImpTradPlus); + extToImps.computeIfAbsent(extImpTradPlus, ext -> new ArrayList<>()).add(bidRequest.getImp().getFirst()); + } catch (PreBidException e) { + return Result.withError(BidderError.badInput(e.getMessage())); } final List> httpRequests = extToImps.entrySet().stream() .map(entry -> makeHttpRequest(entry.getKey(), entry.getValue(), bidRequest)) .toList(); - return Result.of(httpRequests, Collections.emptyList()); + return Result.withValues(httpRequests); } - private ExtImpTradPlus parseAndValidateImpExt(ObjectNode extNode) { + private ExtImpTradPlus parseImpExt(ObjectNode extNode) { final ExtImpTradPlus extImpTradPlus; try { extImpTradPlus = mapper.mapper().convertValue(extNode, EXT_TYPE_REFERENCE).getBidder(); } catch (IllegalArgumentException e) { throw new PreBidException(e.getMessage()); } + return extImpTradPlus; + } + + private void validateImpExt(ExtImpTradPlus extImpTradPlus) { if (StringUtils.isBlank(extImpTradPlus.getAccountId())) { throw new PreBidException("Invalid/Missing AccountID"); } - - return extImpTradPlus; } private HttpRequest makeHttpRequest(ExtImpTradPlus extImpTradPlus, List imps, @@ -94,11 +94,8 @@ private HttpRequest makeHttpRequest(ExtImpTradPlus extImpTradPlus, L } private static List removeFirstImpExt(List imps) { - return IntStream.range(0, imps.size()) - .mapToObj(impIndex -> impIndex == 0 - ? imps.get(impIndex).toBuilder().ext(null).build() - : imps.get(impIndex)) - .toList(); + imps.set(0, imps.getFirst().toBuilder().ext(null).build()); + return imps; } @Override @@ -106,7 +103,7 @@ public Result> makeBids(BidderCall httpCall, BidRequ try { final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); return Result.of(extractBids(bidResponse, httpCall.getRequest().getPayload()), Collections.emptyList()); - } catch (DecodeException e) { + } catch (DecodeException | PreBidException e) { return Result.withError(BidderError.badServerResponse(e.getMessage())); } } @@ -139,7 +136,8 @@ private static BidType getBidType(String impId, List imps) { return BidType.banner; } } - return BidType.banner; + throw new PreBidException("Invalid bid imp ID #%s does not match any imp IDs from the original bid request" + .formatted(impId)); } } diff --git a/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java b/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java index ea68e3b93f5..85c7ecb4a1b 100644 --- a/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java +++ b/src/test/java/org/prebid/server/bidder/tradplus/TradPlusBidderTest.java @@ -1,6 +1,7 @@ package org.prebid.server.bidder.tradplus; import com.fasterxml.jackson.core.JsonProcessingException; +import com.iab.openrtb.request.Banner; import com.iab.openrtb.request.BidRequest; import com.iab.openrtb.request.Imp; import com.iab.openrtb.request.Native; @@ -43,7 +44,7 @@ public void creationShouldFailOnInvalidEndpointUrl() { @Test public void makeHttpRequestsShouldCreateCorrectURL() { // given - final BidRequest bidRequest = givenBidRequest(ExtImpTradPlus.of("accountId", "zoneId")); + final BidRequest bidRequest = givenBidRequest(ExtImpTradPlus.of("testAccountId", "testZoneId")); // when final Result>> result = target.makeHttpRequests(bidRequest); @@ -51,7 +52,7 @@ public void makeHttpRequestsShouldCreateCorrectURL() { // then assertThat(result.getErrors()).isEmpty(); assertThat(result.getValue()).hasSize(1); - assertThat(result.getValue().getFirst().getUri()).isEqualTo("http://zoneId/openrtb2?sid=accountId"); + assertThat(result.getValue().getFirst().getUri()).isEqualTo("http://testZoneId/openrtb2?sid=testAccountId"); } @Test @@ -69,9 +70,23 @@ public void makeHttpRequestsShouldReturnErrorIfImpExtCouldNotBeParsed() { } @Test - public void makeHttpRequestsShouldReturnErrorWhenSourceIdIsNull() { + public void makeHttpRequestsShouldReturnErrorWhenAccountIdIsNull() { // given - final BidRequest bidRequest = givenBidRequest(ExtImpTradPlus.of(null, "zoneId")); + final BidRequest bidRequest = givenBidRequest(ExtImpTradPlus.of(null, "testZoneId")); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badInput("Invalid/Missing AccountID")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenAccountIdIsBlank() { + // given + final BidRequest bidRequest = givenBidRequest(ExtImpTradPlus.of(" ", "testZoneId")); // when final Result>> result = target.makeHttpRequests(bidRequest); @@ -126,7 +141,26 @@ public void makeBidsShouldReturnEmptyListIfBidResponseSeatBidIsNull() throws Jso } @Test - public void makeBidsShouldReturnBannerBidByDeault() throws JsonProcessingException { + public void makeBidsShouldReturnErrorWhenBidImpIdIsNotPresent() throws JsonProcessingException { + // given + final BidderCall bidderCall = givenHttpCall( + BidRequest.builder() + .imp(singletonList(Imp.builder().id("123").banner(Banner.builder().build()).build())) + .build(), + mapper.writeValueAsString(givenBidResponse(bidBuilder -> bidBuilder.impid("wrongBlock")))); + + // when + final Result> result = target.makeBids(bidderCall, null); + + // then + assertThat(result.getErrors()).containsExactly( + BidderError.badServerResponse( + "Invalid bid imp ID #wrongBlock does not match any imp IDs from the original bid request")); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnBannerBidByDefault() throws JsonProcessingException { // given final BidderCall httpCall = givenHttpCall( BidRequest.builder()