@nxtedition/deepstream.io-client-js 27.0.1 → 28.0.0

package/benchmark/message-builder.mjs

@@ -0,0 +1,47 @@
+import { randomBytes } from 'node:crypto'
+import { Bench } from 'tinybench'
+import { getMsg } from '../src/message/message-builder.js'
+
+const bench = new Bench()
+
+const name = randomBytes(16).toString('hex')
+const version = randomBytes(16).toString('hex')
+const body = randomBytes(256).toString('hex')
+
+function getMsgString(topic, action, data) {
+  let msg = `R${topic}U${action}`
+  if (data) {
+    for (let i = 0; i < data.length; i++) {
+      const type = typeof data[i]
+      if (data[i] == null) {
+        msg += '\u0001'
+        msg += ''
+      } else if (type === 'object') {
+        msg += '\u0001'
+        msg += JSON.stringify(data[i])
+      } else if (type === 'bigint') {
+        msg += '\u0001'
+        msg += data[i].toString()
+      } else if (type === 'string') {
+        msg += '\u0001'
+        msg += data[i]
+      } else {
+        throw new Error('invalid data')
+      }
+    }
+  }
+  return msg
+}
+
+bench
+  .add('build message string', () => {
+    getMsgString('R', 'U', [ name, version, body ])
+  })
+  .add('build message buffer', () => {
+    getMsg('R', 'U', [ name, version, body ])
+  })
+
+await bench.warmup()
+await bench.run()
+
+console.table(bench.table())

package/eslint.config.mjs

@@ -0,0 +1,80 @@
+import eslint from '@eslint/js'
+import tseslint from 'typescript-eslint'
+import eslintConfigPrettier from 'eslint-config-prettier'
+import eslintPluginImport from 'eslint-plugin-import'
+import eslintPluginN from 'eslint-plugin-n'
+import eslintPluginPromise from 'eslint-plugin-promise'
+import typescriptEslintParser from '@typescript-eslint/parser'
+import globals from 'globals'
+
+const reactFiles = [
+  'app/src/renderer/**/*{js,ts,tsx}',
+  'hub/src/client/**/*.{js,ts,tsx}',
+  'hub/.storybook/**/*.{js,ts,tsx}',
+  'plugins/adobe/**/*{js,ts,tsx}',
+]
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+
+  {
+    ignores: [
+      'tmp*',
+      'benchmarks/**/*',
+    ],
+  },
+
+  // Base config:
+  {
+    plugins: {
+      import: eslintPluginImport,
+      promise: eslintPluginPromise,
+    },
+    languageOptions: {
+      parser: typescriptEslintParser,
+      parserOptions: {
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      'prefer-const': [
+        'error',
+        {
+          destructuring: 'all',
+        },
+      ],
+      'no-empty': ['error', { allowEmptyCatch: true }],
+      'no-constant-condition': ['error', { checkLoops: false }],
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          args: 'none',
+          ignoreRestSiblings: true,
+        },
+      ],
+      'getter-return': 'off',
+      'object-shorthand': ['warn', 'properties'],
+    },
+  },
+
+  // Node specific
+  {
+    ignores: [...reactFiles],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+    plugins: {
+      n: eslintPluginN,
+    },
+    rules: {
+      'no-redeclare': 'warn',
+      'require-yield': 'off',
+    },
+  },
+
+  // Prettier:
+  eslintConfigPrettier
+)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/deepstream.io-client-js",
-  "version": "27.0.1",
+  "version": "28.0.0",
   "description": "the javascript client for deepstream.io",
   "homepage": "http://deepstream.io",
   "type": "module",
@@ -33,31 +33,6 @@
     "semi": false,
     "singleQuote": true
   },
