From faf0fa85c420c44e7d01a3a4b1f2a8ea7a97a1b7 Mon Sep 17 00:00:00 2001 From: antonbabak Date: Wed, 15 Oct 2025 15:14:01 +0200 Subject: [PATCH 1/2] New Contxtful Adapter --- .../bidder/contxtful/ContxtfulBidder.java | 224 ++++++++++ .../request/ContxtfulBidRequest.java | 16 + .../request/ContxtfulBidRequestParams.java | 11 + .../request/ContxtfulBidderRequest.java | 11 + .../request/ContxtfulCompositeRequest.java | 24 ++ .../contxtful/request/ContxtfulConfig.java | 11 + .../request/ContxtfulConfigDetails.java | 11 + .../contxtful/response/ContxtfulBid.java | 56 +++ .../request/contxtful/ExtImpContxtful.java | 14 + .../config/bidder/ContxtfulConfiguration.java | 41 ++ .../resources/bidder-config/contxtful.yaml | 21 + .../static/bidder-params/contxtful.json | 22 + .../bidder/contxtful/ContxtfulBidderTest.java | 390 ++++++++++++++++++ .../org/prebid/server/it/ContxtfulTest.java | 34 ++ .../test-auction-contxtful-request.json | 44 ++ .../test-auction-contxtful-response.json | 47 +++ .../contxtful/test-contxtful-bid-request.json | 91 ++++ .../test-contxtful-bid-response.json | 22 + .../server/it/test-application.properties | 2 + 19 files changed, 1092 insertions(+) create mode 100644 src/main/java/org/prebid/server/bidder/contxtful/ContxtfulBidder.java create mode 100644 src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidRequest.java create mode 100644 src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidRequestParams.java create mode 100644 src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidderRequest.java create mode 100644 src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulCompositeRequest.java create mode 100644 src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulConfig.java create mode 100644 src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulConfigDetails.java create mode 100644 src/main/java/org/prebid/server/bidder/contxtful/response/ContxtfulBid.java create mode 100644 src/main/java/org/prebid/server/proto/openrtb/ext/request/contxtful/ExtImpContxtful.java create mode 100644 src/main/java/org/prebid/server/spring/config/bidder/ContxtfulConfiguration.java create mode 100644 src/main/resources/bidder-config/contxtful.yaml create mode 100644 src/main/resources/static/bidder-params/contxtful.json create mode 100644 src/test/java/org/prebid/server/bidder/contxtful/ContxtfulBidderTest.java create mode 100644 src/test/java/org/prebid/server/it/ContxtfulTest.java create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-auction-contxtful-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-auction-contxtful-response.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-contxtful-bid-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-contxtful-bid-response.json diff --git a/src/main/java/org/prebid/server/bidder/contxtful/ContxtfulBidder.java b/src/main/java/org/prebid/server/bidder/contxtful/ContxtfulBidder.java new file mode 100644 index 00000000000..cc05acadcd4 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/contxtful/ContxtfulBidder.java @@ -0,0 +1,224 @@ +package org.prebid.server.bidder.contxtful; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.User; +import com.iab.openrtb.response.Bid; +import io.vertx.core.http.HttpMethod; +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.StringUtils; +import org.prebid.server.bidder.Bidder; +import org.prebid.server.bidder.contxtful.request.ContxtfulBidRequest; +import org.prebid.server.bidder.contxtful.request.ContxtfulBidRequestParams; +import org.prebid.server.bidder.contxtful.request.ContxtfulBidderRequest; +import org.prebid.server.bidder.contxtful.request.ContxtfulCompositeRequest; +import org.prebid.server.bidder.contxtful.request.ContxtfulConfig; +import org.prebid.server.bidder.contxtful.request.ContxtfulConfigDetails; +import org.prebid.server.bidder.contxtful.response.ContxtfulBid; +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.ExtUser; +import org.prebid.server.proto.openrtb.ext.request.ExtUserPrebid; +import org.prebid.server.proto.openrtb.ext.request.contxtful.ExtImpContxtful; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.function.Function; +import java.util.stream.Collectors; + +public class ContxtfulBidder implements Bidder { + + private static final TypeReference> TYPE_REFERENCE = new TypeReference<>() { + }; + private static final String ACCOUNT_ID_MACRO = "{{AccountId}}"; + private static final String BIDDER_NAME = "contxtful"; + private static final String DEFAULT_ADAPTER_VERSION = "v1"; + private static final String DEFAULT_CURRENCY = "USD"; + + private final String endpointUrl; + private final JacksonMapper mapper; + + public ContxtfulBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + final List errors = new ArrayList<>(); + final List bidRequests = new ArrayList<>(); + String customerId = null; + + for (Imp imp : request.getImp()) { + try { + final ExtImpContxtful extImp = parseImpExt(imp); + if (customerId == null) { + customerId = extImp.getCustomerId(); + } + bidRequests.add(ContxtfulBidRequest.of( + BIDDER_NAME, + ContxtfulBidRequestParams.of(extImp.getPlacementId()), imp.getId())); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + if (CollectionUtils.isEmpty(bidRequests)) { + return Result.withErrors(errors); + } + + final ContxtfulCompositeRequest outgoingRequest = ContxtfulCompositeRequest.builder() + .ortb2Request(request.toBuilder().user(modifyUser(request.getUser())).build()) + .bidRequests(bidRequests) + .bidderRequest(ContxtfulBidderRequest.of(BIDDER_NAME)) + .config(ContxtfulConfig.of(ContxtfulConfigDetails.of(DEFAULT_ADAPTER_VERSION, customerId))) + .build(); + + final HttpRequest httpRequest = HttpRequest.builder() + .method(HttpMethod.POST) + .uri(makeUrl(customerId)) + .headers(HttpUtil.headers()) + .body(mapper.encodeToBytes(outgoingRequest)) + .payload(outgoingRequest) + .impIds(BidderUtil.impIds(request)) + .build(); + + return Result.of(Collections.singletonList(httpRequest), errors); + } + + private ExtImpContxtful parseImpExt(Imp imp) { + try { + return mapper.mapper().convertValue(imp.getExt(), TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException("Error parsing imp.ext for impression " + imp.getId()); + } + } + + private static User modifyUser(User user) { + if (user == null) { + return null; + } + + final String buyerUid = user.getBuyeruid(); + if (StringUtils.isNotBlank(buyerUid)) { + return user; + } + + return Optional.ofNullable(user.getExt()) + .map(ExtUser::getPrebid) + .map(ExtUserPrebid::getBuyeruids) + .map(buyerUids -> buyerUids.get(BIDDER_NAME)) + .filter(StringUtils::isNotBlank) + .map(uid -> user.toBuilder().buyeruid(uid).build()) + .orElse(user); + } + + private String makeUrl(String customerId) { + return endpointUrl.replace(ACCOUNT_ID_MACRO, HttpUtil.encodeUrl(customerId)); + } + + @Override + public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + final List errors = new ArrayList<>(); + try { + final List responseBids = mapper.decodeValue( + httpCall.getResponse().getBody(), + new TypeReference<>() { + }); + return Result.of(extractBids(bidRequest, responseBids, errors), errors); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private static List extractBids(BidRequest bidRequest, + List responseBids, + List errors) { + + if (CollectionUtils.isEmpty(responseBids)) { + return Collections.emptyList(); + } + return bidsFromResponse(bidRequest, responseBids, errors); + } + + private static List bidsFromResponse(BidRequest bidRequest, + List responseBids, + List errors) { + + final Map impsMap = bidRequest.getImp().stream() + .collect(Collectors.toMap(Imp::getId, Function.identity())); + + return responseBids.stream() + .filter(Objects::nonNull) + .map(responseBid -> makeBidderBid(responseBid, impsMap, errors)) + .filter(Objects::nonNull) + .collect(Collectors.toList()); + } + + private static BidderBid makeBidderBid(ContxtfulBid responseBid, + Map impsMap, + List errors) { + + final String impId = responseBid.getRequestId(); + if (responseBid.getCpm() == null || impId == null) { + return null; + } + + if (StringUtils.isBlank(responseBid.getMediaType())) { + errors.add(BidderError.badServerResponse("bid %s has no ad media type".formatted(impId))); + return null; + } + + if (StringUtils.isBlank(responseBid.getAdm())) { + errors.add(BidderError.badServerResponse("bid %s has no ad markup".formatted(impId))); + return null; + } + + final Bid bid = Bid.builder() + .id(BIDDER_NAME + "-" + impId) + .impid(impId) + .price(responseBid.getCpm()) + .adm(responseBid.getAdm()) + .w(responseBid.getWidth()) + .h(responseBid.getHeight()) + .crid(responseBid.getCreativeId()) + .nurl(responseBid.getNurl()) + .burl(responseBid.getBurl()) + .lurl(responseBid.getLurl()) + .ext(responseBid.getExt()) + .build(); + + final String currency = Objects.toString(responseBid.getCurrency(), DEFAULT_CURRENCY); + return BidderBid.of(bid, getBidType(impsMap.get(impId)), currency); + } + + private static BidType getBidType(Imp imp) { + if (imp == null) { + return BidType.banner; + } + + if (imp.getVideo() != null) { + return BidType.video; + } else if (imp.getXNative() != null) { + return BidType.xNative; + } else { + return BidType.banner; + } + } +} + diff --git a/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidRequest.java b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidRequest.java new file mode 100644 index 00000000000..82d011c01f8 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidRequest.java @@ -0,0 +1,16 @@ +package org.prebid.server.bidder.contxtful.request; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ContxtfulBidRequest { + + String bidder; + + ContxtfulBidRequestParams params; + + @JsonProperty("bidId") + String bidId; + +} diff --git a/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidRequestParams.java b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidRequestParams.java new file mode 100644 index 00000000000..e4898fa5064 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidRequestParams.java @@ -0,0 +1,11 @@ +package org.prebid.server.bidder.contxtful.request; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ContxtfulBidRequestParams { + + @JsonProperty("placementId") + String placementId; +} diff --git a/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidderRequest.java b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidderRequest.java new file mode 100644 index 00000000000..3e3a8e7e254 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulBidderRequest.java @@ -0,0 +1,11 @@ +package org.prebid.server.bidder.contxtful.request; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ContxtfulBidderRequest { + + @JsonProperty("bidderCode") + String bidderCode; +} diff --git a/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulCompositeRequest.java b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulCompositeRequest.java new file mode 100644 index 00000000000..dc34fc90c62 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulCompositeRequest.java @@ -0,0 +1,24 @@ +package org.prebid.server.bidder.contxtful.request; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.iab.openrtb.request.BidRequest; +import lombok.Builder; +import lombok.Value; + +import java.util.List; + +@Builder +@Value(staticConstructor = "of") +public class ContxtfulCompositeRequest { + + @JsonProperty("ortb2") + BidRequest ortb2Request; + + @JsonProperty("bidRequests") + List bidRequests; + + @JsonProperty("bidderRequest") + ContxtfulBidderRequest bidderRequest; + + ContxtfulConfig config; +} diff --git a/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulConfig.java b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulConfig.java new file mode 100644 index 00000000000..05e61089eea --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulConfig.java @@ -0,0 +1,11 @@ +package org.prebid.server.bidder.contxtful.request; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ContxtfulConfig { + + @JsonProperty("contxtful") + ContxtfulConfigDetails details; +} diff --git a/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulConfigDetails.java b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulConfigDetails.java new file mode 100644 index 00000000000..0e144646431 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/contxtful/request/ContxtfulConfigDetails.java @@ -0,0 +1,11 @@ +package org.prebid.server.bidder.contxtful.request; + +import lombok.Value; + +@Value(staticConstructor = "of") +public class ContxtfulConfigDetails { + + String version; + + String customer; +} diff --git a/src/main/java/org/prebid/server/bidder/contxtful/response/ContxtfulBid.java b/src/main/java/org/prebid/server/bidder/contxtful/response/ContxtfulBid.java new file mode 100644 index 00000000000..d7eafc62b5a --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/contxtful/response/ContxtfulBid.java @@ -0,0 +1,56 @@ +package org.prebid.server.bidder.contxtful.response; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.databind.node.ObjectNode; +import lombok.Builder; +import lombok.Value; + +import java.math.BigDecimal; + +@Builder +@Value(staticConstructor = "of") +public class ContxtfulBid { + + @JsonProperty("requestId") + String requestId; + + BigDecimal cpm; + + String currency; + + Integer width; + + Integer height; + + @JsonProperty("creativeId") + String creativeId; + + String adm; + + Integer ttl; + + @JsonProperty("netRevenue") + Boolean netRevenue; + + @JsonProperty("mediaType") + String mediaType; + + @JsonProperty("bidderCode") + String bidderCode; + + @JsonProperty("placementId") + String placementId; + + @JsonProperty("traceId") + String traceId; + + BigDecimal random; + + String nurl; + + String burl; + + String lurl; + + ObjectNode ext; +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/contxtful/ExtImpContxtful.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/contxtful/ExtImpContxtful.java new file mode 100644 index 00000000000..14e38b06e9c --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/contxtful/ExtImpContxtful.java @@ -0,0 +1,14 @@ +package org.prebid.server.proto.openrtb.ext.request.contxtful; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpContxtful { + + @JsonProperty("placementId") + String placementId; + + @JsonProperty("customerId") + String customerId; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/ContxtfulConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/ContxtfulConfiguration.java new file mode 100644 index 00000000000..0759f38bc17 --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/ContxtfulConfiguration.java @@ -0,0 +1,41 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.contxtful.ContxtfulBidder; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.spring.config.bidder.model.BidderConfigurationProperties; +import org.prebid.server.spring.config.bidder.util.BidderDepsAssembler; +import org.prebid.server.spring.config.bidder.util.UsersyncerCreator; +import org.prebid.server.spring.env.YamlPropertySourceFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.PropertySource; + +import jakarta.validation.constraints.NotBlank; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/contxtful.yaml", factory = YamlPropertySourceFactory.class) +public class ContxtfulConfiguration { + + private static final String BIDDER_NAME = "contxtful"; + + @Bean("contxtfulConfigurationProperties") + @ConfigurationProperties("adapters.contxtful") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps contxtfulBidderDeps(BidderConfigurationProperties contxtfulConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(contxtfulConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new ContxtfulBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/contxtful.yaml b/src/main/resources/bidder-config/contxtful.yaml new file mode 100644 index 00000000000..cb273e9ebf1 --- /dev/null +++ b/src/main/resources/bidder-config/contxtful.yaml @@ -0,0 +1,21 @@ +adapters: + contxtful: + endpoint: https://prebid.receptivity.io/v1/pbs/{{AccountId}}/bid + meta-info: + maintainer-email: contact@contxtful.com + app-media-types: + - banner + - video + - native + site-media-types: + - banner + - video + - native + supported-vendors: + vendor-id: 0 + usersync: + cookie-family-name: contxtful + iframe: + url: https://sync.receptivity.io/pbs/iframe?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&gpp={{gpp}}&gpp_sid={{gpp_sid}}&redirect={{.redirect_url}} + support-cors: false + uid-macro: '$UID' diff --git a/src/main/resources/static/bidder-params/contxtful.json b/src/main/resources/static/bidder-params/contxtful.json new file mode 100644 index 00000000000..18b44b46f58 --- /dev/null +++ b/src/main/resources/static/bidder-params/contxtful.json @@ -0,0 +1,22 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Contxtful Adapter Params", + "description": "A schema which validates params for the Contxtful adapter", + "type": "object", + "properties": { + "placementId": { + "type": "string", + "description": "Placement ID", + "minLength": 1 + }, + "customerId": { + "type": "string", + "description": "Customer ID used to build the endpoint URL", + "minLength": 1 + } + }, + "required": [ + "placementId", + "customerId" + ] +} diff --git a/src/test/java/org/prebid/server/bidder/contxtful/ContxtfulBidderTest.java b/src/test/java/org/prebid/server/bidder/contxtful/ContxtfulBidderTest.java new file mode 100644 index 00000000000..1606a8b4a9f --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/contxtful/ContxtfulBidderTest.java @@ -0,0 +1,390 @@ +package org.prebid.server.bidder.contxtful; + +import com.fasterxml.jackson.core.JsonProcessingException; +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.request.User; +import com.iab.openrtb.request.Video; +import com.iab.openrtb.response.Bid; +import org.junit.jupiter.api.Test; +import org.prebid.server.VertxTest; +import org.prebid.server.bidder.contxtful.request.ContxtfulBidRequest; +import org.prebid.server.bidder.contxtful.request.ContxtfulBidRequestParams; +import org.prebid.server.bidder.contxtful.request.ContxtfulBidderRequest; +import org.prebid.server.bidder.contxtful.request.ContxtfulCompositeRequest; +import org.prebid.server.bidder.contxtful.request.ContxtfulConfig; +import org.prebid.server.bidder.contxtful.request.ContxtfulConfigDetails; +import org.prebid.server.bidder.contxtful.response.ContxtfulBid; +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.ExtUser; +import org.prebid.server.proto.openrtb.ext.request.ExtUserPrebid; +import org.prebid.server.proto.openrtb.ext.request.contxtful.ExtImpContxtful; +import org.prebid.server.proto.openrtb.ext.response.BidType; + +import java.math.BigDecimal; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.UnaryOperator; +import java.util.stream.Stream; + +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.badServerResponse; +import static org.prebid.server.util.HttpUtil.ACCEPT_HEADER; +import static org.prebid.server.util.HttpUtil.APPLICATION_JSON_CONTENT_TYPE; +import static org.prebid.server.util.HttpUtil.CONTENT_TYPE_HEADER; +import static org.springframework.util.MimeTypeUtils.APPLICATION_JSON_VALUE; + +public class ContxtfulBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://test.endpoint.com/?customer={{AccountId}}"; + private static final String BIDDER_NAME = "contxtful"; + + private final ContxtfulBidder target = new ContxtfulBidder(ENDPOINT_URL, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException().isThrownBy(() -> new ContxtfulBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldReturnErrorIfImpExtCouldNotBeParsed() { + // given + final BidRequest bidRequest = givenBidRequest( + imp -> imp.ext(mapper.valueToTree(ExtPrebid.of(null, mapper.createArrayNode())))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + assertThat(error.getMessage()).startsWith("Error parsing imp.ext for impression impId"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldCreateCorrectUri() { + // given + final BidRequest bidRequest = givenBidRequest( + imp -> imp.ext(givenImpExt("customer1", "placement1")), + imp -> imp.ext(givenImpExt("customer2", "placement2"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1).first() + .extracting(HttpRequest::getUri) + .isEqualTo("https://test.endpoint.com/?customer=customer1"); + } + + @Test + public void makeHttpRequestsShouldSetCorrectHeaders() { + // given + final BidRequest bidRequest = givenBidRequest( + imp -> imp.ext(givenImpExt("customer1", "placement1"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1).first() + .extracting(HttpRequest::getHeaders) + .satisfies(headers -> { + assertThat(headers.get(CONTENT_TYPE_HEADER)).isEqualTo(APPLICATION_JSON_CONTENT_TYPE); + assertThat(headers.get(ACCEPT_HEADER)).isEqualTo(APPLICATION_JSON_VALUE); + }); + } + + @Test + public void makeHttpRequestsShouldCreateCorrectPayload() { + // given + final BidRequest bidRequest = givenBidRequest( + imp -> imp.id("imp1").ext(givenImpExt("customer1", "placement1")), + imp -> imp.id("imp2").ext(givenImpExt("customer2", "placement2"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + final ContxtfulCompositeRequest expectedPayload = ContxtfulCompositeRequest.builder() + .ortb2Request(bidRequest) + .bidRequests(List.of( + ContxtfulBidRequest.of(BIDDER_NAME, ContxtfulBidRequestParams.of("placement1"), "imp1"), + ContxtfulBidRequest.of(BIDDER_NAME, ContxtfulBidRequestParams.of("placement2"), "imp2"))) + .bidderRequest(ContxtfulBidderRequest.of(BIDDER_NAME)) + .config(ContxtfulConfig.of(ContxtfulConfigDetails.of("v1", "customer1"))) + .build(); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1).first() + .satisfies(httpRequest -> { + assertThat(httpRequest.getPayload()).isEqualTo(expectedPayload); + assertThat(httpRequest.getBody()).isEqualTo(jacksonMapper.encodeToBytes(expectedPayload)); + }); + } + + @Test + public void makeHttpRequestsShouldSendCorrectSetOfImpIds() { + // given + final BidRequest bidRequest = givenBidRequest( + imp -> imp.id("imp1").ext(givenImpExt("customer1", "placement1")), + imp -> imp.id("imp2").ext(givenImpExt("customer2", "placement2"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + final ContxtfulCompositeRequest expectedPayload = ContxtfulCompositeRequest.builder() + .ortb2Request(bidRequest) + .bidRequests(List.of( + ContxtfulBidRequest.of(BIDDER_NAME, ContxtfulBidRequestParams.of("placement1"), "imp1"), + ContxtfulBidRequest.of(BIDDER_NAME, ContxtfulBidRequestParams.of("placement2"), "imp2"))) + .bidderRequest(ContxtfulBidderRequest.of(BIDDER_NAME)) + .config(ContxtfulConfig.of(ContxtfulConfigDetails.of("v1", "customer1"))) + .build(); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1).first() + .extracting(HttpRequest::getImpIds) + .isEqualTo(Set.of("imp1", "imp2")); + } + + @Test + public void makeHttpRequestsShouldModifyUserBuyerUidFromExt() { + // given + final ExtUser extUser = ExtUser.builder() + .prebid(ExtUserPrebid.of(Map.of(BIDDER_NAME, "user-id-from-ext"))) + .build(); + final User user = User.builder().ext(extUser).build(); + final BidRequest bidRequest = givenBidRequest(user, imp -> imp.ext(givenImpExt("customer", "placement"))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1).first() + .extracting(HttpRequest::getPayload) + .extracting(ContxtfulCompositeRequest::getOrtb2Request) + .extracting(BidRequest::getUser) + .isEqualTo(user.toBuilder().buyeruid("user-id-from-ext").build()); + } + + @Test + public void makeBidsShouldReturnErrorWhenResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = BidderCall.succeededHttp( + HttpRequest.builder().build(), + HttpResponse.of(200, null, "invalid_json"), + null); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + assertThat(error.getMessage()).startsWith("Failed to decode: Unrecognized token 'invalid_json'"); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnBannerBid() throws JsonProcessingException { + // given + final ContxtfulBid responseBid = givenContxtfulBid("imp1", "banner", 1); + final BidderCall httpCall = givenHttpCall(singletonList(responseBid)); + final BidRequest bidRequest = BidRequest.builder().imp(singletonList(Imp.builder().id("imp1").build())).build(); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + final Bid expectedBid = Bid.builder() + .id("contxtful-imp1") + .impid("imp1") + .price(BigDecimal.ONE) + .adm("adm") + .w(300) + .h(250) + .crid("crid") + .nurl("nurl") + .burl("burl") + .lurl("lurl") + .ext(mapper.createObjectNode()) + .build(); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(BidderBid.of(expectedBid, BidType.banner, "USD")); + } + + @Test + public void makeBidsShouldReturnVideoBid() throws JsonProcessingException { + // given + final ContxtfulBid responseBid = givenContxtfulBid("imp1", "video", 2); + final BidderCall httpCall = givenHttpCall(singletonList(responseBid)); + final BidRequest bidRequest = BidRequest.builder() + .imp(singletonList(Imp.builder().id("imp1").video(Video.builder().build()).build())).build(); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + final Bid expectedBid = Bid.builder() + .id("contxtful-imp1") + .impid("imp1") + .price(BigDecimal.valueOf(2)) + .adm("adm") + .w(300) + .h(250) + .crid("crid") + .nurl("nurl") + .burl("burl") + .lurl("lurl") + .ext(mapper.createObjectNode()) + .build(); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(BidderBid.of(expectedBid, BidType.video, "USD")); + } + + @Test + public void makeBidsShouldReturnNativeBid() throws JsonProcessingException { + // given + final ContxtfulBid responseBid = givenContxtfulBid("imp1", "native", 2); + final BidderCall httpCall = givenHttpCall(singletonList(responseBid)); + final BidRequest bidRequest = BidRequest.builder() + .imp(singletonList(Imp.builder().id("imp1").xNative(Native.builder().build()).build())) + .build(); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + final Bid expectedBid = Bid.builder() + .id("contxtful-imp1") + .impid("imp1") + .price(BigDecimal.valueOf(2)) + .adm("adm") + .w(300) + .h(250) + .crid("crid") + .nurl("nurl") + .burl("burl") + .lurl("lurl") + .ext(mapper.createObjectNode()) + .build(); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsExactly(BidderBid.of(expectedBid, BidType.xNative, "USD")); + } + + @Test + public void makeBidsShouldReturnErrorsForInvalidBids() throws JsonProcessingException { + // given + final ContxtfulBid validBid = givenContxtfulBid("imp1", "anyType", 1); + final ContxtfulBid invalidBidNoAdm = ContxtfulBid.builder() + .requestId("imp2") + .mediaType("banner") + .cpm(BigDecimal.ONE) + .adm("") + .build(); + final ContxtfulBid invalidBidNoMediaType = ContxtfulBid.builder() + .requestId("imp3") + .mediaType("") + .cpm(BigDecimal.ONE) + .adm("adm") + .build(); + + final BidderCall httpCall = givenHttpCall( + List.of(validBid, invalidBidNoAdm, invalidBidNoMediaType)); + final BidRequest bidRequest = BidRequest.builder() + .imp(List.of( + Imp.builder().id("imp1").build(), + Imp.builder().id("imp2").build(), + Imp.builder().id("imp3").build())) + .build(); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + final Bid expectedBid = Bid.builder() + .id("contxtful-imp1") + .impid("imp1") + .price(BigDecimal.ONE) + .adm("adm") + .w(300) + .h(250) + .crid("crid") + .nurl("nurl") + .burl("burl") + .lurl("lurl") + .ext(mapper.createObjectNode()) + .build(); + + assertThat(result.getErrors()).containsExactlyInAnyOrder( + badServerResponse("bid imp2 has no ad markup"), + badServerResponse("bid imp3 has no ad media type")); + + assertThat(result.getValue()).containsExactly(BidderBid.of(expectedBid, BidType.banner, "USD")); + } + + private static BidRequest givenBidRequest(UnaryOperator... impCustomizers) { + return givenBidRequest(null, impCustomizers); + } + + private static BidRequest givenBidRequest(User user, UnaryOperator... impCustomizers) { + final List imps = Stream.of(impCustomizers) + .map(customizer -> customizer.apply(Imp.builder().id("impId")).build()) + .toList(); + + return BidRequest.builder().imp(imps).user(user).build(); + } + + private static ObjectNode givenImpExt(String customerId, String placementId) { + return mapper.valueToTree(ExtPrebid.of(null, ExtImpContxtful.of(placementId, customerId))); + } + + private static ContxtfulBid givenContxtfulBid(String requestId, String mediaType, int price) { + return ContxtfulBid.builder() + .requestId(requestId) + .mediaType(mediaType) + .cpm(BigDecimal.valueOf(price)) + .adm("adm") + .width(300) + .height(250) + .creativeId("crid") + .nurl("nurl") + .burl("burl") + .lurl("lurl") + .ext(mapper.createObjectNode()) + .build(); + } + + private static BidderCall givenHttpCall(List bids) + throws JsonProcessingException { + + return BidderCall.succeededHttp( + HttpRequest.builder().build(), + HttpResponse.of(200, null, mapper.writeValueAsString(bids)), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/ContxtfulTest.java b/src/test/java/org/prebid/server/it/ContxtfulTest.java new file mode 100644 index 00000000000..2172b904114 --- /dev/null +++ b/src/test/java/org/prebid/server/it/ContxtfulTest.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 ContxtfulTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromContxtful() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/contxtful-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/contxtful/test-contxtful-bid-request.json"))) + .willReturn(aResponse().withBody( + jsonFrom("openrtb2/contxtful/test-contxtful-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/contxtful/test-auction-contxtful-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/contxtful/test-auction-contxtful-response.json", response, + singletonList("contxtful")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-auction-contxtful-request.json b/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-auction-contxtful-request.json new file mode 100644 index 00000000000..b7c25e7357f --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-auction-contxtful-request.json @@ -0,0 +1,44 @@ +{ + "id": "test-request-banner", + "imp": [ + { + "id": "test-imp-banner", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "ext": { + "contxtful": { + "customerId": "DEMO123", + "placementId": "banner-placement-1" + } + } + } + ], + "site": { + "id": "demo-site", + "domain": "example.com", + "page": "https://example.com/demo", + "publisher": { + "id": "demo-publisher" + } + }, + "device": { + "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36", + "ip": "192.0.2.1", + "language": "en", + "dnt": 0 + }, + "user": { + "id": "demo-user" + }, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-auction-contxtful-response.json b/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-auction-contxtful-response.json new file mode 100644 index 00000000000..6817b291056 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-auction-contxtful-response.json @@ -0,0 +1,47 @@ +{ + "id": "test-request-banner", + "seatbid": [ + { + "seat": "contxtful", + "bid": [ + { + "id": "contxtful-test-imp-banner", + "impid": "test-imp-banner", + "price": 2.50, + "adm": "
Contxtful Demo Ad
", + "w": 300, + "h": 250, + "crid": "demo-creative-123", + "nurl": "https://monitoring.receptivity.io/v1/pbs/DEMO123/pbs-impression?b=contxtful-test-imp-banner&a=DEMO123&bidder=contxtful&impId=test-imp-banner&price=2.50&traceId=&random=0.000000&domain=example.com&adRequestId=test-request-banner&w=300&h=250&f=b", + "burl": "https://monitoring.receptivity.io/v1/pbs/DEMO123/pbs-billing?b=contxtful-test-imp-banner&a=DEMO123&bidder=contxtful&impId=test-imp-banner&price=2.50&traceId=&random=0.000000&domain=example.com&adRequestId=test-request-banner&w=300&h=250&f=b", + "exp": 300, + "ext": { + "contxtful": { + "reseller": "demo-reseller", + "version": "v1.0" + }, + "origbidcpm": 2.50, + "origbidcur": "USD", + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "contxtful" + } + } + } + } + ], + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "contxtful": "{{ contxtful.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-contxtful-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-contxtful-bid-request.json new file mode 100644 index 00000000000..c75b7002e29 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-contxtful-bid-request.json @@ -0,0 +1,91 @@ +{ + "bidRequests": [ + { + "bidId": "test-imp-banner", + "bidder": "contxtful", + "params": { + "placementId": "banner-placement-1" + } + } + ], + "bidderRequest": { + "bidderCode": "contxtful" + }, + "config": { + "contxtful": { + "customer": "DEMO123", + "version": "v1" + } + }, + "ortb2": { + "id": "test-request-banner", + "imp": [ + { + "id": "test-imp-banner", + "banner": { + "format": [ + { + "w": 300, + "h": 250 + } + ] + }, + "secure": 1, + "ext": { + "tid": "${json-unit.any-string}", + "bidder": { + "customerId": "DEMO123", + "placementId": "banner-placement-1" + } + } + } + ], + "site": { + "id": "demo-site", + "domain": "example.com", + "page": "https://example.com/demo", + "publisher": { + "id": "demo-publisher", + "domain": "example.com" + }, + "ext": { + "amp": 0 + } + }, + "device": { + "dnt": 0, + "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36", + "ip": "192.0.2.1", + "language": "en" + }, + "user": { + "id": "demo-user" + }, + "at": 1, + "tmax": "${json-unit.any-number}", + "cur": [ + "USD" + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "regs": { + "ext": { + "gdpr": 0 + } + }, + "ext": { + "prebid": { + "channel": { + "name": "web" + }, + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "endpoint": "/openrtb2/auction" + } + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-contxtful-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-contxtful-bid-response.json new file mode 100644 index 00000000000..697faf74649 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/contxtful/test-contxtful-bid-response.json @@ -0,0 +1,22 @@ +[ + { + "cpm": 2.50, + "width": 300, + "height": 250, + "currency": "USD", + "requestId": "test-imp-banner", + "adm": "
Contxtful Demo Ad
", + "ttl": 300, + "creativeId": "demo-creative-123", + "netRevenue": true, + "mediaType": "banner", + "nurl": "https://monitoring.receptivity.io/v1/pbs/DEMO123/pbs-impression?b=contxtful-test-imp-banner&a=DEMO123&bidder=contxtful&impId=test-imp-banner&price=2.50&traceId=&random=0.000000&domain=example.com&adRequestId=test-request-banner&w=300&h=250&f=b", + "burl": "https://monitoring.receptivity.io/v1/pbs/DEMO123/pbs-billing?b=contxtful-test-imp-banner&a=DEMO123&bidder=contxtful&impId=test-imp-banner&price=2.50&traceId=&random=0.000000&domain=example.com&adRequestId=test-request-banner&w=300&h=250&f=b", + "ext": { + "contxtful": { + "reseller": "demo-reseller", + "version": "v1.0" + } + } + } +] 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 3d57277ff9d..acdcb2f4c5a 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -199,6 +199,8 @@ adapters.coinzilla.enabled=true adapters.coinzilla.endpoint=http://localhost:8090/coinzilla-exchange adapters.consumable.enabled=true adapters.consumable.endpoint=http://localhost:8090/consumable-exchange +adapters.contxtful.enabled=true +adapters.contxtful.endpoint=http://localhost:8090/contxtful-exchange adapters.copper6ssp.enabled=true adapters.copper6ssp.endpoint=http://localhost:8090/copper6ssp-exchange adapters.criteo.enabled=true From 76e594f21c83cf9766377e50b3ff250fd08a43e6 Mon Sep 17 00:00:00 2001 From: antonbabak Date: Mon, 20 Oct 2025 12:54:02 +0200 Subject: [PATCH 2/2] fix comments --- src/main/resources/bidder-config/contxtful.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/resources/bidder-config/contxtful.yaml b/src/main/resources/bidder-config/contxtful.yaml index cb273e9ebf1..086eb92c1dc 100644 --- a/src/main/resources/bidder-config/contxtful.yaml +++ b/src/main/resources/bidder-config/contxtful.yaml @@ -16,6 +16,6 @@ adapters: usersync: cookie-family-name: contxtful iframe: - url: https://sync.receptivity.io/pbs/iframe?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&gpp={{gpp}}&gpp_sid={{gpp_sid}}&redirect={{.redirect_url}} + url: https://sync.receptivity.io/pbs/iframe?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&gpp={{gpp}}&gpp_sid={{gpp_sid}}&redirect={{redirect_url}} support-cors: false uid-macro: '$UID'