feat: allow mutiple specs per agent (#201)

salesforce · Aug 25, 2019 · de23d70 · de23d70
1 parent 3ee425a
commit de23d70
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 23 deletions.
diff --git a/packages/@best/agent-hub/src/Agent.ts b/packages/@best/agent-hub/src/Agent.ts
@@ -28,10 +28,7 @@ export interface AgentConfig {
         path: string
         proxy?: string
     },
-    spec: {
-        browser: string,
-        version: string,
-    }
+    specs: Spec[],
     remoteRunner: string,
     remoteRunnerConfig?: object
 }
@@ -107,8 +104,10 @@ export class Agent extends EventEmitter {
     }
 
     canRunJob(spec: Spec): boolean {
-        const jobHasSameSpec = spec.browser == this._config.spec.browser &&
-            spec.version === this._config.spec.version;
+        const specs = this._config.specs;
+        const jobHasSameSpec = specs.some(({ browser, version }) => {
+            browser === spec.browser && version === spec.version
+        });
 
         return jobHasSameSpec && this.status !== AgentStatus.Offline;
     }

diff --git a/packages/@best/agent-hub/src/agents-api.ts b/packages/@best/agent-hub/src/agents-api.ts
@@ -7,7 +7,7 @@
 
 import {Application, NextFunction, Request, Response} from "express";
 import {AgentManager} from "./AgentManager";
-import {Agent, AgentStatus} from "./Agent";
+import {Agent, AgentStatus, AgentConfig} from "./Agent";
 import AgentLogger from "@best/agent-logger";
 
 function authenticateAgentApi(tokenSecret: string, req: Request, res: Response, next: NextFunction) {
@@ -25,24 +25,46 @@ function authenticateAgentApi(tokenSecret: string, req: Request, res: Response,
     }
 }
 
-function addAgentToHub(agentManager: AgentManager, logger: AgentLogger, req: Request, res: Response) {
-    // @todo: validate payload.
-    const agentConfig = {
-        host: req.body.host,
-        options: req.body.options,
-        spec: req.body.spec,
-        remoteRunner: req.body.remoteRunner,
-        remoteRunnerConfig: req.body.remoteRunnerConfig
+function validateSpec(maybeSpecObject: any): boolean {
+    if (!maybeSpecObject.browser || !maybeSpecObject.version) {
+        throw new Error('Invalid browser specification. Must contain "browser" and "version" properties');
+    }
+
+    return true;
+}
+
+function normalizeAndValidateAgentConfig(rawAgentConfig: any): AgentConfig {
+    const { host, options, spec: specConfig, remoteRunner, remoteRunnerConfig } = rawAgentConfig;
+    if (!host) {
+        throw new Error('Host for Agent must be provided');
+    }
+
+    if (!remoteRunner) {
+        throw new Error('Remote runner must be provided');
+    }
+
+    const specs = Array.isArray(specConfig) ? specConfig : [specConfig];
+    specs.forEach(validateSpec);
+
+    return {
+        host,
+        options,
+        specs,
+        remoteRunner,
+        remoteRunnerConfig
     };
+}
 
+function addAgentToHub(agentManager: AgentManager, logger: AgentLogger, req: Request, res: Response) {
+    const agentConfig = normalizeAndValidateAgentConfig(req.body);
     const agent = new Agent(agentConfig, logger);
     agent.status = AgentStatus.Offline;
 
     agentManager.addAgent(agent);
 
     agent.status = AgentStatus.Idle;
 
-    logger.info('', 'agent added', [agentConfig.host, agentConfig.spec]);
+    logger.info('', 'agent added', [agentConfig.host, agentConfig.specs]);
 
     return res.status(201).send({
         success: 'true',

diff --git a/packages/@best/agent/src/benchmark-loader.ts b/packages/@best/agent/src/benchmark-loader.ts
@@ -5,10 +5,10 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
 */
 
-import SocketIOFile from "socket.io-file";
 import path from "path";
+import SocketIOFile from "socket.io-file";
 import { cacheDirectory } from '@best/utils';
-import * as SocketIO from "socket.io";
+import { Socket } from "socket.io";
 import AgentLogger from "@best/agent-logger";
 
 // This is all part of the initialization
@@ -23,7 +23,7 @@ const LOADER_CONFIG = {
 
 const UPLOAD_START_TIMEOUT = 5000;
 
-export async function loadBenchmarkJob(socketConnection: SocketIO.Socket, logger: AgentLogger): Promise<any> {
+export async function loadBenchmarkJob(socketConnection: Socket, logger: AgentLogger): Promise<any> {
     return new Promise(async (resolve, reject) => {
         const socket = socketConnection;
         let uploaderTimeout: any = null;

diff --git a/packages/@best/agent/src/hub-registration.ts b/packages/@best/agent/src/hub-registration.ts
@@ -7,17 +7,19 @@
 
 import axios from "axios";
 
+export interface Spec {
+    browser: string,
+    version: string
+}
+
 export interface HubConfig {
     hub: {
         host: string,
         authToken: string,
         pingTimeout: number,
     },
     agentConfig: {
-        spec: {
-            browser: string,
-            version: string
-        },
+        spec: Spec | Spec[],
         host: string,
         options: { path: string },
         remoteRunner: string,