Print RPM messages to the user #1728
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, RPM log messages are written directly to the log file. The new `extract_rpm_logs_buffer()` method allows libdnf5 to retrieve log messages emitted since the last method call and handle them. This will be used in RPM transaction callbacks to display RPM logs to the user.
Adds new public API to retrieve recent RPM log messages. The setter is only used internally and thus is private.
m-blaha
force-pushed
the
mblaha/rpm-logs
branch
from
3d2c9a0 to
e8f40f7
Compare
evan-goode
approved these changes
Oct 1, 2024
libdnf5/rpm/transaction.hpp
Outdated
| @@ -321,6 +321,10 @@ class Transaction { | |||
| /// @param file_path new file path | |||
| void set_script_out_file(const std::string & file_path); | |||
|
|
|||
| /// Retrieve recently emitted rpm log messages. After the method is called, | |||
| /// the stored rpm log messages are cleared. | |||
| std::vector<std::string> get_rpm_messages(); | |||
There was a problem hiding this comment.
Maybe this should be called something other than get_rpm_messages since it mutates the object. I guess it is not marked const so maybe that is enough. But what about calling it extract_rpm_messages or something?
There was a problem hiding this comment.
Maybe "pop" or "dequeue" would make the behavior clearer (the latter is annoying to type 😅 )
There was a problem hiding this comment.
Thanks guys, I'll go with extract which is consistent with what RpmLogGuard has.
At the end of each RPM transaction "block" (before the transaction_stop, (un)install_stop, unpack_error, and script_stop callbacks are triggered), the captured RPM log messages are stored in the base.Transaction object, making them accessible for transaction callbacks to handle.
Change the context.script_output_to_progress() to return the number of lines actually printed.
- In case of an error, do not print the "Stop scriptlet" message, as it's redundant and always followed by the "Error in scriptlet" message. - For better code clarity, concentrate all scriptlet status printing in the `script_stop()` callback, leaving `script_error()` empty. - Drop the "return code XX" part of the message. The return code is only used to distinguish between success, non-critical errors, and fatal errors, which are already indicated by the existing messages. - Even successful scriptlet executions may produce important output. Always forward the scriptlet output to the user.
In the end callback of each RPM transaction section, print all RPM log messages to the user.
Some RPM transaction callback functionality (e.g. reporting RPM logs and scriptlet outputs) depends on the current transaction being set in the context.
m-blaha
force-pushed
the
mblaha/rpm-logs
branch
from
e8f40f7 to
e43ac6c
Compare
|
The F39 tests are failing in the CI due to https://bugzilla.redhat.com/show_bug.cgi?id=2315859, but they pass locally (after rebasing to main). Merging. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The RPM messages contain vital information for debugging RPM transaction.
Currently are these messages only written to the dnf5.log file. This patch
also prints them to the user during the transaction execution.
Resolves: #1710
Related: https://bugzilla.redhat.com/show_bug.cgi?id=2312906