Class: Fastlane::Actions::ShowDetailedSdkSizeAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.available_options ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/fastlane/plugin/stream_actions/actions/show_detailed_sdk_size.rb', line 97

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :sdk_names,
      description: 'SDK names to analyze',
      is_string: false,
      verify_block: proc do |sdks|
        UI.user_error!("SDK names array has to be specified") unless sdks.kind_of?(Array) && sdks.size.positive?
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :threshold,
      description: 'Set minimum size threshold in bytes',
      optional: true,
      is_string: false,
      default_value: 1
    )
  ]
end

.build_collapsible_table(differences) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/fastlane/plugin/stream_actions/actions/show_detailed_sdk_size.rb', line 67

def self.build_collapsible_table(differences)
  differences_list = differences.to_a
  visible_count = differences_list.length > 10 ? 5 : differences_list.length
  hidden_count = differences_list.length - visible_count

  table = "| `Object` | `Diff (bytes)` |\n| - | - |\n"
  differences_list.first(visible_count).each do |object, diff|
    table << "| #{object} | #{diff} |\n"
  end

  if hidden_count > 0
    table << "\n<details>\n<summary>Show #{hidden_count} more objects</summary>\n\n"
    table << "| `Object` | `Diff (bytes)` |\n| - | - |\n"
    differences_list[visible_count..-1].each do |object, diff|
      table << "| #{object} | #{diff} |\n"
    end
    table << "</details>"
  end

  table
end

.description ⇒ Object 



93
94
95
 
# File 'lib/fastlane/plugin/stream_actions/actions/show_detailed_sdk_size.rb', line 93

def self.description
  'Show SDK objects size'
end

.is_supported?(platform) ⇒ Boolean 



117
118
119
 
# File 'lib/fastlane/plugin/stream_actions/actions/show_detailed_sdk_size.rb', line 117

def self.is_supported?(platform)
  [:ios, :mac].include?(platform)
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
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/fastlane/plugin/stream_actions/actions/show_detailed_sdk_size.rb', line 4

def self.run(params)
  is_release = other_action.current_branch.include?('release/')
  metrics_dir = 'metrics'
  FileUtils.remove_dir(metrics_dir, force: true)
  sh("git clone [email protected]:GetStream/stream-internal-metrics.git #{metrics_dir}")

  params[:sdk_names].each do |sdk|
    metrics_path = "metrics/linkmaps/#{sdk}.json"
    metrics_branch = is_release ? 'release' : 'develop'
    metrics = JSON.parse(File.read(metrics_path))
    old_details = metrics[metrics_branch]
    new_details = other_action.xcsize(
      linkmap: "linkmaps/#{sdk}-arm64-LinkMap.txt",
      threshold: 0 # Threshold is set to 0 to show all objects
    )[:details]

    # Compare old linkmap and new linkmap objects sizes
    differences = {}

    # Handle old linkmap objects
    old_details.each do |object, value|
      new_value = new_details[object] || 0
      diff = new_value - value
      if diff.abs >= params[:threshold]
        differences[object] = diff > 0 ? "+#{diff}" : diff.to_s
      end
    end

    # Handle objects that are present only in new linkmap
    new_details.each do |object, value|
      if value >= params[:threshold] && !old_details.key?(object)
        differences[object] = "+#{value}"
      end
    end

    header = "## #{sdk} XCSize"
    content = "#{header}\nNo changes in SDK size."
    unless differences.empty?
      sorted_differences = differences.sort_by { |_, diff| -diff.to_s.gsub(/[+\-]/, '').to_i }
      content = "#{header}\n#{build_collapsible_table(sorted_differences.to_h)}"
    end
    UI.important(content)

    next unless other_action.is_ci

    if is_release || (ENV['GITHUB_EVENT_NAME'].to_s == 'push' && other_action.current_branch == 'develop')
      metrics[metrics_branch] = new_details
      File.write(metrics_path, JSON.pretty_generate(metrics))
      Dir.chdir(metrics_dir) do
        if sh('git status -s').to_s.empty?
          UI.important('No changes in linkmap.')
        else
          sh('git add -A')
          sh("git commit -m 'Update #{metrics_path}'")
          sh('git push')
        end
      end
    end

    other_action.pr_comment(text: content, edit_last_comment_with_text: header) unless differences.empty?
  end
end