-
-
Notifications
You must be signed in to change notification settings - Fork 35
Add design doc for error handling #804
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.
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
Changes from 4 commits
1c5d62e
d212fb7
2fd70e4
0b0e90c
d55e194
25f9fcd
ade8735
be5f9a0
6c9fff0
5f7c317
dd20f33
aee2fb6
1051cee
084a1de
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
| @@ -0,0 +1,106 @@ | ||||
| # Error Handling | ||||
|
|
||||
| Status: **Proposed** | ||||
|
|
||||
| <details> | ||||
| <summary>Metadata</summary> | ||||
| <dl> | ||||
| <dt>Contributors</dt> | ||||
| <dd>@echeran</dd> | ||||
| <dt>First proposed</dt> | ||||
| <dd>2024-06-02</dd> | ||||
| <dt>Issues</dt> | ||||
| <dd><a href="https://github.com/unicode-org/message-format-wg/issues/782">#782</a></dd> | ||||
| <dt>Pull Requests</dt> | ||||
| <dd><a href="https://github.com/unicode-org/message-format-wg/pull/795">#795</a></dd> | ||||
echeran marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
| </dl> | ||||
| </details> | ||||
|
|
||||
| ## Objective | ||||
|
|
||||
| Decide whether and what implementations "MUST" / "SHOULD" / "MAY" perform after a runtime error, regarding: | ||||
|
|
||||
| 1. information about error(s) | ||||
| - including, if relevant, the minimum number of errors for which such information is expected | ||||
| 1. a fallback representation of the message | ||||
|
|
||||
| ## Background | ||||
|
|
||||
| In practice, | ||||
| runtime errors happen when formatting messages. | ||||
| It is useful to provide information about any errors back to the callsite. | ||||
| It is useful to the end user to provide a best effort fallback representation of the message. | ||||
|
Comment on lines
+38
to
+41
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We've had some good discussions in telecon about these cases. We should use the design doc to capture some of this for posterity. I'm going to suggest a use case section below. |
||||
| Specifying the behavior in such cases promotes consistent results across conformant implementations. | ||||
|
|
||||
| However, implementations of MessageFormat 2.0 will be faced with different constraints due to various reasons: | ||||
|
|
||||
| * Programming language: the language of the implementation informs idiomatic patterns of error handling. | ||||
| In Java, errors are thrown and subsequently caught in `try...catch` block. | ||||
| In Rust, fallible callsites (those which can return errors) should return a `Result<T, Err>` monad. | ||||
| In both languages, built-in error handling assumes a singular error. | ||||
| * Environment constriants: as mentioned in [feedback from ICU4X](https://github.com/unicode-org/message-format-wg/issues/782#issuecomment-2103177417), | ||||
| ICU4X operates in low resource environments for which returning at most 1 error is desirable | ||||
| because returning more than 1 error would require heap allocation. | ||||
| * Programming conventions and idioms: in [feedback from ICU-TC](https://docs.google.com/document/d/11yJUWedBIpmq-YNSqqDfgUxcREmlvV0NskYganXkQHA/edit#bookmark=id.lx4ls9eelh99), | ||||
| they found over the 25 years of maintaining the library that there was more cost than benefit in providing a default best effort return value at the same time as providing error information. | ||||
eemeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
| The additional constraint in ICU4C's C++ style to return an error code rather than throwing errors using the STL further complicates the usefulness and likelihood to be used correctly during nested calls. | ||||
|
|
||||
echeran marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
| ## Proposed Design | ||||
|
|
||||
| The following spec text is proposed: | ||||
|
|
||||
| > In all cases, when encountering an error, | ||||
| > a message formatter MUST be able to signal an error or errors. | ||||
| > It MAY also provide the appropriate fallback representation of the _message_ defined | ||||
| > in this specification. | ||||
echeran marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
| This solution requires implementations to be able to signal an error occurred, | ||||
| which can be accomplished in different ways. Ex: | ||||
|
|
||||
| * an API that throws or returns an Error object when encountering an error | ||||
| * an API that includes a read/write `ErrorCode` argument | ||||
| * two APIs, a permissive one that always returns a best-effort formatted result | ||||
| and a stricter one that throws or returns an Error object when encountering an error | ||||
| * an API that always returns a best-effort formatted result | ||||
| and a global `boolean` values | ||||
echeran marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| This does not give implementations full freedom to return _nothing_ or some other behavior. | ||||
|
|
||||
| ## Alternatives Considered | ||||
echeran marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
|
|
||||
| ### Current spec: require information from error(s) and a representative best effort message | ||||
|
|
||||
| The current spec text says: | ||||
|
|
||||
| > In all cases, when encountering a runtime error, | ||||
| > a message formatter MUST provide some representation of the message. | ||||
| > An informative error or errors MUST also be separately provided. | ||||
| This alternative places constraints on implementations to provide multiple avenues of useful information (to the callsite and user). | ||||
|
|
||||
| This alternative establishes constraints that would contravene the constraints that exist in projects that have implemented MF 2.0 (or likely will soon), based on: | ||||
| * programming language idioms/constraints | ||||
| * execution environment constraints | ||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What execution environment constraints does this alternative contravene? The only such mentioned in this document is that the cost of returning more than one error may be prohibitive in some cases, and the current text explicitly says "error or errors" to allow for an implementation signaling a single error to be valid.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The text says "an informative error". As written, that implies to me an error object, like a As I mentioned in the 2024-04-09 meeting, another paradigm from which to look at this, besides "whether is returning an error possible", is "how actionable is returning the error object". ICU & browsers need to be performant and might not want to pay the cost of the creating a full error object. |
||||
| * experience-based programming guidelines | ||||
eemeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
|
|
||||
| ### Allow implementations to determine all details | ||||
|
|
||||
| > When encountering an error during formatting, | ||||
| > a message formatter MAY provide some representation of the message, | ||||
| > or it MAY provide an informative error or errors. | ||||
| > An implementation MAY provide both. | ||||
| This alternative places no expectations on implementations, | ||||
| which supports the constraints we know now, | ||||
| as well as any possible constraints in the future | ||||
| (ex: new programming languages, new execution environments). | ||||
|
|
||||
| This alternative does not assume or assert that some type of useful information | ||||
| (error info, representative message) | ||||
| will be possible and should be returned. | ||||
|
|
||||
| ### Alternate wording | ||||
|
|
||||
| > When an error is encountered during formatting, | ||||
| > a message formatter can provide an informative error (or errors) | ||||
| > or some representation of the message or both. | ||||
Uh oh!
There was an error while loading. Please reload this page.