-  "eslintConfig": {
-    "parserOptions": {
-      "ecmaFeatures": {
-        "ecmaVersion": 2020
-      }
-    },
-    "extends": [
-      "standard",
-      "prettier",
-      "prettier/prettier"
-    ],
-    "rules": {
-      "quotes": [
-        "error",
-        "single",
-        {
-          "avoidEscape": true,
-          "allowTemplateLiterals": true
-        }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "/__tests__"
-  ],
   "dependencies": {
     "@nxtedition/json-path": "^1.0.8",
     "bufferutil": "^4.0.8",
@@ -71,20 +46,21 @@
     "xxhash-wasm": "^1.0.2"
   },
   "devDependencies": {
-    "@types/node": "^22.0.0",
-    "eslint": "^8.0.0",
+    "eslint": "^9.9.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^17.10.1",
+    "eslint-plugin-n": "^17.10.2",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^7.0.0",
-    "husky": "^9.1.3",
-    "lint-staged": "^15.2.7",
+    "eslint-plugin-promise": "^7.1.0",
+    "husky": "^9.1.4",
+    "lint-staged": "^15.2.8",
     "mitata": "^0.1.11",
     "pinst": "^3.0.0",
     "prettier": "^3.3.3",
-    "rxjs": "^7.8.1"
+    "rxjs": "^7.8.1",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.1"
   },
   "peerDependencies": {
     "rxjs": ">=6.x"

package/src/event/event-handler.js

@@ -4,7 +4,7 @@ import * as messageParser from '../message/message-parser.js'
 import MulticastListener from '../utils/multicast-listener.js'
 import UnicastListener from '../utils/unicast-listener.js'
 import EventEmitter from 'component-emitter2'
-import rxjs from 'rxjs'
+import * as rxjs from 'rxjs'
 
 const EventHandler = function (options, connection, client) {
   this._options = options
@@ -79,7 +79,7 @@ EventHandler.on = function (name, callback) {
 EventHandler.once = function (name, callback) {
   const fn = (...args) => {
     this.unsubscribe(fn)
-    callback(...args) // eslint-disable-line
+    callback(...args)
   }
   this.subscribe(name, fn)
   return this

package/src/message/connection.js

@@ -4,8 +4,9 @@ import * as messageBuilder from './message-builder.js'
 import * as C from '../constants/constants.js'
 import FixedQueue from '../utils/fixed-queue.js'
 import Emitter from 'component-emitter2'
+import pkg from '../../package.json' with { type: 'json' }
+import NodeWebSocket from 'ws'
 
-const NodeWebSocket = utils.isNode ? await import('ws').then((x) => x.default) : null
 const BrowserWebSocket = globalThis.WebSocket || globalThis.MozWebSocket
 
 export default function Connection(client, url, options) {
@@ -26,6 +27,7 @@ export default function Connection(client, url, options) {
     action: null,
     data: null,
   }
+  this._decoder = new globalThis.TextDecoder()
   this._recvQueue = new FixedQueue()
   this._reconnectTimeout = null
   this._reconnectionAttempt = 0
@@ -88,19 +90,23 @@ Connection.prototype.close = function () {
 }
 
 Connection.prototype._createEndpoint = function () {
-  this._endpoint = NodeWebSocket
-    ? new NodeWebSocket(this._url, {
-        generateMask() {},
-      })
-    : new BrowserWebSocket(this._url)
+  if (utils.isNode) {
+    this._endpoint = new NodeWebSocket(this._url, {
+      generateMask() {},
+    })
+    this._endpoint.binaryType = 'nodebuffer'
+  } else {
+    this._endpoint = new BrowserWebSocket(this._url)
+    this._endpoint.binaryType = 'arraybuffer'
+  }
+
   this._corked = false
 
   this._endpoint.onopen = this._onOpen.bind(this)
   this._endpoint.onerror = this._onError.bind(this)
   this._endpoint.onclose = this._onClose.bind(this)
-  this._endpoint.onmessage = BrowserWebSocket
-    ? ({ data }) => this._onMessage(typeof data === 'string' ? data : Buffer.from(data).toString())
-    : ({ data }) => this._onMessage(typeof data === 'string' ? data : data.toString())
+  this._endpoint.onmessage = ({ data }) =>
+    this._onMessage(typeof data === 'string' ? data : this._decoder.decode(data))
 }
 
 Connection.prototype.send = function (message) {
@@ -117,6 +123,10 @@ Connection.prototype.send = function (message) {
     return false
   }
 
+  if (!this._endpoint) {
+    return false
+  }
+
   if (
     this._state !== C.CONNECTION_STATE.OPEN ||
     this._endpoint.readyState !== this._endpoint.OPEN
@@ -134,6 +144,7 @@ Connection.prototype.send = function (message) {
   }
 
   this.emit('send', message)
+
   this._endpoint.send(message)
 
   return true
@@ -146,7 +157,7 @@ Connection.prototype._submit = function (message) {
     const err = new Error(`Packet to big: ${message.length} > ${maxPacketSize}`)
     this._client._$onError(C.TOPIC.CONNECTION, C.EVENT.CONNECTION_ERROR, err)
     return false
-  } else if (this._endpoint.readyState === this._endpoint.OPEN) {
+  } else if (this._endpoint != null && this._endpoint.readyState === this._endpoint.OPEN) {
     this.emit('send', message)
     this._endpoint.send(message)
     return true
@@ -161,7 +172,7 @@ Connection.prototype._sendAuthParams = function () {
   this._setState(C.CONNECTION_STATE.AUTHENTICATING)
   const authMessage = messageBuilder.getMsg(C.TOPIC.AUTH, C.ACTIONS.REQUEST, [
     this._authParams,
-    '27.0.0',
+    pkg.version,
     utils.isNode
       ? `Node/${process.version}`
       : globalThis.navigator && globalThis.navigator.userAgent,
@@ -222,7 +233,6 @@ Connection.prototype._onMessage = function (data) {
 Connection.prototype._recvMessages = function (deadline) {
   for (
     let n = 0;
-    // eslint-disable-next-line no-unmodified-loop-condition
     deadline ? deadline.didTimeout || deadline.timeRemaining() : n < this._batchSize;
     ++n
   ) {

package/src/message/message-builder.js

@@ -6,7 +6,7 @@ const poolEncoder = new globalThis.TextEncoder()
 
 // TODO (fix): Don't assume maxMesageSize is 1MB
 const maxMessageSize = 1024 * 1024
-const poolSize = maxMessageSize * 4
+const poolSize = maxMessageSize * 8
 
 let poolBuffer
 let poolView
@@ -51,9 +51,12 @@ export function getMsg(topic, action, data) {
   const start = poolOffset
 
   const headerSize = 8
-  poolBuffer[poolOffset++] = 128 + headerSize
-  let headerPos = poolOffset
-  poolOffset += headerSize - 1
+  for (let n = 0; n < headerSize; n++) {
+    poolBuffer[poolOffset++] = 0
+  }
+
+  let headerPos = start
+  poolBuffer[headerPos++] = 128 + headerSize
 
   poolBuffer[poolOffset++] = topic.charCodeAt(0)
   poolBuffer[poolOffset++] = 31

package/src/record/record-handler.js

@@ -2,12 +2,11 @@ import Record from './record.js'
 import MulticastListener from '../utils/multicast-listener.js'
 import UnicastListener from '../utils/unicast-listener.js'
 import * as C from '../constants/constants.js'
-import rxjs from 'rxjs'
+import * as rxjs from 'rxjs'
 import invariant from 'invariant'
 import EventEmitter from 'component-emitter2'
 import jsonPath from '@nxtedition/json-path'
 import * as utils from '../utils/utils.js'
-import rx from 'rxjs/operators'
 import xuid from 'xuid'
 import * as timers from '../utils/timers.js'
 
@@ -97,19 +96,11 @@ class RecordHandler {
     this._connection = connection
     this._client = client
     this._records = new Map()
-    this._cache = new Map()
     this._listeners = new Map()
     this._pruning = new Set()
     this._patching = new Map()
     this._updating = new Map()
 
-    this._registry = new FinalizationRegistry((name) => {
-      const entry = this._cache.get(name)
-      if (entry && entry.deref && entry.deref() === undefined) {
-        this._cache.delete(name)
-      }
-    })
-
     this._connected = 0
     this._stats = {
       updating: 0,
@@ -142,11 +133,6 @@ class RecordHandler {
       for (const rec of pruning) {
         rec._$dispose()
         this._records.delete(rec.name)
-
-        if (!this._cache.has(rec.name)) {
-          this._cache.set(rec.name, new WeakRef(rec))
-          this._registry.register(rec, rec.name)
-        }
       }
 
       this._stats.pruning -= pruning.size
@@ -232,7 +218,7 @@ class RecordHandler {
     let record = this._records.get(name)
 
     if (!record) {
-      record = this._cache.get(name)?.deref() ?? new Record(name, this)
+      record = new Record(name, this)
       this._stats.records += 1
       this._stats.created += 1
       this._records.set(name, record)
@@ -485,7 +471,7 @@ class RecordHandler {
       // TODO (fix): Missing sync..
       return new Promise((resolve, reject) => {
         this.observe(...args)
-          .pipe(rx.first())
+          .pipe(rxjs.first())
           .subscribe({
             next: resolve,
             error: reject,
@@ -501,7 +487,7 @@ class RecordHandler {
   get2(...args) {
     return new Promise((resolve, reject) => {
       this.observe2(...args)
-        .pipe(rx.first())
+        .pipe(rxjs.first())
         .subscribe({
           next: resolve,
           error: reject,

package/src/record/record.js

@@ -7,7 +7,7 @@ import invariant from 'invariant'
 import cloneDeep from 'lodash.clonedeep'
 import * as timers from '../utils/timers.js'
 
-export default class Record {
+class Record {
   static STATE = C.RECORD_STATE
 
   constructor(name, handler) {
@@ -15,7 +15,6 @@ export default class Record {
 
     this._handler = handler
     this._name = name
-    this._key = utils.h64(name)
     this._version = ''
     this._data = jsonPath.EMPTY
     this._state = C.RECORD_STATE.VOID
@@ -25,15 +24,7 @@ export default class Record {
 
     /** @type Map? */ this._updating = null
     /** @type Array? */ this._patching = null
-    this._subscribed = connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [
-      this._key,
-      this._name,
-    ])
-  }
-
-  /** @type {bigint} */
-  get key() {
-    return this._key
+    this._subscribed = connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [this._name])
   }
 
   /** @type {string} */
@@ -71,8 +62,7 @@ export default class Record {
     if (this._refs === 1) {
       this._handler._onPruning(this, false)
       this._subscribed =
-        this._subscribed ||
-        connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [this._key, this._name])
+        this._subscribed || connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [this._name])
     }
     return this
   }
@@ -334,8 +324,7 @@ export default class Record {
 
     if (connected) {
       this._subscribed =
-        this._refs > 0 &&
-        connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [this._key, this._name])
+        this._refs > 0 && connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [this._name])
 
       if (this._updating) {
         for (const update of this._updating.values()) {
@@ -360,7 +349,7 @@ export default class Record {
     invariant(!this._updating, 'must not have updates')
 
     if (this._subscribed) {
-      connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.UNSUBSCRIBE, [this._key])
+      connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.UNSUBSCRIBE, [this._name])
       this._subscribed = false
     }
 
@@ -382,7 +371,7 @@ export default class Record {
     const prevVersion = this._version
     const nextVersion = this._makeVersion(parseInt(prevVersion) + 1)
 
-    const update = [this._key, nextVersion, jsonPath.stringify(nextData), prevVersion]
+    const update = [this._name, nextVersion, jsonPath.stringify(nextData), prevVersion]
 
     if (!this._updating) {
       this._onUpdating(true)
@@ -584,3 +573,5 @@ Object.defineProperty(Record.prototype, 'hasProvider', {
     return this.state >= C.RECORD_STATE.PROVIDER
   },
 })
+
+export default Record

package/src/utils/multicast-listener.js

@@ -1,6 +1,6 @@
 import * as rxjs from 'rxjs'
 import * as C from '../constants/constants.js'
-import { h64, h64ToString } from '../utils/utils.js'
+import { h64ToString } from '../utils/utils.js'
 
 export default class Listener {
   constructor(topic, pattern, callback, handler, { recursive = false, stringify = null } = {}) {
@@ -48,12 +48,8 @@ export default class Listener {
 
     const name = message.data[1]
 
-    // TOOD (fix): Validate name
-
-    const key = h64(name)
-
     if (message.action === C.ACTIONS.SUBSCRIPTION_FOR_PATTERN_FOUND) {
-      if (this._subscriptions.has(key)) {
+      if (this._subscriptions.has(name)) {
         this._error(name, 'invalid add: listener exists')
         return
       }
@@ -61,7 +57,6 @@ export default class Listener {
       // TODO (refactor): Move to class
       const provider = {
         name,
-        key,
         value$: null,
         sending: false,
         accepted: false,
@@ -74,7 +69,7 @@ export default class Listener {
         if (this.connected && provider.accepted) {
           this._connection.sendMsg(this._topic, C.ACTIONS.LISTEN_REJECT, [
             this._pattern,
-            provider.key,
+            provider.name,
           ])
         }
 
@@ -107,7 +102,7 @@ export default class Listener {
         this._connection.sendMsg(
           this._topic,
           accepted ? C.ACTIONS.LISTEN_ACCEPT : C.ACTIONS.LISTEN_REJECT,
-          [this._pattern, provider.key],
+          [this._pattern, provider.name],
         )
 
         provider.version = null
@@ -163,7 +158,7 @@ export default class Listener {
             if (provider.version !== version) {
               provider.version = version
               this._connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.UPDATE, [
-                provider.key,
+                provider.name,
                 version,
                 body,
               ])
@@ -187,9 +182,9 @@ export default class Listener {
 
       provider.start()
 
-      this._subscriptions.set(provider.key, provider)
+      this._subscriptions.set(provider.name, provider)
     } else if (message.action === C.ACTIONS.LISTEN_ACCEPT) {
-      const provider = this._subscriptions.get(key)
+      const provider = this._subscriptions.get(name)
       if (!provider?.value$) {
         return
       }
@@ -201,13 +196,13 @@ export default class Listener {
         provider.valueSubscription = provider.value$.subscribe(provider.observer)
       }
     } else if (message.action === C.ACTIONS.SUBSCRIPTION_FOR_PATTERN_REMOVED) {
-      const provider = this._subscriptions.get(key)
+      const provider = this._subscriptions.get(name)
 
       if (!provider) {
         this._error(name, 'invalid remove: listener missing')
       } else {
         provider.stop()
-        this._subscriptions.delete(provider.key)
+        this._subscriptions.delete(provider.name)
       }
     } else {
       return false

package/src/utils/timers.js

@@ -1,10 +1,11 @@
-let fastNow = Date.now()
+const fastNowInterval = 1e3
+let fastNow = 0
 let fastNowTimeout
 
 const fastTimers = []
 
 function onTimeout() {
-  fastNow = Date.now()
+  fastNow += fastNowInterval
 
   let len = fastTimers.length
   let idx = 0
@@ -41,7 +42,7 @@ function refreshTimeout() {
     fastNowTimeout.refresh()
   } else {
     globalThis.clearTimeout(fastNowTimeout)
-    fastNowTimeout = globalThis.setTimeout(onTimeout, 1e3)
+    fastNowTimeout = globalThis.setTimeout(onTimeout, fastNowInterval)
     if (fastNowTimeout.unref) {
       fastNowTimeout.unref()
     }
@@ -80,7 +81,7 @@ class Timeout {
 }
 
 export function setTimeout(callback, delay, opaque) {
-  return delay < 1e3
+  return delay < fastNowInterval
     ? globalThis.setTimeout(callback, delay, opaque)
     : new Timeout(callback, delay, opaque)
 }

package/src/utils/unicast-listener.js

@@ -1,8 +1,8 @@
 import * as rxjs from 'rxjs'
 import * as C from '../constants/constants.js'
-import { h64, h64ToString } from '../utils/utils.js'
+import { h64ToString } from '../utils/utils.js'
 
-const valuePipe = rxjs.pipe(
+const PIPE = rxjs.pipe(
   rxjs.map((value) => {
     let data
     if (value && typeof value === 'string') {
@@ -55,12 +55,8 @@ export default class Listener {
   _$onMessage(message) {
     const name = message.data[1]
 
-    // TODO (fix): Validate name
-
-    const key = h64(name)
-
     if (message.action === C.ACTIONS.LISTEN_ACCEPT) {
-      if (this._subscriptions.has(key)) {
+      if (this._subscriptions.has(name)) {
         this._error(name, 'invalid accept: listener exists')
         return
       }
@@ -73,32 +69,32 @@ export default class Listener {
       }
 
       if (value$) {
-        const subscription = value$.pipe(valuePipe).subscribe({
+        const subscription = value$.pipe(PIPE).subscribe({
           next: (data) => {
             if (data == null) {
-              this._connection.sendMsg(this._topic, C.ACTIONS.LISTEN_REJECT, [this._pattern, key])
-              this._subscriptions.delete(key)
+              this._connection.sendMsg(this._topic, C.ACTIONS.LISTEN_REJECT, [this._pattern, name])
+              this._subscriptions.delete(name)
               subscription.unsubscribe()
             } else {
               const version = `INF-${h64ToString(data)}`
-              this._connection.sendMsg(this._topic, C.ACTIONS.UPDATE, [key, version, data])
+              this._connection.sendMsg(this._topic, C.ACTIONS.UPDATE, [name, version, data])
             }
           },
           error: (err) => {
             this._error(name, err)
-            this._connection.sendMsg(this._topic, C.ACTIONS.LISTEN_REJECT, [this._pattern, key])
-            this._subscriptions.delete(key)
+            this._connection.sendMsg(this._topic, C.ACTIONS.LISTEN_REJECT, [this._pattern, name])
+            this._subscriptions.delete(name)
           },
         })
-        this._subscriptions.set(key, subscription)
+        this._subscriptions.set(name, subscription)
       } else {
-        this._connection.sendMsg(this._topic, C.ACTIONS.LISTEN_REJECT, [this._pattern, key])
+        this._connection.sendMsg(this._topic, C.ACTIONS.LISTEN_REJECT, [this._pattern, name])
       }
     } else if (message.action === C.ACTIONS.LISTEN_REJECT) {
-      const subscription = this._subscriptions.get(key)
+      const subscription = this._subscriptions.get(name)
 
       if (subscription) {
-        this._subscriptions.delete(key)
+        this._subscriptions.delete(name)
         subscription.unsubscribe()
       } else {
         this._error(name, 'invalid remove: listener missing')

package/src/utils/utils.js

@@ -129,7 +129,7 @@ function defaultSchedule(fn) {
   setTimeout(fn, 0)
 }
 
-export const schedule = isNode ? defaultSchedule : window.requestIdleCallback
+export const schedule = isNode ? defaultSchedule : globalThis.requestIdleCallback
 
 const abortSignals = new WeakMap()
 const onAbort = function () {
@@ -177,16 +177,11 @@ export function removeAbortListener(signal, handler) {
   }
 }
 
-const HASHER = await xxhash()
-
-export function h64(str) {
-  return HASHER.h64(str)
-}
+// This is a hack to avoid top-level await
+// const HASHER = await xxhash()
+let HASHER
+xxhash().then((hasher) => (HASHER = hasher))
 
 export function h64ToString(str) {
   return HASHER.h64ToString(str)
 }
-
-export function h64Raw(str) {
-  return HASHER.h64Raw(str)
-}