fix: minor fixes to the cursor extension integraiton and installation

pmannion2 · pmannion2 · commit 2d67413d6841 · 2025-03-22T21:05:47.000-06:00
diff --git a/CURSOR_README.md b/CURSOR_README.md
@@ -11,13 +11,18 @@ This extension integrates the Ignition RAG (Retrieval-Augmented Generation) syst
 
 ## Installation
 
-### Option 1: Using the installation script
+### Option 1: Using the installation script (Recommended)
 
 1. Run the installation script:
    ```bash
    ./install_cursor_extension.sh
    ```
 
+   The script will:
+   - Create a virtual environment for Python dependencies
+   - Install required packages in the isolated environment
+   - Configure the extension to use the virtual environment
+
 2. Restart Cursor to enable the extension
 
 ### Option 2: Manual installation
@@ -27,18 +32,60 @@ This extension integrates the Ignition RAG (Retrieval-Augmented Generation) syst
    mkdir -p ~/.cursor/extensions/ignition-rag
    ```
 
-2. Copy the extension files:
+2. Create a virtual environment for Python dependencies:
+   ```bash
+   python3 -m venv ~/.cursor/extensions/ignition-rag/venv
+   ```
+
+3. Install required Python packages:
+   ```bash
+   ~/.cursor/extensions/ignition-rag/venv/bin/pip install requests python-dotenv
+   ```
+
+4. Copy the extension files:
+   ```bash
+   cp cursor_extension.js cursor_client.py cursor.config.json cursor_integration.js cursor_connector.js ~/.cursor/extensions/ignition-rag/
+   ```
+
+5. Create a shell script wrapper for the Python client:
    ```bash
-   cp cursor_extension.js cursor_client.py cursor.config.json ~/.cursor/extensions/ignition-rag/
+   echo '#!/bin/bash
+   ~/.cursor/extensions/ignition-rag/venv/bin/python3 ~/.cursor/extensions/ignition-rag/cursor_client.py "$@"' > ~/.cursor/extensions/ignition-rag/run_client.sh
+   chmod +x ~/.cursor/extensions/ignition-rag/run_client.sh
    ```
 
-3. Create a .env file in the extension directory:
+6. Create a .env file in the extension directory:
    ```
    RAG_API_URL=http://localhost:8001
-   PYTHON_PATH=python3
+   PYTHON_PATH=~/.cursor/extensions/ignition-rag/venv/bin/python3
+   ```
+
+7. Restart Cursor to enable the extension
+
+## Troubleshooting Installation
+
+### External Environment Errors
+
+If you encounter an error about "externally-managed-environment" during installation, this is because your system Python is protected from modifications. The installation script will handle this by creating a virtual environment, but if you encounter issues:
+
+1. Check that the Python venv module is installed:
+   ```bash
+   # On macOS with Homebrew
+   brew install python-venv
+   
+   # On Ubuntu/Debian
+   sudo apt-get install python3-venv
    ```
 
-4. Restart Cursor to enable the extension
+2. If you still have issues, manually install the dependencies:
+   ```bash
+   pip3 install --user requests python-dotenv
+   ```
+
+3. Edit the `.env` file to point to your system Python:
+   ```
+   PYTHON_PATH=python3
+   ```
 
 ## Usage
 
@@ -60,7 +107,7 @@ You can configure the extension by editing the `.env` file in the extension dire
 ```
 # Ignition RAG Extension Configuration
 RAG_API_URL=http://localhost:8001  # URL of your RAG API
