Feature/tvos ios one build script

[vimanyu]

Single build script that builds for ios and tvos.

python3 scripts/gha/build_ios_tvos.py

Build for iOS and tvOS.

optional arguments:
  -h, --help            show this help message and exit
  -b BUILD_DIR, --build_dir BUILD_DIR
                        Name of build directory.
  -s SOURCE_DIR, --source_dir SOURCE_DIR
                        Directory containing source code (top level CMakeLists.txt)
  -p PLATFORM [PLATFORM ...], --platform PLATFORM [PLATFORM ...]
                        List of platforms to build for.
  -a ARCHITECTURE [ARCHITECTURE ...], --architecture ARCHITECTURE [ARCHITECTURE ...]
                        List of architectures to build for.
  -t TARGET [TARGET ...], --target TARGET [TARGET ...]
                        List of CMake build targets
  -o OS [OS ...], --os OS [OS ...]
                        List of operating systems to build for.

In addition to building frameworks for all os/platform/architecture combinations, it will also build "universal" frameworks and "xcframeworks".
The xcframeworks being generated contain both ios and tvos libraries.

Other notable change is a new "merged" Info.plist template file that contains entries for both ios and tvos.

[github-actions]

❌  Integration test FAILED

Requested by @vimanyu on commit 4bb2f22
Last updated: Tue Jun 15 03:27:36 PDT 2021
Download integration test detailed logs and artifacts

Failures	Configs
firestore	[TEST] [FAILURE] [Windows] [boringssl] (1 failed tests)   CanLoadBundlesWithoutProgressUpdates

[jonsimantov]

Is there still a build script in build_scripts/ios?

[vimanyu]

Is there still a build script in build_scripts/ios?

For now, yes as our documentation needs to be updated too. Infact, there are build scripts specifically for tvos.
I will clean things up after ensuring the new xcframeworks work as expected.

[github-actions]

❌  Integration test FAILED

Requested by @vimanyu on commit 192c53b
Last updated: Thu Jun 24 13:55 PDT 2021
View integration test log & download artifacts

Failures	Configs
installations	[TEST] [FAILURE] [Android] [macos] [android_latest] (1 failed tests)   TestGettingTokenTwiceMatches

[sunmou99]

argparse is good. But I wasn't sure if you noticed Google's practice of Command line parsing

[vimanyu]

argparse is good. But I wasn't sure if you noticed Google's practice of Command line parsing

I personally feel the benefit of using a standard library module argparse for simple standalone scripts like this is that we do not have any unnecessary external dependencies.

[vimanyu]

The iOS build workflow takes longer than before: https://github.com/firebase/firebase-cpp-sdk/actions/workflows/ios.yml
Originally, the builds for different architectures are in subprocesses.
Could you add similar features here with Thread?

Thanks for pointing this out. I did some quick tests to see what works best and I think multiprocessing is working great. For debugging purpose, threading/multiprocess makes it a little hard as the log output will be interleaved but we can look into it once it becomes a bigger issue.

Options (and local tests from macbook pro with 12 logical cores):
Comparison with current state of things (building everything serially): 29 minutes

1. Use cmake --build -j <cpu_count>
   This options is great as just the build for a specific architecture is parallelized by cmake but it is slightly slower than multiprocessing.
   Time: 9m 32 s

2. Multithread
   Cmake configure serially but cmake builds are done in parallel on threads.
   Time: 10m

3. Multiprocess
   Cmake configure serially but cmake builds are done in parallel in multiple processes.
   Time: 7m 56s

Note:
Cmake configure in parallel was causing problems and it might be because of cocoapods installing in parallel.
Since github runners have only 3 cores, these times are different but in general multiprocessing is definitely faster.

[sunmou99]

What's the plan about tvos?
If add tvos to the packaging workflow, probably need to update the release note later.

[vimanyu]

What's the plan about tvos?
If add tvos to the packaging workflow, probably need to update the release note later.

Thinking more about it, I think I will revert changes to github workflow files for now. It definitely helped to test the packaging workflow and make sure nothing broke in the process but we should truly include tvos once all the work on simulators on github is done.

[vimanyu]

Have removed changes to workflow files from this PR as we will wait until the work on tvos simulator integration tests on Github is done.
Though, this script was put through a test in cpp-packaging workflow and worked,
https://github.com/firebase/firebase-cpp-sdk/actions/runs/965593738

[sunmou99]

LGTM