|
| 1 | +import { spawnSync } from 'child_process'; |
| 2 | +import * as fs from 'fs'; |
| 3 | +import * as os from 'os'; |
| 4 | +import * as path from 'path'; |
| 5 | + |
| 6 | +const SCRIPTS_DIR = path.resolve(__dirname, '../../scripts'); |
| 7 | +const EXPO_UPLOAD_SCRIPT = path.join(SCRIPTS_DIR, 'expo-upload-sourcemaps.js'); |
| 8 | + |
| 9 | +describe('expo-upload-sourcemaps.js', () => { |
| 10 | + let tempDir: string; |
| 11 | + let outputDir: string; |
| 12 | + let mockSentryCliScript: string; |
| 13 | + |
| 14 | + beforeEach(() => { |
| 15 | + // Create temporary directories for test artifacts |
| 16 | + tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'expo-upload-test-')); |
| 17 | + outputDir = path.join(tempDir, 'dist'); |
| 18 | + fs.mkdirSync(outputDir, { recursive: true }); |
| 19 | + |
| 20 | + // Create a mock sentry-cli script |
| 21 | + mockSentryCliScript = path.join(tempDir, 'mock-sentry-cli'); |
| 22 | + const mockCliContent = `#!/usr/bin/env node |
| 23 | +const args = process.argv.slice(2); |
| 24 | +const output = process.env.MOCK_CLI_OUTPUT || 'Mock upload successful'; |
| 25 | +
|
| 26 | +// Echo the arguments to verify they're passed correctly |
| 27 | +console.log('Arguments received:', JSON.stringify(args)); |
| 28 | +console.log(output); |
| 29 | +
|
| 30 | +const exitCode = parseInt(process.env.MOCK_CLI_EXIT_CODE || '0'); |
| 31 | +process.exit(exitCode); |
| 32 | +`; |
| 33 | + fs.writeFileSync(mockSentryCliScript, mockCliContent); |
| 34 | + fs.chmodSync(mockSentryCliScript, '755'); |
| 35 | + }); |
| 36 | + |
| 37 | + afterEach(() => { |
| 38 | + // Clean up temp directory |
| 39 | + if (tempDir && fs.existsSync(tempDir)) { |
| 40 | + fs.rmSync(tempDir, { recursive: true, force: true }); |
| 41 | + } |
| 42 | + }); |
| 43 | + |
| 44 | + const createAssets = (filenames: string[]) => { |
| 45 | + filenames.forEach(filename => { |
| 46 | + const filePath = path.join(outputDir, filename); |
| 47 | + if (filename.endsWith('.map')) { |
| 48 | + // Create a valid sourcemap with debug_id |
| 49 | + fs.writeFileSync( |
| 50 | + filePath, |
| 51 | + JSON.stringify({ |
| 52 | + version: 3, |
| 53 | + sources: ['index.js'], |
| 54 | + names: [], |
| 55 | + mappings: 'AAAA', |
| 56 | + debugId: 'test-debug-id-123', |
| 57 | + }), |
| 58 | + ); |
| 59 | + } else { |
| 60 | + // Create a simple JS file |
| 61 | + fs.writeFileSync(filePath, '// Mock bundle file'); |
| 62 | + } |
| 63 | + }); |
| 64 | + }; |
| 65 | + |
| 66 | + const runScript = (env: Record<string, string> = {}): { stdout: string; stderr: string; exitCode: number } => { |
| 67 | + const defaultEnv = { |
| 68 | + SENTRY_ORG: 'test-org', |
| 69 | + SENTRY_PROJECT: 'test-project', |
| 70 | + SENTRY_URL: 'https://sentry.io/', |
| 71 | + SENTRY_AUTH_TOKEN: 'test-token', |
| 72 | + SENTRY_CLI_EXECUTABLE: mockSentryCliScript, |
| 73 | + // Skip expo config loading |
| 74 | + EXPO_PUBLIC_SKIP_CONFIG: 'true', |
| 75 | + }; |
| 76 | + |
| 77 | + try { |
| 78 | + const result = spawnSync(process.execPath, [EXPO_UPLOAD_SCRIPT, outputDir], { |
| 79 | + env: { ...process.env, ...defaultEnv, ...env }, |
| 80 | + encoding: 'utf8', |
| 81 | + }); |
| 82 | + |
| 83 | + return { |
| 84 | + stdout: result.stdout || '', |
| 85 | + stderr: result.stderr || '', |
| 86 | + exitCode: result.status || 0, |
| 87 | + }; |
| 88 | + } catch (error: any) { |
| 89 | + return { |
| 90 | + stdout: error.stdout?.toString() || '', |
| 91 | + stderr: error.stderr?.toString() || '', |
| 92 | + exitCode: error.status || 1, |
| 93 | + }; |
| 94 | + } |
| 95 | + }; |
| 96 | + |
| 97 | + describe('basic functionality', () => { |
| 98 | + it('successfully uploads normal bundles and sourcemaps', () => { |
| 99 | + createAssets(['bundle.js', 'bundle.js.map']); |
| 100 | + |
| 101 | + const result = runScript({ |
| 102 | + MOCK_CLI_EXIT_CODE: '0', |
| 103 | + MOCK_CLI_OUTPUT: 'Upload successful', |
| 104 | + }); |
| 105 | + |
| 106 | + expect(result.exitCode).toBe(0); |
| 107 | + expect(result.stdout).toContain('Upload successful'); |
| 108 | + expect(result.stdout).toContain('Uploaded bundles and sourcemaps to Sentry successfully'); |
| 109 | + }); |
| 110 | + |
| 111 | + it('handles multiple bundles', () => { |
| 112 | + createAssets(['bundle1.js', 'bundle1.js.map', 'bundle2.js', 'bundle2.js.map']); |
| 113 | + |
| 114 | + const result = runScript({ |
| 115 | + MOCK_CLI_EXIT_CODE: '0', |
| 116 | + }); |
| 117 | + |
| 118 | + expect(result.exitCode).toBe(0); |
| 119 | + expect(result.stdout).toContain('Uploaded bundles and sourcemaps to Sentry successfully'); |
| 120 | + }); |
| 121 | + |
| 122 | + it('skips bundles without sourcemaps', () => { |
| 123 | + createAssets(['bundle.js']); // No .map file |
| 124 | + |
| 125 | + const result = runScript({ |
| 126 | + MOCK_CLI_EXIT_CODE: '0', |
| 127 | + }); |
| 128 | + |
| 129 | + expect(result.exitCode).toBe(0); |
| 130 | + expect(result.stdout).toContain('Sourcemap for'); |
| 131 | + expect(result.stdout).toContain('not found, skipping'); |
| 132 | + }); |
| 133 | + |
| 134 | + it('exits with error when sentry-cli fails', () => { |
| 135 | + createAssets(['bundle.js', 'bundle.js.map']); |
| 136 | + |
| 137 | + const result = runScript({ |
| 138 | + MOCK_CLI_EXIT_CODE: '1', |
| 139 | + MOCK_CLI_OUTPUT: 'Upload failed: Network error', |
| 140 | + }); |
| 141 | + |
| 142 | + expect(result.exitCode).toBe(1); |
| 143 | + expect(result.stdout).toContain('Upload failed: Network error'); |
| 144 | + }); |
| 145 | + }); |
| 146 | + |
| 147 | + describe('security: command injection prevention', () => { |
| 148 | + it('safely handles filenames with spaces (simulating special characters)', () => { |
| 149 | + // Use spaces to simulate special character handling |
| 150 | + // (semicolons, pipes can't be created on most filesystems) |
| 151 | + const fileWithSpaces = 'bundle with spaces.js'; |
| 152 | + const mapWithSpaces = 'bundle with spaces.js.map'; |
| 153 | + |
| 154 | + createAssets([fileWithSpaces, mapWithSpaces]); |
| 155 | + |
| 156 | + const result = runScript({ |
| 157 | + MOCK_CLI_EXIT_CODE: '0', |
| 158 | + }); |
| 159 | + |
| 160 | + // Should complete successfully with proper argument passing |
| 161 | + expect(result.exitCode).toBe(0); |
| 162 | + expect(result.stdout).toContain('Arguments received:'); |
| 163 | + const argsMatch = result.stdout.match(/Arguments received: (.+)/); |
| 164 | + if (argsMatch) { |
| 165 | + const args = JSON.parse(argsMatch[1]); |
| 166 | + // Verify filename with spaces is passed as single argument |
| 167 | + const fileArg = args.find((arg: string) => arg.includes('bundle with spaces')); |
| 168 | + expect(fileArg).toBeDefined(); |
| 169 | + expect(fileArg).toContain('bundle with spaces.js'); |
| 170 | + } |
| 171 | + }); |
| 172 | + |
| 173 | + it('safely handles filenames with shell metacharacters via spawnSync', () => { |
| 174 | + // spawnSync doesn't use a shell, so no special character escaping is needed |
| 175 | + // Test with parentheses which are valid in filenames but special to shell |
| 176 | + const fileWithParens = 'bundle(test).js'; |
| 177 | + const mapWithParens = 'bundle(test).js.map'; |
| 178 | + |
| 179 | + createAssets([fileWithParens, mapWithParens]); |
| 180 | + |
| 181 | + const result = runScript({ |
| 182 | + MOCK_CLI_EXIT_CODE: '0', |
| 183 | + }); |
| 184 | + |
| 185 | + expect(result.exitCode).toBe(0); |
| 186 | + expect(result.stdout).toContain('Arguments received:'); |
| 187 | + // Verify parentheses are preserved |
| 188 | + const argsMatch = result.stdout.match(/Arguments received: (.+)/); |
| 189 | + if (argsMatch) { |
| 190 | + const args = JSON.parse(argsMatch[1]); |
| 191 | + const fileArg = args.find((arg: string) => arg.includes('(test)')); |
| 192 | + expect(fileArg).toBeDefined(); |
| 193 | + } |
| 194 | + }); |
| 195 | + |
| 196 | + it('demonstrates shell safety: no command interpretation possible', () => { |
| 197 | + // This test verifies that spawnSync passes arguments directly |
| 198 | + // without shell interpretation, making command injection impossible |
| 199 | + const normalFile = 'bundle-safe.js'; |
| 200 | + const normalMap = 'bundle-safe.js.map'; |
| 201 | + |
| 202 | + createAssets([normalFile, normalMap]); |
| 203 | + |
| 204 | + const result = runScript({ |
| 205 | + MOCK_CLI_EXIT_CODE: '0', |
| 206 | + }); |
| 207 | + |
| 208 | + expect(result.exitCode).toBe(0); |
| 209 | + // Verify arguments are passed as an array |
| 210 | + const argsMatch = result.stdout.match(/Arguments received: (.+)/); |
| 211 | + if (argsMatch) { |
| 212 | + const args = JSON.parse(argsMatch[1]); |
| 213 | + // First arg should be the subcommand |
| 214 | + expect(args[0]).toBe('sourcemaps'); |
| 215 | + expect(args[1]).toBe('upload'); |
| 216 | + // Remaining args should be file paths |
| 217 | + expect(args.length).toBeGreaterThanOrEqual(2); |
| 218 | + } |
| 219 | + }); |
| 220 | + }); |
| 221 | + |
| 222 | + describe('Hermes support', () => { |
| 223 | + it('passes --debug-id-reference flag for Hermes bundles', () => { |
| 224 | + // For Hermes, we need the .hbc and .hbc.map files |
| 225 | + createAssets(['bundle.hbc', 'bundle.hbc.map']); |
| 226 | + |
| 227 | + const result = runScript({ |
| 228 | + MOCK_CLI_EXIT_CODE: '0', |
| 229 | + }); |
| 230 | + |
| 231 | + expect(result.exitCode).toBe(0); |
| 232 | + // Check that the flag is in the arguments |
| 233 | + const argsMatch = result.stdout.match(/Arguments received: (.+)/); |
| 234 | + if (argsMatch) { |
| 235 | + const args = JSON.parse(argsMatch[1]); |
| 236 | + expect(args).toContain('--debug-id-reference'); |
| 237 | + } |
| 238 | + }); |
| 239 | + |
| 240 | + it('does not pass --debug-id-reference flag for non-Hermes bundles', () => { |
| 241 | + createAssets(['bundle.js', 'bundle.js.map']); |
| 242 | + |
| 243 | + const result = runScript({ |
| 244 | + MOCK_CLI_EXIT_CODE: '0', |
| 245 | + }); |
| 246 | + |
| 247 | + expect(result.exitCode).toBe(0); |
| 248 | + const argsMatch = result.stdout.match(/Arguments received: (.+)/); |
| 249 | + if (argsMatch) { |
| 250 | + const args = JSON.parse(argsMatch[1]); |
| 251 | + expect(args).not.toContain('--debug-id-reference'); |
| 252 | + } |
| 253 | + }); |
| 254 | + }); |
| 255 | + |
| 256 | + describe('environment variables', () => { |
| 257 | + it('requires SENTRY_AUTH_TOKEN', () => { |
| 258 | + createAssets(['bundle.js', 'bundle.js.map']); |
| 259 | + |
| 260 | + const result = spawnSync(process.execPath, [EXPO_UPLOAD_SCRIPT, outputDir], { |
| 261 | + env: { |
| 262 | + ...process.env, |
| 263 | + SENTRY_ORG: 'test-org', |
| 264 | + SENTRY_PROJECT: 'test-project', |
| 265 | + SENTRY_URL: 'https://sentry.io/', |
| 266 | + SENTRY_CLI_EXECUTABLE: mockSentryCliScript, |
| 267 | + // Explicitly unset SENTRY_AUTH_TOKEN |
| 268 | + SENTRY_AUTH_TOKEN: undefined, |
| 269 | + }, |
| 270 | + encoding: 'utf8', |
| 271 | + }); |
| 272 | + |
| 273 | + expect(result.status).toBe(1); |
| 274 | + expect(result.stdout || result.stderr).toContain('SENTRY_AUTH_TOKEN environment variable must be set'); |
| 275 | + }); |
| 276 | + |
| 277 | + it('requires output directory argument', () => { |
| 278 | + const result = spawnSync(process.execPath, [EXPO_UPLOAD_SCRIPT], { |
| 279 | + env: { |
| 280 | + ...process.env, |
| 281 | + SENTRY_ORG: 'test-org', |
| 282 | + SENTRY_PROJECT: 'test-project', |
| 283 | + SENTRY_URL: 'https://sentry.io/', |
| 284 | + SENTRY_AUTH_TOKEN: 'test-token', |
| 285 | + SENTRY_CLI_EXECUTABLE: mockSentryCliScript, |
| 286 | + }, |
| 287 | + encoding: 'utf8', |
| 288 | + timeout: 5000, // Add timeout in case expo config hangs |
| 289 | + }); |
| 290 | + |
| 291 | + expect(result.status).toBe(1); |
| 292 | + const output = result.stdout + result.stderr; |
| 293 | + expect(output).toContain('Provide the directory with your bundles and sourcemaps'); |
| 294 | + }); |
| 295 | + }); |
| 296 | + |
| 297 | + describe('sourcemap processing', () => { |
| 298 | + it('converts debugId to debug_id in sourcemaps', () => { |
| 299 | + createAssets(['bundle.js', 'bundle.js.map']); |
| 300 | + |
| 301 | + runScript({ |
| 302 | + MOCK_CLI_EXIT_CODE: '0', |
| 303 | + }); |
| 304 | + |
| 305 | + // Read the sourcemap file to verify it was updated |
| 306 | + const sourceMapPath = path.join(outputDir, 'bundle.js.map'); |
| 307 | + const sourceMapContent = JSON.parse(fs.readFileSync(sourceMapPath, 'utf8')); |
| 308 | + |
| 309 | + expect(sourceMapContent.debug_id).toBe('test-debug-id-123'); |
| 310 | + expect(sourceMapContent.debugId).toBe('test-debug-id-123'); |
| 311 | + }); |
| 312 | + }); |
| 313 | +}); |
0 commit comments