Merge pull request #575 from watson-developer-cloud/add-global-transaction-id

add global transaction id to error body

Author: ammardodin

lib/requestwrapper.ts

@@ -26,6 +26,7 @@ import { PassThrough as readableStream } from 'stream';
 
 const pkg = require('../package.json');
 const isBrowser = typeof window === 'object';
+const globalTransactionId = 'x-global-transaction-id';
 
 /**
  * @private
@@ -61,6 +62,9 @@ export function formatErrorIfExists(cb: Function): request.RequestCallback {
         error = new Error(error.message || error.error || error);
         error.body = body;
       }
+      if (response && response.headers) {
+        error[globalTransactionId] = response.headers[globalTransactionId];
+      }
       cb(error, body, response);
       return;
     }
@@ -74,13 +78,14 @@ export function formatErrorIfExists(cb: Function): request.RequestCallback {
 
     // for api-key services
     if (response.statusMessage === 'invalid-api-key') {
-      cb(
-        {
-          error: response.statusMessage,
-          code: response.statusMessage === 'invalid-api-key' ? 401 : 400
-        },
-        null
-      );
+      const error = {
+        error: response.statusMessage,
+        code: response.statusMessage === 'invalid-api-key' ? 401 : 400
+      };
+      if (response.headers) {
+        error[globalTransactionId] = response.headers[globalTransactionId];
+      }
+      cb(error, null);
       return;
     }
 
@@ -125,6 +130,9 @@ export function formatErrorIfExists(cb: Function): request.RequestCallback {
       }
       body = null;
     }
+    if (error && response && response.headers) {
+      error[globalTransactionId] = response.headers[globalTransactionId];
+    }
     cb(error, body, response);
     return;
   };

test/integration/test.tone_analyzer.js

@@ -2,6 +2,7 @@
 
 const fs = require('fs');
 const nock = require('nock');
+const assert = require('assert');
 const watson = require('../../index');
 const path = require('path');
 const authHelper = require('./auth_helper.js');
@@ -31,6 +32,17 @@ describe('tone_analyzer_integration', function() {
     tone_analyzer.tone({ tone_input: mobydick, content_type: 'text/plain' }, done);
   });
 
+  it('failing tone()', function(done) {
+    // this is a failing test
+    const mobydick = fs.readFileSync(path.join(__dirname, '../resources/mobydick.txt'), 'utf8');
+    tone_analyzer.tone({ tone_input: mobydick, content_type: 'invalid content type' }, (err, res) => {
+      assert(err);
+      assert(err['x-global-transaction-id']);
+      assert(typeof err['x-global-transaction-id'] === 'string');
+    });
+    done();
+  });
+
   it('toneChat()', function(done) {
     const utterances = {
       utterances: [

test/integration/test.visual_recognition.js

@@ -140,47 +140,4 @@ describe('visual_recognition_integration', function() {
       });
     });
   });
-
-  // this endpoint is flakey
-  // describe.skip('recognizeText()', function() {
-  //   it('read text in an uploaded image', function(done) {
-  //     const params = {
-  //       images_file: fs.createReadStream(__dirname + '/../resources/car.png')
-  //     };
-  //     visual_recognition.recognizeText(params, function(err, result) {
-  //       if (err) {
-  //         return done(err);
-  //       }
-
-  //       // console.log(JSON.stringify(actual, null, 2));
-
-  //       assert.equal(result.images_processed, 1);
-  //       assert.equal(result.images[0].image, 'car.png');
-  //       assert(result.images[0].text);
-  //       assert(result.images[0].words.length);
-
-  //       done();
-  //     });
-  //   });
-
-  //   it('read text an image via url', function(done) {
-  //     const params = {
-  //       url: 'https://watson-test-resources.mybluemix.net/resources/car.png'
-  //     };
-  //     visual_recognition.recognizeText(params, function(err, result) {
-  //       if (err) {
-  //         return done(err);
-  //       }
-  //       // console.log(JSON.stringify(result, null, 2));
-
-  //       assert.equal(result.images_processed, 1);
-  //       assert.equal(result.images[0].resolved_url, 'https://watson-test-resources.mybluemix.net/resources/car.png');
-  //       assert.equal(result.images[0].source_url, 'https://watson-test-resources.mybluemix.net/resources/car.png');
-  //       assert(result.images[0].text);
-  //       assert(result.images[0].words.length);
-
-  //       done();
-  //     });
-  //   });
-  // });
 }); // vr