Skip to content

fix(api): redirect benign pnpm postinstall warning to log file #1290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 28, 2025
Merged

fix(api): redirect benign pnpm postinstall warning to log file #1290

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da342af
chore(api): approve postinstall from deps
pujitm Mar 28, 2025
3380148
Revert "chore(api): approve postinstall from deps"
pujitm Mar 28, 2025
38239ac
intercept and log ignored build scripts warning in prod
pujitm Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid-api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ pnpm_store_dir="/usr/.pnpm-store"

# Placeholder functions for plugin installation/uninstallation
install() {
true;
true
}
uninstall() {
true;
true
}

# Creates a backup of the global pnpm store directory
Expand Down Expand Up @@ -81,7 +81,7 @@ restore_pnpm_store() {

# Require 1.5x the backup size for safe extraction
local required_space=$((backup_size + (backup_size / 2)))

if [ "$dest_space" -lt "$required_space" ]; then
echo "Error: Insufficient disk space in destination. Need at least $((required_space / 1024 / 1024))MB, have $((dest_space / 1024 / 1024))MB"
return 1
Expand All @@ -91,7 +91,7 @@ restore_pnpm_store() {
# Remove existing store directory if it exists and ensure its parent directory exists
rm -rf "$pnpm_store_dir"
mkdir -p "$(dirname "$pnpm_store_dir")"

# Extract directly to final location
if ! tar -xJf "$backup_file" -C "$(dirname "$pnpm_store_dir")" --preserve-permissions; then
echo "Error: Failed to extract backup to final location."
Expand All @@ -102,6 +102,24 @@ restore_pnpm_store() {
echo "pnpm store restored successfully."
}

# Executes pnpm install with production dependencies and offline preference
# Captures and logs build script warnings to a dedicated log file at /var/log/unraid-api/build-scripts.log
# Args: none
# Output: Streams install progress and logs build script warnings
run_pnpm_install() {
local log_file="/var/log/unraid-api/build-scripts.log"
stdbuf -oL pnpm install --prod --prefer-offline 2>&1 | while IFS= read -r line; do
if echo "$line" | grep -q "Ignored build scripts:"; then
mkdir -p "$(dirname "$log_file")"
echo "Note: This warning is expected. Build scripts are intentionally ignored for security and performance reasons." > "$log_file"
echo "$line" >> "$log_file"
echo "Build scripts completed. See $log_file for details."
else
echo "$line"
fi
done
}

# Installs production dependencies for the unraid-api using pnpm. Prefers offline mode.
# Uses the api_base_directory variable or defaults to /usr/local/unraid-api
# Returns:
Expand All @@ -123,10 +141,9 @@ pnpm_install_unraid_api() {
echo "Executing 'pnpm install' in $unraid_api_dir"
rm -rf /usr/local/unraid-api/node_modules
# Run pnpm install in a subshell to prevent changing the current working directory of the script
( cd "$unraid_api_dir" && pnpm install --prod --prefer-offline )
(cd "$unraid_api_dir" && run_pnpm_install)
}


case "$1" in
'install')
install "$2"
Expand Down
Loading