Cocoapods subspec consumption: Introduce script to filter out unused resources. #492
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…he xcodebuild command.
harrieshin
reviewed
Mar 26, 2021
| try FileManager.default.removeItem(at: directoryURL) | ||
| } | ||
|
|
||
| print(" - \(directoryEntry) (\(shouldBeKept ? "kept" : "removed"))") |
There was a problem hiding this comment.
while this is great should we print all the time tho?
There was a problem hiding this comment.
I think it'll be easier to correlate logs of our cloud builds to understand which assets were included in the bundle.
What is your main concern with printing all the time? Log size? Noise?
There was a problem hiding this comment.
log size and noise. can we put #ifdef?
There was a problem hiding this comment.
Okay. I'm leaving the verbose by default on the Debug configuration and suppressing it in the Release configuration. (attached screenshots of Release and Debug respectively:
Release:
Debug:
kubalani
reviewed
Mar 26, 2021
kubalani
reviewed
Mar 26, 2021
kubalani
approved these changes
Mar 26, 2021
Showing All Messages ONLY_ACTIVE_ARCH=YES requested with multiple ARCHS and no run destination to provide an active architecture; building for all applicable architectures (in target 'MicrosoftFluentUI-FluentUIResources-ios' from project 'Pods')
…nd the script during linting. Enclosing variables in double quotes to prevent parameters from being interpreted incorrectly when they have spaces.
harrieshin
approved these changes
Mar 30, 2021
rdeassis
added a commit
that referenced
this pull request
Mar 30, 2021
…resources. (#492) * First version of the resource cleanup script based on .resources.xcfilelist files. * Fixing script phase commands and preparing for another test (tag 0.0.13_Test). * Fixing log messages and setting additional environment variables in the xcodebuild command. * Bumping version to 0.0.14 * Reverting podspec version and linting script file. * Fixing indentation of string extension. * Adding flags to set verbose level based on Debug/Release configurations. * Setting the ARCHS variable to prevent the build warning in debug mode: Showing All Messages ONLY_ACTIVE_ARCH=YES requested with multiple ARCHS and no run destination to provide an active architecture; building for all applicable architectures (in target 'MicrosoftFluentUI-FluentUIResources-ios' from project 'Pods') * Fixing pod lib lint issues by using $PODS_TARGET_SRCROOT so it can find the script during linting. Enclosing variables in double quotes to prevent parameters from being interpreted incorrectly when they have spaces.
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Platforms Impacted
Context / Problem statement
Currently the Coccoapods consumption story allows client apps to consume individual subspecs which are granular building blocks of the entire FluentUI library. It's a great approach to save on the binary size footprint of FluentUI in the client app by importing only the controls needed instead of the whole library.
While this works with the compiled code, resources are now being consumed as a single monolithic block. This means that if the client app wants to import only the Label subspec (for example), it will get all the resources for all the controls/subspecs (which won't be used) as part of the resource bundle.
The Core_ios subspec defines the resource bundle including the FluentUI-ios.xcassets as well as the shared (with FluentUI Mac) xcassets as part of its resource bundle:
The initially planned approach was based on an assumption that Cococapods would merge all the contents defined with the same resource bundle name ("FluentUIResources-ios") in the resource_bundle properties of the subspecs.
Unfortunately that is not currently supported by Cocoapods. What ends up happening in this case is that the most basic spec in the dependency hierarchy wins and only its defined resources are part of the bundle.
Some issues created in the Cocoapods GitHub repo illustrate the problem:
Solution
Given the context above, the approach taken to solve the problem is to inject a script on the Core_ios subspec (the basic subspec) via script_phases so that we can remove the assets that are not currently being used.
The script will delete assets based on the .resources.xcfilelist files which will contain a list of all resources used by that subspec. The .resource.xcfilelist will only be included in the project folder if the subspec is being consumed by the client app.
Because Cocoapods does not have support for a build script phase in the resource bundle target (so the assets could be removed before the target builds), we need to rebuild that specific target as part of the FluentUI framework/static lib target (which takes dependency on the resource bundle target).
Verification
Published the contents of this PR as a private Cococapods repo (https://github.com/rdeassis/cocoapods-repo) and tested importing the pod from a client test app:
1. Using FluentUI as a framework:
2. Using FluentUI as a static library:
- Imported the entire FluentUI pod
- Imported only the CommandBar_ios, Drawer_ios and Popupmenu_ios subspecs
The table below shows the size of a resource bundle of an app targeted to iOS 14 consuming different variations of the FluentUI subspecs:
Build log sample for reference:
Pull request checklist
This PR has considered:
Microsoft Reviewers: Open in CodeFlow