-
Notifications
You must be signed in to change notification settings - Fork 41
Expand file tree
/
Copy pathcoana-fix.mts
More file actions
449 lines (398 loc) · 13.3 KB
/
coana-fix.mts
File metadata and controls
449 lines (398 loc) · 13.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
import path from 'node:path'
import { joinAnd } from '@socketsecurity/registry/lib/arrays'
import { debugDir, debugFn } from '@socketsecurity/registry/lib/debug'
import { logger } from '@socketsecurity/registry/lib/logger'
import { pluralize } from '@socketsecurity/registry/lib/words'
import {
checkCiEnvVars,
getCiEnvInstructions,
getFixEnv,
} from './env-helpers.mts'
import { getSocketFixBranchName, getSocketFixCommitMessage } from './git.mts'
import { getSocketFixPrs, openSocketFixPr } from './pull-request.mts'
import { FLAG_DRY_RUN, GQL_PR_STATE_OPEN } from '../../constants.mts'
import { handleApiCall } from '../../utils/api.mts'
import { cmdFlagValueToArray } from '../../utils/cmd.mts'
import { spawnCoanaDlx } from '../../utils/dlx.mts'
import { getErrorCause } from '../../utils/errors.mts'
import {
gitCheckoutBranch,
gitCommit,
gitCreateBranch,
gitDeleteBranch,
gitPushBranch,
gitRemoteBranchExists,
gitResetAndClean,
gitUnstagedModifiedFiles,
} from '../../utils/git.mts'
import {
enablePrAutoMerge,
fetchGhsaDetails,
setGitRemoteGithubRepoUrl,
} from '../../utils/github.mts'
import { getPackageFilesForScan } from '../../utils/path-resolve.mts'
import { setupSdk } from '../../utils/sdk.mts'
import { fetchSupportedScanFileNames } from '../scan/fetch-supported-scan-file-names.mts'
import type { FixConfig } from './types.mts'
import type { CResult } from '../../types.mts'
export async function coanaFix(
fixConfig: FixConfig,
): Promise<CResult<{ fixed: boolean }>> {
const {
applyFixes,
autopilot,
cwd,
disableMajorUpdates,
exclude,
ghsas,
include,
limit,
minimumReleaseAge,
orgSlug,
outputFile,
showAffectedDirectDependencies,
spinner,
} = fixConfig
const fixEnv = await getFixEnv()
debugDir('inspect', { fixEnv })
spinner?.start()
const sockSdkCResult = await setupSdk()
if (!sockSdkCResult.ok) {
return sockSdkCResult
}
const sockSdk = sockSdkCResult.data
const supportedFilesCResult = await fetchSupportedScanFileNames({ spinner })
if (!supportedFilesCResult.ok) {
return supportedFilesCResult
}
const supportedFiles = supportedFilesCResult.data
const scanFilepaths = await getPackageFilesForScan(['.'], supportedFiles, {
cwd,
})
const uploadCResult = await handleApiCall(
sockSdk.uploadManifestFiles(orgSlug, scanFilepaths),
{
description: 'upload manifests',
spinner,
},
)
if (!uploadCResult.ok) {
return uploadCResult
}
const tarHash: string = (uploadCResult as any).data.tarHash
if (!tarHash) {
spinner?.stop()
return {
ok: false,
message:
'No tar hash returned from Socket API upload-manifest-files endpoint',
data: uploadCResult.data,
}
}
const isAll =
!ghsas.length ||
(ghsas.length === 1 && (ghsas[0] === 'all' || ghsas[0] === 'auto'))
const shouldOpenPrs = fixEnv.isCi && fixEnv.repoInfo
if (!shouldOpenPrs) {
// Inform user about local mode when fixes will be applied.
if (applyFixes && ghsas.length) {
const envCheck = checkCiEnvVars()
if (envCheck.present.length) {
// Some CI vars are set but not all - show what's missing.
if (envCheck.missing.length) {
logger.info(
'Running in local mode - fixes will be applied directly to your working directory.\n' +
`Missing environment variables for PR creation: ${joinAnd(envCheck.missing)}`,
)
}
} else {
// No CI vars are present - show general local mode message.
logger.info(
'Running in local mode - fixes will be applied directly to your working directory.\n' +
getCiEnvInstructions(),
)
}
}
const ids = isAll ? ['all'] : ghsas.slice(0, limit)
if (!ids.length) {
spinner?.stop()
return { ok: true, data: { fixed: false } }
}
const fixCResult = await spawnCoanaDlx(
[
'compute-fixes-and-upgrade-purls',
cwd,
'--manifests-tar-hash',
tarHash,
'--apply-fixes-to',
...(isAll ? ['all'] : ghsas),
...(fixConfig.rangeStyle
? ['--range-style', fixConfig.rangeStyle]
: []),
...(minimumReleaseAge
? ['--minimum-release-age', minimumReleaseAge]
: []),
...(include.length ? ['--include', ...include] : []),
...(exclude.length ? ['--exclude', ...exclude] : []),
...(!applyFixes ? [FLAG_DRY_RUN] : []),
...(outputFile ? ['--output-file', outputFile] : []),
...(disableMajorUpdates ? ['--disable-major-updates'] : []),
...(showAffectedDirectDependencies
? ['--show-affected-direct-dependencies']
: []),
...fixConfig.unknownFlags,
],
fixConfig.orgSlug,
{ cwd, spinner, stdio: 'inherit' },
)
spinner?.stop()
return fixCResult.ok ? { ok: true, data: { fixed: true } } : fixCResult
}
// Adjust limit based on open Socket Fix PRs.
let adjustedLimit = limit
if (shouldOpenPrs && fixEnv.repoInfo) {
try {
const openPrs = await getSocketFixPrs(
fixEnv.repoInfo.owner,
fixEnv.repoInfo.repo,
{ states: GQL_PR_STATE_OPEN },
)
const openPrCount = openPrs.length
// Reduce limit by number of open PRs to avoid creating too many.
adjustedLimit = Math.max(0, limit - openPrCount)
if (openPrCount > 0) {
debugFn(
'notice',
`limit: adjusted from ${limit} to ${adjustedLimit} (${openPrCount} open Socket Fix ${pluralize('PR', openPrCount)}`,
)
}
} catch (e) {
debugFn('warn', 'Failed to count open PRs, using original limit')
debugDir('error', e)
}
}
const shouldSpawnCoana = adjustedLimit > 0
let ids: string[] | undefined
if (shouldSpawnCoana && isAll) {
const foundCResult = await spawnCoanaDlx(
[
'compute-fixes-and-upgrade-purls',
cwd,
'--manifests-tar-hash',
tarHash,
...(fixConfig.rangeStyle
? ['--range-style', fixConfig.rangeStyle]
: []),
...(minimumReleaseAge
? ['--minimum-release-age', minimumReleaseAge]
: []),
...(include.length ? ['--include', ...include] : []),
...(exclude.length ? ['--exclude', ...exclude] : []),
...(disableMajorUpdates ? ['--disable-major-updates'] : []),
...(showAffectedDirectDependencies
? ['--show-affected-direct-dependencies']
: []),
...fixConfig.unknownFlags,
],
fixConfig.orgSlug,
{ cwd, spinner },
)
if (foundCResult.ok) {
const foundIds = cmdFlagValueToArray(
/(?<=Vulnerabilities found:).*/.exec(foundCResult.data),
)
ids = foundIds.slice(0, adjustedLimit)
}
} else if (shouldSpawnCoana) {
ids = ghsas.slice(0, adjustedLimit)
}
if (!ids?.length) {
debugFn('notice', 'miss: no GHSA IDs to process')
}
if (!fixEnv.repoInfo) {
debugFn('notice', 'miss: no repo info detected')
}
if (!ids?.length || !fixEnv.repoInfo) {
spinner?.stop()
return { ok: true, data: { fixed: false } }
}
debugFn('notice', `fetch: ${ids.length} GHSA details for ${joinAnd(ids)}`)
const ghsaDetails = await fetchGhsaDetails(ids)
const scanBaseNames = new Set(scanFilepaths.map(p => path.basename(p)))
debugFn('notice', `found: ${ghsaDetails.size} GHSA details`)
let count = 0
let overallFixed = false
// Process each GHSA ID individually.
ghsaLoop: for (let i = 0, { length } = ids; i < length; i += 1) {
const ghsaId = ids[i]!
debugFn('notice', `check: ${ghsaId}`)
// Apply fix for single GHSA ID.
// eslint-disable-next-line no-await-in-loop
const fixCResult = await spawnCoanaDlx(
[
'compute-fixes-and-upgrade-purls',
cwd,
'--manifests-tar-hash',
tarHash,
'--apply-fixes-to',
ghsaId,
...(fixConfig.rangeStyle
? ['--range-style', fixConfig.rangeStyle]
: []),
...(minimumReleaseAge
? ['--minimum-release-age', minimumReleaseAge]
: []),
...(include.length ? ['--include', ...include] : []),
...(exclude.length ? ['--exclude', ...exclude] : []),
...(disableMajorUpdates ? ['--disable-major-updates'] : []),
...(showAffectedDirectDependencies
? ['--show-affected-direct-dependencies']
: []),
...fixConfig.unknownFlags,
],
fixConfig.orgSlug,
{ cwd, spinner, stdio: 'inherit' },
)
if (!fixCResult.ok) {
logger.error(`Update failed for ${ghsaId}: ${getErrorCause(fixCResult)}`)
continue ghsaLoop
}
// Check for modified files after applying the fix.
// eslint-disable-next-line no-await-in-loop
const unstagedCResult = await gitUnstagedModifiedFiles(cwd)
const modifiedFiles = unstagedCResult.ok
? unstagedCResult.data.filter(relPath =>
scanBaseNames.has(path.basename(relPath)),
)
: []
if (!modifiedFiles.length) {
debugFn('notice', `skip: no changes for ${ghsaId}`)
continue ghsaLoop
}
overallFixed = true
const branch = getSocketFixBranchName(ghsaId)
try {
// Check if branch already exists.
// eslint-disable-next-line no-await-in-loop
if (await gitRemoteBranchExists(branch, cwd)) {
debugFn('notice', `skip: remote branch "${branch}" exists`)
continue ghsaLoop
}
debugFn('notice', `pr: creating for ${ghsaId}`)
const details = ghsaDetails.get(ghsaId)
debugFn(
'notice',
`ghsa: ${ghsaId} details ${details ? 'found' : 'missing'}`,
)
const pushed =
// eslint-disable-next-line no-await-in-loop
(await gitCreateBranch(branch, cwd)) &&
// eslint-disable-next-line no-await-in-loop
(await gitCheckoutBranch(branch, cwd)) &&
// eslint-disable-next-line no-await-in-loop
(await gitCommit(
getSocketFixCommitMessage(ghsaId, details),
modifiedFiles,
{
cwd,
email: fixEnv.gitEmail,
user: fixEnv.gitUser,
},
)) &&
// eslint-disable-next-line no-await-in-loop
(await gitPushBranch(branch, cwd))
if (!pushed) {
logger.warn(`Push failed for ${ghsaId}, skipping PR creation.`)
// eslint-disable-next-line no-await-in-loop
await gitResetAndClean(fixEnv.baseBranch, cwd)
// eslint-disable-next-line no-await-in-loop
await gitCheckoutBranch(fixEnv.baseBranch, cwd)
// eslint-disable-next-line no-await-in-loop
await gitDeleteBranch(branch, cwd)
continue ghsaLoop
}
// Set up git remote.
if (!fixEnv.githubToken) {
logger.error(
'Cannot create pull request: SOCKET_CLI_GITHUB_TOKEN environment variable is not set.\n' +
'Set SOCKET_CLI_GITHUB_TOKEN or GITHUB_TOKEN to enable PR creation.',
)
// eslint-disable-next-line no-await-in-loop
await gitResetAndClean(fixEnv.baseBranch, cwd)
// eslint-disable-next-line no-await-in-loop
await gitCheckoutBranch(fixEnv.baseBranch, cwd)
// eslint-disable-next-line no-await-in-loop
await gitDeleteBranch(branch, cwd)
continue ghsaLoop
}
// eslint-disable-next-line no-await-in-loop
await setGitRemoteGithubRepoUrl(
fixEnv.repoInfo.owner,
fixEnv.repoInfo.repo,
fixEnv.githubToken,
cwd,
)
// eslint-disable-next-line no-await-in-loop
const prResponse = await openSocketFixPr(
fixEnv.repoInfo.owner,
fixEnv.repoInfo.repo,
branch,
// Single GHSA ID.
[ghsaId],
{
baseBranch: fixEnv.baseBranch,
cwd,
ghsaDetails,
},
)
if (prResponse) {
const { data } = prResponse
const prRef = `PR #${data.number}`
logger.success(`Opened ${prRef} for ${ghsaId}.`)
if (autopilot) {
logger.indent()
spinner?.indent()
// eslint-disable-next-line no-await-in-loop
const { details, enabled } = await enablePrAutoMerge(data)
if (enabled) {
logger.info(`Auto-merge enabled for ${prRef}.`)
} else {
const message = `Failed to enable auto-merge for ${prRef}${
details ? `:\n${details.map(d => ` - ${d}`).join('\n')}` : '.'
}`
logger.error(message)
}
logger.dedent()
spinner?.dedent()
}
}
// Reset back to base branch for next iteration.
// eslint-disable-next-line no-await-in-loop
await gitResetAndClean(branch, cwd)
// eslint-disable-next-line no-await-in-loop
await gitCheckoutBranch(fixEnv.baseBranch, cwd)
} catch (e) {
logger.warn(
`Unexpected condition: Push failed for ${ghsaId}, skipping PR creation.`,
)
debugDir('error', e)
// eslint-disable-next-line no-await-in-loop
await gitResetAndClean(fixEnv.baseBranch, cwd)
// eslint-disable-next-line no-await-in-loop
await gitCheckoutBranch(fixEnv.baseBranch, cwd)
}
count += 1
debugFn(
'notice',
`increment: count ${count}/${Math.min(adjustedLimit, ids.length)}`,
)
if (count >= adjustedLimit) {
break ghsaLoop
}
}
spinner?.stop()
return {
ok: true,
data: { fixed: overallFixed },
}
}