librats 0.3.1 → 0.5.1

package/scripts/build-librats.js

@@ -1,194 +1,241 @@
-#!/usr/bin/env node
-
-const { execSync } = require('child_process');
-const fs = require('fs');
-const path = require('path');
-const os = require('os');
-
-// Determine platform
-const isWindows = process.platform === 'win32';
-const isMac = process.platform === 'darwin';
-const isLinux = process.platform === 'linux';
-
-// Paths
-const nodejsRoot = path.resolve(__dirname, '..');
-const projectRoot = path.resolve(__dirname, '..', '..');
-const buildDir = path.resolve(nodejsRoot, 'build-native');  // Build dir inside nodejs/
-const srcDir = path.resolve(projectRoot, 'src');
-const cmakeLists = path.resolve(projectRoot, 'CMakeLists.txt');
-
-console.log('Building librats native library...');
-console.log(`Platform: ${process.platform}`);
-console.log(`Project root: ${projectRoot}`);
-console.log(`Build directory: ${buildDir}`);
-
-// Check if CMake is installed
-try {
-    execSync('cmake --version', { stdio: 'pipe' });
-    console.log('✓ CMake found');
-} catch (error) {
-    console.error('\n❌ ERROR: CMake is not installed or not in PATH');
-    console.error('\nCMake is required to build librats.');
-    console.error('Please install CMake:');
-    if (isWindows) {
-        console.error('  - Download from: https://cmake.org/download/');
-        console.error('  - Or use: winget install Kitware.CMake');
-        console.error('  - Or use: choco install cmake');
-    } else if (isMac) {
-        console.error('  - Use Homebrew: brew install cmake');
-        console.error('  - Or download from: https://cmake.org/download/');
-    } else if (isLinux) {
-        console.error('  - Use: sudo apt install cmake');
-        console.error('  - Or: sudo yum install cmake');
-        console.error('  - Or download from: https://cmake.org/download/');
-    }
-    console.error('\nAfter installing CMake, run: npm install\n');
-    process.exit(1);
-}
-
-// Check if CMakeLists.txt exists
-if (!fs.existsSync(cmakeLists)) {
-    console.error('ERROR: CMakeLists.txt not found in project root.');
-    console.error('Make sure all source files are included in the npm package.');
-    process.exit(1);
-}
-
-// Check if src directory exists
-if (!fs.existsSync(srcDir)) {
-    console.error('ERROR: src directory not found.');
-    console.error('Make sure all source files are included in the npm package.');
-    process.exit(1);
-}
-
-// Create build directory if it doesn't exist
-if (!fs.existsSync(buildDir)) {
-    console.log(`Creating build directory: ${buildDir}`);
-    fs.mkdirSync(buildDir, { recursive: true });
-}
-
-// Helper function to execute commands
-function exec(command, options = {}) {
-    console.log(`> ${command}`);
-    try {
-        execSync(command, {
-            cwd: buildDir,
-            stdio: 'inherit',
-            ...options
-        });
-    } catch (error) {
-        console.error(`Command failed: ${command}`);
-        throw error;
-    }
-}
-
-try {
-    // Configure CMake with appropriate options
-    console.log('\nConfiguring CMake...');
-    
-    let cmakeArgs = [
-        '-DRATS_BUILD_TESTS=OFF',
-        '-DRATS_BUILD_EXAMPLES=OFF',
-        '-DRATS_STATIC_LIBRARY=ON',
-        '-DRATS_BINDINGS=ON',
-        '-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL'
-    ];
-
-    // Add platform-specific CMake arguments
-    if (isWindows) {
-        // Try to detect Visual Studio version
-        const vsVersions = ['2022', '2019', '2017'];
-        let generator = null;
-        
-        for (const version of vsVersions) {
-            try {
-                execSync(`where "C:\\Program Files\\Microsoft Visual Studio\\${version}"`, { stdio: 'ignore' });
-                generator = `Visual Studio ${version === '2022' ? '17' : version === '2019' ? '16' : '15'} ${version}`;
-                break;
-            } catch (e) {
-                // Try next version
-            }
-        }
-        
-        if (generator) {
-            cmakeArgs.push(`-G "${generator}"`);
-            cmakeArgs.push('-A x64');
-        }
-    } else if (isMac) {
-        // Use Unix Makefiles on macOS
-        cmakeArgs.push('-G "Unix Makefiles"');
-    } else if (isLinux) {
-        // Use Unix Makefiles on Linux
-        cmakeArgs.push('-G "Unix Makefiles"');
-    }
-
-    const cmakeConfigCmd = `cmake ${cmakeArgs.join(' ')} ../..`;
-    exec(cmakeConfigCmd);
-
-    // Build the library
-    console.log('\nBuilding librats library...');
-    
-    if (isWindows) {
-        // Build both Debug and Release configurations on Windows
-        exec('cmake --build . --config Debug --parallel');
-        exec('cmake --build . --config Release --parallel');
-        console.log('\nLibrats built successfully (Debug and Release)');
-    } else {
-        exec('cmake --build . -- -j4');
-        console.log('\nLibrats built successfully');
-    }
-
-    // Verify the library was built
-    const expectedLibPaths = isWindows 
-        ? [
-            path.join(buildDir, 'lib', 'Debug', 'rats.lib'),
-            path.join(buildDir, 'lib', 'Release', 'rats.lib')
-        ]
-        : [
-            path.join(buildDir, 'lib', 'librats.a')
-        ];
-    
-    console.log('\nBuild directory:', buildDir);
-
-    let foundLib = false;
-    for (const libPath of expectedLibPaths) {
-        if (fs.existsSync(libPath)) {
-            console.log(`✓ Found library: ${libPath}`);
-            foundLib = true;
-        }
-    }
-
-    if (!foundLib) {
-        console.warn('WARNING: Could not find built library files.');
-        console.warn('Expected paths:');
-        expectedLibPaths.forEach(p => console.warn(`  - ${p}`));
-        console.warn('The build may have failed. Check the output above.');
-        // Don't exit with error - let node-gyp try anyway
-    }
-
-    console.log('\n✓ Librats build completed successfully!\n');
-
-} catch (error) {
-    console.error('\n✗ Failed to build librats library');
-    console.error('Error:', error.message);
-    
-    // Provide helpful error messages
-    console.error('\nTroubleshooting:');
-    
-    if (isWindows) {
-        console.error('- Ensure Visual Studio Build Tools or Visual Studio is installed');
-        console.error('- Download from: https://visualstudio.microsoft.com/downloads/');
-        console.error('- Or run: npm install --global windows-build-tools');
-    } else if (isMac) {
-        console.error('- Ensure Xcode Command Line Tools are installed');
-        console.error('- Run: xcode-select --install');
-    } else if (isLinux) {
-        console.error('- Ensure build-essential is installed');
-        console.error('- Run: sudo apt install build-essential cmake');
-    }
-    
-    console.error('- Ensure CMake is installed and available in PATH');
-    console.error('- CMake download: https://cmake.org/download/');
-    
-    process.exit(1);
-}
-
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+// Determine platform
+const isWindows = process.platform === 'win32';
+const isMac = process.platform === 'darwin';
+const isLinux = process.platform === 'linux';
+
+// Paths
+const nodejsRoot = path.resolve(__dirname, '..');
+const buildDir = path.resolve(nodejsRoot, 'build-native');
+
+// Determine source location:
+// 1. When installed from npm: sources are in nodejs/native-src/
+// 2. When developing locally: sources are in project root (../../ from scripts)
+let projectRoot;
+let srcDir;
+let cmakeLists;
+
+const nativeSrcDir = path.resolve(nodejsRoot, 'native-src');
+const devProjectRoot = path.resolve(__dirname, '..', '..');
+
+if (fs.existsSync(path.join(nativeSrcDir, 'CMakeLists.txt'))) {
+    // npm install scenario: use native-src directory
+    projectRoot = nativeSrcDir;
+    srcDir = path.resolve(nativeSrcDir, 'src');
+    cmakeLists = path.resolve(nativeSrcDir, 'CMakeLists.txt');
+    console.log('Using bundled source files from native-src/');
+} else if (fs.existsSync(path.join(devProjectRoot, 'CMakeLists.txt'))) {
+    // Development scenario: use parent directory
+    projectRoot = devProjectRoot;
+    srcDir = path.resolve(devProjectRoot, 'src');
+    cmakeLists = path.resolve(devProjectRoot, 'CMakeLists.txt');
+    console.log('Using source files from project root (development mode)');
+} else {
+    console.error('ERROR: Cannot find librats source files.');
+    console.error('');
+    console.error('Checked locations:');
+    console.error(`  - ${nativeSrcDir} (npm install)`);
+    console.error(`  - ${devProjectRoot} (development)`);
+    console.error('');
+    console.error('If you installed from npm, the package may be corrupted.');
+    console.error('Try: npm cache clean --force && npm install librats');
+    console.error('');
+    console.error('If you are developing locally, make sure you are in the librats repository.');
+    process.exit(1);
+}
+
+console.log('Building librats native library...');
+console.log(`Platform: ${process.platform}`);
+console.log(`Source root: ${projectRoot}`);
+console.log(`Build directory: ${buildDir}`);
+
+// Check if CMake is installed
+try {
+    execSync('cmake --version', { stdio: 'pipe' });
+    console.log('✓ CMake found');
+} catch (error) {
+    console.error('\n❌ ERROR: CMake is not installed or not in PATH');
+    console.error('\nCMake is required to build librats.');
+    console.error('Please install CMake:');
+    if (isWindows) {
+        console.error('  - Download from: https://cmake.org/download/');
+        console.error('  - Or use: winget install Kitware.CMake');
+        console.error('  - Or use: choco install cmake');
+    } else if (isMac) {
+        console.error('  - Use Homebrew: brew install cmake');
+        console.error('  - Or download from: https://cmake.org/download/');
+    } else if (isLinux) {
+        console.error('  - Use: sudo apt install cmake');
+        console.error('  - Or: sudo yum install cmake');
+        console.error('  - Or download from: https://cmake.org/download/');
+    }
+    console.error('\nAfter installing CMake, run: npm install\n');
+    process.exit(1);
+}
+
+// Verify CMakeLists.txt exists
+if (!fs.existsSync(cmakeLists)) {
+    console.error('ERROR: CMakeLists.txt not found.');
+    console.error(`Expected at: ${cmakeLists}`);
+    process.exit(1);
+}
+
+// Verify src directory exists
+if (!fs.existsSync(srcDir)) {
+    console.error('ERROR: src directory not found.');
+    console.error(`Expected at: ${srcDir}`);
+    process.exit(1);
+}
+
+// Create build directory if it doesn't exist
+if (!fs.existsSync(buildDir)) {
+    console.log(`Creating build directory: ${buildDir}`);
+    fs.mkdirSync(buildDir, { recursive: true });
+} else {
+    // Clear CMake cache if it exists to avoid source directory mismatch errors
+    const cmakeCache = path.join(buildDir, 'CMakeCache.txt');
+    if (fs.existsSync(cmakeCache)) {
+        console.log('Clearing existing CMake cache...');
+        fs.unlinkSync(cmakeCache);
+        
+        // Also remove CMakeFiles directory for a clean reconfigure
+        const cmakeFiles = path.join(buildDir, 'CMakeFiles');
+        if (fs.existsSync(cmakeFiles)) {
+            fs.rmSync(cmakeFiles, { recursive: true, force: true });
+        }
+    }
+}
+
+// Helper function to execute commands
+function exec(command, options = {}) {
+    console.log(`> ${command}`);
+    try {
+        execSync(command, {
+            cwd: buildDir,
+            stdio: 'inherit',
+            ...options
+        });
+    } catch (error) {
+        console.error(`Command failed: ${command}`);
+        throw error;
+    }
+}
+
+try {
+    // Configure CMake with appropriate options
+    console.log('\nConfiguring CMake...');
+    
+    let cmakeArgs = [
+        '-DRATS_BUILD_TESTS=OFF',
+        '-DRATS_BUILD_EXAMPLES=OFF',
+        '-DRATS_STATIC_LIBRARY=ON',
+        '-DRATS_BINDINGS=ON',
+        '-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL'
+    ];
+
+    // Add platform-specific CMake arguments
+    if (isWindows) {
+        // Try to detect Visual Studio version
+        const vsVersions = ['2022', '2019', '2017'];
+        let generator = null;
+        
+        for (const version of vsVersions) {
+            try {
+                execSync(`where "C:\\Program Files\\Microsoft Visual Studio\\${version}"`, { stdio: 'ignore' });
+                generator = `Visual Studio ${version === '2022' ? '17' : version === '2019' ? '16' : '15'} ${version}`;
+                break;
+            } catch (e) {
+                // Try next version
+            }
+        }
+        
+        if (generator) {
+            cmakeArgs.push(`-G "${generator}"`);
+            cmakeArgs.push('-A x64');
+        }
+    } else if (isMac) {
+        // Use Unix Makefiles on macOS
+        cmakeArgs.push('-G "Unix Makefiles"');
+    } else if (isLinux) {
+        // Use Unix Makefiles on Linux
+        cmakeArgs.push('-G "Unix Makefiles"');
+    }
+
+    // Calculate the relative path from build directory to source root
+    const relativePath = path.relative(buildDir, projectRoot);
+    const cmakeConfigCmd = `cmake ${cmakeArgs.join(' ')} "${relativePath}"`;
+    exec(cmakeConfigCmd);
+
+    // Build the library
+    console.log('\nBuilding librats library...');
+    
+    if (isWindows) {
+        // Build both Debug and Release configurations on Windows
+        exec('cmake --build . --config Debug --parallel');
+        exec('cmake --build . --config Release --parallel');
+        console.log('\nLibrats built successfully (Debug and Release)');
+    } else {
+        exec('cmake --build . -- -j4');
+        console.log('\nLibrats built successfully');
+    }
+
+    // Verify the library was built
+    const expectedLibPaths = isWindows 
+        ? [
+            path.join(buildDir, 'lib', 'Debug', 'rats.lib'),
+            path.join(buildDir, 'lib', 'Release', 'rats.lib')
+        ]
+        : [
+            path.join(buildDir, 'lib', 'librats.a')
+        ];
+    
+    console.log('\nBuild directory:', buildDir);
+
+    let foundLib = false;
+    for (const libPath of expectedLibPaths) {
+        if (fs.existsSync(libPath)) {
+            console.log(`✓ Found library: ${libPath}`);
+            foundLib = true;
+        }
+    }
+
+    if (!foundLib) {
+        console.warn('WARNING: Could not find built library files.');
+        console.warn('Expected paths:');
+        expectedLibPaths.forEach(p => console.warn(`  - ${p}`));
+        console.warn('The build may have failed. Check the output above.');
+        // Don't exit with error - let node-gyp try anyway
+    }
+
+    console.log('\n✓ Librats build completed successfully!\n');
+
+} catch (error) {
+    console.error('\n✗ Failed to build librats library');
+    console.error('Error:', error.message);
+    
+    // Provide helpful error messages
+    console.error('\nTroubleshooting:');
+    
+    if (isWindows) {
+        console.error('- Ensure Visual Studio Build Tools or Visual Studio is installed');
+        console.error('- Download from: https://visualstudio.microsoft.com/downloads/');
+        console.error('- Or run: npm install --global windows-build-tools');
+    } else if (isMac) {
+        console.error('- Ensure Xcode Command Line Tools are installed');
+        console.error('- Run: xcode-select --install');
+    } else if (isLinux) {
+        console.error('- Ensure build-essential is installed');
+        console.error('- Run: sudo apt install build-essential cmake');
+    }
+    
+    console.error('- Ensure CMake is installed and available in PATH');
+    console.error('- CMake download: https://cmake.org/download/');
+    
+    process.exit(1);
+}

