Merge branch 'release/2.1.4'

CHANGELOG.md

@@ -4,6 +4,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [2.1.4] - 2024-01-31
+### CHANGED
+- Changed the error message produced when more than 1 GraphQL error is encountered. Previously, all that was logged
+  was "More than 1 error encountered" which is too vague. This has been changed to "More than 1 GraphQLError
+  encountered" with additional logs detailing each GraphQL error encountered as "<message> @ locations/s <locations>...".
+
 ## [2.1.3] - 2024-01-31
 ### FIXED
 - Added utility class `EntityCriteria` to package exports.
@@ -176,7 +182,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### ADDED
 - Alpha release
 
-[Unreleased]: https://github.com/widesky/jswidesky-client/compare/master...2.1.1
+[Unreleased]: https://github.com/widesky/jswidesky-client/compare/master...2.1.4
 [1.0.0]: https://github.com/widesky/jswidesky-client/compare/1.0.0...1.0.0
 [1.1.0]: https://github.com/widesky/jswidesky-client/compare/1.1.0...1.0.0
 [1.1.1]: https://github.com/widesky/jswidesky-client/compare/1.1.1...1.1.0
@@ -194,3 +200,5 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 [2.1.0]: https://github.com/widesky/jswidesky-client/compare/2.1.0...2.0.6
 [2.1.1]: https://github.com/widesky/jswidesky-client/compare/2.1.1...2.1.0
 [2.1.2]: https://github.com/widesky/jswidesky-client/compare/2.1.2...2.1.1
+[2.1.3]: https://github.com/widesky/jswidesky-client/compare/2.1.3...2.1.2
+[2.1.4]: https://github.com/widesky/jswidesky-client/compare/2.1.4...2.1.3

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@widesky/jswidesky-client",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "WideSky Client in JavaScript",
   "main": "index.js",
   "private": false,
@@ -9,7 +9,7 @@
     "coverage": "npx nyc --reporter=html --reporter=text mocha test/*/**.js",
     "build:bundlejs:prd": "webpack --config webpack.config.js --mode production",
     "build:bundlejs:dev": "webpack --config webpack.config.js --mode development",
-    "build": "run-s test build:bundlejs:prd build:bundlejs:dev"
+    "build": "npm install && run-s test build:bundlejs:prd build:bundlejs:dev"
   },
   "author": "WideSky.cloud <[email protected]>",
   "license": "MIT",

src/client/client.js

@@ -18,6 +18,7 @@ const clientV2Functions = require("./functions/v2");
 const { performOpInBatch, ...allBatchFunctions } = require("./functions/batch");
 const cliProgress = require("cli-progress");
 const bFormat = require("bunyan-format");
+const {GraphQLError} = require("../errors");
 
 let axios;
 // Browser/Node axios import
@@ -423,11 +424,14 @@ class WideSkyClient {
                         return this._wsRawSubmit(method, uri, body, config);
                     }
                     else {
-                        parsedErr = RequestError.make(err);
+                        parsedErr = RequestError.make(err, this.logger);
                     }
                 }
             }
             this.logger.error(parsedErr);
+            if (parsedErr instanceof GraphQLError && parsedErr.errors.length > 1) {
+                parsedErr.errors.forEach((msg, i) => this.logger.error("GraphQL error #%d: %s", i + 1, msg));
+            }
             throw parsedErr;
         }
     }

src/errors.js

@@ -10,18 +10,19 @@ class RequestError extends Error {
         this.stack += reqError.stack.substring(reqError.stack.indexOf("\n"));
     }
 
