Class: Fastlane::Actions::CleanTestflightTestersAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 


70
71
72
 
# File 'lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb', line 70

def self.authors
  ["KrauseFx"]
end

.available_options ⇒ Object 


78
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
 
# File 'lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb', line 78

def self.available_options
  user = CredentialsManager::AppfileConfig.try_fetch_value(:itunes_connect_id)
  user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)

  [
    FastlaneCore::ConfigItem.new(key: :username,
                               short_option: "-u",
                               env_name: "CLEAN_TESTFLIGHT_TESTERS_USERNAME",
                               description: "Your Apple ID Username",
                               default_value: user),
    FastlaneCore::ConfigItem.new(key: :app_identifier,
                                 short_option: "-a",
                                 env_name: "CLEAN_TESTFLIGHT_TESTERS_APP_IDENTIFIER",
                                 description: "The bundle identifier of the app to upload or manage testers (optional)",
                                 optional: true,
                                 default_value: ENV["TESTFLIGHT_APP_IDENTITIFER"] || CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)),
    FastlaneCore::ConfigItem.new(key: :team_id,
                                 short_option: "-q",
                                 env_name: "CLEAN_TESTFLIGHT_TESTERS_TEAM_ID",
                                 description: "The ID of your iTunes Connect team if you're in multiple teams",
                                 optional: true,
                                 is_string: false, # as we also allow integers, which we convert to strings anyway
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
                                 verify_block: proc do |value|
                                   ENV["FASTLANE_ITC_TEAM_ID"] = value.to_s
                                 end),
    FastlaneCore::ConfigItem.new(key: :team_name,
                                 short_option: "-r",
                                 env_name: "CLEAN_TESTFLIGHT_TESTERS_TEAM_NAME",
                                 description: "The name of your iTunes Connect team if you're in multiple teams",
                                 optional: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
                                 verify_block: proc do |value|
                                   ENV["FASTLANE_ITC_TEAM_NAME"] = value.to_s
                                 end),
    FastlaneCore::ConfigItem.new(key: :days_of_inactivity,
                               short_option: "-k",
                               env_name: "CLEAN_TESTFLIGHT_TESTERS_WAIT_PROCESSING_INTERVAL",
                               description: "Numbers of days a tester has to be inactive for (no build uses) for them to be removed",
                               default_value: 30,
                               type: Integer,
                               verify_block: proc do |value|
                                 UI.user_error!("Please enter a valid positive number of days") unless value.to_i > 0
                               end),
    FastlaneCore::ConfigItem.new(key: :oldest_build_allowed,
                               short_option: "-b",
                               env_name: "CLEAN_TESTFLIGHT_TESTERS_OLDEST_BUILD_ALLOWED",
                               description: "Oldest build number allowed. All testers with older builds will be removed",
                               optional: true,
                               default_value: 0,
                               type: Integer,
                               verify_block: proc do |value|
                                 UI.user_error!("Please enter a valid build number") unless value.to_i >= 0
                               end),
    FastlaneCore::ConfigItem.new(key: :dry_run,
                               short_option: "-d",
                               env_name: "CLEAN_TESTFLIGHT_TESTERS_DRY_RUN",
                               description: "Only print inactive users, don't delete them",
                               default_value: false,
                               is_string: false)
  ]
end

.description ⇒ Object 


66
67
68
 
# File 'lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb', line 66

def self.description
  "Automatically remove TestFlight testers that are not actually testing your app"
end

.details ⇒ Object 


74
75
76
 
# File 'lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb', line 74

def self.details
  "Automatically remove TestFlight testers that are not actually testing your app"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 

141
142
143
 
# File 'lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb', line 141

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

.remove_tester(tester, app, dry_run) ⇒ Object 


57
58
59
60
61
62
63
64
 
# File 'lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb', line 57

def self.remove_tester(tester, app, dry_run)
  if dry_run
    UI.message("TestFlight tester #{tester.email} seems to be inactive for app ID #{app.id}")
  else
    UI.message("Removing tester #{tester.email} due to inactivity from app ID #{app.id}...")
    tester.delete_from_apps(apps: [app])
  end
end

.run(params) ⇒ Object 


4
5
6
7
8
9
10
11
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
51
52
53
54
55
 
# File 'lib/fastlane/plugin/clean_testflight_testers/actions/clean_testflight_testers_action.rb', line 4

def self.run(params)
  require 'spaceship'

  app_identifier = params[:app_identifier]
  username = params[:username]

  UI.message("Login to iTunes Connect (#{username})")
  Spaceship::Tunes.(username)
  Spaceship::Tunes.select_team
  UI.message("Login successful")

  UI.message("Fetching all TestFlight testers, this might take a few minutes, depending on the number of testers")

  # Convert from bundle identifier to app ID
  spaceship_app ||= Spaceship::ConnectAPI::App.find(app_identifier)
  UI.user_error!("Couldn't find app '#{app_identifier}' on the account of '#{username}' on iTunes Connect") unless spaceship_app

  all_testers = spaceship_app.get_beta_testers(includes: "betaTesterMetrics", limit: 200)
  counter = 0

  all_testers.each do |current_tester|
    tester_metrics = current_tester.beta_tester_metrics.first

    time = Time.parse(tester_metrics.last_modified_date)
    days_since_status_change = (Time.now - time) / 60.0 / 60.0 / 24.0

    if tester_metrics.beta_tester_state == "INVITED"
      if days_since_status_change > params[:days_of_inactivity]
        remove_tester(current_tester, spaceship_app, params[:dry_run]) # user got invited, but never installed a build... why would you do that?
        counter += 1
      end
    else
      # We don't really have a good way to detect whether the user is active unfortunately
      # So we can just delete users that had no sessions
      if days_since_status_change > params[:days_of_inactivity] && tester_metrics.session_count == 0
        # User had no sessions in the last e.g. 30 days, let's get rid of them
        remove_tester(current_tester, spaceship_app, params[:dry_run])
        counter += 1
      elsif params[:oldest_build_allowed] && tester_metrics.installed_cf_bundle_short_version_string.to_i > 0 && tester_metrics.installed_cf_bundle_short_version_string.to_i < params[:oldest_build_allowed]
        # User has a build that is too old, let's get rid of them
        remove_tester(current_tester, spaceship_app, params[:dry_run])
        counter += 1
      end
    end
  end

  if params[:dry_run]
    UI.success("Didn't delete any testers, but instead only printed them out (#{counter}), disable `dry_run` to actually delete them 🦋")
  else
    UI.success("Successfully removed #{counter} testers 🦋")
  end
end