Merge branch 'master' into snyk-fix-k82684

dpopp07 · dpopp07 · commit 9bf01a9d7ff1 · 2019-01-14T15:32:49.000-06:00
diff --git a/.travis.yml b/.travis.yml
@@ -4,17 +4,16 @@ node_js:
 - 6
 - 8
 before_install:
-- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && openssl aes-256-cbc -K $encrypted_ac3aacad7ba8_key -iv $encrypted_ac3aacad7ba8_iv
-  -in secrets.tar.enc -out test/resources/secrets.tar -d || true'
-- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && cd test/resources/ && tar xvf secrets.tar && cd ../.. || true'
+- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && openssl aes-256-cbc -K $encrypted_ac3aacad7ba8_key
+  -iv $encrypted_ac3aacad7ba8_iv -in secrets.tar.enc -out test/resources/secrets.tar
+  -d || true'
+- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && cd test/resources/ && tar xvf secrets.tar
+  && cd ../.. || true'
 - npm install -g typescript
 script:
 - tsc
-- if [ "${TRAVIS_PULL_REQUEST}" = "false" ];
-    then npm run test-travis;
-  else
-    npm run test-unit-travis;
-  fi
+- if [ "${TRAVIS_PULL_REQUEST}" = "false" ]; then npm run test-travis; else npm run
+  test-unit-travis; fi
 - sh scripts/typedoc/generate_typedoc.sh
 after_success:
 - npm run report-coverage
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+## [3.15.1](https://github.com/watson-developer-cloud/node-sdk/compare/v3.15.0...v3.15.1) (2019-01-07)
+
+
+### Bug Fixes
+
+* add `disabled` property to CreateDialogNode ([41cd8dc](https://github.com/watson-developer-cloud/node-sdk/commit/41cd8dc))
+* add `user_defined` property to MessageOutput model ([ea28bf3](https://github.com/watson-developer-cloud/node-sdk/commit/ea28bf3))
+
 # [3.15.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.14.0...v3.15.0) (2018-12-07)
 
 
diff --git a/README.md b/README.md
@@ -282,8 +282,6 @@ function (err, token) {
 
 ### Assistant v2
 
-> Watson Assistant v2 API is released in beta. For details, see the ["Introducing Watson Assistant"](https://www.ibm.com/blogs/watson/2018/03/the-future-of-watson-conversation-watson-assistant/) blog post.
-
 Use the [Assistant][conversation] service to determine the intent of a message.
 
 Note: You must first create a workspace via IBM Cloud. See [the documentation](https://console.bluemix.net/docs/services/conversation/index.html#about) for details.
diff --git a/assistant/v1.ts b/assistant/v1.ts
@@ -3805,6 +3805,8 @@ namespace AssistantV1 {
     digress_out_slots?: string;
     /** A label that can be displayed externally to describe the purpose of the node to users. This string must be no longer than 512 characters. */
     user_label?: string;
+    /** For internal use only. */
+    disabled?: boolean;
   }
 
   /** DialogNodeAction. */
diff --git a/assistant/v2.ts b/assistant/v2.ts
@@ -452,6 +452,8 @@ namespace AssistantV2 {
     actions?: DialogNodeAction[];
     /** Additional detailed information about a message response and how it was generated. */
     debug?: MessageOutputDebug;
+    /** An object containing any custom properties included in the response. This object includes any arbitrary properties defined in the dialog JSON editor as part of the dialog node output. */
+    user_defined?: Object;
   }
 
   /** Additional detailed information about a message response and how it was generated. */
diff --git a/examples/personality_insights.v2.js b/examples/personality_insights.v2.js
diff --git a/examples/text_to_speech_websocket.js b/examples/text_to_speech_websocket.js
@@ -22,8 +22,9 @@ const synthesizeStream = textToSpeech.synthesizeUsingWebSocket(params);
 // the output of the stream can be piped to any writable stream, like an audio file
 synthesizeStream.pipe(fs.createWriteStream('./speech.ogg'));
 
+// !!!!! IMPORTANT !!!!!
 // if the stream is not being piped anywhere and is only being listened to, the stream needs
-//   to be explicitly set to flowing mode:
+//   to be explicitly set to flowing mode by uncommenting the following line:
 
 // synthesizeStream.resume();
 
diff --git a/lib/base_service.ts b/lib/base_service.ts
@@ -89,6 +89,30 @@ function usesBasicForIam(obj: any): boolean {
   return obj.username === 'apikey' && !obj.password.startsWith('icp-');
 }
 
+// returns true if the string has a curly bracket or quote as the first or last character
+// these are common user-issues that we should handle before they get a network error
+function badCharAtAnEnd(value: string): boolean {
+  return value.startsWith('{') || value.startsWith('"') || value.endsWith('}') || value.endsWith('"');
+}
+
+// checks credentials for common user mistakes of copying {, }, or " characters from the documentation
+function checkCredentials(obj: any) {
+  let errorMessage = '';
+  const credsToCheck = ['url', 'username', 'password', 'iam_apikey'];
+  credsToCheck.forEach(cred => {
+    if (obj[cred] && badCharAtAnEnd(obj[cred])) {
+      errorMessage += `The ${cred} shouldn't start or end with curly brackets or quotes. Be sure to remove any {, }, or "`;
+    }
+  });
+
+  if (errorMessage.length) {
+    errorMessage += 'Revise these credentials - they should not start or end with curly brackets or quotes.';
+    return errorMessage;
+  } else {
+    return null;
+  }
+}
+
 export class BaseService {
   static URL: string;
   name: string;
@@ -309,6 +333,11 @@ export class BaseService {
         }
       }
     }
+    // check credentials for common user errors
+    const credentialProblems = checkCredentials(_options);
+    if (credentialProblems) {
+      throw new Error(credentialProblems);
+    }
     return _options;
   }
   /**
diff --git a/lib/synthesize-stream.ts b/lib/synthesize-stream.ts
@@ -99,7 +99,7 @@ class SynthesizeStream extends Readable {
     const url =
       (options.url || 'wss://stream.watsonplatform.net/text-to-speech/api')
         .replace(/^http/, 'ws') + 
-        '/v1/synthesize' +
+        '/v1/synthesize?' +
         queryString;
 
     const socket = (this.socket = new w3cWebSocket(
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "watson-developer-cloud",
-  "version": "3.15.0",
+  "version": "3.15.1",
   "description": "Client library to use the IBM Watson Services and AlchemyAPI",
   "main": "./index",
   "repository": {
diff --git a/secrets.tar.enc b/secrets.tar.enc
diff --git a/test/integration/adapter.personality_insights.v3.test.js b/test/integration/adapter.personality_insights.v3.test.js
@@ -11,9 +11,9 @@ const TWENTY_SECONDS = 20000;
 describe('personality_insights_v3_adapter_integration', function() {
   jest.setTimeout(TWENTY_SECONDS);
   const mobydick = fs.readFileSync(path.join(__dirname, '../resources/mobydick.txt'), 'utf8');
-  auth.personality_insights.v3.version = 'v3';
-  auth.personality_insights.v3.version_date = '2016-10-19';
-  const personality_insights = watson.personality_insights(auth.personality_insights.v3);
+  auth.personality_insights.version = 'v3';
+  auth.personality_insights.version_date = '2016-10-19';
+  const personality_insights = watson.personality_insights(auth.personality_insights);
 
   it('profile()', function(done) {
     const params = {
diff --git a/test/integration/personality_insights.v2.test.js b/test/integration/personality_insights.v2.test.js
diff --git a/test/integration/personality_insights.v3.test.js b/test/integration/personality_insights.v3.test.js
@@ -12,8 +12,8 @@ describe('personality_insights_v3_integration', function() {
   jest.setTimeout(TWENTY_SECONDS);
 
   const mobydick = fs.readFileSync(path.join(__dirname, '../resources/mobydick.txt'), 'utf8');
-  auth.personality_insights.v3.version = '2016-10-19';
-  const personality_insights = new watson.PersonalityInsightsV3(auth.personality_insights.v3);
+  auth.personality_insights.version = '2016-10-19';
+  const personality_insights = new watson.PersonalityInsightsV3(auth.personality_insights);
 
   it('profile with text content', function(done) {
     const params = {
diff --git a/test/integration/text_to_speech.test.js b/test/integration/text_to_speech.test.js
@@ -20,6 +20,7 @@ describe('text_to_speech_integration', function() {
     const params = {
       text: 'test',
       accept: 'audio/wav',
+      voice: 'en-US_LisaVoice',
     };
 
     it('synthesize using http', function(done) {
diff --git a/test/unit/baseService.test.js b/test/unit/baseService.test.js
@@ -335,4 +335,86 @@ describe('BaseService', function() {
     });
     expect(instance._options.rejectUnauthorized).toBe(true);
   });
+
+  describe('check credentials for common problems', function() {
+    function assertConstructorThrows(params) {
+      expect(() => {
+        new TestService(params);
+      }).toThrowError(
+        'Revise these credentials - they should not start or end with curly brackets or quotes.'
+      );
+    }
+
+    it('should throw when username starts with {', function() {
+      assertConstructorThrows({
+        username: '{batman}',
+        password: 'goodpass',
+      });
+    });
+
+    it('should throw when username starts with "', function() {
+      assertConstructorThrows({
+        username: '"<batman">',
+        password: 'goodpass',
+      });
+    });
+
+    it('should throw when password starts with {', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: '{badpass}',
+      });
+    });
+
+    it('should throw when password starts with "', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: '"badpass"',
+      });
+    });
+
+    it('should throw when iam_apikey starts with {', function() {
+      assertConstructorThrows({
+        iam_apikey: '{abc123}',
+      });
+    });
+
+    it('should throw when iam_apikey starts with "', function() {
+      assertConstructorThrows({
+        iam_apikey: '"<abc123',
+      });
+    });
+
+    it('should throw when url starts with {', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: 'goodpass',
+        url: '{watson-url}/some-api/v1/endpoint',
+      });
+    });
+
+    it('should throw when url ends with }', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: 'goodpass',
+        url: 'watson-url.com/some-api/v1/endpoint}',
+      });
+    });
+
+    it('should throw when url starts with "', function() {
+      assertConstructorThrows({
+        username: 'batman',
+        password: 'goodpass',
+        url: '"watson-url.com/some-api/v1/endpoint',
+      });
+    });
+
+    it('should throw when mutiple creds are bad', function() {
+      assertConstructorThrows({
+        username: '{batman}',
+        password: '"<badpass>"',
+        url: '{watson-url}/some-api/v1/endpoint',
+      });
+    });
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -3805,6 +3805,8 @@ namespace AssistantV1 {`
`3805`	`3805`	`digress_out_slots?: string;`
`3806`	`3806`	`/** A label that can be displayed externally to describe the purpose of the node to users. This string must be no longer than 512 characters. */`
`3807`	`3807`	`user_label?: string;`
	`3808`	`+ /** For internal use only. */`
	`3809`	`+ disabled?: boolean;`
`3808`	`3810`	`}`
`3809`	`3811`
`3810`	`3812`	`/** DialogNodeAction. */`
Original file line number	Diff line number	Diff line change
`@@ -452,6 +452,8 @@ namespace AssistantV2 {`
`452`	`452`	`actions?: DialogNodeAction[];`
`453`	`453`	`/** Additional detailed information about a message response and how it was generated. */`
`454`	`454`	`debug?: MessageOutputDebug;`
	`455`	`+ /** An object containing any custom properties included in the response. This object includes any arbitrary properties defined in the dialog JSON editor as part of the dialog node output. */`
	`456`	`+ user_defined?: Object;`
`455`	`457`	`}`
`456`	`458`
`457`	`459`	`/** Additional detailed information about a message response and how it was generated. */`