From a376abd7b9a7b070cfb9763a538109b93273752e Mon Sep 17 00:00:00 2001 From: Marc-Enzo Bonnafon Date: Mon, 28 Apr 2025 17:43:09 +0100 Subject: [PATCH 1/7] Port Mobkoi: New Adapter --- .../server/bidder/mobkoi/MobkoiBidder.java | 150 ++++++++++ .../ext/request/mobkoi/ExtImpMobkoi.java | 17 ++ .../config/bidder/MobkoiConfiguration.java | 41 +++ src/main/resources/bidder-config/mobkoi.yaml | 10 + .../static/bidder-params/mobkoi.json | 17 ++ .../bidder/mobkoi/MobkoiBidderTest.java | 263 ++++++++++++++++++ .../java/org/prebid/server/it/MobkoiTest.java | 34 +++ .../mobkoi/test-auction-mobkoi-request.json | 23 ++ .../mobkoi/test-auction-mobkoi-response.json | 40 +++ .../mobkoi/test-mobkoi-bid-request.json | 55 ++++ .../mobkoi/test-mobkoi-bid-response.json | 18 ++ .../server/it/test-application.properties | 2 + 12 files changed, 670 insertions(+) create mode 100644 src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java create mode 100644 src/main/java/org/prebid/server/proto/openrtb/ext/request/mobkoi/ExtImpMobkoi.java create mode 100644 src/main/java/org/prebid/server/spring/config/bidder/MobkoiConfiguration.java create mode 100644 src/main/resources/bidder-config/mobkoi.yaml create mode 100644 src/main/resources/static/bidder-params/mobkoi.json create mode 100644 src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java create mode 100644 src/test/java/org/prebid/server/it/MobkoiTest.java create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-auction-mobkoi-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-auction-mobkoi-response.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-response.json diff --git a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java new file mode 100644 index 00000000000..ab70a80b166 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java @@ -0,0 +1,150 @@ +package org.prebid.server.bidder.mobkoi; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.apache.commons.collections4.CollectionUtils; +import org.prebid.server.bidder.Bidder; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.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.mobkoi.ExtImpMobkoi; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Objects; +import java.util.Optional; +import java.util.stream.Collectors; + +public class MobkoiBidder implements Bidder { + + private static final TypeReference> MOBKOI_EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private final String endpointUrl; + private final JacksonMapper mapper; + + public MobkoiBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest bidRequest) { + + final Imp firstImp = bidRequest.getImp().stream().findFirst().orElse(null); + if (firstImp == null) { + return Result.withError(BidderError.badInput("No impression provided")); + } + + final ExtImpMobkoi extImpMobkoi; + try { + extImpMobkoi = parseExtImp(firstImp); + } catch (PreBidException e) { + return Result.withError(BidderError.badInput(e.getMessage())); + } + + if (extImpMobkoi.getPlacementId() == null) { + return Result.withError(BidderError.badInput("placementId should not be null")); + } + + final String selectedEndpointUrl = Optional.ofNullable(extImpMobkoi.getAdServerBaseUrl()) + .filter(this::validCustomEndpointUrl) + .orElse(endpointUrl); + + final List modifiedImps = List.of(modifyImp(firstImp, extImpMobkoi)); + + return Result.withValue(BidderUtil.defaultRequest( + modifyBidRequest(bidRequest, modifiedImps), + selectedEndpointUrl, + mapper)); + } + + private ExtImpMobkoi parseExtImp(Imp imp) { + try { + return mapper.mapper().convertValue(imp.getExt(), MOBKOI_EXT_TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException( + "Invalid imp.ext for impression id %s. Error Information: %s" + .formatted(imp.getId(), e.getMessage())); + } + } + + private boolean validCustomEndpointUrl(String customUrl) { + try { + HttpUtil.validateUrl(Objects.requireNonNull(customUrl)); + return true; + } catch (IllegalArgumentException | NullPointerException e) { + return false; + } + } + + private Imp modifyImp(Imp imp, ExtImpMobkoi extImpMobkoi) { + final ObjectNode ext = mapper.mapper().createObjectNode(); + ext.set("bidder", mapper.mapper().valueToTree(extImpMobkoi)); + return imp.toBuilder().ext(ext).build(); + } + + private static BidRequest modifyBidRequest(BidRequest bidRequest, List imps) { + return bidRequest.toBuilder().imp(imps).build(); + } + + @Override + public final Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + try { + final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); + return Result.withValues(extractBids(bidResponse)); + } catch (DecodeException | PreBidException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private static List extractBids(BidResponse bidResponse) { + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + return bidsFromResponse(bidResponse); + } + + private static List bidsFromResponse(BidResponse bidResponse) { + return bidResponse.getSeatbid() + .stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(Collection::stream) + .map(bid -> BidderBid.of(bid, getBidType(bid), bidResponse.getCur())) + .collect(Collectors.toList()); + } + + private static BidType getBidType(Bid bid) { + final Integer markupType = bid.getMtype(); + if (markupType == null) { + throw new PreBidException("Missing mediaType for bid: " + bid.getId()); + } + + // markupType = 1 is a banner + if (markupType != 1) { + throw new PreBidException( + "Unsupported bid mediaType: %s for impression: %s" + .formatted(markupType, bid.getImpid())); + } + + return BidType.banner; + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/mobkoi/ExtImpMobkoi.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/mobkoi/ExtImpMobkoi.java new file mode 100644 index 00000000000..0d5ad97fc90 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/mobkoi/ExtImpMobkoi.java @@ -0,0 +1,17 @@ +package org.prebid.server.proto.openrtb.ext.request.mobkoi; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +/** + * Defines the contract for bidrequest.imp[i].ext.mobkoi + */ +@Value(staticConstructor = "of") +public class ExtImpMobkoi { + + @JsonProperty("placementId") + String placementId; + + @JsonProperty("adServerBaseUrl") + String adServerBaseUrl; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/MobkoiConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/MobkoiConfiguration.java new file mode 100644 index 00000000000..d706c06a2ec --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/MobkoiConfiguration.java @@ -0,0 +1,41 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.mobkoi.MobkoiBidder; +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/mobkoi.yaml", factory = YamlPropertySourceFactory.class) +public class MobkoiConfiguration { + + private static final String BIDDER_NAME = "mobkoi"; + + @Bean("mobkoiConfigurationProperties") + @ConfigurationProperties("adapters.mobkoi") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps mobkoiBidderDeps(BidderConfigurationProperties mobkoiConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(mobkoiConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new MobkoiBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/mobkoi.yaml b/src/main/resources/bidder-config/mobkoi.yaml new file mode 100644 index 00000000000..00de3d8fb76 --- /dev/null +++ b/src/main/resources/bidder-config/mobkoi.yaml @@ -0,0 +1,10 @@ +adapters: + mobkoi: + endpoint: "https://pbs.maximus.mobkoi.com/bid" + meta-info: + maintainer-email: platformteam@mobkoi.com + app-media-types: + site-media-types: + - banner + supported-vendors: + vendor-id: 898 diff --git a/src/main/resources/static/bidder-params/mobkoi.json b/src/main/resources/static/bidder-params/mobkoi.json new file mode 100644 index 00000000000..8286229b035 --- /dev/null +++ b/src/main/resources/static/bidder-params/mobkoi.json @@ -0,0 +1,17 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Mobkoi Adapter Params", + "description": "A schema which validates params accepted by the Mobkoi adapter", + "type": "object", + "properties": { + "placementId": { + "type": "string", + "description": "Placement ID" + }, + "adServerBaseUrl": { + "type": "string", + "description": "Mobkoi's ad server url", + "pattern": "^https?://[^.]+\\.mobkoi\\.com$" + } + } +} diff --git a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java new file mode 100644 index 00000000000..90f5e1fbb81 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java @@ -0,0 +1,263 @@ +package org.prebid.server.bidder.mobkoi; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.junit.jupiter.api.Test; +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.VertxTest; +import org.prebid.server.proto.openrtb.ext.request.mobkoi.ExtImpMobkoi; + +import java.util.List; +import java.util.function.UnaryOperator; + +import static java.util.Collections.emptyList; +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.bidder.model.BidderError.badInput; +import static org.prebid.server.proto.openrtb.ext.response.BidType.banner; + +public class MobkoiBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://test.endpoint.com"; + + private final MobkoiBidder target = new MobkoiBidder(ENDPOINT_URL, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException().isThrownBy(() -> new MobkoiBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenRequestHasNoImpression() { + // given + final BidRequest bidRequest = BidRequest.builder().imp(emptyList()).build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).containsExactly(badInput("No impression provided")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenRequestHasInvalidExtImpression() { + // given + final ObjectNode invalidExt = mapper.valueToTree(ExtPrebid.of(null, mapper.createArrayNode())); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(invalidExt)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1).first() + .satisfies(error -> { + assertThat(error.getMessage()) + .startsWith("Invalid imp.ext for impression id imp_id. Error Information:"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + }); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenRequestHasMissingPlacementId() { + // given + final ObjectNode mobkoiExt = impExt(null, null); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).containsExactly(badInput("placementId should not be null")); + } + + @Test + public void makeHttpRequestsShouldUseConstructorEndpointWhenNoCustomEndpointIsDefinedInMobkoiExtension() { + // given + final ObjectNode mobkoiExt = impExt("pid", null); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + + // when + final Result>> results = target.makeHttpRequests(bidRequest); + + // then + assertThat(results.getValue()).extracting(HttpRequest::getUri).containsExactly("https://test.endpoint.com"); + assertThat(results.getErrors()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldConstructorEndpointWhenTheCustomIsInvalidInMobkoiExtension() { + // given + final ObjectNode mobkoiExt = impExt("pid", "invalid-URI"); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).extracting(HttpRequest::getUri).containsExactly("https://test.endpoint.com"); + assertThat(result.getErrors()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldUseCustomEndpointWhenDefinedInMobkoiExtension() { + // given + final ObjectNode mobkoiExt = impExt("pid", "https://custom.endpoint.com"); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).extracting(HttpRequest::getUri).containsExactly("https://custom.endpoint.com"); + assertThat(result.getErrors()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldCreateTheMobkoiExtensionCorrectly() throws Exception { + // given + final ObjectNode mobkoiExt = impExt("pid", null); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) + .flatExtracting(BidRequest::getImp) + .extracting(imp -> imp.getExt().get("bidder")) + .containsExactly(mapper.valueToTree(ExtImpMobkoi.of("pid", null))); + } + + @Test + public void makeBidsShouldReturnEmptyListIfBidResponseIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall(mapper.writeValueAsString(null)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnErrorIfResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = givenHttpCall("invalid"); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getMessage()).startsWith("Failed to decode: Unrecognized token 'invalid':"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + }); + } + + @Test + public void makeBidsShouldReturnEmptyListIfBidResponseSeatBidIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall(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 makeBidsShouldReturnBannerBid() throws JsonProcessingException { + // given + final BidResponse bannerBidResponse = givenBidResponse(bidBuilder -> bidBuilder.mtype(1).impid("123")); + final BidderCall httpCall = givenHttpCall(mapper.writeValueAsString(bannerBidResponse)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .containsExactly(BidderBid.of(Bid.builder().mtype(1).impid("123").build(), banner, "USD")); + } + + @Test + public void makeBidsShouldThrowErrorWhenMediaTypeIsMissing() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + mapper.writeValueAsString(givenBidResponse(bidBuilder -> bidBuilder.impid("123")))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badServerResponse("Missing mediaType for bid: null")); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldThrowErrorWhenMediaTypeIsUnsupported() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + mapper.writeValueAsString(givenBidResponse(bidBuilder -> bidBuilder.mtype(2).impid("imp_id")))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .containsOnly(BidderError.badServerResponse("Unsupported bid mediaType: 2 for impression: imp_id")); + } + + private static BidRequest givenBidRequest(UnaryOperator impModifier) { + return BidRequest.builder() + .imp(singletonList(givenImp(impModifier))) + .build(); + } + + private static Imp givenImp(UnaryOperator impCustomizer) { + return impCustomizer.apply(Imp.builder().id("imp_id").ext(impExt("placementIdValue", null))).build(); + } + + private static ObjectNode impExt(String placementId, String adServerBaseUrl) { + return mapper.valueToTree(ExtPrebid.of(null, ExtImpMobkoi.of(placementId, adServerBaseUrl))); + } + + private static BidResponse givenBidResponse(UnaryOperator bidCustomizer) { + return BidResponse.builder() + .cur("USD") + .seatbid(singletonList(SeatBid.builder() + .bid(singletonList(bidCustomizer.apply(Bid.builder()).build())) + .build())) + .build(); + } + + private static BidderCall givenHttpCall(String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(null).build(), + HttpResponse.of(200, null, body), + null); + } +} + diff --git a/src/test/java/org/prebid/server/it/MobkoiTest.java b/src/test/java/org/prebid/server/it/MobkoiTest.java new file mode 100644 index 00000000000..1246f6d82f2 --- /dev/null +++ b/src/test/java/org/prebid/server/it/MobkoiTest.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 MobkoiTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromMobkoi() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/mobkoi-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/mobkoi/test-mobkoi-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/mobkoi/test-mobkoi-bid-response.json")))); + + // when + final Response response = responseFor( + "openrtb2/mobkoi/test-auction-mobkoi-request.json", + Endpoint.openrtb2_auction + ); + + // then + assertJsonEquals("openrtb2/mobkoi/test-auction-mobkoi-response.json", response, singletonList("mobkoi")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-auction-mobkoi-request.json b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-auction-mobkoi-request.json new file mode 100644 index 00000000000..42d9bb8580c --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-auction-mobkoi-request.json @@ -0,0 +1,23 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "mobkoi": { + "placementId": "999999" + } + } + } + ], + "tmax": 5000, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-auction-mobkoi-response.json b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-auction-mobkoi-response.json new file mode 100644 index 00000000000..a791e359cb7 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-auction-mobkoi-response.json @@ -0,0 +1,40 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "exp": 300, + "mtype": 1, + "price": 0.01, + "adm": "
", + "cid": "test_cid", + "crid": "test_banner_crid", + "ext": { + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "mobkoi" + } + }, + "origbidcpm": 0.01 + } + } + ], + "group": 0, + "seat": "mobkoi" + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "mobkoi": "{{ mobkoi.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json new file mode 100644 index 00000000000..a0e27c9d2ef --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json @@ -0,0 +1,55 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "secure": 1, + "ext": { + "bidder": { + "placementId": "999999" + } + } + } + ], + "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" + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "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/mobkoi/test-mobkoi-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-response.json new file mode 100644 index 00000000000..34c58bd8a52 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-response.json @@ -0,0 +1,18 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "adm": "
", + "crid": "test_banner_crid", + "cid": "test_cid", + "impid": "imp_id", + "id": "bid_id", + "mtype": 1, + "price": 0.01 + } + ] + } + ] +} 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 bf0af8f2c13..8c488afdb40 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -357,6 +357,8 @@ adapters.mobfoxpb.enabled=true adapters.mobfoxpb.endpoint=http://localhost:8090/mobfoxpb-exchange?c=__route__&m=__method__&key=__key__ adapters.mobilefuse.enabled=true adapters.mobilefuse.endpoint=http://localhost:8090/mobilefuse-exchange/ +adapters.mobkoi.enabled=true +adapters.mobkoi.endpoint=http://localhost:8090/mobkoi-exchange adapters.motorik.enabled=true adapters.motorik.endpoint=http://localhost:8090/motorik-exchange?k={{AccountID}}&name={{SourceId}} adapters.nextmillennium.enabled=true From b2864fb4453d4838d2ad4fb3c4314cbabc567a59 Mon Sep 17 00:00:00 2001 From: Marc-Enzo Bonnafon Date: Fri, 9 May 2025 17:54:23 +0100 Subject: [PATCH 2/7] fixup after review --- .../server/bidder/mobkoi/MobkoiBidder.java | 98 ++++++++------ .../ext/request/mobkoi/ExtImpMobkoi.java | 3 - src/main/resources/bidder-config/mobkoi.yaml | 1 + .../bidder/mobkoi/MobkoiBidderTest.java | 122 +++++++++--------- .../mobkoi/test-mobkoi-bid-request.json | 2 + 5 files changed, 124 insertions(+), 102 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java index ab70a80b166..39ee4cf05cc 100644 --- a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java +++ b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java @@ -1,10 +1,9 @@ package org.prebid.server.bidder.mobkoi; import com.fasterxml.jackson.core.type.TypeReference; -import com.fasterxml.jackson.databind.node.ObjectNode; import com.iab.openrtb.request.BidRequest; import com.iab.openrtb.request.Imp; -import com.iab.openrtb.response.Bid; +import com.iab.openrtb.request.User; import com.iab.openrtb.response.BidResponse; import com.iab.openrtb.response.SeatBid; import org.apache.commons.collections4.CollectionUtils; @@ -18,16 +17,20 @@ 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.ExtUser; import org.prebid.server.proto.openrtb.ext.request.mobkoi.ExtImpMobkoi; import org.prebid.server.proto.openrtb.ext.response.BidType; import org.prebid.server.util.BidderUtil; import org.prebid.server.util.HttpUtil; +import java.net.URI; +import java.net.URISyntaxException; import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.Objects; import java.util.Optional; +import java.util.Vector; import java.util.stream.Collectors; public class MobkoiBidder implements Bidder { @@ -47,10 +50,8 @@ public MobkoiBidder(String endpointUrl, JacksonMapper mapper) { @Override public Result>> makeHttpRequests(BidRequest bidRequest) { - final Imp firstImp = bidRequest.getImp().stream().findFirst().orElse(null); - if (firstImp == null) { - return Result.withError(BidderError.badInput("No impression provided")); - } + final Imp firstImp = bidRequest.getImp().stream().findFirst() + .orElseThrow(() -> new PreBidException("No impression found")); final ExtImpMobkoi extImpMobkoi; try { @@ -59,20 +60,35 @@ public Result>> makeHttpRequests(BidRequest bidRequ return Result.withError(BidderError.badInput(e.getMessage())); } - if (extImpMobkoi.getPlacementId() == null) { - return Result.withError(BidderError.badInput("placementId should not be null")); + final Imp validImp; + if (firstImp.getTagid() == null) { + if (extImpMobkoi.getPlacementId() != null) { + validImp = modifyImp(firstImp, extImpMobkoi.getPlacementId()); + } else { + return Result.withError( + BidderError.badInput( + "invalid because it comes with neither request.imp[0].tagId nor " + + "req.imp[0].ext.Bidder.placementId")); + } + } else { + validImp = firstImp; + } + + List modifiedImps = bidRequest.getImp(); + if (validImp != firstImp) { + modifiedImps = updateFirstImpWith(bidRequest.getImp(), validImp); } final String selectedEndpointUrl = Optional.ofNullable(extImpMobkoi.getAdServerBaseUrl()) - .filter(this::validCustomEndpointUrl) + .flatMap(this::validateAndReplaceUri) .orElse(endpointUrl); - final List modifiedImps = List.of(modifyImp(firstImp, extImpMobkoi)); + final User user = modifyUser(bidRequest.getUser()); return Result.withValue(BidderUtil.defaultRequest( - modifyBidRequest(bidRequest, modifiedImps), - selectedEndpointUrl, - mapper)); + modifyBidRequest(bidRequest, user, modifiedImps), + selectedEndpointUrl, + mapper)); } private ExtImpMobkoi parseExtImp(Imp imp) { @@ -85,23 +101,39 @@ private ExtImpMobkoi parseExtImp(Imp imp) { } } - private boolean validCustomEndpointUrl(String customUrl) { + private Optional validateAndReplaceUri(String customUri) { try { - HttpUtil.validateUrl(Objects.requireNonNull(customUrl)); - return true; - } catch (IllegalArgumentException | NullPointerException e) { - return false; + HttpUtil.validateUrl(customUri); + final URI uri = new URI(customUri); + return Optional.of(uri.resolve("/bid").toString()); + } catch (IllegalArgumentException | URISyntaxException e) { + return Optional.empty(); } } - private Imp modifyImp(Imp imp, ExtImpMobkoi extImpMobkoi) { - final ObjectNode ext = mapper.mapper().createObjectNode(); - ext.set("bidder", mapper.mapper().valueToTree(extImpMobkoi)); - return imp.toBuilder().ext(ext).build(); + private Imp modifyImp(Imp imp, String tagId) { + return imp.toBuilder().tagid(tagId).build(); } - private static BidRequest modifyBidRequest(BidRequest bidRequest, List imps) { - return bidRequest.toBuilder().imp(imps).build(); + private List updateFirstImpWith(List imp, Imp validImp) { + final List imps = new Vector<>(imp); + imps.set(0, validImp); + return Collections.unmodifiableList(imps); + } + + private User modifyUser(User user) { + if (user == null || user.getConsent() == null) { + return user; + } + + final String consent = user.getConsent(); + final ExtUser userExt = ExtUser.builder().consent(consent).build(); + + return user.toBuilder().ext(userExt).build(); + } + + private static BidRequest modifyBidRequest(BidRequest bidRequest, User user, List imps) { + return bidRequest.toBuilder().user(user).imp(imps).build(); } @Override @@ -128,23 +160,7 @@ private static List bidsFromResponse(BidResponse bidResponse) { .map(SeatBid::getBid) .filter(Objects::nonNull) .flatMap(Collection::stream) - .map(bid -> BidderBid.of(bid, getBidType(bid), bidResponse.getCur())) + .map(bid -> BidderBid.of(bid, BidType.banner, "mobkoi", bidResponse.getCur())) .collect(Collectors.toList()); } - - private static BidType getBidType(Bid bid) { - final Integer markupType = bid.getMtype(); - if (markupType == null) { - throw new PreBidException("Missing mediaType for bid: " + bid.getId()); - } - - // markupType = 1 is a banner - if (markupType != 1) { - throw new PreBidException( - "Unsupported bid mediaType: %s for impression: %s" - .formatted(markupType, bid.getImpid())); - } - - return BidType.banner; - } } diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/mobkoi/ExtImpMobkoi.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/mobkoi/ExtImpMobkoi.java index 0d5ad97fc90..0faa3d1efc8 100644 --- a/src/main/java/org/prebid/server/proto/openrtb/ext/request/mobkoi/ExtImpMobkoi.java +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/mobkoi/ExtImpMobkoi.java @@ -3,9 +3,6 @@ import com.fasterxml.jackson.annotation.JsonProperty; import lombok.Value; -/** - * Defines the contract for bidrequest.imp[i].ext.mobkoi - */ @Value(staticConstructor = "of") public class ExtImpMobkoi { diff --git a/src/main/resources/bidder-config/mobkoi.yaml b/src/main/resources/bidder-config/mobkoi.yaml index 00de3d8fb76..59fcd36110f 100644 --- a/src/main/resources/bidder-config/mobkoi.yaml +++ b/src/main/resources/bidder-config/mobkoi.yaml @@ -8,3 +8,4 @@ adapters: - banner supported-vendors: vendor-id: 898 + ortb-version: "2.6" diff --git a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java index 90f5e1fbb81..9c76f50fb92 100644 --- a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java +++ b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.node.ObjectNode; import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.User; import com.iab.openrtb.response.Bid; import com.iab.openrtb.request.BidRequest; import com.iab.openrtb.response.BidResponse; @@ -21,7 +22,6 @@ import java.util.List; import java.util.function.UnaryOperator; -import static java.util.Collections.emptyList; import static java.util.Collections.singletonList; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; @@ -30,7 +30,7 @@ public class MobkoiBidderTest extends VertxTest { - private static final String ENDPOINT_URL = "https://test.endpoint.com"; + private static final String ENDPOINT_URL = "https://test.endpoint.com/bid"; private final MobkoiBidder target = new MobkoiBidder(ENDPOINT_URL, jacksonMapper); @@ -39,18 +39,6 @@ public void creationShouldFailOnInvalidEndpointUrl() { assertThatIllegalArgumentException().isThrownBy(() -> new MobkoiBidder("invalid_url", jacksonMapper)); } - @Test - public void makeHttpRequestsShouldReturnErrorWhenRequestHasNoImpression() { - // given - final BidRequest bidRequest = BidRequest.builder().imp(emptyList()).build(); - - // when - final Result>> result = target.makeHttpRequests(bidRequest); - - // then - assertThat(result.getErrors()).containsExactly(badInput("No impression provided")); - } - @Test public void makeHttpRequestsShouldReturnErrorWhenRequestHasInvalidExtImpression() { // given @@ -70,7 +58,7 @@ public void makeHttpRequestsShouldReturnErrorWhenRequestHasInvalidExtImpression( } @Test - public void makeHttpRequestsShouldReturnErrorWhenRequestHasMissingPlacementId() { + public void makeHttpRequestsShouldReturnErrorWhenRequestHasMissingTagIdAndPlacementId() { // given final ObjectNode mobkoiExt = impExt(null, null); final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); @@ -79,7 +67,45 @@ public void makeHttpRequestsShouldReturnErrorWhenRequestHasMissingPlacementId() final Result>> result = target.makeHttpRequests(bidRequest); // then - assertThat(result.getErrors()).containsExactly(badInput("placementId should not be null")); + assertThat(result.getErrors()) + .containsExactly( + badInput("invalid because it comes with neither " + + "request.imp[0].tagId nor req.imp[0].ext.Bidder.placementId")); + } + + @Test + public void makeHttpRequestsShouldReturnPlacementIdInTagId() { + // given + final ObjectNode mobkoiExt = impExt("pid", null); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()) + .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) + .flatExtracting(BidRequest::getImp) + .extracting(imp -> imp.getTagid()) + .containsExactly("pid"); + } + + @Test + public void makeHttpRequestsShouldCreateTheMobkoiExtensionCorrectly() throws Exception { + // given + final ObjectNode mobkoiExt = impExt("pid", null); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) + .flatExtracting(BidRequest::getImp) + .extracting(imp -> imp.getExt().get("bidder")) + .containsExactly(mapper.valueToTree(ExtImpMobkoi.of("pid", null))); } @Test @@ -92,7 +118,7 @@ public void makeHttpRequestsShouldUseConstructorEndpointWhenNoCustomEndpointIsDe final Result>> results = target.makeHttpRequests(bidRequest); // then - assertThat(results.getValue()).extracting(HttpRequest::getUri).containsExactly("https://test.endpoint.com"); + assertThat(results.getValue()).extracting(HttpRequest::getUri).containsExactly("https://test.endpoint.com/bid"); assertThat(results.getErrors()).isEmpty(); } @@ -106,7 +132,7 @@ public void makeHttpRequestsShouldConstructorEndpointWhenTheCustomIsInvalidInMob final Result>> result = target.makeHttpRequests(bidRequest); // then - assertThat(result.getValue()).extracting(HttpRequest::getUri).containsExactly("https://test.endpoint.com"); + assertThat(result.getValue()).extracting(HttpRequest::getUri).containsExactly("https://test.endpoint.com/bid"); assertThat(result.getErrors()).isEmpty(); } @@ -120,26 +146,26 @@ public void makeHttpRequestsShouldUseCustomEndpointWhenDefinedInMobkoiExtension( final Result>> result = target.makeHttpRequests(bidRequest); // then - assertThat(result.getValue()).extracting(HttpRequest::getUri).containsExactly("https://custom.endpoint.com"); + assertThat(result.getValue()).extracting(HttpRequest::getUri).containsExactly("https://custom.endpoint.com/bid"); assertThat(result.getErrors()).isEmpty(); } @Test - public void makeHttpRequestsShouldCreateTheMobkoiExtensionCorrectly() throws Exception { + public void makeHttpRequestsShouldSetUserExtConsent() { // given - final ObjectNode mobkoiExt = impExt("pid", null); - final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + final BidRequest bidRequest = givenBidRequest( + bidRequestBuilder -> bidRequestBuilder.user(User.builder().consent("consent").build()), + impBuilder -> impBuilder); // when final Result>> result = target.makeHttpRequests(bidRequest); // then - assertThat(result.getErrors()).isEmpty(); assertThat(result.getValue()) .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) - .flatExtracting(BidRequest::getImp) - .extracting(imp -> imp.getExt().get("bidder")) - .containsExactly(mapper.valueToTree(ExtImpMobkoi.of("pid", null))); + .extracting(request -> request.getUser().getExt().getConsent()) + .containsExactly("consent"); + assertThat(result.getErrors()).isEmpty(); } @Test @@ -186,7 +212,7 @@ public void makeBidsShouldReturnEmptyListIfBidResponseSeatBidIsNull() throws Jso } @Test - public void makeBidsShouldReturnBannerBid() throws JsonProcessingException { + public void makeBidsShouldReturnBannerBidWithMobkoiSeat() throws JsonProcessingException { // given final BidResponse bannerBidResponse = givenBidResponse(bidBuilder -> bidBuilder.mtype(1).impid("123")); final BidderCall httpCall = givenHttpCall(mapper.writeValueAsString(bannerBidResponse)); @@ -197,37 +223,9 @@ public void makeBidsShouldReturnBannerBid() throws JsonProcessingException { // then assertThat(result.getErrors()).isEmpty(); assertThat(result.getValue()) - .containsExactly(BidderBid.of(Bid.builder().mtype(1).impid("123").build(), banner, "USD")); - } - - @Test - public void makeBidsShouldThrowErrorWhenMediaTypeIsMissing() throws JsonProcessingException { - // given - final BidderCall httpCall = givenHttpCall( - mapper.writeValueAsString(givenBidResponse(bidBuilder -> bidBuilder.impid("123")))); - - // when - final Result> result = target.makeBids(httpCall, null); - - // then - assertThat(result.getErrors()).hasSize(1) - .containsOnly(BidderError.badServerResponse("Missing mediaType for bid: null")); - assertThat(result.getValue()).isEmpty(); - } - - @Test - public void makeBidsShouldThrowErrorWhenMediaTypeIsUnsupported() throws JsonProcessingException { - // given - final BidderCall httpCall = givenHttpCall( - mapper.writeValueAsString(givenBidResponse(bidBuilder -> bidBuilder.mtype(2).impid("imp_id")))); - - // when - final Result> result = target.makeBids(httpCall, null); - - // then - assertThat(result.getValue()).isEmpty(); - assertThat(result.getErrors()).hasSize(1) - .containsOnly(BidderError.badServerResponse("Unsupported bid mediaType: 2 for impression: imp_id")); + .containsExactly( + BidderBid.of( + Bid.builder().mtype(1).impid("123").build(), banner, "mobkoi", "USD")); } private static BidRequest givenBidRequest(UnaryOperator impModifier) { @@ -236,6 +234,14 @@ private static BidRequest givenBidRequest(UnaryOperator impModif .build(); } + private static BidRequest givenBidRequest( + UnaryOperator bidRequestCustomizer, + UnaryOperator impModifier) { + return bidRequestCustomizer.apply(BidRequest.builder()) + .imp(singletonList(givenImp(impModifier))) + .build(); + } + private static Imp givenImp(UnaryOperator impCustomizer) { return impCustomizer.apply(Imp.builder().id("imp_id").ext(impExt("placementIdValue", null))).build(); } diff --git a/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json index a0e27c9d2ef..600d7b3fa5a 100644 --- a/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json +++ b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json @@ -7,8 +7,10 @@ "w": 300, "h": 250 }, + "tagid" : "999999", "secure": 1, "ext": { + "tid" :"${json-unit.any-string}", "bidder": { "placementId": "999999" } From 832661e9b41e5be5eed0594d5915bed215b27aeb Mon Sep 17 00:00:00 2001 From: Marc-Enzo Bonnafon Date: Mon, 12 May 2025 15:04:29 +0100 Subject: [PATCH 3/7] fixup after 2nd review --- .../server/bidder/mobkoi/MobkoiBidder.java | 75 ++++++++----------- .../config/bidder/MobkoiConfiguration.java | 6 +- src/main/resources/bidder-config/mobkoi.yaml | 2 +- .../mobkoi/test-mobkoi-bid-request.json | 4 +- 4 files changed, 38 insertions(+), 49 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java index 39ee4cf05cc..8676ef93e13 100644 --- a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java +++ b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java @@ -7,6 +7,7 @@ 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; @@ -25,12 +26,11 @@ import java.net.URI; import java.net.URISyntaxException; +import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.Objects; -import java.util.Optional; -import java.util.Vector; import java.util.stream.Collectors; public class MobkoiBidder implements Bidder { @@ -50,43 +50,21 @@ public MobkoiBidder(String endpointUrl, JacksonMapper mapper) { @Override public Result>> makeHttpRequests(BidRequest bidRequest) { - final Imp firstImp = bidRequest.getImp().stream().findFirst() - .orElseThrow(() -> new PreBidException("No impression found")); + final Imp firstImp = bidRequest.getImp().getFirst(); final ExtImpMobkoi extImpMobkoi; + final Imp modifiedFirstImp; try { extImpMobkoi = parseExtImp(firstImp); + modifiedFirstImp = modifyImp(firstImp, extImpMobkoi); } catch (PreBidException e) { return Result.withError(BidderError.badInput(e.getMessage())); } - final Imp validImp; - if (firstImp.getTagid() == null) { - if (extImpMobkoi.getPlacementId() != null) { - validImp = modifyImp(firstImp, extImpMobkoi.getPlacementId()); - } else { - return Result.withError( - BidderError.badInput( - "invalid because it comes with neither request.imp[0].tagId nor " - + "req.imp[0].ext.Bidder.placementId")); - } - } else { - validImp = firstImp; - } - - List modifiedImps = bidRequest.getImp(); - if (validImp != firstImp) { - modifiedImps = updateFirstImpWith(bidRequest.getImp(), validImp); - } - - final String selectedEndpointUrl = Optional.ofNullable(extImpMobkoi.getAdServerBaseUrl()) - .flatMap(this::validateAndReplaceUri) - .orElse(endpointUrl); - - final User user = modifyUser(bidRequest.getUser()); + final String selectedEndpointUrl = customOrDefaultEndpoint(extImpMobkoi.getAdServerBaseUrl()); return Result.withValue(BidderUtil.defaultRequest( - modifyBidRequest(bidRequest, user, modifiedImps), + modifyBidRequest(bidRequest, modifiedFirstImp), selectedEndpointUrl, mapper)); } @@ -101,27 +79,38 @@ private ExtImpMobkoi parseExtImp(Imp imp) { } } - private Optional validateAndReplaceUri(String customUri) { + private Imp modifyImp(Imp firstImp, ExtImpMobkoi extImpMobkoi) { + String tagId = firstImp.getTagid(); + if (StringUtils.isBlank(tagId)) { + if (StringUtils.isNotBlank(extImpMobkoi.getPlacementId())) { + tagId = extImpMobkoi.getPlacementId(); + } else { + throw new PreBidException("invalid because it comes with neither request.imp[0].tagId nor " + + "req.imp[0].ext.Bidder.placementId"); + } + + return firstImp.toBuilder().tagid(tagId).build(); + } + return firstImp; + } + + private String customOrDefaultEndpoint(String customUri) { try { HttpUtil.validateUrl(customUri); final URI uri = new URI(customUri); - return Optional.of(uri.resolve("/bid").toString()); + return uri.resolve("/bid").toString(); } catch (IllegalArgumentException | URISyntaxException e) { - return Optional.empty(); + return endpointUrl; } } - private Imp modifyImp(Imp imp, String tagId) { - return imp.toBuilder().tagid(tagId).build(); - } - - private List updateFirstImpWith(List imp, Imp validImp) { - final List imps = new Vector<>(imp); - imps.set(0, validImp); - return Collections.unmodifiableList(imps); + private static List updateFirstImpWith(List imps, Imp imp) { + final List modifiedImps = new ArrayList<>(imps); + modifiedImps.set(0, imp); + return Collections.unmodifiableList(modifiedImps); } - private User modifyUser(User user) { + private static User modifyUser(User user) { if (user == null || user.getConsent() == null) { return user; } @@ -132,7 +121,9 @@ private User modifyUser(User user) { return user.toBuilder().ext(userExt).build(); } - private static BidRequest modifyBidRequest(BidRequest bidRequest, User user, List imps) { + private static BidRequest modifyBidRequest(BidRequest bidRequest, Imp modifiedFirstImp) { + final User user = modifyUser(bidRequest.getUser()); + final List imps = updateFirstImpWith(bidRequest.getImp(), modifiedFirstImp); return bidRequest.toBuilder().user(user).imp(imps).build(); } diff --git a/src/main/java/org/prebid/server/spring/config/bidder/MobkoiConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/MobkoiConfiguration.java index d706c06a2ec..9b4761fdfaf 100644 --- a/src/main/java/org/prebid/server/spring/config/bidder/MobkoiConfiguration.java +++ b/src/main/java/org/prebid/server/spring/config/bidder/MobkoiConfiguration.java @@ -28,9 +28,9 @@ BidderConfigurationProperties configurationProperties() { } @Bean - BidderDeps mobkoiBidderDeps(BidderConfigurationProperties mobkoiConfigurationProperties, - @NotBlank @Value("${external-url}") String externalUrl, - JacksonMapper mapper) { + BidderDeps mobkoiBidderDeps(BidderConfigurationProperties mobkoiConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + JacksonMapper mapper) { return BidderDepsAssembler.forBidder(BIDDER_NAME) .withConfig(mobkoiConfigurationProperties) diff --git a/src/main/resources/bidder-config/mobkoi.yaml b/src/main/resources/bidder-config/mobkoi.yaml index 59fcd36110f..cccf3822bf3 100644 --- a/src/main/resources/bidder-config/mobkoi.yaml +++ b/src/main/resources/bidder-config/mobkoi.yaml @@ -1,6 +1,7 @@ adapters: mobkoi: endpoint: "https://pbs.maximus.mobkoi.com/bid" + ortb-version: "2.6" meta-info: maintainer-email: platformteam@mobkoi.com app-media-types: @@ -8,4 +9,3 @@ adapters: - banner supported-vendors: vendor-id: 898 - ortb-version: "2.6" diff --git a/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json index 600d7b3fa5a..f0baad1ac99 100644 --- a/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json +++ b/src/test/resources/org/prebid/server/it/openrtb2/mobkoi/test-mobkoi-bid-request.json @@ -40,9 +40,7 @@ "tid": "${json-unit.any-string}" }, "regs": { - "ext": { - "gdpr": 0 - } + "gdpr": 0 }, "ext": { "prebid": { From 284ec10c4f5fdd4338c870867a9bc174c2072c17 Mon Sep 17 00:00:00 2001 From: Marc-Enzo Bonnafon Date: Wed, 14 May 2025 10:28:45 +0100 Subject: [PATCH 4/7] fixup after 3rd review --- .../server/bidder/mobkoi/MobkoiBidder.java | 44 +++++++++---------- .../bidder/mobkoi/MobkoiBidderTest.java | 41 +++++++---------- 2 files changed, 36 insertions(+), 49 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java index 8676ef93e13..3e4065a2495 100644 --- a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java +++ b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java @@ -31,6 +31,7 @@ import java.util.Collections; import java.util.List; import java.util.Objects; +import java.util.Optional; import java.util.stream.Collectors; public class MobkoiBidder implements Bidder { @@ -61,7 +62,7 @@ public Result>> makeHttpRequests(BidRequest bidRequ return Result.withError(BidderError.badInput(e.getMessage())); } - final String selectedEndpointUrl = customOrDefaultEndpoint(extImpMobkoi.getAdServerBaseUrl()); + final String selectedEndpointUrl = resolveEndpoint(extImpMobkoi.getAdServerBaseUrl()); return Result.withValue(BidderUtil.defaultRequest( modifyBidRequest(bidRequest, modifiedFirstImp), @@ -80,21 +81,19 @@ private ExtImpMobkoi parseExtImp(Imp imp) { } private Imp modifyImp(Imp firstImp, ExtImpMobkoi extImpMobkoi) { - String tagId = firstImp.getTagid(); - if (StringUtils.isBlank(tagId)) { - if (StringUtils.isNotBlank(extImpMobkoi.getPlacementId())) { - tagId = extImpMobkoi.getPlacementId(); - } else { - throw new PreBidException("invalid because it comes with neither request.imp[0].tagId nor " - + "req.imp[0].ext.Bidder.placementId"); - } - - return firstImp.toBuilder().tagid(tagId).build(); + if (StringUtils.isNotBlank(firstImp.getTagid())) { + return firstImp; + } + + if (StringUtils.isNotBlank(extImpMobkoi.getPlacementId())) { + return firstImp.toBuilder().tagid(extImpMobkoi.getPlacementId()).build(); + } else { + throw new PreBidException("invalid because it comes with neither request.imp[0].tagId nor " + + "req.imp[0].ext.Bidder.placementId"); } - return firstImp; } - private String customOrDefaultEndpoint(String customUri) { + private String resolveEndpoint(String customUri) { try { HttpUtil.validateUrl(customUri); final URI uri = new URI(customUri); @@ -104,23 +103,20 @@ private String customOrDefaultEndpoint(String customUri) { } } + private static User modifyUser(User user) { + return Optional.ofNullable(user) + .map(User::getConsent) + .map(consent -> ExtUser.builder().consent(consent).build()) + .map(ext -> user.toBuilder().ext(ext).build()) + .orElse(user); + } + private static List updateFirstImpWith(List imps, Imp imp) { final List modifiedImps = new ArrayList<>(imps); modifiedImps.set(0, imp); return Collections.unmodifiableList(modifiedImps); } - private static User modifyUser(User user) { - if (user == null || user.getConsent() == null) { - return user; - } - - final String consent = user.getConsent(); - final ExtUser userExt = ExtUser.builder().consent(consent).build(); - - return user.toBuilder().ext(userExt).build(); - } - private static BidRequest modifyBidRequest(BidRequest bidRequest, Imp modifiedFirstImp) { final User user = modifyUser(bidRequest.getUser()); final List imps = updateFirstImpWith(bidRequest.getImp(), modifiedFirstImp); diff --git a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java index 9c76f50fb92..a173315f70f 100644 --- a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java +++ b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java @@ -17,11 +17,13 @@ import org.prebid.server.bidder.model.Result; import org.prebid.server.proto.openrtb.ext.ExtPrebid; import org.prebid.server.VertxTest; +import org.prebid.server.proto.openrtb.ext.request.ExtUser; import org.prebid.server.proto.openrtb.ext.request.mobkoi.ExtImpMobkoi; import java.util.List; import java.util.function.UnaryOperator; +import static java.util.Arrays.asList; import static java.util.Collections.singletonList; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; @@ -74,10 +76,12 @@ public void makeHttpRequestsShouldReturnErrorWhenRequestHasMissingTagIdAndPlacem } @Test - public void makeHttpRequestsShouldReturnPlacementIdInTagId() { + public void makeHttpRequestsShouldAddPlacementIdOnlyInFirstImpressionTagId() { // given final ObjectNode mobkoiExt = impExt("pid", null); - final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + final Imp givenImp1 = givenImp(impBuilder -> impBuilder.ext(mobkoiExt)); + final Imp givenImp2 = givenImp(impBuilder -> impBuilder); + final BidRequest bidRequest = BidRequest.builder().imp(asList(givenImp1, givenImp2)).build(); // when final Result>> result = target.makeHttpRequests(bidRequest); @@ -87,25 +91,7 @@ public void makeHttpRequestsShouldReturnPlacementIdInTagId() { .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) .flatExtracting(BidRequest::getImp) .extracting(imp -> imp.getTagid()) - .containsExactly("pid"); - } - - @Test - public void makeHttpRequestsShouldCreateTheMobkoiExtensionCorrectly() throws Exception { - // given - final ObjectNode mobkoiExt = impExt("pid", null); - final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); - - // when - final Result>> result = target.makeHttpRequests(bidRequest); - - // then - assertThat(result.getErrors()).isEmpty(); - assertThat(result.getValue()) - .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) - .flatExtracting(BidRequest::getImp) - .extracting(imp -> imp.getExt().get("bidder")) - .containsExactly(mapper.valueToTree(ExtImpMobkoi.of("pid", null))); + .containsExactly("pid", null); } @Test @@ -151,10 +137,13 @@ public void makeHttpRequestsShouldUseCustomEndpointWhenDefinedInMobkoiExtension( } @Test - public void makeHttpRequestsShouldSetUserExtConsent() { + public void makeHttpRequestsShouldOverrideUserExtAndSetConsent() { // given + final ObjectNode originExtUserData = mapper.createObjectNode().put("originAttr", "originValue"); + final ExtUser extUser = ExtUser.builder().data(originExtUserData).consent("consent-to-be-overridden").build(); + final User user = User.builder().consent("consent").ext(extUser).build(); final BidRequest bidRequest = givenBidRequest( - bidRequestBuilder -> bidRequestBuilder.user(User.builder().consent("consent").build()), + bidRequestBuilder -> bidRequestBuilder.user(user), impBuilder -> impBuilder); // when @@ -163,8 +152,10 @@ public void makeHttpRequestsShouldSetUserExtConsent() { // then assertThat(result.getValue()) .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) - .extracting(request -> request.getUser().getExt().getConsent()) - .containsExactly("consent"); + .extracting(request -> request.getUser().getExt()).hasSize(1).element(0) + .isEqualTo(ExtUser.builder() + .consent("consent") + .build()); assertThat(result.getErrors()).isEmpty(); } From 37d6883d7bae03c13ddc6d8e1525b7ace8bb52bc Mon Sep 17 00:00:00 2001 From: Marc-Enzo Bonnafon Date: Wed, 14 May 2025 11:00:11 +0100 Subject: [PATCH 5/7] invert functions order --- .../prebid/server/bidder/mobkoi/MobkoiBidder.java | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java index 3e4065a2495..7e1977b09e7 100644 --- a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java +++ b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java @@ -103,6 +103,12 @@ private String resolveEndpoint(String customUri) { } } + private static BidRequest modifyBidRequest(BidRequest bidRequest, Imp modifiedFirstImp) { + final User user = modifyUser(bidRequest.getUser()); + final List imps = updateFirstImpWith(bidRequest.getImp(), modifiedFirstImp); + return bidRequest.toBuilder().user(user).imp(imps).build(); + } + private static User modifyUser(User user) { return Optional.ofNullable(user) .map(User::getConsent) @@ -117,12 +123,6 @@ private static List updateFirstImpWith(List imps, Imp imp) { return Collections.unmodifiableList(modifiedImps); } - private static BidRequest modifyBidRequest(BidRequest bidRequest, Imp modifiedFirstImp) { - final User user = modifyUser(bidRequest.getUser()); - final List imps = updateFirstImpWith(bidRequest.getImp(), modifiedFirstImp); - return bidRequest.toBuilder().user(user).imp(imps).build(); - } - @Override public final Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { try { From 129795d1d508fc954038616b594b875a7c0147f1 Mon Sep 17 00:00:00 2001 From: Marc-Enzo Bonnafon Date: Mon, 19 May 2025 09:39:40 +0100 Subject: [PATCH 6/7] fixup after 4th review --- .../server/bidder/mobkoi/MobkoiBidder.java | 15 ++++++++------- .../server/bidder/mobkoi/MobkoiBidderTest.java | 17 ++--------------- 2 files changed, 10 insertions(+), 22 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java index 7e1977b09e7..210e0927bbe 100644 --- a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java +++ b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java @@ -32,7 +32,6 @@ import java.util.List; import java.util.Objects; import java.util.Optional; -import java.util.stream.Collectors; public class MobkoiBidder implements Bidder { @@ -50,7 +49,6 @@ public MobkoiBidder(String endpointUrl, JacksonMapper mapper) { @Override public Result>> makeHttpRequests(BidRequest bidRequest) { - final Imp firstImp = bidRequest.getImp().getFirst(); final ExtImpMobkoi extImpMobkoi; @@ -87,15 +85,18 @@ private Imp modifyImp(Imp firstImp, ExtImpMobkoi extImpMobkoi) { if (StringUtils.isNotBlank(extImpMobkoi.getPlacementId())) { return firstImp.toBuilder().tagid(extImpMobkoi.getPlacementId()).build(); - } else { - throw new PreBidException("invalid because it comes with neither request.imp[0].tagId nor " - + "req.imp[0].ext.Bidder.placementId"); } + + throw new PreBidException("invalid because it comes with neither request.imp[0].tagId nor " + + "req.imp[0].ext.Bidder.placementId"); } + // url is already validated with `bidder-params` json schema private String resolveEndpoint(String customUri) { try { - HttpUtil.validateUrl(customUri); + if (customUri == null) { + return endpointUrl; + } final URI uri = new URI(customUri); return uri.resolve("/bid").toString(); } catch (IllegalArgumentException | URISyntaxException e) { @@ -148,6 +149,6 @@ private static List bidsFromResponse(BidResponse bidResponse) { .filter(Objects::nonNull) .flatMap(Collection::stream) .map(bid -> BidderBid.of(bid, BidType.banner, "mobkoi", bidResponse.getCur())) - .collect(Collectors.toList()); + .toList(); } } diff --git a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java index a173315f70f..2a7809407b9 100644 --- a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java +++ b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java @@ -25,6 +25,7 @@ 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.prebid.server.bidder.model.BidderError.badInput; @@ -80,7 +81,7 @@ public void makeHttpRequestsShouldAddPlacementIdOnlyInFirstImpressionTagId() { // given final ObjectNode mobkoiExt = impExt("pid", null); final Imp givenImp1 = givenImp(impBuilder -> impBuilder.ext(mobkoiExt)); - final Imp givenImp2 = givenImp(impBuilder -> impBuilder); + final Imp givenImp2 = givenImp(identity()); final BidRequest bidRequest = BidRequest.builder().imp(asList(givenImp1, givenImp2)).build(); // when @@ -108,20 +109,6 @@ public void makeHttpRequestsShouldUseConstructorEndpointWhenNoCustomEndpointIsDe assertThat(results.getErrors()).isEmpty(); } - @Test - public void makeHttpRequestsShouldConstructorEndpointWhenTheCustomIsInvalidInMobkoiExtension() { - // given - final ObjectNode mobkoiExt = impExt("pid", "invalid-URI"); - final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); - - // when - final Result>> result = target.makeHttpRequests(bidRequest); - - // then - assertThat(result.getValue()).extracting(HttpRequest::getUri).containsExactly("https://test.endpoint.com/bid"); - assertThat(result.getErrors()).isEmpty(); - } - @Test public void makeHttpRequestsShouldUseCustomEndpointWhenDefinedInMobkoiExtension() { // given From f51138aaae3fe9fc6be76218d73e010dd6116c4b Mon Sep 17 00:00:00 2001 From: Marc-Enzo Bonnafon Date: Mon, 26 May 2025 20:46:14 +0100 Subject: [PATCH 7/7] fixup after 5th review --- .../prebid/server/bidder/mobkoi/MobkoiBidder.java | 6 +++--- .../server/bidder/mobkoi/MobkoiBidderTest.java | 14 ++++++++++++++ 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java index 210e0927bbe..97cd481b235 100644 --- a/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java +++ b/src/main/java/org/prebid/server/bidder/mobkoi/MobkoiBidder.java @@ -93,10 +93,10 @@ private Imp modifyImp(Imp firstImp, ExtImpMobkoi extImpMobkoi) { // url is already validated with `bidder-params` json schema private String resolveEndpoint(String customUri) { + if (customUri == null) { + return endpointUrl; + } try { - if (customUri == null) { - return endpointUrl; - } final URI uri = new URI(customUri); return uri.resolve("/bid").toString(); } catch (IllegalArgumentException | URISyntaxException e) { diff --git a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java index 2a7809407b9..1c98d21a3ca 100644 --- a/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java +++ b/src/test/java/org/prebid/server/bidder/mobkoi/MobkoiBidderTest.java @@ -109,6 +109,20 @@ public void makeHttpRequestsShouldUseConstructorEndpointWhenNoCustomEndpointIsDe assertThat(results.getErrors()).isEmpty(); } + @Test + public void makeHttpRequestsShouldConstructWithDefaultEndpointWhenTheCustomURLIsInvalidInMobkoiExtension() { + // given + final ObjectNode mobkoiExt = impExt("pid", "invalid URI"); + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.ext(mobkoiExt)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).extracting(HttpRequest::getUri).containsExactly("https://test.endpoint.com/bid"); + assertThat(result.getErrors()).isEmpty(); + } + @Test public void makeHttpRequestsShouldUseCustomEndpointWhenDefinedInMobkoiExtension() { // given