Merge pull request #541 from handymenny/subtypes-in-metada

parsing: add subtypes to metadata
handymenny · Nov 17, 2024 · a270623 · a270623
2 parents ac10e5f + ffacb36
commit a270623
Show file tree

Hide file tree

Showing 70 changed files with 236 additions and 134 deletions.
diff --git a/src/main/java/it/smartphonecombo/uecapabilityparser/model/index/IndexLine.kt b/src/main/java/it/smartphonecombo/uecapabilityparser/model/index/IndexLine.kt
@@ -23,17 +23,15 @@ data class IndexLine(
     @EncodeDefault(EncodeDefault.Mode.ALWAYS) var description: String = "",
     var inputs: List<String> = emptyList(),
     var compressed: Boolean = false,
-    var defaultNR: Boolean = false,
     val parserVersion: String,
 ) {
-    // This is only used to extract description and defaultNR from capabilities JSON
+    // This is only used to extract description from capabilities JSON
     private var metadata: MutableMap<String, String>? = null
 
     init {
-        // if metadata is set, extract description and default nr from that
+        // if metadata is set, extract description from that
         metadata?.let {
             description = it["description"] ?: ""
-            defaultNR = it["defaultNR"].toBoolean()
             // unset metadata to free resources
             metadata = null
         }

diff --git a/src/main/java/it/smartphonecombo/uecapabilityparser/server/JavalinApp.kt b/src/main/java/it/smartphonecombo/uecapabilityparser/server/JavalinApp.kt
@@ -248,6 +248,12 @@ class JavalinApp {
             return listOf(Rat.EUTRA)
         }
 
+        // if there's subTypes in metadata return that
+        val subTypes = capabilities.getStringMetadata("subTypes")
+        if (!subTypes.isNullOrEmpty()) {
+            return subTypes.split(", ").mapNotNull(Rat::of)
+        }
+
         val defaultRatList = listOf(Rat.EUTRA, Rat.NR, Rat.EUTRA_NR)
 
         if (inputsLength == 3) {

diff --git a/src/main/java/it/smartphonecombo/uecapabilityparser/server/Requests.kt b/src/main/java/it/smartphonecombo/uecapabilityparser/server/Requests.kt
@@ -39,7 +39,6 @@ class RequestParse(
     val input: InputSource? = null,
     val inputNR: InputSource? = null,
     val inputENDC: InputSource? = null,
-    val defaultNR: Boolean = false,
     val type: LogType,
     val description: String = "",
 ) {
@@ -60,14 +59,7 @@ class RequestParse(
 
             require(ratList.size >= inputs.size) { "Something weird, inputs list >= rat List" }
 
-            return RequestParse(
-                input,
-                inputNR,
-                inputENDC,
-                ratList.first() == Rat.NR,
-                type,
-                description,
-            )
+            return RequestParse(input, inputNR, inputENDC, type, description)
         }
     }
 }

diff --git a/src/main/java/it/smartphonecombo/uecapabilityparser/util/Parsing.kt b/src/main/java/it/smartphonecombo/uecapabilityparser/util/Parsing.kt
@@ -42,16 +42,35 @@ class Parsing(
         capabilities.logType = type
         capabilities.timestamp = Instant.now().toEpochMilli()
         capabilities.setMetadata("processingTime", "${processTime}ms")
-        if (defaultRat == Rat.NR) capabilities.setMetadata("defaultNR", "true")
 
         // Set description
         if (description.isNotEmpty()) {
             capabilities.setMetadata("description", description)
         }
 
+        if (type == LogType.H) {
+            // set subtypes
+            val subTypes =
+                getInputs().mapNotNull {
+                    when (it) {
+                        input -> defaultRat
+                        inputNR -> Rat.NR
+                        inputENDC -> Rat.EUTRA_NR
+                        else -> null
+                    }
+                }
+
+            if (subTypes.isNotEmpty()) {
+                capabilities.addMetadata("subTypes", subTypes.joinToString(", "))
+            }
+        }
+
         return capabilities
     }
 
+    private fun getInputs(): List<InputSource?> =
+        arrayOf(input, inputNR, inputENDC).filterNot { it == null || it.size() == 0L }
+
     private fun parseCapabilities(): Capabilities {
         val imports = LogType.getImporter(type) ?: return Capabilities()
 
@@ -79,16 +98,12 @@ class Parsing(
         val inputDir = "$path/input"
         val outputDir = "$path/output"
         val id = capabilities.id
-        val inputs = arrayOf(input, inputNR, inputENDC)
-        val inputsPath = mutableListOf<String>()
-
-        inputs
-            .filterNot { it == null || it.size() == 0L }
-            .forEachIndexed { index, data ->
+        val inputsPath =
+            getInputs().mapIndexed { index, data ->
                 val fileName = "$id-$index"
                 val inputPath = "$inputDir/$fileName"
                 IOUtils.outputFile(data!!.readBytes(), inputPath, compression)
-                inputsPath.add(fileName)
+                fileName
             }
 
         val encodedString = Json.custom().encodeToString(capabilities)
@@ -101,7 +116,6 @@ class Parsing(
                 capabilities.getStringMetadata("description") ?: "",
                 inputsPath,
                 compression,
-                capabilities.getStringMetadata("defaultNR").toBoolean(),
                 capabilities.parserVersion,
             )
         libraryIndex?.putLine(indexLine)
@@ -112,7 +126,7 @@ class Parsing(
         fun fromRequest(req: RequestParse): Parsing? {
             val defaultRat =
                 when {
-                    req.defaultNR || req.input == null && req.inputNR != null -> Rat.NR
+                    req.input == null && req.inputNR != null -> Rat.NR
                     req.input == null && req.inputENDC != null -> Rat.EUTRA_NR
                     req.input != null -> Rat.EUTRA
                     else -> null

diff --git a/src/test/resources/cli/oracleJson/ueCapHexEutra.json b/src/test/resources/cli/oracleJson/ueCapHexEutra.json
@@ -2319,7 +2319,9 @@
             "rat": "EUTRA"
         }
     ],
-    "metadata": {},
+    "metadata": {
+        "subTypes": "eutra"
+    },
     "id": "",
     "parserVersion": "staging",
     "timestamp": 0

diff --git a/src/test/resources/cli/oracleJson/ueCapHexMrdcSplit.json b/src/test/resources/cli/oracleJson/ueCapHexMrdcSplit.json
@@ -20421,7 +20421,9 @@
             "rat": "NR"
         }
     ],
-    "metadata": {},
+    "metadata": {
+        "subTypes": "eutra, nr, eutra-nr"
+    },
     "id": "",
     "parserVersion": "staging",
     "timestamp": 0

diff --git a/src/test/resources/cli/oracleJson/ueCapHexNr.json b/src/test/resources/cli/oracleJson/ueCapHexNr.json
@@ -221,7 +221,7 @@
         }
     ],
     "metadata": {
-        "defaultNR": "true"
+        "subTypes": "nr"
     },
     "id": "",
     "parserVersion": "staging",

diff --git a/src/test/resources/cli/oracleJson/ueCapHexSegmented.json b/src/test/resources/cli/oracleJson/ueCapHexSegmented.json
@@ -43673,7 +43673,9 @@
             ]
         }
     ],
