Desktop release: full bundle in CI, SKIP_MODEL for 2GB limit, first-run auto-download

andresarbelaez · andresarbelaez · commit 1a5e6db70807 · 2026-02-16T21:33:20.000-05:00
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -47,10 +47,12 @@ jobs:
           cd desktop
           npm ci
 
+      # SKIP_MODEL=1 keeps DMG/MSI under GitHub's 2 GB release asset limit; users download model in Settings.
       - name: Setup full bundle (Python + default model + KB)
         env:
           BUNDLE_PYTHON: 1
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SKIP_MODEL: 1
         run: |
           cd desktop
           bash scripts/setup-full-bundle.sh
diff --git a/desktop/scripts/setup-full-bundle.sh b/desktop/scripts/setup-full-bundle.sh
@@ -22,18 +22,23 @@ bash "$DESKTOP_DIR/scripts/setup-python-bundle.sh"
 echo ""
 
 # --- 2. Default model into resources/models/ ---
+# Set SKIP_MODEL=1 in CI to keep release assets under GitHub's 2 GB limit; users download model in Settings.
 echo "Step 2/3: Default model (for bundled DMG) ..."
-mkdir -p "$MODELS_DIR"
-if [ -f "$DEFAULT_MODEL_PATH" ]; then
-  echo "  Model already present at $DEFAULT_MODEL_PATH"
+if [ -n "${SKIP_MODEL:-}" ]; then
+  echo "  SKIP_MODEL is set; skipping model download (installer will stay under 2 GB; users can download in Settings)."
 else
-  echo "  Downloading default model (~2.5 GB) to $DEFAULT_MODEL_PATH"
-  echo "  This may take a while."
-  if curl -# -L -o "$DEFAULT_MODEL_PATH" "$DEFAULT_MODEL_URL"; then
-    echo "  Model downloaded."
+  mkdir -p "$MODELS_DIR"
+  if [ -f "$DEFAULT_MODEL_PATH" ]; then
+    echo "  Model already present at $DEFAULT_MODEL_PATH"
   else
-    echo "  Download failed. Delete any partial file and re-run, or run without model (first launch will open Settings)."
-    exit 1
+    echo "  Downloading default model (~2.5 GB) to $DEFAULT_MODEL_PATH"
+    echo "  This may take a while."
+    if curl -# -L -o "$DEFAULT_MODEL_PATH" "$DEFAULT_MODEL_URL"; then
+      echo "  Model downloaded."
+    else
+      echo "  Download failed. Delete any partial file and re-run, or run without model (first launch will open Settings)."
+      exit 1
+    fi
   fi
 fi
 echo ""
@@ -53,4 +58,8 @@ fi
 echo ""
 
 echo "Full bundle ready. Run: npm run build"
-echo "Installers (DMG etc.) will include the model and KB; first launch will not show Settings."
+if [ -n "${SKIP_MODEL:-}" ]; then
+  echo "Installers will include Python and KB; download the model once in Settings."
+else
+  echo "Installers (DMG etc.) will include the model and KB; first launch will not show Settings."
+fi
diff --git a/desktop/src-tauri/src/bundled_defaults.rs b/desktop/src-tauri/src/bundled_defaults.rs
@@ -25,13 +25,22 @@ const DEFAULT_MODEL_ID: &str = "llama-3.2-3b-instruct-q4_k_m";
 /// Filename used when downloading default model from URL (last segment of HuggingFace URL).
 const DEFAULT_MODEL_DOWNLOAD_FILENAME: &str = "Llama-3.2-3B-Instruct-Q4_K_M.gguf";
 
+/// URL for the default model (same as in setup-full-bundle.sh). Used for first-run auto-download.
+const DEFAULT_MODEL_URL: &str = "https://huggingface.co/bartowski/Llama-3.2-3B-Instruct-GGUF/resolve/main/Llama-3.2-3B-Instruct-Q4_K_M.gguf";
+
 /// Relative path to bundled KB JSON in resources (same format as URL-loaded package: manifest, documents, embeddings).
 const BUNDLED_KB_FILENAME: &str = "default_kb.json";
 
 #[derive(Debug, Serialize)]
 pub struct BundledDefaultsStatus {
     pub model_ready: bool,
     pub kb_ready: bool,
+    /// When packaged and no model found: URL to download the default model on first run.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub default_model_download_url: Option<String>,
+    /// When packaged and no model found: path where the default model should be saved (app data).
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub default_model_output_path: Option<String>,
 }
 
 /// Find project root (directory that contains "data" and ideally "desktop") for dev fallback.
