Exception cleanup #250

tobie · 2016-12-08T14:27:38Z

Don't define simple exception names in WebIDL.
Make Error exclusively for authors.
Fix syntax for throwing and creating DomExceptions.
Fix examples.

Closes #247.

NOTE: This doesn't address the distinction between #throw and #ecmascript-throw, which I think needs fixing before we merge this.

I'd be tempted not to export #ecmascript-throw and make everything use #throw instead. (Currently all simple exceptions in the spec reference #ecmascript-throw, which I don't think is the right thing to do.)
We'd then only use the text around #ecmascript-throw in the bindings to describe the behavior of all exceptions (or just simple ones?) in an ES environment. Thoughts?

NOTE 2: I opted for an "ExceptionName" {{DOMException}} syntax because it reads better, but I'm happy to switch it around if that makes more sense.

Preview | Diff w/ current ED | Diff w/ base

domenic

I'd be tempted not to export #ecmascript-throw and make everything use #throw instead. (Currently all simple exceptions in the spec reference #ecmascript-throw, which I don't think is the right thing to do.)
We'd then only use the text around #ecmascript-throw in the bindings to describe the behavior of all exceptions (or just simple ones?) in an ES environment. Thoughts?

Sounds good to me. I kind of assumed that was how it worked already. I think the bindings only throw simple errors?

domenic · 2016-12-08T19:11:37Z

index.bs

-[=error name=].
+[=Simple exceptions=] can be <dfn id="dfn-create-exception" for="exception" export>created</dfn>
+by providing their [=error name=].
+{{DOMException|DOMExceptions}}, by providing their [=error name=] followed by {{DOMException}}.


Grammar is a bit weird. I'd say "DOMExceptions can be created by providing..."

I remembered having a twitter thread about this grammar construction. Wasn't expecting @domenic to be the first reply, though. :D

I'll fix that.

domenic · 2016-12-08T19:12:42Z

index.bs

-
-        [=Throw=] a TypeError.
-
+        [=Throw=] a <emu-val>TypeError</emu-val>.


So, I think in practice we want specifications to use {{TypeError}}, not <emu-val>TypeError</emu-val>. The emu-val is used for the "bindings" sections of specs like Web IDL and ES. So it's a bit confusing since this is the only place in the document that we'd use {{TypeError}}, but I think it makes sense.

