Merge pull request #5 from pladisdev/development

Added an MSI installer!

Author: pladisdev

.github/workflows/build-and-release.yml

@@ -44,30 +44,28 @@ jobs:
     - name: Get version from git tags
       id: get_version
       run: |
-        # Try to get version from latest git tag
+        # Get version from backend/version.py as the source of truth
+        $fileVersion = "1.0.0"  # Default fallback
+        if (Test-Path "backend/version.py") {
+          $versionContent = Get-Content "backend/version.py" | Select-String -Pattern '__version__\s*=\s*[''"]([^''"]+)[''"]'
+          if ($versionContent) {
+            $fileVersion = $versionContent.Matches.Groups[1].Value
+            Write-Host "Found version in backend/version.py: $fileVersion"
+          }
+        }
+        
+        # Also check latest git tag for reference
         $gitVersion = git describe --tags --abbrev=0 2>$null
         if ($LASTEXITCODE -eq 0 -and $gitVersion) {
-          # Clean up version (remove 'v' prefix if present)
-          $version = $gitVersion -replace '^v', ''
-          Write-Host "Found git tag version: $version"
-        } else {
-          # Fallback to version from backend/version.py
-          if (Test-Path "backend/version.py") {
-            $versionContent = Get-Content "backend/version.py" | Select-String -Pattern '__version__\s*=\s*[''"]([^''"]+)[''"]'
-            if ($versionContent) {
-              $version = $versionContent.Matches.Groups[1].Value
-              Write-Host "Using version from backend/version.py: $version"
-            } else {
-              $version = "1.0.0"
-              Write-Host "No version found, using default: $version"
-            }
-          } else {
-            $version = "1.0.0"
-            Write-Host "No version found, using default: $version"
-          }
+          $gitVersion = $gitVersion -replace '^v', ''
+          Write-Host "Latest git tag version: $gitVersion"
         }
         
-        # Update backend/version.py with the version
+        # Use the version from backend/version.py as the authoritative source
+        $version = $fileVersion
+        Write-Host "Using version: $version"
+        
+        # Update backend/version.py to ensure it's consistent
         @"
         # Auto-generated version file
         # This file is automatically updated during the build process
@@ -117,6 +115,56 @@ jobs:
         Write-Host "Executable size: $([math]::Round($size, 2)) MB"
       shell: powershell
 
+    - name: Install WiX Toolset v4
+      run: |
+        Write-Host "Installing WiX Toolset v4..."
+        dotnet tool install --global wix
+        
+        # Ensure WiX is in PATH
+        $env:PATH = "$env:USERPROFILE\.dotnet\tools;$env:PATH"
+        
+        Write-Host "Verifying WiX installation..."
+        wix --version
+        
+        Write-Host "Installing WiX UI extension globally..."
+        wix extension add --global WixToolset.UI.wixext
+        
+        Write-Host "Verifying UI extension..."
+        wix extension list
+        wix extension list --global
+        
+        Write-Host "WiX installation complete"
+      shell: powershell
+    
+    - name: Generate installer images
+      run: |
+        Write-Host "Generating custom installer images..."
+        pip install pillow
+        python deployment/create_installer_images.py
+      shell: powershell
+    
+    - name: Build MSI Installer
+      run: python deployment/build_msi.py
+      env:
+        VITE_APP_VERSION: ${{ steps.get_version.outputs.app_version }}
+    
+    - name: Verify MSI exists
+      id: msi_info
+      run: |
+        $msiPath = Get-ChildItem -Path "dist/msi" -Filter "*.msi" | Select-Object -First 1
+        if (!$msiPath) {
+          Write-Error "MSI build failed: No .msi file found in dist/msi directory"
+          exit 1
+        }
+        Write-Host "[SUCCESS] MSI build successful: $($msiPath.Name) found"
+        $size = $msiPath.Length / 1MB
+        Write-Host "MSI size: $([math]::Round($size, 2)) MB"
+        
+        # Store MSI info for later steps
+        echo "msi_path=$($msiPath.FullName)" >> $env:GITHUB_OUTPUT
+        echo "msi_name=$($msiPath.Name)" >> $env:GITHUB_OUTPUT
+      shell: powershell
+    
     - name: Get version info
       id: version
       run: |
