Fix key log encoding #682
Merged
Fix key log encoding #682
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
aschmahmann
commented
Jul 15, 2020
Comment on lines
+296
to
+309
|
|
||
| type loggableRawKeyString string | ||
|
|
||
| func (lk loggableRawKeyString) String() string { | ||
| k := string(lk) | ||
|
|
||
| if len(k) == 0 { | ||
| return k | ||
| } | ||
|
|
||
| encStr := base32.RawStdEncoding.EncodeToString([]byte(k)) | ||
|
|
||
| return encStr | ||
| } |
There was a problem hiding this comment.
It's a little unfortunate that this is here. It didn't seem worth it to make a logging subpackage, but I'm willing to budge here.
| if err == nil { | ||
| return newKey | ||
| } | ||
| return err.Error() |
There was a problem hiding this comment.
Previously we always returned the key whenever there was an error (e.g. empty string, invalid path, etc.) now we return error messages.
| @@ -128,7 +128,7 @@ func (dht *IpfsDHT) GetValue(ctx context.Context, key string, opts ...routing.Op | |||
| if best == nil { | |||
| return nil, routing.ErrNotFound | |||
| } | |||
| logger.Debugf("GetValue %v %v", key, best) | |||
| logger.Debugf("GetValue %v %x", loggableRecordKeyString(key), best) | |||
There was a problem hiding this comment.
This is, AFAICT, the only place we log record values. We now use hex encoding.
aschmahmann
force-pushed
the
fix/key-log-encoding
branch
from
1958ff0
to
db2389a
Compare
aschmahmann
commented
Jul 15, 2020
aschmahmann
commented
Jul 15, 2020
petar
approved these changes
Jul 17, 2020
| return strings.ToLower(base32.RawStdEncoding.EncodeToString(k)) | ||
| } | ||
|
|
||
| func tryFormatLoggableRecordKey(k string) (string, error) { |
aschmahmann
commented
Jul 20, 2020
petar
force-pushed
the
fix/key-log-encoding
branch
from
8f88727
to
b213268
Compare
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.
Fixes #680
This is an attempt at normalizing how we log keys. Suggestions welcome, the main constraints are: