cocoapods-binary-ht 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fb1e861e5728064394631f9037d1b7d164ee4385f5dc5bd768bae537aa9c5eb
+  data.tar.gz: 820ba6fd23aa548cbebc2de961ef4805fde49d3ea49838c2936cf51c78378829
+SHA512:
+  metadata.gz: 10aa6a928916f62360f0a705a461b487623205df3f6369a22eb21101a886febc774ada9626caf0bdd788ac5f6d972fb0deb2d5417f6f89c125a3b3883d837faf
+  data.tar.gz: aee491cdcc6e53f549aa7cac39074c55614eb3a843c81347255578551cca8d6b77a4d1c8c07d8d635b2648a33d0c33b79e999d7646cbf4603de1eea8eaf22284

data/lib/cocoapods-binary-cache.rb

@@ -0,0 +1,2 @@
+# Copyright 2019 panda Holdings PTE LTE (panda), All rights reserved.
+# Use of this source code is governed by an MIT-style license that can be found in the LICENSE file

data/lib/cocoapods-binary-ht/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-ht/cache/validation_result.rb

@@ -0,0 +1,73 @@
+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 all
+      (hit + missed).to_set
+    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-ht/cache/validator.rb

@@ -0,0 +1,20 @@
+module PodPrebuild
+  class CacheValidator
+    def initialize(options)
+      @validators = [
+        PodPrebuild::PodfileChangesCacheValidator.new(options),
+        PodPrebuild::NonDevPodsCacheValidator.new(options)
+      ]
+      @validators << PodPrebuild::DevPodsCacheValidator.new(options) if PodPrebuild.config.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-ht/cache/validator_accumulated.rb

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

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

@@ -0,0 +1,112 @@
+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|
+        root_name = name.split("/")[0]
+        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})"
+        elsif load_metadata(root_name).blank?
+          missed[name] = "Metadata not available (probably #{root_name}.zip is not in GeneratedFrameworks)"
+        else
+          diff = incompatible_pod(root_name)
+          if diff.empty?
+            hit << name
+            result = true
+          else
+            missed[name] = "Incompatible: #{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 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)
+      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
+
+    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-ht/cache/validator_dependencies_graph.rb

@@ -0,0 +1,25 @@
+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(lockfile: @pod_lockfile.lockfile, invert_edge: true)
+      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
+
+      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-ht/cache/validator_dev_pods.rb

@@ -0,0 +1,30 @@
+module PodPrebuild
+  class DevPodsCacheValidator < BaseCacheValidator
+    def validate(*)
+      return PodPrebuild::CacheValidationResult.new if @pod_lockfile.nil?
+
+      validate_pods(
+        pods: @pod_lockfile.dev_pods,
+        subspec_pods: [],
+        prebuilt_pods: @prebuilt_lockfile.nil? ? {} : @prebuilt_lockfile.dev_pods
+      )
+    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-ht/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-ht/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_vendor_pods,
+        prebuilt_pods: @prebuilt_lockfile.nil? ? {} : @prebuilt_lockfile.non_dev_pods
+      )
+    end
+  end
+end

data/lib/cocoapods-binary-ht/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-ht/dependencies_graph/dependencies_graph.rb

