v7.0.0 (#40)

* ts cleanup, housekeeping, ws agent and timeout

* modernized linter, fixed types, added udp timeout, added ts transports config comments

* updated READMEs, added description in ts definitions, fixed bugs in tick

Author: fed135

.eslintignore

@@ -1,4 +1,6 @@
 *.js
 examples
 node_modules
-scripts
+scripts
+*.d.ts
+tests

.eslintrc

@@ -1,16 +1,16 @@
 {
-    "extends": "airbnb-base",
-    "parser": "@typescript-eslint/parser",
-    "plugins": [ "import", "@typescript-eslint" ],
-    "settings": {
-      "import/resolver": {
-        "node": {
-          "paths": ["packages"],
-          "extensions": [".ts", ".spec.ts"]
-        }
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "plugins": [ "@typescript-eslint" ],
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".js", ".ts"],
+        "moduleDirectory": ["node_modules", "packages/"]
       }
-    },
-    "rules": {
+    }
+  },
+  "rules": {
         "import/extensions": 0,
         "no-bitwise": 0,
         "linebreak-style": 1,
@@ -26,13 +26,14 @@
         "no-continue": 0,
         "no-unused-vars": 0,
         "global-require": 0,
-        "max-len": [1, 140],
+        "max-len": [1, 180],
         "@typescript-eslint/no-unused-vars": [
             "error", 
             { "vars": "all", "args": "after-used", "ignoreRestSiblings": false }
         ],
-        "import/no-extraneous-dependencies": 0,
-        "import/no-unresolved": 1
+        "@typescript-eslint/no-explicit-any": 0,
+        "@typescript-eslint/ban-types": 0,
+        "@typescript-eslint/no-empty-function": 0
     },
     "env": {
         "browser": true,

CHANGELOG.md

@@ -1,8 +1,41 @@
 # Changelog
 
+## [v7.0.0] - 2023-03-17
+
+commit [#](https://github.com/kalm/kalm.js/commits)
+
+### Major changes
+
+- Standardized parameter names and expected behavior
+  - Removed `secure` WS option, instead checking if `cert` and `key` are set
+  - Routines.dynamic option `hz` is now `maxInterval` and is measured in milliseconds
+  - Renamed `provider` internally to `server` for easier understanding
+  - Removed previously deprecated UDP `connectTimeout` option
+- Added UDP idle timeout behavior
+- Added WS idle timeout behavior
+- Added WS Agent option for proxying
+- frameId counter now goes up to 0xffffffff before cycling instead of 0xffff
+
+### Bug fixes
+
+- Fixed an issue in Routines.tick where all queues shared the same frameId counter
+- Routines.tick option `seed` now correctly sets the `frameId` and starts the counter to match the expected pace
+- Fixed references to Node modules in TS definitions
+
+## [v6.1.0] - 2022-09-21
+
+commit [a0e88e3](https://github.com/kalm/kalm.js/commit/a0e88e310d98646b53fbcc56f6efeea4db5e87d8)
+
+### Major changes
+
+- Removed SYN/ACK UDP handshake, which removes the socket timeout behaviour for that transport
+- Added error event for UDP packet over the safe limit (16384 bytes), previous behaviour was to crash silently
+- Routines are no longer event emitters, but have a size function
+
+
 ## [v6.0.0] - 2021-04-26
 
-commit: [#](https://github.com/kalm/kalm.js/commits)
+commit: [47b810d](https://github.com/kalm/kalm.js/commit/47b810d5ab212686c3194d53e781e1728bd735f9)
 
 ### Breaking changes
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 Frederic Charette
+Copyright 2023 Frederic Charette
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

SECURITY.md

@@ -4,9 +4,9 @@
 
 | Version | Supported |
 | ------- | ------------------ |
+| 7.x | :white_check_mark: |
 | 6.x | :white_check_mark: |
-| 5.x | :white_check_mark: |
-| <= 4.x | :x: |
+| <= 5.x | :x: |
 
 ## Reporting a Vulnerability
 

examples/typescript/client.ts

@@ -2,7 +2,7 @@ import {connect, routines} from 'kalm';
 import ws from '@kalm/ws';
 
 const client = connect({
-  transport: ws(),
+  transport: ws({}),
   port: 3938,
   routine: routines.realtime(),
 });

package.json

@@ -1,12 +1,12 @@
 {
   "name": "kalm",
   "private": true,
-  "version": "6.1.0",
+  "version": "7.0.0",
   "description": "The socket optimizer",
   "main": "packages/kalm/bin/kalm.js",
   "scripts": {
-    "lint": "eslint packages/**/*.ts packages/**/*.spec.ts tests/**/*.spec.ts",
-    "lint:fix": "yarn lint --fix",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "test": "yarn workspaces run test && yarn run test:integration",
     "test:integration": "jest ./tests/integration --forceExit",
     "build": "yarn workspaces run build",
@@ -52,18 +52,16 @@
     }
   },
   "devDependencies": {
-    "@types/jest": "^29.2.0",
-    "@types/node": "^18.11.0",
-    "@typescript-eslint/eslint-plugin": "^5.40.0",
-    "@typescript-eslint/parser": "^5.40.0",
-    "eslint": "^8.25.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.26.0",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.15.0",
+    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@typescript-eslint/parser": "^5.55.0",
+    "eslint": "^8.36.0",
     "husky": "^8.0.0",
-    "jest": "^29.2.0",
-    "socket.io": "^4.5.0",
-    "socket.io-client": "^4.5.0",
+    "jest": "^29.5.0",
+    "socket.io": "^4.6.0",
+    "socket.io-client": "^4.6.0",
     "ts-jest": "^29.0.0",
-    "typescript": "^4.8.0"
+    "typescript": "^4.9.0"
   }
 }

packages/ipc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kalm/ipc",
-  "version": "6.1.0",
+  "version": "7.0.0",
   "description": "IPC transport for Kalm",
   "main": "bin/ipc.js",
   "scripts": {

packages/ipc/src/ipc.ts

@@ -1,21 +1,22 @@
-/* Requires ------------------------------------------------------------------*/
-
 import net from 'net';
 
-/* Methods -------------------------------------------------------------------*/
-
 interface IPCSocket extends net.Socket {
-  server: {
+  server?: {
     _connectionKey: string
   }
-  _server: {
+  _server?: {
     _pipeName: string
   }
-  _handle: {
+  _handle?: {
     fd: number
   }
 }
 
+type IPCConfig = {
+  socketTimeout?: number
+  path?: string
+}
+
 function ipc({ socketTimeout = 30000, path = '/tmp/app.socket-' }: IPCConfig = {}): KalmTransport {
   return function socket(params: ClientConfig, emitter: NodeJS.EventEmitter): Socket {
     let listener: net.Server;
@@ -40,7 +41,7 @@ function ipc({ socketTimeout = 30000, path = '/tmp/app.socket-' }: IPCConfig = {
       }
     }
 
-    function connect(handle: net.Socket): net.Socket {
+    function connect(handle: IPCSocket): IPCSocket {
       const connection: net.Socket = handle || net.connect(`${path}${params.port}`);
       let buffer = '';
       connection.on('data', req => {
@@ -83,6 +84,5 @@ function ipc({ socketTimeout = 30000, path = '/tmp/app.socket-' }: IPCConfig = {
   };
 }
 
-/* Exports -------------------------------------------------------------------*/
-
+// Ensures support for modules and requires
 module.exports = ipc;

packages/ipc/types.d.ts

@@ -1,30 +1,13 @@
-/* eslint-disable */
-
 declare module '@kalm/ipc' {
-    interface IPCConfig {
+interface IPCConfig {
+        /** The maximum idle time for the connection before it hangs up */
         socketTimeout?: number
+        /** The unique path for the IPC file descriptor (Unix only) */
         path?: string
     }
 
-    interface KalmTransport {
-        (params: any, emitter: NodeJS.EventEmitter): Socket
-    }
-
-    type Remote = {
-        host: string
-        port: number
-    }
-
-    type SocketHandle = NodeJS.Socket
-
-    interface Socket {
-        bind: () => void
-        remote: (handle: SocketHandle) => Remote
-        connect: (handle?: SocketHandle) => SocketHandle
-        stop: () => void
-        send: (handle: SocketHandle, message: number[] | Buffer) => void
-        disconnect: (handle: SocketHandle) => void
-    }
-
-    export default function ipc(config?: IPCConfig): (config?: IPCConfig) => Transport;
+    /**
+     * Creates an IPC Transport
+     */
+    export default function ipc(config?: IPCConfig): (config?: IPCConfig) => any;
 }