Skip to content

Commit

Permalink
core/peer: remove deprecated ID.Pretty method
Browse files Browse the repository at this point in the history
  • Loading branch information
@marten-seemann
marten-seemann committed Sep 10, 2023
1 parent 0509445 commit 682cb85
Show file tree
Hide file tree
Showing 19 changed files with 76 additions and 82 deletions.
2 changes: 1 addition & 1 deletion core/peer/addrinfo.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ func AddrInfoToP2pAddrs(pi *AddrInfo) ([]ma.Multiaddr, error) {

func (pi *AddrInfo) Loggable() map[string]interface{} {
return map[string]interface{}{
"peerID": pi.ID.Pretty(),
"peerID": pi.ID.String(),
"addrs": pi.Addrs,
}
}
Expand Down
44 changes: 22 additions & 22 deletions core/peer/addrinfo_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,45 @@ package peer_test
import (
"testing"

ma "github.com/multiformats/go-multiaddr"
"github.com/libp2p/go-libp2p/core/peer"

. "github.com/libp2p/go-libp2p/core/peer"
ma "github.com/multiformats/go-multiaddr"
)

var (
testID ID
testID peer.ID
maddrFull, maddrTpt, maddrPeer ma.Multiaddr
)

func init() {
var err error
testID, err = Decode("QmS3zcG7LhYZYSJMhyRZvTddvbNUqtt8BJpaSs6mi1K5Va")
testID, err = peer.Decode("QmS3zcG7LhYZYSJMhyRZvTddvbNUqtt8BJpaSs6mi1K5Va")
if err != nil {
panic(err)
}
maddrPeer = ma.StringCast("/p2p/" + Encode(testID))
maddrPeer = ma.StringCast("/p2p/" + peer.Encode(testID))
maddrTpt = ma.StringCast("/ip4/127.0.0.1/tcp/1234")
maddrFull = maddrTpt.Encapsulate(maddrPeer)
}

func TestSplitAddr(t *testing.T) {
tpt, id := SplitAddr(maddrFull)
tpt, id := peer.SplitAddr(maddrFull)
if !tpt.Equal(maddrTpt) {
t.Fatal("expected transport")
}
if id != testID {
t.Fatalf("%s != %s", id, testID)
}

tpt, id = SplitAddr(maddrPeer)
tpt, id = peer.SplitAddr(maddrPeer)
if tpt != nil {
t.Fatal("expected no transport")
}
if id != testID {
t.Fatalf("%s != %s", id, testID)
}

tpt, id = SplitAddr(maddrTpt)
tpt, id = peer.SplitAddr(maddrTpt)
if !tpt.Equal(maddrTpt) {
t.Fatal("expected a transport")
}
Expand All @@ -51,7 +51,7 @@ func TestSplitAddr(t *testing.T) {
}

func TestAddrInfoFromP2pAddr(t *testing.T) {
ai, err := AddrInfoFromP2pAddr(maddrFull)
ai, err := peer.AddrInfoFromP2pAddr(maddrFull)
if err != nil {
t.Fatal(err)
}
Expand All @@ -62,7 +62,7 @@ func TestAddrInfoFromP2pAddr(t *testing.T) {
t.Fatalf("%s != %s", ai.ID, testID)
}

ai, err = AddrInfoFromP2pAddr(maddrPeer)
ai, err = peer.AddrInfoFromP2pAddr(maddrPeer)
if err != nil {
t.Fatal(err)
}
Expand All @@ -73,21 +73,21 @@ func TestAddrInfoFromP2pAddr(t *testing.T) {
t.Fatalf("%s != %s", ai.ID, testID)
}

_, err = AddrInfoFromP2pAddr(maddrTpt)
if err != ErrInvalidAddr {
_, err = peer.AddrInfoFromP2pAddr(maddrTpt)
if err != peer.ErrInvalidAddr {
t.Fatalf("wrong error: %s", err)
}
}

func TestAddrInfosFromP2pAddrs(t *testing.T) {
infos, err := AddrInfosFromP2pAddrs()
infos, err := peer.AddrInfosFromP2pAddrs()
if err != nil {
t.Fatal(err)
}
if len(infos) != 0 {
t.Fatal("expected no addrs")
}
if _, err = AddrInfosFromP2pAddrs(nil); err == nil {
if _, err = peer.AddrInfosFromP2pAddrs(nil); err == nil {
t.Fatal("expected nil multiaddr to fail")
}

Expand All @@ -100,7 +100,7 @@ func TestAddrInfosFromP2pAddrs(t *testing.T) {

ma.StringCast("/ipfs/QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM"),
}
expected := map[string][]ma.Multiaddr{
expected := map[peer.ID][]ma.Multiaddr{
"QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64": {
ma.StringCast("/ip4/128.199.219.111/tcp/4001"),
ma.StringCast("/ip4/104.236.76.40/tcp/4001"),
Expand All @@ -110,41 +110,41 @@ func TestAddrInfosFromP2pAddrs(t *testing.T) {
},
"QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM": nil,
}
infos, err = AddrInfosFromP2pAddrs(addrs...)
infos, err = peer.AddrInfosFromP2pAddrs(addrs...)
if err != nil {
t.Fatal(err)
}
for _, info := range infos {
exaddrs, ok := expected[info.ID.Pretty()]
exaddrs, ok := expected[info.ID]
if !ok {
t.Fatalf("didn't expect peer %s", info.ID)
}
if len(info.Addrs) != len(exaddrs) {
t.Fatalf("got %d addrs, expected %d", len(info.Addrs), len(exaddrs))
}
// AddrInfosFromP2pAddrs preserves order. I'd like to keep this
// peer.AddrInfosFromP2pAddrs preserves order. I'd like to keep this
// guarantee for now.
for i, addr := range info.Addrs {
if !exaddrs[i].Equal(addr) {
t.Fatalf("expected %s, got %s", exaddrs[i], addr)
}
}
delete(expected, info.ID.Pretty())
delete(expected, info.ID)
}
}

func TestAddrInfoJSON(t *testing.T) {
ai := AddrInfo{ID: testID, Addrs: []ma.Multiaddr{maddrFull}}
ai := peer.AddrInfo{ID: testID, Addrs: []ma.Multiaddr{maddrFull}}
out, err := ai.MarshalJSON()
if err != nil {
t.Fatal(err)
}
var addrInfo AddrInfo
var addrInfo peer.AddrInfo
if err := addrInfo.UnmarshalJSON(out); err != nil {
t.Fatal(err)
}
if addrInfo.ID != testID {
t.Fatalf("expected ID to equal %s, got %s", testID.Pretty(), addrInfo.ID.Pretty())
t.Fatalf("expected ID to equal %s, got %s", testID, addrInfo.ID)
}
if len(addrInfo.Addrs) != 1 || !addrInfo.Addrs[0].Equal(maddrFull) {
t.Fatalf("expected addrs to match %v, got %v", maddrFull, addrInfo.Addrs)
Expand Down
6 changes: 0 additions & 6 deletions core/peer/peer.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,6 @@ const maxInlineKeyLength = 42
// hash output as a multihash. See IDFromPublicKey for details.
type ID string

// Pretty returns a base58-encoded string representation of the ID.
// Deprecated: use String() instead.
func (id ID) Pretty() string {
return id.String()
}

// Loggable returns a pretty peer ID string in loggable JSON format.
func (id ID) Loggable() map[string]interface{} {
return map[string]interface{}{
Expand Down
10 changes: 5 additions & 5 deletions p2p/host/autonat/svc.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func (as *autoNATService) handleStream(s network.Stream) {
defer s.Close()

pid := s.Conn().RemotePeer()
log.Debugf("New stream from %s", pid.Pretty())
log.Debugf("New stream from %s", pid)

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

err := r.ReadMsg(&req)
if err != nil {
log.Debugf("Error reading message from %s: %s", pid.Pretty(), err.Error())
log.Debugf("Error reading message from %s: %s", pid, err.Error())
s.Reset()
return
}

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

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

conn, err := as.config.dialer.DialPeer(ctx, pi.ID)
if err != nil {
log.Debugf("error dialing %s: %s", pi.ID.Pretty(), err.Error())
log.Debugf("error dialing %s: %s", pi.ID, err.Error())
// wait for the context to timeout to avoid leaking timing information
// this renders the service ineffective as a port scanner
<-ctx.Done()
Expand Down
2 changes: 1 addition & 1 deletion p2p/host/autorelay/relay_finder.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -736,7 +736,7 @@ func (rf *relayFinder) relayAddrs(addrs []ma.Multiaddr) []ma.Multiaddr {
for p := range rf.relays {
addrs := cleanupAddressSet(rf.host.Peerstore().Addrs(p))
relayAddrCnt += len(addrs)
circuit := ma.StringCast(fmt.Sprintf("/p2p/%s/p2p-circuit", p.Pretty()))
circuit := ma.StringCast(fmt.Sprintf("/p2p/%s/p2p-circuit", p))
for _, addr := range addrs {
pub := addr.Encapsulate(circuit)
raddrs = append(raddrs, pub)
Expand Down
12 changes: 6 additions & 6 deletions p2p/host/peerstore/pstoreds/addr_book.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ func (ab *dsAddrBook) storeSignedPeerRecord(p peer.ID, envelope *record.Envelope
func (ab *dsAddrBook) GetPeerRecord(p peer.ID) *record.Envelope {
pr, err := ab.loadRecord(p, true, false)
if err != nil {
log.Errorf("unable to load record for peer %s: %v", p.Pretty(), err)
log.Errorf("unable to load record for peer %s: %v", p, err)
return nil
}
pr.RLock()
Expand All @@ -372,7 +372,7 @@ func (ab *dsAddrBook) GetPeerRecord(p peer.ID) *record.Envelope {
}
state, _, err := record.ConsumeEnvelope(pr.CertifiedRecord.Raw, peer.PeerRecordEnvelopeDomain)
if err != nil {
log.Errorf("error unmarshaling stored signed peer record for peer %s: %v", p.Pretty(), err)
log.Errorf("error unmarshaling stored signed peer record for peer %s: %v", p, err)
return nil
}
return state
Expand All @@ -398,7 +398,7 @@ func (ab *dsAddrBook) SetAddrs(p peer.ID, addrs []ma.Multiaddr, ttl time.Duratio
func (ab *dsAddrBook) UpdateAddrs(p peer.ID, oldTTL time.Duration, newTTL time.Duration) {
pr, err := ab.loadRecord(p, true, false)
if err != nil {
log.Errorf("failed to update ttls for peer %s: %s\n", p.Pretty(), err)
log.Errorf("failed to update ttls for peer %s: %s\n", p, err)
return
}

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

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

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

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

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

pr.Lock()
Expand Down
12 changes: 6 additions & 6 deletions p2p/host/peerstore/pstoreds/addr_book_gc.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ func (gc *dsAddrBookGc) purgeLookahead() {
cached.Lock()
if cached.clean(gc.ab.clock.Now()) {
if err = cached.flush(batch); err != nil {
log.Warnf("failed to flush entry modified by GC for peer: &v, err: %v", id.Pretty(), err)
log.Warnf("failed to flush entry modified by GC for peer: %s, err: %v", id, err)
}
}
dropOrReschedule(gcKey, cached)
Expand All @@ -241,7 +241,7 @@ func (gc *dsAddrBookGc) purgeLookahead() {
if record.clean(gc.ab.clock.Now()) {
err = record.flush(batch)
if err != nil {
log.Warnf("failed to flush entry modified by GC for peer: &v, err: %v", id.Pretty(), err)
log.Warnf("failed to flush entry modified by GC for peer: %s, err: %v", id, err)
}
}
dropOrReschedule(gcKey, record)
Expand Down Expand Up @@ -353,7 +353,7 @@ func (gc *dsAddrBookGc) populateLookahead() {
}
gcKey := gcLookaheadBase.ChildString(fmt.Sprintf("%d/%s", cached.Addrs[0].Expiry, idb32))
if err = batch.Put(context.TODO(), gcKey, []byte{}); err != nil {
log.Warnf("failed while inserting GC entry for peer: %v, err: %v", id.Pretty(), err)
log.Warnf("failed while inserting GC entry for peer: %s, err: %v", id, err)
}
cached.RUnlock()
continue
Expand All @@ -363,17 +363,17 @@ func (gc *dsAddrBookGc) populateLookahead() {

val, err := gc.ab.ds.Get(context.TODO(), ds.RawKey(result.Key))
if err != nil {
log.Warnf("failed which getting record from store for peer: %v, err: %v", id.Pretty(), err)
log.Warnf("failed which getting record from store for peer: %s, err: %v", id, err)
continue
}
if err := proto.Unmarshal(val, record); err != nil {
log.Warnf("failed while unmarshalling record from store for peer: %v, err: %v", id.Pretty(), err)
log.Warnf("failed while unmarshalling record from store for peer: %s, err: %v", id, err)
continue
}
if len(record.Addrs) > 0 && record.Addrs[0].Expiry <= until {
gcKey := gcLookaheadBase.ChildString(fmt.Sprintf("%d/%s", record.Addrs[0].Expiry, idb32))
if err = batch.Put(context.TODO(), gcKey, []byte{}); err != nil {
log.Warnf("failed while inserting GC entry for peer: %v, err: %v", id.Pretty(), err)
log.Warnf("failed while inserting GC entry for peer: %s, err: %v", id, err)
}
}
}
Expand Down
18 changes: 9 additions & 9 deletions p2p/host/peerstore/pstoreds/keybook.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (kb *dsKeyBook) PubKey(p peer.ID) ic.PubKey {
if value, err := kb.ds.Get(context.TODO(), key); err == nil {
pk, err = ic.UnmarshalPublicKey(value)
if err != nil {
log.Errorf("error when unmarshalling pubkey from datastore for peer %s: %s\n", p.Pretty(), err)
log.Errorf("error when unmarshalling pubkey from datastore for peer %s: %s\n", p, err)
}
} else if err == ds.ErrNotFound {
pk, err = p.ExtractPublicKey()
Expand All @@ -47,20 +47,20 @@ func (kb *dsKeyBook) PubKey(p peer.ID) ic.PubKey {
case peer.ErrNoPublicKey:
return nil
default:
log.Errorf("error when extracting pubkey from peer ID for peer %s: %s\n", p.Pretty(), err)
log.Errorf("error when extracting pubkey from peer ID for peer %s: %s\n", p, err)
return nil
}
pkb, err := ic.MarshalPublicKey(pk)
if err != nil {
log.Errorf("error when turning extracted pubkey into bytes for peer %s: %s\n", p.Pretty(), err)
log.Errorf("error when turning extracted pubkey into bytes for peer %s: %s\n", p, err)
return nil
}
if err := kb.ds.Put(context.TODO(), key, pkb); err != nil {
log.Errorf("error when adding extracted pubkey to peerstore for peer %s: %s\n", p.Pretty(), err)
log.Errorf("error when adding extracted pubkey to peerstore for peer %s: %s\n", p, err)
return nil
}
} else {
log.Errorf("error when fetching pubkey from datastore for peer %s: %s\n", p.Pretty(), err)
log.Errorf("error when fetching pubkey from datastore for peer %s: %s\n", p, err)
}

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

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

val, err := ic.MarshalPrivateKey(sk)
if err != nil {
log.Errorf("error while converting privkey byte string for peer %s: %s\n", p.Pretty(), err)
log.Errorf("error while converting privkey byte string for peer %s: %s\n", p, err)
return err
}
if err := kb.ds.Put(context.TODO(), peerToKey(p, privSuffix), val); err != nil {
log.Errorf("error while updating privkey in datastore for peer %s: %s\n", p.Pretty(), err)
log.Errorf("error while updating privkey in datastore for peer %s: %s\n", p, err)
}
return err
}
Expand Down
Loading

0 comments on commit 682cb85

Please sign in to comment.