writer-json: do not needlessly duplicate messages in SARIF

... when we have only one. Reported-by: Jan Macku <[email protected]>
csutils · Feb 7, 2023 · e335308 · e335308
1 parent 4effa83
commit e335308
Show file tree

Hide file tree

Showing 6 changed files with 693 additions and 13,807 deletions.
diff --git a/src/lib/writer-json.cc b/src/lib/writer-json.cc
@@ -368,32 +368,34 @@ void SarifTreeEncoder::appendDef(const Defect &def)
     sarifEncodeMsg(&result, keyEvt.msg);
 
     // other events
-    PTree flowLocs, relatedLocs;
-    for (unsigned i = 0; i < def.events.size(); ++i) {
-        if (def.events[i].event == "#")
-            sarifEncodeComment(&relatedLocs, def, i);
-        else
-            sarifEncodeEvt(&flowLocs, def, i);
-    }
+    if (1U < def.events.size()) {
+        PTree flowLocs, relatedLocs;
+        for (unsigned i = 0; i < def.events.size(); ++i) {
+            if (def.events[i].event == "#")
+                sarifEncodeComment(&relatedLocs, def, i);
+            else
+                sarifEncodeEvt(&flowLocs, def, i);
+        }
 
-    // locations
-    PTree tf;
-    tf.put_child("locations", flowLocs);
+        // locations
+        PTree tf;
+        tf.put_child("locations", flowLocs);
 
-    // threadFlows
-    PTree tfList;
-    appendNode(&tfList, tf);
-    PTree cf;
-    cf.put_child("threadFlows", tfList);
+        // threadFlows
+        PTree tfList;
+        appendNode(&tfList, tf);
+        PTree cf;
+        cf.put_child("threadFlows", tfList);
 
-    // codeFlows
-    PTree cfList;
-    appendNode(&cfList, cf);
-    result.put_child("codeFlows", cfList);
+        // codeFlows
+        PTree cfList;
+        appendNode(&cfList, cf);
+        result.put_child("codeFlows", cfList);
 
-    if (!relatedLocs.empty())
-        // our stash for comments
-        result.put_child("relatedLocations", relatedLocs);
+        if (!relatedLocs.empty())
+            // our stash for comments
+            result.put_child("relatedLocations", relatedLocs);
+    }
 
     // append the `result` object to the `results` array
     appendNode(&results_, result);