Skip to content
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.

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

[cuebot] Automatically replace --log.frame-log-root with the new flag. #1203

Merged
merged 4 commits into from
Dec 6, 2022

Conversation

bcipriano
Copy link
Collaborator

The log.frame-log-root setting has been replaced with OS-specific flags e.g. log.frame-log-root.default_os.

If users don't switch to using the new flag, this can cause an issue:

  • If the new flag isn't provided, it will be set with a default value of /shots.
  • If the old flag is provided, it will be silently ignored.
    The resulting behavior is that RQD will try to write log files to a subdirectory of /shots. This is unexpected and potentially dangerous as it creates filesystem changes.

It appears we can't support both old and new flags at the same time, likely because the new flags use log.frame-log-root.* as a base.

The solution I've found is contained here. We intercept argv and check it for the removed flag. If it's present, and the new flags are not, we log a warning and swap in the provided value into the closest match, which is log.frame-log-root.default_os.

This logic can be removed in the future once users have been notified and had a chance to switch to the new flags.

@bcipriano
Copy link
Collaborator Author

@DiegoTavares What do you think, should we go ahead and rename the newer log settings? If we're going to do that, no need to merge this one I think.

@bcipriano
Copy link
Collaborator Author

@DiegoTavares Ping -- I think you expressed interest in renaming these new flags.

@DiegoTavares
Copy link
Collaborator

I'm okay with merging this version in.

@bcipriano bcipriano marked this pull request as ready for review December 6, 2022 17:19
@bcipriano bcipriano merged commit 35aa461 into AcademySoftwareFoundation:master Dec 6, 2022
@bcipriano bcipriano deleted the log-root-flag branch December 6, 2022 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants