Skip to content

Scope ModelContext to Document, and handle detached documents #177

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

Open
domfarolino wants to merge 1 commit into
base: main
Choose a base branch
from
+38 −8
Open

Scope ModelContext to Document, and handle detached documents #177

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 38 additions & 8 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,14 @@ spec:html; type:dfn;
text:browsing context group set
text:unique internal value
</pre>
<pre class="anchors">
spec: html; type: dfn; urlPrefix: https://html.spec.whatwg.org/C
text: create and initialize a Document object; url: initialise-the-document-object
# Because `text` and `url` are the same (modulo slashes), we should be able to
# exclude `url`. But the colon breaks the URL in `text`, forcing us to include
# `url`.
text:is initial about:blank; url: is-initial-about:blank
</pre>

<h2 id="intro">Introduction</h2>

Expand Down Expand Up @@ -113,6 +121,7 @@ A <dfn>model context</dfn> is a [=struct=] with the following [=struct/items=]:
[=structs=].
</dl>


A <dfn>tool definition</dfn> is a [=struct=] with the following [=struct/items=]:

<dl dfn-for="tool definition">
Expand Down Expand Up @@ -183,19 +192,40 @@ https://dlaliberte.github.io/bikeshed-intro/#a-strategy-for-incremental-developm

<h3 id="navigator-extension">Extensions to the {{Navigator}} Interface</h3>

The {{Navigator}} interface is extended to provide access to the {{ModelContext}}.
Each {{Document}} object has an <dfn for=Document>associated {{ModelContext}}</dfn>, which is a
{{ModelContext}} object.

Upon creation of the {{Document}} object, its [=Document/associated ModelContext|associated
<code>ModelContext</code>=] must be set to a [=new=] {{ModelContext}} object created in the
Copy link
Copy Markdown
Collaborator Author

@domfarolino domfarolino May 15, 2026

Choose a reason for hiding this comment

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

Hey @tabatkins, I could not for the life of me figure out how to add {{ModelContext}} or <code>ModelContext</code> to the actual linking text, so I had to settle on this super verbose [=foo|<code>foo</code>=] which is really redundant and I can't figure out if there's a way around it, so I can tighten these up. It's not blocking, so if there's no solution, that's fine.

Copy link
Copy Markdown

@tabatkins tabatkins May 16, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

There's no "proper" way around it - linking text is text, not markup.

There is a workaround, tho - use an internal macro:

<pre class=metadata>
...
Text Macro: ASSOCIATEDMODELCONTENT [=Document/associated ModelContext|associated <code>ModelContext</code>=]
</pre>

...
Upon creation of the {{Document}} object, its [ASSOCIATEDMODELCONTENT] must be set to a [=new=] {{ModelContext}} object

(You could also scope it to just use the macro for the visible text part, but if you're doing this link a lot you might as well macro the whole thing.)

{{Document}}'s [=relevant realm=].

The {{Navigator}} interface provides access to a {{Document}}'s [=Document/associated
ModelContext|associated <code>ModelContext</code>=] through its {{Navigator/modelContext}}
attribute.

Note: The reason {{ModelContext}} is owned by {{Document}} instead of {{Navigator}} is to ensure
that tools registered within an [=is initial about:blank|initial <code>about:blank</code>=]
{{Document}} are not available to the subsequent [=same origin=] {{Document}} that results from
navigating away from the initial {{Document}}. This is crucial, since these two {{Document}}s share
the same {{Window}} and {{Navigator}} objects. See step 6.1 in [=create and initialize a Document
object|create and initialize a <code>Document</code> object=].

<hr>

<xmp class="idl">
partial interface Navigator {
[SecureContext, SameObject] readonly attribute ModelContext modelContext;
[SecureContext] readonly attribute ModelContext? modelContext;
};
</xmp>

Each {{Navigator}} object has an associated <dfn for=Navigator>modelContext</dfn>, which is a
{{ModelContext}} instance created alongside the {{Navigator}}.

<div algorithm>
The <dfn attribute for=Navigator>modelContext</dfn> getter steps are to return [=this=]'s [=Navigator/modelContext=].
The <dfn attribute for=Navigator>modelContext</dfn> getter steps are:

1. If [=this=]'s [=relevant global object=]'s [=Window/browsing context=] is null, then return null.
Copy link
Copy Markdown
Contributor

@beaufortfrancois beaufortfrancois May 18, 2026

Choose a reason for hiding this comment

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

From a developer perspective, I'd love if this wouldn't become null in special cases. Could we keep it not null and simply return empty when calling modelContext.getTools() instead for instance?


1. Return [=this=]'s [=relevant global object=]'s [=associated Document=]'s [=Document/associated
ModelContext|associated <code>ModelContext</code>=] object.

</div>

<h3 id="model-context-container">ModelContext Interface</h3>
Expand Down Expand Up @@ -515,8 +545,8 @@ steps:

1. Let |id| be |document|'s [=Document/unique ID=].

1. Set |observation|'s [=observation/tool map=][|id|] = |document|'s [=relevant global
object=]'s {{Navigator}}'s [=Navigator/modelContext=]'s [=ModelContext/internal context=]'s
1. Set |observation|'s [=observation/tool map=][|id|] = |document|'s [=Document/associated
ModelContext|associated <code>ModelContext</code>=]'s [=ModelContext/internal context=]'s
[=model context/tool map=]'s [=map/values=], which are [=tool definitions=].

1. Perform any [=implementation-defined=] steps to add anything to |observation| that the [=user
Expand Down
Loading