chore: move debug, env and user agent from utils/ (#34766)

Author: pavelfeldman

packages/playwright-core/src/DEPS.list

@@ -8,10 +8,13 @@
 **
 
 [inprocess.ts]
+common/
 utils/
+server/utils
 
 [outofprocess.ts]
 client/
+common/
 protocol/
 utils/
 utils/isomorphic

packages/playwright-core/src/client/android.ts

@@ -21,7 +21,7 @@ import { ChannelOwner } from './channelOwner';
 import { TargetClosedError, isTargetClosedError } from './errors';
 import { Events } from './events';
 import { Waiter } from './waiter';
-import { TimeoutSettings } from '../common/timeoutSettings';
+import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
 import { isRegExp, isString } from '../utils/isomorphic/rtti';
 import { monotonicTime } from '../utils/isomorphic/time';
 import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
@@ -30,7 +30,7 @@ import type { Page } from './page';
 import type * as types from './types';
 import type * as api from '../../types/types';
 import type { AndroidServerLauncherImpl } from '../androidServerImpl';
-import type { Platform } from '../utils/platform';
+import type { Platform } from '../common/platform';
 import type * as channels from '@protocol/channels';
 
 type Direction = 'down' | 'up' | 'left' | 'right';

packages/playwright-core/src/client/artifact.ts

@@ -16,7 +16,7 @@
 
 import { ChannelOwner } from './channelOwner';
 import { Stream } from './stream';
-import { mkdirIfNeeded } from '../utils/fileUtils';
+import { mkdirIfNeeded } from '../common/fileUtils';
 
 import type * as channels from '@protocol/channels';
 import type { Readable } from 'stream';

packages/playwright-core/src/client/browser.ts

@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
 import { ChannelOwner } from './channelOwner';
 import { isTargetClosedError } from './errors';
 import { Events } from './events';
-import { mkdirIfNeeded } from '../utils/fileUtils';
+import { mkdirIfNeeded } from '../common/fileUtils';
 
 import type { BrowserType } from './browserType';
 import type { Page } from './page';

packages/playwright-core/src/client/browserContext.ts

@@ -34,8 +34,8 @@ import { Tracing } from './tracing';
 import { Waiter } from './waiter';
 import { WebError } from './webError';
 import { Worker } from './worker';
-import { TimeoutSettings } from '../common/timeoutSettings';
-import { mkdirIfNeeded } from '../utils/fileUtils';
+import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
+import { mkdirIfNeeded } from '../common/fileUtils';
 import { headersObjectToArray } from '../utils/isomorphic/headers';
 import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
 import { isRegExp, isString } from '../utils/isomorphic/rtti';
@@ -46,7 +46,7 @@ import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitF
 import type * as structs from '../../types/structs';
 import type * as api from '../../types/types';
 import type { URLMatch } from '../utils/isomorphic/urlMatch';
-import type { Platform } from '../utils/platform';
+import type { Platform } from '../common/platform';
 import type * as channels from '@protocol/channels';
 
 export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {

packages/playwright-core/src/client/browserType.ts

@@ -21,7 +21,7 @@ import { BrowserContext, prepareBrowserContextParams } from './browserContext';
 import { ChannelOwner } from './channelOwner';
 import { envObjectToArray } from './clientHelper';
 import { Events } from './events';
-import { assert } from '../utils/debug';
+import { assert } from '../utils/isomorphic/debug';
 import { headersObjectToArray } from '../utils/isomorphic/headers';
 import { monotonicTime } from '../utils/isomorphic/time';
 import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';

packages/playwright-core/src/client/channelOwner.ts

@@ -16,16 +16,15 @@
 
 import { EventEmitter } from './eventEmitter';
 import { ValidationError, maybeFindValidator  } from '../protocol/validator';
-import { isUnderTest } from '../utils/debug';
-import { debugLogger } from '../utils/debugLogger';
+import { isUnderTest } from '../utils/isomorphic/debug';
 import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/isomorphic/stackTrace';
 import { zones } from '../utils/zones';
 
 import type { ClientInstrumentation } from './clientInstrumentation';
 import type { Connection } from './connection';
 import type { Logger } from './types';
 import type { ValidatorContext } from '../protocol/validator';
-import type { Platform } from '../utils/platform';
+import type { Platform } from '../common/platform';
 import type * as channels from '@protocol/channels';
 
 type Listener = (...args: any[]) => void;
@@ -158,7 +157,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
                   apiZone.params = params;
                   apiZone.reported = true;
                   this._instrumentation.onApiCallBegin(apiZone);
-                  logApiCall(this._logger, `=> ${apiZone.apiName} started`);
+                  logApiCall(this._platform, this._logger, `=> ${apiZone.apiName} started`);
                   return await this._connection.sendMessageToServer(this, prop, validatedParams, apiZone.apiName, apiZone.frames, apiZone.stepId);
                 }
                 // Since this api call is either internal, or has already been reported/traced once,
@@ -189,7 +188,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
     try {
       const result = await zones.run('apiZone', apiZone, async () => await func(apiZone));
       if (!isInternal) {
-        logApiCall(logger, `<= ${apiZone.apiName} succeeded`);
+        logApiCall(this._platform, logger, `<= ${apiZone.apiName} succeeded`);
         this._instrumentation.onApiCallEnd(apiZone);
       }
       return result;
@@ -204,7 +203,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
         e.stack = '';
       if (!isInternal) {
         apiZone.error = e;
-        logApiCall(logger, `<= ${apiZone.apiName} failed`);
+        logApiCall(this._platform, logger, `<= ${apiZone.apiName} failed`);
         this._instrumentation.onApiCallEnd(apiZone);
       }
       throw e;
@@ -227,10 +226,10 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
   }
 }
 
