From b8928b1e574b659601112ea19ede86f4edaf7010 Mon Sep 17 00:00:00 2001
From: Austin Roberts <austin.roberts@openrelay.xyz>
Date: Wed, 15 Sep 2021 08:54:04 -0500
Subject: [PATCH] Add code comments, remove debug logging

---
 rpc/plugin_subscriptions.go | 31 +++++++++++++++++++++++++------
 1 file changed, 25 insertions(+), 6 deletions(-)

diff --git a/rpc/plugin_subscriptions.go b/rpc/plugin_subscriptions.go
index 6afcf0e01..165717176 100644
--- a/rpc/plugin_subscriptions.go
+++ b/rpc/plugin_subscriptions.go
@@ -49,6 +49,31 @@ func callbackifyChanPubSub(receiver, fn reflect.Value) *callback {
 
 	retFnType := reflect.FuncOf(append([]reflect.Type{receiver.Type(), contextType}, c.argTypes...), []reflect.Type{subscriptionType, errorType}, false)
 
+// // What follows uses reflection to construct a dynamically typed function equivalent to:
+// func(receiver <T>, cctx context.Context, args ...<T>) (rpc.Subscription, error) {
+// 	notifier, supported := NotifierFromContext(cctx)
+// 	if !supported { return Subscription{}, ErrNotificationsUnsupported}
+// 	ctx, cancel := context.WithCancel(context.Background())
+// 	ch, err := fn()
+// 	if err != nil { return Subscription{}, err }
+// 	rpcSub := notifier.CreateSubscription()
+// 	go func() {
+// 		select {
+// 		case v, ok := <- ch:
+// 			if !ok { return }
+// 			notifier.Notify(rpcSub.ID, v)
+// 		case <-rpcSub.Err():
+// 			cancel()
+// 			return
+// 		case <-notifier.Closed():
+// 			cancel()
+// 			return
+// 		}
+// 	}()
+// 	return rpcSub, nil
+// }
+//
+
 	c.fn = reflect.MakeFunc(retFnType, func(args []reflect.Value) ([]reflect.Value) {
 		notifier, supported := NotifierFromContext(args[1].Interface().(context.Context))
 		if !supported {
@@ -56,9 +81,7 @@ func callbackifyChanPubSub(receiver, fn reflect.Value) *callback {
 		}
 		ctx, cancel := context.WithCancel(context.Background())
 		args[1] = reflect.ValueOf(ctx)
-		log.Info("Calling with args", "args", args, "expecting", fntype.NumIn())
 		out := fn.Call(args)
-		log.Info("Called with args", "args", args, "out", out)
 		if !out[1].IsNil() {
 			// This amounts to: if err != nil { return nil, err }
 			return []reflect.Value{reflect.Zero(subscriptionType), out[1]}
@@ -79,17 +102,13 @@ func callbackifyChanPubSub(receiver, fn reflect.Value) *callback {
 				switch chosen {
 				case 0: // val, ok := <-ch
 					if !recvOK {
-						log.Info("!recvok, closing")
 						return
 					}
-					log.Info("Sending value to notifier", "value", val.Interface())
 					notifier.Notify(rpcSub.ID, val.Interface())
 				case 1:
-					log.Info("rpcSubErr")
 					cancel()
 					return
 				case 2:
-					log.Info("notifier closed")
 					cancel()
 					return
 				}