|
| 1 | +/** |
| 2 | + * @fileoverview Tests for @socketbin/custom-node package structure and configuration. |
| 3 | + */ |
| 4 | + |
| 5 | +import { existsSync } from 'node:fs' |
| 6 | +import { promises as fs } from 'node:fs' |
| 7 | +import path from 'node:path' |
| 8 | +import { fileURLToPath } from 'node:url' |
| 9 | + |
| 10 | +import { describe, expect, it } from 'vitest' |
| 11 | + |
| 12 | +const __dirname = path.dirname(fileURLToPath(import.meta.url)) |
| 13 | +const packageDir = path.join(__dirname, '..') |
| 14 | +const scriptsDir = path.join(packageDir, 'scripts') |
| 15 | +const buildDir = path.join(packageDir, 'build') |
| 16 | + |
| 17 | +describe('@socketbin/custom-node package', () => { |
| 18 | + describe('package.json validation', () => { |
| 19 | + it('should have valid package.json metadata', async () => { |
| 20 | + const pkgJson = JSON.parse( |
| 21 | + await fs.readFile(path.join(packageDir, 'package.json'), 'utf-8'), |
| 22 | + ) |
| 23 | + |
| 24 | + expect(pkgJson.name).toBe('@socketbin/custom-node') |
| 25 | + expect(pkgJson.version).toMatch(/^\d+\.\d+\.\d+$/) |
| 26 | + expect(pkgJson.license).toBe('MIT') |
| 27 | + expect(pkgJson.description).toContain('Custom Node.js') |
| 28 | + expect(pkgJson.private).toBe(true) |
| 29 | + }) |
| 30 | + |
| 31 | + it('should have build scripts', async () => { |
| 32 | + const pkgJson = JSON.parse( |
| 33 | + await fs.readFile(path.join(packageDir, 'package.json'), 'utf-8'), |
| 34 | + ) |
| 35 | + |
| 36 | + expect(pkgJson.scripts).toBeDefined() |
| 37 | + expect(pkgJson.scripts.build).toBe('node scripts/build.mjs') |
| 38 | + expect(pkgJson.scripts['build:all']).toBe('node scripts/build.mjs --all-platforms') |
| 39 | + }) |
| 40 | + }) |
| 41 | + |
| 42 | + describe('build scripts exist', () => { |
| 43 | + it('should have build.mjs script', () => { |
| 44 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 45 | + expect(existsSync(buildPath)).toBe(true) |
| 46 | + }) |
| 47 | + |
| 48 | + it('build.mjs should be valid JavaScript', async () => { |
| 49 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 50 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 51 | + |
| 52 | + // Should not throw syntax errors. |
| 53 | + expect(content).toBeTruthy() |
| 54 | + expect(content).toContain('import') |
| 55 | + expect(content).toContain('Node.js') |
| 56 | + }) |
| 57 | + }) |
| 58 | + |
| 59 | + describe('build script documentation', () => { |
| 60 | + it('build.mjs should document binary size optimization', async () => { |
| 61 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 62 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 63 | + |
| 64 | + expect(content).toContain('Binary Size Optimization') |
| 65 | + expect(content).toContain('TARGET ACHIEVED') |
| 66 | + expect(content).toContain('MB') |
| 67 | + }) |
| 68 | + |
| 69 | + it('build.mjs should document configuration flags', async () => { |
| 70 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 71 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 72 | + |
| 73 | + expect(content).toContain('--with-intl=none') |
| 74 | + expect(content).toContain('--v8-lite-mode') |
| 75 | + }) |
| 76 | + |
| 77 | + it('build.mjs should document compression approach', async () => { |
| 78 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 79 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 80 | + |
| 81 | + expect(content).toContain('Compression Approach') |
| 82 | + expect(content).toContain('Brotli') |
| 83 | + }) |
| 84 | + |
| 85 | + it('build.mjs should document performance impact', async () => { |
| 86 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 87 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 88 | + |
| 89 | + expect(content).toContain('Performance Impact') |
| 90 | + expect(content).toContain('Startup overhead') |
| 91 | + expect(content).toContain('Runtime performance') |
| 92 | + }) |
| 93 | + |
| 94 | + it('build.mjs should document usage options', async () => { |
| 95 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 96 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 97 | + |
| 98 | + expect(content).toContain('--clean') |
| 99 | + expect(content).toContain('--verify') |
| 100 | + expect(content).toContain('--test') |
| 101 | + }) |
| 102 | + }) |
| 103 | + |
| 104 | + describe('build directory structure', () => { |
| 105 | + it('should have build directory', () => { |
| 106 | + expect(existsSync(buildDir)).toBe(true) |
| 107 | + }) |
| 108 | + |
| 109 | + it('should have wasm-bundle subdirectory', () => { |
| 110 | + const wasmBundleDir = path.join(buildDir, 'wasm-bundle') |
| 111 | + expect(existsSync(wasmBundleDir)).toBe(true) |
| 112 | + }) |
| 113 | + |
| 114 | + it('wasm-bundle should have Cargo.toml', () => { |
| 115 | + const cargoPath = path.join(buildDir, 'wasm-bundle', 'Cargo.toml') |
| 116 | + expect(existsSync(cargoPath)).toBe(true) |
| 117 | + }) |
| 118 | + }) |
| 119 | + |
| 120 | + describe('README documentation', () => { |
| 121 | + it('should have README.md', () => { |
| 122 | + const readmePath = path.join(packageDir, 'README.md') |
| 123 | + expect(existsSync(readmePath)).toBe(true) |
| 124 | + }) |
| 125 | + |
| 126 | + it('README should document what it does', async () => { |
| 127 | + const readmePath = path.join(packageDir, 'README.md') |
| 128 | + const readme = await fs.readFile(readmePath, 'utf-8') |
| 129 | + |
| 130 | + expect(readme).toContain('Custom Node.js') |
| 131 | + expect(readme).toContain('Socket security patches') |
| 132 | + expect(readme).toContain('v24.10.0') |
| 133 | + }) |
| 134 | + |
| 135 | + it('README should document build process', async () => { |
| 136 | + const readmePath = path.join(packageDir, 'README.md') |
| 137 | + const readme = await fs.readFile(readmePath, 'utf-8') |
| 138 | + |
| 139 | + expect(readme).toContain('pnpm run build') |
| 140 | + expect(readme).toContain('Downloads') |
| 141 | + expect(readme).toContain('patches') |
| 142 | + expect(readme).toContain('compiles') |
| 143 | + }) |
| 144 | + |
| 145 | + it('README should document output location', async () => { |
| 146 | + const readmePath = path.join(packageDir, 'README.md') |
| 147 | + const readme = await fs.readFile(readmePath, 'utf-8') |
| 148 | + |
| 149 | + expect(readme).toContain('build/out') |
| 150 | + }) |
| 151 | + }) |
| 152 | + |
| 153 | + describe('package is private', () => { |
| 154 | + it('should be marked as private', async () => { |
| 155 | + const pkgJson = JSON.parse( |
| 156 | + await fs.readFile(path.join(packageDir, 'package.json'), 'utf-8'), |
| 157 | + ) |
| 158 | + |
| 159 | + expect(pkgJson.private).toBe(true) |
| 160 | + }) |
| 161 | + |
| 162 | + it('should not have publishConfig for npm', async () => { |
| 163 | + const pkgJson = JSON.parse( |
| 164 | + await fs.readFile(path.join(packageDir, 'package.json'), 'utf-8'), |
| 165 | + ) |
| 166 | + |
| 167 | + // Private package should not configure npm publishing. |
| 168 | + expect(pkgJson.publishConfig).toBeUndefined() |
| 169 | + }) |
| 170 | + }) |
| 171 | + |
| 172 | + describe('build script structure', () => { |
| 173 | + it('build.mjs should import required dependencies', async () => { |
| 174 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 175 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 176 | + |
| 177 | + // Check for key imports. |
| 178 | + expect(content).toContain("from 'node:fs'") |
| 179 | + }) |
| 180 | + |
| 181 | + it('build.mjs should reference Node.js version', async () => { |
| 182 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 183 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 184 | + |
| 185 | + expect(content).toContain('v24.10.0') |
| 186 | + }) |
| 187 | + |
| 188 | + it('build.mjs should reference Socket patches', async () => { |
| 189 | + const buildPath = path.join(scriptsDir, 'build.mjs') |
| 190 | + const content = await fs.readFile(buildPath, 'utf-8') |
| 191 | + |
| 192 | + expect(content).toContain('Socket') |
| 193 | + expect(content).toContain('patch') |
| 194 | + }) |
| 195 | + }) |
| 196 | + |
| 197 | + // Note: Actual build execution tests are skipped because: |
| 198 | + // - Builds take 5-10 minutes |
| 199 | + // - Require compilation toolchain (gcc, make, python) |
| 200 | + // - Require ~1GB disk space for source |
| 201 | + // - Platform-specific build process |
| 202 | + // - Best tested manually or in dedicated CI jobs |
| 203 | + describe.skip('build execution (manual/CI only)', () => { |
| 204 | + it('should build custom Node.js binary', async () => { |
| 205 | + // This test is skipped by default. |
| 206 | + // To run: FULL_BUILD_TEST=1 pnpm test |
| 207 | + }) |
| 208 | + |
| 209 | + it('should apply Socket patches', async () => { |
| 210 | + // This test is skipped by default. |
| 211 | + // To run: FULL_BUILD_TEST=1 pnpm test |
| 212 | + }) |
| 213 | + |
| 214 | + it('should produce binary under 30MB', async () => { |
| 215 | + // This test is skipped by default. |
| 216 | + // To run: FULL_BUILD_TEST=1 pnpm test |
| 217 | + }) |
| 218 | + }) |
| 219 | +}) |
0 commit comments