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

fix(InteractionOutput): don't require schema.type in value function #534

Merged
merged 7 commits into from
Mar 4, 2024
Merged

fix(InteractionOutput): don't require schema.type in value function #534

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e13cb35
fix(InteractionOutput): don't require schema.type in value function
JKRhb Jan 22, 2024
0f00764
fix: improve check data schema algorithm
JKRhb Feb 12, 2024
e0d5447
fixup! fix: improve check data schema algorithm
JKRhb Feb 26, 2024
7fc27e3
fixup! fix: improve check data schema algorithm
JKRhb Feb 26, 2024
2a3365f
fixup! fix: improve check data schema algorithm
JKRhb Feb 26, 2024
9a8e2e5
fixup! fix: improve check data schema algorithm
JKRhb Feb 27, 2024
b38cf77
fixup! fix: improve check data schema algorithm
JKRhb Feb 27, 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
45 changes: 43 additions & 2 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,8 +976,8 @@ <h2>The <dfn>InteractionOutput</dfn> interface</h2>
</li>
<li>
If |this|.|data| is not a {{ReadableStream}} or if
|dataUsed| is `true`, or if |form| is not an {{object}} or if |schema| or its
|type| are `null` or `undefined`, then
|dataUsed| is `true`, or if |form| is not an {{object}} or if |schema|
is `null` or `undefined`, then
Comment on lines +979 to +980
Copy link
Member Author

Choose a reason for hiding this comment

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

For reference, this is (more or less) the change proposed by @relu91 in #534 (review). The question here, also raised by him, is how we should ensure that the schema is valid – do we need to define a separate algorithm for that?

Suggested change
|dataUsed| is `true`, or if |form| is not an {{object}} or if |schema|
is `null` or `undefined`, then
|dataUsed| is `true`, or if |form| is not an {{object}} or if |schema|
is `null` or `undefined` or not a valid schema, then

Copy link
Contributor

Choose a reason for hiding this comment

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

Note: JSON schema is VERY loose when it comes to what is a valid schema.. almost anything is a valid JSON schema. Hence I am not sure if it makes sense to do anything on top...

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, yeah, I now remember that we also discussed this briefly on Friday during the Thingweb meeting... Then I suppose we should keep this step as is, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

"not a valid schema" needs an algorithm

[=reject=] |promise| with {{NotReadableError}} and stop.
</li>
<li>
Expand Down Expand Up @@ -1057,6 +1057,47 @@ <h2>The <dfn>InteractionOutput</dfn> interface</h2>
<section><h3>The <dfn>check data schema</dfn> algorithm</h3>
To run the <a>check data schema</a> steps on |payload| and |schema:object|,
<ol>
<li>
If |schema| is `null` or `undefined`, return `undefined`.
</li>
<li>
<!--
TODO: Should we just continue with the rest of the algorithm here?
-->
If |schema|.|default| is not |undefined| and |payload| is undefined,
let |payload| be the value of |schema|.|default|.
JKRhb marked this conversation as resolved.
Show resolved Hide resolved
</li>
<li>
Let |const| be |schema|.|const|.
If |const| is not |undefined|,
<ol>
<li>
<!-- TODO: Should we already return here? -->
If |const| equals |payload|, return |payload|.
</li>
<li>
If |const| does not equal |payload|, throw {{TypeError}} and stop.
</li>
JKRhb marked this conversation as resolved.
Show resolved Hide resolved
</ol>
JKRhb marked this conversation as resolved.
Show resolved Hide resolved
</li>
<li>
If |schema|.|enum| is not |undefined| and none of the elements in
|schema|.|enum| equal |payload|, throw {{TypeError}} and stop.
</li>
<li>
Let |oneOf| be |schema|.|oneOf|.
If |oneOf| is not |undefined|,
<ol>
<li>
For each |subSchema| in |oneOf|, run the <a>check data schema</a>
steps on |payload| and |subSchema|.
</li>
<li>
If none or more than two of these runs do not throw, throw
{{TypeError}} and stop.
</li>
JKRhb marked this conversation as resolved.
Show resolved Hide resolved
</ol>
</li>
<li>
Let |type| be |schema|.|type|.
</li>
Expand Down