Upgrade dependencies & add new tls phase

Author: szmarczak

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - '11'
+  - '13'
+  - '12'
   - '10'
-  - '8'
 after_success: npm run coveralls

README.md

@@ -21,7 +21,7 @@ Yarn:
 ```js
 'use strict';
 const https = require('https');
-const timer = require('@szmarczak/http-timer').default;
+const timer = require('@szmarczak/http-timer');
 
 const request = https.get('https://httpbin.org/anything');
 const timings = timer(request);
@@ -33,21 +33,25 @@ request.on('response', response => {
 	});
 });
 
-// { start: 1535708511443,
-//   socket: 1535708511444,
-//   lookup: 1535708511444,
-//   connect: 1535708511582,
-//   upload: 1535708511887,
-//   response: 1535708512037,
-//   end: 1535708512040,
-//   phases:
-//    { wait: 1,
-//      dns: 0,
-//      tcp: 138,
-//      request: 305,
-//      firstByte: 150,
-//      download: 3,
-//      total: 597 } }
+// {
+//   start: 1572712180361,
+//   socket: 1572712180362,
+//   lookup: 1572712180415,
+//   connect: 1572712180571,
+//   upload: 1572712180884,
+//   response: 1572712181037,
+//   end: 1572712181039,
+//   error: null,
+//   phases: {
+//     wait: 1,
+//     dns: 53,
+//     tcp: 156,
+//     request: 313,
+//     firstByte: 153,
+//     download: 2,
+//     total: 678
+//   }
+// }
 ```
 
 ## API
@@ -60,6 +64,7 @@ Returns: `Object`
 - `socket` - Time when a socket was assigned to the request.
 - `lookup` - Time when the DNS lookup finished.
 - `connect` - Time when the socket successfully connected.
+- `secureConnect` - Time when the socket securely connected.
 - `upload` - Time when the request finished uploading.
 - `response` - Time when the request fired the `response` event.
 - `end` - Time when the response fired the `end` event.
@@ -68,12 +73,13 @@ Returns: `Object`
 	- `wait` - `timings.socket - timings.start`
 	- `dns` - `timings.lookup - timings.socket`
 	- `tcp` - `timings.connect - timings.lookup`
