To
register bids for reporting given a [=list=] of
[=generated bids=] |generatedBids|, [=interest group=] |ig|, [=bid debug reporting info=]
- |bidDebugReportInfo|, a [=Private Aggregation contributions=] |paContributions| and a [=reporting
- context=] |reportingContext|:
+ |bidDebugReportInfo|, a [=Private Aggregation contributions=] |paContributions|,
+ [=execution metrics=] |executionMetrics| and a [=reporting context=] |reportingContext|:
1. Let |id| be a new [=reporting bid key=] with the following [=struct/items=]:
: [=reporting bid key/context=]
:: |reportingContext|
@@ -3677,6 +3733,15 @@ auction in a multi-party auction).
:: |ig|'s [=interest group/name=]
1. [=map/Set=] |reportingContext|'s [=reporting context/debug reporting info=][|id|] to
|bidDebugReportInfo|.
+ 1. Let |metrics| be the result of [=access per-participant metrics=] given |reportingContext|,
+ |ig|'s [=interest group/owner=], [=worklet function/generate-bid=].
+ 1. [=Merge samples to an averager=] given |metrics|'s [=per participant metrics/average code fetch
+ time=] and |executionMetrics|'s [=execution metrics/average code fetch time=].
+ 1. Set |metrics|'s [=per participant metrics/script executions attempted=] to
+ |metrics|'s [=per participant metrics/participating interest group count=].
+ 1. If |executionMetrics|'s [=execution metrics/script timeout occurred=] is true, set |metrics|'s
+ [=per participant metrics/script timeouts occurred=] to |metrics|'s [=per participant metrics/
+ script timeouts occurred=] + 1.
1. [=set/Insert=] |id| into |reportingContext|'s [=reporting context/bidder participants=].
1. [=Commit private aggregation contributions=] given |paContributions|, |id| and
|reportingContext|.
@@ -4074,6 +4139,28 @@ A signal base value is one of the following:
Note: this mapping to an integer is defined in [=determine a signal's
numeric value=].
+: "
average-code-fetch-time"
+:: The numeric value is the average time it took to fetch code resources (JavaScript or WebAssembly)
+ for this particular worklet function, for this participant.
+: "
participating-ig-count"
+:: The numeric value is the number of interest groups for the buyer actually participating in the
+ auction, after considering prioritization and capabilities.
+: "
percent-scripts-timeout"
+:: The numeric value is percentage of executions of this script that hit their individual timeout,
+ out of all executions that were expected to happen.
+: "
regular-igs-count"
+:: Number of [=regular interest groups=] for the given buyer. (0 if this is used by a seller).
+: "
percent-regular-ig-count-quota-used"
+::
+: "
negative-igs-count"
+:: Number of [=negative interest groups=] for the given buyer. (0 if this is used by a seller).
+: "
percent-negative-ig-count-quota-used"
+::
+: "
ig-storage-used"
+:: Bytes of storage used by the given buyer. (0 if this is used by a seller).
+: "
percent-ig-storage-quota-used"
+::
+
On event contribution entry
@@ -4089,6 +4176,8 @@ An on event contribution entry is a [=struct=] with the following items:
:: A [=debug details=] or null (default null)
:
worklet function
:: A [=worklet function=].
+:
origin
+:: The [=origin=] of the script that contributed the entry.
@@ -4106,6 +4195,80 @@ A worklet function is one of the following:
+
+To
find corresponding bid and score phase function given a [=worklet function=] |fn|:
+
+ 1.Switch on on |fn|:
+
+ : [=worklet function/generate-bid=]
+ :: Return [=worklet function/generate-bid=].
+ : [=worklet function/score-ad=]
+ :: Return [=worklet function/score-ad=].
+ : [=worklet function/report-result=]
+ :: Return [=worklet function/score-ad=].
+ : [=worklet function/report-win=]
+ :: Return [=worklet function/generate-bid=].
+
+
+
+
+### Averager ### {#private-aggregation-averager}
+An
averager is a a [=struct=] with the following [=struct/items=]:
+
+ : count
+ :: A {{long}}, initially 0.
+ : sum
+ :: A {{double}}, initially 0.
+
+
+
+To add a sample to an averager given an [=averager=] |averager|, a {{double}} |sample|:
+1. Set |averager|'s [=averager/count=] to |averager|'s [=averager/count=] + 1.
+1. Set |averager|'s [=averager/sum=] to |averager|'s [=averager/sum=] + |sample|.
+
+
+
+
+To merge samples to an averager given [=averagers=] |dest| and |source|:
+1. Set |dest|'s [=averager/count=] to |dest|'s [=averager/count=] + |source|'s [averager/count=].
+1. Set |dest|'s [=averager/sum=] to |dest|'s [=averager/sum=] + |source|'s [averager/sum=].
+
+
+
+
+To get the value to report from an averager given an [=averager=] |averager|:
+1. If |averager|'s [=averager/count=] = 0, return 0.
+1. Return |averager|'s [=averager/sum=] / [=averager/count=].
+
+
+
+### Metrics structures ### {#private-aggregation-metrics-structures}
+An
execution metrics is a [=struct=] with the following [=struct/items=]:
+
+ : average code fetch time
+ :: An [=averager=].
+ : script timeout occurred
+ :: A [=boolean=], initially false.
+
+
+A
per participant metrics is a [=struct=] with the following [=struct/items=]:
+
+ : participating interest group count
+ :: A {{long}}, initially 0.
+ : average code fetch time
+ :: An [=averager=].
+ : script timeouts occurred
+ :: A {{long}}, initially 0.
+ : script executions attempted
+ :: A {{long}}, initially 0.
+ : regular interest group count
+ :: A {{long}}, initially 0.
+ : negative interest group count
+ :: A {{long}}, initially 0.
+ : storage quota used
+ :: A {{long}}, initially 0.
+
+
Private Aggregation contributions
Private Aggregation contributions is a [=map=] from [=string=] to a [=list=] of [=on event
contribution entries=].
@@ -4118,6 +4281,7 @@ To
prepare for private aggregation given a
a [=reporting context=] |reportingContext|, and [=origins=] |origin| and |aggregationCoordinator|:
1. Let |debugScope| be a new [=debug scope=].
1. Set |global|'s [=InterestGroupScriptRunnerGlobalScope/worklet function=] to |workletFunction|.
+1. Set |global|'s [=InterestGroupScriptRunnerGlobalScope/origin=] to |origin|.
1. Set |global|'s [=InterestGroupScriptRunnerGlobalScope/private aggregation=] to a new
[=PrivateAggregation=] with the following [=struct/items=]:
:
allowed to use
@@ -4226,7 +4390,7 @@ an [=auction config=] |auctionConfig| and a [=reporting context=] |reportingCont
1. Otherwise:
1. If |bidId| ≠ |sellerOnceRep|, [=iteration/continue=].
1. Let |filledInContribution| be the result of [=filling in the contribution=] given
- |onEventEntry|'s [=on event contribution entry/contribution=] and |leadingBidInfo|.
+ |reportingContext|, |onEventEntry| and |leadingBidInfo|.
Issue: Once
WICG/turtledove#627
is resolved, align 'filling in' logic with `forDebuggingOnly`.
@@ -4338,15 +4502,18 @@ an [=auction config=] |auctionConfig| and a [=reporting context=] |reportingCont
-To
fill in the signal value given a {{PASignalValue}} |value|, an
+To
fill in the signal value given a [=reporting context=] |reportingContext|,
+an [=on event contribution entry=] |onEventEntry|, a {{PASignalValue}} |value|, an
integer |maxAllowed| and a [=leading bid info=] |leadingBidInfo|, perform the following steps.
They return an integer.
1. [=Assert=]: |value|["{{PASignalValue/baseValue}}"] is a valid [=signal base
value=].
1. Let |returnValue| be the result of [=determining a signal's numeric value=]
- given |value|["{{PASignalValue/baseValue}}"] and |leadingBidInfo|.
+ given |reportingContext|, |onEventEntry|, |value|["{{PASignalValue/baseValue}}"] and
+ |leadingBidInfo|.
1. If |value|["{{PASignalValue/scale}}"] [=map/exists=], set |returnValue| to
the result of multiplying |value|["{{PASignalValue/scale}}"] with
|returnValue|.
@@ -4381,9 +4550,17 @@ They return an integer.
-To determine a signal's numeric value given a [=signal base value=]
+To determine a signal's numeric value given a [=reporting context=] |reportingContext|,
+an [=on event contribution entry=] |onEventEntry|, a [=signal base value=]
|signalBaseValue| and a [=leading bid info=] |leadingBidInfo|, perform the following steps.
They return a {{double}}.
+1. Let |metrics| be the result of [=access per-participant metrics=] given |reportingContext|,
+ |onEventEntry|'s [=on event contribution entry/origin=], [=on event contribution entry/
+ worklet function=].
+1. Let |bidAndScoreMetrics| be the result of [=access per-participant metrics=] given
+ |reportingContext|, |onEventEntry|'s [=on event contribution entry/origin=], and the result of
+ [=find corresponding bid and score phase function=] given [=on event contribution entry/worklet
+ function=].
1. If |signalBaseValue| is "[=signal base value/winning-bid=]":
1. If |leadingBidInfo|'s [=leading bid info/leading bid=] is null, return 0.
1. Otherwise, return |leadingBidInfo|'s [=leading bid info/leading bid=]'s [=generated bid/bid=].
@@ -4446,6 +4623,54 @@ They return a {{double}}.
Issue: Verify handling when the bid was not rejected.
+1. If |signalBaseValue| is "[=signal base value/average-code-fetch-time=]":
+ 1. Return the result of [=getting the value to report from an averager=] given |metrics|'s [=per
+ participant metrics/average code fetch time=].
+1. If |signalBaseValue| is "[=signal base value/participating-ig-count=]":
+ 1. Return |bidAndScoreMetrics|'s [=per participant metrics/participating interest group count=].
+1. If |signalBaseValue| is "[=signal base value/percent-scripts-timeout=]":
+ 1. Return the result of [=computing a percentage metric=] given |metrics|'s [=per participant
+ metrics/script timeouts occurred=] and |metrics|'s [=per participant metrics/script executions
+ attempted=].
+1. If |signalBaseValue| is "[=signal base value/regular-igs-count=]":
+ 1. Return |bidAndScoreMetrics|'s [=per participant metrics/regular interest group count=].
+1. If |signalBaseValue| is "[=signal base value/percent-regular-ig-count-quota-used=]":
+ 1. Return the result of [=computing a percentage metric=] given |bidAndScoreMetrics|'s [=per
+ participant metrics/regular interest group count=] and [=Max regular interest groups per owner=].
+1. If |signalBaseValue| is "[=signal base value/negative-igs-count=]":
+ 1. Return |bidAndScoreMetrics|'s [=per participant metrics/negative interest group count=].
+1. If |signalBaseValue| is "[=signal base value/percent-negative-ig-count-quota-used=]":
+ 1. Return the result of [=computing a percentage metric=] given |bidAndScoreMetrics|'s [=per
+ participant metrics/negative interest group count=] and [=Max negative interest groups per
+ owner=].
+1. If |signalBaseValue| is "[=signal base value/ig-storage-used=]":
+ 1. Return |bidAndScoreMetrics|'s [=per participant metrics/storage quota used=].
+1. If |signalBaseValue| is "[=signal base value/percent-ig-storage-quota-used=]":
+ 1. Return the result of [=computing a percentage metric=] given |bidAndScoreMetrics|'s [=per
+ participant metrics/storage quota used=] and [=Max interest groups total size per owner=].
+
+
+
+
+To compute a percentage metric given {{long}}s |numerator| and |denominator|:
+1. If |denominator| is 0, return 0.
+1. Let |result| be 100.0 * |numerator| / |denominator|, performing the computation with
+ {{double}}s.
+1. If |result| > 110.0, set |result| to 110.0
+1. Return |result|.
+
+
+
+
+To update storage metrics given [=per participant metrics=] |metrics| and a [=list=] of
+[=interest groups=] |igs|:
+1. [=list/For each=] |ig| of |igs|:
+ 1. If [=interest group/additional bid key=] is null, increment |metrics|'s [=per participant
+ metrics/regular interest group count=] by 1.
+ 1. Otherwise, increment |metrics|'s [=per participant metrics/negative interest group count=]
+ by 1.
+ 1. Increment |metrics|'s [=per participant metrics/storage quota used=] by |ig|'s [=interest
+ group/estimated size=]
@@ -5326,6 +5551,7 @@ of the following global objects:
To evaluate a bidding script given a [=string=] |script|, an {{unsigned short}}
|multiBidLimit|, an [=interest group=] |ig|, a [=reporting context=] |reportingContext|,
+ an [=execution metrics=] |executionMetrics|,
a [=currency tag=] |expectedCurrency|, a {{GenerateBidInterestGroup}} |igGenerateBid|,
a [=string=]-or-null |auctionSignals|, a [=string=]-or-null |perBuyerSignals|,
an [=ordered map=]-or-null |sameOriginTrustedBiddingSignals|, an [=ordered map=]-or-null
@@ -5369,7 +5595,8 @@ of the following global objects:
1. Let |crossOriginTrustedBiddingSignalsJS| be |crossOriginTrustedBiddingSignals|
[=converted to ECMAScript values=].
1. Let |startTime| be |settings|'s [=environment settings object/current monotonic time=].
- 1. Let |result| be the result of [=evaluating a script=] with |realm|, |script|, "`generateBid`",
+ 1. Let (|result|, |executionMetrics|'s [=execution metrics/script timeout occurred=]) be the
+ result of [=evaluating a script=] with |realm|, |script|, "`generateBid`",
« |igJS|, |auctionSignalsJS|, |perBuyerSignalsJS|, |sameOriginTrustedBiddingSignalsJS|,
|browserSignalsJS|, |directFromSellerSignalsJS|, |crossOriginTrustedBiddingSignalsJS| »,
and |timeout|.
@@ -5424,7 +5651,7 @@ of the following global objects:
1. Let |paContributions| be the result of [=extracting private aggregation contributions=] given
|global|.
1. Return a [=tuple=] (|generatedBids|, |bidDebugReportInfo|, |realTimeContributions|,
- |paContributions|).
+ |paContributions|, |executionMetrics|).
@@ -5452,7 +5679,9 @@ of the following global objects:
1. Let |directFromSellerSignalsJs| be |directFromSellerSignalsForSeller|
[=converted to ECMAScript values=].
1. Let |startTime| be |settings|'s [=environment settings object/current monotonic time=].
- 1. Let |scoreAdResult| be the result of [=evaluating a script=] with |realm|, |script|, "`scoreAd`",
+ 1. Let |executionMetrics| be a new [=execution metrics=].
+ 1. Let (|scoreAdResult|, |executionMetrics|'s [=execution metrics/script timeout occurred=]) be
+ the result of [=evaluating a script=] with |realm|, |script|, "`scoreAd`",
«|adMetadata|, |bidValue|, |auctionConfigJS|, |sameOriginTrustedScoringSignalsJS|,
|browserSignalsJS|, |directFromSellerSignalsJs|, |crossOriginTrustedScoringSignalsJS|»,
and |timeout|.
@@ -5474,7 +5703,7 @@ of the following global objects:
1. Let |paContributions| be the result of [=extracting private aggregation contributions=] given
|global|.
1. Return « |scoreAdResult|, |debugWinReportUrl|, |debugLossReportUrl|, |realTimeContributions|,
- |paContributions| ».
+ |paContributions|, |executionMetrics| ».
@@ -5493,8 +5722,10 @@ of the following global objects:
1. Let |argumentsJS| be the result of [=converting a Web IDL arguments list to an ECMAScript
arguments list|converting=] |arguments| to an ECMAScript arguments list. If this
[=exception/throws=] an exception, return « "null", null, null, null ».
- 1. Let |result| be the result of [=evaluating a script=] with |realm|, |script|,
- |functionName|, |argumentsJS|, and |timeout|.
+ 1. Let |executionMetrics| be a new [=execution metrics=].
+ 1. Let (|result|, |executionMetrics|'s [=execution metrics/script timeout occurred=]) be the
+ result of [=evaluating a script=] with |realm|, |script|, |functionName|, |argumentsJS|,
+ and |timeout|.
1. If |result| is an [=ECMAScript/abrupt completion=], return « "null", null, null, null ».
1. Let |resultJSON| be "null".
1. If |functionName| is "`reportResult`", then set |resultJSON| to the result of
@@ -5511,20 +5742,23 @@ of the following global objects:
|global|.
1. Return « |resultJSON|, |reportURL|,
|global|'s [=InterestGroupReportingScriptRunnerGlobalScope/reporting beacon map=], |macroMap|,
- |paContributions| ».
+ |paContributions|, |executionMetrics| ».
To evaluate a script with a [=ECMAScript/realm=] |realm|, [=string=] |script|, [=string=]
|functionName|, a [=list=] |arguments|, and an integer millisecond [=duration=] |timeout|, run these steps.
- They return a [=ECMAScript/Completion Record=], which is either an [=ECMAScript/abrupt completion=] (in
- the case of a parse failure or execution error), or a [=ECMAScript/normal completion=] populated with the
- [=ECMAScript/ECMAScript language value=] result of invoking |functionName|.
+ They return a tuple of a [=ECMAScript/Completion Record=], which is either an [=ECMAScript/abrupt
+ completion=] (in the case of a parse failure or execution error), or a [=ECMAScript/normal
+ completion=] populated with the [=ECMAScript/ECMAScript language value=] result of invoking
+ |functionName|, and a [=boolean=] stating whether the script was interrupted due to reaching
+ |timeout|.
1. [=Assert=] that these steps are running [=in parallel=].
- 1. If |timeout| ≤ 0, [=immediately=] interrupt the execution and set |finalCompletion| to a
- new [=ECMAScript/throw completion=] given null.
+ 1. If |timeout| ≤ 0, return (new [=ECMAScript/throw completion=] given null, true).
+
+ 1. Let |timeoutOccurred| be false.
1. Let |global| be |realm|'s [=realm/global object=], and run these steps in |realm|'s [=realm/agent=]:
@@ -5555,8 +5789,8 @@ of the following global objects:
|arguments|)).
In |timeout| milliseconds, if the invocation of [$Call$] has not completed,
- [=immediately=] interrupt the execution and set |finalCompletion| to a new
- [=ECMAScript/throw completion=] given null.
+ [=immediately=] interrupt the execution, set |finalCompletion| to a new
+ [=ECMAScript/throw completion=] given null, and set |timeoutOccurred| to true.
1. Return: at this point |finalCompletion| will be set to a
[=ECMAScript/Completion Record=].
@@ -5565,7 +5799,7 @@ of the following global objects:
execution context|running JavaScript execution context=], and remove it from the
[=ECMAScript/execution context stack|JavaScript execution context stack=].
- 1. Return |finalCompletion|.
+ 1. Return (|finalCompletion|, timeoutOccurred).
## Global scopes ## {#global-scopes}
@@ -5611,6 +5845,8 @@ Each {{InterestGroupScriptRunnerGlobalScope}} has a
:: A [=worklet function=]. Affects some
[Private Aggregation API](https://github.com/patcg-individual-drafts/private-aggregation-api)
functionality.
+ :
origin
+ :: The [=origin=] of the script being executed.
@@ -5626,6 +5862,7 @@ The
contributeToHistogramOnEvent(DOMString
event, PAExtendedHistogramContribution contribution) method steps are:
1. Let |global| be [=this=]'s [=relevant global object=].
1. Let |function| be |global|'s [=InterestGroupScriptRunnerGlobalScope/worklet function=].
+1. Let |origin| be |global|'s [=InterestGroupScriptRunnerGlobalScope/origin=].
1. If [=this=]'s
allowed to use is false, [=exception/throw=] a {{TypeError}}.
1. Let |scopingDetails| be [=this=]'s
@@ -5685,7 +5922,8 @@ event, PAExtendedHistogramContribution contribution) method steps are:
for="scoping details">get debug scope steps.
: [=on event contribution entry/worklet function=]
:: |function|
-
+ : [=on event contribution entry/origin=]
+ :: |origin|
1. Let |onEventContributionMap| be |global|'s
[=InterestGroupScriptRunnerGlobalScope/on event contribution map=].
1. If |onEventContributionMap|[|event|] does not [=map/exist=], set
@@ -7859,6 +8097,8 @@ headers. It's a [=struct=] with the following [=struct/items=]:
:
origins authorized for cross origin trusted signals
:: A [=list=] of [=origins=] or null. Initially null. Parsed value of
[:Ad-Auction-Allow-Trusted-Scoring-Signals-From:].
+ :
fetch duration
+ :: A [=duration=] in milliseconds, denoting how long it took the fetch to complete.
@@ -7936,6 +8176,8 @@ a [=script fetcher=] |fetcher|:
Issue: Stop using "`no-cors`" mode where possible
(
WICG/turtledove#667).
+
+ 1. Let |fetchStart| be |settings|'s [=environment settings object/current monotonic time=].
1. Let |fetchController| be the result of [=fetching=] |request| with [=fetch/useParallelQueue=]
set to true, and [=fetch/processResponse=] set to the following steps given
a [=response=] |response|:
@@ -7943,6 +8185,8 @@ a [=script fetcher=] |fetcher|:
1. [=fetch controller/Abort=] |fetchController|.
1. Set |fetcher|'s [=script fetcher/origins authorized for cross origin trusted signals=] to
an empty [=list=] of [=origins=].
+ 1. Set |fetcher|'s [=script fetcher/fetch duration=] to the [=duration from=] |fetchStart| to
+ |settings|'s [=environment settings object/current monotonic time=], in milliseconds.
1. Set |fetcher|'s [=script fetcher/script body=] to failure.
1. Set |fetcher|'s [=script fetcher/origins authorized for cross origin trusted signals=] to the
result of [=parsing allowed trusted scoring signals origins=] given |response|'s [=response/
@@ -7951,6 +8195,8 @@ a [=script fetcher=] |fetcher|:
1. Let |bodyReader| be result of [=ReadableStream/getting a reader=] from |bodyStream|.
1. Let |successSteps| be a set of steps that take a [=byte sequence=] |responseBody|, and
perform the following:
+ 1. Set |fetcher|'s [=script fetcher/fetch duration=] to the [=duration from=] |fetchStart| to
+ |settings|'s [=environment settings object/current monotonic time=], in milliseconds.
1. If [=validate fetching response mime and body=] with |response|, |responseBody| and
"`text/javascript`" returns false, set |fetcher|'s [=script fetcher/script body=] to
failure.