-    static make(reqError) {
+    static make(reqError, logger) {
         if (lodash.has(reqError, "response.data")) {
             const { data } = reqError.response;
             if (lodash.has(data, "meta.dis")) {
                 return new HaystackError(data.meta.dis.substring(2), reqError);
             }
             else if (data.errors !== undefined && Array.isArray(data.errors) && data.errors.length > 0) {
-                let errMsg = "More than 1 error encountered";
+                let errMsg = "More than 1 GraphQLError encountered";
                 if (data.errors.length === 1) {
                     errMsg = data.errors[0].message;
                 }
 
+                logger.debug("Raw GraphQL error response: %j", data);
                 return new GraphQLError(errMsg.replace(/\n/g, ""), reqError);
             }
             else {
@@ -49,8 +50,13 @@ class HaystackError extends RequestError {
  */
 class GraphQLError extends RequestError {
     constructor(name, reqError) {
-        super(name, reqError);
-        this.errors = reqError.response.data.errors;
+        super(name.replace(/\n/g, ""), reqError);
+        this.errors = [];
+        for (const errorMsg of reqError.response.data.errors) {
+            const {message, locations} = errorMsg;
+            const locationsStr = locations.map((loc) => `line ${loc.line}:${loc.column}`);
+            this.errors.push(`${message.replace(/\n/g, " ")} @ location/s ${locationsStr.join(", ")}`);
+        }
     }
 }
 

test/client/errors/RequestError.js

@@ -1,19 +1,25 @@
 const {RequestError, HaystackError, GraphQLError} = require("../../../src/errors");
 const { expect } = require("chai");
+const {StubLogger} = require("../../stubs");
 
 describe("RequestError", () => {
+    let logger = new StubLogger();
+    beforeEach(() => {
+        logger.resetHistory();
+    });
+
     describe("make", () => {
         it("should not create RequestError if no response received", () => {
             const error = new Error("Test error");
-            const reqError = RequestError.make(error);
+            const reqError = RequestError.make(error, logger);
             expect(reqError).to.be.instanceof(Error);
         });
 
         it("should not create RequestError if no data in response", () => {
             // e.g. HTTP 403 errors don't typically have a message
             const error = new Error("Test error");
             error.response = {};
-            const reqError = RequestError.make(error);
+            const reqError = RequestError.make(error, logger);
             expect(reqError).to.be.instanceof(Error);
         });
 
@@ -24,7 +30,7 @@ describe("RequestError", () => {
                     nothingToSee: "here"
                 }
             };
-            const reqError = RequestError.make(error);
+            const reqError = RequestError.make(error, logger);
             expect(reqError).to.be.instanceof(Error);
         });
 
@@ -38,7 +44,7 @@ describe("RequestError", () => {
                         }
                     }
                 };
-                const reqError = RequestError.make(error);
+                const reqError = RequestError.make(error, logger);
                 expect(reqError).to.be.instanceof(HaystackError);
                 expect(reqError.message).to.equal("HBadRequestError: It broken");
             });
@@ -63,12 +69,14 @@ describe("RequestError", () => {
                         ]
                     }
                 };
-                const reqError = RequestError.make(error);
+                const reqError = RequestError.make(error, logger);
                 expect(reqError).to.be.instanceof(GraphQLError);
                 expect(reqError.message).to.equal(
                     "Field \"search\" argument \"whereTag\" of type \"String!\" is required but not provided."
                 );
-                expect(reqError.errors).to.eql(error.response.data.errors);
+                expect(reqError.errors).to.eql([
+                    "Field \"search\" argument \"whereTag\" of type \"String!\" is required but not provided. @ location/s line 5:5"
+                ]);
             });
         });
 
@@ -99,10 +107,13 @@ describe("RequestError", () => {
                     ]
                 }
             };
-            const reqError = RequestError.make(error);
+            const reqError = RequestError.make(error, logger);
             expect(reqError).to.be.instanceof(GraphQLError);
-            expect(reqError.message).to.equal("More than 1 error encountered");
-            expect(reqError.errors).to.eql(error.response.data.errors);
+            expect(reqError.message).to.equal("More than 1 GraphQLError encountered");
+            expect(reqError.errors).to.eql([
+                "Field \"search\" argument \"whereTag\" of type \"String!\" is required but not provided. @ location/s line 5:5",
+                "Field blah not blah blah @ location/s line 5:10"
+            ]);
         });
     });
 });

test/client/functions/batch/deleteByFilter.js

@@ -145,7 +145,7 @@ describe("client.batch.deleteByFilter", () => {
                         ]
                     }
                 }
-                throw RequestError.make(fakeError);
+                throw RequestError.make(fakeError, log);
             });
 
             const { success, errors } = await ws.batch.deleteByFilter("bad filter");

test/client/functions/batch/hisDeleteByFilter.js

@@ -350,7 +350,7 @@ describe("client.batch.hisDeleteByFilter", () => {
                         ]
                     }
                 }
-                throw RequestError.make(fakeError);
+                throw RequestError.make(fakeError, log);
             });
 
             const { success, errors } = await ws.batch.hisDeleteByFilter("bad filter", TIME_START, TIME_END);

test/client/functions/batch/hisReadByFilter.js

@@ -173,7 +173,7 @@ describe("client.batch.hisReadByFilter", () => {
                         ]
                     }
                 }
-                throw RequestError.make(fakeError);
+                throw RequestError.make(fakeError, log);
             });
 
 

test/stubs.js

@@ -27,6 +27,11 @@ const StubLogger = function() {
     ['fatal','error','warn','info','debug','trace'].forEach((l) => {
         self[l] = sinon.stub();
     });
+    self.resetHistory = () => {
+        ['fatal','error','warn','info','debug','trace'].forEach((l) => {
+            self[l].resetHistory();
+        });
+    }
 };
 
 /**