refactor: change naming to reflect blocks -> keys

This commit was moved from ipfs/go-bitswap@693e97d

Author: dirkmc

bitswap/bitswap.go

@@ -330,7 +330,7 @@ func (bs *Bitswap) receiveBlocksFrom(from peer.ID, blks []blocks.Block) error {
 
 	// Send all block keys (including duplicates) to any sessions that want them.
 	// (The duplicates are needed by sessions for accounting purposes)
-	bs.sm.ReceiveBlocksFrom(from, allKs)
+	bs.sm.ReceiveFrom(from, allKs)
 
 	// Send wanted block keys to decision engine
 	bs.engine.AddBlocks(wantedKs)

bitswap/session/session.go

@@ -52,9 +52,9 @@ type interestReq struct {
 	resp chan bool
 }
 
-type blksRecv struct {
+type rcvFrom struct {
 	from peer.ID
-	ks []cid.Cid
+	ks   []cid.Cid
 }
 
 // Session holds state for an individual bitswap transfer operation.
@@ -68,7 +68,7 @@ type Session struct {
 	srs RequestSplitter
 
 	// channels
-	incoming      chan blksRecv
+	incoming      chan rcvFrom
 	newReqs       chan []cid.Cid
 	cancelKeys    chan []cid.Cid
 	interestReqs  chan interestReq
@@ -117,7 +117,7 @@ func New(ctx context.Context,
 		wm:                  wm,
 		pm:                  pm,
 		srs:                 srs,
-		incoming:            make(chan blksRecv),
+		incoming:            make(chan rcvFrom),
 		notif:               notif,
 		uuid:                loggables.Uuid("GetBlockRequest"),
 		baseTickDelay:       time.Millisecond * 500,
@@ -134,10 +134,10 @@ func New(ctx context.Context,
 	return s
 }
 
-// ReceiveBlocksFrom receives incoming blocks from the given peer.
-func (s *Session) ReceiveBlocksFrom(from peer.ID, ks []cid.Cid) {
+// ReceiveFrom receives incoming blocks from the given peer.
+func (s *Session) ReceiveFrom(from peer.ID, ks []cid.Cid) {
 	select {
-	case s.incoming <- blksRecv{from: from, ks: ks}:
+	case s.incoming <- rcvFrom{from: from, ks: ks}:
 	case <-s.ctx.Done():
 	}
 }
@@ -232,13 +232,13 @@ func (s *Session) run(ctx context.Context) {
 	for {
 		select {
 		case rcv := <-s.incoming:
-			s.cancelIncomingBlocks(ctx, rcv)
+			s.cancelIncoming(ctx, rcv)
 			// Record statistics only if the blocks came from the network
 			// (blocks can also be received from the local node)
 			if rcv.from != "" {
 				s.updateReceiveCounters(ctx, rcv)
 			}
-			s.handleIncomingBlocks(ctx, rcv)
+			s.handleIncoming(ctx, rcv)
 		case keys := <-s.newReqs:
 			s.handleNewRequest(ctx, keys)
 		case keys := <-s.cancelKeys:
@@ -260,7 +260,7 @@ func (s *Session) run(ctx context.Context) {
 	}
 }
 
-func (s *Session) cancelIncomingBlocks(ctx context.Context, rcv blksRecv) {
+func (s *Session) cancelIncoming(ctx context.Context, rcv rcvFrom) {
 	// We've received the blocks so we can cancel any outstanding wants for them
 	wanted := make([]cid.Cid, 0, len(rcv.ks))
 	for _, k := range rcv.ks {
@@ -272,11 +272,11 @@ func (s *Session) cancelIncomingBlocks(ctx context.Context, rcv blksRecv) {
 	s.wm.CancelWants(s.ctx, wanted, nil, s.id)
 }
 
-func (s *Session) handleIncomingBlocks(ctx context.Context, rcv blksRecv) {
+func (s *Session) handleIncoming(ctx context.Context, rcv rcvFrom) {
 	s.idleTick.Stop()
 
 	// Process the received blocks
-	s.receiveBlocks(ctx, rcv.ks)
+	s.processIncoming(ctx, rcv.ks)
 
 	s.resetIdleTick()
 }
@@ -376,7 +376,7 @@ func (s *Session) cidIsWanted(c cid.Cid) bool {
 	return ok
 }
 
-func (s *Session) receiveBlocks(ctx context.Context, ks []cid.Cid) {
+func (s *Session) processIncoming(ctx context.Context, ks []cid.Cid) {
 	for _, c := range ks {
 		if s.cidIsWanted(c) {
 			// If the block CID was in the live wants queue, remove it
@@ -414,7 +414,7 @@ func (s *Session) receiveBlocks(ctx context.Context, ks []cid.Cid) {
 	}
 }
 
-func (s *Session) updateReceiveCounters(ctx context.Context, rcv blksRecv) {
+func (s *Session) updateReceiveCounters(ctx context.Context, rcv rcvFrom) {
 	for _, k := range rcv.ks {
 		// Inform the request splitter of unique / duplicate blocks
 		if s.cidIsWanted(k) {

bitswap/session/session_test.go

@@ -126,10 +126,10 @@ func TestSessionGetBlocks(t *testing.T) {
 	var receivedBlocks []blocks.Block
 	for i, p := range peers {
 		// simulate what bitswap does on receiving a message:
-		// - calls ReceiveBlocksFrom() on session
+		// - calls ReceiveFrom() on session
 		// - publishes block to pubsub channel
 		blk := blks[testutil.IndexOf(blks, receivedWantReq.cids[i])]
-		session.ReceiveBlocksFrom(p, []cid.Cid{blk.Cid()})
+		session.ReceiveFrom(p, []cid.Cid{blk.Cid()})
 		notif.Publish(blk)
 
 		select {
@@ -188,10 +188,10 @@ func TestSessionGetBlocks(t *testing.T) {
 	// receive remaining blocks
 	for i, p := range peers {
 		// simulate what bitswap does on receiving a message:
-		// - calls ReceiveBlocksFrom() on session
+		// - calls ReceiveFrom() on session
 		// - publishes block to pubsub channel
 		blk := blks[testutil.IndexOf(blks, newCidsRequested[i])]
-		session.ReceiveBlocksFrom(p, []cid.Cid{blk.Cid()})
+		session.ReceiveFrom(p, []cid.Cid{blk.Cid()})
 		notif.Publish(blk)
 
 		receivedBlock := <-getBlocksCh
@@ -252,10 +252,10 @@ func TestSessionFindMorePeers(t *testing.T) {
 	p := testutil.GeneratePeers(1)[0]
 
 	// simulate what bitswap does on receiving a message:
-	// - calls ReceiveBlocksFrom() on session
+	// - calls ReceiveFrom() on session
 	// - publishes block to pubsub channel
 	blk := blks[0]
-	session.ReceiveBlocksFrom(p, []cid.Cid{blk.Cid()})
+	session.ReceiveFrom(p, []cid.Cid{blk.Cid()})
 	notif.Publish(blk)
 	select {
 	case <-cancelReqs:

bitswap/sessionmanager/sessionmanager.go

@@ -18,7 +18,7 @@ import (
 type Session interface {
 	exchange.Fetcher
 	InterestedIn(cid.Cid) bool
-	ReceiveBlocksFrom(peer.ID, []cid.Cid)
+	ReceiveFrom(peer.ID, []cid.Cid)
 }
 
 type sesTrk struct {
@@ -114,9 +114,9 @@ func (sm *SessionManager) GetNextSessionID() uint64 {
 	return sm.sessID
 }
 
-// ReceiveBlocksFrom receives blocks from a peer and dispatches to interested
+// ReceiveFrom receives blocks from a peer and dispatches to interested
 // sessions.
-func (sm *SessionManager) ReceiveBlocksFrom(from peer.ID, ks []cid.Cid) {
+func (sm *SessionManager) ReceiveFrom(from peer.ID, ks []cid.Cid) {
 	sm.sessLk.Lock()
 	defer sm.sessLk.Unlock()
 
@@ -128,6 +128,6 @@ func (sm *SessionManager) ReceiveBlocksFrom(from peer.ID, ks []cid.Cid) {
 				sessKs = append(sessKs, k)
 			}
 		}
-		s.session.ReceiveBlocksFrom(from, sessKs)
+		s.session.ReceiveFrom(from, sessKs)
 	}
 }

bitswap/sessionmanager/sessionmanager_test.go

@@ -40,7 +40,7 @@ func (fs *fakeSession) InterestedIn(c cid.Cid) bool {
 	}
 	return false
 }
-func (fs *fakeSession) ReceiveBlocksFrom(p peer.ID, ks []cid.Cid) {
+func (fs *fakeSession) ReceiveFrom(p peer.ID, ks []cid.Cid) {
 	fs.ks = append(fs.ks, ks...)
 }
 
@@ -137,7 +137,7 @@ func TestAddingSessions(t *testing.T) {
 		thirdSession.id != secondSession.id+2 {
 		t.Fatal("session does not have correct id set")
 	}
-	sm.ReceiveBlocksFrom(p, []cid.Cid{block.Cid()})
+	sm.ReceiveFrom(p, []cid.Cid{block.Cid()})
 	if len(firstSession.ks) == 0 ||
 		len(secondSession.ks) == 0 ||
 		len(thirdSession.ks) == 0 {
@@ -167,7 +167,7 @@ func TestReceivingBlocksWhenNotInterested(t *testing.T) {
 	nextInterestedIn = []cid.Cid{}
 	thirdSession := sm.NewSession(ctx, time.Second, delay.Fixed(time.Minute)).(*fakeSession)
 
-	sm.ReceiveBlocksFrom(p, []cid.Cid{blks[0].Cid(), blks[1].Cid()})
+	sm.ReceiveFrom(p, []cid.Cid{blks[0].Cid(), blks[1].Cid()})
 
 	if !cmpSessionCids(firstSession, []cid.Cid{cids[0], cids[1]}) ||
 		!cmpSessionCids(secondSession, []cid.Cid{cids[0]}) ||
@@ -194,7 +194,7 @@ func TestRemovingPeersWhenManagerContextCancelled(t *testing.T) {
 	cancel()
 	// wait for sessions to get removed
 	time.Sleep(10 * time.Millisecond)
-	sm.ReceiveBlocksFrom(p, []cid.Cid{block.Cid()})
+	sm.ReceiveFrom(p, []cid.Cid{block.Cid()})
 	if len(firstSession.ks) > 0 ||
 		len(secondSession.ks) > 0 ||
 		len(thirdSession.ks) > 0 {
@@ -222,7 +222,7 @@ func TestRemovingPeersWhenSessionContextCancelled(t *testing.T) {
 	sessionCancel()
 	// wait for sessions to get removed
 	time.Sleep(10 * time.Millisecond)
-	sm.ReceiveBlocksFrom(p, []cid.Cid{block.Cid()})
+	sm.ReceiveFrom(p, []cid.Cid{block.Cid()})
 	if len(firstSession.ks) == 0 ||
 		len(secondSession.ks) > 0 ||
 		len(thirdSession.ks) == 0 {