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.

Sign up for GitHub

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] Allow setting automatic beacon data from cross-origin subframes. #203

Merged
merged 10 commits into from
Jan 22, 2025
Merged

[Spec] Allow setting automatic beacon data from cross-origin subframes. #203

Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7a1d43e
start work
blu25 Oct 23, 2024
1a8c85e
Merge branch 'master' into liam-cross-origin-beacon-changes
blu25 Jan 3, 2025
d50335c
have set check match impl
blu25 Jan 8, 2025
010f4b5
fix functional issues
blu25 Jan 8, 2025
d807142
more cleanup and add wpts
blu25 Jan 8, 2025
9d4da11
Merge branch 'master' into liam-cross-origin-beacon-changes
blu25 Jan 8, 2025
262ff14
remove comma
blu25 Jan 10, 2025
74cf338
address review comments
blu25 Jan 17, 2025
394fee3
Update spec.bs
blu25 Jan 17, 2025
0c72724
add dashes
blu25 Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 64 additions & 41 deletions spec.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1770,9 +1770,9 @@ Several APIs specific to fenced frames are defined on the {{Fence}} interface.
* |destinationURL| [=url/scheme=] is not "`https`";

1. Run [=report an event=] using |instance|'s [=fenced frame config instance/fenced frame
reporter=] with {{FenceReportingDestination/buyer}}, |request initiator|, |initiator
referrer policy| and a [=fencedframetype/destination URL event=] that is |event|'s
{{FenceEvent/destinationURL}}.
reporter=] with {{FenceReportingDestination/buyer}}, |request initiator|,
|initiator referrer policy|, and a [=fencedframetype/destination URL event=] that is
|event|'s {{FenceEvent/destinationURL}}.

1. Otherwise:
1. If |event| does not have a {{FenceEvent/destination}} or |event| does not have a
Expand Down Expand Up @@ -1837,13 +1837,13 @@ Several APIs specific to fenced frames are defined on the {{Fence}} interface.

1. If [=this=]'s [=relevant settings object=]'s [=environment settings object/origin=] and
|instance|'s [=fenced frame config instance/mapped url=]'s [=url/origin=] are not [=same
origin=], then return.
origin=], and if |event|'s {{FenceEvent/crossOriginExposed}} is false, then return.

1. If |instance|'s [=fenced frame config instance/fenced frame reporter=] is null, then return.

1. Set [=this=]'s [=relevant global object=]'s [=associated Document=]'s [=Document/automatic
beacon data map=][|event|'s {{FenceEvent/eventType}}] to an [=fencedframetype/automatic beacon
data=] with the following [=struct/items=]:
beacon data mapping=][|event|'s {{FenceEvent/eventType}}] to an [=fencedframetype/automatic
beacon data=] with the following [=struct/items=]:

: [=automatic beacon data/eventData=]
:: |event|'s {{FenceEvent/eventData}} if defined and |instance|'s [=fenced frame config
Expand Down Expand Up @@ -2115,22 +2115,22 @@ event|event-level beacon=] when a fenced frame initiates a successful [=navigate
instance/is ad component=] is false, and |sourceSnapshotParams|'s [=source snapshot
params/initiator ancestor root referrer policy=] otherwise.

1. Let |beacon data| be |sourceSnapshotParams|'s [=source snapshot params/automatic beacon data
map=][|eventType|].
1. Let |isCrossOrigin| be true if |sourceOrigin| is not [=same origin=] with |config|'s [=fenced
frame config instance/mapped url=]'s [=url/origin=], false otherwise.

1. Let |has header opt in| be |sourceSnapshotParams|'s [=source snapshot params/automatic beacons
allowed=].
1. Let |beaconMapping| be |sourceSnapshotParams|'s [=source snapshot params/snapshot automatic
beacon mapping=]'s [=snapshot automatic beacon mapping/data mapping=] if |isCrossOrigin| is
false, |sourceSnapshotParams|'s [=source snapshot params/snapshot automatic beacon mapping=]'s
[=snapshot automatic beacon mapping/cross-origin exposed data mapping=] otherwise.

1. If |beacon data| is null and |has header opt in| is false, abort these steps.
1. Let |beaconData| be |beaconMapping|[|eventType|].

