Merge pull request #45 from Br3nd3n/do-not-stop-on-failed-comment

Fix for minor issues after production testing 🔥
AikidoSec · Apr 5, 2024 · 1c1bbfb · 1c1bbfb
2 parents ef53d55 + 221678b
commit 1c1bbfb
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 21 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -283,7 +283,7 @@ async function createReviewComments(secretKey, scanId) {
             path: finding.file,
             line: finding.end_line,
             start_line: finding.start_line,
-            body: `${finding.title}\n${finding.description}\n**Remediation:** ${finding.remediation}\n**Details**: [View details](https://app.aikido.dev/featurebranch/scan/${scanId})`
+            body: `${finding.title}\n${finding.description}\n**Remediation:** ${finding.remediation}\n**Aikido Security:**: [View details](https://app.aikido.dev/featurebranch/scan/${scanId}?groupId=${findingResponse.group_id})`
         }));
         if (findings.length > 0) {
             await (0, postReviewComment_1.postFindingsAsReviewComments)(findings);
@@ -485,15 +485,25 @@ const postFindingsAsReviewComments = async (findings) => {
             existingFinding = comment;
         }
         if (typeof existingFinding === 'undefined') {
-            await octokit.rest.pulls.createReviewComment({
-                ...context.repo,
-                pull_number: pullRequestNumber,
-                commit_id: finding.commit_id,
-                path: finding.path,
-                body: finding.body,
-                line: finding.line,
-                ...(finding.start_line != finding.line) && { start_line: finding.start_line }
-            });
+            try {
+                await octokit.rest.pulls.createReviewComment({
+                    ...context.repo,
+                    pull_number: pullRequestNumber,
+                    commit_id: finding.commit_id,
+                    path: finding.path,
+                    body: finding.body,
+                    line: finding.line,
+                    ...(finding.start_line != finding.line) && { start_line: finding.start_line }
+                });
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    core.info(`unable to post scan status comment due to error: ${error.message}. Tried posting ${JSON.stringify(finding)}`);
+                }
+                else {
+                    core.info(`unable to post scan status comment due to unknown error`);
+                }
+            }
         }
     }
 };

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/api.ts b/src/api.ts
@@ -25,6 +25,7 @@ export type GetScanStatusResponse =
 
 export type GetScanFindingsResponse =
 		{
+			group_id: number,
 			start_commit_id?: string,
 			end_commit_id: string,
 			introduced_sast_issues: [

diff --git a/src/main.ts b/src/main.ts
@@ -204,7 +204,7 @@ async function createReviewComments(secretKey: string, scanId: number): Promise<
 				path: finding.file,
 				line: finding.end_line,
 				start_line: finding.start_line,
-				body: `${finding.title}\n${finding.description}\n**Remediation:** ${finding.remediation}\n**Details**: [View details](https://app.aikido.dev/featurebranch/scan/${scanId})`
+				body: `${finding.title}\n${finding.description}\n**Remediation:** ${finding.remediation}\n**Aikido Security:**: [View details](https://app.aikido.dev/featurebranch/scan/${scanId}?groupId=${findingResponse.group_id})`
 			}
 		))
 

diff --git a/src/postReviewComment.ts b/src/postReviewComment.ts
@@ -66,15 +66,24 @@ export const postFindingsAsReviewComments = async (findings: TFinding[]): Promis
 		}
 
 		if (typeof existingFinding === 'undefined') {
-			await octokit.rest.pulls.createReviewComment({
-				...context.repo,
-				pull_number: pullRequestNumber,
-				commit_id: finding.commit_id,
-				path: finding.path,
-				body: finding.body,
-				line: finding.line,
-				...(finding.start_line != finding.line) && { start_line: finding.start_line }
-			});
+			try {
+				await octokit.rest.pulls.createReviewComment({
+					...context.repo,
+					pull_number: pullRequestNumber,
+					commit_id: finding.commit_id,
+					path: finding.path,
+					body: finding.body,
+					line: finding.line,
+					...(finding.start_line != finding.line) && { start_line: finding.start_line }
+				});
+			} catch (error) {
+				if (error instanceof Error) {
+					core.info(`unable to post scan status comment due to error: ${error.message}. Tried posting ${JSON.stringify(finding)}`);
+				} else {
+					core.info(`unable to post scan status comment due to unknown error`);
+				}
+			}
+
 		}
 	}
 };