feat: better error name/messaging/suggestion and DRY

Author: mshanemc

messages/messages.md

@@ -48,9 +48,9 @@ Disable masking of user input; use with problematic terminals.
 
 OAuth client secret of personal connected app?
 
-# invalidInstanceUrl
+# lightningInstanceUrl
 
-Invalid instance URL. Specify a Salesforce instance URL using the format <domainname>.salesforce.com
+Invalid instance URL. It should NOT be a lightning domain.
 
 # accessTokenStdin
 

src/common.ts

@@ -14,9 +14,7 @@ export class Common {
   public static async resolveLoginUrl(instanceUrl?: string): Promise<string> {
     const logger = await Logger.child('Common', { tag: 'resolveLoginUrl' });
     if (instanceUrl) {
-      if (instanceUrl.match(/lightning\..*force\.com/)) {
-        throw new SfError(messages.getMessage('invalidInstanceUrl'), 'URL_WARNING');
-      }
+      throwIfLightning(instanceUrl);
       return instanceUrl;
     }
     let loginUrl: string;
@@ -29,10 +27,17 @@ export class Common {
       logger.debug(`error occurred while trying to determine loginUrl: ${message}`);
       loginUrl = SfdcUrl.PRODUCTION;
     }
-    if (loginUrl.match(/lightning\..*force\.com/)) {
-      throw new SfError(messages.getMessage('invalidInstanceUrl'), 'URL_WARNING');
-    }
+    throwIfLightning(loginUrl);
+
     logger.debug(`loginUrl: ${loginUrl}`);
     return loginUrl;
   }
 }
+
+const throwIfLightning = (urlString?: string): void => {
+  if (urlString?.match(/lightning\..*force\.com/)) {
+    throw new SfError(messages.getMessage('lightningInstanceUrl'), 'LightningDomain', [
+      messages.getMessage('flags.instance-url.description'),
+    ]);
+  }
+};

test/common.test.ts

@@ -77,7 +77,7 @@ describe('common unit tests', () => {
         expect.fail('This test is failing because it is expecting an error that is never thrown');
       } catch (error) {
         assert(error instanceof Error);
-        expect(error.name).to.equal('URL_WARNING');
+        expect(error.name).to.equal('LightningDomain');
       }
     });
     it('should throw on lightning login URL passed in to resolveLoginUrl()', async () => {
@@ -87,7 +87,7 @@ describe('common unit tests', () => {
         expect.fail('This test is failing because it is expecting an error that is never thrown');
       } catch (error) {
         assert(error instanceof Error);
-        expect(error.name).to.equal('URL_WARNING');
+        expect(error.name).to.equal('LightningDomain');
       }
     });
 
@@ -98,7 +98,7 @@ describe('common unit tests', () => {
         expect.fail('This test is failing because it is expecting an error that is never thrown');
       } catch (error) {
         assert(error instanceof Error);
-        expect(error.name).to.equal('URL_WARNING');
+        expect(error.name).to.equal('LightningDomain');
       }
     });
   });