Running Test Demo Apps

Intro

tl;dr: The easiest way to obtain example app binaries is to go to the SDK releases in GitHub and download the example app for your desired platform (iOS/Android).

• example-apps.android.zip
• example-apps.ios.zip

Every time the release job completes, new updated versions of the example apps will be available along with the release.

Android

In Android there are 2 test apps

• GradleTestApp is built using gradle and lives in https://github.com/bitdriftlabs/capture-sdk/tree/main/platform/jvm/gradle-test-app
• HelloWorldApp is built using bazel and lives in https://github.com/bitdriftlabs/capture-sdk/tree/main/examples/android

Prerequisites

• Have adb (Android Debug Bridge) installed. This is included as part of the Android Platform Tools.
  • You can install it using homebrew brew install android-platform-tools
• Have USB debugging enabled in your device.
  • Enable Developer options. Go to Settings > About Phone > Scroll to the bottom and tap the Build number row 7 times.
  • Enable USB debugging. Go to Settings > System > Developer options > Scroll down and enable USB debugging.
  • If you don't have a device you can follow these steps to install an Android Emulator: http://johnborg.es/2019/04/android-setup-macos.html. You don't have to enable USB debugging in emulators.

GradleTestApp

Install the test app

• Download the desired zipped apk (Android Package) artifact from any of the release builds. Example apps are automatically built for every release of the SDK.
  • Alternatively you can run the workflow manually if you want to create an updated version using latest main or any other branch.
  • An example build is here: https://github.com/bitdriftlabs/capture-sdk/actions/runs/16969975335 (scroll to Artifacts section the bottom)
• Unzip the apk unzip path/to/Android Example Apps.zip
• Install the apk. Connect a USB cable, unlock your device, and run adb install -r path/to/app.apk (The -r will update the app if it's already installed.)

Run / debug the test app

• Run GradleTestApp. Search your device for an app called "Gradle Test App".
• Debug the app. Using logcat you can do some basic verification and troubleshooting using the debug apk
  • Obtain the <appId> by running adb shell dumpsys package io.bitdrift.gradletestapp | grep appId
  • Stream the app logs by using the app Id obtained above running adb logcat --uid=<appId>
  • Additionally we support changing the filter of the rust logger e.g. for trace in bd crates only run adb shell setprop debug.bitdrift.internal_rust_log info,bd=trace (needs and app restart to be applied)

HelloWorldApp

Coming Soon...

iOS

There are two iOS example apps:

• Hello World example app - optimized for testing general logging and workflows SDK capabitilies.
• Session Replay example app - optimized for testing Session Replay. Use it together with your local instance of bitdrift frontend to see in real-time how app's screens are represented in bitdrift frontend. Go to #Intro to learn more about how to download example apps artifacts.

Prerequisites

1. Install Xcode. The details about the currently recommended Xcode version can be found in repo's README page.
2. Launch Xcode. You may be asked to install iOS SDK, do it.

Running Example Apps on Simulator

1. Right click on Xcode icon in the dock > Open Developer Tools > Simulator to launch the simulator.
2. Drag & Drop downloaded example app binaries into a running Simulator window to install the app.
3. Click app icon to run the app.

Running Example Apps on Real Device

Coming Soon...