/** * Copyright (c) Facebook, Inc. and its affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. * * @format */ import pako from 'pako'; import {Request, Header, ResponseInfo} from './types'; import {Base64} from 'js-base64'; export function getHeaderValue( headers: Array
| undefined, key: string, ): string { if (!headers) { return ''; } for (const header of headers) { if (header.key.toLowerCase() === key.toLowerCase()) { return header.value; } } return ''; } // Matches `application/json` and `application/vnd.api.v42+json` (see https://jsonapi.org/#mime-types) const jsonContentTypeRegex = new RegExp('application/(json|.+\\+json)'); export function isTextual(headers?: Array
): boolean { const contentType = getHeaderValue(headers, 'Content-Type'); if (!contentType) { return false; } // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types return ( contentType.startsWith('text/') || contentType.startsWith('application/x-www-form-urlencoded') || jsonContentTypeRegex.test(contentType) || contentType.startsWith('multipart/') || contentType.startsWith('message/') || contentType.startsWith('image/svg') || contentType.startsWith('application/xhtml+xml') ); } export function decodeBody( headers?: Array
, data?: string | null, ): string | undefined | Uint8Array { if (!data) { return undefined; } try { const isGzip = getHeaderValue(headers, 'Content-Encoding') === 'gzip'; if (isGzip) { try { // The request is gzipped, so convert the raw bytes back to base64 first. const dataArr = Base64.toUint8Array(data); // then inflate. return isTextual(headers) ? // pako will detect the BOM headers and return a proper utf-8 string right away pako.inflate(dataArr, {to: 'string'}) : pako.inflate(dataArr); } catch (e) { // on iOS, the stream send to flipper is already inflated, so the content-encoding will not // match the actual data anymore, and we should skip inflating. // In that case, we intentionally fall-through if (!('' + e).includes('incorrect header check')) { throw e; } } } // If this is not a gzipped request, assume we are interested in a proper utf-8 string. // - If the raw binary data in is needed, in base64 form, use data directly // - either directly use data (for example) if (isTextual(headers)) { return Base64.decode(data); } else { return Base64.toUint8Array(data); } } catch (e) { console.warn( `Flipper failed to decode request/response body (size: ${data.length}): ${e}`, ); return undefined; } } export function convertRequestToCurlCommand( request: Pick, ): string { let command: string = `curl -v -X ${request.method}`; command += ` ${escapedString(request.url)}`; // Add headers request.requestHeaders.forEach((header: Header) => { const headerStr = `${header.key}: ${header.value}`; command += ` -H ${escapedString(headerStr)}`; }); if (typeof request.requestData === 'string') { command += ` -d ${escapedString(request.requestData)}`; } return command; } export function bodyAsString(body: undefined | string | Uint8Array): string { if (body == undefined) { return '(empty)'; } if (body instanceof Uint8Array) { return '(binary data)'; } return body; } export function bodyAsBinary( body: undefined | string | Uint8Array, ): Uint8Array | undefined { if (body instanceof Uint8Array) { return body; } return undefined; } function escapeCharacter(x: string) { const code = x.charCodeAt(0); return code < 16 ? '\\u0' + code.toString(16) : '\\u' + code.toString(16); } const needsEscapingRegex = /[\u0000-\u001f\u007f-\u009f!]/g; // Escape util function, inspired by Google DevTools. Works only for POSIX // based systems. function escapedString(str: string) { if (needsEscapingRegex.test(str) || str.includes("'")) { return ( "$'" + str .replace(/\\/g, '\\\\') .replace(/\'/g, "\\'") .replace(/\n/g, '\\n') .replace(/\r/g, '\\r') .replace(needsEscapingRegex, escapeCharacter) + "'" ); } // Simply use singly quoted string. return "'" + str + "'"; } export function getResponseLength(request: ResponseInfo): number { const lengthString = request.headers ? getHeaderValue(request.headers, 'content-length') : undefined; if (lengthString) { return parseInt(lengthString, 10); } else if (request.data) { return Buffer.byteLength(request.data, 'base64'); } return 0; } export function formatDuration(duration: number | undefined) { if (typeof duration === 'number') return duration + 'ms'; return ''; } export function formatBytes(count: number | undefined): string { if (typeof count !== 'number') { return ''; } if (count > 1024 * 1024) { return (count / (1024.0 * 1024)).toFixed(1) + ' MB'; } if (count > 1024) { return (count / 1024.0).toFixed(1) + ' kB'; } return count + ' B'; } export function formatStatus(status: number | undefined) { return status ? '' + status : ''; } export function requestsToText(requests: Request[]): string { const request = requests[0]; if (!request || !request.url) { return ''; } let copyText = `# HTTP request for ${request.domain} (ID: ${request.id}) ## Request HTTP ${request.method} ${request.url} ${request.requestHeaders .map( ({key, value}: {key: string; value: string}): string => `${key}: ${String(value)}`, ) .join('\n')}`; // TODO: we want decoding only for non-binary data! See D23403095 if (request.requestData) { copyText += `\n\n${request.requestData}`; } if (request.status) { copyText += ` ## Response HTTP ${request.status} ${request.reason} ${ request.responseHeaders ?.map( ({key, value}: {key: string; value: string}): string => `${key}: ${String(value)}`, ) .join('\n') ?? '' }`; } if (request.responseData) { copyText += `\n\n${request.responseData}`; } return copyText; }