carthage_remote_cache 0.0.5 → 0.0.10

data/lib/constants.rb

@@ -1,12 +1,14 @@
-CARTHAGE_DIR = 'Carthage'
-CARTHAGE_BUILD_DIR = File.join(CARTHAGE_DIR, 'Build')
-CARTFILE_RESOLVED = 'Cartfile.resolved'
-CARTRCFILE = 'Cartrcfile'
+CARTHAGE_DIR = "Carthage"
+CARTHAGE_BUILD_DIR = File.join(CARTHAGE_DIR, "Build")
+CARTFILE_RESOLVED = "Cartfile.resolved"
+CARTRCFILE = "Cartrcfile"
 THREAD_POOL_SIZE = 8
 
 SERVER_DEFAULT_PORT = 9292
-SERVER_CACHE_DIR = File.join(Dir.home, '.carthagerc_server')
+SERVER_CACHE_DIR = File.join(Dir.home, ".carthagerc_server")
 
 ARCHIVE_CHECKSUM_HEADER_REST_CLIENT = :archive_checksum
-ARCHIVE_CHECKSUM_HEADER_SINATRA_IN = 'HTTP_ARCHIVE_CHECKSUM'
-ARCHIVE_CHECKSUM_HEADER_SINATRA_OUT = 'Archive-Checksum'
+ARCHIVE_CHECKSUM_HEADER_SINATRA_IN = "HTTP_ARCHIVE_CHECKSUM"
+ARCHIVE_CHECKSUM_HEADER_SINATRA_OUT = "Archive-Checksum"
+
+PLATFORMS = [:iOS, :macOS, :tvOS, :watchOS]

data/lib/crc32.rb

@@ -1,5 +1,5 @@
-require 'digest'
-require 'zlib'
+require "digest"
+require "zlib"
 
 class Digest::CRC32 < Digest::Class
   include Digest::Instance
@@ -17,6 +17,6 @@ class Digest::CRC32 < Digest::Class
   end
 
   def finish
-    [@crc32].pack('N')
+    [@crc32].pack("N")
   end
 end

data/lib/errors.rb

@@ -19,6 +19,64 @@ class MultipleErrorsError < AppError
   end
 end
 
-class OutdatedFrameworkBuildError < AppError; end
+class VersionFileDoesNotExistError < AppError; end
+
+class OutdatedFrameworkBuildError < AppError
+  attr_reader :framework_name, :build_version, :cartfile_resolved_version
+
+  def initialize(framework_name, build_version, cartfile_resolved_version)
+    @framework_name = framework_name
+    @build_version = build_version
+    @cartfile_resolved_version = cartfile_resolved_version
+  end
+
+  def ==(o)
+    self.class == o.class && state == o.state
+  end
+
+  def to_s
+    "framework name: #{@framework_name}, build version: #{@build_version}, resolved version: #{@cartfile_resolved_version}"
+  end
+
+  protected
+
+  def state
+    [@framework_name, @build_version, @cartfile_resolved_version]
+  end
+end
+
+class FrameworkValidationError < AppError
+  def initialize(errors)
+    @errors = errors
+  end
+
+  def to_s
+    header = ["Framework", CARTHAGE_BUILD_DIR, CARTFILE_RESOLVED]
+    rows = @errors.map { |e| [e.framework_name, e.build_version, e.cartfile_resolved_version] }
+    table = Table.new(header, rows)
+    <<~EOS
+      Detected differences between existing frameworks in '#{CARTHAGE_BUILD_DIR}' and entries in '#{CARTFILE_RESOLVED}':
+
+      #{table}
+
+      To resolve the issue:
+      - run `carthagerc download` to fetch missing frameworks from the server.
+      - if the issue persists, run `carthage bootstrap` to build frameworks and `carthagerc upload` to populate the server.
+    EOS
+  end
+end
 
 class MissingFrameworkDirectoryError < AppError; end
+
+class ServerVersionMismatchError < AppError; end
+
+class PlatformMismatchError < AppError
+  def initialize(platform)
+    @platform = platform
+  end
+
+  def to_s
+    platforms = PLATFORMS.map(&:to_s).join(", ")
+    "Platform '#{@platform}' doesn't match any of: #{platforms}"
+  end
+end

