cocoapods-binary-cache 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 284d9870e8f4938c92a779543fffa2810804096cb6cf8504a68cc20c0307acfe
+  data.tar.gz: 7f0ef9d6f2a0afe33cd6fe1c05c77c0ec51d1598f746fbe090faea61ac6cc513
+SHA512:
+  metadata.gz: c3287b32dda1506122f0b1d89be9cf413970c8f3389bc538680db8addfe83ca273df223ded9b31dd3c9ee59c5791331ebee87c93f6f85c3437920d29500952ec
+  data.tar.gz: 7ff8a381f96027f7f45321ef2979f43e5383b8f7dfb787adafd2c7afa0348454632a7ab73b43cb2ff05a89aa15c1aac6ff54f245192d86549d63521b612f56af

data/lib/cocoapods-binary-cache.rb

@@ -0,0 +1,4 @@
+# Copyright 2019 Grabtaxi Holdings PTE LTE (GRAB), All rights reserved.
+# Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
+
+require "cocoapods-binary-cache/gem_version"

data/lib/cocoapods-binary-cache/cache/all.rb

@@ -0,0 +1,9 @@
+require_relative "validation_result"
+require_relative "validator_base"
+require_relative "validator_accumulated"
+require_relative "validator_with_podfile"
+require_relative "validator_non_dev_pods"
+require_relative "validator_dev_pods"
+require_relative "validator_dependencies_graph"
+require_relative "validator_exclusion"
+require_relative "validator"

data/lib/cocoapods-binary-cache/cache/validation_result.rb

@@ -0,0 +1,69 @@
+module PodPrebuild
+  class CacheValidationResult
+    attr_reader :hit, :missed_with_reasons
+
+    def initialize(missed_with_reasons = {}, hit = Set.new)
+      @missed_with_reasons = missed_with_reasons
+      @hit = hit.to_set - missed_with_reasons.keys
+    end
+
+    def missed
+      @missed_with_reasons.keys.to_set
+    end
+
+    def missed?(name)
+      @missed_with_reasons.key?(name)
+    end
+
+    def hit?(name)
+      @hit.include?(name)
+    end
+
+    def include?(name)
+      missed?(name) || hit?(name)
+    end
+
+    def merge(other)
+      PodPrebuild::CacheValidationResult.new(
+        @missed_with_reasons.merge(other.missed_with_reasons),
+        @hit + other.hit
+      )
+    end
+
+    def update_to(path)
+      FileUtils.mkdir_p(File.dirname(path))
+      json_file = PodPrebuild::JSONFile.new(path)
+      json_file["cache_missed"] = missed.to_a
+      json_file["cache_hit"] = hit.to_a
+      json_file.save!
+    end
+
+    def keep(names)
+      base_names = names.map { |name| name.split("/")[0] }.to_set
+      select { |name| base_names.include?(name.split("/")[0]) }
+    end
+
+    def discard(names)
+      base_names = names.map { |name| name.split("/")[0] }.to_set
+      reject { |name| base_names.include?(name.split("/")[0]) }
+    end
+
+    def select(&predicate)
+      PodPrebuild::CacheValidationResult.new(
+        @missed_with_reasons.select { |name, _| predicate.call(name) },
+        @hit.select(&predicate)
+      )
+    end
+
+    def reject(&predicate)
+      select { |name| !predicate.call(name) }
+    end
+
+    def print_summary
+      Pod::UI.puts "Cache validation: hit (#{@hit.count}) #{@hit.to_a}"
+      @missed_with_reasons.each do |name, reason|
+        Pod::UI.puts "Cache validation: missed #{name}. Reason: #{reason}".yellow
+      end
+    end
+  end
+end

data/lib/cocoapods-binary-cache/cache/validator.rb

@@ -0,0 +1,21 @@
+module PodPrebuild
+  class CacheValidator < BaseCacheValidator
+    def initialize(options)
+      super(options)
+      @validators = [
+        PodPrebuild::PodfileChangesCacheValidator.new(options),
+        PodPrebuild::NonDevPodsCacheValidator.new(options)
+      ]
+      @validators << PodPrebuild::DevPodsCacheValidator.new(options) if Pod::Podfile::DSL.dev_pods_enabled
+      @validators << PodPrebuild::DependenciesGraphCacheValidator.new(options)
+      @validators << PodPrebuild::ExclusionCacheValidator.new(options)
+    end
+
+    def validate(*)
+      @validators.reduce(PodPrebuild::CacheValidationResult.new) do |acc, validator|
+        validation = validator.validate(acc)
+        validator.is_a?(AccumulatedCacheValidator) ? validation : acc.merge(validation)
+      end
+    end
+  end
+end

