Skip to content

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

chore(protocol): move protocol runtime into packages/protocol (#41612)

Dmitry Gozmanbc92bfe18820
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 8a852e3f0e..3d04768e11 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -460,7 +460,7 @@ export default [
{
files: [
"packages/playwright-core/src/client/**/*.ts",
- "packages/playwright-core/src/protocol/**/*.ts",
+ "packages/protocol/src/**/*.ts",
],
languageOptions: languageOptionsWithTsConfig,
rules: {
diff --git a/packages/playwright-core/src/DEPS.list b/packages/playwright-core/src/DEPS.list
index a780ae6ddf..264d291549 100644
--- a/packages/playwright-core/src/DEPS.list
+++ b/packages/playwright-core/src/DEPS.list
@@ -3,7 +3,7 @@ remote/
server/
@utils/**
@isomorphic/**
-protocol/validatorPrimitives.ts
+@protocol/**
[androidServerImpl.ts]
remote/
diff --git a/packages/playwright-core/src/browserServerImpl.ts b/packages/playwright-core/src/browserServerImpl.ts
index 7144ac3f25..6efd617b45 100644
--- a/packages/playwright-core/src/browserServerImpl.ts
+++ b/packages/playwright-core/src/browserServerImpl.ts
@@ -20,10 +20,10 @@ import { createGuid } from '@utils/crypto';
import { isUnderTest } from '@utils/debug';
import { rewriteErrorMessage } from '@utils/stackTrace';
import { DEFAULT_PLAYWRIGHT_LAUNCH_TIMEOUT } from '@isomorphic/time';
+import * as validatorPrimitives from '@protocol/validatorPrimitives';
import { PlaywrightServer } from './remote/playwrightServer';
import { helper } from './server/helper';
import { createPlaywright } from './server/playwright';
-import * as validatorPrimitives from './protocol/validatorPrimitives';
import { ProgressController } from './server/progress';
import type { BrowserServer, BrowserServerLauncher } from './client/browserType';
diff --git a/packages/playwright-core/src/client/DEPS.list b/packages/playwright-core/src/client/DEPS.list
index 6fd9f02f26..368fa1a847 100644
--- a/packages/playwright-core/src/client/DEPS.list
+++ b/packages/playwright-core/src/client/DEPS.list
@@ -1,6 +1,6 @@
[*]
-../protocol/
@isomorphic/**
+@protocol/**
@utils/crypto.ts
@utils/debug.ts
@utils/debugLogger.ts
diff --git a/packages/playwright-core/src/client/channelOwner.ts b/packages/playwright-core/src/client/channelOwner.ts
index 66571bd35b..18d1e7ddc7 100644
--- a/packages/playwright-core/src/client/channelOwner.ts
+++ b/packages/playwright-core/src/client/channelOwner.ts
@@ -19,14 +19,14 @@ import { showInternalStackFrames, stringifyStackFrames } from '@utils/stackTrace
import { isUnderTest } from '@utils/debug';
import { debugLogger } from '@utils/debugLogger';
import { currentZone } from '@utils/zones';
+import { ValidationError, maybeFindValidator } from '@protocol/validator';
import { EventEmitter } from './eventEmitter';
-import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { captureLibraryStackTrace } from './clientStackTrace';
import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
-import type { ValidatorContext } from '../protocol/validator';
+import type { ValidatorContext } from '@protocol/validator';
import type * as channels from './channels';
type Listener = (...args: any[]) => void;
diff --git a/packages/playwright-core/src/client/connection.ts b/packages/playwright-core/src/client/connection.ts
index 2e3c1a33a0..db9de249a0 100644
--- a/packages/playwright-core/src/client/connection.ts
+++ b/packages/playwright-core/src/client/connection.ts
@@ -19,6 +19,7 @@ import { rewriteErrorMessage } from '@utils/stackTrace';
import { isUnderTest } from '@utils/debug';
import { debugLogger } from '@utils/debugLogger';
import { emptyZone } from '@utils/zones';
+import { ValidationError, findValidator, maybeFindValidator } from '@protocol/validator';
import { EventEmitter } from './eventEmitter';
import { Android, AndroidDevice, AndroidSocket } from './android';
import { Artifact } from './artifact';
@@ -46,10 +47,9 @@ import { Stream } from './stream';
import { Tracing } from './tracing';
import { Worker } from './worker';
import { WritableStream } from './writableStream';
-import { ValidationError, findValidator, maybeFindValidator } from '../protocol/validator';
import type { ClientInstrumentation } from './clientInstrumentation';
import type { HeadersArray } from './types';
-import type { ValidatorContext } from '../protocol/validator';
+import type { ValidatorContext } from '@protocol/validator';
import type * as channels from './channels';
class Root extends ChannelOwner<channels.RootChannel> {
diff --git a/packages/playwright-core/src/client/errors.ts b/packages/playwright-core/src/client/errors.ts
index 0ef84ee489..7e37702514 100644
--- a/packages/playwright-core/src/client/errors.ts
+++ b/packages/playwright-core/src/client/errors.ts
@@ -15,7 +15,7 @@
*/
import { isError } from '@isomorphic/rtti';
-import { parseSerializedValue, serializeValue } from '../protocol/serializers';
+import { parseSerializedValue, serializeValue } from '@protocol/serializers';
import type { SerializedError } from './channels';
diff --git a/packages/playwright-core/src/client/jsHandle.ts b/packages/playwright-core/src/client/jsHandle.ts
index e0bed9425a..2df73dd2d9 100644
--- a/packages/playwright-core/src/client/jsHandle.ts
+++ b/packages/playwright-core/src/client/jsHandle.ts
@@ -14,9 +14,9 @@
* limitations under the License.
*/
+import { parseSerializedValue, serializeValue } from '@protocol/serializers';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
-import { parseSerializedValue, serializeValue } from '../protocol/serializers';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
diff --git a/packages/playwright-core/src/protocol/DEPS.list b/packages/playwright-core/src/protocol/DEPS.list
deleted file mode 100644
index e43dcb5d9f..0000000000
--- a/packages/playwright-core/src/protocol/DEPS.list
+++ /dev/null
@@ -1 +0,0 @@
-[*]
diff --git a/packages/playwright-core/src/server/DEPS.list b/packages/playwright-core/src/server/DEPS.list
index d074147741..b212c0c3f3 100644
--- a/packages/playwright-core/src/server/DEPS.list
+++ b/packages/playwright-core/src/server/DEPS.list
@@ -1,9 +1,9 @@
[*]
@isomorphic/**
+@protocol/**
@utils/**
../generated/
../package.ts
-../protocol/
./
./har/
./recorder/
diff --git a/packages/playwright-core/src/server/dispatchers/DEPS.list b/packages/playwright-core/src/server/dispatchers/DEPS.list
index 1015a3e35a..28d0edf394 100644
--- a/packages/playwright-core/src/server/dispatchers/DEPS.list
+++ b/packages/playwright-core/src/server/dispatchers/DEPS.list
@@ -1,7 +1,7 @@
[*]
../../generated/
-../../protocol/
@utils/**
@isomorphic/**
+@protocol/**
../**
node_modules/yaml
diff --git a/packages/playwright-core/src/server/dispatchers/dispatcher.ts b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
index ba14ed9c14..6a0c8a8728 100644
--- a/packages/playwright-core/src/server/dispatchers/dispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
@@ -22,7 +22,7 @@ import { isUnderTest } from '@utils/debug';
import { assert } from '@isomorphic/assert';
import { monotonicTime } from '@isomorphic/time';
import { rewriteErrorMessage } from '@utils/stackTrace';
-import { ValidationError, createMetadataValidator, createWaitInfoValidator, findValidator, maybeFindValidator } from '../../protocol/validator';
+import { ValidationError, createMetadataValidator, createWaitInfoValidator, findValidator, maybeFindValidator } from '@protocol/validator';
import { AbortError, TargetClosedError, isTargetClosedError, serializeError } from '../errors';
import { createRootSdkObject, SdkObject } from '../instrumentation';
import { isProtocolError } from '../protocolError';
@@ -32,7 +32,7 @@ import { Progress, ProgressController } from '../progress';
import type { CallMetadata } from '../instrumentation';
import type { PlaywrightDispatcher } from './playwrightDispatcher';
import type { RegisteredListener } from '@utils/eventsHelper';
-import type { ValidatorContext } from '../../protocol/validator';
+import type { ValidatorContext } from '@protocol/validator';
import type * as channels from '../channels';
const metadataValidator = createMetadataValidator();
diff --git a/packages/playwright-core/src/server/dispatchers/jsHandleDispatcher.ts b/packages/playwright-core/src/server/dispatchers/jsHandleDispatcher.ts
index c2da3199ba..d3ecc88c1b 100644
--- a/packages/playwright-core/src/server/dispatchers/jsHandleDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/jsHandleDispatcher.ts
@@ -14,9 +14,9 @@
* limitations under the License.
*/
+import { parseSerializedValue, serializeValue } from '@protocol/serializers';
import { Dispatcher } from './dispatcher';
import { ElementHandleDispatcher } from './elementHandlerDispatcher';
-import { parseSerializedValue, serializeValue } from '../../protocol/serializers';
import type * as js from '../javascript';
import type { ElectronApplicationDispatcher } from './electronDispatcher';
diff --git a/packages/playwright-core/src/server/errors.ts b/packages/playwright-core/src/server/errors.ts
index 03392de605..6d18b4ddcb 100644
--- a/packages/playwright-core/src/server/errors.ts
+++ b/packages/playwright-core/src/server/errors.ts
@@ -15,7 +15,7 @@
*/
import { isError } from '@isomorphic/rtti';
-import { parseSerializedValue, serializeValue } from '../protocol/serializers';
+import { parseSerializedValue, serializeValue } from '@protocol/serializers';
import type { SerializedError } from './channels';
diff --git a/packages/playwright-core/src/server/socksInterceptor.ts b/packages/playwright-core/src/server/socksInterceptor.ts
index 72200bab03..d964068c50 100644
--- a/packages/playwright-core/src/server/socksInterceptor.ts
+++ b/packages/playwright-core/src/server/socksInterceptor.ts
@@ -18,10 +18,10 @@ import EventEmitter from 'events';
import * as socks from '@utils/socksProxy';
import { isUnderTest } from '@utils/debug';
-import { ValidationError, findValidator } from '../protocol/validator';
+import { ValidationError, findValidator } from '@protocol/validator';
import type { WebSocketTransport } from './transport';
-import type { ValidatorContext } from '../protocol/validator';
+import type { ValidatorContext } from '@protocol/validator';
import type * as channels from '../client/channels'; // this file lives in server/, but since it runs via localUtils, client channels is still correct.
export class SocksInterceptor {
diff --git a/packages/playwright-core/src/protocol/serializers.ts b/packages/protocol/src/serializers.ts
similarity index 100%
rename from packages/playwright-core/src/protocol/serializers.ts
rename to packages/protocol/src/serializers.ts
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/protocol/src/validator.ts
similarity index 100%
rename from packages/playwright-core/src/protocol/validator.ts
rename to packages/protocol/src/validator.ts
diff --git a/packages/playwright-core/src/protocol/validatorPrimitives.ts b/packages/protocol/src/validatorPrimitives.ts
similarity index 100%
rename from packages/playwright-core/src/protocol/validatorPrimitives.ts
rename to packages/protocol/src/validatorPrimitives.ts
diff --git a/utils/build/build.js b/utils/build/build.js
index 2c0fbf6502..8790ade423 100644
--- a/utils/build/build.js
+++ b/utils/build/build.js
@@ -590,6 +590,8 @@ for (const pkg of workspace.packages()) {
filePath('packages/playwright-client/src'),
filePath('packages/playwright-core/src/client'),
filePath('packages/isomorphic'),
+ filePath('packages/utils'),
+ filePath('packages/protocol/src'),
]));
}
@@ -663,7 +665,7 @@ steps.push(new EsbuildStep({
setup: build => build.onResolve({ filter: /utilsBundle/ },
() => ({ path: './utilsBundle', external: true })),
}, dynamicImportToRequirePlugin],
-}, [playwrightCoreSrc]));
+}, [playwrightCoreSrc, filePath('packages/protocol/src')]));
function assertCoreBundleHasNoNodeModules() {
const bundlePath = filePath('packages/playwright-core/lib/coreBundle.js');
diff --git a/utils/check_deps.js b/utils/check_deps.js
index 01754c95eb..edc5b4b737 100644
--- a/utils/check_deps.js
+++ b/utils/check_deps.js
@@ -29,6 +29,7 @@ const packages = new Map();
packages.set('web', packagesDir + '/web/src/');
packages.set('injected', packagesDir + '/injected/src/');
packages.set('isomorphic', packagesDir + '/isomorphic/');
+packages.set('protocol', packagesDir + '/protocol/src/');
packages.set('utils', packagesDir + '/utils/');
packages.set('testIsomorphic', packagesDir + '/playwright/src/isomorphic/');
diff --git a/utils/generate_channels.js b/utils/generate_channels.js
index d18da74789..8b3d08e3ad 100755
--- a/utils/generate_channels.js
+++ b/utils/generate_channels.js
@@ -464,5 +464,5 @@ writeFile(path.join(__dirname, '..', 'packages', 'protocol', 'src', 'structs.d.t
writeFile(path.join(__dirname, '..', 'packages', 'playwright-core', 'src', 'client', 'channels.d.ts'), client_channels_ts.join('\n') + '\n');
writeFile(path.join(__dirname, '..', 'packages', 'playwright-core', 'src', 'server', 'channels.d.ts'), server_channels_ts.join('\n') + '\n');
writeFile(path.join(__dirname, '..', 'packages', 'isomorphic', 'protocolMetainfo.ts'), metainfoContent);
-writeFile(path.join(__dirname, '..', 'packages', 'playwright-core', 'src', 'protocol', 'validator.ts'), validatorContent);
+writeFile(path.join(__dirname, '..', 'packages', 'protocol', 'src', 'validator.ts'), validatorContent);
process.exit(hasChanges ? 1 : 0);