polfan-server-js-client 0.2.66 → 0.2.68

package/build/types/AbstractChatClient.d.ts

@@ -1,4 +1,4 @@
-import { Bye, GetSession, JoinSpace, Session, SpaceJoined, Error as ErrorType, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMemberUpdated, SpaceDeleted, SpaceMembers, SpaceRooms, NewRole, RoomDeleted, RoomJoined, RoomLeft, RoomMemberLeft, RoomMemberJoined, RoomMembers, NewRoom, NewTopic, TopicDeleted, NewMessage, GetPermissionOverwrites, GetComputedPermissions, LeaveSpace, CreateSpace, DeleteSpace, GetSpaceMembers, GetSpaceRooms, CreateRole, DeleteRole, AssignRole, DeassignRole, SetPermissionOverwrites, JoinRoom, LeaveRoom, CreateRoom, DeleteRoom, GetRoomMembers, CreateTopic, DeleteTopic, CreateMessage, Envelope, PermissionOverwrites, PermissionOverwritesUpdated, RoomMemberUpdated, UpdateRole, RoleUpdated, Ack, UserUpdated, UpdateRoom, RoomUpdated, UpdateSpace, SpaceUpdated, PermissionOverwriteTargets, GetPermissionOverwriteTargets, Owners, Ok, GetOwners, CreateOwner, RoleDeleted, FollowedTopicUpdated, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowTopic, UnfollowTopic, GetFollowedTopics, Messages, GetMessages, Topics, GetTopics, TopicUpdated, UpdateTopic, GetDiscoverableSpaces, DiscoverableSpaces, CreateEmoticon, DeleteEmoticon, GetEmoticons, Emoticons, EmoticonDeleted, NewEmoticon, Bans, GetBans, Ban, Unban, Kick, ClientData, GetClientData, SetClientData, GetRoomSummary, GetSpaceSummary, RoomSummaryEvent, SpaceSummaryEvent, UpdateSpaceMember, Relationships, RelationshipDeleted, NewRelationship, DeleteRelationship, CreateRelationship, RoomSummaryUpdated } from "./types/src/index";
+import { Bye, GetSession, JoinSpace, Session, SpaceJoined, Error as ErrorType, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMemberUpdated, SpaceDeleted, SpaceMembers, SpaceRooms, NewRole, RoomDeleted, RoomJoined, RoomLeft, RoomMemberLeft, RoomMemberJoined, RoomMembers, NewRoom, NewTopic, TopicDeleted, NewMessage, GetPermissionOverwrites, GetComputedPermissions, LeaveSpace, CreateSpace, DeleteSpace, GetSpaceMembers, GetSpaceRooms, CreateRole, DeleteRole, AssignRole, DeassignRole, SetPermissionOverwrites, JoinRoom, LeaveRoom, CreateRoom, DeleteRoom, GetRoomMembers, CreateTopic, DeleteTopic, CreateMessage, Envelope, PermissionOverwrites, PermissionOverwritesUpdated, RoomMemberUpdated, UpdateRole, RoleUpdated, Ack, UserUpdated, UpdateRoom, RoomUpdated, UpdateSpace, SpaceUpdated, PermissionOverwriteTargets, GetPermissionOverwriteTargets, Owners, Ok, GetOwners, CreateOwner, RoleDeleted, FollowedTopicUpdated, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowTopic, UnfollowTopic, GetFollowedTopics, Messages, GetMessages, Topics, GetTopics, TopicUpdated, UpdateTopic, GetDiscoverableSpaces, DiscoverableSpaces, CreateEmoticon, DeleteEmoticon, GetEmoticons, Emoticons, EmoticonDeleted, NewEmoticon, Bans, GetBans, Ban, Unban, Kick, ClientData, GetClientData, SetClientData, GetRoomSummary, GetSpaceSummary, RoomSummaryEvent, SpaceSummaryEvent, UpdateSpaceMember, Relationships, RelationshipDeleted, NewRelationship, DeleteRelationship, CreateRelationship, RoomSummaryUpdated, Pong, Ping } from "./types/src/index";
 import { EventTarget } from "./EventTarget";
 import { GetRelationships } from "./types/src/schemes/commands/GetRelationships";
 import { UpdateRoomMember } from "./types/src/schemes/commands/UpdateRoomMember";
