Cleanup sdk api usage

Author: jdalton

src/commands/analytics/fetch-org-analytics.mts

@@ -2,19 +2,29 @@ import { handleApiCall } from '../../utils/api.mts'
 import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
+import type { SetupSdkOptions } from '../../utils/sdk.mts'
 import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
 
+export type FetchOrgAnalyticsDataOptions = {
+  sdkOptions?: SetupSdkOptions | undefined
+}
+
 export async function fetchOrgAnalyticsData(
   time: number,
+  options?: FetchOrgAnalyticsDataOptions | undefined,
 ): Promise<CResult<SocketSdkSuccessResult<'getOrgAnalytics'>['data']>> {
-  const sockSdkCResult = await setupSdk()
+  const { sdkOptions } = {
+    __proto__: null,
+    ...options,
+  } as FetchOrgAnalyticsDataOptions
+
+  const sockSdkCResult = await setupSdk(sdkOptions)
   if (!sockSdkCResult.ok) {
     return sockSdkCResult
   }
   const sockSdk = sockSdkCResult.data
 
-  return await handleApiCall(
-    sockSdk.getOrgAnalytics(time.toString()),
-    'analytics data',
-  )
+  return await handleApiCall(sockSdk.getOrgAnalytics(time.toString()), {
+    desc: 'analytics data',
+  })
 }

src/commands/analytics/fetch-repo-analytics.mts

@@ -2,20 +2,30 @@ import { handleApiCall } from '../../utils/api.mts'
 import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
+import type { SetupSdkOptions } from '../../utils/sdk.mts'
 import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
 
+export type RepoAnalyticsDataOptions = {
+  sdkOptions?: SetupSdkOptions | undefined
+}
+
 export async function fetchRepoAnalyticsData(
   repo: string,
   time: number,
+  options?: RepoAnalyticsDataOptions | undefined,
 ): Promise<CResult<SocketSdkSuccessResult<'getRepoAnalytics'>['data']>> {
-  const sockSdkCResult = await setupSdk()
+  const { sdkOptions } = {
+    __proto__: null,
+    ...options,
+  } as RepoAnalyticsDataOptions
+
+  const sockSdkCResult = await setupSdk(sdkOptions)
   if (!sockSdkCResult.ok) {
     return sockSdkCResult
   }
   const sockSdk = sockSdkCResult.data
 
-  return await handleApiCall(
-    sockSdk.getRepoAnalytics(repo, time.toString()),
-    'analytics data',
-  )
+  return await handleApiCall(sockSdk.getRepoAnalytics(repo, time.toString()), {
+    desc: 'analytics data',
+  })
 }

src/commands/audit-log/fetch-audit-log.mts

@@ -2,27 +2,38 @@ import { handleApiCall } from '../../utils/api.mts'
 import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult, OutputKind } from '../../types.mts'
+import type { SetupSdkOptions } from '../../utils/sdk.mts'
 import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
 
