Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #5094 : [Wiki update] Bazel build failed in mac m1 #5139

Merged
merged 4 commits into from
Sep 5, 2023
Merged

Fix #5094 : [Wiki update] Bazel build failed in mac m1 #5139

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
39882bb
wiki update - for mac m1 bazel failed who updated there mac version
MohitGupta121 Aug 22, 2023
4826f64
remove unwanted changes
MohitGupta121 Aug 22, 2023
b1a3967
update review changes
MohitGupta121 Sep 1, 2023
edc680f
update review changes
MohitGupta121 Sep 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions wiki/Troubleshooting-Installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ Here are some general troubleshooting tips for oppia-android. The specific platf

1. If you find any error related to `cURL`, please set up cURL on your machine. For Linux, you can use `sudo apt install curl`. No need to set up `cURL` for Windows as you are using git bash command line.<br>


2. If you find any error which says `java: command not found`, please check you have Java installed correctly in your machine and the [environment path variable](https://www.java.com/en/download/help/path.html) is also set up correctly.


3. If you find any error related to Kotlin or Java/Checkstyle while pushing the code, please check [this link](https://github.com/oppia/oppia-android/wiki/Android-Studio-UI-based-Github-workflow#how-to-fix-push-failures).


4. If you see the error

```
Expand All @@ -22,6 +25,7 @@ Here are some general troubleshooting tips for oppia-android. The specific platf

then please follow the 2nd step mentioned in [this wiki](https://github.com/oppia/oppia-android/wiki/Installing-Oppia-Android#install-oppia-android) for Mac with Apple silicon(M1/M2) chips.


5. If you see the error

```
Expand Down Expand Up @@ -70,6 +74,7 @@ Here are some general troubleshooting tips for oppia-android. The specific platf
```
[Steps](https://docs.bazel.build/versions/main/tutorial/android-app.html#integrate-with-the-android-sdk) to add ANDROID_HOME environment variable.


2. If you encounter the following:

```
Expand All @@ -79,11 +84,42 @@ Here are some general troubleshooting tips for oppia-android. The specific platf

Try to delete the `.bazelrc` file to solve the above error.


3. **java.lang.ClassNotFoundException: com.android.tools.r8.compatdx.CompatDx**

If, when building the app binary, you encounter a failure that indicates that the CompatDx file cannot be found, this is likely due to you using a newer version of the Android build tools. You can manually downgrade to an older version of build-tools (particularly 29.0.2). Unfortunately, this can't be done through Android Studio but it can be done over a terminal. Follow the instructions listed [here](https://github.com/oppia/oppia-android/issues/3024#issuecomment-884513455) to downgrade your build tools & then try to build the app again.


4. If you encounter this error while building bazel in Mac M1:
```
ERROR: /Users/OpenSource/oppia-android/model/src/main/proto/BUILD.bazel:167:20: Generating JavaLite proto_library //model/src/main/proto:profile_proto failed: (Segmentation fault): protoc failed: error executing command bazel-out/darwin-opt-exec-2B5CBBC6/bin/external/com_google_protobuf/protoc '--proto_path=bazel-out/android-armeabi-v7a-fastbuild/bin/model/src/main/proto/_virtual_imports/languages_proto' ... (remaining 8 argument(s) skipped)

Use --sandbox_debug to see verbose messages from the sandbox protoc failed: error executing command bazel-out/darwin-opt-exec-2B5CBBC6/bin/external/com_google_protobuf/protoc '--proto_path=bazel-out/android-armeabi-v7a-fastbuild/bin/model/src/main/proto/_virtual_imports/languages_proto' ... (remaining 8 argument(s) skipped)
```
Bazel requires Xcode commandline tools to build on M1, and the Xcode license also needs to be accepted.

**Follow these steps to solve this error:**

- Install the commandline tools: `xcode-select --install`

- Accept the Xcode licence: `sudo xcodebuild -licence`

- Reset the xcode select path: `sudo xcode-select -r `

- Set the xcode select path to use CommandLineTools: `sudo xcode-select -s /Library/Developer/CommandLineTools`

- Confirm that the path was correctly set. The expected output is: `/Library/Developer/CommandLineTools`

xcode-select -p

After successfully running the above commands, build the app using Bazel by running the following command:

```
bazel clean --expunge
bazel build //:oppia --noexperimental_check_desugar_deps
```
The `--noexperimental_check_desugar_deps` flag is explained in the [bazel blog](https://blog.bazel.build/2018/12/19/bazel-0.21.html#android).

### Can’t find a particular issue?

If the error you get is not in the Troubleshooting section above, please create an issue providing all the necessary information and assign it to **@MohitGupta121**.