-PYTHON_PATH=python3                # Path to Python interpreter
+PYTHON_PATH=/path/to/python        # Path to Python interpreter (usually automatic)
 ```
 
 ## Requirements
@@ -77,6 +124,7 @@ If the extension is not working as expected:
 2. Check the Cursor console for error messages (Help > Toggle Developer Tools)
 3. Verify that Python is installed and accessible
 4. Make sure the extension is correctly installed in `~/.cursor/extensions/ignition-rag/`
+5. Verify the virtual environment was created successfully at `~/.cursor/extensions/ignition-rag/venv/`
 
 ## License
 
diff --git a/cursor_extension.js b/cursor_extension.js
@@ -6,19 +6,20 @@ const path = require('path');
 const fs = require('fs');
 
 // Configuration
-const DEFAULT_RAG_API_URL = 'http://localhost:8001';
+const DEFAULT_RAG_API_URL = process.env.RAG_API_URL || 'http://localhost:8001';
 const DEFAULT_PYTHON_SCRIPT = path.join(__dirname, 'cursor_client.py');
+const SHELL_SCRIPT_WRAPPER = path.join(__dirname, 'run_client.sh');
 
 // Extension configuration
 let config = {
   ragApiUrl: process.env.RAG_API_URL || DEFAULT_RAG_API_URL,
   pythonPath: process.env.PYTHON_PATH || 'python3',
-  clientScript: DEFAULT_PYTHON_SCRIPT,
+  clientScript: fs.existsSync(SHELL_SCRIPT_WRAPPER) ? SHELL_SCRIPT_WRAPPER : DEFAULT_PYTHON_SCRIPT,
   enabled: true,
   topK: 3,
 };
 
-// Check if the Python script exists
+// Check if the client script exists
 function verifySetup() {
   try {
     if (!fs.existsSync(config.clientScript)) {
@@ -55,17 +56,35 @@ async function getIgnitionContext(query, context = {}) {
       // Get current file path from cursor context
       const currentFile = context.currentFile || '';
 
-      // Prepare arguments for Python script
-      const args = [
-        config.clientScript,
-        query,
-        '--file', currentFile,
-        '--top-k', config.topK.toString(),
-        '--output', 'text'
-      ];
+      // Determine if we're using the shell script wrapper
+      const isUsingWrapper = config.clientScript.endsWith('run_client.sh');
+      
+      // Prepare arguments for Python script or shell wrapper
+      let args = [];
+      if (isUsingWrapper) {
+        // Shell script already includes the path to the Python script
+        args = [
+          query,
+          '--file', currentFile,
+          '--top-k', config.topK.toString(),
+          '--output', 'text'
+        ];
+      } else {
+        // Using Python directly
+        args = [
+          config.clientScript,
+          query,
+          '--file', currentFile,
+          '--top-k', config.topK.toString(),
+          '--output', 'text'
+        ];
+      }
 
-      // Spawn Python process
-      const process = spawn(config.pythonPath, args, {
+      // Prepare the command to run
+      const command = isUsingWrapper ? config.clientScript : config.pythonPath;
+      
+      // Spawn process
+      const process = spawn(command, args, {
         env: { ...process.env, RAG_API_URL: config.ragApiUrl }
       });
 
diff --git a/install_cursor_extension.sh b/install_cursor_extension.sh
@@ -7,6 +7,7 @@ set -e
 EXTENSION_NAME="ignition-rag"
 CURSOR_EXTENSIONS_DIR="$HOME/.cursor/extensions"
 EXTENSION_DIR="$CURSOR_EXTENSIONS_DIR/$EXTENSION_NAME"
+VENV_DIR="$EXTENSION_DIR/venv"
 
 # Check if cursor extension directory exists
 if [ ! -d "$CURSOR_EXTENSIONS_DIR" ]; then
@@ -45,7 +46,20 @@ cat > "$EXTENSION_DIR/extension.js" << EOF
 // Ignition RAG Extension Loader
 // This file is automatically loaded by Cursor on startup
 
+const { spawn } = require('child_process');
+const path = require('path');
+
+// Update the Python path in the extension
 try {
+  const fs = require('fs');
+  const extensionConfig = require('./cursor_extension');
+  
+  // Use the shell script wrapper to run the Python client
+  extensionConfig.configure({
+    clientScript: path.join(__dirname, 'run_client.sh'),
+    pythonPath: '' // Not needed as the shell script handles this
+  });
+  
   // Load the connector
   require('./cursor_connector');
   console.log('Ignition RAG Extension loaded successfully');
@@ -56,16 +70,38 @@ EOF
 
 # Check if Python is installed
 if ! command -v python3 &> /dev/null; then
-  echo "Warning: python3 not found. You may need to install Python 3 for the extension to work."
+  echo "Warning: python3 not found. You need to install Python 3 for the extension to work."
+  exit 1
 fi
 
-# Check if pip is installed
-if command -v pip3 &> /dev/null; then
-  echo "Installing Python dependencies..."
-  pip3 install requests python-dotenv
-else
-  echo "Warning: pip3 not found. You may need to install Python dependencies manually."
-  echo "Required packages: requests, python-dotenv"
+# Install Python dependencies
+echo "Setting up Python dependencies..."
+
+# Create a virtual environment for the extension
+echo "Creating a virtual environment..."
+python3 -m venv "$VENV_DIR" || {
+  echo "Failed to create virtual environment. Python venv module might be missing."
+  echo "You may need to install it manually:"
+  echo "  On macOS: brew install python-venv"
+  echo "  On Ubuntu/Debian: apt-get install python3-venv"
+  echo ""
+  echo "Alternatively, you can install the required packages manually:"
+  echo "  pip3 install --user requests python-dotenv"
+  echo ""
+  echo "Warning: Dependencies not installed automatically!"
+  HAS_VENV=false
+}
+
+# If venv was created successfully, install dependencies
+if [ -d "$VENV_DIR" ]; then
+  echo "Installing dependencies in virtual environment..."
+  "$VENV_DIR/bin/pip" install requests python-dotenv || {
+    echo "Failed to install dependencies in virtual environment."
+    echo "You may need to install them manually:"
+    echo "  pip3 install --user requests python-dotenv"
+  }
+  echo "Dependencies installed successfully in virtual environment."
+  HAS_VENV=true
 fi
 
 # Create .env file for the extension
@@ -74,10 +110,24 @@ if [ ! -f "$EXTENSION_DIR/.env" ]; then
   cat > "$EXTENSION_DIR/.env" << EOF
 # Ignition RAG Extension Configuration
 RAG_API_URL=http://localhost:8001
-PYTHON_PATH=python3
+PYTHON_PATH=$([ "$HAS_VENV" = true ] && echo "$VENV_DIR/bin/python3" || echo "python3")
 EOF
 fi
 
+# Create a shell script to run the client with the virtual environment
+cat > "$EXTENSION_DIR/run_client.sh" << EOF
+#!/bin/bash
+$([ "$HAS_VENV" = true ] && echo "$VENV_DIR/bin/python3" || echo "python3") "$EXTENSION_DIR/cursor_client.py" "\$@"
+EOF
+chmod +x "$EXTENSION_DIR/run_client.sh"
+
+echo ""
 echo "Ignition RAG extension has been installed to $EXTENSION_DIR"
+if [ "$HAS_VENV" = true ]; then
+  echo "✅ Virtual environment created and dependencies installed successfully."
+else
+  echo "⚠️  Virtual environment setup failed. You may need to install dependencies manually:"
+  echo "   pip3 install --user requests python-dotenv"
+fi
 echo "To configure the extension, edit $EXTENSION_DIR/.env"
 echo "Restart Cursor to enable the extension" 
