Skip to content

Commit

Permalink
Update of TR report from new reffy run
Browse files Browse the repository at this point in the history
Using reffy commit 17.2.3.
  • Loading branch information
reffy-bot committed Sep 4, 2024
1 parent d75ad2e commit 8c20f99
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 44 deletions.
32 changes: 10 additions & 22 deletions tr/algorithms/push-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,24 +87,18 @@
{
"html": "If <var data-type=\"ServiceWorkerRegistration\">registration</var>'s <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://www.w3.org/TR/service-workers/#dfn-active-worker\">active worker</a> is null, <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://html.spec.whatwg.org/multipage/webappapis.html#queue-a-global-task\">queue a global task</a> on the <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://html.spec.whatwg.org/multipage/webappapis.html#networking-task-source\">networking task source</a> using <var>global</var> to <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://webidl.spec.whatwg.org/#reject\">reject</a> <var>promise</var> with\n an \"<a data-link-type=\"idl\" data-type=\"exception\" href=\"https://webidl.spec.whatwg.org/#invalidstateerror\"><code>InvalidStateError</code></a>\" <a data-link-type=\"idl\" data-lt=\"DOMException\" data-type=\"interface\" href=\"https://webidl.spec.whatwg.org/#idl-DOMException\"><code>DOMException</code></a> and terminate these steps."
},
{
"html": "Let <var>sw</var> be <var data-type=\"ServiceWorkerRegistration\">registration</var>'s <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://www.w3.org/TR/service-workers/#dfn-active-worker\">active worker</a>."
},
{
"html": "Let <var>permission</var> be <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://www.w3.org/TR/permissions/#dfn-request-permission-to-use\">request permission to use</a> \"push\"."
},
{
"html": "If <var>permission</var> is \"<a data-link-type=\"idl\" data-type=\"enum-value\" href=\"https://www.w3.org/TR/permissions/#dom-permissionstate-denied\"><code>denied</code></a>\", <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://html.spec.whatwg.org/multipage/webappapis.html#queue-a-global-task\">queue a global task</a> on the <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://html.spec.whatwg.org/multipage/webappapis.html#user-interaction-task-source\">user interaction task source</a> using <var>global</var> to <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://webidl.spec.whatwg.org/#reject\">reject</a> <var>promise</var> with a\n \"<a data-link-type=\"idl\" data-type=\"exception\" href=\"https://webidl.spec.whatwg.org/#notallowederror\"><code>NotAllowedError</code></a>\" <a data-link-type=\"idl\" data-lt=\"DOMException\" data-type=\"interface\" href=\"https://webidl.spec.whatwg.org/#idl-DOMException\"><code>DOMException</code></a> and terminate these steps."
},
{
"html": "If <var>sw</var> is already subscribed, run the following sub-steps:",
"rationale": "try",
"html": "If <var data-type=\"ServiceWorkerRegistration\">registration</var> has a <a href=\"https://www.w3.org/TR/push-api/#dfn-push-subscription\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-subscription-49\">push subscription</a>:",
"rationale": "let",
"steps": [
{
"html": "Try to retrieve the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-subscription\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-subscription-49\">push subscription</a> associated with the <var>sw</var>. If there is\n an error, <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://html.spec.whatwg.org/multipage/webappapis.html#queue-a-global-task\">queue a global task</a> on the <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://html.spec.whatwg.org/multipage/webappapis.html#networking-task-source\">networking task source</a> using <var>global</var> to\n <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://webidl.spec.whatwg.org/#reject\">reject</a> <var>promise</var> with an \"<a data-link-type=\"idl\" data-type=\"exception\" href=\"https://webidl.spec.whatwg.org/#aborterror\"><code>AbortError</code></a>\" <a data-link-type=\"idl\" data-lt=\"DOMException\" data-type=\"interface\" href=\"https://webidl.spec.whatwg.org/#idl-DOMException\"><code>DOMException</code></a> and terminate these\n steps."
},
{
"html": "Let <var>subscription</var> be the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-subscription\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-subscription-50\">push subscription</a> associated with <var>sw</var>."
"html": "Let <var>subscription</var> be the result of obtaining <var data-type=\"ServiceWorkerRegistration\">registration</var>'s <a href=\"https://www.w3.org/TR/push-api/#dfn-push-subscription\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-subscription-50\">push\n subscription</a>. If there is an error, <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://html.spec.whatwg.org/multipage/webappapis.html#queue-a-global-task\">queue a global task</a> on the <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://html.spec.whatwg.org/multipage/webappapis.html#networking-task-source\">networking task source</a> using <var>global</var> to <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://webidl.spec.whatwg.org/#reject\">reject</a> <var>promise</var> with an \"<a data-link-type=\"idl\" data-type=\"exception\" href=\"https://webidl.spec.whatwg.org/#aborterror\"><code>AbortError</code></a>\"\n <a data-link-type=\"idl\" data-lt=\"DOMException\" data-type=\"interface\" href=\"https://webidl.spec.whatwg.org/#idl-DOMException\"><code>DOMException</code></a> and terminate these steps."
},
{
"html": "Compare the <var>options</var> argument with the <code>options</code> attribute of <var>subscription</var>. The\n contents of <a data-link-type=\"idl\" data-lt=\"BufferSource\" data-type=\"typedef\" href=\"https://webidl.spec.whatwg.org/#BufferSource\"><code>BufferSource</code></a> values are compared for equality rather than\n <a data-link-type=\"dfn|abstract-op\" data-lt=\"reference record\" data-type=\"dfn\" href=\"https://tc39.es/ecma262/multipage/ecmascript-data-types-and-values.html#sec-reference-record-specification-type\">reference</a>."
Expand Down Expand Up @@ -321,32 +315,26 @@
"html": "Let <var>subscription</var> be the active <a href=\"https://www.w3.org/TR/push-api/#dfn-push-subscription\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-subscription-69\">push subscription</a> for <var>registration</var>."
},
{
"html": "Initialize <var>data</var> to a value of <code>null</code>."
"html": "Let <var>bytes</var> be null."
},
{
"html": "If the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-41\">push message</a> contains a payload, perform the following steps:",
"html": "If the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-41\">push message</a> contains a payload:",
"rationale": "decrypt",
"steps": [
{
"html": "Decrypt the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-42\">push message</a> using the private key from the key pair\n associated with <var>subscription</var> and the process described in [<cite><a class=\"bibref\" data-link-type=\"biblio\" href=\"https://www.w3.org/TR/push-api/#bib-rfc8291\" title=\"Message Encryption for Web Push\">RFC8291</a></cite>]. This\n produces the plain text of the message."
"html": "Decrypt the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-42\">push message</a> payload using the private key from the key pair\n associated with <var>subscription</var> and the process described in [<cite><a class=\"bibref\" data-link-type=\"biblio\" href=\"https://www.w3.org/TR/push-api/#bib-rfc8291\" title=\"Message Encryption for Web Push\">RFC8291</a></cite>]. Set <var>bytes</var>\n to the resulting <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#byte-sequence\">byte sequence</a>."
},
{
"html": "If the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-43\">push message</a> could not be decrypted for any reason, perform the\n following steps:",
"html": "If the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-43\">push message</a> payload could not be decrypted for any reason:",
"rationale": "acknowledge",
"steps": [
{
"html": "Acknowledge the receipt of the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-44\">push message</a> according to [<cite><a class=\"bibref\" data-link-type=\"biblio\" href=\"https://www.w3.org/TR/push-api/#bib-rfc8030\" title=\"Generic Event Delivery Using HTTP Push\">RFC8030</a></cite>].\n Though the message was not successfully received and processed, this prevents the\n push service from attempting to retransmit the message; a badly encrypted message\n is not recoverable."
},
{
"html": "Discard the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-45\">push message</a>."
},
{
"html": "Terminate this process."
"html": "Abort these steps."
}
]
},
{
"html": "Let <var>data</var> be a new <a href=\"https://www.w3.org/TR/push-api/#dom-pushmessagedata\" class=\"internalDFN\" data-link-type=\"idl\" id=\"ref-for-dom-pushmessagedata-5\"><code>PushMessageData</code></a> instance with the decrypted plain text\n of the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-47\">push message</a>."
}
]
},
Expand All @@ -358,10 +346,10 @@
"html": "Wait for all of the promises in the <a data-link-type=\"dfn|abstract-op\" data-type=\"dfn\" href=\"https://www.w3.org/TR/service-workers/#extendableevent-extend-lifetime-promises\">extend lifetime promises</a>\n of <var>dispatchedEvent</var> to resolve."
},
{
"html": "If all the promises resolve successfully, acknowledge the receipt of the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-48\">push\n message</a> according to [<cite><a class=\"bibref\" data-link-type=\"biblio\" href=\"https://www.w3.org/TR/push-api/#bib-rfc8030\" title=\"Generic Event Delivery Using HTTP Push\">RFC8030</a></cite>] and abort these steps."
"html": "If all the promises resolve successfully, acknowledge the receipt of the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-46\">push\n message</a> according to [<cite><a class=\"bibref\" data-link-type=\"biblio\" href=\"https://www.w3.org/TR/push-api/#bib-rfc8030\" title=\"Generic Event Delivery Using HTTP Push\">RFC8030</a></cite>] and abort these steps."
},
{
"html": "<p>\n If the same <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-49\">push message</a> has been delivered to a <a data-type=\"dfn\" href=\"https://www.w3.org/TR/service-workers/#dfn-service-worker-registration\">service worker\n registration</a> multiple times unsuccessfully, acknowledge the receipt of the\n <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-50\">push message</a> according to [<cite><a class=\"bibref\" data-link-type=\"biblio\" href=\"https://www.w3.org/TR/push-api/#bib-rfc8030\" title=\"Generic Event Delivery Using HTTP Push\">RFC8030</a></cite>].\n </p>\n <p>\n Acknowledging the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-51\">push message</a> causes the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-service\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-service-30\">push service</a> to stop\n delivering the message and to report success to the <a href=\"https://www.w3.org/TR/push-api/#dfn-application-server\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-application-server-25\">application server</a>.\n This prevents the same <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-52\">push message</a> from being retried by the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-service\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-service-31\">push\n service</a> indefinitely.\n </p>\n <p>\n Acknowledging also means that an <a href=\"https://www.w3.org/TR/push-api/#dfn-application-server\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-application-server-26\">application server</a> could incorrectly\n receive a delivery receipt indicating successful delivery of the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-53\">push\n message</a>. Therefore, multiple rejections <em class=\"rfc2119\">SHOULD</em> be permitted before\n acknowledging; allowing at least three attempts is recommended.\n </p>"
"html": "<p>\n If the same <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-47\">push message</a> has been delivered to a <a data-type=\"dfn\" href=\"https://www.w3.org/TR/service-workers/#dfn-service-worker-registration\">service worker\n registration</a> multiple times unsuccessfully, acknowledge the receipt of the\n <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-48\">push message</a> according to [<cite><a class=\"bibref\" data-link-type=\"biblio\" href=\"https://www.w3.org/TR/push-api/#bib-rfc8030\" title=\"Generic Event Delivery Using HTTP Push\">RFC8030</a></cite>].\n </p>\n <p>\n Acknowledging the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-49\">push message</a> causes the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-service\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-service-30\">push service</a> to stop\n delivering the message and to report success to the <a href=\"https://www.w3.org/TR/push-api/#dfn-application-server\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-application-server-25\">application server</a>.\n This prevents the same <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-50\">push message</a> from being retried by the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-service\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-service-31\">push\n service</a> indefinitely.\n </p>\n <p>\n Acknowledging also means that an <a href=\"https://www.w3.org/TR/push-api/#dfn-application-server\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-application-server-26\">application server</a> could incorrectly\n receive a delivery receipt indicating successful delivery of the <a href=\"https://www.w3.org/TR/push-api/#dfn-push-message\" class=\"internalDFN\" data-link-type=\"dfn\" id=\"ref-for-dfn-push-message-51\">push\n message</a>. Therefore, multiple rejections <em class=\"rfc2119\">SHOULD</em> be permitted before\n acknowledging; allowing at least three attempts is recommended.\n </p>"
}
]
}
Expand Down
17 changes: 9 additions & 8 deletions tr/ids/push-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -562,22 +562,23 @@
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-42",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-43",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-44",
"https://www.w3.org/TR/push-api/#issue-container-generatedID-1",
"https://www.w3.org/TR/push-api/#h-note-1",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-45",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-46",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-subscription-70",
"https://www.w3.org/TR/push-api/#ref-for-dom-pushevent-4",
"https://www.w3.org/TR/push-api/#ref-for-dom-pushmessagedata-5",
"https://www.w3.org/TR/push-api/#ref-for-dfn-bytes-6",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-46",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-47",
"https://www.w3.org/TR/push-api/#ref-for-dom-pushevent-4",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-48",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-49",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-50",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-51",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-service-30",
"https://www.w3.org/TR/push-api/#ref-for-dfn-application-server-25",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-52",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-50",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-service-31",
"https://www.w3.org/TR/push-api/#ref-for-dfn-application-server-26",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-53",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-message-51",
"https://www.w3.org/TR/push-api/#the-pushsubscriptionchange-event",
"https://www.w3.org/TR/push-api/#x10-5-the-pushsubscriptionchange-event",
"https://www.w3.org/TR/push-api/#dfn-pushsubscriptionchange",
Expand All @@ -586,8 +587,8 @@
"https://www.w3.org/TR/push-api/#dfn-fire-the-pushsubscriptionchange-event",
"https://www.w3.org/TR/push-api/#ref-for-dfn-user-agent-52",
"https://www.w3.org/TR/push-api/#ref-for-dom-pushsubscriptionchangeevent-1",
"https://www.w3.org/TR/push-api/#issue-container-generatedID-1",
"https://www.w3.org/TR/push-api/#h-note-1",
"https://www.w3.org/TR/push-api/#issue-container-generatedID-2",
"https://www.w3.org/TR/push-api/#h-note-2",
"https://www.w3.org/TR/push-api/#ref-for-dfn-push-subscription-72",
"https://www.w3.org/TR/push-api/#ref-for-dfn-application-server-27",
"https://www.w3.org/TR/push-api/#pushsubscriptionchangeevent-interface",
Expand Down
Loading

0 comments on commit 8c20f99

Please sign in to comment.