suitest-js-api 3.0.0 → 3.1.0

package/index.d.ts

@@ -53,6 +53,7 @@ declare namespace suitest {
 		pairDevice(deviceId: string): Promise<DeviceData|SuitestError>;
 		releaseDevice(): Promise<void|SuitestError>;
 		startREPL(options?: ReplOptions): Promise<void>;
+		getAppConfig(): Promise<AppConfiguration|SuitestError>;
 
 		// config
 		getConfig(): ConfigureOptions;
@@ -268,6 +269,14 @@ declare namespace suitest {
 		accessToken: string;
 	}
 
+	interface AppConfiguration {
+		name: string;
+		url: string;
+		suitestify: boolean;
+		domainList: string[];
+		variables: Record<string, string>;
+	}
+
 	interface ConfigureOptions {
 		logLevel: 'silent'|'normal'|'verbose'|'debug'|'silly';
 		disallowCrashReports: boolean;

package/lib/api/wsContentTypes.js

@@ -11,6 +11,7 @@ const contentTypes = {
 	eval: 'eval',
 	testLine: 'testLine',
 	takeScreenshot: 'takeScreenshot',
+	getConfiguration: 'getConfiguration',
 };
 
 Object.freeze(contentTypes);

package/lib/commands/getAppConfig.js

@@ -0,0 +1,23 @@
+const wsContentTypes = require('../api/wsContentTypes');
+const chainPromise = require('../utils/chainPromise');
+const {getAppConfigError} = require('../texts');
+const SuitestError = require('../utils/SuitestError');
+
+async function getAppConfig({appContext, authContext, webSockets}) {
+	const authedContent = await authContext.authorizeWs({
+		type: wsContentTypes.getConfiguration,
+		configId: appContext._context.configId,
+	}, getAppConfig.name);
+
+	const response = await webSockets.send(authedContent);
+
+	if (response.result === 'error') {
+		throw new SuitestError(getAppConfigError());
+	}
+
+	return response.configuration;
+}
+
+module.exports = {
+	getAppConfig: chainPromise(getAppConfig),
+};

package/lib/constants/timestamp.js

@@ -3,7 +3,7 @@
  */
 
 const timestamp = {
-	default: 'MMM D HH:mm:ss',
+	default: 'MMM D HH:mm:ss Z',
 	none: 'none',
 };
 

package/lib/constants/vrc.js

@@ -36,6 +36,8 @@ const vrcConstants = {
 	NUM_7:                   '7',
 	NUM_8:                   '8',
 	NUM_9:                   '9',
+	NEXT:                    'NEXT',
+	PREVIOUS:                'PREVIOUS',
 	FAST_FWD:                'FAST_FWD',
 	REWIND:                  'REWIND',
 	STOP:                    'STOP',

package/lib/testLauncher/processArgs.js

@@ -3,7 +3,7 @@ const parser = require('yargs-parser');
 // Specify which options should be treated as boolen.
 // This will enable setting boolean option value to true if not defined explicitly,
 // eg: '--disallow-crash-reports' will be parsed as '--disallow-crash-reports=true'
-const booleanOpts = ['disallow-crash-reports'];
+const booleanOpts = ['disallow-crash-reports', 'include-changelist'];
 const inspectOpts = ['inspect', 'inspect-brk'];
 
 const parseOptions = argv => {

package/lib/texts.js

@@ -144,6 +144,11 @@ ${leaves}`,
 	'errorType.specifyRunningDevices': () => 'Please specify Configuration id and device id, or presets',
 	'errorType.notFoundPresets': (notFoundPresets) => `Presets ${notFoundPresets.join(', ')} were not found in your configuration`,
 
+	'commandError.notSupportedPlatform': () => 'Screenshots are not supported on this device.',
+	'commandError.timeout': () => 'Failed to take a screenshot due to timeout.',
+	'commandError.generalError': () => 'Failed to take a screenshot.',
+	'commandError.notSupportedDriver': () => 'Screenshots are not supported on this driver.',
+
 	executorStopped: () => 'Test execution was stopped. See our documentation for possible reasons: https://suite.st/docs/error-messages/results-errors/#test-execution-was-stopped',
 
 	executionAborted: () => 'Test execution was aborted.',
@@ -166,6 +171,7 @@ ${leaves}`,
 	usingAppConfig: (id) => `Setting app configuration id: ${id}`,
 	usedAppConfig: (id) => `Will use app configuration id: ${id}`,
 	useAppConfigOverrides: () => 'Will apply configuration overrides',
+	getAppConfigError: () => 'getAppConfig was called before configId initialization',
 
 	disconnectedFromDevice: () => 'Disconnected from device',
 	disconnectingFromDevice: () => 'Disconnecting from device',

package/lib/utils/AuthContext.js

@@ -37,7 +37,7 @@ const tokenAllowed = {
 		wsContentTypes.pairDevice, wsContentTypes.releaseDevice,
 		wsContentTypes.selectConfiguration, wsContentTypes.query,
 		wsContentTypes.eval, wsContentTypes.testLine,
-		wsContentTypes.takeScreenshot,
+		wsContentTypes.takeScreenshot, wsContentTypes.getConfiguration,
 	],
 };
 

package/lib/utils/socketErrorMessages.js

@@ -1,6 +1,6 @@
 /* eslint-disable max-len */
 const {EOL} = require('os');
-const {path} = require('ramda');
+const {path, has} = require('ramda');
 
 const t = require('../texts');
 const chainUtils = require('./chainUtils');
@@ -94,6 +94,22 @@ const getSnippetLogs = ({testId, definitions, results, level, verbosity}, transl
 	}, []).filter(Boolean).join('\n');
 };
 
+const commandErrors = {
+	'notSupportedPlatform': () => t['commandError.notSupportedPlatform'](),
+	'timeout': () => t['commandError.timeout'](),
+	'generalError': () => t['commandError.generalError'](),
+	'notSupportedDriver': () => t['commandError.notSupportedDriver'](),
+};
+
+/**
+ * @description check that response error is related to "command" (not "line") execution.
+ * For now it is related only for taking screenshots
+ * @param response
+ */
+function isCommandError(response) {
+	return response.result === 'error' && has(response.errorType, commandErrors);
+}
+
 /**
  * @description Create human readable error message from suitest error response
  * @param verbosity
@@ -109,6 +125,10 @@ function getErrorMessage({response, jsonMessage, verbosity, snippets}) {
 		);
 	}
 
+	if (isCommandError(response)) {
+		return commandErrors[response.errorType]();
+	}
+
 	return chainUtils.translateLineResult(jsonMessage, verbosity, response);
 }
 

package/package.json

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

package/suitest.js

@@ -7,6 +7,7 @@ const {closeSession} = require('./lib/commands/closeSession');
 const {pairDevice} = require('./lib/commands/pairDevice');
 const releaseDevice = require('./lib/commands/releaseDevice');
 const {setAppConfig} = require('./lib/commands/setAppConfig');
+const {getAppConfig} = require('./lib/commands/getAppConfig');
 
 // Chains
 const openAppFactory = require('./lib/chains/openAppChain');
@@ -98,6 +99,7 @@ class SUITEST_API extends EventEmitter {
 		this.setAppConfig = (...args) => setAppConfig(this, ...args);
 		this.closeSession = (...args) => closeSession(this, ...args);
 		this.releaseDevice = (...args) => releaseDevice(this, ...args);
+		this.getAppConfig = (...args) => getAppConfig(this, ...args);
 
 		const {openApp, openAppAssert} = openAppFactory(this);
 		const {closeApp, closeAppAssert} = closeAppFactory(this);

package/typeDefinition/constants/Vrc.d.ts

@@ -20,6 +20,8 @@ export type VrcConstants = {
 	NUM_7:                   '7',
 	NUM_8:                   '8',
 	NUM_9:                   '9',
+	NEXT:                    'NEXT',
+	PREVIOUS:                'PREVIOUS',
 	FAST_FWD:                'FAST_FWD',
 	REWIND:                  'REWIND',
 	STOP:                    'STOP',