feat(Devpod): Support devpod cache flow and refactoring

Author: bangnguyengrab

docs/configure_cocoapods_binary_cache.md

@@ -13,8 +13,6 @@ Following are the options available in `config_cocoapods_binary_cache`:
 
 - `prebuild_config` (default: `Debug`): The configuration to use (such as `Debug`) when prebuilding pods
 
-- `prebuild_job` (default: `false`): Whether or not this is a prebuild job
-
 - `prebuild_all_vendor_pods` (default: `false`): Whether to build all vendor pods in the prebuild job
 
 - `excluded_pods` (default: `[]`): A list of pods to exclude (ie. treat them as non-prebuilt pods)

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

@@ -1,7 +1,6 @@
 module PodPrebuild
-  class CacheValidator < BaseCacheValidator
+  class CacheValidator
     def initialize(options)
-      super(options)
       @validators = [
         PodPrebuild::PodfileChangesCacheValidator.new(options),
         PodPrebuild::NonDevPodsCacheValidator.new(options)

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

@@ -70,13 +70,6 @@ def validate_pods(options)
       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)
@@ -88,5 +81,37 @@ def incompatible_build_settings(name)
       end
       settings_diff
     end
+
+    def incompatible_source(name)
+      diff = {}
+      prebuilt_hash = source_hash_info(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
+
+    private
+
+    def load_metadata(name)
+      return nil if generated_framework_path.nil?
+
+      PodPrebuild::Metadata.in_dir(generated_framework_path + name)
+    end
+
+    def read_prebuilt_build_settings(name)
+      metadata = load_metadata(name)
+      return {} if metadata.nil?
+
+      metadata.build_settings
+    end
+
+    def source_hash_info(name)
+      metadata = load_metadata(name)
+      return {} if metadata.nil?
+
+      metadata.source_hash || {}
+    end
   end
 end

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

@@ -8,15 +8,17 @@ def initialize(options)
     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)
+      hits = Set.new
+      misses = {}
+      @pod_lockfile.dev_pod_names.each do |name|
+        diff = incompatible_source(name)
+        if diff.empty?
+          hits.add(name)
+        else
+          misses[name] = "Incompatible source: #{diff}"
+        end
+      end
+      PodPrebuild::CacheValidationResult.new(misses, hits)
     end
   end
 end

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 @@ def external_sources
       @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 @@ def dev_pod_names
       #     :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
@@ -46,8 +52,20 @@ def subspec_pods
         .group_by { |k| k.split("/")[0] }
     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
 
+    # 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.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
     #   Examples:

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?
 

lib/cocoapods-binary-cache/main.rb

@@ -15,7 +15,6 @@
 require_relative "pod-binary/prebuild_dsl"
 require_relative "pod-binary/prebuild_hook"
 require_relative "pod-binary/prebuild"
-require_relative "prebuild_cache"
 require_relative "prebuild_output/metadata"
 require_relative "prebuild_output/output"
 require_relative "scheme_editor"

lib/cocoapods-binary-cache/pod-binary/helper/names.rb

@@ -18,19 +18,10 @@
 module Pod
   def self.fast_get_targets_for_pod_name(pod_name, targets, cache)
     pod_name = pod_name.split("/")[0] # Look for parent spec instead of subspecs
-    pod_name_to_targets_hash = nil
     if cache.empty?
-      pod_name_to_targets_hash = targets.reduce({}) do |sum, target|
-        array = sum[target.pod_name] || []
-        array << target
-        sum[target.pod_name] = array
-        sum
-      end
-      cache << pod_name_to_targets_hash
+      targets.select { |target| target.name == pod_name }
     else
-      pod_name_to_targets_hash = cache.first
+      cache.first[pod_name] || []
     end
-
-    pod_name_to_targets_hash[pod_name] || []
   end
 end

lib/cocoapods-binary-cache/pod-binary/integration.rb

@@ -5,7 +5,6 @@
 require_relative "helper/target_checker"
 require_relative "integration/alter_specs"
 require_relative "integration/remove_target_files"
-require_relative "integration/source_installer"
 require_relative "integration/validation"
 require_relative "integration/patch/embed_framework_script"
 require_relative "integration/patch/resolve_dependencies"

lib/cocoapods-binary-cache/pod-binary/integration/patch/source_installation.rb

@@ -1,3 +1,5 @@
+require_relative "../source_installer"
+
 module Pod
   class Installer
     # Override the download step to skip download and prepare file in target folder