Merge pull request #6902 from psiinon/postman/stats

postman: add statistics

Author: kingthorin

addOns/callhome/CHANGELOG.md

@@ -4,7 +4,8 @@ All notable changes to this add-on will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
-
+### Added
+- Postman stats to telemetry.
 
 ## [0.17.0] - 2025-11-04
 ### Added

addOns/callhome/src/main/java/org/zaproxy/addon/callhome/ExtensionCallHome.java

@@ -321,6 +321,7 @@ public boolean test(Entry<String, Long> t) {
                     || key.startsWith("stats.network.")
                     || key.startsWith("stats.oast.")
                     || key.startsWith("stats.openapi.")
+                    || key.startsWith("stats.postman.")
                     || key.startsWith("stats.quickstart.")
                     || key.startsWith("stats.reports.")
                     || key.startsWith("stats.script.")

addOns/postman/CHANGELOG.md

@@ -4,7 +4,8 @@ All notable changes to this add-on will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
-
+### Added
+- Statistics.
 
 ## [0.7.0] - 2025-09-02
 ### Changed

addOns/postman/src/main/java/org/zaproxy/addon/postman/PostmanParser.java

@@ -54,6 +54,7 @@
 import org.zaproxy.addon.postman.models.PostmanCollection;
 import org.zaproxy.addon.postman.models.Request;
 import org.zaproxy.addon.postman.models.Request.Url;
+import org.zaproxy.zap.utils.Stats;
 
 public class PostmanParser {
 
@@ -88,6 +89,7 @@ public boolean importFromFile(
         }
 
         String collectionJson = FileUtils.readFileToString(file, StandardCharsets.UTF_8);
+        Stats.incCounter("stats.postman.import.file");
         return importCollection(collectionJson, variables, initViaUi);
     }
 
@@ -106,6 +108,7 @@ public boolean importFromUrl(final String url, final String variables, final boo
         }
 
         String collectionJson = requestor.getResponseBody(uri);
+        Stats.incCounter("stats.postman.import.url");
         return importCollection(collectionJson, variables, initViaUi);
     }
 
@@ -121,6 +124,7 @@ List<HttpMessage> getHttpMessages(
                 postmanCollection.getItem(), httpMessages, errors, postmanCollection.getVariable());
         if (httpMessages.isEmpty()) {
             errors.add(Constant.messages.getString("postman.import.error.noItem"));
+            Stats.incCounter("stats.postman.error.nomsgs");
         }
         return httpMessages;
     }
@@ -135,6 +139,10 @@ public boolean importCollection(
 
         outputErrors(errors, initViaUi);
 
+        if (!errors.isEmpty()) {
+            Stats.incCounter("stats.postman.errors", errors.size());
+        }
+
         return errors.isEmpty();
     }
 
@@ -273,6 +281,7 @@ static HttpMessage extractHttpMessage(
                             IMPORT_FORMAT_ERROR,
                             item.getName(),
                             Constant.messages.getString("postman.import.errorMsg.reqNotPresent")));
+            Stats.incCounter("stats.postman.error.noreq");
             return null;
         }
 
@@ -283,6 +292,7 @@ static HttpMessage extractHttpMessage(
                             IMPORT_FORMAT_ERROR,
                             item.getName(),
                             Constant.messages.getString("postman.import.errorMsg.urlNotPresent")));
+            Stats.incCounter("stats.postman.error.nourl");
             return null;
         }
 
@@ -306,6 +316,7 @@ static HttpMessage extractHttpMessage(
                             IMPORT_FORMAT_ERROR,
                             item.getName(),
                             Constant.messages.getString("postman.import.errorMsg.rawInvalid")));
+            Stats.incCounter("stats.postman.error.exception");
             return null;
         }
 
@@ -322,6 +333,7 @@ static HttpMessage extractHttpMessage(
                 }
             }
         }
+        Stats.incCounter("stats.postman.messages");
 
         Body body = request.getBody();
         if (body == null || body.isDisabled()) {
@@ -423,6 +435,7 @@ static HttpMessage extractHttpMessage(
                                 IMPORT_WARNING,
                                 item.getName(),
                                 e1.getClass().getName() + ": " + e1.getMessage()));
+                Stats.incCounter("stats.postman.error.badfile");
             }
         } else if (mode.equals(Body.GRAPHQL)) {
             if (body.getGraphQl() == null) {
@@ -503,6 +516,7 @@ private static String generateMultiPartBody(
                                 IMPORT_WARNING,
                                 itemName,
                                 "Could not read file: " + e.getMessage()));
+                Stats.incCounter("stats.postman.error.badfile");
                 return "";
             }
         } else {
@@ -528,6 +542,7 @@ private static String getFileContentType(String value, List<String> errors, Stri
                                     + e.getClass().getName()
                                     + ": "
                                     + e.getMessage()));
+            Stats.incCounter("stats.postman.error.badfiletype");
             return "";
         }
     }

addOns/postman/src/test/java/org/zaproxy/addon/postman/PostmanParserUnitTest.java

@@ -54,15 +54,21 @@
 import org.zaproxy.addon.postman.models.KeyValueData;
 import org.zaproxy.addon.postman.models.PostmanCollection;
 import org.zaproxy.addon.postman.models.Request;
+import org.zaproxy.zap.extension.stats.InMemoryStats;
 import org.zaproxy.zap.testutils.TestUtils;
+import org.zaproxy.zap.utils.Stats;
 
 class PostmanParserUnitTest extends TestUtils {
 
+    private InMemoryStats stats;
+
     @BeforeEach
     void setup() throws Exception {
         setUpZap();
         startServer();
         mockMessages(new ExtensionPostman());
+        stats = new InMemoryStats();
+        Stats.addListener(stats);
     }
 
     @AfterEach
@@ -287,6 +293,9 @@ void shouldExtractHttpMessagesFromItems(List<AbstractItem> items, int numberOfit
         PostmanParser.extractHttpMessages(items, httpMessages);
 
         assertEquals(numberOfitems, httpMessages.size());
+        assertEquals(
+                stats.getStats("").get("stats.postman.messages"),
+                httpMessages.size() == 0 ? null : (long) httpMessages.size());
     }
 
     // The 'Content-Type' header gets set according to the mode of the request body, but if it's
@@ -351,6 +360,13 @@ void shouldHandleRequestBodyModes(Body body, String contentType, String stringBo
         assertEquals(
                 stringBody,
                 new String(httpMessage.getRequestBody().getContent(), StandardCharsets.UTF_8));
+        assertEquals(stats.getStats("").get("stats.postman.messages"), 1);
+    }
+
+    private long getStatsErrorCount() {
+        return stats.getStats("stats.postman.error.").values().stream()
+                .mapToLong(Long::longValue)
+                .sum();
     }
 
     @ParameterizedTest
@@ -366,6 +382,7 @@ void shouldGiveErrors(String collectionJson, List<String> expectedErrors)
         for (int i = 0; i < errors.size(); i++) {
             assertEquals(expectedErrors.get(i), errors.get(i));
         }
+        assertEquals(getStatsErrorCount(), errors.size());
     }
 
     @MethodSource("variablesTestData")