Fix: onborading improvements

[AnkushMalaker]

Summary by CodeRabbit

Release Notes

• New Features

  • Configuration values are now preserved across re-runs, preventing loss of settings.
  • Auto-detection of Tailscale addresses for HTTPS setup with fallback to localhost.
  • Enhanced speaker identification capabilities for transcription services.
  • CLI-driven configuration with wizard-style confirmations.

• Improvements

  • Interactive setup now includes safety notes about re-running.
  • Better error messages with actionable guidance for troubleshooting.
  • Streamlined optional services configuration flow.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

• 🔍 Trigger a full review

📝 Walkthrough

Walkthrough

This pull request refactors setup utilities into a shared module (setup_utils.py) and enhances configuration flows across backend authentication, ASR services, and the wizard CLI. The changes introduce CLI-first configuration patterns, preserve existing environment values during re-runs, auto-detect Tailscale addresses for HTTPS setup, and update ASR provider capabilities.

Changes

Cohort / File(s)	Summary
Core Setup Utilities setup_utils.py	Added two new public utility functions: detect_tailscale_info() to detect MagicDNS names and IPv4 addresses via Tailscale CLI, and detect_cuda_version() to parse CUDA version from nvidia-smi and map to PyTorch strings (cu121, cu126, cu128).
Backend Authentication & Configuration backends/advanced/init.py	Reworked authentication flow to preserve existing .env values during re-runs; updated transcription setup to support CLI-driven configuration with wizard-style messaging; enhanced HTTPS setup with Tailscale auto-detection; added mask_api_key() public method for API key masking.
ASR Services & Providers extras/asr-services/init.py, extras/asr-services/providers/vibevoice/transcriber.py	Refactored to use shared utilities (detect_cuda_version, read_env_value); updated VibeVoice provider capabilities to include speaker_identification and long_form; implemented CLI-first selection patterns for provider and model; fixed speaker field handling to avoid double-prefixing in output parsing.
Speaker Recognition Service extras/speaker-recognition/init.py	Refactored to delegate CUDA detection, environment value reading, and API key masking to shared utilities from setup_utils.
Wizard & Service Orchestration wizard.py	Enhanced select_services() to accept optional transcription_provider parameter and auto-add matching ASR services; added Tailscale auto-detection for HTTPS configuration with fallback to localhost; improved error handling and user messaging for setup failures and retries.
ASR Tests tests/asr/protocol_tests.robot	Expanded documented ASR capabilities set to include speaker_identification, long_form, language_detection, vad_filter, translation, and chunked_processing alongside existing diarization capabilities.

Sequence Diagram

sequenceDiagram
    participant User
    participant Wizard
    participant SetupUtils
    participant Backend
    participant ASR as ASR Services
    participant Tailscale

    User->>Wizard: Run setup with options
    Wizard->>Wizard: Main flow with safety notes
    
    Note over Wizard: Transcription Provider Selection
    User->>Wizard: Select transcription provider
    Wizard->>Wizard: Auto-add matching ASR service
    
    Note over Wizard: HTTPS Configuration
    alt HTTPS Enabled
        Wizard->>SetupUtils: detect_tailscale_info()
        SetupUtils->>Tailscale: Query MagicDNS & IPv4
        Tailscale-->>SetupUtils: DNS name and/or IP
        SetupUtils-->>Wizard: Detected address
        Wizard->>Wizard: Use detected address as default
        User->>Wizard: Confirm/override server address
    end
    
    Note over Wizard: Service Setup
    Wizard->>Backend: Configure with auth/values
    Backend->>SetupUtils: Preserve/reuse existing env values
    
    Wizard->>ASR: Setup with transcription provider
    ASR->>SetupUtils: detect_cuda_version()
    SetupUtils-->>ASR: CUDA version (cu121/cu126/cu128)
    ASR->>ASR: Configure provider & model
    
    Wizard-->>User: Configuration complete with summary

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title contains a typo ('onborading' instead of 'onboarding') and is vague/generic; it doesn't clearly convey the substantial improvements made to authentication flow, transcription setup, Tailscale integration, and speaker identification logic.	Correct the typo to 'onboarding' and make the title more specific to the primary changes, such as: 'Improve onboarding flow with reusable config values and Tailscale auto-detection' or similar.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	Docstring coverage is 96.77% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/onborading-improvements

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[AnkushMalaker]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 5

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

backends/advanced/init.py (2)

640-640: ⚠️ Potential issue | 🟡 Minor

Rich markup mismatch: opening [yellow] closed with [/warning].

This will cause the yellow styling to leak into subsequent console output.

Proposed fix

-                self.console.print(f"[yellow][WARNING][/warning] SSL script not found at {ssl_script}")
+                self.console.print(f"[yellow][WARNING][/yellow] SSL script not found at {ssl_script}")

---

133-135: ⚠️ Potential issue | 🟡 Minor

Same Optional[str] return type mismatch as noted in extras/speaker-recognition/init.py.

read_env_value returns Optional[str], but this method is annotated as returning str.

🤖 Fix all issues with AI agents

In `@backends/advanced/init.py`:
- Line 458: The printed message uses an unnecessary f-string; update the
self.console.print call (the invocation that prints "[green]✅[/green]
Obsidian/Neo4j: enabled (configured via wizard)") to use a plain string literal
instead of an f-prefixed string so the Ruff F541 warning is resolved.

In `@extras/asr-services/init.py`:
- Line 40: The capabilities list in extras/asr-services/init.py no longer
includes "segments" but VibeVoice's transcriber (VibeVoice.transcribe / class
VibeVoice) still returns a "segments" field; restore consistency by adding
"segments" back into the capabilities array in init.py (so downstream protocol
check sees segments) or alternatively remove the segment-generation code from
VibeVoice.transcribe if segments are intentionally deprecated; also update the
test mock in tests/libs/mock_asr_server.py to match whichever choice you make
(ensure the mock's capabilities array matches VibeVoice's declared
capabilities).

In `@extras/speaker-recognition/init.py`:
- Around line 72-74: The return type annotation of read_existing_env_value is
incorrect: read_env_value returns Optional[str], so update the signature of
read_existing_env_value to return Optional[str] and import Optional from typing
(ensure Optional is added to the existing imports); adjust the docstring if
desired to indicate the function may return None so callers and type-checkers
are accurate.

In `@setup_utils.py`:
- Around line 397-406: The code currently compares the string cuda_ver (built
from match.groups()) using lexicographic operators, which misclassifies versions
like "12.10"; change the logic to convert major and minor to integers and
compare numeric tuples instead (e.g., use tuple comparisons like (int(major),
int(minor)) >= (12, 8) to decide between "cu128", "cu126", "cu121"); update the
branch that assigns cuda_ver and the subsequent if/elif checks to use these
integer comparisons and remove string-based comparisons.

In `@wizard.py`:
- Around line 279-292: Several console.print calls in the
subprocess.TimeoutExpired and subprocess.CalledProcessError handlers use
f-strings without interpolation; change those f"... " literals to plain string
literals (remove the leading "f") for the messages passed to console.print in
the except blocks handling subprocess.TimeoutExpired (the prints for
"Configuration may be partially written.", "To retry just this service:", and
the "cd {service['path']} && {' '.join(service['cmd'])}" line should keep
interpolation and remain f-strings while the other two should be non-f strings)
and subprocess.CalledProcessError (the two "[yellow]   ..." helper messages
should be plain strings while the lines composing the retry command and the main
error message that use e.returncode or service interpolation should remain
f-strings); update the console.print calls in those exception handlers
accordingly.