suitest-js-api 3.2.0 → 3.2.3

package/index.d.ts

@@ -39,6 +39,7 @@ import {ScreenOrientation} from './typeDefinition/constants/ScreenOrientation';
 import {CloseAppChain} from './typeDefinition/CloseAppChain';
 import {SuspendAppChain} from './typeDefinition/SuspendAppChain';
 import {RelativePosition} from './typeDefinition/RelativePositionChain';
+import {LaunchMode} from './typeDefinition/constants/LaunchMode';
 
 // --------------- Suitest Interface ---------------------- //
 
@@ -151,6 +152,7 @@ declare namespace suitest {
 		TAP_TYPES: TapTypes;
 		DIRECTIONS: Directions;
 		SCREEN_ORIENTATION: ScreenOrientation;
+		LAUNCH_MODE: LaunchMode;
 
 		authContext: AuthContext;
 		appContext: Context;
@@ -232,16 +234,7 @@ declare namespace suitest {
 	interface DeviceData {
 		id: string;
 		firmware: string;
-		deviceMeta: {
-			codeName: string;
-			deviceType: string;
-		};
-		status: {
-			type: string;
-			canPair: boolean;
-		};
-		platforms: string[];
-		workingPlatforms: string[];
+		modelId: string;
 	}
 
 	interface ConfigOverride {

package/lib/testLauncher/SuitestLauncher.js

@@ -7,6 +7,7 @@ const {
 	addLauncherIpcListeners,
 	throwDebugForManyDevicesError,
 	increaseMaxListeners,
+	handleChildResult,
 } = require('../utils/testLauncherHelper');
 const {TEST_COMMAND, TOKEN} = require('../constants/modes');
 const sessionConstants = require('../constants/session');
@@ -88,6 +89,8 @@ class SuitestLauncher {
 				throwDebugForManyDevicesError();
 			}
 
+			let finishedWithErrors = false;
+
 			try {
 				const ipcPort = await ipcServer.start({
 					...this.ownArgv,
@@ -101,7 +104,7 @@ class SuitestLauncher {
 				// increase stdout max listeners based on number of child processes to avoid node warning
 				increaseMaxListeners(process.stdout, devices.length, this.ownArgv.concurrency);
 
-				await runAllDevices(
+				finishedWithErrors = await runAllDevices(
 					this.restArgs,
 					this.ownArgv,
 					devicesWithDetails,
@@ -109,6 +112,7 @@ class SuitestLauncher {
 				);
 			} finally {
 				await closeSessionUnchained(suitest);
+				handleChildResult(finishedWithErrors);
 			}
 		} catch (error) {
 			await captureException(error);

package/lib/texts.js

@@ -158,9 +158,6 @@ ${leaves}`,
 	// ipc
 	ipcFailedToCreateServer: template`Failed to create IPC server. Port ${0} is busy.`,
 
-	// suffixes
-	'suffix.sessionWillClose': () => 'Test session will now close and all remaining Suitest commands will fail.',
-
 	// logger msg
 	sessionOpen: () => 'Connecting to Suitest ...',
 	sessionOpened: () => 'Connected to Suitest',

package/lib/utils/socketErrorMessages.js

@@ -133,15 +133,6 @@ function getErrorMessage({response, jsonMessage, verbosity, snippets}) {
 	return chainUtils.translateLineResult(jsonMessage, verbosity, response);
 }
 
-/**
- * @description check if error should be considered as fatal
- * @param {Object} res websocket message
- * @returns {boolean}
- */
-function isErrorFatal(res) {
-	return res.result === 'fatal' || normalizeErrorType(res) === 'testIsNotStarted';
-}
-
 /**
  * @description Normalize errorType
  * @param {*} response webscoket message
@@ -169,8 +160,7 @@ module.exports = {
 	 * @returns {string}
 	 */
 	getInfoErrorMessage: (message, prefix = '', res, stack) => {
-		const suffix = isErrorFatal(res) ? ` ${t['suffix.sessionWillClose']()}` : '';
-		const msg = prefix + stripAnsiChars(message) + suffix;
+		const msg = prefix + stripAnsiChars(message);
 		const firstStackLine = stack && getFirstStackLine(stack);
 		const nl = firstStackLine && msg.endsWith(EOL) ? '' : EOL;
 

package/lib/utils/testLauncherHelper.js

@@ -312,7 +312,7 @@ function getChildOptions(device, port) {
  * @param {Object} ownArgv - implicitly derived parameters
  * @param {Array} devices - array with items containing full device information
  * @param {number} ipcPort - ipc port number
- * @returns {Promise<*>}
+ * @returns {Promise<boolean>} - finished with errors or not.
  */
 function runAllDevices(cmdArgv, ownArgv, devices, ipcPort) {
 	const tests = devices.map(device => () => runTestOnDevice(
@@ -343,7 +343,8 @@ function runAllDevices(cmdArgv, ownArgv, devices, ipcPort) {
 
 		log.final(failedDevices.length, result.length - failedDevices.length);
 		warnNewVersionAvailable(logger, version, suitestVersion);
-		handleChildResult(failedDevices.length !== 0);
+
+		return failedDevices.length !== 0;
 	});
 }
 

package/lib/validation/jsonSchemas.js

@@ -19,46 +19,50 @@ const SCREEN_ORIENTATION = require('../constants/screenOrientation');
 const LAUNCH_MODE = require('../constants/launchMode');
 const schemas = {};
 
-schemas[validationKeys.CONFIG_OVERRIDE] = {
-	'type': 'object',
-	'properties': {
-		'url': {'type': 'string'},
-		'suitestify': {'type': 'boolean'},
-		'domainList': {
-			'type': 'array',
-			'items': {'type': 'string'},
-		},
-		'mapRules': {
-			'type': 'array',
-			'items': {
-				'type': 'object',
-				'properties': {
-					'methods': {
-						'type': 'array',
-						'items': {'type': 'string'},
-					},
-					'url': {'type': 'string'},
-					'type': {'type': 'string'},
-					'toUrl': {'type': 'string'},
+const CONFIG_OVERRIDE_PROPERTIES = {
+	'url': {'type': 'string'},
+	'suitestify': {'type': 'boolean'},
+	'domainList': {
+		'type': 'array',
+		'items': {'type': 'string'},
+	},
+	'mapRules': {
+		'type': 'array',
+		'items': {
+			'type': 'object',
+			'properties': {
+				'methods': {
+					'type': 'array',
+					'items': {'type': 'string'},
 				},
+				'url': {'type': 'string'},
+				'type': {'type': 'string'},
+				'toUrl': {'type': 'string'},
 			},
 		},
-		'codeOverrides': {'type': 'object'},
-		'configVariables': {
-			'type': 'array',
-			'items': {
-				'type': 'object',
-				'properties': {
-					'key': {'type': 'string'},
-					'value': {'type': 'string'},
-				},
-				'required': ['key', 'value'],
+	},
+	'codeOverrides': {'type': 'object'},
+	'configVariables': {
+		'type': 'array',
+		'items': {
+			'type': 'object',
+			'properties': {
+				'key': {'type': 'string'},
+				'value': {'type': 'string'},
 			},
+			'required': ['key', 'value'],
 		},
-		'openAppOverrideTest': {
-			'type': 'string',
-			'format': 'uuid',
-		},
+	},
+	'openAppOverrideTest': {
+		'type': 'string',
+		'format': 'uuid',
+	},
+};
+
+schemas[validationKeys.CONFIG_OVERRIDE] = {
+	'type': 'object',
+	'properties': {
+		...CONFIG_OVERRIDE_PROPERTIES,
 	},
 };
 
@@ -328,8 +332,8 @@ schemas[validationKeys.TEST_LAUNCHER_TOKEN] = {
 								'type': 'object',
 								'properties': {
 									'configId': {'type': 'string'},
+									...CONFIG_OVERRIDE_PROPERTIES,
 								},
-								'additionalProperties': false,
 							},
 						],
 					},

package/package.json

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

package/typeDefinition/OpenAppChain.d.ts

@@ -1,12 +1,12 @@
 import {
 	AbstractChain,
 	BaseChain,
-	LaunchMode
+	LaunchModeModifier
 } from './modifiers';
 
 export interface OpenAppChain extends
 	BaseChain<OpenAppChain, OpenAppEvalResult, OpenAppAbandonedChain>,
-	LaunchMode<OpenAppChain>
+	LaunchModeModifier<OpenAppChain>
 {}
 
 interface OpenAppAbandonedChain extends AbstractChain {}

package/typeDefinition/constants/LaunchMode.d.ts

@@ -0,0 +1,6 @@
+export type LaunchMode = {
+	RESUME:   'resume',
+	RESTART:  'restart',
+}
+
+export type LaunchModeValues = LaunchMode[keyof LaunchMode];

package/typeDefinition/modifiers.d.ts

@@ -1,3 +1,5 @@
+import {LaunchModeValues} from './constants/LaunchMode';
+
 export interface Thenable <R> {
 	then <U> (onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => U | Thenable<U>): Thenable<U>;
 	then <U> (onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => void): Thenable<U>;
@@ -38,8 +40,8 @@ export interface Clonable<T> {
 	clone(): T;
 }
 
-export interface LaunchMode<T> {
-	launchMode(mode: 'resume' | 'restart'): T;
+export interface LaunchModeModifier<T> {
+	launchMode(mode: LaunchModeValues): T;
 }
 
 export interface Abandable<T> {