New Adapter: Sparteo

[t-sormonte]

🔧 Type of changes

• [ X] new bid adapter

✨ What's the context?

We would like to allow our partners to be able to include us in s2s bidding.
The Go PR: prebid/prebid-server#4275

🧠 Rationale behind the change

The adapter logic is the same as the one we have implemented for the GO version

🔎 New Bid Adapter Checklist

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

🧪 Test plan

How do you know the changes are safe to ship to production?
We have implemented the unit and integration test.
We have run several manual "real" tests.

🏎 Quality check

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

[AntoxaAntoxic]

please make sure the Go and Java versions have feature parity before merging

[t-sormonte]

Hi @AntoxaAntoxic ,
thank you for your time on this review, i have implemented your suggestions, please let me know if i have miss implemented some of your comments.

[AntoxaAntoxic]

closing parenthesis shouldn't be on the new line, please check the code style guide and fix everywhere

[t-sormonte]

Formatted

[AntoxaAntoxic]

not fixed

[t-sormonte]

updated

[AntoxaAntoxic]

okay, spent some time on refactoring, here is what I came up with

    private static final TypeReference<ExtPrebid<?, ExtImpSparteo>> TYPE_REFERENCE =
            new TypeReference<>() {
            };

    private final String endpointUrl;
    private final JacksonMapper mapper;

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

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

        for (Imp imp : request.getImp()) {
            try {
                final ExtImpSparteo extImp = parseExtImp(imp);
                if (siteNetworkId == null && extImp.getNetworkId() != null) {
                    siteNetworkId = extImp.getNetworkId();
                }
            } catch (PreBidException e) {
                errors.add(BidderError.badInput("ignoring imp id=%s, error processing ext: %s".formatted(imp.getId(), e.getMessage())));
            }

            modifiedImps.add(imp.toBuilder().ext(modifyImpExt(imp)).build());
        }

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

        final BidRequest outgoingRequest = request.toBuilder()
                .imp(modifiedImps)
                .site(modifySite(request.getSite(), siteNetworkId, mapper))
                .build();

        final HttpRequest<BidRequest> call = BidderUtil.defaultRequest(outgoingRequest, endpointUrl, mapper);

        return Result.of(Collections.singletonList(call), errors);
    }

    private ExtImpSparteo parseExtImp(Imp imp) {
        try {
            return mapper.mapper().convertValue(imp.getExt(), TYPE_REFERENCE).getBidder();
        } catch (IllegalArgumentException e) {
            throw new PreBidException("invalid imp.ext");
        }
    }

    private static ObjectNode modifyImpExt(Imp imp) {
        final ObjectNode modifiedImpExt = imp.getExt().deepCopy();
        final JsonNode sparteoJsonNode = modifiedImpExt.get("sparteo");
        final ObjectNode sparteoNode = sparteoJsonNode == null || !sparteoJsonNode.isObject()
                ? modifiedImpExt.putObject("sparteo")
                : (ObjectNode) sparteoJsonNode;

        final JsonNode paramsJsonNode = sparteoNode.get("params");
        final ObjectNode paramsNode = paramsJsonNode == null || !paramsJsonNode.isObject()
                ? sparteoNode.putObject("params")
                : (ObjectNode) paramsJsonNode;

        final JsonNode bidderJsonNode = modifiedImpExt.remove("bidder");
        if (bidderJsonNode != null && bidderJsonNode.isObject()) {
            final Iterator<Map.Entry<String, JsonNode>> fields = bidderJsonNode.fields();
            while (fields.hasNext()) {
                Map.Entry<String, JsonNode> field = fields.next();
                paramsNode.set(field.getKey(), field.getValue());
            }
        }
        return modifiedImpExt;
    }

[AntoxaAntoxic]

Also, now we don't need ExtImpParamsSparteo

having separate DTOs was bad idea from my side according to the Go version because there is no strict list of fields we can potentially receive within the imp.ext

also ExtImpSparteo can be shrink to the following

@Value(staticConstructor = "of")
public class ExtImpSparteo {

    @JsonProperty("networkId")
    String networkId;
}

all the custom params will be copied to the outgoing DTO anyway

[AntoxaAntoxic]

please double-check in case I have missed something and sorry for confusion

[t-sormonte]

Hey @AntoxaAntoxic ,
No problem, i admit that having no strict list of fields could misled.
Thank you to have spent time to refactor it. I have implemented the changes i just have changed the loop logic to include the
modifiedImps.add(imp.toBuilder().ext(modifyImpExt(imp)).build());
into the try block.

Please let me know if you see anything else.

[AntoxaAntoxic]

the bidder itself looks good, some comments on the test class

[AntoxaAntoxic]

the method should be higher

[t-sormonte]

What is the rule behind ? I did an alphabetic order for private methods. Where should i put this method ?

[AntoxaAntoxic]

please utilize assertj extracting methods whenever it's possible

[t-sormonte]

updated but i'm not 100% i did it the right way, do not hesitate to tell me if it is not what you expected

[AntoxaAntoxic]

it's especially handy while working with lists of objects instead of comparing one by one with the duplicated code

[AntoxaAntoxic]

Overall, looks good. Only minor issues are left. Thank you!