Skip to content

Commit fdaeafb

Browse files
committed
1 parent 32b274c commit fdaeafb

3 files changed

Lines changed: 253 additions & 0 deletions

File tree

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
library http2.src.frames.frame_defragmenter;
6+
7+
import 'frames.dart';
8+
9+
import '../sync_errors.dart';
10+
11+
/// Class used for defragmenting [HeadersFrame]s and [PushPromiseFrame]s.
12+
// TODO: Somehow emit an error if too many continuation frames have been sent
13+
// (since we're buffering all of them).
14+
class FrameDefragmenter {
15+
/// The current incomplete [HeadersFrame] fragment.
16+
HeadersFrame _headersFrame;
17+
18+
/// The current incomplete [PushPromiseFrame] fragment.
19+
PushPromiseFrame _pushPromiseFrame;
20+
21+
/// Tries to defragment [frame].
22+
///
23+
/// If the given [frame] is a [HeadersFrame] or a [PushPromiseFrame] which
24+
/// needs de-fragmentation, it will be saved and `null` will be returned.
25+
///
26+
/// If there is currently an incomplete [HeadersFrame] or [PushPromiseFrame]
27+
/// saved, [frame] needs to be a [ContinuationFrame]. It will be added to the
28+
/// saved frame. In case the defragmentation is complete, the defragmented
29+
/// [HeadersFrame] or [PushPromiseFrame] will be returned.
30+
///
31+
/// All other [Frame] types will be returned.
32+
// TODO: Consider handling continuation frames without preceding
33+
// headers/push-promise frame here instead of the call site?
34+
Frame tryDefragmentFrame(Frame frame) {
35+
if (_headersFrame != null) {
36+
if (frame is ContinuationFrame) {
37+
if (_headersFrame.header.streamId != frame.header.streamId) {
38+
throw new ProtocolException(
39+
'Defragmentation: frames have different stream ids.');
40+
}
41+
_headersFrame = _headersFrame.addBlockContinuation(frame);
42+
43+
if (frame.hasEndHeadersFlag) {
44+
var frame = _headersFrame;
45+
_headersFrame = null;
46+
return frame;
47+
} else {
48+
return null;
49+
}
50+
} else {
51+
throw new ProtocolException(
52+
'Defragmentation: Incomplete frame must be followed by '
53+
'continuation frame.');
54+
}
55+
} else if (_pushPromiseFrame != null) {
56+
if (frame is ContinuationFrame) {
57+
if (_pushPromiseFrame.header.streamId != frame.header.streamId) {
58+
throw new ProtocolException(
59+
'Defragmentation: frames have different stream ids.');
60+
}
61+
_pushPromiseFrame = _pushPromiseFrame.addBlockContinuation(frame);
62+
63+
if (frame.hasEndHeadersFlag) {
64+
var frame = _pushPromiseFrame;
65+
_pushPromiseFrame = null;
66+
return frame;
67+
} else {
68+
return null;
69+
}
70+
} else {
71+
throw new ProtocolException(
72+
'Defragmentation: Incomplete frame must be followed by '
73+
'continuation frame.');
74+
}
75+
} else {
76+
if (frame is HeadersFrame) {
77+
if (!frame.hasEndHeadersFlag) {
78+
_headersFrame = frame;
79+
return null;
80+
}
81+
} else if (frame is PushPromiseFrame) {
82+
if (!frame.hasEndHeadersFlag) {
83+
_pushPromiseFrame = frame;
84+
return null;
85+
}
86+
}
87+
}
88+
89+
// If this frame is not relevant for header defragmentation, we pass it to
90+
// the next stage.
91+
return frame;
92+
}
93+
}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
library http2.src.sync_errors;
6+
7+
class ProtocolException implements Exception {
8+
final String message;
9+
10+
ProtocolException(this.message);
11+
12+
String toString() => 'ProtocolError: $message';
13+
}
Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
import 'package:unittest/unittest.dart';
6+
7+
import 'package:http2/src/sync_errors.dart';
8+
import 'package:http2/src/frames/frames.dart';
9+
import 'package:http2/src/frames/frame_defragmenter.dart';
10+
11+
main() {
12+
group('frames', () {
13+
group('frame-defragmenter', () {
14+
UnknownFrame unknownFrame() {
15+
return new UnknownFrame(new FrameHeader(0, 0, 0, 1), []);
16+
}
17+
18+
HeadersFrame headersFrame(List<int> data,
19+
{bool fragmented: false, int streamId: 1}) {
20+
int flags = fragmented ? 0 : HeadersFrame.FLAG_END_HEADERS;
21+
var header = new FrameHeader(
22+
data.length, FrameType.HEADERS, flags, streamId);
23+
return new HeadersFrame(header, 0, false, null, null, data);
24+
}
25+
26+
PushPromiseFrame pushPromiseFrame(List<int> data,
27+
{bool fragmented: false,
28+
int streamId: 1}) {
29+
int flags = fragmented ? 0 : HeadersFrame.FLAG_END_HEADERS;
30+
var header = new FrameHeader(
31+
data.length, FrameType.PUSH_PROMISE, flags, streamId);
32+
return new PushPromiseFrame(header, 0, 44, data);
33+
}
34+
35+
ContinuationFrame continuationFrame(List<int> data,
36+
{bool fragmented: false,
37+
int streamId: 1}) {
38+
int flags = fragmented ? 0 : ContinuationFrame.FLAG_END_HEADERS;
39+
var header = new FrameHeader(
40+
data.length, FrameType.CONTINUATION, flags, streamId);
41+
return new ContinuationFrame(header, data);
42+
}
43+
44+
test('unknown-frame', () {
45+
var defrag = new FrameDefragmenter();
46+
expect(defrag.tryDefragmentFrame(unknownFrame()) is UnknownFrame, true);
47+
});
48+
49+
test('fragmented-headers-frame', () {
50+
var defrag = new FrameDefragmenter();
51+
52+
var f1 = headersFrame([1, 2, 3], fragmented: true);
53+
var f2 = continuationFrame([4, 5, 6], fragmented: true);
54+
var f3 = continuationFrame([7, 8, 9], fragmented: false);
55+
56+
expect(defrag.tryDefragmentFrame(f1), isNull);
57+
expect(defrag.tryDefragmentFrame(f2), isNull);
58+
HeadersFrame h = defrag.tryDefragmentFrame(f3);
59+
expect(h.hasEndHeadersFlag, isTrue);
60+
expect(h.hasEndStreamFlag, isFalse);
61+
expect(h.hasPaddedFlag, isFalse);
62+
expect(h.padLength, 0);
63+
expect(h.headerBlockFragment, [1, 2, 3, 4, 5, 6, 7, 8, 9]);
64+
});
65+
66+
test('fragmented-push-promise-frame', () {
67+
var defrag = new FrameDefragmenter();
68+
69+
var f1 = pushPromiseFrame([1, 2, 3], fragmented: true);
70+
var f2 = continuationFrame([4, 5, 6], fragmented: true);
71+
var f3 = continuationFrame([7, 8, 9], fragmented: false);
72+
73+
expect(defrag.tryDefragmentFrame(f1), isNull);
74+
expect(defrag.tryDefragmentFrame(f2), isNull);
75+
PushPromiseFrame h = defrag.tryDefragmentFrame(f3);
76+
expect(h.hasEndHeadersFlag, isTrue);
77+
expect(h.hasPaddedFlag, isFalse);
78+
expect(h.padLength, 0);
79+
expect(h.headerBlockFragment, [1, 2, 3, 4, 5, 6, 7, 8, 9]);
80+
});
81+
82+
test('fragmented-headers-frame--wrong-id', () {
83+
var defrag = new FrameDefragmenter();
84+
85+
var f1 = headersFrame([1, 2, 3], fragmented: true, streamId: 1);
86+
var f2 = continuationFrame([4, 5, 6], fragmented: true, streamId: 2);
87+
88+
expect(defrag.tryDefragmentFrame(f1), isNull);
89+
expect(() => defrag.tryDefragmentFrame(f2),
90+
throwsProtocolException);
91+
});
92+
93+
test('fragmented-push-promise-frame', () {
94+
var defrag = new FrameDefragmenter();
95+
96+
var f1 = pushPromiseFrame([1, 2, 3], fragmented: true, streamId: 1);
97+
var f2 = continuationFrame([4, 5, 6], fragmented: true, streamId: 2);
98+
99+
expect(defrag.tryDefragmentFrame(f1), isNull);
100+
expect(() => defrag.tryDefragmentFrame(f2),
101+
throwsProtocolException);
102+
});
103+
104+
test('fragmented-headers-frame--no-continuation-frame', () {
105+
var defrag = new FrameDefragmenter();
106+
107+
var f1 = headersFrame([1, 2, 3], fragmented: true);
108+
var f2 = unknownFrame();
109+
110+
expect(defrag.tryDefragmentFrame(f1), isNull);
111+
expect(() => defrag.tryDefragmentFrame(f2),
112+
throwsProtocolException);
113+
});
114+
115+
test('fragmented-push-promise-no-continuation-frame', () {
116+
var defrag = new FrameDefragmenter();
117+
118+
var f1 = pushPromiseFrame([1, 2, 3], fragmented: true);
119+
var f2 = unknownFrame();
120+
121+
expect(defrag.tryDefragmentFrame(f1), isNull);
122+
expect(() => defrag.tryDefragmentFrame(f2),
123+
throwsProtocolException);
124+
});
125+
126+
test('push-without-headres-or-push-promise-frame', () {
127+
var defrag = new FrameDefragmenter();
128+
129+
var f1 = continuationFrame([4, 5, 6], fragmented: true, streamId: 1);
130+
expect(defrag.tryDefragmentFrame(f1), equals(f1));
131+
});
132+
});
133+
});
134+
}
135+
136+
137+
/// A matcher for HuffmannDecodingExceptions.
138+
const Matcher isProtocolException = const _ProtocolException();
139+
140+
class _ProtocolException extends TypeMatcher {
141+
const _ProtocolException() : super("ProtocolException");
142+
bool matches(item, Map matchState) => item is ProtocolException;
143+
}
144+
145+
const Matcher throwsProtocolException =
146+
const Throws(isProtocolException);
147+

0 commit comments

Comments
 (0)