fastlane 2.98.0 → 2.99.0

data/fastlane_core/lib/fastlane_core/analytics/analytics_event_builder.rb

@@ -1,50 +1,21 @@
 module FastlaneCore
   class AnalyticsEventBuilder
-    attr_accessor :base_hash
     attr_accessor :action_name
 
-    def initialize(oauth_app_name: nil, p_hash: nil, session_id: nil, action_name: nil, timestamp_millis: (Time.now.to_f * 1000).to_i)
+    def initialize(p_hash: nil, session_id: nil, action_name: nil)
+      @p_hash = p_hash
+      @session_id = session_id
       @action_name = action_name
-      @base_hash = {
-        event_source: {
-          oauth_app_name: oauth_app_name,
-          product: 'fastlane'
-        },
-        actor: {
-          name: p_hash,
-          detail: session_id
-        },
-        millis_since_epoch: timestamp_millis,
-        version: 1
-      }
-    end
-
-    def launched_event(primary_target_hash: nil, secondary_target_hash: nil)
-      return new_event(
-        stage: 'launched',
-        primary_target_hash: primary_target_hash,
-        secondary_target_hash: secondary_target_hash
-      )
-    end
-
-    def completed_event(primary_target_hash: nil, secondary_target_hash: nil)
-      return new_event(
-        stage: 'completed',
-        primary_target_hash: primary_target_hash,
-        secondary_target_hash: secondary_target_hash
-      )
     end
 
-    def new_event(stage: nil, primary_target_hash: nil, secondary_target_hash: nil)
-      raise 'Need at least a primary_target_hash' if primary_target_hash.nil?
-      event = base_hash.dup
-      event[:action] = {
-          name: stage,
-          detail: action_name
+    def new_event(action_stage)
+      {
+        client_id: @p_hash,
+        category: :undefined,
+        action: action_stage,
+        label: action_name,
+        value: nil
       }
-      event[:primary_target] = primary_target_hash
-      event[:secondary_target] = secondary_target_hash unless secondary_target_hash.nil?
-      return event
     end
   end
 end

data/fastlane_core/lib/fastlane_core/analytics/analytics_ingester_client.rb

@@ -1,49 +1,53 @@
+require 'faraday'
 require 'openssl'
+require 'json'
 
 require_relative '../helper'
 
 module FastlaneCore
   class AnalyticsIngesterClient
-    def post_events(events)
-      unless Helper.test?
-        Thread.new do
-          send_request(json: { analytics: events }.to_json)
-        end
+    GA_URL = "https://www.google-analytics.com"
+
+    private_constant :GA_URL
+
+    def initialize(ga_tracking)
+      @ga_tracking = ga_tracking
+    end
+
+    def post_event(event)
+      # If our users want to opt out of usage metrics, don't post the events.
+      # Learn more at https://docs.fastlane.tools/#metrics
+      if Helper.test? || FastlaneCore::Env.truthy?("FASTLANE_OPT_OUT_USAGE")
+        return nil
+      end
+      return Thread.new do
+        send_request(event)
       end
-      return true
     end
 
-    def send_request(json: nil, retries: 2)
-      post_request(body: json)
+    def send_request(event, retries: 2)
+      post_request(event)
     rescue
       retries -= 1
       retry if retries >= 0
     end
 
-    def post_request(body: nil)
-      if ENV['METRICS_DEBUG']
-        write_json(body)
-      end
-      url = ENV["FASTLANE_METRICS_URL"] || "https://fastlane-metrics.fabric.io"
-
-      require 'faraday'
-      connection = Faraday.new(url) do |conn|
+    def post_request(event)
+      connection = Faraday.new(GA_URL) do |conn|
+        conn.request(:url_encoded)
         conn.adapter(Faraday.default_adapter)
-        if ENV['METRICS_DEBUG']
-          conn.proxy = "https://127.0.0.1:8888"
-          conn.ssl[:verify_mode] = OpenSSL::SSL::VERIFY_NONE
-        end
-      end
-      connection.post do |req|
-        req.url('/public')
-        req.headers['Content-Type'] = 'application/json'
-        req.body = body
       end
-    end
-
-    # This method is only for debugging purposes
-    def write_json(body)
-      File.write("#{ENV['HOME']}/Desktop/mock_analytics-#{Time.now.to_i}.json", body)
+      connection.headers[:user_agent] = 'fastlane/' + Fastlane::VERSION
+      connection.post("/collect", {
+        v: "1",                                            # API Version
+        tid: @ga_tracking,                                 # Tracking ID / Property ID
+        cid: event[:client_id],                            # Client ID
+        t: "event",                                        # Event hit type
+        ec: event[:category],                              # Event category
+        ea: event[:action],                                # Event action
+        el: event[:label] || "na",                         # Event label
+        ev: event[:value] || "0"                           # Event value
+      })
     end
   end
 end

data/fastlane_core/lib/fastlane_core/analytics/analytics_session.rb

@@ -4,204 +4,44 @@ require_relative 'analytics_event_builder'
 
 module FastlaneCore
   class AnalyticsSession
+    GA_TRACKING = "UA-121171860-1"
+
+    private_constant :GA_TRACKING
     attr_accessor :session_id
     attr_accessor :client
-    attr_accessor :events
-    attr_accessor :fastfile_id
-    attr_accessor :is_fastfile
-    alias fastfile? is_fastfile
-
-    # make this a method so that we can override it in monkey patches
-    def oauth_app_name
-      return 'fastlane_v2'
-    end
 
-    def initialize(analytics_ingester_client: AnalyticsIngesterClient.new)
+    def initialize(analytics_ingester_client: AnalyticsIngesterClient.new(GA_TRACKING))
       require 'securerandom'
       @session_id = SecureRandom.uuid
       @client = analytics_ingester_client
-      @events = []
-      @is_fastfile = false
-    end
-
-    def backfill_p_hashes(p_hash: nil)
-      return if p_hash.nil? || p_hash == ActionLaunchContext::UNKNOWN_P_HASH || @events.count == 0
-      @events.reverse_each do |event|
-        # event[:actor][:name] is the field in which we store the p_hash
-        # to be sent to analytics ingester.
-        # If they are nil, we want to fill them in until we reach
-        # an event that already has a p_hash.
-        if event[:actor][:name].nil? || event[:actor][:name] == ActionLaunchContext::UNKNOWN_P_HASH
-          event[:actor][:name] = p_hash
-        else
-          break
-        end
-      end
+      @threads = []
+      @launch_event_sent = false
     end
 
     def action_launched(launch_context: nil)
-      backfill_p_hashes(p_hash: launch_context.p_hash)
+      if @launch_event_sent || launch_context.p_hash.nil?
+        return
+      end
 
+      @launch_event_sent = true
       builder = AnalyticsEventBuilder.new(
-        oauth_app_name: oauth_app_name,
         p_hash: launch_context.p_hash,
         session_id: session_id,
-        action_name: launch_context.action_name
-      )
-
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'fastlane_version',
-          detail: fastlane_version
-        }
-      )
-
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'configuration_language',
-          detail: launch_context.configuration_language
-        }
-      )
-
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'install_method',
-          detail: install_method
-        }
-      )
-
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'operating_system',
-          detail: operating_system
-        },
-        secondary_target_hash: {
-          name: 'version',
-          detail: operating_system_version
-        }
-      )
-
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'build_tool_version',
-          detail: launch_context.build_tool_version
-        }
-      )
-
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'ci',
-          detail: ci?.to_s
-        }
-      )
-
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'fastfile',
-          detail: fastfile?.to_s
-        },
-        secondary_target_hash: {
-          name: 'fastfile_id',
-          detail: fastfile_id.to_s
-        }
+        action_name: nil
       )
 
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'platform',
-          detail: launch_context.platform.to_s
-        }
-      )
-
-      @events << builder.launched_event(
-        primary_target_hash: {
-          name: 'ruby_version',
-          detail: ruby_version
-        }
-      )
-    end
-
-    def is_fastfile=(value)
-      if value
-        # If true, update all of the events to reflect
-        # that the execution is running within a Fastfile context.
-        # We don't want to update if this is false because once we
-        # detect a true value, that is the one to be trusted
-        @events.reverse_each do |event|
-          event[:primary_target][:name] == 'fastfile' ? event[:primary_target][:detail] = value.to_s : next
-        end
+      launch_event = builder.new_event(:launch)
+      post_thread = client.post_event(launch_event)
+      unless post_thread.nil?
+        @threads << post_thread
       end
