Skip to content

Address warnings from building spec #1523

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

Merged
apasel422 merged 4 commits into from
May 19, 2025
Merged

Address warnings from building spec #1523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
23c2c83
Suppress warnings about unreferenced definitions
apasel422 May 19, 2025
4ef50d6
Address RFC2119 keyword warnings
apasel422 May 19, 2025
7b59745
Address example-ID warnings
apasel422 May 19, 2025
65408db
Fail spec builds on lint issues
apasel422 May 19, 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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ $(bikeshed): $(venv-marker) Makefile
@touch $@

$(OUT_DIR)/index.html: index.bs $(OUT_DIR) $(bikeshed)
$(bikeshed) --die-on=warning spec $< $@
$(bikeshed) --die-on=lint spec $< $@

validator: $(OUT_DIR)/validate-headers.html $(OUT_DIR)/validate-headers.js $(OUT_DIR)/filters.html $(OUT_DIR)/filters-main.js

Expand Down
52 changes: 26 additions & 26 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ a [=set=] of [=strings=] |allowedKeys|:
value |value|, and the parameters |params| to |entries|.
1. Return a [=structured header/dictionary=] containing |entries|.

<p class=note>The user agent may "[=structured header/define new structured fields|grease=]" the
<p class=note>The user agent can "[=structured header/define new structured fields|grease=]" the
dictionary structured headers according to the preceding algorithm to help ensure that recipients
use a proper structured header parser, rather than naive string equality or
`contains` operations, which makes it easier to introduce backwards-compatible
Expand All @@ -443,14 +443,14 @@ members helps ensure that, e.g., "`key1, key2`" is treated equivalently to "`key
In the following example, only the "`trigger`" key should be interpreted by the
recipient after the header has been parsed as a structured dictionary:

<pre class="example" heading="Greased Attribution-Reporting-Eligible header">
<pre class="example" heading="Greased Attribution-Reporting-Eligible header" id=grease-eligible>
Attribution-Reporting-Eligible: not-event-source, trigger=event-source;navigation-source=3
</pre>

In the following example, only the "`os`" key should be interpreted by the
recipient after the header has been parsed as a structured dictionary:

<pre class="example" heading="Greased Attribution-Reporting-Support header">
<pre class="example" heading="Greased Attribution-Reporting-Support header" id=grease-support>
Attribution-Reporting-Support: os=web
</pre>

Expand Down Expand Up @@ -1173,7 +1173,7 @@ Possible values are:
<li>"<dfn><code>source-storage-limit</code></dfn>"
<li>"<dfn><code>source-success</code></dfn>"
<li>"<dfn><code>source-trigger-state-cardinality-limit</code></dfn>"
<li>"<dfn><code>source-unknown-error</code></dfn>"
<li>"<dfn noexport><code>source-unknown-error</code></dfn>"
</ul>

A <dfn>trigger debug data type</dfn> is a [=debug data type=] for trigger registrations.
Expand Down Expand Up @@ -1201,7 +1201,7 @@ Possible values are:
<li>"<dfn><code>trigger-no-matching-filter-data</code></dfn>"
<li>"<dfn><code>trigger-no-matching-source</code></dfn>"
<li>"<dfn><code>trigger-reporting-origin-limit</code></dfn>"
<li>"<dfn><code>trigger-unknown-error</code></dfn>"
<li>"<dfn noexport><code>trigger-unknown-error</code></dfn>"
</ul>

An <dfn>OS debug data type</dfn> is a [=debug data type=] for OS registrations.
Expand All @@ -1212,7 +1212,7 @@ Possible values are:
<li>"<dfn><code>os-trigger-delegated</code></dfn>"
</ul>

A <dfn>header errors debug data type</dfn> is a [=debug data type=] for
A <dfn noexport>header errors debug data type</dfn> is a [=debug data type=] for
registration header errors. Possible values are:

<ul dfn-for="header errors debug data type">
Expand Down Expand Up @@ -1587,7 +1587,7 @@ To <dfn>serialize [=event-level report/attribution destinations=]</dfn> |destina
1. If |destinationStrings|'s [=set/size=] is equal to 1, return |destinationStrings|[0].
1. Return |destinationStrings|.

