feat: emulation.setScreenSettingsOverride (#3943)

Author: sadym-chromium

.gitignore

@@ -23,3 +23,4 @@ coverage/
 wpt-metadata/mapper/headful/webdriver/tests/bidi/
 *.tsbuildinfo
 **.code-workspace
+.agent/

src/bidiMapper/BidiNoOpParser.ts

@@ -211,6 +211,11 @@ export class BidiNoOpParser implements BidiCommandParameterParser {
   ): Emulation.SetScreenOrientationOverrideParameters {
     return params as Emulation.SetScreenOrientationOverrideParameters;
   }
+  parseSetScreenSettingsOverrideParams(
+    params: unknown,
+  ): Emulation.SetScreenSettingsOverrideParameters {
+    return params as Emulation.SetScreenSettingsOverrideParameters;
+  }
   parseSetScriptingEnabledParams(
     params: unknown,
   ): Emulation.SetScriptingEnabledParameters {

src/bidiMapper/BidiParser.ts

@@ -137,6 +137,9 @@ export interface BidiCommandParameterParser {
   parseSetScreenOrientationOverrideParams(
     params: unknown,
   ): Emulation.SetScreenOrientationOverrideParameters;
+  parseSetScreenSettingsOverrideParams(
+    params: unknown,
+  ): Emulation.SetScreenSettingsOverrideParameters;
   parseSetScriptingEnabledParams(
     params: unknown,
   ): Emulation.SetScriptingEnabledParameters;

src/bidiMapper/CommandProcessor.ts

@@ -346,6 +346,10 @@ export class CommandProcessor extends EventEmitter<CommandProcessorEventsMap> {
         return await this.#emulationProcessor.setScreenOrientationOverride(
           this.#parser.parseSetScreenOrientationOverrideParams(command.params),
         );
+      case 'emulation.setScreenSettingsOverride':
+        return await this.#emulationProcessor.setScreenSettingsOverride(
+          this.#parser.parseSetScreenSettingsOverrideParams(command.params),
+        );
       case 'emulation.setScriptingEnabled':
         return await this.#emulationProcessor.setScriptingEnabled(
           this.#parser.parseSetScriptingEnabledParams(command.params),

src/bidiMapper/modules/browser/ContextConfig.ts

@@ -44,6 +44,7 @@ export class ContextConfig {
     | null;
   locale?: string | null;
   prerenderingDisabled?: boolean;
+  screenArea?: Emulation.ScreenArea | null;
   screenOrientation?: Emulation.ScreenOrientation | null;
   scriptingEnabled?: false | null;
   // Timezone is kept in CDP format with GMT prefix for offset values.

src/bidiMapper/modules/cdp/CdpTarget.ts

@@ -588,11 +588,13 @@ export class CdpTarget {
     viewport: BrowsingContext.Viewport | null,
     devicePixelRatio: number | null,
     screenOrientation: Emulation.ScreenOrientation | null,
+    screenArea: Emulation.ScreenArea | null,
   ) {
     if (
       viewport === null &&
       devicePixelRatio === null &&
-      screenOrientation === null
+      screenOrientation === null &&
+      screenArea === null
     ) {
       await this.cdpClient.sendCommand('Emulation.clearDeviceMetricsOverride');
       return;
@@ -606,6 +608,8 @@ export class CdpTarget {
         screenOrientation:
           this.#toCdpScreenOrientationAngle(screenOrientation) ?? undefined,
         mobile: false,
+        screenWidth: screenArea?.width,
+        screenHeight: screenArea?.height,
       };
 
     await this.cdpClient.sendCommand(
@@ -637,13 +641,15 @@ export class CdpTarget {
     if (
       config.viewport !== undefined ||
       config.devicePixelRatio !== undefined ||
-      config.screenOrientation !== undefined
+      config.screenOrientation !== undefined ||
+      config.screenArea !== undefined
     ) {
       promises.push(
         this.setDeviceMetricsOverride(
           config.viewport ?? null,
           config.devicePixelRatio ?? null,
           config.screenOrientation ?? null,
+          config.screenArea ?? null,
         ).catch(() => {
           // Ignore CDP errors, as the command is not supported by iframe targets. Generic
           // catch, as the error can vary between CdpClient implementations: Tab vs

src/bidiMapper/modules/context/BrowsingContextImpl.ts

@@ -1134,10 +1134,15 @@ export class BrowsingContextImpl {
     screenOrientation: Emulation.ScreenOrientation | null,
   ) {
     // Set the target's viewport.
+    const config = this.#configStorage.getActiveConfig(
+      this.id,
+      this.userContext,
+    );
     await this.cdpTarget.setDeviceMetricsOverride(
       viewport,
       devicePixelRatio,
       screenOrientation,
+      config.screenArea ?? null,
     );
   }
 

src/bidiMapper/modules/emulation/EmulationProcessor.ts

@@ -247,6 +247,47 @@ export class EmulationProcessor {
     return {};
   }
 
+  async setScreenSettingsOverride(
+    params: Emulation.SetScreenSettingsOverrideParameters,
+  ): Promise<EmptyResult> {
+    const browsingContexts = await this.#getRelatedTopLevelBrowsingContexts(
+      params.contexts,
+      params.userContexts,
+    );
+
+    for (const browsingContextId of params.contexts ?? []) {
+      this.#contextConfigStorage.updateBrowsingContextConfig(
+        browsingContextId,
+        {
+          screenArea: params.screenArea,
+        },
+      );
+    }
+    for (const userContextId of params.userContexts ?? []) {
+      this.#contextConfigStorage.updateUserContextConfig(userContextId, {
+        screenArea: params.screenArea,
+      });
+    }
+
+    await Promise.all(
+      browsingContexts.map(async (context) => {
+        // Actual value can be different from the one in params, e.g. in case of already
+        // existing more granular setting.
+        const config = this.#contextConfigStorage.getActiveConfig(
+          context.id,
+          context.userContext,
+        );
+
+        await context.setViewport(
+          config.viewport ?? null,
+          config.devicePixelRatio ?? null,
+          config.screenOrientation ?? null,
+        );
+      }),
+    );
+    return {};
+  }
+
   /**
    * Returns a list of top-level browsing contexts.
    */

src/bidiTab/BidiParser.ts

@@ -212,6 +212,11 @@ export class BidiParser implements BidiCommandParameterParser {
   ): Emulation.SetScreenOrientationOverrideParameters {
     return Parser.Emulation.parseSetScreenOrientationOverrideParams(params);
   }
+  parseSetScreenSettingsOverrideParams(
+    params: unknown,
+  ): Emulation.SetScreenSettingsOverrideParameters {
+    return Parser.Emulation.parseSetScreenSettingsOverrideParams(params);
+  }
   parseSetScriptingEnabledParams(
     params: unknown,
   ): Emulation.SetScriptingEnabledParameters {

src/protocol-parser/generated/webdriver-bidi.ts

@@ -1307,6 +1307,7 @@ export const EmulationCommandSchema = z.lazy(() =>
     Emulation.SetLocaleOverrideSchema,
     Emulation.SetNetworkConditionsSchema,
     Emulation.SetScreenOrientationOverrideSchema,
+    Emulation.SetScreenSettingsOverrideSchema,
     Emulation.SetScriptingEnabledSchema,
     Emulation.SetTimezoneOverrideSchema,
     Emulation.SetUserAgentOverrideSchema,