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

Clarify session.subscribe and session.unsubscribe #628

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Clarify session.subscribe and session.unsubscribe #628

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a94c9d5
clarify `session.subscribe` and `session.unsubscribe`
Lightning00Blade Dec 19, 2023
025cc47
chore: address comments
Lightning00Blade Jan 30, 2024
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
56 changes: 36 additions & 20 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1643,8 +1643,8 @@ session.SystemProxyConfiguration = (

<pre class="cddl remote-cddl">
session.SubscriptionRequest = {
events: [*text],
? contexts: [*browsingContext.BrowsingContext],
events: [+text],
? contexts: [+browsingContext.BrowsingContext],
Copy link
Contributor Author

@Lightning00Blade Lightning00Blade Dec 19, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

If we encounter events: [] or contexts: [] we should throw errors. Will add WPT tests for these cases.

}
</pre>

Expand Down Expand Up @@ -1832,8 +1832,8 @@ Issue: This needs to be generalized to work with realms too
<dd>
<pre class="cddl remote-cddl">
session.Subscribe = (
method: "session.subscribe",
params: session.SubscriptionRequest
method: "session.subscribe",
params: session.SubscriptionRequest
)
</pre>
</dd>
Expand All @@ -1848,14 +1848,22 @@ Issue: This needs to be generalized to work with realms too
<div algorithm="remote end steps for session.subscribe">
The [=remote end steps=] with |session| and |command parameters| are:

1. Let the |list of event names| be the value of the <code>events</code> field of
|command parameters|
1. Let the |set of event names| be empty [=set=].

1. Let the |list of contexts| be the value of the <code>contexts</code>
field of |command parameters| if it is present or null if it isn't.
1. For each |event| of <code>command parameters</code>["events"]:

1. Append |event| to |set of event names|.

1. Let |set of contexts| be null.

1. If the value of the <code>contexts</code> field of |command parameters| is not null:

1. Set |set of contexts| to empty [=set=].

1. For each |event| of <code>command parameters</code>["contexts"], append |event| to |set of contexts|.

1. Let |enabled events| be the result of [=trying=] to [=update the event map=]
with |session|, |list of event names| , |list of contexts| and
with |session|, |set of event names| , |set of contexts| and
enabled true.

1. Let |subscribe step events| be a new [=/map=].
Expand Down Expand Up @@ -1898,12 +1906,12 @@ Issue: This needs to be generalised to work with realms too
<dl>
<dt>Command Type</dt>
<dd>
<pre class="cddl remote-cddl">
session.Unsubscribe = (
method: "session.unsubscribe",
params: session.SubscriptionRequest
)
</pre>
<pre class="cddl remote-cddl">
session.Unsubscribe = (
method: "session.unsubscribe",
params: session.SubscriptionRequest
)
</pre>
</dd>
<dt>Result Type</dt>
<dd>
Expand All @@ -1916,14 +1924,22 @@ Issue: This needs to be generalised to work with realms too
<div algorithm="remote end steps for session.unsubscribe">
The [=remote end steps=] with |session| and |command parameters| are:

1. Let the |list of event names| be the value of the <code>events</code> field of
|command parameters|.
1. Let the |set of event names| be empty [=set=].

1. For each |event| of <code>command parameters</code>["events"], append |event| to |set of event names|.

1. Let |set of contexts| be null.

1. If the value of the <code>contexts</code> field of |command parameters| is not null:

1. Set |set of contexts| to empty [=set=].

1. For each |event| of <code>command parameters</code>["contexts"]:

1. Let the |list of contexts| be the value of the <code>contexts</code>
field of |command parameters| if it is present or null if it isn't.
1. Append |event| to |set of contexts|.

1. [=Try=] to [=update the event map=] with |session|,
|list of event names|, |list of contexts| and enabled false.
|set of event names|, |set of contexts| and enabled false.

1. Return [=success=] with data null.

Expand Down
Loading