data/lib/log.rb

@@ -1,4 +1,4 @@
-require 'logger'
+require "logger"
 
 $LOG = Logger.new(STDOUT)
 $LOG.level = Logger::INFO

data/lib/networking.rb

@@ -1,23 +1,48 @@
-require 'rest-client'
-require 'uri'
+require "rest-client"
+require "uri"
 
 class Networking
-  def initialize(config)
+  def initialize(config, is_retry_enabled)
     @config = config
+    @is_retry_enabled = is_retry_enabled
+  end
+
+  # Version
+
+  def get_server_version
+    url = new_version_url
+    $LOG.debug("Fetching server version from #{url}")
+    server_version = perform_network_request do
+      RestClient.get(url) do |response, request, result|
+        if response.code == 200
+          response.strip
+        else
+          raise AppError.new, "Failed to read server version from #{url}, response:\n  #{response[0...300]}"
+        end
+      end
+    end
+    server_version
   end
 
   # Version Files
 
   # @return VersionFile or nil
-  def download_version_file(carthage_dependency)
+  def download_version_file(carthage_dependency, platforms)
     url = new_version_file_url(carthage_dependency)
-    $LOG.debug("Downloading version file from #{url}")
-    version_file = RestClient.get(url) do |response, request, result|
-      if response.code == 200
-        File.write(carthage_dependency.version_filename, response.to_s)
-        VersionFile.new(carthage_dependency.version_filename)
-      else
-        nil
+    params = {}
+    unless platforms.nil?
+      params[:platform] = platforms.map(&:to_s).join(",")
+    end
+
+    version_file = perform_network_request do
+      $LOG.debug("Downloading version file from #{url}, params: #{params}")
+      RestClient.get(url, { params: params }) do |response, request, result|
+        if response.code == 200
+          File.write(carthage_dependency.version_filename, response.to_s)
+          VersionFile.new(carthage_dependency.version_filename)
+        else
+          nil
+        end
       end
     end
     version_file
@@ -26,10 +51,12 @@ class Networking
   # @raise AppError on upload failure
   def upload_version_file(carthage_dependency)
     url = new_version_file_url(carthage_dependency)
-    $LOG.debug("Uploading #{carthage_dependency.version_filename}")
-    RestClient.post(url, :version_file => File.new(carthage_dependency.version_filepath)) do |response, request, result|
-      unless response.code == 200
-        raise AppError.new, "Version file upload #{carthage_dependency.version_filename} failed, response:\n  #{response[0..300]}"
+    perform_network_request do
+      $LOG.debug("Uploading #{carthage_dependency.version_filename}")
+      RestClient.post(url, :version_file => File.new(carthage_dependency.version_filepath)) do |response, request, result|
+        unless response.code == 200
+          raise AppError.new, "Version file upload #{carthage_dependency.version_filename} failed, response:\n  #{response[0..300]}"
+        end
       end
     end
   end
@@ -39,14 +66,16 @@ class Networking
   # @return Hash with CarthageArchive and checksum or nil
   def download_framework_archive(carthage_dependency, framework_name, platform)
     url = new_framework_url(carthage_dependency, framework_name, platform)
-    $LOG.debug("Downloading framework from #{url}")
-    archive = RestClient.get(url) do |response, request, result|
-      if response.code == 200
-        archive = CarthageArchive.new(framework_name, platform)
-        File.write(archive.archive_path, response.to_s)
-        {:archive => archive, :checksum => response.headers[ARCHIVE_CHECKSUM_HEADER_REST_CLIENT]}
-      else
-        nil
+    archive = perform_network_request do
+      $LOG.debug("Downloading framework from #{url}")
+      RestClient.get(url) do |response, request, result|
+        if response.code == 200
+          archive = CarthageArchive.new(framework_name, platform)
+          File.write(archive.archive_path, response.to_s)
+          { :archive => archive, :checksum => response.headers[ARCHIVE_CHECKSUM_HEADER_REST_CLIENT] }
+        else
+          nil
+        end
       end
     end
     archive
@@ -55,21 +84,27 @@ class Networking
   # @raise AppError when upload fails
   def upload_framework_archive(zipfile_name, carthage_dependency, framework_name, platform, checksum)
     url = new_framework_url(carthage_dependency, framework_name, platform)
