Refactoring: Add TimeoutContext (#2976)

src/main/java/org/prebid/server/auction/BidResponseCreator.java

@@ -488,7 +488,7 @@ private Future<CategoryMappingResult> createCategoryMapping(AuctionContext aucti
  return categoryMappingService.createCategoryMapping(
  bidderResponses,
  auctionContext.getBidRequest(),
- auctionContext.getTimeout())
+ auctionContext.getTimeoutContext().getTimeout())
 
  .map(categoryMappingResult -> addCategoryMappingErrors(categoryMappingResult, auctionContext));
  }
@@ -1253,7 +1253,7 @@ private BidResponse toBidResponse(List<BidderResponseInfo> bidderResponseInfos,
  private Future<VideoStoredDataResult> videoStoredDataResult(AuctionContext auctionContext) {
  final List<Imp> imps = auctionContext.getBidRequest().getImp();
  final String accountId = auctionContext.getAccount().getId();
- final Timeout timeout = auctionContext.getTimeout();
+ final Timeout timeout = auctionContext.getTimeoutContext().getTimeout();
 
  final List<String> errors = new ArrayList<>();
  final List<Imp> storedVideoInjectableImps = new ArrayList<>();

src/main/java/org/prebid/server/auction/ExchangeService.java

@@ -47,6 +47,7 @@
 import org.prebid.server.auction.model.BidderResponse;
 import org.prebid.server.auction.model.MultiBidConfig;
 import org.prebid.server.auction.model.StoredResponseResult;
+import org.prebid.server.auction.model.TimeoutContext;
 import org.prebid.server.auction.versionconverter.BidRequestOrtbVersionConversionManager;
 import org.prebid.server.auction.versionconverter.OrtbVersion;
 import org.prebid.server.bidder.Bidder;
@@ -169,7 +170,6 @@ public class ExchangeService {
  private static final BigDecimal THOUSAND = BigDecimal.valueOf(1000);
 
  private final double logSamplingRate;
- private final int timeoutAdjustmentFactor;
  private final BidderCatalog bidderCatalog;
  private final StoredResponseProcessor storedResponseProcessor;
  private final DealsService dealsService;
@@ -201,7 +201,6 @@ public class ExchangeService {
  private final boolean enabledStrictAppSiteDoohValidation;
 
  public ExchangeService(double logSamplingRate,
- int timeoutAdjustmentFactor,
  BidderCatalog bidderCatalog,
  StoredResponseProcessor storedResponseProcessor,
  DealsService dealsService,
@@ -232,11 +231,7 @@ public ExchangeService(double logSamplingRate,
  CriteriaLogManager criteriaLogManager,
  boolean enabledStrictAppSiteDoohValidation) {
 
- if (timeoutAdjustmentFactor < 0 || timeoutAdjustmentFactor > 100) {
- throw new IllegalArgumentException("Expected timeout adjustment factor should be in [0, 100].");
- }
  this.logSamplingRate = logSamplingRate;
- this.timeoutAdjustmentFactor = timeoutAdjustmentFactor;
  this.bidderCatalog = Objects.requireNonNull(bidderCatalog);
  this.storedResponseProcessor = Objects.requireNonNull(storedResponseProcessor);
  this.dealsService = dealsService;
@@ -292,7 +287,7 @@ private static BidResponse emptyResponse() {
  private Future<AuctionContext> runAuction(AuctionContext receivedContext) {
  final UidsCookie uidsCookie = receivedContext.getUidsCookie();
  final BidRequest bidRequest = receivedContext.getBidRequest();
- final Timeout timeout = receivedContext.getTimeout();
+ final Timeout timeout = receivedContext.getTimeoutContext().getTimeout();
  final Account account = receivedContext.getAccount();
  final List<String> debugWarnings = receivedContext.getDebugWarnings();
  final MetricName requestTypeMetric = receivedContext.getRequestTypeMetric();
@@ -1141,15 +1136,16 @@ private Source prepareSource(String bidder, BidRequest bidRequest, boolean trans
 
  final SupplyChain bidderSchain = supplyChainResolver.resolveForBidder(bidder, bidRequest);
 
- if (bidderSchain == null && transmitTid) {
+ if (bidderSchain == null && (transmitTid || receivedSource == null)) {
  return receivedSource;
  }
 
  return receivedSource == null
  ? Source.builder().schain(bidderSchain).build()
  : receivedSource.toBuilder()
  .schain(bidderSchain != null ? bidderSchain : receivedSource.getSchain())
- .tid(transmitTid ? receivedSource.getTid() : null).build();
+ .tid(transmitTid ? receivedSource.getTid() : null)
+ .build();
  }
 
  /**
@@ -1388,11 +1384,13 @@ private Future<BidderResponse> requestBids(BidderRequest bidderRequest,
  final Bidder<?> bidder = bidderCatalog.bidderByName(resolvedBidderName);
  final BidRejectionTracker bidRejectionTracker = auctionContext.getBidRejectionTrackers().get(bidderName);
 
- final long auctionStartTime = auctionContext.getStartTime();
+ final TimeoutContext timeoutContext = auctionContext.getTimeoutContext();
+ final long auctionStartTime = timeoutContext.getStartTime();
+ final int adjustmentFactor = timeoutContext.getAdjustmentFactor();
  final long bidderRequestStartTime = clock.millis();
 
  return Future.succeededFuture(bidderRequest.getBidRequest())
- .map(bidRequest -> adjustTmax(bidRequest, auctionStartTime, bidderRequestStartTime))
+ .map(bidRequest -> adjustTmax(bidRequest, auctionStartTime, adjustmentFactor, bidderRequestStartTime))
  .map(bidRequest -> ortbVersionConversionManager.convertFromAuctionSupportedVersion(
  bidRequest, bidderRequest.getOrtbVersion()))
  .map(bidderRequest::with)
@@ -1407,10 +1405,9 @@ private Future<BidderResponse> requestBids(BidderRequest bidderRequest,
  .map(seatBid -> BidderResponse.of(bidderName, seatBid, responseTime(bidderRequestStartTime)));
  }
 
- private BidRequest adjustTmax(BidRequest bidRequest, long startTime, long currentTime) {
+ private BidRequest adjustTmax(BidRequest bidRequest, long startTime, int adjustmentFactor, long currentTime) {
  final long tmax = timeoutResolver.limitToMax(bidRequest.getTmax());
- final long adjustedTmax = timeoutResolver.adjustForBidder(
- tmax, timeoutAdjustmentFactor, currentTime - startTime);
+ final long adjustedTmax = timeoutResolver.adjustForBidder(tmax, adjustmentFactor, currentTime - startTime);
  return tmax != adjustedTmax
  ? bidRequest.toBuilder().tmax(adjustedTmax).build()
  : bidRequest;

src/main/java/org/prebid/server/auction/PrivacyEnforcementService.java

@@ -109,7 +109,7 @@ public Future<PrivacyContext> contextFromBidRequest(AuctionContext auctionContex
  final List<String> errors = auctionContext.getPrebidErrors();
  final Account account = auctionContext.getAccount();
  final MetricName requestType = auctionContext.getRequestTypeMetric();
- final Timeout timeout = auctionContext.getTimeout();
+ final Timeout timeout = auctionContext.getTimeoutContext().getTimeout();
 
  final Privacy privacy = privacyExtractor.validPrivacyFrom(bidRequest, errors);
 

src/main/java/org/prebid/server/auction/model/AuctionContext.java

@@ -12,7 +12,6 @@
 import org.prebid.server.cookie.UidsCookie;
 import org.prebid.server.deals.model.DeepDebugLog;
 import org.prebid.server.deals.model.TxnLog;
-import org.prebid.server.execution.Timeout;
 import org.prebid.server.geolocation.model.GeoInfo;
 import org.prebid.server.hooks.execution.model.HookExecutionContext;
 import org.prebid.server.metric.MetricName;
@@ -40,12 +39,6 @@ public class AuctionContext {
  @JsonIgnore
  List<AuctionParticipation> auctionParticipations;
 
- @JsonIgnore
- long startTime;
-
- @JsonIgnore
- Timeout timeout;
-
  Account account;
 
  MetricName requestTypeMetric;
@@ -58,6 +51,9 @@ public class AuctionContext {
 
  Map<String, BidRejectionTracker> bidRejectionTrackers;
 
+ @JsonIgnore
+ TimeoutContext timeoutContext;
+
  GppContext gppContext;
 
  PrivacyContext privacyContext;

src/main/java/org/prebid/server/auction/model/TimeoutContext.java

@@ -0,0 +1,18 @@
+package org.prebid.server.auction.model;
+
+import lombok.Value;
+import org.prebid.server.execution.Timeout;
+
+@Value(staticConstructor = "of")
+public class TimeoutContext {
+
+ long startTime;
+
+ Timeout timeout;
+
+ int adjustmentFactor;
+
+ public TimeoutContext with(Timeout timeout) {
+ return TimeoutContext.of(startTime, timeout, adjustmentFactor);
+ }
+}

src/main/java/org/prebid/server/auction/privacycontextfactory/AmpPrivacyContextFactory.java

@@ -49,7 +49,7 @@ public Future<PrivacyContext> contextFrom(AuctionContext auctionContext) {
  final BidRequest bidRequest = auctionContext.getBidRequest();
 
  final MetricName requestType = auctionContext.getRequestTypeMetric();
- final Timeout timeout = auctionContext.getTimeout();
+ final Timeout timeout = auctionContext.getTimeoutContext().getTimeout();
  final List<String> errors = auctionContext.getPrebidErrors();
 
  final Privacy initialPrivacy = privacyExtractor.validPrivacyFrom(bidRequest, errors);

src/main/java/org/prebid/server/auction/requestfactory/Ortb2RequestFactory.java

@@ -24,6 +24,7 @@
 import org.prebid.server.auction.TimeoutResolver;
 import org.prebid.server.auction.model.AuctionContext;
 import org.prebid.server.auction.model.IpAddress;
+import org.prebid.server.auction.model.TimeoutContext;
 import org.prebid.server.auction.model.debug.DebugContext;
 import org.prebid.server.cookie.UidsCookieService;
 import org.prebid.server.deals.UserAdditionalInfoService;
@@ -91,6 +92,7 @@ public class Ortb2RequestFactory {
  private static final ConditionalLogger UNKNOWN_ACCOUNT_LOGGER = new ConditionalLogger("unknown_account", logger);
 
  private final boolean enforceValidAccount;
+ private final int timeoutAdjustmentFactor;
  private final double logSamplingRate;
  private final List<String> blacklistedAccounts;
  private final UidsCookieService uidsCookieService;
@@ -109,6 +111,7 @@ public class Ortb2RequestFactory {
  private final Clock clock;
 
  public Ortb2RequestFactory(boolean enforceValidAccount,
+ int timeoutAdjustmentFactor,
  double logSamplingRate,
  List<String> blacklistedAccounts,
  UidsCookieService uidsCookieService,
@@ -126,7 +129,12 @@ public Ortb2RequestFactory(boolean enforceValidAccount,
  Metrics metrics,
  Clock clock) {
 
+ if (timeoutAdjustmentFactor < 0 || timeoutAdjustmentFactor > 100) {
+ throw new IllegalArgumentException("Expected timeout adjustment factor should be in [0, 100].");
+ }
+
  this.enforceValidAccount = enforceValidAccount;
+ this.timeoutAdjustmentFactor = timeoutAdjustmentFactor;
  this.logSamplingRate = logSamplingRate;
  this.blacklistedAccounts = Objects.requireNonNull(blacklistedAccounts);
  this.uidsCookieService = Objects.requireNonNull(uidsCookieService);
@@ -168,8 +176,7 @@ public AuctionContext enrichAuctionContext(AuctionContext auctionContext,
  .httpRequest(httpRequest)
  .uidsCookie(uidsCookieService.parseFromRequest(httpRequest))
  .bidRequest(bidRequest)
- .startTime(startTime)
- .timeout(timeout(bidRequest, startTime))
+ .timeoutContext(TimeoutContext.of(startTime, timeout(bidRequest, startTime), timeoutAdjustmentFactor))
  .deepDebugLog(createDeepDebugLog(bidRequest))
  .build();
  }
@@ -184,7 +191,7 @@ public Future<Account> fetchAccount(AuctionContext auctionContext) {
 
  private Future<Account> fetchAccount(AuctionContext auctionContext, boolean isLookupStoredRequest) {
  final BidRequest bidRequest = auctionContext.getBidRequest();
- final Timeout timeout = auctionContext.getTimeout();
+ final Timeout timeout = auctionContext.getTimeoutContext().getTimeout();
  final HttpRequestContext httpRequest = auctionContext.getHttpRequest();
 
  return findAccountIdFrom(bidRequest, isLookupStoredRequest)
@@ -359,7 +366,8 @@ public AuctionContext enrichWithPriceFloors(AuctionContext auctionContext) {
  }
 
  public AuctionContext updateTimeout(AuctionContext auctionContext, long startTime) {
- final Timeout currentTimeout = auctionContext.getTimeout();
+ final TimeoutContext timeoutContext = auctionContext.getTimeoutContext();
+ final Timeout currentTimeout = timeoutContext.getTimeout();
 
  final BidRequest bidRequest = auctionContext.getBidRequest();
  final BidRequest resolvedBidRequest = resolveBidRequest(bidRequest);
@@ -376,7 +384,7 @@ public AuctionContext updateTimeout(AuctionContext auctionContext, long startTim
 
  return auctionContext.toBuilder()
  .bidRequest(effectiveBidRequest)
- .timeout(requestTimeout)
+ .timeoutContext(timeoutContext.with(requestTimeout))
  .build();
  }
 

src/main/java/org/prebid/server/cache/CacheService.java

@@ -361,7 +361,7 @@ private Future<CacheServiceResult> doCacheOpenrtb(List<CacheBid> bids,
  cachedCreatives.add(makeDebugCacheCreative(cachedDebugLog, hbCacheId, videoCacheTtl));
  }
 
- final long remainingTimeout = auctionContext.getTimeout().remaining();
+ final long remainingTimeout = auctionContext.getTimeoutContext().getTimeout().remaining();
  if (remainingTimeout <= 0) {
  return Future.succeededFuture(CacheServiceResult.of(null, new TimeoutException("Timeout has been exceeded"),
  Collections.emptyMap()));

src/main/java/org/prebid/server/deals/UserAdditionalInfoService.java

@@ -79,7 +79,7 @@ public Future<AuctionContext> populate(AuctionContext context) {
  }
 
  final Device device = context.getBidRequest().getDevice();
- final Timeout timeout = context.getTimeout();
+ final Timeout timeout = context.getTimeoutContext().getTimeout();
  final GeoInfo geoInfo = context.getGeoInfo();
 
  final CompositeFuture compositeFuture = CompositeFuture.join(

src/main/java/org/prebid/server/spring/config/ServiceConfiguration.java

@@ -352,6 +352,7 @@ SetuidGppService setuidGppService(GppService gppService) {
  @Bean
  Ortb2RequestFactory openRtb2RequestFactory(
  @Value("${settings.enforce-valid-account}") boolean enforceValidAccount,
+ @Value("${auction.biddertmax.percent}") int timeoutAdjustmentFactor,
  @Value("${auction.blacklisted-accounts}") String blacklistedAccountsString,
  UidsCookieService uidsCookieService,
  ActivityInfrastructureCreator activityInfrastructureCreator,
@@ -372,6 +373,7 @@ Ortb2RequestFactory openRtb2RequestFactory(
 
  return new Ortb2RequestFactory(
  enforceValidAccount,
+ timeoutAdjustmentFactor,
  logSamplingRate,
  blacklistedAccounts,
  uidsCookieService,
@@ -797,7 +799,6 @@ BidResponseCreator bidResponseCreator(
  @Bean
  ExchangeService exchangeService(
  @Value("${logging.sampling-rate:0.01}") double logSamplingRate,
- @Value("${auction.biddertmax.percent}") int timeoutAdjustmentFactor,
  BidderCatalog bidderCatalog,
  StoredResponseProcessor storedResponseProcessor,
  @Autowired(required = false) DealsService dealsService,
@@ -830,7 +831,6 @@ ExchangeService exchangeService(
 
  return new ExchangeService(
  logSamplingRate,
- timeoutAdjustmentFactor,
  bidderCatalog,
  storedResponseProcessor,
  dealsService,

src/test/java/org/prebid/server/analytics/reporter/pubstack/PubstackEventHandlerTest.java

@@ -15,6 +15,7 @@
 import org.prebid.server.analytics.model.SetuidEvent;
 import org.prebid.server.analytics.reporter.pubstack.model.PubstackAnalyticsProperties;
 import org.prebid.server.auction.model.AuctionContext;
+import org.prebid.server.auction.model.TimeoutContext;
 import org.prebid.server.cookie.UidsCookie;
 import org.prebid.server.deals.model.DeepDebugLog;
 import org.prebid.server.deals.model.TxnLog;
@@ -159,7 +160,7 @@ public void handleShouldBeAbleToEncodeAuctionEvent() {
  final AuctionEvent event = AuctionEvent.builder()
  .auctionContext(AuctionContext.builder()
  .uidsCookie(mock(UidsCookie.class))
- .timeout(mock(Timeout.class))
+ .timeoutContext(TimeoutContext.of(0, mock(Timeout.class), 0))
  .txnLog(mock(TxnLog.class))
  .deepDebugLog(mock(DeepDebugLog.class))
  .build())

src/test/java/org/prebid/server/auction/BidResponseCreatorTest.java

@@ -47,6 +47,7 @@
 import org.prebid.server.auction.model.CategoryMappingResult;
 import org.prebid.server.auction.model.MultiBidConfig;
 import org.prebid.server.auction.model.TargetingInfo;
+import org.prebid.server.auction.model.TimeoutContext;
 import org.prebid.server.auction.model.debug.DebugContext;
 import org.prebid.server.bidder.BidderCatalog;
 import org.prebid.server.bidder.model.BidderBid;
@@ -3867,8 +3868,8 @@ public void shouldPopulateTargetingKeywordsWithDefaultPrefixAndRelatedWarning()
 
  final String expectedErrorMsg = "Key prefix value is dropped to default. "
  + "Decrease custom prefix length or increase truncateattrchars by 30";
- assertThat(bidResponse.getExt().getWarnings()).containsOnly(entry("targeting", Arrays.asList(
-  ExtBidderError.of(BidderError.Type.bad_input.getCode(), expectedErrorMsg))));
+ assertThat(bidResponse.getExt().getWarnings()).containsOnly(entry("targeting", singletonList(
+ ExtBidderError.of(BidderError.Type.bad_input.getCode(), expectedErrorMsg))));
 
  verify(cacheService, never()).cacheBidsOpenrtb(anyList(), any(), any(), any());
  }
@@ -3880,7 +3881,7 @@ private AuctionContext givenAuctionContext(BidRequest bidRequest,
  .account(Account.empty("accountId"))
  .bidRequest(bidRequest)
  .txnLog(TxnLog.create())
- .timeout(timeout)
+ .timeoutContext(TimeoutContext.of(0, timeout, 0))
  .debugContext(DebugContext.empty())
  .deepDebugLog(DeepDebugLog.create(false, clock))
  .debugHttpCalls(new HashMap<>())