v6.0.0 (#35)

* Update client.ts * Update client.ts * changed build option, version bumps * fixed socket remote, logs, build module config, added node 16 target * removed node 12 support * updated tests, added engines check, changelog bump * hotfix test command order * added missing tests * fixed linting, build order * made broken import linter warning Co-authored-by: Frederic Charette <[email protected]>
kalm · Apr 26, 2021 · 47b810d · 47b810d
1 parent bda2296
commit 47b810d
Show file tree

Hide file tree

Showing 31 changed files with 207 additions and 81 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -31,7 +31,8 @@
             "error", 
             { "vars": "all", "args": "after-used", "ignoreRestSiblings": false }
         ],
-        "import/no-extraneous-dependencies": 0
+        "import/no-extraneous-dependencies": 0,
+        "import/no-unresolved": 1
     },
     "env": {
         "browser": true,

diff --git a/.github/workflows/master-status.yml b/.github/workflows/master-status.yml
@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [14.x, 16.x]
 
     steps:
     - uses: actions/checkout@v1
@@ -23,9 +23,9 @@ jobs:
     - name: npm install, build, and test
       run: |
         yarn
+        yarn run build
         yarn run lint
         yarn run test
-        yarn run build
         yarn run bench
       env:
         CI: true
diff --git a/.github/workflows/pr-validation.yml b/.github/workflows/pr-validation.yml
@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x]
+        node-version: [14.x, 16.x]
 
     steps:
     - uses: actions/checkout@v1
@@ -23,9 +23,9 @@ jobs:
     - name: npm install, build, and test
       run: |
         yarn
+        yarn run build
         yarn run lint
         yarn run test
-        yarn run build
         yarn run bench
       env:
         CI: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,16 +1,38 @@
 # Changelog
 
