playwright/src/dispatchers/streamDispatcher.ts

/**
 * 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 * as channels from '../protocol/channels';
import { Dispatcher, DispatcherScope } from './dispatcher';
import * as stream from 'stream';
import { SdkObject } from '../server/sdkObject';

export class StreamWrapper extends SdkObject {
  readonly stream: stream.Readable;
  constructor(parentObject: SdkObject, stream: stream.Readable) {
    super(parentObject);
    this.stream = stream;
  }
}

export class StreamDispatcher extends Dispatcher<StreamWrapper, channels.StreamInitializer> implements channels.StreamChannel {
  constructor(scope: DispatcherScope, stream: StreamWrapper) {
    super(scope, stream, 'Stream', {});
  }

  async read(params: channels.StreamReadParams): Promise<channels.StreamReadResult> {
    const buffer = this._object.stream.read(Math.min(this._object.stream.readableLength, params.size || this._object.stream.readableLength));
    return { binary: buffer ? buffer.toString('base64') : '' };
  }

  async close() {
    this._object.stream.destroy();
  }
}