diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /devtools/client/netmonitor/doc | |
parent | Initial commit. (diff) | |
download | firefox-upstream.tar.xz firefox-upstream.zip |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devtools/client/netmonitor/doc')
-rw-r--r-- | devtools/client/netmonitor/doc/architecture.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/devtools/client/netmonitor/doc/architecture.md b/devtools/client/netmonitor/doc/architecture.md new file mode 100644 index 0000000000..1d3a65c2a1 --- /dev/null +++ b/devtools/client/netmonitor/doc/architecture.md @@ -0,0 +1,42 @@ +# Network Monitor + +The Network Monitor (netmonitor) shows you all the network requests Firefox makes (for example, when a page is loaded or when an XMLHttpRequest is performed) , how long each request takes, and details of each request. You can edit the method, query, header and resend the request as well. Read [MDN](https://developer.mozilla.org/en-US/docs/Tools/Network_Monitor) to learn all the features and how to use the tool. + +## Prerequisite + +If you want to build the Network Monitor inside of the DevTools toolbox (Firefox Devtools Panels), follow the [simple Firefox build](https://developer.mozilla.org/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_build) document in MDN. Start your compiled firefox and open the Firefox developer tool, you can see the Network Monitor inside. + +### Run inside of the DevTools toolbox + +Files used to run the Network Monitor inside of the DevTools toolbox. + +* `panel.js` called by devtools toolbox to launch the Network Monitor panel. +* `index.html` panel UI and launch scripts. +* `src/connector/` wrap function call for Browser specific API. Current support Firefox and Chrome(experimental). + +### UI + +The Network Monitor UI is built using [React](http://searchfox.org/mozilla-central/source/devtools/docs/frontend/react.md) components (in `src/components/`). + +* **MonitorPanel** in `MonitorPanel.js` is the root element. +* Three major container components are + - **Toolbar** Panel related functions. + - **RequestList** Show each request information. + - **NetworkDetailsBar** Show detailed information per request. + - **StatusBar** Show statistics while loading. +* `src/assets` Styles that affect the Network Monitor panel. + +We prefer stateless component (define by function) instead of stateful component (define by class) unless the component has to maintain its internal state. + +### State + +![](https://hacks.mozilla.org/files/2017/06/image8.png) + +Besides the UI, the Network Monitor manages the app state via [Redux](http://searchfox.org/mozilla-central/source/devtools/docs/frontend/redux.md). The following locations define the app state: + +* `src/constants.js` constants used across the tool including action and event names. +* `src/actions/` for all actions that change the state. +* `src/reducers/` for all reducers that change the state. +* `src/selectors/` functions that return a formatted version of parts of the app state. + +We use [reselect](https://github.com/reactjs/reselect) library to perform state calculations efficiently. |