CommandProcessor.ts

/**
 * Copyright 2021 Google LLC.
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type {CdpClient} from '../cdp/CdpClient';
import type {CdpConnection} from '../cdp/CdpConnection.js';
import {
  Exception,
  UnknownCommandException,
  UnknownErrorException,
  type ChromiumBidi,
  type Script,
} from '../protocol/protocol.js';
import {EventEmitter} from '../utils/EventEmitter.js';
import {LogType, type LoggerFn} from '../utils/log.js';
import type {Result} from '../utils/result.js';

import {BidiNoOpParser} from './BidiNoOpParser.js';
import type {BidiCommandParameterParser} from './BidiParser.js';
import type {MapperOptions} from './BidiServer.js';
import type {BluetoothProcessor} from './modules/bluetooth/BluetoothProcessor.js';
import {BrowserProcessor} from './modules/browser/BrowserProcessor.js';
import {CdpProcessor} from './modules/cdp/CdpProcessor.js';
import {BrowsingContextProcessor} from './modules/context/BrowsingContextProcessor.js';
import type {BrowsingContextStorage} from './modules/context/BrowsingContextStorage.js';
import {InputProcessor} from './modules/input/InputProcessor.js';
import {NetworkProcessor} from './modules/network/NetworkProcessor.js';
import type {NetworkStorage} from './modules/network/NetworkStorage.js';
import {PermissionsProcessor} from './modules/permissions/PermissionsProcessor.js';
import type {PreloadScriptStorage} from './modules/script/PreloadScriptStorage.js';
import type {RealmStorage} from './modules/script/RealmStorage.js';
import {ScriptProcessor} from './modules/script/ScriptProcessor.js';
import type {EventManager} from './modules/session/EventManager.js';
import {SessionProcessor} from './modules/session/SessionProcessor.js';
import {StorageProcessor} from './modules/storage/StorageProcessor.js';
import {OutgoingMessage} from './OutgoingMessage.js';

export const enum CommandProcessorEvents {
  Response = 'response',
}

type CommandProcessorEventsMap = {
  [CommandProcessorEvents.Response]: {
    message: Promise<Result<OutgoingMessage>>;
    event: string;
  };
};

export class CommandProcessor extends EventEmitter<CommandProcessorEventsMap> {
  // keep-sorted start
  #bluetoothProcessor: BluetoothProcessor;
  #browserProcessor: BrowserProcessor;
  #browsingContextProcessor: BrowsingContextProcessor;
  #cdpProcessor: CdpProcessor;
  #inputProcessor: InputProcessor;
  #networkProcessor: NetworkProcessor;
  #permissionsProcessor: PermissionsProcessor;
  #scriptProcessor: ScriptProcessor;
  #sessionProcessor: SessionProcessor;
  #storageProcessor: StorageProcessor;
  // keep-sorted end

  #parser: BidiCommandParameterParser;
  #logger?: LoggerFn;

  constructor(
    cdpConnection: CdpConnection,
    browserCdpClient: CdpClient,
    eventManager: EventManager,
    browsingContextStorage: BrowsingContextStorage,
    realmStorage: RealmStorage,
    preloadScriptStorage: PreloadScriptStorage,
    networkStorage: NetworkStorage,
    bluetoothProcessor: BluetoothProcessor,
    parser: BidiCommandParameterParser = new BidiNoOpParser(),
    initConnection: (options: MapperOptions) => Promise<void>,
    logger?: LoggerFn,
  ) {
    super();
    this.#parser = parser;
    this.#logger = logger;

    this.#bluetoothProcessor = bluetoothProcessor;

    // keep-sorted start block=yes
    this.#browserProcessor = new BrowserProcessor(
      browserCdpClient,
      browsingContextStorage,
    );
    this.#browsingContextProcessor = new BrowsingContextProcessor(
      browserCdpClient,
      browsingContextStorage,
      eventManager,
    );
    this.#cdpProcessor = new CdpProcessor(
      browsingContextStorage,
      realmStorage,
      cdpConnection,
      browserCdpClient,
    );
    this.#inputProcessor = new InputProcessor(browsingContextStorage);
    this.#networkProcessor = new NetworkProcessor(
      browsingContextStorage,
      networkStorage,
    );
    this.#permissionsProcessor = new PermissionsProcessor(browserCdpClient);
    this.#scriptProcessor = new ScriptProcessor(
      eventManager,
      browsingContextStorage,
      realmStorage,
      preloadScriptStorage,
      logger,
    );
    this.#sessionProcessor = new SessionProcessor(
      eventManager,
      browserCdpClient,
      initConnection,
    );
    this.#storageProcessor = new StorageProcessor(
      browserCdpClient,
      browsingContextStorage,
      logger,
    );
    // keep-sorted end
  }

  async #processCommand(
    command: ChromiumBidi.Command,
  ): Promise<ChromiumBidi.ResultData> {
    switch (command.method) {
      case 'session.end':
        // TODO: Implement.
        break;

      // Bluetooth domain
      // keep-sorted start block=yes
      case 'bluetooth.handleRequestDevicePrompt':
        return await this.#bluetoothProcessor.handleRequestDevicePrompt(
          this.#parser.parseHandleRequestDevicePromptParams(command.params),
        );
      case 'bluetooth.simulateAdapter':
        return await this.#bluetoothProcessor.simulateAdapter(
          this.#parser.parseSimulateAdapterParameters(command.params),
        );
      case 'bluetooth.simulateAdvertisement':
        return await this.#bluetoothProcessor.simulateAdvertisement(
          this.#parser.parseSimulateAdvertisementParameters(command.params),
        );
      case 'bluetooth.simulatePreconnectedPeripheral':
        return await this.#bluetoothProcessor.simulatePreconnectedPeripheral(
          this.#parser.parseSimulatePreconnectedPeripheralParameters(
            command.params,
          ),
        );
      // keep-sorted end

      // Browser domain
      // keep-sorted start block=yes
      case 'browser.close':
        return this.#browserProcessor.close();
      case 'browser.createUserContext':
        return await this.#browserProcessor.createUserContext(command.params);
      case 'browser.getClientWindows':
        return await this.#browserProcessor.getClientWindows();
      case 'browser.getUserContexts':
        return await this.#browserProcessor.getUserContexts();
      case 'browser.removeUserContext':
        return await this.#browserProcessor.removeUserContext(
          this.#parser.parseRemoveUserContextParams(command.params),
        );
      case 'browser.setClientWindowState':
        throw new UnknownErrorException(
          `Method ${command.method} is not implemented.`,
        );
      // keep-sorted end

      // Browsing Context domain
      // keep-sorted start block=yes
      case 'browsingContext.activate':
        return await this.#browsingContextProcessor.activate(
          this.#parser.parseActivateParams(command.params),
        );
      case 'browsingContext.captureScreenshot':
        return await this.#browsingContextProcessor.captureScreenshot(
          this.#parser.parseCaptureScreenshotParams(command.params),
        );
      case 'browsingContext.close':
        return await this.#browsingContextProcessor.close(
          this.#parser.parseCloseParams(command.params),
        );
      case 'browsingContext.create':
        return await this.#browsingContextProcessor.create(
          this.#parser.parseCreateParams(command.params),
        );
      case 'browsingContext.getTree':
        return this.#browsingContextProcessor.getTree(
          this.#parser.parseGetTreeParams(command.params),
        );
      case 'browsingContext.handleUserPrompt':
        return await this.#browsingContextProcessor.handleUserPrompt(
          this.#parser.parseHandleUserPromptParams(command.params),
        );
      case 'browsingContext.locateNodes':
        return await this.#browsingContextProcessor.locateNodes(
          this.#parser.parseLocateNodesParams(command.params),
        );
      case 'browsingContext.navigate':
        return await this.#browsingContextProcessor.navigate(
          this.#parser.parseNavigateParams(command.params),
        );
      case 'browsingContext.print':
        return await this.#browsingContextProcessor.print(
          this.#parser.parsePrintParams(command.params),
        );
      case 'browsingContext.reload':
        return await this.#browsingContextProcessor.reload(
          this.#parser.parseReloadParams(command.params),
        );
      case 'browsingContext.setViewport':
        return await this.#browsingContextProcessor.setViewport(
          this.#parser.parseSetViewportParams(command.params),
        );
      case 'browsingContext.traverseHistory':
        return await this.#browsingContextProcessor.traverseHistory(
          this.#parser.parseTraverseHistoryParams(command.params),
        );
      // keep-sorted end

      // CDP domain
      // keep-sorted start block=yes
      case 'cdp.getSession':
        return this.#cdpProcessor.getSession(
          this.#parser.parseGetSessionParams(command.params),
        );
      case 'cdp.resolveRealm':
        return this.#cdpProcessor.resolveRealm(
          this.#parser.parseResolveRealmParams(command.params),
        );
      case 'cdp.sendCommand':
        return await this.#cdpProcessor.sendCommand(
          this.#parser.parseSendCommandParams(command.params),
        );
      // keep-sorted end

      // Input domain
      // keep-sorted start block=yes
      case 'input.performActions':
        return await this.#inputProcessor.performActions(
          this.#parser.parsePerformActionsParams(command.params),
        );
      case 'input.releaseActions':
        return await this.#inputProcessor.releaseActions(
          this.#parser.parseReleaseActionsParams(command.params),
        );
      case 'input.setFiles':
        return await this.#inputProcessor.setFiles(
          this.#parser.parseSetFilesParams(command.params),
        );
      // keep-sorted end

      // Network domain
      // keep-sorted start block=yes
      case 'network.addIntercept':
        return await this.#networkProcessor.addIntercept(
          this.#parser.parseAddInterceptParams(command.params),
        );
      case 'network.continueRequest':
        return await this.#networkProcessor.continueRequest(
          this.#parser.parseContinueRequestParams(command.params),
        );
      case 'network.continueResponse':
        return await this.#networkProcessor.continueResponse(
          this.#parser.parseContinueResponseParams(command.params),
        );
      case 'network.continueWithAuth':
        return await this.#networkProcessor.continueWithAuth(
          this.#parser.parseContinueWithAuthParams(command.params),
        );
      case 'network.failRequest':
        return await this.#networkProcessor.failRequest(
          this.#parser.parseFailRequestParams(command.params),
        );
      case 'network.provideResponse':
        return await this.#networkProcessor.provideResponse(
          this.#parser.parseProvideResponseParams(command.params),
        );
      case 'network.removeIntercept':
        return await this.#networkProcessor.removeIntercept(
          this.#parser.parseRemoveInterceptParams(command.params),
        );
      case 'network.setCacheBehavior':
        return await this.#networkProcessor.setCacheBehavior(
          this.#parser.parseSetCacheBehavior(command.params),
        );
      // keep-sorted end

      // Permissions domain
      // keep-sorted start block=yes
      case 'permissions.setPermission':
        return await this.#permissionsProcessor.setPermissions(
          this.#parser.parseSetPermissionsParams(command.params),
        );
      // keep-sorted end

      // Script domain
      // keep-sorted start block=yes
      case 'script.addPreloadScript':
        return await this.#scriptProcessor.addPreloadScript(
          this.#parser.parseAddPreloadScriptParams(command.params),
        );
      case 'script.callFunction':
        return await this.#scriptProcessor.callFunction(
          this.#parser.parseCallFunctionParams(
            this.#processTargetParams(command.params),
          ),
        );
      case 'script.disown':
        return await this.#scriptProcessor.disown(
          this.#parser.parseDisownParams(
            this.#processTargetParams(command.params),
          ),
        );
      case 'script.evaluate':
        return await this.#scriptProcessor.evaluate(
          this.#parser.parseEvaluateParams(
            this.#processTargetParams(command.params),
          ),
        );
      case 'script.getRealms':
        return this.#scriptProcessor.getRealms(
          this.#parser.parseGetRealmsParams(command.params),
        );
      case 'script.removePreloadScript':
        return await this.#scriptProcessor.removePreloadScript(
          this.#parser.parseRemovePreloadScriptParams(command.params),
        );
      // keep-sorted end

      // Session domain
      // keep-sorted start block=yes
      case 'session.new':
        return await this.#sessionProcessor.new(command.params);
      case 'session.status':
        return this.#sessionProcessor.status();
      case 'session.subscribe':
        return await this.#sessionProcessor.subscribe(
          this.#parser.parseSubscribeParams(command.params),
          command.channel,
        );
      case 'session.unsubscribe':
        return await this.#sessionProcessor.unsubscribe(
          this.#parser.parseSubscribeParams(command.params),
          command.channel,
        );
      // keep-sorted end

      // Storage domain
      // keep-sorted start block=yes
      case 'storage.deleteCookies':
        return await this.#storageProcessor.deleteCookies(
          this.#parser.parseDeleteCookiesParams(command.params),
        );
      case 'storage.getCookies':
        return await this.#storageProcessor.getCookies(
          this.#parser.parseGetCookiesParams(command.params),
        );
      case 'storage.setCookie':
        return await this.#storageProcessor.setCookie(
          this.#parser.parseSetCookieParams(command.params),
        );
      // keep-sorted end
    }

    // Intentionally kept outside the switch statement to ensure that
    // ESLint @typescript-eslint/switch-exhaustiveness-check triggers if a new
    // command is added.
    throw new UnknownCommandException(`Unknown command '${command.method}'.`);
  }

  // Workaround for as zod.union always take the first schema
  // https://github.com/w3c/webdriver-bidi/issues/635
  #processTargetParams(params: {target: Script.Target}) {
    if (
      typeof params === 'object' &&
      params &&
      'target' in params &&
      typeof params.target === 'object' &&
      params.target &&
      'context' in params.target
    ) {
      delete (params.target as any)['realm'];
    }
    return params;
  }

  async processCommand(command: ChromiumBidi.Command): Promise<void> {
    try {
      const result = await this.#processCommand(command);

      const response = {
        type: 'success',
        id: command.id,
        result,
      } satisfies ChromiumBidi.CommandResponse;

      this.emit(CommandProcessorEvents.Response, {
        message: OutgoingMessage.createResolved(response, command.channel),
        event: command.method,
      });
    } catch (e) {
      if (e instanceof Exception) {
        this.emit(CommandProcessorEvents.Response, {
          message: OutgoingMessage.createResolved(
            e.toErrorResponse(command.id),
            command.channel,
          ),
          event: command.method,
        });
      } else {
        const error = e as Error;
        this.#logger?.(LogType.bidi, error);
        this.emit(CommandProcessorEvents.Response, {
          message: OutgoingMessage.createResolved(
            new UnknownErrorException(
              error.message,
              error.stack,
            ).toErrorResponse(command.id),
            command.channel,
          ),
          event: command.method,
        });
      }
    }
  }
}