Files
firezone/kotlin/android
dependabot[bot] 0cb6e2069e build(deps): bump the retrofit group in /kotlin/android with 2 updates (#9253)
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.11.0 to 3.0.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>3.0.0</h2>
<p><strong>Changed</strong></p>
<ul>
<li>
<p>Upgrade to OkHttp 4.12 (from 3.14).</p>
<p>This is the version of OkHttp that is written in Kotlin, and as a
result Retrofit now has a transitive Kotlin dependency. However, this is
also the <em>supported</em> version of OkHttp whereas the previous
version was out of support for nearly 4 years.</p>
</li>
</ul>
<p>Note: The 3.x versions of Retrofit maintain forward
binary-compatibility with the 2.x versions.
This means libraries compiled against 2.x can still be used with the 3.x
versions.</p>
<h2>2.12.0</h2>
<p><strong>New</strong></p>
<ul>
<li>
<p>First-party converters now support deferring serialization to happen
when the request body is written (i.e., during HTTP execution) rather
than when the HTTP request is created. In some cases this moves
conversion from a calling thread to a background thread, such as in the
case when using <code>Call.enqueue</code> directly.</p>
<p>The following converters support this feature through a new
<code>withStreaming()</code> factory method:</p>
<ul>
<li>Gson</li>
<li>Jackson</li>
<li>Moshi</li>
<li>Protobuf</li>
<li>Wire</li>
</ul>
</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Primitive types used with <code>@Tag</code> now work by storing the
value boxed with the boxed class as the key.</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><a
href="https://github.com/square/retrofit/releases/tag/3.0.0">3.0.0</a> -
2025-05-15</h2>
<p><strong>Changed</strong></p>
<ul>
<li>
<p>Upgrade to OkHttp 4.12 (from 3.14).</p>
<p>This is the version of OkHttp that is written in Kotlin, and as a
result Retrofit now has a transitive Kotlin dependency. However, this is
also the <em>supported</em> version of OkHttp whereas the previous
version was out of support for nearly 4 years.</p>
</li>
</ul>
<p>Note: The 3.x versions of Retrofit maintain forward
binary-compatibility with the 2.x versions.
This means libraries compiled against 2.x can still be used with the 3.x
versions.</p>
<h2><a
href="https://github.com/square/retrofit/releases/tag/2.12.0">2.12.0</a>
- 2025-05-15</h2>
<p><strong>New</strong></p>
<ul>
<li>
<p>First-party converters now support deferring serialization to happen
when the request body is written (i.e., during HTTP execution) rather
than when the HTTP request is created. In some cases this moves
conversion from a calling thread to a background thread, such as in the
case when using <code>Call.enqueue</code> directly.</p>
<p>The following converters support this feature through a new
<code>withStreaming()</code> factory method:</p>
<ul>
<li>Gson</li>
<li>Jackson</li>
<li>Moshi</li>
<li>Protobuf</li>
<li>Wire</li>
</ul>
</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Primitive types used with <code>@Tag</code> now work by storing the
value boxed with the boxed class as the key.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="3ab0f1a2c1"><code>3ab0f1a</code></a>
Prepare version 3.0.0</li>
<li><a
href="e5c02d08f3"><code>e5c02d0</code></a>
Commit 2.x docs (<a
href="https://redirect.github.com/square/retrofit/issues/4378">#4378</a>)</li>
<li><a
href="5bc3f183cf"><code>5bc3f18</code></a>
Fix links on the proudction site (<a
href="https://redirect.github.com/square/retrofit/issues/4377">#4377</a>)</li>
<li><a
href="7c3b2290bd"><code>7c3b229</code></a>
Remove compileOnly stdlib dependency (<a
href="https://redirect.github.com/square/retrofit/issues/4376">#4376</a>)</li>
<li><a
href="84185470ad"><code>8418547</code></a>
Update okhttp monorepo to v4 (major) (<a
href="https://redirect.github.com/square/retrofit/issues/4375">#4375</a>)</li>
<li><a
href="06216a3b24"><code>06216a3</code></a>
Try to fix removal of latest dir during release</li>
<li><a
href="1697bdc491"><code>1697bdc</code></a>
Prepare next development version</li>
<li><a
href="5a6ce364ad"><code>5a6ce36</code></a>
Prepare version 2.12.0</li>
<li><a
href="4fb8aed0cc"><code>4fb8aed</code></a>
Fix artifact name (<a
href="https://redirect.github.com/square/retrofit/issues/4372">#4372</a>)</li>
<li><a
href="bf11ef4cfa"><code>bf11ef4</code></a>
Dedicated website build, final status job (<a
href="https://redirect.github.com/square/retrofit/issues/4371">#4371</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/square/retrofit/compare/2.11.0...3.0.0">compare
view</a></li>
</ul>
</details>
<br />

Updates `com.squareup.retrofit2:converter-moshi` from 2.11.0 to 3.0.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>3.0.0</h2>
<p><strong>Changed</strong></p>
<ul>
<li>
<p>Upgrade to OkHttp 4.12 (from 3.14).</p>
<p>This is the version of OkHttp that is written in Kotlin, and as a
result Retrofit now has a transitive Kotlin dependency. However, this is
also the <em>supported</em> version of OkHttp whereas the previous
version was out of support for nearly 4 years.</p>
</li>
</ul>
<p>Note: The 3.x versions of Retrofit maintain forward
binary-compatibility with the 2.x versions.
This means libraries compiled against 2.x can still be used with the 3.x
versions.</p>
<h2>2.12.0</h2>
<p><strong>New</strong></p>
<ul>
<li>
<p>First-party converters now support deferring serialization to happen
when the request body is written (i.e., during HTTP execution) rather
than when the HTTP request is created. In some cases this moves
conversion from a calling thread to a background thread, such as in the
case when using <code>Call.enqueue</code> directly.</p>
<p>The following converters support this feature through a new
<code>withStreaming()</code> factory method:</p>
<ul>
<li>Gson</li>
<li>Jackson</li>
<li>Moshi</li>
<li>Protobuf</li>
<li>Wire</li>
</ul>
</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Primitive types used with <code>@Tag</code> now work by storing the
value boxed with the boxed class as the key.</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><a
href="https://github.com/square/retrofit/releases/tag/3.0.0">3.0.0</a> -
2025-05-15</h2>
<p><strong>Changed</strong></p>
<ul>
<li>
<p>Upgrade to OkHttp 4.12 (from 3.14).</p>
<p>This is the version of OkHttp that is written in Kotlin, and as a
result Retrofit now has a transitive Kotlin dependency. However, this is
also the <em>supported</em> version of OkHttp whereas the previous
version was out of support for nearly 4 years.</p>
</li>
</ul>
<p>Note: The 3.x versions of Retrofit maintain forward
binary-compatibility with the 2.x versions.
This means libraries compiled against 2.x can still be used with the 3.x
versions.</p>
<h2><a
href="https://github.com/square/retrofit/releases/tag/2.12.0">2.12.0</a>
- 2025-05-15</h2>
<p><strong>New</strong></p>
<ul>
<li>
<p>First-party converters now support deferring serialization to happen
when the request body is written (i.e., during HTTP execution) rather
than when the HTTP request is created. In some cases this moves
conversion from a calling thread to a background thread, such as in the
case when using <code>Call.enqueue</code> directly.</p>
<p>The following converters support this feature through a new
<code>withStreaming()</code> factory method:</p>
<ul>
<li>Gson</li>
<li>Jackson</li>
<li>Moshi</li>
<li>Protobuf</li>
<li>Wire</li>
</ul>
</li>
</ul>
<p><strong>Fixed</strong></p>
<ul>
<li>Primitive types used with <code>@Tag</code> now work by storing the
value boxed with the boxed class as the key.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="3ab0f1a2c1"><code>3ab0f1a</code></a>
Prepare version 3.0.0</li>
<li><a
href="e5c02d08f3"><code>e5c02d0</code></a>
Commit 2.x docs (<a
href="https://redirect.github.com/square/retrofit/issues/4378">#4378</a>)</li>
<li><a
href="5bc3f183cf"><code>5bc3f18</code></a>
Fix links on the proudction site (<a
href="https://redirect.github.com/square/retrofit/issues/4377">#4377</a>)</li>
<li><a
href="7c3b2290bd"><code>7c3b229</code></a>
Remove compileOnly stdlib dependency (<a
href="https://redirect.github.com/square/retrofit/issues/4376">#4376</a>)</li>
<li><a
href="84185470ad"><code>8418547</code></a>
Update okhttp monorepo to v4 (major) (<a
href="https://redirect.github.com/square/retrofit/issues/4375">#4375</a>)</li>
<li><a
href="06216a3b24"><code>06216a3</code></a>
Try to fix removal of latest dir during release</li>
<li><a
href="1697bdc491"><code>1697bdc</code></a>
Prepare next development version</li>
<li><a
href="5a6ce364ad"><code>5a6ce36</code></a>
Prepare version 2.12.0</li>
<li><a
href="4fb8aed0cc"><code>4fb8aed</code></a>
Fix artifact name (<a
href="https://redirect.github.com/square/retrofit/issues/4372">#4372</a>)</li>
<li><a
href="bf11ef4cfa"><code>bf11ef4</code></a>
Dedicated website build, final status job (<a
href="https://redirect.github.com/square/retrofit/issues/4371">#4371</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/square/retrofit/compare/2.11.0...3.0.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>
2025-05-27 14:11:32 +00:00
..
2024-03-08 01:55:27 +00: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.

If you get errors about rustc or cargo not being found, it can help to explicitly specify the path to these in your shell environment. For example:

# ~/.zprofile or ~/.bash_profile
export RUST_ANDROID_GRADLE_RUSTC_COMMAND=$HOME/.cargo/bin/rustc
export RUST_ANDROID_GRADLE_CARGO_COMMAND=$HOME/.cargo/bin/cargo

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

Logs

To see all connlib related logs via ADB use:

adb logcat --format color "connlib *:S"

This will show logs of all levels from the connlib tag and silence logs from other tags (*:S).