Initial release

.eslintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+  "parserOptions": {
+    'sourceType': 'script',
+    'ecmaVersion': 5
+  },
+  "env": {
+    "node": true,
+    "commonjs": true,
+    "mocha": true,
+  },
+  "globals": {
+    "Promise": true
+  },
+  "extends": "eslint:recommended",
+  "rules": {
+    "indent": ["error", 2],
+    "linebreak-style": [ "error", "unix"],
+    "semi": ["error", "always"],
+    "eol-last": ["error", "always"]
+  },
+  "overrides": [{
+    "files": ["src/requestsDebugger.js", "src/commandLine.js", "test/**/*.test.js"],
+    "rules": {
+      "no-console": "off"
+    }
+  }]
+};

.gitignore

@@ -0,0 +1,110 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+RequestsDebuggerLogs
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Executables
+RequestsDebugger-Mac
+RequestsDebugger.exe
+RequestsDebugger-Linux

README.md

@@ -1,2 +1,96 @@
-# requests-debugger
-Tool for debugging client side failure of requests, leading to requests getting dropped or not reaching BrowserStack. For internal reference : https://browserstack.atlassian.net/wiki/spaces/ENG/pages/1561081359/Network+Utility+Tool
+## Requests Debugger
+### Tool for debugging client side failure of requests, leading to requests getting dropped or not reaching BrowserStack.
+
+## Features
+- Proxy Server to intercept requests fired by client bindings to keep track of their flow.
+- Connectivity Checker : To check for the reachability of BrowserStack components, i.e. Rails & Hub.
+- Multi-Platform Stats Compatibility : Ability to collect stats of CPU, Network & Memory Stats.
+- Retry Mechanism in case a request fails at the client side
+
+## How to run
+- Code
+  - Install all the required packages: `npm install`
+  - Start Requests Debugger with the required arguments: `npm run start -- <args>`. 
+  - Supported `args`:
+    - `--port <port>`: Port on which the Requests Debugger Tool's Proxy will run. Default: 9687
+    - `--proxy-host <hostname>`: Hostname of the Upstream Proxy
+    - `--proxy-port <port>`: Port of the Upstream Proxy. Default: 3128 (if hostname is provided)
+    - `--proxy-user <username>`: Username for auth of the Upstream Proxy
+    - `--proxy-pass <password>`: Password for auth of the Upstream Proxy. Default: empty (if username is provided)
+    - `--retry-delay <milliseconds>`: Delay for the retry of a failed request. Default: 1000ms
+    - `--request-timeout <milliseconds>`: Hard timeout for killing the requests being fired from the tool before receiving any response. Default: 260000ms.
+    - `--logs-path <relative/absolute path>`: Directory where the 'RequestsDebuggerLogs' folder will be created for storing logs. Default: Current Working Directory
+    - `--del-logs`: Deletes any existing logs from the RequestsDebuggerLogs/ directory and initializes new files for logging
+    - `--help`: Help for Requests Debugger Tool
+    - `--version`: Version of the Requests Debugger Tool
+- Executable
+  - Run the Platform Specific executable via terminal/cmd:
+    - Mac: `./RequestsDebugger-Mac <args>`
+    - Linux: `./RequestsDebugger-Linux <args>`
+    - Windows: `RequestsDebugger.exe <args>`
+
+## How to use
+- Since the tool acts like a proxy, you will have to set the proxy to be used by your client binding to `localhost:9687`. i.e.
+  - For Java:
+    - ```
+      System.getProperties().put("http.proxyHost", "localhost");
+      System.getProperties().put("http.proxyPort", "9687");
+      ```
+  - For Ruby:
+    - Set your system's env variable `http_proxy=localhost:9687` and Ruby's Selenium Client Binding will pick the value. Or,
+    - Run you test by giving the environment variable to your command itself, i.e. `http_proxy=localhost:9687 ruby <your_script.rb>`
+  - Similarly, you can also set proxy for other client bindings.
+
+## Steps to build the executables
+- Linux
+  - `npm run build:linux`
+- Mac OS X
+  - `npm run build:mac`
+- Windows
+  - `npm run build:win`
+
+## What each log file consists of?
+- `Connectivitiy.log`
+  - It consists the logs of all the connectivity checks which were performed in terms of reachability with BrowserStack componenets, i.e. Hub and Rails.
+  - The report includes HTTP & HTTPS requests by passing the requests via any upstream proxy (if provided).
+  - New checks are performed whenever a request fails.
+- `CPUStats.log`
+  - It consists of the load and usage stats of user's CPU while booting up the Requests Debugger Tool. It lists down the top 10 processes which were using the highest CPU at that moment. Note: For Windows, it only includes the `loadPercentage` at that moment.
+- `MemStats.log`
+  - It consists of the memory stats of the user's machine while booting up the tool. It includes:
+    - Total Memory
+    - Free Memory
+    - Used Memory
+    - Swap Total
+    - Swap Free
+    - Swap Used
+- `NetworkStats.log`
+  - It consists the list of connections/sockets being established/listening via the user's machine.
+  - It also includes the report of ping checks with Hub & Rails.
+  - New stats are appended whenever a request fails.
+- `Requests.log`
+  - It includes the logs of requests being passed via the Requests Debugger Tool.
+  - Example Logs:
+    - ```
+      TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Request Start] [INFO] POST http://<URL>/wd/hub/status, {"headers":{"......."}}
+      TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Request End] [INFO] POST http://<URL>/wd/hub/status, {"data":"{\"key\": \"value\"}"}
+      TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Tool Request - Retries Left: 1] [INFO] POST http://<URL>/wd/hub/status, {"method":"POST","headers":{".......","Proxy-Authorization":"Basic AaBbCcDdEeFfGg==","X-Requests-Debugger":"2::UNIQUE_IDENTIFIER"},"host":"<EXTERNAL_PROXY_URL>","port":"3130","path":"http://<URL>/wd/hub/status","data":"{\"key\": \"value\"}"}
+      TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Tool Request - Retries Left: 1] [ERROR] POST http://<URL>/wd/hub/status, {"errorMessage":"Error: getaddrinfo ENOTFOUND <EXTERNAL_PROXY_URL> <EXTERNAL_PROXY_URL>:3130"}
+      TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Tool Request - Retries Left: 0] [ERROR] POST http://<URL>/wd/hub/status, {"errorMessage":"Error: getaddrinfo ENOTFOUND <EXTERNAL_PROXY_URL> <EXTERNAL_PROXY_URL>:3130"}
+      TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Response End] [ERROR] POST http://<URL>/wd/hub/status, Status Code: 500, {"message":"Error: getaddrinfo ENOTFOUND <EXTERNAL_PROXY_URL> <EXTERNAL_PROXY_URL>:3130. Request Failed At Requests Debugger","error":"Request Failed At Requests Debugger"}
+  - Tags & their meaning:
+    - **TIMESTAMP_IN_UTC** : Timestamp of each event in UTC.
+    - **#2** : This represents the `nth` request which the tool served from the time it was started.
+    - **UNIQUE_IDENTIFIER** : `uuid` for the request. This is used in `X-Requests-Debugger` custom header for usage & debugging at BrowserStack's end.
+    - **Request Start** : Client request entering the Requests Debugger Tool.
+    - **Request End** : This is logged when the client request is finished, i.e. in case of `POST` request, when the client request has pushed all the data.
+    - **Tool Request - Retries Left: X** : Request which was fired from the tool for the respective client request. It also mentions the retries left for the request. Max retries = 1. A request is retried in case it fails at the tool itself, i.e `ENOTFOUND` etc.
+    - **Response End** : This specifies the response which was finally sent to the client.
+- `RDT_Error.log`
+  - This is to log any unexpected errors which might occur while using the tool.
+
+
+## Note
+- The tool is written in a manner to make it compatible with Node 4.4.0.
+- `npm test` sets up a server which runs on port 8787.
+- Building the executables require Node >=4.9.1. 

config/constants.js

@@ -0,0 +1,95 @@
+module.exports.VERSION = '1.0.0';
+module.exports.HUB_STATUS_URL = 'http://hub-cloud.browserstack.com/wd/hub/status';
+module.exports.RAILS_AUTOMATE = 'http://automate.browserstack.com';
+module.exports.CONNECTIVITY_REQ_TIMEOUT = 30000;
+module.exports.DEFAULT_PROXY_PORT = 3128;
+module.exports.MAX_RETRIES = 1;
+module.exports.LOGS_FOLDER = 'RequestsDebuggerLogs';
+module.exports.PORTS = {
+  MAX: 65535,
+  MIN: 1
+};
+
+module.exports.LOGS = Object.freeze({
+  NETWORK: 'NetworkStats.log',
+  CPU: 'CPUStats.log',
+  MEM: 'MemStats.log',
+  REQUESTS: 'Requests.log',
+  CONNECTIVITY: 'Connectivity.log',
+  ERROR: 'RDT_Error.log'
+});
+
+module.exports.RdGlobalConfig = {
+  RETRY_DELAY: 1000, // in ms
+  RD_HANDLER_PORT: process.env.NODE_ENV === 'test' ? 8787 : 9687,
+  CLIENT_REQ_TIMEOUT: 260000, // in ms
+};
+
+module.exports.COMMON = Object.freeze({
+  PING_HUB: 'ping -c 5 hub-cloud.browserstack.com',
+  PING_AUTOMATE: 'ping -c 5 automate.browserstack.com'
+});
+
+module.exports.MAC = Object.freeze({
+  TCP_LISTEN_ESTABLISHED: 'lsof -PiTCP',
+  TOP_3_SAMPLES: 'top -n 10 -l 3 -stats pid,command,cpu,cpu_others,time,threads,ports,mem,vsize,pgrp,ppid,cycles',
+  SWAP_USAGE: 'sysctl -n vm.swapusage'
+});
+
+module.exports.LINUX = Object.freeze({
+  TCP_LISTEN_ESTABLISHED: 'lsof -PiTCP',
+  TOP_3_SAMPLES: 'top -bn 3',
+  PROC_MEMINFO: '/proc/meminfo'
+});
+
+module.exports.WIN = Object.freeze({
+  NETSTAT_TCP: 'netstat -anosp tcp',
+  NETSTAT_ROUTING_TABLE: 'netstat -r',
+  IPCONFIG_ALL: 'ipconfig /all',
+  SWAP_USAGE: 'pagefile get AllocatedBaseSize, CurrentUsage', // this is a WMIC command. Prefix with WMIC Path
+  PING_HUB: 'ping -n 5 hub-cloud.browserstack.com',
+  PING_AUTOMATE: 'ping -n 5 automate.browserstack.com',
+  LOAD_PERCENTAGE: 'cpu get loadpercentage', // prefix wmic path
+});
+
+module.exports.ERROR_CODES = Object.freeze({
+  EEXIST: 'EEXIST'
+});
+
+module.exports.TOPICS = Object.freeze({
+  LINUX_MEM: 'Linux-Mem',
+  MAC_MEM: 'Mac-Mem',
+  WIN_MEM: 'Win-Mem',
+  TOOL_REQUEST_WITH_RETRIES: 'Tool Request - Retries Left: ',
+  TOOL_RESPONSE_ERROR: 'Tool Response',
+  CLIENT_REQUEST_WITH_RETRIES: 'Request - Retries Left: ',
+  CLIENT_REQUEST_END: 'Request End',
+  CLIENT_REQUEST_START: 'Request Start',
+  CLIENT_RESPONSE_END: 'Response End',
+  NO_TOPIC: 'NO_TOPIC',
+  UNEXPECTED_ERROR: 'UNEXPECTED_ERROR'
+});
+
+module.exports.STATIC_MESSAGES = Object.freeze({
+  STARTING_TOOL: 'Starting Requests Debugger Tool',
+  CHECK_CPU_STATS: 'Stats : Checking CPU Stats',
+  CHECK_NETWORK_STATS: 'Stats : Checking Network Stats',
+  CHECK_MEMORY_STATS: 'Stats : Checking Memory Stats',
+  CHECK_CONNECTIVITY: 'Checks : Checking Connectivity With BrowserStack',
+  ERR_STARTING_TOOL: 'Error in starting Requests Debugger Tool Proxy: ',
+  TOOL_STARTED_ON_PORT: 'Requests Debugger Tool Proxy Started on Port: ',
+  CPU_STATS_COLLECTED: 'Stats : Initial CPU Stats Collected',
+  NETWORK_STATS_COLLECTED: 'Stats : Initial Network Stats Collected',
+  MEMORY_STATS_COLLECTED: 'Stats : Initial Memory Stats Collected',
+  CONNECTIVITY_CHECKS_DONE: 'Checks : Connectivity Checks Performed with BrowserStack',
+  NO_REPORT_GENERATED: 'COULD NOT GENERATE REPORT FOR : ',
+  REQ_TIMED_OUT: 'Request Timed Out. Did not get any response for ',
+  REQ_FAILED_MSG: 'Request Failed At Requests Debugger',
+  BASE_STATS_DESC: 'Base Object for System & Network Stats',
+  CPU_STATS_NOT_IMPLEMENTED: 'CPU Stats Not Yet Implemented',
+  MEM_STATS_NOT_IMPLEMENTED: 'Mem Stats Not Yet Implemented',
+  NETWORK_STATS_NOT_IMPLEMENTED: 'Network Stats Not Yet Implemented',
+  LINUX_STATS_DESC: 'System and Network Stats for Linux',
+  MAC_STATS_DESC: 'System and Network Stats for Mac',
+  WIN_STATS_DESC: 'System and Network Stats for Windows'
+});

hooks/pre-push

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# copy the hook again
+npm run copyhooks
+
+# run the npm tests
+npm test
+
+# return the 'npm test' exit code
+exit $?