appium-flutter-driver/lib/commands/context.ts

Appium Flutter driver

import type {FlutterDriver} from '../driver';
import {log} from '../logger';

export const FLUTTER_CONTEXT_NAME = `FLUTTER`;
export const NATIVE_CONTEXT_NAME = `NATIVE_APP`;

export const getCurrentContext = async function (this: FlutterDriver): Promise<string> {
  return this.currentContext;
};

export const setContext = async function (this: FlutterDriver, context: string) {
  if ([FLUTTER_CONTEXT_NAME, NATIVE_CONTEXT_NAME].includes(context)) {
    this.proxyWebViewActive = false;
    // Set 'native context' when flutter driver sets the context to FLUTTER_CONTEXT_NAME
    if (this.proxydriver) {
      log.debug(
        `Setting downstream drier context to '${NATIVE_CONTEXT_NAME}' in context '${context}'.`,
      );
      // @ts-expect-error this exist in xcuitestdriver or uia2 driver
      await this.proxydriver.setContext(NATIVE_CONTEXT_NAME);
    }
  } else {
    // this case may be 'webview'
    if (this.proxydriver) {
      log.debug(`Setting downstream drier context to '${context}'.`);
      // @ts-expect-error this exist in xcuitestdriver or uia2 driver
      await this.proxydriver.setContext(context);
      this.proxyWebViewActive = true;
    }
  }
  this.currentContext = context;
  if (context === FLUTTER_CONTEXT_NAME) {
    log.debug(
      `Downstream driver context is set as 'NATIVE_APP' in 'FLUTTER' context to handle the native app.`,
    );
  }
};

export const getContexts = async function (this: FlutterDriver): Promise<string[]> {
  // @ts-expect-error this exist in xcuitestdriver or uia2 driver
  const nativeContext = await this.proxydriver?.getContexts();
  if (nativeContext) {
    return [...(nativeContext as string[]), FLUTTER_CONTEXT_NAME];
  } else {
    return [FLUTTER_CONTEXT_NAME];
  }
};

export const driverShouldDoProxyCmd = function (this: FlutterDriver, command: string): boolean {
  if (!this.proxydriver) {
    return false;
  }

  if (this.currentContext === FLUTTER_CONTEXT_NAME) {
    return false;
  }

  if ([`getCurrentContext`, `setContext`, `getContexts`].includes(command)) {
    return false;
  }

  return true;
};