Merge pull request #2 from journeyapps/updates

Updates

Author: rkistner

.circleci/config.yml

@@ -1,47 +1,49 @@
 version: 2
 jobs:
-  build:
+  build_8:
     docker:
-      - image: circleci/node:8.11.4
+      - image: circleci/node:8.17.0
     steps:
       - checkout
       - run: echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
-      - restore_cache:
-          keys:
-            - modules-{{ checksum "yarn.lock" }}
-      - run: yarn install --check-files --frozen-lockfile
-      - save_cache:
-          key: modules-{{ checksum "yarn.lock" }}
-          paths:
-            - node_modules
+      - run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
       - run: yarn run build
       - run: yarn run test
+
+  build_10:
+    docker:
+      - image: circleci/node:10.18.1
+    steps:
+      - checkout
+      - run: echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
+      - run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
+      - run: yarn run build
+      - run: yarn run test
+
+  build_12:
+    docker:
+      - image: circleci/node:12.14.1
+    steps:
+      - checkout
+      - run: echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
+      - run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
+      - run: yarn run build
+      - run: yarn run test
+
   publish:
     docker:
-      - image: circleci/node:8.11.4
+      - image: circleci/node:12.14.1
     steps:
       - checkout
       - run: echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
-      - restore_cache:
-          keys:
-            - modules-{{ checksum "yarn.lock" }}
-      - run: yarn install --check-files --frozen-lockfile
-      - save_cache:
-          key: modules-{{ checksum "yarn.lock" }}
-          paths:
-            - node_modules
+      - run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
       - run: yarn run build
       - run: ./node_modules/.bin/journey-deploy execute
 
 workflows:
   version: 2
-  build_and_publish:
+  build:
     jobs:
-      - build:
-          filters:
-            branches:
-              only: /.*/
-              ignore: /.*deploy-cli.*/
-            tags:
-              only: /.*/
-              ignore: /.*dev.*/
+      - build_8
+      - build_10
+      - build_12

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2020 Journey Mobile, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -9,33 +9,47 @@ but adapted to expose raw Sockets, instead of just http/https requests.
 
     yarn add @journeyapps/https-proxy-socket
 
-## Usage
-
+## Usage - node-fetch
 
     const { HttpsProxySocket } = require('@journeyapps/https-proxy-socket');
