rename JsError to JsExn and create JsError and JsExn modules (#7408)

* rename JsError to JsExn and create JsError and JsExn modules

* make JsExn getters type safe

Author: tsnobip

CHANGELOG.md

@@ -12,6 +12,10 @@
 
 # 12.0.0-alpha.13 (Unreleased)
 
+#### :boom: Breaking Change
+
+- Rename `JsError` to `JsExn` and error modules cleanup. https://github.com/rescript-lang/rescript/pull/7408
+
 #### :rocket: New Feature
 
 - Add shift (`<<`, `>>`, `>>>`) operators for `int` and `bigint`. https://github.com/rescript-lang/rescript/pull/7183

analysis/examples/workspace-project/myplugin/src/Promise.res

@@ -1,6 +1,6 @@
 type t<+'a> = Js.Promise.t<'a>
 
-exception JsError(Js.Exn.t)
+exception JsExn(Js.Exn.t)
 external unsafeToJsExn: exn => Js.Exn.t = "%identity"
 
 @new

analysis/reanalyze/src/Exn.ml

@@ -8,7 +8,7 @@ let endOfFile = "End_of_file"
 let exit = "exit"
 let failure = "Failure"
 let invalidArgument = "Invalid_argument"
-let jsExnError = "Exn.Error"
+let jsExn = "JsExn"
 let matchFailure = "Match_failure"
 let notFound = "Not_found"
 let sysError = "Sys_error"

analysis/reanalyze/src/Exn.mli

@@ -10,7 +10,7 @@ val failure : t
 val fromLid : Longident.t -> t
 val fromString : string -> t
 val invalidArgument : t
-val jsExnError : t
+val jsExn : t
 val matchFailure : t
 val notFound : t
 val sysError : t

analysis/reanalyze/src/ExnLib.ml

@@ -38,8 +38,8 @@ let raisesLibTable : (Name.t, Exceptions.t) Hashtbl.t =
   in
   let stdlib =
     [
-      ("panic", [jsExnError]);
-      ("assertEqual", [jsExnError]);
+      ("panic", [jsExn]);
+      ("assertEqual", [jsExn]);
       ("invalid_arg", [invalidArgument]);
       ("failwith", [failure]);
       ("/", [divisionByZero]);
@@ -50,38 +50,38 @@ let raisesLibTable : (Name.t, Exceptions.t) Hashtbl.t =
       ("float_of_string", [failure]);
     ]
   in
-  let stdlibBigInt = [("fromStringExn", [jsExnError])] in
+  let stdlibBigInt = [("fromStringExn", [jsExn])] in
   let stdlibBool = [("fromStringExn", [invalidArgument])] in
-  let stdlibError = [("raise", [jsExnError])] in
+  let stdlibError = [("raise", [jsExn])] in
   let stdlibExn =
     [
-      ("raiseError", [jsExnError]);
-      ("raiseEvalError", [jsExnError]);
-      ("raiseRangeError", [jsExnError]);
-      ("raiseReferenceError", [jsExnError]);
-      ("raiseSyntaxError", [jsExnError]);
-      ("raiseTypeError", [jsExnError]);
-      ("raiseUriError", [jsExnError]);
+      ("raiseError", [jsExn]);
+      ("raiseEvalError", [jsExn]);
+      ("raiseRangeError", [jsExn]);
+      ("raiseReferenceError", [jsExn]);
+      ("raiseSyntaxError", [jsExn]);
+      ("raiseTypeError", [jsExn]);
+      ("raiseUriError", [jsExn]);
     ]
   in
   let stdlibJson =
     [
-      ("parseExn", [jsExnError]);
-      ("parseExnWithReviver", [jsExnError]);
-      ("stringifyAny", [jsExnError]);
-      ("stringifyAnyWithIndent", [jsExnError]);
-      ("stringifyAnyWithReplacer", [jsExnError]);
-      ("stringifyAnyWithReplacerAndIndent", [jsExnError]);
-      ("stringifyAnyWithFilter", [jsExnError]);
-      ("stringifyAnyWithFilterAndIndent", [jsExnError]);
+      ("parseExn", [jsExn]);
+      ("parseExnWithReviver", [jsExn]);
+      ("stringifyAny", [jsExn]);
+      ("stringifyAnyWithIndent", [jsExn]);
+      ("stringifyAnyWithReplacer", [jsExn]);
+      ("stringifyAnyWithReplacerAndIndent", [jsExn]);
+      ("stringifyAnyWithFilter", [jsExn]);
+      ("stringifyAnyWithFilterAndIndent", [jsExn]);
     ]
   in
   let stdlibList =
     [("headExn", [notFound]); ("tailExn", [notFound]); ("getExn", [notFound])]
   in
   let stdlibNull = [("getExn", [invalidArgument])] in
   let stdlibNullable = [("getExn", [invalidArgument])] in
-  let stdlibOption = [("getExn", [jsExnError])] in
+  let stdlibOption = [("getExn", [jsExn])] in
   let stdlibResult = [("getExn", [notFound])] in
   let yojsonBasic = [("from_string", [yojsonJsonError])] in
   let yojsonBasicUtil =
@@ -144,7 +144,7 @@ let raisesLibTable : (Name.t, Exceptions.t) Hashtbl.t =
     ("Bool", stdlibBool);
     ("Error", stdlibError);
     ("Exn", stdlibExn);
-    ("Js.Json", [("parseExn", [jsExnError])]);
+    ("Js.Json", [("parseExn", [jsExn])]);
     ("JSON", stdlibJson);
     ("Json_decode", bsJson);
     ("Json.Decode", bsJson);

compiler/core/design.md

@@ -372,7 +372,7 @@ function packError(exn){
   }
 }
 ```
-So whenever we raise an OCaml exception, we always wrapped it as a JS error.
+So whenever we raise an OCaml exception, we always wrapped it as a JS exception.
 Now we unpack it, it could be OCaml exception or JS exception, so we  did 
 a runtime dispatch.
 
@@ -381,7 +381,7 @@ Some potential optimization
 ```ocaml
 try f x with 
 Not_found -> ..