-    "metadata": {},
+    "metadata": {
+        "subTypes": "eutra"
+    },
     "id": "",
     "parserVersion": "staging",
     "timestamp": 0

diff --git a/src/test/resources/cli/oracleMultiJson/nsgJson.json b/src/test/resources/cli/oracleMultiJson/nsgJson.json
@@ -302,6 +302,7 @@
         ],
         "metadata": {
             "description": "UE NR Cap from NSG, Timestamps: 1727632521830058",
+            "subTypes": "eutra",
             "deviceName": "Google Pixel 7 Pro",
             "deviceType": "Exynos",
             "simId": "2",
@@ -21058,6 +21059,7 @@
         ],
         "metadata": {
             "description": "UE LTE Cap from NSG, Timestamps: 1727632592636862, 1727632592911284",
+            "subTypes": "eutra, eutra-nr",
             "deviceName": "Google Pixel 7 Pro",
             "deviceType": "Exynos",
             "simId": "2",
@@ -25481,6 +25483,7 @@
         ],
         "metadata": {
             "description": "UE LTE Cap from NSG, Timestamps: 1708175715402271",
+            "subTypes": "eutra",
             "deviceName": "",
             "deviceType": "Qualcomm",
             "simId": "1",

diff --git a/src/test/resources/cli/oracleMultiJson/pcap.json b/src/test/resources/cli/oracleMultiJson/pcap.json
@@ -423,7 +423,8 @@
             }
         ],
         "metadata": {
-            "description": "UE NR Cap from PCAP, Timestamps: 1612629633088060"
+            "description": "UE NR Cap from PCAP, Timestamps: 1612629633088060",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -9605,7 +9606,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1612629644496007, 1612629644517236"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1612629644496007, 1612629644517236",
+            "subTypes": "eutra, eutra-nr"
         },
         "id": "",
         "parserVersion": "staging",
