@logux/server 0.13.1 → 0.14.0

package/README.md

@@ -27,38 +27,18 @@ This repository contains Logux server with:
 [cult]: http://cultofmartians.com/done.html
 
 
-### Logux Server as Proxy
-
-```js
-import { fileURLToPath } from 'url'
-
-const server = new Server(
-  Server.loadOptions(process, {
-    controlSecret: 'secret',
-    subprotocol: '1.0.0',
-    supports: '0.6.2',
-    backend: 'http://localhost:3000/logux',
-    fileUrl: import.meta.url
-  })
-)
-
-server.listen()
-```
-
-
 ### Logux Server as Framework
 
 ```js
-import { fileURLToPath } from 'url'
 import { isFirstOlder } from '@logux/core'
 import { dirname } from 'path'
 import { Server } from '@logux/server'
 
 const server = new Server(
   Server.loadOptions(process, {
-    subprotocol: '1.0.0',
-    supports: '1.x',
-    fileUrl: import.meta.url
+    subprotocol: 1,
+    minSubprotocol: 1,
+    root: import.meta.dirname
   })
 )
 

package/add-http-pages/index.js

@@ -0,0 +1,24 @@
+import { readFile } from 'node:fs/promises'
+import { join } from 'node:path'
+
+let hello
+async function readHello() {
+  if (!hello) {
+    hello = await readFile(join(import.meta.dirname, 'hello.html'))
+  }
+  return hello
+}
+
+export function addHttpPages(server) {
+  if (!server.options.disableHttpServer) {
+    server.http('GET', '/', async (req, res) => {
+      let data = await readHello()
+      res.writeHead(200, { 'Content-Type': 'text/html' })
+      res.end(data)
+    })
+    server.http('GET', '/health', (req, res) => {
+      res.writeHead(200, { 'Content-Type': 'text/plain' })
+      res.end('Logux Server: OK\n')
+    })
+  }
+}

package/base-server/index.d.ts

@@ -19,11 +19,18 @@ import type {
   IncomingMessage,
   ServerResponse
 } from 'node:http'
-import type { LogFn } from 'pino'
 
-import type { ChannelContext, Context } from '../context/index.js'
+import type {
+  ChannelContext,
+  ConnectContext,
+  Context
+} from '../context/index.js'
 import type { ServerClient } from '../server-client/index.js'
 
+interface LogFn {
+  (...objs: unknown[]): void
+}
+
 interface TypeOptions {
   /**
    * Name of the queue that will be used to process actions
@@ -40,6 +47,23 @@ interface ChannelOptions {
   queue?: string
 }
 
+interface ConnectLoader<Headers extends object = unknown> {
+  (
+    ctx: ConnectContext<Headers>,
+    lastSynced: number
+  ):
+    | [Action, ServerMeta][]
+    | Promise<
+        [
+          Action,
+          Partial<Pick<ServerMeta, 'subprotocol'>> &
+            Pick<ServerMeta, 'id' | 'time'>
+        ][]
+      >
+}
+
+type ServerNodeConstructor = new (...args: any[]) => ServerNode
+
 export interface ServerMeta extends Meta {
   /**
    * All nodes subscribed to channel will receive the action.
@@ -98,12 +122,6 @@ export interface ServerMeta extends Meta {
 }
 
 export interface BaseServerOptions {
-  /**
-   * URL to PHP, Ruby on Rails, or other backend to process actions and
-   * authentication.
-   */
-  backend?: string
-
   /**
    * SSL certificate or path to it. Path could be relative from server
    * root. It is required in production mode, because WSS is highly
@@ -119,17 +137,7 @@ export interface BaseServerOptions {
   cleanFromLog?: RegExp
 
   /**
-   * CIDR masks for IP address, where control requests could came from.
-   */
-  controlMask?: string
-
-  /**
-   * Secret to control the server.
-   */
-  controlSecret?: string
-
-  /**
-   * Disable health check endpoint, control HTTP API, {@link Server#http}.
+   * Disable health check endpoint, {@link Server#http}.
    *
    * The server will process only WebSocket connection and ignore all other
    * HTTP request (so they can be processed by other HTTP server).
@@ -144,8 +152,8 @@ export interface BaseServerOptions {
   env?: 'development' | 'production'
 
   /**
-   * URL of main JS file in the root dir. Shortcut to set `root` in ES modules
-   * without `fileURLToPath`.
+   * URL of main JS file in the root dir for the cases where you can’t use
+   * `import.meta.dirname`.
    *
    * ```
    * fileUrl: import.meta.url
