Add source metadata/ConfigItem and reorder metas

Author: AliSoftware

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

@@ -14,10 +14,11 @@ def self.run(params)
 
         # Build the payload base
         payload = Fastlane::WPMRT::AppSizeMetricsPayload.new(
+          'Platform': 'iOS',
           'App Name': params[:app_name],
-          'Build Type': params[:build_type],
           'App Version': params[:app_version],
-          'Platform': 'iOS'
+          'Build Type': params[:build_type],
+          'Source': params[:source],
         )
         payload.add_metric(name: 'File Size', value: File.size(params[:ipa_path]))
 
@@ -100,19 +101,26 @@ def self.available_options
             type: String,
             optional: false
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :app_version,
+            env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_APP_VERSION',
+            description: 'The version of the app for which we are publishing metrics, to help filter by app in the dashboard',
+            type: String,
+            optional: false
+          ),
           FastlaneCore::ConfigItem.new(
             key: :build_type,
             env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_BUILD_TYPE',
-            description: 'The build type for which we are publishing metrics, to help filter by app in the dashboard. Typically one of: `pr`, `beta`, `release`',
+            description: 'The build configuration for which we are publishing metrics, to help filter by app in the dashboard. E.g. `Debug`, `Release`',
             type: String,
-            optional: false
+            optional: true
           ),
           FastlaneCore::ConfigItem.new(
-            key: :app_version,
-            env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_APP_VERSION',
-            description: 'The version of the app for which we are publishing metrics, to help filter by app in the dashboard',
+            key: :source,
+            env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_SOURCE',
+            description: 'The type of build at the origin of that build, to help filter by app in the dashboard. E.g. `pr`, `beta`, `final-release`',
             type: String,
-            optional: false
+            optional: true
           ),
           FastlaneCore::ConfigItem.new(
             key: :ipa_path,

spec/ios_send_app_size_metrics_spec.rb

@@ -54,10 +54,11 @@ def test_app_size_action(fake_ipa_size:, expected_json:, **other_action_args)
   it 'sends the right payload from just an ipa file' do
     expected_json = {
       meta: [
+        { name: 'Platform', value: 'iOS' },
         { name: 'App Name', value: 'my-app' },
-        { name: 'Build Type', value: 'beta' },
         { name: 'App Version', value: '1.2.3' },
-        { name: 'Platform', value: 'iOS' },
+        { name: 'Build Type', value: 'beta' },
+        { name: 'Source', value: 'unit-test' },
       ],
       metrics: [
         { name: 'File Size', value: 123_456 },
@@ -69,7 +70,8 @@ def test_app_size_action(fake_ipa_size:, expected_json:, **other_action_args)
       expected_json: expected_json,
       app_name: 'my-app',
       build_type: 'beta',
-      app_version: '1.2.3'
+      app_version: '1.2.3',
+      source: 'unit-test'
     )
   end
 

spec/test-data/app_size_metrics/ios-metrics-payload.json

@@ -1,20 +1,20 @@
 {
   "meta": [
     {
-      "name": "App Name",
-      "value": "wordpress"
+      "name": "Platform",
+      "value": "iOS"
     },
     {
-      "name": "Build Type",
-      "value": "internal"
+      "name": "App Name",
+      "value": "wordpress"
     },
     {
       "name": "App Version",
       "value": "19.8.0.2"
     },
     {
-      "name": "Platform",
-      "value": "iOS"
+      "name": "Build Type",
+      "value": "internal"
     }
   ],
   "metrics": [