Files
firezone/kotlin/android
dependabot[bot] e411b94071 build(deps): Bump the retrofit group in /kotlin/android with 2 updates (#4445)
Bumps the retrofit group in /kotlin/android with 2 updates:
[com.squareup.retrofit2:retrofit](https://github.com/square/retrofit)
and
[com.squareup.retrofit2:converter-moshi](https://github.com/square/retrofit).

Updates `com.squareup.retrofit2:retrofit` from 2.9.0 to 2.11.0
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/square/retrofit/releases">com.squareup.retrofit2:retrofit's
releases</a>.</em></p>
<blockquote>
<h2>2.11.0</h2>
<p><strong>New</strong></p>
<ul>
<li>The built-in <code>OptionalConverterFactory</code> is now public to
allow installing it before other converters which consume all types
(e.g., Moshi, Gson, Jackson, etc.).</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Ensure that exceptions thrown from failure to parse method
annotations can be observed by multiple threads/callers. Previously only
the first caller would see the actual parsing exception and other
callers would get a cryptic <code>ClassCastException</code>.</li>
</ul>
<h2>2.10.0</h2>
<p><strong>New</strong></p>
<ul>
<li>
<p>Support using <code>Unit</code> as a response type. This can be used
for non-body HTTP methods like <code>HEAD</code> or body-containing HTTP
methods like <code>GET</code> where the body will be discarded without
deserialization.</p>
</li>
<li>
<p>kotlinx.serialization converter!</p>
<p>This was imported from <a
href="https://github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/">github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/</a>
and remains unchanged from its 1.0.0 release.</p>
<p>The Maven coordinates are
<code>com.squareup.retrofit2:converter-kotlinx-serialization</code>.</p>
</li>
<li>
<p>JAXB 3 converter!</p>
<p>The Maven coordinates are
<code>com.squareup.retrofit2:converter-jaxb3</code>.</p>
</li>
<li>
<p><code>@Header</code>, <code>@Headers</code>, and
<code>@HeaderMap</code> can now set non-ASCII values through the
<code>allowUnsafeNonAsciiValues</code> annotation property. These are
not technically compliant with the HTTP specification, but are often
supported or required by services.</p>
</li>
<li>
<p>Publish a BOM of all modules. The Maven coordinates are
<code>com.squareup.retrofit2:retrofit-bom</code>.</p>
</li>
<li>
<p><code>Invocation</code> now exposes the service
<code>Class&lt;?&gt;</code> and the instance on which the method was
invoked. This disambiguates the source when service inheritence is
used.</p>
</li>
<li>
<p>A response type keeper annotation processor is now available for
generating shrinker rules for all referenced types in your service
interface. In some cases, it's impossible for static shrinker rules to
keep the entirety of what Retrofit needs at runtime. This annotation
processor generates those additional rules. For more info see <a
href="https://github.com/square/retrofit/tree/trunk/retrofit-response-type-keeper#readme">its
README</a>.</p>
</li>
</ul>
<p><strong>Changed</strong></p>
<ul>
<li>Add shrinker rules to retain the generic signatures of built-in
types (<code>Call</code>, <code>Response</code>, etc.) which are used
via reflection at runtime.</li>
<li>Remove backpressure support from RxJava 2 and 3 adapters. Since we
only deliver a single value and the Reactive Streams specification
states that callers must request a non-zero subscription value, we never
need to honor backpressure.</li>
<li>Kotlin <code>Retrofit.create</code> function now has a non-null
lower bound. Even if you specified a nullable type before this function
would never return null.</li>
<li>Suspend functions now capture and defer all <code>Throwable</code>
subtypes (not just <code>Exception</code> subtypes) to avoid Java's
<code>UndeclaredThrowableException</code> when thrown
synchronously.</li>
<li>Eagerly reject <code>suspend fun</code> functions that return
<code>Call&lt;Body&gt;</code>. These are never correct, and should
declare a return type of <code>Body</code> directly.</li>
<li>Support for Java 14-specific and Java 16-specific reflection needed
to invoke default methods on interfaces have been moved to separate
versions of a class through a multi-release jar. This should have no
observable impact other than the jar now contains classes which target
Java 14 and Java 16 bytecode that might trip up some static analysis
tools which are not aware of multi-release jars.</li>
<li>Parameter names are now displayed in exception messages when
available in the underlying Java bytecode.</li>
<li>Jackson converter now supports binary formats by using byte streams
rather than character streams in its implementation. Use the
<code>create(ObjectMapper, MediaType)</code> overload to supply the
value of the <code>Content-Type</code> header for your format.</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Do not include synthetic methods when doing eager validation.</li>
<li>Use per-method rather than per-class locking when parsing
annotations. This eliminates contention when multiple calls are made in
quick succession at the beginning of the process lifetime.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/square/retrofit/blob/trunk/CHANGELOG.md">com.squareup.retrofit2:retrofit's
changelog</a>.</em></p>
<blockquote>
<h2>[2.11.0] - 2024-03-28</h2>
<p><strong>New</strong></p>
<ul>
<li>The built-in <code>OptionalConverterFactory</code> is now public to
allow installing it before other converters which consume all types
(e.g., Moshi, Gson, Jackson, etc.).</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Ensure that exceptions thrown from failure to parse method
annotations can be observed by multiple threads/callers. Previously only
the first caller would see the actual parsing exception and other
callers would get a cryptic <code>ClassCastException</code>.</li>
</ul>
<h2>[2.10.0] - 2024-03-18</h2>
<p><strong>New</strong></p>
<ul>
<li>
<p>Support using <code>Unit</code> as a response type. This can be used
for non-body HTTP methods like <code>HEAD</code> or body-containing HTTP
methods like <code>GET</code> where the body will be discarded without
deserialization.</p>
</li>
<li>
<p>kotlinx.serialization converter!</p>
<p>This was imported from <a
href="https://github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/">github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/</a>
and remains unchanged from its 1.0.0 release.</p>
<p>The Maven coordinates are
<code>com.squareup.retrofit2:converter-kotlinx-serialization</code>.</p>
</li>
<li>
<p>JAXB 3 converter!</p>
<p>The Maven coordinates are
<code>com.squareup.retrofit2:converter-jaxb3</code>.</p>
</li>
<li>
<p><code>@Header</code>, <code>@Headers</code>, and
<code>@HeaderMap</code> can now set non-ASCII values through the
<code>allowUnsafeNonAsciiValues</code> annotation property. These are
not technically compliant with the HTTP specification, but are often
supported or required by services.</p>
</li>
<li>
<p>Publish a BOM of all modules. The Maven coordinates are
<code>com.squareup.retrofit2:retrofit-bom</code>.</p>
</li>
<li>
<p><code>Invocation</code> now exposes the service
<code>Class&lt;?&gt;</code> and the instance on which the method was
invoked. This disambiguates the source when service inheritence is
used.</p>
</li>
<li>
<p>A response type keeper annotation processor is now available for
generating shrinker rules for all referenced types in your service
interface. In some cases, it's impossible for static shrinker rules to
keep the entirety of what Retrofit needs at runtime. This annotation
processor generates those additional rules. For more info see <a
href="https://github.com/square/retrofit/tree/trunk/retrofit-response-type-keeper#readme">its
README</a>.</p>
</li>
</ul>
<p><strong>Changed</strong></p>
<ul>
<li>Add shrinker rules to retain the generic signatures of built-in
types (<code>Call</code>, <code>Response</code>, etc.) which are used
via reflection at runtime.</li>
<li>Remove backpressure support from RxJava 2 and 3 adapters. Since we
only deliver a single value and the Reactive Streams specification
states that callers must request a non-zero subscription value, we never
need to honor backpressure.</li>
<li>Kotlin <code>Retrofit.create</code> function now has a non-null
lower bound. Even if you specified a nullable type before this function
would never return null.</li>
<li>Suspend functions now capture and defer all <code>Throwable</code>
subtypes (not just <code>Exception</code> subtypes) to avoid Java's
<code>UndeclaredThrowableException</code> when thrown
synchronously.</li>
<li>Eagerly reject <code>suspend fun</code> functions that return
<code>Call&lt;Body&gt;</code>. These are never correct, and should
declare a return type of <code>Body</code> directly.</li>
<li>Support for Java 14-specific and Java 16-specific reflection needed
to invoke default methods on interfaces have been moved to separate
versions of a class through a multi-release jar. This should have no
observable impact other than the jar now contains classes which target
Java 14 and Java 16 bytecode that might trip up some static analysis
tools which are not aware of multi-release jars.</li>
<li>Parameter names are now displayed in exception messages when
available in the underlying Java bytecode.</li>
<li>Jackson converter now supports binary formats by using byte streams
rather than character streams in its implementation. Use the
<code>create(ObjectMapper, MediaType)</code> overload to supply the
value of the <code>Content-Type</code> header for your format.</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Do not include synthetic methods when doing eager validation.</li>
<li>Use per-method rather than per-class locking when parsing
annotations. This eliminates contention when multiple calls are made in
quick succession at the beginning of the process lifetime.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="cc76c22a68"><code>cc76c22</code></a>
Prepare version 2.11.0</li>
<li><a
href="eba9567812"><code>eba9567</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4117">#4117</a>
from square/jw.public-optional.2024-03-27</li>
<li><a
href="c579693e70"><code>c579693</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4114">#4114</a>
from square/jw.locks.2024-03-22</li>
<li><a
href="d6eac54ccf"><code>d6eac54</code></a>
Make optional converter public</li>
<li><a
href="9b5e6307b8"><code>9b5e630</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4116">#4116</a>
from deterclosed/trunk</li>
<li><a
href="bab101e678"><code>bab101e</code></a>
all: remove repetitive words</li>
<li><a
href="80aee71348"><code>80aee71</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4115">#4115</a>
from square/renovate/gradle-8.x</li>
<li><a
href="83acb51298"><code>83acb51</code></a>
Update dependency gradle to v8.7</li>
<li><a
href="d41213948e"><code>d412139</code></a>
Gracefully handle parse failure with locking</li>
<li><a
href="8f5a3c940f"><code>8f5a3c9</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4110">#4110</a>
from jonapoul/patch-1</li>
<li>Additional commits viewable in <a
href="https://github.com/square/retrofit/compare/2.9.0...2.11.0">compare
view</a></li>
</ul>
</details>
<br />

Updates `com.squareup.retrofit2:converter-moshi` from 2.9.0 to 2.11.0
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/square/retrofit/releases">com.squareup.retrofit2:converter-moshi's
releases</a>.</em></p>
<blockquote>
<h2>2.11.0</h2>
<p><strong>New</strong></p>
<ul>
<li>The built-in <code>OptionalConverterFactory</code> is now public to
allow installing it before other converters which consume all types
(e.g., Moshi, Gson, Jackson, etc.).</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Ensure that exceptions thrown from failure to parse method
annotations can be observed by multiple threads/callers. Previously only
the first caller would see the actual parsing exception and other
callers would get a cryptic <code>ClassCastException</code>.</li>
</ul>
<h2>2.10.0</h2>
<p><strong>New</strong></p>
<ul>
<li>
<p>Support using <code>Unit</code> as a response type. This can be used
for non-body HTTP methods like <code>HEAD</code> or body-containing HTTP
methods like <code>GET</code> where the body will be discarded without
deserialization.</p>
</li>
<li>
<p>kotlinx.serialization converter!</p>
<p>This was imported from <a
href="https://github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/">github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/</a>
and remains unchanged from its 1.0.0 release.</p>
<p>The Maven coordinates are
<code>com.squareup.retrofit2:converter-kotlinx-serialization</code>.</p>
</li>
<li>
<p>JAXB 3 converter!</p>
<p>The Maven coordinates are
<code>com.squareup.retrofit2:converter-jaxb3</code>.</p>
</li>
<li>
<p><code>@Header</code>, <code>@Headers</code>, and
<code>@HeaderMap</code> can now set non-ASCII values through the
<code>allowUnsafeNonAsciiValues</code> annotation property. These are
not technically compliant with the HTTP specification, but are often
supported or required by services.</p>
</li>
<li>
<p>Publish a BOM of all modules. The Maven coordinates are
<code>com.squareup.retrofit2:retrofit-bom</code>.</p>
</li>
<li>
<p><code>Invocation</code> now exposes the service
<code>Class&lt;?&gt;</code> and the instance on which the method was
invoked. This disambiguates the source when service inheritence is
used.</p>
</li>
<li>
<p>A response type keeper annotation processor is now available for
generating shrinker rules for all referenced types in your service
interface. In some cases, it's impossible for static shrinker rules to
keep the entirety of what Retrofit needs at runtime. This annotation
processor generates those additional rules. For more info see <a
href="https://github.com/square/retrofit/tree/trunk/retrofit-response-type-keeper#readme">its
README</a>.</p>
</li>
</ul>
<p><strong>Changed</strong></p>
<ul>
<li>Add shrinker rules to retain the generic signatures of built-in
types (<code>Call</code>, <code>Response</code>, etc.) which are used
via reflection at runtime.</li>
<li>Remove backpressure support from RxJava 2 and 3 adapters. Since we
only deliver a single value and the Reactive Streams specification
states that callers must request a non-zero subscription value, we never
need to honor backpressure.</li>
<li>Kotlin <code>Retrofit.create</code> function now has a non-null
lower bound. Even if you specified a nullable type before this function
would never return null.</li>
<li>Suspend functions now capture and defer all <code>Throwable</code>
subtypes (not just <code>Exception</code> subtypes) to avoid Java's
<code>UndeclaredThrowableException</code> when thrown
synchronously.</li>
<li>Eagerly reject <code>suspend fun</code> functions that return
<code>Call&lt;Body&gt;</code>. These are never correct, and should
declare a return type of <code>Body</code> directly.</li>
<li>Support for Java 14-specific and Java 16-specific reflection needed
to invoke default methods on interfaces have been moved to separate
versions of a class through a multi-release jar. This should have no
observable impact other than the jar now contains classes which target
Java 14 and Java 16 bytecode that might trip up some static analysis
tools which are not aware of multi-release jars.</li>
<li>Parameter names are now displayed in exception messages when
available in the underlying Java bytecode.</li>
<li>Jackson converter now supports binary formats by using byte streams
rather than character streams in its implementation. Use the
<code>create(ObjectMapper, MediaType)</code> overload to supply the
value of the <code>Content-Type</code> header for your format.</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Do not include synthetic methods when doing eager validation.</li>
<li>Use per-method rather than per-class locking when parsing
annotations. This eliminates contention when multiple calls are made in
quick succession at the beginning of the process lifetime.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/square/retrofit/blob/trunk/CHANGELOG.md">com.squareup.retrofit2:converter-moshi's
changelog</a>.</em></p>
<blockquote>
<h2>[2.11.0] - 2024-03-28</h2>
<p><strong>New</strong></p>
<ul>
<li>The built-in <code>OptionalConverterFactory</code> is now public to
allow installing it before other converters which consume all types
(e.g., Moshi, Gson, Jackson, etc.).</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Ensure that exceptions thrown from failure to parse method
annotations can be observed by multiple threads/callers. Previously only
the first caller would see the actual parsing exception and other
callers would get a cryptic <code>ClassCastException</code>.</li>
</ul>
<h2>[2.10.0] - 2024-03-18</h2>
<p><strong>New</strong></p>
<ul>
<li>
<p>Support using <code>Unit</code> as a response type. This can be used
for non-body HTTP methods like <code>HEAD</code> or body-containing HTTP
methods like <code>GET</code> where the body will be discarded without
deserialization.</p>
</li>
<li>
<p>kotlinx.serialization converter!</p>
<p>This was imported from <a
href="https://github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/">github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/</a>
and remains unchanged from its 1.0.0 release.</p>
<p>The Maven coordinates are
<code>com.squareup.retrofit2:converter-kotlinx-serialization</code>.</p>
</li>
<li>
<p>JAXB 3 converter!</p>
<p>The Maven coordinates are
<code>com.squareup.retrofit2:converter-jaxb3</code>.</p>
</li>
<li>
<p><code>@Header</code>, <code>@Headers</code>, and
<code>@HeaderMap</code> can now set non-ASCII values through the
<code>allowUnsafeNonAsciiValues</code> annotation property. These are
not technically compliant with the HTTP specification, but are often
supported or required by services.</p>
</li>
<li>
<p>Publish a BOM of all modules. The Maven coordinates are
<code>com.squareup.retrofit2:retrofit-bom</code>.</p>
</li>
<li>
<p><code>Invocation</code> now exposes the service
<code>Class&lt;?&gt;</code> and the instance on which the method was
invoked. This disambiguates the source when service inheritence is
used.</p>
</li>
<li>
<p>A response type keeper annotation processor is now available for
generating shrinker rules for all referenced types in your service
interface. In some cases, it's impossible for static shrinker rules to
keep the entirety of what Retrofit needs at runtime. This annotation
processor generates those additional rules. For more info see <a
href="https://github.com/square/retrofit/tree/trunk/retrofit-response-type-keeper#readme">its
README</a>.</p>
</li>
</ul>
<p><strong>Changed</strong></p>
<ul>
<li>Add shrinker rules to retain the generic signatures of built-in
types (<code>Call</code>, <code>Response</code>, etc.) which are used
via reflection at runtime.</li>
<li>Remove backpressure support from RxJava 2 and 3 adapters. Since we
only deliver a single value and the Reactive Streams specification
states that callers must request a non-zero subscription value, we never
need to honor backpressure.</li>
<li>Kotlin <code>Retrofit.create</code> function now has a non-null
lower bound. Even if you specified a nullable type before this function
would never return null.</li>
<li>Suspend functions now capture and defer all <code>Throwable</code>
subtypes (not just <code>Exception</code> subtypes) to avoid Java's
<code>UndeclaredThrowableException</code> when thrown
synchronously.</li>
<li>Eagerly reject <code>suspend fun</code> functions that return
<code>Call&lt;Body&gt;</code>. These are never correct, and should
declare a return type of <code>Body</code> directly.</li>
<li>Support for Java 14-specific and Java 16-specific reflection needed
to invoke default methods on interfaces have been moved to separate
versions of a class through a multi-release jar. This should have no
observable impact other than the jar now contains classes which target
Java 14 and Java 16 bytecode that might trip up some static analysis
tools which are not aware of multi-release jars.</li>
<li>Parameter names are now displayed in exception messages when
available in the underlying Java bytecode.</li>
<li>Jackson converter now supports binary formats by using byte streams
rather than character streams in its implementation. Use the
<code>create(ObjectMapper, MediaType)</code> overload to supply the
value of the <code>Content-Type</code> header for your format.</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Do not include synthetic methods when doing eager validation.</li>
<li>Use per-method rather than per-class locking when parsing
annotations. This eliminates contention when multiple calls are made in
quick succession at the beginning of the process lifetime.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="cc76c22a68"><code>cc76c22</code></a>
Prepare version 2.11.0</li>
<li><a
href="eba9567812"><code>eba9567</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4117">#4117</a>
from square/jw.public-optional.2024-03-27</li>
<li><a
href="c579693e70"><code>c579693</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4114">#4114</a>
from square/jw.locks.2024-03-22</li>
<li><a
href="d6eac54ccf"><code>d6eac54</code></a>
Make optional converter public</li>
<li><a
href="9b5e6307b8"><code>9b5e630</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4116">#4116</a>
from deterclosed/trunk</li>
<li><a
href="bab101e678"><code>bab101e</code></a>
all: remove repetitive words</li>
<li><a
href="80aee71348"><code>80aee71</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4115">#4115</a>
from square/renovate/gradle-8.x</li>
<li><a
href="83acb51298"><code>83acb51</code></a>
Update dependency gradle to v8.7</li>
<li><a
href="d41213948e"><code>d412139</code></a>
Gracefully handle parse failure with locking</li>
<li><a
href="8f5a3c940f"><code>8f5a3c9</code></a>
Merge pull request <a
href="https://redirect.github.com/square/retrofit/issues/4110">#4110</a>
from jonapoul/patch-1</li>
<li>Additional commits viewable in <a
href="https://github.com/square/retrofit/compare/2.9.0...2.11.0">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-04-01 16:22:23 +00:00
..
2024-03-08 01:55:27 +00:00
2024-02-20 15:01:17 -06:00

Firezone Android client

This README contains instructions for building and testing the Android client locally.

Dev Setup

  1. Install Rust

  2. Install Android Studio

  3. Install your JDK 17 of choice. We recommend just updating your CLI environment to use the JDK bundled in Android Studio to ensure you're using the same JDK on the CLI as Android Studio.

  4. Install the Android SDK through Android Studio.

    • Open Android studio, go to Android Studio > Preferences
    • Search for sdk
    • Find the Android SDK nav item under System Settings and select
    • Click the Edit button next to the Android SDK Location field
    • Follow the steps presented to install Android SDK
  5. Install NDK using Android Studio

    To see which version is installed, make sure to select the Show Package Details checkbox in the Android SDK settings page in Android Studio

    Android SDK Tools

    Make sure the correct NDK version is installed by looking at: ../../rust/connlib/clients/android/connlib/build.gradle.kts

  6. Set the following ENV variables in the start up config for your shell:

    JAVA_HOME=/Applications/Android\ Studio.app/Contents/jbr/Contents/Home
    ANDROID_HOME=/Users/<username>/Library/Android/sdk
    NDK_HOME=$ANDROID_HOME/ndk-bundle
    PATH=$PATH:$ANDROID_HOME/platform-tools:$ANDROID_HOME/tools:$ANDROID_HOME/tools/bin
    
  7. Make sure the following Rust targets are installed into the correct toolchain.

    aarch64-linux-android
    arm-linux-androideabi
    armv7-linux-androideabi
    i686-linux-android
    x86_64-linux-android
    

    Ensure you've activated the correct toolchain version for your local environment with rustup default <toolchain> (find this from the root /rust/rust-toolchain.toml file), then run:

    rustup target add aarch64-linux-android arm-linux-androideabi armv7-linux-androideabi i686-linux-android x86_64-linux-android
    
  8. Perform a test build: ./gradlew assembleDebug.

Release Setup

We release from GitHub CI, so this shouldn't be necessary. But if you're looking to test the release variant locally:

  1. Download the keystore from 1Pass and save to app/.signing/keystore.jks dir.
  2. Download firebase credentials from 1Pass and save to app/.signing/firebase.json
  3. Now you can execute the *Release tasks with:
export KEYSTORE_PATH="$(pwd)/app/.signing/keystore.jks"
export FIREBASE_CREDENTIALS_PATH="$(pwd)/app/.signing/firebase.json"
HISTCONTROL=ignorespace # prevents saving the next line in shell history
 KEYSTORE_PASSWORD='keystore_password' KEYSTORE_KEY_PASSWORD='keystore_key_password' ./gradlew assembleRelease