@@ -145,7 +193,9 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: ChatYapper-${{ steps.version.outputs.version }}
-        path: dist/ChatYapper.exe
+        path: |
+          dist/ChatYapper.exe
+          dist/msi/*.msi
         retention-days: 7
 
     - name: Comment PR with build status
@@ -154,19 +204,28 @@ jobs:
       with:
         script: |
           const fs = require('fs');
-          const stats = fs.statSync('dist/ChatYapper.exe');
-          const sizeMB = (stats.size / (1024 * 1024)).toFixed(2);
+          const path = require('path');
+          
+          const exeStats = fs.statSync('dist/ChatYapper.exe');
+          const exeSizeMB = (exeStats.size / (1024 * 1024)).toFixed(2);
+          
+          // Find MSI file
+          const msiDir = 'dist/msi';
+          const msiFiles = fs.readdirSync(msiDir).filter(f => f.endsWith('.msi'));
+          const msiFile = msiFiles.length > 0 ? msiFiles[0] : null;
+          const msiStats = msiFile ? fs.statSync(path.join(msiDir, msiFile)) : null;
+          const msiSizeMB = msiStats ? (msiStats.size / (1024 * 1024)).toFixed(2) : 'N/A';
           
           const comment = `## ✅ Build Successful
           
-          **Executable:** \`ChatYapper.exe\`
-          **Size:** ${sizeMB} MB
+          **Executable:** \`ChatYapper.exe\` (${exeSizeMB} MB)
+          **MSI Installer:** \`${msiFile || 'Not found'}\` (${msiSizeMB} MB)
           **App Version:** \`${{ steps.get_version.outputs.app_version }}\`
           **Build ID:** \`${{ steps.version.outputs.version }}\`
           **Commit:** ${{ github.sha }}
           
-          The executable has been built and is ready for testing.
-          Download the artifact from the workflow run to test before merging.
+          Both the standalone executable and MSI installer have been built and are ready for testing.
+          Download the artifacts from the workflow run to test before merging.
           
           Once merged to \`main\`, an official release will be created automatically with tag \`v${{ steps.get_version.outputs.app_version }}\`.`;
           
@@ -179,13 +238,10 @@ jobs:
     
     - name: Create Release (on merge to main)
       if: steps.version.outputs.is_release == 'true'
-      id: create_release
-      uses: actions/create-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      uses: softprops/action-gh-release@v1
       with:
         tag_name: ${{ steps.version.outputs.version }}
-        release_name: Chat Yapper ${{ steps.version.outputs.version }}
+        name: Chat Yapper ${{ steps.version.outputs.version }}
         body: |
           ## Chat Yapper ${{ steps.version.outputs.version }}
           
@@ -197,34 +253,45 @@ jobs:
           **Build Date:** ${{ github.event.head_commit.timestamp }}
           
           ### Download
-          Download `ChatYapper.exe` below to run the application.
+          Choose one of the following installation methods:
+          
+          #### MSI Installer (Recommended)
+          - Download `${{ steps.msi_info.outputs.msi_name }}` for a traditional Windows installation
+          - Double-click to install to Program Files
+          - Creates Start Menu and Desktop shortcuts
+          - Easily uninstall via Windows Settings
+          
+          #### Standalone Executable
+          - Download `ChatYapper.exe` for a portable version
+          - No installation required
+          - Run directly from any location
           
           ### Installation
+          
+          **MSI Installer:**
+          1. Download the `.msi` file below
+          2. Double-click to run the installer
+          3. Follow the installation wizard
+          4. Launch from Start Menu or Desktop shortcut
+          
+          **Standalone Executable:**
           1. Download `ChatYapper.exe`
           2. Run the executable
           3. The application will start on `http://localhost:8008`
           
           ### System Requirements
           - Windows 10 or later
-          - No additional dependencies required (all bundled in the executable)
+          - No additional dependencies required (all bundled)
           
           ### Support
           - **Issues:** https://github.com/${{ github.repository }}/issues
           - **Discussions:** https://github.com/${{ github.repository }}/discussions
+        files: |
+          dist/ChatYapper.exe
+          ${{ steps.msi_info.outputs.msi_path }}
         draft: false
         prerelease: false
 
-    - name: Upload Release Asset
-      if: steps.version.outputs.is_release == 'true'
-      uses: actions/upload-release-asset@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: ./dist/ChatYapper.exe
-        asset_name: ChatYapper.exe
-        asset_content_type: application/vnd.microsoft.portable-executable
-    
     - name: Notify release created
       if: steps.version.outputs.is_release == 'true'
       run: |

.gitignore

@@ -165,3 +165,5 @@ coverage.xml
 *.cover
 
 
+.wix/
+

ChatYapper.exe

@@ -7,6 +7,7 @@
 from datetime import datetime
 from typing import Dict, Any, List
 from collections import defaultdict
+import builtins
 
 # Load environment variables from .env file
 from dotenv import load_dotenv
@@ -204,8 +205,18 @@ async def log_requests(request: Request, call_next):
 
 # Serve generated audio files under /audio
 # Use AUDIO_DIR from TTS module to ensure consistency
+logger.info(f"=== MOUNTING AUDIO DIRECTORY ===")
 logger.info(f"Audio directory: {AUDIO_DIR}")
+logger.info(f"Audio directory exists: {os.path.isdir(AUDIO_DIR)}")
+if os.path.isdir(AUDIO_DIR):
+    try:
+        files = os.listdir(AUDIO_DIR)
+        logger.info(f"Files in audio directory: {len(files)} files")
+    except Exception as e:
+        logger.error(f"Error listing audio directory: {e}")
+        
 app.mount("/audio", StaticFiles(directory=AUDIO_DIR), name="audio")
+logger.info(f"=== AUDIO MOUNT COMPLETE ===")
 
 
 # Debug: List files in the public directory
@@ -232,16 +243,33 @@ def unregister(self, ws: WebSocket):
         if ws in self.clients:
             self.clients.remove(ws)
     async def broadcast(self, payload: Dict[str, Any]):
+        logger.debug(f"Hub.broadcast called with payload type: {payload.get('type')}")
+        logger.debug(f"Broadcasting to {len(self.clients)} clients")
         dead = []
+        sent_count = 0
         for ws in self.clients:
             try:
                 await ws.send_text(json.dumps(payload))
-            except Exception:
+                sent_count += 1
+                logger.debug(f"Sent message to client {sent_count}/{len(self.clients)}")
+            except Exception as e:
+                logger.warning(f"Failed to send to client: {e}")
                 dead.append(ws)
         for d in dead:
             self.unregister(d)
+        logger.debug(f"Broadcast complete: {sent_count} succeeded, {len(dead)} failed")
+
+# Use a singleton pattern to prevent hub from being recreated on module reload
+# This is critical for .exe builds where imports can cause module reinitialization
+# We store the hub in builtins which is truly global and survives module reloads
+if not hasattr(builtins, '_chatyapper_hub_instance'):
+    logger.info("Creating new Hub instance (first initialization)")
+    hub = Hub()
+    builtins._chatyapper_hub_instance = hub
+else:
+    hub = builtins._chatyapper_hub_instance
+    logger.info(f"Hub already exists with {len(hub.clients)} clients (module reload detected)")
 
-hub = Hub()
 async def broadcast_avatar_slots():
     await hub.broadcast({
         "type": "avatar_slots_updated",
@@ -1142,6 +1170,15 @@ async def process_tts_message(evt: Dict[str, Any]):
 
         audio_url = f"/audio/{os.path.basename(path)}"
 
+        # Debug logging for .exe troubleshooting
+        logger.info(f"=== TTS AUDIO GENERATED ===")
+        logger.info(f"Audio file path: {path}")
+        logger.info(f"Audio file exists: {os.path.exists(path)}")
+        logger.info(f"Audio file size: {os.path.getsize(path) if os.path.exists(path) else 'N/A'} bytes")
+        logger.info(f"Audio URL: {audio_url}")
+        logger.info(f"Audio duration: {audio_duration}s")
+        logger.info(f"AUDIO_DIR: {AUDIO_DIR}")
+        
         # Create base payload
         voice_info = {
             "id": selected_voice.id,
@@ -1176,7 +1213,15 @@ async def process_tts_message(evt: Dict[str, Any]):
             })
 
             logger.info(f"Broadcasting TTS with slot {target_slot['id']} to {len(hub.clients)} clients")
+            logger.info(f"=== BROADCASTING WEBSOCKET MESSAGE ===")
+            logger.info(f"Message type: play")
+            logger.info(f"Target slot: {target_slot['id']}")
+            logger.info(f"Audio URL in payload: {enhanced_payload.get('audioUrl')}")
+            logger.info(f"Connected WebSocket clients: {len(hub.clients)}")
+            logger.info(f"Payload keys: {list(enhanced_payload.keys())}")
+            
             await hub.broadcast(enhanced_payload)
+            logger.info(f"=== BROADCAST COMPLETE ===")
         else:
             # No slots available - queue the message
             logger.info(f"All slots busy, queuing TTS for {username}")

backend/app.py

@@ -58,8 +58,20 @@ def get_user_data_dir():
 YOUTUBE_REDIRECT_URI = f"http://localhost:{os.environ.get('PORT', 8000)}/auth/youtube/callback"
 YOUTUBE_SCOPE = "https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtube.force-ssl"
 
-AUDIO_DIR = os.environ.get("AUDIO_DIR", os.path.join(find_project_root(), "audio"))
+# Audio directory - use persistent location for .exe compatibility
+# In development, use project root's audio folder
+# When packaged as .exe, use user data directory
+if os.environ.get("AUDIO_DIR"):
+    AUDIO_DIR = os.environ.get("AUDIO_DIR")
+elif getattr(sys, 'frozen', False):
+    # Running as compiled executable - use user data directory
+    AUDIO_DIR = os.path.join(USER_DATA_DIR, "audio")
+else:
+    # Running from source - use project root
+    AUDIO_DIR = os.path.join(find_project_root(), "audio")
+
 os.makedirs(AUDIO_DIR, exist_ok=True)
+logger.info(f"Audio directory set to: {AUDIO_DIR}")
 
 # Database setup
 engine = create_engine(f"sqlite:///{DB_PATH}", echo=False, connect_args={"check_same_thread": False})