Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore(bidi): add support for emulation.setScreenOrientationOverride (#37390)

Holger Benl434c6f5b40fe
diff --git a/packages/playwright-core/src/server/bidi/bidiBrowser.ts b/packages/playwright-core/src/server/bidi/bidiBrowser.ts
index d92e05f898..96703ef9e5 100644
--- a/packages/playwright-core/src/server/bidi/bidiBrowser.ts
+++ b/packages/playwright-core/src/server/bidi/bidiBrowser.ts
@@ -354,14 +354,20 @@ export class BidiBrowserContext extends BrowserContext {
override async doUpdateDefaultViewport() {
if (!this._options.viewport)
return;
- await this._browser._browserSession.send('browsingContext.setViewport', {
- viewport: {
- width: this._options.viewport.width,
- height: this._options.viewport.height
- },
- devicePixelRatio: this._options.deviceScaleFactor || 1,
- userContexts: [this._userContextId()],
- });
+ await Promise.all([
+ this._browser._browserSession.send('browsingContext.setViewport', {
+ viewport: {
+ width: this._options.viewport.width,
+ height: this._options.viewport.height
+ },
+ devicePixelRatio: this._options.deviceScaleFactor || 1,
+ userContexts: [this._userContextId()],
+ }),
+ this._browser._browserSession.send('emulation.setScreenOrientationOverride', {
+ screenOrientation: getScreenOrientation(!!this._options.isMobile, this._options.viewport),
+ userContexts: [this._userContextId()],
+ })
+ ]);
}
override async doUpdateDefaultEmulatedMedia() {
@@ -479,6 +485,19 @@ function getProxyConfiguration(proxySettings?: types.ProxySettings): bidi.Sessio
return proxy;
}
+export function getScreenOrientation(isMobile: boolean, viewportSize: types.Size) {
+ const screenOrientation: bidi.Emulation.ScreenOrientation = {
+ type: 'landscape-primary',
+ natural: bidi.Emulation.ScreenOrientationNatural.Landscape
+ };
+ if (isMobile) {
+ screenOrientation.natural = bidi.Emulation.ScreenOrientationNatural.Portrait;
+ if (viewportSize.width <= viewportSize.height)
+ screenOrientation.type = 'portrait-primary';
+ }
+ return screenOrientation;
+}
+
export namespace Network {
export const enum SameSite {
Strict = 'strict',
diff --git a/packages/playwright-core/src/server/bidi/bidiPage.ts b/packages/playwright-core/src/server/bidi/bidiPage.ts
index 7dd77fd31e..94c91e53b4 100644
--- a/packages/playwright-core/src/server/bidi/bidiPage.ts
+++ b/packages/playwright-core/src/server/bidi/bidiPage.ts
@@ -18,7 +18,7 @@ import { eventsHelper } from '../utils/eventsHelper';
import * as dialog from '../dialog';
import * as dom from '../dom';
import { Page } from '../page';
-import { BidiBrowserContext } from './bidiBrowser';
+import { BidiBrowserContext, getScreenOrientation } from './bidiBrowser';
import { BidiExecutionContext, createHandle } from './bidiExecutionContext';
import { RawKeyboardImpl, RawMouseImpl, RawTouchscreenImpl } from './bidiInput';
import { BidiNetworkManager } from './bidiNetworkManager';
@@ -299,14 +299,20 @@ export class BidiPage implements PageDelegate {
if (!emulatedSize)
return;
const viewportSize = emulatedSize.viewport;
- await this._session.send('browsingContext.setViewport', {
- context: this._session.sessionId,
- viewport: {
- width: viewportSize.width,
- height: viewportSize.height,
- },
- devicePixelRatio: options.deviceScaleFactor || 1
- });
+ await Promise.all([
+ this._session.send('browsingContext.setViewport', {
+ context: this._session.sessionId,
+ viewport: {
+ width: viewportSize.width,
+ height: viewportSize.height,
+ },
+ devicePixelRatio: options.deviceScaleFactor || 1
+ }),
+ this._session.send('emulation.setScreenOrientationOverride', {
+ contexts: [this._session.sessionId],
+ screenOrientation: getScreenOrientation(!!options.isMobile, viewportSize)
+ })
+ ]);
}
async updateRequestInterception(): Promise<void> {
diff --git a/packages/playwright-core/src/server/bidi/third_party/bidiCommands.d.ts b/packages/playwright-core/src/server/bidi/third_party/bidiCommands.d.ts
index 65435f08b8..b84f6e8b1f 100644
--- a/packages/playwright-core/src/server/bidi/third_party/bidiCommands.d.ts
+++ b/packages/playwright-core/src/server/bidi/third_party/bidiCommands.d.ts
@@ -117,6 +117,10 @@ export interface Commands {
params: Bidi.Emulation.SetGeolocationOverrideParameters;
returnType: Bidi.EmptyResult;
};
+ 'emulation.setScreenOrientationOverride': {
+ params: Bidi.Emulation.SetScreenOrientationOverrideParameters;
+ returnType: Bidi.EmptyResult;
+ };
'emulation.setTimezoneOverride': {
params: Bidi.Emulation.SetTimezoneOverrideParameters;
returnType: Bidi.EmptyResult;