Automatically remove nil values in metadata

Author: AliSoftware

lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb

@@ -27,7 +27,7 @@ def self.run(params)
           plist['variants'].each do |_key, variant|
             variant_descriptors = variant['variantDescriptors'] || [{ 'device' => 'Universal' }]
             variant_descriptors.each do |desc|
-              variant_metadata = { device: desc['device'], 'OS Version': desc['os-version'] }.compact
+              variant_metadata = { device: desc['device'], 'OS Version': desc['os-version'] }
               payload.add_metric(name: 'Download Size', value: variant['sizeCompressedApp'], meta: variant_metadata)
               payload.add_metric(name: 'Install Size', value: variant['sizeUncompressedApp'], meta: variant_metadata)
             end

lib/fastlane/plugin/wpmreleasetoolkit/models/app_size_metrics_payload.rb

@@ -17,7 +17,7 @@ def initialize(group_meta = {})
       # @param [Hash] hash The metadata common to all the metrics to set on the whole payload. Can be any arbitrary set of key/value pairs
       #
       def meta=(hash)
-        @meta = (hash || {}).map { |key, value| { name: key.to_s, value: value } }
+        @meta = (hash.compact || {}).map { |key, value| { name: key.to_s, value: value } }
       end
 
       # Adds a single metric to the group of metrics
@@ -28,7 +28,8 @@ def meta=(hash)
       #
       def add_metric(name:, value:, meta: nil)
         metric = { name: name, value: value }
-        metric[:meta] = meta.map { |meta_key, meta_value| { name: meta_key.to_s, value: meta_value } } unless meta.nil?
+        meta = (meta || {}).compact # Remove nil values if any
+        metric[:meta] = meta.map { |meta_key, meta_value| { name: meta_key.to_s, value: meta_value } } unless meta.empty?
         @metrics.append(metric)
       end
 

spec/app_size_metrics_payload_spec.rb

@@ -39,4 +39,45 @@
     }
     expect(payload.to_h).to eq(expected_hash)
   end
+
+  it 'removes `nil` values in metadata' do
+    payload = described_class.new({
+                                    'Group Metadata 1': 'Group Value 1',
+                                    'Group Metadata 2': nil,
+                                    'Group Metadata 3': 'Group Value 3'
+                                  })
+    payload.add_metric(name: 'Metric 1', value: 12_345, meta: { m1a: 'Metric 1 Metadata A', m1c: nil, m1c: 'Metric 1 Metadata C' })
+    payload.add_metric(name: 'Metric 2', value: 67_890, meta: { m2a: nil })
+    payload.add_metric(name: 'Metric 3', value: 13_579, meta: { m3a: 'Metric 3 Metadata A', m3b: 'Metric 3 Metadata B' })
+
+    expected_hash = {
+      meta: [
+        { name: 'Group Metadata 1', value: 'Group Value 1' },
+        { name: 'Group Metadata 3', value: 'Group Value 3' },
+      ],
+      metrics: [
+        {
+          name: 'Metric 1',
+          value: 12_345,
+          meta: [
+            { name: 'm1a', value: 'Metric 1 Metadata A' },
+            { name: 'm1c', value: 'Metric 1 Metadata C' },
+          ]
+        },
+        {
+          name: 'Metric 2',
+          value: 67_890
+        },
+        {
+          name: 'Metric 3',
+          value: 13_579,
+          meta: [
+            { name: 'm3a', value: 'Metric 3 Metadata A' },
+            { name: 'm3b', value: 'Metric 3 Metadata B' },
+          ]
+        },
+      ]
+    }
+    expect(payload.to_h).to eq(expected_hash)
+  end
 end

spec/test-data/app_size_metrics/app-size-metrics-payload.json

@@ -5905,10 +5905,6 @@
         {
           "name": "device",
           "value": "Universal"
-        },
-        {
-          "name": "OS Version",
-          "value": null
         }
       ]
     },
@@ -5919,10 +5915,6 @@
         {
           "name": "device",
           "value": "Universal"
-        },
-        {
-          "name": "OS Version",
-          "value": null
         }
       ]
     }