<p class=note>|destinations| is required to be sorted to avoid revealing extra
<p class=note>|destinations| has to be sorted to avoid revealing extra
information about the original source registration, namely the order of the
"<code>[=source-registration JSON key/destination=]</code>" field in the
original JSON registration, which can be used to distinguish semantically
Expand Down Expand Up @@ -1695,7 +1695,7 @@ To <dfn>parse an aggregation coordinator</dfn> given |value|:

<h3 id="parsing-aggregatable-debug-reporting-config">Parsing aggregatable debug reporting config</h3>

An <dfn>aggregatable-debug-reporting JSON key</dfn> is one of the following:
An <dfn noexport>aggregatable-debug-reporting JSON key</dfn> is one of the following:

<ul dfn-for="aggregatable-debug-reporting JSON key">
<li>"<dfn><code>aggregation_coordinator_origin</code></dfn>"
Expand Down Expand Up @@ -1789,7 +1789,7 @@ and an [=aggregatable debug reporting config=] |default|:
1. Return |aggregatableDebugReportingConfig|.

<p class=note>The parsing errors are intentionally ignored in this algorithm with |default|
returned to avoid data loss from the optional debug reporting feature.
returned to avoid data loss from the debug reporting feature.

<h3 id="getting-registration-info">Getting registration info</h3>

Expand Down Expand Up @@ -2124,9 +2124,9 @@ and a [=response=] |response|:

1. The user-agent may ignore the response; if so, return.

<p class=note>The user-agent may prevent attribution for a number of reasons, such as user opt-out. In these
<p class=note>The user-agent can prevent attribution for a number of reasons, such as user opt-out. In these
cases, it is preferred to abort the API flow at response time rather than at request time so this
state is not immediately detectable. Attribution may also be blocked if the reporting origin is not
state is not immediately detectable. Attribution can also be blocked if the reporting origin is not
<a href="https://github.com/privacysandbox/attestation">enrolled</a>.

1. [=Queue a task=] on the [=networking task source=] to proceed with the following steps.
Expand Down Expand Up @@ -2373,7 +2373,7 @@ To <dfn>compute the scopes channel capacity of a source</dfn> given a positive i

<h3 algorithm id="parsing-source-registration">Parsing source-registration JSON</h3>

A <dfn>source-registration JSON key</dfn> is one of the following:
A <dfn noexport>source-registration JSON key</dfn> is one of the following:

<ul dfn-for="source-registration JSON key">
<li>"<dfn><code>aggregatable_debug_reporting</code></dfn>"
Expand Down Expand Up @@ -2857,11 +2857,11 @@ To <dfn>delete sources for unexpired destination limit</dfn> given a [=set=] of
1. [=set/Append=] |report|'s [=event-level report/internal ID=] to |deletedEventLevelReports|.
1. [=set/Remove=] |report| from the [=event-level report cache=].

<p class=note>Leaking browsing history of destinations deactivated for unexpired
<p class=note>Leaking browsing history of destinations deactivated for the unexpired
destination limit from [=event-level reports=] whose [=event-level report/trigger time=]
is earlier than |now| is mitigated by the presence of [=obtain a fake report|fake reports=].
[=Event-level reports=] whose [=event-level report/trigger time=] is greater
than or equal to |now| must be deleted to avoid exposing whether an
than or equal to |now| have to be deleted to avoid exposing whether an
[=attribution source=] has a [=attribution source/randomized response=].

1. Let |deletedAggregatableReports| be a new [=set=].
Expand Down Expand Up @@ -3041,7 +3041,7 @@ a [=boolean=] |isNoised|, and a [=boolean=] |destinationLimitReplaced|:
1. If |destinationLimitReplaced| is true, [=map/set=] |body|["`source_destination_limit`"]
to the user agent's [=max destinations covered by unexpired sources=], [=serialize an integer|serialized=].

<p class=note>The "`source_destination_limit`" field may be included to indicate that
<p class=note>The "`source_destination_limit`" field can be included to indicate that
[=max destinations covered by unexpired sources=] was hit, which is not
reported as "<code>[=source debug data type/source-destination-limit=]</code>" to prevent side-channel
leakage of cross-origin data.
Expand Down Expand Up @@ -3306,16 +3306,16 @@ To <dfn>process an attribution source</dfn> given an [=attribution source=] |sou
privacy budget of all possible destinations.

