@nxtedition/deepstream.io-client-js 27.0.0-beta.1 → 27.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/deepstream.io-client-js",
-  "version": "27.0.0-beta.1",
+  "version": "27.0.1",
   "description": "the javascript client for deepstream.io",
   "homepage": "http://deepstream.io",
   "type": "module",
@@ -71,6 +71,7 @@
     "xxhash-wasm": "^1.0.2"
   },
   "devDependencies": {
+    "@types/node": "^22.0.0",
     "eslint": "^8.0.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard": "^17.1.0",

package/src/client.js

@@ -127,12 +127,10 @@ Client.prototype._getOptions = function (options) {
   return mergedOptions
 }
 
-function createDeepstream(url, options) {
+export default function createDeepstream(url, options) {
   return new Client(url, options)
 }
 
 Client.prototype.isSameOrNewer = utils.isSameOrNewer
 Client.prototype.CONSTANTS = C
 createDeepstream.CONSTANTS = C
-
-export default createDeepstream

package/src/event/event-handler.js

@@ -1,10 +1,10 @@
-import * as messageBuilder from '../message/message-builder.js'
-import messageParser from '../message/message-parser.js'
 import * as C from '../constants/constants.js'
+import * as messageBuilder from '../message/message-builder.js'
+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 * as rxjs from 'rxjs'
+import rxjs from 'rxjs'
 
 const EventHandler = function (options, connection, client) {
   this._options = options

package/src/message/connection.js

@@ -1,16 +1,14 @@
 import * as utils from '../utils/utils.js'
-import messageParser from './message-parser.js'
+import * as messageParser from './message-parser.js'
 import * as messageBuilder from './message-builder.js'
 import * as C from '../constants/constants.js'
-import xxhash from 'xxhash-wasm'
 import FixedQueue from '../utils/fixed-queue.js'
 import Emitter from 'component-emitter2'
 
-const HASHER = await xxhash()
 const NodeWebSocket = utils.isNode ? await import('ws').then((x) => x.default) : null
 const BrowserWebSocket = globalThis.WebSocket || globalThis.MozWebSocket
 
-const Connection = function (client, url, options) {
+export default function Connection(client, url, options) {
   this._client = client
   this._options = options
   this._logger = options.logger
@@ -40,8 +38,6 @@ const Connection = function (client, url, options) {
 
   this._state = C.CONNECTION_STATE.CLOSED
 
-  this.hasher = HASHER
-
   this._createEndpoint()
 }
 
@@ -86,30 +82,25 @@ Connection.prototype.close = function () {
   this._endpoint?.close()
 
   if (this._reconnectTimeout) {
-    globalThis.clearTimeout(this._reconnectTimeout)
+    clearTimeout(this._reconnectTimeout)
     this._reconnectTimeout = null
   }
 }
 
 Connection.prototype._createEndpoint = function () {
-  if (utils.isNode) {
-    this._endpoint = new NodeWebSocket(this._url, {
-      generateMask() {},
-    })
-  } else {
-    this._endpoint = new BrowserWebSocket(this._url)
-    this._endpoint.binaryType = 'arraybuffer'
-  }
+  this._endpoint = NodeWebSocket
+    ? new NodeWebSocket(this._url, {
+        generateMask() {},
+      })
+    : new BrowserWebSocket(this._url)
   this._corked = false
 
   this._endpoint.onopen = this._onOpen.bind(this)
   this._endpoint.onerror = this._onError.bind(this)
   this._endpoint.onclose = this._onClose.bind(this)
-
-  const decoder = new TextDecoder()
-  this._endpoint.onmessage = ({ data }) => {
-    this._onMessage(typeof data === 'string' ? data : decoder.decode(data))
-  }
+  this._endpoint.onmessage = BrowserWebSocket
+    ? ({ data }) => this._onMessage(typeof data === 'string' ? data : Buffer.from(data).toString())
+    : ({ data }) => this._onMessage(typeof data === 'string' ? data : data.toString())
 }
 
 Connection.prototype.send = function (message) {
@@ -136,7 +127,7 @@ Connection.prototype.send = function (message) {
   if (this._endpoint._socket && !this._corked) {
     this._endpoint._socket.cork()
     this._corked = true
-    globalThis.setTimeout(() => {
+    setTimeout(() => {
       this._endpoint._socket.uncork()
       this._corked = false
     }, 1)
@@ -245,6 +236,10 @@ Connection.prototype._recvMessages = function (deadline) {
       continue
     }
 
+    if (this._logger) {
+      this._logger.trace(message, 'receive')
+    }
+
     messageParser.parseMessage(message, this._client, this._message)
 
     this.emit('recv', this._message)
@@ -365,5 +360,3 @@ Connection.prototype._clearReconnect = function () {
   }
   this._reconnectionAttempt = 0
 }
-
-export default Connection

package/src/message/message-builder.js

@@ -1,16 +1,18 @@
 import * as C from '../constants/constants.js'
-import varint from 'varint'
 import * as utils from '../utils/utils.js'
+import varint from 'varint'
 
 const poolEncoder = new globalThis.TextEncoder()
 
-let poolSize
+// TODO (fix): Don't assume maxMesageSize is 1MB
+const maxMessageSize = 1024 * 1024
+const poolSize = maxMessageSize * 4
+
 let poolBuffer
 let poolView
 let poolOffset
 
-function allocPool(size) {
-  poolSize = size || poolSize || 1024 * 1024
+function reallocPool() {
   poolBuffer = utils.isNode
     ? globalThis.Buffer.allocUnsafe(poolSize)
     : new Uint8Array(new ArrayBuffer(poolSize))
@@ -40,8 +42,8 @@ export function getMsg(topic, action, data) {
     throw new Error('data must be an array')
   }
 
-  if (!poolSize || poolOffset + poolSize / 16 >= poolSize) {
-    allocPool()
+  if (!poolBuffer || poolOffset + maxMessageSize > poolSize) {
+    reallocPool()
   } else {
     alignPool()
   }
@@ -84,12 +86,11 @@ export function getMsg(topic, action, data) {
       varint.encode(len + 1, poolBuffer, headerPos)
       headerPos += varint.encode.bytes
       if (headerPos - start >= headerSize) {
-        throw new Error(`header too large: ${headerPos - start} ${headerSize}`)
+        throw new Error('header too large')
       }
 
-      if (poolOffset >= poolBuffer.length) {
-        allocPool(start === 0 ? poolSize * 2 : poolSize)
-        return getMsg(topic, action, data)
+      if (poolOffset >= poolSize) {
+        throw new Error('message too large')
       }
     }
   }

package/src/message/message-parser.js

@@ -1,10 +1,12 @@
 import * as C from '../constants/constants.js'
 
-const MessageParser = function () {
-  this._actions = this._getActions()
+const actions = {}
+
+for (const key in C.ACTIONS) {
+  actions[C.ACTIONS[key]] = key
 }
 
-MessageParser.prototype.convertTyped = function (value, client) {
+export function convertTyped(value, client) {
   const type = value.charAt(0)
 
   if (type === C.TYPES.STRING) {
@@ -45,17 +47,7 @@ MessageParser.prototype.convertTyped = function (value, client) {
   return undefined
 }
 
-MessageParser.prototype._getActions = function () {
-  const actions = {}
-
-  for (const key in C.ACTIONS) {
-    actions[C.ACTIONS[key]] = key
-  }
-
-  return actions
-}
-
-MessageParser.prototype.parseMessage = function (message, client, result) {
+export function parseMessage(message, client, result) {
   const parts = message.split(C.MESSAGE_PART_SEPERATOR)
 
   if (parts.length < 2) {
@@ -72,7 +64,7 @@ MessageParser.prototype.parseMessage = function (message, client, result) {
     return null
   }
 
-  if (this._actions[parts[1]] === undefined) {
+  if (actions[parts[1]] === undefined) {
     client._$onError(
       C.TOPIC.ERROR,
       C.EVENT.MESSAGE_PARSE_ERROR,
@@ -87,5 +79,3 @@ MessageParser.prototype.parseMessage = function (message, client, result) {
   result.action = parts[1]
   result.data = parts.splice(2)
 }
-
-export default new MessageParser()

package/src/record/record-handler.js

@@ -2,7 +2,7 @@ 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 * as rxjs from 'rxjs'
+import rxjs from 'rxjs'
 import invariant from 'invariant'
 import EventEmitter from 'component-emitter2'
 import jsonPath from '@nxtedition/json-path'
@@ -97,11 +97,19 @@ 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,
@@ -134,6 +142,11 @@ 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
@@ -219,7 +232,7 @@ class RecordHandler {
     let record = this._records.get(name)
 
     if (!record) {
-      record = new Record(name, this)
+      record = this._cache.get(name)?.deref() ?? new Record(name, this)
       this._stats.records += 1
       this._stats.created += 1
       this._records.set(name, record)

package/src/record/record.js

@@ -1,7 +1,7 @@
 import jsonPath from '@nxtedition/json-path'
 import * as utils from '../utils/utils.js'
 import * as C from '../constants/constants.js'
-import messageParser from '../message/message-parser.js'
+import * as messageParser from '../message/message-parser.js'
 import xuid from 'xuid'
 import invariant from 'invariant'
 import cloneDeep from 'lodash.clonedeep'
@@ -11,40 +11,36 @@ export default class Record {
   static STATE = C.RECORD_STATE
 
   constructor(name, handler) {
-    if (!name?.length || typeof name !== 'string') {
-      throw new Error('invalid argument: name')
-    }
-
     const connection = handler._connection
 
     this._handler = handler
-
     this._name = name
-    this._key = utils.hashNameBigInt(name)
+    this._key = utils.h64(name)
     this._version = ''
     this._data = jsonPath.EMPTY
     this._state = C.RECORD_STATE.VOID
     this._refs = 0
     this._subscriptions = []
     this._emitting = false
+
     /** @type Map? */ this._updating = null
     /** @type Array? */ this._patching = null
     this._subscribed = connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [
-      this._name,
       this._key,
+      this._name,
     ])
   }
 
-  /** @type {string} */
-  get name() {
-    return this._name
-  }
-
   /** @type {bigint} */
   get key() {
     return this._key
   }
 
+  /** @type {string} */
+  get name() {
+    return this._name
+  }
+
   /** @type {string} */
   get version() {
     return this._version
@@ -76,7 +72,7 @@ export default class Record {
       this._handler._onPruning(this, false)
       this._subscribed =
         this._subscribed ||
-        connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [this._name, this._key])
+        connection.sendMsg(C.TOPIC.RECORD, C.ACTIONS.SUBSCRIBE, [this._key, this._name])
     }
     return this
   }
@@ -437,7 +433,7 @@ export default class Record {
       this._onPatching(false)
     }
 
-    if (this._state < C.RECORD_STATE.PROVIDER && hasProvider === 'T') {
+    if (hasProvider === 'T') {
       this._state = C.RECORD_STATE.PROVIDER
     } else if (this._state < C.RECORD_STATE.SERVER) {
       this._state = this._version.charAt(0) === 'I' ? C.RECORD_STATE.STALE : C.RECORD_STATE.SERVER

package/src/rpc/rpc-handler.js

@@ -1,6 +1,6 @@
 import * as C from '../constants/constants.js'
 import RpcResponse from './rpc-response.js'
-import messageParser from '../message/message-parser.js'
+import * as messageParser from '../message/message-parser.js'
 import * as messageBuilder from '../message/message-builder.js'
 import xuid from 'xuid'
 

package/src/utils/multicast-listener.js

@@ -1,8 +1,8 @@
-import * as C from '../constants/constants.js'
 import * as rxjs from 'rxjs'
-import * as utils from '../utils/utils.js'
+import * as C from '../constants/constants.js'
+import { h64, h64ToString } from '../utils/utils.js'
 
-class Listener {
+export default class Listener {
   constructor(topic, pattern, callback, handler, { recursive = false, stringify = null } = {}) {
     this._topic = topic
     this._pattern = pattern
@@ -48,12 +48,9 @@ class Listener {
 
     const name = message.data[1]
 
-    if (!name?.length) {
-      this._error(name, 'invalid message')
-      return
-    }
+    // TOOD (fix): Validate name
 
-    const key = utils.hashNameBigInt(name)
+    const key = h64(name)
 
     if (message.action === C.ACTIONS.SUBSCRIPTION_FOR_PATTERN_FOUND) {
       if (this._subscriptions.has(key)) {
@@ -86,7 +83,7 @@ class Listener {
         provider.accepted = false
         provider.sending = false
 
-        globalThis.clearTimeout(provider.timeout)
+        clearTimeout(provider.timeout)
         provider.timeout = null
 
         provider.patternSubscription?.unsubscribe()
@@ -160,7 +157,7 @@ class Listener {
             }
 
             const body = typeof value !== 'string' ? this._stringify(value) : value
-            const hash = utils.h64ToString(body)
+            const hash = h64ToString(body)
             const version = `INF-${hash}`
 
             if (provider.version !== version) {
@@ -237,5 +234,3 @@ class Listener {
     this._subscriptions.clear()
   }
 }
-
-export default Listener

package/src/utils/unicast-listener.js

@@ -1,8 +1,8 @@
-import * as C from '../constants/constants.js'
 import * as rxjs from 'rxjs'
-import * as utils from '../utils/utils.js'
+import * as C from '../constants/constants.js'
+import { h64, h64ToString } from '../utils/utils.js'
 
-const PIPE = rxjs.pipe(
+const valuePipe = rxjs.pipe(
   rxjs.map((value) => {
     let data
     if (value && typeof value === 'string') {
@@ -21,7 +21,7 @@ const PIPE = rxjs.pipe(
   rxjs.distinctUntilChanged(),
 )
 
-class Listener {
+export default class Listener {
   constructor(topic, pattern, callback, handler, opts) {
     if (opts.recursive) {
       throw new Error('invalid argument: recursive')
@@ -55,12 +55,9 @@ class Listener {
   _$onMessage(message) {
     const name = message.data[1]
 
-    if (!name?.length) {
-      this._error(name, 'invalid message')
-      return
-    }
+    // TODO (fix): Validate name
 
-    const key = utils.hashNameBigInt(name)
+    const key = h64(name)
 
     if (message.action === C.ACTIONS.LISTEN_ACCEPT) {
       if (this._subscriptions.has(key)) {
@@ -76,14 +73,14 @@ class Listener {
       }
 
       if (value$) {
-        const subscription = value$.pipe(PIPE).subscribe({
+        const subscription = value$.pipe(valuePipe).subscribe({
           next: (data) => {
             if (data == null) {
               this._connection.sendMsg(this._topic, C.ACTIONS.LISTEN_REJECT, [this._pattern, key])
               this._subscriptions.delete(key)
               subscription.unsubscribe()
             } else {
-              const version = `INF-${utils.h64ToString(data)}`
+              const version = `INF-${h64ToString(data)}`
               this._connection.sendMsg(this._topic, C.ACTIONS.UPDATE, [key, version, data])
             }
           },
@@ -133,5 +130,3 @@ class Listener {
     this._connection.sendMsg(this._topic, C.ACTIONS.UNLISTEN, [this._pattern])
   }
 }
-
-export default Listener

package/src/utils/utils.js

@@ -1,7 +1,5 @@
 import xxhash from 'xxhash-wasm'
 
-const HASHER = await xxhash()
-
 const NODE_ENV = typeof process !== 'undefined' && process.env && process.env.NODE_ENV
 export const isNode = typeof process !== 'undefined' && process.toString() === '[object process]'
 export const isProduction = NODE_ENV === 'production'
@@ -83,7 +81,7 @@ export function setTimeout(callback, timeoutDuration) {
 
 export function setInterval(callback, intervalDuration) {
   if (intervalDuration !== null) {
-    return globalThis.setInterval(callback, intervalDuration)
+    return setInterval(callback, intervalDuration)
   } else {
     return -1
   }
@@ -179,23 +177,16 @@ export function removeAbortListener(signal, handler) {
   }
 }
 
-export function h64(name) {
-  return HASHER.h64(name)
-}
+const HASHER = await xxhash()
 
-export function h64ToString(name) {
-  return HASHER.h64ToString(name)
+export function h64(str) {
+  return HASHER.h64(str)
 }
 
-const encoder = new globalThis.TextEncoder()
-const buffer = new Uint8Array(8 * 3)
-const view = new DataView(buffer.buffer)
-
-export function hashNameBigInt(name) {
-  if (name.length >= 8) {
-    return HASHER.h64(name)
-  }
+export function h64ToString(str) {
+  return HASHER.h64ToString(str)
+}
 
-  const { written } = encoder.encodeInto(name, buffer)
-  return written === 8 ? view.getBigUint64(0, false) : HASHER.h64Raw(buffer.subarray(0, written))
+export function h64Raw(str) {
+  return HASHER.h64Raw(str)
 }