File: decoder_test.go

package info (click to toggle)
golang-github-marten-seemann-qpack 0.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 356 kB
  • sloc: makefile: 3
file content (318 lines) | stat: -rw-r--r-- 8,420 bytes parent folder | download
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
package qpack

import (
	"io"
	"testing"

	"golang.org/x/net/http2/hpack"

	"github.com/stretchr/testify/require"
)

func insertPrefix(data []byte) []byte {
	prefix := appendVarInt(nil, 8, 0)
	prefix = appendVarInt(prefix, 7, 0)
	return append(prefix, data...)
}

func TestDecoderInvalidInputs(t *testing.T) {
	tests := []struct {
		name     string
		input    []byte
		expected string
	}{
		{
			name:     "non-zero required insert count", // we don't support dynamic table updates
			input:    append(appendVarInt(nil, 8, 1), appendVarInt(nil, 7, 0)...),
			expected: "expected Required Insert Count to be zero",
		},
		{
			name:     "non-zero delta base", // we don't support dynamic table updates
			input:    append(appendVarInt(nil, 8, 0), appendVarInt(nil, 7, 1)...),
			expected: "expected Base to be zero",
		},
		{
			name:     "unknown type byte",
			input:    insertPrefix([]byte{0x10}),
			expected: "unexpected type byte: 0x10",
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			dec := NewDecoder()
			decode := dec.Decode(tt.input)
			_, err := decode()
			require.EqualError(t, err, tt.expected)
		})
	}
}

const (
	loremIpsum1 = "lorem ipsum dolor sit amet"
	loremIpsum2 = "consectetur adipiscing elit"
)

type testcase struct {
	Data     []byte
	Expected []HeaderField
}

var (
	literalFieldWithoutNameReference = testcase{
		Data: func() []byte {
			data := appendVarInt(nil, 3, 3)
			data[0] ^= 0x20
			data = append(data, []byte("foo")...)
			data = appendVarInt(data, 7, uint64(len(loremIpsum1)))
			data = append(data, []byte(loremIpsum1)...)
			data2 := appendVarInt(nil, 3, 3)
			data2[0] ^= 0x20
			data2 = append(data2, []byte("bar")...)
			data2 = appendVarInt(data2, 7, uint64(len(loremIpsum2)))
			data2 = append(data2, []byte(loremIpsum2)...)
			return insertPrefix(append(data, data2...))
		}(),
		Expected: []HeaderField{
			{Name: "foo", Value: loremIpsum1},
			{Name: "bar", Value: loremIpsum2},
		},
	}
	literalFieldWithNameReference = testcase{
		Data: func() []byte {
			data := appendVarInt(nil, 4, 49)
			data[0] ^= 0x40 | 0x10
			data = appendVarInt(data, 7, uint64(len(loremIpsum1)))
			data = append(data, []byte(loremIpsum1)...)
			data2 := appendVarInt(nil, 4, 82)
			data2[0] ^= 0x40 | 0x10
			data2[0] |= 0x20 // set the N-bit
			data2 = appendVarInt(data2, 7, uint64(len(loremIpsum2)))
			data2 = append(data2, []byte(loremIpsum2)...)
			return insertPrefix(append(data, data2...))
		}(),
		Expected: []HeaderField{
			{Name: "content-type", Value: loremIpsum1},
			{Name: "access-control-request-method", Value: loremIpsum2},
		},
	}
	literalFieldWithHuffmanEncoding = testcase{
		Data: func() []byte {
			data := appendVarInt(nil, 4, 49)
			data[0] ^= 0x40 | 0x10
			data2 := appendVarInt(nil, 7, hpack.HuffmanEncodeLength(loremIpsum1))
			data2[0] ^= 0x80
			data = hpack.AppendHuffmanString(append(data, data2...), loremIpsum1)
			data3 := appendVarInt(nil, 4, 82)
			data3[0] ^= 0x40 | 0x10
			data4 := appendVarInt(nil, 7, hpack.HuffmanEncodeLength(loremIpsum2))
			data4[0] ^= 0x80
			data5 := hpack.AppendHuffmanString(append(data3, data4...), loremIpsum2)
			return insertPrefix(append(data, data5...))
		}(),
		Expected: []HeaderField{
			{Name: "content-type", Value: loremIpsum1},
			{Name: "access-control-request-method", Value: loremIpsum2},
		},
	}
	indexedField = testcase{
		Data: func() []byte {
			data := appendVarInt(nil, 6, 20)
			data[0] ^= 0x80 | 0x40
			data2 := appendVarInt(nil, 6, 42)
			data2[0] ^= 0x80 | 0x40
			return insertPrefix(append(data, data2...))
		}(),
		Expected: []HeaderField{
			staticTableEntries[20],
			staticTableEntries[42],
		},
	}
)

func TestDecoderLiteralHeaderFieldDynamicTable(t *testing.T) {
	data := appendVarInt(nil, 4, 49)
	data[0] ^= 0x40 // don't set the static flag (0x10)
	data = appendVarInt(data, 7, 6)
	data = append(data, []byte("foobar")...)
	dec := NewDecoder()
	decode := dec.Decode(insertPrefix(data))
	_, err := decode()
	require.ErrorIs(t, err, errNoDynamicTable)
}