package/scripts/postinstall.js

@@ -1,52 +1,52 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const path = require('path');
-
-// Check if we're in a development install (node_modules doesn't contain librats)
-const isDev = !__dirname.includes('node_modules');
-
-if (isDev) {
-  console.log('\n✨ Development installation detected');
-  console.log('   Librats native addon has been built for local development\n');
-} else {
-  console.log('\n✅ Librats installed successfully!');
-  console.log('   Native addon is ready to use\n');
-}
-
-// Check if the addon was built successfully
-const possiblePaths = [
-  path.join(__dirname, '..', 'build', 'Release', 'librats.node'),
-  path.join(__dirname, '..', 'build', 'Debug', 'librats.node'),
-];
-
-let addonFound = false;
-for (const addonPath of possiblePaths) {
-  if (fs.existsSync(addonPath)) {
-    addonFound = true;
-    if (process.env.LIBRATS_DEBUG) {
-      console.log(`   Native addon: ${addonPath}`);
-    }
-    break;
-  }
-}
-
-if (!addonFound) {
-  console.warn('⚠️  Warning: Native addon not found');
-  console.warn('   The build may have failed. Try running:');
-  console.warn('   npm rebuild librats\n');
-}
-
-// Show quick start example
-if (!process.env.CI && !process.env.npm_config_global) {
-  console.log('Verify installation:');
-  console.log('  npm run verify\n');
-  console.log('Quick start:');
-  console.log('```javascript');
-  console.log("const { RatsClient } = require('librats');");
-  console.log('const client = new RatsClient(8080);');
-  console.log('client.start();');
-  console.log('```\n');
-  console.log('Documentation: https://github.com/librats/librats/tree/main/nodejs\n');
-}
-
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+// Check if we're in a development install (node_modules doesn't contain librats)
+const isDev = !__dirname.includes('node_modules');
+
+if (isDev) {
+  console.log('\n✨ Development installation detected');
+  console.log('   Librats native addon has been built for local development\n');
+} else {
+  console.log('\n✅ Librats installed successfully!');
+  console.log('   Native addon is ready to use\n');
+}
+
+// Check if the addon was built successfully
+const possiblePaths = [
+  path.join(__dirname, '..', 'build', 'Release', 'librats.node'),
+  path.join(__dirname, '..', 'build', 'Debug', 'librats.node'),
+];
+
+let addonFound = false;
+for (const addonPath of possiblePaths) {
+  if (fs.existsSync(addonPath)) {
+    addonFound = true;
+    if (process.env.LIBRATS_DEBUG) {
+      console.log(`   Native addon: ${addonPath}`);
+    }
+    break;
+  }
+}
+
+if (!addonFound) {
+  console.warn('⚠️  Warning: Native addon not found');
+  console.warn('   The build may have failed. Try running:');
+  console.warn('   npm rebuild librats\n');
+}
+
+// Show quick start example
+if (!process.env.CI && !process.env.npm_config_global) {
+  console.log('Verify installation:');
+  console.log('  npm run verify\n');
+  console.log('Quick start:');
+  console.log('```javascript');
+  console.log("const { RatsClient } = require('librats');");
+  console.log('const client = new RatsClient(8080);');
+  console.log('client.start();');
+  console.log('```\n');
+  console.log('Documentation: https://github.com/librats/librats/tree/main/nodejs\n');
+}
+