cocoapods-binary-cache 0.1.2 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f1e025f0f15030692b54a837f0570f8407e19b83a073f8aa39f3f0a7e37fa49
-  data.tar.gz: 68a219a8f46e33712e4471295ba767e4cf523152a060d1bf4ada279096803eb4
+  metadata.gz: 939a85addd611d4a4bcd2b9ce1eeb7e036d58a937a14bdd4f772a6c8170e4394
+  data.tar.gz: 0372d8f94f6e486259669f4db5431585a08645c1a23ad363258581fc5f679eff
 SHA512:
-  metadata.gz: d64cfaed327ace3fb95372be38dff97ec3ea059eb97d64053e2c7b213efb71c53b77f27d8ed38e1d7521f7992dede01d73ad670f86cfd7928e4ca4bc41f7b4d0
-  data.tar.gz: 3895ac6b33beabfe3d78210b76712b68096852886e527882e68100888b322404b35399b21211dc02d38192d35d2038784bbc67e4e869814fc2ab0547813ef760
+  metadata.gz: aa2bbc570dc6a1f462a85286578b8dc41a7ce189df2017177d083a70df9ac0d026c8ca8dea310eee2ae5b517b3418004045b8bcc782aa0440f755d8bab1dd0d4
+  data.tar.gz: c98e55ae66d034897db4969bf9c12b0386a69a5139bc78ada10298875c5a9487d499852bb77195ffca42f11b0d2ab97fad940348da90d21296f6f0d6952b64af

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

@@ -7,6 +7,10 @@ module PodPrebuild
       @hit = hit.to_set - missed_with_reasons.keys
     end
 
+    def all
+      (hit + missed).to_set
+    end
+
     def missed
       @missed_with_reasons.keys.to_set
     end

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

@@ -1,12 +1,11 @@
 module PodPrebuild
-  class CacheValidator < BaseCacheValidator
+  class CacheValidator
     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::DevPodsCacheValidator.new(options) if PodPrebuild.config.dev_pods_enabled?
       @validators << PodPrebuild::DependenciesGraphCacheValidator.new(options)
       @validators << PodPrebuild::ExclusionCacheValidator.new(options)
     end

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

@@ -37,6 +37,7 @@ module PodPrebuild
       hit = Set.new
 
       check_pod = lambda do |name|
+        root_name = name.split("/")[0]
         version = pods[name]
         prebuilt_version = prebuilt_pods[name]
         result = false
@@ -44,13 +45,15 @@ module PodPrebuild
           missed[name] = "Not available (#{version})"
         elsif prebuilt_version != version
           missed[name] = "Outdated: (prebuilt: #{prebuilt_version}) vs (#{version})"
+        elsif load_metadata(root_name).blank?
+          missed[name] = "Metadata not available (probably #{root_name}.zip is not in GeneratedFrameworks)"
         else
-          settings_diff = incompatible_build_settings(name)
-          if settings_diff.empty?
+          diff = incompatible_pod(root_name)
+          if diff.empty?
             hit << name
             result = true
           else
-            missed[name] = "Incompatible build settings: #{settings_diff}"
+            missed[name] = "Incompatible: #{diff}"
           end
         end
         result
@@ -70,11 +73,10 @@ module PodPrebuild
       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
+    def incompatible_pod(name)
+      # Pod incompatibility is a universal concept. Generally, it requires build settings compatibility.
+      # For more checks, do override this function to define what it means by `incompatible`.
+      incompatible_build_settings(name)
     end
 
     def incompatible_build_settings(name)
@@ -88,5 +90,23 @@ module PodPrebuild
       end
       settings_diff
     end
+
+    def load_metadata(name)
+      @metadata_cache ||= {}
+      cache = @metadata_cache[name]
+      return cache unless cache.nil?
+
+      metadata = PodPrebuild::Metadata.in_dir(generated_framework_path + name)
+      @metadata_cache[name] = metadata
+      metadata
+    end
+
+    def read_prebuilt_build_settings(name)
+      load_metadata(name).build_settings
+    end
+
+    def read_source_hash(name)
+      load_metadata(name).source_hash
+    end
   end
 end

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

@@ -1,11 +1,16 @@
 module PodPrebuild
   class DependenciesGraphCacheValidator < AccumulatedCacheValidator
+    def initialize(options)
+      super(options)
+      @ignored_pods = options[:ignored_pods] || Set.new
+    end
+
     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 = dependencies_graph.get_clients(accumulated.discard(@ignored_pods).missed.to_a)
+      unless PodPrebuild.config.dev_pods_enabled?
         clients = clients.reject { |client| @pod_lockfile.dev_pods.keys.include?(client) }
       end
 

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

@@ -1,22 +1,30 @@
 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
+      validate_pods(
+        pods: @pod_lockfile.dev_pods,
+        subspec_pods: [],
+        prebuilt_pods: @prebuilt_lockfile.nil? ? {} : @prebuilt_lockfile.dev_pods
       )
-      missed = missed_with_checksum.transform_values { |checksum| "Checksum changed: #{checksum}" }
-      PodPrebuild::CacheValidationResult.new(missed, hit_with_checksum.keys.to_set)
+    end
+
+    def incompatible_pod(name)
+      diff = super(name)
+      return diff unless diff.empty?
+
+      incompatible_source(name)
+    end
+
+    def incompatible_source(name)
+      diff = {}
+      prebuilt_hash = read_source_hash(name)
+      expected_hash = pod_lockfile.dev_pod_hash(name)
+      unless prebuilt_hash == expected_hash
+        diff[name] = { :prebuilt_hash => prebuilt_hash, :expected_hash => expected_hash}
+      end
+      diff
     end
   end
 end

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