@@ -80,6 +89,26 @@ fn resolve_bundled_model_path(app: &AppHandle) -> Option<PathBuf> {
             }
         }
     }
+    // App data (e.g. after first-run auto-download or Settings download)
+    if let Some(base) = app.path().app_data_dir().ok() {
+        let models_dir = base.join("data").join("models");
+        let id_gguf = format!("{}.gguf", DEFAULT_MODEL_ID);
+        for name in [
+            DEFAULT_MODEL_DOWNLOAD_FILENAME,
+            BUNDLED_MODEL_FILENAME,
+            id_gguf.as_str(),
+        ] {
+            let p = models_dir.join(name);
+            if p.exists() {
+                if let Ok(metadata) = fs::metadata(&p) {
+                    let size_gb = metadata.len() as f64 / (1024.0 * 1024.0 * 1024.0);
+                    if size_gb >= 1.0 {
+                        return Some(p);
+                    }
+                }
+            }
+        }
+    }
     // Dev fallback: use same location as Settings download (project data/models/)
     if let Some(data_dir) = find_dev_data_dir() {
         let models_dir = data_dir.join("models");
@@ -215,8 +244,25 @@ async fn ingest_kb_from_path(app: &AppHandle, path: &Path) -> Result<(), String>
     Ok(())
 }
 
+/// When packaged (resource dir present) and no model exists, return (url, output_path) for first-run auto-download.
+fn default_model_download_info(app: &AppHandle) -> Option<(String, PathBuf)> {
+    if resolve_bundled_model_path(app).is_some() {
+        return None;
+    }
+    let resource_dir = app.path().resource_dir().ok()?;
+    if !resource_dir.exists() {
+        return None;
+    }
+    let base = app.path().app_data_dir().ok()?;
+    let models_dir = base.join("data").join("models");
+    let _ = fs::create_dir_all(&models_dir);
+    let output_path = models_dir.join(DEFAULT_MODEL_DOWNLOAD_FILENAME);
+    Some((DEFAULT_MODEL_URL.to_string(), output_path))
+}
+
 /// Ensure the default model and global KB are initialized from bundled resources when possible.
 /// Call this once after loading; then check setup status (model_ready, kb_ready).
+/// When no model is found in a packaged build, returns default_model_download_url/output_path for first-run auto-download.
 #[tauri::command]
 pub async fn ensure_bundled_defaults_initialized(app: AppHandle) -> Result<BundledDefaultsStatus, String> {
     // 1. Model: if not loaded, try bundled model path
@@ -231,10 +277,11 @@ pub async fn ensure_bundled_defaults_initialized(app: AppHandle) -> Result<Bundl
                 }
             }
             None => {
+                #[cfg(debug_assertions)]
                 if let Ok(rd) = app.path().resource_dir() {
                     let expected = rd.join("models").join(BUNDLED_MODEL_FILENAME);
                     eprintln!(
-                        "[Confidant] No bundled model found. Expected at: {} (add resources/models/default_model.gguf and rebuild)",
+                        "[Confidant] No bundled model. Auto-download on first run or add resources/models/default_model.gguf. Expected: {}",
                         expected.display()
                     );
                 }
@@ -287,8 +334,18 @@ pub async fn ensure_bundled_defaults_initialized(app: AppHandle) -> Result<Bundl
         .map(|n| n > 0)
         .unwrap_or(false);
 
+    let (default_model_download_url, default_model_output_path) = if !model_ready {
+        default_model_download_info(&app)
+            .map(|(url, path)| (Some(url), Some(path.to_string_lossy().to_string())))
+            .unwrap_or((None, None))
+    } else {
+        (None, None)
+    };
+
     Ok(BundledDefaultsStatus {
         model_ready,
         kb_ready,
+        default_model_download_url,
+        default_model_output_path,
     })
 }
