Web Inspector: add a DebugUI context menu item for saving inspector protocol traffic...
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Debug / CapturingProtocolTracer.js
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 WebInspector.CapturingProtocolTracer = class CapturingProtocolTracer extends WebInspector.ProtocolTracer
27 {
28     constructor()
29     {
30         super();
31
32         this._trace = new WebInspector.ProtocolTrace;
33     }
34
35     // Public
36
37     get trace()
38     {
39         return this._trace;
40     }
41
42     logFrontendException(message, exception)
43     {
44         this._processEntry({type: "exception", message: this._stringifyMessage(message), exception});
45     }
46
47     logProtocolError(message, error)
48     {
49         this._processEntry({type: "error", message: this._stringifyMessage(message), error});
50     }
51
52     logFrontendRequest(message)
53     {
54         this._processEntry({type: "request", message: this._stringifyMessage(message)});
55     }
56
57     logDidHandleResponse(message, timings = null)
58     {
59         let entry = {type: "response", message: this._stringifyMessage(message)};
60         if (timings)
61             entry.timings = Object.shallowCopy(timings);
62
63         this._processEntry(entry);
64     }
65
66     logDidHandleEvent(message, timings = null)
67     {
68         let entry = {type: "event", message: this._stringifyMessage(message)};
69         if (timings)
70             entry.timings = Object.shallowCopy(timings);
71
72         this._processEntry(entry);
73     }
74
75     _stringifyMessage(message)
76     {
77         try {
78             return JSON.stringify(message);
79         } catch (e) {
80             console.error("couldn't stringify object:", message, e);
81             return {};
82         }
83     }
84
85     _processEntry(entry)
86     {
87         this._trace.addEntry(entry);
88     }
89 };