Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spec: add some shared infra for reporting, and port forDebugOnly to it. #1296

Merged
merged 11 commits into from
Oct 23, 2024

Conversation

morlovich
Copy link
Collaborator

@morlovich morlovich commented Oct 8, 2024

This is intended to be used for moving our Private Aggregation support into our spec, as it provides:

  • A way of identifying the winning invocations that's not tied to forDebugOnly
  • A place to store organizing information per component auction and per worklet function invocation. (Though I am a bit
    vague on how the top-level scope should work still).
    ...for now, forDebugOnly is what's ported to it, and while at it, things were fixed to actually pass the argument needed for reporting to scoreAd invocations, and to fix up additional bids (and B&A) for it.

It may make sense to move realTimeContributions in there as well, though it doesn't really benefit from any functionality besides maybe avoiding a parameter sometimes (and the split is kinda harmful).


Preview | Diff

@morlovich morlovich added the spec Relates to the spec label Oct 8, 2024
spec.bs Show resolved Hide resolved
Copy link
Collaborator

@qingxinwu qingxinwu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first round

spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated
: [=reporting bid key/origin=]
:: |ig|'s [=interest group/owner=]
: [=reporting bid key/interest group name=]
:: A string representation of a new globably unique identifier. This is needed since |igName|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's interest group name for regular interest groups. For additional bids it can't be, since there is nothing saying that they have to provide a unique interest group name. (And now I am scared of something in our impl breaking because of that...).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So renamed this. The new description is kinda vague, but it does I think clarify that one can't expect it to be an IG name.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does impl rely on IG name? if so, we need to fix it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Impl generally uses BidState* as equivalent of "reporting bid key" for reporting. There are a bunch of other things that use InterestGroupKey which seem fine for what I looked, but there are too many for me to be certain none get confused with additionalBid stuff (especially since it's somehow wired into fenced frame?)

Copy link
Collaborator Author

@morlovich morlovich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied the little fixes; can't quite make up my mind of naming of fields of the key.

spec.bs Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
Copy link
Collaborator

@qingxinwu qingxinwu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few more comments. Will take a final look today.

spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
spec.bs Show resolved Hide resolved
spec.bs Show resolved Hide resolved
@morlovich
Copy link
Collaborator Author

Anything else I need to do here?

spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
context.
</dl>

A <dfn>reporting context</dfn> is a [=struct=] with the following [=struct/items=]:
Copy link
Collaborator

@qingxinwu qingxinwu Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be useful to say that "is a [=struct=] which contains reports from bidding and scoring phases, with the following ...". PAgg also exists in reportWin()/reportResult(), but probably we don't want to put them into this

@qingxinwu
Copy link
Collaborator

qingxinwu commented Oct 23, 2024

just this last comment, but I'm fine with adding that sentence when we start handling PAgg requests (from reportWin/reportResult) in this spec (then we know whether it's true or not). Otherwise, LGTM and just approved.

@JensenPaul JensenPaul merged commit 4a419ab into WICG:main Oct 23, 2024
2 checks passed
github-actions bot added a commit that referenced this pull request Oct 23, 2024
…t. (#1296)

SHA: 4a419ab
Reason: push, by JensenPaul

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot added a commit to morlovich/turtledove that referenced this pull request Oct 23, 2024
…t. (WICG#1296)

SHA: 4a419ab
Reason: push, by morlovich

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
HabibiYou pushed a commit to HabibiYou/turtledove that referenced this pull request Oct 29, 2024
…t. (WICG#1296)

* Start the refactor on reporting...

* Fix score invocations.

* Don't do reporting from shadow auction.

* Revert note move.

* Rename field.

* Apply feedback

* More feedback.

* origin -> bidder origin.

* More feedback

---------

Co-authored-by: Maks Orlovich <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec Relates to the spec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants