@logux/server 0.14.0 → 0.15.0

package/human-formatter/index.js

@@ -1,8 +1,9 @@
 import os from 'node:os'
 import { stripVTControlCharacters, styleText } from 'node:util'
 
-import { mulberry32, onceXmur3 } from './utils.js'
+import { isBinary, mulberry32, onceXmur3 } from './utils.js'
 
+const BINARY_MARK = '[binary]'
 const INDENT = '  '
 const PADDING = '        '
 const SEPARATOR = os.EOL + os.EOL
@@ -119,7 +120,9 @@ function formatNodeId(nodeId) {
 }
 
 function formatValue(value) {
-  if (typeof value === 'string') {
+  if (isBinary(value)) {
+    return styleText('bold', BINARY_MARK)
+  } else if (typeof value === 'string') {
     return '"' + styleText('bold', value) + '"'
   } else if (Array.isArray(value)) {
     return formatArray(value)
@@ -145,10 +148,7 @@ function formatActionId(id) {
   if (p.length === 1) {
     return p
   }
-  return (
-    `${styleText('bold', splitAndColorize(4, p[0]))} ` +
-    `${formatNodeId(p[1])} ${styleText('bold', p[2])}`
-  )
+  return `${styleText('bold', splitAndColorize(4, p[0]))} ${formatNodeId(p[1])}`
 }
 
 function formatParams(params, parent) {
@@ -164,7 +164,12 @@ function formatParams(params, parent) {
 
       let start = PADDING + rightPag(`${name}: `, maxName + 2)
 
-      if (name === 'Node ID' || (parent === 'Meta' && name === 'server')) {
+      if (isBinary(value)) {
+        return start + styleText('bold', BINARY_MARK)
+      } else if (
+        name === 'Node ID' ||
+        (parent === 'Meta' && name === 'server')
+      ) {
         return start + formatNodeId(value)
       } else if (
         parent === 'Meta' &&

package/human-formatter/utils.js

@@ -1,3 +1,17 @@
+export const BINARY = {
+  toJSON() {
+    return '[binary]'
+  }
+}
+
+export function isBinary(value) {
+  return (
+    value === BINARY ||
+    ArrayBuffer.isView(value) ||
+    value instanceof ArrayBuffer
+  )
+}
+
 export function onceXmur3(str) {
   let h = 1779033703 ^ str.length
   for (let i = 0; i < str.length; i++) {

package/index.d.ts

@@ -16,7 +16,7 @@ export {
   ServerMeta,
   wasNot403
 } from './base-server/index.js'
-export { ChannelContext, Context } from './context/index.js'
+export { Context, ConnectContext, ChannelContext } from './context/index.js'
 export { filterMeta } from './filter-meta/index.js'
 export {
   del,

package/package.json

@@ -1,25 +1,22 @@
 {
   "name": "@logux/server",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Build own Logux server",
   "keywords": [
-    "logux",
-    "server",
-    "framework",
-    "websocket",
-    "proxy",
+    "collaborative",
     "crdt",
-    "event sourcing",
     "distributed systems",
-    "collaborative"
+    "event sourcing",
+    "framework",
+    "logux",
+    "proxy",
+    "server",
+    "websocket"
   ],
-  "author": "Andrey Sitnik <andrey@sitnik.ru>",
-  "license": "MIT",
   "homepage": "https://logux.org/",
+  "license": "MIT",
+  "author": "Andrey Sitnik <andrey@sitnik.es>",
   "repository": "logux/server",
-  "engines": {
-    "node": "^20.0.0 || >=22.0.0"
-  },
   "type": "module",
   "types": "./index.d.ts",
   "exports": {
@@ -27,14 +24,15 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@logux/actions": "^0.5.0",
-    "@logux/core": "^0.10.0",
-    "cookie": "^1.0.2",
-    "fastq": "^1.19.1",
-    "nanoevents": "^9.1.0",
-    "nanoid": "^5.1.5",
-    "tinyglobby": "^0.2.14",
-    "url-pattern": "^1.0.3",
-    "ws": "^8.18.3"
+    "@logux/actions": "^0.6.0",
+    "@logux/core": "^0.11.0",
+    "cookie": "^2.0.1",
+    "fastq": "^1.20.1",
+    "nanoevents": "^10.0.0",
+    "nanoid": "^6.0.1",
+    "ws": "^8.21.3"
+  },
+  "engines": {
+    "node": "^22.5.0 || ^24.0.0 || >=26.0.0"
   }
 }

package/server/index.d.ts

@@ -1,7 +1,10 @@
-import {
+import type { Log } from '@logux/core'
+
+import type {
   BaseServer,
-  type BaseServerOptions,
-  type Logger
+  BaseServerOptions,
+  Logger,
+  ServerMeta
 } from '../base-server/index.js'
 
 export interface LogStream {
@@ -62,8 +65,9 @@ export interface ServerOptions extends BaseServerOptions {
  * ```
  */
 export class Server<
-  Headers extends object = unknown
-> extends BaseServer<Headers> {
+  Headers extends object = unknown,
+  ClientData extends object = unknown
+> extends BaseServer<Headers, Log<ServerMeta>, ClientData> {
   /**
    * Server options.
    *

package/server/index.js

@@ -1,6 +1,6 @@
-import { join, relative } from 'node:path'
+import { glob } from 'node:fs/promises'
+import { join, matchesGlob, relative } from 'node:path'
 import { styleText } from 'node:util'
-import { glob } from 'tinyglobby'
 
 import { BaseServer } from '../base-server/index.js'
 import { createReporter } from '../create-reporter/index.js'
@@ -120,14 +120,23 @@ export class Server extends BaseServer {
     files = ['modules/*/index.js', 'modules/*.js', '!**/*.{test,spec}.js']
   ) {
     if (!Array.isArray(files)) files = [files]
-    let matches = await glob(files, {
-      absolute: true,
+    let ignore = files.filter(i => i.startsWith('!')).map(i => i.slice(1))
+    let patterns = files.filter(i => !i.startsWith('!'))
+
+    let matches = new Set()
+    for await (let entry of glob(patterns, {
       cwd: this.options.root,
-      onlyFiles: true
-    })
+      withFileTypes: true
+    })) {
+      if (!entry.isFile()) continue
+      let file = join(entry.parentPath, entry.name)
+      let path = relative(this.options.root, file)
+      if (ignore.some(i => matchesGlob(path, i))) continue
+      matches.add(file)
+    }
 
     await Promise.all(
-      matches.map(async file => {
+      [...matches].map(async file => {
         let serverModule = (await import(file)).default
         if (typeof serverModule === 'function') {
           await serverModule(this)

package/server-client/index.d.ts

@@ -9,7 +9,7 @@ import type { BaseServer } from '../base-server/index.js'
  * const client = server.connected.get(0)
  * ```
  */
-export class ServerClient {
+export class ServerClient<ClientData extends object = unknown> {
   /**
    * Server, which received client.
    */
@@ -30,6 +30,23 @@ export class ServerClient {
    */
   connection: ServerConnection
 
+  /**
+   * Open structure to save data for the whole connection.
+   *
+   * ```js
+   * server.auth(async ({ client, userId, token }) => {
+   *   let session = await findSession(token)
+   *   if (!session) return false
+   *   client.data.sessionId = session.id
+   *   return true
+   * })
+   * server.on('disconnected', client => {
+   *   touchSession(client.data.sessionId)
+   * })
+   * ```
+   */
+  data: ClientData
+
   /**
    * HTTP headers of WS connection.
    *
@@ -100,4 +117,11 @@ export class ServerClient {
    * Disconnect client.
    */
   destroy(): void
+
+  /**
+   * Wait until the client will confirm all sent actions.
+   *
+   * @returns Promise with `false` if the client was disconnected.
+   */
+  drain(): Promise<boolean>
 }

package/server-client/index.js

@@ -1,5 +1,5 @@
 import { LoguxError, parseId } from '@logux/core'
-import cookie from 'cookie'
+import { parseCookie } from 'cookie'
 import fastq from 'fastq'
 
 import { ALLOWED_META } from '../allowed-meta/index.js'
@@ -11,6 +11,8 @@ async function onSend(action, meta) {
   return [action, filterMeta(meta)]
 }
 
+function ignore() {}
+
 function reportDetails(client) {
   return {
     connectionId: client.key,
@@ -70,7 +72,9 @@ export class ServerClient {
     this.userId = undefined
     this.clientId = undefined
     this.nodeId = undefined
+    this.data = {}
     this.processing = false
+    this.sending = new Set()
     this.connection = connection
     this.key = key.toString()
     if (connection.ws) {
@@ -89,6 +93,7 @@ export class ServerClient {
       onSend,
       ping: app.options.ping,
       subprotocol: app.options.subprotocol,
+      syncBatch: app.options.syncBatch,
       timeout: app.options.timeout
     })
     if (this.app.env === 'development') {
@@ -99,11 +104,12 @@ export class ServerClient {
       this.node.syncSinceQuery = async lastSynced => {
         let context = new Context(app, this)
         let entries = await app.connectLoader(context, lastSynced)
-        let added = entries.reduce((max, entry) => {
-          let meta = filterMeta(entry[1])
-          entry[1] = meta
-          return meta.added > max ? meta.added : max
-        }, 0)
+        let added = 0
+        for (let entry of entries) {
+          // `added` should be taken before `filterMeta()` removes it
+          if (entry[1].added > added) added = entry[1].added
+          entry[1] = filterMeta(entry[1])
+        }
         return { added, entries }
       }
     }
@@ -157,7 +163,7 @@ export class ServerClient {
     try {
       result = await this.app.authenticator({
         client: this,
-        cookie: cookie.parse(headers.cookie || ''),
+        cookie: parseCookie(headers.cookie || ''),
         headers: this.node.remoteHeaders,
         token,
         userId: this.userId
@@ -239,6 +245,23 @@ export class ServerClient {
     this.app.connected.delete(this.key)
   }
 
+  async drain() {
+    if (this.sending.size > 0) await Promise.all(this.sending)
+    if (this.destroyed || !this.node.connected) return false
+    if (this.node.syncing === 0) return true
+    return new Promise(resolve => {
+      let unbind = this.node.on('state', () => {
+        if (this.node.state === 'synchronized') {
+          unbind()
+          resolve(true)
+        } else if (!this.node.connected) {
+          unbind()
+          resolve(false)
+        }
+      })
+    })
+  }
+
   onReceive(action, meta) {
     if (this.app.actionToQueue.has(meta.id)) {
       return Promise.resolve(false)
@@ -263,8 +286,10 @@ export class ServerClient {
 
       if (isChannel) {
         for (let channel of this.app.channels) {
-          let pattern = channel.regexp || channel.pattern.regex
-          if (action.channel.match(pattern)) {
+          let match = channel.regexp
+            ? action.channel.match(channel.regexp)
+            : channel.pattern(action.channel)
+          if (match) {
             queueName = channel.queue
             break
           }
@@ -299,4 +324,12 @@ export class ServerClient {
       })
     })
   }
+
+  track(sending) {
+    let done = Promise.resolve(sending).then(ignore, ignore)
+    this.sending.add(done)
+    void done.then(() => {
+      this.sending.delete(done)
+    })
+  }
 }

package/test-client/index.d.ts

@@ -141,7 +141,7 @@ export class TestClient {
    * @param test Function, where do you expect action will be received
    * @returns Promise with all received actions
    */
-  collect(test: () => Promise<any>): Promise<Action[]>
+  collect(test: () => Promise<unknown>): Promise<Action[]>
 
   /**
    * Connect to test server.
@@ -180,7 +180,10 @@ export class TestClient {
    * @param meta Optional action’s meta.
    * @returns Promise until `logux/processed` answer.
    */
-  process(action: AnyAction, meta?: Partial<ServerMeta>): Promise<Action[]>
+  process<TypeAction extends Action = AnyAction>(
+    action: TypeAction,
+    meta?: Partial<ServerMeta>
+  ): Promise<Action[]>
 
   /**
    * Collect actions received from server during the `test` call.

package/test-client/index.js

@@ -1,5 +1,5 @@
 import { ClientNode, TestPair } from '@logux/core'
-import cookie from 'cookie'
+import { stringifyCookie } from 'cookie'
 import { setTimeout } from 'node:timers/promises'
 
 import { filterMeta } from '../filter-meta/index.js'
@@ -34,9 +34,9 @@ export class TestClient {
       this.node.setLocalHeaders(opts.headers)
     }
     if (opts.cookie) {
-      this.pair.right.ws.upgradeReq.headers.cookie = Object.keys(opts.cookie)
-        .map(i => cookie.serialize(i, opts.cookie[i]))
-        .join('; ')
+      this.pair.right.ws.upgradeReq.headers.cookie = stringifyCookie(
+        opts.cookie
+      )
     }
     server.unbind.push(() => {
       this.node.destroy()
@@ -46,7 +46,7 @@ export class TestClient {
   async collect(test) {
     let added = []
     let unbind = this.node.log.on('add', (action, meta) => {
-      if (!meta.id.includes(` ${this.nodeId} `)) {
+      if (meta.id.split(' ')[1] !== this.nodeId) {
         added.push(action)
       }
     })
@@ -67,8 +67,8 @@ export class TestClient {
       })
 
       this.server.addClient(this.pair.right)
-      this.node.connection.connect()
-      this.node.waitFor('synchronized').then(() => {
+      void this.node.connection.connect()
+      void this.node.waitFor('synchronized').then(() => {
         this.node.throwsError = true
         unbind()
         resolve()
@@ -136,7 +136,7 @@ export class TestClient {
   async received(test) {
     let actions = []
     let unbind = this.log.on('add', (action, meta) => {
-      if (!meta.id.includes(` ${this.nodeId} `)) {
+      if (meta.id.split(' ')[1] !== this.nodeId) {
         actions.push(action)
       }
     })

package/test-server/index.d.ts

@@ -1,7 +1,7 @@
-import type { TestLog, TestTime } from '@logux/core'
+import type { Log, TestLog, TestTime } from '@logux/core'
 
-import { BaseServer } from '../base-server/index.js'
 import type {
+  BaseServer,
   BaseServerOptions,
   Logger,
   ServerMeta
@@ -9,8 +9,10 @@ import type {
 import type { LoggerOptions } from '../server/index.js'
 import type { TestClient, TestClientOptions } from '../test-client/index.js'
 
-export interface TestServerOptions
-  extends Omit<BaseServerOptions, 'minSubprotocol' | 'subprotocol'> {
+export interface TestServerOptions extends Omit<
+  BaseServerOptions,
+  'minSubprotocol' | 'subprotocol'
+> {
   /**
    * Disable built-in auth.
    */
@@ -46,8 +48,9 @@ export interface TestServerOptions
  * ```
  */
 export class TestServer<
-  Headers extends object = unknown
-> extends BaseServer<Headers> {
+  Headers extends object = unknown,
+  ClientData extends object = unknown
+> extends BaseServer<Headers, Log<ServerMeta>, ClientData> {
   /**
    * fetch() compatible API to test HTTP endpoints.
    *

package/test-server/index.js

@@ -34,8 +34,8 @@ export class TestServer extends BaseServer {
 
     this.fetch = this.fetch.bind(this)
 
-    this.on('fatal', () => {
-      this.destroy()
+    this.on('fatal', async () => {
+      await this.destroy()
     })
   }
 
@@ -72,7 +72,8 @@ export class TestServer extends BaseServer {
       if (e.message === 'Server undid action') {
         if (e.action.reason !== reason) {
           throw new Error(
-            `Undo was with ${e.action.reason} reason, not ${reason}`
+            `Undo was with ${e.action.reason} reason, not ${reason}`,
+            { cause: e }
           )
         }
       } else {

package/url-pattern/index.js

@@ -0,0 +1,28 @@
+const PARAM = /:(\w+)/g
+const SPECIAL = /[.*+?^${}()|[\]\\]/g
+
+function escape(text) {
+  return text.replace(SPECIAL, '\\$&')
+}
+
+export function createPattern(pattern) {
+  let names = []
+  let source = ''
+  let last = 0
+  for (let param of pattern.matchAll(PARAM)) {
+    source += escape(pattern.slice(last, param.index)) + '([^/]+)'
+    names.push(param[1])
+    last = param.index + param[0].length
+  }
+  let regexp = new RegExp('^' + source + escape(pattern.slice(last)) + '$')
+
+  return url => {
+    let match = regexp.exec(url)
+    if (!match) return null
+    let params = {}
+    for (let i = 0; i < names.length; i++) {
+      if (names[i] !== '__proto__') params[names[i]] = match[i + 1]
+    }
+    return params
+  }
+}