[Guide] Speeding up your Android/iOS Build #3027
Conversation
✅ Deploy Preview for react-native ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
My only comment is, I guess, that this is maybe a missed opportunity to have it be "Speeding up your build" in general, with a mostly-Android section, but then also mentioning you can symlink clang/clang++ in the same way, and prefix xcodebuild with env vars for CLANG/CLANG++/LD/LD++ that point to clang/clang++ respectively or use a Podfile stanza so clang/clang++ are discovered via relative names vs absolute paths, and then your Objective-C/C++ builds are also blazing. If you're open to this I could make a formal proposal for the verbiage? Seems so obvious if people are already setting up ccache
|
Actually there is the obligatory other comment which should be first: this is fantastic |
Please go ahead 👍 I'd be more than happy to have iOS & Android instructions here. I was aware of benefits that ccache could give to iOS builds as well, but I haven't tried ccache for iOS, therefore I haven't added section with untested comments. If you have a series of instructions that are concise and works well on iOS, we can totally add them. |
|
Great, I'll do that. I have it thoroughly tested + working locally and CI. Requires some special ccache "sloppiness" config settings for iOS to get cache hits so the testing is critical yes |
docs/build-speed-android.md
Outdated
|
|
||
| However, there are a couple of things to be aware: | ||
|
|
||
| 1. On CI, we recommend to do a full clean build, to avoid poisoned cache problems. If you follow the approach mentioned in the previous paragraph, you should be able to parallelize the native build on 4 different ABIs and you will most likely not need `ccache` on CI. |
There was a problem hiding this comment.
Suggest speedup might still be worth it, there is a ccache-action that works great, and you can specify a versioned cache key to wipe out the cache if you suspect a poisoned cache. All of this in action:
|
Alright - I offered up the text for the three main steps to make ccache work for Xcode. Take them and mash them around, re-purpose, re-organize however needed. It is really a magic trick for react-native, I think it will impact people's lives more even then the NDK optimizations you started here with - my iOS builds now take just a few seconds normally despite build testing everything all the time in a huge matrix on many projects. Life altering and I don't say that lightly |
|
The formatting is terrible though, triple-backticks pop the "suggestion" from github web UI out of scope. I trust you to integrate well though, that's a trivial issue since you'll have the file up on your fork |
|
Maybe also mention to install a jdk that matches your cpus arch. |
I think it should be mentioned on environment setup page. |
i mentioned here but unsure how to proceed, happy to add a diff suggestion, jus unsure where |
|
@cortinico Is there any plans (or does it make sense) to integrate ccache into the build scripts to avoid developers setting it up manually ? |
That makes a lot of sense.. it would be great to make RN builds more extendable .. for instance, I would like to try buildxl with RN builds.. By the way, big thanks for adding documentation to improve local c++ development workflow. Is there any documentation for debugging c++ code in react native locally ? My setup is a bit complicated, hence curious to know how others do it ? |
Co-authored-by: Mike Hardy <github@mikehardy.net>
docs/build-speed.md
Outdated
| ln -s ccache /usr/local/bin/clang | ||
| ln -s ccache /usr/local/bin/clang++ |
There was a problem hiding this comment.
We should also note that this may break compilation in general. Even Homebrew warns of this when installing ccache:
% brew info ccache
ccache: stable 4.6 (bottled), HEAD
Object-file caching compiler wrapper
https://ccache.dev/
/usr/local/Cellar/ccache/4.5.1 (68 files, 1.3MB) *
Poured from bottle on 2022-02-14 at 11:55:31
From: https://github.com/Homebrew/homebrew-core/blob/HEAD/Formula/ccache.rb
License: GPL-3.0-or-later
==> Dependencies
Build: asciidoctor ✘, cmake ✔, pkg-config ✔
Required: hiredis ✔, zstd ✔
==> Options
--HEAD
Install HEAD version
==> Caveats
To install symlinks for compilers that will automatically use
ccache, prepend this directory to your PATH:
/usr/local/opt/ccache/libexec
If this is an upgrade and you have previously added the symlinks to
your PATH, you may need to modify it to the path specified above so
it points to the current version.
NOTE: ccache can prevent some software from compiling.
ALSO NOTE: The brew command, by design, will never use ccache.
There was a problem hiding this comment.
Agree, though this is it's a user's risk. The brew problem is out of scope in this document. If we're afraid of users creating symlinks, we can update the .mk/CMake files to offer users to prepend ccache to all the compilation commands.
That solution however, would be android-only.
There was a problem hiding this comment.
I wonder if it's enough to leave a sentence saying something like "this may break other projects, use at own risk". My worry is that we'll start seeing issues around this. But maybe that'll happen regardless… 😛
| config.build_settings["CC"] = "clang" | ||
| config.build_settings["LD"] = "clang" | ||
| config.build_settings["CXX"] = "clang++" | ||
| config.build_settings["LDPLUSPLUS"] = "clang++" |
There was a problem hiding this comment.
We should note here that Clang static analysis may break when these variables are set. We've seen issues and had to disable ccache here: microsoft/react-native-macos#1043 (comment)
Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>
Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>
cortinico
changed the title
|
I should have addressed all the comments by now 👍 Let me know if you're fine with the restructure @kelset |
Co-authored-by: Lorenzo Sciandra <notkelset@kelset.dev>
|
Looks solid 👍 |
There was a problem hiding this comment.
Looks like a great addition to the website! 👍
Also thanks to all of the people involved in the review of this PR, I have seen bunch of great suggestions! 🙏
One thing that we can address in the future could be adding npm commands and wrapping them with yarn ones in tabs, like on the other pages.
Co-authored-by: Bartosz Kaszubowski <gosimek@gmail.com>
Echoing @Simek here, thank you all for making this a x-platform build improvement page 🙌 |
I'm adding a short guide on how to use single arch ABI and ccache to speedup android builds.
Feedbacks are more than welcome 🙏