Skip to content

Reachability analysis improvements #709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdalton merged 6 commits into from
Aug 15, 2025
Merged

Reachability analysis improvements #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
415e3d8
use shared performReachabilityAnalysis for socket scan create --reach
mtorp Aug 15, 2025
674a3e9
add API Token Requirements to socket scan reach help description
mtorp Aug 15, 2025
1581ea3
use reachabilityReport instead of scanPaths for ReachabilityAnalysisR…
mtorp Aug 15, 2025
6821067
remove --reach-continue-on-failing-projects since it's now the defaul…
mtorp Aug 15, 2025
17030c6
upgrade coana CLI to version 14.11.10
mtorp Aug 15, 2025
1ea9f54
use the new Coana CLI flag --purl-types instead of computing --reach-…
mtorp Aug 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
"@babel/preset-typescript": "7.27.1",
"@babel/runtime": "7.28.3",
"@biomejs/biome": "2.2.0",
"@coana-tech/cli": "14.11.8",
"@coana-tech/cli": "14.11.10",
"@cyclonedx/cdxgen": "11.5.0",
"@dotenvx/dotenvx": "1.48.4",
"@eslint/compat": "1.3.2",
Expand Down
1 change: 0 additions & 1 deletion src/commands/ci/handle-ci.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ export async function handleCi(autoManifest: boolean): Promise<void> {
pullRequest: 0,
reach: {
runReachabilityAnalysis: false,
reachContinueOnFailingProjects: false,
reachDisableAnalytics: false,
reachAnalysisTimeout: 0,
reachAnalysisMemoryLimit: 0,
Expand Down
10 changes: 0 additions & 10 deletions src/commands/scan/cmd-scan-create.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,6 @@ async function run(
reach,
reachAnalysisMemoryLimit,
reachAnalysisTimeout,
reachContinueOnFailingProjects,
reachDisableAnalytics,
readOnly,
setAsAlertsPage: pendingHeadFlag,
Expand All @@ -241,7 +240,6 @@ async function run(
reach: boolean
reachAnalysisTimeout: number
reachAnalysisMemoryLimit: number
reachContinueOnFailingProjects: boolean
reachDisableAnalytics: boolean
}

Expand Down Expand Up @@ -467,13 +465,6 @@ async function run(
message: 'The --reachEcosystems flag requires --reach to be set',
fail: 'missing --reach flag',
},
{
nook: true,
test: reach || !reachContinueOnFailingProjects,
message:
'The --reachContinueOnFailingProjects flag requires --reach to be set',
fail: 'missing --reach flag',
},
{
nook: true,
test: reach || !reachExcludePaths.length,
Expand Down Expand Up @@ -505,7 +496,6 @@ async function run(
pullRequest: Number(pullRequest),
reach: {
runReachabilityAnalysis: Boolean(reach),
reachContinueOnFailingProjects: Boolean(reachContinueOnFailingProjects),
reachDisableAnalytics: Boolean(reachDisableAnalytics),
reachAnalysisTimeout: Number(reachAnalysisTimeout),
reachAnalysisMemoryLimit: Number(reachAnalysisMemoryLimit),
Expand Down
65 changes: 0 additions & 65 deletions src/commands/scan/cmd-scan-create.test.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ describe('socket scan create', async () => {
Reachability Options (when --reach is used)
--reach-analysis-memory-limit The maximum memory in MB to use for the reachability analysis. The default is 8192MB.
--reach-analysis-timeout Set timeout for the reachability analysis. Split analysis runs may cause the total scan time to exceed this timeout significantly.
--reach-continue-on-failing-projects Continue reachability analysis even when some projects/workspaces fail. Default is to crash the CLI at the first failing project/workspace.
--reach-disable-analytics Disable reachability analytics sharing with Socket. Also disables caching-based optimizations.
--reach-ecosystems List of ecosystems to conduct reachability analysis on, as either a comma separated value or as multiple flags. Defaults to all ecosystems.
--reach-exclude-paths List of paths to exclude from reachability analysis, as either a comma separated value or as multiple flags.
Expand Down Expand Up @@ -285,37 +284,6 @@ describe('socket scan create', async () => {
},
)

cmdit(
[
'scan',
'create',
'--org',
'fakeOrg',
'target',
'--dry-run',
'--repo',
'xyz',
'--branch',
'abc',
'--reach-continue-on-failing-projects',
'--config',
'{"apiToken":"fakeToken"}',
],
'should fail when --reach-continue-on-failing-projects is used without --reach',
async cmd => {
const { code, stderr, stdout } = await invokeNpm(binCliPath, cmd)
const output = stdout + stderr
expect(output).toContain(
'The --reachContinueOnFailingProjects flag requires --reach to be set',
)
expect(output).toContain('missing --reach flag')
expect(
code,
'should exit with non-zero code when validation fails',
).not.toBe(0)
},
)

cmdit(
[
'scan',
Expand Down Expand Up @@ -394,39 +362,6 @@ describe('socket scan create', async () => {
'--branch',
'abc',
'--reach',
'--reach-continue-on-failing-projects',
'--reach-disable-analytics',
'--reach-analysis-memory-limit',
'4096',
'--reach-analysis-timeout',
'3600',
'--reach-ecosystems',
'npm',
'--config',
'{"apiToken":"fakeToken"}',
],
'should succeed when all reachability options including reachContinueOnFailingProjects are used with --reach',
async cmd => {
const { code, stdout } = await invokeNpm(binCliPath, cmd)
expect(stdout).toMatchInlineSnapshot(`"[DryRun]: Bailing now"`)
expect(code, 'should exit with code 0 when all flags are valid').toBe(0)
},
)

cmdit(
[
'scan',
'create',
'--org',
'fakeOrg',
'target',
'--dry-run',
'--repo',
'xyz',
'--branch',
'abc',
'--reach',
'--reach-continue-on-failing-projects',
'--reach-disable-analytics',
'--reach-analysis-memory-limit',
'4096',
Expand Down
7 changes: 4 additions & 3 deletions src/commands/scan/cmd-scan-reach.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ const config: CliCommandConfig = {
Usage
$ ${command} [options] [CWD=.]

API Token Requirements
- Quota: 1 unit
- Permissions: full-scans:create
Copy link
Contributor

@jdalton jdalton Aug 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

☝️ I love the permission requirements but... I'll try to add that to the error messages too.


Options
${getFlagListOutput(generalFlags)}

Expand Down Expand Up @@ -96,7 +100,6 @@ async function run(
org: orgFlag,
reachAnalysisMemoryLimit,
reachAnalysisTimeout,
reachContinueOnFailingProjects,
reachDisableAnalytics,
} = cli.flags as {
cwd: string
Expand All @@ -106,7 +109,6 @@ async function run(
org: string
reachAnalysisTimeout: number
reachAnalysisMemoryLimit: number
reachContinueOnFailingProjects: boolean
reachDisableAnalytics: boolean
}

Expand Down Expand Up @@ -183,7 +185,6 @@ async function run(
targets,
interactive,
reachabilityOptions: {
reachContinueOnFailingProjects: Boolean(reachContinueOnFailingProjects),
reachDisableAnalytics: Boolean(reachDisableAnalytics),
reachAnalysisTimeout: Number(reachAnalysisTimeout),
reachAnalysisMemoryLimit: Number(reachAnalysisMemoryLimit),
Expand Down
25 changes: 4 additions & 21 deletions src/commands/scan/cmd-scan-reach.test.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ describe('socket scan reach', async () => {
Usage
$ socket scan reach [options] [CWD=.]

API Token Requirements
- Quota: 1 unit
- Permissions: full-scans:create

Options
--cwd working directory, defaults to process.cwd()
--json Output result as json
Expand All @@ -27,7 +31,6 @@ describe('socket scan reach', async () => {
Reachability Options
--reach-analysis-memory-limit The maximum memory in MB to use for the reachability analysis. The default is 8192MB.
--reach-analysis-timeout Set timeout for the reachability analysis. Split analysis runs may cause the total scan time to exceed this timeout significantly.
--reach-continue-on-failing-projects Continue reachability analysis even when some projects/workspaces fail. Default is to crash the CLI at the first failing project/workspace.
--reach-disable-analytics Disable reachability analytics sharing with Socket. Also disables caching-based optimizations.
--reach-ecosystems List of ecosystems to conduct reachability analysis on, as either a comma separated value or as multiple flags. Defaults to all ecosystems.
--reach-exclude-paths List of paths to exclude from reachability analysis, as either a comma separated value or as multiple flags.
Expand Down Expand Up @@ -206,25 +209,6 @@ describe('socket scan reach', async () => {
},
)

cmdit(
[
'scan',
'reach',
'--dry-run',
'--reach-continue-on-failing-projects',
'--org',
'fakeOrg',
'--config',
'{"apiToken":"fakeToken"}',
],
'should accept --reach-continue-on-failing-projects flag',
async cmd => {
const { code, stdout } = await invokeNpm(binCliPath, cmd)
expect(stdout).toMatchInlineSnapshot(`"[DryRun]: Bailing now"`)
expect(code, 'should exit with code 0').toBe(0)
},
)

cmdit(
[
'scan',
Expand Down Expand Up @@ -279,7 +263,6 @@ describe('socket scan reach', async () => {
'3600',
'--reach-ecosystems',
'npm,pypi',
'--reach-continue-on-failing-projects',
'--reach-exclude-paths',
'node_modules,dist',
'--org',
Expand Down
1 change: 0 additions & 1 deletion src/commands/scan/create-scan-from-github.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,6 @@ async function scanOneRepo(
pullRequest: 0,
reach: {
runReachabilityAnalysis: false,
reachContinueOnFailingProjects: false,
reachDisableAnalytics: false,
reachAnalysisTimeout: 0,
reachAnalysisMemoryLimit: 0,
Expand Down
Loading
Loading