fix: prevent defaultHelp method to throw when there is no target-devops-center value set (#139)

Author: EstebanRomero84

src/common/base/abstractPromote.ts

@@ -185,7 +185,7 @@ export abstract class PromoteCommand<T extends typeof SfCommand> extends SfComma
    * @returns
    */
   protected catch(error: Error | SfError): Promise<SfCommand.Error> {
-    if (error.name.includes('GenericTimeoutError')) {
+    if (error.name?.includes('GenericTimeoutError')) {
       const err = messages.createError('error.ClientTimeout', [
         this.config.bin,
         this.id?.split(':').slice(0, -1).join(' '),

src/common/base/abstractResume.ts

@@ -105,7 +105,7 @@ export abstract class ResumeCommand<T extends typeof SfCommand> extends SfComman
    * @returns
    */
   protected catch(error: Error | SfError): Promise<SfCommand.Error> {
-    if (error.name.includes('GenericTimeoutError')) {
+    if (error.name?.includes('GenericTimeoutError')) {
       const err = messages.createError('error.ClientTimeout', [
         this.config.bin,
         this.id?.split(':').slice(0, -1).join(' '),

src/common/flags/flags.ts

@@ -47,7 +47,7 @@ export const requiredDoceOrgFlag = OclifFlags.custom({
   summary: messages.getMessage('flags.targetDoceOrg.summary'),
   parse: async (input: string | undefined) => getOrgOrThrow(input),
   default: async () => getOrgOrThrow(),
-  defaultHelp: async () => (await getOrgOrThrow())?.getUsername(),
+  defaultHelp: async () => getDefaultDevopsCenterUsernameAlias(),
   required: true,
 });
 
@@ -74,18 +74,26 @@ export const concise: BooleanFlag<boolean> = Flags.boolean({
   exclusive: ['verbose'],
 });
 
+/**
+ * Helper to get the userneame or alias of the default Devops Center org
+ * from the target-devops-center config variable.
+ */
+export const getDefaultDevopsCenterUsernameAlias = async (): Promise<string | undefined> => {
+  const config = await ConfigAggregator.create({ customConfigMeta: ConfigMeta });
+  return config.getInfo(ConfigVars.TARGET_DEVOPS_CENTER)?.value?.toString();
+};
+
 /**
  *
  * @param input alias/username of an org
  * @returns instance of an Org that correspons to the alias/username passed in
  * or to the alias/username set in --target-devops-center config variable.
  */
 const getOrgOrThrow = async (input?: string): Promise<Org> => {
-  const aggregator = await ConfigAggregator.create({ customConfigMeta: ConfigMeta });
-  const alias = input ? input : aggregator.getInfo(ConfigVars.TARGET_DEVOPS_CENTER)?.value?.toString();
-  if (!alias) {
+  const usernameOrAlias = input ? input : await getDefaultDevopsCenterUsernameAlias();
+  if (!usernameOrAlias) {
     throw messages.createError('errors.NoDefaultDoceEnv');
   }
-  const org: Org = await Org.create({ aliasOrUsername: alias });
+  const org: Org = await Org.create({ aliasOrUsername: usernameOrAlias });
   return org;
 };

test/common/flags.test.ts

@@ -11,7 +11,13 @@ import { Parser } from '@oclif/core';
 import { ConfigAggregator, Org } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { ConfigVars } from '../../src/configMeta';
-import { requiredDoceOrgFlag, wait, verbose, concise } from '../../src/common/flags/flags';
+import {
+  requiredDoceOrgFlag,
+  wait,
+  verbose,
+  concise,
+  getDefaultDevopsCenterUsernameAlias,
+} from '../../src/common/flags/flags';
 import { async } from '../../src/common/flags/promote/promoteFlags';
 
 const TARGET_DEVOPS_CENTER_ALIAS = 'target-devops-center';
@@ -156,6 +162,30 @@ describe('requiredDoceOrgFlag', () => {
       expect(err.message).to.include(`No authorization information found for ${invalidTargetDevopsCenter}`);
     }
   });
+
+  it('returns the value of the target-devops-center config variable', async () => {
+    sandbox.stub(ConfigAggregator.prototype, 'getInfo').returns({
+      value: TARGET_DEVOPS_CENTER_ALIAS,
+      key: ConfigVars.TARGET_DEVOPS_CENTER,
+      isLocal: () => false,
+      isGlobal: () => true,
+      isEnvVar: () => false,
+    });
+    const defaultDoceAlias = await getDefaultDevopsCenterUsernameAlias();
+    expect(defaultDoceAlias).to.equal(TARGET_DEVOPS_CENTER_ALIAS);
+  });
+
+  it('returns undefined when there is not a target-devops-center config variable', async () => {
+    sandbox.stub(ConfigAggregator.prototype, 'getInfo').returns({
+      value: null,
+      key: ConfigVars.TARGET_DEVOPS_CENTER,
+      isLocal: () => false,
+      isGlobal: () => true,
+      isEnvVar: () => false,
+    });
+    const defaultDoceAlias = await getDefaultDevopsCenterUsernameAlias();
+    expect(defaultDoceAlias).to.equal(undefined);
+  });
 });
 
 describe('waitFlag', () => {