Make @nix json structured build log parsing warn instead of fail #11921
+84
−48
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
roberth
added
bug
derivation-build
github-actions
bot
added
the
with-tests
roberth
added
backport 2.24-maintenance
Ericson2314
reviewed
Nov 20, 2024
src/libutil/logging.cc
Outdated
| return true; | ||
| } catch (nlohmann::json::exception &e) { | ||
| warn( | ||
| "warning: Unable to handle a JSON message from the builder: %s", |
There was a problem hiding this comment.
Don't like how this makes assumptions about where this function is being used.
There was a problem hiding this comment.
Spot on. That also fixes a technically incorrect message, although it was probably never seen.
Now:
if (handleJSONLogMessage(s, worker.act, worker.hook->activities, "the build hook", true))
Ericson2314
reviewed
Nov 20, 2024
|
Interestingly, the |
|
@roberth CI fails. |
Before this change, expressions like:
with import <nixpkgs> {};
runCommand "foo" {} ''
echo '@nix {}' >&$NIX_LOG_FD
''
would result in Lix crashing, because accessing nonexistent fields of
a JSON object throws an exception.
Rather than handling each field individually, we just catch JSON
exceptions wholesale. Since these log messages are an unusual
circumstance, log a warning when this happens.
Fixes #544.
Change-Id: Idc2d8acf6e37046b3ec212f42e29269163dca893
(cherry picked from commit e55cd3beea710db727fd966f265a1b715b7285f3)
…warning correctly
roberth
force-pushed
the
log-json-tolerant
branch
from
8179d9d
to
2043cfa
Compare
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-11-20-nix-team-meeting-minutes-196/56688/1 |
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.
Motivation
A build may log with
@nix somethingwithout the intent to write Nix structured logs, resulting in an obscure error.This makes it easy to understand and continues the build.
Example:
Context
Cherry-picked from https://gerrit.lix.systems/c/lix/+/2057
Author @lheckemann
Priorities and Process
Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.