cocoapods-binary-cache 0.1.1 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284d9870e8f4938c92a779543fffa2810804096cb6cf8504a68cc20c0307acfe
-  data.tar.gz: 7f0ef9d6f2a0afe33cd6fe1c05c77c0ec51d1598f746fbe090faea61ac6cc513
+  metadata.gz: e068bdcb9e91a8e599e3ad1732837a1a7dbd49a4409e05b97b1cdc476bfb76a7
+  data.tar.gz: 21d3e3fa0374a8818efa927bb822ce9386e43e18ec26a1ab5be7d8b481a688d6
 SHA512:
-  metadata.gz: c3287b32dda1506122f0b1d89be9cf413970c8f3389bc538680db8addfe83ca273df223ded9b31dd3c9ee59c5791331ebee87c93f6f85c3437920d29500952ec
-  data.tar.gz: 7ff8a381f96027f7f45321ef2979f43e5383b8f7dfb787adafd2c7afa0348454632a7ab73b43cb2ff05a89aa15c1aac6ff54f245192d86549d63521b612f56af
+  metadata.gz: f5588698b1d818071b2bfb568bcbd44bc1e02084f7caf0b4b554a50277f2064209ec527339de4c8166ab74ff358b0a173f149b5db67f33a808c8d562f8d02625
+  data.tar.gz: dd21d19ff94f2a8dcf3b4b1dd7372484993e0aba4705512fde75be14e66d72ddadc592fc88b9ea81ae3983f156e5fe251e4dbcfe8047f7904db1b0fd3cf0cbcf

data/lib/cocoapods-binary-cache.rb

@@ -1,4 +1,2 @@
 # 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/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/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,16 @@
+require_relative "base"
+require_relative "integration"
+
+module PodPrebuild
+  class Diagnosis
+    def initialize(options)
+      @diagnosers = [
+        IntegrationDiagnosis
+      ].map { |klazz| klazz.new(options) }
+    end
+
+    def run
+      @diagnosers.each(&:run)
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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
+      Pod::UI.puts "🚩 Unintegrated frameworks: #{unintegrated}".yellow unless unintegrated.empty?
+    end
+  end
+end

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

@@ -4,9 +4,15 @@
 require "digest/md5"
 
 class FolderChecksum
