[gym] Copy Asset Pack into output directory

[CRoig]

Checklist

• I've run bundle exec rspec from the root directory to see all new and existing tests pass
• I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
• I've read the Contribution Guidelines
• I've updated the documentation if necessary.

Motivation and Context

This changes make easier to locate the assetpack files generated during the export phase. Before this change, the asset packs were created in the temporary output folder. Gym tool only copied .ipa, .dSym, and Apps folder.
Locating asset pack files is very helpful if you want to upload automatically your remote assets into a particular server.

I opened an issue (#16037) in order to ask the community how was I supposed to access the asset pack files. During my investigation I found out this feature was not implemented, so I implemented myself.

Description

I extended runner.rb functionality to copy OnDemandResources as Apps folder and ipa and dSym files.

I installed the gem from my repo and archived my project using fastlane gym. I could see on the console the path to the asset packs output and verified the files were in the expected location.

Testing Steps

In order to verify the functionality works, project should have "Enable On Demand Resources" set to "Yes" in the iOS Project Build Settings menu. In addition, at least one assets should have a tag assigned. This tag will appear under iOS Project Resource Tags menu.

Gym export options should include the following parameters:

export_options: {
        embedOnDemandResourcesAssetPacksInBundle: false,
        onDemandResourcesAssetPacksBaseURL: "https://assets.dummy.com/tags"
}

[googlebot]

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

[Fl0p]

+1

[gonchar]

yay! thanks for doing this! waiting when it will be merged

[Fl0p]

@CRoig tnx

[fahadhaq]

@CRoig thanks for this. Saved me a lot of time :)

[joshdholtz]

@CRoig TIL about asset packs 😊 And thanks for those testing steps! Going to test this on my test project but code looks 💯 . Thanks for doing this!

[CRoig]

@CRoig TIL about asset packs 😊 And thanks for those testing steps! Going to test this on my test project but code looks 💯 . Thanks for doing this!

Today I Learned what TIL stands for 🤣

[fahadhaq]

First of all thanks for the code it creates the asset packs when I run Fastlane. The problem I am seeing is that when I generate the assetpack using Fastlane I am not able to download it . I am getting a

Error Domain=NSURLErrorDomain Code=-1008 Resource Unavailable For Download Request

I then went to Xcode and archived my project and generated the OnDemandResources folder with the same assetpack. After doing this I can now download my assetpack when I run my app.

Not sure if anyone else is experiencing the same issue.

Few differences that I have noticed is that when I generate a asset pack via Xcode the name appends the end bit of the bundle key string that is in the AssetPackManifest.plist. the screenshot below is from the assetpack that downloads correctly.

Screen shot of the assetpack that does not download correctly

Cant really see any other difference between the two assetpack that I have uploaded to the server. Can some one please help. Thanks in advance.

[CRoig]

Hi @fahadhaq, I faced same problem in the past. Somehow maybe your are copying to the server some packs that does not match with AssetPackManifest.plist.

I know it is obvious, but this is the root cause of your problem.

In my case, I faced 2 problems, I solved by deeply understanding how it worked:

1. Be sure Asset Pack Manifest URL Prefix parameter in Build Settings properly resolves for you Build Configuration.

2. Be sure AssetPackManifest.plist embed in ipa matches the AssetPackManifest.plist embed in the ipa. Because of the previous bullet (setting did not resolve properly), the embedded AssetPackManifest pointed to my local machine (e.g. something similart to http://127.0.0.1/Users/...)

3. Be sure asset pack you are using are an actual file. From Archive several folders named <product-name>-<tag-name>-<hash>.assetpack are generated, but the ones you need to upload are the ones signed which are not inspectable.

I created a gitlab pipeline to upload directly asset packs generated on build output path using this actual PR, and everything seems fine to me.

Also worth to define the following export_options as part of your gym setup:

export_options: {
        embedOnDemandResourcesAssetPacksInBundle: false,
        onDemandResourcesAssetPacksBaseURL: "https://assets.dummy.com/tags"
}

Good luck.

PS: it is a pity there is no so detailed documentation on this topic. I am about to write kind of a Medium tutorial to export and update assetpack (to use ODR) using fastlane.

[fahadhaq]

Thanks for your help @CRoig. My issue was I was using Legacy build system win Fastlane to create the On Demand resources and when running my app from Xcode I was using the new build system. That is why I couldn't access my Resources and nothing was downloading. Hope this will help someone. Make sure the build systems are same when creating and running the app

[joshdholtz]

This looks great! Thanks so much for adding this feature 😊 Really appreciate the contribution ❤️ This will be released today

[fastlane-bot]

Hey @CRoig 👋

Thank you for your contribution to fastlane and congrats on getting this pull request merged 🎉
The code change now lives in the master branch, however it wasn't released to RubyGems yet.
We usually ship about once a week, and your PR will be included in the next one.

Please let us know if this change requires an immediate release by adding a comment here 👍
We'll notify you once we shipped a new release with your changes 🚀

[fastlane-bot]

Congratulations! 🎉 This was released as part of fastlane 2.144.0 🚀