suitest-js-api 3.9.0 → 3.10.0

package/index.d.ts

@@ -127,7 +127,6 @@ declare namespace suitest {
 			model: string,
 			owner: string,
 			firmware: string,
-			isShared: boolean,
 			modelId: string,
 			platforms: string[],
 			customName?: string,

package/index.js

@@ -4,7 +4,10 @@ const suitest = new SUITEST_API({exitOnError: true});
 
 // Check if we are in launcher child process, connect to master IPC,
 // override config, start session, pair device, set app config
-connectToIpcAndBootstrapSession(suitest);
+connectToIpcAndBootstrapSession(suitest).catch(function(err) {
+	suitest.logger.error(err);
+	process.exit(1);
+});
 
 // Export public API
 module.exports = suitest;

package/lib/api/endpoints.js

@@ -12,7 +12,7 @@ const endpoints = {
 	appConfigById:         '/apps/:appId/configs/:configId',
 	appTestDefinitions:    '/apps/:appId/test-definitions',
 	appTestDefinitionById: '/apps/:appId/versions/:versionId/tests/:testId',
-	devices:               '/devices',
+	device:                '/devices/:deviceId',
 	testRun:               '/test-run',
 	testRunById:           '/test-run/:testRunId',
 	testRunOnDevice:       '/test-run/:testRunId/device/:deviceId',

package/lib/api/request.js

@@ -2,7 +2,7 @@
  * http request module
  */
 
-const fetch = require('node-fetch');
+const {fetch} = require('../utils/fetch');
 
 const {apiUrl} = require('../../config');
 const SuitestError = require('../utils/SuitestError');
@@ -15,10 +15,10 @@ const {captureException} = require('../utils/sentry/Raven');
  *
  * @param {string|[string, any]} url
  * @param {Object|any} requestObject
- * @param {Function} onReject - will be invoked if response not ok
+ * @param {function(Response)} [onFail] - will be invoked if response not ok
  * @returns {Promise}
  */
-async function request(url, requestObject, onReject) {
+async function request(url, requestObject, onFail) {
 	if (requestObject.body) {
 		requestObject.body = JSON.stringify(requestObject.body);
 
@@ -47,8 +47,8 @@ async function request(url, requestObject, onReject) {
 		return res.json();
 	}
 
-	if (onReject) {
-		return Promise.reject(onReject(res));
+	if (onFail) {
+		return onFail(res);
 	}
 
 	throw new SuitestError(

package/lib/api/webSockets.js

@@ -7,7 +7,7 @@ const WS = require('ws');
 const {v1: uuid} = require('uuid');
 const {path} = require('ramda');
 const Raven = require('raven');
-const fetch = require('node-fetch');
+const {fetch, setUserAgent} = require('../utils/fetch');
 
 const SuitestError = require('../utils/SuitestError');
 const texts = require('../texts');
@@ -31,6 +31,11 @@ const webSocketsFactory = (self) => {
 		disconnect();
 		logger.debug('Initializing websocket connection with options:', connectionOps);
 
+		if (!connectionOps.headers) {
+			connectionOps.headers = {};
+		}
+		setUserAgent(connectionOps.headers);
+
 		ws = new WS(config.wsUrl, connectionOps);
 
 		ws.on('message', msg => {

package/lib/chains/positionChain.js

@@ -132,8 +132,8 @@ const positionFactory = (classInstance) => {
 		return makeChain(classInstance, getComposers, {
 			type: 'position',
 			coordinates: {
-				x: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, x, invalidInputMessage('position', 'Position x')),
-				y: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, y, invalidInputMessage('position', 'Position y')),
+				x: validate(validators.ST_VAR_NOT_NEGATIVE_NUMBER, x, invalidInputMessage('position', 'Position x')),
+				y: validate(validators.ST_VAR_NOT_NEGATIVE_NUMBER, y, invalidInputMessage('position', 'Position y')),
 			},
 		});
 	};

package/lib/chains/pressButtonChain.js

@@ -92,7 +92,7 @@ const pressButtonFactory = (classInstance) => {
 			),
 			longPressMs: options.longPressMs !== undefined
 				? validate(
-					validators.ST_VAR_OR_POSITIVE_NUMBER,
+					validators.ST_VAR_NOT_NEGATIVE_NUMBER,
 					options.longPressMs,
 					invalidInputMessage('pressButton', 'Invalid longPressMs'),
 				)

package/lib/chains/sleepChain.js

@@ -59,7 +59,7 @@ const sleepFactory = (classInstance) => {
 	const sleepChain = milliseconds => makeChain(classInstance, getComposers, {
 		type: 'sleep',
 		milliseconds: validation.validate(
-			validation.validators.ST_VAR_OR_POSITIVE_NUMBER,
+			validation.validators.ST_VAR_NOT_NEGATIVE_NUMBER,
 			milliseconds,
 			invalidInputMessage('sleep', 'Sleep milliseconds')
 		),

package/lib/composers/intervalComposer.js

@@ -8,7 +8,7 @@ const {invalidInputMessage} = require('../texts');
  */
 const intervalComposer = makeModifierComposer(composers.INTERVAL, ['interval'], (_, meta, value) => ({
 	...meta,
-	interval: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, value, invalidInputMessage('interval', 'Interval')),
+	interval: validate(validators.ST_VAR_NOT_NEGATIVE_NUMBER, value, invalidInputMessage('interval', 'Interval')),
 }));
 
 module.exports = intervalComposer;

package/lib/composers/repeatComposer.js

@@ -8,7 +8,7 @@ const {invalidInputMessage} = require('../texts');
  */
 const repeatComposer = makeModifierComposer(composers.REPEAT, ['repeat'], (_, meta, value) => ({
 	...meta,
-	repeat: validate(validators.ST_VAR_OR_POSITIVE_NUMBER_NOT_ZERO, value, invalidInputMessage('repeat', 'Repeat')),
+	repeat: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, value, invalidInputMessage('repeat', 'Repeat')),
 }));
 
 module.exports = repeatComposer;

package/lib/composers/scrollComposer.js

@@ -14,7 +14,7 @@ const scrollComposer = makeModifierComposer(composers.TAP, ['scroll'], (_, meta,
 		isScroll: true,
 		direction: validate(validators.DIRECTIONS, direction, invalidInputMessage('scroll', 'direction')),
 		distance: distance !== undefined
-			? validate(validators.ST_VAR_OR_POSITIVE_NUMBER, distance, invalidInputMessage('scroll', 'distance'))
+			? validate(validators.ST_VAR_NOT_NEGATIVE_NUMBER, distance, invalidInputMessage('scroll', 'distance'))
 			: undefined,
 	};
 });

package/lib/composers/setSizeComposer.js

@@ -11,8 +11,8 @@ const {invalidInputMessage} = require('../texts');
 const setSizeComposer = makeModifierComposer(composers.SET_SIZE, ['setSize'], (_, meta, width, height) => ({
 	...meta,
 	isSetSize: true,
-	width: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, width, invalidInputMessage('setSize', 'Width')),
-	height: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, height, invalidInputMessage('setSize', 'Height')),
+	width: validate(validators.ST_VAR_NOT_NEGATIVE_NUMBER, width, invalidInputMessage('setSize', 'Width')),
+	height: validate(validators.ST_VAR_NOT_NEGATIVE_NUMBER, height, invalidInputMessage('setSize', 'Height')),
 }));
 
 module.exports = setSizeComposer;

package/lib/composers/swipeComposer.js

@@ -14,11 +14,11 @@ const swipeComposer = makeModifierComposer(
 		isSwipe: true,
 		direction: validate(validators.DIRECTIONS, direction, invalidInputMessage('swipe/flick', 'direction')),
 		distance: validate(
-			validators.ST_VAR_OR_POSITIVE_NUMBER, distance,
+			validators.ST_VAR_NOT_NEGATIVE_NUMBER, distance,
 			invalidInputMessage('swipe/flick', 'distance'),
 		),
 		duration: validate(
-			validators.ST_VAR_OR_POSITIVE_NUMBER, duration,
+			validators.ST_VAR_NOT_NEGATIVE_NUMBER, duration,
 			invalidInputMessage('swipe/flick', 'duration'),
 		),
 	}));

package/lib/composers/timeoutComposer.js

@@ -7,7 +7,7 @@ const {validate, validators} = require('../validation');
  */
 const timeoutComposer = makeModifierComposer(composers.TIMEOUT, ['timeout'], (_, meta, value) => ({
 	...meta,
-	timeout: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, value, 'timeout'),
+	timeout: validate(validators.ST_VAR_NOT_NEGATIVE_NUMBER, value, 'timeout'),
 }));
 
 module.exports = timeoutComposer;

package/lib/constants/environment.js

@@ -3,6 +3,7 @@ const ENVIRONMENT_VARS = Object.freeze({
 	 * @description indicates that session is running as launcher child process, contains deviceId|configId|ipcPortNumber
 	 */
 	SUITEST_CHILD_PROCESS: 'SUITEST_CHILD_PROCESS',
+	SUITEST_DEVICE_ID: 'SUITEST_DEVICE_ID',
 	SUITEST_PRESET_NAME: 'SUITEST_PRESET_NAME',
 	SUITEST_BE_SERVER: 'SUITEST_BE_SERVER',
 });

package/lib/constants/validationKeys.js

@@ -2,9 +2,9 @@ const validationKeys = {
 	CONFIG_OVERRIDE: Symbol('configOverride'),
 	CONFIGURE: Symbol('configure'),
 	NON_EMPTY_STRING: Symbol('nonEmptyString'),
-	POSITIVE_NUMBER: Symbol('positiveNumber'),
-	ST_VAR_OR_POSITIVE_NUMBER: Symbol('stVarOrPositiveNumber'),
-	ST_VAR_OR_POSITIVE_NUMBER_NOT_ZERO: Symbol('stVarOrPositiveNumberNotZero'),
+	NOT_NEGATIVE_NUMBER: Symbol('notNegativeNumber'),
+	ST_VAR_NOT_NEGATIVE_NUMBER: Symbol('stVarOrPositiveNumber'),
+	ST_VAR_OR_POSITIVE_NUMBER: Symbol('stVarOrPositiveNumberNotZero'),
 	ST_VAR_OR_NUMBER: Symbol('stVarOrNumber'),
 	NON_EMPTY_STRING_OR_UNDEFINED: Symbol('nonEmptyStringOrUndefined'),
 	NON_EMPTY_STRING_OR_NUll: Symbol('nonEmptyStringOrNull'),

package/lib/utils/AuthContext.js

@@ -28,7 +28,7 @@ const tokenAllowed = {
 		[endpoints.appConfigById]: ['GET'],
 		[endpoints.appTestDefinitions]: ['GET'],
 		[endpoints.appTestDefinitionById]: ['GET'],
-		[endpoints.devices]: ['GET'],
+		[endpoints.device]: ['GET'],
 		[endpoints.testRun]: ['POST'],
 		[endpoints.testRunById]: ['GET', 'DELETE'],
 		[endpoints.testRunOnDevice]: ['DELETE'],

package/lib/utils/fetch.js

@@ -0,0 +1,27 @@
+const nodeFetch = require('node-fetch');
+const {name, version} = require('../../package.json');
+
+async function fetch(resource, options = {}) {
+	if (!options.headers) {
+		options.headers = {};
+	}
+	setUserAgent(options.headers);
+
+	return await nodeFetch(resource, options);
+}
+
+/**
+ * Always overwrite user agent to ours
+ * @param {Object} headers
+ */
+function setUserAgent(headers) {
+	const uaHeader = 'user-agent';
+	const headerName = Object.keys(headers).find(headerName => headerName.toLowerCase() === uaHeader);
+
+	headers[headerName || uaHeader] = `${name}/${version}`;
+}
+
+module.exports = {
+	fetch,
+	setUserAgent,
+};

package/lib/utils/getDeviceInfo.js

@@ -1,7 +1,8 @@
 const request = require('../api/request');
 const endpoints = require('../api/endpoints');
-const fetch = require('node-fetch');
 const R = require('ramda');
+const SuitestError = require('./SuitestError');
+const {suitestServerError} = require('../texts');
 
 /**
  * Return devices details
@@ -10,19 +11,28 @@ const R = require('ramda');
  * @returns {object}
  */
 async function getDevicesDetails({authContext}, devicesList) {
-	const authorizeHttp = await authContext.authorizeHttp(endpoints.devices, {
+	const authorizeHttp = await authContext.authorizeHttp(endpoints.device, {
 		method: 'GET',
 	});
-	let response = await request(
-		[endpoints.devices, null, {limit: 100}],
-		authorizeHttp,
-	);
-	let devices = [...response.values];
 
-	while (response.next) {
-		response = await fetch(response.next, authorizeHttp);
-		response = await response.json();
-		devices = [...devices, ...response.values];
+	let devices = [];
+
+	for (const {device: deviceId} of devicesList) {
+		const response = await request([endpoints.device, {deviceId}], authorizeHttp, function(res) {
+			if (res.status === 404) {
+				return undefined;
+			}
+			throw new SuitestError(
+				suitestServerError(`[getDeviceDetail(deviceId: ${deviceId})]`, res.status, res.statusText),
+				SuitestError.SERVER_ERROR,
+			);
+		});
+		if (response) {
+			devices.push({
+				deviceId,
+				...response,
+			});
+		}
 	}
 
 	return devicesList.reduce((result, d) => {
@@ -57,7 +67,7 @@ function getDeviceName(deviceInfo, short = false) {
 		name = short ? `${model}` : `${manufacturer} ${model}`;
 
 	if (short && name.length > 15)
-		name = `${model} (${deviceId.substr(0, 3)})`;
+		name = `${model} (${deviceId.slice(0, 3)})`;
 
 	return name;
 }

package/lib/utils/makeUrlFromArray.js

@@ -8,7 +8,7 @@ function makeUrlFromArray(url) {
 	let key, reg;
 	let firstLoop = true;
 
-	if (Object.prototype.toString.call(url) === '[object Array]') {
+	if (Array.isArray(url)) {
 		// refill variables in url
 		if (url[1]) {
 			for (key in url[1]) {

package/lib/utils/testHelpers/mockDeviceInfo.js

@@ -3,50 +3,21 @@ const config = require('../../../config');
 const makeUrlFromArray = require('../makeUrlFromArray');
 const endpoints = require('../../api/endpoints');
 
-const devices = {
-	values: [
-		{
-			manufacturer: 'Google',
-			model: 'Chrome',
-			owner: 'Suitest, Inc.',
-			firmware: '68.0.3440.106',
-			isShared: false,
-			modelId: '046b8cbc-1278-4c01-ae2e-5db509c19d33',
-			platforms: ['browser'],
-			status: 'OFF',
-		},
-		{
-			deviceId: '1',
-			manufacturer: 'Google',
-			model: 'Chrome',
-			owner: 'Suitest, Inc.',
-			firmware: '68.0.3440.106',
-			isShared: false,
-			modelId: '046b8cbc-1278-4c01-ae2e-5db509c19d33',
-			platforms: ['browser'],
-			status: 'OFF',
-		},
-
-		{
-			deviceId: 'deviceId',
-			manufacturer: 'Google',
-			model: 'Chrome',
-			owner: 'Suitest, Inc.',
-			firmware: '68.0.3440.106',
-			isShared: false,
-			modelId: '046b8cbc-1278-4c01-ae2e-5db509c19d33',
-			platforms: ['browser'],
-			status: 'OFF',
-		},
-
-	],
+const device = {
+	manufacturer: 'Google',
+	model: 'Chrome',
+	owner: 'Suitest, Inc.',
+	firmware: '68.0.3440.106',
+	isShared: false,
+	modelId: '046b8cbc-1278-4c01-ae2e-5db509c19d33',
+	platforms: ['browser'],
+	status: 'OFF',
 };
 
 function stubDeviceInfoFeed(deviceId) {
-	devices.values[0].deviceId = deviceId;
 	nock(config.apiUrl)
-		.get(makeUrlFromArray([endpoints.devices, null, {limit: 100}]))
-		.reply(200, devices);
+		.get(makeUrlFromArray([endpoints.device, {deviceId}]))
+		.reply(200, device);
 }
 
 module.exports = stubDeviceInfoFeed;

package/lib/utils/testHelpers/testLauncherTest.js

@@ -14,7 +14,7 @@ process.on('exit', () => {
 async function setUp() {
 	await testServer.restart();
 
-	stubDeviceInfoFeed();
+	stubDeviceInfoFeed('deviceId');
 
 	const suitest = require('../../../index');
 

package/lib/utils/testLauncherHelper.js

@@ -298,6 +298,7 @@ function getChildOptions(device, port) {
 		env: {
 			...process.env,
 			[envVars.SUITEST_CHILD_PROCESS]: `${device.deviceId}|${device.config}|${port}`,
+			[envVars.SUITEST_DEVICE_ID]: device.deviceId,
 			[envVars.SUITEST_PRESET_NAME]: device.presetName,
 			FORCE_COLOR: true,
 			NODE_NO_READLINE: 1, // enable repl in advanced consoles

package/lib/validation/validators.js

@@ -28,6 +28,10 @@ function throwError(text) {
 	);
 }
 
+function validSuitestVariable(value) {
+	return typeof value === 'string' && !/^<%.+%>$/.test(value);
+}
+
 /**
  * @description returns prettified errors messages for element properties errors
  * @param {Object} validate
@@ -155,15 +159,15 @@ function validateJsonSchema(schemaKey, data, errorMessage) {
 	return data;
 }
 
-const validatePositiveNumber = (val, name) => {
+const validateNotNegativeNumber = (val, name) => {
 	if (!Number.isFinite(val) || val < 0) {
-		throwError(name + ' should be positive number');
+		throwError(name + ' should be not negative number');
 	}
 
 	return val;
 };
 
-const validatePositiveNumberNotZero = (val, name) => {
+const validatePositiveNumber = (val, name) => {
 	if (!Number.isFinite(val) || val <= 0) {
 		throwError(name + ' should be positive number');
 	}
@@ -179,25 +183,31 @@ const validateNumber = (val, name) => {
 	return val;
 };
 
-const createStVarOrNumberValidator = (onlyPositiveNumber = false, biggerThanZero = false) => (val, name) => {
-	if (!['number', 'string'].includes(typeof val)) {
+const createStVarOrNumberValidator = ({
+	notNegativeNumbers = false,
+	positiveNumbers = false,
+}) => (val, name) => {
+	if (
+		!['number', 'string'].includes(typeof val)
+		|| validSuitestVariable(val)
+	) {
 		throwError(name + ' should be suitest configuration variable or number');
 	} else if (typeof val === 'number') {
-		if (onlyPositiveNumber && biggerThanZero) {
-			(validatePositiveNumberNotZero)(val, name);
+		if (positiveNumbers) {
+			validatePositiveNumber(val, name);
+		} else if (notNegativeNumbers) {
+			validateNotNegativeNumber(val, name);
 		} else {
-			(onlyPositiveNumber ? validatePositiveNumber : validateNumber)(val, name);
+			validateNumber(val, name);
 		}
-	} else if (typeof val === 'string' && !/^<%.+%>$/.test(val)) {
-		throwError(name + ' should be suitest configuration variable');
 	}
 
 	return val;
 };
 
-const validateStVarOrNumber = createStVarOrNumberValidator();
-const validateStVarOrPositiveNumber = createStVarOrNumberValidator(true);
-const validateStVarOrPositiveNumberNotZero = createStVarOrNumberValidator(true, true);
+const validateStVarOrNumber = createStVarOrNumberValidator({});
+const validateStVarOrPositiveNumber = createStVarOrNumberValidator({notNegativeNumbers: true});
+const validateStVarOrPositiveNumberNotZero = createStVarOrNumberValidator({positiveNumbers: true});
 
 const validateNonEmptyStringOrUndefined = (val, name) => {
 	if (typeof val === 'string' && val.length || val === undefined) {
@@ -306,7 +316,7 @@ const validateTapTypeAndDuration = ({tapType, tapDuration}, tapTypeErrorMsg, dur
 
 module.exports = {
 	validateJsonSchema,
-	validatePositiveNumber,
+	validateNotNegativeNumber,
 	validateNumber,
 	validateNonEmptyStringOrUndefined,
 	validateNonEmptyStringOrNull,

package/lib/validation/validatorsMap.js

@@ -8,13 +8,13 @@ const validatorsMap = {
 	[validationKeys.STRING]: (value, text) => {
 		return validators.validateJsonSchema(validationKeys.STRING, value, text);
 	},
-	[validationKeys.POSITIVE_NUMBER]: (value, text) => {
-		return validators.validatePositiveNumber(value, text);
+	[validationKeys.NOT_NEGATIVE_NUMBER]: (value, text) => {
+		return validators.validateNotNegativeNumber(value, text);
 	},
-	[validationKeys.ST_VAR_OR_POSITIVE_NUMBER]: (value, text) => {
+	[validationKeys.ST_VAR_NOT_NEGATIVE_NUMBER]: (value, text) => {
 		return validators.validateStVarOrPositiveNumber(value, text);
 	},
-	[validationKeys.ST_VAR_OR_POSITIVE_NUMBER_NOT_ZERO]: (value, text) => {
+	[validationKeys.ST_VAR_OR_POSITIVE_NUMBER]: (value, text) => {
 		return validators.validateStVarOrPositiveNumberNotZero(value, text);
 	},
 	[validationKeys.ST_VAR_OR_NUMBER]: (value, text) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "main": "index.js",
   "repository": "git@github.com:SuitestAutomation/suitest-js-api.git",
   "author": "Suitest <hello@suite.st>",