-      @is_fastfile = value
     end
 
     def action_completed(completion_context: nil)
-      backfill_p_hashes(p_hash: completion_context.p_hash)
-
-      builder = AnalyticsEventBuilder.new(
-        oauth_app_name: oauth_app_name,
-        p_hash: completion_context.p_hash,
-        session_id: session_id,
-        action_name: completion_context.action_name
-      )
-
-      @events << builder.completed_event(
-        primary_target_hash: {
-          name: 'status',
-          detail: completion_context.status
-        }
-      )
     end
 
     def finalize_session
-      # If our users want to opt out of usage metrics, don't post the events.
-      # Learn more at https://docs.fastlane.tools/#metrics
-      return if FastlaneCore::Env.truthy?("FASTLANE_OPT_OUT_USAGE")
-
-      client.post_events(@events)
-    end
-
-    def fastlane_version
-      return Fastlane::VERSION
-    end
-
-    def ruby_version
-      patch_level = RUBY_PATCHLEVEL == 0 ? nil : "p#{RUBY_PATCHLEVEL}"
-      return "#{RUBY_VERSION}#{patch_level}"
-    end
-
-    def operating_system
-      return Helper.operating_system
-    end
-
-    def install_method
-      if Helper.rubygems?
-        return 'gem'
-      elsif Helper.bundler?
-        return 'bundler'
-      elsif Helper.mac_app?
-        return 'mac_app'
-      elsif Helper.contained_fastlane?
-        return 'standalone'
-      elsif Helper.homebrew?
-        return 'homebrew'
-      else
-        return 'unknown'
-      end
-    end
-
-    def ci?
-      return Helper.ci?
-    end
-
-    def operating_system_version
-      os = self.operating_system
-      case os
-      when "macOS"
-        return system('sw_vers', out: File::NULL) ? `sw_vers -productVersion`.strip : 'unknown'
-      else
-        # Need to test in Windows and Linux... not sure this is enough
-        return Gem::Platform.local.version
-      end
+      @threads.map(&:join)
     end
   end
 end