func decodeAll(t *testing.T, decode func() (HeaderField, error)) []HeaderField {
	t.Helper()
	var hfs []HeaderField
	for {
		hf, err := decode()
		if err == io.EOF {
			break
		}
		require.NoError(t, err)
		hfs = append(hfs, hf)
	}
	return hfs
}

func TestDecoderIndexedHeaderFields(t *testing.T) {
	dec := NewDecoder()
	decodeFn := dec.Decode(indexedField.Data)
	require.Equal(t, indexedField.Expected, decodeAll(t, decodeFn))
}

func TestDecoderInvalidIndexedHeaderFields(t *testing.T) {
	tests := []struct {
		name     string
		input    []byte
		expected string
	}{
		{
			name: "errors when a non-existent static table entry is referenced",
			input: func() []byte {
				data := appendVarInt(nil, 6, 10000)
				data[0] ^= 0x80 | 0x40
				return insertPrefix(data)
			}(),
			expected: "invalid indexed representation index 10000",
		},
		{
			name: "rejects an indexed header field that references the dynamic table",
			input: func() []byte {
				data := appendVarInt(nil, 6, 20)
				data[0] ^= 0x80 // don't set the static flag (0x40)
				return insertPrefix(data)
			}(),
			expected: errNoDynamicTable.Error(),
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			dec := NewDecoder()
			decodeFn := dec.Decode(tt.input)
			_, err := decodeFn()
			require.EqualError(t, err, tt.expected)
		})
	}
}

func TestDecoderLiteralHeaderFieldWithNameReferenceAndHuffmanEncoding(t *testing.T) {
	dec := NewDecoder()
	decodeFn := dec.Decode(literalFieldWithHuffmanEncoding.Data)
	require.Equal(t, literalFieldWithHuffmanEncoding.Expected, decodeAll(t, decodeFn))
}

func TestDecoderLiteralHeaderFieldWithoutNameReference(t *testing.T) {
	dec := NewDecoder()
	decodeFn := dec.Decode(literalFieldWithoutNameReference.Data)
	require.Equal(t, literalFieldWithoutNameReference.Expected, decodeAll(t, decodeFn))
}

func TestDecoderEOF(t *testing.T) {
	t.Run("literal field without name reference", func(t *testing.T) {
		testDecoderEOF(t,
			literalFieldWithoutNameReference.Data,
			len(literalFieldWithoutNameReference.Expected),
		)
	})

	t.Run("literal field with name reference", func(t *testing.T) {
		testDecoderEOF(t,
			literalFieldWithNameReference.Data,
			len(literalFieldWithNameReference.Expected),
		)
	})

	t.Run("literal field with Huffman encoding", func(t *testing.T) {
		testDecoderEOF(t,
			literalFieldWithHuffmanEncoding.Data,
			len(literalFieldWithHuffmanEncoding.Expected),
		)
	})

	t.Run("indexed field", func(t *testing.T) {
		testDecoderEOF(t,
			indexedField.Data,
			len(indexedField.Expected),
		)
	})
}

func testDecoderEOF(t *testing.T, data []byte, numExpected int) {
	for i := range data {
		dec := NewDecoder()
		decodeFn := dec.Decode(data[:i])
		var hfs []HeaderField
		for {
			hf, err := decodeFn()
			// the data might have been cut right after a header field,
			// which is a valid header
			if err == io.EOF {
				require.Less(t, len(hfs), numExpected)
				break
			}
			if err != nil {
				require.ErrorIs(t, err, io.ErrUnexpectedEOF)
				break
			}
			hfs = append(hfs, hf)
		}
	}
}

func BenchmarkDecoder(b *testing.B) {
	b.Run("literal field without name reference", func(b *testing.B) {
		benchmarkDecoder(b,
			literalFieldWithoutNameReference.Data,
			len(literalFieldWithoutNameReference.Expected),
		)
	})

	b.Run("literal field with name reference", func(b *testing.B) {
		benchmarkDecoder(b,
			literalFieldWithNameReference.Data,
			len(literalFieldWithNameReference.Expected),
		)
	})

	b.Run("literal field with Huffman encoding", func(b *testing.B) {
		benchmarkDecoder(b,
			literalFieldWithHuffmanEncoding.Data,
			len(literalFieldWithHuffmanEncoding.Expected),
		)
	})

	b.Run("indexed field", func(b *testing.B) {
		benchmarkDecoder(b,
			indexedField.Data,
			len(indexedField.Expected),
		)
	})
}

func benchmarkDecoder(b *testing.B, data []byte, numExpected int) {
	b.ReportAllocs()

	decoder := NewDecoder()
	hdr := make(map[string]string)
	for b.Loop() {
		decodeFn := decoder.Decode(data)
		for {
			hf, err := decodeFn()
			if err != nil {
				if err == io.EOF {
					break
				}
				b.Fatalf("unexpected error: %v", err)
			}
			// simulate what a typical HTTP/3 consumer would do with the header fields:
			// populate an http.Header with the header fields
			hdr[hf.Name] = hf.Value
		}
		if len(hdr) != numExpected {
			b.Fatalf("expected %d header fields, got %d", numExpected, len(hdr))
		}
		clear(hdr)
	}
}