Merge pull request #814 from salesforcecli/sm/html-maintenance

shetzel · web-flow · commit da78ad6f36b4 · 2023-10-02T14:50:43.000-06:00
fix: handle html maintenance message
diff --git a/src/shared/orgListUtil.ts b/src/shared/orgListUtil.ts
@@ -329,18 +329,10 @@ export class OrgListUtil {
         await org.refreshAuth();
         return 'Connected';
       } catch (err) {
-        const error = err as SfError;
-        const logger = await OrgListUtil.retrieveLogger();
-        logger.trace(`error refreshing auth for org: ${org.getUsername()}`);
-        logger.trace(error);
-        return (error.code ?? error.message) as string;
+        return authErrorHandler(err, org.getUsername() as string);
       }
     } catch (err) {
-      const error = err as SfError;
-      const logger = await OrgListUtil.retrieveLogger();
-      logger.trace(`error refreshing auth for org: ${username}`);
-      logger.trace(error);
-      return (error.code ?? error.message ?? 'Unknown') as string;
+      return authErrorHandler(err, username);
     }
   }
 }
@@ -377,3 +369,15 @@ const removeRestrictedInfoFromConfig = (
 const sandboxFilter = (org: AuthFieldsFromFS): boolean => Boolean(org.isSandbox);
 const regularOrgFilter = (org: AuthFieldsFromFS): boolean => !org.isSandbox && !org.isDevHub;
 const devHubFilter = (org: AuthFieldsFromFS): boolean => Boolean(org.isDevHub);
+
+const authErrorHandler = async (err: unknown, username: string): Promise<string> => {
+  const error = err as SfError;
+  const logger = await OrgListUtil.retrieveLogger();
+  logger.trace(`error refreshing auth for org: ${username}`);
+  logger.trace(error);
+  // Orgs under maintenace return html as the error message.
+  if (error.message.includes('maintenance')) return 'Down (Maintenance)';
+  // handle other potential html responses
+  if (error.message.includes('<html>')) return 'Bad Response';
+  return (error.code ?? error.message) as string;
+};
diff --git a/test/shared/orgListUtil.test.ts b/test/shared/orgListUtil.test.ts
@@ -208,6 +208,33 @@ describe('orgListUtil tests', () => {
       expect(checkNonScratchOrgIsDevHub.called).to.be.false;
     });
 
+    it('handles html responses for non-scratch orgs under maintenance', async () => {
+      determineConnectedStatusForNonScratchOrg.restore();
+      stubMethod(sandbox, Org, 'create').returns(Org.prototype);
+      stubMethod(sandbox, Org.prototype, 'getField').returns(undefined);
+      stubMethod(sandbox, Org.prototype, 'getUsername').returns(devHubConfigFields.username);
+      stubMethod(sandbox, Org.prototype, 'refreshAuth').rejects({
+        message: `<html>                                                                                                                                                                                           
+  <body>                                                                                                                                                                                           
+  <center>                                                                                                                                                                                         
+    <table bgcolor="white" cellpadding="0" cellspacing="0" width="758">                                                                                                                              
+      <tbody>                                                                                                                                                                                          
+      <tr>                                                                                                                                                                                             
+        <td><span style="font-family: Verdana; font-size: medium; font-weight: bold;">We are down for maintenance.</span><br><br>Sorry for the inconvenience. We'll be back shortly.</td><br>            
+      </tr>                                                                                                                                                                                            
+      </tbody>                                                                                                                                                                                         
+    </table>                                                                                                                                                                                         
+  </center>                                                                                                                                                                                        
+  </body>                                                                                                                                                                                          
+  </html>`,
+      });
+
+      const orgGroups = await OrgListUtil.readLocallyValidatedMetaConfigsGroupedByOrgType(fileNames, false);
+      expect(orgGroups.nonScratchOrgs).to.have.length(1);
+      expect(orgGroups.nonScratchOrgs[0].connectedStatus).to.equal('Down (Maintenance)');
+      expect(checkNonScratchOrgIsDevHub.called).to.be.false;
+    });
+
     it('handles auth file problems for non-scratch orgs', async () => {
       determineConnectedStatusForNonScratchOrg.restore();
       stubMethod(sandbox, Org, 'create').rejects({ message: 'bad file' });