-    params = {:framework_file => File.new(zipfile_name)}
-    headers = {ARCHIVE_CHECKSUM_HEADER_REST_CLIENT => checksum}
-    $LOG.debug("Uploading framework to #{url}, headers: #{headers}")
-    RestClient.post(url, params, headers) do |response, request, result|
-      unless response.code == 200
-        raise AppError.new, "Framework upload #{zipfile_name} failed, response:\n  #{response[0..300]}"
+    params = { :framework_file => File.new(zipfile_name) }
+    headers = { ARCHIVE_CHECKSUM_HEADER_REST_CLIENT => checksum }
+    perform_network_request do
+      $LOG.debug("Uploading framework to #{url}, headers: #{headers}")
+      RestClient.post(url, params, headers) do |response, request, result|
+        unless response.code == 200
+          raise AppError.new, "Framework upload #{zipfile_name} failed, response:\n  #{response[0..300]}"
+        end
       end
     end
   end
 
   private
 
+  def new_version_url
+    new_server_url(["version"])
+  end
+
   def new_version_file_url(carthage_dependency)
     new_server_url([
-      'versions',
+      "versions",
       @config.xcodebuild_version,
       @config.swift_version,
       carthage_dependency.guessed_framework_basename,
@@ -80,7 +115,7 @@ class Networking
 
   def new_framework_url(carthage_dependency, framework_name, platform)
     new_server_url([
-      'frameworks',
+      "frameworks",
       @config.xcodebuild_version,
       @config.swift_version,
       carthage_dependency.guessed_framework_basename,
@@ -96,13 +131,37 @@ class Networking
       :scheme => @config.server_uri.scheme,
       :host => @config.server_uri.host,
       :port => @config.server_uri.port,
-      :path => '/' + sanitized_path_slices.join('/'),
+      :path => "/" + sanitized_path_slices.join("/"),
     )
     uri.to_s
   end
 
   # Mangle identifiers for URL paths.
   def sanitized(input)
-    input.gsub(/\//, '_')
+    input.gsub(/\//, "_")
+  end
+
+  def perform_network_request
+    if @is_retry_enabled
+      retries_remaining = 3
+      sleep_time_seconds = 5
+      begin
+        result = yield
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+             Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        if retries_remaining > 0
+          $LOG.warn("Network request failed - remaining retries: #{retries_remaining}, sleeping for: #{sleep_time_seconds}s, error: #{e.message}")
+          sleep(sleep_time_seconds)
+          retries_remaining -= 1
+          sleep_time_seconds *= 3
+          retry
+        else
+          raise e
+        end
+      end
+      result
+    else
+      yield
+    end
   end
 end

data/lib/server/config.ru

@@ -1,6 +1,6 @@
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 Bundler.require
 
-require './server_app.rb'
+require "./server_app.rb"
 run Sinatra::Application

data/lib/server/server_app.rb

@@ -1,22 +1,41 @@
-require 'sinatra'
-require 'fileutils'
-require 'carthage_remote_cache'
+require "json"
+require "sinatra"
+require "fileutils"
+require "carthage_remote_cache"
 
-get '/' do
+get "/" do
   "Welcome to carthage_remote_cache"
 end
 
-versions_path = '/versions/:xcodebuild_version/:swift_version/:dependency_name/:version/:version_filename'
-frameworks_path = '/frameworks/:xcodebuild_version/:swift_version/:dependency_name/:version/:framework_name/:platform'
+version_path = "/version"
+versions_path = "/versions/:xcodebuild_version/:swift_version/:dependency_name/:version/:version_filename"
+frameworks_path = "/frameworks/:xcodebuild_version/:swift_version/:dependency_name/:version/:framework_name/:platform"
+
+get version_path do
+  status(200)
+  VERSION
+end
 
 get versions_path do
+  if params.key?(:platform)
+    begin
+      platforms = platform_to_symbols(params[:platform])
+    rescue AppError => e
+      status(400)
+      return JSON.pretty_generate({ "error" => e.message })
+    end
+  else
+    platforms = PLATFORMS
+  end
+
   dirname = params_to_framework_dir(params)
   filename = params[:version_filename]
   filepath = File.join(dirname, filename)
 
   if File.exist?(filepath)
     status(200)
-    send_file(filepath)
+    version_file = VersionFile.new(filepath, platforms)
+    JSON.pretty_generate(version_file.json)
   else
     status(404)
   end
@@ -33,7 +52,7 @@ post versions_path do
   File.delete(target_filename) if File.exist?(target_filename)
 
   $LOG.info("Writing: #{target_filename}")
-  File.open(target_filename, 'wb') do |target_file|
+  File.open(target_filename, "wb") do |target_file|
     target_file.write(source_file.read)
   end
 
@@ -69,7 +88,7 @@ post frameworks_path do
   File.delete(target_filename) if File.exist?(target_filename)
 
   $LOG.info("Writing: #{target_filename}")
-  File.open(target_filename, 'wb') do |target_file|
+  File.open(target_filename, "wb") do |target_file|
     target_file.write(source_file.read)
   end
 

data/lib/shell_wrapper.rb

@@ -1,4 +1,4 @@
-require 'open3'
+require "open3"
 
 class ShellWrapper
   # @return

data/lib/table.rb

@@ -0,0 +1,58 @@
+class Table
+  def initialize(header, rows)
+    @header = header
+    @rows = rows
+    @column_sizes = calculate_column_sizes
+  end
+
+  def to_s
+    lines = [
+      separator_line,
+      header_line,
+      separator_line,
+      @rows.map { |r| row_line(r) },
+      separator_line,
+    ]
+
+    lines
+      .flatten
+      .reject { |line| line.empty? }
+      .join("\n")
+  end
+
+  private
+
+  def calculate_column_sizes
+    all = [@header] + @rows
+    result = all.transpose.map do |row|
+      lengths = row.map { |r| r.length }
+      lengths.max + 2
+    end
+    result
+  end
+
+  def separator_line
+    dashes = @column_sizes.map { |size| "-" * size }
+    "+" + dashes.join("+") + "+"
+  end
+
+  def header_line
+    columns = @header.each_with_index.map do |column, index|
+      column_size = @column_sizes[index] - 1
+      " %-#{column_size}.#{column_size}s" % column
+    end
+    "|" + columns.join("|") + "|"
+  end
+
+  def row_line(row)
+    columns = row.each_with_index.map do |column, index|
+      column_size = @column_sizes[index] - 1
+      if index == 0
+        " %-#{column_size}.#{column_size}s" % column
+      else
+        "%#{column_size}.#{column_size}s " % column
+      end
+    end
+    "|" + columns.join("|") + "|"
+  end
+end

data/lib/utils.rb

@@ -15,7 +15,7 @@ end
 def quote(input)
   if input.is_a? String
     if input.empty?
-      ''
+      ""
     else
       '"' + input + '"'
     end
@@ -23,7 +23,7 @@ def quote(input)
     input
       .map { |e| quote(e) }
       .select { |e| !e.empty? }
-      .join(' ')
+      .join(" ")
   else
     raise AppError.new, "Unsupported type #{input}"
   end
@@ -32,13 +32,13 @@ end
 def platform_to_api_string(platform)
   case platform
   when :iOS
-    'iOS'
+    "iOS"
   when :macOS
-    'macOS'
+    "macOS"
   when :tvOS
-    'tvOS'
+    "tvOS"
   when :watchOS
-    'watchOS'
+    "watchOS"
   else
     raise AppError.new, "Unrecognized platform #{platform.inspect}"
   end
@@ -47,18 +47,28 @@ end
 def platform_to_carthage_dir_string(platform)
   case platform
   when :iOS
-    'iOS'
+    "iOS"
   when :macOS
-    'Mac'
+    "Mac"
   when :tvOS
-    'tvOS'
+    "tvOS"
   when :watchOS
-    'watchOS'
+    "watchOS"
   else
     raise AppError.new, "Unrecognized platform #{platform.inspect}"
   end
 end
 
+def platform_to_symbols(string)
+  platforms = string.split(",").map(&:to_sym)
+  for platform in platforms
+    if !PLATFORMS.include?(platform)
+      raise PlatformMismatchError.new(platform)
+    end
+  end
+  platforms
+end
+
 # @return string in "x.y MB" format
 def format_file_size(bytes)
   megabytes = bytes / 1000.0 / 1000.0