status-react/nix/deps/gradle
Jakub Sokołowski 789b24e3a4
nix: add script for adding missing Gradle packages
This handles the usual case where a missing Gradle version causes the
call to `make nix-update-gradle` to fail since call to Gradle also fails.

This is simpler than getting a dev to run commands manually.

Signed-off-by: Jakub Sokołowski <jakub@status.im>
2022-06-09 13:07:51 +02:00
..
README.md nix: add script for adding missing Gradle packages 2022-06-09 13:07:51 +02:00
add_package.sh nix: add script for adding missing Gradle packages 2022-06-09 13:07:51 +02:00
default.nix nix: refactor loading of node.js modules 2020-05-15 16:19:27 +02:00
deps.json google free and metrics free 2022-05-19 07:22:23 +02:00
deps.list google free and metrics free 2022-05-19 07:22:23 +02:00
deps.urls google free and metrics free 2022-05-19 07:22:23 +02:00
generate.sh nix: add script for adding missing Gradle packages 2022-06-09 13:07:51 +02:00
get_deps.sh nix: replace grep and sed with AWK for parsing Gradle deps 2020-05-25 19:34:56 +02:00
get_projects.sh nix: refactor updating Gradle dependencies 2020-05-14 09:46:30 +02:00
gradle_parser.awk nix/deps/gradle: include Gradle targets with numbers in names 2021-05-25 14:33:41 +02:00
proj.list google free and metrics free 2022-05-19 07:22:23 +02:00
url2json.sh nix: fortify the nix-update-gradle process 2022-05-17 20:04:04 +02:00

README.md

Description

This directory contains the tools and the data that allows Nix to manage Gradle project dependencies for the app.

Usage

Simply calling generate.sh should result in a deps.json file which is used in the derivation that provides Gradle dependencies when building the Android app.

You can see in nix/mobile/android/release.nix that it's used via the -Dmaven.repo.local='${deps.gradle}' Gradle flag.

Files

First we have the files that store data on Gradle dependencies:

  • proj.list - List of projects of which our Gradle project consists.
  • deps.list - List of dependencies for our project and sub-projects.
  • deps.urls - List of URLs to POMs for all of the dependencies.
  • deps.json - Final file containing all of the necessary data for Nix.

Generating scripts:

  • generate.sh - Main script which generates all the above files.
  • get_projects.sh - Calls Gradle to get a list of sub-projects.
  • get_deps.sh - Calls Gradle to get all the dependencies of sub-projects.
  • gradle_parser.awk - An AWK script that parses above Gradle output.
  • url2json.sh - Converts the list of URLs into a format consumable by Nix.

Finally we have the Nix derivation in default.nix which produces a derivation with all of the Gradle project dependencies:

 $ nix-build --no-out-link --attr pkgs.deps.gradle default.nix       
/nix/store/57g95ik19k6gs5w68yid3hzhsax60i3m-status-react-maven-deps

 $ ls -l /nix/store/57g95ik19k6gs5w68yid3hzhsax60i3m-status-react-maven-deps | head -n 5 
total 32
dr-xr-xr-x  3 root root  3 Jan  1  1970 android
dr-xr-xr-x 35 root root 35 Jan  1  1970 androidx
dr-xr-xr-x 15 root root 15 Jan  1  1970 com
dr-xr-xr-x  3 root root  3 Jan  1  1970 commons-cli
...

Dependencies

One dependency these scripts require is the go-maven-resolver which turns a list of packages into list of all URLs of POMs for them and their dependencies.

Known Issues

One edge case that is currently not automatically handled by this setup is an addition of a new dependency that requires a version of Gradle we don't have. In that case running make nix-update-gradle would fail with:

AILURE: Build failed with an exception.

* What went wrong:
A problem occurred configuring project ':react-native-example-project'.
> Could not resolve all artifacts for configuration ':react-native-example-project:classpath'.
   > Could not find com.android.tools.build:gradle:3.4.0.
     Searched in the following locations:
       - file:/nix/store/34a4qd5qhg2a9kq6a0q9lp7hgmi48q4x-status-react-maven-deps/com/android/tools/build/gradle/3.4.0/gradle-3.4.0.pom
       - file:/nix/store/34a4qd5qhg2a9kq6a0q9lp7hgmi48q4x-status-react-maven-deps/com/android/tools/build/gradle/3.4.0/gradle-3.4.0.jar
     Required by:
         project :react-native-example-project

This happens because get_projects.sh and get_deps.sh depend on running Gradle to generate their output, and that will not work because Gradle cannot find the matching JAR for the new dependency.

You can use the add_package.sh script to add missing Gradle dependencies:

 > make shell TARGET=gradle
Configuring Nix shell for target 'gradle'...

[nix-shell:~/status-react]$ nix/deps/gradle/add_package.sh com.android.tools.build:gradle:3.4.0
Regenerating Nix files...
Found 548 direct dependencies...
Successfully added: com.android.tools.build:gradle:3.4.0

This may take a bit longer than normal make nix-update-gradle but should add the missing package.