Issue #446 Adding peername to PinInfo

api/types.go

@@ -203,21 +203,23 @@ func (gpis GlobalPinInfoSerial) ToGlobalPinInfo() GlobalPinInfo {
 
 // PinInfo holds information about local pins.
 type PinInfo struct {
-	Cid    cid.Cid
-	Peer   peer.ID
-	Status TrackerStatus
-	TS     time.Time
-	Error  string
+	Cid      cid.Cid
+	Peer     peer.ID
+	PeerName string
+	Status   TrackerStatus
+	TS       time.Time
+	Error    string
 }
 
 // PinInfoSerial is a serializable version of PinInfo.
 // information is marked as
 type PinInfoSerial struct {
-	Cid    string `json:"cid"`
-	Peer   string `json:"peer"`
-	Status string `json:"status"`
-	TS     string `json:"timestamp"`
-	Error  string `json:"error"`
+	Cid      string `json:"cid"`
+	Peer     string `json:"peer"`
+	PeerName string `json:"peername"`
+	Status   string `json:"status"`
+	TS       string `json:"timestamp"`
+	Error    string `json:"error"`
 }
 
 // ToSerial converts a PinInfo to its serializable version.
@@ -232,11 +234,12 @@ func (pi PinInfo) ToSerial() PinInfoSerial {
 	}
 
 	return PinInfoSerial{
-		Cid:    c,
-		Peer:   p,
-		Status: pi.Status.String(),
-		TS:     pi.TS.UTC().Format(time.RFC3339),
-		Error:  pi.Error,
+		Cid:      c,
+		Peer:     p,
+		PeerName: pi.PeerName,
+		Status:   pi.Status.String(),
+		TS:       pi.TS.UTC().Format(time.RFC3339),
+		Error:    pi.Error,
 	}
 }
 
@@ -255,11 +258,12 @@ func (pis PinInfoSerial) ToPinInfo() PinInfo {
 		logger.Debug(pis.TS, err)
 	}
 	return PinInfo{
-		Cid:    c,
-		Peer:   p,
-		Status: TrackerStatusFromString(pis.Status),
-		TS:     ts,
-		Error:  pis.Error,
+		Cid:      c,
+		Peer:     p,
+		PeerName: pis.PeerName,
+		Status:   TrackerStatusFromString(pis.Status),
+		TS:       ts,
+		Error:    pis.Error,
 	}
 }
 

cluster.go

@@ -1172,11 +1172,12 @@ func (c *Cluster) globalPinInfoCid(method string, h cid.Cid) (api.GlobalPinInfo,
 		if r.Status == api.TrackerStatusBug {
 			logger.Errorf("%s: error in broadcast response from %s: %s ", c.id, members[i], e)
 			pin.PeerMap[members[i]] = api.PinInfo{
-				Cid:    h,
-				Peer:   members[i],
-				Status: api.TrackerStatusClusterError,
-				TS:     time.Now(),
-				Error:  e.Error(),
+				Cid:      h,
+				Peer:     members[i],
+				PeerName: string(members[i]),
+				Status:   api.TrackerStatusClusterError,
+				TS:       time.Now(),
+				Error:    e.Error(),
 			}
 		} else { // there was an rpc error, but got a valid response :S
 			r.Error = e.Error()

cluster_test.go

@@ -129,7 +129,7 @@ func testingCluster(t *testing.T) (*Cluster, *mockAPI, *mockConnector, state.Sta
 	api := &mockAPI{}
 	ipfs := &mockConnector{}
 	st := mapstate.NewMapState()
-	tracker := makePinTracker(t, clusterCfg.ID, maptrackerCfg, statelesstrackerCfg)
+	tracker := makePinTracker(t, clusterCfg.ID, maptrackerCfg, statelesstrackerCfg, clusterCfg.Peername)
 
 	raftcon, _ := raft.NewConsensus(host, consensusCfg, st, false)
 

ipfs-cluster-ctl/formatters.go

@@ -147,7 +147,11 @@ func textFormatPrintGPInfo(obj *api.GlobalPinInfoSerial) {
 
 	for _, k := range peers {
 		v := obj.PeerMap[k]
-		fmt.Printf("    > Peer %s : %s", k, strings.ToUpper(v.Status))
+		if len(v.PeerName) > 0 {
+			fmt.Printf("    > %-15s : %s", v.PeerName, strings.ToUpper(v.Status))
+		} else {
+			fmt.Printf("    > %-15s : %s", k, strings.ToUpper(v.Status))
+		}
 		if v.Error != "" {
 			fmt.Printf(": %s", v.Error)
 		}

ipfs-cluster-service/daemon.go

@@ -126,7 +126,7 @@ func createCluster(
 	)
 	checkErr("creating consensus component", err)
 
-	tracker := setupPinTracker(c.String("pintracker"), host, cfgs.maptrackerCfg, cfgs.statelessTrackerCfg)
+	tracker := setupPinTracker(c.String("pintracker"), host, cfgs.maptrackerCfg, cfgs.statelessTrackerCfg, cfgs.clusterCfg.Peername)
 	mon := setupMonitor(c.String("monitor"), host, cfgs.monCfg, cfgs.pubsubmonCfg)
 	informer, alloc := setupAllocation(c.String("alloc"), cfgs.diskInfCfg, cfgs.numpinInfCfg)
 
@@ -259,14 +259,15 @@ func setupPinTracker(
 	h host.Host,
 	mapCfg *maptracker.Config,
 	statelessCfg *stateless.Config,
+	peerName string,
 ) ipfscluster.PinTracker {
 	switch name {
 	case "map":
-		ptrk := maptracker.NewMapPinTracker(mapCfg, h.ID())
+		ptrk := maptracker.NewMapPinTracker(mapCfg, h.ID(), peerName)
 		logger.Debug("map pintracker loaded")
 		return ptrk
 	case "stateless":
-		ptrk := stateless.New(statelessCfg, h.ID())
+		ptrk := stateless.New(statelessCfg, h.ID(), peerName)
 		logger.Debug("stateless pintracker loaded")
 		return ptrk
 	default:

ipfscluster_test.go

@@ -163,7 +163,7 @@ func createComponents(t *testing.T, i int, clusterSecret []byte, staging bool) (
 	ipfs, err := ipfshttp.NewConnector(ipfshttpCfg)
 	checkErr(t, err)
 	state := mapstate.NewMapState()
-	tracker := makePinTracker(t, clusterCfg.ID, maptrackerCfg, statelesstrackerCfg)
+	tracker := makePinTracker(t, clusterCfg.ID, maptrackerCfg, statelesstrackerCfg, clusterCfg.Peername)
 
 	mon := makeMonitor(t, host, bmonCfg, psmonCfg)
 
@@ -191,13 +191,13 @@ func makeMonitor(t *testing.T, h host.Host, bmonCfg *basic.Config, psmonCfg *pub
 	return mon
 }
 
-func makePinTracker(t *testing.T, pid peer.ID, mptCfg *maptracker.Config, sptCfg *stateless.Config) PinTracker {
+func makePinTracker(t *testing.T, pid peer.ID, mptCfg *maptracker.Config, sptCfg *stateless.Config, peerName string) PinTracker {
 	var ptrkr PinTracker
 	switch ptracker {
 	case "map":
-		ptrkr = maptracker.NewMapPinTracker(mptCfg, pid)
+		ptrkr = maptracker.NewMapPinTracker(mptCfg, pid, peerName)
 	case "stateless":
-		ptrkr = stateless.New(sptCfg, pid)
+		ptrkr = stateless.New(sptCfg, pid, peerName)
 	default:
 		panic("bad pintracker")
 	}

pintracker/maptracker/maptracker.go

@@ -47,14 +47,14 @@ type MapPinTracker struct {
 
 // NewMapPinTracker returns a new object which has been correcly
 // initialized with the given configuration.
-func NewMapPinTracker(cfg *Config, pid peer.ID) *MapPinTracker {
+func NewMapPinTracker(cfg *Config, pid peer.ID, peerName string) *MapPinTracker {
 	ctx, cancel := context.WithCancel(context.Background())
 
 	mpt := &MapPinTracker{
 		ctx:       ctx,
 		cancel:    cancel,
 		config:    cfg,
-		optracker: optracker.NewOperationTracker(ctx, pid),
+		optracker: optracker.NewOperationTracker(ctx, pid, peerName),
 		rpcReady:  make(chan struct{}, 1),
 		peerID:    pid,
 		pinCh:     make(chan *optracker.Operation, cfg.MaxPinQueueSize),

pintracker/maptracker/maptracker_test.go

@@ -71,7 +71,7 @@ func testSlowMapPinTracker(t *testing.T) *MapPinTracker {
 	cfg := &Config{}
 	cfg.Default()
 	cfg.ConcurrentPins = 1
-	mpt := NewMapPinTracker(cfg, test.TestPeerID1)
+	mpt := NewMapPinTracker(cfg, test.TestPeerID1, test.TestPeerName1)
 	mpt.SetClient(mockRPCClient(t))
 	return mpt
 }
@@ -80,7 +80,7 @@ func testMapPinTracker(t *testing.T) *MapPinTracker {
 	cfg := &Config{}
 	cfg.Default()
 	cfg.ConcurrentPins = 1
-	mpt := NewMapPinTracker(cfg, test.TestPeerID1)
+	mpt := NewMapPinTracker(cfg, test.TestPeerID1, test.TestPeerName1)
 	mpt.SetClient(test.NewMockRPCClient(t))
 	return mpt
 }

pintracker/optracker/operationtracker.go

@@ -21,18 +21,20 @@ var logger = logging.Logger("optracker")
 
 // OperationTracker tracks and manages all inflight Operations.
 type OperationTracker struct {
-	ctx context.Context // parent context for all ops
-	pid peer.ID
+	ctx      context.Context // parent context for all ops
+	pid      peer.ID
+	peerName string
 
 	mu         sync.RWMutex
 	operations map[string]*Operation
 }
 
 // NewOperationTracker creates a new OperationTracker.
-func NewOperationTracker(ctx context.Context, pid peer.ID) *OperationTracker {
+func NewOperationTracker(ctx context.Context, pid peer.ID, peerName string) *OperationTracker {
 	return &OperationTracker{
 		ctx:        ctx,
 		pid:        pid,
+		peerName:   peerName,
 		operations: make(map[string]*Operation),
 	}
 }
@@ -109,20 +111,21 @@ func (opt *OperationTracker) SetError(c cid.Cid, err error) {
 func (opt *OperationTracker) unsafePinInfo(op *Operation) api.PinInfo {
 	if op == nil {
 		return api.PinInfo{
-			Cid:    cid.Undef,
-			Peer:   opt.pid,
-			Status: api.TrackerStatusUnpinned,
-			TS:     time.Now(),
-			Error:  "",
+			Cid:      cid.Undef,
+			Peer:     opt.pid,
+			PeerName: opt.peerName,
+			Status:   api.TrackerStatusUnpinned,
+			TS:       time.Now(),
+			Error:    "",
 		}
 	}
-
 	return api.PinInfo{
-		Cid:    op.Cid(),
-		Peer:   opt.pid,
-		Status: op.ToTrackerStatus(),
-		TS:     op.Timestamp(),
-		Error:  op.Error(),
+		Cid:      op.Cid(),
+		Peer:     opt.pid,
+		PeerName: opt.peerName,
+		Status:   op.ToTrackerStatus(),
+		TS:       op.Timestamp(),
+		Error:    op.Error(),
 	}
 }
 

pintracker/optracker/operationtracker_test.go

@@ -11,8 +11,7 @@ import (
 
 func testOperationTracker(t *testing.T) *OperationTracker {
 	ctx := context.Background()
-	pid := test.TestPeerID1
-	return NewOperationTracker(ctx, pid)
+	return NewOperationTracker(ctx, test.TestPeerID1, test.TestPeerName1)
 }
 
 func TestOperationTracker_TrackNewOperation(t *testing.T) {

pintracker/pintracker_test.go

@@ -202,31 +202,31 @@ var sortPinInfoByCid = func(p []api.PinInfo) {
 func testSlowMapPinTracker(t testing.TB) *maptracker.MapPinTracker {
 	cfg := &maptracker.Config{}
 	cfg.Default()
-	mpt := maptracker.NewMapPinTracker(cfg, test.TestPeerID1)
+	mpt := maptracker.NewMapPinTracker(cfg, test.TestPeerID1, test.TestPeerName1)
 	mpt.SetClient(mockRPCClient(t))
 	return mpt
 }
 
 func testMapPinTracker(t testing.TB) *maptracker.MapPinTracker {
 	cfg := &maptracker.Config{}
 	cfg.Default()
-	mpt := maptracker.NewMapPinTracker(cfg, test.TestPeerID1)
+	mpt := maptracker.NewMapPinTracker(cfg, test.TestPeerID1, test.TestPeerName1)
 	mpt.SetClient(test.NewMockRPCClient(t))
 	return mpt
 }
 
 func testSlowStatelessPinTracker(t testing.TB) *stateless.Tracker {
 	cfg := &stateless.Config{}
 	cfg.Default()
-	mpt := stateless.New(cfg, test.TestPeerID1)
+	mpt := stateless.New(cfg, test.TestPeerID1, test.TestPeerName1)
 	mpt.SetClient(mockRPCClient(t))
 	return mpt
 }
 
 func testStatelessPinTracker(t testing.TB) *stateless.Tracker {
 	cfg := &stateless.Config{}
 	cfg.Default()
-	spt := stateless.New(cfg, test.TestPeerID1)
+	spt := stateless.New(cfg, test.TestPeerID1, test.TestPeerName1)
 	spt.SetClient(test.NewMockRPCClient(t))
 	return spt
 }

pintracker/stateless/stateless.go

@@ -44,15 +44,15 @@ type Tracker struct {
 }
 
 // New creates a new StatelessPinTracker.
-func New(cfg *Config, pid peer.ID) *Tracker {
+func New(cfg *Config, pid peer.ID, peerName string) *Tracker {
 	ctx, cancel := context.WithCancel(context.Background())
 
 	spt := &Tracker{
 		config:    cfg,
 		peerID:    pid,
 		ctx:       ctx,
 		cancel:    cancel,
-		optracker: optracker.NewOperationTracker(ctx, pid),
+		optracker: optracker.NewOperationTracker(ctx, pid, peerName),
 		rpcReady:  make(chan struct{}, 1),
 		pinCh:     make(chan *optracker.Operation, cfg.MaxPinQueueSize),
 		unpinCh:   make(chan *optracker.Operation, cfg.MaxPinQueueSize),

pintracker/stateless/stateless_test.go

@@ -102,15 +102,15 @@ func (mock *mockService) PinGet(ctx context.Context, in api.PinSerial, out *api.
 func testSlowStatelessPinTracker(t *testing.T) *Tracker {
 	cfg := &Config{}
 	cfg.Default()
-	mpt := New(cfg, test.TestPeerID1)
+	mpt := New(cfg, test.TestPeerID1, test.TestPeerName1)
 	mpt.SetClient(mockRPCClient(t))
 	return mpt
 }
 
 func testStatelessPinTracker(t testing.TB) *Tracker {
 	cfg := &Config{}
 	cfg.Default()
-	spt := New(cfg, test.TestPeerID1)
+	spt := New(cfg, test.TestPeerID1, test.TestPeerName1)
 	spt.SetClient(test.NewMockRPCClient(t))
 	return spt
 }

test/cids.go

@@ -22,6 +22,13 @@ var (
 	TestPeerID4, _ = peer.IDB58Decode("QmZ8naDy5mEz4GLuQwjWt9MPYqHTBbsm8tQBrNSjiq6zBc")
 	TestPeerID5, _ = peer.IDB58Decode("QmZVAo3wd8s5eTTy2kPYs34J9PvfxpKPuYsePPYGjgRRjg")
 	TestPeerID6, _ = peer.IDB58Decode("QmR8Vu6kZk7JvAN2rWVWgiduHatgBq2bb15Yyq8RRhYSbx")
+
+	TestPeerName1 = "TestPeer1"
+	TestPeerName2 = "TestPeer2"
+	TestPeerName3 = "TestPeer3"
+	TestPeerName4 = "TestPeer4"
+	TestPeerName5 = "TestPeer5"
+	TestPeerName6 = "TestPeer6"
 )
 
 // MustDecodeCid provides a test helper that ignores