aboutsummaryrefslogtreecommitdiffstats
path: root/rpc/subscription_test.go
blob: 0ba177e63b452da3c9a4bb4ac0300ca4d087df76 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
// Copyright 2016 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package rpc

import (
    "context"
    "encoding/json"
    "fmt"
    "net"
    "sync"
    "testing"
    "time"
)

type NotificationTestService struct {
    mu           sync.Mutex
    unsubscribed bool

    gotHangSubscriptionReq  chan struct{}
    unblockHangSubscription chan struct{}
}

func (s *NotificationTestService) Echo(i int) int {
    return i
}

func (s *NotificationTestService) wasUnsubCallbackCalled() bool {
    s.mu.Lock()
    defer s.mu.Unlock()
    return s.unsubscribed
}

func (s *NotificationTestService) Unsubscribe(subid string) {
    s.mu.Lock()
    s.unsubscribed = true
    s.mu.Unlock()
}

func (s *NotificationTestService) SomeSubscription(ctx context.Context, n, val int) (*Subscription, error) {
    notifier, supported := NotifierFromContext(ctx)
    if !supported {
        return nil, ErrNotificationsUnsupported
    }

    // by explicitly creating an subscription we make sure that the subscription id is send back to the client
    // before the first subscription.Notify is called. Otherwise the events might be send before the response
    // for the eth_subscribe method.
    subscription := notifier.CreateSubscription()

    go func() {
        // test expects n events, if we begin sending event immediately some events
        // will probably be dropped since the subscription ID might not be send to
        // the client.
        time.Sleep(5 * time.Second)
        for i := 0; i < n; i++ {
            if err := notifier.Notify(subscription.ID, val+i); err != nil {
                return
            }
        }

        select {
        case <-notifier.Closed():
            s.mu.Lock()
            s.unsubscribed = true
            s.mu.Unlock()
        case <-subscription.Err():
            s.mu.Lock()
            s.unsubscribed = true
            s.mu.Unlock()
        }
    }()

    return subscription, nil
}

// HangSubscription blocks on s.unblockHangSubscription before
// sending anything.
func (s *NotificationTestService) HangSubscription(ctx context.Context, val int) (*Subscription, error) {
    notifier, supported := NotifierFromContext(ctx)
    if !supported {
        return nil, ErrNotificationsUnsupported
    }

    s.gotHangSubscriptionReq <- struct{}{}
    <-s.unblockHangSubscription
    subscription := notifier.CreateSubscription()

    go func() {
        notifier.Notify(subscription.ID, val)
    }()
    return subscription, nil
}

func TestNotifications(t *testing.T) {
    server := NewServer()
    service := &NotificationTestService{}

    if err := server.RegisterName("eth", service); err != nil {
        t.Fatalf("unable to register test service %v", err)
    }

    clientConn, serverConn := net.Pipe()

    go server.ServeCodec(NewJSONCodec(serverConn), OptionMethodInvocation|OptionSubscriptions)

    out := json.NewEncoder(clientConn)
    in := json.NewDecoder(clientConn)

    n := 5
    val := 12345
    request := map[string]interface{}{
        "id":      1,
        "method":  "eth_subscribe",
        "version": "2.0",
        "params":  []interface{}{"someSubscription", n, val},
    }

    // create subscription
    if err := out.Encode(request); err != nil {
        t.Fatal(err)
    }

    var subid string
    response := jsonSuccessResponse{Result: subid}
    if err := in.Decode(&response); err != nil {
        t.Fatal(err)
    }

    var ok bool
    if _, ok = response.Result.(string); !ok {
        t.Fatalf("expected subscription id, got %T", response.Result)
    }

    for i := 0; i < n; i++ {
        var notification jsonNotification
        if err := in.Decode(&notification); err != nil {
            t.Fatalf("%v", err)
        }

        if int(notification.Params.Result.(float64)) != val+i {
            t.Fatalf("expected %d, got %d", val+i, notification.Params.Result)
        }
    }

    clientConn.Close() // causes notification unsubscribe callback to be called
    time.Sleep(1 * time.Second)

    if !service.wasUnsubCallbackCalled() {
        t.Error("unsubscribe callback not called after closing connection")
    }
}