1. Let |is cross origin| be true if |sourceOrigin| is not [=same origin=] with |config|'s [=fenced
frame config instance/mapped url=]'s [=url/origin=], false otherwise.
1. Let |has header opt in| be |sourceSnapshotParams|'s [=source snapshot params/automatic beacons
blu25 marked this conversation as resolved.
Show resolved Hide resolved
allowed=].

1. If |is cross origin| is true and |has header opt in| is false, abort these steps.
1. If |beaconData| is null and |has header opt in| is false, abort these steps.

1. Let |should send beacon with data| be true if |beacon data| is not null and either
|is cross origin| is false or |beacon data|'s [=automatic beacon data/crossOriginExposed=] is
true, false otherwise.
1. If |isCrossOrigin| is true and |has header opt in| is false, abort these steps.

1. [=list/For each=] |destination| of |config|'s [=fenced frame config instance/fenced frame
reporter=]'s [=fenced frame reporter/fenced frame reporting metadata reference=]'s
Expand All @@ -2144,19 +2144,17 @@ event|event-level beacon=] when a fenced frame initiates a successful [=navigate
:: |eventType|

: [=automatic beacon event/data=]
:: |beacon data|'s [=automatic beacon data/eventData=] if |should send beacon with data| is
true, |beacon data|'s [=automatic beacon data/destinations=] [=list/contains=]
|destination|, and |config|'s [=fenced frame config instance/is ad component=] is false,
the empty string otherwise.
:: The empty string if |beaconData| is null, |beaconData|'s [=automatic beacon
data/eventData=] otherwise.

: [=automatic beacon event/attributionReportingEnabled=]
:: |sourceSnapshotParams|'s [=source snapshot params/attribution reporting enabled=]

: [=automatic beacon event/attributionReportingContextOrigin=]
:: |sourceSnapshotParams|'s [=source snapshot params/attribution reporting context origin=]

1. If |beacon data|'s [=automatic beacon data/once=] is true, set |sourceSnapshotParams|'s
[=source snapshot params/automatic beacon data map=][|eventType|] to null.
1. If |beaconData|'s [=automatic beacon data/once=] is true, set |beaconMapping|[|eventType|] to
null.

<wpt>
/fenced-frame/automatic-beacon-anchor-click-handler.https.html
Expand All @@ -2173,6 +2171,11 @@ event|event-level beacon=] when a fenced frame initiates a successful [=navigate
/fenced-frame/automatic-beacon-cross-origin-no-opt-in.https.html
/fenced-frame/automatic-beacon-use-ancestor-data.https.html
</wpt>

TODO: Add the following tests:
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is blocking merge right?

Copy link
Collaborator Author

@blu25 blu25 Jan 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yeah. This isn't ready for review yet. I just uploaded this so I could see a visual diff.

I'm also running into issues with the tests not being found. I tried running bikeshed update --skip-manifest and got this error:

FATAL ERROR: Bikeshed currently only knows how to handle WPT v8 manifest data, but got v9. Please report this to the maintainer!

I think I have the latest release installed (4.2.8) so adding any new WPTs to the spec might be blocked until that gets patched.

/fenced-frame/automatic-beacon-data-cross-origin-ancestor.sub.https.html
/fenced-frame/automatic-beacon-data-set-by-sibling.https.html
/fenced-frame/automatic-beacon-data-multiple-ancestors.https.html
</div>

<div algorithm="top_navigation_start beacon patch">
Expand Down Expand Up @@ -2247,9 +2250,23 @@ An <dfn for=fencedframetype>automatic beacon data</dfn> is a [=struct=] with the
:: a [=boolean=]
</dl>

Each {{Document}} object has an associated <dfn for=Document>automatic beacon data map</dfn>, which
is a [=map=] whose [=map/keys=] are [=fencedframetype/automatic beacon event type=]s and whose
[=map/values=] are null or an [=fencedframetype/automatic beacon data=]
An <dfn for=fencedframetype>automatic beacon data mapping</dfn> is a [=map=] whose [=map/keys=] are
[=fencedframetype/automatic beacon event type=]s and whose [=map/values=] are null or an
[=fencedframetype/automatic beacon data=].

An <dfn for=fencedframetype>snapshot automatic beacon mapping</dfn> is a [=struct=] with the
blu25 marked this conversation as resolved.
Show resolved Hide resolved
following [=struct/items=]:

<dl dfn-for="snapshot automatic beacon mapping">
: <dfn>data mapping</dfn>
:: an [=fencedframetype/automatic beacon data mapping=]

: <dfn>cross-origin exposed data mapping</dfn>
:: an [=fencedframetype/automatic beacon data mapping=]
</dl>

Each {{Document}} object has an associated <dfn for=Document>automatic beacon data mapping</dfn>,
which is an [=fencedframetype/automatic beacon data mapping=].

Each {{Document}} object has an associated <dfn for=Document>automatic beacons allowed</dfn>, which
is a [=boolean=], initially false.
Expand Down Expand Up @@ -2949,41 +2966,47 @@ CORP violation report=] algorithm, as leaving it unfenced may cause a privacy le
: <dfn for="source snapshot params">automatic beacons allowed</dfn>
:: an [=boolean=].

