-
Notifications
You must be signed in to change notification settings - Fork 7
/
request_response.go
326 lines (275 loc) · 9.36 KB
/
request_response.go
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
package connection
import (
"github.com/cyverse/go-irodsclient/irods/common"
"github.com/cyverse/go-irodsclient/irods/message"
"golang.org/x/xerrors"
)
// Request is an interface for calling iRODS RPC.
type Request interface {
GetMessage() (*message.IRODSMessage, error)
}
// Response is an interface for response of iRODS RPC Call.
type Response interface {
FromMessage(*message.IRODSMessage) error
}
// CheckErrorResponse is a Response on which CheckError can be called.
type CheckErrorResponse interface {
Response
CheckError() error
}
// RequestResponsePair is a structure that wraps Request, Response, and other parameters for making iRODS RPC call.
type RequestResponsePair struct {
Request Request
Response Response
BsBuffer []byte // can be null
RequestCallback common.TrackerCallBack // can be null
ResponseCallback common.TrackerCallBack // can be null
Error error
}
// Request sends a request and expects a response.
// bsBuffer is optional
func (conn *IRODSConnection) Request(request Request, response Response, bsBuffer []byte) error {
return conn.RequestWithTrackerCallBack(request, response, bsBuffer, nil, nil)
}
// RequestWithTrackerCallBack sends a request and expects a response.
// bsBuffer is optional
func (conn *IRODSConnection) RequestWithTrackerCallBack(request Request, response Response, bsBuffer []byte, reqCallback common.TrackerCallBack, resCallback common.TrackerCallBack) error {
// set transaction dirty
conn.SetTransactionDirty(true)
requestMessage, err := conn.getRequestMessage(request, true, false)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return err
}
err = conn.SendMessageWithTrackerCallBack(requestMessage, reqCallback)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to send a request message: %w", err)
}
// Server responds with results
// external bs buffer
responseMessage, err := conn.ReadMessageWithTrackerCallBack(bsBuffer, resCallback)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to receive a response message: %w", err)
}
err = conn.getResponse(responseMessage, response, true)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to parse response message: %w", err)
}
return nil
}
// RequestAsyncWithTrackerCallBack sends multiple requests and expects responses.
func (conn *IRODSConnection) RequestAsyncWithTrackerCallBack(rrChan chan RequestResponsePair) chan RequestResponsePair {
waitResponseChan := make(chan RequestResponsePair, 100)
outputPair := make(chan RequestResponsePair, 100)
var lastErr error
// sender
go func() {
for {
pair, ok := <-rrChan
if !ok {
// input closed
close(waitResponseChan)
break
}
// if errored before? skip
if lastErr != nil {
pair.Error = lastErr
waitResponseChan <- pair
continue
}
requestMessage, err := conn.getRequestMessage(pair.Request, true, false)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
lastErr = err
pair.Error = lastErr
waitResponseChan <- pair
continue
}
err = conn.SendMessageWithTrackerCallBack(requestMessage, pair.RequestCallback)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
lastErr = xerrors.Errorf("failed to send a request message: %w", err)
pair.Error = lastErr
waitResponseChan <- pair
continue
}
waitResponseChan <- pair
}
}()
// receiver
go func() {
for {
pair, ok := <-waitResponseChan
if !ok {
// input closed
close(outputPair)
break
}
// if errored before? skip
if lastErr != nil {
if pair.Error == nil {
pair.Error = lastErr
}
outputPair <- pair
continue
}
// Server responds with results
// external bs buffer
responseMessage, err := conn.ReadMessageWithTrackerCallBack(pair.BsBuffer, pair.ResponseCallback)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
lastErr = xerrors.Errorf("failed to receive a response message: %w", err)
pair.Error = lastErr
outputPair <- pair
continue
}
err = conn.getResponse(responseMessage, pair.Response, true)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
lastErr = xerrors.Errorf("failed to parse response message: %w", err)
pair.Error = lastErr
outputPair <- pair
continue
}
outputPair <- pair
}
}()
return outputPair
}
// RequestForPassword sends a request and expects a response. XML escape only for '&'
// bsBuffer is optional
func (conn *IRODSConnection) RequestForPassword(request Request, response Response, bsBuffer []byte) error {
requestMessage, err := conn.getRequestMessage(request, true, true)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return err
}
err = conn.SendMessage(requestMessage)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to send a request message: %w", err)
}
// Server responds with results
// external bs buffer
responseMessage, err := conn.ReadMessage(bsBuffer)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to receive a response message: %w", err)
}
err = conn.getResponse(responseMessage, response, true)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to parse response message: %w", err)
}
return nil
}
// RequestWithoutResponse sends a request but does not wait for a response.
func (conn *IRODSConnection) RequestWithoutResponse(request Request) error {
requestMessage, err := conn.getRequestMessage(request, true, false)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return err
}
err = conn.SendMessage(requestMessage)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to send a request message: %w", err)
}
return nil
}
// RequestWithoutResponseNoXML sends a request but does not wait for a response.
func (conn *IRODSConnection) RequestWithoutResponseNoXML(request Request) error {
requestMessage, err := conn.getRequestMessage(request, false, false)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to make a request message: %w", err)
}
err = conn.SendMessage(requestMessage)
if err != nil {
if conn.metrics != nil {
conn.metrics.IncreaseCounterForRequestResponseFailures(1)
}
return xerrors.Errorf("failed to send a request message: %w", err)
}
return nil
}
// RequestAndCheck sends a request and expects a CheckErrorResponse, on which the error is already checked.
func (conn *IRODSConnection) RequestAndCheck(request Request, response CheckErrorResponse, bsBuffer []byte) error {
return conn.RequestAndCheckWithTrackerCallBack(request, response, bsBuffer, nil, nil)
}
// RequestAndCheckWithCallBack sends a request and expects a CheckErrorResponse, on which the error is already checked.
func (conn *IRODSConnection) RequestAndCheckWithTrackerCallBack(request Request, response CheckErrorResponse, bsBuffer []byte, reqCallback common.TrackerCallBack, resCallback common.TrackerCallBack) error {
if err := conn.RequestWithTrackerCallBack(request, response, bsBuffer, reqCallback, resCallback); err != nil {
return err
}
return response.CheckError()
}
// RequestAndCheckForPassword sends a request and expects a CheckErrorResponse, on which the error is already checked.
// Only escape '&'
func (conn *IRODSConnection) RequestAndCheckForPassword(request Request, response CheckErrorResponse, bsBuffer []byte) error {
if err := conn.RequestForPassword(request, response, bsBuffer); err != nil {
return err
}
return response.CheckError()
}
func (conn *IRODSConnection) getRequestMessage(request Request, xml bool, forPassword bool) (*message.IRODSMessage, error) {
requestMessage, err := request.GetMessage()
if err != nil {
return nil, xerrors.Errorf("failed to make a request message: %w", err)
}
if xml {
// translate xml.Marshal XML into irods-understandable XML (among others, replace " by ")
err = conn.PreprocessMessage(requestMessage, forPassword)
if err != nil {
return nil, xerrors.Errorf("failed to send preprocess message: %w", err)
}
}
return requestMessage, nil
}
func (conn *IRODSConnection) getResponse(responseMessage *message.IRODSMessage, response Response, xml bool) error {
if xml {
// translate irods-dialect XML into valid XML
err := conn.PostprocessMessage(responseMessage)
if err != nil {
return xerrors.Errorf("failed to send postprocess message: %w", err)
}
}
err := response.FromMessage(responseMessage)
if err != nil {
return xerrors.Errorf("failed to parse a response message: %w", err)
}
return nil
}