Fix some vulnerabilities and other enhancements (#2663)

Author: marques-work

.eslintignore

@@ -0,0 +1 @@
+**/*.d.ts

.github/workflows/taiko.yml

@@ -35,9 +35,14 @@ jobs:
             libcups2 \
             libxrandr2 \
             libpangocairo-1.0-0 \
-            libgtk-3-0
+            libgtk-3-0 \
+            libdrm-dev \
+            libgbm-dev \
+            libasound-dev
       - name: unit-tests
-        run: npm test
+        run: |
+          npm run lint:check
+          npm test
 
   functional-tests:
     needs: unit-tests
@@ -65,7 +70,10 @@ jobs:
             libcups2 \
             libxrandr2 \
             libpangocairo-1.0-0 \
-            libgtk-3-0
+            libgtk-3-0 \
+            libdrm-dev \
+            libgbm-dev \
+            libasound-dev
       - name: functional-tests
         run: npm run test-functional
 
@@ -104,7 +112,10 @@ jobs:
               libcups2 \
               libxrandr2 \
               libpangocairo-1.0-0 \
-              libgtk-3-0    
+              libgtk-3-0 \
+              libdrm-dev \
+              libgbm-dev \
+              libasound-dev   
       - name: install xvfb
         run: sudo apt install xvfb
       - name: functional-tests-headful
@@ -152,7 +163,10 @@ jobs:
             libcups2 \
             libxrandr2 \
             libpangocairo-1.0-0 \
-            libgtk-3-0
+            libgtk-3-0 \
+            libdrm-dev \
+            libgbm-dev \
+            libasound-dev
       - name: test-docs
         run: npm run test-docs
       - name: Upload html report

.tool-versions

@@ -0,0 +1 @@
+nodejs 16.18.1

lib/actions/scrollTo.js

@@ -6,17 +6,17 @@ const { doActionAwaitingNavigation } = require('../doActionAwaitingNavigation');
 
 const scrollToElement = async (element, options = {}) => {
   options = setScrollOptions(options);
-  
+
   function scrollToNode(opt) {
     const element = this.nodeType === Node.TEXT_NODE ? this.parentElement : this;
     element.scrollIntoView({ block: opt.blockAlignment, inline: opt.inlineAlignment });
     return 'result';
   }
-  await runtimeHandler.runtimeCallFunctionOn(scrollToNode, null, { 
+  await runtimeHandler.runtimeCallFunctionOn(scrollToNode, null, {
     objectId: element.get(),
     arg: {
       blockAlignment: options.blockAlignment,
-      inlineAlignment: options.inlineAlignment
+      inlineAlignment: options.inlineAlignment,
     },
   });
 };

lib/browserLauncher.js

@@ -17,10 +17,10 @@ function updateArgsFromOptions(args, options) {
   args = options.args ? args.concat(options.args) : args;
   args = process.env.TAIKO_BROWSER_ARGS
     ? args.concat(
-      process.env.TAIKO_BROWSER_ARGS.split(/\s*,?\s*--/)
-        .filter((arg) => arg !== '')
-        .map((arg) => `--${arg}`),
-    )
+        process.env.TAIKO_BROWSER_ARGS.split(/\s*,?\s*--/)
+          .filter((arg) => arg !== '')
+          .map((arg) => `--${arg}`),
+      )
     : args;
   return args;
 }
@@ -366,7 +366,7 @@ const closeBrowser = async () => {
   if (temporaryUserDataDir) {
     try {
       fs.removeSync(temporaryUserDataDir);
-    } catch (e) { }
+    } catch (e) {}
   }
 };
 

lib/config.js

@@ -98,7 +98,7 @@ const setClickOptions = (options, x, y) => {
 
 const setScrollOptions = (options) => {
   options.blockAlignment = options.blockAlignment || defaultConfig.blockAlignment;
-  options.inlineAlignment = options.inlineAlignment ||defaultConfig.inlineAlignment;
+  options.inlineAlignment = options.inlineAlignment || defaultConfig.inlineAlignment;
   return options;
 };
 

lib/data/devices.js

@@ -523,54 +523,6 @@ let DEVICES = {
       isLandscape: true,
     },
   },
-  'iPhone 11': {
-    userAgent:
-      'Mozilla/5.0 (iPhone; CPU iPhone OS 15_3_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1',
-    viewport: {
-      width: 414,
-      height: 896,
-      deviceScaleFactor: 2,
-      isMobile: true,
-      hasTouch: true,
-      isLandscape: false,
-    },
-  },
-  'iPhone 11 landscape': {
-    userAgent:
-      'Mozilla/5.0 (iPhone; CPU iPhone OS 15_3_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1',
-    viewport: {
-      width: 896,
-      height: 414,
-      deviceScaleFactor: 2,
-      isMobile: true,
-      hasTouch: true,
-      isLandscape: true,
-    },
-  },
-  'iPhone 11 Pro': {
-    userAgent:
-      'Mozilla/5.0 (iPhone; CPU iPhone OS 15_3_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1',
-    viewport: {
-      width: 375,
-      height: 812,
-      deviceScaleFactor: 3,
-      isMobile: true,
-      hasTouch: true,
-      isLandscape: false,
-    },
-  },
-  'iPhone 11 Pro landscape': {
-    userAgent:
-      'Mozilla/5.0 (iPhone; CPU iPhone OS 15_3_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1',
-    viewport: {
-      width: 812,
-      height: 375,
-      deviceScaleFactor: 3,
-      isMobile: true,
-      hasTouch: true,
-      isLandscape: true,
-    },
-  },
   'Kindle Fire HDX': {
     userAgent:
       'Mozilla/5.0 (Linux; U; en-us; KFAPWI Build/JDQ39) AppleWebKit/535.19 (KHTML, like Gecko) Silk/3.13 Safari/535.19 Silk-Accelerated=true',

lib/documentation.js

@@ -1,14 +1,18 @@
-const documentation = require('documentation');
 const fs = require('fs');
 
 const jsDocToJson = async (sourceFiles, outputFile) => {
-  documentation
-    .build(sourceFiles, { shallow: true })
-    .then(documentation.formats.json)
-    .then((output) => {
-      // output is a string of JSON data
-      fs.writeFileSync(outputFile, output);
-    });
+  try {
+    const documentation = await import('documentation');
+    documentation
+      .build(sourceFiles, { shallow: true })
+      .then(documentation.formats.json)
+      .then((output) => {
+        // output is a string of JSON data
+        fs.writeFileSync(outputFile, output);
+      });
+  } catch (error) {
+    console.error('Failed to load `documentation`:', error);
+  }
 };
 
 module.exports.jsDocToJson = jsDocToJson;

lib/elements/elementHelper.js

@@ -7,7 +7,7 @@ const highlightElement = async (element) => {
   // Adding a wait as tests fail on newer versions of chrome
   if (!defaultConfig.highlightOnAction) {
     await wait(1000);
-    return
+    return;
   }
 
   if (await element.isVisible()) {

lib/repl/repl.js

@@ -112,8 +112,7 @@ function initCommands(taiko, repl, previousSessionFile) {
     },
   });
   repl.defineCommand('step', {
-    help:
-      'Generate gauge steps from recorded script. (openBrowser and closeBrowser are not recorded as part of step)',
+    help: 'Generate gauge steps from recorded script. (openBrowser and closeBrowser are not recorded as part of step)',
     action(file) {
       if (!file) {
         console.log(step());