-## [v5.0.0] - 2020-06-23
+## [v6.0.0] - 2021-04-26
 
 commit: [#](https://github.com/kalm/kalm.js/commits)
 
-## Breaking changes
+### Breaking changes
+
+- Client.remote is now a const instead of a function (breaking change)
+- Client.local is now a const instead of a function (breaking change)
+- Engines config in package.json now only allows node >=14
+
+### Added
+
+- Client reference in subscribe callback is now fully featured instead of a shallow config object.
+- Bumped `ws` version
+- Added integration tests
+
+### Bug fixes
+
+- Fixed importing when using typescript (breaking change)
+- Fixed socket remote info
+- Fixed multiple types, including opening `port` value to be a string 
+
+## [v5.0.0] - 2020-06-23
+
+commit: [#](https://github.com/kalm/kalm.js/commit/527a245e4855f6ab7678ef4fe1ee9e7cd2ff3cb8)
+
+### Breaking changes
 - Changed default packet framing to be a pure json object
 - Removed custom framing
 - Added packet message cap
 - Fixed multiplexing
 
-## Added
+### Added
 - Added more error messages
 - Added tests for transport packages
 - Added CHANGELOG and LICENSE to all packages
@@ -19,7 +41,7 @@ commit: [#](https://github.com/kalm/kalm.js/commits)
 
 commit: [731491d](https://github.com/kalm/kalm.js/commit/731491d7b98f3116e0491905c99f9ece29d24d65)
 
-## Added
+### Added
 - Added more error messages
 - Added tests for transport packages
 - Added CHANGELOG and LICENSE to all packages

diff --git a/examples/typescript/client.ts b/examples/typescript/client.ts
@@ -1,5 +1,5 @@
 import {connect, routines} from 'kalm';
-import * as ws from '@kalm/ws';
+import ws from '@kalm/ws';
 
 const client = connect({
   transport: ws(),

diff --git a/examples/typescript/server.ts b/examples/typescript/server.ts
@@ -1,5 +1,5 @@
 import {listen, routines} from 'kalm';
-import * as ws from '@kalm/ws';
+import ws from '@kalm/ws';
 
 const provider = listen({
   transport: ws(),

diff --git a/package.json b/package.json
@@ -1,11 +1,11 @@
 {
   "name": "kalm",
   "private": true,
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "The socket optimizer",
   "main": "packages/kalm/bin/kalm.js",
   "scripts": {
-    "lint": "eslint **/*.ts **/*.spec.ts",
+    "lint": "eslint packages/**/*.ts packages/**/*.spec.ts tests/**/*.spec.ts",
     "lint:fix": "yarn lint --fix",
     "test": "yarn workspaces run test && yarn run test:integration",
     "test:integration": "jest ./tests/integration --forceExit",
@@ -51,18 +51,18 @@
     }
   },
   "devDependencies": {
-    "@types/jest": "^25.1.0",
-    "@types/node": "^13.9.0",
-    "@typescript-eslint/eslint-plugin": "^2.24.0",
-    "@typescript-eslint/parser": "^2.24.0",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.1.0",
-    "eslint-plugin-import": "^2.20.0",
-    "husky": "^4.2.0",
-    "jest": "^25.1.0",
-    "socket.io": "^2.3.0",
-    "socket.io-client": "^2.3.0",
-    "ts-jest": "^25.2.0",
-    "typescript": "^3.8.0"
+    "@types/jest": "^26.0.0",
+    "@types/node": "^14.14.0",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
+    "eslint": "^7.24.0",
+    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint-plugin-import": "^2.22.0",
+    "husky": "^6.0.0",
+    "jest": "^26.6.0",
+    "socket.io": "^4.0.0",
+    "socket.io-client": "^4.0.0",
+    "ts-jest": "^26.5.0",
+    "typescript": "^4.2.0"
   }
 }
diff --git a/packages/ipc/package.json b/packages/ipc/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@kalm/ipc",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "IPC transport for Kalm",
   "main": "bin/ipc.js",
   "scripts": {
@@ -9,6 +9,9 @@
     "test": "jest ./tests",
     "prepublish": "cp ../../LICENSE ./LICENSE && cp ../../CHANGELOG.md ./CHANGELOG.md"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "funding": {
     "type": "Open Collective",
     "url": "https://opencollective.com/kalm"

diff --git a/packages/ipc/src/ipc.ts b/packages/ipc/src/ipc.ts
@@ -5,6 +5,9 @@ import net from 'net';
 /* Methods -------------------------------------------------------------------*/
 
 interface IPCSocket extends net.Socket {
+  server: {
+    _connectionKey: string
+  }
   _server: {
     _pipeName: string
   }
@@ -25,8 +28,8 @@ function ipc({ socketTimeout = 30000, path = '/tmp/app.socket-' }: IPCConfig = {
 
     function remote(handle: IPCSocket): Remote {
       return {
-        host: handle && handle._server && handle._server._pipeName || null,
-        port: handle && handle._handle && handle._handle.fd || null,
+        host: handle?._server?._pipeName || handle?.server?._connectionKey || null,
+        port: handle?._handle?.fd || null,
       };
     }
 

diff --git a/packages/ipc/types.d.ts b/packages/ipc/types.d.ts
@@ -1,3 +1,5 @@
+/* eslint-disable */
+
 declare module '@kalm/ipc' {
     interface IPCConfig {
         socketTimeout?: number

diff --git a/packages/kalm/package.json b/packages/kalm/package.json
@@ -1,6 +1,6 @@
 {
   "name": "kalm",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "The socket optimizer",
   "main": "bin/kalm.js",
   "scripts": {
@@ -9,6 +9,9 @@
     "test": "jest ./tests",
     "prepublish": "cp ../../LICENSE ./LICENSE && cp ../../CHANGELOG.md ./CHANGELOG.md"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "funding": {
     "type": "Open Collective",
     "url": "https://opencollective.com/kalm"

diff --git a/packages/kalm/src/components/client.ts b/packages/kalm/src/components/client.ts
@@ -11,6 +11,10 @@ export function Client(params: ClientConfig, emitter: NodeJS.EventEmitter, handl
   const routine = params.routine(params, new EventEmitter());
   const socket: Socket = params.transport(params, emitter);
   let totalMessages = 0;
+  let instance;
+
+  const remote: Remote = (params.isServer) ? socket.remote(handle) : { host: params.host, port: params.port };
+  const local: Remote = (params.isServer) ? { host: params.host, port: params.port } : null;
 
   function _resolveChannel(channelName: string): Channel {
     if (!(channelName in channels)) {
@@ -54,7 +58,7 @@ export function Client(params: ClientConfig, emitter: NodeJS.EventEmitter, handl
             channels[channelName].handlers.forEach(handler => handler(
               packet,
               {
-                client: params,
+                client: instance,
                 frame: {
                   channel: channelName,
                   id: frame.frameId,
@@ -105,24 +109,6 @@ export function Client(params: ClientConfig, emitter: NodeJS.EventEmitter, handl
     if (channels[channelName].handlers.length === 0 && channels[channelName].packets.length === 0) delete channels[channelName];
   }
 
-  function remote(): Remote {
-    if (params.isServer) return socket.remote(handle);
-    return {
-      host: params.host,
-      port: params.port,
-    };
-  }
-
-  function local(): Remote {
-    if (params.isServer) {
-      return {
-        host: params.host,
-        port: params.port,
-      };
-    }
-    return null;
-  }
-
   routine.emitter.on('runQueue', _wrap);
   emitter.on('connect', _handleConnect);
   emitter.on('disconnect', _handleDisconnect);
@@ -131,7 +117,7 @@ export function Client(params: ClientConfig, emitter: NodeJS.EventEmitter, handl
   if (!handle) log(`connecting to ${params.host}:${params.port}`);
   handle = socket.connect(handle);
 
-  return Object.assign(emitter, {
+  instance = Object.assign(emitter, {
     write,
     destroy,
     subscribe,
@@ -141,4 +127,5 @@ export function Client(params: ClientConfig, emitter: NodeJS.EventEmitter, handl
     label: params.label,
     getChannels,
   });
+  return instance;
 }
diff --git a/packages/kalm/src/kalm.ts b/packages/kalm/src/kalm.ts
@@ -36,6 +36,8 @@ function validateOptions(options: ProviderConfig): void {
     throw new Error('Transport is not valid, it may not have been invoked, see: https://github.com/kalm/kalm.js#documentation');
   }
 
+  if (options.port && !isNaN(options.port)) options.port = +options.port;
+
   if (options.routine) {
     if (typeof options.transport !== 'function') {
       throw new Error(`Routine is not a function (${options.routine}), see: https://github.com/kalm/kalm.js#documentation`);

diff --git a/packages/kalm/types.d.ts b/packages/kalm/types.d.ts
@@ -1,10 +1,12 @@
+/* eslint-disable */
+
 declare module 'kalm' {
     interface ClientConfig {
         label?: string
         routine?: KalmRoutine
         json?: Boolean
         transport?: KalmTransport
-        port?: number
+        port?: number|string
         host?: string
         isServer?: boolean
         provider?: any
@@ -36,8 +38,8 @@ declare module 'kalm' {
         destroy: () => void
         subscribe: (channel: string, handler: (body: any, frame: Frame) => any) => void
         unsubscribe: (channel: string, handler: (body: any, frame: Frame) => any) => void
-        local: () => Remote
-        remote: () => Remote
+        local: Remote
+        remote: Remote
     }
 
     type Channel = {

diff --git a/packages/tcp/package.json b/packages/tcp/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@kalm/tcp",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "TCP transport for Kalm",
   "main": "bin/tcp.js",
   "scripts": {
@@ -9,6 +9,9 @@
     "test": "jest ./tests",
     "prepublish": "cp ../../LICENSE ./LICENSE && cp ../../CHANGELOG.md ./CHANGELOG.md"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "funding": {
     "type": "Open Collective",
     "url": "https://opencollective.com/kalm"

diff --git a/packages/tcp/src/tcp.ts b/packages/tcp/src/tcp.ts
@@ -4,6 +4,13 @@ import net from 'net';
 
 /* Methods -------------------------------------------------------------------*/
 
+interface TCPSocket extends net.Socket {
+  _peername: {
+    address: string
+    port: number
+  }
+}
+
 function tcp({ socketTimeout = 30000 }: TCPConfig = {}): KalmTransport {
   return function socket(params: ClientConfig, emitter: NodeJS.EventEmitter): Socket {
     let listener: net.Server;
@@ -14,10 +21,10 @@ function tcp({ socketTimeout = 30000 }: TCPConfig = {}): KalmTransport {
       listener.listen(params.port, () => emitter.emit('ready'));
     }
 
-    function remote(handle: net.Socket): Remote {
+    function remote(handle: TCPSocket): Remote {
       return {
-        host: handle && handle.remoteAddress || null,
-        port: handle && handle.remotePort || null,
+        host: handle?.remoteAddress || handle?._peername?.address || null,
+        port: handle?.remotePort || handle?._peername?.port || null,
       };
     }
 

diff --git a/packages/tcp/types.d.ts b/packages/tcp/types.d.ts
@@ -1,3 +1,5 @@
+/* eslint-disable */
+
 declare module '@kalm/tcp' {
     interface TCPConfig {
         socketTimeout?: number

diff --git a/packages/udp/package.json b/packages/udp/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@kalm/udp",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "UDP transport for Kalm",
   "main": "bin/udp.js",
   "scripts": {
@@ -13,6 +13,9 @@
     "type": "Open Collective",
     "url": "https://opencollective.com/kalm"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kalm/kalm-js.git"