Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
improve findings table in check run
Matheus Nogueira615e9b198533
diff --git a/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-factory.ts b/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-factory.tsindex 3a6e7d9b20..b11bae00e9 100644--- a/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-factory.ts+++ b/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-factory.ts@@ -191,7 +191,8 @@ export const GitHubSecretScanningFactory = () => {return createPullRequestScanReport({installationId: payload.installationId,repositoryFullName: payload.repository.full_name,- metadata: getPullRequestScanMetadata(payload)+ metadata: getPullRequestScanMetadata(payload),+ findingsUrl: payload.findingsUrl});};diff --git a/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-fns.test.ts b/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-fns.test.tsindex cadc48c360..277f720f2e 100644--- a/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-fns.test.ts+++ b/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-fns.test.ts@@ -76,15 +76,27 @@ const makeFinding = (index: number): TFindingsPayload[number] => ({describe("getPullRequestScanCheckRunResult", () => {test("fails on any finding and never includes the secret", () => {+ const finding = makeFinding(0);const result = getPullRequestScanCheckRunResult({- findings: [makeFinding(0), makeFinding(1)],+ findings: [+ {+ ...finding,+ id: "0a1b2c3d-0000-4000-8000-000000000000",+ status: SecretScanningFindingStatus.Unresolved,+ details: { ...(finding.details as object), link: "https://github.com/acme/api/blob/abc123/my file.go#L1" }+ },+ makeFinding(1)+ ],scannedCommitCount: 2,- totalCommitCount: 2+ totalCommitCount: 2,+ findingsUrl: "https://app.infisical.com/organizations/org/secret-scanning/findings?resourceId=r"});expect(result.conclusion).toBe("failure");expect(result.title).toBe("2 secret(s) found");- expect(result.summary).toContain("| github-pat | config\\|0.ts | 1 | abc123d |");+ expect(result.summary).toContain(+ "| [0a1b2c3d](https://app.infisical.com/organizations/org/secret-scanning/findings?resourceId=r) | Unresolved | github-pat | abc123d | config\\|0.ts:1 | [View secret](https://github.com/acme/api/blob/abc123/my%20file.go#L1) |"+ );expect(result.summary).not.toContain(SECRET_VALUE);});diff --git a/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-fns.ts b/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-fns.tsindex 8027472e09..799c3e752a 100644--- a/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-fns.ts+++ b/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-fns.ts@@ -416,7 +416,8 @@ const FindingLocationSchema = GitRepositoryScanFindingDetailsSchema.pick({startLine: true,endLine: true,commit: true,- description: true+ description: true,+ link: true});const getFindingLocations = (findings: TFindingsPayload) =>@@ -437,14 +438,24 @@ const toCheckRunAnnotations = (findings: TFindingsPayload) =>const escapeMarkdownTableCell = (value: string) => value.replace(/\|/g, "\\|").replace(/\r?\n/g, " ");+const toMarkdownUrl = (url: string) => url.replace(/ /g, "%20").replace(/\(/g, "%28").replace(/\)/g, "%29");++const toStatusLabel = (status?: string | null) =>+ (status ?? SecretScanningFindingStatus.Unresolved)+ .split("-")+ .map((word) => word.charAt(0).toUpperCase() + word.slice(1))+ .join(" ");+export const getPullRequestScanCheckRunResult = ({findings: allFindings,scannedCommitCount,- totalCommitCount+ totalCommitCount,+ findingsUrl}: {- findings: (TFindingsPayload[number] & { status?: string | null })[];+ findings: (TFindingsPayload[number] & { id?: string; status?: string | null })[];scannedCommitCount: number;totalCommitCount: number;+ findingsUrl?: string;}): TPullRequestCheckRunResult => {const truncationNote =scannedCommitCount < totalCommitCount@@ -484,12 +495,26 @@ export const getPullRequestScanCheckRunResult = ({}const table = [- "| Rule | File | Line | Commit |",- "| --- | --- | --- | --- |",- ...getFindingLocations(findings.slice(0, CHECK_RUN_MAX_SUMMARY_FINDINGS)).map(- ({ rule, file, startLine, commit }) =>- `| ${escapeMarkdownTableCell(rule)} | ${escapeMarkdownTableCell(file)} | ${startLine} | ${commit.slice(0, 7)} |`- )+ "| Infisical ID | Status | Secret | Commit | File | |",+ "| --- | --- | --- | --- | --- | --- |",+ ...findings.slice(0, CHECK_RUN_MAX_SUMMARY_FINDINGS).flatMap((finding) => {+ const details = FindingLocationSchema.safeParse(finding.details);+ if (!details.success) return [];++ const { file, startLine, commit, link } = details.data;+ const shortId = finding.id ? finding.id.slice(0, 8) : "";++ const cells = [+ shortId && findingsUrl ? `[${shortId}](${toMarkdownUrl(findingsUrl)})` : shortId,+ toStatusLabel(finding.status),+ escapeMarkdownTableCell(finding.rule),+ commit.slice(0, 7),+ escapeMarkdownTableCell(`${file}:${startLine}`),+ link ? `[View secret](${toMarkdownUrl(link)})` : ""+ ];++ return [`| ${cells.join(" | ")} |`];+ })].join("\n");const summary = [@@ -599,11 +624,13 @@ export const getPullRequestScanMetadata = (payload: TGitHubPullRequestScanPayloaexport const createPullRequestScanReport = ({installationId,repositoryFullName,- metadata+ metadata,+ findingsUrl}: {installationId: string;repositoryFullName: string;metadata: TGitHubPullRequestScanMetadata;+ findingsUrl?: string;}): TSecretScanningScanReport => {const target = { installationId, repositoryFullName, checkRunId: metadata.checkRunId };@@ -627,7 +654,8 @@ export const createPullRequestScanReport = ({result: getPullRequestScanCheckRunResult({findings,scannedCommitCount: details?.scannedCommitCount ?? 0,- totalCommitCount: details?.totalCommitCount ?? 0+ totalCommitCount: details?.totalCommitCount ?? 0,+ findingsUrl})}),fail: ({ reason, isTimedOut }) =>@@ -743,6 +771,10 @@ export const processGitHubPullRequestEvent: TSecretScanningFactoryProcessEvent<Tconst scanId = crypto.nativeCrypto.randomUUID();const { SITE_URL } = getConfig();const orgId = dataSource.connection?.orgId;+ const findingsUrl =+ SITE_URL && orgId+ ? `${SITE_URL}/organizations/${orgId}/secret-scanning/findings?resourceId=${resource.id}`+ : undefined;let checkRunId: number;try {@@ -751,10 +783,7 @@ export const processGitHubPullRequestEvent: TSecretScanningFactoryProcessEvent<TrepositoryFullName: repository.full_name,headSha: pullRequest.headSha,scanId,- detailsUrl:- SITE_URL && orgId- ? `${SITE_URL}/organizations/${orgId}/secret-scanning/findings?resourceId=${resource.id}`- : undefined+ detailsUrl: findingsUrl});} catch (error) {logger.warn(@@ -768,7 +797,8 @@ export const processGitHubPullRequestEvent: TSecretScanningFactoryProcessEvent<TinstallationId: String(installationId),repository: { id: repository.id, full_name: repository.full_name },pullRequest,- checkRunId+ checkRunId,+ findingsUrl};await queueReportedRealtimeScan({diff --git a/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-types.ts b/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-types.tsindex d520c2cfc5..74a71b9627 100644--- a/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-types.ts+++ b/backend/src/ee/services/secret-scanning-v2/github/github-secret-scanning-types.ts@@ -37,6 +37,8 @@ export type TGitHubPullRequestScanPayload = {headSha: string;};checkRunId: number;+ // The data source's findings page for the repository, linked from the check's summary.+ findingsUrl?: string;};export type TQueueGitHubResourceDiffScan = {