Rename api_base_url to api_url

Since we expect it to point to the full URL, including the `/api/grouped-metrics` path, in order to be as flexible as possible

Author: AliSoftware

lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_send_app_size_metrics.rb

@@ -5,10 +5,10 @@ module Actions
     class AndroidSendAppSizeMetricsAction < Action
       def self.run(params)
         # Check input parameters
-        base_url = URI(params[:api_base_url])
+        api_url = URI(params[:api_url])
         api_token = params[:api_token]
-        if (api_token.nil? || api_token.empty?) && !base_url.is_a?(URI::File)
-          UI.user_error!('An API token is required when using an `api_base_url` with a scheme other than `file://`')
+        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
@@ -48,7 +48,7 @@ def self.run(params)
 
         # Send the payload
         metrics_helper.send_metrics(
-          base_url: base_url,
+          to: api_url,
           api_token: api_token,
           use_gzip: params[:use_gzip_content_encoding]
         )
@@ -82,24 +82,24 @@ def self.details
 
           See https://github.com/Automattic/apps-metrics for the API contract expected by the Metrics server you will send those metrics to.
 
-          Tip: If you provide a `file://` URL for the `api_base_url`, the action will write the payload on disk at the specified path instead of sending
+          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
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(
-            key: :api_base_url,
-            env_name: 'FL_ANDROID_SEND_APP_SIZE_METRICS_API_BASE_URL',
+            key: :api_url,
+            env_name: 'FL_ANDROID_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_ANDROID_SEND_APP_SIZE_METRICS_API_TOKEN',
-            description: 'The bearer token to call the API. Required, unless `api_base_url` is a `file://` URL',
+            description: 'The bearer token to call the API. Required, unless `api_url` is a `file://` URL',
             type: String,
             optional: true
           ),

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

@@ -6,10 +6,10 @@ module Actions
     class IosSendAppSizeMetricsAction < Action
       def self.run(params)
         # Check input parameters
-        base_url = URI(params[:api_base_url])
+        api_url = URI(params[:api_url])
         api_token = params[:api_token]
-        if (api_token.nil? || api_token.empty?) && !base_url.is_a?(URI::File)
-          UI.user_error!('An API token is required when using an `api_base_url` with a scheme other than `file://`')
+        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
@@ -38,7 +38,7 @@ def self.run(params)
 
         # Send the payload
         metrics_helper.send_metrics(
-          base_url: base_url,
+          to: api_url,
           api_token: api_token,
           use_gzip: params[:use_gzip_content_encoding]
         )
@@ -66,24 +66,24 @@ def self.details
 
           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_base_url`, the action will write the payload on disk at the specified path instead of sending
+          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
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(
-            key: :api_base_url,
-            env_name: 'FL_IOS_SEND_APP_SIZE_METRICS_API_BASE_URL',
+            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_base_url` is a `file://` URL',
+            description: 'The bearer token to call the API. Required, unless `api_url` is a `file://` URL',
             type: String,
             optional: true
           ),

lib/fastlane/plugin/wpmreleasetoolkit/helper/app_size_metrics_helper.rb

@@ -49,12 +49,12 @@ def to_h
       #
       # Must conform to the API described in https://github.com/Automattic/apps-metrics/wiki/Queue-Group-of-Metrics
       #
-      # @param [String,URI] base_url The base URL of the App Metrics service
+      # @param [String,URI] to The URL of the App Metrics service, or a `file://` URL to write the payload to disk
       # @param [String] api_token The API bearer token to use to register the metric.
       # @return [Integer] the HTTP response code
       #
-      def send_metrics(base_url:, api_token:, use_gzip: true)
-        uri = URI(base_url)
+      def send_metrics(to:, api_token:, use_gzip: true)
+        uri = URI(to)
         json_payload = use_gzip ? Zlib.gzip(to_h.to_json) : to_h.to_json
 
         # Allow using a `file:` URI for debugging

spec/android_send_app_size_metrics_spec.rb

@@ -33,7 +33,7 @@ def test_app_size_action(fake_aab_size:, fake_apks:, expected_payload:, **other_
 
       # Act
       code = run_described_fastlane_action(
-        api_base_url: File.join('file://localhost/', output_file),
+        api_url: File.join('file://localhost/', output_file),
         aab_path: aab_path,
         **other_action_args
       )

spec/app_size_metrics_helper_spec.rb

@@ -79,9 +79,9 @@
       it 'writes the payload uncompressed to a file when disabling gzip' do
         in_tmp_dir do |tmp_dir|
           output_file = File.join(tmp_dir, 'payload.json')
-          base_url = File.join('file://localhost/', output_file)
+          file_url = File.join('file://localhost/', output_file)
 
-          code = metrics_helper.send_metrics(base_url: base_url, api_token: nil, use_gzip: false)
+          code = metrics_helper.send_metrics(to: file_url, api_token: nil, use_gzip: false)
 
           expect(code).to eq(201)
           expect(File).to exist(output_file)
@@ -93,9 +93,9 @@
       it 'writes the payload compressed to a file when enabling gzip' do
         in_tmp_dir do |tmp_dir|
           output_file = File.join(tmp_dir, 'payload.json.gz')
-          base_url = File.join('file://localhost/', output_file)
+          file_url = File.join('file://localhost/', output_file)
 
-          code = metrics_helper.send_metrics(base_url: base_url, api_token: nil, use_gzip: true)
+          code = metrics_helper.send_metrics(to: file_url, api_token: nil, use_gzip: true)
 
           expect(code).to eq(201)
           expect(File).to exist(output_file)
@@ -106,7 +106,7 @@
     end
 
     context 'when using non-file:// scheme for the URL' do
-      let(:base_url) { 'https://fake-metrics-server/api/grouped-metrics' }
+      let(:api_url) { 'https://fake-metrics-server/api/grouped-metrics' }
       let(:token) { 'fake#tokn' }
 
       it 'sends the payload uncompressed to the server and with the right headers when disabling gzip' do
@@ -116,11 +116,11 @@
           'Content-Type': 'application/json'
         }
         last_received_body = nil
-        stub = stub_request(:post, base_url).with(headers: expected_headers) do |req|
+        stub = stub_request(:post, api_url).with(headers: expected_headers) do |req|
           last_received_body = req.body
         end.to_return(status: 201)
 
-        code = metrics_helper.send_metrics(base_url: base_url, api_token: token, use_gzip: false)
+        code = metrics_helper.send_metrics(to: api_url, api_token: token, use_gzip: false)
 
         expect(code).to eq(201)
         expect(stub).to have_been_made.once
@@ -135,11 +135,11 @@
           'Content-Encoding': 'gzip'
         }
         last_received_body = nil
-        stub = stub_request(:post, base_url).with(headers: expected_headers) do |req|
+        stub = stub_request(:post, api_url).with(headers: expected_headers) do |req|
           last_received_body = req.body
         end.to_return(status: 201)
 
-        code = metrics_helper.send_metrics(base_url: base_url, api_token: token, use_gzip: true)
+        code = metrics_helper.send_metrics(to: api_url, api_token: token, use_gzip: true)
 
         expect(code).to eq(201)
         expect(stub).to have_been_made.once

spec/ios_send_app_size_metrics_spec.rb

@@ -14,7 +14,7 @@ def test_app_size_action(fake_ipa_size:, expected_payload:, **other_action_args)
 
       # Act
       code = run_described_fastlane_action(
-        api_base_url: File.join('file://localhost/', output_file),
+        api_url: File.join('file://localhost/', output_file),
         ipa_path: ipa_path,
         **other_action_args
       )