feat: adding deprecated warning for the old log level names

detox/local-cli/detox-run-server.js

@@ -6,12 +6,14 @@ const logger = require('../src/utils/logger');
 
 program
   .name('detox run-server')
-  .description('Starts a standalone Detox server')
+  .description('Start a standalone Detox server')
   .option(
     '-p, --port [port]',
     'Port number',
     '8099'
   )
+  .option('-l, --loglevel [value]',
+    'Log level: fatal, error, warn, info, debug, trace', 'info')
   .option(
     '--no-color',
     'Disable colorful logs',

detox/src/utils/logger.js

@@ -18,15 +18,26 @@ function adaptOlderLogLevelName(level) {
     case 'verbose':
       return 'debug';
 
-    case 'wss':
     case 'silly':
+    case 'wss':
       return 'trace';
 
     default:
       return 'info';
   }
 }
 
+function isLogLevelNameDeprecated(level) {
+  switch (level) {
+    case 'verbose':
+    case 'silly':
+    case 'wss':
+      return true;
+    default:
+      return false;
+  }
+}
+
 function createPlainBunyanStream({ logPath, level }) {
   const options = {
     showDate: false,
@@ -63,7 +74,8 @@ function createPlainBunyanStream({ logPath, level }) {
 }
 
 function init() {
-  const level = adaptOlderLogLevelName(argparse.getArgValue('loglevel'));
+  const levelFromArg = argparse.getArgValue('loglevel');
+  const level = adaptOlderLogLevelName(levelFromArg);
   const logBaseFilename = path.join(argparse.getArgValue('artifacts-location') || '', `detox_pid_${process.pid}`);
   const shouldRecordLogs = ['failing', 'all'].indexOf(argparse.getArgValue('record-logs')) >= 0;
 
@@ -86,10 +98,16 @@ function init() {
     }));
   }
 
-  return bunyan.createLogger({
+  const logger = bunyan.createLogger({
     name: 'detox',
     streams: bunyanStreams,
   });
+
+  if (isLogLevelNameDeprecated(levelFromArg)) {
+    logger.warn(`--loglevel ${levelFromArg} is deprecated and will be removed in detox@9.0.0, use --loglevel ${level} instead`);
+  }
+
+  return logger;
 }
 
 module.exports = init();

docs/APIRef.DetoxCLI.md

@@ -46,7 +46,8 @@ Initiating your test suite
 | ---                                           | --- |
 | -h, --help                                    | output usage information |
 | -o, --runner-config \<config\>                | Test runner config file, defaults to 'e2e/mocha.opts' for mocha and 'e2e/config.json' for jest |
-| -l, --loglevel [value]                        | info, debug, verbose, silly, wss |
+| -l, --loglevel [value]                        | Log level: fatal, error, warn, info, debug, trace |
+| --no-color                                    | Disable colors in log output |
 | -c, -configuration \<device config\>          | Select a device configuration from your defined configurations,if not supplied, and there's only one configuration, detox will default to it |
 | -r, --reuse                                   | Reuse existing installed app (do not delete and re-tall) for a faster run. |
 | -u, --cleanup                                 | Shutdown simulator when test is over, useful for CI ipts, to make sure detox exists cleanly with no residue |
@@ -55,12 +56,11 @@ Initiating your test suite
 | --record-logs [failing/all/none]              | Save logs during each test to artifacts directory. Pass "failing" to save logs of failing tests only. The default value is **none**. |
 | --take-screenshots [failing/all/none]         | Save screenshots before and after each test to artifacts directory. Pass "failing" to save screenshots of failing tests only. The default value is **none**. |
 | --record-videos [failing/all/none]            | Save screen recordings of each test to artifacts directory. Pass "failing" to save recordings of failing tests only. The default value is **none**. |
-| -p, --platform [ios/android]		            | Run platform specific tests. Runs tests with invert grep on `:platform:`, e.g test with substring `:ios:` in its name will not run when passing `--platform android` |
+| -p, --platform [ios/android]                  | Run platform specific tests. Runs tests with invert grep on `:platform:`, e.g test with substring `:ios:` in its name will not run when passing `--platform android` |
 | -H, --headless                                | [Android Only] Launch Emulator in headless mode. Useful when running on CI. |
 | -w, --workers                                 | [iOS Only] Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest) |
-|&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;||
-
 
+> NOTE: such log levels as `verbose`, `silly`, `wss` are deprecated since detox@8.1.0 and will be removed in 9.0.0.
 
 ### build
 Run a command defined in 'configuration.build'
@@ -71,20 +71,23 @@ Run a command defined in 'configuration.build'
 | --- | --- |
 | -h, --help                            |  output usage information |
 | -c, --configuration \<device config\> |  Select a device configuration from your defined configurations,if not supplied, and there's only one configuration, detox will default to it |
-|&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;&#8195;||
 
 
 ### run-server
-Start a standalone detox server
+
+Start a standalone Detox server
 
 `detox run-server [options]`
 
