|
| 1 | +/** |
| 2 | + * Tests for RockEnv - TDD implementation |
| 3 | + * |
| 4 | + * These tests verify the fix for PR #492 reviewer comments: |
| 5 | + * 1. sandboxId should be initialized by calling the "make" API |
| 6 | + * 2. Should use HttpUtils instead of raw AxiosInstance for consistent camelCase/snake_case conversion |
| 7 | + */ |
| 8 | + |
| 9 | +import { RockEnv } from './rock_env.js'; |
| 10 | +import { HttpUtils } from '../utils/http.js'; |
| 11 | + |
| 12 | +// Mock HttpUtils |
| 13 | +jest.mock('../utils/http.js'); |
| 14 | +const mockedHttpUtils = HttpUtils as jest.Mocked<typeof HttpUtils>; |
| 15 | + |
| 16 | +describe('RockEnv', () => { |
| 17 | + const mockBaseUrl = 'http://test-rock-api.example.com'; |
| 18 | + |
| 19 | + beforeEach(() => { |
| 20 | + jest.clearAllMocks(); |
| 21 | + process.env.ROCK_BASE_URL = mockBaseUrl; |
| 22 | + }); |
| 23 | + |
| 24 | + afterEach(() => { |
| 25 | + delete process.env.ROCK_BASE_URL; |
| 26 | + }); |
| 27 | + |
| 28 | + describe('initializeEnvironment', () => { |
| 29 | + test('should call "make" API and set sandboxId from response', async () => { |
| 30 | + // Arrange |
| 31 | + const expectedSandboxId = 'test-sandbox-123'; |
| 32 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 33 | + status: 'Success', |
| 34 | + result: { sandboxId: expectedSandboxId }, |
| 35 | + headers: {}, |
| 36 | + }); |
| 37 | + |
| 38 | + // Act |
| 39 | + const env = await RockEnv.create({ envId: 'test-env' }); |
| 40 | + |
| 41 | + // Assert |
| 42 | + expect(mockedHttpUtils.post).toHaveBeenCalledWith( |
| 43 | + `${mockBaseUrl}/apis/v1/envs/gem/make`, |
| 44 | + { 'Content-Type': 'application/json' }, |
| 45 | + { envId: 'test-env' } |
| 46 | + ); |
| 47 | + expect(env.getSandboxId()).toBe(expectedSandboxId); |
| 48 | + }); |
| 49 | + |
| 50 | + test('should throw error when make API does not return sandboxId', async () => { |
| 51 | + // Arrange |
| 52 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 53 | + status: 'Success', |
| 54 | + result: {}, |
| 55 | + headers: {}, |
| 56 | + }); |
| 57 | + |
| 58 | + // Act & Assert |
| 59 | + await expect(RockEnv.create({ envId: 'test-env' })).rejects.toThrow( |
| 60 | + 'Failed to get environment instance ID' |
| 61 | + ); |
| 62 | + }); |
| 63 | + |
| 64 | + test('should throw error when make API fails', async () => { |
| 65 | + // Arrange |
| 66 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 67 | + status: 'Failed', |
| 68 | + error: 'Environment not found', |
| 69 | + headers: {}, |
| 70 | + }); |
| 71 | + |
| 72 | + // Act & Assert |
| 73 | + await expect(RockEnv.create({ envId: 'invalid-env' })).rejects.toThrow(); |
| 74 | + }); |
| 75 | + }); |
| 76 | + |
| 77 | + describe('step', () => { |
| 78 | + test('should use HttpUtils.post and send sandboxId', async () => { |
| 79 | + // Arrange |
| 80 | + const sandboxId = 'test-sandbox-456'; |
| 81 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 82 | + status: 'Success', |
| 83 | + result: { sandboxId }, |
| 84 | + headers: {}, |
| 85 | + }); |
| 86 | + |
| 87 | + const env = await RockEnv.create({ envId: 'test-env' }); |
| 88 | + |
| 89 | + // Mock step response |
| 90 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 91 | + status: 'Success', |
| 92 | + result: { |
| 93 | + observation: 'state-1', |
| 94 | + reward: 1.0, |
| 95 | + terminated: false, |
| 96 | + truncated: false, |
| 97 | + info: { steps: 1 }, |
| 98 | + }, |
| 99 | + headers: {}, |
| 100 | + }); |
| 101 | + |
| 102 | + // Act |
| 103 | + const result = await env.step('action-1'); |
| 104 | + |
| 105 | + // Assert - verify HttpUtils.post was called with correct params |
| 106 | + expect(mockedHttpUtils.post).toHaveBeenLastCalledWith( |
| 107 | + `${mockBaseUrl}/apis/v1/envs/gem/step`, |
| 108 | + { 'Content-Type': 'application/json' }, |
| 109 | + { sandboxId, action: 'action-1' } |
| 110 | + ); |
| 111 | + expect(result).toEqual(['state-1', 1.0, false, false, { steps: 1 }]); |
| 112 | + }); |
| 113 | + |
| 114 | + test('should throw error when environment is closed', async () => { |
| 115 | + // Arrange |
| 116 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 117 | + status: 'Success', |
| 118 | + result: { sandboxId: 'test-sandbox' }, |
| 119 | + headers: {}, |
| 120 | + }); |
| 121 | + |
| 122 | + const env = await RockEnv.create({ envId: 'test-env' }); |
| 123 | + await env.close(); |
| 124 | + |
| 125 | + // Act & Assert |
| 126 | + await expect(env.step('action')).rejects.toThrow('Environment is closed'); |
| 127 | + }); |
| 128 | + }); |
| 129 | + |
| 130 | + describe('reset', () => { |
| 131 | + test('should use HttpUtils.post and send sandboxId', async () => { |
| 132 | + // Arrange |
| 133 | + const sandboxId = 'test-sandbox-789'; |
| 134 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 135 | + status: 'Success', |
| 136 | + result: { sandboxId }, |
| 137 | + headers: {}, |
| 138 | + }); |
| 139 | + |
| 140 | + const env = await RockEnv.create({ envId: 'test-env' }); |
| 141 | + |
| 142 | + // Mock reset response |
| 143 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 144 | + status: 'Success', |
| 145 | + result: { |
| 146 | + observation: 'initial-state', |
| 147 | + info: { episode: 1 }, |
| 148 | + }, |
| 149 | + headers: {}, |
| 150 | + }); |
| 151 | + |
| 152 | + // Act |
| 153 | + const result = await env.reset(42); |
| 154 | + |
| 155 | + // Assert - verify HttpUtils.post was called with correct params |
| 156 | + expect(mockedHttpUtils.post).toHaveBeenLastCalledWith( |
| 157 | + `${mockBaseUrl}/apis/v1/envs/gem/reset`, |
| 158 | + { 'Content-Type': 'application/json' }, |
| 159 | + { sandboxId, seed: 42 } |
| 160 | + ); |
| 161 | + expect(result).toEqual(['initial-state', { episode: 1 }]); |
| 162 | + }); |
| 163 | + |
| 164 | + test('should work without seed parameter', async () => { |
| 165 | + // Arrange |
| 166 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 167 | + status: 'Success', |
| 168 | + result: { sandboxId: 'test-sandbox' }, |
| 169 | + headers: {}, |
| 170 | + }); |
| 171 | + |
| 172 | + const env = await RockEnv.create({ envId: 'test-env' }); |
| 173 | + |
| 174 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 175 | + status: 'Success', |
| 176 | + result: { |
| 177 | + observation: 'initial-state', |
| 178 | + info: {}, |
| 179 | + }, |
| 180 | + headers: {}, |
| 181 | + }); |
| 182 | + |
| 183 | + // Act |
| 184 | + await env.reset(); |
| 185 | + |
| 186 | + // Assert - seed should not be in params |
| 187 | + const calls = mockedHttpUtils.post.mock.calls; |
| 188 | + const lastCall = calls[calls.length - 1]; |
| 189 | + expect(lastCall?.[2]).toEqual({ sandboxId: 'test-sandbox' }); |
| 190 | + }); |
| 191 | + }); |
| 192 | + |
| 193 | + describe('close', () => { |
| 194 | + test('should use HttpUtils.post and send sandboxId', async () => { |
| 195 | + // Arrange |
| 196 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 197 | + status: 'Success', |
| 198 | + result: { sandboxId: 'test-sandbox' }, |
| 199 | + headers: {}, |
| 200 | + }); |
| 201 | + |
| 202 | + const env = await RockEnv.create({ envId: 'test-env' }); |
| 203 | + |
| 204 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 205 | + status: 'Success', |
| 206 | + result: {}, |
| 207 | + headers: {}, |
| 208 | + }); |
| 209 | + |
| 210 | + // Act |
| 211 | + await env.close(); |
| 212 | + |
| 213 | + // Assert |
| 214 | + expect(mockedHttpUtils.post).toHaveBeenLastCalledWith( |
| 215 | + `${mockBaseUrl}/apis/v1/envs/gem/close`, |
| 216 | + { 'Content-Type': 'application/json' }, |
| 217 | + { sandboxId: 'test-sandbox' } |
| 218 | + ); |
| 219 | + }); |
| 220 | + |
| 221 | + test('should be idempotent - calling close multiple times should not error', async () => { |
| 222 | + // Arrange |
| 223 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 224 | + status: 'Success', |
| 225 | + result: { sandboxId: 'test-sandbox' }, |
| 226 | + headers: {}, |
| 227 | + }); |
| 228 | + |
| 229 | + const env = await RockEnv.create({ envId: 'test-env' }); |
| 230 | + |
| 231 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 232 | + status: 'Success', |
| 233 | + result: {}, |
| 234 | + headers: {}, |
| 235 | + }); |
| 236 | + |
| 237 | + // Act |
| 238 | + await env.close(); |
| 239 | + await env.close(); // Second call should be a no-op |
| 240 | + |
| 241 | + // Assert - close API should only be called once |
| 242 | + const closeCalls = mockedHttpUtils.post.mock.calls.filter( |
| 243 | + (call) => typeof call[0] === 'string' && call[0].includes('/close') |
| 244 | + ); |
| 245 | + expect(closeCalls).toHaveLength(1); |
| 246 | + }); |
| 247 | + |
| 248 | + test('should not call close API when sandboxId is null', async () => { |
| 249 | + // Arrange - create env that failed to get sandboxId |
| 250 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 251 | + status: 'Success', |
| 252 | + result: {}, |
| 253 | + headers: {}, |
| 254 | + }); |
| 255 | + |
| 256 | + // Act - create will fail, but let's test close behavior |
| 257 | + try { |
| 258 | + await RockEnv.create({ envId: 'test-env' }); |
| 259 | + } catch { |
| 260 | + // Expected to throw |
| 261 | + } |
| 262 | + |
| 263 | + // Clear mock |
| 264 | + mockedHttpUtils.post.mockClear(); |
| 265 | + |
| 266 | + // This scenario tests the internal guard |
| 267 | + }); |
| 268 | + }); |
| 269 | + |
| 270 | + describe('camelCase/snake_case conversion', () => { |
| 271 | + test('should send envId (camelCase) as env_id (snake_case) to API', async () => { |
| 272 | + // Arrange |
| 273 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 274 | + status: 'Success', |
| 275 | + result: { sandboxId: 'test-sandbox' }, |
| 276 | + headers: {}, |
| 277 | + }); |
| 278 | + |
| 279 | + // Act |
| 280 | + await RockEnv.create({ envId: 'my-test-env' }); |
| 281 | + |
| 282 | + // Assert - HttpUtils should receive camelCase, it handles conversion internally |
| 283 | + expect(mockedHttpUtils.post).toHaveBeenCalledWith( |
| 284 | + expect.any(String), |
| 285 | + expect.any(Object), |
| 286 | + { envId: 'my-test-env' } // SDK uses camelCase |
| 287 | + ); |
| 288 | + }); |
| 289 | + |
| 290 | + test('should receive sandbox_id (snake_case) from API as sandboxId (camelCase)', async () => { |
| 291 | + // Arrange - API returns snake_case, HttpUtils converts to camelCase |
| 292 | + mockedHttpUtils.post.mockResolvedValueOnce({ |
| 293 | + status: 'Success', |
| 294 | + result: { sandboxId: 'converted-to-camelCase' }, |
| 295 | + headers: {}, |
| 296 | + }); |
| 297 | + |
| 298 | + // Act |
| 299 | + const env = await RockEnv.create({ envId: 'test-env' }); |
| 300 | + |
| 301 | + // Assert |
| 302 | + expect(env.getSandboxId()).toBe('converted-to-camelCase'); |
| 303 | + }); |
| 304 | + }); |
| 305 | +}); |
0 commit comments