sarman/tftsr-devops_investigation
1
1
Fork 0
Code Issues 4 Pull Requests Actions 34 Packages Projects 3 Releases 6 Wiki Activity

fix/libsodium-build-failures #102

Merged
sarman merged 6 commits from fix/libsodium-build-failures into beta 2026-06-14 09:21:52 +00:00
Conversation 3 Commits 6 Files Changed 4 +376 -143
4 changed files with 376 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitea/workflows/auto-tag.yml
View File

@ -344,6 +344,7 @@ jobs:
- name: Build - name: Build
env: env:
APPIMAGE_EXTRACT_AND_RUN: "1" APPIMAGE_EXTRACT_AND_RUN: "1"
SODIUM_USE_PKG_CONFIG: "1"
run: | run: |
npm ci --legacy-peer-deps npm ci --legacy-peer-deps
CI=true npx tauri build --target x86_64-unknown-linux-gnu CI=true npx tauri build --target x86_64-unknown-linux-gnu
@ -446,6 +447,7 @@ jobs:
OPENSSL_STATIC: "1" OPENSSL_STATIC: "1"
SODIUM_LIB_DIR: /usr/x86_64-w64-mingw32/lib SODIUM_LIB_DIR: /usr/x86_64-w64-mingw32/lib
SODIUM_STATIC: "1" SODIUM_STATIC: "1"
SODIUM_USE_PKG_CONFIG: "no"
run: | run: |
npm ci --legacy-peer-deps npm ci --legacy-peer-deps
CI=true npx tauri build --target x86_64-pc-windows-gnu CI=true npx tauri build --target x86_64-pc-windows-gnu
@ -631,6 +633,7 @@ jobs:
PKG_CONFIG_SYSROOT_DIR: /usr/aarch64-linux-gnu PKG_CONFIG_SYSROOT_DIR: /usr/aarch64-linux-gnu
PKG_CONFIG_PATH: /usr/lib/aarch64-linux-gnu/pkgconfig PKG_CONFIG_PATH: /usr/lib/aarch64-linux-gnu/pkgconfig
PKG_CONFIG_ALLOW_CROSS: "1" PKG_CONFIG_ALLOW_CROSS: "1"
SODIUM_USE_PKG_CONFIG: "1"
OPENSSL_NO_VENDOR: "0" OPENSSL_NO_VENDOR: "0"
OPENSSL_STATIC: "1" OPENSSL_STATIC: "1"
APPIMAGE_EXTRACT_AND_RUN: "1" APPIMAGE_EXTRACT_AND_RUN: "1"

218
LIBSODIUM_BUILD_FIX.md
View File

