feat(scan): add --workspace flag to scan create command

Author: jdalton

packages/cli/src/commands/scan/cmd-scan-create.mts

@@ -75,6 +75,7 @@ interface ScanCreateFlags {
   reportLevel: REPORT_LEVEL
   setAsAlertsPage: boolean
   tmp: boolean
+  workspace: string
 }
 
 export const CMD_NAME = 'create'
@@ -190,6 +191,12 @@ const generalFlags: MeowFlags = {
       'Set the visibility (true/false) of the scan in your dashboard.',
     shortFlag: 't',
   },
+  workspace: {
+    type: 'string',
+    default: '',
+    description:
+      'The workspace in the Socket Organization that the repository is in to associate with the full scan.',
+  },
 }
 
 export const cmdScanCreate = {
@@ -320,6 +327,7 @@ async function run(
     branch: branchName,
     repo: repoName,
     report,
+    workspace,
   } = cli.flags as unknown as ScanCreateFlags
 
   let { 0: orgSlug } = await determineOrgSlug(
@@ -364,6 +372,10 @@ async function run(
       repoName = await getRepoName(cwd)
     }
   }
+  if (!workspace && sockJson.defaults?.scan?.create?.workspace) {
+    workspace = sockJson.defaults.scan.create.workspace
+    logger.info(`Using default --workspace from ${SOCKET_JSON}:`, workspace)
+  }
   if (typeof report !== 'boolean') {
     if (sockJson.defaults?.scan?.create?.report !== undefined) {
       report = sockJson.defaults.scan.create.report
@@ -656,5 +668,6 @@ async function run(
     reportLevel,
     targets,
     tmp: Boolean(tmp),
+    workspace: (workspace && String(workspace)) || '',
   })
 }

packages/cli/src/commands/scan/fetch-create-org-full-scan.mts

@@ -14,6 +14,7 @@ export type FetchCreateOrgFullScanConfigs = {
   pullRequest: number
   repoName: string
   scanType: string | undefined
+  workspace?: string | undefined
 }
 
 export type FetchCreateOrgFullScanOptions = {
@@ -40,6 +41,7 @@ export async function fetchCreateOrgFullScan(
     pullRequest,
     repoName,
     scanType,
+    workspace,
   } = { __proto__: null, ...config } as FetchCreateOrgFullScanConfigs
 
   const {
@@ -71,6 +73,7 @@ export async function fetchCreateOrgFullScan(
       ...(pullRequest ? { pull_request: String(pullRequest) } : {}),
       ...(repoName ? { repo: repoName } : {}),
       ...(scanType ? { scan_type: scanType } : {}),
+      ...(workspace ? { workspace } : {}),
       ...(pendingHead !== undefined
         ? { set_as_pending_head: Boolean(pendingHead) }
         : {}),

packages/cli/src/commands/scan/handle-create-new-scan.mts

@@ -68,6 +68,7 @@ export type HandleCreateNewScanConfig = {
   reportLevel: REPORT_LEVEL
   targets: string[]
   tmp: boolean
+  workspace?: string | undefined
 }
 
 export async function handleCreateNewScan({
@@ -91,8 +92,12 @@ export async function handleCreateNewScan({
   reportLevel,
   targets,
   tmp,
+  workspace,
 }: HandleCreateNewScanConfig): Promise<void> {
-  debug('notice', `Creating new scan for ${orgSlug}/${repoName}`)
+  debug(
+    'notice',
+    `Creating new scan for ${orgSlug}/${workspace ? `${workspace}/` : ''}${repoName}`,
+  )
   debugDir('inspect', {
     autoManifest,
     branchName,
@@ -106,6 +111,7 @@ export async function handleCreateNewScan({
     reportLevel,
     targets,
     tmp,
+    workspace,
   })
 
   if (autoManifest) {
@@ -288,6 +294,7 @@ export async function handleCreateNewScan({
       scanType: reach.runReachabilityAnalysis
         ? SCAN_TYPE_SOCKET_TIER1
         : SCAN_TYPE_SOCKET,
+      workspace,
     },
     {
       cwd,

packages/cli/src/commands/scan/setup-scan-config.mts

@@ -9,6 +9,7 @@ import { SOCKET_JSON } from '../../constants/paths.mts'
 import {
   detectDefaultBranch,
   getRepoName,
+  getRepoOwner,
   gitBranch,
 } from '../../utils/git/operations.mjs'
 import {
@@ -156,6 +157,21 @@ async function configureScan(
     delete config.repo
   }
 
+  const defaultWorkspace = await input({
+    message:
+      '(--workspace) The workspace in the Socket Organization that the repository is in to associate with the full scan.',
+    default: config.workspace || (await getRepoOwner(cwd)) || '',
+    required: false,
+  })
+  if (defaultWorkspace === undefined) {
+    return canceledByUser()
+  }
+  if (defaultWorkspace) {
+    config.workspace = defaultWorkspace
+  } else {
+    delete config.workspace
+  }
+
   const defaultBranchName = await input({
     message:
       '(--branch) What branch name (slug) should be reported to Socket for this dir?',

packages/cli/src/utils/socket/json.mts

@@ -69,9 +69,10 @@ export interface SocketJson {
     scan?: {
       create?: {
         autoManifest?: boolean | undefined
+        branch?: string | undefined
         repo?: string | undefined
         report?: boolean | undefined
-        branch?: string | undefined
+        workspace?: string | undefined
       }
       github?: {
         all?: boolean | undefined