@@ -5,7 +5,7 @@ module PodPrebuild
 
       validate_pods(
         pods: @pod_lockfile.non_dev_pods,
-        subspec_pods: @pod_lockfile.subspec_pods,
+        subspec_pods: @pod_lockfile.subspec_vendor_pods,
         prebuilt_pods: @prebuilt_lockfile.nil? ? {} : @prebuilt_lockfile.non_dev_pods
       )
     end

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

@@ -1,56 +1,50 @@
 # 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'
+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
+# 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.
+    # A normal edge is an edge (one direction) from library A to library B which is a dependency of A.
+    @invert_edge = true
   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()
+    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}"
+        Pod::UI.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)
+  def write_graphic_file(options)
+    graph.write_to_graphic_file(options)
   end
 
   private
 
   def dependencies
-    @dependencies ||= begin
-      if @lockfile
-        @lockfile.to_hash['PODS']
-      else
-        nil
-      end
-    end
+    @dependencies ||= (@lockfile && @lockfile.to_hash["PODS"])
   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) }
+    dependencies
+      .map { |d| d.is_a?(Hash) ? d : { d => [] } }
+      .reduce({}) { |combined, individual| combined.merge!(individual) }
   end
 
   def add_vertex(graph, pod)
@@ -65,14 +59,15 @@ class DependenciesGraph
 
   def graph
     @graph ||= begin
-      graph = RGL::DirectedAdjacencyGraph.new()
-
+      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
@@ -85,11 +80,11 @@ class DependenciesGraph
   end
 
   def traverse_sub_tree(graph, vertex)
-    visited_nodes = Set.new()
+    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
+end

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

@@ -2,73 +2,64 @@
 # 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'
+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'] || {}
+    def to_dot_graph(options)
+      highlight_nodes = options[:highlight_nodes] || Set.new
+      options["name"] ||= self.class.name.gsub(/:/, "_")
+      fontsize = options["fontsize"] || "12"
+      graph = (directed? ? DOT::Digraph : DOT::Graph).new(options)
+      edge_class = directed? ? DOT::DirectedEdge : DOT::Edge
+      vertex_options = options["vertex"] || {}
+      edge_options = options["edge"] || {}
 
       each_vertex do |v|
-        default_vertex_options =  {
-          'name'     => vertex_id(v),
-          'fontsize' => fontsize,
-          'label'    => vertex_label(v),
-          'style'    => 'filled',
+        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
-
+        default_vertex_options.merge!("color" => "red", "fillcolor" => "red") if highlight_nodes.include?(v)
         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)}
+        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
+          "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)}
+        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
+    def write_to_graphic_file(options)
+      output_path = Pathname.new(options[:output_path])
+      fmt = output_path.extname.delete_prefix(".")
+      dotfile = output_path.sub_ext(".dot")
 
-      File.open(src, 'w') do |f|
-        f << self.to_dot_graph(params=options, highlight_nodes=highlight_nodes).to_s << "\n"
+      File.open(dotfile, "w") do |f|
+        f << to_dot_graph(options).to_s
       end
 
-      unless system("dot -T#{fmt} #{src} -o #{dot}")
-        message = <<-HEREDOC # Use <<- to indent End of String terminator
+      unless system("dot -T#{fmt} #{dotfile} -o #{output_path}")
+        message = <<~HEREDOC
           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
+      output_path
     end
   end
 end

data/lib/cocoapods-binary-cache/diagnosis/base.rb

@@ -0,0 +1,13 @@
+module PodPrebuild
+  class BaseDiagnosis
+    def initialize(options)
+      @cache_validation = options[:cache_validation]
+      @standard_sandbox = options[:standard_sandbox]
+      @specs = (options[:specs] || []).map { |s| [s.name, s] }.to_h
+    end
+
+    def spec(name)
+      @specs[name]
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "base"
+require_relative "integration"
+
+module PodPrebuild
+  class Diagnosis
+    def initialize(options)
+      @diagnosers = [
+        IntegrationDiagnosis
+      ].map { |klazz| klazz.new(options) }
+    end
+
+    def run
+      diagnosis = @diagnosers.map(&:run)
+      errors = diagnosis.select { |d| d[0] == :error }.map { |d| d[1] }
+      warnings = diagnosis.select { |d| d[0] == :error }.map { |d| d[1] }
+
+      warnings.each { |d| Pod::UI.puts "⚠️  #{d[1]}" }
+      errors.each { |d| Pod::UI.puts "🚩  #{d[1]}" }
+      return if errors.empty? || !PodPrebuild.config.strict_diagnosis?
+
+      raise "There are #{errors.count} error(s) spotted after the diagnosis"
+    end
+  end
+end

data/lib/cocoapods-binary-cache/diagnosis/integration.rb

@@ -0,0 +1,23 @@
+require_relative "base"
+
+module PodPrebuild
+  class IntegrationDiagnosis < BaseDiagnosis
+    def run
+      should_be_integrated = if PodPrebuild.config.prebuild_job? \
+                             then @cache_validation.hit + @cache_validation.missed \
+                             else @cache_validation.hit \
+                             end
+      should_be_integrated = should_be_integrated.map { |name| name.split("/")[0] }.to_set
+      unintegrated = should_be_integrated.reject do |name|
+        module_name = spec(name)&.module_name || name
+        framework_path = \
+          @standard_sandbox.pod_dir(name) + \
+          PodPrebuild.config.prebuilt_path(path: "#{module_name}.framework")
+        framework_path.exist?
+      end
+      return [] if unintegrated.empty?
+
+      [[:error, "Unintegrated frameworks: #{unintegrated}"]]
+    end
+  end
+end