Teal: new adapter

[ollyburns]

🔧 Type of changes

• new bid adapter
• bid adapter update
• new feature
• new analytics adapter
• new module
• module update
• bugfix
• documentation
• configuration
• dependency update
• tech debt (test coverage, refactorings, etc.)

✨ What's the context?

Bid adapter for Teal SSP

🧠 Rationale behind the change

Enable publishers to access Teal demand via Prebid Server.
Needs its own adapter as parameters and custom ext fields required.

🔎 New Bid Adapter Checklist

• verify email contact works
• NO fully dynamic hostnames
• geographic host parameters are NOT required
• direct use of HTTP is prohibited - implement an existing Bidder interface that will do all the job
• if the ORTB is just forwarded to the endpoint, use the generic adapter - define the new adapter as the alias of the generic adapter
• cover an adapter configuration with an integration test

🧪 Test plan

Has been tested on Teal's own fork of Prebid Server Java

🏎 Quality check

• Are your changes following our code style guidelines?
• Are there any breaking changes in your code?
• Does your test coverage exceed 90%?
• Are there any erroneous console logs, debuggers or leftover code in your changes?

[CTMBNara]

Add an empty line between these lines

[CTMBNara]

    public TealBidder(String endpointUrl, JacksonMapper mapper) {
        this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
        this.mapper = Objects.requireNonNull(mapper);
    }

[CTMBNara]

Inline this method

[CTMBNara]

Since the 'account' property is marked as 'required' in the 'teal.json' file, it will be present in every imp object, so we can move the validation and reading of this parameter.

If 'required' was added by mistake and the parameter is expected only in the first imp, then move the account validation so that it appears after the loop.

    @Override
    public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest request) {
        final List<Imp> modifiedImps = new ArrayList<>();
        final List<BidderError> errors = new ArrayList<>();
        String account = null;

        for (Imp imp : request.getImp()) {
            final ExtImpTeal extImpTeal;
            try {
                extImpTeal = parseImpExt(imp);
                validateImpExt(extImpTeal);
            } catch (PreBidException e) {
                errors.add(BidderError.badInput(e.getMessage()));
                continue;
            }

            account = account == null ? extImpTeal.getAccount() : account;
            modifiedImps.add(modifyImp(imp, extImpTeal.getPlacement()));
        }

        if (modifiedImps.isEmpty()) {
            return Result.withErrors(errors);
        }

        final BidRequest modifiedRequest = modifyBidRequest(request, account, modifiedImps);
        return Result.of(
                Collections.singletonList(BidderUtil.defaultRequest(modifiedRequest, endpointUrl, mapper)),
                errors);
    }

    private ExtImpTeal 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(ExtImpTeal extImpTeal) {
        if (StringUtils.isBlank(extImpTeal.getAccount())) {
            throw new PreBidException("account parameter failed validation");
        }

        final String placement = extImpTeal.getPlacement();
        if (placement != null && StringUtils.isBlank(placement)) {
            throw new PreBidException("placement parameter failed validation");
        }
    }

    private static Imp modifyImp(Imp imp, String placement) {
        if (placement == null) {
            return imp;
        }

        final ObjectNode modifiedExt = imp.getExt().deepCopy();
        getOrCreate(getOrCreate(modifiedExt, "prebid"), "storedrequest")
                .put("id", placement);

        return imp.toBuilder().ext(modifiedExt).build();
    }

    private static ObjectNode getOrCreate(ObjectNode parent, String field) {
        final JsonNode child = parent.get(field);
        return child != null && child.isObject()
                ? (ObjectNode) child
                : parent.putObject(field);
    }

[CTMBNara]

    private BidRequest modifyBidRequest(BidRequest request, String account, List<Imp> modifiedImps) {
        final ExtRequest ext = ObjectUtils.defaultIfNull(request.getExt(), ExtRequest.empty());
        ext.addProperty("bids", mapper.mapper().createObjectNode().put("pbs", 1));

        return request.toBuilder()
                .site(modifySite(request.getSite(), account))
                .app(modifyApp(request.getApp(), account))
                .imp(modifiedImps)
                .ext(ext)
                .build();
    }

[CTMBNara]

Remove PreBidException

[CTMBNara]

add .filter(Objects::nonNull) between these lines

[CTMBNara]

.collect(Collectors.toList()); -> .toList()

[CTMBNara]

No need for JsonProperty annotations here

[CTMBNara]

Align parameters

[ollyburns]

@CTMBNara many thanks for your thorough review. I hope each of your points is now resolved - thank you for providing the code. To confirm, the account property is required.