mattermost-mobile-upstream/detox
Andre Vasconcelos e18fc6921e
MM-68208 Implementing global and channel-level banners on mobile (#9752)
* Expo-Router partial migration

* Full migration to ExpoRouter

* i18n

* add tests

* library hardware-keyboard android new arch support fix

* library rnshare android new arch support fix

* library rnutils android new arch support fix

* library secure-pdf-viewer add new arch support

* Enable new arch on iOS and Android

* update emm and network client with new-arch

* update intune to use new-arch

* performance improvements

* fix tests

* fixes post input on new-arch

* Merge branch 'main' into expo-router

* fix android emoji picker

* align package-lock.json

* i18n

* feedback review

* feedback review

* android 16kb patch

* Refactored emoji picker keyboard using a state machine

* set android launch_screen in drawables instead of layout

* no conditional hooks

* remove duplicate call in test

* address feedback

* fix tests and address more feedback

* small corrections

* small corrections

* small corrections

* fix draft test

* fix draft test 2

* remove navigateToScreen in draff test

* fix nit in draft test

* remove doc file

* remove doc

* run tests in parallel

* Feedback review

* fix snapshots

* improve test coverage

* fix i18n

* upgrade to React Native 0.83.9, Expo 55, React 19, and New Architecture

Bumps core dependencies to their latest versions:
- React Native 0.77.3 → 0.83.9 (New Architecture enabled)
- React 18.3.1 → 19.2.5
- Expo SDK 52 → 55
- TypeScript 5.8.3 → 6.0.3
- Node.js 22.16.0 → 24.15.0
- react-native-reanimated 3.17.3 → 4.3.0
- Various other dependency upgrades

Migrates iOS AppDelegate from Objective-C to Swift, updates Android
build tooling and Gradle wrapper, refreshes all patches and font
assets, and adapts app code, tests, and CI workflows throughout for
API changes introduced by these upgrades.

* remove unecessary dismissKeyboard in notifications

* feedback review

* update intune to use new-arch

* update @mattermost deps

* missing i18n string

* additional fixes

* update fastlane

* Re-implementing global classification banners on top of rn83

* Refactoring to de-couple the classification banner from the layout

* Implementing per-channel banners on mobile

* Removing custom header in favor of common component

* Making fixes for coderabbit

* Improving padding calculation

* Converting global classification banner to use portals

* Removing dead code, adding deletion check

* Addressing dryrun securit concerns

* Removing call for template field, improving consistency

* MM-68208 Storing system property values in WatermelonDB (#9781)

* Added persistence layer to system properties

* Making debounce behavior more consistent

* Cleaning up debounce logic from store persistence

* Addressing PR feedback

* Removing ephemeral store usage and employing observables

- Changing name of group to access_control

* Updating unit tests

* Refactoring to improve code consistency

- Removing any patterns introduced that weren't already established in the repo
- Removing hooks with database reads in favor of withObservables and withDatabase pattern
- Simplifying _layout.tsx by removing inset modification, now handled in the Container HoC component
- Moved some repeated hook logic into its own utils file

* Refactoring to use propertyfield and propertyvalue tables instead of system

- Simplified remote actions to purely perform API call, and call a local action to sync values
- Using local action layer to perform syncing and removal operations of property fields and values
- Observables now pre-filter for active fields / values via querying for delete_at=0

* Improving consistency of local actions

- Added unit tests for syncPropertyFieldsByGroupId, syncPropertyValuesByTargetId, clearClassificationData

* Replacing local actions with operator handlers

* Removing needless mocks from unit tests

* Consolidating operator handlers

- Leaving 1 handler for fields and 1 for values, each of them evaluating whether to delete or upsert values received in the function call

* MM-68208 Making changes based on feedback

- Removing !visible guard in global classification container
- Increasing clarity of comment for clearing of stale fields
- Updating log messages to be more clear

* Batching database operations together for fields and values

* Consolidating API call for fetching classification data

- Preparation for caching mechanism

* Updating field names to the unified classification

* Updating E2E test values to match current field names

---------

Co-authored-by: Elias Nahum <nahumhbl@gmail.com>
Co-authored-by: Mattermost Build <build@mattermost.com>
2026-07-08 12:47:01 +03:00
..
android_emulator test(detox): re-submit RF→Detox migration without unintended UI changes (#9847) 2026-06-19 22:44:02 +05:30
e2e MM-68208 Implementing global and channel-level banners on mobile (#9752) 2026-07-08 12:47:01 +03:00
maestro feat(e2e): Run e2e against different server version when rc branch is pushed (#9800) 2026-07-07 18:02:13 +05:30
provision test(maestro): Add maestro test framework (#9788) 2026-06-26 15:08:55 +05:30
scripts test(maestro): Add maestro test framework (#9788) 2026-06-26 15:08:55 +05:30
utils feat(e2e): Run e2e against different server version when rc branch is pushed (#9800) 2026-07-07 18:02:13 +05:30
.babelrc Barebones code for v2 2020-11-17 14:20:58 -03:00
.detoxrc.json test(detox): re-submit RF→Detox migration without unintended UI changes (#9847) 2026-06-19 22:44:02 +05:30
CLAUDE.md test(maestro): Add maestro test framework (#9788) 2026-06-26 15:08:55 +05:30
create_android_emulator.sh test(maestro): Add maestro test framework (#9788) 2026-06-26 15:08:55 +05:30
generate_unified_report.js test(detox): re-submit RF→Detox migration without unintended UI changes (#9847) 2026-06-19 22:44:02 +05:30
inject-detox-settings.js Revert "e2e(detox): Rainforest to Detox migration (#9790)" (#9834) 2026-06-15 17:57:01 +02:00
package-lock.json Mattermost Blocks (#9764) 2026-06-29 18:42:16 +02:00
package.json feat(e2e): Run e2e against different server version when rc branch is pushed (#9800) 2026-07-07 18:02:13 +05:30
README.md test(detox): re-submit RF→Detox migration without unintended UI changes (#9847) 2026-06-19 22:44:02 +05:30
save_maestro_zephyr.js feat(e2e): Run e2e against different server version when rc branch is pushed (#9800) 2026-07-07 18:02:13 +05:30
save_report.js test(detox): re-submit RF→Detox migration without unintended UI changes (#9847) 2026-06-19 22:44:02 +05:30
tsconfig.json test(maestro): Add maestro test framework (#9788) 2026-06-26 15:08:55 +05:30
webhook_server.js Mattermost Blocks (#9764) 2026-06-29 18:42:16 +02:00

How to Run Detox Tests

This guide will help you set up and run Detox tests for your project.

Install Dependencies

First, navigate to the root directory of your project and install the necessary dependencies by running:

npm install

navigate to the detox folder and run npm install

Configure your server details

in detox/e2e/support/test_config.ts will provide some default values for your server, if they differ you can:

  • use environment variables
  export SITE_1_URL="http://your-server:8065"
  export ADMIN_USERNAME="your-username"
  export ADMIN_PASSWORD="your-password"
  export ADMIN_EMAIL="your-email"
  • create a .env file in the detox folder providing the values:
  # detox/.env
  SITE_1_URL=http://localhost:8065
  ADMIN_USERNAME=your-username
  ADMIN_PASSWORD=your-password
  ADMIN_EMAIL=your-email@example.com

Note: no need to provide all variables, only the ones that differ.

Android

Build Detox Android App

To build the Detox Android app, navigate to the detox folder and run:

npm run e2e:android-build

The debug apk will be built and available at android/app/build/outputs/apk/debug/app-debug.apk

Run Detox Android Tests

Create emulator

./create_android_emulator.sh SDK_VERSION AVD_NAME

# example ./create_android_emulator.sh 34 pixel_5a_avd
# example ./create_android_emulator.sh 34 pixel_5a_avd --headless
# If we want to see the emulator logs. Run it in debug mode example ./create_android_emulator.sh 34 pixel_5a_avd --debug

To execute the Detox tests on Android, navigate to the detox folder and run:

npm run e2e:android-test

# To run a particular tests

npm run e2e:android-test <path to test file>

Local runs now default to a lower-memory setup so they coexist better with other tools:

  • Detox uses 1 worker unless you set DETOX_MAX_WORKERS.
  • Detox caps Node heap at 4096MB unless you already set NODE_OPTIONS.
  • Android Detox builds cap Gradle heap at 3072MB and use at most 2 Gradle workers unless you override MM_GRADLE_XMX_MB or MM_GRADLE_WORKERS_MAX.
  • Android emulator RAM defaults to 3072MB when created or refreshed; override with MM_ANDROID_EMULATOR_RAM_MB.

iOS

Build iOS Simulator

To build the iOS simulator for Detox, from the project folder run:

npm run e2e:ios-build

This will build the Simulator .zip file at the root folder.

Create a folder named mobile-artifacts at the project root. Move the zip file under mobile-artifacts and unzip it there.

# From project root
mkdir mobile-artifacts

Configure your local

Update detox/.detoxrc.json to specify which device you want to run it. Change:

 "device": {
     "type": "__DEVICE_NAME__",
     "os": "__DEVICE_OS_VERSION__"
 },

to something like:

 "device": {
     "type": "iPhone 17 Pro",
     "os": "iOS 26.4"
 },

To get your values run xcrun simctl list devices to find both the device and iOS version.

Run iOS Tests

To execute the Detox tests on iOS, navigate to the detox folder and run:

npm run e2e:ios-test

# To run a particular tests

npm run e2e:android-test path to test file.

Disabling Password Autofill

from iOS v26 password autofill can interfere with login tests by automatically filling credentials. To disable this feature on your simulator:

# Interactive mode - select simulator from list
npm run e2e:ios-disable-autofill

# Or specify simulator ID directly
npm run e2e:ios-disable-autofill -- --simulator-id SIMULATOR_UDID

When to use this:

  • if using iOS 26 or later
  • Before running iOS E2E tests if you notice password fields being auto-filled
  • When login tests fail unexpectedly due to autofill interference
  • After creating a new iOS simulator for testing

Note: CI environments automatically disable this setting, so this is only needed for local development.

Finding your simulator ID:

xcrun simctl list devices | grep Booted

TIP : For iOS, you can download the simulator from ~Mobile: Test build or ~Release: Mobile Apps channel in the community.

Results

The Local Runs generate artifacts under detox/artifacts/ios-debug-** or detox/artifacts/android-debug-**. You can see the html report, failure screenshot under that folder.

Playbooks Tests (AI-Powered Testing)

The Playbooks tests leverage AI-powered testing through the Wix Pilot framework, enabling natural language test creation and execution.

How It Works

The Playbooks tests utilize the pilot library, which connects to Anthropic Claude via the ClaudePromptHandler. This innovative approach allows you to:

  • Write tests using natural language prompts
  • Automatically translate prompts into executable test steps
  • Maintain tests more intuitively through conversational interfaces
  • Handle complex scenarios with AI-generated test logic

The system integrates seamlessly with your existing Detox test infrastructure while adding AI capabilities.

Best Practices

For reliable and effective Playbooks tests, follow these guidelines from the Pilot Best Practices Guide:

  1. Prompt Clarity:

    • Write clear, concise prompts
    • Use specific action-oriented language
    • Avoid ambiguous phrasing
  2. Test Design:

    • Keep prompts focused on single scenarios
    • Use deterministic language to prevent flaky tests
    • Structure complex tests as sequences of simple prompts
  3. Maintenance:

    • Review AI-generated test steps before committing
    • Version control both prompts and generated code
    • Monitor test stability regularly
  4. Integration:

    • Combine AI tests with traditional assertions
    • Use AI for complex scenarios, traditional methods for simple verifications
    • Document which tests are AI-generated

Getting Started

To run Playbooks tests:

  1. Set up your environment:

    export ANTHROPIC_API_KEY='your-api-key-here'
    
  2. Run tests normally:

    • The system will automatically initialize the ClaudePromptHandler when the API key is detected
    • No additional configuration is required beyond the API key
  3. Execution examples:

    # Run all Playbooks tests
    npm run e2e:android-test tests/playbooks/
    
    # Run a specific Playbook test
    npm run e2e:ios-test tests/playbooks/playbooks_basic.e2e.ts
    

Technical Notes

  • The Pilot framework handles the translation between natural language prompts and executable code
  • Tests are cached locally after generation for faster subsequent runs
  • All AI interactions are logged in the test artifacts for debugging
  • The system falls back to traditional testing methods if the API key isn't available

For complete documentation, see: