Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore(bidi) add support for emulation.setLocaleOverride (#36862)
Holger Benl81684fa4100e
diff --git a/packages/playwright-core/src/server/bidi/bidiBrowser.ts b/packages/playwright-core/src/server/bidi/bidiBrowser.tsindex 5235b74a88..76847bd5d3 100644--- a/packages/playwright-core/src/server/bidi/bidiBrowser.ts+++ b/packages/playwright-core/src/server/bidi/bidiBrowser.ts@@ -199,6 +199,12 @@ export class BidiBrowserContext extends BrowserContext {promises.push(this.doUpdateDefaultViewport());if (this._options.geolocation)promises.push(this.setGeolocation(this._options.geolocation));+ if (this._options.locale) {+ promises.push(this._browser._browserSession.send('emulation.setLocaleOverride', {+ locale: this._options.locale,+ userContexts: [this._userContextId()],+ }));+ }await Promise.all(promises);}@@ -295,7 +301,7 @@ export class BidiBrowserContext extends BrowserContext {},state,origin,- userContext: this._browserContextId || 'default',+ userContext: this._userContextId(),});}@@ -310,7 +316,7 @@ export class BidiBrowserContext extends BrowserContext {longitude: geolocation.longitude,accuracy: geolocation.accuracy,} : null,- userContexts: [this._browserContextId || 'default'],+ userContexts: [this._userContextId()],});}@@ -333,7 +339,7 @@ export class BidiBrowserContext extends BrowserContext {const { script } = await this._browser._browserSession.send('script.addPreloadScript', {// TODO: remove function call from the source.functionDeclaration: `() => { return ${initScript.source} }`,- userContexts: [this._browserContextId || 'default'],+ userContexts: [this._userContextId()],});this._initScriptIds.set(initScript, script);}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.tsindex 5463cbaf77..5be629678a 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@@ -118,6 +118,11 @@ export interface Commands {returnType: Bidi.EmptyResult;};+ 'emulation.setLocaleOverride': {+ params: Bidi.Emulation.SetLocaleOverrideParameters;+ returnType: Bidi.EmptyResult;+ };+'permissions.setPermission': {params: Bidi.Permissions.SetPermissionParameters;returnType: Bidi.EmptyResult;diff --git a/packages/playwright-core/src/server/bidi/third_party/bidiProtocolCore.ts b/packages/playwright-core/src/server/bidi/third_party/bidiProtocolCore.tsindex 81e9e8b713..5d9bedd662 100644--- a/packages/playwright-core/src/server/bidi/third_party/bidiProtocolCore.ts+++ b/packages/playwright-core/src/server/bidi/third_party/bidiProtocolCore.ts@@ -1,8 +1,18 @@/**- * @license- * Copyright 2024 Google Inc.- * Modifications copyright (c) Microsoft Corporation.- * SPDX-License-Identifier: Apache-2.0+ * Copyright 2024 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.*/// Copied from upstream: https://github.com/GoogleChromeLabs/chromium-bidi/blob/main/src/protocol/generated/webdriver-bidi.ts@@ -80,11 +90,13 @@ export const enum ErrorCode {InvalidWebExtension = 'invalid web extension',MoveTargetOutOfBounds = 'move target out of bounds',NoSuchAlert = 'no such alert',+ NoSuchNetworkCollector = 'no such network collector',NoSuchElement = 'no such element',NoSuchFrame = 'no such frame',NoSuchHandle = 'no such handle',NoSuchHistoryEntry = 'no such history entry',NoSuchIntercept = 'no such intercept',+ NoSuchNetworkData = 'no such network data',NoSuchNode = 'no such node',NoSuchRequest = 'no such request',NoSuchScript = 'no such script',@@ -96,6 +108,7 @@ export const enum ErrorCode {UnableToCloseBrowser = 'unable to close browser',UnableToSetCookie = 'unable to set cookie',UnableToSetFileInput = 'unable to set file input',+ UnavailableNetworkData = 'unavailable network data',UnderspecifiedStoragePartition = 'underspecified storage partition',UnknownCommand = 'unknown command',UnknownError = 'unknown error',@@ -148,7 +161,6 @@ export namespace Session {export namespace Session {export type ManualProxyConfiguration = {proxyType: 'manual';- ftpProxy?: string;httpProxy?: string;sslProxy?: string;} & ({} | Session.SocksProxyConfiguration) & {@@ -334,6 +346,7 @@ export namespace Browser {export type CreateUserContextParameters = {acceptInsecureCerts?: boolean;proxy?: Session.ProxyConfiguration;+ unhandledPromptBehavior?: Session.UserPromptHandler;};}export namespace Browser {@@ -414,6 +427,7 @@ export type BrowsingContextEvent =| BrowsingContext.ContextCreated| BrowsingContext.ContextDestroyed| BrowsingContext.DomContentLoaded+ | BrowsingContext.DownloadEnd| BrowsingContext.DownloadWillBegin| BrowsingContext.FragmentNavigated| BrowsingContext.HistoryUpdated@@ -866,6 +880,7 @@ export namespace BrowsingContext {export namespace BrowsingContext {export type HistoryUpdatedParameters = {context: BrowsingContext.BrowsingContext;+ timestamp: JsUint;url: string;};}@@ -892,6 +907,28 @@ export namespace BrowsingContext {suggestedFilename: string;} & BrowsingContext.BaseNavigationInfo;}+export namespace BrowsingContext {+ export type DownloadEnd = {+ method: 'browsingContext.downloadEnd';+ params: BrowsingContext.DownloadEndParams;+ };+}+export namespace BrowsingContext {+ export type DownloadEndParams =+ | BrowsingContext.DownloadCanceledParams+ | BrowsingContext.DownloadCompleteParams;+}+export namespace BrowsingContext {+ export type DownloadCanceledParams = {+ status: 'canceled';+ } & BrowsingContext.BaseNavigationInfo;+}+export namespace BrowsingContext {+ export type DownloadCompleteParams = {+ status: 'complete';+ filepath: string | null;+ } & BrowsingContext.BaseNavigationInfo;+}export namespace BrowsingContext {export type NavigationAborted = {method: 'browsingContext.navigationAborted';@@ -939,7 +976,34 @@ export namespace BrowsingContext {defaultValue?: string;};}-export type EmulationCommand = Emulation.SetGeolocationOverride;+export type EmulationCommand =+ | Emulation.SetForcedColorsModeThemeOverride+ | Emulation.SetGeolocationOverride+ | Emulation.SetLocaleOverride+ | Emulation.SetScreenOrientationOverride+ | Emulation.SetTimezoneOverride;+export namespace Emulation {+ export type SetForcedColorsModeThemeOverride = {+ method: 'emulation.setForcedColorsModeThemeOverride';+ params: Emulation.SetForcedColorsModeThemeOverrideParameters;+ };+}+export namespace Emulation {+ export type SetForcedColorsModeThemeOverrideParameters = {+ theme: Emulation.ForcedColorsModeTheme | null;+ contexts?: [+ BrowsingContext.BrowsingContext,+ ...BrowsingContext.BrowsingContext[],+ ];+ userContexts?: [Browser.UserContext, ...Browser.UserContext[]];+ };+}+export namespace Emulation {+ export const enum ForcedColorsModeTheme {+ Light = 'light',+ Dark = 'dark',+ }+}export namespace Emulation {export type SetGeolocationOverride = {method: 'emulation.setGeolocationOverride';@@ -1007,15 +1071,87 @@ export namespace Emulation {type: 'positionUnavailable';};}+export namespace Emulation {+ export type SetLocaleOverride = {+ method: 'emulation.setLocaleOverride';+ params: Emulation.SetLocaleOverrideParameters;+ };+}+export namespace Emulation {+ export type SetLocaleOverrideParameters = {+ locale: string | null;+ contexts?: [+ BrowsingContext.BrowsingContext,+ ...BrowsingContext.BrowsingContext[],+ ];+ userContexts?: [Browser.UserContext, ...Browser.UserContext[]];+ };+}+export namespace Emulation {+ export type SetScreenOrientationOverride = {+ method: 'emulation.setScreenOrientationOverride';+ params: Emulation.SetScreenOrientationOverrideParameters;+ };+}+export namespace Emulation {+ export const enum ScreenOrientationNatural {+ Portrait = 'portrait',+ Landscape = 'landscape',+ }+}+export namespace Emulation {+ export type ScreenOrientationType =+ | 'portrait-primary'+ | 'portrait-secondary'+ | 'landscape-primary'+ | 'landscape-secondary';+}+export namespace Emulation {+ export type ScreenOrientation = {+ natural: Emulation.ScreenOrientationNatural;+ type: Emulation.ScreenOrientationType;+ };+}+export namespace Emulation {+ export type SetScreenOrientationOverrideParameters = {+ screenOrientation: Emulation.ScreenOrientation | null;+ contexts?: [+ BrowsingContext.BrowsingContext,+ ...BrowsingContext.BrowsingContext[],+ ];+ userContexts?: [Browser.UserContext, ...Browser.UserContext[]];+ };+}+export namespace Emulation {+ export type SetTimezoneOverride = {+ method: 'emulation.setTimezoneOverride';+ params: Emulation.SetTimezoneOverrideParameters;+ };+}+export namespace Emulation {+ export type SetTimezoneOverrideParameters = {+ timezone: string | null;+ contexts?: [+ BrowsingContext.BrowsingContext,+ ...BrowsingContext.BrowsingContext[],+ ];+ userContexts?: [Browser.UserContext, ...Browser.UserContext[]];+ };+}export type NetworkCommand =+ | Network.AddDataCollector| Network.AddIntercept| Network.ContinueRequest| Network.ContinueResponse| Network.ContinueWithAuth+ | Network.DisownData| Network.FailRequest+ | Network.GetData| Network.ProvideResponse+ | Network.RemoveDataCollector| Network.RemoveIntercept- | Network.SetCacheBehavior;+ | Network.SetCacheBehavior+ | Network.SetExtraHeaders;export type NetworkEvent =| Network.AuthRequired| Network.BeforeRequestSent@@ -1062,11 +1198,20 @@ export namespace Network {value: string;};}+export namespace Network {+ export type Collector = string;+}+export namespace Network {+ export const enum CollectorType {+ Blob = 'blob',+ }+}export namespace Network {export const enum SameSite {Strict = 'strict',Lax = 'lax',None = 'none',+ Default = 'default',}}export namespace Network {@@ -1088,6 +1233,11 @@ export namespace Network {value: Network.BytesValue;};}+export namespace Network {+ export const enum DataType {+ Response = 'response',+ }+}export namespace Network {export type FetchTimingInfo = {timeOrigin: number;@@ -1193,6 +1343,32 @@ export namespace Network {pattern: string;};}+export namespace Network {+ export type AddDataCollector = {+ method: 'network.addDataCollector';+ params: Network.AddDataCollectorParameters;+ };+}+export namespace Network {+ export type AddDataCollectorParameters = {+ dataTypes: [Network.DataType, ...Network.DataType[]];+ maxEncodedDataSize: JsUint;+ /**+ * @defaultValue `"blob"`+ */+ collectorType?: Network.CollectorType;+ contexts?: [+ BrowsingContext.BrowsingContext,+ ...BrowsingContext.BrowsingContext[],+ ];+ userContexts?: [Browser.UserContext, ...Browser.UserContext[]];+ };+}+export namespace Network {+ export type AddDataCollectorResult = {+ collector: Network.Collector;+ };+}export namespace Network {export type AddInterceptParameters = {phases: [Network.InterceptPhase, ...Network.InterceptPhase[]];@@ -1278,6 +1454,19 @@ export namespace Network {action: 'default' | 'cancel';};}+export namespace Network {+ export type DisownData = {+ method: 'network.disownData';+ params: Network.DisownDataParameters;+ };+}+export namespace Network {+ export type DisownDataParameters = {+ dataType: Network.DataType;+ collector: Network.Collector;+ request: Network.Request;+ };+}export namespace Network {export type FailRequest = {method: 'network.failRequest';@@ -1289,6 +1478,28 @@ export namespace Network {request: Network.Request;};}+export namespace Network {+ export type GetData = {+ method: 'network.getData';+ params: Network.GetDataParameters;+ };+}+export namespace Network {+ export type GetDataParameters = {+ dataType: Network.DataType;+ collector?: Network.Collector;+ /**+ * @defaultValue `false`+ */+ disown?: boolean;+ request: Network.Request;+ };+}+export namespace Network {+ export type GetDataResult = {+ bytes: Network.BytesValue;+ };+}export namespace Network {export type ProvideResponse = {method: 'network.provideResponse';@@ -1305,6 +1516,17 @@ export namespace Network {statusCode?: JsUint;};}+export namespace Network {+ export type RemoveDataCollector = {+ method: 'network.removeDataCollector';+ params: Network.RemoveDataCollectorParameters;+ };+}+export namespace Network {+ export type RemoveDataCollectorParameters = {+ collector: Network.Collector;+ };+}export namespace Network {export type RemoveIntercept = {method: 'network.removeIntercept';@@ -1331,6 +1553,22 @@ export namespace Network {];};}+export namespace Network {+ export type SetExtraHeaders = {+ method: 'network.setExtraHeaders';+ params: Network.SetExtraHeadersParameters;+ };+}+export namespace Network {+ export type SetExtraHeadersParameters = {+ headers: [Network.Header, ...Network.Header[]];+ contexts?: [+ BrowsingContext.BrowsingContext,+ ...BrowsingContext.BrowsingContext[],+ ];+ userContexts?: [Browser.UserContext, ...Browser.UserContext[]];+ };+}export type ScriptEvent =| Script.Message| Script.RealmCreated