summaryrefslogtreecommitdiffstats
path: root/docs/en/cowboy/2.3/guide/migrating_from_2.1/index.html
blob: 6d6fed210fbad181455077ebf21d02ae47a041f3 (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
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="">
    <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">

    <title>Nine Nines: Migrating from Cowboy 2.1 to 2.2</title>

    <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
    <link href="/css/99s.css?r=1" rel="stylesheet">

    <link rel="shortcut icon" href="/img/ico/favicon.ico">
    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
    <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
    <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">

    
</head>


<body class="">
  <header id="page-head">
    <div id="topbar" class="container">
        <div class="row">
          <div class="span2">
            <h1 id="logo"><a href="/" title="99s">99s</a></h1>
          </div>
          <div class="span10">
            
            <div id="side-header">
              <nav>
                <ul>
                  <li><a title="Hear my thoughts" href="/articles">Articles</a></li>
  				  <li><a title="Watch my talks" href="/talks">Talks</a></li>
  				  <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
  				  <li><a title="Request my services" href="/services">Consulting & Training</a></li>
                </ul>
              </nav> 
              <ul id="social">
                <li>
                  <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
                </li>
                    <li>
						<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
					</li>
              </ul>
            </div>
          </div>
        </div>
    </div>


</header>

<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">

<h1 class="lined-header"><span>Migrating from Cowboy 2.1 to 2.2</span></h1>

<div class="paragraph"><p>Cowboy 2.2 focused on adding features required for writing
gRPC servers and on completing test suites for the core
HTTP RFCs, fixing many bugs along the way.</p></div>
<div class="sect1">
<h2 id="_features_added">Features added</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
Add support for sending trailers at the end of response bodies.
  Trailers are additional header fields that may be sent after the
  body to add more information to the response. Their usage is
  required in gRPC servers. They are optional and may be discarded
  in other scenarios (for example if the request goes through an
  HTTP/1.0 proxy, as HTTP/1.0 does not support trailers).
</p>
</li>
<li>
<p>
The <code>max_skip_body_length</code> option was added to <code>cowboy_http</code>.
  It controls how much of a request body Cowboy is willing to skip
  when the handler did not touch it. If the remaining body size is
  too large Cowboy instead closes the connection. It defaults to 1MB.
</p>
</li>
<li>
<p>
The CONNECT and TRACE methods are now rejected as they are
  currently not implemented and must be handled differently than
  other methods. They will be implemented in a future release.
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_new_functions">New functions</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
The function <code>stream_trailers/2</code> has been added. It terminates
  a stream and adds trailer fields at the end of the response. A
  corresponding stream handler command <code>{trailers, Trailers}</code>
  has also been added.
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_bugs_fixed">Bugs fixed</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
Test suites for the core HTTP RFCs RFC7230, RFC7231 and RFC7540
  have been completed. Many of the bugs listed here were fixed as
  a result of this work.
</p>
</li>
<li>
<p>
Many HTTP/2 edge cases when clients are misbehaving have been
  corrected. This includes many cases where the request is malformed
  (for example when a pseudo-header is present twice).
</p>
</li>
<li>
<p>
When the HTTP/2 SETTINGS_INITIAL_WINDOW_SIZE value changes,
  Cowboy now properly updates the flow control windows.
</p>
</li>
<li>
<p>
HTTP/2 could mistakenly log stray messages that actually were
  expected. This is no longer the case.
</p>
</li>
<li>
<p>
We no longer send a GOAWAY frame when the HTTP/2 preface is invalid.
</p>
</li>
<li>
<p>
Some values in the Req object of pushed requests were in the
  wrong type. They are now the expected binary instead of iolist.
</p>
</li>
<li>
<p>
A response body was sometimes sent in response to HEAD requests
  when using HTTP/2. The body is now ignored.
</p>
</li>
<li>
<p>
The <code>max_headers</code> option for <code>cowboy_http</code> was not always respected
  depending on the contents of the buffer. The limit is now strict.
</p>
</li>
<li>
<p>
When an early error occurred on the HTTP/1.1 request line, the
  partial Req given to stream handlers was missing the <code>ref</code> and
  <code>peer</code> information. This has been corrected.
</p>
</li>
<li>
<p>
Absolute URIs with a userinfo component, or without an authority
  component, are now properly rejected for HTTP/1.0 and HTTP/1.1.
</p>
</li>
<li>
<p>
Whitespace is no longer allowed in header lines before the colon.
</p>
</li>
<li>
<p>
408 responses to HTTP/1.1 requests now properly include a
  connection: close header indicating that we are going to
  close the connection. This header will also be sent for
  other early errors resulting in the closing of the connection.
</p>
</li>
<li>
<p>
When both the transfer-encoding and content-length headers are
  sent in an HTTP/1.1 request, the transfer-encoding now takes
  precedence over the content-length header and the latter is
  removed from the Req object.
</p>
</li>
<li>
<p>
A 400 response is now returned when the transfer-encoding
  header is invalid or contains any transfer-coding other
  than chunked.
</p>
</li>
<li>
<p>
Invalid chunk sizes are now rejected immediately.
</p>
</li>
<li>
<p>
Chunk extensions are now limited to 129 characters. They are
  not used in practice and are still ignored by Cowboy. The limit
  is not configurable.
</p>
</li>
<li>
<p>
The final chunk was mistakenly sent in responses to HEAD
  requests. This is now corrected.
</p>
</li>
<li>
<p>
<code>OPTIONS *</code> requests were broken in Cowboy 2.0. They are now
  working again. Both the routing and <code>cowboy_req:uri/1,2</code> have
  been corrected.
</p>
</li>
<li>
<p>
204 responses no longer include a content-length header.
</p>
</li>
<li>
<p>
A packet could be lost when switching to Websocket or any
  other protocol via the <code>switch_protocol</code> command. This is
  now fixed.
</p>
</li>
<li>
<p>
A 426 response will now be sent when a handler requires
  the client to upgrade to Websocket and the request did not
  include the required headers.
</p>
</li>
<li>
<p>
Both experimental stream handlers <code>cowboy_metrics_h</code> and
  <code>cowboy_tracer_h</code> received a number of fixes and improvements.
</p>
</li>
</ul></div>
</div>
</div>



	
		
		
		
		
		

		<nav style="margin:1em 0">
			
				<a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_2.2/">
					Migrating from Cowboy 2.2 to 2.3
				</a>
			

			
				<a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_2.0/">
					Migrating from Cowboy 2.0 to 2.1
				</a>
			
		</nav>
	



</div>

<div class="span3 sidecol">


<h3>
	Cowboy
	2.3
	
	User Guide
</h3>

<ul>
	
		<li><a href="/docs/en/cowboy/2.3/guide">User Guide</a></li>
	
	
		<li><a href="/docs/en/cowboy/2.3/manual">Function Reference</a></li>
	
	
</ul>

<h4 id="docs-nav">Navigation</h4>

<h4>Version select</h4>
<ul>
	
	
	
		<li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li>
	
		<li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li>
	
		<li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li>
	
		<li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li>
	
		<li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li>
	
		<li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li>
	
</ul>

</div>
</div>
</div>
</div>

      <footer>
        <div class="container">
          <div class="row">
            <div class="span6">
              <p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
              <nav>
                <ul>
                  <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
                </ul>
              </nav>
            </div>
            <div class="span6 credits">
               <p><img src="/img/footer_logo.png"></p>
               <p>Copyright &copy; Loïc Hoguin 2012-2018</p>
            </div>
          </div>
        </div>
      </footer>

    
    <script src="/js/custom.js"></script>
  </body>
</html>