Cleanup org name and slug use

Author: jdalton

src/commands/config/discover-config-value.ts

@@ -59,8 +59,8 @@ export async function discoverConfigValue(
       }
     }
 
-    const org = await getDefaultOrgFromToken()
-    if (!org?.length) {
+    const orgSlugs = await getDefaultOrgFromToken()
+    if (!orgSlugs?.length) {
       return {
         success: false,
         value: undefined,
@@ -69,17 +69,17 @@ export async function discoverConfigValue(
       }
     }
 
-    if (Array.isArray(org)) {
+    if (Array.isArray(orgSlugs)) {
       return {
         success: true,
-        value: org,
+        value: orgSlugs,
         message: 'These are the orgs that the current API token can access.'
       }
     }
 
     return {
       success: true,
-      value: org,
+      value: orgSlugs,
       message: 'This is the org that belongs to the current API token.'
     }
   }
@@ -95,8 +95,8 @@ export async function discoverConfigValue(
       }
     }
 
-    const orgs = await getEnforceableOrgsFromToken()
-    if (!orgs?.length) {
+    const orgSlugs = await getEnforceableOrgsFromToken()
+    if (!orgSlugs?.length) {
       return {
         success: false,
         value: undefined,
@@ -107,7 +107,7 @@ export async function discoverConfigValue(
 
     return {
       success: true,
-      value: orgs,
+      value: orgSlugs,
       message: 'These are the orgs whose security policy you can enforce.'
     }
   }
@@ -131,25 +131,11 @@ export async function discoverConfigValue(
 async function getDefaultOrgFromToken(): Promise<
   string[] | string | undefined
 > {
-  const sockSdk = await setupSdk()
-  const result = await handleApiCall(
-    sockSdk.getOrganizations(),
-    'looking up organizations'
-  )
-
-  if (result.success) {
-    const arr = Array.from(Object.values(result.data.organizations)).map(
-      ({ slug }) => slug
-    )
-    if (arr.length === 0) {
-      return undefined
-    }
-    if (arr.length === 1) {
-      return arr[0]
-    }
-    return arr
+  const orgSlugs = await getEnforceableOrgsFromToken()
+  const length = orgSlugs?.length
+  if (length) {
+    return length === 1 ? orgSlugs![0] : orgSlugs!
   }
-
   return undefined
 }
 
@@ -159,16 +145,12 @@ async function getEnforceableOrgsFromToken(): Promise<string[] | undefined> {
     sockSdk.getOrganizations(),
     'looking up organizations'
   )
-
   if (result.success) {
-    const arr = Array.from(Object.values(result.data.organizations)).map(
-      ({ slug }) => slug
-    )
-    if (arr.length === 0) {
-      return undefined
+    const organizations = Object.values(result.data.organizations)
+    const orgSlugs = organizations.map(o => o.slug)
+    if (orgSlugs.length) {
+      return orgSlugs
     }
-    return arr
   }
-
   return undefined
 }

src/commands/login/attempt-login.ts

@@ -34,25 +34,26 @@ export async function attemptLogin(
 
   spinner.start('Verifying API key...')
 
-  let orgs: SocketSdkReturnType<'getOrganizations'>['data']
+  let data: SocketSdkReturnType<'getOrganizations'>['data']
   try {
     const sdk = await setupSdk(apiToken, apiBaseUrl, apiProxy)
     const result = await sdk.getOrganizations()
     if (!result.success) {
       throw new AuthError()
     }
-    orgs = result.data
+    data = result.data
     spinner.success('API key verified')
   } catch {
     spinner.errorAndStop('Invalid API key')
     return
   }
 
-  const enforcedChoices: OrgChoices = Object.values(orgs.organizations)
-    .filter(org => org?.plan === 'enterprise')
-    .map(org => ({
-      name: org.name ?? 'undefined',
-      value: org.id
+  const organizations = Object.values(data.organizations)
+  const enforcedChoices: OrgChoices = organizations
+    .filter(o => o?.plan === 'enterprise')
+    .map(o => ({
+      name: o.name ?? o.slug,
+      value: o.id
     }))
 
   let enforcedOrgs: string[] = []

src/commands/organization/output-organization-list.ts

@@ -20,7 +20,7 @@ export async function outputOrganizationList(
       logger.log(
         JSON.stringify(
           organizations.map(o => ({
-            name: o.name,
+            name: o.name ?? o.slug,
             id: o.id,
             plan: o.plan
           })),
@@ -70,7 +70,7 @@ export async function outputOrganizationList(
       // Just dump
       for (const o of organizations) {
         logger.log(
-          `- Name: ${colors.bold(o.name ?? 'undefined')}, ID: ${colors.bold(o.id)}, Plan: ${colors.bold(o.plan)}`
+          `- Name: ${colors.bold(o.name ?? o.slug)}, ID: ${colors.bold(o.id)}, Plan: ${colors.bold(o.plan)}`
         )
       }
     }

src/commands/scan/suggest-org-slug.ts

@@ -13,16 +13,17 @@ export async function suggestOrgSlug(): Promise<string | void> {
   // Ignore a failed request here. It was not the primary goal of
   // running this command and reporting it only leads to end-user confusion.
   if (result.success) {
+    const organizations = Object.values(result.data.organizations)
     const proceed = await select<string>({
       message:
         'Missing org name; do you want to use any of these orgs for this scan?',
       choices: [
-        ...Object.values(result.data.organizations).map(org => {
-          const slug = org.name ?? 'undefined'
+        ...organizations.map(o => {
+          const displayName = o.name ?? o.slug
           return {
-            name: `Yes [${slug}]`,
-            value: slug,
-            description: `Use "${slug}" as the organization`
+            name: `Yes [${displayName}]`,
+            value: displayName,
+            description: `Use "${displayName}" as the organization`
           }
         }),
         {