Fix CDP errors in Network domain - two booleans not marked as optional

Author: eNcacz

cdp/network.py

@@ -3090,7 +3090,7 @@ class RequestWillBeSent:
     #: In the case that redirectResponse is populated, this flag indicates whether
     #: requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted
     #: for the request which was just redirected.
-    redirect_has_extra_info: bool
+    redirect_has_extra_info: typing.Optional[bool]
     #: Redirect response data.
     redirect_response: typing.Optional[Response]
     #: Type of this resource.
@@ -3110,7 +3110,7 @@ def from_json(cls, json: T_JSON_DICT) -> RequestWillBeSent:
             timestamp=MonotonicTime.from_json(json['timestamp']),
             wall_time=TimeSinceEpoch.from_json(json['wallTime']),
             initiator=Initiator.from_json(json['initiator']),
-            redirect_has_extra_info=bool(json['redirectHasExtraInfo']),
+            redirect_has_extra_info=bool(json['redirectHasExtraInfo']) if 'redirectHasExtraInfo' in json else None,
             redirect_response=Response.from_json(json['redirectResponse']) if 'redirectResponse' in json else None,
             type_=ResourceType.from_json(json['type']) if 'type' in json else None,
             frame_id=page.FrameId.from_json(json['frameId']) if 'frameId' in json else None,
@@ -3181,7 +3181,7 @@ class ResponseReceived:
     response: Response
     #: Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be
     #: or were emitted for this request.
-    has_extra_info: bool
+    has_extra_info: typing.Optional[bool]
     #: Frame identifier.
     frame_id: typing.Optional[page.FrameId]
 
@@ -3193,7 +3193,7 @@ def from_json(cls, json: T_JSON_DICT) -> ResponseReceived:
             timestamp=MonotonicTime.from_json(json['timestamp']),
             type_=ResourceType.from_json(json['type']),
             response=Response.from_json(json['response']),
-            has_extra_info=bool(json['hasExtraInfo']),
+            has_extra_info=bool(json['hasExtraInfo']) if 'hasExtraInfo' in json else None,
             frame_id=page.FrameId.from_json(json['frameId']) if 'frameId' in json else None
         )
 

generator/generate.py

@@ -952,6 +952,38 @@ def generate_docs(docs_path, domains):
             f.write(domain.generate_sphinx())
 
 
+def patchCDP(domains):
+    '''Patch up CDP errors. It's easier to patch that here than it is to modify the generator code.'''
+
+    # 1. DOM includes an erroneous $ref that refers to itself.
+    # 2. Page includes an event with an extraneous backtick in the description.
+    # 3. Network.requestWillBeSent.redirectHasExtraInfo is not marked as optional but it is not present in all events
+    # 4. Network.responseReceived.hasExtraInfo is not marked as optional but it is not present in all events
+    for domain in domains:
+        if domain.domain == 'DOM':
+            for cmd in domain.commands:
+                if cmd.name == 'resolveNode':
+                    # Patch 1
+                    cmd.parameters[1].ref = 'BackendNodeId'
+        elif domain.domain == 'Page':
+            for event in domain.events:
+                if event.name == 'screencastVisibilityChanged':
+                    # Patch 2
+                    event.description = event.description.replace('`', '')
+        elif domain.domain == 'Network':
+            for event in domain.events:
+                if event.name == 'requestWillBeSent':
+                    for param in event.parameters:
+                        if param.name == 'redirectHasExtraInfo':
+                            # Patch 3
+                            param.optional = True
+                if event.name == 'responseReceived':
+                    for param in event.parameters:
+                        if param.name == 'hasExtraInfo':
+                            # Patch 4
+                            param.optional = True
+
+
 def main():
     ''' Main entry point. '''
     here = Path(__file__).parent.resolve()
@@ -974,21 +1006,7 @@ def main():
         domains.extend(parse(json_path, output_path))
     domains.sort(key=operator.attrgetter('domain'))
 
-    # Patch up CDP errors. It's easier to patch that here than it is to modify
-    # the generator code.
-    # 1. DOM includes an erroneous $ref that refers to itself.
-    # 2. Page includes an event with an extraneous backtick in the description.
-    for domain in domains:
-        if domain.domain == 'DOM':
-            for cmd in domain.commands:
-                if cmd.name == 'resolveNode':
-                    # Patch 1
-                    cmd.parameters[1].ref = 'BackendNodeId'
-        elif domain.domain == 'Page':
-            for event in domain.events:
-                if event.name == 'screencastVisibilityChanged':
-                    # Patch 2
-                    event.description = event.description.replace('`', '')
+    patchCDP(domains)
 
     for domain in domains:
         logger.info('Generating module: %s → %s.py', domain.domain,