@checkly/playwright-core 1.41.2-beta.0

package/lib/server/artifact.js

@@ -0,0 +1,104 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Artifact = void 0;
+var _fs = _interopRequireDefault(require("fs"));
+var _utils = require("../utils");
+var _manualPromise = require("../utils/manualPromise");
+var _instrumentation = require("./instrumentation");
+var _errors = require("./errors");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * 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.
+ */
+
+class Artifact extends _instrumentation.SdkObject {
+  constructor(parent, localPath, unaccessibleErrorMessage, cancelCallback) {
+    super(parent, 'artifact');
+    this._localPath = void 0;
+    this._unaccessibleErrorMessage = void 0;
+    this._cancelCallback = void 0;
+    this._finishedPromise = new _manualPromise.ManualPromise();
+    this._saveCallbacks = [];
+    this._finished = false;
+    this._deleted = false;
+    this._failureError = void 0;
+    this._localPath = localPath;
+    this._unaccessibleErrorMessage = unaccessibleErrorMessage;
+    this._cancelCallback = cancelCallback;
+  }
+  finishedPromise() {
+    return this._finishedPromise;
+  }
+  localPath() {
+    return this._localPath;
+  }
+  async localPathAfterFinished() {
+    if (this._unaccessibleErrorMessage) throw new Error(this._unaccessibleErrorMessage);
+    await this._finishedPromise;
+    if (this._failureError) throw this._failureError;
+    return this._localPath;
+  }
+  saveAs(saveCallback) {
+    if (this._unaccessibleErrorMessage) throw new Error(this._unaccessibleErrorMessage);
+    if (this._deleted) throw new Error(`File already deleted. Save before deleting.`);
+    if (this._failureError) throw this._failureError;
+    if (this._finished) {
+      saveCallback(this._localPath).catch(() => {});
+      return;
+    }
+    this._saveCallbacks.push(saveCallback);
+  }
+  async failureError() {
+    var _this$_failureError;
+    if (this._unaccessibleErrorMessage) return this._unaccessibleErrorMessage;
+    await this._finishedPromise;
+    return ((_this$_failureError = this._failureError) === null || _this$_failureError === void 0 ? void 0 : _this$_failureError.message) || null;
+  }
+  async cancel() {
+    (0, _utils.assert)(this._cancelCallback !== undefined);
+    return this._cancelCallback();
+  }
+  async delete() {
+    if (this._unaccessibleErrorMessage) return;
+    const fileName = await this.localPathAfterFinished();
+    if (this._deleted) return;
+    this._deleted = true;
+    if (fileName) await _fs.default.promises.unlink(fileName).catch(e => {});
+  }
+  async deleteOnContextClose() {
+    // Compared to "delete", this method does not wait for the artifact to finish.
+    // We use it when closing the context to avoid stalling.
+    if (this._deleted) return;
+    this._deleted = true;
+    if (!this._unaccessibleErrorMessage) await _fs.default.promises.unlink(this._localPath).catch(e => {});
+    await this.reportFinished(new _errors.TargetClosedError());
+  }
+  async reportFinished(error) {
+    if (this._finished) return;
+    this._finished = true;
+    this._failureError = error;
+    if (error) {
+      for (const callback of this._saveCallbacks) await callback('', error);
+    } else {
+      for (const callback of this._saveCallbacks) await callback(this._localPath);
+    }
+    this._saveCallbacks = [];
+    this._finishedPromise.resolve();
+  }
+}
+exports.Artifact = Artifact;

package/lib/server/browser.js

