refactored code base to match that of react plugin

Author: gravityvi

.eslintrc

@@ -0,0 +1,121 @@
+{
+  "extends": [
+    "eslint:recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": false
+    }
+  },
+  "env": {
+    "mocha": true,
+    "node": true
+  },
+  "rules": {
+    "eqeqeq": [
+      "error",
+      "smart"
+    ],
+    "no-extra-boolean-cast": 0,
+    "quotes": [
+      "error",
+      "single"
+    ],
+    "curly": [
+      "error",
+      "all"
+    ],
+    "no-console": [
+      "error",
+      {
+        "allow": [
+          "error"
+        ]
+      }
+    ],
+    "no-debugger": 1,
+    "semi": [
+      "error",
+      "always",
+      {
+        "omitLastInOneLineBlock": true
+      }
+    ],
+    "no-trailing-spaces": 0,
+    "no-else-return": 2,
+    "no-extra-bind": 0,
+    "no-implicit-coercion": 0,
+    "no-useless-call": 0,
+    "no-return-assign": 0,
+    "eol-last": 0,
+    "no-unused-vars": 0,
+    "no-extra-semi": 0,
+    "comma-dangle": 2,
+    "no-underscore-dangle": 0,
+    "no-lone-blocks": 0,
+    "array-bracket-spacing": 2,
+    "object-curly-spacing": 2,
+    "brace-style": [
+      2,
+      "1tbs",
+      {
+        "allowSingleLine": true
+      }
+    ],
+    "comma-spacing": 2,
+    "comma-style": 2,
+    "key-spacing": 2,
+    "one-var": [
+      "error",
+      "never"
+    ],
+    "semi-style": [
+      "error",
+      "last"
+    ],
+    "space-in-parens": [
+      "error",
+      "never"
+    ],
+    "keyword-spacing": [
+      2,
+      {
+        "before": true,
+        "after": true
+      }
+    ],
+    "padding-line-between-statements": [
+      "error",
+      {
+        "blankLine": "always",
+        "prev": "*",
+        "next": "return"
+      }
+    ],
+    "indent": [
+      "error",
+      2,
+      {
+        "SwitchCase": 1
+      }
+    ],
+    "prefer-const": [
+      "warn"
+    ]
+  },
+  "globals": {
+    "Promise": true,
+    "Proxy": true,
+    "Set": true,
+    "Reflect": true,
+    "document": "readonly",
+    "window": "readonly",
+    "element": "readonly",
+    "by": "readonly",
+    "expect": "readonly",
+    "browser": "readonly",
+    "Key": "readonly"
+  }
+}

index.js

@@ -6,4 +6,4 @@ module.exports = {
   setup,
   teardown,
   vite
-}
+};

lib/setup.js

@@ -1,22 +1,71 @@
 const path = require('path');
+const fs = require('fs');
+const vite = require('./vite.js');
+const getPort = require('get-port');
 
 const vite_dev_server = {
-  port: 5174
+  port: process.argv.includes('--test-worker') ? null : 5173
 };
 try {
   const nightwatch_config = require(path.resolve('./nightwatch.conf.js'));
   Object.assign(vite_dev_server, nightwatch_config.vite_dev_server || {});
-} catch (err) {}
+} catch (err) {
+  //
+}
 
-const vite = require('./vite.js');
 
-module.exports = async function({viteConfigFile = null} = {}) {
-  const viteServer = await vite.start({
-    configFile: viteConfigFile,
+const projectJsConfigFile = path.join(process.cwd(), 'vite.config.js');
+const projectTsConfigFile = path.join(process.cwd(), 'vite.config.ts');
+
+const hasProjectJsConfigFile = () => {
+  try {
+    if (fs.statSync(projectJsConfigFile).isFile()) {
+      return projectJsConfigFile;
+    }
+  } catch (err) {
+    if (fs.statSync(projectTsConfigFile).isFile()) {
+      return projectTsConfigFile;
+    }
+
+    return false;
+  }
+};
+
+module.exports = async function() {
+  const viteConfig = {
     port: vite_dev_server.port
-  });
+  };
+  
+  if (!viteConfig.port) {
+    viteConfig.port = await getPort();
+  }
+  const projectConfigFile = hasProjectJsConfigFile();
+  viteConfig.configFile = projectConfigFile ? projectConfigFile : path.join(__dirname, '../vite.config.js');
+  
+  const viteServer = await vite.start(viteConfig);
+  const nightwatchPlugin = viteServer.middlewares.stack.find(item => item.route === '/_nightwatch');
+
+  if (!nightwatchPlugin) {
+    const error = new Error('Missing vite-plugin-nightwatch in '+ projectConfigFile);
+    const code = `:
+    
+    import nightwatchPlugin from 'vite-plugin-nightwatch'
 
+    export default {
+      plugins: [
+        // ... other plugins
+        nightwatchPlugin({
+          componentType: 'vue'
+        })
+      ]
+    };
+    `;
+    error.help = ['Please ensure that "vite-nightwatch-plugin" is loaded in your Vite config file ' + code];
+    throw error;
+  } 
   global.viteServer = viteServer;
 
   return viteServer;
-}
+};
+
+  

lib/teardown.js

@@ -2,4 +2,4 @@ module.exports = async function() {
   if (global.viteServer) {
     await global.viteServer.close();
   }
-}
+};

nightwatch.conf.js

@@ -14,7 +14,7 @@ module.exports = {
 
 
   // See https://nightwatchjs.org/guide/#external-globals
-  globals_path : 'test/globals.js',
+  globals_path: 'test/globals.js',
 
   webdriver: {},
 

nightwatch/globals.js

@@ -1,35 +1,110 @@
-const fs = require('fs');
-const path = require('path');
-
+const http = require('../lib/setup.js');
 const setup = require('../lib/setup.js');
 
 let viteServer;
-const projectConfigFile = path.join(process.cwd(), 'vite.config.js');
-const viteConfigFile = path.join(__dirname, '../vite.config.js');
-
-const hasProjectConfigFile = () => {
-  try {
-    return fs.statSync(projectConfigFile).isFile();
-  } catch (err) {
-    return false;
+const isWorker = process.argv.includes('--test-worker');
+const startViteServer = async (settings = {}) =>{
+  settings.vite_dev_server = Object.assign({
+    start_vite: true,
+    port: 5173
+  }, settings.vite_dev_server || {});
+
+  let vite_port;
+  if (settings.vite_dev_server.start_vite) {
+    viteServer = await setup();
+
+    settings.vite_dev_server.port = vite_port = viteServer.config.server.port;
+  } else {
+    vite_port = settings.vite_dev_server.port; 
+    try {
+      const enabled = await makeViteRequest(vite_port);
+      if (!enabled) {
+        const error = new Error('Missing vite-plugin-nightwatch');
+        const code = `:
+
+    import nightwatchPlugin from 'vite-plugin-nightwatch'
+
+    export default {
+      plugins: [
+        // ... other plugins
+        nightwatchPlugin({
+          componentType: 'vue'
+        })
+      ]
+    };
+    `;
+        error.help = ['Please ensure that "vite-plugin-nightwatch" is loaded in your Vite config file ' + code];
+        throw error;
+      }
+
+      return true;
+    } catch (err) {
+      const error = new Error('vite dev server is not running: \n  ' + err.message);
+      error.help = [`You can configure Nightwatch to start Vite automatically by adding this to your nightwatch.conf.js: 
+      vite_dev_server: {
+        start_vite: true,
+        port: 5173 
+      }
+      `];
+      throw error;
+    } 
   }
-}
+
+  this.launchUrl = this.baseUrl = `http://localhost:${vite_port}`;
+};
+
+const stopViteServer = async () => {
+  if (viteServer) {
+    await viteServer.close();
+    viteServer = null;
+  }
+};
 
 module.exports = {
-  async before(settings) {
-    viteServer = await setup({
-      viteConfigFile: hasProjectConfigFile() ? projectConfigFile : viteConfigFile
-    });
+  async beforeEach(settings) {
+    if (isWorker) {
+      await startViteServer.call(this, settings);
+    }
+  },
 
-    // This will make sure the launch Url is set correctly when mounting the React component
-    const vite_port = viteServer.config.server.port;
-    settings.vite_port = vite_port;
-    this.launchUrl = this.baseUrl = `http://localhost:${vite_port}`;
+  async before(settings) {
+    if (!settings.parallel_mode && !settings.testWorkersEnabled) {
+      await startViteServer.call(this, settings);
+    }
   },
 
+
   async after() {
-    if (viteServer) {
-      await viteServer.close();
+    await stopViteServer();
+  },
+
+  async afterEach() {
+    if (isWorker) {
+      await stopViteServer();
     }
   }
+};
+
+function makeViteRequest(port) {
+  const options = {
+    host: 'localhost',
+    port,
+    path: '/_nightwatch'
+  };
+
+  return new Promise((resolve, reject) => {
+    const req = http.request(options, function(response) {
+      if (response.statusCode === 404) {
+        return resolve(false);
+      }
+
+      resolve(true);
+    });
+
+    req.on('error', err => {
+      reject(err);
+    });
+
+    req.end();
+  });
 }