chore: adding electron request module

Signed-off-by: Pawel Psztyc <[email protected]>

Author: jarrodek

.github/workflows/deployment.yml

@@ -0,0 +1,103 @@
+name: Node CI
+
+env:
+  FORCE_COLOR: 1
+
+on:
+  push:
+    branches:
+      - master
+      - main
+      - develop
+  pull_request:
+    branches:
+      - master
+      - main
+
+jobs:
+  test_linux:
+    name: Ubuntu
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: install required packages
+        run: |
+          sudo apt-get install libwoff1 libopus0 libwebp6 libwebpdemux2 libenchant1c2a libgudev-1.0-0 libsecret-1-0 libhyphen0 libgdk-pixbuf2.0-0
+          sudo apt-get install xvfb
+          export DISPLAY=:99.0
+          Xvfb -ac :99 -screen 0 1280x1024x16 > /dev/null 2>&1 &
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: xvfb-run --auto-servernum npm run test
+  test_win:
+    name: "Windows"
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test
+  tag:
+    name: "Publishing release"
+    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+    needs: 
+      - test_linux
+      - test_win
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+      - uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm install
+      - name: Read version from package.json
+        uses: culshaw/read-package-node-version-actions@v1
+        id: package-node-version
+      - name: Changelog
+        uses: scottbrenner/generate-changelog-action@master
+        id: Changelog
+      - name: Github Release
+        id: create_release
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ steps.package-node-version.outputs.version }}
+          release_name: v${{ steps.package-node-version.outputs.version }}
+          body: |
+            ${{ steps.Changelog.outputs.changelog }}
+          draft: false
+          prerelease: false
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

docs/http.md

@@ -0,0 +1,80 @@
+# Electron request
+
+The HTTP engine for the Advanced REST Client application.
+
+It works in the Electron's renderer process and allows to make a HTTP request resulting with detailed response.
+
+The detailed response contains information about redirects and timings similar to the ones presented by Chrome Dev Tools.
+
+## Usage
+
+The library contain two HTTP clients:
+
+- `SocketRequest` - ARC's original and own HTTP client. Operates directly on the socket.
+- `ElectronRequest` - A request engine using higher level Node's APIs
+
+Both classes use the same configuration and produce the same output.
+
+### Socket request
+
+Originally `SocketRequest` was develop for ARC Chrome Application as Chrome apps don't have access to low level request APIs and therefore the application was unable to produce detailed information about the request.
+
+```javascript
+import { SocketRequest } from '@advanced-rest-client/electron-request';
+
+const opts = {
+  timeout: 30000,
+  hosts: [{from: 'domain.com', to: 'other.com'}],
+  followRedirects: true
+};
+const id = 'some-id';
+const request = {
+  url: 'http://api.domain.com',
+  method: 'GET',
+  headers: 'x-test: true'
+};
+
+const connection = new SocketRequest(request, id, opts);
+request.on('load', (id, response, transport) => {});
+request.on('error', (error, id, transport, response) => {});
+try {
+  await connection.send();
+  console.log('Request message sent.');
+} catch (cause) {
+  // usually it means that the server is down or configuration is invalid (URL).
+  console.error('Connection error', cause);
+}
+```
+
+The `transport` is defined in `@advanced-rest-client/arc-types` as `TransportRequest` interface and describes the final message that has been sent to the endpoint. This includes all transformations applied to the request like added headers.
+
+### Native request
+
+Electron application can access Node's APIs and therefore `SocketRequest` can be eventually replaced to reduce amount of code to maintain.
+
+```javascript
+import { ElectronRequest } from '@advanced-rest-client/electron-request';
+
+const opts = {
+  timeout: 30000,
+  hosts: [{from: 'domain.com', to: 'other.com'}],
+  followRedirects: true
+};
+const id = 'some-id';
+const request = {
+  url: 'http://api.domain.com',
+  method: 'GET',
+  headers: 'x-test: true'
+};
+
+const connection = new ElectronRequest(request, id, opts);
+request.on('load', (id, response, transport) => {});
+request.on('error', (error, id, transport, response) => {});
+try {
+  await connection.send();
+  console.log('Request message sent.');
+} catch (cause) {
+  // usually it means that the server is down or configuration is invalid (URL).
+  console.error('Connection error', cause);
+}
+```