CM-48120 - Add detection sorting by line number in addition to severity (#40)

MarshalX · web-flow · commit 79d7a5f5f749 · 2025-05-14T14:53:15.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@
 
 ## [Unreleased]
 
+## [1.10.0] - 2025-05-14
+
+- Add detection sorting by line number in addition to severity
+
 ## [1.9.0] - 2025-02-24
 
 - Add tree view filtering by severity
@@ -85,6 +89,8 @@
 
 The first public release of the extension.
 
+[1.10.0]: https://github.com/cycodehq/visual-studio-extension/releases/tag/v1.10.0
+
 [1.9.0]: https://github.com/cycodehq/visual-studio-extension/releases/tag/v1.9.0
 
 [1.8.0]: https://github.com/cycodehq/visual-studio-extension/releases/tag/v1.8.0
@@ -119,4 +125,4 @@ The first public release of the extension.
 
 [1.0.0]: https://github.com/cycodehq/visual-studio-extension/releases/tag/v1.0.0
 
-[Unreleased]: https://github.com/cycodehq/visual-studio-extension/compare/v1.9.0...HEAD
+[Unreleased]: https://github.com/cycodehq/visual-studio-extension/compare/v1.10.0...HEAD
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 ﻿{
   "sdk": {
-    "version": "8.0.404",
-    "rollForward": "latestFeature"
+    "version": "8.0.408",
+    "rollForward": "disable"
   }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.14.0-16.0/source.extension.vsixmanifest b/src/extension/Cycode.VisualStudio.Extension.14.0-16.0/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
     <Metadata>
-        <Identity Id="Cycode.7e1a0714-9b3b-4e0e-9c0a-d23fb20ab86e" Version="1.9.0" Language="en-US" Publisher="cycodehq" />
+        <Identity Id="Cycode.7e1a0714-9b3b-4e0e-9c0a-d23fb20ab86e" Version="1.10.0" Language="en-US" Publisher="cycodehq" />
         <DisplayName>Cycode</DisplayName>
         <Description xml:space="preserve">Cycode for Visual Studio IDE</Description>
         <MoreInfo>https://github.com/cycodehq/visual-studio-extension</MoreInfo>
diff --git a/src/extension/Cycode.VisualStudio.Extension.17.0/source.extension.vsixmanifest b/src/extension/Cycode.VisualStudio.Extension.17.0/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
     <Metadata>
-        <Identity Id="Cycode.f2c5020e-67a2-46f8-a888-609412fd59db" Version="1.9.0" Language="en-US" Publisher="cycodehq" />
+        <Identity Id="Cycode.f2c5020e-67a2-46f8-a888-609412fd59db" Version="1.10.0" Language="en-US" Publisher="cycodehq" />
         <DisplayName>Cycode</DisplayName>
         <Description xml:space="preserve">Cycode for Visual Studio IDE</Description>
         <MoreInfo>https://github.com/cycodehq/visual-studio-extension</MoreInfo>
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/DetectionDetailsBase.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/DetectionDetailsBase.cs
@@ -2,4 +2,6 @@
 
 public abstract class DetectionDetailsBase {
     public abstract string GetFilePath();
+    // This method returns a 1-indexed line number
+    public abstract int GetLineNumber();
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Iac/IacDetection.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Iac/IacDetection.cs
@@ -31,6 +31,6 @@ public override string GetFormattedTitle() {
     }
 
     public override string GetFormattedNodeTitle() {
-        return $"line {DetectionDetails.LineInFile + 1}: {GetFormattedMessage()}";
+        return $"line {DetectionDetails.GetLineNumber()}: {GetFormattedMessage()}";
     }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Iac/IacDetectionDetails.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Iac/IacDetectionDetails.cs
@@ -35,4 +35,8 @@ public class IacDetectionDetails : DetectionDetailsBase {
     public override string GetFilePath() {
         return FileName;
     }
+    
+    public override int GetLineNumber() {
+        return LineInFile;
+    }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Sast/SastDetection.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Sast/SastDetection.cs
@@ -31,6 +31,6 @@ public override string GetFormattedTitle() {
     }
 
     public override string GetFormattedNodeTitle() {
-        return $"line {DetectionDetails.LineInFile}: {GetFormattedMessage()}";
+        return $"line {DetectionDetails.GetLineNumber()}: {GetFormattedMessage()}";
     }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Sast/SastDetectionDetails.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Sast/SastDetectionDetails.cs
@@ -46,4 +46,8 @@ public class SastDetectionDetails : DetectionDetailsBase {
     public override string GetFilePath() {
         return FilePath;
     }
+    
+    public override int GetLineNumber() {
+        return LineInFile;
+    }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Sca/ScaDetection.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Sca/ScaDetection.cs
@@ -32,6 +32,6 @@ public override string GetFormattedTitle() {
     }
 
     public override string GetFormattedNodeTitle() {
-        return $"line {DetectionDetails.LineInFile}: {GetFormattedTitle()}";
+        return $"line {DetectionDetails.GetLineNumber()}: {GetFormattedTitle()}";
     }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Sca/ScaDetectionDetails.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Sca/ScaDetectionDetails.cs
@@ -37,4 +37,8 @@ public class ScaDetectionDetails : DetectionDetailsBase {
     public override string GetFilePath() {
         return FileName;
     }
+
+    public override int GetLineNumber() {
+        return LineInFile;
+    }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Secret/SecretDetection.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Secret/SecretDetection.cs
@@ -31,6 +31,6 @@ public override string GetFormattedTitle() {
     }
 
     public override string GetFormattedNodeTitle() {
-        return $"line {DetectionDetails.Line + 1}: a hardcoded {Type} is used";
+        return $"line {DetectionDetails.GetLineNumber()}: a hardcoded {Type} is used";
     }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Secret/SecretDetectionDetails.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Cli/DTO/ScanResult/Secret/SecretDetectionDetails.cs
@@ -40,4 +40,8 @@ public class SecretDetectionDetails : DetectionDetailsBase {
     public override string GetFilePath() {
         return $"{FilePath}{FileName}";
     }
+
+    public override int GetLineNumber() {
+        return Line + 1; // 1-indexed
+    }
 }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Components/TreeView/CycodeTreeViewControl.xaml.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Components/TreeView/CycodeTreeViewControl.xaml.cs
@@ -44,7 +44,7 @@ private void OnSelectedItemChanged(object sender, RoutedPropertyChangedEventArgs
             case SecretDetectionNode secretDetectionNode: {
                 SecretDetection detection = secretDetectionNode.Detection;
                 filePath = detection.DetectionDetails.GetFilePath();
-                line = detection.DetectionDetails.Line + 1;
+                line = detection.DetectionDetails.GetLineNumber();
                 _toolWindowMessengerService.Send(
                     new MessageEventArgs(MessengerCommand.LoadSecretViolationCardControl, detection)
                 );
@@ -53,7 +53,7 @@ private void OnSelectedItemChanged(object sender, RoutedPropertyChangedEventArgs
             case ScaDetectionNode scaDetectionNode: {
                 ScaDetection detection = scaDetectionNode.Detection;
                 filePath = detection.DetectionDetails.GetFilePath();
-                line = detection.DetectionDetails.LineInFile;
+                line = detection.DetectionDetails.GetLineNumber();
                 _toolWindowMessengerService.Send(
                     new MessageEventArgs(MessengerCommand.LoadScaViolationCardControl, detection)
                 );
@@ -62,7 +62,7 @@ private void OnSelectedItemChanged(object sender, RoutedPropertyChangedEventArgs
             case IacDetectionNode iacDetectionNode: {
                 IacDetection detection = iacDetectionNode.Detection;
                 filePath = detection.DetectionDetails.GetFilePath();
-                line = detection.DetectionDetails.LineInFile + 1;
+                line = detection.DetectionDetails.GetLineNumber();
                 _toolWindowMessengerService.Send(
                     new MessageEventArgs(MessengerCommand.LoadIacViolationCardControl, detection)
                 );
@@ -71,7 +71,7 @@ private void OnSelectedItemChanged(object sender, RoutedPropertyChangedEventArgs
             case SastDetectionNode sastDetectionNode: {
                 SastDetection detection = sastDetectionNode.Detection;
                 filePath = detection.DetectionDetails.GetFilePath();
-                line = detection.DetectionDetails.LineInFile;
+                line = detection.DetectionDetails.GetLineNumber();
                 _toolWindowMessengerService.Send(
                     new MessageEventArgs(MessengerCommand.LoadSastViolationCardControl, detection)
                 );
@@ -144,14 +144,11 @@ Func<DetectionBase, BaseNode> createNodeCallback
         List<DetectionBase> severityFilteredDetections = detections
             .Where(detection => !enabledSeverityFilters.Contains(detection.Severity.ToLower()))
             .ToList();
-        List<DetectionBase> sortedDetections = severityFilteredDetections
-            .OrderByDescending(detection => GetSeverityWeight(detection.Severity))
-            .ToList();
         IEnumerable<IGrouping<string, DetectionBase>> detectionsByFile =
-            sortedDetections.GroupBy(detection => detection.GetDetectionDetails().GetFilePath());
+            severityFilteredDetections.GroupBy(detection => detection.GetDetectionDetails().GetFilePath());
 
         ScanTypeNode scanTypeNode = RootNodesManager.GetScanTypeNode(scanType);
-        scanTypeNode.Summary = GetRootNodeSummary(sortedDetections);
+        scanTypeNode.Summary = GetRootNodeSummary(severityFilteredDetections);
 
         foreach (IGrouping<string, DetectionBase> detectionsInFile in detectionsByFile) {
             string filePath = detectionsInFile.Key;
@@ -162,7 +159,12 @@ Func<DetectionBase, BaseNode> createNodeCallback
                 Icon = ExtensionIcons.GetFileIconPath(filePath)
             };
 
-            foreach (DetectionBase detection in detectionsInFile) fileNode.Items.Add(createNodeCallback(detection));
+            List<DetectionBase> sortedDetectionsInFile = detectionsInFile
+                .OrderByDescending(detection => GetSeverityWeight(detection.Severity))
+                .ThenBy(detection => detection.GetDetectionDetails().GetLineNumber())
+                .ToList();
+
+            foreach (DetectionBase detection in sortedDetectionsInFile) fileNode.Items.Add(createNodeCallback(detection));
 
             scanTypeNode.Items.Add(fileNode);
         }
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorList/TaskCreators/IacErrorTaskCreator.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorList/TaskCreators/IacErrorTaskCreator.cs
@@ -10,7 +10,7 @@ public static List<ErrorTask> CreateErrorTasks(List<IacDetection> detections) {
 
         errorTasks.AddRange(detections.Select(detection => new ErrorTask {
             Text = $"Cycode: {detection.GetFormattedTitle()}",
-            Line = detection.DetectionDetails.LineInFile,
+            Line = detection.DetectionDetails.GetLineNumber() - 1,
             Document = detection.DetectionDetails.GetFilePath(),
             Category = TaskCategory.User,
             ErrorCategory = ErrorCategoryUtilities.GetTaskErrorCategory(detection.Severity),
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorList/TaskCreators/SastErrorTaskCreator.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorList/TaskCreators/SastErrorTaskCreator.cs
@@ -10,7 +10,7 @@ public static List<ErrorTask> CreateErrorTasks(List<SastDetection> detections) {
 
         errorTasks.AddRange(detections.Select(detection => new ErrorTask {
             Text = $"Cycode: {detection.GetFormattedTitle()}",
-            Line = detection.DetectionDetails.LineInFile - 1,
+            Line = detection.DetectionDetails.GetLineNumber() - 1,
             Document = detection.DetectionDetails.GetFilePath(),
             Category = TaskCategory.User,
             ErrorCategory = ErrorCategoryUtilities.GetTaskErrorCategory(detection.Severity),
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorList/TaskCreators/ScaErrorTaskCreator.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorList/TaskCreators/ScaErrorTaskCreator.cs
@@ -10,7 +10,7 @@ public static List<ErrorTask> CreateErrorTasks(List<ScaDetection> detections) {
 
         errorTasks.AddRange(detections.Select(detection => new ErrorTask {
             Text = $"Cycode: {detection.GetFormattedTitle()}",
-            Line = detection.DetectionDetails.LineInFile - 1,
+            Line = detection.DetectionDetails.GetLineNumber() - 1,
             Document = detection.DetectionDetails.GetFilePath(),
             Category = TaskCategory.User,
             ErrorCategory = ErrorCategoryUtilities.GetTaskErrorCategory(detection.Severity),
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorList/TaskCreators/SecretsErrorTaskCreator.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorList/TaskCreators/SecretsErrorTaskCreator.cs
@@ -10,7 +10,7 @@ public static List<ErrorTask> CreateErrorTasks(List<SecretDetection> detections)
 
         errorTasks.AddRange(detections.Select(detection => new ErrorTask {
             Text = $"Cycode: {detection.GetFormattedTitle()}",
-            Line = detection.DetectionDetails.Line,
+            Line = detection.DetectionDetails.GetLineNumber() - 1,
             Document = detection.DetectionDetails.GetFilePath(),
             Category = TaskCategory.User,
             ErrorCategory = ErrorCategoryUtilities.GetTaskErrorCategory(detection.Severity),
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorTagger/TagSpansCreators/IacTagSpansCreator.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorTagger/TagSpansCreators/IacTagSpansCreator.cs
@@ -23,7 +23,7 @@ public static List<ITagSpan<DetectionTag>> CreateTagSpans(ITextSnapshot snapshot
             .ToList();
 
         tagSpans.AddRange(from detection in detections
-            let line = detection.DetectionDetails.LineInFile
+            let line = detection.DetectionDetails.GetLineNumber() - 1
             let startSnapshotPoint = snapshot.GetLineFromLineNumber(line).Start
             let endSnapshotPoint = snapshot.GetLineFromLineNumber(line).End
             let snapshotSpan = new SnapshotSpan(startSnapshotPoint, endSnapshotPoint)
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorTagger/TagSpansCreators/SastTagSpansCreator.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorTagger/TagSpansCreators/SastTagSpansCreator.cs
@@ -23,7 +23,7 @@ public static List<ITagSpan<DetectionTag>> CreateTagSpans(ITextSnapshot snapshot
             .ToList();
 
         tagSpans.AddRange(from detection in detections
-            let line = detection.DetectionDetails.LineInFile - 1
+            let line = detection.DetectionDetails.GetLineNumber() - 1
             let startSnapshotPoint = snapshot.GetLineFromLineNumber(line).Start
             let endSnapshotPoint = snapshot.GetLineFromLineNumber(line).End
             let snapshotSpan = new SnapshotSpan(startSnapshotPoint, endSnapshotPoint)
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorTagger/TagSpansCreators/ScaTagSpansCreator.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorTagger/TagSpansCreators/ScaTagSpansCreator.cs
@@ -23,7 +23,7 @@ public static List<ITagSpan<DetectionTag>> CreateTagSpans(ITextSnapshot snapshot
             .ToList();
 
         tagSpans.AddRange(from detection in detections
-            let line = detection.DetectionDetails.LineInFile - 1
+            let line = detection.DetectionDetails.GetLineNumber() - 1
             let length = snapshot.GetLineFromLineNumber(line).Length
             let startSnapshotPoint = snapshot.GetLineFromLineNumber(line).Start.Add(0)
             let endSnapshotPoint = snapshot.GetLineFromLineNumber(line).Start.Add(length)
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorTagger/TagSpansCreators/SecretsTagSpansCreator.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/Services/ErrorTagger/TagSpansCreators/SecretsTagSpansCreator.cs
@@ -23,7 +23,7 @@ public static List<ITagSpan<DetectionTag>> CreateTagSpans(ITextSnapshot snapshot
             .ToList();
 
         tagSpans.AddRange(from detection in detections
-            let line = detection.DetectionDetails.Line
+            let line = detection.DetectionDetails.GetLineNumber() - 1
             let column = ErrorTaggerUtilities.CalculateColumn(snapshot, detection.DetectionDetails.StartPosition)
             let length = detection.DetectionDetails.Length
             let startSnapshotPoint = snapshot.GetLineFromLineNumber(line).Start.Add(column)
diff --git a/src/extension/Cycode.VisualStudio.Extension.Shared/source.extension.cs b/src/extension/Cycode.VisualStudio.Extension.Shared/source.extension.cs
@@ -3,5 +3,5 @@ namespace Cycode.VisualStudio.Extension.Shared;
 internal sealed class Vsix {
     public const string Name = "Cycode";
     public const string Description = "Cycode for Visual Studio IDE";
-    public const string Version = "1.9.0";
+    public const string Version = "1.10.0";
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`		`- "version": "8.0.404",`
`4`		`- "rollForward": "latestFeature"`
	`3`	`+ "version": "8.0.408",`
	`4`	`+ "rollForward": "disable"`
`5`	`5`	`}`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,6 @@`
`2`	`2`
`3`	`3`	`public abstract class DetectionDetailsBase {`
`4`	`4`	`public abstract string GetFilePath();`
	`5`	`+ // This method returns a 1-indexed line number`
	`6`	`+ public abstract int GetLineNumber();`
`5`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,6 @@ public override string GetFormattedTitle() {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`public override string GetFormattedNodeTitle() {`
`34`		`- return $"line {DetectionDetails.LineInFile + 1}: {GetFormattedMessage()}";`
	`34`	`+ return $"line {DetectionDetails.GetLineNumber()}: {GetFormattedMessage()}";`
`35`	`35`	`}`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,8 @@ public class IacDetectionDetails : DetectionDetailsBase {`
`35`	`35`	`public override string GetFilePath() {`
`36`	`36`	`return FileName;`
`37`	`37`	`}`
	`38`	`+`
	`39`	`+ public override int GetLineNumber() {`
	`40`	`+ return LineInFile;`
	`41`	`+ }`
`38`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,4 +46,8 @@ public class SastDetectionDetails : DetectionDetailsBase {`
`46`	`46`	`public override string GetFilePath() {`
`47`	`47`	`return FilePath;`
`48`	`48`	`}`
	`49`	`+`
	`50`	`+ public override int GetLineNumber() {`
	`51`	`+ return LineInFile;`
	`52`	`+ }`
`49`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,6 @@ public override string GetFormattedTitle() {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public override string GetFormattedNodeTitle() {`
`35`		`- return $"line {DetectionDetails.LineInFile}: {GetFormattedTitle()}";`
	`35`	`+ return $"line {DetectionDetails.GetLineNumber()}: {GetFormattedTitle()}";`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,8 @@ public class ScaDetectionDetails : DetectionDetailsBase {`
`37`	`37`	`public override string GetFilePath() {`
`38`	`38`	`return FileName;`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+ public override int GetLineNumber() {`
	`42`	`+ return LineInFile;`
	`43`	`+ }`
`40`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,4 +40,8 @@ public class SecretDetectionDetails : DetectionDetailsBase {`
`40`	`40`	`public override string GetFilePath() {`
`41`	`41`	`return $"{FilePath}{FileName}";`
`42`	`42`	`}`
	`43`	`+`
	`44`	`+ public override int GetLineNumber() {`
	`45`	`+ return Line + 1; // 1-indexed`
	`46`	`+ }`
`43`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@ namespace Cycode.VisualStudio.Extension.Shared;`
`3`	`3`	`internal sealed class Vsix {`
`4`	`4`	`public const string Name = "Cycode";`
`5`	`5`	`public const string Description = "Cycode for Visual Studio IDE";`
`6`		`- public const string Version = "1.9.0";`
	`6`	`+ public const string Version = "1.10.0";`
`7`	`7`	`}`