Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(trace viewer): Extending existing NetworkTab view (#5009)
feat(trace viewer): Extending existing NetworkTab view Currently the network tab contains a limited amount of information on the resources that were loaded in the browser. This change proposes extending the details displayed for each resource, to include: - HTTP method, - Full url, - Easily visible response content type, - Request headers, - Request & response bodies. Such level of information could help quickly understand what happened in the application, when it was communicating with backend services. This can help debug tests quicker to figure out why they are failing. This implementation still needs some clean up & tests improvement, but I wanted to propose such changes and gather your feedback before going too far.
- Loading branch information
Showing
14 changed files
with
349 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /* | ||
| Copyright (c) Microsoft Corporation. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| .network-request { | ||
| box-shadow: var(--box-shadow); | ||
| white-space: nowrap; | ||
| display: flex; | ||
| align-items: center; | ||
| padding: 0 10px; | ||
| margin-bottom: 10px; | ||
| background: #fdfcfc; | ||
| width: 100%; | ||
| border: 3px solid transparent; | ||
| flex: none; | ||
| outline: none; | ||
| } | ||
|
|
||
| .network-request.selected, | ||
| .network-request:hover { | ||
| border-color: var(--inactive-focus-ring); | ||
| } | ||
|
|
||
| .network-request.selected:focus { | ||
| border-color: var(--orange); | ||
| } | ||
|
|
||
| .network-request-title { | ||
| height: 36px; | ||
| display: flex; | ||
| align-items: center; | ||
| flex: 1; | ||
| } | ||
|
|
||
| .network-request-title-status { | ||
| font-weight: bold; | ||
| height: 100%; | ||
| display: flex; | ||
| align-items: center; | ||
| padding: 0px 5px; | ||
| margin-right: 5px; | ||
| } | ||
|
|
||
| .network-request-title-status.status-success { | ||
| background-color: var(--green); | ||
| } | ||
|
|
||
| .network-request-title-status.status-failure { | ||
| background-color: var(--red); | ||
| color: var(--white); | ||
| } | ||
|
|
||
| .network-request-title-status.status-neutral { | ||
| background-color: var(--white); | ||
| } | ||
|
|
||
| .network-request-title-method { | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| .network-request-title-url { | ||
| overflow: hidden; | ||
| text-overflow: ellipsis; | ||
| flex: 1; | ||
| } | ||
|
|
||
| .network-request-title-content-type { | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| .network-request-details { | ||
| font-family: var(--monospace-font); | ||
| width: 100%; | ||
| } | ||
|
|
||
| .network-request-details-url { | ||
| white-space: normal; | ||
| word-wrap: break-word; | ||
| } | ||
|
|
||
| .network-request-headers { | ||
| white-space: pre; | ||
| overflow: hidden; | ||
| } | ||
|
|
||
| .network-request-body { | ||
| white-space: pre; | ||
| overflow: scroll; | ||
| background-color: var(--network-content-bg); | ||
| border: black 1px solid; | ||
| max-height: 500px; | ||
| } | ||
|
|
||
| .network-request-response-body { | ||
| white-space: pre; | ||
| overflow: scroll; | ||
| background-color: var(--network-content-bg); | ||
| border: black 1px solid; | ||
| max-height: 500px; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| /** | ||
| * Copyright (c) Microsoft Corporation. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import './networkResourceDetails.css'; | ||
| import * as React from 'react'; | ||
| import { Expandable } from './helpers'; | ||
| import { NetworkResourceTraceEvent } from '../../../../trace/traceTypes'; | ||
|
|
||
|
|
||
| export const NetworkResourceDetails: React.FunctionComponent<{ | ||
| resource: NetworkResourceTraceEvent, | ||
| index: number, | ||
| selected: boolean, | ||
| setSelected: React.Dispatch<React.SetStateAction<number>>, | ||
| }> = ({ resource, index, selected, setSelected }) => { | ||
| const [expanded, setExpanded] = React.useState(false); | ||
| const [requestBody, setRequestBody] = React.useState<string | null>(null); | ||
| const [responseBody, setResponseBody] = React.useState<string | null>(null); | ||
|
|
||
| React.useEffect(() => { | ||
| setExpanded(false); | ||
| setSelected(-1); | ||
| }, [resource, setSelected]); | ||
|
|
||
| React.useEffect(() => { | ||
| const readResources = async () => { | ||
| if (resource.requestSha1 !== 'none') { | ||
| const requestResource = await window.readResource(resource.requestSha1); | ||
| setRequestBody(requestResource); | ||
| } | ||
|
|
||
| if (resource.responseSha1 !== 'none') { | ||
| const responseResource = await window.readResource(resource.responseSha1); | ||
| setResponseBody(responseResource); | ||
| } | ||
| }; | ||
|
|
||
| readResources(); | ||
| }, [expanded, resource.responseSha1, resource.requestSha1]); | ||
|
|
||
| function formatBody(body: string | null, contentType: string): string { | ||
| if (body === null) | ||
| return 'Loading...'; | ||
|
|
||
| const bodyStr = atob(body); | ||
|
|
||
| if (bodyStr === '') | ||
| return '<Empty>'; | ||
|
|
||
| if (contentType.includes('application/json')) { | ||
| try { | ||
| return JSON.stringify(JSON.parse(bodyStr), null, 2); | ||
| } catch (err) { | ||
| return bodyStr; | ||
| } | ||
| } | ||
|
|
||
| if (contentType.includes('application/x-www-form-urlencoded')) | ||
| return decodeURIComponent(bodyStr); | ||
|
|
||
| return bodyStr; | ||
| } | ||
|
|
||
| function formatStatus(status: number): string { | ||
| if (status >= 200 && status < 400) | ||
| return 'status-success'; | ||
|
|
||
| if (status >= 400) | ||
| return 'status-failure'; | ||
|
|
||
| return 'status-neutral'; | ||
| } | ||
|
|
||
| const requestContentTypeHeader = resource.requestHeaders.find(q => q.name === 'Content-Type'); | ||
| const requestContentType = requestContentTypeHeader ? requestContentTypeHeader.value : ''; | ||
|
|
||
| return <div | ||
| className={'network-request ' + (selected ? 'selected' : '')} onClick={() => setSelected(index)}> | ||
| <Expandable expanded={expanded} setExpanded={setExpanded} style={{ width: '100%' }} title={ | ||
| <div className='network-request-title'> | ||
| <div className={'network-request-title-status ' + formatStatus(resource.status)}>{resource.status}</div> | ||
| <div className='network-request-title-method'>{resource.method}: </div> | ||
| <div className='network-request-title-url'>{resource.url}</div> | ||
| <div className='network-request-title-content-type'>{resource.contentType}</div> | ||
| </div> | ||
| } body={ | ||
| <div className='network-request-details'> | ||
| <h4>URL</h4> | ||
| <div className='network-request-details-url'>{resource.url}</div> | ||
| <h4>Request Headers</h4> | ||
| <div className='network-request-headers'>{resource.requestHeaders.map(pair => `${pair.name}: ${pair.value}`).join('\n')}</div> | ||
| <h4>Response Headers</h4> | ||
| <div className='network-request-headers'>{resource.responseHeaders.map(pair => `${pair.name}: ${pair.value}`).join('\n')}</div> | ||
| {resource.requestSha1 !== 'none' ? <h4>Request Body</h4> : ''} | ||
| {resource.requestSha1 !== 'none' ? <div className='network-request-body'>{formatBody(requestBody, requestContentType)}</div> : ''} | ||
| <h4>Response Body</h4> | ||
| {resource.responseSha1 === 'none' ? <div className='network-request-response-body'>Response body is not available for this request.</div> : ''} | ||
| {responseBody !== null && resource.contentType.includes('image') ? <img src={`data:${resource.contentType};base64,${responseBody}`} /> : ''} | ||
| {responseBody !== null && !resource.contentType.includes('image') ? <div className='network-request-response-body'>{formatBody(responseBody, resource.contentType)}</div> : ''} | ||
| </div> | ||
| }/> | ||
| </div>; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.