Skip to content

Commit 3dd5e8e

Browse files
Implement a workaround for macOS/Bazel flakes.
Bazel has a 2 minute timeout for their internal `xcrun` call, which can be exceeded on our github runners about 5% of the time. This leads to flakes and opaque errors, but is a one-time cost. Subsequent xcruns finish in seconds, so we can just do an initial call w/o a timeout before running Bazel. With this change our total flake rate drops from ~30% to nearly 0% for our full suite of tests See bazelbuild/bazel#17437 for background. PiperOrigin-RevId: 509944178
1 parent 1f62059 commit 3dd5e8e

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

.github/actions/bazel/action.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,29 @@ runs:
9393
shell: bash
9494
run: bazelisk version
9595

96+
# Bazel has multiple Xcode calls with hardcoded timeouts. Many of these
97+
# end up timing out on our github runners, causing flakes on every mac
98+
# build that invoked Bazel. To work around this, we manually inoke these
99+
# calls before running Bazel to make sure they end up in Xcode's cache for
100+
# quicker runs later. All of these calls are obtained from xcrun calls in
101+
# https://github.com/bazelbuild/bazel/blob/e8a69f5d5acaeb6af760631490ecbf73e8a04eeb/tools/cpp/osx_cc_configure.bzl.
102+
# See https://github.com/bazelbuild/bazel/issues/17437 for more details.
103+
# TODO(b/269503614) Remove this once Bazel provides an official solution.
104+
- name: Warm up Xcode
105+
if: ${{ runner.os == 'macOS' }}
106+
shell: bash
107+
run: |
108+
mkdir -p mac_bazel_workaround
109+
bazelisk ${{ steps.bazel.outputs.bazel-startup-flags }} build @bazel_tools//tools/osx:xcode_locator.m $BAZEL_FLAGS
110+
XCODE_LOCATOR_FLAGS="--sdk macosx clang -mmacosx-version-min=10.9 -fobjc-arc -framework CoreServices -framework Foundation"
111+
SINGLE_ARCH_COMPILE_FLAGS="--sdk macosx clang -mmacosx-version-min=10.9 -std=c++11 -lc++ -O3"
112+
COMPILE_FLAGS="$SINGLE_ARCH_COMPILE_FLAGS -arch arm64 -arch x86_64 -Wl,-no_adhoc_codesign -Wl,-no_uuid -O3"
113+
time env -i DEVELOPER_DIR=$DEVELOPER_DIR xcrun $XCODE_LOCATOR_FLAGS -o mac_bazel_workaround/xcode-locator-bin $(bazel info output_base)/external/bazel_tools/tools/osx/xcode_locator.m
114+
time env -i DEVELOPER_DIR=$DEVELOPER_DIR xcrun $SINGLE_ARCH_COMPILE_FLAGS -o mac_bazel_workaround/libtool_check_unique $(bazel info output_base)/external/bazel_tools/tools/objc/libtool_check_unique.cc
115+
time env -i DEVELOPER_DIR=$DEVELOPER_DIR xcrun $COMPILE_FLAGS -o mac_bazel_workaround/libtool_check_unique $(bazel info output_base)/external/bazel_tools/tools/objc/libtool_check_unique.cc
116+
time env -i DEVELOPER_DIR=$DEVELOPER_DIR xcrun $SINGLE_ARCH_COMPILE_FLAGS -o mac_bazel_workaround/wrapped_clang $(bazel info output_base)/external/bazel_tools/tools/osx/crosstool/wrapped_clang.cc
117+
time env -i DEVELOPER_DIR=$DEVELOPER_DIR xcrun $COMPILE_FLAGS -o mac_bazel_workaround/wrapped_clang $(bazel info output_base)/external/bazel_tools/tools/osx/crosstool/wrapped_clang.cc
118+
96119
- name: Run Bash
97120
if: ${{ inputs.bash }}
98121
run: ${{ inputs.bash }}

.github/actions/internal/bazel-setup/action.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ runs:
4242
- name: Initialize MacOS-specific Bazel flags
4343
if: runner.os == 'macOS'
4444
shell: bash
45-
run: echo "BAZEL_FLAGS=$BAZEL_FLAGS --xcode_version_config=//.github:host_xcodes" >> $GITHUB_ENV
45+
run: |
46+
echo "BAZEL_FLAGS=$BAZEL_FLAGS --xcode_version_config=//.github:host_xcodes" >> $GITHUB_ENV
47+
echo "DEVELOPER_DIR=${{ env.DEVELOPER_DIR || '/Applications/Xcode_14.1.app/Contents/Developer' }}" >> $GITHUB_ENV
4648
4749
- name: Configure Bazel caching
4850
# Skip bazel cache for local act runs due to issue with credential files

0 commit comments

Comments
 (0)