diff --git a/.github/workflows/e2e-test.yml b/.github/workflows/e2e-test.yml
new file mode 100644
index 0000000000..e71792358f
--- /dev/null
+++ b/.github/workflows/e2e-test.yml
@@ -0,0 +1,339 @@
+name: E2E Tests
+
+on:
+ pull_request:
+
+ workflow_dispatch:
+ inputs:
+ ios:
+ description: "Run iOS e2e tests"
+ type: boolean
+ default: false
+ android:
+ description: "Run Android e2e tests"
+ type: boolean
+ default: true
+ mock_server_branch:
+ description: "stream-chat-test-mock-server branch"
+ type: string
+ default: "main"
+
+permissions:
+ contents: read
+ pull-requests: read
+ checks: read
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
+env:
+ MOCK_SERVER_BRANCH: ${{ inputs.mock_server_branch || 'main' }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ GITHUB_PR_NUM: ${{ github.event.pull_request.number }}
+ GITHUB_EVENT_ACTION: ${{ github.event.action }}
+ GITHUB_EVENT_BEFORE: ${{ github.event.before }}
+ GITHUB_EVENT_AFTER: ${{ github.event.after }}
+ # node_modules of the e2e app and the workspaces it depends on (nmHoistingLimits: workspaces
+ # keeps them apart); `yarn workspaces focus` installs nothing else.
+ NODE_MODULES_PATHS: |
+ node_modules
+ configs/*/node_modules
+ package/node_modules
+ package/native-package/node_modules
+ examples/E2ETestApp/node_modules
+ .yarn/install-state.gz
+
+jobs:
+ check:
+ name: Check E2E Required
+ runs-on: ubuntu-latest
+ timeout-minutes: 10
+ outputs:
+ required: ${{ steps.check.outputs.required }}
+ steps:
+ - uses: actions/checkout@v6
+ - uses: ./.github/actions/ruby-cache
+ - name: Check if e2e tests are required
+ id: check
+ working-directory: examples/SampleApp
+ run: bundle exec fastlane e2e_check_required
+
+ ios:
+ needs: check
+ if: needs.check.outputs.required == 'true' && github.event_name == 'workflow_dispatch' && inputs.ios
+ runs-on: macos-15
+ timeout-minutes: 60
+ env:
+ DETOX_IOS_DEVICE: "iPhone 17 Pro"
+ IOS_VERSION: "26.2"
+ XCODE_VERSION: "26.2"
+ APP_PATH: examples/E2ETestApp/ios/build/detox/Build/Products/Release-iphonesimulator/E2ETestApp.app
+ MOCK_SERVER_BUNDLE_PATH: ${{ github.workspace }}/../mock-server-gems
+ steps:
+ - uses: actions/checkout@v6
+ - uses: actions/setup-node@v6
+ with:
+ node-version: 24.x
+ cache: "yarn"
+ cache-dependency-path: "yarn.lock"
+ - uses: maxim-lobanov/setup-xcode@v1
+ with:
+ xcode-version: ${{ env.XCODE_VERSION }}
+ # A fresh simulator takes minutes to boot on CI; boot it now so that overlaps with setup.
+ - name: Boot simulator
+ run: |
+ runtime="com.apple.CoreSimulator.SimRuntime.iOS-${IOS_VERSION//./-}"
+ udid=$(xcrun simctl list devices available -j |
+ jq -r --arg rt "$runtime" --arg name "$DETOX_IOS_DEVICE" '.devices[$rt][]? | select(.name == $name) | .udid' | head -1)
+ if [ -z "$udid" ]; then
+ echo "::warning::No $DETOX_IOS_DEVICE on iOS $IOS_VERSION; Detox will pick and boot a simulator itself"
+ exit 0
+ fi
+ echo "DETOX_IOS_UDID=$udid" >> "$GITHUB_ENV"
+ nohup xcrun simctl boot "$udid" > /dev/null 2>&1 &
+ - uses: ./.github/actions/ruby-cache
+
+ # --- JS dependencies ---
+ - name: Restore node_modules
+ id: node-modules
+ uses: actions/cache/restore@v5
+ with:
+ path: ${{ env.NODE_MODULES_PATHS }}
+ key: ${{ runner.os }}-e2e-node-modules-${{ hashFiles('yarn.lock') }}
+ # Only the e2e app's dependency tree, not every example app.
+ - name: Install dependencies
+ run: yarn workspaces focus e2etestapp
+ - name: Save node_modules
+ if: steps.node-modules.outputs.cache-hit != 'true'
+ uses: actions/cache/save@v5
+ with:
+ path: ${{ env.NODE_MODULES_PATHS }}
+ key: ${{ steps.node-modules.outputs.cache-primary-key }}
+
+ # --- App binary: rebuilt only when the app or SDK sources change, not for test-only changes ---
+ - name: Restore app
+ id: app
+ uses: actions/cache/restore@v5
+ with:
+ path: ${{ env.APP_PATH }}
+ key: e2e-ios-app-xcode${{ env.XCODE_VERSION }}-${{ hashFiles('yarn.lock', 'package/package.json', 'package/src/**', 'package/shared-native/**', 'package/native-package/package.json', 'package/native-package/src/**', 'package/native-package/ios/**', 'package/native-package/*.podspec', 'examples/SampleApp/Gemfile.lock', 'examples/E2ETestApp/*.js', '!examples/E2ETestApp/.detoxrc.js', 'examples/E2ETestApp/*.json', 'examples/E2ETestApp/*.tsx', 'examples/E2ETestApp/src/**', 'examples/E2ETestApp/ios/**', '!examples/E2ETestApp/ios/build/**', '!examples/E2ETestApp/ios/Pods/**') }}
+ - name: Set up ccache
+ if: steps.app.outputs.cache-hit != 'true'
+ uses: hendrikmuhs/ccache-action@v1.2
+ with:
+ key: e2e-ios-xcode${{ env.XCODE_VERSION }}
+ max-size: 1500M
+ - name: Point the RN ccache wrappers at ccache
+ if: steps.app.outputs.cache-hit != 'true'
+ # RN's ccache-clang.sh runs `$CCACHE_BINARY clang`, but Xcode doesn't export that build
+ # setting to the compiler, so without this every compile silently skips ccache.
+ run: echo "CCACHE_BINARY=$(which ccache)" >> "$GITHUB_ENV"
+ - name: Cache pods
+ if: steps.app.outputs.cache-hit != 'true'
+ uses: actions/cache@v5
+ with:
+ path: examples/E2ETestApp/ios/Pods
+ key: ${{ runner.os }}-e2e-pods-${{ hashFiles('examples/E2ETestApp/ios/Podfile.lock') }}
+ restore-keys: |
+ ${{ runner.os }}-e2e-pods-
+ - name: Install pods
+ if: steps.app.outputs.cache-hit != 'true'
+ working-directory: examples/SampleApp
+ run: USE_CCACHE=1 bundle exec fastlane e2e_pod_install
+ - name: Build app
+ if: steps.app.outputs.cache-hit != 'true'
+ working-directory: examples/E2ETestApp
+ run: yarn e2e:build -c ios.sim.release
+ - name: Save app
+ if: steps.app.outputs.cache-hit != 'true'
+ uses: actions/cache/save@v5
+ with:
+ path: ${{ env.APP_PATH }}
+ key: ${{ steps.app.outputs.cache-primary-key }}
+
+ # --- Test tooling ---
+ - name: Install applesimutils
+ # Homebrew refuses formulae from non-official taps until they are trusted.
+ run: brew tap wix/brew && brew trust --formula wix/brew/applesimutils && brew install wix/brew/applesimutils
+ - name: Restore Detox framework
+ id: detox-framework
+ uses: actions/cache/restore@v5
+ with:
+ path: ~/Library/Detox
+ key: ${{ runner.os }}-detox-framework-xcode${{ env.XCODE_VERSION }}-${{ hashFiles('yarn.lock') }}
+ # Yarn's `enableScripts: false` skips Detox's postinstall, which would build this.
+ - name: Build Detox framework
+ if: steps.detox-framework.outputs.cache-hit != 'true'
+ working-directory: examples/E2ETestApp
+ run: yarn detox build-framework-cache
+ - name: Save Detox framework
+ if: steps.detox-framework.outputs.cache-hit != 'true'
+ uses: actions/cache/save@v5
+ with:
+ path: ~/Library/Detox
+ key: ${{ steps.detox-framework.outputs.cache-primary-key }}
+ - name: Resolve mock server revision
+ id: mock-server
+ run: echo "sha=$(git ls-remote https://github.com/GetStream/stream-chat-test-mock-server "refs/heads/$MOCK_SERVER_BRANCH" | cut -f1)" >> "$GITHUB_OUTPUT"
+ - name: Cache mock server gems
+ uses: actions/cache@v5
+ with:
+ path: ${{ env.MOCK_SERVER_BUNDLE_PATH }}
+ key: ${{ runner.os }}-mock-server-gems-${{ steps.mock-server.outputs.sha }}
+ restore-keys: |
+ ${{ runner.os }}-mock-server-gems-
+
+ - name: Wait for the simulator
+ if: env.DETOX_IOS_UDID != ''
+ timeout-minutes: 15
+ # `-b` boots it if the background boot never started; it errors (405) when the device is
+ # already booted, and then the plain call returns at once.
+ run: xcrun simctl bootstatus "$DETOX_IOS_UDID" -b || xcrun simctl bootstatus "$DETOX_IOS_UDID"
+ - name: Run e2e tests
+ working-directory: examples/SampleApp
+ run: bundle exec fastlane test_e2e platform:ios skip_build:true mock_server_branch:"$MOCK_SERVER_BRANCH"
+ - uses: actions/upload-artifact@v6
+ if: failure()
+ with:
+ name: e2e-ios-logs
+ path: |
+ examples/E2ETestApp/stream-chat-test-mock-server/logs
+ examples/E2ETestApp/artifacts
+
+ android:
+ needs: check
+ if: needs.check.outputs.required == 'true' && (github.event_name != 'workflow_dispatch' || inputs.android)
+ runs-on: ubuntu-latest
+ timeout-minutes: 60
+ env:
+ # Same as the native Android SDK e2e jobs, which run stably on these runners
+ ANDROID_API_LEVEL: "36"
+ ANDROID_EMULATOR_OPTIONS: -no-snapshot-save -no-window -no-audio -no-boot-anim -gpu swiftshader_indirect -camera-back none -camera-front none
+ DETOX_ADB_NAME: "emulator-5554"
+ APK_PATHS: |
+ examples/E2ETestApp/android/app/build/outputs/apk/release/app-release.apk
+ examples/E2ETestApp/android/app/build/outputs/apk/androidTest/release/app-release-androidTest.apk
+ MOCK_SERVER_BUNDLE_PATH: ${{ github.workspace }}/../mock-server-gems
+ # The emulator is x86_64: skip compiling native code for the other ABIs.
+ ORG_GRADLE_PROJECT_reactNativeArchitectures: x86_64
+ steps:
+ - uses: actions/checkout@v6
+ - uses: actions/setup-node@v6
+ with:
+ node-version: 24.x
+ cache: "yarn"
+ cache-dependency-path: "yarn.lock"
+ - uses: actions/setup-java@v5
+ with:
+ distribution: "zulu"
+ java-version: "21"
+ # Caches Gradle's dependencies, wrapper and build cache. It only writes on the default branch by
+ # default, and this workflow doesn't run there, so let PR runs write: their reruns reuse it.
+ - uses: gradle/actions/setup-gradle@v4
+ with:
+ cache-read-only: false
+ - uses: ./.github/actions/ruby-cache
+
+ # --- JS dependencies ---
+ - name: Restore node_modules
+ id: node-modules
+ uses: actions/cache/restore@v5
+ with:
+ path: ${{ env.NODE_MODULES_PATHS }}
+ key: ${{ runner.os }}-e2e-node-modules-${{ hashFiles('yarn.lock') }}
+ # Only the e2e app's dependency tree, not every example app.
+ - name: Install dependencies
+ run: yarn workspaces focus e2etestapp
+ - name: Save node_modules
+ if: steps.node-modules.outputs.cache-hit != 'true'
+ uses: actions/cache/save@v5
+ with:
+ path: ${{ env.NODE_MODULES_PATHS }}
+ key: ${{ steps.node-modules.outputs.cache-primary-key }}
+
+ # --- App binaries: rebuilt only when the app or SDK sources change, not for test-only changes ---
+ - name: Restore APKs
+ id: apk
+ uses: actions/cache/restore@v5
+ with:
+ path: ${{ env.APK_PATHS }}
+ key: e2e-android-apk-${{ hashFiles('yarn.lock', 'package/package.json', 'package/src/**', 'package/shared-native/**', 'package/native-package/package.json', 'package/native-package/src/**', 'package/native-package/android/**', '!package/native-package/android/build/**', 'examples/E2ETestApp/*.js', '!examples/E2ETestApp/.detoxrc.js', 'examples/E2ETestApp/*.json', 'examples/E2ETestApp/*.tsx', 'examples/E2ETestApp/src/**', 'examples/E2ETestApp/android/**', '!examples/E2ETestApp/android/**/build/**', '!examples/E2ETestApp/android/.gradle/**') }}
+ # Built before the emulator boots so the emulator doesn't idle through the Gradle build.
+ - name: Build app
+ if: steps.apk.outputs.cache-hit != 'true'
+ working-directory: examples/E2ETestApp
+ run: yarn e2e:build -c android.att.release
+ - name: Save APKs
+ if: steps.apk.outputs.cache-hit != 'true'
+ uses: actions/cache/save@v5
+ with:
+ path: ${{ env.APK_PATHS }}
+ key: ${{ steps.apk.outputs.cache-primary-key }}
+ # Frees the daemons' memory for the emulator, which otherwise can get killed mid-run.
+ - name: Stop Gradle daemons
+ if: steps.apk.outputs.cache-hit != 'true'
+ working-directory: examples/E2ETestApp/android
+ run: ./gradlew --stop
+
+ # --- Emulator: same setup as the native Android SDK's e2e jobs (AOSP image, no Play services) ---
+ - name: Enable KVM
+ run: |
+ echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+ sudo udevadm control --reload-rules
+ sudo udevadm trigger --name-match=kvm
+
+ # --- Test tooling ---
+ - name: Resolve mock server revision
+ id: mock-server
+ run: echo "sha=$(git ls-remote https://github.com/GetStream/stream-chat-test-mock-server "refs/heads/$MOCK_SERVER_BRANCH" | cut -f1)" >> "$GITHUB_OUTPUT"
+ - name: Cache mock server gems
+ uses: actions/cache@v5
+ with:
+ path: ${{ env.MOCK_SERVER_BUNDLE_PATH }}
+ key: ${{ runner.os }}-mock-server-gems-${{ steps.mock-server.outputs.sha }}
+ restore-keys: |
+ ${{ runner.os }}-mock-server-gems-
+
+ - name: Run e2e tests (Android emulator)
+ uses: reactivecircus/android-emulator-runner@v2
+ with:
+ api-level: ${{ env.ANDROID_API_LEVEL }}
+ arch: x86_64
+ profile: pixel
+ emulator-options: ${{ env.ANDROID_EMULATOR_OPTIONS }}
+ disable-animations: true
+ working-directory: examples/SampleApp
+ script: bundle exec fastlane test_e2e platform:android device:att skip_build:true mock_server_branch:"$MOCK_SERVER_BRANCH"
+ # The emulator has vanished mid-run without any output; this shows whether the kernel killed it.
+ - name: Diagnose emulator
+ if: failure()
+ run: |
+ sudo dmesg -T | grep -i -E 'out of memory|oom-kill|killed process' || echo "No OOM kills in dmesg"
+ free -m
+ df -h
+ ls -la /tmp/android-runner 2>/dev/null || true
+ - uses: actions/upload-artifact@v6
+ if: failure()
+ with:
+ name: e2e-android-logs
+ path: |
+ examples/E2ETestApp/stream-chat-test-mock-server/logs
+ examples/E2ETestApp/artifacts
+ /tmp/android-runner
+
+ result:
+ name: Test E2E Result
+ runs-on: ubuntu-latest
+ if: always()
+ needs:
+ - check
+ - android
+ steps:
+ - name: Check E2E results
+ if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
+ run: |
+ echo "$NEEDS"
+ exit 1
+ env:
+ NEEDS: ${{ toJson(needs) }}
diff --git a/.prettierignore b/.prettierignore
index c4f36f8ee4..55d7ebb190 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -24,6 +24,10 @@ examples/SampleApp/patches/
.yarn/
yarn.lock
+# Detox e2e: mock server checkout cloned by `fastlane start_mock_server`, test artifacts
+examples/E2ETestApp/stream-chat-test-mock-server/
+examples/E2ETestApp/artifacts/
+
# Generated SDK assets
package/src/components/docs/
package/src/theme/generated/
diff --git a/AGENTS.md b/AGENTS.md
index be4dd9dce5..fa8cbbd6b9 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -20,7 +20,7 @@ Targets iOS and Android.
- **Languages:** TypeScript + React Native
- **Runtime:** Node 24 (`.nvmrc` is `v24`; root `engines.node` is `>=20.19.4`; CI runs `24.x`)
- **Package manager:** Yarn 4.15.0 (Berry). The binary lives at `.yarn/releases/yarn-4.15.0.cjs` and is activated via `yarnPath` in `.yarnrc.yml`. Any globally installed `yarn` (even the Homebrew classic 1.x) acts only as a launcher — no Corepack required.
-- **Workspaces:** single root `yarn.lock`; workspaces are `configs/typescript-config`, `package`, `package/native-package`, `package/expo-package`, `examples/SampleApp`, `examples/ExpoMessaging`. **No Lerna.**
+- **Workspaces:** single root `yarn.lock`; workspaces are `configs/typescript-config`, `package`, `package/native-package`, `package/expo-package`, `examples/SampleApp`, `examples/E2ETestApp`, `examples/ExpoMessaging`. **No Lerna.**
- **Testing:** Jest with the `@react-native/jest-preset` + `@testing-library/react-native`.
- **Build:** `react-native-builder-bob` → CommonJS (`lib/commonjs`), ESM (`lib/module`), types (`lib/typescript`)
- **Lint/format:** ESLint 9 flat config + Prettier, strict (`--max-warnings 0`)
@@ -41,7 +41,7 @@ Respect repo-specific rules. Do not suppress lint rules broadly; justify and sco
- `native-package/` — bare RN wrapper (`stream-chat-react-native`)
- `expo-package/` — Expo wrapper (`stream-chat-expo`)
- `shared-native/{ios,android}` — native source shared by both wrappers; synced into them, never edited in place
-- `examples/` — `SampleApp` (full-featured), `ExpoMessaging`
+- `examples/` — `SampleApp` (full-featured), `E2ETestApp` (minimal app for the Detox e2e suite), `ExpoMessaging`
- `configs/typescript-config/` — shared `tsconfig` presets
- `ai-docs/` — agent-facing deep dives (see [References](#references))
- `perf/` — on-device performance toolkit (see [Accessibility, RTL & performance](#accessibility-rtl--performance))
@@ -244,6 +244,8 @@ Native pieces live in `package/shared-native/`: the Android-only `PerfText` Fabr
To run one test file, prefer `cd package && TZ=UTC npx jest path/to/file.test.tsx`. The `testRegex` array in `jest.config.js` also accepts a temporary path — revert it before committing.
+**E2E:** Detox suite in `examples/E2ETestApp/e2e/` against the shared `stream-chat-test-mock-server`, with robots and page objects mirroring the native iOS/Android suites. Run it with `bundle exec fastlane test_e2e platform:ios|android` from `examples/SampleApp`; see `examples/E2ETestApp/e2e/README.md`. Elements it needs get a `testID` in the SDK (kebab-case, additive).
+
**Mock builders** (`package/src/mock-builders/`):
- `api/initiateClientWithChannels` — creates a test client + channels in one call (fastest path)
@@ -369,7 +371,7 @@ Follow `PULL_REQUEST_TEMPLATE.md`. Keep PRs small and focused.
### CI expectations
-`.github/workflows/check-pr.yml` (Node 24): `yarn install --immutable` → `yarn build` → `yarn lint` → `yarn typecheck` → `yarn test:coverage`. Other workflows: `changelog-preview`, `lint-pr-title`, `release`, `sample-distribution`, `sdk-size-metrics`.
+`.github/workflows/check-pr.yml` (Node 24): `yarn install --immutable` → `yarn build` → `yarn lint` → `yarn typecheck` → `yarn test:coverage`. Other workflows: `changelog-preview`, `e2e-test` (Detox on `examples/E2ETestApp`, gated by `is_check_required`; require its `Test E2E Result` check), `lint-pr-title`, `release`, `sample-distribution`, `sdk-size-metrics`.
Failing or flaky tests: fix them, or quarantine with a justification comment and a follow-up.
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 97425a89b6..468d782eab 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -44,6 +44,10 @@ export default tsEslint.config(
'**/android/',
'**/fastlane/',
+ // Detox e2e: mock server checkout cloned by `fastlane start_mock_server`, test artifacts
+ 'examples/E2ETestApp/stream-chat-test-mock-server/',
+ 'examples/E2ETestApp/artifacts/',
+
// Generated SDK assets
'package/src/components/docs/',
'package/src/theme/generated/',
diff --git a/examples/E2ETestApp/.detoxrc.js b/examples/E2ETestApp/.detoxrc.js
new file mode 100644
index 0000000000..2e090e80c7
--- /dev/null
+++ b/examples/E2ETestApp/.detoxrc.js
@@ -0,0 +1,67 @@
+/** @type {Detox.DetoxConfig} */
+module.exports = {
+ testRunner: {
+ args: {
+ $0: 'jest',
+ config: 'e2e/jest.config.js',
+ },
+ jest: {
+ setupTimeout: 300000,
+ },
+ },
+ apps: {
+ 'ios.debug': {
+ type: 'ios.app',
+ binaryPath: 'ios/build/detox/Build/Products/Debug-iphonesimulator/E2ETestApp.app',
+ build:
+ 'xcodebuild -workspace ios/E2ETestApp.xcworkspace -scheme E2ETestApp -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build/detox',
+ },
+ 'ios.release': {
+ type: 'ios.app',
+ binaryPath: 'ios/build/detox/Build/Products/Release-iphonesimulator/E2ETestApp.app',
+ build:
+ 'xcodebuild -workspace ios/E2ETestApp.xcworkspace -scheme E2ETestApp -configuration Release -sdk iphonesimulator -derivedDataPath ios/build/detox',
+ },
+ 'android.debug': {
+ type: 'android.apk',
+ binaryPath: 'android/app/build/outputs/apk/debug/app-debug.apk',
+ testBinaryPath: 'android/app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk',
+ build:
+ 'cd android && ./gradlew assembleDebug assembleAndroidTest -DtestBuildType=debug && cd ..',
+ reversePorts: [8081],
+ },
+ 'android.release': {
+ type: 'android.apk',
+ binaryPath: 'android/app/build/outputs/apk/release/app-release.apk',
+ testBinaryPath:
+ 'android/app/build/outputs/apk/androidTest/release/app-release-androidTest.apk',
+ build:
+ 'cd android && ./gradlew assembleRelease assembleAndroidTest -DtestBuildType=release && cd ..',
+ },
+ },
+ devices: {
+ simulator: {
+ type: 'ios.simulator',
+ // CI pins the simulator it boots early (DETOX_IOS_UDID), so Detox reuses it.
+ device: process.env.DETOX_IOS_UDID
+ ? { id: process.env.DETOX_IOS_UDID }
+ : { type: process.env.DETOX_IOS_DEVICE || 'iPhone 16 Pro' },
+ },
+ emulator: {
+ type: 'android.emulator',
+ device: { avdName: process.env.DETOX_AVD_NAME || 'Pixel_API_37' },
+ },
+ attached: {
+ type: 'android.attached',
+ device: { adbName: process.env.DETOX_ADB_NAME || '.*' },
+ },
+ },
+ configurations: {
+ 'ios.sim.debug': { app: 'ios.debug', device: 'simulator' },
+ 'ios.sim.release': { app: 'ios.release', device: 'simulator' },
+ 'android.emu.debug': { app: 'android.debug', device: 'emulator' },
+ 'android.emu.release': { app: 'android.release', device: 'emulator' },
+ 'android.att.debug': { app: 'android.debug', device: 'attached' },
+ 'android.att.release': { app: 'android.release', device: 'attached' },
+ },
+};
diff --git a/examples/E2ETestApp/.gitignore b/examples/E2ETestApp/.gitignore
new file mode 100644
index 0000000000..9be6361de6
--- /dev/null
+++ b/examples/E2ETestApp/.gitignore
@@ -0,0 +1,79 @@
+# OSX
+#
+.DS_Store
+
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+**/.xcode.env.local
+
+# Android/IntelliJ
+#
+build/
+.idea
+.gradle
+local.properties
+*.iml
+*.hprof
+.cxx/
+*.keystore
+!debug.keystore
+.kotlin/
+
+# node.js
+#
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# fastlane
+#
+# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
+# screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/
+
+**/fastlane/report.xml
+**/fastlane/Preview.html
+**/fastlane/screenshots
+**/fastlane/test_output
+
+# Bundle artifact
+*.jsbundle
+
+# Ruby / CocoaPods
+**/Pods/
+/vendor/bundle/
+
+# Temporary files created by Metro to check the health of the file watcher
+.metro-health-check*
+
+# testing
+/coverage
+
+# Yarn
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Detox e2e: mock server checkout cloned by `fastlane start_mock_server`, test artifacts
+/stream-chat-test-mock-server/
+/artifacts/
diff --git a/examples/E2ETestApp/.watchmanconfig b/examples/E2ETestApp/.watchmanconfig
new file mode 100644
index 0000000000..0967ef424b
--- /dev/null
+++ b/examples/E2ETestApp/.watchmanconfig
@@ -0,0 +1 @@
+{}
diff --git a/examples/E2ETestApp/App.tsx b/examples/E2ETestApp/App.tsx
new file mode 100644
index 0000000000..653961dc5f
--- /dev/null
+++ b/examples/E2ETestApp/App.tsx
@@ -0,0 +1,133 @@
+import React, { useCallback, useEffect, useMemo, useState } from 'react';
+import { BackHandler, Pressable, StyleSheet, Text, View } from 'react-native';
+import { GestureHandlerRootView } from 'react-native-gesture-handler';
+import { SafeAreaProvider, SafeAreaView, useSafeAreaInsets } from 'react-native-safe-area-context';
+
+import { Channel as ChannelType, ChannelFilters, ChannelSort, StreamChat } from 'stream-chat';
+import {
+ Channel,
+ ChannelList,
+ Chat,
+ MessageComposer,
+ MessageList,
+ OverlayProvider,
+} from 'stream-chat-react-native';
+
+import { apiKey, appUser, appUserToken, mockServerUrl } from './src/config';
+
+// Same opt-in as the SampleApp, so the e2e suite sees the same accessibility tree.
+const accessibility = { enabled: true };
+const sort: ChannelSort = { last_message_at: -1 };
+
+/** Lists the mock server's app user, like the SampleApp's user selector. */
+const LoginScreen = ({ onLogin }: { onLogin: () => void }) => (
+
+ E2E Test App
+ {mockServerUrl ? (
+
+ {appUser.name}
+
+ ) : (
+ Launch with the MOCK_SERVER_URL argument (see e2e/README.md).
+ )}
+
+);
+
+const ChannelScreen = ({ channel, onBack }: { channel: ChannelType; onBack: () => void }) => {
+ const { top } = useSafeAreaInsets();
+
+ useEffect(() => {
+ const subscription = BackHandler.addEventListener('hardwareBackPress', () => {
+ onBack();
+ return true;
+ });
+ return () => subscription.remove();
+ }, [onBack]);
+
+ // Laid out like the SampleApp's channel screen: the header lives inside , which sizes
+ // itself to the screen and handles the bottom inset and keyboard for the composer.
+ return (
+
+
+
+
+ ‹ Back
+
+
+ {channel.id}
+
+
+
+
+
+
+ );
+};
+
+const ChatScreens = ({ client }: { client: StreamChat }) => {
+ const [channel, setChannel] = useState();
+ const filters = useMemo(
+ () => ({ members: { $in: [client.userID ?? appUser.id] } }),
+ [client.userID],
+ );
+ const closeChannel = useCallback(() => setChannel(undefined), []);
+
+ return (
+
+ {/* The list stays mounted under the channel, as in a navigation stack. */}
+
+
+
+ {channel ? : null}
+
+ );
+};
+
+const App = () => {
+ const [client, setClient] = useState();
+
+ const login = useCallback(async () => {
+ const chatClient = StreamChat.getInstance(apiKey, { baseURL: mockServerUrl, timeout: 6000 });
+ await chatClient.connectUser(appUser, appUserToken);
+ setClient(chatClient);
+ }, []);
+
+ return (
+
+
+
+ {client ? : }
+
+
+
+ );
+};
+
+const styles = StyleSheet.create({
+ back: { fontSize: 17, paddingRight: 12 },
+ container: { backgroundColor: '#FFFFFF', flex: 1 },
+ flex: { flex: 1 },
+ header: {
+ alignItems: 'center',
+ flexDirection: 'row',
+ paddingHorizontal: 16,
+ paddingVertical: 12,
+ },
+ headerTitle: { flex: 1, fontSize: 17, fontWeight: '600' },
+ hint: { padding: 16 },
+ title: { fontSize: 22, fontWeight: '700', padding: 16 },
+ userName: { fontSize: 17 },
+ userRow: { borderBottomColor: '#E5E5E5', borderBottomWidth: 1, padding: 16 },
+});
+
+export default App;
diff --git a/examples/E2ETestApp/android/app/build.gradle b/examples/E2ETestApp/android/app/build.gradle
new file mode 100644
index 0000000000..879f64489c
--- /dev/null
+++ b/examples/E2ETestApp/android/app/build.gradle
@@ -0,0 +1,124 @@
+apply plugin: "com.android.application"
+apply plugin: "org.jetbrains.kotlin.android"
+apply plugin: "com.facebook.react"
+
+/**
+ * This is the configuration block to customize your React Native Android app.
+ * By default you don't need to apply any configuration, just uncomment the lines you need.
+ */
+react {
+ /* Folders */
+ // The root of your project, i.e. where "package.json" lives. Default is '../..'
+ // root = file("../../")
+ // The folder where the react-native NPM package is. Default is ../../node_modules/react-native
+ // reactNativeDir = file("../../node_modules/react-native")
+ // The folder where the react-native Codegen package is. Default is ../../node_modules/@react-native/codegen
+ // codegenDir = file("../../node_modules/@react-native/codegen")
+ // The cli.js file which is the React Native CLI entrypoint. Default is ../../node_modules/react-native/cli.js
+ // cliFile = file("../../node_modules/react-native/cli.js")
+
+ /* Variants */
+ // The list of variants to that are debuggable. For those we're going to
+ // skip the bundling of the JS bundle and the assets. Default is "debug", "debugOptimized".
+ // If you add flavors like lite, prod, etc. you'll have to list your debuggableVariants.
+ // debuggableVariants = ["liteDebug", "liteDebugOptimized", "prodDebug", "prodDebugOptimized"]
+
+ /* Bundling */
+ // A list containing the node command and its flags. Default is just 'node'.
+ // nodeExecutableAndArgs = ["node"]
+ //
+ // The command to run when bundling. By default is 'bundle'
+ // bundleCommand = "ram-bundle"
+ //
+ // The path to the CLI configuration file. Default is empty.
+ // bundleConfig = file(../rn-cli.config.js)
+ //
+ // The name of the generated asset file containing your JS bundle
+ // bundleAssetName = "MyApplication.android.bundle"
+ //
+ // The entry file for bundle generation. Default is 'index.android.js' or 'index.js'
+ // entryFile = file("../js/MyApplication.android.js")
+ //
+ // A list of extra flags to pass to the 'bundle' commands.
+ // See https://github.com/react-native-community/cli/blob/main/docs/commands.md#bundle
+ // extraPackagerArgs = []
+
+ /* Hermes Commands */
+ // The hermes compiler command to run. By default it is 'hermesc'
+ // hermesCommand = "$rootDir/my-custom-hermesc/bin/hermesc"
+ //
+ // The list of flags to pass to the Hermes compiler. By default is "-O", "-output-source-map"
+ // hermesFlags = ["-O", "-output-source-map"]
+
+ /* Autolinking */
+ autolinkLibrariesWithApp()
+}
+
+/**
+ * Set this to true to Run Proguard on Release builds to minify the Java bytecode.
+ */
+def enableProguardInReleaseBuilds = false
+
+/**
+ * The preferred build flavor of JavaScriptCore (JSC)
+ *
+ * For example, to use the international variant, you can use:
+ * `def jscFlavor = io.github.react-native-community:jsc-android-intl:2026004.+`
+ *
+ * The international variant includes ICU i18n library and necessary data
+ * allowing to use e.g. `Date.toLocaleString` and `String.localeCompare` that
+ * give correct results when using with locales other than en-US. Note that
+ * this variant is about 6MiB larger per architecture than default.
+ */
+def jscFlavor = 'io.github.react-native-community:jsc-android:2026004.+'
+
+android {
+ ndkVersion rootProject.ext.ndkVersion
+ buildToolsVersion rootProject.ext.buildToolsVersion
+ compileSdk rootProject.ext.compileSdkVersion
+
+ namespace "io.getstream.reactnative.e2etestapp"
+ defaultConfig {
+ applicationId "io.getstream.reactnative.e2etestapp"
+ minSdkVersion rootProject.ext.minSdkVersion
+ targetSdkVersion rootProject.ext.targetSdkVersion
+ versionCode 1
+ versionName "1.0"
+ // Detox: builds the instrumentation APK against the variant under test
+ testBuildType System.getProperty('testBuildType', 'debug')
+ testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
+ }
+ signingConfigs {
+ debug {
+ storeFile file('debug.keystore')
+ storePassword 'android'
+ keyAlias 'androiddebugkey'
+ keyPassword 'android'
+ }
+ }
+ buildTypes {
+ debug {
+ signingConfig signingConfigs.debug
+ }
+ release {
+ // Caution! In production, you need to generate your own keystore file.
+ // see https://reactnative.dev/docs/signed-apk-android.
+ signingConfig signingConfigs.debug
+ minifyEnabled enableProguardInReleaseBuilds
+ proguardFiles getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro"
+ }
+ }
+}
+
+dependencies {
+ // The version of react-native is set by the React Native Gradle Plugin
+ implementation("com.facebook.react:react-android")
+
+ if (hermesEnabled.toBoolean()) {
+ implementation("com.facebook.react:hermes-android")
+ } else {
+ implementation jscFlavor
+ }
+
+ androidTestImplementation('com.wix:detox:+')
+}
diff --git a/examples/E2ETestApp/android/app/debug.keystore b/examples/E2ETestApp/android/app/debug.keystore
new file mode 100644
index 0000000000..364e105ed3
Binary files /dev/null and b/examples/E2ETestApp/android/app/debug.keystore differ
diff --git a/examples/E2ETestApp/android/app/proguard-rules.pro b/examples/E2ETestApp/android/app/proguard-rules.pro
new file mode 100644
index 0000000000..11b025724a
--- /dev/null
+++ b/examples/E2ETestApp/android/app/proguard-rules.pro
@@ -0,0 +1,10 @@
+# Add project specific ProGuard rules here.
+# By default, the flags in this file are appended to flags specified
+# in /usr/local/Cellar/android-sdk/24.3.3/tools/proguard/proguard-android.txt
+# You can edit the include path and order by changing the proguardFiles
+# directive in build.gradle.
+#
+# For more details, see
+# http://developer.android.com/guide/developing/tools/proguard.html
+
+# Add any project specific keep options here:
diff --git a/examples/E2ETestApp/android/app/src/androidTest/java/io/getstream/reactnative/e2etestapp/DetoxTest.kt b/examples/E2ETestApp/android/app/src/androidTest/java/io/getstream/reactnative/e2etestapp/DetoxTest.kt
new file mode 100644
index 0000000000..18e8533735
--- /dev/null
+++ b/examples/E2ETestApp/android/app/src/androidTest/java/io/getstream/reactnative/e2etestapp/DetoxTest.kt
@@ -0,0 +1,27 @@
+package io.getstream.reactnative.e2etestapp
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.filters.LargeTest
+import androidx.test.rule.ActivityTestRule
+import com.wix.detox.Detox
+import com.wix.detox.config.DetoxConfig
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4::class)
+@LargeTest
+class DetoxTest {
+ @get:Rule
+ val activityRule = ActivityTestRule(MainActivity::class.java, false, false)
+
+ @Test
+ fun runDetoxTests() {
+ val detoxConfig = DetoxConfig().apply {
+ idlePolicyConfig.masterTimeoutSec = 90
+ idlePolicyConfig.idleResourceTimeoutSec = 60
+ rnContextLoadTimeoutSec = if (BuildConfig.DEBUG) 180 else 60
+ }
+ Detox.runTests(activityRule, detoxConfig)
+ }
+}
diff --git a/examples/E2ETestApp/android/app/src/main/AndroidManifest.xml b/examples/E2ETestApp/android/app/src/main/AndroidManifest.xml
new file mode 100644
index 0000000000..d5ac9c6e7c
--- /dev/null
+++ b/examples/E2ETestApp/android/app/src/main/AndroidManifest.xml
@@ -0,0 +1,28 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/examples/E2ETestApp/android/app/src/main/java/io/getstream/reactnative/e2etestapp/MainActivity.kt b/examples/E2ETestApp/android/app/src/main/java/io/getstream/reactnative/e2etestapp/MainActivity.kt
new file mode 100644
index 0000000000..b59b475ece
--- /dev/null
+++ b/examples/E2ETestApp/android/app/src/main/java/io/getstream/reactnative/e2etestapp/MainActivity.kt
@@ -0,0 +1,22 @@
+package io.getstream.reactnative.e2etestapp
+
+import com.facebook.react.ReactActivity
+import com.facebook.react.ReactActivityDelegate
+import com.facebook.react.defaults.DefaultNewArchitectureEntryPoint.fabricEnabled
+import com.facebook.react.defaults.DefaultReactActivityDelegate
+
+class MainActivity : ReactActivity() {
+
+ /**
+ * Returns the name of the main component registered from JavaScript. This is used to schedule
+ * rendering of the component.
+ */
+ override fun getMainComponentName(): String = "E2ETestApp"
+
+ /**
+ * Returns the instance of the [ReactActivityDelegate]. We use [DefaultReactActivityDelegate]
+ * which allows you to enable New Architecture with a single boolean flags [fabricEnabled]
+ */
+ override fun createReactActivityDelegate(): ReactActivityDelegate =
+ DefaultReactActivityDelegate(this, mainComponentName, fabricEnabled)
+}
diff --git a/examples/E2ETestApp/android/app/src/main/java/io/getstream/reactnative/e2etestapp/MainApplication.kt b/examples/E2ETestApp/android/app/src/main/java/io/getstream/reactnative/e2etestapp/MainApplication.kt
new file mode 100644
index 0000000000..dd573a42aa
--- /dev/null
+++ b/examples/E2ETestApp/android/app/src/main/java/io/getstream/reactnative/e2etestapp/MainApplication.kt
@@ -0,0 +1,27 @@
+package io.getstream.reactnative.e2etestapp
+
+import android.app.Application
+import com.facebook.react.PackageList
+import com.facebook.react.ReactApplication
+import com.facebook.react.ReactHost
+import com.facebook.react.ReactNativeApplicationEntryPoint.loadReactNative
+import com.facebook.react.defaults.DefaultReactHost.getDefaultReactHost
+
+class MainApplication : Application(), ReactApplication {
+
+ override val reactHost: ReactHost by lazy {
+ getDefaultReactHost(
+ context = applicationContext,
+ packageList =
+ PackageList(this).packages.apply {
+ // Packages that cannot be autolinked yet can be added manually here, for example:
+ // add(MyReactNativePackage())
+ },
+ )
+ }
+
+ override fun onCreate() {
+ super.onCreate()
+ loadReactNative(this)
+ }
+}
diff --git a/examples/E2ETestApp/android/app/src/main/res/drawable/rn_edit_text_material.xml b/examples/E2ETestApp/android/app/src/main/res/drawable/rn_edit_text_material.xml
new file mode 100644
index 0000000000..5c25e728ea
--- /dev/null
+++ b/examples/E2ETestApp/android/app/src/main/res/drawable/rn_edit_text_material.xml
@@ -0,0 +1,37 @@
+
+
+
+
+
+
+