Skip to content

fix(scripts): every known flags should be shifted before executing the sentry <foo> command #3831

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
Aug 7, 2025
Merged

fix(scripts): every known flags should be shifted before executing the sentry <foo> command #3831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bb3fbf
fix(scripts): every known flags should be shifted before executing th…
aldy505 Jul 25, 2025
7e10624
Merge branch 'master' into fix/aldy505/scripts-flag-usage
aldy505 Jul 25, 2025
65b47c0
Merge branch 'master' into fix/aldy505/scripts-flag-usage
aldy505 Aug 6, 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
11 changes: 1 addition & 10 deletions scripts/_lib.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,24 +78,15 @@ function restore() {
}

# Needed variables to source error-handling script
MINIMIZE_DOWNTIME="${MINIMIZE_DOWNTIME:-}"
export STOP_TIMEOUT=60

# Save logs in order to send envelope to Sentry
log_file="sentry_${cmd%% *}_log-$(date +%Y-%m-%d_%H-%M-%S).txt"
exec &> >(tee -a "$log_file")
version=""

while (($#)); do
case "$1" in
--report-self-hosted-issues) export REPORT_SELF_HOSTED_ISSUES=1 ;;
--no-report-self-hosted-issues) export REPORT_SELF_HOSTED_ISSUES=0 ;;
*) version=$1 ;;
esac
shift
done

# Source files needed to set up error-handling
source install/_lib.sh
source install/dc-detect-version.sh
source install/detect-platform.sh
source install/error-handling.sh
Expand Down
13 changes: 13 additions & 0 deletions scripts/backup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
#!/usr/bin/env bash
MINIMIZE_DOWNTIME="${MINIMIZE_DOWNTIME:-}"
REPORT_SELF_HOSTED_ISSUES="${REPORT_SELF_HOSTED_ISSUES:-}"

while (($#)); do
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not just add --minimize-downtime to the scripts/_lib.sh? That way we don't need to maintain 3 areas of similar logic

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because it won't be shifted by Bash and would be included on the Docker command. The problem was this:

cmd="backup $1"
source scripts/_lib.sh
$cmd

If you do ./scripts/backup.sh --minimize-downtime, the resulting cmd would be backup --minimize-downtime. If you want to add another known flag for the backup script, like --silent, you would have to do backup --sillent --minimize-downtime. It will be hard to make users aware that they are not supposed to do backup --minimize-downtime --silent.

So if you omit those known flags before passing the command, it will work as expected. This also would open the possibility of doing cmd="backup $@" (I don't know if this correct, but I hope you get the right idea) to allow more than one parameter.

case "$1" in
--report-self-hosted-issues) REPORT_SELF_HOSTED_ISSUES=1 ;;
--no-report-self-hosted-issues) REPORT_SELF_HOSTED_ISSUES=0 ;;
--minimize-downtime) MINIMIZE_DOWNTIME=1 ;;
*) version=$1 ;;
esac
shift
done

cmd="backup $1"
source scripts/_lib.sh
$cmd
13 changes: 13 additions & 0 deletions scripts/reset.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
#!/usr/bin/env bash
MINIMIZE_DOWNTIME="${MINIMIZE_DOWNTIME:-}"
REPORT_SELF_HOSTED_ISSUES="${REPORT_SELF_HOSTED_ISSUES:-}"

while (($#)); do
case "$1" in
--report-self-hosted-issues) REPORT_SELF_HOSTED_ISSUES=1 ;;
--no-report-self-hosted-issues) REPORT_SELF_HOSTED_ISSUES=0 ;;
--minimize-downtime) MINIMIZE_DOWNTIME=1 ;;
*) version=$1 ;;
esac
shift
done

cmd=reset
source scripts/_lib.sh
$cmd
13 changes: 13 additions & 0 deletions scripts/restore.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
#!/usr/bin/env bash
MINIMIZE_DOWNTIME="${MINIMIZE_DOWNTIME:-}"
REPORT_SELF_HOSTED_ISSUES="${REPORT_SELF_HOSTED_ISSUES:-}"

while (($#)); do
case "$1" in
--report-self-hosted-issues) REPORT_SELF_HOSTED_ISSUES=1 ;;
--no-report-self-hosted-issues) REPORT_SELF_HOSTED_ISSUES=0 ;;
--minimize-downtime) MINIMIZE_DOWNTIME=1 ;;
*) version=$1 ;;
esac
shift
done

cmd="restore $1"
source scripts/_lib.sh

Expand Down
Loading