// Copyright (c) 2016 GitHub, Inc. // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. #include "shell/browser/api/electron_api_debugger.h" #include #include #include #include "base/json/json_reader.h" #include "base/json/json_writer.h" #include "content/public/browser/devtools_agent_host.h" #include "content/public/browser/web_contents.h" #include "gin/handle.h" #include "gin/object_template_builder.h" #include "gin/per_isolate_data.h" #include "shell/browser/javascript_environment.h" #include "shell/common/gin_converters/value_converter.h" #include "shell/common/gin_helper/promise.h" #include "shell/common/node_includes.h" using content::DevToolsAgentHost; namespace electron::api { gin::WrapperInfo Debugger::kWrapperInfo = {gin::kEmbedderNativeGin}; Debugger::Debugger(v8::Isolate* isolate, content::WebContents* web_contents) : content::WebContentsObserver(web_contents), web_contents_(web_contents) {} Debugger::~Debugger() = default; void Debugger::AgentHostClosed(DevToolsAgentHost* agent_host) { DCHECK(agent_host == agent_host_); agent_host_ = nullptr; ClearPendingRequests(); Emit("detach", "target closed"); } void Debugger::DispatchProtocolMessage(DevToolsAgentHost* agent_host, base::span message) { DCHECK(agent_host == agent_host_); v8::Isolate* isolate = JavascriptEnvironment::GetIsolate(); v8::HandleScope handle_scope(isolate); std::string_view message_str(reinterpret_cast(message.data()), message.size()); std::optional parsed_message = base::JSONReader::Read( message_str, base::JSON_REPLACE_INVALID_CHARACTERS); if (!parsed_message || !parsed_message->is_dict()) return; base::Value::Dict& dict = parsed_message->GetDict(); std::optional id = dict.FindInt("id"); if (!id) { std::string* method = dict.FindString("method"); if (!method) return; std::string* session_id = dict.FindString("sessionId"); base::Value::Dict* params = dict.FindDict("params"); Emit("message", *method, params ? std::move(*params) : base::Value::Dict(), session_id ? *session_id : ""); } else { auto it = pending_requests_.find(*id); if (it == pending_requests_.end()) return; gin_helper::Promise promise = std::move(it->second); pending_requests_.erase(it); base::Value::Dict* error = dict.FindDict("error"); if (error) { std::string* error_message = error->FindString("message"); promise.RejectWithErrorMessage(error_message ? *error_message : ""); } else { base::Value::Dict* result = dict.FindDict("result"); promise.Resolve(result ? std::move(*result) : base::Value::Dict()); } } } void Debugger::RenderFrameHostChanged(content::RenderFrameHost* old_rfh, content::RenderFrameHost* new_rfh) { if (agent_host_) { agent_host_->DisconnectWebContents(); auto* web_contents = content::WebContents::FromRenderFrameHost(new_rfh); agent_host_->ConnectWebContents(web_contents); } } void Debugger::Attach(gin::Arguments* args) { std::string protocol_version; args->GetNext(&protocol_version); if (agent_host_) { args->ThrowTypeError("Debugger is already attached to the target"); return; } if (!protocol_version.empty() && !DevToolsAgentHost::IsSupportedProtocolVersion(protocol_version)) { args->ThrowTypeError("Requested protocol version is not supported"); return; } agent_host_ = DevToolsAgentHost::GetOrCreateFor(web_contents_); if (!agent_host_) { args->ThrowTypeError("No target available"); return; } agent_host_->AttachClient(this); } bool Debugger::IsAttached() { return agent_host_ && agent_host_->IsAttached(); } void Debugger::Detach() { if (!agent_host_) return; agent_host_->DetachClient(this); AgentHostClosed(agent_host_.get()); } v8::Local Debugger::SendCommand(gin::Arguments* args) { v8::Isolate* isolate = args->isolate(); gin_helper::Promise promise(isolate); v8::Local handle = promise.GetHandle(); if (!agent_host_) { promise.RejectWithErrorMessage("No target available"); return handle; } std::string method; if (!args->GetNext(&method)) { promise.RejectWithErrorMessage("Invalid method"); return handle; } base::Value::Dict command_params; args->GetNext(&command_params); std::string session_id; if (args->GetNext(&session_id) && session_id.empty()) { promise.RejectWithErrorMessage("Empty session id is not allowed"); return handle; } base::Value::Dict request; int request_id = ++previous_request_id_; pending_requests_.emplace(request_id, std::move(promise)); request.Set("id", request_id); request.Set("method", method); if (!command_params.empty()) { request.Set("params", std::move(command_params)); } if (!session_id.empty()) { request.Set("sessionId", session_id); } const auto json_args = base::WriteJson(request).value_or(""); agent_host_->DispatchProtocolMessage( this, base::as_bytes(base::make_span(json_args))); return handle; } void Debugger::ClearPendingRequests() { for (auto& it : pending_requests_) it.second.RejectWithErrorMessage("target closed while handling command"); pending_requests_.clear(); } // static gin::Handle Debugger::Create(v8::Isolate* isolate, content::WebContents* web_contents) { return gin::CreateHandle(isolate, new Debugger(isolate, web_contents)); } gin::ObjectTemplateBuilder Debugger::GetObjectTemplateBuilder( v8::Isolate* isolate) { return gin_helper::EventEmitterMixin::GetObjectTemplateBuilder( isolate) .SetMethod("attach", &Debugger::Attach) .SetMethod("isAttached", &Debugger::IsAttached) .SetMethod("detach", &Debugger::Detach) .SetMethod("sendCommand", &Debugger::SendCommand); } const char* Debugger::GetTypeName() { return "Debugger"; } } // namespace electron::api