playwright/src/client/video.ts
Dmitry Gozman 9d9599c6a6
api(video): implement video.saveAs and video.delete (#6005)
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.
2021-03-31 10:38:05 -07:00

62 lines
2 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 { Page } from './page';
import * as api from '../../types/types';
import { Artifact } from './artifact';
export class Video implements api.Video {
private _artifact: Promise<Artifact | null> | null = null;
private _artifactCallback = (artifact: Artifact) => {};
private _isRemote = false;
constructor(page: Page) {
const browser = page.context()._browser;
this._isRemote = !!browser && browser._isRemote;
this._artifact = Promise.race([
new Promise<Artifact>(f => this._artifactCallback = f),
page._closedOrCrashedPromise.then(() => null),
]);
}
_artifactReady(artifact: Artifact) {
artifact._isRemote = this._isRemote;
this._artifactCallback(artifact);
}
async path(): Promise<string> {
if (this._isRemote)
throw new Error(`Path is not available when using browserType.connect(). Use saveAs() to save a local copy.`);
const artifact = await this._artifact;
if (!artifact)
throw new Error('Page did not produce any video frames');
return artifact._initializer.absolutePath;
}
async saveAs(path: string): Promise<void> {
const artifact = await this._artifact;
if (!artifact)
throw new Error('Page did not produce any video frames');
return artifact.saveAs(path);
}
async delete(): Promise<void> {
const artifact = await this._artifact;
if (artifact)
await artifact.delete();
}
}