Merge pull request #66 from acoustic-content-samples/rel4.5.5

rel4.5.5

Author: will-izard-ac

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 4.5.5 changes since 4.5.4
+ - error handling
+    - show error description when present
+
 ### 4.5.4 changes since 4.5.3
  - pull
     - Fix for content pull which could cause to start infinite pulling loop

CLI/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wchtools-cli",
   "description": "Command line tools for Acoustic Content",
-  "version": "4.5.4",
+  "version": "4.5.5",
   "keywords": [
     "cli"
   ],
@@ -60,4 +60,4 @@
     "posttest": "npm run testcleanup && npm run checkcoverage",
     "postinstall": "node ./scripts/postinstall.js"
   }
-}
+}

authoring-api/lib/contentFS.js

@@ -42,6 +42,9 @@ class ContentFS extends JSONItemFS {
     getFileName(content) {
         if (content && content.id) {
             return BaseFS.getValidFileName(content.id);
+        } else if (content) {
+            // when no id provided in json use path that is the file name
+            return BaseFS.getValidFileName(content.path);
         }
     }
 }

authoring-api/lib/utils/utils.js

@@ -335,6 +335,9 @@ function getErrorFromBody (body) {
             if (Array.isArray(body.errors)) {
                 body.errors.forEach(function (error, index) {
                     messages += error.message;
+                    if(error.description) {
+                        messages += ' ' + error.description;
+                    }
                     if (index < body.errors.length - 1) {
                         // Add a separator if this is not the last error in the array.
                         messages += ' ; ';

authoring-api/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wchtools-api",
   "description": "Tools API for Acoustic Content",
-  "version": "4.5.4",
+  "version": "4.5.5",
   "keywords": [
     "api",
     "tools"
@@ -52,4 +52,4 @@
     "testcleanup": "node ./test/testcleanup.js",
     "posttest": "npm run testcleanup && npm run checkcoverage"
   }
-}
+}

authoring-api/test/unit/utils.test.js

@@ -295,6 +295,54 @@ describe("utils", function () {
             }
         });
 
+        it("should return an error based on single errors (array) property on the response body and description if present", function (done) {
+            const TEST_ERROR_1 = "First error message used for testing.";
+            const DESCRIPTION_1 = 'Additional description.';
+            const testError = null;
+            let error1 = new Error(TEST_ERROR_1);
+            error1.description = DESCRIPTION_1;
+            const testBody = {"errors": [error1]};
+            const testResponse = null;
+            const testRequestOptions = null;
+            let error;
+            try {
+                const error = utils.getError(testError, testBody, testResponse, testRequestOptions);
+                expect(error.message).to.contain(TEST_ERROR_1);
+                expect(error.message).to.contain(DESCRIPTION_1);
+            } catch (err) {
+                error = err;
+            } finally {
+                done(error);
+            }
+        });
+
+        it("should return an error based on the errors (array) property on the response body and description if present", function (done) {
+            const TEST_ERROR_1 = "First error message used for testing.";
+            const TEST_ERROR_2 = "Second error message used for testing.";
+            const DESCRIPTION_1 = 'Additional description.';
+            const DESCRIPTION_2 = '2nd additional description.';
+            const testError = null;
+            let error1 = new Error(TEST_ERROR_1);
+            error1.description = DESCRIPTION_1;
+            let error2 = new Error(TEST_ERROR_2);
+            error2.description = DESCRIPTION_2;
+            const testBody = {"errors": [error1, error2]};
+            const testResponse = null;
+            const testRequestOptions = null;
+            let error;
+            try {
+                const error = utils.getError(testError, testBody, testResponse, testRequestOptions);
+                expect(error.message).to.contain(TEST_ERROR_1);
+                expect(error.message).to.contain(TEST_ERROR_2);
+                expect(error.message).to.contain(DESCRIPTION_1);
+                expect(error.message).to.contain(DESCRIPTION_2);
+            } catch (err) {
+                error = err;
+            } finally {
+                done(error);
+            }
+        });
+
         it("should return an error based on the errors (non-array Error) property on the response body", function (done) {
             const TEST_ERROR_1 = "First error message used for testing.";
             const testError = null;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "prod-tools",
-  "version": "4.5.4",
+  "version": "4.5.5",
   "author": "Acoustic, L.P.",
   "license": "Apache-2.0",
   "bugs": {
@@ -28,4 +28,4 @@
     "install": "npm run clear && npm run npminstallall",
     "unit": "node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha authoring-api/test/unit/*.test.js CLI/test/unit/*.test.js -- --recursive"
   }
-}
+}