-    const proxy = new HttpsProxySocket({
-      // Connection options
-      host: 'my-proxy.test',
-      port: 443
-    }, {
-        auth: 'myuser:mypassword' // Optional: proxy basic auth
+    const fetch = require('node-fetch');
+
+    // Proxy connection options
+    const proxy = new HttpsProxySocket('https://my-proxy.test', {
+      // Proxy auth and headers may be set here, for example:
+      auth: 'myuser:mypassword' // Basic auth
     });
 
-    const socket = await proxy.connect({host: 'myhost.test', port: 1234});
+    const agent = proxy.agent({
+      // Additional TLS options for the host may be set here, for example:
+      // rejectUnauthorized: false, // Disable TLS checks completely (dangerous)
+      // ca: fs.readFileSync('my-ca-cert.pem') // Use a custom CA cert
+
+      // Documentation of the available options is available here:
+      //  https://nodejs.org/api/tls.html#tls_new_tls_tlssocket_socket_options
+      //  https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options
+    });
 
-## Usage with mssql
+    const response = await fetch('https://myhost.test', { agent: agent });
+
+## Usage - Direct socket
+
+    const { HttpsProxySocket } = require('@journeyapps/https-proxy-socket');
+    const proxy = new HttpsProxySocket('https://my-proxy.test');
+
+    const socket = await proxy.connect({host: 'myhost.test', port: 1234});
 
+## Usage - mssql
 
     const sql = require('mssql')
-    const { useProxy } = require('@journeyapps/https-proxy-socket/lib/TediousPatch');
+    const { HttpsProxySocket, useProxyForTedious } = require('@journeyapps/https-proxy-socket');
 
-    const { HttpsProxySocket } = require('./lib/HttpsProxySocket');
     const proxy = new HttpsProxySocket({
       // Same as above
     });
 
     // Register the proxy globally for tedious/mssql
-    useProxy(proxy);
+    useProxyForTedious(proxy);
 
     async function run() {
       // Connect using the proxy

package.json

@@ -1,7 +1,9 @@
 {
   "name": "@journeyapps/https-proxy-socket",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "author": "JourneyApps",
+  "repository": "journeyapps/https-proxy-socket",
+  "license": "MIT",
   "scripts": {
     "build": "tsc",
     "test": "mocha src/*.spec.ts",
@@ -20,15 +22,14 @@
     "mocha": "^6.0.2",
     "mssql": "^4.3.2",
     "node-fetch": "^2.3.0",
-    "proxy": "^0.2.4",
+    "proxy": "^1.0.1",
     "ts-node": "^8.0.2",
     "typescript": "3.2.4"
   },
   "main": "./lib/index.js",
   "dependencies": {},
   "files": [
     "/README.md",
-    "/src",
     "/lib"
   ]
 }

src/HttpsProxySocket.ts

@@ -2,6 +2,7 @@
 
 import * as tls from 'tls';
 import * as url from 'url';
+import { proxyAgent } from './proxyAgent';
 
 const debug = require('debug')('https-proxy');
 
@@ -69,6 +70,15 @@ export class HttpsProxySocket {
     });
   }
 
+  /**
+   * Construct an agent for http(s) requests.
+   *
+   * @param options - to set additional TLS options for https requests, e.g. rejectUnauthorized
+   */
+  agent(options?: tls.ConnectionOptions) {
+    return proxyAgent(this, options);
+  }
+
   private _connect(opts: ConnectionOptions, cb: (error: any, socket: tls.TLSSocket) => void) {
     const proxy = this.proxy;
 

src/index.ts

@@ -1 +1,2 @@
 export * from './HttpsProxySocket';
+export * from './tediousPatch';

src/HttpsProxyAgent.spec.ts src/proxyAgent.spec.tssrc/HttpsProxyAgent.spec.ts renamed to src/proxyAgent.spec.ts

@@ -4,10 +4,9 @@ import * as fs from 'fs';
 import * as http from 'http';
 import * as https from 'https';
 import * as assert from 'assert';
-import * as url from 'url';
 
 import { HttpsProxySocket, HttpsProxyConfig } from './HttpsProxySocket';
-import { agent as proxyAgent } from './HttpsProxyAgent';
+import { proxyAgent } from './proxyAgent';
 import { ConnectionOptions } from 'tls';
 import { AddressInfo } from 'net';
 
@@ -70,24 +69,15 @@ describe('HttpsProxyAgent', function() {
 
   // shut down test HTTP server
   after(function(done) {
-    server.once('close', function() {
-      done();
-    });
-    server.close();
+    server.close(done);
   });
 
   after(function(done) {
-    sslServer.once('close', function() {
-      done();
-    });
-    sslServer.close();
+    sslServer.close(done);
   });
 
   after(function(done) {
-    sslProxy.once('close', function() {
-      done();
-    });
-    sslProxy.close();
+    sslProxy.close(done);
   });
 
   describe('constructor', function() {

src/HttpsProxyAgent.ts src/proxyAgent.tssrc/HttpsProxyAgent.ts renamed to src/proxyAgent.ts

@@ -8,7 +8,7 @@ import * as tls from 'tls';
  * @param proxy - the proxy to use
  * @param options - to set additional TLS options for https requests, e.g. rejectUnauthorized
  */
-export function agent(proxy: HttpsProxySocket, options?: tls.ConnectionOptions) {
+export function proxyAgent(proxy: HttpsProxySocket, options?: tls.ConnectionOptions) {
   return agentBase(async (req, opts: any) => {
     const socket = await proxy.connect(opts);
 
@@ -26,6 +26,7 @@ export function agent(proxy: HttpsProxySocket, options?: tls.ConnectionOptions)
       const tlsSocket = tls.connect(tlsOptions);
       return tlsSocket;
     } else {
+      socket.resume();
       return socket;
     }
   });

src/TediousPatch.ts src/tediousPatch.tssrc/TediousPatch.ts renamed to src/tediousPatch.ts

@@ -8,7 +8,7 @@ const debug = require('debug')('https-proxy');
  *
  * @param proxy - the proxy to use
  */
-export function useProxy(proxy: HttpsProxySocket) {
+export function useProxyForTedious(proxy: HttpsProxySocket) {
   const { Connector } = require('tedious/lib/connector');
   Connector.prototype.execute = async function(cb: any) {
     debug(`opening sql connection to ${this.options.host}:${this.options.port}`);