func waitForMessages(t *testing.T, in *json.Decoder, successes chan<- jsonSuccessResponse,
    failures chan<- jsonErrResponse, notifications chan<- jsonNotification, errors chan<- error) {

    // read and parse server messages
    for {
        var rmsg json.RawMessage
        if err := in.Decode(&rmsg); err != nil {
            return
        }

        var responses []map[string]interface{}
        if rmsg[0] == '[' {
            if err := json.Unmarshal(rmsg, &responses); err != nil {
                errors <- fmt.Errorf("Received invalid message: %s", rmsg)
                return
            }
        } else {
            var msg map[string]interface{}
            if err := json.Unmarshal(rmsg, &msg); err != nil {
                errors <- fmt.Errorf("Received invalid message: %s", rmsg)
                return
            }
            responses = append(responses, msg)
        }

        for _, msg := range responses {
            // determine what kind of msg was received and broadcast
            // it to over the corresponding channel
            if _, found := msg["result"]; found {
                successes <- jsonSuccessResponse{
                    Version: msg["jsonrpc"].(string),
                    Id:      msg["id"],
                    Result:  msg["result"],
                }
                continue
            }
            if _, found := msg["error"]; found {
                params := msg["params"].(map[string]interface{})
                failures <- jsonErrResponse{
                    Version: msg["jsonrpc"].(string),
                    Id:      msg["id"],
                    Error:   jsonError{int(params["subscription"].(float64)), params["message"].(string), params["data"]},
                }
                continue
            }
            if _, found := msg["params"]; found {
                params := msg["params"].(map[string]interface{})
                notifications <- jsonNotification{
                    Version: msg["jsonrpc"].(string),
                    Method:  msg["method"].(string),
                    Params:  jsonSubscription{params["subscription"].(string), params["result"]},
                }
                continue
            }
            errors <- fmt.Errorf("Received invalid message: %s", msg)
        }
    }
}

// TestSubscriptionMultipleNamespaces ensures that subscriptions can exists
// for multiple different namespaces.
func TestSubscriptionMultipleNamespaces(t *testing.T) {
    var (
        namespaces             = []string{"eth", "shh", "bzz"}
        server                 = NewServer()
        service                = NotificationTestService{}
        clientConn, serverConn = net.Pipe()

        out           = json.NewEncoder(clientConn)
        in            = json.NewDecoder(clientConn)
        successes     = make(chan jsonSuccessResponse)
        failures      = make(chan jsonErrResponse)
        notifications = make(chan jsonNotification)

        errors = make(chan error, 10)
    )

    // setup and start server
    for _, namespace := range namespaces {
        if err := server.RegisterName(namespace, &service); err != nil {
            t.Fatalf("unable to register test service %v", err)
        }
    }

    go server.ServeCodec(NewJSONCodec(serverConn), OptionMethodInvocation|OptionSubscriptions)
    defer server.Stop()

    // wait for message and write them to the given channels
    go waitForMessages(t, in, successes, failures, notifications, errors)

    // create subscriptions one by one
    n := 3
    for i, namespace := range namespaces {
        request := map[string]interface{}{
            "id":      i,
            "method":  fmt.Sprintf("%s_subscribe", namespace),
            "version": "2.0",
            "params":  []interface{}{"someSubscription", n, i},
        }

        if err := out.Encode(&request); err != nil {
            t.Fatalf("Could not create subscription: %v", err)
        }
    }

    // create all subscriptions in 1 batch
    var requests []interface{}
    for i, namespace := range namespaces {
        requests = append(requests, map[string]interface{}{
            "id":      i,
            "method":  fmt.Sprintf("%s_subscribe", namespace),
            "version": "2.0",
            "params":  []interface{}{"someSubscription", n, i},
        })
    }

    if err := out.Encode(&requests); err != nil {
        t.Fatalf("Could not create subscription in batch form: %v", err)
    }

    timeout := time.After(30 * time.Second)
    subids := make(map[string]string, 2*len(namespaces))
    count := make(map[string]int, 2*len(namespaces))

    for {
        done := true
        for id := range count {
            if count, found := count[id]; !found || count < (2*n) {
                done = false
            }
        }

        if done && len(count) == len(namespaces) {
            break
        }

        select {
        case err := <-errors:
            t.Fatal(err)
        case suc := <-successes: // subscription created
            subids[namespaces[int(suc.Id.(float64))]] = suc.Result.(string)
        case failure := <-failures:
            t.Errorf("received error: %v", failure.Error)
        case notification := <-notifications:
            if cnt, found := count[notification.Params.Subscription]; found {
                count[notification.Params.Subscription] = cnt + 1
            } else {
                count[notification.Params.Subscription] = 1
            }
        case <-timeout:
            for _, namespace := range namespaces {
                subid, found := subids[namespace]
                if !found {
                    t.Errorf("Subscription for '%s' not created", namespace)
                    continue
                }
                if count, found := count[subid]; !found || count < n {
                    t.Errorf("Didn't receive all notifications (%d<%d) in time for namespace '%s'", count, n, namespace)
                }
            }
            return
        }
    }
}