-	- `request` - `timings.upload - timings.connect`
+	- `tls` - ``timings.secureConnect - timings.connect`
+	- `request` - `timings.upload - (timings.secureConnect || timings.connect)`
 	- `firstByte` - `timings.response - timings.upload`
 	- `download` - `timings.end - timings.response`
 	- `total` - `timings.end - timings.start` or `timings.error - timings.start`
 
-If something is not measured yet, it will be `undefined`.
+If something has not been measured yet, it will be `undefined`.
 
 **Note**: The time is a `number` representing the milliseconds elapsed since the UNIX epoch.
 

package.json

@@ -4,7 +4,7 @@
 	"description": "Timings for HTTP requests",
 	"main": "dist",
 	"engines": {
-		"node": ">=8"
+		"node": ">=10"
 	},
 	"scripts": {
 		"test": "xo && nyc ava",
@@ -32,7 +32,7 @@
 	},
 	"homepage": "https://github.com/szmarczak/http-timer#readme",
 	"dependencies": {
-		"defer-to-connect": "^1.0.2"
+		"defer-to-connect": "^1.1.0"
 	},
 	"devDependencies": {
 		"@sindresorhus/tsconfig": "^0.3.0",

source/index.ts

@@ -1,14 +1,14 @@
 import {EventEmitter} from 'events';
 import {Socket} from 'net';
 import {ClientRequest, IncomingMessage} from 'http';
-// @ts-ignore
-import deferToConnect = require('defer-to-connect');
+import deferToConnect from 'defer-to-connect';
 
 export interface Timings {
 	start: number;
 	socket?: number;
 	lookup?: number;
 	connect?: number;
+	secureConnect?: number;
 	upload?: number;
 	response?: number;
 	end?: number;
@@ -17,19 +17,21 @@ export interface Timings {
 		wait?: number;
 		dns?: number;
 		tcp?: number;
+		tls?: number;
 		request?: number;
 		firstByte?: number;
 		download?: number;
 		total?: number;
 	};
 }
 
-export default (request: ClientRequest): Timings => {
+const timer = (request: ClientRequest): Timings => {
 	const timings: Timings = {
 		start: Date.now(),
 		socket: undefined,
 		lookup: undefined,
 		connect: undefined,
+		secureConnect: undefined,
 		upload: undefined,
 		response: undefined,
 		end: undefined,
@@ -38,6 +40,7 @@ export default (request: ClientRequest): Timings => {
 			wait: undefined,
 			dns: undefined,
 			tcp: undefined,
+			tls: undefined,
 			request: undefined,
 			firstByte: undefined,
 			download: undefined,
@@ -74,25 +77,31 @@ export default (request: ClientRequest): Timings => {
 
 		socket.prependOnceListener('lookup', lookupListener);
 
-		deferToConnect(socket, () => {
-			timings.connect = Date.now();
+		deferToConnect(socket, {
+			connect: () => {
+				timings.connect = Date.now();
 
-			if (timings.lookup === undefined) {
-				socket.removeListener('lookup', lookupListener);
-				timings.lookup = timings.connect;
-				timings.phases.dns = timings.lookup - timings.socket!;
-			}
+				if (timings.lookup === undefined) {
+					socket.removeListener('lookup', lookupListener);
+					timings.lookup = timings.connect;
+					timings.phases.dns = timings.lookup - timings.socket!;
+				}
 
-			timings.phases.tcp = timings.connect - timings.lookup;
+				timings.phases.tcp = timings.connect - timings.lookup;
 
-			// This callback is called before flushing any data,
-			// so we don't need to set `timings.phases.request` here.
+				// This callback is called before flushing any data,
+				// so we don't need to set `timings.phases.request` here.
+			},
+			secureConnect: () => {
+				timings.secureConnect = Date.now();
+				timings.phases.tls = timings.secureConnect - timings.connect!;
+			}
 		});
 	});
 
 	request.prependOnceListener('finish', () => {
 		timings.upload = Date.now();
-		timings.phases.request = timings.upload - timings.connect!;
+		timings.phases.request = timings.upload - (timings.secureConnect || timings.connect!);
 	});
 
 	request.prependOnceListener('response', (response: IncomingMessage): void => {
@@ -110,3 +119,9 @@ export default (request: ClientRequest): Timings => {
 
 	return timings;
 };
+
+export default timer;
+
+// For CommonJS default export support
+module.exports = timer;
+module.exports.default = timer;

test.ts

@@ -1,8 +1,7 @@
 import EventEmitter from 'events';
-import http, {ClientRequest, IncomingMessage, RequestOptions} from 'http';
+import http, {ClientRequest, IncomingMessage} from 'http';
 import https from 'https';
 import {AddressInfo} from 'net';
-import {parse as parseUrl, URL} from 'url'; // eslint-disable-line node/no-deprecated-api
 import util from 'util';
 import pEvent from 'p-event';
 import test from 'ava';
@@ -52,9 +51,21 @@ test('by default everything is set to undefined', t => {
 	t.is(timings.socket, undefined);
 	t.is(timings.lookup, undefined);
 	t.is(timings.connect, undefined);
+	t.is(timings.secureConnect, undefined);
 	t.is(timings.response, undefined);
 	t.is(timings.end, undefined);
 	t.is(timings.error, undefined);
+
+	t.deepEqual(timings.phases, {
+		wait: undefined,
+		dns: undefined,
+		tcp: undefined,
+		tls: undefined,
+		request: undefined,
+		firstByte: undefined,
+		download: undefined,
+		total: undefined
+	});
 });
 
 test('timings', async t => {
@@ -68,6 +79,7 @@ test('timings', async t => {
 	t.is(typeof timings.socket, 'number');
 	t.is(typeof timings.lookup, 'number');
 	t.is(typeof timings.connect, 'number');
+	t.is(typeof timings.secureConnect, 'number');
 	t.is(typeof timings.upload, 'number');
 	t.is(typeof timings.response, 'number');
 	t.is(typeof timings.end, 'number');
@@ -83,14 +95,16 @@ test('phases', async t => {
 	t.is(typeof timings.phases.wait, 'number');
 	t.is(typeof timings.phases.dns, 'number');
 	t.is(typeof timings.phases.tcp, 'number');
+	t.is(typeof timings.phases.tls, 'number');
 	t.is(typeof timings.phases.firstByte, 'number');
 	t.is(typeof timings.phases.download, 'number');
 	t.is(typeof timings.phases.total, 'number');
 
 	t.is(timings.phases.wait, timings.socket! - timings.start);
 	t.is(timings.phases.dns, timings.lookup! - timings.socket!);
 	t.is(timings.phases.tcp, timings.connect! - timings.lookup!);
-	t.is(timings.phases.request, timings.upload! - timings.connect!);
+	t.is(timings.phases.tls, timings.secureConnect! - timings.connect!);
+	t.is(timings.phases.request, timings.upload! - timings.secureConnect!);
 	t.is(timings.phases.firstByte, timings.response! - timings.upload!);
 	t.is(timings.phases.download, timings.end! - timings.response!);
 	t.is(timings.phases.total, timings.end! - timings.start);
@@ -105,10 +119,9 @@ test('no memory leak (`lookup` event)', async t => {
 });
 
 test('sets `total` on request error', async t => {
-	const request = http.get({
-		...parseUrl(server.url!),
+	const request = http.get(server.url!, {
 		timeout: 1
-	} as RequestOptions);
+	});
 	request.on('timeout', () => {
 		request.abort();
 	});
@@ -147,7 +160,7 @@ test('doesn\'t throw when someone used `.prependOnceListener()`', t => {
 });
 
 test('sensible timings', async t => {
-	const {timings, request} = makeRequest('http://google.com');
+	const {timings, request} = makeRequest('https://google.com');
 	const now = Date.now();
 
 	const response = await pEvent(request, 'response');
@@ -157,12 +170,14 @@ test('sensible timings', async t => {
 	t.true(timings.socket! >= now);
 	t.true(timings.lookup! >= now);
 	t.true(timings.connect! >= now);
+	t.true(timings.secureConnect! >= now);
 	t.true(timings.response! >= now);
 	t.true(timings.end! >= now);
 	t.is(timings.error, undefined);
 	t.true(timings.phases.wait! < 1000);
 	t.true(timings.phases.dns! < 1000);
 	t.true(timings.phases.tcp! < 1000);
+	t.true(timings.phases.tls! < 1000);
 	t.true(timings.phases.request! < 1000);
 	t.true(timings.phases.firstByte! < 1000);
 	t.true(timings.phases.download! < 1000);
@@ -185,3 +200,25 @@ test('prepends once listeners', async t => {
 	await promise;
 	request.abort();
 });
+
+test('`tls` phase for https requests', async t => {
+	const {request, timings} = makeRequest('https://google.com');
+
+	const response = await pEvent(request, 'response');
+	response.resume();
+	await pEvent(response, 'end');
+
+	t.is(typeof timings.secureConnect, 'number');
+	t.is(typeof timings.phases.tls, 'number');
+});
+
+test('no `tls` phase for http requests', async t => {
+	const {request, timings} = makeRequest(server.url);
+
+	const response = await pEvent(request, 'response');
+	response.resume();
+	await pEvent(response, 'end');
+
+	t.is(timings.secureConnect, undefined);
+	t.is(timings.phases.tls, undefined);
+});

tsconfig.json

@@ -2,7 +2,7 @@
 	"extends": "@sindresorhus/tsconfig",
 	"compilerOptions": {
 		"outDir": "dist",
-		"target": "es2017" // Node.js 8
+		"target": "es2018" // Node.js 10
 	},
 	"include": [
 		"source"