Skip to content

Commit 32f9239

Browse files
core/peer: remove deprecated ID.Pretty method (#2565)
* core/peer: remove deprecated ID.Pretty method * Update p2p/net/connmgr/decay.go
1 parent fd2a1ed commit 32f9239

File tree

19 files changed

+59
-65
lines changed

19 files changed

+59
-65
lines changed

core/peer/addrinfo.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ func AddrInfoToP2pAddrs(pi *AddrInfo) ([]ma.Multiaddr, error) {
102102

103103
func (pi *AddrInfo) Loggable() map[string]interface{} {
104104
return map[string]interface{}{
105-
"peerID": pi.ID.Pretty(),
105+
"peerID": pi.ID.String(),
106106
"addrs": pi.Addrs,
107107
}
108108
}

core/peer/addrinfo_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ package peer_test
33
import (
44
"testing"
55

6-
ma "github.com/multiformats/go-multiaddr"
7-
86
. "github.com/libp2p/go-libp2p/core/peer"
7+
8+
ma "github.com/multiformats/go-multiaddr"
99
)
1010

1111
var (
@@ -115,7 +115,7 @@ func TestAddrInfosFromP2pAddrs(t *testing.T) {
115115
t.Fatal(err)
116116
}
117117
for _, info := range infos {
118-
exaddrs, ok := expected[info.ID.Pretty()]
118+
exaddrs, ok := expected[info.ID.String()]
119119
if !ok {
120120
t.Fatalf("didn't expect peer %s", info.ID)
121121
}
@@ -129,7 +129,7 @@ func TestAddrInfosFromP2pAddrs(t *testing.T) {
129129
t.Fatalf("expected %s, got %s", exaddrs[i], addr)
130130
}
131131
}
132-
delete(expected, info.ID.Pretty())
132+
delete(expected, info.ID.String())
133133
}
134134
}
135135

@@ -144,7 +144,7 @@ func TestAddrInfoJSON(t *testing.T) {
144144
t.Fatal(err)
145145
}
146146
if addrInfo.ID != testID {
147-
t.Fatalf("expected ID to equal %s, got %s", testID.Pretty(), addrInfo.ID.Pretty())
147+
t.Fatalf("expected ID to equal %s, got %s", testID, addrInfo.ID)
148148
}
149149
if len(addrInfo.Addrs) != 1 || !addrInfo.Addrs[0].Equal(maddrFull) {
150150
t.Fatalf("expected addrs to match %v, got %v", maddrFull, addrInfo.Addrs)

core/peer/peer.go

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,6 @@ const maxInlineKeyLength = 42
4141
// hash output as a multihash. See IDFromPublicKey for details.
4242
type ID string
4343

44-
// Pretty returns a base58-encoded string representation of the ID.
45-
// Deprecated: use String() instead.
46-
func (id ID) Pretty() string {
47-
return id.String()
48-
}
49-
5044
// Loggable returns a pretty peer ID string in loggable JSON format.
5145
func (id ID) Loggable() map[string]interface{} {
5246
return map[string]interface{}{

p2p/host/autonat/svc.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func (as *autoNATService) handleStream(s network.Stream) {
6868
defer s.Close()
6969

7070
pid := s.Conn().RemotePeer()
71-
log.Debugf("New stream from %s", pid.Pretty())
71+
log.Debugf("New stream from %s", pid)
7272

7373
r := pbio.NewDelimitedReader(s, maxMsgSize)
7474
w := pbio.NewDelimitedWriter(s)
@@ -78,14 +78,14 @@ func (as *autoNATService) handleStream(s network.Stream) {
7878

7979
err := r.ReadMsg(&req)
8080
if err != nil {
81-
log.Debugf("Error reading message from %s: %s", pid.Pretty(), err.Error())
81+
log.Debugf("Error reading message from %s: %s", pid, err.Error())
8282
s.Reset()
8383
return
8484
}
8585

8686
t := req.GetType()
8787
if t != pb.Message_DIAL {
88-
log.Debugf("Unexpected message from %s: %s (%d)", pid.Pretty(), t.String(), t)
88+
log.Debugf("Unexpected message from %s: %s (%d)", pid, t.String(), t)
8989
s.Reset()
9090
return
9191
}
@@ -96,7 +96,7 @@ func (as *autoNATService) handleStream(s network.Stream) {
9696

9797
err = w.WriteMsg(&res)
9898
if err != nil {
99-
log.Debugf("Error writing response to %s: %s", pid.Pretty(), err.Error())
99+
log.Debugf("Error writing response to %s: %s", pid, err.Error())
100100
s.Reset()
101101
return
102102
}
@@ -234,7 +234,7 @@ func (as *autoNATService) doDial(pi peer.AddrInfo) *pb.Message_DialResponse {
234234

235235
conn, err := as.config.dialer.DialPeer(ctx, pi.ID)
236236
if err != nil {
237-
log.Debugf("error dialing %s: %s", pi.ID.Pretty(), err.Error())
237+
log.Debugf("error dialing %s: %s", pi.ID, err.Error())
238238
// wait for the context to timeout to avoid leaking timing information
239239
// this renders the service ineffective as a port scanner
240240
<-ctx.Done()

p2p/host/autorelay/relay_finder.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -736,7 +736,7 @@ func (rf *relayFinder) relayAddrs(addrs []ma.Multiaddr) []ma.Multiaddr {
736736
for p := range rf.relays {
737737
addrs := cleanupAddressSet(rf.host.Peerstore().Addrs(p))
738738
relayAddrCnt += len(addrs)
739-
circuit := ma.StringCast(fmt.Sprintf("/p2p/%s/p2p-circuit", p.Pretty()))
739+
circuit := ma.StringCast(fmt.Sprintf("/p2p/%s/p2p-circuit", p))
740740
for _, addr := range addrs {
741741
pub := addr.Encapsulate(circuit)
742742
raddrs = append(raddrs, pub)

p2p/host/peerstore/pstoreds/addr_book.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ func (ab *dsAddrBook) storeSignedPeerRecord(p peer.ID, envelope *record.Envelope
362362
func (ab *dsAddrBook) GetPeerRecord(p peer.ID) *record.Envelope {
363363
pr, err := ab.loadRecord(p, true, false)
364364
if err != nil {
365-
log.Errorf("unable to load record for peer %s: %v", p.Pretty(), err)
365+
log.Errorf("unable to load record for peer %s: %v", p, err)
366366
return nil
367367
}
368368
pr.RLock()
@@ -372,7 +372,7 @@ func (ab *dsAddrBook) GetPeerRecord(p peer.ID) *record.Envelope {
372372
}
373373
state, _, err := record.ConsumeEnvelope(pr.CertifiedRecord.Raw, peer.PeerRecordEnvelopeDomain)
374374
if err != nil {
375-
log.Errorf("error unmarshaling stored signed peer record for peer %s: %v", p.Pretty(), err)
375+
log.Errorf("error unmarshaling stored signed peer record for peer %s: %v", p, err)
376376
return nil
377377
}
378378
return state
@@ -398,7 +398,7 @@ func (ab *dsAddrBook) SetAddrs(p peer.ID, addrs []ma.Multiaddr, ttl time.Duratio
398398
func (ab *dsAddrBook) UpdateAddrs(p peer.ID, oldTTL time.Duration, newTTL time.Duration) {
399399
pr, err := ab.loadRecord(p, true, false)
400400
if err != nil {
401-
log.Errorf("failed to update ttls for peer %s: %s\n", p.Pretty(), err)
401+
log.Errorf("failed to update ttls for peer %s: %s\n", p, err)
402402
return
403403
}
404404

@@ -423,7 +423,7 @@ func (ab *dsAddrBook) UpdateAddrs(p peer.ID, oldTTL time.Duration, newTTL time.D
423423
func (ab *dsAddrBook) Addrs(p peer.ID) []ma.Multiaddr {
424424
pr, err := ab.loadRecord(p, true, true)
425425
if err != nil {
426-
log.Warn("failed to load peerstore entry for peer %v while querying addrs, err: %v", p, err)
426+
log.Warnf("failed to load peerstore entry for peer %s while querying addrs, err: %v", p, err)
427427
return nil
428428
}
429429

@@ -466,7 +466,7 @@ func (ab *dsAddrBook) ClearAddrs(p peer.ID) {
466466

467467
key := addrBookBase.ChildString(b32.RawStdEncoding.EncodeToString([]byte(p)))
468468
if err := ab.ds.Delete(context.TODO(), key); err != nil {
469-
log.Errorf("failed to clear addresses for peer %s: %v", p.Pretty(), err)
469+
log.Errorf("failed to clear addresses for peer %s: %v", p, err)
470470
}
471471
}
472472

@@ -477,7 +477,7 @@ func (ab *dsAddrBook) setAddrs(p peer.ID, addrs []ma.Multiaddr, ttl time.Duratio
477477

478478
pr, err := ab.loadRecord(p, true, false)
479479
if err != nil {
480-
return fmt.Errorf("failed to load peerstore entry for peer %v while setting addrs, err: %v", p, err)
480+
return fmt.Errorf("failed to load peerstore entry for peer %s while setting addrs, err: %v", p, err)
481481
}
482482

483483
pr.Lock()

p2p/host/peerstore/pstoreds/addr_book_gc.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ func (gc *dsAddrBookGc) purgeLookahead() {
215215
cached.Lock()
216216
if cached.clean(gc.ab.clock.Now()) {
217217
if err = cached.flush(batch); err != nil {
218-
log.Warnf("failed to flush entry modified by GC for peer: &v, err: %v", id.Pretty(), err)
218+
log.Warnf("failed to flush entry modified by GC for peer: %s, err: %v", id, err)
219219
}
220220
}
221221
dropOrReschedule(gcKey, cached)
@@ -241,7 +241,7 @@ func (gc *dsAddrBookGc) purgeLookahead() {
241241
if record.clean(gc.ab.clock.Now()) {
242242
err = record.flush(batch)
243243
if err != nil {
244-
log.Warnf("failed to flush entry modified by GC for peer: &v, err: %v", id.Pretty(), err)
244+
log.Warnf("failed to flush entry modified by GC for peer: %s, err: %v", id, err)
245245
}
246246
}
247247
dropOrReschedule(gcKey, record)
@@ -353,7 +353,7 @@ func (gc *dsAddrBookGc) populateLookahead() {
353353
}
354354
gcKey := gcLookaheadBase.ChildString(fmt.Sprintf("%d/%s", cached.Addrs[0].Expiry, idb32))
355355
if err = batch.Put(context.TODO(), gcKey, []byte{}); err != nil {
356-
log.Warnf("failed while inserting GC entry for peer: %v, err: %v", id.Pretty(), err)
356+
log.Warnf("failed while inserting GC entry for peer: %s, err: %v", id, err)
357357
}
358358
cached.RUnlock()
359359
continue
@@ -363,17 +363,17 @@ func (gc *dsAddrBookGc) populateLookahead() {
363363

364364
val, err := gc.ab.ds.Get(context.TODO(), ds.RawKey(result.Key))
365365
if err != nil {
366-
log.Warnf("failed which getting record from store for peer: %v, err: %v", id.Pretty(), err)
366+
log.Warnf("failed which getting record from store for peer: %s, err: %v", id, err)
367367
continue
368368
}
369369
if err := proto.Unmarshal(val, record); err != nil {
370-
log.Warnf("failed while unmarshalling record from store for peer: %v, err: %v", id.Pretty(), err)
370+
log.Warnf("failed while unmarshalling record from store for peer: %s, err: %v", id, err)
371371
continue
372372
}
373373
if len(record.Addrs) > 0 && record.Addrs[0].Expiry <= until {
374374
gcKey := gcLookaheadBase.ChildString(fmt.Sprintf("%d/%s", record.Addrs[0].Expiry, idb32))
375375
if err = batch.Put(context.TODO(), gcKey, []byte{}); err != nil {
376-
log.Warnf("failed while inserting GC entry for peer: %v, err: %v", id.Pretty(), err)
376+
log.Warnf("failed while inserting GC entry for peer: %s, err: %v", id, err)
377377
}
378378
}
379379
}

p2p/host/peerstore/pstoreds/keybook.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func (kb *dsKeyBook) PubKey(p peer.ID) ic.PubKey {
3838
if value, err := kb.ds.Get(context.TODO(), key); err == nil {
3939
pk, err = ic.UnmarshalPublicKey(value)
4040
if err != nil {
41-
log.Errorf("error when unmarshalling pubkey from datastore for peer %s: %s\n", p.Pretty(), err)
41+
log.Errorf("error when unmarshalling pubkey from datastore for peer %s: %s\n", p, err)
4242
}
4343
} else if err == ds.ErrNotFound {
4444
pk, err = p.ExtractPublicKey()
@@ -47,20 +47,20 @@ func (kb *dsKeyBook) PubKey(p peer.ID) ic.PubKey {
4747
case peer.ErrNoPublicKey:
4848
return nil
4949
default:
50-
log.Errorf("error when extracting pubkey from peer ID for peer %s: %s\n", p.Pretty(), err)
50+
log.Errorf("error when extracting pubkey from peer ID for peer %s: %s\n", p, err)
5151
return nil
5252
}
5353
pkb, err := ic.MarshalPublicKey(pk)
5454
if err != nil {
55-
log.Errorf("error when turning extracted pubkey into bytes for peer %s: %s\n", p.Pretty(), err)
55+
log.Errorf("error when turning extracted pubkey into bytes for peer %s: %s\n", p, err)
5656
return nil
5757
}
5858
if err := kb.ds.Put(context.TODO(), key, pkb); err != nil {
59-
log.Errorf("error when adding extracted pubkey to peerstore for peer %s: %s\n", p.Pretty(), err)
59+
log.Errorf("error when adding extracted pubkey to peerstore for peer %s: %s\n", p, err)
6060
return nil
6161
}
6262
} else {
63-
log.Errorf("error when fetching pubkey from datastore for peer %s: %s\n", p.Pretty(), err)
63+
log.Errorf("error when fetching pubkey from datastore for peer %s: %s\n", p, err)
6464
}
6565

6666
return pk
@@ -74,11 +74,11 @@ func (kb *dsKeyBook) AddPubKey(p peer.ID, pk ic.PubKey) error {
7474

7575
val, err := ic.MarshalPublicKey(pk)
7676
if err != nil {
77-
log.Errorf("error while converting pubkey byte string for peer %s: %s\n", p.Pretty(), err)
77+
log.Errorf("error while converting pubkey byte string for peer %s: %s\n", p, err)
7878
return err
7979
}
8080
if err := kb.ds.Put(context.TODO(), peerToKey(p, pubSuffix), val); err != nil {
81-
log.Errorf("error while updating pubkey in datastore for peer %s: %s\n", p.Pretty(), err)
81+
log.Errorf("error while updating pubkey in datastore for peer %s: %s\n", p, err)
8282
return err
8383
}
8484
return nil
@@ -107,11 +107,11 @@ func (kb *dsKeyBook) AddPrivKey(p peer.ID, sk ic.PrivKey) error {
107107

108108
val, err := ic.MarshalPrivateKey(sk)
109109
if err != nil {
110-
log.Errorf("error while converting privkey byte string for peer %s: %s\n", p.Pretty(), err)
110+
log.Errorf("error while converting privkey byte string for peer %s: %s\n", p, err)
111111
return err
112112
}
113113
if err := kb.ds.Put(context.TODO(), peerToKey(p, privSuffix), val); err != nil {
114-
log.Errorf("error while updating privkey in datastore for peer %s: %s\n", p.Pretty(), err)
114+
log.Errorf("error while updating privkey in datastore for peer %s: %s\n", p, err)
115115
}
116116
return err
117117
}

p2p/host/peerstore/test/utils.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func RandomPeer(b *testing.B, addrCount int) *peerpair {
3838
}
3939

4040
for i := 0; i < addrCount; i++ {
41-
if addrs[i], err = ma.NewMultiaddr(fmt.Sprintf(aFmt, i, pid.Pretty())); err != nil {
41+
if addrs[i], err = ma.NewMultiaddr(fmt.Sprintf(aFmt, i, pid)); err != nil {
4242
b.Fatal(err)
4343
}
4444
}

p2p/net/connmgr/decay.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ func (t *decayingTag) Bump(p peer.ID, delta int) error {
320320
default:
321321
return fmt.Errorf(
322322
"unable to bump decaying tag for peer %s, tag %s, delta %d; queue full (len=%d)",
323-
p.Pretty(), t.name, delta, len(t.trkr.bumpTagCh))
323+
p, t.name, delta, len(t.trkr.bumpTagCh))
324324
}
325325
}
326326

@@ -337,7 +337,7 @@ func (t *decayingTag) Remove(p peer.ID) error {
337337
default:
338338
return fmt.Errorf(
339339
"unable to remove decaying tag for peer %s, tag %s; queue full (len=%d)",
340-
p.Pretty(), t.name, len(t.trkr.removeTagCh))
340+
p, t.name, len(t.trkr.removeTagCh))
341341
}
342342
}
343343

0 commit comments

Comments
 (0)