@ -1,181 +1,113 @@
# libsodium Build Failure Fix # libsodium pkg-config Detection Fix
> **Scope:** This document describes **only the changes in this PR**. For historical context including prior related work, see `LIBSODIUM_BUILD_HISTORY.md`.
## Description ## Description
This fix resolves build failures across all CI/CD build targets (Linux amd64/arm64, Windows cross-compilation) caused by missing libsodium library dependencies. The application uses `tauri-plugin-stronghold` which transitively depends on `iota-crypto` → `libsodium-sys-stable`, requiring libsodium to be available at build time. This PR fixes libsodium build failures by adding explicit `SODIUM_USE_PKG_CONFIG` environment variables to CI workflows. The Docker images already have libsodium packages installed, but the build script wasn't being told **how** to find them.
**Build failures observed:** **Build failures observed:**
1. **Linux amd64/arm64**: `libsodium not found via pkg-config or vcpkg` 1. **Linux amd64/arm64**: `libsodium not found via pkg-config or vcpkg` (despite `libsodium-dev` + `pkg-config` being installed in Docker images)
2. **Windows cross-build**: `SODIUM_LIB_DIR is incompatible with SODIUM_USE_PKG_CONFIG` 2. **Windows cross-build**: `SODIUM_LIB_DIR is incompatible with SODIUM_USE_PKG_CONFIG` (conflicting detection methods)
## Root Cause ## Root Cause
- **Linux builds**: Docker images lacked `libsodium-dev` package The `libsodium-sys-stable` crate's `build.rs` checks environment variables in this precedence:
- **Windows cross-build**: Missing explicit `SODIUM_LIB_DIR` environment variable despite pre-built libsodium in the cross-compiler image
## Acceptance Criteria 1. If `SODIUM_LIB_DIR` is set → use explicit path (incompatible with `SODIUM_USE_PKG_CONFIG` mode)
2. If `SODIUM_USE_PKG_CONFIG` ≠ `"no"` (string equality) → try pkg-config detection
3. Fall back to vcpkg or fail with error
- [x] All three Docker build images updated with libsodium dependencies **Note on string values:** The build script performs string comparison, so `"no"` disables pkg-config while any other value (including `"1"`, `"yes"`, or empty) enables it. YAML quotes preserve these as strings.
- [x] Windows cross-build CI configuration includes proper `SODIUM_LIB_DIR` and `SODIUM_STATIC` environment variables
- [x] New test added to verify libsodium linking via stronghold dependency chain
- [x] All existing tests (416 Rust + 386 TypeScript = 802 total) pass without regression
- [x] All linting checks pass (cargo fmt, clippy, eslint, tsc)
- [x] Changes follow TDD methodology with test-first approach
## Work Implemented **What went wrong:**
### 1. Docker Image Updates - **Linux**: Had the packages installed but wasn't explicitly told to use pkg-config → fell through to vcpkg → failed
- **Windows**: `SODIUM_LIB_DIR` was already set, but pkg-config was also available → conflicting modes → build script error
**`.docker/Dockerfile.linux-amd64`** ## Changes in This PR
- Added `libsodium-dev` to apt package installation list
**`.docker/Dockerfile.linux-arm64`** ### `.gitea/workflows/auto-tag.yml`
- Added `libsodium-dev:arm64` to multiarch package installation list
### 2. CI/CD Pipeline Fix #### Linux amd64 build (line ~347)
```yaml
**`.gitea/workflows/auto-tag.yml`** env:
- Added `SODIUM_LIB_DIR: /usr/x86_64-w64-mingw32/lib` to Windows build environment SODIUM_USE_PKG_CONFIG: "1" # NEW: Force pkg-config detection
- Added `SODIUM_STATIC: "1"` to ensure static linking of pre-built libsodium
### 3. Test Coverage
**`src-tauri/src/state.rs`**
- Added comprehensive test module with 3 tests:
- `test_app_settings_default`: Verifies default settings initialization
- `test_get_app_data_dir_returns_some`: Ensures data directory resolution
- `test_libsodium_linking`: **Smoke test that verifies libsodium linking through the stronghold dependency chain**
The smoke test is critical because it ensures the entire dependency chain compiles and links correctly. If libsodium were misconfigured, this test would fail at compile/link time, not runtime.
### 4. Code Quality
- All code follows Rust 2021 edition best practices
- Comprehensive inline documentation added to test functions
- Formatting verified with `cargo fmt`
- Zero clippy warnings
- Zero ESLint warnings
- Zero TypeScript type errors
## Testing Needed
### Local Testing (Completed ✓)
- [x] `cargo test --manifest-path src-tauri/Cargo.toml` → 416 tests passed
- [x] `npm run test:run` → 386 tests passed
- [x] `cargo fmt --check` → Passed
- [x] `cargo clippy -- -D warnings` → Zero warnings
- [x] `npx eslint . --max-warnings 0` → Zero warnings
- [x] `npx tsc --noEmit` → Zero errors
### CI/CD Testing (Required)
The following must be verified after merging to beta and triggering CI builds:
1. **Linux amd64 build** (`build-linux-amd64` job)
- [ ] Build completes without `libsodium not found` error
- [ ] `.deb` and `.rpm` artifacts generated successfully
- [ ] Artifacts uploaded to Gitea release
2. **Linux arm64 build** (`build-linux-arm64` job)
- [ ] Cross-compilation completes with arm64 libsodium-dev
- [ ] `.deb` and `.rpm` artifacts generated successfully
- [ ] Artifacts uploaded to Gitea release
3. **Windows amd64 build** (`build-windows-amd64` job)
- [ ] Build completes without env var conflict error
- [ ] `.exe` and `.msi` artifacts generated successfully
- [ ] Artifacts uploaded to Gitea release
4. **macOS arm64 build** (`build-macos-arm64` job)
- [ ] Build continues to work (no libsodium changes needed for macOS)
- [ ] `.dmg` artifact generated successfully
### Verification Steps
After PR merge and CI completion:
1. Navigate to https://gogs.tftsr.com/sarman/tftsr-devops_investigation/actions
2. Verify all 4 build jobs complete with success status
3. Check https://gogs.tftsr.com/sarman/tftsr-devops_investigation/releases for artifacts
4. Download and test artifacts on respective platforms:
- Linux: Install `.deb`/`.rpm` and verify app launches
- Windows: Install `.msi` and verify app launches
- macOS: Mount `.dmg` and verify app launches
## Files Changed
```
.docker/Dockerfile.linux-amd64 | 1 +
.docker/Dockerfile.linux-arm64 | 1 +
.gitea/workflows/auto-tag.yml | 2 +
src-tauri/src/state.rs | 46 +++++++++++++++++++++++++++++++
────────────────────────────────────────────────
4 files changed, 50 insertions(+)
``` ```
## Technical Details **Why:** Ensures `libsodium-sys-stable` uses the installed `libsodium-dev` package via pkg-config.
### Dependency Chain #### Linux arm64 build (line ~633)
``` ```yaml
trcaa (main app) env:
└─ tauri-plugin-stronghold v2 SODIUM_USE_PKG_CONFIG: "1" # NEW: Force pkg-config for cross-compile
└─ iota-crypto v0.23.2
└─ libsodium-sys-stable v1.24.0
└─ libsodium (system library)
``` ```
### Build System Integration **Why:** Same as amd64 - force pkg-config to find the arm64 libsodium package.
**libsodium-sys-stable build.rs resolution order:** #### Windows cross-compile build (line ~448)
1. Check `SODIUM_LIB_DIR` env var (Windows cross-build uses this) ```yaml
2. Try `pkg-config` to find system libsodium (Linux native uses this) env:
3. Try `vcpkg` (Windows native uses this) SODIUM_LIB_DIR: /usr/x86_64-w64-mingw32/lib # Already present (see HISTORY doc)
4. Fail if none found SODIUM_STATIC: "1" # Already present (see HISTORY doc)
SODIUM_USE_PKG_CONFIG: "no" # NEW in this PR: Disable pkg-config
```
**Our solution:** **Why:** Prevents conflict between explicit path mode (`SODIUM_LIB_DIR`) and pkg-config detection. Windows uses pre-built libsodium from Dockerfile, not system packages.
- Linux: Install `libsodium-dev` → pkg-config finds it automatically
- Windows cross: Set `SODIUM_LIB_DIR=/usr/x86_64-w64-mingw32/lib` → points to pre-built libsodium
- macOS: Already has libsodium via Homebrew (no changes needed)
## Risk Assessment **Only the `SODIUM_USE_PKG_CONFIG: "no"` line is new in this PR** - the other env vars were already present.
**Risk Level:** Low ### Documentation
**Reasoning:** **Files changed in this PR:**
- Changes are additive (adding packages, env vars, tests) - `LIBSODIUM_BUILD_FIX.md` (this file) - Documents env var strategy for pkg-config detection
- No modifications to existing application logic - `LIBSODIUM_PKG_CONFIG_FIX.md` - Alternative/detailed version of this doc
- All 802 existing tests pass without regression - `LIBSODIUM_BUILD_HISTORY.md` - Complete fix history across PR #101 and PR #102
- Docker image changes only affect CI builds, not production deployment
- Smoke test ensures the fix works at compile/link time, not just runtime
**Rollback Plan:** Explains:
If issues arise, revert the 4 changed files and rebuild the Docker images with the previous tags. - Platform-specific environment variable strategy
- Build script precedence order
- Rationale for each approach
## Performance Impact ## Strategy Summary
**Build Time:** Negligible increase (~5 seconds) to install libsodium-dev packages in Docker images. | Platform | Method | Env Vars | Reason |
|----------|--------|----------|--------|
| Linux amd64 | pkg-config | `SODIUM_USE_PKG_CONFIG=1` | Has `libsodium-dev` + `pkg-config` installed |
| Linux arm64 | pkg-config | `SODIUM_USE_PKG_CONFIG=1` | Has `libsodium-dev:arm64` + `pkg-config` |
| Windows | explicit path | `SODIUM_LIB_DIR=...` + `SODIUM_USE_PKG_CONFIG=no` | Pre-built lib in known location, disable pkg-config |
**Runtime:** Zero impact. Libsodium is already statically linked in release builds via `OPENSSL_STATIC=1` and `SODIUM_STATIC=1`. ## Testing
## Security Considerations This PR only modifies CI workflow environment variables. Testing occurs via CI pipeline:
- Using system-provided `libsodium-dev` packages from official Debian/Ubuntu repositories - [ ] Linux amd64 build succeeds with pkg-config detection
- Version pinned to distribution-stable releases (Ubuntu 22.04 for arm64, Rust 1.88 Debian slim for amd64) - [ ] Linux arm64 build succeeds with cross-compile pkg-config
- Windows uses manually built libsodium 1.0.20 from official release tarball - [ ] Windows build succeeds with explicit lib path (no pkg-config conflict)
- Static linking ensures no runtime dependency vulnerabilities - [ ] All platforms produce valid `.deb`, `.rpm`, `.exe`, `.msi` artifacts
## Related Documentation ## Acceptance Criteria (This PR Only)
- **Upstream Issue:** libsodium-sys-stable build script requires libsodium at build time - [x] Added `SODIUM_USE_PKG_CONFIG` env vars to all three CI build targets
- **Tauri Plugin Stronghold:** https://v2.tauri.app/plugin/stronghold/ - [x] Documentation accurately reflects only changes in this PR
- **libsodium:** https://libsodium.gitbook.io/doc/ - [ ] Linux amd64 CI build succeeds
- [ ] Linux arm64 CI build succeeds
- [ ] Windows CI build succeeds
- [ ] All platforms produce valid artifacts
## Approval Notes ## Files Changed in This PR
This fix is required to unblock all CI/CD builds. Without it, no releases can be generated for any platform. 1. **`.gitea/workflows/auto-tag.yml`**
- Linux amd64 build: Added `SODIUM_USE_PKG_CONFIG: "1"`
- Linux arm64 build: Added `SODIUM_USE_PKG_CONFIG: "1"`
- Windows build: Added `SODIUM_USE_PKG_CONFIG: "no"`
--- 2. **Documentation only**
- `LIBSODIUM_BUILD_FIX.md` (this file)
- `LIBSODIUM_PKG_CONFIG_FIX.md` (detailed version)
- `LIBSODIUM_BUILD_HISTORY.md` (historical context - see for relationship to PR #101)
**Branch:** `fix/libsodium-build-failures` **No Dockerfile changes** - Docker images already have libsodium packages from prior work.
**Base Branch:** `beta` **No application code changes** - This PR only adds environment variables to CI workflow.
**Target Merge:** `beta` → `master` (via standard PR workflow) **No test changes** - libsodium linking is already validated by existing tests.

208
LIBSODIUM_BUILD_HISTORY.md Normal file
View File

@ -0,0 +1,208 @@
# libsodium Build Failure Fix (Complete Solution)
> **Note:** This document describes the complete fix implemented across **two PRs**:
> - **PR #101**: Docker package additions + initial Windows env vars + test coverage
> - **PR #102**: pkg-config detection control (see `LIBSODIUM_PKG_CONFIG_FIX.md` for PR #102 details)
## Description
This fix resolves build failures across all CI/CD build targets (Linux amd64/arm64, Windows cross-compilation) caused by missing libsodium library dependencies. The application uses `tauri-plugin-stronghold` which transitively depends on `iota-crypto` → `libsodium-sys-stable`, requiring libsodium to be available at build time.
**Build failures observed:**
1. **Linux amd64/arm64**: `libsodium not found via pkg-config or vcpkg`
2. **Windows cross-build**: `SODIUM_LIB_DIR is incompatible with SODIUM_USE_PKG_CONFIG`
## Root Cause (Two-Part Issue)
**Part 1 (Fixed in PR #101):**
- **Linux builds**: Docker images lacked `libsodium-dev` package
- **Windows cross-build**: Missing explicit `SODIUM_LIB_DIR` environment variable despite pre-built libsodium in the cross-compiler image
**Part 2 (Fixed in PR #102):**
- **Linux builds**: `libsodium-sys-stable` build script wasn't explicitly told to use pkg-config
- **Windows cross-build**: Setting `SODIUM_LIB_DIR` without disabling pkg-config caused detection conflict
## Acceptance Criteria
- [x] All three Docker build images updated with libsodium dependencies
- [x] Windows cross-build CI configuration includes proper `SODIUM_LIB_DIR` and `SODIUM_STATIC` environment variables
- [x] New test added to verify libsodium linking via stronghold dependency chain
- [x] All existing tests (416 Rust + 386 TypeScript = 802 total) pass without regression
- [x] All linting checks pass (cargo fmt, clippy, eslint, tsc)
- [x] Changes follow TDD methodology with test-first approach
## Work Implemented
### 1. Docker Image Updates (PR #101)
**`.docker/Dockerfile.linux-amd64`**
- Added `libsodium-dev` to apt package installation list
**`.docker/Dockerfile.linux-arm64`**
- Added `libsodium-dev:arm64` to multiarch package installation list
### 2. CI/CD Pipeline Fix
**`.gitea/workflows/auto-tag.yml`**
**Linux amd64 build:**
- **PR #102:** Added `SODIUM_USE_PKG_CONFIG: "1"` to force pkg-config detection of libsodium
**Linux arm64 build:**
- **PR #102:** Added `SODIUM_USE_PKG_CONFIG: "1"` to force pkg-config detection for cross-compiled libsodium
**Windows cross-compile build:**
- **PR #101:** Added `SODIUM_LIB_DIR: /usr/x86_64-w64-mingw32/lib` to point to pre-built libsodium
- **PR #101:** Added `SODIUM_STATIC: "1"` to ensure static linking of pre-built libsodium
- **PR #102:** Added `SODIUM_USE_PKG_CONFIG: "no"` to prevent conflict with explicit SODIUM_LIB_DIR
**Rationale:**
`libsodium-sys-stable`'s build.rs checks environment variables in this order:
1. If `SODIUM_LIB_DIR` is set → use explicit path (incompatible with `SODIUM_USE_PKG_CONFIG`)
2. If `SODIUM_USE_PKG_CONFIG` is not "no" → try pkg-config detection
3. Fall back to vcpkg or fail
Linux builds have `libsodium-dev` + `pkg-config` installed, so we force pkg-config mode.
Windows has pre-compiled libsodium at a known path, so we use explicit path mode and disable pkg-config.
### 3. Test Coverage (PR #101)
**`src-tauri/src/state.rs`**
- Added comprehensive test module with 3 tests:
- `test_app_settings_default`: Verifies default settings initialization
- `test_get_app_data_dir_returns_some`: Ensures data directory resolution
- `test_libsodium_linking`: **Smoke test that verifies libsodium linking through the stronghold dependency chain**
The smoke test is critical because it ensures the entire dependency chain compiles and links correctly. If libsodium were misconfigured, this test would fail at compile/link time, not runtime.
### 4. Code Quality
- All code follows Rust 2021 edition best practices
- Comprehensive inline documentation added to test functions
- Formatting verified with `cargo fmt`
- Zero clippy warnings
- Zero ESLint warnings
- Zero TypeScript type errors
## Testing Needed
### Local Testing (Completed ✓)
- [x] `cargo test --manifest-path src-tauri/Cargo.toml` → 416 tests passed
- [x] `npm run test:run` → 386 tests passed
- [x] `cargo fmt --check` → Passed
- [x] `cargo clippy -- -D warnings` → Zero warnings
- [x] `npx eslint . --max-warnings 0` → Zero warnings
- [x] `npx tsc --noEmit` → Zero errors
### CI/CD Testing (Required)
The following must be verified after merging to beta and triggering CI builds:
1. **Linux amd64 build** (`build-linux-amd64` job)
- [ ] Build completes without `libsodium not found` error
- [ ] `.deb` and `.rpm` artifacts generated successfully
- [ ] Artifacts uploaded to Gitea release
2. **Linux arm64 build** (`build-linux-arm64` job)
- [ ] Cross-compilation completes with arm64 libsodium-dev
- [ ] `.deb` and `.rpm` artifacts generated successfully
- [ ] Artifacts uploaded to Gitea release
3. **Windows amd64 build** (`build-windows-amd64` job)
- [ ] Build completes without env var conflict error
- [ ] `.exe` and `.msi` artifacts generated successfully
- [ ] Artifacts uploaded to Gitea release
4. **macOS arm64 build** (`build-macos-arm64` job)
- [ ] Build continues to work (no libsodium changes needed for macOS)
- [ ] `.dmg` artifact generated successfully
### Verification Steps
After PR merge and CI completion:
1. Navigate to https://gogs.tftsr.com/sarman/tftsr-devops_investigation/actions
2. Verify all 4 build jobs complete with success status
3. Check https://gogs.tftsr.com/sarman/tftsr-devops_investigation/releases for artifacts
4. Download and test artifacts on respective platforms:
- Linux: Install `.deb`/`.rpm` and verify app launches
- Windows: Install `.msi` and verify app launches
- macOS: Mount `.dmg` and verify app launches
## Files Changed
```
.docker/Dockerfile.linux-amd64 | 1 +
.docker/Dockerfile.linux-arm64 | 1 +
.gitea/workflows/auto-tag.yml | 2 +
src-tauri/src/state.rs | 46 +++++++++++++++++++++++++++++++
────────────────────────────────────────────────
4 files changed, 50 insertions(+)
```
## Technical Details
### Dependency Chain
```
trcaa (main app)
└─ tauri-plugin-stronghold v2
└─ iota-crypto v0.23.2
└─ libsodium-sys-stable v1.24.0
└─ libsodium (system library)
```
### Build System Integration
**libsodium-sys-stable build.rs resolution order:**
1. Check `SODIUM_LIB_DIR` env var (Windows cross-build uses this)
2. Try `pkg-config` to find system libsodium (Linux native uses this)
3. Try `vcpkg` (Windows native uses this)
4. Fail if none found
**Our solution:**
- Linux: Install `libsodium-dev` → pkg-config finds it automatically
- Windows cross: Set `SODIUM_LIB_DIR=/usr/x86_64-w64-mingw32/lib` → points to pre-built libsodium
- macOS: Already has libsodium via Homebrew (no changes needed)
## Risk Assessment
**Risk Level:** Low
**Reasoning:**
- Changes are additive (adding packages, env vars, tests)
- No modifications to existing application logic
- All 802 existing tests pass without regression
- Docker image changes only affect CI builds, not production deployment
- Smoke test ensures the fix works at compile/link time, not just runtime
**Rollback Plan:**
If issues arise, revert the 4 changed files and rebuild the Docker images with the previous tags.
## Performance Impact
**Build Time:** Negligible increase (~5 seconds) to install libsodium-dev packages in Docker images.
**Runtime:** Zero impact. Libsodium is already statically linked in release builds via `OPENSSL_STATIC=1` and `SODIUM_STATIC=1`.
## Security Considerations
- Using system-provided `libsodium-dev` packages from official Debian/Ubuntu repositories
- Version pinned to distribution-stable releases (Ubuntu 22.04 for arm64, Rust 1.88 Debian slim for amd64)
- Windows uses manually built libsodium 1.0.20 from official release tarball
- Static linking ensures no runtime dependency vulnerabilities
## Related Documentation
- **Upstream Issue:** libsodium-sys-stable build script requires libsodium at build time
- **Tauri Plugin Stronghold:** https://v2.tauri.app/plugin/stronghold/
- **libsodium:** https://libsodium.gitbook.io/doc/
## Approval Notes
This fix is required to unblock all CI/CD builds. Without it, no releases can be generated for any platform.
---
**Branch:** `fix/libsodium-build-failures`
**Base Branch:** `beta`
**Target Merge:** `beta` → `master` (via standard PR workflow)

90
LIBSODIUM_PKG_CONFIG_FIX.md Normal file
View File

@ -0,0 +1,90 @@
# libsodium pkg-config Detection Fix
## Description
This PR fixes libsodium build failures that persisted after adding `libsodium-dev` packages to Docker images (PR #101). The issue was that `libsodium-sys-stable`'s build script wasn't being explicitly told **how** to find libsodium.
**Remaining build failures after PR #101:**
1. **Linux amd64/arm64**: `libsodium not found via pkg-config or vcpkg` (despite `libsodium-dev` + `pkg-config` being installed)
2. **Windows cross-build**: `SODIUM_LIB_DIR is incompatible with SODIUM_USE_PKG_CONFIG` (conflicting detection methods)
## Root Cause
The `libsodium-sys-stable` crate's `build.rs` checks environment variables in this precedence:
1. If `SODIUM_LIB_DIR` is set → use explicit path (incompatible with `SODIUM_USE_PKG_CONFIG` mode)
2. If `SODIUM_USE_PKG_CONFIG` ≠ "no" → try pkg-config detection
3. Fall back to vcpkg or fail with error
**What went wrong:**
- **Linux**: Had the packages installed but wasn't explicitly told to use pkg-config → fell through to vcpkg → failed
- **Windows**: Set `SODIUM_LIB_DIR` (from previous PR) but also had pkg-config available → conflicting modes → build script error
## Changes in This PR
### `.gitea/workflows/auto-tag.yml`
#### Linux amd64 build (line ~347)
```yaml
env:
SODIUM_USE_PKG_CONFIG: "1" # NEW: Force pkg-config detection
```
**Why:** Ensures `libsodium-sys-stable` uses the installed `libsodium-dev` package via pkg-config.
#### Linux arm64 build (line ~633)
```yaml
env:
SODIUM_USE_PKG_CONFIG: "1" # NEW: Force pkg-config for cross-compile
```
**Why:** Same as amd64 - force pkg-config to find the arm64 libsodium package.
#### Windows cross-compile build (line ~448)
```yaml
env:
SODIUM_LIB_DIR: /usr/x86_64-w64-mingw32/lib # Already present from PR #101
SODIUM_STATIC: "1" # Already present from PR #101
SODIUM_USE_PKG_CONFIG: "no" # NEW: Disable pkg-config
```
**Why:** Prevents conflict between explicit path mode (`SODIUM_LIB_DIR`) and pkg-config detection. Windows uses pre-built libsodium from Dockerfile, not system packages.
### `LIBSODIUM_BUILD_FIX.md`
Updated documentation section 2 (CI/CD Pipeline Fix) to explain:
- Platform-specific environment variable strategy
- Build script precedence order
- Rationale for each approach
## Strategy Summary
| Platform | Method | Env Vars | Reason |
|----------|--------|----------|--------|
| Linux amd64 | pkg-config | `SODIUM_USE_PKG_CONFIG=1` | Has `libsodium-dev` + `pkg-config` installed |
| Linux arm64 | pkg-config | `SODIUM_USE_PKG_CONFIG=1` | Has `libsodium-dev:arm64` + `pkg-config` |
| Windows | explicit path | `SODIUM_LIB_DIR=...` + `SODIUM_USE_PKG_CONFIG=no` | Pre-built lib in known location, disable pkg-config |
## Testing
This PR only modifies CI workflow environment variables. Testing occurs via CI pipeline:
- [ ] Linux amd64 build succeeds with pkg-config detection
- [ ] Linux arm64 build succeeds with cross-compile pkg-config
- [ ] Windows build succeeds with explicit lib path (no pkg-config conflict)
- [ ] All platforms produce valid `.deb`, `.rpm`, `.exe`, `.msi` artifacts
## Relationship to PR #101
**PR #101** (already merged):
- Added `libsodium-dev` to Linux Docker images
- Added `SODIUM_LIB_DIR` + `SODIUM_STATIC` to Windows workflow
- Added smoke test in `src-tauri/src/state.rs`
**This PR** (new):
- Adds `SODIUM_USE_PKG_CONFIG` env vars to tell build script **how** to find libsodium
- Fixes detection failures that persisted after package installation
Both PRs together form the complete fix.