@@ -10035,7 +10037,8 @@
             }
         ],
         "metadata": {
-            "description": "UE NR Cap from PCAP, Timestamps: 1612629724916405"
+            "description": "UE NR Cap from PCAP, Timestamps: 1612629724916405",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -10465,7 +10468,8 @@
             }
         ],
         "metadata": {
-            "description": "UE NR Cap from PCAP, Timestamps: 1612629762343068"
+            "description": "UE NR Cap from PCAP, Timestamps: 1612629762343068",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",

diff --git a/src/test/resources/cli/oracleMultiJson/scat.json b/src/test/resources/cli/oracleMultiJson/scat.json
@@ -195,7 +195,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from DLF, Timestamps: 1638043858674893"
+            "description": "UE LTE Cap from DLF, Timestamps: 1638043858674893",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -1220,7 +1221,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from SDM, Timestamps: 1591378346163000"
+            "description": "UE LTE Cap from SDM, Timestamps: 1591378346163000",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",

diff --git a/src/test/resources/cli/oracleMultiJson/segmented.json b/src/test/resources/cli/oracleMultiJson/segmented.json
@@ -80333,7 +80333,8 @@
             }
         ],
         "metadata": {
-            "description": "UE NR Cap from PCAP, Timestamps: 315965578030978"
+            "description": "UE NR Cap from PCAP, Timestamps: 315965578030978",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -212615,7 +212616,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1720055421197912, 1720055421300828, 1720055421338463"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1720055421197912, 1720055421300828, 1720055421338463",
+            "subTypes": "eutra, nr, eutra-nr"
         },
         "id": "",
         "parserVersion": "staging",

diff --git a/src/test/resources/nsgJson/oracle/airscreenQcom.json b/src/test/resources/nsgJson/oracle/airscreenQcom.json
@@ -4413,6 +4413,7 @@
         ],
         "metadata": {
             "description": "UE LTE Cap from NSG, Timestamps: 1708175715402271",
+            "subTypes": "eutra",
             "deviceName": "",
             "deviceType": "Qualcomm",
             "simId": "1",

diff --git a/src/test/resources/nsgJson/oracle/nsgExy.json b/src/test/resources/nsgJson/oracle/nsgExy.json
@@ -302,6 +302,7 @@
         ],
         "metadata": {
             "description": "UE NR Cap from NSG, Timestamps: 1727632521830058",
+            "subTypes": "eutra",
             "deviceName": "Google Pixel 7 Pro",
             "deviceType": "Exynos",
             "simId": "2",
@@ -21058,6 +21059,7 @@
         ],
         "metadata": {
             "description": "UE LTE Cap from NSG, Timestamps: 1727632592636862, 1727632592911284",
+            "subTypes": "eutra, eutra-nr",
             "deviceName": "Google Pixel 7 Pro",
             "deviceType": "Exynos",
             "simId": "2",

diff --git a/src/test/resources/pcap/oracle/exportedPduEutra-capabilities.json b/src/test/resources/pcap/oracle/exportedPduEutra-capabilities.json
@@ -4346,7 +4346,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670593060602816"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670593060602816",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",

diff --git a/src/test/resources/pcap/oracle/exportedPduEutraDifferentFilters-capabilities.json b/src/test/resources/pcap/oracle/exportedPduEutraDifferentFilters-capabilities.json
@@ -983,7 +983,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670070858782740"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670070858782740",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -1539,7 +1540,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670070870420631"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670070870420631",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -1696,7 +1698,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670070955683923"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670070955683923",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -1853,7 +1856,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670070967045658"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670070967045658",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -2059,7 +2063,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670071011211689"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670071011211689",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -2175,7 +2180,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670071018386306"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670071018386306",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -5230,7 +5236,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670071191057261"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670071191057261",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",
@@ -8236,7 +8243,8 @@
             }
         ],
         "metadata": {
-            "description": "UE LTE Cap from PCAP, Timestamps: 1670071462011478"
+            "description": "UE LTE Cap from PCAP, Timestamps: 1670071462011478",
+            "subTypes": "eutra"
         },
         "id": "",
         "parserVersion": "staging",