feat: pr feedback

Author: JustSamuel

README.md

@@ -115,28 +115,6 @@ npm run watch
 ```
 
 The server will be available at `http://localhost:3000`
-
-### 6. WebSocket (Socket.IO) authentication
-
-The backend exposes a Socket.IO server (default `WEBSOCKET_PORT=8080` in development).
-
-- **Connect with token (preferred)**: provide the JWT in `handshake.auth.token`.
-- **Room subscriptions**: clients must `emit('subscribe', roomName)` to join rooms. Rooms that require authorization will respond with an `error` event if the client is unauthenticated/unauthorized.
-
-Example:
-
-```ts
-import { io } from 'socket.io-client';
-
-const socket = io('http://localhost:8080', {
-  auth: { token: '<jwt>' },
-});
-
-socket.on('error', (err) => console.error(err));
-socket.emit('subscribe', 'pos:123:transactions');
-socket.on('transaction:created', (tx) => console.log(tx));
-```
-
 ### 6. Access API Documentation
 
 Visit `http://localhost:3000/api-docs` to access the Swagger UI for API documentation.

src/controller/server-settings-controller.ts

@@ -109,7 +109,7 @@ export default class ServerSettingsController extends BaseController {
       await store.setSetting('maintenanceMode', body.enabled);
 
       // Send websocket message to POS
-      WebSocketService.sendMaintenanceMode(body.enabled);
+      WebSocketService.emitMaintenanceMode(body.enabled);
 
       res.status(204).send();
     } catch (error) {

src/index.ts

@@ -247,10 +247,9 @@ export default async function createApp(): Promise<Application> {
   try {
     const existingInstance = WebSocketService.getInstance();
     if (existingInstance.server.listening) {
-      const l = log4js.getLogger('index');
-      l.info('Closing existing WebSocket server before creating new instance');
+      application.logger.info('Closing existing WebSocket server before creating new instance');
       existingInstance.server.close(() => {
-        l.info('Existing WebSocket server closed');
+        application.logger.info('Existing WebSocket server closed');
       });
     }
   } catch {

src/service/websocket-service.ts

@@ -30,7 +30,7 @@ import TokenHandler from '../authentication/token-handler';
 import JsonWebToken from '../authentication/json-web-token';
 import User from '../entity/user/user';
 import { TransactionResponse } from '../controller/response/transaction-response';
-import { parseRoom } from './websocket/room-authorization';
+import { parseRoom } from './websocket/room-parser';
 import {
   RoomPolicyRegistry,
   RoomRegistration,
@@ -193,7 +193,7 @@ export default class WebSocketService {
       },
     });
 
-    // Register global transaction rooms
+    // Register global transaction room
     this.registerRoom({
       pattern: 'transactions:all',
       policy: async (context) => this.roleManager.can(
@@ -326,7 +326,7 @@ export default class WebSocketService {
 
     const tokenString = tokenFromAuth ?? tokenFromQuery;
 
-    if (!tokenString || typeof tokenString !== 'string') {
+    if (!tokenString) {
       this.logger.trace(`Client ${client.id} connected without authentication`);
       return;
     }
@@ -339,7 +339,6 @@ export default class WebSocketService {
       const token = await this.tokenHandler.verifyToken(tokenString);
       const user = await User.findOne({ 
         where: { id: token.user.id },
-        relations: { pointOfSale: true },
       });
 
       if (user) {
@@ -550,7 +549,7 @@ export default class WebSocketService {
    * Delegates to the singleton instance.
    * @throws Error if WebSocketService has not been initialized.
    */
-  public static sendMaintenanceMode(enabled: boolean): void {
+  public static emitMaintenanceMode(enabled: boolean): void {
     this.getInstance().sendMaintenanceMode(enabled);
   }
 

src/service/websocket/event-guards.ts

@@ -18,7 +18,7 @@
  *  @license
  */
 
-import { ParsedRoom } from './room-authorization';
+import { ParsedRoom } from './room-parser';
 
 /**
  * Guard function that determines if an event should be emitted to a room.

…/service/websocket/room-authorization.ts src/service/websocket/room-parser.tssrc/service/websocket/room-authorization.ts renamed to src/service/websocket/room-parser.ts src/service/websocket/room-authorization.ts renamed to src/service/websocket/room-parser.ts

@@ -20,7 +20,7 @@
 
 import User from '../../entity/user/user';
 import JsonWebToken from '../../authentication/json-web-token';
-import { ParsedRoom, matchesRoomPattern } from './room-authorization';
+import { ParsedRoom, matchesRoomPattern } from './room-parser';
 
 /**
  * WebSocket request context similar to RequestWithToken but for WebSocket connections.

src/service/websocket/room-policy.ts

@@ -80,7 +80,7 @@ describe('ServerSettingsController', () => {
       tokenHandler: mockTokenHandler,
       roleManager: mockRoleManager,
     });
-    // Mock sendMaintenanceMode to avoid actual WebSocket operations in tests
+    // Mock emitMaintenanceMode to avoid actual WebSocket operations in tests
     sinon.stub(webSocketService, 'sendMaintenanceMode').returns(undefined);
     sinon.stub(WebSocketService, 'getInstance').returns(webSocketService);
 

test/unit/controller/server-settings-controller.ts

@@ -200,7 +200,7 @@ describe('WebSocketService', () => {
 
         // Send maintenance mode and verify we don't receive it after unsubscribing
         setTimeout(() => {
-          WebSocketService.sendMaintenanceMode(true);
+          WebSocketService.emitMaintenanceMode(true);
 
           setTimeout(() => {
             expect(receivedAfterUnsubscribe).to.be.false;
@@ -242,12 +242,12 @@ describe('WebSocketService', () => {
         clientSocket.on('maintenance-mode', () => {
           done();
         });
-        WebSocketService.sendMaintenanceMode(true);
+        WebSocketService.emitMaintenanceMode(true);
       }, 200);
     });
   });
 
-  describe('sendMaintenanceMode function', () => {
+  describe('emitMaintenanceMode function', () => {
     it('should emit maintenance-mode event to subscribed clients', (done) => {
       // Configure ServerSettingsStore mock to return 'true' for maintenance mode
       serverSettingsMock.getSettingFromDatabase.withArgs('maintenanceMode').resolves(true);
@@ -264,7 +264,7 @@ describe('WebSocketService', () => {
 
       // Wait for subscription to complete, then send maintenance mode
       setTimeout(() => {
-        WebSocketService.sendMaintenanceMode(true);
+        WebSocketService.emitMaintenanceMode(true);
       }, 100);
     });
 
@@ -284,7 +284,7 @@ describe('WebSocketService', () => {
 
       // Also send maintenance mode manually to ensure test completes
       setTimeout(() => {
-        WebSocketService.sendMaintenanceMode(false);
+        WebSocketService.emitMaintenanceMode(false);
       }, 300);
     });
   });
@@ -567,10 +567,10 @@ describe('WebSocketService', () => {
       expect(webSocketService.emitQRConfirmed).to.be.a('function');
     });
 
-    it('should delegate sendMaintenanceMode to instance', () => {
+    it('should delegate emitMaintenanceMode to instance', () => {
       // Should complete without error
-      WebSocketService.sendMaintenanceMode(true);
-      WebSocketService.sendMaintenanceMode(false);
+      WebSocketService.emitMaintenanceMode(true);
+      WebSocketService.emitMaintenanceMode(false);
 
       // Verify method exists
       expect(webSocketService.sendMaintenanceMode).to.be.a('function');

test/unit/service/websocket-service.ts

@@ -20,7 +20,7 @@
 
 import { expect } from 'chai';
 import { InPosGuard, ForUserGuard } from '../../../../src/service/websocket/event-guards';
-import { ParsedRoom } from '../../../../src/service/websocket/room-authorization';
+import { ParsedRoom } from '../../../../src/service/websocket/room-parser';
 
 describe('Event Guards', () => {
   describe('InPosGuard', () => {