cocoapods-xcremotecache 0.0.11 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a580b1046422fa075fe4922b61967ceed2b26d9fbbecc799d1397956a0174b
-  data.tar.gz: 80794d37cb6102733f0ff743167f9d7268b8bdf0f04f8be56063c4ae7f19cb47
+  metadata.gz: 9929e3043567b27f1a9a8dd2d475876930ed6ba35d654b463776688edcf4f0c4
+  data.tar.gz: f03ed16f60910db323d0ae5edf3e3d8db4f5c32b722c417990a3cae3184b9fa7
 SHA512:
-  metadata.gz: bb1ed213b18aa38ad521abcc71174419ea83f62e10f11d2cbc2cbffc9894b2aa23dc832b91b208350dd4a9783641e1ed349ffeedbf1b2815d02758a59e5605b7
-  data.tar.gz: 7514c19217f180da685f9083a4488d8b95451541343c0b604e2989dfe344b0dc1b241e95b116bd448433072bbdf7e38332522ec9f17be243585c8665eeee462d
+  metadata.gz: 14d5fba66c6ed362882a1cd6bcdf6a2e9095f81cca83ab7893020232af51839fc2154e61bdb7621f175873c460bfd5178413fc73d3c6f9c7a08c4354b3880486
+  data.tar.gz: 7ea3092b9c346a2d75d0df98431a721badc7065449a1f89ab19db8fa58137002907e39a755dfffa789cb2cbe1e491aa4b5ffbee31a694df9752a236981619cc8

data/README.md

@@ -63,7 +63,3 @@ To fully uninstall the plugin, call:
 ```bash
 gem uninstall cocoapods-xcremotecache
 ```
-
-## Limitations
-
-* When `generate_multiple_pod_projects` mode is enabled, only first-party targets are cached by XCRemoteCache (all dependencies are compiled locally).

data/lib/cocoapods-xcremotecache/command/hooks.rb

@@ -27,8 +27,9 @@ module CocoapodsXCRemoteCacheModifier
     LLDB_INIT_COMMENT="#RemoteCacheCustomSourceMap"
     LLDB_INIT_PATH = "#{ENV['HOME']}/.lldbinit"
     FAT_ARCHIVE_NAME_INFIX = 'arm64-x86_64'
+    XCRC_COOCAPODS_ROOT_KEY = 'XCRC_COOCAPODS_ROOT'
 
-    # List of plugins' user properties that should be copied to .rcinfo 
+    # List of plugins' user properties that should not be copied to .rcinfo 
     CUSTOM_CONFIGURATION_KEYS = [
       'enabled', 
       'xcrc_location',
@@ -38,9 +39,7 @@ module CocoapodsXCRemoteCacheModifier
       'check_build_configuration', 
       'check_platform', 
       'modify_lldb_init',
-      'prettify_meta_files',
       'fake_src_root',
-      'disable_certificate_verification'
     ]
 
     class XCRemoteCache
@@ -64,9 +63,14 @@ module CocoapodsXCRemoteCacheModifier
           'exclude_targets' => [],
           'prettify_meta_files' => false,
           'fake_src_root' => "/#{'x' * 10 }",
-          'disable_certificate_verification' => false
+          'disable_certificate_verification' => false,
+          'custom_rewrite_envs' => []
         }
         @@configuration.merge! default_values.select { |k, v| !@@configuration.key?(k) }
+        # Always include XCRC_COOCAPODS_ROOT_KEY in custom_rewrite_envs
+        unless @@configuration['custom_rewrite_envs'].include?(XCRC_COOCAPODS_ROOT_KEY)
+          @@configuration['custom_rewrite_envs'] << XCRC_COOCAPODS_ROOT_KEY
+        end
       end
 
       def self.validate_configuration()
@@ -109,6 +113,8 @@ module CocoapodsXCRemoteCacheModifier
       # @param final_target [String] name of target that should trigger marking
       def self.enable_xcremotecache(target, repo_distance, xc_location, xc_cc_path, mode, exclude_build_configurations, final_target, fake_src_root)
         srcroot_relative_xc_location = parent_dir(xc_location, repo_distance)
+        # location of the entrite CocoaPods project, relative to SRCROOT
+        srcroot_relative_project_location = parent_dir('', repo_distance)
 
         target.build_configurations.each do |config|
           # apply only for relevant Configurations
@@ -121,9 +127,12 @@ module CocoapodsXCRemoteCacheModifier
           config.build_settings['SWIFT_EXEC'] = ["$SRCROOT/#{srcroot_relative_xc_location}/xcswiftc"]
           config.build_settings['LIBTOOL'] = ["$SRCROOT/#{srcroot_relative_xc_location}/xclibtool"]
           config.build_settings['LD'] = ["$SRCROOT/#{srcroot_relative_xc_location}/xcld"]
