🐛 Use violation id instead of description for key

konveyor · Jan 21, 2025 · 4781812 · 4781812
1 parent 7356808
commit 4781812
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 10 deletions.
diff --git a/shared/src/types/types.ts b/shared/src/types/types.ts
@@ -20,12 +20,11 @@ export interface Link {
 export type Category = "potential" | "optional" | "mandatory";
 
 export interface Violation {
+  id: string;
   description: string;
   category?: Category;
   labels?: string[];
   incidents: Incident[];
-  links?: Link[];
-  extras?: unknown;
   effort?: number;
 }
 

diff --git a/vscode/src/analysis/__tests__/data.ts b/vscode/src/analysis/__tests__/data.ts
@@ -5,6 +5,7 @@ export const FOO: RuleSet = {
   violations: {
     "foo-01": {
       description: "foo-01 description",
+      id: "foo-01",
       category: "mandatory",
       labels: ["konveyor.io/target=foo", "konveyor.io/target=bar"],
       incidents: [
@@ -37,6 +38,7 @@ export const BAR: RuleSet = {
   violations: {
     "bar-01": {
       description: "bar-01 description",
+      id: "bar-01",
       category: "mandatory",
       labels: ["konveyor.io/target=foo", "konveyor.io/target=bar"],
       incidents: [
@@ -57,6 +59,7 @@ export const BAR: RuleSet = {
     },
     "bar-02": {
       description: "bar-02 description",
+      id: "bar-02",
       category: "mandatory",
       labels: ["konveyor.io/target=foo", "konveyor.io/target=bar"],
       incidents: [
@@ -86,6 +89,7 @@ export const DISCOVERY: RuleSet = {
   insights: {
     "discover-java-files": {
       description: "Java source files",
+      id: "discover-java-files",
       labels: [
         "konveyor.io/include=always",
         "konveyor.io/target=discovery",

diff --git a/webview-ui/src/components/ViolationIncidentsList.tsx b/webview-ui/src/components/ViolationIncidentsList.tsx
@@ -143,17 +143,12 @@ const ViolationIncidentsList: React.FC<ViolationIncidentsListProps> = ({
         }
         return text.slice(0, maxLength) + "...";
       };
-      const isExpanded = expandedViolations.has(violation.description);
+      const isExpanded = expandedViolations.has(violation.id);
       const highestSeverity = getHighestSeverity(violation.incidents);
       const truncatedDescription = truncateText(violation.description, 100);
 
       return (
-        <Card
-          isExpanded={isExpanded}
-          isCompact
-          key={violation.description}
-          style={{ marginBottom: "10px" }}
-        >
+        <Card isExpanded={isExpanded} isCompact key={violation.id} style={{ marginBottom: "10px" }}>
           <CardHeader
             actions={{
               actions: (
@@ -167,7 +162,7 @@ const ViolationIncidentsList: React.FC<ViolationIncidentsListProps> = ({
                 />
               ),
             }}
-            onExpand={() => toggleViolation(violation.description)}
+            onExpand={() => toggleViolation(violation.id)}
           >
             <Content style={{ marginBottom: "5px" }}>{truncatedDescription}</Content>
             <Flex>