Harden CDP patch coverage

Co-authored-by: P4x-ng <P4X-ng@users.noreply.github.com>

Author: cursoragent

generator/generate.py

@@ -990,32 +990,26 @@ def generate_docs(docs_path, domains):
 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
+    # 1. Page includes an event with an extraneous backtick in the description.
+    # 2. Network.requestWillBeSent.redirectHasExtraInfo is not marked as optional but it is not present in all events
+    # 3. 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':
+        if domain.domain == 'Page':
             for event in domain.events:
                 if event.name == 'screencastVisibilityChanged':
-                    # Patch 2
+                    # Patch 1
                     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
+                            # Patch 2
                             param.optional = True
                 if event.name == 'responseReceived':
                     for param in event.parameters:
                         if param.name == 'hasExtraInfo':
-                            # Patch 4
+                            # Patch 3
                             param.optional = True
 
 

generator/test_generate.py

@@ -12,7 +12,7 @@
 
 from textwrap import dedent
 
-from generate import CdpCommand, CdpDomain, CdpEvent, CdpType, docstring
+from generate import CdpCommand, CdpDomain, CdpEvent, CdpType, docstring, patchCDP
 
 
 def test_docstring():
@@ -491,6 +491,51 @@ def resolve_animation(
     assert expected == actual
 
 
+def test_cdp_command_same_domain_ref_parameter():
+    json_cmd = {
+        "name": "resolveNode",
+        "description": "Resolves the JavaScript node object for a given BackendNodeId.",
+        "parameters": [
+            {
+                "name": "backendNodeId",
+                "description": "Backend identifier of the node to resolve.",
+                "optional": True,
+                "$ref": "DOM.BackendNodeId"
+            }
+        ],
+        "returns": [
+            {
+                "name": "object",
+                "description": "JavaScript object wrapper for given node.",
+                "$ref": "Runtime.RemoteObject"
+            }
+        ]
+    }
+    expected = dedent("""\
+        def resolve_node(
+                backend_node_id: typing.Optional[BackendNodeId] = None
+            ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,runtime.RemoteObject]:
+            r'''
+            Resolves the JavaScript node object for a given BackendNodeId.
+
+            :param backend_node_id: *(Optional)* Backend identifier of the node to resolve.
+            :returns: JavaScript object wrapper for given node.
+            '''
+            params: T_JSON_DICT = dict()
+            if backend_node_id is not None:
+                params['backendNodeId'] = backend_node_id.to_json()
+            cmd_dict: T_JSON_DICT = {
+                'method': 'DOM.resolveNode',
+                'params': params,
+            }
+            json = yield cmd_dict
+            return runtime.RemoteObject.from_json(json['object'])""")
+
+    cmd = CdpCommand.from_json(json_cmd, 'DOM')
+    actual = cmd.generate_code()
+    assert expected == actual
+
+
 def test_cdp_command_multiple_return():
     json_cmd = {
         "name": "getEncodedResponse",
@@ -858,6 +903,46 @@ def test_domain_shadows_builtin():
     assert domain.module == 'input_'
 
 
+def test_patch_cdp_marks_network_extra_info_flags_optional():
+    json_domain = {
+        "domain": "Network",
+        "types": [],
+        "commands": [],
+        "events": [
+            {
+                "name": "requestWillBeSent",
+                "parameters": [
+                    {"name": "requestId", "type": "string"},
+                    {"name": "redirectHasExtraInfo", "type": "boolean"},
+                ],
+            },
+            {
+                "name": "responseReceived",
+                "parameters": [
+                    {"name": "requestId", "type": "string"},
+                    {"name": "hasExtraInfo", "type": "boolean"},
+                ],
+            },
+        ],
+    }
+
+    domain = CdpDomain.from_json(json_domain)
+    request_will_be_sent = next(
+        event for event in domain.events if event.name == 'requestWillBeSent'
+    )
+    response_received = next(
+        event for event in domain.events if event.name == 'responseReceived'
+    )
+
+    assert request_will_be_sent.parameters[1].optional is False
+    assert response_received.parameters[1].optional is False
+
+    patchCDP([domain])
+
+    assert request_will_be_sent.parameters[1].optional is True
+    assert response_received.parameters[1].optional is True
+
+
 def test_cdp_domain_sphinx():
     json_domain = {
         "domain": "Animation",

test/test_cdp.py

@@ -1,7 +1,7 @@
 '''
 Some basic tests for the generated CDP modules.
 '''
-from cdp import dom, io, page, tracing, util
+from cdp import dom, io, network, page, tracing, util
 
 
 def test_primitive_type():
@@ -71,3 +71,52 @@ def test_event_dispatch():
     assert event.window_name == 'Window 1'
     assert event.window_features == ['feature1', 'feature2']
     assert not event.user_gesture
+
+
+def test_request_will_be_sent_missing_redirect_has_extra_info():
+    event = network.RequestWillBeSent.from_json({
+        'requestId': 'request-1',
+        'loaderId': 'loader-1',
+        'documentURL': 'https://example.com',
+        'request': {
+            'url': 'https://example.com',
+            'method': 'GET',
+            'headers': {},
+            'initialPriority': 'Medium',
+            'referrerPolicy': 'strict-origin-when-cross-origin',
+        },
+        'timestamp': 1.25,
+        'wallTime': 2.5,
+        'initiator': {
+            'type': 'parser',
+        },
+    })
+
+    assert event.request_id == network.RequestId('request-1')
+    assert event.redirect_has_extra_info is None
+    assert event.request.initial_priority == network.ResourcePriority.MEDIUM
+
+
+def test_response_received_missing_has_extra_info():
+    event = network.ResponseReceived.from_json({
+        'requestId': 'request-1',
+        'loaderId': 'loader-1',
+        'timestamp': 1.25,
+        'type': 'Document',
+        'response': {
+            'url': 'https://example.com',
+            'status': 200,
+            'statusText': 'OK',
+            'headers': {},
+            'mimeType': 'text/html',
+            'charset': 'utf-8',
+            'connectionReused': False,
+            'connectionId': 1,
+            'encodedDataLength': 128,
+            'securityState': 'secure',
+        },
+    })
+
+    assert event.request_id == network.RequestId('request-1')
+    assert event.has_extra_info is None
+    assert event.response.status == 200