New Adapter: Adswag

src/main/java/org/prebid/server/bidder/adswag/AdswagBidder.java

@@ -0,0 +1,371 @@
+package org.prebid.server.bidder.adswag;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.iab.openrtb.request.App;
+import com.iab.openrtb.request.Banner;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Format;
+import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.request.Publisher;
+import com.iab.openrtb.request.Site;
+import com.iab.openrtb.response.Bid;
+import com.iab.openrtb.response.BidResponse;
+import com.iab.openrtb.response.SeatBid;
+import org.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.prebid.server.bidder.Bidder;
+import org.prebid.server.bidder.model.BidderBid;
+import org.prebid.server.bidder.model.BidderCall;
+import org.prebid.server.bidder.model.BidderError;
+import org.prebid.server.bidder.model.HttpRequest;
+import org.prebid.server.bidder.model.Result;
+import org.prebid.server.exception.PreBidException;
+import org.prebid.server.json.DecodeException;
+import org.prebid.server.json.JacksonMapper;
+import org.prebid.server.proto.openrtb.ext.ExtPrebid;
+import org.prebid.server.proto.openrtb.ext.request.adswag.ExtImpAdswag;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.util.BidderUtil;
+import org.prebid.server.util.HttpUtil;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.regex.Pattern;
+
+/**
+ * Adswag {@link Bidder} implementation.
+ * <p>
+ * The Adswag bid endpoint speaks plain OpenRTB 2.6 JSON in/out and answers a
+ * no-bid as an empty-body HTTP 200 (its Prebid.js contract) as well as the
+ * conventional 204.
+ * <p>
+ * Display (banner) bids carry markup in adm (a loader script tag that
+ * injects the composed creative into the containing frame at render time);
+ * it passes through unchanged. bid.ext.adswag.serve_url remains populated
+ * as a legacy fallback: if adm is ever absent, the adapter synthesizes an
+ * iframe tag around that URL so the bid still carries renderable markup
+ * for every PBS consumer (network-equivalent to the Prebid.js adapter's
+ * adUrl render).
+ * Video and audio bids carry VAST markup in adm and pass through unchanged.
+ */
+public class AdswagBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpAdswag>> TYPE_REFERENCE = new TypeReference<>() {
+    };
+
+    private static final String DEFAULT_CURRENCY = "EUR";
+    private static final Pattern VAST_MARKUP = Pattern.compile("<\\s*VAST[\\s/>]", Pattern.CASE_INSENSITIVE);
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public AdswagBidder(String endpointUrl, JacksonMapper mapper) {
+        this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
+        this.mapper = Objects.requireNonNull(mapper);
+    }
+
+    /**
+     * The endpoint resolves the supply-side publisher from site.publisher.id /
+     * app.publisher.id, and the bidder param is the source of truth for that
+     * value. Both are REQUEST-level fields, so imps are grouped by their
+     * publisherId and each group is sent as its own request: PBS hands an
+     * adapter every imp that named the bidder regardless of the bidder params
+     * inside them, and those imps may legitimately belong to different Adswag
+     * publisher accounts. Folding them into one request would report — and
+     * pay — every impression under whichever account happened to come first.
+     * Groups keep the order of their first imp.
+     */
+    @Override
+    public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest request) {
+        final Map<String, List<Imp>> impsByPublisher = new LinkedHashMap<>();
+        final List<BidderError> errors = new ArrayList<>();
+
+        for (Imp imp : request.getImp()) {
+            final ExtImpAdswag extImpAdswag;
+            try {
+                extImpAdswag = parseImpExt(imp);
+                validateImpExt(extImpAdswag, imp.getId());
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+                continue;
+            }
+
+            impsByPublisher
+                    .computeIfAbsent(extImpAdswag.getPublisherId(), key -> new ArrayList<>())
+                    .add(modifyImp(imp, extImpAdswag.getPlacementId()));
+        }
+
+        if (impsByPublisher.isEmpty()) {
+            return Result.withErrors(errors);
+        }
+
+        // Request-level and identical for every group, so it is checked once.
+        if (request.getSite() == null && request.getApp() == null) {
+            errors.add(BidderError.badInput("request must contain either site or app"));
+            return Result.withErrors(errors);
+        }
+
+        final List<HttpRequest<BidRequest>> httpRequests = impsByPublisher.entrySet().stream()
+                .map(group -> modifyBidRequest(request, group.getKey(), group.getValue()))
+                .map(modifiedRequest -> BidderUtil.defaultRequest(modifiedRequest, endpointUrl, mapper))
+                .toList();
+
+        return Result.of(httpRequests, errors);
+    }
+
+    private ExtImpAdswag parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException("Error parsing imp.ext for impression " + imp.getId());
+        }
+    }
+
+    private static void validateImpExt(ExtImpAdswag extImpAdswag, String impId) {
+        if (extImpAdswag == null || StringUtils.isBlank(extImpAdswag.getPublisherId())) {
+            throw new PreBidException("missing publisherId for imp " + impId);
+        }
+    }
+
+    /**
+     * Rewrites imp.ext into the shape the Adswag endpoint expects: the
+     * prebid/bidder envelopes are removed and an optional placementId
+     * override moves to ext.adswag.placement_id. Standard placement-identity
+     * fields (gpid, tid, data.pbadslot) stay where PBS core put them.
+     */
+    private static Imp modifyImp(Imp imp, String placementId) {
+        final ObjectNode modifiedExt = imp.getExt().deepCopy();
+        modifiedExt.remove("bidder");
+        modifiedExt.remove("prebid");
+        if (StringUtils.isNotBlank(placementId)) {
+            modifiedExt.putObject("adswag").put("placement_id", placementId);
+        }
+
+        return imp.toBuilder().ext(modifiedExt.isEmpty() ? null : modifiedExt).build();
+    }
+
+    private static BidRequest modifyBidRequest(BidRequest request, String publisherId, List<Imp> modifiedImps) {
+        return request.toBuilder()
+                .site(modifySite(request.getSite(), publisherId))
+                .app(modifyApp(request.getApp(), publisherId))
+                .imp(modifiedImps)
+                .build();
+    }
+
+    private static Site modifySite(Site site, String publisherId) {
+        return site != null
+                ? site.toBuilder().publisher(modifyPublisher(site.getPublisher(), publisherId)).build()
+                : null;
+    }
+
+    private static App modifyApp(App app, String publisherId) {
+        return app != null
+                ? app.toBuilder().publisher(modifyPublisher(app.getPublisher(), publisherId)).build()
+                : null;
+    }
+
+    private static Publisher modifyPublisher(Publisher publisher, String publisherId) {
+        return Optional.ofNullable(publisher)
+                .map(Publisher::toBuilder)
+                .orElseGet(Publisher::builder)
+                .id(publisherId)
+                .build();
+    }
+
+    @Override
+    public final Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
+        final String body = httpCall.getResponse().getBody();
+        if (StringUtils.isBlank(body)) {
+            return Result.empty();
+        }
+
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(body, BidResponse.class);
+            final List<BidderError> errors = new ArrayList<>();
+            final List<BidderBid> bids = extractBids(httpCall.getRequest().getPayload(), bidResponse, errors);
+            return Result.of(bids, errors);
+        } catch (DecodeException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private List<BidderBid> extractBids(BidRequest bidRequest, BidResponse bidResponse, List<BidderError> errors) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+
+        final String currency = StringUtils.defaultIfBlank(bidResponse.getCur(), DEFAULT_CURRENCY);
+        return bidResponse.getSeatbid().stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .flatMap(List::stream)
+                .filter(Objects::nonNull)
+                .map(bid -> makeBidderBid(bid, bidRequest.getImp(), currency, errors))
+                .filter(Objects::nonNull)
+                .toList();
+    }
+
+    private BidderBid makeBidderBid(Bid bid, List<Imp> imps, String currency, List<BidderError> errors) {
+        final Imp imp = findImp(imps, bid.getImpid());
+        if (imp == null) {
+            errors.add(BidderError.badServerResponse(
+                    "bid %s references unknown imp %s".formatted(bid.getId(), bid.getImpid())));
+            return null;
+        }
+
+        final String serveUrl = serveUrl(bid);
+        if (StringUtils.isBlank(bid.getAdm()) && StringUtils.isBlank(serveUrl)) {
+            errors.add(BidderError.badServerResponse(
+                    "bid %s has neither adm nor ext.adswag.serve_url".formatted(bid.getId())));
+            return null;
+        }
+
+        final BidType bidType;
+        try {
+            bidType = resolveBidType(imp, bid);
+        } catch (PreBidException e) {
+            errors.add(BidderError.badServerResponse(e.getMessage()));
+            return null;
+        }
+
+        return BidderBid.of(materializeBid(bid, bidType, serveUrl, imp), bidType, currency);
+    }
+
+    private static String serveUrl(Bid bid) {
+        final JsonNode serveUrlNode = bid.getExt() != null
+                ? bid.getExt().path("adswag").path("serve_url")
+                : null;
+        return serveUrlNode != null && serveUrlNode.isTextual() ? serveUrlNode.textValue() : null;
+    }
+
+    /**
+     * Resolves the bid's media type, mirroring the Prebid.js adapter and the
+     * endpoint's per-imp channel precedence (banner &gt; audio &gt; video):
+     * VAST markup on an imp that declares audio is an audio bid, VAST on a
+     * video imp is a video bid, everything else is banner. bid.mtype is
+     * honored first when present (the endpoint does not currently set it).
+     */
+    private static BidType resolveBidType(Imp imp, Bid bid) {
+        final Integer mtype = bid.getMtype();
+        if (mtype != null) {
+            return switch (mtype) {
+                case 1 -> BidType.banner;
+                case 2 -> BidType.video;
+                case 3 -> BidType.audio;
+                default -> throw new PreBidException(
+                        "unsupported bid.mtype %d for impression %s".formatted(mtype, bid.getImpid()));
+            };
+        }
+
+        final boolean isVast = bid.getAdm() != null && VAST_MARKUP.matcher(bid.getAdm()).find();
+        if (imp.getAudio() != null && (isVast || imp.getBanner() == null)) {
+            return BidType.audio;
+        }
+        if (imp.getVideo() != null && (isVast || imp.getBanner() == null)) {
+            return BidType.video;
+        }
+        if (imp.getBanner() != null) {
+            return BidType.banner;
+        }
+        throw new PreBidException("unable to resolve media type for impression " + bid.getImpid());
+    }
+
+    /**
+     * Materializes markup for display bids served by URL and backfills the
+     * bid size from the requested primary size (the endpoint omits w/h).
+     */
+    private static Bid materializeBid(Bid bid, BidType bidType, String serveUrl, Imp imp) {
+        final Bid.BidBuilder builder = bid.toBuilder();
+        final boolean hasSize = bid.getW() != null && bid.getW() > 0 && bid.getH() != null && bid.getH() > 0;
+
+        switch (bidType) {
+            case banner -> {
+                final Format size = bannerSize(imp.getBanner());
+                if (StringUtils.isBlank(bid.getAdm())) {
+                    builder.adm(iframeMarkup(serveUrl, size));
+                }
+                if (!hasSize && size != null) {
+                    builder.w(size.getW()).h(size.getH());
+                }
+                builder.mtype(1);
+            }
+            case video -> {
+                if (StringUtils.isBlank(bid.getAdm())) {
+                    // VAST by URL: nurl is the conventional PBS carrier
+                    // (cached / rendered as vastUrl downstream).
+                    builder.nurl(serveUrl);
+                }
+                final com.iab.openrtb.request.Video video = imp.getVideo();
+                if (!hasSize && video != null && video.getW() != null && video.getH() != null) {
+                    builder.w(video.getW()).h(video.getH());
+                }
+                builder.mtype(2);
+            }
+            case audio -> {
+                if (StringUtils.isBlank(bid.getAdm())) {
+                    builder.nurl(serveUrl);
+                }
+                builder.mtype(3);
+            }
+            default -> {
+                // banner/video/audio are the only resolvable types
+            }
+        }
+
+        return builder.build();
+    }
+
+    private static Imp findImp(List<Imp> imps, String impId) {
+        return imps.stream()
+                .filter(imp -> Objects.equals(imp.getId(), impId))
+                .findFirst()
+                .orElse(null);
+    }
+
+    private static Format bannerSize(Banner banner) {
+        if (banner == null) {
+            return null;
+        }
+        if (CollectionUtils.isNotEmpty(banner.getFormat())) {
+            return banner.getFormat().getFirst();
+        }
+        if (banner.getW() != null && banner.getH() != null) {
+            return Format.builder().w(banner.getW()).h(banner.getH()).build();
+        }
+        return null;
+    }
+
+    /**
+     * Wraps a serve URL in an iframe tag; fetching the iframe src at render
+     * time is network-equivalent to Prebid.js rendering the URL as adUrl.
+     */
+    private static String iframeMarkup(String serveUrl, Format size) {
+        final StringBuilder markup = new StringBuilder();
+        markup.append("<iframe src=\"").append(escapeHtmlAttribute(serveUrl)).append("\"");
+        if (size != null && size.getW() != null && size.getH() != null) {
+            markup.append(" width=\"").append(size.getW()).append("\"")
+                    .append(" height=\"").append(size.getH()).append("\"");
+        }
+        markup.append(" frameborder=\"0\" scrolling=\"no\" marginheight=\"0\" marginwidth=\"0\"")
+                .append(" style=\"border:0\" title=\"Advertisement\"></iframe>");
+        return markup.toString();
+    }
+
+    // Mirrors Go's html.EscapeString so both server adapters emit identical markup.
+    private static String escapeHtmlAttribute(String value) {
+        return value
+                .replace("&", "&amp;")
+                .replace("'", "&#39;")
+                .replace("<", "&lt;")
+                .replace(">", "&gt;")
+                .replace("\"", "&#34;");
+    }
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/adswag/ExtImpAdswag.java

@@ -0,0 +1,14 @@
+package org.prebid.server.proto.openrtb.ext.request.adswag;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Value;
+
+@Value(staticConstructor = "of")
+public class ExtImpAdswag {
+
+    @JsonProperty("publisherId")
+    String publisherId;
+
+    @JsonProperty("placementId")
+    String placementId;
+}