From 31321b5d6faeecf27fa46983e9c9630d7e1c690b Mon Sep 17 00:00:00 2001 From: Tai Lai Date: Tue, 22 Oct 2024 15:06:56 -0700 Subject: [PATCH 1/7] telemetry: add definitions for reviewbird --- telemetry/definitions/commonDefinitions.json | 179 ++++++++++++++++++- 1 file changed, 178 insertions(+), 1 deletion(-) diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json index e0751a474..a9de419ef 100644 --- a/telemetry/definitions/commonDefinitions.json +++ b/telemetry/definitions/commonDefinitions.json @@ -554,6 +554,8 @@ "description": "The scope of the security scan being performed", "allowedValues": [ "FILE", + "FILE_AUTO", + "FILE_ON_DEMAND", "PROJECT" ] }, @@ -885,7 +887,8 @@ "infobar", "hover", "webview", - "quickfix" + "quickfix", + "tree" ], "description": "The IDE or OS component used for the action. (Examples: S3 download to filesystem, S3 upload from editor, ...). See also `featureId` for specific feature names, `module` for low-level modules, and `resourceType`." }, @@ -4395,6 +4398,180 @@ } ] }, + { + "name": "codewhisperer_codeScanIssueIgnore", + "description": "Called when a code scan issue is ignored", + "metadata": [ + { + "type": "component" + }, + { + "type": "credentialStartUrl", + "required": false + }, + { + "type": "detectorId" + }, + { + "type": "findingId" + }, + { + "type": "ruleId", + "required": false + } + ] + }, + { + "name": "codewhisperer_codeScanIssueIgnoreAll", + "description": "Called when all code scan issues of a specific type are ignored", + "metadata": [ + { + "type": "component" + }, + { + "type": "credentialStartUrl", + "required": false + }, + { + "type": "detectorId" + }, + { + "type": "findingId" + }, + { + "type": "ruleId", + "required": false + } + ] + }, + { + "name": "codewhisperer_codeScanIssueGenerateFix", + "description": "Called when a code scan issue fix is generated", + "metadata": [ + { + "type": "component" + }, + { + "type": "credentialStartUrl", + "required": false + }, + { + "type": "detectorId" + }, + { + "type": "findingId" + }, + { + "type": "ruleId", + "required": false + }, + { + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true + } + ] + }, + { + "name": "codewhisperer_codeScanIssueRegenerateFix", + "description": "Called when a code scan issue fix is regenerated", + "metadata": [ + { + "type": "component" + }, + { + "type": "credentialStartUrl", + "required": false + }, + { + "type": "detectorId" + }, + { + "type": "findingId" + }, + { + "type": "ruleId", + "required": false + }, + { + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true + } + ] + }, + { + "name": "codewhisperer_codeScanChatNewTab", + "description": "Called when a new chat tab is opened in the code scan view", + "metadata": [ + { + "type": "codeScanSessionId", + "required": false + }, + { + "type": "credentialSourceId", + "required": false + }, + { + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true + } + ] + }, + { + "name": "codewhisperer_codeScanChatProjectScan", + "description": "Called when project scan is selected from chat", + "metadata": [ + { + "type": "codeScanSessionId", + "required": false + }, + { + "type": "credentialSourceId", + "required": false + }, + { + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true + } + ] + }, + { + "name": "codewhisperer_codeScanChatFileScan", + "description": "Called when file scan is selected from chat", + "metadata": [ + { + "type": "codeScanSessionId", + "required": false + }, + { + "type": "credentialSourceId", + "required": false + }, + { + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true + } + ] + }, { "name": "codewhisperer_enabled", "description": "Whether or not CodeWhisperer is enabled", From 272a6ab550e9309b318b40986b55ca8f0b93af17 Mon Sep 17 00:00:00 2001 From: Tai Lai Date: Tue, 22 Oct 2024 15:13:47 -0700 Subject: [PATCH 2/7] add codeScanSessionId type --- telemetry/definitions/commonDefinitions.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json index a9de419ef..59e9dadbb 100644 --- a/telemetry/definitions/commonDefinitions.json +++ b/telemetry/definitions/commonDefinitions.json @@ -262,6 +262,11 @@ "type": "int", "description": "Time taken to invoke code scan service APIs in milliseconds" }, + { + "name": "codeScanSessionId", + "type": "string", + "description": "Represents the IDE session from which users start the scan process" + }, { "name": "codeTransformArtifactType", "type": "string", @@ -1134,7 +1139,7 @@ "remoteDesktop", "ssh", "scp", - "ssm", + "ssm", "remoteWorkspace" ], "description": "Ways to connect to an EC2 Instance" From 067d55200af6b9cb9f1f01b274242b366c080fa4 Mon Sep 17 00:00:00 2001 From: Tai Lai Date: Tue, 22 Oct 2024 15:16:11 -0700 Subject: [PATCH 3/7] reorder --- telemetry/definitions/commonDefinitions.json | 132 +++++++++---------- 1 file changed, 66 insertions(+), 66 deletions(-) diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json index 59e9dadbb..a662a3d0f 100644 --- a/telemetry/definitions/commonDefinitions.json +++ b/telemetry/definitions/commonDefinitions.json @@ -4330,6 +4330,72 @@ ], "passive": true }, + { + "name": "codewhisperer_codeScanChatFileScan", + "description": "Called when file scan is selected from chat", + "metadata": [ + { + "type": "codeScanSessionId", + "required": false + }, + { + "type": "credentialSourceId", + "required": false + }, + { + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true + } + ] + }, + { + "name": "codewhisperer_codeScanChatNewTab", + "description": "Called when a new chat tab is opened in the code scan view", + "metadata": [ + { + "type": "codeScanSessionId", + "required": false + }, + { + "type": "credentialSourceId", + "required": false + }, + { + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true + } + ] + }, + { + "name": "codewhisperer_codeScanChatProjectScan", + "description": "Called when project scan is selected from chat", + "metadata": [ + { + "type": "codeScanSessionId", + "required": false + }, + { + "type": "credentialSourceId", + "required": false + }, + { + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true + } + ] + }, { "name": "codewhisperer_codeScanIssueApplyFix", "description": "Called when a code scan issue suggested fix is applied", @@ -4511,72 +4577,6 @@ } ] }, - { - "name": "codewhisperer_codeScanChatNewTab", - "description": "Called when a new chat tab is opened in the code scan view", - "metadata": [ - { - "type": "codeScanSessionId", - "required": false - }, - { - "type": "credentialSourceId", - "required": false - }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true - } - ] - }, - { - "name": "codewhisperer_codeScanChatProjectScan", - "description": "Called when project scan is selected from chat", - "metadata": [ - { - "type": "codeScanSessionId", - "required": false - }, - { - "type": "credentialSourceId", - "required": false - }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true - } - ] - }, - { - "name": "codewhisperer_codeScanChatFileScan", - "description": "Called when file scan is selected from chat", - "metadata": [ - { - "type": "codeScanSessionId", - "required": false - }, - { - "type": "credentialSourceId", - "required": false - }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true - } - ] - }, { "name": "codewhisperer_enabled", "description": "Whether or not CodeWhisperer is enabled", From d0ea0ce54784a8e1d020b1f7c3cf7079483ecdf0 Mon Sep 17 00:00:00 2001 From: Tai Lai Date: Tue, 22 Oct 2024 15:17:33 -0700 Subject: [PATCH 4/7] reorder --- telemetry/definitions/commonDefinitions.json | 50 ++++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json index a662a3d0f..ce9a5f3ce 100644 --- a/telemetry/definitions/commonDefinitions.json +++ b/telemetry/definitions/commonDefinitions.json @@ -4427,9 +4427,12 @@ ] }, { - "name": "codewhisperer_codeScanIssueHover", - "description": "Called when a code scan issue is hovered over", + "name": "codewhisperer_codeScanIssueGenerateFix", + "description": "Called when a code scan issue fix is generated", "metadata": [ + { + "type": "component" + }, { "type": "credentialStartUrl", "required": false @@ -4441,7 +4444,12 @@ "type": "findingId" }, { - "type": "includesFix" + "type": "reason", + "required": false + }, + { + "type": "result", + "required": true }, { "type": "ruleId", @@ -4450,8 +4458,8 @@ ] }, { - "name": "codewhisperer_codeScanIssueViewDetails", - "description": "Called when a code scan issue webview is opened", + "name": "codewhisperer_codeScanIssueHover", + "description": "Called when a code scan issue is hovered over", "metadata": [ { "type": "credentialStartUrl", @@ -4463,6 +4471,9 @@ { "type": "findingId" }, + { + "type": "includesFix" + }, { "type": "ruleId", "required": false @@ -4516,8 +4527,8 @@ ] }, { - "name": "codewhisperer_codeScanIssueGenerateFix", - "description": "Called when a code scan issue fix is generated", + "name": "codewhisperer_codeScanIssueRegenerateFix", + "description": "Called when a code scan issue fix is regenerated", "metadata": [ { "type": "component" @@ -4532,10 +4543,6 @@ { "type": "findingId" }, - { - "type": "ruleId", - "required": false - }, { "type": "reason", "required": false @@ -4543,16 +4550,17 @@ { "type": "result", "required": true + }, + { + "type": "ruleId", + "required": false } ] }, { - "name": "codewhisperer_codeScanIssueRegenerateFix", - "description": "Called when a code scan issue fix is regenerated", + "name": "codewhisperer_codeScanIssueViewDetails", + "description": "Called when a code scan issue webview is opened", "metadata": [ - { - "type": "component" - }, { "type": "credentialStartUrl", "required": false @@ -4566,14 +4574,6 @@ { "type": "ruleId", "required": false - }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true } ] }, @@ -7151,4 +7151,4 @@ ] } ] -} +} \ No newline at end of file From 5b1dc805dfd2c6a230680be0ba26a90bc9d561f5 Mon Sep 17 00:00:00 2001 From: Tai Lai Date: Tue, 22 Oct 2024 16:36:53 -0700 Subject: [PATCH 5/7] remove reason and result --- telemetry/definitions/commonDefinitions.json | 49 +------------------- 1 file changed, 1 insertion(+), 48 deletions(-) diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json index ce9a5f3ce..f4518b435 100644 --- a/telemetry/definitions/commonDefinitions.json +++ b/telemetry/definitions/commonDefinitions.json @@ -4341,14 +4341,6 @@ { "type": "credentialSourceId", "required": false - }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true } ] }, @@ -4363,14 +4355,6 @@ { "type": "credentialSourceId", "required": false - }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true } ] }, @@ -4385,14 +4369,6 @@ { "type": "credentialSourceId", "required": false - }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true } ] }, @@ -4413,13 +4389,6 @@ { "type": "findingId" }, - { - "type": "reason", - "required": false - }, - { - "type": "result" - }, { "type": "ruleId", "required": false @@ -4443,14 +4412,6 @@ { "type": "findingId" }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true - }, { "type": "ruleId", "required": false @@ -4543,14 +4504,6 @@ { "type": "findingId" }, - { - "type": "reason", - "required": false - }, - { - "type": "result", - "required": true - }, { "type": "ruleId", "required": false @@ -7151,4 +7104,4 @@ ] } ] -} \ No newline at end of file +} From 8e4fab5d18d4a61f372bd219c30dbba3f6559209 Mon Sep 17 00:00:00 2001 From: Tai Lai Date: Tue, 22 Oct 2024 16:54:12 -0700 Subject: [PATCH 6/7] address comments --- telemetry/definitions/commonDefinitions.json | 98 ++++---------------- 1 file changed, 18 insertions(+), 80 deletions(-) diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json index f4518b435..1ec3de683 100644 --- a/telemetry/definitions/commonDefinitions.json +++ b/telemetry/definitions/commonDefinitions.json @@ -262,11 +262,6 @@ "type": "int", "description": "Time taken to invoke code scan service APIs in milliseconds" }, - { - "name": "codeScanSessionId", - "type": "string", - "description": "Represents the IDE session from which users start the scan process" - }, { "name": "codeTransformArtifactType", "type": "string", @@ -533,6 +528,15 @@ "type": "int", "description": "The compressed payload size of built jars in bytes of customer project context sent for security scan. This is only applicable for Java project" }, + { + "name": "codewhispererCodeScanInvocationSource", + "description": "The location where the code scan is being invoked from", + "type": "string", + "allowedValues": [ + "chat", + "menu" + ] + }, { "name": "codewhispererCodeScanIssuesWithFixes", "type": "int", @@ -4330,42 +4334,10 @@ ], "passive": true }, - { - "name": "codewhisperer_codeScanChatFileScan", - "description": "Called when file scan is selected from chat", - "metadata": [ - { - "type": "codeScanSessionId", - "required": false - }, - { - "type": "credentialSourceId", - "required": false - } - ] - }, { "name": "codewhisperer_codeScanChatNewTab", "description": "Called when a new chat tab is opened in the code scan view", "metadata": [ - { - "type": "codeScanSessionId", - "required": false - }, - { - "type": "credentialSourceId", - "required": false - } - ] - }, - { - "name": "codewhisperer_codeScanChatProjectScan", - "description": "Called when project scan is selected from chat", - "metadata": [ - { - "type": "codeScanSessionId", - "required": false - }, { "type": "credentialSourceId", "required": false @@ -4415,6 +4387,10 @@ { "type": "ruleId", "required": false + }, + { + "type": "variant", + "required": false } ] }, @@ -4461,51 +4437,9 @@ { "type": "ruleId", "required": false - } - ] - }, - { - "name": "codewhisperer_codeScanIssueIgnoreAll", - "description": "Called when all code scan issues of a specific type are ignored", - "metadata": [ - { - "type": "component" - }, - { - "type": "credentialStartUrl", - "required": false - }, - { - "type": "detectorId" - }, - { - "type": "findingId" - }, - { - "type": "ruleId", - "required": false - } - ] - }, - { - "name": "codewhisperer_codeScanIssueRegenerateFix", - "description": "Called when a code scan issue fix is regenerated", - "metadata": [ - { - "type": "component" - }, - { - "type": "credentialStartUrl", - "required": false - }, - { - "type": "detectorId" - }, - { - "type": "findingId" }, { - "type": "ruleId", + "type": "variant", "required": false } ] @@ -4663,6 +4597,10 @@ }, { "type": "result" + }, + { + "type": "codewhispererCodeScanInvocationSource", + "required": false } ] }, From 4770dba24f1913d0700a52325e14b00662d4333e Mon Sep 17 00:00:00 2001 From: Tai Lai Date: Tue, 22 Oct 2024 16:56:27 -0700 Subject: [PATCH 7/7] lint --- telemetry/definitions/commonDefinitions.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json index 1ec3de683..1314e31a2 100644 --- a/telemetry/definitions/commonDefinitions.json +++ b/telemetry/definitions/commonDefinitions.json @@ -4550,6 +4550,10 @@ "type": "codewhispererCodeScanBuildZipFileBytes", "required": false }, + { + "type": "codewhispererCodeScanInvocationSource", + "required": false + }, { "type": "codewhispererCodeScanIssuesWithFixes", "required": false @@ -4597,10 +4601,6 @@ }, { "type": "result" - }, - { - "type": "codewhispererCodeScanInvocationSource", - "required": false } ] }, @@ -7042,4 +7042,4 @@ ] } ] -} +} \ No newline at end of file