-function logApiCall(logger: Logger | undefined, message: string) {
+function logApiCall(platform: Platform, logger: Logger | undefined, message: string) {
   if (logger && logger.isEnabled('api', 'info'))
     logger.log('api', 'info', message, [], { color: 'cyan' });
-  debugLogger.log('api', message);
+  platform.log('api', message);
 }
 
 function tChannelImplToWire(names: '*' | string[], arg: any, path: string, context: ValidatorContext) {

packages/playwright-core/src/client/clientHelper.ts

@@ -18,7 +18,7 @@
 import { isString } from '../utils/isomorphic/rtti';
 
 import type * as types from './types';
-import type { Platform } from '../utils/platform';
+import type { Platform } from '../common/platform';
 
 export function envObjectToArray(env: types.Env): { name: string, value: string }[] {
   const result: { name: string, value: string }[] = [];

packages/playwright-core/src/client/connection.ts

@@ -42,14 +42,13 @@ import { Tracing } from './tracing';
 import { Worker } from './worker';
 import { WritableStream } from './writableStream';
 import { ValidationError, findValidator  } from '../protocol/validator';
-import { debugLogger } from '../utils/debugLogger';
 import { formatCallLog, rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
 import { zones } from '../utils/zones';
 
 import type { ClientInstrumentation } from './clientInstrumentation';
 import type { HeadersArray } from './types';
 import type { ValidatorContext } from '../protocol/validator';
-import type { Platform } from '../utils/platform';
+import type { Platform } from '../common/platform';
 import type * as channels from '@protocol/channels';
 
 class Root extends ChannelOwner<channels.RootChannel> {
@@ -139,9 +138,9 @@ export class Connection extends EventEmitter {
     const type = object._type;
     const id = ++this._lastId;
     const message = { id, guid, method, params };
-    if (debugLogger.isEnabled('channel')) {
+    if (this.platform.isLogEnabled('channel')) {
       // Do not include metadata in debug logs to avoid noise.
-      debugLogger.log('channel', 'SEND> ' + JSON.stringify(message));
+      this.platform.log('channel', 'SEND> ' + JSON.stringify(message));
     }
     const location = frames[0] ? { file: frames[0].file, line: frames[0].line, column: frames[0].column } : undefined;
     const metadata: channels.Metadata = { apiName, location, internal: !apiName, stepId };
@@ -159,8 +158,8 @@ export class Connection extends EventEmitter {
 
     const { id, guid, method, params, result, error, log } = message as any;
     if (id) {
-      if (debugLogger.isEnabled('channel'))
-        debugLogger.log('channel', '<RECV ' + JSON.stringify(message));
+      if (this.platform.isLogEnabled('channel'))
+        this.platform.log('channel', '<RECV ' + JSON.stringify(message));
       const callback = this._callbacks.get(id);
       if (!callback)
         throw new Error(`Cannot find command to respond: ${id}`);
@@ -176,8 +175,8 @@ export class Connection extends EventEmitter {
       return;
     }
 
-    if (debugLogger.isEnabled('channel'))
-      debugLogger.log('channel', '<EVENT ' + JSON.stringify(message));
+    if (this.platform.isLogEnabled('channel'))
+      this.platform.log('channel', '<EVENT ' + JSON.stringify(message));
     if (method === '__create__') {
       this._createRemoteObject(guid, params.type, params.guid, params.initializer);
       return;

packages/playwright-core/src/client/consoleMessage.ts

@@ -18,7 +18,7 @@ import { JSHandle } from './jsHandle';
 import { Page } from './page';
 
 import type * as api from '../../types/types';
-import type { Platform } from '../utils/platform';
+import type { Platform } from '../common/platform';
 import type * as channels from '@protocol/channels';
 
 type ConsoleMessageLocation = channels.BrowserContextConsoleEvent['location'];