Fire a transfer queued event when a transfer is queued in Graphsync (#221)

* req queued event in GS

* fire a transfer queued event

* changes as per review and tests

* address nit

* update graphsync deps

Author: aarshkshah1992

channels/channels.go

@@ -215,6 +215,10 @@ func (c *Channels) Accept(chid datatransfer.ChannelID) error {
 	return c.send(chid, datatransfer.Accept)
 }
 
+func (c *Channels) TransferRequestQueued(chid datatransfer.ChannelID) error {
+	return c.send(chid, datatransfer.TransferRequestQueued)
+}
+
 // Restart marks a data transfer as restarted
 func (c *Channels) Restart(chid datatransfer.ChannelID) error {
 	return c.send(chid, datatransfer.Restart)

channels/channels_fsm.go

@@ -34,6 +34,13 @@ var ChannelEvents = fsm.Events{
 		chst.AddLog("")
 		return nil
 	}),
+
+	fsm.Event(datatransfer.TransferRequestQueued).FromAny().ToJustRecord().Action(func(chst *internal.ChannelState) error {
+		chst.Message = ""
+		chst.AddLog("")
+		return nil
+	}),
+
 	fsm.Event(datatransfer.Restart).FromAny().ToJustRecord().Action(func(chst *internal.ChannelState) error {
 		chst.Message = ""
 		chst.AddLog("")

channels/channels_test.go

@@ -127,6 +127,17 @@ func TestChannels(t *testing.T) {
 		require.True(t, xerrors.As(err, new(*channels.ErrNotFound)))
 	})
 
+	t.Run("transfer queued", func(t *testing.T) {
+		state, err := channelList.GetByID(ctx, datatransfer.ChannelID{Initiator: peers[0], Responder: peers[1], ID: tid1})
+		require.NoError(t, err)
+		require.Equal(t, state.Status(), datatransfer.Ongoing)
+
+		err = channelList.TransferRequestQueued(datatransfer.ChannelID{Initiator: peers[0], Responder: peers[1], ID: tid1})
+		require.NoError(t, err)
+		state = checkEvent(ctx, t, received, datatransfer.TransferRequestQueued)
+		require.Equal(t, state.Status(), datatransfer.Ongoing)
+	})
+
 	t.Run("updating send/receive values", func(t *testing.T) {
 		ds := dss.MutexWrap(datastore.NewMapDatastore())
 		dir := os.TempDir()

events.go

@@ -102,6 +102,9 @@ const (
 	// ReceiveDataError indicates that the transport layer had an error
 	// receiving data from the remote peer
 	ReceiveDataError
+
+	// TransferRequestQueued indicates that a new data transfer request has been queued in the transport layer
+	TransferRequestQueued
 )
 
 // Events are human readable names for data transfer events
@@ -134,6 +137,7 @@ var Events = map[EventCode]string{
 	RequestTimedOut:             "RequestTimedOut",
 	SendDataError:               "SendDataError",
 	ReceiveDataError:            "ReceiveDataError",
+	TransferRequestQueued:       "TransferRequestQueued",
 }
 
 // Event is a struct containing information about a data transfer event

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/ipfs/go-cid v0.0.7
 	github.com/ipfs/go-datastore v0.4.5
 	github.com/ipfs/go-ds-badger v0.2.3
-	github.com/ipfs/go-graphsync v0.6.1
+	github.com/ipfs/go-graphsync v0.6.4
 	github.com/ipfs/go-ipfs-blockstore v1.0.1
 	github.com/ipfs/go-ipfs-blocksutil v0.0.1
 	github.com/ipfs/go-ipfs-chunker v0.0.5

go.sum

@@ -215,8 +215,8 @@ github.com/ipfs/go-ds-badger v0.2.3/go.mod h1:pEYw0rgg3FIrywKKnL+Snr+w/LjJZVMTBR
 github.com/ipfs/go-ds-leveldb v0.0.1/go.mod h1:feO8V3kubwsEF22n0YRQCffeb79OOYIykR4L04tMOYc=
 github.com/ipfs/go-ds-leveldb v0.4.1/go.mod h1:jpbku/YqBSsBc1qgME8BkWS4AxzF2cEu1Ii2r79Hh9s=
 github.com/ipfs/go-ds-leveldb v0.4.2/go.mod h1:jpbku/YqBSsBc1qgME8BkWS4AxzF2cEu1Ii2r79Hh9s=
-github.com/ipfs/go-graphsync v0.6.1 h1:i9wN7YkBXWwIsUjVQeuaDxFB59yWZrG1xL564Nz7aGE=
-github.com/ipfs/go-graphsync v0.6.1/go.mod h1:e2ZxnClqBBYAtd901g9vXMJzS47labjAtOzsWtOzKNk=
+github.com/ipfs/go-graphsync v0.6.4 h1:g6wFRK2BkLPnx8nfoSdnokp5gtpuGyWZjbqI6q3NGb8=
+github.com/ipfs/go-graphsync v0.6.4/go.mod h1:5WyaeigpNdpiYQuW2vwpuecOoEfB4h747ZGEOKmAGTg=
 github.com/ipfs/go-ipfs-blockstore v0.0.1/go.mod h1:d3WClOmRQKFnJ0Jz/jj/zmksX0ma1gROTlovZKBmN08=
 github.com/ipfs/go-ipfs-blockstore v0.1.0/go.mod h1:5aD0AvHPi7mZc6Ci1WCAhiBQu2IsfTduLl+422H6Rqw=
 github.com/ipfs/go-ipfs-blockstore v0.1.4/go.mod h1:Jxm3XMVjh6R17WvxFEiyKBLUGr86HgIYJW/D/MwqeYQ=

impl/events.go

@@ -160,6 +160,10 @@ func (m *manager) OnRequestReceived(chid datatransfer.ChannelID, request datatra
 	return nil, nil
 }
 
+func (m *manager) OnTransferQueued(chid datatransfer.ChannelID) {
+	m.channels.TransferRequestQueued(chid)
+}
+
 func (m *manager) OnResponseReceived(chid datatransfer.ChannelID, response datatransfer.Response) error {
 	if response.IsCancel() {
 		log.Infof("channel %s: received cancel response, cancelling channel", chid)

testutil/fakegraphsync.go

@@ -106,6 +106,7 @@ type FakeGraphSync struct {
 	OutgoingRequestHook          graphsync.OnOutgoingRequestHook
 	IncomingBlockHook            graphsync.OnIncomingBlockHook
 	OutgoingBlockHook            graphsync.OnOutgoingBlockHook
+	IncomingRequestQueuedHook    graphsync.OnIncomingRequestQueuedHook
 	IncomingRequestHook          graphsync.OnIncomingRequestHook
 	CompletedResponseListener    graphsync.OnResponseCompletedListener
 	RequestUpdatedHook           graphsync.OnRequestUpdatedHook
@@ -286,6 +287,14 @@ func (fgs *FakeGraphSync) RegisterIncomingRequestHook(hook graphsync.OnIncomingR
 	}
 }
 
+// RegisterIncomingRequestQueuedHook adds a hook that runs when an incoming GS request is queued.
+func (fgs *FakeGraphSync) RegisterIncomingRequestQueuedHook(hook graphsync.OnIncomingRequestQueuedHook) graphsync.UnregisterHookFunc {
+	fgs.IncomingRequestQueuedHook = hook
+	return func() {
+		fgs.IncomingRequestQueuedHook = nil
+	}
+}
+
 // RegisterIncomingResponseHook adds a hook that runs when a response is received
 func (fgs *FakeGraphSync) RegisterIncomingResponseHook(hook graphsync.OnIncomingResponseHook) graphsync.UnregisterHookFunc {
 	fgs.IncomingResponseHook = hook

transport.go

@@ -39,6 +39,9 @@ type EventsHandler interface {
 	// OnDataSent is called when we send data for the given channel ID
 	OnDataSent(chid ChannelID, link ipld.Link, size uint64) error
 
+	// OnTransferQueued is called when a new data transfer request is queued in the transport layer.
+	OnTransferQueued(chid ChannelID)
+
 	// OnRequestReceived is called when we receive a new request to send data
 	// for the given channel ID
 	// return values are:

transport/graphsync/graphsync.go

@@ -285,6 +285,7 @@ func (t *Transport) SetEventHandler(events datatransfer.EventsHandler) error {
 	}
 	t.events = events
 
+	t.unregisterFuncs = append(t.unregisterFuncs, t.gs.RegisterIncomingRequestQueuedHook(t.gsReqQueuedHook))
 	t.unregisterFuncs = append(t.unregisterFuncs, t.gs.RegisterIncomingRequestHook(t.gsReqRecdHook))
 	t.unregisterFuncs = append(t.unregisterFuncs, t.gs.RegisterCompletedResponseListener(t.gsCompletedResponseListener))
 	t.unregisterFuncs = append(t.unregisterFuncs, t.gs.RegisterIncomingBlockHook(t.gsIncomingBlockHook))
@@ -448,6 +449,40 @@ func (t *Transport) gsOutgoingBlockHook(p peer.ID, request graphsync.RequestData
 	}
 }
 
+// gsReqQueuedHook is called when graphsync enqueues an incoming request for data
+func (t *Transport) gsReqQueuedHook(p peer.ID, request graphsync.RequestData) {
+	msg, err := extension.GetTransferData(request, t.supportedExtensions)
+	if err != nil {
+		log.Errorf("failed GetTransferData, req=%+v, err=%s", request, err)
+	}
+	// extension not found; probably not our request.
+	if msg == nil {
+		return
+	}
+
+	var chid datatransfer.ChannelID
+	if msg.IsRequest() {
+		// when a data transfer request comes in on graphsync, the remote peer
+		// initiated a pull
+		chid = datatransfer.ChannelID{ID: msg.TransferID(), Initiator: p, Responder: t.peerID}
+		request := msg.(datatransfer.Request)
+		if request.IsNew() {
+			log.Infof("%s, pull request queued, req=%+v", chid, request)
+			t.events.OnTransferQueued(chid)
+		}
+	} else {
+		// when a data transfer response comes in on graphsync, this node
+		// initiated a push, and the remote peer responded with a request
+		// for data
+		chid = datatransfer.ChannelID{ID: msg.TransferID(), Initiator: t.peerID, Responder: p}
+		response := msg.(datatransfer.Response)
+		if response.IsNew() {
+			log.Infof("%s, GS pull request queued in response to our push, req=%+v", chid, request)
+			t.events.OnTransferQueued(chid)
+		}
+	}
+}
+
 // gsReqRecdHook is called when graphsync receives an incoming request for data
 func (t *Transport) gsReqRecdHook(p peer.ID, request graphsync.RequestData, hookActions graphsync.IncomingRequestHookActions) {
 	// if this is a push request the sender is us.