Merge pull request #4104 from BuckleScript/websocket_fix

bobzhang · web-flow · commit 15cf202c1855 · 2020-01-18T15:26:05.000+08:00
fix #4067, #4101: websocket error better error message and docs
diff --git a/jscomp/bsb/bsb_real_path.mli b/jscomp/bsb/bsb_real_path.mli
@@ -1,3 +1,27 @@
-val real_path : string -> string 
+
+(* Copyright (C) 2020- Authors of BuckleScript
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
 
 val is_same_paths_via_io : string -> string -> bool 
diff --git a/jscomp/main/bsb_main.ml b/jscomp/main/bsb_main.ml
@@ -77,7 +77,12 @@ let bsb_main_flags : (string * Arg.spec * string) list=
     "-where",
     Arg.Unit (fun _ -> 
         print_endline (Filename.dirname Sys.executable_name)),
-    " Show where bsb.exe is located"
+    " Show where bsb.exe is located";
+(** Below flags are only for bsb script, it is not available for bsb.exe 
+  we make it at this time to make `bsb -help` easier
+*)
+    "-ws", Arg.Bool ignore, 
+    " [host:]port specify the websocket number so that when a build is finished, we send such websocket port number a signal" 
   ]
 
 
diff --git a/lib/4.06.1/bsb.ml b/lib/4.06.1/bsb.ml
@@ -7887,7 +7887,31 @@ let info_args (args : string array) =
 end
 module Bsb_real_path : sig 
 #1 "bsb_real_path.mli"
-val real_path : string -> string 
+
+(* Copyright (C) 2020- Authors of BuckleScript
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
 
 val is_same_paths_via_io : string -> string -> bool 
 
@@ -16534,7 +16558,12 @@ let bsb_main_flags : (string * Arg.spec * string) list=
     "-where",
     Arg.Unit (fun _ -> 
         print_endline (Filename.dirname Sys.executable_name)),
-    " Show where bsb.exe is located"
+    " Show where bsb.exe is located";
+(** Below flags are only for bsb script, it is not available for bsb.exe 
+  we make it at this time to make `bsb -help` easier
+*)
+    "-ws", Arg.Bool ignore, 
+    " [host:]port specify the websocket number so that when a build is finished, we send such websocket port number a signal" 
   ]
 
 
diff --git a/lib/4.06.1/unstable/bsb_native.ml b/lib/4.06.1/unstable/bsb_native.ml
@@ -7887,7 +7887,31 @@ let info_args (args : string array) =
 end
 module Bsb_real_path : sig 
 #1 "bsb_real_path.mli"
-val real_path : string -> string 
+
+(* Copyright (C) 2020- Authors of BuckleScript
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
 
 val is_same_paths_via_io : string -> string -> bool 
 
@@ -16641,7 +16665,12 @@ let bsb_main_flags : (string * Arg.spec * string) list=
     "-where",
     Arg.Unit (fun _ -> 
         print_endline (Filename.dirname Sys.executable_name)),
-    " Show where bsb.exe is located"
+    " Show where bsb.exe is located";
+(** Below flags are only for bsb script, it is not available for bsb.exe 
+  we make it at this time to make `bsb -help` easier
+*)
+    "-ws", Arg.Bool ignore, 
+    " [host:]port specify the websocket number so that when a build is finished, we send such websocket port number a signal" 
   ]
 
 
diff --git a/lib/bsb b/lib/bsb
@@ -91,7 +91,13 @@ function setUpWebSocket() {
             wsClients.push(ws)
         })
         .on('error', function (err) {
-            console.error(err)
+            if(err !== undefined && err.code === "EADDRINUSE" ){
+                var error = std_is_tty?`\x1b[1;31mERROR:\x1b[0m` : `ERROR:`
+                console.error(`${error} The websocket port number ${webSocketPort} is already used, 
+please pick a different one using "-ws [host:]port" syntax`)
+            } else {            
+                console.error(err)            
+            }            
             process.exit(2)
         })
         .listen(webSocketPort, webSocketHost);
@@ -112,6 +118,9 @@ for (var i = 2; i < process_argv.length; ++i) {
         postBuild = process_argv[++i]
     } else if (current === "-ws") {
         var hostAndPortNumber = (process_argv[++i] || '').split(':');
+        /**
+         * @type {number}
+         */
         var portNumber;
         if (hostAndPortNumber.length === 1) {
             portNumber = parseInt(hostAndPortNumber[0])