+          config.build_settings['LDPLUSPLUS'] = ["$SRCROOT/#{srcroot_relative_xc_location}/xcldplusplus"]
+          config.build_settings['SWIFT_USE_INTEGRATED_DRIVER'] = ['NO']
 
           config.build_settings['XCREMOTE_CACHE_FAKE_SRCROOT'] = fake_src_root
           config.build_settings['XCRC_PLATFORM_PREFERRED_ARCH'] = ["$(LINK_FILE_LIST_$(CURRENT_VARIANT)_$(PLATFORM_PREFERRED_ARCH):dir:standardizepath:file:default=arm64)"]
+          config.build_settings[XCRC_COOCAPODS_ROOT_KEY] = ["$SRCROOT/#{srcroot_relative_project_location}"]
           debug_prefix_map_replacement = '$(SRCROOT' + ':dir:standardizepath' * repo_distance + ')'
           add_cflags!(config.build_settings, '-fdebug-prefix-map', "#{debug_prefix_map_replacement}=$(XCREMOTE_CACHE_FAKE_SRCROOT)")
           add_swiftflags!(config.build_settings, '-debug-prefix-map', "#{debug_prefix_map_replacement}=$(XCREMOTE_CACHE_FAKE_SRCROOT)")
@@ -174,6 +183,11 @@ module CocoapodsXCRemoteCacheModifier
           "$(TARGET_BUILD_DIR)/$(MODULES_FOLDER_PATH)/$(PRODUCT_MODULE_NAME).swiftmodule/$(XCRC_PLATFORM_PREFERRED_ARCH)-$(LLVM_TARGET_TRIPLE_VENDOR)-$(SWIFT_PLATFORM_TARGET_PREFIX)$(LLVM_TARGET_TRIPLE_SUFFIX).swiftmodule.md5"
         ]
         postbuild_script.dependency_file = "$(TARGET_TEMP_DIR)/postbuild.d"
+        # Move postbuild (last element) to the position after compile sources phase (to make it real 'postbuild')
+        if !existing_postbuild_script 
+          compile_phase_index = target.build_phases.index(target.source_build_phase)
+          target.build_phases.insert(compile_phase_index + 1, target.build_phases.delete(postbuild_script))
+        end
 
         # Mark a sha as ready for a given platform and configuration when building the final_target
         if (mode == 'producer' || mode == 'producer-fast') && target.name == final_target
@@ -201,9 +215,12 @@ module CocoapodsXCRemoteCacheModifier
           config.build_settings.delete('SWIFT_EXEC') if config.build_settings.key?('SWIFT_EXEC')
           config.build_settings.delete('LIBTOOL') if config.build_settings.key?('LIBTOOL')
           config.build_settings.delete('LD') if config.build_settings.key?('LD')
+          config.build_settings.delete('LDPLUSPLUS') if config.build_settings.key?('LDPLUSPLUS')
+          config.build_settings.delete('SWIFT_USE_INTEGRATED_DRIVER') if config.build_settings.key?('SWIFT_USE_INTEGRATED_DRIVER')
           # Remove Fake src root for ObjC & Swift
           config.build_settings.delete('XCREMOTE_CACHE_FAKE_SRCROOT')
           config.build_settings.delete('XCRC_PLATFORM_PREFERRED_ARCH')
+          config.build_settings.delete(XCRC_COOCAPODS_ROOT_KEY)
           remove_cflags!(config.build_settings, '-fdebug-prefix-map')
           remove_swiftflags!(config.build_settings, '-debug-prefix-map')
         end
@@ -223,7 +240,7 @@ module CocoapodsXCRemoteCacheModifier
       end
 
       def self.download_xcrc_if_needed(local_location)
-        required_binaries = ['xcld', 'xclibtool', 'xcpostbuild', 'xcprebuild', 'xcprepare', 'xcswiftc']
+        required_binaries = ['xcld', 'xcldplusplus', 'xclibtool', 'xcpostbuild', 'xcprebuild', 'xcprepare', 'xcswiftc']
         binaries_exist = required_binaries.reduce(true) do |exists, filename|
           file_path = File.join(local_location, filename) 
           exists = exists && File.exist?(file_path)
@@ -345,12 +362,73 @@ module CocoapodsXCRemoteCacheModifier
         File.write(LLDB_INIT_PATH, lldbinit_lines.join("\n"), mode: "w")
       end
 
-      Pod::HooksManager.register('cocoapods-xcremotecache', :post_install) do |installer_context|
+      Pod::HooksManager.register('cocoapods-xcremotecache', :pre_install) do |installer_context|
+        # The main responsibility of that hook is forcing Pods regeneration when XCRemoteCache is enabled for the first time
+        # In the post_install hook, this plugin adds extra build settings and steps to all Pods targets, but only when XCRemoteCache
+        # is enabled and all artifacts are available (i.e. xcprepare returns 0).
+        # If Pods projects/targets are cached from previous `pod install` action that didn't enable XCRemoteCache (e.g. artifacts
+        # are not available in the remote cache), these projects/targets should be invalidated to include XCRemoteCache-related
+        # build steps and build settings.
         if @@configuration.nil?
           Pod::UI.puts "[XCRC] Warning! XCRemoteCache not configured. Call xcremotecache({...}) in Podfile to enable XCRemoteCache"
           next
         end
 
