ds

Author: devversion

.circleci/config.yml

@@ -338,6 +338,7 @@ jobs:
         name: Running tests
         command: |
           TESTS=$(yarn -s bazel query --output label 'attr("tags", "saucelabs", //src/...)')
+          yarn -s bazel build ${TESTS}
           yarn -s bazel test ${TESTS} --jobs=2
 
     - run:

tools/saucelabs-bazel/BUILD.bazel

@@ -6,6 +6,7 @@ ts_library(
     name = "saucelabs-bazel",
     srcs = [
         "browser.ts",
+        "ipc-defaults.ts",
         "ipc-messages.ts",
     ],
     deps = [],

tools/saucelabs-bazel/background-service/ipc.ts

@@ -1,4 +1,5 @@
 import {createServer, Server, Socket} from 'net';
+import { IPC_PORT } from '../ipc-defaults';
 import {BackgroundServiceReceiveMessages, NoAvailableBrowserMessage} from '../ipc-messages';
 import {SaucelabsDaemon} from './saucelabs-daemon';
 
@@ -8,9 +9,9 @@ export class IpcServer {
   private readonly _server: Server;
   private _connections = new Map<number, Socket>();
 
-  constructor(private _service: SaucelabsDaemon, port = 5324) {
+  constructor(private _service: SaucelabsDaemon) {
     this._server = createServer(this._connectionHandler.bind(this));
-    this._server.listen(port, () => console.info('Daemon IPC server listening.'));
+    this._server.listen(IPC_PORT, () => console.info('Daemon IPC server listening.'));
   }
 
   private _connectionHandler(socket: Socket) {

tools/saucelabs-bazel/background-service/saucelabs-daemon.ts

@@ -27,17 +27,32 @@ interface BrowserTest {
 }
 
 export class SaucelabsDaemon {
+  /**
+   * Map of browsers and their pending tests. If a browser is acquired on the
+   * remote selenium server, the browser is not immediately ready. If the browser
+   * becomes active, the pending tests will be started.
+   */
   private _pendingTests = new Map<RemoteBrowser, BrowserTest>();
-  _browsers = new Set<RemoteBrowser>();
+
+  /** List of active browsers that are managed by the daemon. */
+  private _activeBrowsers = new Set<RemoteBrowser>();
+
+  /** Map that contains test ids with their acquired browser. */
   private _runningTests = new Map<number, RemoteBrowser>();
+
+  /** Server used for communication with the Karma launcher. */
   private _server = new IpcServer(this);
+
+  /** Base selenium capabilities that will be added to each browser. */
   private _baseCapabilities = {...defaultCapabilities, ...this._userCapabilities};
+
+  /** Id of the keep alive interval that ensures no remote browsers time out. */
   private _keepAliveIntervalId: NodeJS.Timeout|null = null;
 
   constructor(
       private _username: string, private _accessKey: string,
       private _userCapabilities: object = {}) {
-    // Starts the heartbeat for browsers.
+    // Starts the keep alive loop for all active browsers.
     this._keepAliveLoop();
   }
 
@@ -51,7 +66,7 @@ export class SaucelabsDaemon {
 
       // Keep track of the launched browser. We do this before it even completed the
       // launch as we can then handle scheduled tests when the browser is still launching.
-      this._browsers.add(launched);
+      this._activeBrowsers.add(launched);
 
       // See the following link for public API of the selenium server.
       // https://wiki.saucelabs.com/display/DOCS/Instant+Selenium+Node.js+Tests
@@ -80,12 +95,12 @@ export class SaucelabsDaemon {
   }
 
   async quitAllBrowsers() {
-    this._browsers.forEach(b => {
+    this._activeBrowsers.forEach(b => {
       if (b.driver !== null) {
         b.driver.quit();
       }
     });
-    this._browsers.clear();
+    this._activeBrowsers.clear();
     this._runningTests.clear();
     this._pendingTests.clear();
   }
@@ -140,7 +155,7 @@ export class SaucelabsDaemon {
 
   private _findMatchingBrowsers(browserId: string): RemoteBrowser[] {
     const browsers: RemoteBrowser[] = [];
-    for (let browser of this._browsers) {
+    for (let browser of this._activeBrowsers) {
       if (browser.id === browserId) {
         browsers.push(browser);
       }
@@ -153,7 +168,7 @@ export class SaucelabsDaemon {
   // https://saucelabs.com/blog/selenium-tips-how-to-coordinate-multiple-browsers-in-sauce-ondemand.
   private _keepAliveLoop = async () => {
     const pendingCommands: promise.Promise<any>[] = [];
-    for (const browser of this._browsers) {
+    for (const browser of this._activeBrowsers) {
       if (browser.driver !== null) {
         pendingCommands.push(browser.driver.getTitle());
       }

tools/saucelabs-bazel/browser.ts

@@ -1,3 +1,4 @@
+/** Definition of a test browser. */
 export interface Browser {
   browserName: string;
   browserVersion?: string;
@@ -6,8 +7,13 @@ export interface Browser {
   deviceName?: string;
 }
 
+/**
+ * Gets a unique id for the specified browser. This id can be shared
+ * across the background service and launcher using IPC.
+ */
 export function getUniqueId(browser: Browser): string {
   let result = '';
-  Object.keys(browser).sort().forEach((k) => result += `${k}=${browser[k as keyof Browser]}`);
+  Object.keys(browser).sort()
+    .forEach((key) => result += `${key}=${browser[key as keyof Browser]}`);
   return result;
 }

tools/saucelabs-bazel/ipc-messages.ts

@@ -1,15 +1,21 @@
+/** Message that can be sent to the daemon to start a given test. */
 export class StartTestMessage {
   readonly type = 'start-test';
   constructor(public url: string, public browserId: string) {}
 }
 
+/** Message that can be sent to the daemon if a test completed. */
 export class EndTestMessage {
   readonly type = 'end-test';
 }
 
+/** Message being sent from the daemon if a request browser is not available. */
 export class NoAvailableBrowserMessage {
   readonly type = 'browser-not-ready';
 }
 
+/** Type of messages the background service can receive. */
 export type BackgroundServiceReceiveMessages = StartTestMessage|EndTestMessage;
+
+/** Type of messages the background services can send to clients. */
 export type BackgroundServiceSendMessages = NoAvailableBrowserMessage;

tools/saucelabs-bazel/launcher/launcher.ts

@@ -1,5 +1,6 @@
 import {createConnection, Socket} from 'net';
 import {Browser, getUniqueId} from '../browser';
+import { IPC_PORT } from '../ipc-defaults';
 import {BackgroundServiceSendMessages, EndTestMessage, StartTestMessage} from '../ipc-messages';
 
 export function SaucelabsLauncher(this: any,
@@ -26,7 +27,7 @@ export function SaucelabsLauncher(this: any,
   this.name = browserDisplayName + ' on SauceLabs (daemon)';
 
   this.on('start', (pageUrl: string) => {
-    daemonConnection = createConnection({port: 5324},
+    daemonConnection = createConnection({port: IPC_PORT},
         () => _startBrowserTest(pageUrl, args));
 
     daemonConnection.on('data', b => _processMessage(