suitest-js-api 4.2.3 → 4.3.0

package/index.d.ts

@@ -165,36 +165,7 @@ declare namespace suitest {
 		image(imageData: ImageData): ImageChain;
 		image(apiId: string): ImageChain;
 
-		getPairedDevice(): null | {
-			deviceId: string,
-			manufacturer: string,
-			model: string,
-			owner: string,
-			firmware: string,
-			osVersion?: string,
-			modelId: string,
-			platforms: string[],
-			customName: string,
-			ipAddress: string,
-			controlUnitIds: string[],
-			inactivityTimeout?: number,
-			status: string,
-			displayName?: string,
-			shortDisplayName?: string,
-			customUserInfo?: {
-				location?: string,
-				team?: string,
-				responsibleUser?: string,
-				osInfo?: string,
-				otherInfo?: string,
-			},
-			inUseBy?: {
-				description?: string,
-				email?: string,
-				orgName?: string,
-				tokenName?: string,
-			},
-		}
+		getPairedDevice(): PairedDevice | null;
 
 		// constants
 		PROP: elementTypes.ElementPropTypes;
@@ -223,8 +194,8 @@ declare namespace suitest {
 		LANG: Lang;
 
 		authContext: AuthContext;
-		appContext: Context;
-		pairedDeviceContext: Context;
+		appContext: Context<AppContextData>;
+		pairedDeviceContext: Context<PairedDevice>;
 
 		on(eventName: 'consoleLog', listener: (consoleLog: ConsoleLogEvent) => void): this;
 		on(eventName: 'networkLog', listener: (networkLog: NetworkLogEvent) => void): this;
@@ -310,6 +281,58 @@ declare namespace suitest {
 		recordingUrl?: string;
 	}
 
+	interface PairedDevice {
+		deviceId: string;
+		manufacturer: string;
+		model: string;
+		owner: string;
+		firmware: string;
+		osVersion?: string;
+		modelId: string;
+		platforms: string[];
+		customName: string;
+		ipAddress: string;
+		controlUnitIds: string[];
+		inactivityTimeout?: number;
+		status: string;
+		displayName?: string;
+		shortDisplayName?: string;
+		customUserInfo?: {
+			location?: string;
+			team?: string;
+			responsibleUser?: string;
+			osInfo?: string;
+			otherInfo?: string;
+		};
+		inUseBy?: {
+			description?: string;
+			email?: string;
+			orgName?: string;
+			tokenName?: string;
+		};
+	}
+
+	interface ConfigVariable {
+		key: string;
+		value: string;
+	}
+
+	interface EffectiveAppConfiguration {
+		configVariables: ConfigVariable[];
+	}
+
+	interface AppContextData {
+		appId: string;
+		versionId: string;
+		configId: string;
+		configOverride: ConfigOverride;
+		/**
+		 * The locally available part of the application configuration used by the current test execution.
+		 * It combines values from the selected cloud configuration with local overrides, with override values taking precedence.
+		 */
+		effectiveAppConfig: EffectiveAppConfiguration;
+	}
+
 	interface ConfigOverride {
 		url?: string;
 		suitestify?: boolean;
@@ -321,10 +344,7 @@ declare namespace suitest {
 			toUrl: string;
 		}>;
 		codeOverrides?: object;
-		configVariables?: Array<{
-			key: string;
-			value: string;
-		}>;
+		configVariables?: ConfigVariable[];
 		openAppOverrideTest?: string;
 		[key: string]: any; // user should have ability to pass any property to config object
 	}
@@ -396,9 +416,9 @@ declare namespace suitest {
 		defaultTimeout: number;
 	}
 
-	interface Context {
-		context: unknown;
-		setContext(context: unknown): void;
+	interface Context<T = unknown> {
+		context: T | null;
+		setContext(context: T): void;
 		clear(): void;
 	}
 

package/lib/commands/getAppConfig.js

@@ -3,10 +3,10 @@ const chainPromise = require('../utils/chainPromise');
 const {getAppConfigError} = require('../texts');
 const SuitestError = require('../utils/SuitestError');
 
-async function getAppConfig({appContext, authContext, webSockets}) {
+async function getAppConfig({appContext, authContext, webSockets}, configId = appContext._context.configId) {
 	const authedContent = await authContext.authorizeWs({
 		type: wsContentTypes.getConfiguration,
-		configId: appContext._context.configId,
+		configId,
 	}, getAppConfig.name);
 
 	const response = await webSockets.send(authedContent);
@@ -20,4 +20,5 @@ async function getAppConfig({appContext, authContext, webSockets}) {
 
 module.exports = {
 	getAppConfig: chainPromise(getAppConfig),
+	getAppConfigUnchained: getAppConfig,
 };

package/lib/commands/setAppConfig.js

@@ -6,6 +6,15 @@ const {validate, validators} = require('../validation');
 const wsContentTypes = require('../api/wsContentTypes');
 const chainPromise = require('../utils/chainPromise');
 const {invalidInputMessage, usingAppConfig, usedAppConfig, useAppConfigOverrides} = require('../texts');
+const {getAppConfigUnchained: getAppConfig} = require('./getAppConfig');
+
+const mergeConfigVariables = (variables = {}, overrideVariables = []) => {
+	const effectiveVariables = new Map(Object.entries(variables));
+
+	overrideVariables.forEach(({key, value}) => effectiveVariables.set(key, value));
+
+	return Array.from(effectiveVariables, ([key, value]) => ({key, value}));
+};
 
 /**
  * Set application config
@@ -30,7 +39,8 @@ async function setAppConfig({appContext, authContext, webSockets, logger, config
 	}, setAppConfig.name);
 
 	// make ws request
-	const {appId, versionId} = await webSockets.send(authedContent);
+	const {versionId, appId} = await webSockets.send(authedContent);
+	const cloudConfig = await getAppConfig({appContext, authContext, webSockets}, configId);
 
 	// set app context
 	appContext.setContext({
@@ -38,6 +48,12 @@ async function setAppConfig({appContext, authContext, webSockets, logger, config
 		versionId,
 		configId,
 		configOverride,
+		effectiveAppConfig: {
+			configVariables: mergeConfigVariables(
+				cloudConfig && cloudConfig.variables || {},
+				configOverride.configVariables,
+			),
+		},
 	});
 
 	logger.log(usedAppConfig(configId));

package/lib/composers/thenComposer.js

@@ -43,7 +43,11 @@ const makeThenComposer = (getSocketMessage, callback, beforeSend) => makeMethodC
 				if (beforeSend) {
 					beforeSend(data);
 				} else {
-					const translation = translateLine(dataToTranslate, config.logLevel);
+					const translation = translateLine(
+						dataToTranslate,
+						config.logLevel,
+						appContext.context ? appContext.context.effectiveAppConfig : null,
+					);
 
 					if (translation) {
 						logger.log(translation);
@@ -52,7 +56,11 @@ const makeThenComposer = (getSocketMessage, callback, beforeSend) => makeMethodC
 
 				promise = authContext.authorizeWs(jsonSocketMessage, data.type)
 					.then(() => {
-						const defaultResponseHandler = processServerResponse(logger, config.logLevel);
+						const defaultResponseHandler = processServerResponse(
+							logger,
+							config.logLevel,
+							appContext.context ? appContext.context.effectiveAppConfig : null,
+						);
 
 						return webSockets.send(message).then(result => {
 							return callback

package/lib/constants/element.js

@@ -38,6 +38,7 @@ const ELEMENT_PROP = {
 	ID: 'id',
 	IMAGE: 'image',
 	IMAGE_HASH: 'imageHash',
+	IS_ACCESSIBLE: 'isAccessible',
 	IS_CHECKED: 'isChecked',
 	IS_CHECKED_ANDROID_OTTIUM: 'checked',
 	IS_CLICKABLE: 'isClickable',
@@ -54,6 +55,7 @@ const ELEMENT_PROP = {
 	IS_SELECTED_ANDROID_OTTIUM: 'selected',
 	IS_TOUCHABLE: 'isTouchable',
 	ITEM_FOCUSED: 'itemFocused',
+	LABEL: 'label',
 	LEFT: 'left',
 	LEFT_ABSOLUTE: 'leftAbsolute',
 	MARGIN: 'margin',
@@ -102,6 +104,8 @@ const ELEMENT_PROP = {
 	IS_LONG_CLICKABLE_ANDROID_OTTIUM: 'long-clickable',
 	IS_SCROLLABLE_ANDROID_OTTIUM: 'scrollable',
 	BOUNDS: 'bounds',
+	CLASS_CHAIN: 'classChain',
+	PREDICATE_STRING: 'predicateString',
 	ROLE: 'role',
 	DESCRIPTION: 'description',
 	ORIENTATION_TEXT: 'orientationText',

package/lib/utils/chainUtils.js

@@ -246,22 +246,23 @@ const mapLogLevelsToTranslationModule = {
  * Use translation module to translate strings
  * @param json
  * @param logLevel
+ * @param appConfig
  */
-const translateLine = (json, logLevel) => {
+const translateLine = (json, logLevel, appConfig) => {
 	if (logLevel === 'silent') {
 		// no progress messages
 		return '';
 	}
 	const testLine = processJsonMessageForToString(json);
 	const line = text.toText(
-		translate.translateTestLine({testLine}),
+		translate.translateTestLine({testLine, appConfig}),
 		{format: true, verbosity: mapLogLevelsToTranslationModule[logLevel]});
 	const prefix = getRequestOpType(json);
 
 	return `${prefix}${line}`;
 };
 
-const translateLineResult = (json, logLevel, lineResult) => {
+const translateLineResult = (json, logLevel, lineResult, appConfig) => {
 	const testLine = processJsonMessageForToString(json);
 	let verbosity = mapLogLevelsToTranslationModule[logLevel];
 
@@ -270,7 +271,7 @@ const translateLineResult = (json, logLevel, lineResult) => {
 	}
 
 	return text.toText(
-		translate.translateTestLineResult({testLine, lineResult}),
+		translate.translateTestLineResult({testLine, lineResult, appConfig}),
 		{format: true, verbosity},
 	);
 };

package/lib/utils/socketChainHelper.js

@@ -20,9 +20,10 @@ const assertionErrorTypes = ['queryFailed', 'appRunning', 'appNotRunning', 'quer
  * Process network api websocket chain response
  * @param logger
  * @param {verbosity} verbosity level
+ * @param appConfig
  * @returns {any}
  */
-const processServerResponse = (logger, verbosity) =>
+const processServerResponse = (logger, verbosity, appConfig) =>
 	function processServerResponseHandler(res, data, jsonMessage, snippets) {
 		const isSnippet = data.type === 'runSnippet';
 		const isAssertionError = isSnippet || assertionErrorTypes.includes(normalizeErrorType(res));
@@ -32,6 +33,7 @@ const processServerResponse = (logger, verbosity) =>
 			verbosity,
 			jsonMessage,
 			snippets,
+			appConfig,
 		});
 		const throwErr = err => {
 			err.stack = data.stack;
@@ -102,6 +104,7 @@ const processServerResponse = (logger, verbosity) =>
 					results: [],
 					testId: jsonMessage.request.val,
 					level: 1,
+					appConfig,
 				});
 
 				logger.log(snippet);

package/lib/utils/socketErrorMessages.js

@@ -40,7 +40,7 @@ const testSnippetError = 'testSnippetError';
  * @param {string} data.verbosity - string verbosity level
  * @param {function} translate - added as function argument for testing
  */
-const getSnippetLogs = ({testId, definitions, results, level, verbosity}, translate = chainUtils.translateLineResult) => {
+const getSnippetLogs = ({testId, definitions, results, level, verbosity, appConfig}, translate = chainUtils.translateLineResult) => {
 	const indent = ' '.repeat(level);
 	// Indent all text by indent constant
 	const applyIndent = (str) => str.split('\n').map(l => indent + l).join('\n');
@@ -69,7 +69,7 @@ const getSnippetLogs = ({testId, definitions, results, level, verbosity}, transl
 	}).filter(Boolean);
 
 	return definitionsWithResults.reduce((logs, {def, result}) => {
-		logs.push(applyIndent(translate(def, verbosity, result)));
+		logs.push(applyIndent(translate(def, verbosity, result, appConfig)));
 
 		if (result && (result.results || result.loopResults)) {
 			const getLoopLogs = loopRes => getSnippetLogs({
@@ -78,6 +78,7 @@ const getSnippetLogs = ({testId, definitions, results, level, verbosity}, transl
 				results: loopRes,
 				level: level + 1,
 				verbosity,
+				appConfig,
 			}, translate);
 
 			if (result.loopResults) {
@@ -120,10 +121,10 @@ function isCommandError(response) {
  * @param {Array} snippets
  * @returns {string}
  */
-function getErrorMessage({response, jsonMessage, verbosity, snippets}) {
+function getErrorMessage({response, jsonMessage, verbosity, snippets, appConfig}) {
 	if (response.results && snippets) {
 		return getSnippetLogs(
-			{verbosity, definitions: snippets, results: response.results, testId: jsonMessage.request.val, level: 1},
+			{verbosity, definitions: snippets, results: response.results, testId: jsonMessage.request.val, level: 1, appConfig},
 		);
 	}
 
@@ -131,7 +132,7 @@ function getErrorMessage({response, jsonMessage, verbosity, snippets}) {
 		return commandErrors[response.errorType]();
 	}
 
-	return chainUtils.translateLineResult(jsonMessage, verbosity, response);
+	return chainUtils.translateLineResult(jsonMessage, verbosity, response, appConfig);
 }
 
 /**

package/lib/validation/elementPropTypes.js

@@ -33,6 +33,7 @@ const ELEMENT_PROP_TYPES = {
 	[ELEMENT_PROP.HINT]: 'string',
 	[ELEMENT_PROP.HREF]: 'string',
 	[ELEMENT_PROP.ID]: 'string',
+	[ELEMENT_PROP.IS_ACCESSIBLE]: 'boolean',
 	[ELEMENT_PROP.IS_CHECKED]: 'boolean',
 	[ELEMENT_PROP.IS_CHECKED_ANDROID_OTTIUM]: 'boolean',
 	[ELEMENT_PROP.IS_CLICKABLE]: 'boolean',
@@ -46,6 +47,7 @@ const ELEMENT_PROP_TYPES = {
 	[ELEMENT_PROP.IS_SELECTED_ANDROID_OTTIUM]: 'boolean',
 	[ELEMENT_PROP.IS_TOUCHABLE]: 'boolean',
 	[ELEMENT_PROP.IMAGE]: 'string',
+	[ELEMENT_PROP.LABEL]: 'string',
 	[ELEMENT_PROP.LEFT]: 'number',
 	[ELEMENT_PROP.MARGIN]: 'string',
 	[ELEMENT_PROP.NAME]: 'string',
@@ -106,6 +108,8 @@ const ELEMENT_PROP_TYPES = {
 	[ELEMENT_PROP.IS_LONG_CLICKABLE_ANDROID_OTTIUM]: 'boolean',
 	[ELEMENT_PROP.IS_SCROLLABLE_ANDROID_OTTIUM]: 'boolean',
 	[ELEMENT_PROP.BOUNDS]: 'string',
+	[ELEMENT_PROP.CLASS_CHAIN]: 'string',
+	[ELEMENT_PROP.PREDICATE_STRING]: 'string',
 	[ELEMENT_PROP.ROLE]: 'string',
 	[ELEMENT_PROP.DESCRIPTION]: 'string',
 	[ELEMENT_PROP.ORIENTATION_TEXT]: 'string',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "4.2.3",
+  "version": "4.3.0",
   "main": "index.js",
   "repository": "github:SuitestAutomation/suitest-js-api",
   "author": "Suitest <hello@suite.st>",
@@ -88,7 +88,6 @@
     "eslint": "^7.1.0",
     "husky": "^4.2.5",
     "mocha": "^11.7.6",
-    "mock-fs": "^5.1.0",
     "mock-require": "^3.0.3",
     "mock-socket": "^7.1.0",
     "mock-spawn": "^0.2.6",
@@ -100,7 +99,7 @@
   "dependencies": {
     "@sentry/node": "^7.120.3",
     "@suitest/smst-to-text": "^4.32.0",
-    "@suitest/translate": "^4.32.0",
+    "@suitest/translate": "^4.34.0",
     "@types/node": "^14.0.10",
     "ajv": "^6.14.0",
     "ansi-regex": "^5.0.0",

package/typeDefinition/constants/Element.d.ts

@@ -28,6 +28,7 @@ export type ElementPropTypes = {
 	HINT: 'hint',
 	HREF: 'href',
 	ID: 'id',
+	IS_ACCESSIBLE: 'isAccessible',
 	IS_CHECKED: 'isChecked',
 	IS_CHECKED_ANDROID_OTTIUM: 'checked',
 	IS_CLICKABLE: 'isClickable',
@@ -42,6 +43,7 @@ export type ElementPropTypes = {
 	IS_TOUCHABLE: 'isTouchable',
 	IMAGE: 'image',
 	ITEM_FOCUSED:'itemFocused',
+	LABEL: 'label',
 	LEFT: 'left',
 	MARGIN:'margin',
 	NAME: 'name',
@@ -100,6 +102,8 @@ export type ElementPropTypes = {
 	IS_LONG_CLICKABLE_ANDROID_OTTIUM: 'long-clickable',
 	IS_SCROLLABLE_ANDROID_OTTIUM: 'scrollable',
 	BOUNDS: 'bounds',
+	CLASS_CHAIN: 'classChain',
+	PREDICATE_STRING: 'predicateString',
 	ROLE: 'role',
 	DESCRIPTION: 'description',
 	ORIENTATION_TEXT: 'orientationText',

package/typeDefinition/constants/ElementProps.d.ts

@@ -81,6 +81,8 @@ export type ElementProps = {
 	extends:                 string,
 	uiElementId:             string,
 	index:                   number,
+	isAccessible:            boolean,
+	label:                   string,
 }
 
 export type PlayStationVideoProps = Pick<ElementProps, 'videoLength' | 'videoPos' | 'videoState' | 'videoUrl'>