push.rocks/smartsocket
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

BREAKING CHANGE(socketconnection): Stricter typings, smartserve hooks, connection fixes, and tag API change

Browse Source
This commit is contained in:
Jürgen Kunz
2025-12-04 07:59:44 +00:00
parent 5b21955e04
commit 0499db71b8
12 changed files with 1039 additions and 2864 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
ts/00_commitinfo_data.ts
View File

@@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@push.rocks/smartsocket',
version: '3.0.0',
version: '4.0.0',
description: 'Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.'
}

8
ts/interfaces/message.ts
View File

@@ -13,7 +13,7 @@ export type TMessageType =
/**
* Base message interface for all smartsocket messages
*/
export interface ISocketMessage<T = any> {
export interface ISocketMessage<T = unknown> {
type: TMessageType;
id?: string; // For request/response correlation
payload: T;
@@ -44,16 +44,16 @@ export interface IAuthResponsePayload {
/**
* Function call payload
*/
export interface IFunctionCallPayload {
export interface IFunctionCallPayload<T = unknown> {
funcName: string;
funcData: any;
funcData: T;
}
/**
* Tag update payload
*/
export interface ITagUpdatePayload {
tags: { [key: string]: any };
tags: Record<string, unknown>;
}
/**

6
ts/smartsocket.classes.smartsocket.ts
View File

@@ -58,7 +58,7 @@ export class Smartsocket {
* Handle a new WebSocket connection
* Called by SocketServer when a new connection is established
*/
public async handleNewConnection(socket: WebSocket | pluginsTyped.ws.WebSocket) {
public async handleNewConnection(socket: pluginsTyped.TWebSocket | pluginsTyped.IWebSocketLike) {
const socketConnection: SocketConnection = new SocketConnection({
alias: undefined,
authenticated: false,
@@ -76,8 +76,8 @@ export class Smartsocket {
socketConnection.eventSubject.next('disconnected');
};
socket.addEventListener('close', handleClose);
socket.addEventListener('error', handleClose);
(socket as pluginsTyped.IWebSocketLike).addEventListener('close', handleClose);
(socket as pluginsTyped.IWebSocketLike).addEventListener('error', handleClose);
try {
await socketConnection.authenticate();

9
ts/smartsocket.classes.smartsocketclient.ts
View File

@@ -98,11 +98,18 @@ export class SmartsocketClient {
}
private isReconnecting = false;
private isConnecting = false;
/**
* connect the client to the server
*/
public async connect() {
// Prevent duplicate connection attempts
if (this.isConnecting) {
return;
}
this.isConnecting = true;
// Only reset retry counters on fresh connection (not during auto-reconnect)
if (!this.isReconnecting) {
this.currentRetryCount = 0;
@@ -213,6 +220,7 @@ export class SmartsocketClient {
await this.addTag(oldTagStore[tag]);
}
this.updateStatus('connected');
this.isConnecting = false;
done.resolve();
break;
@@ -262,6 +270,7 @@ export class SmartsocketClient {
return;
}
this.disconnectRunning = true;
this.isConnecting = false;
this.updateStatus('disconnecting');
this.tagStoreSubscription?.unsubscribe();

37
ts/smartsocket.classes.socketconnection.ts
View File

@@ -26,7 +26,7 @@ export interface ISocketConnectionConstructorOptions {
authenticated: boolean;
side: TSocketConnectionSide;
smartsocketHost: Smartsocket | SmartsocketClient;
socket: WebSocket | pluginsTyped.ws.WebSocket;
socket: pluginsTyped.TWebSocket | pluginsTyped.IWebSocketLike;
}
/**
@@ -47,7 +47,7 @@ export class SocketConnection {
public side: TSocketConnectionSide;
public authenticated: boolean = false;
public smartsocketRef: Smartsocket | SmartsocketClient;
public socket: WebSocket | pluginsTyped.ws.WebSocket;
public socket: pluginsTyped.TWebSocket | pluginsTyped.IWebSocketLike;
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
public eventStatus: interfaces.TConnectionStatus = 'new';
@@ -82,13 +82,13 @@ export class SocketConnection {
public handleMessage(messageData: interfaces.ISocketMessage): void {
switch (messageData.type) {
case 'function':
this.handleFunctionCall(messageData);
this.handleFunctionCall(messageData as interfaces.ISocketMessage<interfaces.IFunctionCallPayload>);
break;
case 'functionResponse':
this.handleFunctionResponse(messageData);
this.handleFunctionResponse(messageData as interfaces.ISocketMessage<interfaces.IFunctionCallPayload>);
break;
case 'tagUpdate':
this.handleTagUpdate(messageData);
this.handleTagUpdate(messageData as interfaces.ISocketMessage<interfaces.ITagUpdatePayload>);
break;
default:
// Authentication messages are handled by the server/client classes
@@ -96,7 +96,7 @@ export class SocketConnection {
}
}
private handleFunctionCall(messageData: interfaces.ISocketMessage): void {
private handleFunctionCall(messageData: interfaces.ISocketMessage<interfaces.IFunctionCallPayload>): void {
const requestData: ISocketRequestDataObject<any> = {
funcCallData: {
funcName: messageData.payload.funcName,
@@ -123,7 +123,7 @@ export class SocketConnection {
}
}
private handleFunctionResponse(messageData: interfaces.ISocketMessage): void {
private handleFunctionResponse(messageData: interfaces.ISocketMessage<interfaces.IFunctionCallPayload>): void {
const responseData: ISocketRequestDataObject<any> = {
funcCallData: {
funcName: messageData.payload.funcName,
@@ -141,7 +141,7 @@ export class SocketConnection {
}
}
private handleTagUpdate(messageData: interfaces.ISocketMessage): void {
private handleTagUpdate(messageData: interfaces.ISocketMessage<interfaces.ITagUpdatePayload>): void {
const tagStoreArg = messageData.payload.tags as interfaces.TTagStore;
if (!plugins.smartjson.deepEqualObjects(this.tagStore, tagStoreArg)) {
this.tagStore = tagStoreArg;
@@ -181,17 +181,16 @@ export class SocketConnection {
}
/**
* gets a tag by id
* @param tagIdArg
* Gets a tag by id
*/
public async getTagById(tagIdArg: interfaces.ITag['id']) {
public getTagById(tagIdArg: interfaces.ITag['id']): interfaces.ITag | undefined {
return this.tagStore[tagIdArg];
}
/**
* removes a tag from a connection
* Removes a tag from a connection
*/
public async removeTagById(tagIdArg: interfaces.ITag['id']) {
public removeTagById(tagIdArg: interfaces.ITag['id']): void {
delete this.tagStore[tagIdArg];
this.tagStoreObservable.next(this.tagStore);
this.sendMessage({
@@ -209,7 +208,7 @@ export class SocketConnection {
const done = plugins.smartpromise.defer<SocketConnection>();
// Set up message handler for authentication
const messageHandler = (event: MessageEvent | { data: string }) => {
const messageHandler = (event: pluginsTyped.TMessageEvent) => {
try {
const data = typeof event.data === 'string' ? event.data : event.data.toString();
const message: interfaces.ISocketMessage = JSON.parse(data);
@@ -241,11 +240,11 @@ export class SocketConnection {
}
}
} catch (err) {
// Not a valid message, ignore
logger.log('warn', `Failed to parse auth message: ${err instanceof Error ? err.message : String(err)}`);
}
};
this.socket.addEventListener('message', messageHandler as any);
(this.socket as pluginsTyped.IWebSocketLike).addEventListener('message', messageHandler);
// Request authentication
const requestAuthPayload: interfaces.TAuthRequestMessage = {
@@ -268,17 +267,17 @@ export class SocketConnection {
const done = plugins.smartpromise.defer();
if (this.authenticated) {
// Set up message handler for all messages
const messageHandler = (event: MessageEvent | { data: string }) => {
const messageHandler = (event: pluginsTyped.TMessageEvent) => {
try {
const data = typeof event.data === 'string' ? event.data : event.data.toString();
const message: interfaces.ISocketMessage = JSON.parse(data);
this.handleMessage(message);
} catch (err) {
// Not a valid JSON message, ignore
logger.log('warn', `Failed to parse socket message: ${err instanceof Error ? err.message : String(err)}`);
}
};
this.socket.addEventListener('message', messageHandler as any);
(this.socket as pluginsTyped.IWebSocketLike).addEventListener('message', messageHandler);
logger.log(
'info',

4
ts/smartsocket.classes.socketrequest.ts
View File

@@ -128,6 +128,10 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
};
this.originSocketConnection.sendMessage(message);
this.smartsocketRef.socketRequests.remove(this);
})
.catch((error) => {
logger.log('error', `Function invocation failed for ${this.funcCallData.funcName}: ${error instanceof Error ? error.message : String(error)}`);
this.smartsocketRef.socketRequests.remove(this);
});
}
}

8
ts/smartsocket.classes.socketserver.ts
View File

@@ -114,7 +114,7 @@ export class SocketServer {
onOpen: async (peer: pluginsTyped.ISmartserveWebSocketPeer) => {
// Create a wrapper that adapts ISmartserveWebSocketPeer to WebSocket-like interface
const wsLikeSocket = this.createWsLikeFromPeer(peer);
await this.smartsocket.handleNewConnection(wsLikeSocket as any);
await this.smartsocket.handleNewConnection(wsLikeSocket);
},
onMessage: async (peer: pluginsTyped.ISmartserveWebSocketPeer, message: pluginsTyped.ISmartserveWebSocketMessage) => {
// Dispatch message to the SocketConnection via the adapter
@@ -153,8 +153,8 @@ export class SocketServer {
* Creates a WebSocket-like object from a smartserve peer
* This allows our SocketConnection to work with both native WebSocket and smartserve peers
*/
private createWsLikeFromPeer(peer: pluginsTyped.ISmartserveWebSocketPeer): any {
const messageListeners: Array<(event: any) => void> = [];
private createWsLikeFromPeer(peer: pluginsTyped.ISmartserveWebSocketPeer): pluginsTyped.IWebSocketLike {
const messageListeners: Array<(event: pluginsTyped.TMessageEvent) => void> = [];
const closeListeners: Array<() => void> = [];
const errorListeners: Array<() => void> = [];
@@ -174,7 +174,7 @@ export class SocketServer {
});
return {
readyState: peer.readyState,
get readyState() { return peer.readyState; },
send: (data: string) => peer.send(data),
close: (code?: number, reason?: string) => peer.close(code, reason),
addEventListener: (event: string, listener: any) => {

23
ts/smartsocket.pluginstyped.ts
View File

@@ -13,6 +13,29 @@ export namespace ws {
export type RawData = wsTypes.RawData;
}
/**
* Unified WebSocket type supporting both browser and Node.js environments
*/
export type TWebSocket = WebSocket | ws.WebSocket;
/**
* Message event type for WebSocket messages (browser and Node.js compatible)
*/
export type TMessageEvent = MessageEvent | { data: string };
/**
* WebSocket-like interface for adapters (e.g., smartserve peer adapter)
*/
export interface IWebSocketLike {
readyState: number;
send(data: string): void;
close(code?: number, reason?: string): void;
addEventListener(event: 'message', listener: (event: TMessageEvent) => void): void;
addEventListener(event: 'close', listener: () => void): void;
addEventListener(event: 'error', listener: () => void): void;
removeEventListener?(event: string, listener: (...args: any[]) => void): void;
}
// smartserve compatibility interface (for setExternalServer)
// This mirrors the IWebSocketPeer interface from smartserve
export interface ISmartserveWebSocketPeer {