data/lib/cocoapods-binary-cache/cache/validator_accumulated.rb

@@ -0,0 +1,4 @@
+module PodPrebuild
+  class AccumulatedCacheValidator < BaseCacheValidator
+  end
+end

data/lib/cocoapods-binary-cache/cache/validator_base.rb

@@ -0,0 +1,92 @@
+module PodPrebuild
+  class BaseCacheValidator
+    attr_reader :podfile, :pod_lockfile, :prebuilt_lockfile
+    attr_reader :validate_prebuilt_settings, :generated_framework_path
+
+    def initialize(options)
+      @podfile = options[:podfile]
+      @pod_lockfile = options[:pod_lockfile] && PodPrebuild::Lockfile.new(options[:pod_lockfile])
+      @prebuilt_lockfile = options[:prebuilt_lockfile] && PodPrebuild::Lockfile.new(options[:prebuilt_lockfile])
+      @validate_prebuilt_settings = options[:validate_prebuilt_settings]
+      @generated_framework_path = options[:generated_framework_path]
+    end
+
+    def validate(*)
+      raise NotImplementedError
+    end
+
+    def changes_of_prebuilt_lockfile_vs_podfile
+      @changes_of_prebuilt_lockfile_vs_podfile ||= Pod::Installer::Analyzer::SpecsState.new(
+        @prebuilt_lockfile.lockfile.detect_changes_with_podfile(@podfile)
+      )
+    end
+
+    def validate_with_podfile
+      changes = changes_of_prebuilt_lockfile_vs_podfile
+      missed = changes.added.map { |pod| [pod, "Added from Podfile"] }.to_h
+      missed.merge!(changes.changed.map { |pod| [pod, "Updated from Podfile"] }.to_h)
+      PodPrebuild::CacheValidationResult.new(missed, changes.unchanged)
+    end
+
+    def validate_pods(options)
+      pods = options[:pods]
+      subspec_pods = options[:subspec_pods]
+      prebuilt_pods = options[:prebuilt_pods]
+
+      missed = {}
+      hit = Set.new
+
+      check_pod = lambda do |name|
+        version = pods[name]
+        prebuilt_version = prebuilt_pods[name]
+        result = false
+        if prebuilt_version.nil?
+          missed[name] = "Not available (#{version})"
+        elsif prebuilt_version != version
+          missed[name] = "Outdated: (prebuilt: #{prebuilt_version}) vs (#{version})"
+        else
+          settings_diff = incompatible_build_settings(name)
+          if settings_diff.empty?
+            hit << name
+            result = true
+          else
+            missed[name] = "Incompatible build settings: #{settings_diff}"
+          end
+        end
+        result
+      end
+
+      subspec_pods.each do |parent, children|
+        missed_children = children.reject { |child| check_pod.call(child) }
+        if missed_children.empty?
+          hit << parent
+        else
+          missed[parent] = "Subspec pods were missed: #{missed_children}"
+        end
+      end
+
+      non_subspec_pods = pods.reject { |pod| subspec_pods.include?(pod) }
+      non_subspec_pods.each { |pod, _| check_pod.call(pod) }
+      PodPrebuild::CacheValidationResult.new(missed, hit)
+    end
+
+    def read_prebuilt_build_settings(name)
+      return {} if generated_framework_path.nil?
+
+      metadata = PodPrebuild::Metadata.in_dir(generated_framework_path + name)
+      metadata.build_settings
+    end
+
+    def incompatible_build_settings(name)
+      settings_diff = {}
+      prebuilt_build_settings = read_prebuilt_build_settings(name)
+      validate_prebuilt_settings&.(name)&.each do |key, value|
+        prebuilt_value = prebuilt_build_settings[key]
+        unless prebuilt_value.nil? || value == prebuilt_value
+          settings_diff[key] = { :current => value, :prebuilt => prebuilt_value }
+        end
+      end
+      settings_diff
+    end
+  end
+end

data/lib/cocoapods-binary-cache/cache/validator_dependencies_graph.rb

@@ -0,0 +1,20 @@
+module PodPrebuild
+  class DependenciesGraphCacheValidator < AccumulatedCacheValidator
+    def validate(accumulated)
+      return accumulated if library_evolution_supported? || @pod_lockfile.nil?
+
+      dependencies_graph = DependenciesGraph.new(@pod_lockfile.lockfile)
+      clients = dependencies_graph.get_clients(accumulated.missed.to_a)
+      unless Pod::Podfile::DSL.dev_pods_enabled
+        clients = clients.reject { |client| @pod_lockfile.dev_pods.keys.include?(client) }
+      end
+
+      missed = clients.map { |client| [client, "Dependencies were missed"] }.to_h
+      accumulated.merge(PodPrebuild::CacheValidationResult.new(missed, Set.new))
+    end
+
+    def library_evolution_supported?
+      false
+    end
+  end
+end

