Merge pull request square#356 from adriancole/draft6-headers

Update to http/2 draft 6 CONTINUATION after HEADERS frame

Author: Adrian Cole

mockwebserver/src/main/java/com/squareup/okhttp/mockwebserver/MockWebServer.java

@@ -71,15 +71,15 @@
 public final class MockWebServer {
   private static final byte[] NPN_PROTOCOLS = {
       // TODO: support HTTP/2.0.
-      // 17, 'H', 'T', 'T', 'P', '-', 'd', 'r', 'a', 'f', 't', '-', '0', '4', '/', '2', '.', '0',
+      // 17, 'H', 'T', 'T', 'P', '-', 'd', 'r', 'a', 'f', 't', '-', '0', '6', '/', '2', '.', '0',
       6, 's', 'p', 'd', 'y', '/', '3',
       8, 'h', 't', 't', 'p', '/', '1', '.', '1'
   };
   private static final byte[] SPDY3 = new byte[] {
       's', 'p', 'd', 'y', '/', '3'
   };
-  private static final byte[] HTTP_20_DRAFT_04 = new byte[] {
-      'H', 'T', 'T', 'P', '-', 'd', 'r', 'a', 'f', 't', '-', '0', '4', '/', '2', '.', '0'
+  private static final byte[] HTTP_20_DRAFT_06 = new byte[] {
+      'H', 'T', 'T', 'P', '-', 'd', 'r', 'a', 'f', 't', '-', '0', '6', '/', '2', '.', '0'
   };
   private static final byte[] HTTP_11 = new byte[] {
       'h', 't', 't', 'p', '/', '1', '.', '1'
@@ -327,8 +327,8 @@ public void processConnection() throws Exception {
             byte[] selectedProtocol = Platform.get().getNpnSelectedProtocol(sslSocket);
             if (selectedProtocol == null || Arrays.equals(selectedProtocol, HTTP_11)) {
               transport = Transport.HTTP_11;
-            } else if (Arrays.equals(selectedProtocol, HTTP_20_DRAFT_04)) {
-              transport = Transport.HTTP_20_DRAFT_04;
+            } else if (Arrays.equals(selectedProtocol, HTTP_20_DRAFT_06)) {
+              transport = Transport.HTTP_20_DRAFT_06;
             } else if (Arrays.equals(selectedProtocol, SPDY3)) {
               transport = Transport.SPDY_3;
             } else {
@@ -341,14 +341,14 @@ public void processConnection() throws Exception {
           socket = raw;
         }
 
-        if (transport == Transport.SPDY_3 || transport == Transport.HTTP_20_DRAFT_04) {
+        if (transport == Transport.SPDY_3 || transport == Transport.HTTP_20_DRAFT_06) {
           SpdySocketHandler spdySocketHandler = new SpdySocketHandler(socket, transport);
           SpdyConnection.Builder builder = new SpdyConnection.Builder(false, socket)
               .handler(spdySocketHandler);
           if (transport == Transport.SPDY_3) {
             builder.spdy3();
           } else {
-            builder.http20Draft04();
+            builder.http20Draft06();
           }
           SpdyConnection spdyConnection = builder.build();
           openSpdyConnections.put(spdyConnection, Boolean.TRUE);
@@ -717,6 +717,6 @@ private void writeResponse(SpdyStream stream, MockResponse response) throws IOEx
   }
 
   enum Transport {
-    HTTP_11, SPDY_3, HTTP_20_DRAFT_04
+    HTTP_11, SPDY_3, HTTP_20_DRAFT_06
   }
 }

okhttp-protocols/src/main/java/com/squareup/okhttp/internal/spdy/Hpack.java

@@ -9,8 +9,8 @@
 import java.util.List;
 
 /**
- * Read and write HPACK v01.
- * http://http2.github.io/compression-spec/compression-spec.html#rfc.status
+ * Read and write HPACK v03.
+ * http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-03
  */
 final class Hpack {
   static final int PREFIX_5_BITS = 0x1f;

okhttp-protocols/src/main/java/com/squareup/okhttp/internal/spdy/Http20Draft04.java renamed to okhttp-protocols/src/main/java/com/squareup/okhttp/internal/spdy/Http20Draft06.java

@@ -26,7 +26,11 @@
 import java.util.Arrays;
 import java.util.List;
 
-final class Http20Draft04 implements Variant {
+/**
+ * Read and write http/2 v06 frames.
+ * http://tools.ietf.org/html/draft-ietf-httpbis-http2-06
+ */
+final class Http20Draft06 implements Variant {
   private static final byte[] CONNECTION_HEADER;
   static {
     try {
@@ -45,8 +49,10 @@ final class Http20Draft04 implements Variant {
   static final int TYPE_PING = 0x6;
   static final int TYPE_GOAWAY = 0x7;
   static final int TYPE_WINDOW_UPDATE = 0x9;
+  static final int TYPE_CONTINUATION = 0xa;
 
   static final int FLAG_END_STREAM = 0x1;
+  /** Used for headers, push-promise and continuation. */
   static final int FLAG_END_HEADERS = 0x4;
   static final int FLAG_PRIORITY = 0x8;
   static final int FLAG_PONG = 0x1;
@@ -141,31 +147,38 @@ private void readHeaders(Handler handler, int flags, int length, int streamId)
         throws IOException {
       if (streamId == 0) throw ioException("TYPE_HEADERS streamId == 0");
 
+      boolean inFinished = (flags & FLAG_END_STREAM) != 0;
+
       while (true) {
         hpackReader.readHeaders(length);
 
         if ((flags & FLAG_END_HEADERS) != 0) {
           hpackReader.emitReferenceSet();
           List<String> namesAndValues = hpackReader.getAndReset();
-          boolean inFinished = (flags & FLAG_END_STREAM) != 0;
           int priority = -1; // TODO: priority
           handler.headers(false, inFinished, streamId, -1, priority, namesAndValues,
               HeadersMode.HTTP_20_HEADERS);
           return;
         }
 
-        // Read another frame of headers.
+        // Read another continuation frame.
         int w1 = in.readInt();
         int w2 = in.readInt();
 
         length = (w1 & 0xffff0000) >> 16;
         int newType = (w1 & 0xff00) >> 8;
         flags = w1 & 0xff;
-        // boolean r = (w2 & 0x80000000) != 0; // Reserved.
+
+        // TODO: remove in draft 8: CONTINUATION no longer sets END_STREAM
+        inFinished = (flags & FLAG_END_STREAM) != 0;
+
+        // boolean u = (w2 & 0x80000000) != 0; // Unused.
         int newStreamId = (w2 & 0x7fffffff);
 
-        if (newType != TYPE_HEADERS) throw ioException("TYPE_HEADERS didn't have FLAG_END_HEADERS");
-        if (newStreamId != streamId) throw ioException("TYPE_HEADERS streamId changed");
+        if (newType != TYPE_CONTINUATION) {
+          throw ioException("TYPE_CONTINUATION didn't have FLAG_END_HEADERS");
+        }
+        if (newStreamId != streamId) throw ioException("TYPE_CONTINUATION streamId changed");
       }
     }
 
@@ -302,6 +315,7 @@ private void headers(boolean outFinished, int streamId, int priority,
       hpackBuffer.reset();
       hpackWriter.writeHeaders(nameValueBlock);
       int type = TYPE_HEADERS;
+      // TODO: implement CONTINUATION
       int length = hpackBuffer.size();
       int flags = FLAG_END_HEADERS;
       if (outFinished) flags |= FLAG_END_STREAM;

okhttp-protocols/src/main/java/com/squareup/okhttp/internal/spdy/SpdyConnection.java

@@ -59,7 +59,7 @@ public final class SpdyConnection implements Closeable {
       Integer.MAX_VALUE, 60, TimeUnit.SECONDS, new SynchronousQueue<Runnable>(),
       Util.daemonThreadFactory("OkHttp SpdyConnection"));
 
-  /** The protocol variant, like SPDY/3 or HTTP-draft-04/2.0. */
+  /** The protocol variant, like SPDY/3 or HTTP-draft-06/2.0. */
   final Variant variant;
 
   /** True if this peer initiated the connection. */
@@ -416,8 +416,8 @@ public Builder spdy3() {
       return this;
     }
 
-    public Builder http20Draft04() {
-      this.variant = Variant.HTTP_20_DRAFT_04;
+    public Builder http20Draft06() {
+      this.variant = Variant.HTTP_20_DRAFT_06;
       return this;
     }
 

okhttp-protocols/src/main/java/com/squareup/okhttp/internal/spdy/Variant.java

@@ -21,7 +21,7 @@
 /** A version and dialect of the framed socket protocol. */
 interface Variant {
   Variant SPDY3 = new Spdy3();
-  Variant HTTP_20_DRAFT_04 = new Http20Draft04();
+  Variant HTTP_20_DRAFT_06 = new Http20Draft06();
 
   /**
    * @param client true if this is the HTTP client's reader, reading frames from

okhttp-protocols/src/test/java/com/squareup/okhttp/internal/spdy/Http20Draft04Test.java renamed to okhttp-protocols/src/test/java/com/squareup/okhttp/internal/spdy/Http20Draft06Test.java

@@ -27,7 +27,7 @@
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
-public class Http20Draft04Test {
+public class Http20Draft06Test {
 
   @Test public void onlyOneLiteralHeadersFrame() throws IOException {
     final int expectedStreamId = 15;
@@ -40,13 +40,13 @@ public class Http20Draft04Test {
     {
       byte[] headerBytes = literalHeaders(sentHeaders);
       dataOut.writeShort(headerBytes.length);
-      dataOut.write(Http20Draft04.TYPE_HEADERS);
-      dataOut.write(Http20Draft04.FLAG_END_HEADERS | Http20Draft04.FLAG_END_STREAM);
+      dataOut.write(Http20Draft06.TYPE_HEADERS);
+      dataOut.write(Http20Draft06.FLAG_END_HEADERS | Http20Draft06.FLAG_END_STREAM);
       dataOut.writeInt(expectedStreamId & 0x7fffffff); // stream with reserved bit set
       dataOut.write(headerBytes);
     }
 
-    FrameReader fr = new Http20Draft04.Reader(new ByteArrayInputStream(out.toByteArray()), false);
+    FrameReader fr = new Http20Draft06.Reader(new ByteArrayInputStream(out.toByteArray()), false);
 
     // Consume the headers frame.
     fr.nextFrame(new BaseTestHandler() {
@@ -66,7 +66,7 @@ public void headers(boolean outFinished, boolean inFinished, int streamId,
     });
   }
 
-  @Test public void twoLiteralHeadersFrames() throws IOException {
+  @Test public void headersFrameThenContinuation() throws IOException {
     final int expectedStreamId = 15;
 
     ByteArrayOutputStream out = new ByteArrayOutputStream();
@@ -76,23 +76,23 @@ public void headers(boolean outFinished, boolean inFinished, int streamId,
     {
       byte[] headerBytes = literalHeaders(Arrays.asList("foo", "bar"));
       dataOut.writeShort(headerBytes.length);
-      dataOut.write(Http20Draft04.TYPE_HEADERS);
+      dataOut.write(Http20Draft06.TYPE_HEADERS);
       dataOut.write(0); // no flags
       dataOut.writeInt(expectedStreamId & 0x7fffffff); // stream with reserved bit set
       dataOut.write(headerBytes);
     }
 
-    // Write the second headers frame, specifying no more frames are expected.
+    // Write the continuation frame, specifying no more frames are expected.
     {
       byte[] headerBytes = literalHeaders(Arrays.asList("baz", "qux"));
       dataOut.writeShort(headerBytes.length);
-      dataOut.write(Http20Draft04.TYPE_HEADERS);
-      dataOut.write(Http20Draft04.FLAG_END_HEADERS | Http20Draft04.FLAG_END_STREAM);
+      dataOut.write(Http20Draft06.TYPE_CONTINUATION);
+      dataOut.write(Http20Draft06.FLAG_END_HEADERS | Http20Draft06.FLAG_END_STREAM);
       dataOut.writeInt(expectedStreamId & 0x7fffffff); // stream with reserved bit set
       dataOut.write(headerBytes);
     }
 
-    FrameReader fr = new Http20Draft04.Reader(new ByteArrayInputStream(out.toByteArray()), false);
+    FrameReader fr = new Http20Draft06.Reader(new ByteArrayInputStream(out.toByteArray()), false);
 
     // Reading the above frames should result in a concatenated nameValueBlock.
     fr.nextFrame(new BaseTestHandler() {