-| Option | Description |
+| Option                 | Description                                       |
 | --- | --- |
-| -h, --help |  output usage information |
-
+| -p, --port [port]      | Port number (default: 8099)                       |
+| -l, --loglevel [value] | Log level: fatal, error, warn, info, debug, trace |
+| --no-color             | Disable colorful logs                             |
+| -h, --help             | output usage information                          |
 
 ### init
+
 Scaffolds initial E2E test folder structure for a specific test runner
 
 `detox init -r <test-runner-name>`

docs/More.AndroidSupportStatus.md

@@ -81,7 +81,7 @@ Type 'android.attached' could be used to connect to any of already attached devi
 3. Location - Coming soon
 
 ## Debugging
-1. `--loglevel verbose` can give you pretty good insight on what going on.
+1. `--loglevel trace` can give you pretty good insight on what going on.
 2. `--debug-synchronization [ms]`, our tool to identify synchronization issues works on Android too.
 
 ## Cross platform support

docs/Troubleshooting.Flakiness.md

@@ -17,20 +17,20 @@ Assume you have a suite of 100 tests and each test is flaky in 0.5% of execution
 
 It's important to identify the various sources of flakiness in Detox tests.
 
-* Control of the device / simulator - in order to run your tests, Detox must communicate with a simulator and instruct it to install the app, restart it, etc. Simulators don't always behave and controlling them might occasionally fail.<br> Detox's underlying simulator control is [`AppleSimulatorUtils`](https://github.com/wix/AppleSimulatorUtils), it is a tool that supports both basic and advanced simulator and device interaction options, it uses some core simulator features which are not always stable and may need time to "warm up" (booting, shutting down, etc.). Detox is set to have a few retries on any of these actions before failing. It will also print all the `exec` commands when using verbose log level.
+* Control of the device / simulator - in order to run your tests, Detox must communicate with a simulator and instruct it to install the app, restart it, etc. Simulators don't always behave and controlling them might occasionally fail.<br> Detox's underlying simulator control is [`AppleSimulatorUtils`](https://github.com/wix/AppleSimulatorUtils), it is a tool that supports both basic and advanced simulator and device interaction options, it uses some core simulator features which are not always stable and may need time to "warm up" (booting, shutting down, etc.). Detox is set to have a few retries on any of these actions before failing. It will also print all the `exec` commands when using `debug` log level, and with `trace` level it will print everything.
 
 * Asynchronous operations inside your app - every time an E2E test runs, operations might take place in a different order inside your app. This makes E2E tests nondeterministic. Consider an HTTP request made to a server, this request may take a variable time to complete due to external concerns like network congestion and server load.<br>Detox takes this into account by monitoring all asynchronous operations that take place in your app from the inside. Detox knows which network requests are currently in-flight. Detox knows how busy the React Native bridge is. Tests are automatically synchronized to the app and only move forward when the app is idle.
 
 ### 3. Get More Data About the Problem
 
 In order to identify the source of flakiness you're suffering from you need more data. If you catch a failing test that should be passing, you need to record as much information as possible in order to investigate.
 
-* Enable verbose mode in Detox. This will output a lot of information about what happening during the test.<br>
+* Enable `trace` mode in Detox. This will output a lot of information about what happening during the test.<br>
 	1. `exec` commands
 	2. All communication going over the websocket, both from tester and testee
 
-To enable verbose mode run your tests in verbose log mode:
+To enable `trace` mode run your tests in trace log mode:
 
 ```sh
-detox test --loglevel verbose
+detox test --loglevel trace
 ```

docs/Troubleshooting.RunningTests.md

@@ -2,7 +2,7 @@
 id: Troubleshooting.RunningTests
 title: Failing Tests
 ---
-* [Enable verbose mode](#enable-verbose-mode)
+* [Enable trace mode](#enable-trace-mode)
 * [Syntax Error: Unxpected Token](#syntax-error-unxpected-token)
 * [Can't find my component even though I added testID to its props](#cant-find-my-component-even-though-i-added-testid-to-its-props)
 * [Test tries to find my component before it's created](#test-tries-to-find-my-component-before-its-created)
@@ -15,12 +15,12 @@ title: Failing Tests
 
 <br>
 
-### Enable verbose mode
+### Enable trace mode
 
-It's a good idea to get as much information as possible about what's going on. We can enable verbose mode during tests by running our tests with:
+It's a good idea to get as much information as possible about what's going on. We can enable trace mode during tests by running our tests with:
 
 ```
-detox test --loglevel verbose
+detox test --loglevel trace
 ```
 
 
@@ -210,7 +210,7 @@ Include the following information in your issue to increase the chances of resol
 
 1. Versions of all dependencies - iOS version you're working on, simulator model, React Native version, Detox version, etc
 
-2. The verbose log of the test (see above)
+2. The trace log of the test (see above)
 
 3. Source code of your test scenario