-
Notifications
You must be signed in to change notification settings - Fork 11
/
block-014-post-out-of-order-blockwise-response.js
299 lines (266 loc) · 12 KB
/
block-014-post-out-of-order-blockwise-response.js
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
/*
Handle an out-of-order blockwise response to a confirmable, blockwise
POST request (Block2 option included with Block1 option doesn't start at number
`0`):
1. User sends a request with the `blockSize` option set to `128`:
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 0 0 | 0 0 0 0 | 0 0 0 0 0 0 1 0 | 0x0001
1 | CON | 0 bytes | POST | 1
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
------------------------------------------------------------------------------
Uri-Path : blocks
Uri-Path : post
Content-Format: text/plain;charset=utf-8
------------------------------------------------------------------------------
Payload (128 bytes)
|-------------------------------------------------------------|
| BLOCK 1 |
|-------------------------------------------------------------|
| BLOCK 2 |
|-------------------------------------------------------------|
==============================================================================
2. Client recognizes that the payload of the #1 request is bigger than
the specified block size, so it constructs and sends the first Block1 request
instead:
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 0 0 | 0 0 0 0 | 0 0 0 0 0 0 1 0 | 0x0002
1 | CON | 0 bytes | POST | 2
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
------------------------------------------------------------------------------
Uri-Path : blocks
Uri-Path : post
Content-Format: text/plain;charset=utf-8
Block1 : NUM: 0, M: true, SZX: 3 (128 bytes)
------------------------------------------------------------------------------
Payload (128 bytes)
|-------------------------------------------------------------|
| BLOCK 1 |
==============================================================================
3. Server confirms the first Block1:
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 1 0 | 0 0 0 0 | 0 1 0 0 0 1 0 0 | 0x0002
1 | ACK | 0 bytes | 2.01 Created | 2
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
------------------------------------------------------------------------------
Block1: NUM: 0, M: true, SZX: 3 (128 bytes)
==============================================================================
4. Client receives the #3 confirmation. Request emits the`acknowledged` event
and the `block sent` event.
5. Client sends a request with the second Block1:
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 0 0 | 0 0 0 0 | 0 0 0 0 0 0 1 0 | 0x0003
1 | CON | 0 bytes | POST | 3
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
------------------------------------------------------------------------------
Uri-Path : blocks
Uri-Path : post
Content-Format: text/plain;charset=utf-8
Block1 : NUM: 1, M: true, SZX: 3 (128 bytes)
------------------------------------------------------------------------------
Payload (128 bytes)
|-------------------------------------------------------------|
| BLOCK 2 |
==============================================================================
6. Servers confirms the second Block1:
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 1 0 | 0 0 0 0 | 0 1 0 0 0 1 0 0 | 0x0003
1 | ACK | 0 bytes | 2.01 Created | 3
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
------------------------------------------------------------------------------
Block1: NUM: 1, M: true, SZX: 3 (128 bytes)
==============================================================================
7. Client receives the #6 confirmation. Request emits the`block sent` event.
8. Client sends a request with the third, last Block1:
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 0 0 | 0 0 0 0 | 0 0 0 0 0 0 1 0 | 0x0004
1 | CON | 0 bytes | POST | 4
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
------------------------------------------------------------------------------
Uri-Path : blocks
Uri-Path : post
Content-Format: text/plain;charset=utf-8
Block1 : NUM: 2, M: false, SZX: 3 (128 bytes)
------------------------------------------------------------------------------
Payload (63 bytes)
|-------------------------------------------------------------|
==============================================================================
9. Server confirms the last Block1 and includes an invalid Block2 option
(doesn't start at number `0`):
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 1 0 | 0 0 0 0 | 0 1 0 0 0 1 0 0 | 0x0004
1 | ACK | 0 bytes | 2.01 Created | 4
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
------------------------------------------------------------------------------
Content-Format: text/plain;charset=utf-8
Block1 : NUM: 2, M: false, SZX: 3 (128 bytes)
Block2 : NUM: 1, M: true, SZX: 3 (128 bytes)
------------------------------------------------------------------------------
Payload (128 bytes)
|-------------------------------------------------------------|
| block 2 |
==============================================================================
10. Client receives the #9 confirmation, recognizes that it contains a Block2
option, validates it, determines that it's invalid as it doesn't start at
number `0`, and so ignores the response.
12. Servers sends the third, last Block2:
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 0 0 | 0 0 0 0 | 0 1 0 0 0 1 0 0 | 0x4714
1 | CON | 0 bytes | 2.01 Created | 18196
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
------------------------------------------------------------------------------
Content-Format: text/plain;charset=utf-8
Block2 : NUM: 2, M: false, SZX: 3 (128 bytes)
------------------------------------------------------------------------------
Payload (63 bytes)
|-------------------------------------------------------------|
==============================================================================
13. Client receives the #12 Block2, but because the previous one was invalid,
this one is reset:
==============================================================================
Version | Type | Token Length | Code | Message ID
0 1 | 1 1 | 0 0 0 0 | 0 0 0 0 0 0 0 0 | 0x4714
1 | RST | 0 bytes | Empty | 18196
------------------------------------------------------------------------------
Remote Endpoint: 127.0.0.1
==============================================================================
14. After `exchangeTimeout` ms have passed, the client emits
the `exchange timeout` event and the request emits the `timeout` event.
*/
'use strict';
require('should');
var sinon = require('sinon');
var helpers = require('../helpers');
var Message = require(helpers.LIB_DIR).Message;
helpers.test(__filename, function(ctx)
{
/*jshint maxstatements:99*/
var requestPayload =
'|-------------------------------------------------------------|\n' +
'| BLOCK 1 |\n' +
'|-------------------------------------------------------------|\n' +
'| BLOCK 2 |\n' +
'|-------------------------------------------------------------|';
var responsePayload = new Buffer(requestPayload.toLowerCase());
var request = {
type: Message.Type.CON,
code: Message.Code.POST,
uri: '/blocks/put',
contentFormat: 'text/plain;charset=utf-8',
payload: new Buffer(requestPayload)
};
var reqWithBlock0 = {
type: request.type,
code: request.code,
id: 0x0002,
uri: request.uri,
block1: {num: 0, m: true, szx: 3},
contentFormat: request.contentFormat,
payload: request.payload.slice(0 * 128, 1 * 128)
};
var resToBlock0 = {
type: Message.Type.ACK,
code: Message.Code.CREATED,
id: reqWithBlock0.id,
block1: {num: 0, m: true, szx: 3}
};
var reqWithBlock1 = {
type: request.type,
code: request.code,
id: 0x0003,
uri: request.uri,
block1: {num: 1, m: true, szx: 3},
contentFormat: request.contentFormat,
payload: request.payload.slice(1 * 128, 2 * 128)
};
var resToBlock1 = {
type: Message.Type.ACK,
code: Message.Code.CREATED,
id: reqWithBlock1.id,
block1: {num: 1, m: true, szx: 3}
};
var reqWithBlock2 = {
type: request.type,
code: request.code,
id: 0x0004,
uri: request.uri,
block1: {num: 2, m: false, szx: 3},
contentFormat: request.contentFormat,
payload: request.payload.slice(2 * 128, 3 * 128)
};
var resToBlock2 = {
type: Message.Type.ACK,
code: Message.Code.CREATED,
id: reqWithBlock2.id,
contentFormat: request.contentFormat,
block1: {num: 2, m: false, szx: 3},
block2: {num: 1, m: true, szx: 3},
payload: responsePayload.slice(1 * 128, 2 * 128)
};
var serverBlock2 = {
type: Message.Type.CON,
code: Message.Code.CREATED,
id: 0x4714,
contentFormat: request.contentFormat,
block2: {num: 2, m: false, szx: 3},
payload: responsePayload.slice(2 * 128, 3 * 128)
};
var clientBlock2 = {
type: Message.Type.RST,
code: Message.Code.EMPTY,
id: serverBlock2.id
};
ctx.socket.expectRequest(reqWithBlock0);
ctx.socket.scheduleResponse(50, resToBlock0);
ctx.socket.expectRequest(50, reqWithBlock1);
ctx.socket.scheduleResponse(100, resToBlock1);
ctx.socket.expectRequest(100, reqWithBlock2);
ctx.socket.scheduleResponse(150, resToBlock2);
ctx.socket.scheduleResponse(250, serverBlock2);
ctx.socket.expectRequest(250, clientBlock2);
var req = ctx.client.request(Message.fromObject(request), {
blockSize: 128
});
var eventSpy = sinon.spy(req, 'emit');
ctx.clock.tick(3600000);
return function assert()
{
ctx.socket.assert();
sinon.assert.callCount(eventSpy, 4);
sinon.assert.calledWith(
eventSpy, 'acknowledged', sinon.match.instanceOf(Message)
);
sinon.assert.calledWith(
eventSpy, 'block sent', sinon.match.instanceOf(Message)
);
sinon.assert.calledWith(eventSpy, 'timeout');
eventSpy.args[0][0].should.be.equal('acknowledged');
sinon.assert.coapMessage(
eventSpy.args[0][1], resToBlock0, "Invalid ACK."
);
eventSpy.args[1][0].should.be.equal('block sent');
sinon.assert.coapMessage(
eventSpy.args[1][1], resToBlock0, "Invalid `block sent` (#1)."
);
eventSpy.args[2][0].should.be.equal('block sent');
sinon.assert.coapMessage(
eventSpy.args[2][1], resToBlock1, "Invalid `block sent` (#2)."
);
eventSpy.args[3][0].should.be.equal('timeout');
};
});