+        begin
+          # `user_pod_directory`` and `user_proj_directory` in the 'postinstall' should be equal
+          user_pod_directory = File.dirname(installer_context.podfile.defined_in_file)
+          set_configuration_default_values
+
+          unless @@configuration['enabled']
+            # No need to check if enabling remote cache for the first time
+            next
+          end
+
+          validate_configuration()
+          mode = @@configuration['mode']
+          remote_commit_file = @@configuration['remote_commit_file']
+          xcrc_location = @@configuration['xcrc_location']
+          check_build_configuration = @@configuration['check_build_configuration']
+          check_platform = @@configuration['check_platform']
+
+          xcrc_location_absolute = "#{user_pod_directory}/#{xcrc_location}"
+          remote_commit_file_absolute = "#{user_pod_directory}/#{remote_commit_file}"
+
+          # Download XCRC
+          download_xcrc_if_needed(xcrc_location_absolute)
+
+          # Save .rcinfo
+          root_rcinfo = generate_rcinfo()
+          save_rcinfo(root_rcinfo, user_pod_directory)
+
+          # Create directory for xccc & arc.rc location
+          Dir.mkdir(BIN_DIR) unless File.exist?(BIN_DIR)
+
+          # Remove previous xccc & arc.rc
+          was_previously_enabled = File.exist?(remote_commit_file_absolute)
+          File.delete(remote_commit_file_absolute) if File.exist?(remote_commit_file_absolute)
+
+          prepare_result = YAML.load`#{xcrc_location_absolute}/xcprepare --configuration #{check_build_configuration} --platform #{check_platform}`
+          if !prepare_result['result'] && mode == 'consumer'
+            # Remote cache is still disabled - no need to force Pods projects/targets regeneration
+            next
+          end
+          
+          # Force rebuilding all Pods project, because XCRC build steps and settings need to be added to Pods project/targets 
+          # It is relevant only when 'incremental_installation' is enabled, otherwise installed_cache_path does not exist on a disk
+          installed_cache_path = installer_context.sandbox.project_installation_cache_path
+          if !was_previously_enabled && File.exist?(installed_cache_path)
+            Pod::UI.puts "[XCRC] Forces Pods project regenerations because XCRC is enabled for the first time."
+            File.delete(installed_cache_path)
+          end
+        end
+      end
+
+      Pod::HooksManager.register('cocoapods-xcremotecache', :post_install) do |installer_context|
+        if @@configuration.nil?
+          next
+        end
+
         user_project = installer_context.umbrella_targets[0].user_project
 
         begin    
@@ -377,20 +455,12 @@ module CocoapodsXCRemoteCacheModifier
 
           xccc_location_absolute = "#{user_proj_directory}/#{xccc_location}"
           xcrc_location_absolute = "#{user_proj_directory}/#{xcrc_location}"
-          remote_commit_file_absolute = "#{user_proj_directory}/#{remote_commit_file}"
-
-          # Download XCRC
-          download_xcrc_if_needed(xcrc_location_absolute)
 
           # Save .rcinfo
           root_rcinfo = generate_rcinfo()
           save_rcinfo(root_rcinfo, user_proj_directory)
 
-          # Create directory for xccc & arc.rc location
-          Dir.mkdir(BIN_DIR) unless File.exist?(BIN_DIR)
-
-          # Remove previous xccc & arc.rc
-          File.delete(remote_commit_file_absolute) if File.exist?(remote_commit_file_absolute)
+          # Remove previous xccc
           File.delete(xccc_location_absolute) if File.exist?(xccc_location_absolute)
 
           # Prepare XCRC
@@ -441,6 +511,7 @@ module CocoapodsXCRemoteCacheModifier
 
           # Enabled/disable XCRemoteCache for the main (user) project
           begin
+            # TODO: Do not compile xcc again. `xcprepare` compiles it in pre-install anyway 
             prepare_result = YAML.load`#{xcrc_location_absolute}/xcprepare --configuration #{check_build_configuration} --platform #{check_platform}`
             unless prepare_result['result'] || mode != 'consumer'
               # Uninstall the XCRemoteCache for the consumer mode

data/lib/cocoapods-xcremotecache/gem_version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module CocoapodsXcremotecache
-  VERSION = "0.0.11"
+  VERSION = "0.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-xcremotecache
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.14
 platform: ruby
 authors:
 - Bartosz Polaczyk
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies: []
 description: CocoaPods plugin that enables XCRemoteCache with the project.
 email: