Boolean highlightOnAction (#2584)

getgauge · May 27, 2022 · 9b59e2e · 9b59e2e
1 parent 359720d
commit 9b59e2e
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 11 deletions.
diff --git a/lib/config.js b/lib/config.js
@@ -18,8 +18,12 @@ const defaultConfig = {
   highlightOnAction:
     process.env.TAIKO_BROWSER_PATH &&
     process.env.TAIKO_BROWSER_PATH.toLowerCase().includes('firefox')
-      ? 'false'
-      : process.env.TAIKO_HIGHLIGHT_ON_ACTION || 'true',
+      ? false
+      :
+        (process.env.TAIKO_HIGHLIGHT_ON_ACTION
+          ? (process.env.TAIKO_HIGHLIGHT_ON_ACTION.toLowerCase() === 'true')
+          : true
+        ),
   blockAlignment: 'nearest',
   inlineAlignment: 'nearest',
   useHostName: false,

diff --git a/lib/elements/elementHelper.js b/lib/elements/elementHelper.js
@@ -5,7 +5,7 @@ const { wait } = require('../helper');
 
 const highlightElement = async (element) => {
   // Adding a wait as tests fail on newer versions of chrome
-  if (defaultConfig.highlightOnAction.toLowerCase() !== 'true') {
+  if (!defaultConfig.highlightOnAction) {
     await wait(1000);
     return
   }

diff --git a/lib/taiko.js b/lib/taiko.js
@@ -2520,7 +2520,7 @@ module.exports.getConfig = getConfig;
  * 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint', 'targetNavigated']
  * @param {boolean} [options.ignoreSSLErrors = true ] Option to ignore SSL errors encountered by the browser.
  * @param {boolean} [options.headful = false ] Option to open browser in headless/headful mode.
- * @param {string} [options.highlightOnAction = 'false' ] Option to highlight an element on action.
+ * @param {boolean} [options.highlightOnAction = false ] Option to highlight an element on action.
  */
 module.exports.setConfig = setConfig;
 

diff --git a/test/unit-tests/config.test.js b/test/unit-tests/config.test.js
@@ -28,7 +28,7 @@ describe('Config tests', () => {
         it('should update the config', () => {
           const newConfig = {
             headful: false,
-            highlightOnAction: 'true',
+            highlightOnAction: true,
             firefox: false,
             ignoreSSLErrors: true,
             navigationTimeout: 2,
@@ -238,7 +238,7 @@ describe('Config tests', () => {
       };
       const expectedConfig = {
         headful: true,
-        highlightOnAction: 'true',
+        highlightOnAction: true,
         ignoreSSLErrors: true,
         firefox: false,
         navigationTimeout: 30000,

diff --git a/test/unit-tests/elements/elementHelper.test.js b/test/unit-tests/elements/elementHelper.test.js
@@ -47,7 +47,7 @@ describe('elementHelper', () => {
     });
     actualConsole = console;
     elemHelper.__set__('console', { warn: (warning) => (warningMessage = warning) });
-    setConfig({ highlightOnAction: 'true' });
+    setConfig({ highlightOnAction: true });
   });
 
   afterEach(() => {
@@ -76,7 +76,7 @@ describe('elementHelper', () => {
   });
 
   it('should not highlight when highlightOnAction is false', async () => {
-    setConfig({ highlightOnAction: 'false' });
+    setConfig({ highlightOnAction: false });
     await elemHelper.highlightElement(createElement(20, true));
 
     expect(getBoxModelCalled).to.be.false;

diff --git a/test/unit-tests/test-util.js b/test/unit-tests/test-util.js
@@ -52,6 +52,6 @@ module.exports.resetConfig = () => {
     waitForNavigation: true,
     ignoreSSLErrors: true,
     headful: false,
-    highlightOnAction: 'true',
+    highlightOnAction: true,
   });
 };
diff --git a/types/taiko/index.d.ts b/types/taiko/index.d.ts
@@ -73,7 +73,7 @@ export interface GlobalConfigurationOptions {
   headful?: boolean;
   criConnectionRetries?: number;
   firefox?: boolean;
-  highlightOnAction?: 'true' | 'false';
+  highlightOnAction?: boolean;
   local?: boolean;
 }
 

diff --git a/types/taiko/test/helpers.ts b/types/taiko/test/helpers.ts
@@ -119,7 +119,7 @@ setConfig({
   waitForNavigation: true,
   ignoreSSLErrors: true,
   headful: false,
-  highlightOnAction: 'false',
+  highlightOnAction: false,
 });
 setConfig({});
 setConfig({ other: true }); // $ExpectError