-  def self.checksum(dir)
-    files = Dir["#{dir}/**/*"].reject { |f| File.directory?(f) }
-    content = files.map { |f| File.read(f) }.join
-    Digest::MD5.hexdigest(content).to_s
+  def self.git_checksum(dir)
+    checksum_of_files(`git ls-files #{dir}`.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-cache/helper/lockfile.rb

@@ -1,3 +1,5 @@
+require_relative "checksum"
+
 module PodPrebuild
   class Lockfile
     attr_reader :lockfile, :data
@@ -15,6 +17,10 @@ module PodPrebuild
       @data["EXTERNAL SOURCES"] || {}
     end
 
+    def dev_pod_sources
+      @dev_pod_sources ||= external_sources.select { |_, attributes| attributes.key?(:path) } || {}
+    end
+
     def dev_pod_names
       # There are 2 types of external sources:
       # - Development pods: declared with `:path` option in Podfile, corresponding to `:path` in the Lockfile
@@ -27,7 +33,7 @@ module PodPrebuild
       #     :git: git@remote_url
       #     :commit: abc1234
       # --------------------
-      @dev_pod_names ||= external_sources.select { |_, attributes| attributes.key?(:path) }.keys.to_set
+      @dev_pod_names ||= dev_pod_sources.keys.to_set
     end
 
     def dev_pods
@@ -40,13 +46,30 @@ module PodPrebuild
       @non_dev_pods ||= pods.reject { |name, _| dev_pod_names_.include?(name) }
     end
 
+    def subspec_vendor_pods
+      dev_pod_names_ = dev_pod_names
+      @subspec_vendor_pods ||= subspec_pods.reject { |name, _| dev_pod_names_.include?(name) }
+    end
+
+    # Return content hash (Hash the directory at source path) of a dev_pod
+    # Return nil if it's not a dev_pod
+    def dev_pod_hash(pod_name)
+      dev_pod_hashes_map[pod_name]
+    end
+
+    private
+
     def subspec_pods
-      pods.keys
+      @subspec_pods ||= pods.keys
         .select { |k| k.include?("/") }
         .group_by { |k| k.split("/")[0] }
     end
 
-    private
+    # Generate a map between a dev_pod and it source hash
+    def dev_pod_hashes_map
+      @dev_pod_hashes_map ||=
+        dev_pod_sources.map { |name, attribs| [name, FolderChecksum.git_checksum(attribs[:path])] }.to_h
+    end
 
     # Parse an item under `PODS` section of a Lockfile
     # @param hash_or_string: an item under `PODS` section, could be a Hash (if having dependencies) or a String

data/lib/cocoapods-binary-cache/helper/podspec.rb

@@ -1,5 +1,6 @@
 module Pod
   class Specification
+    # TODO: this detect objc lib as empty source, eg. Realm
     def empty_source_files?
       return subspecs.all?(&:empty_source_files?) unless subspecs.empty?
 

data/lib/cocoapods-binary-cache/hooks/post_install.rb

@@ -5,12 +5,29 @@ module PodPrebuild
     end
 
     def run
-      return unless Pod::Podfile::DSL.dev_pods_enabled && @installer_context.sandbox.instance_of?(Pod::PrebuildSandbox)
+      edit_scheme_for_code_coverage if PodPrebuild::Env.prebuild_stage?
+      diagnose if PodPrebuild::Env.integration_stage?
+    end
+
+    private
+
+    def diagnose
+      Pod::UI.section("Diagnosing cocoapods-binary-cache") do
+        PodPrebuild::Diagnosis.new(
+          cache_validation: PodPrebuild::StateStore.cache_validation,
+          standard_sandbox: @installer_context.sandbox,
+          specs: @installer_context.umbrella_targets.map(&:specs).flatten
+        ).run
+      end
+    end
+
+    def edit_scheme_for_code_coverage
+      return unless PodPrebuild.config.dev_pods_enabled? && @installer_context.sandbox.instance_of?(Pod::PrebuildSandbox)
 
       # Modify pods scheme to support code coverage
       # If we don't prebuild dev pod -> no need to care about this in Pod project
       # because we setup in the main project (ex. DriverCI scheme)
-      SchemeEditor.edit_to_support_code_coverage(@installer_context.sandbox) if Pod.is_prebuild_stage
+      SchemeEditor.edit_to_support_code_coverage(@installer_context.sandbox)
     end
   end
 end

data/lib/cocoapods-binary-cache/hooks/pre_install.rb

@@ -13,18 +13,21 @@ module PodPrebuild
     end
 
     def run
+      return if @installer_context.sandbox.is_a?(Pod::PrebuildSandbox)
+
       require_relative "../pod-binary/helper/feature_switches"
-      return if Pod.is_prebuild_stage
 
       log_section "🚀  Prebuild frameworks"
       ensure_valid_podfile
       save_installation_states
-      prepare_environment
+      Pod::UI.section("Prepare environment") { prepare_environment }
       create_prebuild_sandbox
       Pod::UI.section("Detect implicit dependencies") { detect_implicit_dependencies }
       Pod::UI.section("Validate prebuilt cache") { validate_cache }
-      prebuild! if Pod::Podfile::DSL.prebuild_job?
-      reset_environment
+      prebuild! if PodPrebuild.config.prebuild_job?
+      Pod::UI.section("Reset environment") { reset_environment }
+
+      PodPrebuild::Env.next_stage!
       log_section "🤖  Resume pod installation"
       require_relative "../pod-binary/integration"
     end
@@ -53,19 +56,13 @@ module PodPrebuild
     end
 
     def prepare_environment
-      Pod::UI.puts "Prepare environment"
-      Pod.is_prebuild_stage = true
-      Pod::Podfile::DSL.enable_prebuild_patch true  # enable sikpping for prebuild targets
       Pod::Installer.force_disable_integration true # don't integrate targets
       Pod::Config.force_disable_write_lockfile true # disbale write lock file for perbuild podfile
       Pod::Installer.disable_install_complete_message true # disable install complete message
     end
 
     def reset_environment
-      Pod::UI.puts "Reset environment"
-      Pod.is_prebuild_stage = false
       Pod::Installer.force_disable_integration false
-      Pod::Podfile::DSL.enable_prebuild_patch false
       Pod::Config.force_disable_write_lockfile false
       Pod::Installer.disable_install_complete_message false
       Pod::UserInterface.warnings = [] # clean the warning in the prebuild step, it's duplicated.
@@ -75,13 +72,13 @@ module PodPrebuild
       # Note: DSL is reloaded when creating an installer (Pod::Installer.new).
       # Any mutation to DSL is highly discouraged
       # --> Rather, perform mutation on PodPrebuild::StateStore instead
-      PodPrebuild::StateStore.excluded_pods += Pod::Podfile::DSL.excluded_pods
+      PodPrebuild::StateStore.excluded_pods += PodPrebuild.config.excluded_pods
     end
 
     def create_prebuild_sandbox
       standard_sandbox = installer_context.sandbox
       @prebuild_sandbox = Pod::PrebuildSandbox.from_standard_sandbox(standard_sandbox)
-      Pod::UI.puts "Create prebuild sandbox at #{@prebuild_sandbox.root}"
+      Pod::UI.message "Create prebuild sandbox at #{@prebuild_sandbox.root}"
     end
 
     def detect_implicit_dependencies
@@ -104,13 +101,13 @@ module PodPrebuild
         podfile: podfile,
         pod_lockfile: installer_context.lockfile,
         prebuilt_lockfile: prebuilt_lockfile,
-        validate_prebuilt_settings: Pod::Podfile::DSL.validate_prebuilt_settings,
+        validate_prebuilt_settings: PodPrebuild.config.validate_prebuilt_settings,
         generated_framework_path: prebuild_sandbox.generate_framework_path,
         sandbox_root: prebuild_sandbox.root,
         ignored_pods: PodPrebuild::StateStore.excluded_pods,
         prebuilt_pod_names: @original_installer.prebuilt_pod_names
       ).validate
-      path_to_save_cache_validation = Pod::Podfile::DSL.save_cache_validation_to
+      path_to_save_cache_validation = PodPrebuild.config.save_cache_validation_to
       @cache_validation.update_to(path_to_save_cache_validation) unless path_to_save_cache_validation.nil?
       cache_validation.print_summary
       PodPrebuild::StateStore.cache_validation = cache_validation