@@ -39,6 +39,7 @@ export type EventsMap = {
     NewRelationship: NewRelationship;
     RelationshipDeleted: RelationshipDeleted;
     Relationships: Relationships;
+    Pong: Pong;
     DiscoverableSpaces: DiscoverableSpaces;
     SpaceJoined: SpaceJoined;
     SpaceLeft: SpaceLeft;
@@ -100,6 +101,7 @@ export type CommandsMap = {
     DeleteRelationship: [DeleteRelationship, EventsMap['RelationshipDeleted']];
     CreateRelationship: [CreateRelationship, EventsMap['NewRelationship']];
     GetRelationships: [GetRelationships, EventsMap['Relationships']];
+    Ping: [Ping, EventsMap['Pong']];
     GetDiscoverableSpaces: [GetDiscoverableSpaces, EventsMap['DiscoverableSpaces']];
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']];
     LeaveSpace: [LeaveSpace, EventsMap['SpaceLeft']];

package/build/types/WebSocketChatClient.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { ObservableInterface } from "./EventTarget";
 import { AbstractChatClient, CommandResult, CommandsMap } from "./AbstractChatClient";
 import { ChatStateTracker } from "./state-tracker/ChatStateTracker";
@@ -9,6 +10,20 @@ export interface WebSocketClientOptions {
     awaitQueueSendDelayMs?: number;
     stateTracking?: boolean;
     queryParams?: Record<string, string>;
+    /**
+     * Ping/pong configuration, enabled by default.
+     */
+    ping?: {
+        enabled?: boolean;
+        /**
+         * Time without activity after which a ping will be sent. Default is 10 seconds.
+         */
+        noActivityTimeoutMs?: number;
+        /**
+         * Time to wait for a pong response before considering the connection dead. Default is 2 seconds.
+         */
+        pongBackTimeoutMs?: number;
+    };
 }
 declare enum WebSocketChatClientEvent {
     connect = "connect",
@@ -25,6 +40,9 @@ export declare class WebSocketChatClient extends AbstractChatClient implements O
     protected connectingTimeoutId: any;
     protected authenticated: boolean;
     protected authenticatedResolvers: [() => void, (error: Error) => void];
+    protected pingIntervalId?: NodeJS.Timeout;
+    protected lastReceivedMessageAt?: number;
+    protected pingInFlight: boolean;
     constructor(options: WebSocketClientOptions);
     connect(): Promise<void>;
     disconnect(): void;
@@ -37,5 +55,7 @@ export declare class WebSocketChatClient extends AbstractChatClient implements O
     private triggerConnectionTimeout;
     private isConnectingWsState;
     private isOpenWsState;
+    private startConnectionMonitor;
+    private stopConnectionMonitor;
 }
 export {};

package/build/types/types/src/index.d.ts

@@ -126,4 +126,6 @@ import { Relationships } from "./schemes/events/Relationships";
 import { CreateRelationship } from "./schemes/commands/CreateRelationship";
 import { RoomSummaryUpdated } from "./schemes/events/RoomSummaryUpdated";
 import { UpdateRoomMember } from "./schemes/commands/UpdateRoomMember";
-export { Envelope, Message, MessageType, MessageAuthor, Role, Room, RoomFlag, RoomType, RoomStream, RoomStreamType, RoomHistory, RoomHistoryMode, RoomMember, RoomSummary, RoomSummaryExtras, Space, SpaceFlag, SpaceMember, Topic, FollowedTopic, User, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, UserRelationship, UserRelationshipType, CreateTopicInitialMessage, Bye, Error, Messages, NewMessage, NewRole, NewRoom, NewTopic, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowedTopicUpdated, ComputedPermissions, PermissionOverwrites, PermissionOverwritesUpdated, RoleDeleted, RoleUpdated, RoomDeleted, RoomUpdated, RoomJoined, RoomLeft, RoomMemberJoined, RoomMemberLeft, RoomMembers, RoomMemberUpdated, UserUpdated, Session, SpaceDeleted, SpaceUpdated, SpaceJoined, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMembers, SpaceMemberUpdated, SpaceRooms, TopicDeleted, TopicUpdated, PermissionOverwriteTargets, Owners, Ok, DiscoverableSpaces, Emoticons, EmoticonDeleted, NewEmoticon, Bans, ClientData, SpaceSummaryEvent, RoomSummaryEvent, NewRelationship, RelationshipDeleted, Relationships, RoomSummaryUpdated, AssignRole, GetMessages, CreateMessage, Ack, CreateRole, CreateRoom, CreateSpace, CreateTopic, FollowTopic, UnfollowTopic, GetFollowedTopics, DeassignRole, DeleteRole, DeleteRoom, DeleteSpace, DeleteTopic, SetPermissionOverwrites, GetPermissionOverwrites, GetComputedPermissions, GetRoomMembers, GetSession, GetSpaceMembers, GetSpaceRooms, JoinRoom, JoinSpace, LeaveRoom, LeaveSpace, UpdateRole, UpdateSpace, UpdateRoom, UpdateTopic, GetPermissionOverwriteTargets, CreateOwner, DeleteOwner, GetOwners, Topics, GetTopics, GetDiscoverableSpaces, GetEmoticons, CreateEmoticon, DeleteEmoticon, Ban, Unban, GetBans, Kick, GetClientData, SetClientData, GetSpaceSummary, GetRoomSummary, UpdateSpaceMember, CreateRelationship, DeleteRelationship, UpdateRoomMember, };
+import { Ping } from "./schemes/commands/Ping";
+import { Pong } from "./schemes/events/Pong";
+export { Envelope, Message, MessageType, MessageAuthor, Role, Room, RoomFlag, RoomType, RoomStream, RoomStreamType, RoomHistory, RoomHistoryMode, RoomMember, RoomSummary, RoomSummaryExtras, Space, SpaceFlag, SpaceMember, Topic, FollowedTopic, User, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, UserRelationship, UserRelationshipType, CreateTopicInitialMessage, Bye, Error, Messages, NewMessage, NewRole, NewRoom, NewTopic, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowedTopicUpdated, ComputedPermissions, PermissionOverwrites, PermissionOverwritesUpdated, RoleDeleted, RoleUpdated, RoomDeleted, RoomUpdated, RoomJoined, RoomLeft, RoomMemberJoined, RoomMemberLeft, RoomMembers, RoomMemberUpdated, UserUpdated, Session, SpaceDeleted, SpaceUpdated, SpaceJoined, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMembers, SpaceMemberUpdated, SpaceRooms, TopicDeleted, TopicUpdated, PermissionOverwriteTargets, Owners, Ok, DiscoverableSpaces, Emoticons, EmoticonDeleted, NewEmoticon, Bans, ClientData, SpaceSummaryEvent, RoomSummaryEvent, NewRelationship, RelationshipDeleted, Relationships, RoomSummaryUpdated, Pong, AssignRole, GetMessages, CreateMessage, Ack, CreateRole, CreateRoom, CreateSpace, CreateTopic, FollowTopic, UnfollowTopic, GetFollowedTopics, DeassignRole, DeleteRole, DeleteRoom, DeleteSpace, DeleteTopic, SetPermissionOverwrites, GetPermissionOverwrites, GetComputedPermissions, GetRoomMembers, GetSession, GetSpaceMembers, GetSpaceRooms, JoinRoom, JoinSpace, LeaveRoom, LeaveSpace, UpdateRole, UpdateSpace, UpdateRoom, UpdateTopic, GetPermissionOverwriteTargets, CreateOwner, DeleteOwner, GetOwners, Topics, GetTopics, GetDiscoverableSpaces, GetEmoticons, CreateEmoticon, DeleteEmoticon, Ban, Unban, GetBans, Kick, GetClientData, SetClientData, GetSpaceSummary, GetRoomSummary, UpdateSpaceMember, CreateRelationship, DeleteRelationship, UpdateRoomMember, Ping, };

package/build/types/types/src/schemes/commands/Ping.d.ts

@@ -0,0 +1,2 @@
+export interface Ping {
+}

package/build/types/types/src/schemes/events/Pong.d.ts

@@ -0,0 +1,2 @@
+export interface Pong {
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polfan-server-js-client",
-  "version": "0.2.66",
+  "version": "0.2.68",
   "description": "JavaScript client library for handling communication with Polfan chat server.",
   "author": "Jarosław Żak",
   "license": "MIT",

package/src/AbstractChatClient.ts

@@ -101,7 +101,7 @@ import {
     NewRelationship,
     DeleteRelationship,
     CreateRelationship,
-    RoomSummaryUpdated,
+    RoomSummaryUpdated, Pong, Ping,
 } from "./types/src/index";
 import {EventTarget} from "./EventTarget";
 import {GetRelationships} from "./types/src/schemes/commands/GetRelationships";
@@ -184,6 +184,7 @@ export type EventsMap = {
     NewRelationship: NewRelationship,
     RelationshipDeleted: RelationshipDeleted,
     Relationships: Relationships,
+    Pong: Pong,
     // Space events
     DiscoverableSpaces: DiscoverableSpaces,
     SpaceJoined: SpaceJoined,
@@ -250,6 +251,7 @@ export type CommandsMap = {
     DeleteRelationship: [DeleteRelationship, EventsMap['RelationshipDeleted']],
     CreateRelationship: [CreateRelationship, EventsMap['NewRelationship']],
     GetRelationships: [GetRelationships, EventsMap['Relationships']],
+    Ping: [Ping, EventsMap['Pong']],
     // Space commands
     GetDiscoverableSpaces: [GetDiscoverableSpaces, EventsMap['DiscoverableSpaces']],
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']],

package/src/WebSocketChatClient.ts

@@ -1,5 +1,5 @@
 import {ObservableInterface} from "./EventTarget";
-import {AbstractChatClient, CommandResult, CommandsMap} from "./AbstractChatClient";
+import {AbstractChatClient, CommandResult, CommandsMap, EventsMap} from "./AbstractChatClient";
 import {ChatStateTracker} from "./state-tracker/ChatStateTracker";
 import {Envelope} from "./types/src";
 
@@ -10,6 +10,20 @@ export interface WebSocketClientOptions {
     awaitQueueSendDelayMs?: number;
     stateTracking?: boolean;
     queryParams?: Record<string, string>;
+    /**
+     * Ping/pong configuration, enabled by default.
+     */
+    ping?: {
+        enabled?: boolean;
+        /**
+         * Time without activity after which a ping will be sent. Default is 10 seconds.
+         */
+        noActivityTimeoutMs?: number;
+        /**
+         * Time to wait for a pong response before considering the connection dead. Default is 2 seconds.
+         */
+        pongBackTimeoutMs?: number;
+    },
 }
 
 enum WebSocketChatClientEvent {
@@ -28,12 +42,20 @@ export class WebSocketChatClient extends AbstractChatClient implements Observabl
     protected connectingTimeoutId: any;
     protected authenticated: boolean;
     protected authenticatedResolvers: [() => void, (error: Error) => void];
+    protected pingIntervalId?: NodeJS.Timeout;
+    protected lastReceivedMessageAt?: number;
+    protected pingInFlight: boolean;
 
     public constructor(private readonly options: WebSocketClientOptions) {
         super();
         if (this.options.stateTracking ?? true) {
             this.state = new ChatStateTracker(this);
         }
+
+        options.ping ??= {};
+        options.ping.enabled ??= true;
+        options.ping.noActivityTimeoutMs ??= 15000;
+        options.ping.pongBackTimeoutMs ??= 5000;
     }
 
     public async connect(): Promise<void> {
@@ -52,13 +74,12 @@ export class WebSocketChatClient extends AbstractChatClient implements Observabl
             this.options.connectingTimeoutMs ?? 10000
         );
         this.authenticated = false;
-
         return new Promise((...args) => this.authenticatedResolvers = args);
     }
 
     public disconnect(): void {
         this.sendQueue = [];
-        this.ws?.close();
+        this.ws?.close(1000); // Normal closure
         this.ws = null;
     }
 
@@ -93,6 +114,7 @@ export class WebSocketChatClient extends AbstractChatClient implements Observabl
     }
 
     private onMessage(event: MessageEvent): void {
+        this.lastReceivedMessageAt = Date.now();
         const envelope: Envelope = JSON.parse(event.data);
         this.handleIncomingEnvelope(envelope);
         this.emit(envelope.type, envelope.data);
@@ -103,6 +125,7 @@ export class WebSocketChatClient extends AbstractChatClient implements Observabl
             const isAuthenticated = envelope.type !== 'Bye';
             this.authenticated = isAuthenticated;
             if (isAuthenticated) {
+                this.startConnectionMonitor();
                 this.authenticatedResolvers[0]();
                 this.emit(this.Event.connect);
                 this.sendFromQueue();
@@ -113,6 +136,7 @@ export class WebSocketChatClient extends AbstractChatClient implements Observabl
     }
 
     private onClose(event: CloseEvent): void {
+        this.stopConnectionMonitor();
         clearTimeout(this.connectingTimeoutId);
         const reconnect = event.code !== 1000; // Connection was closed because of error
         if (reconnect) {
@@ -145,4 +169,42 @@ export class WebSocketChatClient extends AbstractChatClient implements Observabl
     private isOpenWsState(): boolean {
         return this.ws && this.ws.readyState === this.ws.OPEN;
     }
+
+    private startConnectionMonitor(): void {
+        if (!this.options.ping!.enabled) {
+            return;
+        }
+
+        this.lastReceivedMessageAt = Date.now();
+
+        this.pingIntervalId = setInterval(async () => {
+            if (!this.isReady || this.pingInFlight) {
+                return;
+            }
+
+            if ((Date.now() - this.lastReceivedMessageAt) < this.options.ping!.noActivityTimeoutMs) {
+                return;
+            }
+
+            const timeout = setTimeout(() => {
+                this.pingInFlight = false;
+                this.ws.close(1012); // Service Restart (reconnect)
+            }, this.options.ping.pongBackTimeoutMs);
+
+            this.pingInFlight = true;
+
+            this.send('Ping', {}).then(() => {
+                this.pingInFlight = false;
+                clearTimeout(timeout);
+            });
+        }, 1000);
+    }
+
+    private stopConnectionMonitor(): void {
+        if (this.pingIntervalId) {
+            clearInterval(this.pingIntervalId);
+            this.pingIntervalId = undefined;
+        }
+        this.pingInFlight = false;
+    }
 }

package/src/types/src/index.ts

@@ -126,6 +126,8 @@ import {Relationships} from "./schemes/events/Relationships";
 import {CreateRelationship} from "./schemes/commands/CreateRelationship";
 import {RoomSummaryUpdated} from "./schemes/events/RoomSummaryUpdated";
 import {UpdateRoomMember} from "./schemes/commands/UpdateRoomMember";
+import {Ping} from "./schemes/commands/Ping";
+import {Pong} from "./schemes/events/Pong";
 
 export {
     // objects
@@ -215,6 +217,7 @@ export {
     RelationshipDeleted,
     Relationships,
     RoomSummaryUpdated,
+    Pong,
     // commands
     AssignRole,
     GetMessages,
@@ -269,4 +272,5 @@ export {
     CreateRelationship,
     DeleteRelationship,
     UpdateRoomMember,
+    Ping,
 };

package/src/types/src/schemes/commands/Ping.ts

@@ -0,0 +1,3 @@
+export interface Ping {
+
+}

package/src/types/src/schemes/events/Pong.ts

@@ -0,0 +1,3 @@
+export interface Pong {
+
+}