@@ -0,0 +1,129 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Browser = void 0;
+var _browserContext = require("./browserContext");
+var _page = require("./page");
+var _download = require("./download");
+var _instrumentation = require("./instrumentation");
+var _artifact = require("./artifact");
+/**
+ * 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.
+ */
+
+class Browser extends _instrumentation.SdkObject {
+  constructor(parent, options) {
+    super(parent, 'browser');
+    this.options = void 0;
+    this._downloads = new Map();
+    this._defaultContext = null;
+    this._startedClosing = false;
+    this._idToVideo = new Map();
+    this._contextForReuse = void 0;
+    this._closeReason = void 0;
+    this._isCollocatedWithServer = true;
+    this.attribution.browser = this;
+    this.options = options;
+    this.instrumentation.onBrowserOpen(this);
+  }
+  async newContext(metadata, options) {
+    (0, _browserContext.validateBrowserContextOptions)(options, this.options);
+    const context = await this.doCreateNewContext(options);
+    if (options.storageState) await context.setStorageState(metadata, options.storageState);
+    return context;
+  }
+  async newContextForReuse(params, metadata) {
+    const hash = _browserContext.BrowserContext.reusableContextHash(params);
+    if (!this._contextForReuse || hash !== this._contextForReuse.hash || !this._contextForReuse.context.canResetForReuse()) {
+      if (this._contextForReuse) await this._contextForReuse.context.close({
+        reason: 'Context reused'
+      });
+      this._contextForReuse = {
+        context: await this.newContext(metadata, params),
+        hash
+      };
+      return {
+        context: this._contextForReuse.context,
+        needsReset: false
+      };
+    }
+    await this._contextForReuse.context.stopPendingOperations('Context recreated');
+    return {
+      context: this._contextForReuse.context,
+      needsReset: true
+    };
+  }
+  async stopPendingOperations(reason) {
+    var _this$_contextForReus;
+    await ((_this$_contextForReus = this._contextForReuse) === null || _this$_contextForReus === void 0 || (_this$_contextForReus = _this$_contextForReus.context) === null || _this$_contextForReus === void 0 ? void 0 : _this$_contextForReus.stopPendingOperations(reason));
+  }
+  _downloadCreated(page, uuid, url, suggestedFilename) {
+    const download = new _download.Download(page, this.options.downloadsPath || '', uuid, url, suggestedFilename);
+    this._downloads.set(uuid, download);
+  }
+  _downloadFilenameSuggested(uuid, suggestedFilename) {
+    const download = this._downloads.get(uuid);
+    if (!download) return;
+    download._filenameSuggested(suggestedFilename);
+  }
+  _downloadFinished(uuid, error) {
+    const download = this._downloads.get(uuid);
+    if (!download) return;
+    download.artifact.reportFinished(error ? new Error(error) : undefined);
+    this._downloads.delete(uuid);
+  }
+  _videoStarted(context, videoId, path, pageOrError) {
+    const artifact = new _artifact.Artifact(context, path);
+    this._idToVideo.set(videoId, {
+      context,
+      artifact
+    });
+    pageOrError.then(page => {
+      if (page instanceof _page.Page) {
+        page._video = artifact;
+        page.emitOnContext(_browserContext.BrowserContext.Events.VideoStarted, artifact);
+        page.emit(_page.Page.Events.Video, artifact);
+      }
+    });
+  }
+  _takeVideo(videoId) {
+    const video = this._idToVideo.get(videoId);
+    this._idToVideo.delete(videoId);
+    return video === null || video === void 0 ? void 0 : video.artifact;
+  }
+  _didClose() {
+    for (const context of this.contexts()) context._browserClosed();
+    if (this._defaultContext) this._defaultContext._browserClosed();
+    this.emit(Browser.Events.Disconnected);
+    this.instrumentation.onBrowserClose(this);
+  }
+  async close(options) {
+    if (!this._startedClosing) {
+      if (options.reason) this._closeReason = options.reason;
+      this._startedClosing = true;
+      await this.options.browserProcess.close();
+    }
+    if (this.isConnected()) await new Promise(x => this.once(Browser.Events.Disconnected, x));
+  }
+  async killForTests() {
+    await this.options.browserProcess.kill();
+  }
+}
+exports.Browser = Browser;
+Browser.Events = {
+  Disconnected: 'disconnected'
+};