|
| 1 | +/** |
| 2 | + * @fileoverview Unit tests for IPC object getter. |
| 3 | + */ |
| 4 | + |
| 5 | +import { describe, expect, it } from 'vitest' |
| 6 | + |
| 7 | +import { getIpc } from '@socketsecurity/lib/utils/get-ipc' |
| 8 | +import type { IpcObject } from '@socketsecurity/lib/utils/get-ipc' |
| 9 | + |
| 10 | +describe('utils/get-ipc', () => { |
| 11 | + describe('getIpc()', () => { |
| 12 | + it('should export getIpc function', () => { |
| 13 | + expect(typeof getIpc).toBe('function') |
| 14 | + }) |
| 15 | + |
| 16 | + it('should return an object', async () => { |
| 17 | + const ipc = await getIpc() |
| 18 | + expect(typeof ipc).toBe('object') |
| 19 | + expect(ipc).not.toBeNull() |
| 20 | + }) |
| 21 | + |
| 22 | + it('should return frozen object', async () => { |
| 23 | + const ipc = await getIpc() |
| 24 | + expect(Object.isFrozen(ipc)).toBe(true) |
| 25 | + }) |
| 26 | + |
| 27 | + it('should cache result on subsequent calls', async () => { |
| 28 | + const ipc1 = await getIpc() |
| 29 | + const ipc2 = await getIpc() |
| 30 | + expect(ipc1).toBe(ipc2) |
| 31 | + }) |
| 32 | + |
| 33 | + it('should return same reference every time', async () => { |
| 34 | + const results = await Promise.all([ |
| 35 | + getIpc(), |
| 36 | + getIpc(), |
| 37 | + getIpc(), |
| 38 | + ]) |
| 39 | + expect(results[0]).toBe(results[1]) |
| 40 | + expect(results[1]).toBe(results[2]) |
| 41 | + }) |
| 42 | + }) |
| 43 | + |
| 44 | + describe('IpcObject properties', () => { |
| 45 | + it('should only contain SOCKET_CLI_* properties if set', async () => { |
| 46 | + const ipc = await getIpc() |
| 47 | + const keys = Object.keys(ipc) |
| 48 | + |
| 49 | + keys.forEach(key => { |
| 50 | + expect(key).toMatch(/^SOCKET_CLI_/) |
| 51 | + }) |
| 52 | + }) |
| 53 | + |
| 54 | + it('should have correct property types', async () => { |
| 55 | + const ipc = await getIpc() |
| 56 | + |
| 57 | + // String properties |
| 58 | + if ('SOCKET_CLI_FIX' in ipc) { |
| 59 | + expect(typeof ipc.SOCKET_CLI_FIX).toBe('string') |
| 60 | + } |
| 61 | + if ('SOCKET_CLI_SHADOW_API_TOKEN' in ipc) { |
| 62 | + expect(typeof ipc.SOCKET_CLI_SHADOW_API_TOKEN).toBe('string') |
| 63 | + } |
| 64 | + if ('SOCKET_CLI_SHADOW_BIN' in ipc) { |
| 65 | + expect(typeof ipc.SOCKET_CLI_SHADOW_BIN).toBe('string') |
| 66 | + } |
| 67 | + |
| 68 | + // Boolean properties |
| 69 | + if ('SOCKET_CLI_OPTIMIZE' in ipc) { |
| 70 | + expect(typeof ipc.SOCKET_CLI_OPTIMIZE).toBe('boolean') |
| 71 | + } |
| 72 | + if ('SOCKET_CLI_SHADOW_ACCEPT_RISKS' in ipc) { |
| 73 | + expect(typeof ipc.SOCKET_CLI_SHADOW_ACCEPT_RISKS).toBe('boolean') |
| 74 | + } |
| 75 | + if ('SOCKET_CLI_SHADOW_PROGRESS' in ipc) { |
| 76 | + expect(typeof ipc.SOCKET_CLI_SHADOW_PROGRESS).toBe('boolean') |
| 77 | + } |
| 78 | + if ('SOCKET_CLI_SHADOW_SILENT' in ipc) { |
| 79 | + expect(typeof ipc.SOCKET_CLI_SHADOW_SILENT).toBe('boolean') |
| 80 | + } |
| 81 | + }) |
| 82 | + |
| 83 | + it('should not have undefined values', async () => { |
| 84 | + const ipc = await getIpc() |
| 85 | + const values = Object.values(ipc) |
| 86 | + |
| 87 | + values.forEach(value => { |
| 88 | + expect(value).not.toBeUndefined() |
| 89 | + }) |
| 90 | + }) |
| 91 | + }) |
| 92 | + |
| 93 | + describe('key accessor', () => { |
| 94 | + it('should support getting specific keys', async () => { |
| 95 | + const ipc = await getIpc() |
| 96 | + const keys = Object.keys(ipc) as Array<keyof IpcObject> |
| 97 | + |
| 98 | + for (const key of keys) { |
| 99 | + const value = await getIpc(key) |
| 100 | + expect(value).toBe(ipc[key]) |
| 101 | + } |
| 102 | + }) |
| 103 | + |
| 104 | + it('should return undefined for missing keys', async () => { |
| 105 | + const value = await getIpc('SOCKET_CLI_FIX' as keyof IpcObject) |
| 106 | + const ipc = await getIpc() |
| 107 | + |
| 108 | + if (!('SOCKET_CLI_FIX' in ipc)) { |
| 109 | + expect(value).toBeUndefined() |
| 110 | + } |
| 111 | + }) |
| 112 | + |
| 113 | + it('should work with all known keys', async () => { |
| 114 | + const keys: Array<keyof IpcObject> = [ |
| 115 | + 'SOCKET_CLI_FIX', |
| 116 | + 'SOCKET_CLI_OPTIMIZE', |
| 117 | + 'SOCKET_CLI_SHADOW_ACCEPT_RISKS', |
| 118 | + 'SOCKET_CLI_SHADOW_API_TOKEN', |
| 119 | + 'SOCKET_CLI_SHADOW_BIN', |
| 120 | + 'SOCKET_CLI_SHADOW_PROGRESS', |
| 121 | + 'SOCKET_CLI_SHADOW_SILENT', |
| 122 | + ] |
| 123 | + |
| 124 | + for (const key of keys) { |
| 125 | + const value = await getIpc(key) |
| 126 | + const ipc = await getIpc() |
| 127 | + expect(value).toBe(ipc[key]) |
| 128 | + } |
| 129 | + }) |
| 130 | + }) |
| 131 | + |
| 132 | + describe('type safety', () => { |
| 133 | + it('should support IpcObject type', () => { |
| 134 | + const obj: IpcObject = { |
| 135 | + SOCKET_CLI_FIX: 'test', |
| 136 | + SOCKET_CLI_OPTIMIZE: true, |
| 137 | + } |
| 138 | + expect(obj).toBeDefined() |
| 139 | + }) |
| 140 | + |
| 141 | + it('should support partial IpcObject', () => { |
| 142 | + const obj: Partial<IpcObject> = { |
| 143 | + SOCKET_CLI_FIX: 'test', |
| 144 | + } |
| 145 | + expect(obj).toBeDefined() |
| 146 | + }) |
| 147 | + |
| 148 | + it('should support empty IpcObject', () => { |
| 149 | + const obj: IpcObject = {} |
| 150 | + expect(obj).toBeDefined() |
| 151 | + }) |
| 152 | + |
| 153 | + it('should enforce correct types for properties', () => { |
| 154 | + // TypeScript compile-time check |
| 155 | + const obj: IpcObject = { |
| 156 | + SOCKET_CLI_FIX: 'string-value', |
| 157 | + SOCKET_CLI_OPTIMIZE: true, |
| 158 | + SOCKET_CLI_SHADOW_ACCEPT_RISKS: true, |
| 159 | + SOCKET_CLI_SHADOW_API_TOKEN: 'token', |
| 160 | + SOCKET_CLI_SHADOW_BIN: '/bin/path', |
| 161 | + SOCKET_CLI_SHADOW_PROGRESS: true, |
| 162 | + SOCKET_CLI_SHADOW_SILENT: false, |
| 163 | + } |
| 164 | + expect(obj).toBeDefined() |
| 165 | + }) |
| 166 | + }) |
| 167 | + |
| 168 | + describe('immutability', () => { |
| 169 | + it('should not allow modification', async () => { |
| 170 | + const ipc = await getIpc() |
| 171 | + |
| 172 | + expect(() => { |
| 173 | + // @ts-expect-error - testing immutability |
| 174 | + ipc.SOCKET_CLI_FIX = 'modified' |
| 175 | + }).toThrow() |
| 176 | + }) |
| 177 | + |
| 178 | + it('should not allow adding properties', async () => { |
| 179 | + const ipc = await getIpc() |
| 180 | + |
| 181 | + expect(() => { |
| 182 | + // @ts-expect-error - testing immutability |
| 183 | + ipc.NEW_PROPERTY = 'value' |
| 184 | + }).toThrow() |
| 185 | + }) |
| 186 | + |
| 187 | + it('should not allow deleting properties', async () => { |
| 188 | + const ipc = await getIpc() |
| 189 | + const keys = Object.keys(ipc) |
| 190 | + |
| 191 | + if (keys.length > 0) { |
| 192 | + expect(() => { |
| 193 | + // @ts-expect-error - testing immutability |
| 194 | + delete ipc[keys[0]] |
| 195 | + }).toThrow() |
| 196 | + } |
| 197 | + }) |
| 198 | + }) |
| 199 | + |
| 200 | + describe('concurrent access', () => { |
| 201 | + it('should handle multiple concurrent calls', async () => { |
| 202 | + const results = await Promise.all([ |
| 203 | + getIpc(), |
| 204 | + getIpc(), |
| 205 | + getIpc(), |
| 206 | + getIpc(), |
| 207 | + getIpc(), |
| 208 | + ]) |
| 209 | + |
| 210 | + // All should return the same reference |
| 211 | + results.forEach(result => { |
| 212 | + expect(result).toBe(results[0]) |
| 213 | + }) |
| 214 | + }) |
| 215 | + |
| 216 | + it('should handle concurrent key accesses', async () => { |
| 217 | + const ipc = await getIpc() |
| 218 | + const keys = Object.keys(ipc) as Array<keyof IpcObject> |
| 219 | + |
| 220 | + if (keys.length > 0) { |
| 221 | + const results = await Promise.all( |
| 222 | + keys.map(key => getIpc(key)) |
| 223 | + ) |
| 224 | + |
| 225 | + results.forEach((result, i) => { |
| 226 | + expect(result).toBe(ipc[keys[i]]) |
| 227 | + }) |
| 228 | + } |
| 229 | + }) |
| 230 | + }) |
| 231 | + |
| 232 | + describe('edge cases', () => { |
| 233 | + it('should handle rapid repeated calls', async () => { |
| 234 | + const calls = [] |
| 235 | + for (let i = 0; i < 100; i++) { |
| 236 | + calls.push(getIpc()) |
| 237 | + } |
| 238 | + |
| 239 | + const results = await Promise.all(calls) |
| 240 | + results.forEach(result => { |
| 241 | + expect(result).toBe(results[0]) |
| 242 | + }) |
| 243 | + }) |
| 244 | + |
| 245 | + it('should work with destructuring', async () => { |
| 246 | + const ipc = await getIpc() |
| 247 | + const { SOCKET_CLI_FIX, SOCKET_CLI_OPTIMIZE } = ipc |
| 248 | + |
| 249 | + expect(SOCKET_CLI_FIX).toBe(ipc.SOCKET_CLI_FIX) |
| 250 | + expect(SOCKET_CLI_OPTIMIZE).toBe(ipc.SOCKET_CLI_OPTIMIZE) |
| 251 | + }) |
| 252 | + |
| 253 | + it('should work with spread operator', async () => { |
| 254 | + const ipc = await getIpc() |
| 255 | + const copy = { ...ipc } |
| 256 | + |
| 257 | + expect(copy).toEqual(ipc) |
| 258 | + expect(copy).not.toBe(ipc) |
| 259 | + }) |
| 260 | + |
| 261 | + it('should work with Object.keys', async () => { |
| 262 | + const ipc = await getIpc() |
| 263 | + const keys = Object.keys(ipc) |
| 264 | + |
| 265 | + expect(Array.isArray(keys)).toBe(true) |
| 266 | + keys.forEach(key => { |
| 267 | + expect(key in ipc).toBe(true) |
| 268 | + }) |
| 269 | + }) |
| 270 | + |
| 271 | + it('should work with Object.values', async () => { |
| 272 | + const ipc = await getIpc() |
| 273 | + const values = Object.values(ipc) |
| 274 | + |
| 275 | + expect(Array.isArray(values)).toBe(true) |
| 276 | + expect(values.length).toBe(Object.keys(ipc).length) |
| 277 | + }) |
| 278 | + |
| 279 | + it('should work with Object.entries', async () => { |
| 280 | + const ipc = await getIpc() |
| 281 | + const entries = Object.entries(ipc) |
| 282 | + |
| 283 | + expect(Array.isArray(entries)).toBe(true) |
| 284 | + entries.forEach(([key, value]) => { |
| 285 | + expect(ipc[key as keyof IpcObject]).toBe(value) |
| 286 | + }) |
| 287 | + }) |
| 288 | + |
| 289 | + it('should work with for...in loop', async () => { |
| 290 | + const ipc = await getIpc() |
| 291 | + const keys: string[] = [] |
| 292 | + |
| 293 | + for (const key in ipc) { |
| 294 | + keys.push(key) |
| 295 | + } |
| 296 | + |
| 297 | + expect(keys).toEqual(Object.keys(ipc)) |
| 298 | + }) |
| 299 | + |
| 300 | + it('should work with hasOwnProperty', async () => { |
| 301 | + const ipc = await getIpc() |
| 302 | + const keys = Object.keys(ipc) |
| 303 | + |
| 304 | + keys.forEach(key => { |
| 305 | + expect(ipc.hasOwnProperty(key)).toBe(true) |
| 306 | + }) |
| 307 | + }) |
| 308 | + |
| 309 | + it('should not have prototype pollution', async () => { |
| 310 | + const ipc = await getIpc() |
| 311 | + |
| 312 | + expect('toString' in ipc).toBe(true) // inherited |
| 313 | + expect(ipc.hasOwnProperty('toString')).toBe(false) // not own property |
| 314 | + }) |
| 315 | + }) |
| 316 | +}) |
0 commit comments