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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

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
1. [=list/For each=] |generatedBid| of |generatedBids|:
1. If |generatedBid|'s [=generated bid/for k-anon auction=] is true:
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

...I need to figure out how to not report the non-k-anon run properly, I think it's wrong right now.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK, not too hard, but I am wondering about what we should do about platform realtime contributions here --- I think in impl we don't keep them for non-k-anon scoreAd run, while it's actually annoying to make the spec say that, and I am not sure it should.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done'ish. Also fixed additional bids not participating in non-k-anon auction.

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
: <dfn>source</dfn>
:: A [=reporting bid source=] describing where the bid came from.
: <dfn>origin</dfn>
:: The [=origin=] of the bidder.
Copy link
Collaborator

Choose a reason for hiding this comment

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

An [=origin=]. The bidding [=interest group=]'s [=interest group/owner=]?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There is not necessarily an interest group... which makes my bidding of the next field is dubious.

originated in.
: <dfn>source</dfn>
:: A [=reporting bid source=] describing where the bid came from.
: <dfn>origin</dfn>
Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe owner?

spec.bs Outdated
: <dfn>origin</dfn>
:: The [=origin=] of the bidder.
: <dfn>interest group name</dfn>
:: A [=string=] uniquely identifying the interest group.
Copy link
Collaborator

Choose a reason for hiding this comment

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

A [=string=]. The bidding [=interest group=]'s [=interest group/name=]?
And it's the owner/name pair that uniquely identifies the IG, right?

spec.bs Outdated

</dl>

Note: This type exists only to uniquely identify places bid came from, avoiding confusion in
Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe move this note to right after the "A reporting bid key" line, before the <dl>?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

...And the validator seems to dislike it, so reverted.

Copy link
Collaborator

@qingxinwu qingxinwu Oct 14, 2024

Choose a reason for hiding this comment

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

I meant before <dl> some lines above, not </dl>. It's not allowed to put "Note" into a <dl> block. But I'm fine with keeping the note here as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done?

spec.bs Outdated Show resolved Hide resolved
spec.bs Outdated Show resolved Hide resolved
: [=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 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.

: <dfn>source</dfn>
:: A [=reporting bid source=] describing where the bid came from.
: <dfn>origin</dfn>
:: The [=origin=] of the bidder.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There is not necessarily an interest group... which makes my bidding of the next field is dubious.

spec.bs Outdated

</dl>

Note: This type exists only to uniquely identify places bid came from, avoiding confusion in
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

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
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.

2 participants