data/lib/cocoapods-binary-cache/cache/validator_dev_pods.rb

@@ -0,0 +1,22 @@
+module PodPrebuild
+  class DevPodsCacheValidator < BaseCacheValidator
+    def initialize(options)
+      super(options)
+      @sandbox_root = options[:sandbox_root]
+    end
+
+    def validate(*)
+      return PodPrebuild::CacheValidationResult.new if @pod_lockfile.nil?
+
+      # TODO (thuyen): Logic needs to be revised
+      # TODO (thuyen): Migrate the code PodCacheValidator.verify_devpod_checksum to this place
+      missed_with_checksum, hit_with_checksum = PodCacheValidator.verify_devpod_checksum(
+        @sandbox_root,
+        @generated_framework_path,
+        @pod_lockfile.lockfile
+      )
+      missed = missed_with_checksum.transform_values { |checksum| "Checksum changed: #{checksum}" }
+      PodPrebuild::CacheValidationResult.new(missed, hit_with_checksum.keys.to_set)
+    end
+  end
+end

data/lib/cocoapods-binary-cache/cache/validator_exclusion.rb

@@ -0,0 +1,14 @@
+module PodPrebuild
+  class ExclusionCacheValidator < AccumulatedCacheValidator
+    def initialize(options)
+      super(options)
+      @ignored_pods = options[:ignored_pods] || Set.new
+      @prebuilt_pod_names = options[:prebuilt_pod_names]
+    end
+
+    def validate(accumulated)
+      validation = @prebuilt_pod_names.nil? ? accumulated : accumulated.keep(@prebuilt_pod_names)
+      validation.discard(@ignored_pods)
+    end
+  end
+end

data/lib/cocoapods-binary-cache/cache/validator_non_dev_pods.rb

@@ -0,0 +1,13 @@
+module PodPrebuild
+  class NonDevPodsCacheValidator < BaseCacheValidator
+    def validate(*)
+      return PodPrebuild::CacheValidationResult.new if @pod_lockfile.nil?
+
+      validate_pods(
+        pods: @pod_lockfile.non_dev_pods,
+        subspec_pods: @pod_lockfile.subspec_pods,
+        prebuilt_pods: @prebuilt_lockfile.nil? ? {} : @prebuilt_lockfile.non_dev_pods
+      )
+    end
+  end
+end

data/lib/cocoapods-binary-cache/cache/validator_with_podfile.rb

@@ -0,0 +1,9 @@
+module PodPrebuild
+  class PodfileChangesCacheValidator < BaseCacheValidator
+    def validate(*)
+      return PodPrebuild::CacheValidationResult.new if @prebuilt_lockfile.nil? || @podfile.nil?
+
+      validate_with_podfile
+    end
+  end
+end

data/lib/cocoapods-binary-cache/dependencies_graph/dependencies_graph.rb

