fix api and docs

This commit is contained in:
Robo 2016-01-22 10:27:25 +05:30
parent 0e2323c9c8
commit df5bad3f89
4 changed files with 27 additions and 39 deletions

View file

@ -1,4 +1,4 @@
// Copyright (c) 2015 GitHub, Inc. // Copyright (c) 2016 GitHub, Inc.
// Use of this source code is governed by the MIT license that can be // Use of this source code is governed by the MIT license that can be
// found in the LICENSE file. // found in the LICENSE file.
@ -33,8 +33,7 @@ void Debugger::AgentHostClosed(DevToolsAgentHost* agent_host,
std::string detach_reason = "target closed"; std::string detach_reason = "target closed";
if (replaced_with_another_client) if (replaced_with_another_client)
detach_reason = "replaced with devtools"; detach_reason = "replaced with devtools";
if (!detach_callback_.is_null()) Emit("detach", detach_reason);
detach_callback_.Run(detach_reason);
} }
void Debugger::DispatchProtocolMessage(DevToolsAgentHost* agent_host, void Debugger::DispatchProtocolMessage(DevToolsAgentHost* agent_host,
@ -54,8 +53,7 @@ void Debugger::DispatchProtocolMessage(DevToolsAgentHost* agent_host,
return; return;
base::DictionaryValue* params = nullptr; base::DictionaryValue* params = nullptr;
dict->GetDictionary("params", &params); dict->GetDictionary("params", &params);
if (!response_callback_.is_null()) Emit("message", method, *params);
response_callback_.Run(method, *params);
} else { } else {
auto send_command_callback = pending_requests_[id]; auto send_command_callback = pending_requests_[id];
pending_requests_.erase(id); pending_requests_.erase(id);
@ -90,7 +88,10 @@ void Debugger::Attach(mate::Arguments* args) {
} }
void Debugger::Detach() { void Debugger::Detach() {
if (!agent_host_.get())
return;
agent_host_->DetachClient(); agent_host_->DetachClient();
AgentHostClosed(agent_host_.get(), false);
agent_host_ = nullptr; agent_host_ = nullptr;
} }
@ -121,14 +122,6 @@ void Debugger::SendCommand(mate::Arguments* args) {
agent_host_->DispatchProtocolMessage(json_args); agent_host_->DispatchProtocolMessage(json_args);
} }
void Debugger::OnDetach(const DetachCallback& callback) {
detach_callback_ = callback;
}
void Debugger::OnEvent(const ResponseCallback& callback) {
response_callback_ = callback;
}
// static // static
mate::Handle<Debugger> Debugger::Create( mate::Handle<Debugger> Debugger::Create(
v8::Isolate* isolate, v8::Isolate* isolate,
@ -142,9 +135,7 @@ void Debugger::BuildPrototype(v8::Isolate* isolate,
mate::ObjectTemplateBuilder(isolate, prototype) mate::ObjectTemplateBuilder(isolate, prototype)
.SetMethod("attach", &Debugger::Attach) .SetMethod("attach", &Debugger::Attach)
.SetMethod("detach", &Debugger::Detach) .SetMethod("detach", &Debugger::Detach)
.SetMethod("sendCommand", &Debugger::SendCommand) .SetMethod("sendCommand", &Debugger::SendCommand);
.SetMethod("onDetach", &Debugger::OnDetach)
.SetMethod("onEvent", &Debugger::OnEvent);
} }
} // namespace api } // namespace api

View file

@ -1,4 +1,4 @@
// Copyright (c) 2015 GitHub, Inc. // Copyright (c) 2016 GitHub, Inc.
// Use of this source code is governed by the MIT license that can be // Use of this source code is governed by the MIT license that can be
// found in the LICENSE file. // found in the LICENSE file.
@ -30,11 +30,8 @@ namespace api {
class Debugger: public mate::TrackableObject<Debugger>, class Debugger: public mate::TrackableObject<Debugger>,
public content::DevToolsAgentHostClient { public content::DevToolsAgentHostClient {
public: public:
using ResponseCallback =
base::Callback<void(const std::string&, const base::DictionaryValue&)>;
using SendCommandCallback = using SendCommandCallback =
base::Callback<void(const base::DictionaryValue&)>; base::Callback<void(const base::DictionaryValue&)>;
using DetachCallback = base::Callback<void(const std::string&)>;
static mate::Handle<Debugger> Create( static mate::Handle<Debugger> Create(
v8::Isolate* isolate, content::WebContents* web_contents); v8::Isolate* isolate, content::WebContents* web_contents);
@ -59,15 +56,10 @@ class Debugger: public mate::TrackableObject<Debugger>,
void Attach(mate::Arguments* args); void Attach(mate::Arguments* args);
void Detach(); void Detach();
void SendCommand(mate::Arguments* args); void SendCommand(mate::Arguments* args);
void OnDetach(const DetachCallback& callback);
void OnEvent(const ResponseCallback& callback);
content::WebContents* web_contents_; // Weak Reference. content::WebContents* web_contents_; // Weak Reference.
scoped_refptr<content::DevToolsAgentHost> agent_host_; scoped_refptr<content::DevToolsAgentHost> agent_host_;
DetachCallback detach_callback_;
ResponseCallback response_callback_;
PendingRequestMap pending_requests_; PendingRequestMap pending_requests_;
int previous_request_id_; int previous_request_id_;

View file

@ -70,6 +70,9 @@ let wrapWebContents = function(webContents) {
var controller, method, name, ref1; var controller, method, name, ref1;
webContents.__proto__ = EventEmitter.prototype; webContents.__proto__ = EventEmitter.prototype;
// webContents.debugger is an EventEmitter.
webContents.debugger.__proto__ = EventEmitter.prototype;
// Every remote callback from renderer process would add a listenter to the // Every remote callback from renderer process would add a listenter to the
// render-view-deleted event, so ignore the listenters warning. // render-view-deleted event, so ignore the listenters warning.
webContents.setMaxListeners(0); webContents.setMaxListeners(0);

View file

@ -836,7 +836,7 @@ when the DevTools has been closed.
### `webContents.debugger` ### `webContents.debugger`
Debugger API serves as an alternate transport for remote debugging protocol. Debugger API serves as an alternate transport for [remote debugging protocol][rdp].
```javascript ```javascript
try { try {
@ -845,11 +845,11 @@ try {
console.log("Debugger attach failed : ", err); console.log("Debugger attach failed : ", err);
}; };
win.webContents.debugger.onDetach(function(reason) { win.webContents.debugger.on('detach', function(event, reason) {
console.log("Debugger detached due to : ", reason); console.log("Debugger detached due to : ", reason);
}); });
win.webContents.debugger.onEvent(function(method, params) { win.webContents.debugger.on('message', function(event, method, params) {
if (method == "Network.requestWillBeSent") { if (method == "Network.requestWillBeSent") {
if (params.request.url == "https://www.github.com") if (params.request.url == "https://www.github.com")
win.webContents.debugger.detach(); win.webContents.debugger.detach();
@ -861,7 +861,7 @@ win.webContents.debugger.sendCommand("Network.enable");
#### `webContents.debugger.attach([protocolVersion])` #### `webContents.debugger.attach([protocolVersion])`
* `protocolVersion` String - Required debugging protocol version. * `protocolVersion` String - Requested debugging protocol version.
Attaches the debugger to the `webContents`. Attaches the debugger to the `webContents`.
@ -880,19 +880,21 @@ Detaches the debugger from the `webContents`.
Send given command to the debugging target. Send given command to the debugging target.
#### `webContents.debugger.onDetach(callback)` #### Event: 'detach'
* `callback` Function * `event` Event
* `reason` String - Reason for detaching debugger. * `reason` String - Reason for detaching debugger.
`callback` is fired when debugging session is terminated. This happens either when Emitted when debugging session is terminated. This happens either when
`webContents` is closed or devtools is invoked for the attached `webContents`. `webContents` is closed or devtools is invoked for the attached `webContents`.
#### `webContents.debugger.onEvent(callback)` #### Event: 'message'
* `callback` Function * `event` Event
* `method` String - Method name. * `method` String - Method name.
* `params` Object - Event parameters defined by the 'parameters' * `params` Object - Event parameters defined by the 'parameters'
attribute in the remote debugging protocol. attribute in the remote debugging protocol.
`callback` is fired whenever debugging target issues instrumentation event. Emitted whenever debugging target issues instrumentation event.
[rdp]: https://developer.chrome.com/devtools/docs/debugger-protocol