Merge pull request #479 from python-hyper/backport-2.4.X

Backport #476 to 2.4.X

Author: Lukasa

HISTORY.rst

@@ -4,6 +4,12 @@ Release History
 2.4.4dev0
 ---------
 
+Bugfixes
+~~~~~~~~
+
+- Allowed hyperframe v5 support while continuing to ignore unexpected frames.
+
+
 2.4.3 (2017-01-27)
 ------------------
 

h2/connection.py

@@ -27,7 +27,7 @@
 from .exceptions import (
     ProtocolError, NoSuchStreamError, FlowControlError, FrameTooLargeError,
     TooManyStreamsError, StreamClosedError, StreamIDTooLowError,
-    NoAvailableStreamIDError, UnsupportedFrameError, RFC1122Error
+    NoAvailableStreamIDError, RFC1122Error
 )
 from .frame_buffer import FrameBuffer
 from .settings import (
@@ -38,6 +38,15 @@
 from .utilities import validate_headers, guard_increment_window
 
 
+try:
+    from hyperframe.frame import ExtensionFrame
+except ImportError:  # Platform-specific: Hyperframe < 5.0.0
+    # If the frame doesn't exist, that's just fine: we'll define it ourselves
+    # and the method will just never be called.
+    class ExtensionFrame(object):
+        pass
+
+
 class ConnectionState(Enum):
     IDLE = 0
     CLIENT_OPEN = 1
@@ -358,6 +367,7 @@ def __init__(self, client_side=True, header_encoding='utf-8'):
             GoAwayFrame: self._receive_goaway_frame,
             ContinuationFrame: self._receive_naked_continuation,
             AltSvcFrame: self._receive_alt_svc_frame,
+            ExtensionFrame: self._receive_unknown_frame
         }
 
     def _prepare_for_sending(self, frames):
@@ -1352,10 +1362,6 @@ def _receive_frame(self, frame):
             if frame.stream_id not in self._reset_streams:
                 raise
             events = []
-        except KeyError as e:  # pragma: no cover
-            # We don't have a function for handling this frame. Let's call this
-            # a PROTOCOL_ERROR and exit.
-            raise UnsupportedFrameError("Unexpected frame: %s" % frame)
         else:
             self._prepare_for_sending(frames)
 
@@ -1713,6 +1719,18 @@ def _receive_alt_svc_frame(self, frame):
 
         return frames, events
 
+    def _receive_unknown_frame(self, frame):
+        """
+        We have received a frame that we do not understand. This is almost
+        certainly an extension frame, though it's impossible to be entirely
+        sure.
+
+        RFC 7540 § 5.5 says that we MUST ignore unknown frame types: so we
+        do.
+        """
+        # We don't do anything here.
+        return [], []
+
     def _local_settings_acked(self):
         """
         Handle the local settings being ACKed, update internal state.

h2/frame_buffer.py

@@ -65,11 +65,13 @@ def _parse_frame_header(self, data):
         """
         try:
             frame, length = Frame.parse_frame_header(data[:9])
-        except UnknownFrameError as e:
+        except UnknownFrameError as e:  # Platform-specific: Hyperframe < 5.0
             # Here we do something a bit odd. We want to consume the frame data
             # as consistently as possible, but we also don't ever want to yield
             # None. Instead, we make sure that, if there is no frame, we
             # recurse into ourselves.
+            # This can only happen now on older versions of hyperframe.
+            # TODO: Remove in 3.0
             length = e.length
             frame = None
         except ValueError as e:

setup.py

@@ -61,7 +61,7 @@
         'Programming Language :: Python :: Implementation :: PyPy',
     ],
     install_requires=[
-        'hyperframe>=3.1, <5, !=4.0.0',
+        'hyperframe>=3.1, <6, !=4.0.0',
         'hpack>=2.2, <3',
     ],
     extras_require={