-JsError e
+JsExn e
 ```
 
 currently it would be transalted as 

compiler/frontend/ast_exp_extension.ml

@@ -43,7 +43,7 @@ let handle_extension e (self : Bs_ast_mapper.mapper)
     in
 
     Exp.apply ~loc
-      (Exp.ident ~loc {txt = Longident.parse "Js.Exn.raiseError"; loc})
+      (Exp.ident ~loc {txt = Longident.parse "JsError.throwWithMessage"; loc})
       [
         ( Nolabel,
           Exp.constant ~loc

compiler/ml/predef.ml

@@ -158,7 +158,7 @@ and ident_error = ident_create_predef_exn "Error"
 and ident_dict_magic_field_name =
   ident_create Dict_type_helpers.dict_magic_field_name
 
-and ident_js_error = ident_create_predef_exn "JsError"
+and ident_js_exn = ident_create_predef_exn "JsExn"
 
 and ident_not_found = ident_create_predef_exn "Not_found"
 
@@ -176,7 +176,7 @@ let all_predef_exns =
     ident_match_failure;
     ident_invalid_argument;
     ident_failure;
-    ident_js_error;
+    ident_js_exn;
     ident_not_found;
     ident_end_of_file;
     ident_division_by_zero;
@@ -412,7 +412,7 @@ let common_initial_env add_type add_extension empty_env =
   |> add_exception ident_end_of_file []
   |> add_exception ident_not_found []
   |> add_exception ident_failure [type_string]
-  |> add_exception ident_js_error [type_unknown]
+  |> add_exception ident_js_exn [type_unknown]
   |> add_exception ident_invalid_argument [type_string]
   |> add_exception ident_match_failure
        [newgenty (Ttuple [type_string; type_int; type_int])]
@@ -433,7 +433,7 @@ let builtin_values =
       ident_match_failure;
       ident_invalid_argument;
       ident_failure;
-      ident_js_error;
+      ident_js_exn;
       ident_not_found;
       ident_end_of_file;
       ident_division_by_zero;

lib/es6/Primitive_exceptions.js

@@ -14,7 +14,7 @@ function internalToException(e) {
     return e;
   } else {
     return {
-      RE_EXN_ID: "JsError",
+      RE_EXN_ID: "JsExn",
       _1: e
     };
   }
@@ -33,7 +33,7 @@ function create(str) {
   return str;
 }
 
-let $$Error = "JsError";
+let $$Error = "JsExn";
 
 export {
   $$Error,

lib/es6/Stdlib.js

@@ -1,7 +1,7 @@
 
 
-import * as Stdlib_Error from "./Stdlib_Error.js";
 import * as Stdlib_Global from "./Stdlib_Global.js";
+import * as Stdlib_JsError from "./Stdlib_JsError.js";
 import * as Primitive_object from "./Primitive_object.js";
 
 function assertEqual(a, b) {
@@ -12,7 +12,7 @@ function assertEqual(a, b) {
     RE_EXN_ID: "Assert_failure",
     _1: [
       "Stdlib.res",
-      120,
+      122,
       4
     ],
     Error: new Error()
@@ -47,6 +47,10 @@ let Int;
 
 let $$Intl;
 
+let JsError;
+
+let JsExn;
+
 let $$JSON;
 
 let Lazy;
@@ -117,7 +121,7 @@ let $$BigInt64Array;
 
 let $$BigUint64Array;
 
-let panic = Stdlib_Error.panic;
+let panic = Stdlib_JsError.panic;
 
 export {
   TimeoutId,
@@ -134,6 +138,8 @@ export {
   Float,
   Int,
   $$Intl,
+  JsError,
+  JsExn,
   $$JSON,
   Lazy,
   List,

lib/es6/Stdlib_Exn.js

@@ -2,7 +2,7 @@
 
 import * as Primitive_option from "./Primitive_option.js";
 
-let $$Error = "JsError";
+let $$Error = "JsExn";
 
 function asJsExn(exn) {
   if (exn.RE_EXN_ID === $$Error) {

lib/es6/Stdlib_JsError.js

@@ -0,0 +1,70 @@
+
+
+
+function throwWithMessage(str) {
+  throw new Error(str);
+}
+
+function throwWithMessage$1(s) {
+  throw new EvalError(s);
+}
+
+let $$EvalError$1 = {
+  throwWithMessage: throwWithMessage$1
+};
+
+function throwWithMessage$2(s) {
+  throw new RangeError(s);
+}
+
+let $$RangeError$1 = {
+  throwWithMessage: throwWithMessage$2
+};
+
+function throwWithMessage$3(s) {
+  throw new ReferenceError(s);
+}
+
+let $$ReferenceError$1 = {
+  throwWithMessage: throwWithMessage$3
+};
+
+function throwWithMessage$4(s) {
+  throw new SyntaxError(s);
+}
+
+let $$SyntaxError$1 = {
+  throwWithMessage: throwWithMessage$4
+};
+
+function throwWithMessage$5(s) {
+  throw new TypeError(s);
+}
+
+let $$TypeError$1 = {
+  throwWithMessage: throwWithMessage$5
+};
+
+function throwWithMessage$6(s) {
+  throw new URIError(s);
+}
+
+let $$URIError$1 = {
+  throwWithMessage: throwWithMessage$6
+};
+
+function panic(msg) {
+  throw new Error("Panic! " + msg);
+}
+
+export {
+  $$EvalError$1 as $$EvalError,
+  $$RangeError$1 as $$RangeError,
+  $$ReferenceError$1 as $$ReferenceError,
+  $$SyntaxError$1 as $$SyntaxError,
+  $$TypeError$1 as $$TypeError,
+  $$URIError$1 as $$URIError,
+  throwWithMessage,
+  panic,
+}
+/* No side effect */

lib/es6/Stdlib_JsExn.js

@@ -0,0 +1,29 @@
+
+
+import * as Primitive_option from "./Primitive_option.js";
+
+function fromException(exn) {
+  if (exn.RE_EXN_ID === "JsExn") {
+    return Primitive_option.some(exn._1);
+  }
+  
+}
+
+let getOrUndefined = (fieldName => t => (t && typeof t[fieldName] === "string" ? t[fieldName] : undefined));
+
+let stack = getOrUndefined("stack");
+
+let message = getOrUndefined("message");
+
+let name = getOrUndefined("name");
+
+let fileName = getOrUndefined("fileName");
+
+export {
+  fromException,
+  stack,
+  message,
+  name,
+  fileName,
+}
+/* stack Not a pure module */

lib/js/Primitive_exceptions.js

@@ -14,7 +14,7 @@ function internalToException(e) {
     return e;
   } else {
     return {
-      RE_EXN_ID: "JsError",
+      RE_EXN_ID: "JsExn",
       _1: e
     };
   }
@@ -33,7 +33,7 @@ function create(str) {
   return str;
 }
 
-let $$Error = "JsError";
+let $$Error = "JsExn";
 
 exports.$$Error = $$Error;
 exports.create = create;