@@ -169,6 +177,16 @@ export interface BaseServerOptions {
    */
   key?: { pem: string } | string
 
+  /**
+   * The version requirements for client subprotocol version.
+   */
+  minSubprotocol?: number
+
+  /**
+   * Replace class for ServerNode.
+   */
+  Node?: ServerNodeConstructor
+
   /**
    * Process ID, to display in logs.
    */
@@ -184,7 +202,7 @@ export interface BaseServerOptions {
    * Port to bind server. It will create HTTP server manually to connect
    * WebSocket server to it. Default is `31337`.
    */
-  port?: number
+  port?: number | string
 
   /**
    * URL to Redis for Logux Server Pro scaling.
@@ -196,7 +214,7 @@ export interface BaseServerOptions {
    * Default is `process.cwd()`.
    *
    * ```js
-   * root: __dirname
+   * root: import.meta.dirname
    * ```
    */
   root?: string
@@ -215,14 +233,9 @@ export interface BaseServerOptions {
   store?: LogStore
 
   /**
-   * Server current application subprotocol version in SemVer format.
-   */
-  subprotocol?: string
-
-  /**
-   * npm’s version requirements for client subprotocol version.
+   * Server current application subprotocol version.
    */
-  supports?: string
+  subprotocol?: number
 
   /**
    * Test time to test server.
@@ -352,7 +365,7 @@ interface ActionFinally<
  */
 interface ChannelFilter<Headers extends object> {
   (
-    ctx: Context<{}, Headers>,
+    ctx: Context<unknown, Headers>,
     action: Readonly<Action>,
     meta: Readonly<ServerMeta>
   ): boolean | Promise<boolean>
@@ -551,20 +564,17 @@ interface ReportersArguments {
     nodeId?: string
   }
   listen: {
-    backend: string
     cert: boolean
-    controlMask: string
-    controlSecret: string
     environment: 'development' | 'production'
     host: string
     loguxServer: string
+    minSubprotocol: number
     nodeId: string
     notes: object
     port: string
     redis: string
     server: boolean
-    subprotocol: string
-    supports: string
+    subprotocol: number
   }
   processed: {
     actionId: ID
@@ -607,29 +617,13 @@ export type Resend =
   | string[]
 
 export interface Logger {
+  debug(details: object, message: string): void
   error(details: object, message: string): void
   fatal(details: object, message: string): void
   info(details: object, message: string): void
   warn(details: object, message: string): void
 }
 
-interface Response {
-  body: string
-  header?: {
-    [name: string]: string
-  }
-}
-
-interface GetProcessor {
-  request(request: object): Promise<Response> | Response
-  safe?: boolean
-}
-
-interface PostProcessor {
-  command(command: object, request: object): Promise<void>
-  isValid(command: object): boolean
-}
-
 /**
  * Return `false` if `cb()` got response error with 403.
  *
@@ -651,7 +645,7 @@ export function wasNot403(cb: () => Promise<void>): Promise<boolean>
  * Base server class to extend.
  */
 export class BaseServer<
-  Headers extends object = {},
+  Headers extends object = unknown,
   ServerLog extends Log = Log<ServerMeta>
 > {
   /**
@@ -673,13 +667,6 @@ export class BaseServer<
    */
   connected: Map<string, ServerClient>
 
-  /**
-   * Add callback to internal HTTP server.
-   */
-  controls: {
-    [path: string]: GetProcessor | PostProcessor
-  }
-
   /**
    * Production or development mode.
    *
@@ -755,7 +742,7 @@ export class BaseServer<
   subscribers: {
     [channel: string]: {
       [nodeId: string]: {
-        filters: Record<string, ChannelFilter<{}> | true>
+        filters: Record<string, ChannelFilter<unknown> | true>
         unsubscribe?: (action: LoguxUnsubscribeAction, meta: ServerMeta) => void
       }
     }
@@ -827,15 +814,14 @@ export class BaseServer<
    * @param options Additional options
    */
   channel<
-    ChannelParams extends object = {},
-    Data extends object = {},
+    ChannelParams extends object = unknown,
+    Data extends object = unknown,
     SubscribeAction extends LoguxSubscribeAction = LoguxSubscribeAction
   >(
     pattern: string,
     callbacks: ChannelCallbacks<SubscribeAction, Data, ChannelParams, Headers>,
     options?: ChannelOptions
   ): void
-
   /**
    * @param pattern Regular expression for channel name.
    * @param callbacks Callback during subscription process.
@@ -843,7 +829,7 @@ export class BaseServer<
    */
   channel<
     ChannelParams extends string[] = string[],
-    Data extends object = {},
+    Data extends object = unknown,
     SubscribeAction extends LoguxSubscribeAction = LoguxSubscribeAction
   >(
     pattern: RegExp,
@@ -881,21 +867,32 @@ export class BaseServer<
    * Add non-WebSocket HTTP request processor.
    *
    * ```js
-   * server.http((req, res) => {
-   *   if (req.url === '/auth') {
-   *     let token = signIn(req)
-   *     if (token) {
-   *       res.setHeader('Set-Cookie', `token=${token}; Secure; HttpOnly`)
-   *       res.end()
-   *     } else {
-   *       res.statusCode = 400
-   *       res.end('Wrong user or password')
-   *     }
+   * server.http('GET', '/auth', (req, res) => {
+   *   let token = signIn(req)
+   *   if (token) {
+   *     res.setHeader('Set-Cookie', `token=${token}; Secure; HttpOnly`)
+   *     res.end()
+   *   } else {
+   *     res.statusCode = 400
+   *     res.end('Wrong user or password')
    *   }
    * })
    * ```
    */
-  http(listener: (req: IncomingMessage, res: ServerResponse) => void): void
+  http(
+    method: string,
+    url: string,
+    listener: (
+      req: IncomingMessage,
+      res: ServerResponse
+    ) => Promise<void> | void
+  ): void
+  http(
+    listener: (
+      req: IncomingMessage,
+      res: ServerResponse
+    ) => boolean | Promise<boolean>
+  ): void
 
   /**
    * Start WebSocket server and listen for clients.
@@ -909,7 +906,6 @@ export class BaseServer<
    * @param listener Event listener.
    */
   on(event: 'subscriptionCancelled', listener: () => void): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Subscription listener.
@@ -918,29 +914,26 @@ export class BaseServer<
     event: 'subscribing',
     listener: (action: LoguxSubscribeAction, meta: Readonly<ServerMeta>) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Processing listener.
    */
   on(
-    event: 'backendGranted' | 'backendProcessed' | 'processed',
+    event: 'processed',
     listener: (
       action: Action,
       meta: Readonly<ServerMeta>,
       latencyMilliseconds: number
     ) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Action listener.
    */
   on(
-    event: 'add' | 'backendSent' | 'clean',
+    event: 'add' | 'clean',
     listener: (action: Action, meta: Readonly<ServerMeta>) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Client listener.
@@ -949,7 +942,6 @@ export class BaseServer<
     event: 'connected' | 'disconnected',
     listener: (client: ServerClient) => void
   ): Unsubscribe
-
   /**
    * Subscribe for synchronization events. It implements nanoevents API.
    * Supported events:
@@ -985,7 +977,6 @@ export class BaseServer<
     event: 'clientError' | 'fatal',
     listener: (err: Error) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Error listener.
@@ -994,7 +985,6 @@ export class BaseServer<
     event: 'error',
     listener: (err: Error, action: Action, meta: Readonly<ServerMeta>) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Client listener.
@@ -1003,7 +993,6 @@ export class BaseServer<
     event: 'authenticated' | 'unauthenticated',
     listener: (client: ServerClient, latencyMilliseconds: number) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Action listener.
@@ -1012,7 +1001,6 @@ export class BaseServer<
     event: 'preadd',
     listener: (action: Action, meta: ServerMeta) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Subscription listener.
@@ -1025,7 +1013,6 @@ export class BaseServer<
       latencyMilliseconds: number
     ) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Subscription listener.
@@ -1038,7 +1025,6 @@ export class BaseServer<
       clientNodeId: string
     ) => void
   ): Unsubscribe
-
   /**
    * @param event The event name.
    * @param listener Report listener.
@@ -1064,7 +1050,7 @@ export class BaseServer<
    *
    * @param callbacks Callback during subscription process.
    */
-  otherChannel<Data extends object = {}>(
+  otherChannel<Data extends object = unknown>(
     callbacks: ChannelCallbacks<LoguxSubscribeAction, Data, [string], Headers>
   ): void
 
@@ -1094,7 +1080,7 @@ export class BaseServer<
    *
    * @param callbacks Callbacks for actions with this type.
    */
-  otherType<Data extends object = {}>(
+  otherType<Data extends object = unknown>(
     callbacks: ActionCallbacks<Action, Data, Headers>
   ): void
 
@@ -1131,6 +1117,19 @@ export class BaseServer<
    */
   sendAction(action: Action, meta: ServerMeta): Promise<void> | void
 
+  /**
+   * Change a way how server loads actions history for the client.
+   *
+   * ```js
+   * server.sendOnConnect(async (ctx, lastSynced) => {
+   *   return db.loadActions({ user: ctx.userId, after: lastSynced })
+   * })
+   * ```
+   *
+   * @param loader Callback which loads list of actions and meta.
+   */
+  sendOnConnect(loader: ConnectLoader<Headers>)
+
   /**
    * Send `logux/subscribed` if client was not already subscribed.
    *
@@ -1148,12 +1147,11 @@ export class BaseServer<
    * @param callbacks Callbacks for action created by creator.
    * @param options Additional options
    */
-  type<Creator extends AbstractActionCreator, Data extends object = {}>(
+  type<Creator extends AbstractActionCreator, Data extends object = unknown>(
     actionCreator: Creator,
     callbacks: ActionCallbacks<ReturnType<Creator>, Data, Headers>,
     options?: TypeOptions
   ): void
-
   /**
    * Define action type’s callbacks.
    *
@@ -1177,7 +1175,7 @@ export class BaseServer<
    * @param callbacks Callbacks for actions with this type.
    * @param options Additional options
    */
-  type<TypeAction extends Action = AnyAction, Data extends object = {}>(
+  type<TypeAction extends Action = AnyAction, Data extends object = unknown>(
     name: RegExp | TypeAction['type'],
     callbacks: ActionCallbacks<TypeAction, Data, Headers>,
     options?: TypeOptions