pax_global_header 0000666 0000000 0000000 00000000064 14015563661 0014521 g ustar 00root root 0000000 0000000 52 comment=7eecfee3761562d49038e04a37cc5bc0625624b8
defer-to-connect-2.0.1/ 0000775 0000000 0000000 00000000000 14015563661 0014655 5 ustar 00root root 0000000 0000000 defer-to-connect-2.0.1/.editorconfig 0000664 0000000 0000000 00000000257 14015563661 0017336 0 ustar 00root root 0000000 0000000 root = true
[*]
indent_style = tab
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.yml]
indent_style = space
indent_size = 2
defer-to-connect-2.0.1/.gitignore 0000664 0000000 0000000 00000000072 14015563661 0016644 0 ustar 00root root 0000000 0000000 dist
package-lock.json
node_modules
yarn.lock
.nyc_output
defer-to-connect-2.0.1/.travis.yml 0000664 0000000 0000000 00000000127 14015563661 0016766 0 ustar 00root root 0000000 0000000 language: node_js
node_js:
- '13'
- '12'
- '10'
after_success: npm run coveralls
defer-to-connect-2.0.1/LICENSE 0000664 0000000 0000000 00000002057 14015563661 0015666 0 ustar 00root root 0000000 0000000 MIT License
Copyright (c) 2018 Szymon Marczak
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.
defer-to-connect-2.0.1/README.md 0000664 0000000 0000000 00000001667 14015563661 0016146 0 ustar 00root root 0000000 0000000 # defer-to-connect
> The safe way to handle the `connect` socket event
[](https://coveralls.io/github/szmarczak/defer-to-connect?branch=master)
Once you receive the socket, it may be already connected (or disconnected).
To avoid checking that, use `defer-to-connect`. It'll do that for you.
## Usage
```js
const deferToConnect = require('defer-to-connect');
deferToConnect(socket, () => {
console.log('Connected!');
});
```
## API
### deferToConnect(socket, connectListener)
Calls `connectListener()` when connected.
### deferToConnect(socket, listeners)
#### listeners
An object representing `connect`, `secureConnect` and `close` properties.
Calls `connect()` when the socket is connected.
Calls `secureConnect()` when the socket is securely connected.
Calls `close()` when the socket is destroyed.
## License
MIT
defer-to-connect-2.0.1/package.json 0000664 0000000 0000000 00000003064 14015563661 0017146 0 ustar 00root root 0000000 0000000 {
"name": "defer-to-connect",
"version": "2.0.1",
"description": "The safe way to handle the `connect` socket event",
"main": "dist/source",
"files": [
"dist/source"
],
"engines": {
"node": ">=10"
},
"scripts": {
"build": "del-cli dist && tsc",
"prepare": "npm run build",
"test": "xo && tsc --noEmit && nyc ava",
"coveralls": "nyc report --reporter=text-lcov | coveralls"
},
"keywords": [
"socket",
"connect",
"event"
],
"author": "Szymon Marczak",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/szmarczak/defer-to-connect.git"
},
"bugs": {
"url": "https://github.com/szmarczak/defer-to-connect/issues"
},
"homepage": "https://github.com/szmarczak/defer-to-connect#readme",
"xo": {
"extends": "xo-typescript",
"extensions": [
"ts"
]
},
"devDependencies": {
"@ava/typescript": "^1.1.0",
"@sindresorhus/tsconfig": "^0.7.0",
"@types/node": "^13.5.0",
"@typescript-eslint/eslint-plugin": "^2.18.0",
"@typescript-eslint/parser": "^2.18.0",
"ava": "^3.2.0",
"coveralls": "^3.0.9",
"create-cert": "^1.0.6",
"del-cli": "^3.0.0",
"eslint-config-xo-typescript": "^0.24.1",
"nyc": "^15.0.0",
"p-event": "^4.1.0",
"typescript": "^3.7.5",
"xo": "^0.25.3"
},
"nyc": {
"include": [
"dist/source"
],
"extension": [
".ts"
]
},
"ava": {
"typescript": {
"rewritePaths": {
"tests/": "dist/tests/"
}
}
},
"types": "dist/source/index.d.ts"
}
defer-to-connect-2.0.1/source/ 0000775 0000000 0000000 00000000000 14015563661 0016155 5 ustar 00root root 0000000 0000000 defer-to-connect-2.0.1/source/index.ts 0000664 0000000 0000000 00000002756 14015563661 0017646 0 ustar 00root root 0000000 0000000 import {Socket} from 'net';
import {TLSSocket} from 'tls';
interface Listeners {
connect?: () => void;
secureConnect?: () => void;
close?: (hadError: boolean) => void;
}
function isTLSSocket(socket: any): socket is TLSSocket {
return socket.encrypted;
}
const deferToConnect = (socket: Socket | TLSSocket, fn: Listeners | (() => void)): void => {
let listeners: Listeners;
if (typeof fn === 'function') {
const connect = fn;
listeners = {connect};
} else {
listeners = fn;
}
const hasConnectListener = typeof listeners.connect === 'function';
const hasSecureConnectListener = typeof listeners.secureConnect === 'function';
const hasCloseListener = typeof listeners.close === 'function';
const onConnect = (): void => {
if (hasConnectListener) {
listeners.connect!();
}
if (isTLSSocket(socket) && hasSecureConnectListener) {
if (socket.authorized) {
listeners.secureConnect!();
} else if (!socket.authorizationError) {
socket.once('secureConnect', listeners.secureConnect!);
}
}
if (hasCloseListener) {
socket.once('close', listeners.close!);
}
};
if (socket.writable && !socket.connecting) {
onConnect();
} else if (socket.connecting) {
socket.once('connect', onConnect);
} else if (socket.destroyed && hasCloseListener) {
listeners.close!((socket as Socket & {_hadError: boolean})._hadError);
}
};
export default deferToConnect;
// For CommonJS default export support
module.exports = deferToConnect;
module.exports.default = deferToConnect;
defer-to-connect-2.0.1/tests/ 0000775 0000000 0000000 00000000000 14015563661 0016017 5 ustar 00root root 0000000 0000000 defer-to-connect-2.0.1/tests/test.ts 0000664 0000000 0000000 00000007362 14015563661 0017356 0 ustar 00root root 0000000 0000000 import {promisify} from 'util';
import {connect, AddressInfo} from 'net';
import {connect as secureConnect, createServer as createSecureServer} from 'tls';
import test from 'ava';
// @ts-ignore No types yet
import createCert = require('create-cert');
import pEvent from 'p-event';
import deferToConnect from '../source';
const delay = async (ms: number): Promise => new Promise(resolve => setTimeout(resolve, ms));
test('connect listener - socket has been already connected', async t => {
let called = false;
const socket = connect(80, 'example.com');
await pEvent(socket, 'connect');
deferToConnect(socket, () => {
called = true;
});
t.true(called);
});
test('connect listener - socket hasn\'t been connected yet', async t => {
let called = false;
const socket = connect(80, 'example.com');
deferToConnect(socket, () => {
called = true;
});
await pEvent(socket, 'connect');
t.true(called);
});
test('connect listener - not executed, socket has been disconnected', async t => {
let called = false;
const socket = connect(80, 'example.com');
await pEvent(socket, 'connect');
socket.end();
/* istanbul ignore next: this is on purpose */
deferToConnect(socket, () => {
called = true;
});
t.false(called);
});
test('connect listener - as a Listener property', async t => {
let called = false;
const socket = connect(80, 'example.com');
await pEvent(socket, 'connect');
deferToConnect(socket, {
connect: () => {
called = true;
}
});
t.true(called);
});
test('close listener - socket has been already connected', async t => {
let called = false;
const socket = connect(80, 'example.com');
await pEvent(socket, 'connect');
deferToConnect(socket, {
close: () => {
called = true;
}
});
socket.destroy();
await delay(1);
t.true(called);
});
test('close listener - socket has been already closed', async t => {
let called = false;
const socket = connect(80, 'example.com');
await pEvent(socket, 'connect');
socket.destroy();
deferToConnect(socket, {
close: () => {
called = true;
}
});
t.true(called);
});
test('secureConnect listener - socket has been already securely connected', async t => {
let called = false;
const socket = secureConnect(443, 'example.com');
await pEvent(socket, 'secureConnect');
deferToConnect(socket, {
secureConnect: () => {
called = true;
}
});
t.true(called);
});
test('secureConnect listener - socket hasn\'t been securely connected yet', async t => {
let called = false;
const socket = secureConnect(443, 'example.com');
deferToConnect(socket, {
secureConnect: () => {
called = true;
}
});
await pEvent(socket, 'secureConnect');
t.true(called);
});
test('secureConnect listener - not executed, socket has been disconnected', async t => {
let called = false;
const socket = secureConnect(443, 'example.com');
await pEvent(socket, 'secureConnect');
socket.end();
/* istanbul ignore next: this is on purpose */
deferToConnect(socket, () => {
called = true;
});
t.false(called);
});
test('no memory leak when using a self-signed certificate', async t => {
const keys = await createCert();
const server = createSecureServer(keys);
// @ts-ignore
server.listen = promisify(server.listen);
// @ts-ignore
server.close = promisify(server.close);
// eslint-disable-next-line @typescript-eslint/await-thenable
await server.listen();
const socket = secureConnect((server.address() as AddressInfo).port, 'localhost', {rejectUnauthorized: false});
await pEvent(socket, 'secureConnect');
let called = false;
deferToConnect(socket, {
secureConnect: () => {
called = true;
}
});
t.is(socket.listenerCount('secureConnect'), 0);
t.false(called);
socket.end();
// eslint-disable-next-line @typescript-eslint/await-thenable
await server.close();
});
defer-to-connect-2.0.1/tsconfig.json 0000664 0000000 0000000 00000000274 14015563661 0017367 0 ustar 00root root 0000000 0000000 {
"extends": "@sindresorhus/tsconfig",
"compilerOptions": {
"outDir": "dist",
"target": "es2018",
"lib": [
"es2018"
]
},
"include": [
"source",
"tests"
]
}