data/fastlane_core/lib/fastlane_core/analytics/app_identifier_guesser.rb

@@ -31,7 +31,7 @@ module FastlaneCore
     # Use the `FASTLANE_OPT_OUT_USAGE` variable to opt out
     # The resulting value is e.g. ce12f8371df11ef6097a83bdf2303e4357d6f5040acc4f76019489fa5deeae0d
     def generate_p_hash(app_id)
-      unless !FastlaneCore::Env.truthy?("FASTLANE_OPT_OUT_USAGE") && !app_id.nil?
+      if app_id.nil?
         return nil
       end
 

data/fastlane_core/lib/fastlane_core/build_watcher.rb

@@ -47,7 +47,7 @@ module FastlaneCore
       end
 
       def report_status(build: nil)
-        # Due to iTunes Connect, builds disappear from the build list altogether
+        # Due to App Store Connect, builds disappear from the build list altogether
         # after they finished processing. Before returning this build, we have to
         # wait for the build to appear in the build list again
         # As this method is very often used to wait for a build, and then do something
@@ -59,7 +59,7 @@ module FastlaneCore
         elsif build.ready_to_submit? || build.export_compliance_missing? || build.review_rejected?
           UI.success("Successfully finished processing the build #{build.train_version} - #{build.build_version}")
         else
-          UI.message("Waiting for iTunes Connect to finish processing the new build (#{build.train_version} - #{build.build_version})")
+          UI.message("Waiting for App Store Connect to finish processing the new build (#{build.train_version} - #{build.build_version})")
         end
       end
     end

data/fastlane_core/lib/fastlane_core/itunes_transporter.rb

@@ -47,7 +47,7 @@ module FastlaneCore
 
       if hide_output
         # Show a one time message instead
-        UI.success("Waiting for iTunes Connect transporter to be finished.")
+        UI.success("Waiting for App Store Connect transporter to be finished.")
         UI.success("iTunes Transporter progress... this might take a few minutes...")
       end
 
@@ -190,11 +190,11 @@ module FastlaneCore
       unless password === /^[0-9a-zA-Z\.\$\_]*$/
         UI.error([
           "Password contains special characters, which may not be handled properly by iTMSTransporter.",
-          "If you experience problems uploading to iTunes Connect, please consider changing your password to something with only alphanumeric characters."
+          "If you experience problems uploading to App Store Connect, please consider changing your password to something with only alphanumeric characters."
         ].join(' '))
       end
       # rubocop:enable Style/CaseEquality
-      UI.error("Could not download/upload from iTunes Connect! It's probably related to your password or your internet connection.")
+      UI.error("Could not download/upload from App Store Connect! It's probably related to your password or your internet connection.")
     end
 
     private
@@ -334,7 +334,7 @@ module FastlaneCore
     def download(app_id, dir = nil)
       dir ||= "/tmp"
 
-      UI.message("Going to download app metadata from iTunes Connect")
+      UI.message("Going to download app metadata from App Store Connect")
       command = @transporter_executor.build_download_command(@user, @password, app_id, dir, @provider_short_name)
       UI.verbose(@transporter_executor.build_download_command(@user, 'YourPassword', app_id, dir, @provider_short_name))
 
@@ -351,7 +351,7 @@ module FastlaneCore
       successful = result && File.directory?(itmsp_path)
 
       if successful
-        UI.success("✅ Successfully downloaded the latest package from iTunes Connect to #{itmsp_path}")
+        UI.success("✅ Successfully downloaded the latest package from App Store Connect to #{itmsp_path}")
       else
         handle_error(@password)
       end
@@ -359,7 +359,7 @@ module FastlaneCore
       successful
     end
 
-    # Uploads the modified package back to iTunes Connect
+    # Uploads the modified package back to App Store Connect
     # @param app_id [Integer] The unique App ID
     # @param dir [String] the path in which the package file is located
     # @return (Bool) True if everything worked fine
@@ -368,7 +368,7 @@ module FastlaneCore
     def upload(app_id, dir)
       actual_dir = File.join(dir, "#{app_id}.itmsp")
 
-      UI.message("Going to upload updated app to iTunes Connect")
+      UI.message("Going to upload updated app to App Store Connect")
       UI.success("This might take a few minutes. Please don't interrupt the script.")
 
       command = @transporter_executor.build_upload_command(@user, @password, actual_dir, @provider_short_name)
@@ -382,7 +382,7 @@ module FastlaneCore
       end
 
       if result
-        UI.header("Successfully uploaded package to iTunes Connect. It might take a few minutes until it's visible online.")
+        UI.header("Successfully uploaded package to App Store Connect. It might take a few minutes until it's visible online.")
 
         FileUtils.rm_rf(actual_dir) unless Helper.test? # we don't need the package any more, since the upload was successful
       else