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

Remove persistent non-document reporting from spec. #191

Merged
merged 11 commits into from
Mar 3, 2020

Conversation

clelland
Copy link
Contributor

@clelland clelland commented Dec 18, 2019

This change removes the concepts which are only relevant to persistent
out-of-band reporting specs, such as Network Error Logging, and
explicitly defines reporting mechansims for documents, where the
generated reports are queued with the document itself, and thereby
inherit its lifetime. Generic reporting concepts are extracted into
another section so that they can be used by other specs.

Addresses issues raised in #158.


Preview | Diff

This change removes the concepts which are only relevant to persistent
out-of-band reporting specs, such as Network Error Logging, and
explicitly defines reporting mechansims for documents, where the
generated reports are queued with the document itself, and thereby
inherit its lifetime. Generic reporting concepts are extracted into
another section so that they can be used by other specs.

Addresses issues raised in #158.
@clelland
Copy link
Contributor Author

I've updated the deploy scripts to make the rendered artifacts in this branch visible. The core reporting concepts and document-centered reports are at https://w3c.github.io/reporting/split-persistence/index.html, while the persistent network-reports are https://w3c.github.io/reporting/split-persistence/network-reporting.html

This was referenced Jan 10, 2020
@dcreager
Copy link
Member

I'm wondering if this patch could go even further. Are there any other specs besides NEL that need persistent out-of-band reporting? If not, an even cleaner refactoring would be to move all of that logic back into NEL proper. No reason to pull it out into a separate "Network Reporting" spec if there's no one else who would use it.

It might still be useful to be able to use Origin Policy to provide default values for the per-document Reporting configuration, but that would also not go in a separate spec; we'd just put the Origin Policy-related text in the main per-document Reporting spec.

So that would leave us with:

  1. One "Reporting" spec, which is refactored and simplified to only be used for per-document reporting use cases.

  2. "Network Error Logging", which does its own thing since it needs client-side load balancing, failver, retries, etc, to work at all.

This removes endpoint weight and priority from the basic reporting spec,
and creates a 'network reporting endpoint' concept for network
reporting. Endpoint groups are similarly moved to network reporting, as
there is no longer any need to group endpoints otherwise. Retries and
failover are removed from basic reporting.
@clelland clelland merged commit 0ce0939 into master Mar 3, 2020
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