DevTools: respond with error when Debugger command is sent to disabled debugger agent

Source/core/inspector/CodeGeneratorInspector.py

 #!/usr/bin/env python
 # Copyright (c) 2011 Google Inc. All rights reserved.
 # Copyright (c) 2012 Intel Corporation. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer.
@@ skipping 38 matching lines @@
 
 TYPES_WITH_RUNTIME_CAST_SET = frozenset(["Runtime.RemoteObject", "Runtime.PropertyDescriptor", "Runtime.InternalPropertyDescriptor",
                                          "Debugger.FunctionDetails", "Debugger.GeneratorObjectDetails", "Debugger.CollectionEntry", "Debugger.CallFrame", "Debugger.Location"])
 
 TYPES_WITH_OPEN_FIELD_LIST_SET = frozenset([
                                             # InspectorStyleSheet not only creates this property but wants to read it and modify it.
                                             "CSS.CSSProperty",
                                             # InspectorResourceAgent needs to update mime-type.
                                             "Network.Response"])
 
+DOMAINS_WITH_ENABLEMENT_CHECK = frozenset(["DOMDebugger", "Debugger"])
+
 cmdline_parser = optparse.OptionParser()
 cmdline_parser.add_option("--output_dir")
 
 try:
     arg_options, arg_values = cmdline_parser.parse_args()
     if (len(arg_values) != 1):
         raise Exception("Exactly one plain argument expected (found %s)" % len(arg_values))
     input_json_filename = arg_values[0]
     output_dirname = arg_options.output_dir
     if not output_dirname:
@@ skipping 1576 matching lines @@
                 domainClassName=domain_name,
                 domainFieldName=domain_name_lower,
                 frontendDomainMethodDeclarations="".join(flatten_list(frontend_method_declaration_lines))))
 
             agent_interface_name = Capitalizer.lower_camel_case_to_upper(domain_name) + "CommandHandler"
             Generator.backend_agent_interface_list.append("    class %s {\n" % agent_interface_name)
             Generator.backend_agent_interface_list.append("    public:\n")
             if "commands" in json_domain:
                 for json_command in json_domain["commands"]:
                     Generator.process_command(json_command, domain_name, agent_field_name, agent_interface_name)
+            if domain_name in DOMAINS_WITH_ENABLEMENT_CHECK:
+                Generator.backend_agent_interface_list.append("\n    virtual bool checkEnabled(ErrorString*) = 0;\n")
             Generator.backend_agent_interface_list.append("\n    protected:\n")
             Generator.backend_agent_interface_list.append("        virtual ~%s() { }\n" % agent_interface_name)
             Generator.backend_agent_interface_list.append("    };\n\n")
 
             Generator.backend_constructor_init_list.append("        , m_%s(0)" % agent_field_name)
             Generator.backend_virtual_setters_list.append("    virtual void registerAgent(%s* %s) = 0;" % (agent_interface_name, agent_field_name))
             Generator.backend_setters_list.append("    virtual void registerAgent(%s* %s) { ASSERT(!m_%s); m_%s = %s; }" % (agent_interface_name, agent_field_name, agent_field_name, agent_field_name, agent_field_name))
             Generator.backend_field_list.append("    %s* m_%s;" % (agent_interface_name, agent_field_name))
 
     @staticmethod
@@ skipping 47 matching lines @@
         ad_hoc_type_output = []
         backend_agent_interface_list.append(ad_hoc_type_output)
         ad_hoc_type_writer = Writer(ad_hoc_type_output, "        ")
 
         backend_agent_interface_list.append("        virtual void %s(ErrorString*" % json_command_name)
 
         method_in_code = ""
         method_out_code = ""
         agent_call_param_list = ["&error"]
         agent_call_params_declaration_list = ["    ErrorString error;"]
+        agent_enablement_check = ""
+        if domain_name in DOMAINS_WITH_ENABLEMENT_CHECK and json_command["name"] != "enable":
+            agent_enablement_check = "    if (!m_" + agent_field_name + "->checkEnabled(&error)) {\n"
+            agent_enablement_check += "        reportProtocolError(callId, ServerError, error);\n"

[pfeldman, 2015/05/05 14:00:13]

- This is not a server error, this is rather illegal request.
- Also, we should not add logic into this giant generator, but should rather
remove this logic. Otherwise, you are introducing a huge indirection that is
going to be hard to understand / maintain. Why can't we simply check for agent
being enabled wherever it is necessary to be enabled as we agreed offline?

+            agent_enablement_check += "        return;\n"
+            agent_enablement_check += "    }\n"
         send_response_call_params_list = ["error"]
         request_message_param = ""
         normal_response_cook_text = ""
         error_type_binding = None
         if "error" in json_command:
             json_error = json_command["error"]
             error_type_binding = Generator.resolve_type_and_generate_ad_hoc(json_error, json_command_name + "Error", json_command_name, domain_name, ad_hoc_type_writer, agent_interface_name + "::")
             error_type_model = error_type_binding.get_type_model().get_optional()
             error_annotated_type = error_type_model.get_command_return_pass_model().get_output_parameter_type()
             agent_call_param_list.append("%serrorData" % error_type_model.get_command_return_pass_model().get_output_argument_prefix())
@@ skipping 136 matching lines @@
         agent_field = "m_" + agent_field_name
         if "redirect" in json_command:
             agent_field = "m_" + DomainNameFixes.get_fixed_data(json_command.get("redirect"))
 
         Generator.backend_method_implementation_list.append(Templates.backend_method.substitute(None,
             domainName=domain_name, methodName=json_command_name,
             agentField=agent_field,
             methodCode="".join([method_in_code, method_out_code]),
             agentCallParamsDeclaration="\n".join(agent_call_params_declaration_list),
             agentCallParams=", ".join(agent_call_param_list),
+            agentEnablementCheck=agent_enablement_check,
             requestMessageObject=request_message_param,
             responseCook=normal_response_cook_text,
             sendResponseCallParams=", ".join(send_response_call_params_list),
             commandNameIndex=cmd_enum_name))
         declaration_command_name = "%s.%s\\0" % (domain_name, json_command_name)
         Generator.backend_method_name_declaration_list.append("    \"%s\"" % declaration_command_name)
         assert Generator.backend_method_name_declaration_current_index < 2 ** 16, "Number too large for unsigned short."
         Generator.backend_method_name_declaration_index_list.append("    %d," % Generator.backend_method_name_declaration_current_index)
         Generator.backend_method_name_declaration_current_index += len(declaration_command_name) - 1
 
@@ skipping 230 matching lines @@
     validatorIfdefName=VALIDATOR_IFDEF_NAME))
 
 backend_h_file.close()
 backend_cpp_file.close()
 
 frontend_h_file.close()
 frontend_cpp_file.close()
 
 typebuilder_h_file.close()
 typebuilder_cpp_file.close()