v2 Proxy Implementation

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  env: {
+    node: true,
+    commonjs: true,
+    es2021: true,
+  },
+  extends: 'eslint:recommended',
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    indent: ['error', 2],
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'always'],
+  },
+};

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,33 @@
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Screenshots (if appropriate):
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] My code follows the code style of this project.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.

.github/workflows/actions.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Lint and Test
+    steps:
+    - uses: actions/checkout@v2
+      name: Check out repository
+    - uses: actions/setup-node@v2
+      name: Setup Node.js
+      with:
+        node-version: '14.17.5'
+    - run: |
+        cp lib/config/config.json.sample lib/config/config.json
+      name: Setting up configuration
+    - run: | 
+        npm ci
+      name: Installing Dependencies
+    - run: |
+        npm run eslint
+      name: Running ESLint checks on source
+    - run: |
+        npm run eslint:test
+      name: Running ESLint checks on tests  
+    - run: |
+        npm run test
+      name: Running tests

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+tmp/
+config.json
+.nyc_output
+logs/

.nvmrc

@@ -0,0 +1 @@
+v14.17.5

.prettierignore

@@ -0,0 +1,4 @@
+logs/
+.github/
+.nyc_output/
+.vscode/

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "singleQuote": true,
+  "tabWidth": 2,
+  "endOfLine": "lf",
+  "semi": true,
+  "trailingComma": "es5",
+  "useTabs": false
+}

.rotate.js

@@ -0,0 +1,12 @@
+module.exports = {
+  filter(data) {
+    return data.req;
+  },
+  output: {
+    path: './proxy.log',
+    options: {
+      path: './logs',
+      interval: '1d',
+    },
+  },
+};

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "pwa-node",
+			"request": "launch",
+			"name": "ws-reconnect-proxy",
+			"skipFiles": ["<node_internals>/**"],
+			"program": "${workspaceFolder}/cluster.js",
+			"outputCapture": "std",
+			"console": "internalConsole",
+			"env": {
+				"NODE_ENV": "dev"
+			}
+		}
+	]
+}

README.md

@@ -1,2 +1,72 @@
 # ws-reconnect-proxy
-Proxy Server that is between a ws server and a ws client. In case of either server / client disconnects graceful or otherwise - initiates/ supports reconnection . 
+
+Proxy Server that is between a ws server and a ws client. In case of either server / client disconnects graceful or otherwise - initiates/ supports reconnection.
+
+Read more about [📝 design](docs/design.md)
+
+### README Contents:
+
+- [How to contribute](#how-to-contribute)
+- [Development Internals](#development-internals)
+
+### ✨ How to contribute
+
+We are very happy to receive and merge your contributions into this repository!
+
+To contribute via pull request, follow these steps:
+
+1. Create an issue describing the feature you want to work on (or
+   have a look at the [issues](https://github.com/browserstack/ws-reconnect-proxy/issues))
+2. Write your code, tests and format them with `npm run format`
+3. Create a pull request describing your changes
+
+Your pull request will be reviewed by a maintainer, who will get
+back to you about any necessary changes or questions.
+
+## ⚡️ Development Internals
+
+### 🔨 Installing Dependencies
+
+To install dependencies
+
+```bash
+npm install
+```
+
+### ✅ Running the Tests
+
+In order to run the tests, make sure that you have installed dependencies:
+
+```bash
+npm run test
+```
+
+### 🎨 Formatting
+
+To reformat files execute
+
+```bash
+npm run format
+```
+
+### 🚀 Run proxy
+
+🔧 Before, executing proxy create the `config.json` by running the following command:
+
+```bash
+cp lib/config/config.json.sample lib/config/config.json
+```
+
+Additionally, you can configuration your proxy based on your needs. Refer here - [config.json.sample](lib/config/config.json.sample)
+
+Then execute proxy by running the following command:
+
+```bash
+npm run start
+```
+
+_NOTE: By default it runs in `dev` environment you can configure your env by the following command:_
+
+```bash
+NODE_ENV=<env> node cluster.js
+```

cluster.js

@@ -0,0 +1,69 @@
+'use strict';
+
+const cluster = require('cluster');
+const { config } = require('./lib/config/constants.js');
+const { watch } = require('fs');
+const logger = require('./lib/util/loggerFactory.js');
+const Proxy = require('./lib/core/Proxy.js');
+
+const WORKER_CNT = config.workerVal;
+const activeWorkers = [];
+
+const path = require('path');
+
+const RESTART_FILE = path.join(__dirname, 'tmp', 'restart.txt');
+
+const forceKill = (worker) => {
+  if (!worker.isDead()) {
+    logger.info(`Worker ${worker.process.pid} is ${worker.state}, Killing it`);
+    worker.kill('SIGUSR2');
+  }
+};
+
+const disconnectOldWorkers = () => {
+  const len = activeWorkers.length;
+  for (let i = 0; i < len; i++) {
+    const oldWorker = activeWorkers.shift();
+    oldWorker.disconnect();
+    setTimeout(() => forceKill(oldWorker), config.workerKillTimer);
+  }
+};
+
+const spawnNewWorkers = () => {
+  if (cluster.isMaster) {
+    for (let i = 0; i < WORKER_CNT; ++i) {
+      const worker = cluster.fork();
+      worker.on('error', (err) => {
+        logger.error(`Received error event on ${worker.id} : ${err}`);
+      });
+      logger.info(`Created worker with id ${worker.id}`);
+      activeWorkers.push(worker);
+    }
+  }
+};
+
+if (cluster.isMaster) {
+  cluster.on('online', function (worker) {
+    logger.info(`Worker ${worker.process.pid} is online`);
+  });
+
+  cluster.on('exit', (worker, code, signal) => {
+    logger.info(
+      `worker ${worker.process.pid} died with signal ${signal} code ${code}`
+    );
+    if (activeWorkers.length == 0) spawnNewWorkers();
+  });
+
+  spawnNewWorkers();
+
+  let currTime = Date.now();
+  watch(RESTART_FILE, () => {
+    if (Date.now() > currTime) {
+      currTime = Date.now();
+      disconnectOldWorkers();
+      spawnNewWorkers();
+    }
+  });
+} else {
+  new Proxy();
+}