: <dfn for="source snapshot params">automatic beacon data map</dfn>
:: a [=map=] whose [=map/keys=] are [=fencedframetype/automatic beacon event type=]s and whose
[=map/values=] are null or an [=fencedframetype/automatic beacon data=]
: <dfn for="source snapshot params">snapshot automatic beacon mapping</dfn>
:: an [=fencedframetype/snapshot automatic beacon mapping=].

</div>

<div algorithm>
To <dfn>get the automatic beacon data mapping to use</dfn> given a {{Document}} |sourceDocument|:
To <dfn>snapshot the automatic beacon data mapping</dfn> given a {{Document}} |sourceDocument|:

1. [=Assert=] these steps are running on |sourceDocument|'s [=event loop=].

1. Let |automatic beacon data map| be a new empty [=Document/automatic beacon data map=].
1. Let |info| be a new empty [=fencedframetype/snapshot automatic beacon mapping=].

1. Let |mapping| be |info|'s [=snapshot automatic beacon mapping/data mapping=].

1. Let |crossOriginMapping| be |info|'s [=snapshot automatic beacon mapping/cross-origin exposed
data mapping=].

1. Let |current navigable| be |sourceDocument|'s [=node navigable=].

1. While |current navigable| is not null:

1. [=map/iterate|For each=] |type| → |data| of |current navigable|'s [=navigable/active
document=]'s [=Document/automatic beacon data map=]:
document=]'s [=Document/automatic beacon data mapping=]:

1. If |automatic beacon data map|[|type|] does not [=map/exist=], set
|automatic beacon data map|[|type|] to |data|.
1. If |mapping|[|type|] does not [=map/exist=], set |mapping|[|type|] to |data|.

Note: This guarantees that the first ancestor that contains automatic beacon data for a
specific type will be usable by the document initiating the navigation. This will also prevent
an ancestor blocking a document from using data set in a higher ancestor.

1. If |crossOriginMapping|[|type|] does not [=map/exist=] and |data|'s [=automatic beacon
data/crossOriginExposed=] is true, set |crossOriginMapping|[|type|] to |data|.

1. Set |current navigable| to |current navigable|'s [=navigable/parent=].

1. Return |automatic beacon data map|.
1. Return |info|.

Note: The returned map is meant to hold references to the original {{Document}}'s
[=Document/automatic beacon data map=]s that were used to build |automatic beacon data map|. These
are later modified in [=attempt to send an automatic beacon=] to clear out any beacon data with
[=automatic beacon data/once=] set to true.
Note: The maps stored in |info| are meant to hold references to the original {{Document}}'s
[=Document/automatic beacon data mapping=]s that were used to build |info|. These are later
modified in [=attempt to send an automatic beacon=] to clear out any beacon data with [=automatic
beacon data/once=] set to true.
</div>

<div algorithm=get-initiator-ancestor>
Expand Down Expand Up @@ -3068,8 +3091,8 @@ CORP violation report=] algorithm, as leaving it unfenced may cause a privacy le
: [=source snapshot params/automatic beacons allowed=]
:: |sourceDocument|'s [=Document/automatic beacons allowed=]

: [=source snapshot params/automatic beacon data map=]
:: The result of running [=get the automatic beacon data mapping to use=] on |sourceDocument|.
: [=source snapshot params/snapshot automatic beacon mapping=]
:: The result of running [=snapshot the automatic beacon data mapping=] on |sourceDocument|.

</div>

Expand Down
Loading