9d9599c6a6
These methods are safe to call while the page is still open, or when it is already closed. Works in remotely connected browser as well. Also makes video.path() to throw for remotely connected browser. Under the hood migrated Download and Video to use the common Artifact object.
99 lines
3.3 KiB
TypeScript
99 lines
3.3 KiB
TypeScript
/**
|
|
* 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 { StreamDispatcher } from './streamDispatcher';
|
|
import fs from 'fs';
|
|
import * as util from 'util';
|
|
import { mkdirIfNeeded } from '../utils/utils';
|
|
import { Artifact } from '../server/artifact';
|
|
|
|
export class ArtifactDispatcher extends Dispatcher<Artifact, channels.ArtifactInitializer> implements channels.ArtifactChannel {
|
|
constructor(scope: DispatcherScope, artifact: Artifact) {
|
|
super(scope, artifact, 'Artifact', {
|
|
absolutePath: artifact.localPath(),
|
|
});
|
|
}
|
|
|
|
async pathAfterFinished(): Promise<channels.ArtifactPathAfterFinishedResult> {
|
|
const path = await this._object.localPathAfterFinished();
|
|
return { value: path || undefined };
|
|
}
|
|
|
|
async saveAs(params: channels.ArtifactSaveAsParams): Promise<channels.ArtifactSaveAsResult> {
|
|
return await new Promise((resolve, reject) => {
|
|
this._object.saveAs(async (localPath, error) => {
|
|
if (error !== undefined) {
|
|
reject(new Error(error));
|
|
return;
|
|
}
|
|
try {
|
|
await mkdirIfNeeded(params.path);
|
|
await util.promisify(fs.copyFile)(localPath, params.path);
|
|
resolve();
|
|
} catch (e) {
|
|
reject(e);
|
|
}
|
|
});
|
|
});
|
|
}
|
|
|
|
async saveAsStream(): Promise<channels.ArtifactSaveAsStreamResult> {
|
|
return await new Promise((resolve, reject) => {
|
|
this._object.saveAs(async (localPath, error) => {
|
|
if (error !== undefined) {
|
|
reject(new Error(error));
|
|
return;
|
|
}
|
|
try {
|
|
const readable = fs.createReadStream(localPath);
|
|
await new Promise(f => readable.on('readable', f));
|
|
const stream = new StreamDispatcher(this._scope, readable);
|
|
// Resolve with a stream, so that client starts saving the data.
|
|
resolve({ stream });
|
|
// Block the Artifact until the stream is consumed.
|
|
await new Promise<void>(resolve => {
|
|
readable.on('close', resolve);
|
|
readable.on('end', resolve);
|
|
readable.on('error', resolve);
|
|
});
|
|
} catch (e) {
|
|
reject(e);
|
|
}
|
|
});
|
|
});
|
|
}
|
|
|
|
async stream(): Promise<channels.ArtifactStreamResult> {
|
|
const fileName = await this._object.localPathAfterFinished();
|
|
if (!fileName)
|
|
return {};
|
|
const readable = fs.createReadStream(fileName);
|
|
await new Promise(f => readable.on('readable', f));
|
|
return { stream: new StreamDispatcher(this._scope, readable) };
|
|
}
|
|
|
|
async failure(): Promise<channels.ArtifactFailureResult> {
|
|
const error = await this._object.failureError();
|
|
return { error: error || undefined };
|
|
}
|
|
|
|
async delete(): Promise<void> {
|
|
await this._object.delete();
|
|
}
|
|
}
|