-export async function fetchAuditLog({
-  logType,
-  orgSlug,
-  outputKind,
-  page,
-  perPage,
-}: {
-  outputKind: OutputKind
+export type FetchAuditLogsConfig = {
+  logType: string
   orgSlug: string
+  outputKind: OutputKind
   page: number
   perPage: number
-  logType: string
-}): Promise<CResult<SocketSdkSuccessResult<'getAuditLogEvents'>['data']>> {
-  const sockSdkCResult = await setupSdk()
+}
+
+export type FetchAuditLogOptions = {
+  sdkOptions?: SetupSdkOptions | undefined
+}
+
+export async function fetchAuditLog(
+  config: FetchAuditLogsConfig,
+  options?: FetchAuditLogOptions | undefined,
+): Promise<CResult<SocketSdkSuccessResult<'getAuditLogEvents'>['data']>> {
+  const { sdkOptions } = { __proto__: null, ...options } as FetchAuditLogOptions
+
+  const sockSdkCResult = await setupSdk(sdkOptions)
   if (!sockSdkCResult.ok) {
     return sockSdkCResult
   }
   const sockSdk = sockSdkCResult.data
 
+  const { logType, orgSlug, outputKind, page, perPage } = {
+    __proto__: null,
+    ...config,
+  } as FetchAuditLogsConfig
+
   return await handleApiCall(
     sockSdk.getAuditLogEvents(orgSlug, {
       // I'm not sure this is used at all.
@@ -34,6 +45,6 @@ export async function fetchAuditLog({
       page: String(page),
       per_page: String(perPage),
     }),
-    `audit log for ${orgSlug}`,
+    { desc: `audit log for ${orgSlug}` },
   )
 }

src/commands/audit-log/handle-audit-log.mts

@@ -10,18 +10,18 @@ export async function handleAuditLog({
   page,
   perPage,
 }: {
+  logType: string
   outputKind: OutputKind
   orgSlug: string
   page: number
   perPage: number
-  logType: string
 }): Promise<void> {
   const auditLogs = await fetchAuditLog({
+    logType,
     orgSlug,
     outputKind,
     page,
     perPage,
-    logType,
   })
 
   await outputAuditLog(auditLogs, {

src/commands/audit-log/output-audit-log.mts

@@ -26,11 +26,11 @@ export async function outputAuditLog(
     page,
     perPage,
   }: {
+    logType: string
     outputKind: OutputKind
     orgSlug: string
     page: number
     perPage: number
-    logType: string
   },
 ): Promise<void> {
   if (!result.ok) {
@@ -96,10 +96,10 @@ export async function outputAsJson(
     page,
     perPage,
   }: {
+    logType: string
     orgSlug: string
     page: number
     perPage: number
-    logType: string
   },
 ): Promise<string> {
   if (!auditLogs.ok) {
@@ -112,10 +112,10 @@ export async function outputAsJson(
       desc: 'Audit logs for given query',
       // Lazily access constants.ENV.VITEST.
       generated: constants.ENV.VITEST ? REDACTED : new Date().toISOString(),
-      org: orgSlug,
       logType,
-      page,
       nextPage: auditLogs.data.nextPage,
+      org: orgSlug,
+      page,
       perPage,
       logs: auditLogs.data.results.map(log => {
         // Note: The subset is pretty arbitrary

src/commands/audit-log/output-audit-log.test.mts

@@ -25,10 +25,10 @@ describe('output-audit-log', () => {
           "data": {
             "desc": "Audit logs for given query",
             "generated": "<redacted>",
-            "org": "noorgslug",
             "logType": "",
-            "page": 1,
             "nextPage": "2",
+            "org": "noorgslug",
+            "page": 1,
             "perPage": 10,
             "logs": [
               {

src/commands/ci/fetch-default-org-slug.mts

@@ -1,38 +1,25 @@
 import { debugFn } from '@socketsecurity/registry/lib/debug'
 
-import { handleApiCall } from '../../utils/api.mts'
 import { getConfigValueOrUndef } from '../../utils/config.mts'
-import { setupSdk } from '../../utils/sdk.mts'
+import { fetchOrganization } from '../organization/fetch-organization-list.mts'
 
 import type { CResult } from '../../types.mts'
 
 // Use the config defaultOrg when set, otherwise discover from remote.
 export async function getDefaultOrgSlug(): Promise<CResult<string>> {
   const defaultOrgResult = getConfigValueOrUndef('defaultOrg')
-
   if (defaultOrgResult) {
     debugFn('notice', 'use: default org', defaultOrgResult)
     return { ok: true, data: defaultOrgResult }
   }
 
-  const sockSdkCResult = await setupSdk()
-  if (!sockSdkCResult.ok) {
-    return sockSdkCResult
-  }
-  const sockSdk = sockSdkCResult.data
-
-  const result = await handleApiCall(
-    sockSdk.getOrganizations(),
-    'list of organizations',
-  )
-
-  if (!result.ok) {
-    return result
+  const orgsCResult = await fetchOrganization()
+  if (!orgsCResult.ok) {
+    return orgsCResult
   }
 
-  const { organizations } = result.data
+  const { organizations } = orgsCResult.data
   const keys = Object.keys(organizations)
-
   if (!keys.length) {
     return {
       ok: false,
@@ -42,7 +29,6 @@ export async function getDefaultOrgSlug(): Promise<CResult<string>> {
   }
 
   const slug = (organizations as any)[keys[0]!]?.name ?? undefined
-
   if (!slug) {
     return {
       ok: false,

src/commands/ci/handle-ci.mts

@@ -11,14 +11,15 @@ export async function handleCi(autoManifest: boolean): Promise<void> {
   //   description: 'Alias for "report create --view --strict"',
   //     argv: ['report', 'create', '--view', '--strict']
   // }
-  const result = await getDefaultOrgSlug()
-  if (!result.ok) {
-    process.exitCode = result.code ?? 1
+  const orgSlugCResult = await getDefaultOrgSlug()
+  if (!orgSlugCResult.ok) {
+    process.exitCode = orgSlugCResult.code ?? 1
     // Always assume json mode.
-    logger.log(serializeResultJson(result))
+    logger.log(serializeResultJson(orgSlugCResult))
     return
   }
 
+  const orgSlug = orgSlugCResult.data
   const cwd = process.cwd()
   // Lazily access constants.SOCKET_DEFAULT_BRANCH.
   const branchName = (await gitBranch(cwd)) || constants.SOCKET_DEFAULT_BRANCH
@@ -35,7 +36,7 @@ export async function handleCi(autoManifest: boolean): Promise<void> {
     cwd,
     defaultBranch: false,
     interactive: false,
-    orgSlug: result.data,
+    orgSlug,
     outputKind: 'json',
     // When 'pendingHead' is true, it requires 'branchName' set and 'tmp' false.
     pendingHead: true,

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

@@ -1,6 +1,6 @@
-import { handleApiCall } from '../../utils/api.mts'
 import { isSupportedConfigKey } from '../../utils/config.mts'
-import { hasDefaultToken, setupSdk } from '../../utils/sdk.mts'
+import { hasDefaultToken } from '../../utils/sdk.mts'
+import { fetchOrganization } from '../organization/fetch-organization-list.mts'
 
 import type { CResult } from '../../types.mts'
 
@@ -130,54 +130,32 @@ export async function discoverConfigValue(
 async function getDefaultOrgFromToken(): Promise<
   string[] | string | undefined
 > {
-  const sockSdkCResult = await setupSdk()
-  if (!sockSdkCResult.ok) {
+  const orgsCResult = await fetchOrganization()
+  if (!orgsCResult.ok) {
     return undefined
   }
-  const sockSdk = sockSdkCResult.data
-
-  const result = await handleApiCall(
-    sockSdk.getOrganizations(),
-    'list of organizations',
-  )
-
-  if (result.ok) {
-    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
-  }
 
-  return undefined
+  const { organizations } = orgsCResult.data
+  const slugs = Array.from(Object.values(organizations)).map(o => o.slug)
+  if (slugs.length === 0) {
+    return undefined
+  }
+  if (slugs.length === 1) {
+    return slugs[0]
+  }
+  return slugs
 }
 
 async function getEnforceableOrgsFromToken(): Promise<string[] | undefined> {
-  const sockSdkCResult = await setupSdk()
-  if (!sockSdkCResult.ok) {
+  const orgsCResult = await fetchOrganization()
+  if (!orgsCResult.ok) {
     return undefined
   }
-  const sockSdk = sockSdkCResult.data
-
-  const result = await handleApiCall(
-    sockSdk.getOrganizations(),
-    'list of organizations',
-  )
-
-  if (result.ok) {
-    const arr = Array.from(Object.values(result.data.organizations)).map(
-      ({ slug }) => slug,
-    )
-    if (arr.length === 0) {
-      return undefined
-    }
-    return arr
-  }
 
-  return undefined
+  const { organizations } = orgsCResult.data
+  const slugs = Array.from(Object.values(organizations)).map(o => o.slug)
+  if (!slugs.length) {
+    return undefined
+  }
+  return slugs
 }