Merge pull request #814 from watson-developer-cloud/handle-bad-chars-…

…in-urls-creds chore: throw error if user makes common mistake
watson-developer-cloud · Jan 8, 2019 · ab4c1cb · ab4c1cb
2 parents 9360470 + 994169a
commit ab4c1cb
Show file tree

Hide file tree

Showing 2 changed files with 111 additions and 0 deletions.
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/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',
+      });
+    });
+  });
 });