Merge PR #1 from 'nodech/add-ci'

.github/workflows/build.yml

@@ -0,0 +1,48 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup
+      uses: actions/setup-node@v3
+      with:
+        node-version: 20.x
+
+    - name: Install tools
+      run: npm install --location=global bslint
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Lint
+      run: npm run lint
+
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [16.x, 18.x, 20.x]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node }}
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Test
+      run: npm test
+

lib/btcp.js

@@ -1,3 +1,5 @@
 'use strict';
 
-module.exports = require('./tcp');
+const TCP = require('./tcp');
+
+module.exports = TCP;

lib/tcp-browser.js

@@ -19,7 +19,6 @@ class Socket extends EventEmitter {
   /**
    * Create a TCP server.
    * @constructor
-   * @param {Function?} handler
    */
 
   constructor() {

lib/tcp.js

@@ -4,13 +4,17 @@
  * https://github.com/bcoin-org/bcoin
  */
 
-/* eslint prefer-arrow-callback: "off" */
-
 'use strict';
 
 const EventEmitter = require('events');
 const net = require('net');
 
+/**
+ * @callback SocketHandler
+ * @param {net.Socket} socket
+ * @returns {void}
+ */
+
 /**
  * Server
  * @extends EventEmitter
@@ -20,7 +24,7 @@ class Server extends EventEmitter {
   /**
    * Create a TCP server.
    * @constructor
-   * @param {Function?} handler
+   * @param {SocketHandler} [handler]
    */
 
   constructor(handler) {
@@ -186,8 +190,8 @@ exports.createConnection = net.connect;
 
 /**
  * Create a TCP server.
- * @param {Function?} handler
- * @returns {Object}
+ * @param {SocketHandler} [handler]
+ * @returns {Server}
  */
 
 exports.createServer = function createServer(handler) {

package.json

@@ -15,11 +15,11 @@
   "author": "Christopher Jeffrey <[email protected]>",
   "main": "./lib/btcp.js",
   "scripts": {
-    "lint": "eslint lib/ test/ || exit 0",
+    "lint": "eslint lib/ test/",
     "test": "bmocha --reporter spec test/*-test.js"
   },
   "devDependencies": {
-    "bmocha": "^2.1.0"
+    "bmocha": "^2.1.8"
   },
   "engines": {
     "node": ">=8.0.0"

test/tcp-test.js

@@ -0,0 +1,81 @@
+'use strict';
+
+const assert = require('assert');
+const tcp = require('../lib/btcp');
+
+const PORT = 12000;
+
+/**
+ * @param {tcp.Socket} socket
+ */
+
+function echoHandler(socket) {
+  socket.on('data', (...args) => {
+    socket.write(...args);
+  });
+};
+
+describe('TCP', function() {
+  let server;
+
+  beforeEach(async () => {
+    server = tcp.createServer(echoHandler);
+
+    server.listen(PORT);
+    await forEvent(server, 'listening');
+  });
+
+  afterEach(async () => {
+    await server.close();
+  });
+
+  it('should connect', async () => {
+    const client = tcp.connect(PORT);
+    await forEvent(client, 'connect');
+    client.destroy();
+    await forEvent(client, 'close');
+  });
+
+  it('should receive the same data', async () => {
+    const client = tcp.connect(PORT);
+    await forEvent(client, 'connect');
+
+    const data = Buffer.from('hello world');
+    client.write(data);
+    // Half close and wait for the server to echo back.
+    client.end();
+
+    let once = true;
+
+    for await (const chunk of client) {
+      assert(once);
+      assert.deepStrictEqual(chunk, data);
+      once = false;
+    }
+
+    client.destroy();
+    await forEvent(client, 'close');
+  });
+});
+
+/**
+ * @param {tcp.Server|tcp.Socket} ee
+ */
+
+function forEvent(ee, eventName, timeout = 1000) {
+  return new Promise((resolve, reject) => {
+    let timer = null;
+
+    const listener = () => {
+      clearTimeout(timer);
+      resolve();
+    };
+
+    ee.once(eventName, listener);
+
+    timer = setTimeout(() => {
+      ee.removeListener(eventName, listener);
+      reject('Timed out.');
+    }, timeout);
+  });
+}