Core: EID Permissions extension #4349
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| package org.prebid.server.auction.model; | ||
|
|
||
| import com.iab.openrtb.request.Eid; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.prebid.server.proto.openrtb.ext.request.ExtRequestPrebidDataEidPermissions; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
|
|
||
| public final class EidPermissionHolder { | ||
|
|
||
| private static final String WILDCARD_BIDDER = "*"; | ||
|
|
||
| private static final ExtRequestPrebidDataEidPermissions DEFAULT_RULE = ExtRequestPrebidDataEidPermissions.builder() | ||
| .bidders(Collections.singletonList(WILDCARD_BIDDER)) | ||
| .build(); | ||
|
|
||
| private static final EidPermissionHolder EMPTY = new EidPermissionHolder(Collections.emptyList()); | ||
|
|
||
| private final List<ExtRequestPrebidDataEidPermissions> eidPermissions; | ||
|
|
||
| private EidPermissionHolder(List<ExtRequestPrebidDataEidPermissions> eidPermissions) { | ||
| this.eidPermissions = new ArrayList<>(eidPermissions); | ||
| this.eidPermissions.add(DEFAULT_RULE); | ||
| } | ||
|
|
||
| public static EidPermissionHolder of(List<ExtRequestPrebidDataEidPermissions> eidPermissions) { | ||
| return new EidPermissionHolder(eidPermissions); | ||
| } | ||
|
|
||
| public static EidPermissionHolder empty() { | ||
| return EMPTY; | ||
| } | ||
|
|
||
| public boolean isAllowed(Eid eid, String bidder) { | ||
| final Map<Integer, List<ExtRequestPrebidDataEidPermissions>> matchingRulesBySpecificity = eidPermissions | ||
| .stream() | ||
| .filter(rule -> isRuleMatched(eid, rule)) | ||
| .collect(Collectors.groupingBy(this::getRuleSpecificity)); | ||
|
|
||
| final int highestSpecificityMatchingRules = Collections.max(matchingRulesBySpecificity.keySet()); | ||
| return matchingRulesBySpecificity.get(highestSpecificityMatchingRules).stream() | ||
| .anyMatch(eidPermission -> isBidderAllowed(bidder, eidPermission.getBidders())); | ||
| } | ||
|
|
||
| private int getRuleSpecificity(ExtRequestPrebidDataEidPermissions eidPermission) { | ||
| return (int) Stream.of(eidPermission.getInserter(), | ||
| eidPermission.getSource(), | ||
| eidPermission.getMatcher(), | ||
| eidPermission.getMm()) | ||
| .filter(Objects::nonNull) | ||
| .count(); | ||
| } | ||
|
|
||
| private boolean isRuleMatched(Eid eid, ExtRequestPrebidDataEidPermissions eidPermission) { | ||
| return (eidPermission.getInserter() == null || eidPermission.getInserter().equals(eid.getInserter())) | ||
| && (eidPermission.getSource() == null || eidPermission.getSource().equals(eid.getSource())) | ||
| && (eidPermission.getMatcher() == null || eidPermission.getMatcher().equals(eid.getMatcher())) | ||
| && (eidPermission.getMm() == null || eidPermission.getMm().equals(eid.getMm())); | ||
|
Comment on lines
+61
to
+64
Collaborator
There was a problem hiding this comment. add method |
||
| } | ||
|
|
||
| private boolean isBidderAllowed(String bidder, List<String> ruleBidders) { | ||
| return ruleBidders == null || ruleBidders.stream() | ||
| .anyMatch(allowedBidder -> StringUtils.equalsIgnoreCase(allowedBidder, bidder) | ||
| || WILDCARD_BIDDER.equals(allowedBidder)); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,43 @@ | ||
| package org.prebid.server.proto.openrtb.ext.request; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonFormat; | ||
| import lombok.Builder; | ||
| import lombok.Value; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| @Value | ||
| @Builder | ||
| public class ExtRequestPrebidDataEidPermissions { | ||
|
|
||
| /** | ||
| * Defines the contract for bidrequest.ext.prebid.data.eidPermissions.inserter | ||
| */ | ||
| String inserter; | ||
|
|
||
| /** | ||
| * Defines the contract for bidrequest.ext.prebid.data.eidPermissions.source | ||
| */ | ||
| String source; | ||
|
|
||
| /** | ||
| * Defines the contract for bidrequest.ext.prebid.data.eidPermissions.matcher | ||
| */ | ||
| String matcher; | ||
|
|
||
| /** | ||
| * Defines the contract for bidrequest.ext.prebid.data.eidPermissions.mm | ||
| */ | ||
| Integer mm; | ||
|
|
||
| /** | ||
| * Defines the contract for bidrequest.ext.prebid.data.eidPermissions.bidders | ||
| */ | ||
| @JsonFormat(without = JsonFormat.Feature.ACCEPT_SINGLE_VALUE_AS_ARRAY) | ||
| List<String> bidders; | ||
|
|
||
| @Deprecated | ||
| public static ExtRequestPrebidDataEidPermissions of(String source, List<String> bidders) { | ||
| return new ExtRequestPrebidDataEidPermissions(null, source, null, null, bidders); | ||
| } | ||
|
Comment on lines
+39
to
+42
Collaborator
There was a problem hiding this comment. I don't like the idea to keep it |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can also be moved to EidPermissionHolder.