<p class=note>The limits that are not reported as <code>[=source debug data type/source-success=]</code>
in [=verbose debug reports=] should be checked before any limits that are reported implicitly as
in [=verbose debug reports=] have to be checked before any limits that are reported implicitly as
<code>[=source debug data type/source-success=]</code> (
<code>[=source debug data type/source-destination-global-rate-limit=]</code> and
<code>[=source debug data type/source-reporting-origin-limit=]</code>) to
prevent side-channel leakage of cross-origin data. Furthermore, the [=verbose debug data=]
should be fully determined regardless of the result of checks on implicitly reported limits.
have to be fully determined regardless of the result of checks on implicitly reported limits.

# Triggering Algorithms # {#trigger-algorithms}

A <dfn>trigger-registration JSON key</dfn> is one of the following:
A <dfn noexport>trigger-registration JSON key</dfn> is one of the following:

<ul dfn-for="trigger-registration JSON key">
<li>"<dfn><code>aggregatable_debug_reporting</code></dfn>"
Expand Down Expand Up @@ -3683,16 +3683,16 @@ To <dfn>match [=filter values=] with negation</dfn> given a [=filter value=] |a|

To <dfn>match an attribution source against a filter config</dfn> given an
[=attribution source=] |source|, a [=filter config=] |filter|, a [=moment=] |moment|, and a [=boolean=]
<dfn for="match an attribution source against a filter config"><var>isNegated</var></dfn>:
|isNegated|:

1. Let |lookbackWindow| be |filter|'s [=filter config/lookback window=].
1. If |lookbackWindow| is not null:
1. If the [=duration from=] |moment| and the |source|'s [=attribution source/source time=] is greater than |lookbackWindow|:
1. If |isNegated| is false, return false.
1. Else if |isNegated| is true, return false.

<p class=note>If non-negated, the source must have been registered inside of the
lookback window. If negated, it must be outside of the lookback window.
<p class=note>If non-negated, the source had to be registered inside of the
lookback window. If negated, it had to be outside of the lookback window.

1. Let |filterMap| be |filter|'s [=filter config/map=].
1. Let |sourceData| be |source|'s [=attribution source/filter data=].
Expand Down Expand Up @@ -3921,7 +3921,7 @@ an [=event-level report=] |b| if any of the following are true:
* |a|'s [=event-level report/trigger priority=] is equal to |b|'s [=event-level report/trigger priority=]
and |a|'s [=event-level report/trigger time=] is greater than |b|'s [=event-level report/trigger time=].

An <dfn>event-level-report-replacement result</dfn> is one of the following:
An <dfn noexport>event-level-report-replacement result</dfn> is one of the following:

<dl dfn-for="event-level-report-replacement result">
: "<dfn><code>add-new-report</code></dfn>"
Expand Down Expand Up @@ -4536,7 +4536,7 @@ To <dfn>queue reports for delivery</dfn> given a [=set=] of
1. [=set/Remove=] |report| from |cache|.

<p class=note>In order to support sending, waiting, and retries across various
forms of interruption, including shutdown, the user agent may need to
forms of interruption, including shutdown, the user agent might need to
persist reports that are in the process of being sent in some other
storage.
1. [=list/Append=] |report| to |reportsToSend|.
Expand Down Expand Up @@ -4641,7 +4641,7 @@ Issue: Specify this in terms of [=fetch=].

<p class=note>The user agent might enforce weekly key rotation. If there are multiple keys, the user agent
might independently pick a key uniformly at random for every encryption operation.
The key should be uniquely identifiable.
The key has to be uniquely identifiable.

An [=aggregatable report=] |report|'s <dfn for="aggregatable report">plaintext payload</dfn>
is the result of running the following steps:
Expand Down Expand Up @@ -5058,7 +5058,7 @@ configuration.
<tbody>
<tr>
<td>POST</td>
<td>`/session/{session id}/ara/`<dfn>`localtestingmode`</dfn></td>
<td>`/session/{session id}/ara/`<dfn noexport>`localtestingmode`</dfn></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -5094,7 +5094,7 @@ The [=remote end steps=] are:
<tbody>
<tr>
<td>POST</td>
<td>`/session/{session id}/ara/`<dfn>`sendpendingreports`</dfn></td>
<td>`/session/{session id}/ara/`<dfn noexport>`sendpendingreports`</dfn></td>
</tr>
</tbody>
</table>
Expand Down
Loading
⚡