@@ -0,0 +1,95 @@
+# Copyright 2019 Grabtaxi Holdings PTE LTE (GRAB), All rights reserved.
+# Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
+
+require 'rgl/adjacency'
+require 'rgl/dot'
+require_relative 'graph_visualizer'
+
+# Using RGL graph because GraphViz doesn't store adjacent of a node/vertex but we need to traverse a substree from any node
+# https://github.com/monora/rgl/blob/master/lib/rgl/adjacency.rb
+
+class DependenciesGraph
+  def initialize(lockfile)
+    @lockfile = lockfile
+    @invert_edge = true # A normal edge is an edge (one direction) from library A to library B which is a dependency of A.
+  end
+
+  # Input : a list of library names.
+  # Output: a set of library names which are clients (directly and indirectly) of those input libraries.
+  def get_clients(libnames)
+    result = Set.new()
+    libnames.each do |lib|
+      if graph.has_vertex?(lib)
+        result.merge(traverse_sub_tree(graph, lib))
+      else
+        puts "Warning: cannot find lib: #{lib}"
+      end
+    end
+    result
+  end
+
+  def write_graphic_file(output_graphic_fmt, filename='graph', highlight_nodes=Set[])
+    if !output_graphic_fmt
+      puts 'Error: Need graphic format.'
+      return
+    end
+    graph.write_to_graphic_file(output_graphic_fmt, dotfile=filename, options={}, highlight_nodes)
+  end
+
+  private
+
+  def dependencies
+    @dependencies ||= begin
+      if @lockfile
+        @lockfile.to_hash['PODS']
+      else
+        nil
+      end
+    end
+  end
+
+  # Convert array of dictionaries -> a dictionary with format {A: [A's dependencies]}
+  def pod_to_dependencies
+    dependencies.map { |d| d.is_a?(Hash) ? d : { d => [] } }.reduce({}) { |combined, individual| combined.merge!(individual) }
+  end
+
+  def add_vertex(graph, pod)
+    node_name = sanitized_pod_name(pod)
+    graph.add_vertex(node_name)
+    node_name
+  end
+
+  def sanitized_pod_name(name)
+    Pod::Dependency.from_string(name).name
+  end
+
+  def graph
+    @graph ||= begin
+      graph = RGL::DirectedAdjacencyGraph.new()
+
+      pod_to_dependencies.each do |pod, dependencies|
+        pod_node = add_vertex(graph, pod)
+        next if pod_node.nil?
+        dependencies.each do |dependency|
+          dep_node = add_vertex(graph, dependency)
+          next if dep_node.nil?
+          if @invert_edge
+            graph.add_edge(dep_node, pod_node)
+          else
+            graph.add_edge(pod_node, dep_node)
+          end
+        end
+      end
+      graph
+    end
+  end
+
+  def traverse_sub_tree(graph, vertex)
+    visited_nodes = Set.new()
+    graph.each_adjacent(vertex) do |v|
+      visited_nodes.add(v)
+      visited_nodes.merge(traverse_sub_tree(graph, v))
+    end
+    visited_nodes
+  end
+end

data/lib/cocoapods-binary-cache/dependencies_graph/graph_visualizer.rb

@@ -0,0 +1,74 @@
+# Copyright 2019 Grabtaxi Holdings PTE LTE (GRAB), All rights reserved.
+# Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
+# https://github.com/monora/rgl/blob/0b526e16f9fb344abf387f4c5523d7917ce8f4b1/lib/rgl/dot.rb
+
+require 'rgl/rdot'
+
+module RGL
+  module Graph
+    def to_dot_graph(params={}, highlight_nodes)
+      params['name'] ||= self.class.name.gsub(/:/, '_')
+      fontsize       = params['fontsize'] ? params['fontsize'] : '12'
+      graph          = (directed? ? DOT::Digraph : DOT::Graph).new(params)
+      edge_class     = directed? ? DOT::DirectedEdge : DOT::Edge
+      vertex_options = params['vertex'] || {}
+      edge_options   = params['edge'] || {}
+
+      each_vertex do |v|
+        default_vertex_options =  {
+          'name'     => vertex_id(v),
+          'fontsize' => fontsize,
+          'label'    => vertex_label(v),
+          'style'    => 'filled',
+        }
+        if highlight_nodes.include?(v)
+          default_vertex_options = default_vertex_options.merge({
+            'color' => 'red',
+            'fillcolor' => 'red'
+          })
+        else
+          default_vertex_options = default_vertex_options.merge({
+            'color' => 'blue',
+            'fillcolor' => 'blue'
+          })
+        end
+
+        each_vertex_options = default_vertex_options.merge(vertex_options)
+        vertex_options.each{|option, val| each_vertex_options[option] = val.call(v) if val.is_a?(Proc)}
+        graph << DOT::Node.new(each_vertex_options)
+      end
+
+      each_edge do |u, v|
+        default_edge_options = {
+          'from'     => vertex_id(u),
+          'to'       => vertex_id(v),
+          'fontsize' => fontsize
+        }
+        each_edge_options = default_edge_options.merge(edge_options)
+        edge_options.each{|option, val| each_edge_options[option] = val.call(u, v) if val.is_a?(Proc)}
+        graph << edge_class.new(each_edge_options)
+      end
+
+      graph
+    end
+
+    def write_to_graphic_file(fmt='png', dotfile="graph", options={}, highlight_nodes)
+      src = dotfile + ".dot"
+      dot = dotfile + "." + fmt
+
+      File.open(src, 'w') do |f|
+        f << self.to_dot_graph(params=options, highlight_nodes=highlight_nodes).to_s << "\n"
+      end
+
+      unless system("dot -T#{fmt} #{src} -o #{dot}")
+        message = <<-HEREDOC # Use <<- to indent End of String terminator
+          Error executing dot. Did you install GraphViz?
+          Try installing it via Homebrew: `brew install graphviz`.
+          Visit https://graphviz.org/download/ for more installation instructions.
+        HEREDOC
+        raise message
+      end
+      dot
+    end
+  end
+end