// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
function scoreAd(
adMetadata, bid, auctionConfig, trustedScoringSignals,
browserSignals, directFromSellerSignals) {
validateAdMetadata(adMetadata);
validateBid(bid);
validateAuctionConfig(auctionConfig);
validateTrustedScoringSignals(trustedScoringSignals);
validateBrowserSignals(browserSignals, /*isScoreAd=*/true);
validateDirectFromSellerSignals(directFromSellerSignals);
if (browserSignals.bidCurrency === 'USD') {
return {desirability: bid, incomingBidInSellerCurrency: bid * 0.91};
}
return bid;
}
function reportResult(auctionConfig, browserSignals, directFromSellerSignals) {
validateAuctionConfig(auctionConfig);
validateBrowserSignals(browserSignals, /*isScoreAd=*/false);
validateDirectFromSellerSignals(directFromSellerSignals);
sendReportTo(auctionConfig.seller + '/echo?report_seller');
return ['seller signals for winner'];
}
function validateAdMetadata(adMetadata) {
const adMetadataJSON = JSON.stringify(adMetadata);
if (adMetadataJSON !==
'{"renderURL":"https://example.com/render",' +
'"renderUrl":"https://example.com/render",' +
'"metadata":{"ad":"metadata","here":[1,2,3]}}')
throw 'Wrong adMetadata ' + adMetadataJSON;
}
function validateBid(bid) {
if (bid !== 2)
throw 'Wrong bid ' + bid;
}
function validateAuctionConfig(auctionConfig) {
if (Object.keys(auctionConfig).length !== 16) {
throw 'Wrong number of auctionConfig fields ' +
JSON.stringify(auctionConfig);
}
if (!auctionConfig.seller.includes('b.test'))
throw 'Wrong seller ' + auctionConfig.seller;
if (auctionConfig.decisionLogicURL !==
auctionConfig.seller + '/interest_group/decision_argument_validator.js') {
throw 'Wrong decisionLogicURL ' + auctionConfig.decisionLogicURL;
}
if (auctionConfig.decisionLogicUrl !==
auctionConfig.seller + '/interest_group/decision_argument_validator.js') {
throw 'Wrong decisionLogicUrl ' + auctionConfig.decisionLogicUrl;
}
if (auctionConfig.trustedScoringSignalsURL !==
auctionConfig.seller + '/interest_group/trusted_scoring_signals.json') {
throw 'Wrong trustedScoringSignalsURL ' +
auctionConfig.trustedScoringSignalsURL;
}
if (auctionConfig.trustedScoringSignalsUrl !==
auctionConfig.seller + '/interest_group/trusted_scoring_signals.json') {
throw 'Wrong trustedScoringSignalsUrl ' +
auctionConfig.trustedScoringSignalsUrl;
}
// TODO(crbug.com/40172488): Consider validating URL fields like
// auctionConfig.decisionLogicURL once we decide what to do about URL
// normalization.
if (auctionConfig.interestGroupBuyers.length !== 2 ||
!auctionConfig.interestGroupBuyers[0].startsWith('https://a.test') ||
!auctionConfig.interestGroupBuyers[1].startsWith('https://d.test')) {
throw 'Wrong interestGroupBuyers ' +
JSON.stringify(auctionConfig.interestGroupBuyers);
}
const buyerAOrigin = auctionConfig.interestGroupBuyers[0];
const buyerBOrigin = auctionConfig.interestGroupBuyers[1];
// If auctionSignals is passed as a JSON string instead of an object,
// stringify() will wrap it in another layer of quotes, causing the test to
// fail. The order of properties produced by stringify() isn't guaranteed by
// the ECMAScript standard, but some sites depend on the V8 behavior of
// serializing in declaration order.
const auctionSignalsJSON = JSON.stringify(auctionConfig.auctionSignals);
if (auctionSignalsJSON !== '{"so":"I","hear":["you","like","json"]}')
throw 'Wrong auctionSignals ' + auctionConfig.auctionSignalsJSON;
const sellerSignalsJSON = JSON.stringify(auctionConfig.sellerSignals);
if (sellerSignalsJSON !== '{"signals":"from","the":["seller"]}')
throw 'Wrong sellerSignals ' + auctionConfig.sellerSignalsJSON;
if (auctionConfig.sellerTimeout !== 20000)
throw 'Wrong sellerTimeout ' + auctionConfig.sellerTimeout;
if (JSON.stringify(auctionConfig.perBuyerSignals[buyerAOrigin]) !==
'{"signalsForBuyer":1}') {
throw 'Wrong perBuyerSignals ' +
JSON.stringify(auctionConfig.perBuyerSignals);
}
if (auctionConfig.perBuyerTimeouts[buyerAOrigin] !== 11000 ||
auctionConfig.perBuyerTimeouts[buyerBOrigin] !== 12000 ||
auctionConfig.perBuyerTimeouts['*'] !== 15000) {
throw 'Wrong perBuyerTimeouts ' +
JSON.stringify(auctionConfig.perBuyerTimeouts);
}
if (auctionConfig.perBuyerCumulativeTimeouts[buyerAOrigin] !== 13000 ||
auctionConfig.perBuyerCumulativeTimeouts[buyerBOrigin] !== 14000 ||
auctionConfig.perBuyerCumulativeTimeouts['*'] !== 16000) {
throw 'Wrong perBuyerCumulativeTimeouts ' +
JSON.stringify(auctionConfig.perBuyerCumulativeTimeouts);
}
if (auctionConfig.reportingTimeout !== 2000)
throw 'Wrong reportingTimeout ' + auctionConfig.reportingTimeout;
if (auctionConfig.perBuyerCurrencies[buyerAOrigin] !== 'USD' ||
auctionConfig.perBuyerCurrencies[buyerBOrigin] !== 'CAD' ||
auctionConfig.perBuyerCurrencies['*'] !== 'EUR') {
throw 'Wrong perBuyerCurrencies ' +
JSON.stringify(auctionConfig.perBuyerCurrencies);
}
if (auctionConfig.sellerCurrency !== 'EUR') {
throw 'Wrong sellerCurrency ' +
JSON.stringify(auctionConfig.sellerCurrency);
}
const perBuyerPrioritySignals = auctionConfig.perBuyerPrioritySignals;
if (Object.keys(perBuyerPrioritySignals).length !== 2 ||
JSON.stringify(perBuyerPrioritySignals[buyerAOrigin]) !==
'{"foo":1}' ||
JSON.stringify(perBuyerPrioritySignals['*']) !==
'{"BaR":-2}') {
throw 'Wrong perBuyerPrioritySignals ' +
JSON.stringify(perBuyerPrioritySignals);
}
if ('componentAuctions' in auctionConfig) {
throw 'Unexpected componentAuctions ' +
JSON.stringify(auctionConfig.componentAuctions);
}
}
function validateTrustedScoringSignals(signals) {
if (signals.renderURL["https://example.com/render"] !== "foo") {
throw 'Wrong trustedScoringSignals.renderURL ' +
signals.renderURL["https://example.com/render"];
}
if (signals.adComponentRenderURLs["https://example.com/render-component"] !==
1) {
throw 'Wrong trustedScoringSignals.adComponentRenderURLs ' +
signals.adComponentRenderURLs["https://example.com/render-component"];
}
if (signals.renderUrl["https://example.com/render"] !== "foo") {
throw 'Wrong trustedScoringSignals.renderUrl ' +
signals.renderUrl["https://example.com/render"];
}
if (signals.adComponentRenderUrls["https://example.com/render-component"] !==
1) {
throw 'Wrong trustedScoringSignals.adComponentRenderUrls ' +
signals.adComponentRenderUrls["https://example.com/render-component"];
}
}
function validateBrowserSignals(browserSignals, isScoreAd) {
// Fields common to scoreAd() and reportResult().
if (browserSignals.topWindowHostname !== 'c.test')
throw 'Wrong topWindowHostname ' + browserSignals.topWindowHostname;
if ('topLevelSeller' in browserSignals)
throw 'Wrong topLevelSeller ' + browserSignals.topLevelSeller;
if ("componentSeller" in browserSignals)
throw 'Wrong componentSeller ' + browserSignals.componentSeller;
if (!browserSignals.interestGroupOwner.startsWith('https://a.test'))
throw 'Wrong interestGroupOwner ' + browserSignals.interestGroupOwner;
if (browserSignals.renderURL !== "https://example.com/render")
throw 'Wrong renderURL ' + browserSignals.renderURL;
if (browserSignals.renderUrl !== "https://example.com/render")
throw 'Wrong renderUrl ' + browserSignals.renderUrl;
if (browserSignals.dataVersion !== 1234)
throw 'Wrong dataVersion ' + browserSignals.dataVersion;
if (browserSignals.bidCurrency !== 'USD')
throw 'Wrong bidCurrency ' + browserSignals.bidCurrency;
// Fields that vary by method.
if (isScoreAd) {
if (Object.keys(browserSignals).length !== 9) {
throw 'Wrong number of browser signals fields ' +
JSON.stringify(browserSignals);
}
const adComponentsJSON = JSON.stringify(browserSignals.adComponents);
if (adComponentsJSON !== '["https://example.com/render-component"]')
throw 'Wrong adComponents ' + browserSignals.adComponents;
if (browserSignals.biddingDurationMsec < 0)
throw 'Wrong biddingDurationMsec ' + browserSignals.biddingDurationMsec;
if (browserSignals.forDebuggingOnlyInCooldownOrLockout)
throw 'Wrong forDebuggingOnlyInCooldownOrLockout ' +
browserSignals.forDebuggingOnlyInCooldownOrLockout;
} else {
if (Object.keys(browserSignals).length !== 10) {
throw 'Wrong number of browser signals fields ' +
JSON.stringify(browserSignals);
}
validateBid(browserSignals.bid);
if (browserSignals.desirability !== 2)
throw 'Wrong desireability ' + browserSignals.desirability;
if (browserSignals.highestScoringOtherBid !== 0) {
throw 'Wrong highestScoringOtherBid ' +
browserSignals.highestScoringOtherBid;
}
if (browserSignals.highestScoringOtherBidCurrency !== 'EUR') {
throw 'Wrong highestScoringOtherBidCurrency ' +
browserSignals.highestScoringOtherBidCurrency;
}
}
}
function validateDirectFromSellerSignals(directFromSellerSignals) {
const sellerSignalsJSON =
JSON.stringify(directFromSellerSignals.sellerSignals);
if (sellerSignalsJSON !== '{"json":"for","the":["seller"]}') {
throw 'Wrong directFromSellerSignals.sellerSignals ' +
sellerSignalsJSON;
}
const auctionSignalsJSON =
JSON.stringify(directFromSellerSignals.auctionSignals);
if (auctionSignalsJSON !== '{"json":"for","all":["parties"]}' &&
auctionSignalsJSON !== '{"all":["parties"],"json":"for"}') {
throw 'Wrong directFromSellerSignals.auctionSignals ' +
auctionSignalsJSON;
}
}
Codebase Browser
chromium