chore(nodejs): improved error handling

Author: glasstiger

docs/Sender.html

@@ -322,7 +322,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line323">line 323</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line328">line 328</a>
     </li></ul></dd>
 
 
@@ -411,7 +411,7 @@ <h4 class="name" id="atNow"><span class="type-signature"></span>atNow<span class
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line343">line 343</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line348">line 348</a>
     </li></ul></dd>
 
 
@@ -571,7 +571,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line254">line 254</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line259">line 259</a>
     </li></ul></dd>
 
 
@@ -682,7 +682,7 @@ <h4 class="name" id="close"><span class="type-signature">(async) </span>close<sp
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line146">line 146</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line147">line 147</a>
     </li></ul></dd>
 
 
@@ -1037,7 +1037,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line269">line 269</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line274">line 274</a>
     </li></ul></dd>
 
 
@@ -1148,7 +1148,7 @@ <h4 class="name" id="flush"><span class="type-signature">(async) </span>flush<sp
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line162">line 162</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line163">line 163</a>
     </li></ul></dd>
 
 
@@ -1330,7 +1330,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line285">line 285</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line290">line 290</a>
     </li></ul></dd>
 
 
@@ -1762,7 +1762,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line237">line 237</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line242">line 242</a>
     </li></ul></dd>
 
 
@@ -1944,7 +1944,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line212">line 212</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line217">line 217</a>
     </li></ul></dd>
 
 
@@ -2103,7 +2103,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line191">line 191</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line196">line 196</a>
     </li></ul></dd>
 
 
@@ -2285,7 +2285,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line305">line 305</a>
+        <a href="src_sender.js.html">src/sender.js</a>, <a href="src_sender.js.html#line310">line 310</a>
     </li></ul></dd>
 
 
@@ -2359,7 +2359,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Aug 16 2022 13:51:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/index.html

@@ -176,7 +176,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Aug 16 2022 13:51:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/index.js.html

@@ -53,7 +53,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Aug 16 2022 13:51:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/module-@questdb_nodejs-client.html

@@ -156,7 +156,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Aug 16 2022 13:51:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/src_sender.js.html

@@ -75,7 +75,7 @@ <h1 class="page-title">Source: src/sender.js</h1>
      * &lt;/ul>
      * &lt;/p>
      */
-    constructor(options) {
+    constructor(options = undefined) {
         if (options) {
             this.jwk = options.jwk;
         }
@@ -163,6 +163,7 @@ <h1 class="page-title">Source: src/sender.js</h1>
             })
             .on("error", err => {
                 console.error(err);
+                reject(err);
             });
         });
     }
@@ -194,8 +195,12 @@ <h1 class="page-title">Source: src/sender.js</h1>
         }
         return new Promise((resolve, reject) => {
             this.socket.write(data, err => {
-                compact(this);
-                err ? reject(err) : resolve(true);
+                if (err) {
+                    reject(err);
+                } else {
+                    compact(this);
+                    resolve(true);
+                }
             });
         });
     }
@@ -508,7 +513,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Aug 16 2022 13:51:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

notes.md

@@ -2,24 +2,7 @@
 > ./scripts/generateCerts.sh . questdbPwd123
 
 ### TODO:
-- ~~The client should grow the buffer instead of throwing on insufficient buffer size, like other clients do~~
-- If the buffer had to be extended, shrink it back to original size on a subsequent flush() call?
-- ~~Config object for Sender, make bufferSize optional by setting a default~~
-- ~~Github actions to run 'npm test' on each commit and run 'npm publish' when version is bumped in package.json~~
-- ~~Provide a builder style API:
-  builder.table('tab').symbol('symName', any).intColumn('intCol', 34).timestampColumn('tsCol', 23232323).atNow();~~
-- ~~The project lacks a linter. Use ESLint (https://eslint.org) or standard (https://standardjs.com)~~
-- ~~Run linter in build~~
-- ~~Move certs/ under test/ since these are test specific files. Possibly generate certs from test.~~
-- Test the client against a real QuestDB instance, not only mock. The easiest way to do it is to use https://www.npmjs.com/package/testcontainers
-- ~~authenticate() function doesn't await for sender.socket.write() to happen and doesn't check for errors~~
-- ~~Avoid resource leaks on await sender.connect(); await sender.connect();.
-  As a bonus, we could even protect from concurrent connect calls, e.g. await Promise.all(sender.connect(), sender.connect());~~
-- ~~The client should throw Error instances instead of strings.~~
-- ~~sender.close() doesn't flush pending data to the socket. We should document this.~~
+- Test the client against a real QuestDB instance, not only mock.
+  The easiest way to do it is to use https://www.npmjs.com/package/testcontainers
 - Would be nice to accept alternative logger implementations to be used instead of console
-- ~~Add 'use strict'; since we are using JS + CommonJS~~
-- ~~"Typescript" should be "TypeScript" in the readme~~
-- ~~Remove commented code from test/testapp.js~~
-- Update node.js examples in QuestDB documentation
-- Remove notes.md file
+- If the buffer had to be extended, shrink it back to original size on a subsequent flush() call?

src/sender.js

@@ -47,7 +47,7 @@ class Sender {
      * </ul>
      * </p>
      */
-    constructor(options) {
+    constructor(options = undefined) {
         if (options) {
             this.jwk = options.jwk;
         }
@@ -135,6 +135,7 @@ class Sender {
             })
             .on("error", err => {
                 console.error(err);
+                reject(err);
             });
         });
     }
@@ -166,8 +167,12 @@ class Sender {
         }
         return new Promise((resolve, reject) => {
             this.socket.write(data, err => {
-                compact(this);
-                err ? reject(err) : resolve(true);
+                if (err) {
+                    reject(err);
+                } else {
+                    compact(this);
+                    resolve(true);
+                }
             });
         });
     }

test/proxyfunctions.js

@@ -6,9 +6,9 @@ const tls = require('tls');
 const LOCALHOST = '127.0.0.1';
 
 async function write(socket, data) {
-    return new Promise(resolve => {
-        socket.write(data, 'utf8', () => {
-            resolve();
+    return new Promise((resolve, reject) => {
+        socket.write(data, 'utf8', err => {
+            err ? reject(err) : resolve();
         });
     });
 }

types/src/sender.d.ts

@@ -29,7 +29,7 @@ export class Sender {
      * </ul>
      * </p>
      */
-    constructor(options: object);
+    constructor(options?: object);
     /** @private */ private jwk;
     /** @private */ private socket;
     /** @private */ private bufferSize;