Class: Fastlane::Actions::IosSendAppSizeMetricsAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb

Constant Summary collapse

IPA_FILE_SIZE_KEY =

Keys used by the metrics payload

'File Size'.freeze
IPA_DOWNLOAD_SIZE_KEY =

value from ‘File.size` of the Universal `.ipa`

'Download Size'.freeze
IPA_INSTALL_SIZE_KEY =

value from ‘app-thinning.plist`

'Install Size'.freeze

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



161
162
163
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb', line 161

def self.authors
  ['Automattic']
end

.available_options ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb', line 79

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :api_url,
      env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_API_URL',
      description: 'The endpoint API URL to publish metrics to. (Note: you can also point to a `file://` URL to write the payload to a file instead)',
      type: String,
      optional: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :api_token,
      env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_API_TOKEN',
      description: 'The bearer token to call the API. Required, unless `api_url` is a `file://` URL',
      type: String,
      optional: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :use_gzip_content_encoding,
      env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_USE_GZIP_CONTENT_ENCODING',
      description: 'Specify that we should use `Content-Encoding: gzip` and gzip the body when sending the request',
      type: FastlaneCore::Boolean,
      default_value: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :app_name,
      env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_APP_NAME',
      description: 'The name of the app for which we are publishing metrics, to help with filtering and grouping',
      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 with filtering and grouping',
      type: String,
      optional: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :build_type,
      env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_BUILD_TYPE',
      description: 'The build configuration for which we are publishing metrics, to help with filtering and grouping. E.g. `Debug`, `Release`',
      type: String,
      optional: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :source,
      env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_SOURCE',
      description: 'The type of event at the origin of that build, to help with filtering and grouping. E.g. `pr`, `beta`, `final-release`',
      type: String,
      optional: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :ipa_path,
      env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_IPA_PATH',
      description: 'The path to the `.ipa` to extract size information from',
      type: String,
      optional: false,
      default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
      verify_block: proc do |value|
        UI.user_error!('You must provide an path to an existing `.ipa` file') unless File.exist?(value)
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :app_thinning_plist_path,
      env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_APP_THINNING_PLIST_PATH',
      description: 'The path to the `app-thinning.plist` file to extract thinning size information from. ' \
        + 'By default, will try to use the `app-thinning.plist` file next to the `ipa_path`, if that file exists',
      type: String,
      optional: true,
      default_value_dynamic: true
    ),
  ]
end

.description ⇒ Object 



56
57
58
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb', line 56

def self.description
  'Send iOS app size metrics to our metrics server'
end

.details ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb', line 60

def self.details
  <<~DETAILS
    Send iOS app size metrics to our metrics server.

    In order to get Xcode generate the `app-thinning.plist` file (during `gym` and the export of the `.xcarchive`), you need to:
      (1) Use either `ad-hoc`, `enterprise` or `development` export method (in particular, won't work with `app-store`),
      (2) Provide `thinning: '<thin-for-all-variants>'` as part of your `export_options` of `gym` (or in your `options.plist` file if you use raw `xcodebuild`)
    See https://help.apple.com/xcode/mac/11.0/index.html#/devde46df08a

    For builds exported with the `app-store` method, `xcodebuild` won't generate an `app-thinning.plist` file; so you will only be able to get
    the Universal `.ipa` file size as a metric, but won't get the per-device, broken-down install and download sizes for each thinned variant.

    See https://github.com/Automattic/apps-metrics for the API contract expected by the Metrics server you are expected to send those metrics to.

    Tip: If you provide a `file://` URL for the `api_url`, the action will write the payload on disk at the specified path instead of sending
    the data to a endpoint over network. This can be useful e.g. to inspect the payload and debug it, or to store the metrics data as CI artefacts.
  DETAILS
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb', line 165

def self.is_supported?(platform)
  platform == :ios
end

.return_type ⇒ Object 



153
154
155
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb', line 153

def self.return_type
  :integer
end

.return_value ⇒ Object 



157
158
159
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb', line 157

def self.return_value
  'The HTTP return code from the call. Expect a 201 when new metrics were received successfully and entries created in the database'
end

.run(params) ⇒ Object

value from ‘app-thinning.plist`



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_send_app_size_metrics.rb', line 12

def self.run(params)
  # Check input parameters
  api_url = URI(params[:api_url])
  api_token = params[:api_token]
  if (api_token.nil? || api_token.empty?) && !api_url.is_a?(URI::File)
    UI.user_error!('An API token is required when using an `api_url` with a scheme other than `file://`')
  end

  # Build the payload base
  metrics_helper = Fastlane::Helper::AppSizeMetricsHelper.new(
    Platform: 'iOS',
    'App Name': params[:app_name],
    'App Version': params[:app_version],
    'Build Type': params[:build_type],
    Source: params[:source]
  )
  metrics_helper.add_metric(name: IPA_FILE_SIZE_KEY, value: File.size(params[:ipa_path]))

  # Add app-thinning metrics to the payload if a `.plist` is provided
  app_thinning_plist_path = params[:app_thinning_plist_path] || File.join(File.dirname(params[:ipa_path]), 'app-thinning.plist')
  if File.exist?(app_thinning_plist_path)
    plist = Plist.parse_xml(app_thinning_plist_path)
    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'] }
        metrics_helper.add_metric(name: IPA_DOWNLOAD_SIZE_KEY, value: variant['sizeCompressedApp'], metadata: variant_metadata)
        metrics_helper.add_metric(name: IPA_INSTALL_SIZE_KEY, value: variant['sizeUncompressedApp'], metadata: variant_metadata)
      end
    end
  end

  # Send the payload
  metrics_helper.send_metrics(
    to: api_url,
    api_token: api_token,
    use_gzip: params[:use_gzip_content_encoding]
  )
end