airdcpp-apisocket 3.0.0-beta.6 → 3.0.0-beta.8

package/src/SocketBase.ts

@@ -125,11 +125,11 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
   // Connect handler for creation of new session
   const handlePasswordLogin = (username = options.username, password = options.password) => {
     if (!username) {
-      throw '"username" option was not supplied for authentication';
+      throw new Error('"username" option was not supplied for authentication');
     }
 
     if (!password) {
-      throw '"password" option was not supplied for authentication';
+      throw new Error('"password" option was not supplied for authentication');
     }
 
     const data: API.CredentialsAuthenticationData = {
@@ -146,7 +146,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
 
   const handleRefreshTokenLogin = (refreshToken: string) => {
     if (!refreshToken) {
-      throw '"refreshToken" option was not supplied for authentication';
+      throw new Error('"refreshToken" option was not supplied for authentication');
     }
 
     const data: API.RefreshTokenAuthenticationData = {
@@ -317,7 +317,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
         if (isActive()) {
           if (attempts >= maxAttempts) {
             logger.error(`Socket disconnect timed out after ${timeoutMs} ms`);
-            reject('Socket disconnect timed out');
+            reject(new Error('Socket disconnect timed out'));
           } else {
             setTimeout(wait, checkInterval);
             attempts++;
@@ -343,7 +343,6 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
         }
       } else {
         logger.warn('Attempting to disconnect a closed socket (ignore)');
-        //throw 'Attempting to disconnect a closed socket';
       }
 
       return;
@@ -363,7 +362,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     // Username and password are not required if those are available in socket options
     connect: (username?: string, password?: string, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Connect may only be used for a closed socket';
+        throw new Error('Connect may only be used for a closed socket');
       }
 
       resetSession();
@@ -373,7 +372,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
 
     connectRefreshToken: (refreshToken: string, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Connect may only be used for a closed socket';
+        throw new Error('Connect may only be used for a closed socket');
       }
 
       resetSession();
@@ -384,7 +383,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     // Connect and attempt to associate the socket with an existing session
     reconnect: (token: API.AuthTokenType | undefined = undefined, reconnectOnFailure = true) => {
       if (isActive()) {
-        throw 'Reconnect may only be used for a closed socket';
+        throw new Error('Reconnect may only be used for a closed socket');
       }
 
       if (token) {
@@ -392,7 +391,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
       }
 
       if (!authToken) {
-        throw 'No session token available for reconnecting';
+        throw new Error('No session token available for reconnecting');
       }
 
       logger.info('Reconnecting socket');
@@ -463,7 +462,7 @@ const ApiSocket = (userOptions: Options.APISocketOptions, WebSocketImpl: WebSock
     ...requests.socket,
   };
 
-  return socket!;
+  return socket;
 };
 
 export default ApiSocket;

package/src/SocketRequestHandler.ts

@@ -59,12 +59,12 @@ const SocketRequestHandler = (
     // Pre-checks
     if (!authenticating && !socket().isConnected()) {
       logger.warn(`Attempting to send request on a non-authenticated socket: ${path}`);
-      return Promise.reject('Not authorized');
+      return Promise.reject(new Error('Not authorized'));
     }
 
     if (!socket().nativeSocket) {
       logger.warn(`Attempting to send request without a socket: ${path}`);
-      return Promise.reject('No socket');
+      return Promise.reject(new Error('No socket'));
     }
 
     const callbackId = getCallbackId();
@@ -143,12 +143,10 @@ const SocketRequestHandler = (
     },
   
     delete: (path) => {
-      //invariant(!data, 'No data is allowed for delete command');
       return sendRequest('DELETE', path);
     },
   
     get: (path) => {
-      //invariant(!data, 'No data is allowed for get command');
       return sendRequest('GET', path);
     },
   
@@ -188,7 +186,7 @@ const SocketRequestHandler = (
       if (messageObj.code >= 200 && messageObj.code <= 204) {
         const { data } = messageObj as APIInternal.RequestSuccessResponse;
         if (!callbacks[id].ignored) {
-          logger.verbose(chalk.green(id.toString()), 'SUCCEEDED', data ? data : '(no data)');
+          logger.verbose(chalk.green(id.toString()), 'SUCCEEDED', data ?? '(no data)');
         }
 
         callbacks[id].resolver.resolve(data);

package/src/tests/Socket.test.ts

@@ -1,7 +1,7 @@
 import { 
   DEFAULT_AUTH_RESPONSE, DEFAULT_CONNECT_PARAMS, 
-  getConnectedSocket, getMockServer, getSocket
-} from './mock-server.js';
+  getConnectedSocket as getOriginalConnectedSocket, getMockServer as getOriginalMockServer, getSocket as getOriginalSocket
+} from './mocks';
 
 import ApiConstants from '../ApiConstants.js';
 
@@ -9,18 +9,23 @@ import { HookCallback, HookSubscriberInfo, SubscriptionRemoveHandler } from '../
 import { IncomingSubscriptionEvent } from '../types/api_internal.js';
 
 import { jest } from '@jest/globals';
-import { waitForExpect } from './test-utils.js';
-
-let server: ReturnType<typeof getMockServer>;
+import { defusedPromise, getMockConsole, waitForExpect } from './test-utils.js';
 
 const dummyfn = () => {
   // ..
 };
 
+
 // tslint:disable:no-empty
 describe('socket', () => {
+  let server: ReturnType<typeof getOriginalMockServer>;
+  let mockConsole: ReturnType<typeof getMockConsole>;
+  
   beforeEach(() => {
-    server = getMockServer();
+    mockConsole = getMockConsole();
+    server = getOriginalMockServer({
+      mockF: jest,
+    });
   });
 
   afterEach(() => {
@@ -28,12 +33,27 @@ describe('socket', () => {
     jest.useRealTimers();
   });
 
+  const getDefaultSocketOptions = () => ({
+    logOutput: mockConsole,
+  });
+
+  const getMockSocket = () => {
+    return getOriginalSocket(getDefaultSocketOptions());
+  }
+
+  
+  const getConnectedMockSocket = () => {
+    return getOriginalConnectedSocket(server, {
+      socketOptions: getDefaultSocketOptions(),
+    });
+  }
+
   describe('auth', () => {
     test('should handle valid credentials', async () => {
       server.addRequestHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
       const connectedCallback = jest.fn();
 
-      const { socket, mockConsole } = getSocket();
+      const { socket } = getMockSocket();
       socket.onConnected = connectedCallback;
       const response = await socket.connect();
 
@@ -52,7 +72,7 @@ describe('socket', () => {
       server.addRequestHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
       const connectedCallback = jest.fn();
 
-      const { socket, mockConsole } = getSocket();
+      const { socket } = getMockSocket();
       socket.onConnected = connectedCallback;
       const response = await socket.connectRefreshToken('refresh token');
 
@@ -70,7 +90,7 @@ describe('socket', () => {
     test('should handle invalid credentials', async () => {
       server.addErrorHandler('POST', ApiConstants.LOGIN_URL, 'Invalid username or password', 401);
 
-      const { socket, mockConsole } = getSocket();
+      const { socket } = getMockSocket();
       let error;
 
       try {
@@ -89,9 +109,10 @@ describe('socket', () => {
 
     test('should handle connect with custom credentials', async () => {
       server.stop();
-      const { socket } = getSocket({
+      const { socket } = getOriginalSocket({
         username: 'dummy',
         password: 'dummy',
+        ...getDefaultSocketOptions(),
       });
 
       // Fail without a server handler with auto reconnect disabled
@@ -106,7 +127,7 @@ describe('socket', () => {
       await waitForExpect(() => expect(socket.isActive()).toEqual(false));
 
       // Valid connect attempt
-      server = getMockServer();
+      server = getOriginalMockServer();
       server.addRequestHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE);
 
       await socket.connect(DEFAULT_CONNECT_PARAMS.username, DEFAULT_CONNECT_PARAMS.password, false);
@@ -121,7 +142,7 @@ describe('socket', () => {
       const sessionResetCallback = jest.fn();
       const disconnectedCallback = jest.fn();
 
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
       socket.onSessionReset = sessionResetCallback;
       socket.onDisconnected = disconnectedCallback;
 
@@ -132,10 +153,7 @@ describe('socket', () => {
       // Dummy pending request
       server.ignoreMissingHandler('DELETE', 'dummyLogoutDelete');
 
-      socket.delete('dummyLogoutDelete').catch((error: Error) => {
-        // TODO: fix, too unreliable at the moment (depends on the timings)
-        //expect(error.message).toEqual('Socket disconnected');
-      });
+      const pendingRequestPromise = defusedPromise(socket.delete('dummyLogoutDelete'));
 
       // Logout
       server.addRequestHandler('DELETE', ApiConstants.LOGOUT_URL);
@@ -144,6 +162,8 @@ describe('socket', () => {
       expect(sessionResetCallback.mock.calls.length).toBe(1);
       await waitForExpect(() => expect(disconnectedCallback.mock.calls.length).toBe(1));
 
+      await expect(pendingRequestPromise).rejects.toMatchInlineSnapshot(`"Socket disconnected"`);
+
       expect(socket.isActive()).toEqual(false);
       expect(socket.hasListeners()).toEqual(false);
       expect(socket.getPendingRequestCount()).toEqual(0);
@@ -155,7 +175,7 @@ describe('socket', () => {
 
   describe('disconnect', () => {
     test('should handle disconnect', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
       socket.disconnect();
 
@@ -167,16 +187,16 @@ describe('socket', () => {
     });
 
     test('should handle wait disconnected timeout', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
-      let error;
+      let error: Error | null = null;
       try {
         await socket.waitDisconnected(50);
       } catch (e) {
         error = e;
       }
 
-      expect(error).toEqual('Socket disconnect timed out');
+      expect(error?.message).toEqual('Socket disconnect timed out');
 
       expect(mockConsole.error.mock.calls.length).toBe(1);
       expect(mockConsole.warn.mock.calls.length).toBe(0);
@@ -188,19 +208,14 @@ describe('socket', () => {
 
   describe('reconnect', () => {
     test('should handle auto reconnect', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
       jest.useFakeTimers();
 
       socket.disconnect(true);
       jest.runOnlyPendingTimers();
       
-      // TODO: fix
-      /*{
-        const waitForExpectTask = await waitForExpect(() => expect(socket.isActive()).toEqual(false));
-        jest.advanceTimersByTime(1000);
-        await waitForExpectTask;
-      }*/
+      expect(socket.isActive()).toEqual(false);
 
       // Let it fail once
       server.stop();
@@ -208,7 +223,7 @@ describe('socket', () => {
       jest.runOnlyPendingTimers();
       expect(mockConsole.error.mock.calls.length).toBe(1);
 
-      server = getMockServer();
+      server = getOriginalMockServer();
       server.addRequestHandler('POST', ApiConstants.CONNECT_URL, undefined);
       jest.runOnlyPendingTimers();
       jest.runOnlyPendingTimers();
@@ -229,7 +244,7 @@ describe('socket', () => {
     });
 
     test('should cancel auto reconnect', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
       jest.useFakeTimers();
 
@@ -255,7 +270,7 @@ describe('socket', () => {
     });
 
     test('should handle manual reconnect', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
       socket.disconnect();
       await waitForExpect(() => expect(socket.isActive()).toEqual(false));
@@ -271,12 +286,13 @@ describe('socket', () => {
       await waitForExpect(() => expect(socket.isActive()).toEqual(false));
     });
 
-    // TODO: fix
-    test.skip('should re-authenticate on lost session', async () => {
+    test('should re-authenticate on lost session', async () => {
       const ErrorResponse = 'Invalid session token';
+      const authCallback = jest.fn();
+      const connectErrorCallback = jest.fn();
 
       // Connect and disconnect
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
       jest.useFakeTimers();
       socket.disconnect();
@@ -285,25 +301,16 @@ describe('socket', () => {
 
       // Fail the initial reconnect attempt with 'Invalid session token'
       // and connect with credentials afterwards
-      server.addErrorHandler('POST', ApiConstants.CONNECT_URL, ErrorResponse, 400);
+      server.addErrorHandler('POST', ApiConstants.CONNECT_URL, ErrorResponse, 400, connectErrorCallback);
       
-      const authCallback = jest.fn();
       server.addRequestHandler('POST', ApiConstants.LOGIN_URL, DEFAULT_AUTH_RESPONSE, authCallback);
 
       jest.runOnlyPendingTimers();
       socket.reconnect();
 
-      {
-        const waitForExpectTask = waitForExpect(
-          () => {
-            jest.runOnlyPendingTimers();
-            expect(authCallback.mock.calls.length).toBe(1);
-          }
-        );
-
-        jest.advanceTimersByTime(1000);
-        await waitForExpectTask;
-      }
+      await jest.advanceTimersByTimeAsync(1000);
+      expect(authCallback.mock.calls.length).toBe(1);
+      expect(connectErrorCallback.mock.calls.length).toBe(1);
 
       expect(socket.isConnected()).toEqual(true);
       expect(mockConsole.error.mock.calls.length).toBe(0);
@@ -329,7 +336,7 @@ describe('socket', () => {
 
   describe('requests', () => {
     test('should report request timeouts', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
       server.ignoreMissingHandler('POST', 'hubs/listeners/hub_updated');
       server.ignoreMissingHandler('POST', 'hubs/listeners/hub_added');
@@ -359,7 +366,7 @@ describe('socket', () => {
     });
 
     test('should handle missing error messages', async () => {
-      const { socket } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
       server.addErrorHandler('POST', 'test/test', null, 401);
 
@@ -393,7 +400,7 @@ describe('socket', () => {
     };
 
     test('should handle listener messages', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
       server.addSubscriptionHandler('hubs', 'hub_updated');
       server.addSubscriptionHandler('hubs', 'hub_updated', entityId);
 
@@ -419,7 +426,7 @@ describe('socket', () => {
     });
 
     test('should handle listener removal', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
 
       const hubUpdatedListener = server.addSubscriptionHandler('hubs', 'hub_updated');
 
@@ -451,7 +458,7 @@ describe('socket', () => {
     });
 
     test('should handle view updates', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
       const viewUpdateCallback = jest.fn();
 
       const removeListener = socket.addViewUpdateListener('hub_user_view', viewUpdateCallback, entityId);
@@ -482,7 +489,7 @@ describe('socket', () => {
     };
 
     test('should handle hook actions', async () => {
-      const { socket, mockConsole } = await getConnectedSocket(server);
+      const { socket } = await getConnectedMockSocket();
       let removeListener: SubscriptionRemoveHandler | null = null;
 
       // Add hook
@@ -506,10 +513,8 @@ describe('socket', () => {
       }
 
       // Clean up
-      {
-        removeListener();
-        expect(socket.hasListeners()).toBe(false);
-      }
+      removeListener();
+      expect(socket.hasListeners()).toBe(false);
 
       expect(mockConsole.warn.mock.calls.length).toBe(0);
 
@@ -520,9 +525,10 @@ describe('socket', () => {
 
   describe('logging', () => {
     const connect = async (logLevel: string) => {
-      const { socket, mockConsole } = await getConnectedSocket(server, {
+      const { socket } = await getOriginalConnectedSocket(server, {
         socketOptions: {
           logLevel,
+          ...getDefaultSocketOptions(),
         },
       });
 

package/src/tests/mocks/index.ts

@@ -0,0 +1,3 @@
+export * from './mock-data.js';
+export * from './mock-server.js';
+export * from './mock-socket.js';

package/src/tests/mocks/mock-data.ts

@@ -0,0 +1,26 @@
+
+export const DEFAULT_CONNECT_PARAMS = {
+  username: 'test',
+  password: 'test',
+  url: 'ws://localhost:7171/api/v1/',
+};
+
+export const DEFAULT_AUTH_RESPONSE = {
+  auth_token: 'b823187f-4aab-4b71-9764-e63e88401a26',
+  refresh_token: '5124faasf-4aab-4b71-9764-e63e88401a26',
+  user: {
+    permissions: [ 'admin' ],
+    username: 'test',
+    active_sessions: 1,
+    last_login: 0,
+  },
+  system: {
+    cid: 'AHLUODI2YZ2U7FDWMHFNJU65ERGKUN4MH7GW5LY',
+    hostname: 'ubuntu-htpc',
+    network_type: 'private',
+    path_separator: '/',
+    platform: 'other',
+    language: 'fi',
+  },
+  wizard_pending: false,
+};