[Spec] Add downsampling forDebuggingOnly support for B&A response #1325
There are no files selected for viewing
This file contains 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 |
|---|---|---|
|
|
@@ -3095,17 +3095,40 @@ a [=list=] of [=interest groups=] |bidIgs|, and a [=reporting context map=] | |
| equals |componentAd|. If there is no matching element, return failure. | ||
| 1. [=list/Append=] a new [=ad descriptor=] whose [=ad descriptor/url=] is | ||
| |componentAd| to |winningAdComponents|. | ||
| 1. Let |bidDebugReportingInfo| be a new [=bid debug reporting info=]. | ||
| 1. [=list/For each=] |key| → |maybeDebugReportUrl| in |response|'s | ||
| [=server auction response/component win debugging only reports=]: | ||
| 1. If |key|'s [=server auction debug report key/from seller=] is true: | ||
| 1. Set |bidDebugReportingInfo|'s [=bid debug reporting info/component seller=] to |seller|. | ||
| 1. If |key|'s [=server auction debug report key/is debug win=] is true, then set | ||
| |bidDebugReportingInfo|'s [=bid debug reporting info/seller debug win report url=] to | ||
| |maybeDebugReportUrl|. | ||
| 1. Otherwise, set |bidDebugReportingInfo|'s | ||
| [=bid debug reporting info/seller debug loss report url=] to |maybeDebugReportUrl|. | ||
| 1. Otherwise, | ||
| 1. Set |bidDebugReportingInfo|'s [=bid debug reporting info/interest group owner=] to | ||
| |response|'s [=server auction response/interest group owner=]. | ||
| 1. If |key|'s [=server auction debug report key/is debug win=] is true, then set | ||
| |bidDebugReportingInfo|'s [=bid debug reporting info/bidder debug win report url=] to | ||
| |maybeDebugReportUrl|. | ||
| 1. Otherwise, set |bidDebugReportingInfo|'s | ||
| [=bid debug reporting info/bidder debug loss report url=] to |maybeDebugReportUrl|. | ||
| 1. Set |bidDebugReportingInfo|'s [=bid debug reporting info/server filtered debugging only reports=] | ||
| to [=server auction response/server filtered debugging only reports=]. | ||
| 1. Set |reportingContextMap|[|auctionConfig|]'s [=reporting context/debug reporting info=] to | ||
| |bidDebugReportingInfo|. | ||
| 1. Let |reportingId| be a [=reporting bid key=] with the following [=struct/items=]: | ||
| : [=reporting bid key/context=] | ||
| :: |reportingContextMap|[|auctionConfig|] | ||
| : [=reporting bid key/source=] | ||
| :: [=reporting bid source/bidding-and-auction-services=] | ||
| : [=reporting bid key/bidder origin=] | ||
| :: |response|'s [=server auction response/interest group owner=] | ||
| : [=reporting bid key/bid identifier=] | ||
| :: |response|'s [=server auction response/interest group name=] | ||
| 1. Let |winningBid| be a new [=generated bid=] with the following [=struct/items=]: | ||
| : [=generated bid/reporting id=] | ||
| :: |reportingId| | ||
| : [=generated bid/bid=] | ||
| :: |response|'s [=server auction response/bid=] | ||
| : [=generated bid/bid in seller currency=] | ||
|
|
@@ -3197,7 +3220,7 @@ a [=list=] of [=interest groups=] |bidIgs|, and a [=reporting context map=] | |
| 1. If |updateIfOlderThan| is less than 10 mintues, set it to 10 minutes. | ||
| 1. If [=current coarsened wall time=] − |ig|'s [=interest group/last updated=] ≥ | ||
| |updateIfOlderThan|, set |ig|'s [=interest group/next update after=] to the | ||
| [=current coarsened wall time=] + |updateIfOlderThan|. | ||
| 1. Return |winningBidInfo|. | ||
|
|
||
| </div> | ||
|
|
@@ -3317,6 +3340,8 @@ dictionary AdAuctionDataBuyerConfig { | |
| specified. | ||
| </dl> | ||
|
|
||
| A <dfn>server auction</dfn> is an auction executed on a trusted auction server. | ||
|
|
||
| A <dfn>server auction interest group</dfn> is a [=struct=] with the following [=struct/items=]: | ||
| <dl dfn-for="server auction interest group"> | ||
| : <dfn>name</dfn> | ||
|
|
@@ -3374,8 +3399,8 @@ A <dfn>server auction request context</dfn> is a [=struct=] with the following [ | |
| [Section 2.2.4 of Bidding and Auction Services](https://privacysandbox.github.io/draft-ietf-bidding-and-auction-services/draft-ietf-bidding-and-auction-services.html#name-generating-a-request) | ||
| </dl> | ||
|
|
||
| A <dfn>server auction response</dfn> is a [=struct=] that contains auction result from a | ||
| [=server auction=]. It has the following [=struct/items=]: | ||
|
|
||
| <dl dfn-for="server auction response"> | ||
| : <dfn>ad render url</dfn> | ||
|
|
@@ -3428,6 +3453,11 @@ from an auction executed on the trusted auction server. It has the following [=s | |
| :: Null or [=server auction reporting info=]. | ||
| : <dfn>component seller reporting</dfn> | ||
| :: Null or [=server auction reporting info=]. | ||
| : <dfn>component win debugging only reports</dfn> | ||
| :: A [=map=] whose [=map/keys=] are [=server auction debug report keys=], and whose [=map/values=] | ||
| are [=lists=] of [=urls=]. | ||
| : <dfn>server filtered debugging only reports</dfn> | ||
| :: A [=map=] whose [=map/keys=] are [=origins=] and whose [=map/values=] are [=lists=] of [=urls=]. | ||
| </dl> | ||
|
|
||
| A <dfn>server auction reporting info</dfn> is a [=struct=] with the following [=struct/items=]: | ||
|
|
@@ -3439,6 +3469,14 @@ A <dfn>server auction reporting info</dfn> is a [=struct=] with the following [= | |
| are [=URLs=] whose [=url/schemes=] are "`https`". | ||
| </dl> | ||
|
|
||
| a <dfn>server auction debug report key</dfn> is a [=struct=] with the following [=struct/items=]: | ||
| <dl dfn-for="server auction debug report key"> | ||
| : <dfn>from seller</dfn> | ||
| :: A [=boolean=]. | ||
| : <dfn>is debug win</dfn> | ||
| :: A [=boolean=]. | ||
| </dl> | ||
|
|
||
| <div algorithm="getInterestGroupAdAuctionData()"> | ||
|
|
||
| The <dfn for=Navigator method>getInterestGroupAdAuctionData(|configIDL|)</dfn> method steps are: | ||
|
|
@@ -3679,8 +3717,6 @@ an [=origin=] |origin| and [=worklet function=] |workletFunction|: | |
| </div> | ||
|
|
||
| A <dfn>reporting context map</dfn> is a [=map=] from [=auction config=] to [=reporting context=]. | ||
|
|
||
| <div algorithm> | ||
| To <dfn>create a reporting context map</dfn> given the [=auction config=] |auctionConfig| and | ||
|
|
@@ -3738,7 +3774,7 @@ methods for event-level <dfn>forDebuggingOnly reports</dfn> for winning and losi | |
|
|
||
| <div algorithm> | ||
| To <dfn>collect a single forDebuggingOnly report</dfn> given a [=URL=] |reportUrl|, an [=origin=] | ||
| |invokingOrigin|, a [=boolean=] |fromServer|, and a [=list=] |debugReportUrls|: | ||
|
|
||
| Note: While the browser is experimenting with third party cookie deprecation (before they have | ||
| been fully removed), the {{InterestGroupBiddingAndScoringScriptRunnerGlobalScope/forDebuggingOnly}} | ||
|
|
@@ -3747,8 +3783,8 @@ methods for event-level <dfn>forDebuggingOnly reports</dfn> for winning and losi | |
|
|
||
| 1. If |reportUrl| is null, or the result of running [=is debugging only in cooldown or lockout=] | ||
| with |invokingOrigin| is true, then return. | ||
| 1. If the result of running [=sample a debug report=] with |invokingOrigin| and |fromServer| is | ||
| true, then [=list/append=] |reportUrl| to |debugReportUrls|. | ||
| </div> | ||
|
|
||
| <div algorithm> | ||
|
|
@@ -3761,42 +3797,64 @@ methods for event-level <dfn>forDebuggingOnly reports</dfn> for winning and losi | |
| 1. [=map/For each=] _ → |reportingContext| of |reportingContextMap|: | ||
| 1. [=map/For each=] |reportingId| -> |bidDebugReportInfo| of |reportingContext|'s | ||
| [=reporting context/debug reporting info=]: | ||
| 1. Let |fromServer| be true if |reportingId|'s [=reporting bid key/source=] is | ||
| [=reporting bid source/bidding-and-auction-services=], false otherwise. | ||
| 1. If |winningBid| is not null and |reportingId| is equal to |winningBid|'s | ||
| [=generated bid/reporting id=]: | ||
| 1. [=Assert=] that |winningBid|'s [=generated bid/reporting id=] is not null. | ||
| 1. [=Collect a single forDebuggingOnly report=] with |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/bidder debug win report url=], |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/interest group owner=], |fromServer|, and |auctionReportInfo|'s | ||
| [=auction report info/debug win report urls=]. | ||
| 1. If |bidDebugReportInfo|'s [=bid debug reporting info/component seller=] is null: | ||
| 1. [=Collect a single forDebuggingOnly report=] with |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/seller debug win report url=], |seller|, |fromServer|, and | ||
| |auctionReportInfo|'s [=auction report info/debug win report urls=]. | ||
| 1. Otherwise: | ||
| 1. [=Collect a single forDebuggingOnly report=] with |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/seller debug win report url=], |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/component seller=], |fromServer|, and |auctionReportInfo|'s | ||
| [=auction report info/debug win report urls=]. | ||
| 1. [=Collect a single forDebuggingOnly report=] with |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/top level seller debug win report url=], |seller|, |fromServer|, | ||
| and |auctionReportInfo|'s [=auction report info/debug win report urls=]. | ||
| 1. Otherwise: | ||
| 1. [=Collect a single forDebuggingOnly report=] with |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/bidder debug loss report url=], |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/interest group owner=], |fromServer|, and |auctionReportInfo|'s | ||
| [=auction report info/debug loss report urls=]. | ||
| 1. If |bidDebugReportInfo|'s [=bid debug reporting info/component seller=] is null: | ||
| 1. [=Collect a single forDebuggingOnly report=] with |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/seller debug loss report url=], |seller|, |fromServer|, and | ||
| |auctionReportInfo|'s [=auction report info/debug loss report urls=]. | ||
| 1. Otherwise: | ||
| 1. [=Collect a single forDebuggingOnly report=] with |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/seller debug loss report url=], |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/component seller=], |fromServer|, |auctionReportInfo|'s | ||
| [=auction report info/debug loss report urls=]. | ||
| 1. [=Collect a single forDebuggingOnly report=] with |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/top level seller debug loss report url=], |seller|, | ||
| |fromServer|, and |auctionReportInfo|'s [=auction report info/debug loss report urls=]. | ||
| 1. [=map/For each=] |invokingOrigin| → |debugURLs| of |bidDebugReportInfo|'s | ||
| [=bid debug reporting info/server filtered debugging only reports=]: | ||
| 1. If |debugURLs| [=list/is empty=]: | ||
| 1. If the result of running [=is debugging only in cooldown or lockout=] with | ||
| |invokingOrigin| is false, then [=update debug report cooldown=] with |invokingOrigin|. | ||
| 1. [=iteration/Continue=]. | ||
|
There was a problem hiding this comment. So I don't understand what's happening here, especially wrt. to the empty list check. (Or is meant to be not empty? But no, you do update cooldown when fromServer is true, so why do you need to update it if there are no reports; in case the server didn't sample any? What if there weren't any in the first place) There was a problem hiding this comment. In order to send less fDO reports back to client to reduce the response size, we decided to let the server side do the 1/1000 sampling, and only send sampled urls back to client. Client will then check origin's cooldown, and also filter sampled urls based on final auction result (if needed). The design is a little tricky that client side needs to believe B&A server did the right thing (i.e., meeting all the assumptions client side expects, which we agreed in the design) There was a problem hiding this comment. That makes sense, but may be worth some sort of a note in the spec about server inserting a blank array to denote when it didn't sample but when we still need to update the lockout? There was a problem hiding this comment. yeah added a note. It's complicated, so a note would be very helpful. |
||
|
|
||
| Note: An entry for |invokingOrigin| is still needed when |debugURLs| is empty. It could | ||
| happen when forDebuggingOnly API is called but the bidding and auction server | ||
| filtered the debug report URL out with the downsampling algorithm. In this case the | ||
| client still needs to know that forDebuggingOnly API was called and update its cooldown | ||
| information. This is different from forDebuggingOnly API not being called by one origin, | ||
| in which case the list won't have an entry for that origin. | ||
| 1. [=list/For each=] |url| of |debugURLs|: | ||
| 1. [=Collect a single forDebuggingOnly report=] with |url|, |invokingOrigin|, | ||
| |fromServer| (true), and |auctionReportInfo|'s [=auction report info/debug loss report urls=]. | ||
|
|
||
| Note: For server filtered ones, post auction signals were filled on the server side, so | ||
| it's fine to collect them all to [=auction report info/debug loss report urls=] without | ||
| the need of getting post auction signals for debug win urls. | ||
| 1. Return |auctionReportInfo|. | ||
| </div> | ||
|
|
||
|
|
@@ -3848,23 +3906,30 @@ and [=map/values=] are [=moments=] at which the cool down for the origin key exp | |
| </div> | ||
|
|
||
| <div algorithm> | ||
| To <dfn>sample a debug report</dfn> given an [=origin=] |origin| and a [=boolean=] |fromServer|: | ||
|
|
||
| Note: forDebuggingOnly reports from [=server auction response=] were downsampled on trusted | ||
| auction servers, so do not downsample them again on client. | ||
| 1. Let |canSendAfterSampled| be false. | ||
| 1. Let |sampleRand| be a random {{long}}, 0 ≤ |sampleRand| < 1000, so each possible long would be | ||
| chosen with a probability equal to [=sampling rate=]. | ||
| 1. If |fromServer| is true or |sampleRand| is 0: | ||
| 1. Set |canSendAfterSampled| to true. | ||
| 1. Set [=user agent=]'s [=debug report lockout until=] to [=current coarsened wall time=] plus | ||
| [=lockout period=]. | ||
| 1. [=Update debug report cooldown=] with |origin|. | ||
| 1. Return |canSendAfterSampled|. | ||
| </div> | ||
|
|
||
| <div algorithm> | ||
| To <dfn>update debug report cooldown</dfn> given an [=origin=] |origin|: | ||
|
|
||
| 1. Let |cooldownRand| be a random {{long}} ≥ 0 and < 10, which corresponds to | ||
| [=long cooldown rate=]. | ||
| 1. Let |cooldownPeriod| be [=long cooldown period=] if |cooldownRand| is 0, | ||
| [=short cooldown period=] otherwise. | ||
| 1. Set [=user agent=]'s [=debug report cooldown=][|origin|] to [=current coarsened wall time=] | ||
| plus |cooldownPeriod|. | ||
| </div> | ||
|
|
||
| ## {{InterestGroupBiddingAndScoringScriptRunnerGlobalScope/realTimeReporting}} ## {#real-time-reporting-header} | ||
|
|
@@ -5182,7 +5247,7 @@ from querying the server during an auction. | |
| 1. Let |reportingHashCode| be the result of [=query reporting ID k-anonymity count=] | ||
| given |ig|, |igAd|, and |selectableReportingId|. | ||
| 1. If [=query k-anonymity cache=] for |reportingHashCode| returns true, then | ||
| [=list/append=] |selectableReportingId| to |kAnonRestrictedSelectableReportingIds|. | ||
| 1. Set |igAd|'s [=interest group ad/selectable buyer and seller reporting IDs=] to | ||
| |kAnonRestrictedSelectableReportingIds|. | ||
| 1. [=list/Append=] |igAd| to |kAnonRestrictedIG|'s [=interest group/ads=]. | ||
|
|
@@ -8743,6 +8808,9 @@ A <dfn>bid debug reporting info</dfn> is a [=struct=] with the following [=struc | |
| won it, and was then scored by the top-level seller. Set by top-level seller's `scoreAd()`'s | ||
| {{InterestGroupBiddingAndScoringScriptRunnerGlobalScope/forDebuggingOnly}}'s | ||
| {{ForDebuggingOnly/reportAdAuctionLoss(url)}}. | ||
| : <dfn>server filtered debugging only reports</dfn> | ||
| :: A [=map=] whose [=map/keys=] are [=origins=] and whose [=map/values=] are [=lists=] of [=urls=]. | ||
| forDebuggingOnly reports that have been filtered (also downsampled) by the trusted auction server. | ||
| </dl> | ||
|
|
||
| A <dfn>bid with currency</dfn> is a [=struct=] with the following [=struct/items=]: | ||
|
|
||
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.
What has the responsibility for verifying that this is actually a component auction?
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.
good question. [=server auction response/component win debugging only reports=] only comes from reports whose
componentWin(code) is set to true (which is only possible if a B&A response message is from component auction's server, for auctions whose top level auction runs on-device). Currently we trust B&A server should make sure the fields are set correctly, but would probably be good for Chrome to check that the message is from a component auction server if it has a report whosecomponentWinis set to true.