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: export more definitions #175

Merged
merged 3 commits into from
Mar 4, 2025
Merged

Spec: export more definitions #175

merged 3 commits into from
Mar 4, 2025

Conversation

alexmturner
Copy link
Collaborator

@alexmturner alexmturner commented Mar 3, 2025

There are a range of definitions used in other specs that aren't exported yet.


Preview | Diff

@alexmturner
Copy link
Collaborator Author

@dmcardle could you PTAL? Thanks!

There are a range of definitions used in other specs that aren't
exported yet.
Copy link
Contributor

@dmcardle dmcardle left a comment

Choose a reason for hiding this comment

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

LGTM!

I found myself confused by bikeshed's explanation of how to export dfns (does a boolean attribute require an explicit true/false?), so I added a little convenience recipe to the Makefile to generate an "exports report". I diffed the reports from this PR and the main branch and everything looks as expected. Just FYI, here's the difference between the reports:

diff --git a/exports-report.3720046c1c2f469d546464b81d10b109a173b0b9.txt b/exports-report.185e9b4a865c8d1f3920aa05ea52f53f03cdbf6d.txt
index 0546b39..38c968c 100644
--- a/exports-report.3720046c1c2f469d546464b81d10b109a173b0b9.txt
+++ b/exports-report.185e9b4a865c8d1f3920aa05ea52f53f03cdbf6d.txt
@@ -10,28 +10,35 @@ Exported terms:
   filteringId
   PADebugModeOptions
   debugKey
+  scoping details
+  allowed to use
+  should perform default contributeToHistogramOnEvent() processing
   contributeToHistogram(contribution)
   contributeToHistogramOnEvent(event, contribution)
   enableDebugMode(options)
   enableDebugMode()
+  Batching scope
+  Debug scope
+  Scoping details
   internal error event
   error event
+  already triggered external error
+  Contribution cache entry
+  aggregation coordinator
+  pre-specified report parameters
+  private-aggregation
   get the privateAggregation
   append an entry to the contribution cache
   get a debug details
   mark a debug scope complete
+  determine if a report should be sent deterministically
   process contributions for a batching scope
   determine if an origin is an aggregation coordinator
   obtain the Private Aggregation coordinator
   set the aggregation coordinator for a batching scope
   set the pre-specified report parameters for a batching scope
+  validate a histogram contribution
 Unexported terms:
-  scoping details
-  allowed to use
-  should perform default contributeToHistogramOnEvent() processing
-  Batching scope
-  Debug scope
-  Scoping details
   get batching scope steps
   get debug scope steps
   Debug details
@@ -43,9 +50,7 @@ Unexported terms:
   pending-report-limit-reached
   insufficient-budget
   contribution-timeout-reached
-  already triggered external error
   All error events
-  Contribution cache entry
   contribution
   error event
   batching scope
@@ -68,9 +73,7 @@ Unexported terms:
   filtering ID max bytes
   max contributions
   queued
-  aggregation coordinator
   Context type
-  pre-specified report parameters
   context ID
   filtering ID max bytes
   max contributions
@@ -87,10 +90,7 @@ Unexported terms:
   Default maxContributions by API
   Minimum report delay
   Randomized report delay
-  private-aggregation
   serialize an integer
-  determine if a report should be sent deterministically
-  validate a histogram contribution
   report creation and scheduling steps
   compile all unmerged contributions
   merge key

@alexmturner
Copy link
Collaborator Author

Thanks, Dan! Per chat, just added a couple more :)

Copy link
Contributor

@dmcardle dmcardle left a comment

Choose a reason for hiding this comment

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

LGTM! This reminds me, I've got some merge conflicts to fix in WICG/shared-storage#219.

New diff between export reports
diff --git a/exports-report.3720046c1c2f469d546464b81d10b109a173b0b9.txt b/exports-report.a57f44cab3a5705168d8e9353408ded919a9ec34.txt
index 0546b39..e0539a5 100644
--- a/exports-report.3720046c1c2f469d546464b81d10b109a173b0b9.txt
+++ b/exports-report.a57f44cab3a5705168d8e9353408ded919a9ec34.txt
@@ -10,30 +10,42 @@ Exported terms:
   filteringId
   PADebugModeOptions
   debugKey
+  scoping details
+  allowed to use
+  should perform default contributeToHistogramOnEvent() processing
   contributeToHistogram(contribution)
   contributeToHistogramOnEvent(event, contribution)
   enableDebugMode(options)
   enableDebugMode()
+  Batching scope
+  Debug scope
+  Scoping details
+  get batching scope steps
+  get debug scope steps
   internal error event
   error event
+  already triggered external error
+  Contribution cache entry
+  aggregation coordinator
+  pre-specified report parameters
+  context ID
+  filtering ID max bytes
+  max contributions
+  Default filtering ID max bytes
+  Valid filtering ID max bytes range
+  private-aggregation
   get the privateAggregation
   append an entry to the contribution cache
   get a debug details
   mark a debug scope complete
+  determine if a report should be sent deterministically
   process contributions for a batching scope
   determine if an origin is an aggregation coordinator
   obtain the Private Aggregation coordinator
   set the aggregation coordinator for a batching scope
   set the pre-specified report parameters for a batching scope
+  validate a histogram contribution
 Unexported terms:
-  scoping details
-  allowed to use
-  should perform default contributeToHistogramOnEvent() processing
-  Batching scope
-  Debug scope
-  Scoping details
-  get batching scope steps
-  get debug scope steps
   Debug details
   enabled
   key
@@ -43,9 +55,7 @@ Unexported terms:
   pending-report-limit-reached
   insufficient-budget
   contribution-timeout-reached
-  already triggered external error
   All error events
-  Contribution cache entry
   contribution
   error event
   batching scope
@@ -68,29 +78,19 @@ Unexported terms:
   filtering ID max bytes
   max contributions
   queued
-  aggregation coordinator
   Context type
-  pre-specified report parameters
-  context ID
-  filtering ID max bytes
-  max contributions
   aggregatable report cache
   aggregation coordinator map
   pre-specified report parameters map
   contribution cache
   debug scope map
-  Default filtering ID max bytes
-  Valid filtering ID max bytes range
   Allowed aggregation coordinator set
   Default aggregation coordinator
   Maximum maxContributions
   Default maxContributions by API
   Minimum report delay
   Randomized report delay
-  private-aggregation
   serialize an integer
-  determine if a report should be sent deterministically
-  validate a histogram contribution
   report creation and scheduling steps
   compile all unmerged contributions
   merge key

@alexmturner alexmturner merged commit 445134a into main Mar 4, 2025
1 check passed
@alexmturner alexmturner deleted the export-more branch March 4, 2025 21:26
github-actions bot added a commit that referenced this pull request Mar 4, 2025
SHA: 445134a
Reason: push, by alexmturner

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants