Error modules cleanup #7408
Open
Error modules cleanup #7408
+773
−790
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tsnobip
force-pushed
the
clean-error-exn-modules
branch
from
d526cc1 to
f36764d
Compare
tsnobip
force-pushed
the
clean-error-exn-modules
branch
from
f36764d to
1f7f255
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR cleans up error modules by renaming the exception from JsError to JsExn, introducing a dedicated Stdlib.JsExn module, and deprecating the old error-related modules. Key changes include:
- Renaming exception identifiers across multiple files.
- Creating new modules (Stdlib.JsExn and Stdlib.JsError) to provide clearer JavaScript error abstractions.
- Updating documentation and the changelog to reflect these changes.
Reviewed Changes
Copilot reviewed 61 out of 68 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/artifacts.txt | Added new entries for Stdlib_JsError and Stdlib_JsExn. |
| lib/js/Stdlib_JsExn.js | Introduced helper module for handling JsExn conversion. |
| lib/js/Stdlib_JsError.js | Provided utility functions for throwing various errors. |
| lib/js/Stdlib_Exn.js | Updated error literal from "JsError" to "JsExn". |
| lib/js/Stdlib.js | Redirected panic function to Stdlib_JsError and exported JsError/JsExn (but variables remain unassigned). |
| lib/js/Primitive_exceptions.js | Updated error literal from "JsError" to "JsExn". |
| lib/es6/Stdlib_JsExn.js | Added ES6 version of the JsExn module. |
| lib/es6/Stdlib_JsError.js | Added ES6 version of the JsError module. |
| lib/es6/Stdlib_Exn.js | Updated error literal from "JsError" to "JsExn". |
| lib/es6/Stdlib.js | Redirected panic function to Stdlib_JsError and exported JsError/JsExn (but variables remain unassigned). |
| lib/es6/Primitive_exceptions.js | Updated error literal from "JsError" to "JsExn". |
| compiler/core/design.md | Updated terminology in documentation to "JS exception". |
| CHANGELOG.md | Documented the breaking change and module renaming. |
Files not reviewed (7)
- analysis/examples/workspace-project/myplugin/src/Promise.res: Language not supported
- analysis/reanalyze/src/Exn.ml: Language not supported
- analysis/reanalyze/src/Exn.mli: Language not supported
- analysis/reanalyze/src/ExnLib.ml: Language not supported
- compiler/frontend/ast_exp_extension.ml: Language not supported
- compiler/ml/predef.ml: Language not supported
- runtime/Primitive_exceptions.res: Language not supported
Comments suppressed due to low confidence (4)
lib/js/Stdlib.js:50
- The variable 'JsError' is declared but not assigned a value. Consider importing and assigning the appropriate module (e.g., from Stdlib_JsError) to ensure it can be used correctly.
let JsError;
lib/js/Stdlib.js:52
- The variable 'JsExn' is declared but not assigned any value. Assign it from the corresponding module if it is intended for production usage.
let JsExn;
lib/es6/Stdlib.js:50
- In the ES6 Stdlib file, the 'JsError' variable is declared without assignment. Import and assign the module to ensure it is correctly initialized for use.
let JsError;
lib/es6/Stdlib.js:52
- The variable 'JsExn' in the ES6 Stdlib file is declared but never initialized. Consider importing and assigning the proper module to avoid potential runtime issues.
let JsExn;
cknitt
reviewed
Apr 27, 2025
runtime/Stdlib_JsExn.resi
Outdated
| ``` | ||
| */ | ||
| @get | ||
| external name: t => option<string> = "name" |
There was a problem hiding this comment.
This function and the others in this module are unsafe.
t is unknown and so could be anything, including for example an object that has a name property that is of type number or object instead of string.
There was a problem hiding this comment.
It could also be null, just this week I added code like this to a project:
let name: t => option<string> = %raw(`t => typeof t?.name === "string" ? t.name : undefined`)As an aside, it would be awesome if the compiler had support for something like @get(null_coalesce) that worked with @scope.
There was a problem hiding this comment.
@cknitt @CarlOlson I fixed it!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #7377:
JsErrortoJsExnStdlib.JsExnmodule around atype t = unknownand utility functions like@get external name: t => option<string> = "name"returning optionsStdlib.JsErrormodule to limit the confusion withResult.Error. UnlikeStdlib.Error.t, in this module,type tis be abstract.Stdlib.ErrorandStdlib.Exn