@@ -2,179 +2,66 @@ import { debugDir, debugFn } from '@socketsecurity/registry/lib/debug'
22import { logger } from '@socketsecurity/registry/lib/logger'
33
44import constants from '../../constants.mts'
5- import { handleApiCallNoSpinner , queryApiSafeText } from '../../utils/api.mts'
5+ import { queryApiSafeText } from '../../utils/api.mts'
66import { formatErrorWithDetail } from '../../utils/errors.mts'
7- import { setupSdk } from '../../utils/sdk.mts'
87
98import type { CResult } from '../../types.mts'
109import type { SocketArtifact } from '../../utils/alert/artifact.mts'
11- import type { SetupSdkOptions } from '../../utils/sdk.mts'
12- import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
1310
1411export type FetchScanData = {
1512 includeLicensePolicy ?: boolean | undefined
16- sdkOpts ?: SetupSdkOptions | undefined
1713}
1814
19- /**
20- * This fetches all the relevant pieces of data to generate a report, given a
21- * full scan ID.
22- */
15+ /** Fetch the scan data needed to generate a report. */
2316export async function fetchScanData (
2417 orgSlug : string ,
2518 scanId : string ,
2619 options ?: FetchScanData | undefined ,
27- ) : Promise <
28- CResult < {
29- scan : SocketArtifact [ ]
30- securityPolicy : SocketSdkSuccessResult < 'getOrgSecurityPolicy' > [ 'data' ]
31- } >
32- > {
33- const { includeLicensePolicy, sdkOpts } = {
34- __proto__ : null ,
35- ...options ,
36- } as FetchScanData
37- const sockSdkCResult = await setupSdk ( sdkOpts )
38- if ( ! sockSdkCResult . ok ) {
39- return sockSdkCResult
40- }
41- const sockSdk = sockSdkCResult . data
42-
43- let policyStatus = 'requested...'
44- let scanStatus = 'requested...'
45- let finishedFetching = false
46-
20+ ) : Promise < CResult < { scan : SocketArtifact [ ] } > > {
4721 const { spinner } = constants
22+ spinner . start ( 'Scan result: requested...' )
4823
49- function updateScan ( status : string ) {
50- scanStatus = status
51- updateProgress ( )
52- }
53-
54- function updatePolicy ( status : string ) {
55- policyStatus = status
56- updateProgress ( )
57- }
58-
59- function updateProgress ( ) {
60- if ( finishedFetching ) {
61- spinner . stop ( )
62- logger . info (
63- `Scan result: ${ scanStatus } . Security policy: ${ policyStatus } .` ,
64- )
65- } else {
66- spinner . start (
67- `Scan result: ${ scanStatus } . Security policy: ${ policyStatus } .` ,
68- )
69- }
70- }
71-
72- async function fetchScanResult ( ) : Promise < CResult < SocketArtifact [ ] > > {
24+ try {
7325 const result = await queryApiSafeText (
74- `orgs/${ orgSlug } /full-scans/${ encodeURIComponent ( scanId ) } ${ includeLicensePolicy ? '?include_license_details=true' : '' } ` ,
26+ `orgs/${ orgSlug } /full-scans/${ encodeURIComponent ( scanId ) } ${ options ?. includeLicensePolicy ? '?include_license_details=true' : '' } ` ,
7527 )
7628
77- updateScan ( `response received` )
78-
7929 if ( ! result . ok ) {
30+ spinner . stop ( )
31+ logger . info ( 'Scan result: request failed.' )
8032 return result
8133 }
8234
83- const ndJsonString = result . data
84-
85- // This is nd-json; each line is a json object.
86- const lines = ndJsonString . split ( '\n' ) . filter ( Boolean )
87- let ok = true
88- const data = lines . map ( line => {
35+ const data : SocketArtifact [ ] = [ ]
36+ for ( const line of result . data . split ( '\n' ) . filter ( Boolean ) ) {
8937 try {
90- return JSON . parse ( line )
91- } catch ( e ) {
92- ok = false
38+ data . push ( JSON . parse ( line ) )
39+ } catch ( error ) {
9340 debugFn ( 'error' , 'Failed to parse report data line as JSON' )
94- debugDir ( 'error' , { error : e , line } )
95- return
41+ debugDir ( 'error' , { error, line } )
42+ spinner . stop ( )
43+ logger . info ( 'Scan result: received invalid JSON response.' )
44+ return {
45+ ok : false ,
46+ message : 'Invalid Socket API response' ,
47+ cause :
48+ 'The Socket API responded with at least one line that was not valid JSON. Please report if this persists.' ,
49+ }
9650 }
97- } ) as unknown as SocketArtifact [ ]
98-
99- if ( ok ) {
100- updateScan ( 'success' )
101- return { ok : true , data }
10251 }
10352
104- updateScan ( 'received invalid JSON response' )
105-
53+ spinner . stop ( )
54+ logger . info ( 'Scan result: success.' )
55+ return { ok : true , data : { scan : data } }
56+ } catch ( error ) {
57+ spinner . stop ( )
58+ logger . info ( 'Scan result: request failed.' )
10659 return {
10760 ok : false ,
108- message : 'Invalid Socket API response ' ,
61+ message : 'Socket API error ' ,
10962 cause :
110- 'The Socket API responded with at least one line that was not valid JSON. Please report if this persists.' ,
63+ formatErrorWithDetail ( 'Error requesting scan' , error ) ||
64+ 'Error requesting scan: (no error message found)' ,
11165 }
11266 }
113-
114- async function fetchSecurityPolicy ( ) : Promise <
115- CResult < SocketSdkSuccessResult < 'getOrgSecurityPolicy' > [ 'data' ] >
116- > {
117- const result = await handleApiCallNoSpinner (
118- sockSdk . getOrgSecurityPolicy ( orgSlug ) ,
119- 'GetOrgSecurityPolicy' ,
120- )
121-
122- updatePolicy ( 'received policy' )
123-
124- return result
125- }
126-
127- updateProgress ( )
128-
129- const [ scan , securityPolicy ] : [
130- CResult < SocketArtifact [ ] > ,
131- CResult < SocketSdkSuccessResult < 'getOrgSecurityPolicy' > [ 'data' ] > ,
132- ] = await Promise . all ( [
133- fetchScanResult ( ) . catch ( e => {
134- updateScan ( 'failure; unknown blocking error occurred' )
135- return {
136- ok : false as const ,
137- message : 'Socket API error' ,
138- cause :
139- formatErrorWithDetail ( 'Error requesting scan' , e ) ||
140- 'Error requesting scan: (no error message found)' ,
141- }
142- } ) ,
143- fetchSecurityPolicy ( ) . catch ( e => {
144- updatePolicy ( 'failure; unknown blocking error occurred' )
145- return {
146- ok : false as const ,
147- message : 'Socket API error' ,
148- cause :
149- formatErrorWithDetail ( 'Error requesting policy' , e ) ||
150- 'Error requesting policy: (no error message found)' ,
151- }
152- } ) ,
153- ] ) . finally ( ( ) => {
154- finishedFetching = true
155- updateProgress ( )
156- } )
157-
158- if ( ! scan . ok ) {
159- return scan
160- }
161- if ( ! securityPolicy . ok ) {
162- return securityPolicy
163- }
164-
165- if ( ! Array . isArray ( scan . data ) ) {
166- return {
167- ok : false ,
168- message : 'Failed to fetch' ,
169- cause : 'Was unable to fetch scan result, bailing' ,
170- }
171- }
172-
173- return {
174- ok : true ,
175- data : {
176- scan : scan . data satisfies SocketArtifact [ ] ,
177- securityPolicy : securityPolicy . data ,
178- } ,
179- }
18067}
0 commit comments