@@ -0,0 +1,108 @@
+# Copyright 2019 panda Holdings PTE LTE (panda), 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(options)
+    @lockfile = options[:lockfile]
+    @devpod_only = options[:devpod_only]
+    @max_deps = options[:max_deps].to_i if options[:max_deps]
+    # A normal edge is an edge (one direction) from library A to library B which is a dependency of A.
+    @invert_edge = options[:invert_edge] || false
+  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
+        Pod::UI.puts "Warning: cannot find lib: #{lib}"
+      end
+    end
+    result
+  end
+
+  def write_graphic_file(options)
+    graph.write_to_graphic_file(options)
+  end
+
+  private
+
+  def dependencies
+    @dependencies ||= (@lockfile && @lockfile.to_hash["PODS"])
+  end
+
+  def dev_pod_sources
+    @dev_pod_sources ||= @lockfile.to_hash["EXTERNAL SOURCES"].select { |_, attributes| attributes.key?(:path) } || {}
+  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)
+    return if @devpod_only && dev_pod_sources[node_name].nil?
+
+    graph.add_vertex(node_name)
+    node_name
+  end
+
+  def sanitized_pod_name(name)
+    Pod::Dependency.from_string(name).name
+  end
+
+  def reach_max_deps(deps)
+    return unless @max_deps
+    return deps.count > @max_deps unless @devpod_only
+
+    deps = deps.reject { |name| dev_pod_sources[name].nil? }
+    deps.count > @max_deps
+  end
+
+  def graph
+    @graph ||= begin
+      graph = RGL::DirectedAdjacencyGraph.new
+      pod_to_dependencies.each do |pod, dependencies|
+        next if reach_max_deps(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-ht/dependencies_graph/graph_visualizer.rb

@@ -0,0 +1,65 @@
+# Copyright 2019 panda Holdings PTE LTE (panda), 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(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.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) }
+        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(options)
+      output_path = Pathname.new(options[:output_path])
+      fmt = output_path.extname.delete_prefix(".")
+      dotfile = output_path.sub_ext(".dot")
+
+      File.open(dotfile, "w") do |f|
+        f << to_dot_graph(options).to_s
+      end
+
+      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
+      output_path
+    end
+  end
+end

data/lib/cocoapods-binary-ht/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-ht/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-ht/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

data/lib/cocoapods-binary-ht/env.rb

@@ -0,0 +1,32 @@
+module PodPrebuild
+  class Env
+    @stage_idx = 0
+
+    class << self
+      def reset!
+        @stage_idx = 0
+        @stages = nil
+      end
+
+      def next_stage!
+        @stage_idx += 1 if @stage_idx < stages.count - 1
+      end
+
+      def stages
+        @stages ||= PodPrebuild.config.prebuild_job? ? [:prebuild, :integration] : [:integration]
+      end
+
+      def current_stage
+        stages[@stage_idx]
+      end
+
+      def prebuild_stage?
+        current_stage == :prebuild
+      end
+
+      def integration_stage?
+        current_stage == :integration
+      end
+    end
+  end
+end

data/lib/cocoapods-binary-ht/helper/benchmark_show.rb

@@ -0,0 +1,11 @@
+# Copyright 2019 panda Holdings PTE LTE (panda), All rights reserved.
+# Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
+
+require "benchmark"
+
+class BenchmarkShow
+  def self.benchmark
+    time = Benchmark.measure { yield }
+    Pod::UI.puts "🕛 Time elapsed: #{time}"
+  end
+end

data/lib/cocoapods-binary-ht/helper/checksum.rb

@@ -0,0 +1,18 @@
+# Copyright 2019 panda Holdings PTE LTE (panda), All rights reserved.
+# Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
+
+require "digest/md5"
+
+class FolderChecksum
+  def self.git_checksum(dir)
+    checksum_of_files(`git ls-files #{File.realdirpath(dir).shellescape}`.split("\n"))
+  rescue => e
+    Pod::UI.warn "Cannot get checksum of tracked files under #{dir}: #{e}"
+    checksum_of_files(Dir["#{dir}/**/*"].reject { |f| File.directory?(f) })
+  end
+
+  def self.checksum_of_files(files)
+    checksums = files.sort.map { |f| Digest::MD5.hexdigest(File.read(f)) }
+    Digest::MD5.hexdigest(checksums.join)
+  end
+end

data/lib/cocoapods-binary-ht/helper/json.rb

@@ -0,0 +1,37 @@
+require "json"
+
+module PodPrebuild
+  class JSONFile
+    attr_reader :path
+    attr_reader :data
+
+    def initialize(path)
+      @path = path
+      @data = load_json
+    end
+
+    def empty?
+      @data.empty?
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    def []=(key, value)
+      @data[key] = value
+    end
+
+    def save!
+      File.open(@path, "w") { |f| f.write(JSON.pretty_generate(@data)) }
+    end
+
+    private
+
+    def load_json
+      File.open(@path) { |f| JSON.parse(f.read) }
+    rescue
+      {}
+    end
+  end
+end