aboutsummaryrefslogtreecommitdiffstats
path: root/rpc/v2/server.go
blob: 4c04f04d24a6b6a061db322d84aba6e0aa154e90 (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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
// Copyright 2015 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 v2

import (
    "fmt"
    "reflect"

    "runtime"

    "github.com/ethereum/go-ethereum/event"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/logger/glog"
    "golang.org/x/net/context"
)

// NewServer will create a new server instance with no registered handlers.
func NewServer() *Server {
    server := &Server{services: make(serviceRegistry), subscriptions: make(subscriptionRegistry)}

    // register a default service which will provide meta information about the RPC service such as the services and
    // methods it offers.
    rpcService := &RPCService{server}
    server.RegisterName("rpc", rpcService)

    return server
}

// RPCService gives meta information about the server.
// e.g. gives information about the loaded modules.
type RPCService struct {
    server *Server
}

// Modules returns the list of RPC services with their version number
func (s *RPCService) Modules() map[string]string {
    modules := make(map[string]string)
    for name, _ := range s.server.services {
        modules[name] = "1.0"
    }
    return modules
}

// RegisterName will create an service for the given rcvr type under the given name. When no methods on the given rcvr
// match the criteria to be either a RPC method or a subscription an error is returned. Otherwise a new service is
// created and added to the service collection this server instance serves.
func (s *Server) RegisterName(name string, rcvr interface{}) error {
    if s.services == nil {
        s.services = make(serviceRegistry)
    }

    svc := new(service)
    svc.typ = reflect.TypeOf(rcvr)
    rcvrVal := reflect.ValueOf(rcvr)

    if name == "" {
        return fmt.Errorf("no service name for type %s", svc.typ.String())
    }
    if !isExported(reflect.Indirect(rcvrVal).Type().Name()) {
        return fmt.Errorf("%s is not exported", reflect.Indirect(rcvrVal).Type().Name())
    }

    // already a previous service register under given sname, merge methods/subscriptions
    if regsvc, present := s.services[name]; present {
        methods, subscriptions := suitableCallbacks(rcvrVal, svc.typ)
        if len(methods) == 0 && len(subscriptions) == 0 {
            return fmt.Errorf("Service doesn't have any suitable methods/subscriptions to expose")
        }

        for _, m := range methods {
            regsvc.callbacks[formatName(m.method.Name)] = m
        }
        for _, s := range subscriptions {
            regsvc.subscriptions[formatName(s.method.Name)] = s
        }

        return nil
    }

    svc.name = name
    svc.callbacks, svc.subscriptions = suitableCallbacks(rcvrVal, svc.typ)

    if len(svc.callbacks) == 0 && len(svc.subscriptions) == 0 {
        return fmt.Errorf("Service doesn't have any suitable methods/subscriptions to expose")
    }

    s.services[svc.name] = svc

    return nil
}

// ServeCodec reads incoming requests from codec, calls the appropriate callback and writes the
// response back using the given codec. It will block until the codec is closed.
//
// This server will:
// 1. allow for asynchronous and parallel request execution
// 2. supports notifications (pub/sub)
// 3. supports request batches
func (s *Server) ServeCodec(codec ServerCodec) {
    defer func() {
        if err := recover(); err != nil {
            const size = 64 << 10
            buf := make([]byte, size)
            buf = buf[:runtime.Stack(buf, false)]
            glog.Errorln(string(buf))
        }
        codec.Close()
    }()

    ctx, cancel := context.WithCancel(context.Background())
    defer cancel()

    for {
        reqs, batch, err := s.readRequest(codec)
        if err != nil {
            glog.V(logger.Debug).Infof("%v\n", err)
            codec.Write(codec.CreateErrorResponse(nil, err))
            break
        }

        if batch {
            go s.execBatch(ctx, codec, reqs)
        } else {
            go s.exec(ctx, codec, reqs[0])
        }
    }
}

// sendNotification will create a notification from the given event by serializing member fields of the event.
// It will then send the notification to the client, when it fails the codec is closed. When the event has multiple
// fields an array of values is returned.
func sendNotification(codec ServerCodec, subid string, event interface{}) {
    notification := codec.CreateNotification(subid, event)

    if err := codec.Write(notification); err != nil {
        codec.Close()
    }
}

// createSubscription will register a new subscription and waits for raised events. When an event is raised it will:
// 1. test if the event is raised matches the criteria the user has (optionally) specified
// 2. create a notification of the event and send it the client when it matches the criteria
// It will unsubscribe the subscription when the socket is closed or the subscription is unsubscribed by the user.
func (s *Server) createSubscription(c ServerCodec, req *serverRequest) (string, error) {
    args := []reflect.Value{req.callb.rcvr}
    if len(req.args) > 0 {
        args = append(args, req.args...)
    }

    subid, err := newSubscriptionId()
    if err != nil {
        return "", err
    }

    reply := req.callb.method.Func.Call(args)

    if reply[1].IsNil() { // no error
        if subscription, ok := reply[0].Interface().(Subscription); ok {
            s.muSubcriptions.Lock()
            s.subscriptions[subid] = subscription
            s.muSubcriptions.Unlock()
            go func() {
                cases := []reflect.SelectCase{
                    reflect.SelectCase{Dir: reflect.SelectRecv, Chan: reflect.ValueOf(subscription.Chan())}, // new event
                    reflect.SelectCase{Dir: reflect.SelectRecv, Chan: reflect.ValueOf(c.Closed())},          // connection closed
                }

                for {
                    idx, notification, recvOk := reflect.Select(cases)
                    switch idx {
                    case 0: // new event, or channel closed
                        if recvOk { // send notification
                            if event, ok := notification.Interface().(*event.Event); ok {
                                if subscription.match == nil || subscription.match(event.Data) {
                                    sendNotification(c, subid, subscription.format(event.Data))
                                }
                            }
                        } else { // user send an eth_unsubscribe request
                            return
                        }
                    case 1: // connection closed
                        s.unsubscribe(subid)
                        return
                    }
                }
            }()
        } else { // unable to create subscription
            s.muSubcriptions.Lock()
            delete(s.subscriptions, subid)
            s.muSubcriptions.Unlock()
        }
    } else {
        return "", fmt.Errorf("Unable to create subscription")
    }

    return subid, nil
}

// unsubscribe calls the Unsubscribe method on the subscription and removes a subscription from the subscription
// registry.
func (s *Server) unsubscribe(subid string) bool {
    s.muSubcriptions.Lock()
    defer s.muSubcriptions.Unlock()
    if sub, ok := s.subscriptions[subid]; ok {
        sub.Unsubscribe()
        delete(s.subscriptions, subid)
        return true
    }
    return false
}

// handle executes a request and returns the response from the callback.
func (s *Server) handle(ctx context.Context, codec ServerCodec, req *serverRequest) interface{} {
    if req.err != nil {
        return codec.CreateErrorResponse(&req.id, req.err)
    }

    if req.isUnsubscribe { // first param must be the subscription id
        if len(req.args) >= 1 && req.args[0].Kind() == reflect.String {
            subid := req.args[0].String()
            if s.unsubscribe(subid) {
                return codec.CreateResponse(req.id, true)
            } else {
                return codec.CreateErrorResponse(&req.id,
                    &callbackError{fmt.Sprintf("subscription '%s' not found", subid)})
            }
        }
        return codec.CreateErrorResponse(&req.id, &invalidParamsError{"Expected subscription id as argument"})
    }

    if req.callb.isSubscribe {
        subid, err := s.createSubscription(codec, req)
        if err != nil {
            return codec.CreateErrorResponse(&req.id, &callbackError{err.Error()})
        }
        return codec.CreateResponse(req.id, subid)
    }

    // regular RPC call
    if len(req.args) != len(req.callb.argTypes) {
        rpcErr := &invalidParamsError{fmt.Sprintf("%s%s%s expects %d parameters, got %d",
            req.svcname, serviceMethodSeparator, req.callb.method.Name,
            len(req.callb.argTypes), len(req.args))}
        return codec.CreateErrorResponse(&req.id, rpcErr)
    }

    arguments := []reflect.Value{req.callb.rcvr}
    if req.callb.hasCtx {
        arguments = append(arguments, reflect.ValueOf(ctx))
    }
    if len(req.args) > 0 {
        arguments = append(arguments, req.args...)
    }

    reply := req.callb.method.Func.Call(arguments)

    if len(reply) == 0 {
        return codec.CreateResponse(req.id, nil)
    }

    if req.callb.errPos >= 0 { // test if method returned an error
        if !reply[req.callb.errPos].IsNil() {
            e := reply[req.callb.errPos].Interface().(error)
            res := codec.CreateErrorResponse(&req.id, &callbackError{e.Error()})
            return res
        }
    }

    return codec.CreateResponse(req.id, reply[0].Interface())
}

// exec executes the given request and writes the result back using the codec.
func (s *Server) exec(ctx context.Context, codec ServerCodec, req *serverRequest) {
    var response interface{}
    if req.err != nil {
        response = codec.CreateErrorResponse(&req.id, req.err)
    } else {
        response = s.handle(ctx, codec, req)
    }

    if err := codec.Write(response); err != nil {
        glog.V(logger.Error).Infof("%v\n", err)
        codec.Close()
    }
}

// execBatch executes the given requests and writes the result back using the codec. It will only write the response
// back when the last request is processed.
func (s *Server) execBatch(ctx context.Context, codec ServerCodec, requests []*serverRequest) {
    responses := make([]interface{}, len(requests))
    for i, req := range requests {
        if req.err != nil {
            responses[i] = codec.CreateErrorResponse(&req.id, req.err)
        } else {
            responses[i] = s.handle(ctx, codec, req)
        }
    }

    if err := codec.Write(responses); err != nil {
        glog.V(logger.Error).Infof("%v\n", err)
        codec.Close()
    }
}

// readRequest requests the next (batch) request from the codec. It will return the collection of requests, an
// indication if the request was a batch, the invalid request identifier and an error when the request could not be
// read/parsed.
func (s *Server) readRequest(codec ServerCodec) ([]*serverRequest, bool, RPCError) {
    reqs, batch, err := codec.ReadRequestHeaders()
    if err != nil {
        return nil, batch, err
    }

    requests := make([]*serverRequest, len(reqs))

    // verify requests
    for i, r := range reqs {
        var ok bool
        var svc *service

        if r.isPubSub && r.method == unsubscribeMethod {
            requests[i] = &serverRequest{id: r.id, isUnsubscribe: true}
            argTypes := []reflect.Type{reflect.TypeOf("")}
            if args, err := codec.ParseRequestArguments(argTypes, r.params); err == nil {
                requests[i].args = args
            } else {
                requests[i].err = &invalidParamsError{err.Error()}
            }
            continue
        }

        if svc, ok = s.services[r.service]; !ok {
            requests[i] = &serverRequest{id: r.id, err: &methodNotFoundError{r.service, r.method}}
            continue
        }

        if r.isPubSub { // eth_subscribe
            if callb, ok := svc.subscriptions[r.method]; ok {
                requests[i] = &serverRequest{id: r.id, svcname: svc.name, callb: callb}
                if r.params != nil && len(callb.argTypes) > 0 {
                    argTypes := []reflect.Type{reflect.TypeOf("")}
                    argTypes = append(argTypes, callb.argTypes...)
                    if args, err := codec.ParseRequestArguments(argTypes, r.params); err == nil {
                        requests[i].args = args[1:] // first one is service.method name which isn't an actual argument
                    } else {
                        requests[i].err = &invalidParamsError{err.Error()}
                    }
                }
            } else {
                requests[i] = &serverRequest{id: r.id, err: &methodNotFoundError{subscribeMethod, r.method}}
            }
            continue
        }

        if callb, ok := svc.callbacks[r.method]; ok {
            requests[i] = &serverRequest{id: r.id, svcname: svc.name, callb: callb}
            if r.params != nil && len(callb.argTypes) > 0 {
                if args, err := codec.ParseRequestArguments(callb.argTypes, r.params); err == nil {
                    requests[i].args = args
                } else {
                    requests[i].err = &invalidParamsError{err.Error()}
                }
            }
            continue
        }

        requests[i] = &serverRequest{id: r.id, err: &methodNotFoundError{r.service, r.method}}
    }

    return requests, batch, nil
}