📦 microsoft / playwright

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184/**
 * 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.
 */

import crypto from 'crypto';
import fs from 'fs';
import path from 'path';
import * as util from 'util';
import { Readable, Writable, pipeline } from 'stream';
import { EventEmitter } from 'events';

import { colors } from '../../utilsBundle';
import { debugLogger } from './debugLogger';
import { currentZone, emptyZone } from './zones';
import { debugMode, isUnderTest } from './debug';
import { zodToJsonSchema as zodToJsonSchemaV3, z } from '../../mcpBundle';
import type zod3 from 'zod/v3';
import type zod4 from 'zod';

import type { Platform, Zone } from '../../client/platform';
import type { Zone as ZoneImpl } from './zones';
import type * as channels from '@protocol/channels';

const pipelineAsync = util.promisify(pipeline);

class NodeZone implements Zone {
  private _zone: ZoneImpl;

  constructor(zone: ZoneImpl) {
    this._zone = zone;
  }

  push<T>(data: T) {
    return new NodeZone(this._zone.with('apiZone', data));
  }

  pop() {
    return new NodeZone(this._zone.without('apiZone'));
  }

  run<R>(func: () => R): R {
    return this._zone.run(func);
  }

  data<T>(): T | undefined {
    return this._zone.data('apiZone');
  }
}

let boxedStackPrefixes: string[] = [];
export function setBoxedStackPrefixes(prefixes: string[]) {
  boxedStackPrefixes = prefixes;
}

const coreDir = path.dirname(require.resolve('../../../package.json'));

export const nodePlatform: Platform = {
  name: 'node',

  boxedStackPrefixes: () => {
    if (process.env.PWDEBUGIMPL)
      return [];
    return [coreDir, ...boxedStackPrefixes];
  },

  calculateSha1: (text: string) => {
    const sha1 = crypto.createHash('sha1');
    sha1.update(text);
    return Promise.resolve(sha1.digest('hex'));
  },

  colors,

  coreDir,

  createGuid: () => crypto.randomBytes(16).toString('hex'),

  defaultMaxListeners: () => EventEmitter.defaultMaxListeners,
  fs: () => fs,

  env: process.env,

  inspectCustom: util.inspect.custom,

  isDebugMode: () => debugMode() === 'inspector',

  isJSDebuggerAttached: () => !!require('inspector').url(),

  isLogEnabled(name: 'api' | 'channel') {
    return debugLogger.isEnabled(name);
  },

  isUnderTest: () => isUnderTest(),

  log(name: 'api' | 'channel', message: string | Error | object) {
    debugLogger.log(name, message);
  },

  path: () => path,

  pathSeparator: path.sep,

  showInternalStackFrames: () => !!process.env.PWDEBUGIMPL,

  async streamFile(path: string, stream: Writable): Promise<void> {
    await pipelineAsync(fs.createReadStream(path), stream);
  },

  streamReadable: (channel: channels.StreamChannel) => {
    return new ReadableStreamImpl(channel);
  },

  streamWritable: (channel: channels.WritableStreamChannel) => {
    return new WritableStreamImpl(channel);
  },

  zodToJsonSchema: (schema: zod3.Schema | zod4.Schema): any => {
    // https://zod.dev/library-authors?id=how-to-support-zod-3-and-zod-4-simultaneously
    if ('_zod' in schema)
      return z.toJSONSchema(schema);
    return zodToJsonSchemaV3(schema);
  },

  zones: {
    current: () => new NodeZone(currentZone()),
    empty: new NodeZone(emptyZone),
  }
};

class ReadableStreamImpl extends Readable {
  private _channel: channels.StreamChannel;

  constructor(channel: channels.StreamChannel) {
    super();
    this._channel = channel;
  }

  override async _read() {
    const result = await this._channel.read({ size: 1024 * 1024 });
    if (result.binary.byteLength)
      this.push(result.binary);
    else
      this.push(null);
  }

  override _destroy(error: Error | null, callback: (error: Error | null | undefined) => void): void {
    // Stream might be destroyed after the connection was closed.
    this._channel.close().catch(e => null);
    super._destroy(error, callback);
  }
}

class WritableStreamImpl extends Writable {
  private _channel: channels.WritableStreamChannel;

  constructor(channel: channels.WritableStreamChannel) {
    super();
    this._channel = channel;
  }

  override async _write(chunk: Buffer | string, encoding: BufferEncoding, callback: (error?: Error | null) => void) {
    const error = await this._channel.write({ binary: typeof chunk === 'string' ? Buffer.from(chunk) : chunk }).catch(e => e);
    callback(error || null);
  }

  override async _final(callback: (error?: Error | null) => void) {
    // Stream might be destroyed after the connection was closed.
    const error = await this._channel.close().catch(e => e);
    callback(error || null);
  }
}