Class: Spaceship::ConnectAPI::AppScreenshot

Inherits:
Object
  • Object
show all
Includes:
Model
Defined in:
spaceship/lib/spaceship/connect_api/models/app_screenshot.rb

Instance Attribute Summary collapse

Attributes included from Model

#id, #reverse_attr_map

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Model

#attr_mapping, included, #initialize, #reverse_attr_mapping, #to_json, #update_attributes

Instance Attribute Details

#asset_delivery_state ⇒ Object

Returns the value of attribute asset_delivery_state.



20
21
22
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 20

def asset_delivery_state
  @asset_delivery_state
end

#asset_token ⇒ Object

Returns the value of attribute asset_token.



17
18
19
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 17

def asset_token
  @asset_token
end

#asset_type ⇒ Object

Returns the value of attribute asset_type.



18
19
20
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 18

def asset_type
  @asset_type
end

#file_name ⇒ Object

Returns the value of attribute file_name.



14
15
16
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 14

def file_name
  @file_name
end

#file_size ⇒ Object

Returns the value of attribute file_size.



13
14
15
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 13

def file_size
  @file_size
end

#image_asset ⇒ Object

Returns the value of attribute image_asset.



16
17
18
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 16

def image_asset
  @image_asset
end

#source_file_checksum ⇒ Object

Returns the value of attribute source_file_checksum.



15
16
17
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 15

def source_file_checksum
  @source_file_checksum
end

#upload_operations ⇒ Object

Returns the value of attribute upload_operations.



19
20
21
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 19

def upload_operations
  @upload_operations
end

#uploaded ⇒ Object

Returns the value of attribute uploaded.



21
22
23
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 21

def uploaded
  @uploaded
end

Class Method Details

.create(client: nil, app_screenshot_set_id: nil, path: nil, wait_for_processing: true) ⇒ Object

API



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 82

def self.create(client: nil, app_screenshot_set_id: nil, path: nil, wait_for_processing: true)
  client ||= Spaceship::ConnectAPI
  require 'faraday'

  filename = File.basename(path)
  filesize = File.size(path)
  bytes = File.binread(path)

  post_attributes = {
    fileSize: filesize,
    fileName: filename
  }

  # Create placeholder to upload screenshot
  begin
    screenshot = client.post_app_screenshot(
      app_screenshot_set_id: app_screenshot_set_id,
      attributes: post_attributes
    ).first
  rescue => error
    # Sometimes creating a screenshot with the web session App Store Connect API
    # will result in a false failure. The response will return a 503 but the database
    # insert will eventually go through.
    #
    # When this is observed, we will poll until we find the matchin screenshot that
    # is awaiting for upload and file size
    #
    # https://github.com/fastlane/fastlane/pull/16842
    time = Time.now.to_i

    timeout_minutes = (ENV["SPACESHIP_SCREENSHOT_UPLOAD_TIMEOUT"] || 20).to_i

    loop do
      # This error handling needs to be revised since any error occurred can reach here.
      # It should handle errors based on what status code is.
      puts("Waiting for screenshots to appear before uploading. This is unlikely to be recovered unless it's 503 error. error=\"#{error}\"")
      sleep(30)

      screenshots = Spaceship::ConnectAPI::AppScreenshotSet
                    .get(client: client, app_screenshot_set_id: app_screenshot_set_id)
                    .app_screenshots

      screenshot = screenshots.find do |s|
        s.awaiting_upload? && s.file_size == filesize
      end

      break if screenshot

      time_diff = Time.now.to_i - time
      raise error if time_diff >= (60 * timeout_minutes)
    end
  end

  # Upload the file
  upload_operations = screenshot.upload_operations
  Spaceship::ConnectAPI::FileUploader.upload(upload_operations, bytes)

  # Update file uploading complete
  patch_attributes = {
    uploaded: true,
    sourceFileChecksum: Digest::MD5.hexdigest(bytes)
  }

  # Patch screenshot that file upload is complete
  # Catch error if patch retries due to 504. Origal patch
  # may go through by return response as 504.
  begin
    screenshot = Spaceship::ConnectAPI.patch_app_screenshot(
      app_screenshot_id: screenshot.id,
      attributes: patch_attributes
    ).first
  rescue => error
    puts("Failed to patch app screenshot. Update may have gone through so verifying") if Spaceship::Globals.verbose?

    screenshot = client.get_app_screenshot(app_screenshot_id: screenshot.id).first
    raise error unless screenshot.complete?
  end

  # Wait for processing
  if wait_for_processing
    loop do
      if screenshot.complete?
        puts("Screenshot processing complete!") if Spaceship::Globals.verbose?
        break
      elsif screenshot.error?
        messages = ["Error processing screenshot '#{screenshot.file_name}'"] + screenshot.error_messages
        raise messages.join(". ")
      end

      # Poll every 2 seconds
      sleep_time = 2
      puts("Waiting #{sleep_time} seconds before checking status of processing...") if Spaceship::Globals.verbose?
      sleep(sleep_time)

      screenshot = client.get_app_screenshot(app_screenshot_id: screenshot.id).first
    end
  end

  return screenshot
end

.type ⇒ Object 



35
36
37
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 35

def self.type
  return "appScreenshots"
end

Instance Method Details

#awaiting_upload? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 39

def awaiting_upload?
  (asset_delivery_state || {})["state"] == "AWAITING_UPLOAD"
end

#complete? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 43

def complete?
  (asset_delivery_state || {})["state"] == "COMPLETE"
end

#delete!(client: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object 



183
184
185
186
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 183

def delete!(client: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  client ||= Spaceship::ConnectAPI
  client.delete_app_screenshot(app_screenshot_id: id)
end

#error? ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 47

def error?
  (asset_delivery_state || {})["state"] == "FAILED"
end

#error_messages ⇒ Object 



51
52
53
54
55
56
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 51

def error_messages
  errors = (asset_delivery_state || {})["errors"]
  (errors || []).map do |error|
    [error["code"], error["description"]].compact.join(" - ")
  end
end

#image_asset_url(width: nil, height: nil, type: "png") ⇒ Object

This does not download the source image (exact image that was uploaded) This downloads a modified version. This image won’t have the same checksums as source_file_checksum.

There is an open radar for allowing downloading of source file. openradar.appspot.com/radar?id=4980344105205760



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'spaceship/lib/spaceship/connect_api/models/app_screenshot.rb', line 64

def image_asset_url(width: nil, height: nil, type: "png")
  return nil if image_asset.nil?

  template_url = image_asset["templateUrl"]
  width ||= image_asset["width"]
  height ||= image_asset["height"]

  return template_url
         .gsub("{w}", width.to_s)
         .gsub("{h}", height.to_s)
         .gsub("{f}", type)
end