A free, open source, and extensible speech-to-text application that works completely offline.
appimage packaging fixes (#1867)
CJ Paisb428ae4c9c8a
diff --git a/.github/workflows/build.yml b/.github/workflows/build.ymlindex 391ebeb6..5bfb684f 100644--- a/.github/workflows/build.yml+++ b/.github/workflows/build.yml@@ -451,8 +451,8 @@ jobs:# ships them. Pre-build the app so that install dir exists, then expose it# via LD_LIBRARY_PATH so the AppImage's linuxdeploy can resolve# libtranscribe.so (a NEEDED of `handy`) while bundling. tauri-action- # reuses this compile incrementally. TRANSCRIBE_LIBDIR is consumed by the- # AppImage post-processing step to co-locate the dlopen'd ggml modules.+ # reuses this compile incrementally. build.rs stages the runtime and+ # dlopen'd modules into transcribe-libs/, which tauri.conf.json includes.- name: Pre-build and locate transcribe-cpp backend libs (Linux)if: contains(inputs.platform, 'ubuntu')shell: bash@@ -478,7 +478,6 @@ jobs:LIBDIR="$(cd "$LIBDIR" && pwd)"echo "Located transcribe-cpp libs in: $LIBDIR"ls -la "$LIBDIR"- echo "TRANSCRIBE_LIBDIR=$LIBDIR" >> "$GITHUB_ENV"echo "LD_LIBRARY_PATH=$LIBDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}" >> "$GITHUB_ENV"# linuxdeploy resolves `handy`'s NEEDED libs via `ldd` and HARD-FAILS# on an unresolved one (it does not warn-and-skip). libtranscribe.so@@ -490,6 +489,28 @@ jobs:sudo cp -vL "$LIBDIR"/libtranscribe.so* "$LIBDIR"/libggml*.so* /usr/local/lib/ 2>/dev/null || truesudo ldconfig+ # Tauri's mirrored 2024 linuxdeploy predates support for the+ # LINUXDEPLOY_EXCLUDED_LIBRARIES environment variable. Put a current+ # upstream build in Tauri's tool cache so the exclusions on the build step+ # are applied while constructing the original, signed AppImage.+ - name: Install linuxdeploy with library exclusion support+ if: contains(inputs.platform, 'ubuntu') && contains(inputs.build-args, 'appimage')+ shell: bash+ run: |+ set -euo pipefail+ case "$(uname -m)" in+ x86_64) arch="x86_64" ;;+ aarch64|arm64) arch="aarch64" ;;+ *) echo "Unsupported linuxdeploy architecture: $(uname -m)" >&2; exit 1 ;;+ esac+ tools_dir="${XDG_CACHE_HOME:-$HOME/.cache}/tauri"+ mkdir -p "$tools_dir"+ curl -L --fail --show-error --retry 3 \+ -o "$tools_dir/linuxdeploy-${arch}.AppImage" \+ "https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-${arch}.AppImage"+ chmod +x "$tools_dir/linuxdeploy-${arch}.AppImage"+ "$tools_dir/linuxdeploy-${arch}.AppImage" --appimage-extract-and-run --version+- name: Build with Tauriuses: tauri-apps/tauri-action@v0env:@@ -506,6 +527,13 @@ jobs:AZURE_TENANT_ID: ${{ inputs.sign-binaries && secrets.AZURE_TENANT_ID || '' }}TAURI_SIGNING_PRIVATE_KEY: ${{ inputs.sign-binaries && secrets.TAURI_SIGNING_PRIVATE_KEY || '' }}TAURI_SIGNING_PRIVATE_KEY_PASSWORD: ${{ inputs.sign-binaries && secrets.TAURI_SIGNING_PRIVATE_KEY_PASSWORD || '' }}+ # The Vulkan loader and Wayland client library must come from the host+ # graphics stack. Bundling Ubuntu's copies ahead of the system libraries can+ # prevent a newer distro's Vulkan ICD or Mesa stack from loading.+ # linuxdeploy reads this semicolon-separated glob list before it creates+ # (and Tauri signs and uploads) the AppImage, so the published artifact+ # is already clean.+ LINUXDEPLOY_EXCLUDED_LIBRARIES: ${{ contains(inputs.platform, 'ubuntu') && 'libvulkan.so*;libwayland-client.so*' || '' }}# linuxdeploy passes this to appimagetool, which writes it as# X-AppImage-Version for desktop integration tools such as Gear Lever.LINUXDEPLOY_OUTPUT_VERSION: ${{ contains(inputs.platform, 'ubuntu') && steps.get-version.outputs.version || '' }}@@ -516,10 +544,10 @@ jobs:assetNamePattern: ${{ steps.patch-release-name.outputs.platform }}args: ${{ inputs.build-args }}- # tauri-action uploads release assets before returning, so verify the- # metadata produced by Tauri itself rather than relying only on the later- # post-processing audit.- - name: Verify AppImage version metadata before post-processing+ # tauri-action uploads release assets before returning. All AppImage+ # filtering therefore happens inside linuxdeploy above; this verifies the+ # exact artifact Tauri signed and uploaded.+ - name: Verify AppImage version metadataif: contains(inputs.platform, 'ubuntu')shell: bashrun: |@@ -581,79 +609,6 @@ jobs:src-tauri/target/${{ inputs.target }}/${{ steps.build-profile.outputs.profile }}/bundle/macos/*.appretention-days: 30- - name: Install FUSE for AppImage processing- if: contains(inputs.platform, 'ubuntu')- run: |- sudo apt-get update- sudo apt-get install -y fuse libfuse2-- - name: Remove libwayland-client.so from AppImage- if: contains(inputs.platform, 'ubuntu')- run: |- # Find the AppImage file- APPIMAGE_PATH=$(find src-tauri/target/${{ steps.build-profile.outputs.profile }}/bundle/appimage -name "*.AppImage" | head -1)-- if [ -n "$APPIMAGE_PATH" ]; then- echo "Processing AppImage: $APPIMAGE_PATH"-- # Make AppImage executable- chmod +x "$APPIMAGE_PATH"-- # Extract AppImage- cd "$(dirname "$APPIMAGE_PATH")"- APPIMAGE_NAME=$(basename "$APPIMAGE_PATH")-- # Extract using the AppImage itself- "./$APPIMAGE_NAME" --appimage-extract-- # Remove libwayland-client.so files- echo "Removing libwayland-client.so files..."- find squashfs-root -name "libwayland-client.so*" -type f -delete-- # List what was removed for verification- echo "Files remaining in lib directories:"- find squashfs-root -name "lib*" -type d | head -5 | while read dir; do- echo "Contents of $dir:"- ls "$dir" | grep -E "(wayland|fuse)" || echo " No wayland/fuse libraries found"- done-- # Co-locate transcribe-cpp's dynamic backends in the AppImage.- # linuxdeploy bundles the NEEDED libtranscribe.so (resolved at build- # time via LD_LIBRARY_PATH) but NOT the dlopen'd ggml backend modules- # that init_backends_default() loads at runtime from libtranscribe's- # own directory — stage those (and backfill the core libs) into- # usr/lib, next to libtranscribe. Fails loudly if libs are missing.- if [ -n "${TRANSCRIBE_LIBDIR:-}" ]; then- bash "$GITHUB_WORKSPACE/scripts/ci/stage-transcribe-libs.sh" \- "$TRANSCRIBE_LIBDIR" "squashfs-root/usr/lib"- else- echo "ERROR: TRANSCRIBE_LIBDIR not set; transcribe-cpp backends would be missing from the AppImage" >&2- exit 1- fi-- # Detect architecture and get appropriate appimagetool- if [[ "$(uname -m)" == "aarch64" ]]; then- APPIMAGETOOL_ARCH="aarch64"- else- APPIMAGETOOL_ARCH="x86_64"- fi-- wget -q "https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-${APPIMAGETOOL_ARCH}.AppImage"- chmod +x "appimagetool-${APPIMAGETOOL_ARCH}.AppImage"-- # Repackage AppImage with no-appstream to avoid warnings. VERSION- # preserves X-AppImage-Version when appimagetool rewrites metadata.- ARCH="${APPIMAGETOOL_ARCH}" VERSION="${{ steps.get-version.outputs.version }}" \- "./appimagetool-${APPIMAGETOOL_ARCH}.AppImage" --no-appstream squashfs-root "$APPIMAGE_NAME"-- # Clean up- rm -rf squashfs-root "appimagetool-${APPIMAGETOOL_ARCH}.AppImage"-- echo "libwayland-client.so removed from AppImage successfully"- else- echo "No AppImage found to process"- fi-- name: Audit Linux package runtime contentsif: contains(inputs.platform, 'ubuntu')shell: bash@@ -696,11 +651,18 @@ jobs:smoke_binary() {local root="$1"local label="$2"+ local vulkan_icd="${3:-}"# Run under a virtual X server: handy initializes GTK on startup even# on the headless --list-devices path, which fails without a display.+ # An AppImage audit supplies Mesa's software ICD so GPU registration+ # is deterministic even on a runner without physical graphics.+ if [ -n "$vulkan_icd" ]; then+ export VK_ICD_FILENAMES="$vulkan_icd"+ fiHANDY_NO_GTK_LAYER_SHELL=1 \LD_LIBRARY_PATH="${root}/usr/lib/Handy:${root}/usr/lib${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}" \- xvfb-run -a "${root}/usr/bin/handy" --list-devices >/tmp/handy-package-smoke.log+ xvfb-run -a "${root}/usr/bin/handy" --list-devices \+ >/tmp/handy-package-smoke.log 2>&1echo "${label} --list-devices smoke passed"}@@ -783,7 +745,35 @@ jobs:find "squashfs-root/usr/lib" -maxdepth 1 -type f >&2exit 1fi- smoke_binary "$(pwd)/squashfs-root" "AppImage"+ require_path "squashfs-root/usr/lib/libggml-vulkan.so" "AppImage ggml Vulkan backend module"++ # These libraries mediate access to the host graphics stack.+ # Shipping build-host copies ahead of the system versions can+ # break Vulkan ICD or Mesa loading on newer distributions.+ for pattern in \+ 'libvulkan.so*' \+ 'libwayland-client.so*'; do+ forbidden="$(find squashfs-root/usr -name "$pattern" -print -quit)"+ if [ -n "$forbidden" ]; then+ echo "ERROR: AppImage bundles host graphics loader: $forbidden" >&2+ exit 1+ fi+ done++ vulkan_icd="$(find /usr/share/vulkan/icd.d -type f -name 'lvp_icd*.json' -print -quit)"+ if [ -z "$vulkan_icd" ]; then+ echo "ERROR: Mesa software Vulkan ICD is unavailable for the AppImage audit" >&2+ exit 1+ fi+ smoke_binary "$(pwd)/squashfs-root" "AppImage" "$vulkan_icd"+ # llvmpipe is intentionally not exposed as a compute device by+ # ggml, but reaching this log proves the module loaded against a+ # usable system Vulkan loader/ICD instead of failing silently.+ if ! grep -q 'load_backend: loaded Vulkan backend' /tmp/handy-package-smoke.log; then+ echo "ERROR: AppImage could not initialize its Vulkan backend with a usable system ICD" >&2+ cat /tmp/handy-package-smoke.log >&2+ exit 1+ fi)rm -rf "$workdir"donediff --git a/src-tauri/src/managers/transcription.rs b/src-tauri/src/managers/transcription.rsindex 6c546d95..bf169c05 100644--- a/src-tauri/src/managers/transcription.rs+++ b/src-tauri/src/managers/transcription.rs@@ -1801,7 +1801,19 @@ fn select_transcribe_backend(setting: TranscribeAcceleratorSetting) -> Backend {{Some(b) => b,None => {- warn!("No GPU backend available for transcribe.cpp; falling back to Auto");+ #[cfg(target_os = "linux")]+ warn!(+ "GPU acceleration was requested, but no transcribe.cpp GPU backend is \+ registered; falling back to Auto (usually CPU). Run with \+ --list-devices to inspect detected devices; VK_LOADER_DEBUG=error can \+ reveal Vulkan loader or driver failures"+ );+ #[cfg(not(target_os = "linux"))]+ warn!(+ "GPU acceleration was requested, but no transcribe.cpp GPU backend is \+ registered; falling back to Auto (usually CPU). Run with \+ --list-devices to inspect detected devices"+ );Backend::Auto}}