|
| 1 | +import * as vscode from 'vscode'; |
| 2 | +import { beforeEach, describe, expect, it, vi } from 'vitest'; |
| 3 | +import { ServerManager } from './ServerManager'; |
| 4 | +import { URLMap, withResolvers } from '../util'; |
| 5 | +import type { |
| 6 | + ConnectionState, |
| 7 | + IAsyncCacheService, |
| 8 | + IConfigService, |
| 9 | + IDhcServiceFactory, |
| 10 | + IDheService, |
| 11 | + ISecretService, |
| 12 | + IToastService, |
| 13 | + PublicOf, |
| 14 | + ServerState, |
| 15 | + ServerType, |
| 16 | +} from '../types'; |
| 17 | + |
| 18 | +// See __mocks__/vscode.ts for the mock implementation |
| 19 | +vi.mock('vscode'); |
| 20 | + |
| 21 | +// Avoid real server status polling triggered by the constructor's |
| 22 | +// `loadServerConfig` call. |
| 23 | +vi.mock('../dh/dhc', () => ({ |
| 24 | + isDhcServerRunning: vi.fn().mockResolvedValue(false), |
| 25 | +})); |
| 26 | +vi.mock('../dh/dhe', () => ({ |
| 27 | + getWorkerCredentials: vi.fn(), |
| 28 | + isDheServerRunning: vi.fn().mockResolvedValue(false), |
| 29 | +})); |
| 30 | + |
| 31 | +/** |
| 32 | + * Internal shape of `ServerManager` used to seed state and stub the actual |
| 33 | + * connection logic so we can exercise the `connectToServer` race-condition |
| 34 | + * handling in isolation. |
| 35 | + */ |
| 36 | +type TestServerManager = PublicOf<ServerManager> & { |
| 37 | + _serverMap: URLMap<ServerState>; |
| 38 | + _connectionMap: URLMap<ConnectionState>; |
| 39 | + _pendingConnectionMap: URLMap<Promise<ConnectionState | null>>; |
| 40 | + _doConnectToServer: ReturnType<typeof vi.fn>; |
| 41 | +}; |
| 42 | + |
| 43 | +/** Build a `ServerManager` with minimal mocked dependencies. */ |
| 44 | +function createServerManager(): TestServerManager { |
| 45 | + const configService = { |
| 46 | + getCoreServers: vi.fn().mockReturnValue([]), |
| 47 | + getEnterpriseServers: vi.fn().mockReturnValue([]), |
| 48 | + } as unknown as IConfigService; |
| 49 | + |
| 50 | + const dhcServiceFactory = { |
| 51 | + create: vi.fn(), |
| 52 | + } as unknown as IDhcServiceFactory; |
| 53 | + |
| 54 | + const dheServiceCache = { |
| 55 | + has: vi.fn().mockReturnValue(false), |
| 56 | + get: vi.fn(), |
| 57 | + } as unknown as IAsyncCacheService<URL, IDheService>; |
| 58 | + |
| 59 | + const manager = new ServerManager( |
| 60 | + configService, |
| 61 | + new URLMap(), |
| 62 | + dhcServiceFactory, |
| 63 | + new URLMap(), |
| 64 | + dheServiceCache, |
| 65 | + { appendLine: vi.fn() } as unknown as vscode.OutputChannel, |
| 66 | + {} as ISecretService, |
| 67 | + { info: vi.fn(), error: vi.fn() } as IToastService |
| 68 | + ) as unknown as TestServerManager; |
| 69 | + |
| 70 | + return manager; |
| 71 | +} |
| 72 | + |
| 73 | +function mockConnectionState(url: URL): ConnectionState { |
| 74 | + return { isConnected: true, serverUrl: url }; |
| 75 | +} |
| 76 | + |
| 77 | +function mockServerState({ |
| 78 | + url, |
| 79 | + type = 'DHC', |
| 80 | + connectionCount = 0, |
| 81 | +}: { |
| 82 | + url: URL; |
| 83 | + type?: ServerType; |
| 84 | + connectionCount?: number; |
| 85 | +}): ServerState { |
| 86 | + return { |
| 87 | + type, |
| 88 | + url, |
| 89 | + isConnected: connectionCount > 0, |
| 90 | + isRunning: true, |
| 91 | + connectionCount, |
| 92 | + }; |
| 93 | +} |
| 94 | + |
| 95 | +const serverUrl = new URL('http://localhost:10000/'); |
| 96 | +const dhcServer0 = mockServerState({ |
| 97 | + url: serverUrl, |
| 98 | + type: 'DHC', |
| 99 | +}); |
| 100 | +const dhcServer1 = mockServerState({ |
| 101 | + url: serverUrl, |
| 102 | + type: 'DHC', |
| 103 | + connectionCount: 1, |
| 104 | +}); |
| 105 | +const dheServer0 = mockServerState({ |
| 106 | + url: serverUrl, |
| 107 | + type: 'DHE', |
| 108 | +}); |
| 109 | +const cn1 = mockConnectionState(serverUrl); |
| 110 | +const cn2 = mockConnectionState(serverUrl); |
| 111 | + |
| 112 | +describe('ServerManager.connectToServer', () => { |
| 113 | + let manager: TestServerManager; |
| 114 | + |
| 115 | + let promise: Promise<ConnectionState | null>; |
| 116 | + let resolve: (value: ConnectionState | null) => void; |
| 117 | + |
| 118 | + beforeEach(() => { |
| 119 | + vi.clearAllMocks(); |
| 120 | + manager = createServerManager(); |
| 121 | + |
| 122 | + ({ promise, resolve } = withResolvers<ConnectionState | null>()); |
| 123 | + |
| 124 | + manager._doConnectToServer = vi.fn().mockReturnValue(promise); |
| 125 | + }); |
| 126 | + |
| 127 | + it('throws when the server is not found', async () => { |
| 128 | + await expect(manager.connectToServer(serverUrl)).rejects.toThrow( |
| 129 | + `Server with URL '${serverUrl}' not found.` |
| 130 | + ); |
| 131 | + }); |
| 132 | + |
| 133 | + it('returns the existing connection for an already-connected DHC server', async () => { |
| 134 | + manager._serverMap.set(dhcServer1.url, dhcServer1); |
| 135 | + manager._connectionMap.set(serverUrl, cn1); |
| 136 | + |
| 137 | + const result = await manager.connectToServer(serverUrl); |
| 138 | + |
| 139 | + expect(result).toBe(cn1); |
| 140 | + expect(manager._doConnectToServer).not.toHaveBeenCalled(); |
| 141 | + }); |
| 142 | + |
| 143 | + it('only connects once when called concurrently for the same DHC server', async () => { |
| 144 | + manager._serverMap.set(dhcServer0.url, dhcServer0); |
| 145 | + |
| 146 | + const first = manager.connectToServer(serverUrl); |
| 147 | + const second = manager.connectToServer(serverUrl); |
| 148 | + |
| 149 | + // The in-progress connection is reused rather than starting a new one. |
| 150 | + expect(manager._doConnectToServer).toHaveBeenCalledTimes(1); |
| 151 | + |
| 152 | + resolve(cn1); |
| 153 | + |
| 154 | + expect(await first).toBe(cn1); |
| 155 | + expect(await second).toBe(cn1); |
| 156 | + }); |
| 157 | + |
| 158 | + it('clears the pending connection once it resolves so later calls reconnect', async () => { |
| 159 | + manager._serverMap.set(dhcServer0.url, dhcServer0); |
| 160 | + |
| 161 | + manager._doConnectToServer.mockResolvedValue(cn1); |
| 162 | + const first = manager.connectToServer(serverUrl); |
| 163 | + expect(manager._pendingConnectionMap.has(serverUrl)).toBe(true); |
| 164 | + expect(await first).toBe(cn1); |
| 165 | + |
| 166 | + expect(manager._pendingConnectionMap.has(serverUrl)).toBe(false); |
| 167 | + |
| 168 | + // A subsequent connect attempt is not blocked by the resolved pending entry. |
| 169 | + manager._doConnectToServer.mockResolvedValue(cn2); |
| 170 | + const second = manager.connectToServer(serverUrl); |
| 171 | + expect(await second).toBe(cn2); |
| 172 | + |
| 173 | + expect(manager._doConnectToServer).toHaveBeenCalledTimes(2); |
| 174 | + }); |
| 175 | + |
| 176 | + it('does not track pending connections for DHE servers', async () => { |
| 177 | + manager._serverMap.set(dheServer0.url, dheServer0); |
| 178 | + |
| 179 | + void manager.connectToServer(serverUrl); |
| 180 | + void manager.connectToServer(serverUrl); |
| 181 | + |
| 182 | + // DHE supports multiple connections, so concurrent calls each start one. |
| 183 | + expect(manager._doConnectToServer).toHaveBeenCalledTimes(2); |
| 184 | + expect(manager._pendingConnectionMap.has(serverUrl)).toBe(false); |
| 185 | + }); |
| 186 | +}); |
0 commit comments