letsencrypt / letsencrypt/boulder

va: reduce duplication in "Validation result" log message

Open
#7,581 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
5.8k
Forks
649
Avg merge
3d 23h
Merged PRs (30d)
24

Description

When we log a validation result with an error, it shows up three places:

  • We log the updated challenge object, which includes the error
  • We log the error at the top level of the JSON object
  • We log the internal error

We should fix this by:

  • Not logging the updated challenge object
  • Logging the internal error only if it differs from the external error (modulo the prefix of the error type)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the code that logs a validation result and inspect how the updated challenge object, external error, and internal error are serialized. Done means the updated challenge object is omitted and the internal error is logged only when it differs from the external error apart from the error-type prefix.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.