So in that case, we need to define each simple exception somewhere (so back out of the changes right below #dfn-simple-exception).

I think they're already defined in ECMAScript.

Right. But where would we want specs to link to, however?

Oh :(. Not sure what to do then if we want to avoid breaking lots of specs. I guess we could add silly redirect definitions. Or try to get a few choice entries into Shepherd somehow.

So thinking about this a little more, I'm wondering why we'd treat simple exceptions differently than we treat buffer source types. (That is, we have a 1:1 IDL representation of these objects and specs link to the WebIDL one.) To be clear, I'm not objecting to the idea of merging bindings and WebIDL were it make sense, but shouldn't we have a clearer overall picture before we do so?

We should, since Wasm will require their own type I think.

Wasm, like assembly language, doesn't have exceptions at all, so this is pretty orthogonal.

I guess we do need definitions for the Web IDL types that correspond to the JS types.

Wasm, like assembly language, doesn't have exceptions at all, so this is pretty orthogonal.

Hadn't thought of this. Good point.

I guess we do need definitions for the Web IDL types that correspond to the JS types.

OK, so I'll move those back in, then.

* Don't define simple exception names in WebIDL. * Make Error exclusively for authors. * Fix syntax for throwing and creating DomExceptions. * Fix examples. Closes whatwg#247.

domenic · 2016-12-09T18:34:11Z

Latest version LGTM although I guess you still want to straighten out the various kinds of throw.

Cannot rename it to just throw with an added for="ecmascript" attribute, as that would have also modified WebIDL throw for specs that already link to it. Small clean-up that allows using shorthand.

tobie · 2016-12-11T21:54:47Z

Latest version LGTM although I guess you still want to straighten out the various kinds of throw.

So I did some of that. Turns out it's hard to really straighten out, as adding a for attribute to "ecmascript throw" requires adding one to regular (WebIDL) "throw" too. In turn, I think this will break specs who are referencing WebIDL "throw" right now (afaik they would need to use something like [=/throw=] instead).

Alternatively, @tabatkins can prove me wrong and explain what I'd have to do to be able to use [=ecmascript/throw=] locally and export the other, regular (WebIDL) "throw" so folks can just refer to it as [=throw=] elsewhere.

In the meantime, I kept the old name and did some minor cosmetic changes, plus stopped exporting "ecmascript throw"

tabatkins · 2016-12-13T22:05:45Z

If you have both /throw and ecmascript/throw in your document, you'll locally have to use /throw everywhere. However, if you only export the /throw and not the other, then other specs will be able to just use throw. If you want to be extra-safe, you can do <dfn noexport lt="ECMAScript throw" local-lt="throw" for="ECMAScript">, so it won't even clash in the database as an unexported term.

tobie · 2016-12-13T22:09:33Z

Thanks, @tabatkins, this is exactly what I needed.

Amends whatwg#250 and fixes whatwg#247.

Amends #250 and fixes #247.

Meta: fix "throw" dfns (whatwg/webidl#256) whatwg/webidl@7c1eab6 b3c76edd Exception cleanup (whatwg/webidl#250) whatwg/webidl@c2d602f 76b2950c Editorial: clarify typedef aliasing limitations. (whatwg/webidl#253) whatwg/webidl@b4bc602 673c10b2 Disallow nullable Promise types. (whatwg/webidl#248) whatwg/webidl@7366419 cdaa8020 Add missing legacy error names. (whatwg/webidl#251) whatwg/webidl@c50ffc4 101c3b06 その他の編集

tobie requested a review from domenic December 8, 2016 16:38

domenic reviewed Dec 8, 2016

View reviewed changes

tobie added 4 commits December 9, 2016 17:35

Exception cleanup

768039d

* Don't define simple exception names in WebIDL. * Make Error exclusively for authors. * Fix syntax for throwing and creating DomExceptions. * Fix examples. Closes whatwg#247.

Keep defining simple exceptions in WebIDL.

5855832

Fix references to simple exceptions in legacy DOMExceptions.

82255a2

Fix grammar.

da22ef1

tobie force-pushed the fix-247 branch from ab2d126 to da22ef1 Compare December 9, 2016 17:04

Use type instead of name for simple exceptions.

eed6714

Stopped exporting ES throw.

e85e502

Cannot rename it to just throw with an added for="ecmascript" attribute, as that would have also modified WebIDL throw for specs that already link to it. Small clean-up that allows using shorthand.

Editorial: minor edits.

793b67f

tobie merged commit c2d602f into whatwg:gh-pages Dec 13, 2016

tobie deleted the fix-247 branch December 13, 2016 09:46

tobie added a commit to tobie/webidl that referenced this pull request Dec 13, 2016

Meta: fix "throw" dfns

3b60be5

Amends whatwg#250 and fixes whatwg#247.

tobie mentioned this pull request Dec 13, 2016

Meta: fix "throw" dfns #256

Merged

tobie added a commit that referenced this pull request Dec 13, 2016

Meta: fix "throw" dfns (#256)

7c1eab6

Amends #250 and fixes #247.

domenic mentioned this pull request Dec 14, 2016

Editorial: use new language for DOMExceptions w3c/payment-request#375

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exception cleanup #250

Exception cleanup #250

tobie commented Dec 8, 2016 •

edited

Loading

domenic left a comment

domenic Dec 8, 2016

tobie Dec 8, 2016

domenic Dec 8, 2016

tobie Dec 8, 2016

domenic Dec 8, 2016

tobie Dec 8, 2016

domenic Dec 8, 2016

domenic Dec 9, 2016

tobie Dec 9, 2016

annevk Dec 9, 2016

domenic Dec 9, 2016

tobie Dec 9, 2016 •

edited

Loading

domenic commented Dec 9, 2016

tobie commented Dec 11, 2016 •

edited

Loading

tabatkins commented Dec 13, 2016

tobie commented Dec 13, 2016


		[=Throw=] a TypeError.

		[=Throw=] a <emu-val>TypeError</emu-val>.

Exception cleanup #250

Exception cleanup #250

Conversation

tobie commented Dec 8, 2016 • edited Loading

domenic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobie Dec 9, 2016 • edited Loading

Choose a reason for hiding this comment

domenic commented Dec 9, 2016

tobie commented Dec 11, 2016 • edited Loading

tabatkins commented Dec 13, 2016

tobie commented Dec 13, 2016

tobie commented Dec 8, 2016 •

edited

Loading

tobie Dec 9, 2016 •

edited

Loading

tobie commented Dec 11, 2016 •

edited

Loading