diff --git a/desktop/src/App.tsx b/desktop/src/App.tsx
@@ -2,6 +2,7 @@ import { useState, useEffect, useRef, useCallback } from 'react';
 import SetupModal from './components/SetupModal';
 import ChatInterface from './components/ChatInterface';
 import LoadingScreen from './components/LoadingScreen';
+import DownloadingModelScreen from './components/DownloadingModelScreen';
 import UserProfileSelector from './components/UserProfileSelector';
 import ErrorScreen from './components/ErrorScreen';
 import { useAppState } from './hooks/useAppState';
@@ -27,6 +28,8 @@ function App() {
     setupStatus,
     showSettingsModal,
     transitionToChat,
+    transitionToUserSelection,
+    transitionToError,
     closeSettings,
     switchProfile,
     handleModelReady,
@@ -113,6 +116,19 @@ function App() {
 
   // Render based on current view state
   switch (view.type) {
+    case 'downloading-model':
+      return (
+        <DownloadingModelScreen
+          url={view.url}
+          outputPath={view.outputPath}
+          onComplete={async () => {
+            handleModelReady(view.outputPath);
+            await transitionToUserSelection();
+          }}
+          onError={(message) => transitionToError(message)}
+        />
+      );
+
     case 'user-selection':
       return (
         <div className={`App ${showSettingsModal ? 'dimmed' : ''}`}>
diff --git a/desktop/src/components/DownloadingModelScreen.css b/desktop/src/components/DownloadingModelScreen.css
@@ -0,0 +1,78 @@
+.downloading-model-screen {
+  position: fixed;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  background: var(--color-bg);
+  z-index: 9999;
+}
+
+.downloading-model-content {
+  text-align: center;
+  animation: fadeIn 0.6s ease-in;
+}
+
+.downloading-model-title {
+  font-size: 4em;
+  margin: 0;
+  background: var(--color-primary);
+  -webkit-background-clip: text;
+  -webkit-text-fill-color: transparent;
+  background-clip: text;
+  font-weight: 600;
+}
+
+.downloading-model-heading {
+  color: var(--color-text);
+  font-size: 1.5em;
+  margin: 1.5em 0 0.5em;
+  font-weight: 500;
+}
+
+.downloading-model-subtitle {
+  color: var(--color-text-muted);
+  font-size: 1.1em;
+  margin: 0.5em 0 2em;
+  font-weight: 300;
+}
+
+.downloading-model-spinner {
+  width: 40px;
+  height: 40px;
+  border: 3px solid var(--color-border-subtle);
+  border-top: 3px solid var(--color-primary);
+  border-radius: 50%;
+  animation: spin 1s linear infinite;
+  margin: 2rem auto 0;
+}
+
+@keyframes fadeIn {
+  from {
+    opacity: 0;
+    transform: translateY(20px);
+  }
+  to {
+    opacity: 1;
+    transform: translateY(0);
+  }
+}
+
+@keyframes spin {
+  0% { transform: rotate(0deg); }
+  100% { transform: rotate(360deg); }
+}
+
+@media (prefers-color-scheme: dark) {
+  .downloading-model-subtitle {
+    color: var(--color-text-muted);
+  }
+
+  .downloading-model-spinner {
+    border-color: var(--color-border);
+    border-top-color: var(--color-primary);
+  }
+}
diff --git a/desktop/src/components/DownloadingModelScreen.tsx b/desktop/src/components/DownloadingModelScreen.tsx
@@ -0,0 +1,48 @@
+import { useEffect, useState } from 'react';
+import { invoke } from '@tauri-apps/api/core';
+import { useTranslation } from '../i18n/hooks/useTranslation';
+import './DownloadingModelScreen.css';
+
+interface DownloadingModelScreenProps {
+  url: string;
+  outputPath: string;
+  onComplete: () => void;
+  onError: (message: string) => void;
+}
+
+export default function DownloadingModelScreen({
+  url,
+  outputPath,
+  onComplete,
+  onError,
+}: DownloadingModelScreenProps) {
+  const { t } = useTranslation(null);
+  const [started, setStarted] = useState(false);
+
+  useEffect(() => {
+    if (started) return;
+    setStarted(true);
+
+    (async () => {
+      try {
+        await invoke('download_model', { url, outputPath });
+        await invoke('initialize_model', { modelPath: outputPath });
+        onComplete();
+      } catch (err) {
+        const message = err instanceof Error ? err.message : 'Failed to download or load model';
+        onError(message);
+      }
+    })();
+  }, [url, outputPath, onComplete, onError, started]);
+
+  return (
+    <div className="downloading-model-screen">
+      <div className="downloading-model-content">
+        <h1 className="downloading-model-title">{t('ui.appName')}</h1>
+        <p className="downloading-model-heading">{t('ui.downloadingModelTitle')}</p>
+        <p className="downloading-model-subtitle">{t('ui.downloadingModelSubtitle')}</p>
+        <div className="downloading-model-spinner" aria-hidden="true" />
+      </div>
+    </div>
+  );
+}
diff --git a/desktop/src/hooks/useAppState.ts b/desktop/src/hooks/useAppState.ts
@@ -11,6 +11,7 @@ export interface AppUser {
 
 export type AppView =
   | { type: 'loading' }
+  | { type: 'downloading-model'; url: string; outputPath: string }
   | { type: 'user-selection'; preloadedUsers?: AppUser[] | null }
   | { type: 'chat', userId: string }
   | { type: 'error', message: string, retry?: () => void; onContinue?: () => void };
@@ -242,11 +243,34 @@ export function useAppState() {
         if (!setupStatus.modelReady || !setupStatus.globalKBReady) {
           try {
             logAppTiming('ensure_bundled_defaults_initialized start');
-            await invoke<{ model_ready: boolean; kb_ready: boolean }>(
-              'ensure_bundled_defaults_initialized'
-            );
-            setupStatus = await checkSetup();
+            const bundled = await invoke<{
+              model_ready: boolean;
+              kb_ready: boolean;
+              default_model_download_url?: string;
+              default_model_output_path?: string;
+            }>('ensure_bundled_defaults_initialized');
             logAppTiming('ensure_bundled_defaults_initialized done');
+
+            // If no model but we can auto-download, show downloading screen
+            if (
+              !bundled.model_ready &&
+              bundled.default_model_download_url &&
+              bundled.default_model_output_path
+            ) {
+              logViewEntered('downloading-model');
+              setState(prev => ({
+                ...prev,
+                view: {
+                  type: 'downloading-model',
+                  url: bundled.default_model_download_url,
+                  outputPath: bundled.default_model_output_path,
+                },
+                setupStatus: { ...prev.setupStatus, isChecking: false },
+              }));
+              return;
+            }
+
+            setupStatus = await checkSetup();
           } catch (err) {
             console.warn('Bundled defaults init failed:', err);
           }
diff --git a/desktop/src/i18n/translations/en.json b/desktop/src/i18n/translations/en.json
@@ -62,6 +62,8 @@
     "appName": "Confidant",
     "loadingSubtitle": "Your offline AI assistant",
     "loadingTagline": "Mental health support that stays private",
+    "downloadingModelTitle": "Downloading default model",
+    "downloadingModelSubtitle": "First-time setup. This may take a few minutes (~2.5 GB).",
     "modelManagerPrompt": "Please initialize a model first in the Model Manager tab.",
     "userFallback": "User",
     "userSettings": "User Settings",
diff --git a/desktop/src/i18n/translations/es.json b/desktop/src/i18n/translations/es.json
@@ -62,6 +62,8 @@
     "appName": "Confidant",
     "loadingSubtitle": "Tu asistente de IA sin conexión",
     "loadingTagline": "Apoyo en salud mental que se queda en privado",
+    "downloadingModelTitle": "Descargando modelo predeterminado",
+    "downloadingModelSubtitle": "Configuración inicial. Puede tardar unos minutos (~2,5 GB).",
     "modelManagerPrompt": "Inicializa primero un modelo en la pestaña del Gestor de modelos.",
     "userFallback": "Usuario",
     "userSettings": "Ajustes de usuario",
