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

spec: update remaining "in parallel" steps to use tasks #37

Merged
merged 3 commits into from
Nov 21, 2024
Merged

spec: update remaining "in parallel" steps to use tasks #37

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7f6c00
spec: update remaining "in parallel" steps to use tasks
wacky6 Nov 8, 2024
fba14dc
Apply suggestions from code review
wacky6 Nov 11, 2024
3a94a9e
queue if-otherwise
wacky6 Nov 18, 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
46 changes: 28 additions & 18 deletions spec.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,15 +191,21 @@ The same {{HandwritingModelConstraint}} can be used to invoke {{Navigator/create
<div algorithm="navigator-query-handwriting-recognizer">
When {{Navigator/queryHandwritingRecognizer(constraint)}} method is invoked, do the following:

1. If |constraint| doesn't have a {{HandwritingModelConstraint/languages}} member, [=exception/throw=] a new {{TypeError}}
1. If |constraint| doesn't have a {{HandwritingModelConstraint/languages}} member, return [=a promise rejected with=] a new {{TypeError}}.
1. Let |p| be [=a new promise=].
1. Run the following step [=in parallel=]
1. If |constraint|'s {{HandwritingModelConstraint/languages}} member is an empty array, [=/resolve=] |p| with `null` and abort.
1. Run the following step [=in parallel=]:
wacky6 marked this conversation as resolved.
Show resolved Hide resolved
1. <a lt="convert">Convert |constraint| into a suitable form for handwriting recognizer</a>.
1. If the user agent can't find or create a [=handwriting recognizer=] that satisfies the converted |constraint|, [=/resolve=] |p| with `null` and abort.
1. Let |result| be a new {{HandwritingRecognizerQueryResult}}
1. <a lt="convert">Convert the handwriting recognizer's feature description</a>, and fills in all members of |result|,.
1. [=/Resolve=] |p| with |result|.
1. If any of the following is true:
* |constraint|'s {{HandwritingModelConstraint/languages}} member is an empty [=list=].
* The user agent can't find or create a platform-dependent [=handwriting recognizer=] that satisfies the converted |constraint|.

[=Queue a handwriting recognition API task=] to resolve |p| with with `null` and abort the remaining steps.
wacky6 marked this conversation as resolved.
Show resolved Hide resolved

1. Otherwise, [=queue a handwriting recognition API task=] to:
1. Let |result| be a new {{HandwritingRecognizerQueryResult}}
1. <a lt="convert">Convert the handwriting recognizer's feature description</a>, and populate all members of |result|.
1. [=/Resolve=] |p| with |result|.
1. Return |p|.

The implementation should follow these rules when converting to {{HandwritingRecognizerQueryResult}} and {{HandwritingHintsQueryResult}}:
* If the recognizer doesn't accept any hint, set {{HandwritingRecognizerQueryResult/hints}} to `null`.
Expand Down Expand Up @@ -317,18 +323,22 @@ This method creates a {{HandwritingRecognizer}} object that satisfies the provid
<div algorithm="navigator-create-handwriting-recognizer">
When {{Navigator/createHandwritingRecognizer(constraint)}} method is invoked, do the following:

1. If |constraint| doesn't have a {{HandwritingModelConstraint/languages}} member, [=exception/throw=] a new {{TypeError}}
1. If |constraint| doesn't have a {{HandwritingModelConstraint/languages}} member, return [=a promise rejected with=] {{TypeError}}.
1. Let |p| be [=a new promise=].
1. Run the following step [=in parallel=]
1. If |constraint|'s {{HandwritingModelConstraint/languages}} is an empty array, [=/reject=] |p| with a new {{DOMException}} whose {{DOMException/name}} attribute is {{"NotSupportedError"}} and abort.
1. <a lt="convert">Convert |constraint| into a suitable form</a> for [=handwriting recognizer=].
1. If the user agent can't find a [=handwriting recognizer=] that satisfies the converted |constraint|, [=/reject=] |p| with a new {{DOMException}} whose {{DOMException/name}} attribute is {{"NotSupportedError"}} and abort.
1. If creating a [=handwriting recognizer=] would cause the user agent to exceed its limit for total number of active recognizer, [=/reject=] |p| with a new {{DOMException}} whose {{DOMException/name}} attribute is {{"QuotaExceededError"}}.
1. If the user agent can't prepare [=handwriting recognizer=] to perform recognitions, [=/reject=] |p| with a new {{DOMException}} object whose name depending on the failure cause and abort:
* If the web application shouldn't retry, {{"OperationError"}}.
* Otherwise {{"UnknownError"}}.
1. Let |result| be a new {{HandwritingRecognizer}} object, whose [=HandwritingRecognizer/active=] flag is `true`
1. [=/Resolve=] |p| with |result|.
1. Run the following step [=in parallel=]:
wacky6 marked this conversation as resolved.
Show resolved Hide resolved
1. <a lt="convert">Convert |constraint| into a suitable form</a> for creating a platform-dependent [=handwriting recognizer=].
1. If the user agent can't create or prepare a [=handwriting recognizer=] to perform recognitions, [=queue a Handwriting Recognition API task=] to [=/reject=] |p| with a new {{DOMException}} according to the failure cause, then abort the remaining steps:
Copy link
Contributor

Choose a reason for hiding this comment

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

Both steps "queue a Handwriting Recognition API task". Maybe worth re-writing as:

  1. [=Queue a Handwriting Recognition API task=] to:
    1. If the user agent can't create or prepare a [=handwriting recognizer=] to perform recognitions, [=/reject=] |p| with a new {{DOMException}} according to the failure cause:
      • If |constraint|'s ...
    2. Otherwise:
      1. Let |result| be...

Copy link
Member Author

Choose a reason for hiding this comment

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

Would this cause the sequence of event to be interpreted differently?

I think the "if checks" (e.g. check if user agent can instantiate a suitable recognizer) should happen outside of the enqueued tasks, because those checks has nothing to do with JavaScript / DOM.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think the change introduces any substantive difference, but I may have missed something ;)

The Infra Standard explains that "Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. (In particular, the algorithms are intended to be easy to follow, and not intended to be performant.)"

Where and how the user agent checks the if condition is not observable by the application as far as I can tell. In particular, it does not trigger any event that the application could see. Regardless of how the algorithm is written, it seems totally fine for an implementation to check that condition within the enqueued task or outside of the enqueued task.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah. Thanks for the explanation. I've updated to use

Queue a task to:
- If, ...
- Otherwise, ...

* If |constraint|'s {{HandwritingModelConstraint/languages}} is an empty [=list=], {{"NotSupportedError"}}.
* If the user agent can't find a platform-dependent [=handwriting recognizer=] that satisfies the converted |constraint|, {{"NotSupportedError"}}.
* If creating a [=handwriting recognizer=] would cause the user agent to exceed its limit for total number of active recognizer, {{"QuotaExceededError"}}.
* If the web application can retry calling this method, {{OperationError}}.
* For all other failure causes, {{"UnknownError"}}
1. [=Queue a Handwriting Recognition API task=] to:
1. Let |result| be a new {{HandwritingRecognizer}} object.
1. Associate |result| with the platform-dependent [=handwriting recognizer=] created in the previous step.
1. Set |result|.[=HandwritingRecognizer/active=] flag to `true`.
1. [=/Resolve=] |p| with |result|.
1. Return |p|
</div>

<h2 id="using-a-recognizer">Use a recognizer</h2>
Expand Down
Loading