[NTV-606] KingFisher Carthage -> SPM

[scottkicks]

📲 What

As we migrate over to M1 machines for local development, we'll want to move over our Carthage dependencies into Xcode dependency manager where we can.

🤔 Why

There are many benefits of using SPM over Carthage, but the main reason is to avoid handling manual compilation scripts to support multiple architecture types like this one found inside carthage.sh

# For Xcode 13 make sure EXCLUDED_ARCHS is set to arm architectures otherwise
# the build will fail on lipo due to duplicate architectures.

CURRENT_XCODE_VERSION=$(xcodebuild -version | grep "Build version" | cut -d' ' -f3)
echo "EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_simulator__NATIVE_ARCH_64_BIT_x86_64__XCODE_1300__BUILD_$CURRENT_XCODE_VERSION = arm64 arm64e armv7 armv7s armv6 armv8" >> $xcconfig

echo 'EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_simulator__NATIVE_ARCH_64_BIT_x86_64__XCODE_1300 = $(EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_simulator__NATIVE_ARCH_64_BIT_x86_64__XCODE_1300__BUILD_$(XCODE_PRODUCT_BUILD_VERSION))' >> $xcconfig
echo '

As you can see it's verbose, very cryptic, and we're not entirely sure if we can add M1 support to strings like EXCLUDED_ARCHS

At least for now, we're going to move all dependencies that we can over to SPM that are listed inside the Cartfile.
For now we'll do the 3rd party dependencies. There's also binaries which aren't built as schemas (the step failing on make bootstrap with M1 because of the code snippet above). Finally there's internal libraries that do get converted to schemas, which we might need to create custom SPM packages out of as we did with Kickstarter-Prelude.

🛠 How

• Removed KingFisher from Cartfile.
• Removed KingFisher from Cartfile.resolved
• Remove references inside Kickstarter/Frameworks folder and within each target.
• Remove references inside Carthage-xcfilelist
• Add https://github.com/onevcat/Kingfisher to Package Dependencies version 7.3.2
• Add package once downloaded to Library target
  • SPM downloads and caches the library, but it's still needed wherever KingFisher was included before, in this case the only place was "Library" target.
• Ensure app builds, tests pass.
• Set breakpoints for where import statements are import KingFisher, set breakpoints for where framework references are, run app and hit breakpoints. Continue running app and smoke tests where framework call sites occur.

✅ Acceptance criteria

• Breakpoint most instances of code used in files that import KingFisher and run the app on device to check the breakpoints are hit and the app continues to run as expected.
• Run app and smoke test where framework is supposed to be used.

[codecov]

Codecov Report

Merging #1722 (a200cbb) into main (7c9bd4c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1722   +/-   ##
=======================================
  Coverage   85.33%   85.33%           
=======================================
  Files        1275     1275           
  Lines      114806   114806           
  Branches    30343    30343           
=======================================
  Hits        97970    97970           
  Misses      15784    15784           
  Partials     1052     1052           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[msadoon]

Most changes look good, one thing I noticed, (on the AlamofireImage PR too), is to not include the framework in the main Kickstarter-iOS target if it can be avoided.

In this case the previous Carthage version of Kingfisher was included only in Library-iOS, and because Library-iOS is imported in Kickstarter-iOS, it should be enough to just include Kingfisher in only Library-iOS.

A good way to check is to look at exactly which targets the library is included in before removing from Carthage and add it back in those same targets (always under Build Phases Link Binary with Libraries) after SPM caches it.

[msadoon]

good to go!