@logux/server 0.16.2 → 0.17.0

package/base-server/index.d.ts

@@ -66,21 +66,11 @@ interface ConnectLoader<Headers extends object = unknown> {
 type ServerNodeConstructor = new (...args: unknown[]) => ServerNode
 
 export interface ServerMeta extends Meta {
-  /**
-   * All nodes subscribed to channel will receive the action.
-   */
-  channel?: string
-
   /**
    * All nodes subscribed to listed channels will receive the action.
    */
   channels?: string[]
 
-  /**
-   * All nodes with listed client ID will receive the action.
-   */
-  client?: string
-
   /**
    * All nodes with listed client IDs will receive the action.
    */
@@ -91,11 +81,6 @@ export interface ServerMeta extends Meta {
    */
   excludeClients?: string[]
 
-  /**
-   * Node with listed node ID will receive the action.
-   */
-  node?: string
-
   /**
    * All nodes with listed node IDs will receive the action.
    */
@@ -106,16 +91,6 @@ export interface ServerMeta extends Meta {
    */
   server: string
 
-  /**
-   * Action processing status
-   */
-  status?: 'error' | 'processed' | 'waiting'
-
-  /**
-   * All nodes with listed user ID will receive the action.
-   */
-  user?: string
-
   /**
    * All nodes with listed user IDs will receive the action.
    */
@@ -238,6 +213,13 @@ export interface BaseServerOptions {
    */
   subprotocol?: number
 
+  /**
+   * How long an action can stay in the processing queue of the client
+   * before the server answers `logux/undo` and moves to the next action.
+   * `300000` (5 minutes) by default, `0` disables it.
+   */
+  queueTimeout?: number
+
   /**
    * How many actions could be sent in a single message. `100` by default.
    *
@@ -312,6 +294,10 @@ interface Authorizer<
 /**
  * Return object with keys for meta to resend action to other users.
  *
+ * It is called only for the actions from the clients and
+ * from {@link BaseServer#process}. Facts, which were added
+ * by `Server#log.add()`, are routed by their meta alone.
+ *
  * @param ctx Information about node, who create this action.
  * @param action The action data.
  * @param meta The action metadata.
@@ -602,6 +588,10 @@ interface ReportersArguments {
   }
   unsubscribed: SubscriptionReporter
   useless: ActionReporter
+  duplicate: CleanReporter
+  destroyDetached: {
+    actions: number
+  }
   wrongChannel: SubscriptionReporter
   zombie: {
     nodeId: string
@@ -617,14 +607,10 @@ export interface Reporter {
 
 export type Resend =
   | {
-      channel?: string
       channels?: string[]
-      client?: string
       clients?: string[]
       excludeClients?: string[]
-      node?: string
       nodes?: string[]
-      user?: string
       users?: string[]
     }
   | string
@@ -699,6 +685,16 @@ export class BaseServer<
    * ```js
    * server.log.each(finder)
    * ```
+   *
+   * Adding an action delivers it by `meta.channels`, `users`, `clients`,
+   * `nodes`. Callbacks from {@link BaseServer#type} are not called,
+   * use {@link BaseServer#process} for that.
+   *
+   * ```js
+   * server.log.add({ type: 'users/renamed', userId, name }, {
+   *   channels: [`users/${userId}`]
+   * })
+   * ```
    */
   log: ServerLog
 
@@ -925,6 +921,13 @@ export class BaseServer<
    *   }
    * })
    * ```
+   *
+   * The URL can contain `*` to match the rest of the path, including `/`.
+   *
+   * Listeners are checked in the order they were added, so add the specific
+   * URLs before the patterns. Adding a listener for the same method and URL
+   * replaces the previous one: it allows to override the built-in pages
+   * like `/` or `/health`.
    */
   http(
     method: string,
@@ -941,6 +944,24 @@ export class BaseServer<
     ) => boolean | Promise<boolean>
   ): void
 
+  /**
+   * Replace the default `404 Not found` answer for HTTP requests, which
+   * were not processed by `Server#http()` listeners.
+   *
+   * ```js
+   * server.httpNotFound((req, res) => {
+   *   res.writeHead(404, { 'Content-Type': 'application/json' })
+   *   res.end('{"error":"Not found"}')
+   * })
+   * ```
+   */
+  httpNotFound(
+    listener: (
+      req: IncomingMessage,
+      res: ServerResponse
+    ) => Promise<void> | void
+  ): void
+
   /**
    * Start WebSocket server and listen for clients.
    *
@@ -1140,7 +1161,8 @@ export class BaseServer<
    *
    * @param action New action to resend and process.
    * @param meta Action’s meta.
-   * @returns Promise until new action will be resend to clients and processed.
+   * @returns Promise with the action’s meta. It will be rejected
+   *          with the error of the failed callback.
    */
   process<TypeAction extends Action = AnyAction>(
     action: TypeAction,
@@ -1148,8 +1170,12 @@ export class BaseServer<
   ): Promise<Readonly<ServerMeta>>
 
   /**
-   * Send action, received by other server, to all clients of current server.
-   * This method is for multi-server configuration only.
+   * Send an action, which was already processed by another server,
+   * to the clients of this server. The action is not written to the log
+   * and no callback from {@link BaseServer#type} is called.
+   *
+   * This method is for multi-server configuration only. Use
+   * `Server#log.add()` to also store the action in this server’s log.
    *
    * ```js
    * server.on('add', (action, meta) => {
@@ -1158,14 +1184,14 @@ export class BaseServer<
    *   }
    * })
    * onReceivingFromOtherServer((action, meta) => {
-   *   server.sendAction(action, meta)
+   *   server.sendWithoutProcess(action, meta)
    * })
    * ```
    *
    * @param action New action.
    * @param meta Action’s metadata.
    */
-  sendAction(action: Action, meta: ServerMeta): Promise<void> | void
+  sendWithoutProcess(action: Action, meta: ServerMeta): Promise<void> | void
 
   /**
    * Change a way how server loads actions history for the client.
@@ -1184,6 +1210,9 @@ export class BaseServer<
    * Set `meta.added` to let the client ask only for newer actions after
    * the reconnect: the biggest `added` will be sent as the sync position.
    *
+   * Like the default history, the returned actions are prefixed
+   * by `logux/prepare`.
+   *
    * @param loader Callback which loads list of actions and meta.
    */
   sendOnConnect(loader: ConnectLoader<Headers>): void
@@ -1197,8 +1226,9 @@ export class BaseServer<
    *
    * @param nodeId Node ID.
    * @param channel Channel name.
+   * @returns Promise until `logux/subscribed` was published.
    */
-  subscribe(nodeId: string, channel: string): void
+  subscribe(nodeId: string, channel: string): Promise<unknown>
 
   /**
    * @param actionCreator Action creator function.
@@ -1248,11 +1278,15 @@ export class BaseServer<
    * }
    * ```
    *
+   * During the action processing it sets the outcome of the current task:
+   * the callback can not answer `logux/processed` after it. Outside
+   * of the processing it publishes the compensating action.
+   *
    * @param action The original action to undo.
    * @param meta The action’s metadata.
    * @param reason Optional code for reason. Default is `'error'`.
    * @param extra Extra fields to `logux/undo` action.
-   * @returns When action was saved to the log.
+   * @returns When the answer was published.
    */
   undo(
     action: Action,
@@ -1262,8 +1296,8 @@ export class BaseServer<
   ): Promise<void>
 
   /**
-   * If you receive action with unknown type, this method will mark this action
-   * with `error` status and undo it on the clients.
+   * If you receive action with unknown type, this method will undo it
+   * on the clients.
    *
    * If you didn’t set {@link Server#otherType},
    * Logux will call it automatically.