aboutsummaryrefslogtreecommitdiffstats
path: root/rpc/v2/server_test.go
blob: f4f77672fbdccfb4453734394e357ee67aba3cb3 (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
package v2

import (
    "encoding/json"
    "fmt"
    "reflect"
    "testing"
    "time"
)

type Service struct{}

type Args struct {
    S string
}

func (s *Service) NoArgsRets() {
}

type Result struct {
    String string
    Int    int
    Args   *Args
}

func (s *Service) Echo(str string, i int, args *Args) Result {
    return Result{str, i, args}
}

func (s *Service) Rets() (string, error) {
    return "", nil
}

func (s *Service) InvalidRets1() (error, string) {
    return nil, ""
}

func (s *Service) InvalidRets2() (string, string) {
    return "", ""
}

func (s *Service) InvalidRets3() (string, string, error) {
    return "", "", nil
}

func (s *Service) Subscription() (Subscription, error) {
    return NewSubscription(nil), nil
}

func TestServerRegisterName(t *testing.T) {
    server := NewServer()
    service := new(Service)

    if err := server.RegisterName("calc", service); err != nil {
        t.Fatalf("%v", err)
    }

    if len(server.services) != 2 {
        t.Fatalf("Expected 2 service entries, got %d", len(server.services))
    }

    svc, ok := server.services["calc"]
    if !ok {
        t.Fatalf("Expected service calc to be registered")
    }

    if len(svc.callbacks) != 3 {
        t.Errorf("Expected 3 callbacks for service 'calc', got %d", len(svc.callbacks))
    }

    if len(svc.subscriptions) != 1 {
        t.Errorf("Expected 1 subscription for service 'calc', got %d", len(svc.subscriptions))
    }
}

// dummy codec used for testing RPC method execution
type ServerTestCodec struct {
    counter int
    input   []byte
    output  string
    closer  chan interface{}
}

func (c *ServerTestCodec) ReadRequestHeaders() ([]rpcRequest, bool, RPCError) {
    c.counter += 1

    if c.counter == 1 {
        var req jsonRequest
        json.Unmarshal(c.input, &req)
        return []rpcRequest{rpcRequest{id: *req.Id, isPubSub: false, service: "test", method: req.Method, params: req.Payload}}, false, nil
    }

    // requests are executes in parallel, wait a bit before returning an error so that the previous request has time to
    // be executed
    timer := time.NewTimer(time.Duration(2) * time.Second)
    <-timer.C

    return nil, false, &invalidRequestError{"connection closed"}
}

func (c *ServerTestCodec) ParseRequestArguments(argTypes []reflect.Type, payload interface{}) ([]reflect.Value, RPCError) {

    args, _ := payload.(json.RawMessage)

    argValues := make([]reflect.Value, len(argTypes))
    params := make([]interface{}, len(argTypes))

    n, err := countArguments(args)
    if err != nil {
        return nil, &invalidParamsError{err.Error()}
    }
    if n != len(argTypes) {
        return nil, &invalidParamsError{fmt.Sprintf("insufficient params, want %d have %d", len(argTypes), n)}

    }

    for i, t := range argTypes {
        if t.Kind() == reflect.Ptr {
            // values must be pointers for the Unmarshal method, reflect.
            // Dereference otherwise reflect.New would create **SomeType
            argValues[i] = reflect.New(t.Elem())
            params[i] = argValues[i].Interface()

            // when not specified blockNumbers are by default latest (-1)
            if blockNumber, ok := params[i].(*BlockNumber); ok {
                *blockNumber = BlockNumber(-1)
            }
        } else {
            argValues[i] = reflect.New(t)
            params[i] = argValues[i].Interface()

            // when not specified blockNumbers are by default latest (-1)
            if blockNumber, ok := params[i].(*BlockNumber); ok {
                *blockNumber = BlockNumber(-1)
            }
        }
    }

    if err := json.Unmarshal(args, &params); err != nil {
        return nil, &invalidParamsError{err.Error()}
    }

    // Convert pointers back to values where necessary
    for i, a := range argValues {
        if a.Kind() != argTypes[i].Kind() {
            argValues[i] = reflect.Indirect(argValues[i])
        }
    }

    return argValues, nil
}

func (c *ServerTestCodec) CreateResponse(id int64, reply interface{}) interface{} {
    return &jsonSuccessResponse{Version: jsonRPCVersion, Id: id, Result: reply}
}

func (c *ServerTestCodec) CreateErrorResponse(id *int64, err RPCError) interface{} {
    return &jsonErrResponse{Version: jsonRPCVersion, Id: id, Error: jsonError{Code: err.Code(), Message: err.Error()}}
}

func (c *ServerTestCodec) CreateErrorResponseWithInfo(id *int64, err RPCError, info interface{}) interface{} {
    return &jsonErrResponse{Version: jsonRPCVersion, Id: id,
        Error: jsonError{Code: err.Code(), Message: err.Error(), Data: info}}
}

func (c *ServerTestCodec) CreateNotification(subid string, event interface{}) interface{} {
    return &jsonNotification{Version: jsonRPCVersion, Method: notificationMethod,
        Params: jsonSubscription{Subscription: subid, Result: event}}
}

func (c *ServerTestCodec) Write(msg interface{}) error {
    if len(c.output) == 0 { // only capture first response
        if o, err := json.Marshal(msg); err != nil {
            return err
        } else {
            c.output = string(o)
        }
    }

    return nil
}

func (c *ServerTestCodec) Close() {
    close(c.closer)
}

func (c *ServerTestCodec) Closed() <-chan interface{} {
    return c.closer
}

func TestServerMethodExecution(t *testing.T) {
    server := NewServer()
    service := new(Service)

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

    id := int64(12345)
    req := jsonRequest{
        Method:  "echo",
        Version: "2.0",
        Id:      &id,
    }
    args := []interface{}{"string arg", 1122, &Args{"qwerty"}}
    req.Payload, _ = json.Marshal(&args)

    input, _ := json.Marshal(&req)
    codec := &ServerTestCodec{input: input, closer: make(chan interface{})}
    go server.ServeCodec(codec)

    <-codec.closer

    expected := `{"jsonrpc":"2.0","id":12345,"result":{"String":"string arg","Int":1122,"Args":{"S":"qwerty"}}}`

    if expected != codec.output {
        t.Fatalf("expected %s, got %s\n", expected, codec.output)
    }
}