6b7b1fab5c
Summary: Changelog: [Network] Non-binary request are not properly utf-8 decoded on both iOS and Android, both when gzipped and when not gzipped This diff fixes a long standing / ping-pong issue regarding network decoding differences between * iOS vs Android * binary vs utf-8 * gzipped vs uncompressed The changes aren't too big, but the underlying investigating is :) The primary contribution to this diff is: First, adding test cases for know problematic cases. This is done by grabbing the messages that are send from the flipper client to flipper using the flipper messages plugin. This is the base64 data that is stored in the `.txt` files. Beyond that, for all tests public endpoints are used, so that we can both get a hold of the raw original files, and how we expect them to be displayed in flipper. For testing a simple RN app was build, with a button that fires a bunch requests. The first 3 are captured in unit tests, the last one is not idempotent, but a case reported in #1466, so just left it there as manual verification. ``` const fetchData = async () => { await fetch( 'https://raw.githubusercontent.com/SangKa/MobX-Docs-CN/master/docs/donating.md', { headers: { 'Accept-Encoding': 'identity', // signals that we don't want gzip }, }, ); await fetch('https://reactnative.dev/img/tiny_logo.png?x=' + Math.random()); await fetch( 'https://raw.githubusercontent.com/SangKa/MobX-Docs-CN/master/docs/donating.md', ); await fetch( 'https://ex.ke.com/sdk/recommend/html/100001314?hdicCityId=110000¶mMap[source]=&id=100001314&mediumId=100000037&elementId=&resblockId=1111027381003&templateConfig=%5Bobject%20Object%5D&fbExpoId=346620976471638017&fbQueryId=&required400=true&unique=1111027381003&parentSceneId=', ); }; ``` The second contribution of this diff is that it doesn't use weird URLencoder hacks to convert base64 to utf8, but rather a proper library. The problem with our original solution, using `atob` is that it converts to ASCII, not to utf-8, which is the source of the original bugs. See for more background on this: https://www.npmjs.com/package/js-base64#decode-vs-atob-and-encode-vs-btoa- Solves: https://github.com/facebook/flipper/issues/1466 https://github.com/facebook/flipper/pull/1541 https://github.com/facebook/flipper/issues/1458 Supersedes D23837750 Future work: we don't inspect the `content-type=xxx;charset` header yet, which we should do for less common encodings, to make sure that they get displayed correctly as well Future work: in feature like copy data and curl, we always call decode body, without check if we are actually dealing with non-binary data. Probably it is better to keep binary data in base64, rather than decoding it, as that will assume the data is an utf-8 string, which might fail. An assumption in these changes is that binary data is never gzipped, which is generally correct; gzip is not applied by webserver to things like images, as it would increase, not decrease their size, and waste a lot of computation power. Reviewed By: cekkaewnumchai Differential Revision: D23403095 fbshipit-source-id: 5099cc4a7503f0f63bd10585dc6590ba893f3dde
102 lines
3.2 KiB
TypeScript
102 lines
3.2 KiB
TypeScript
/**
|
|
* 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 {readFile} from 'fs';
|
|
import path from 'path';
|
|
import {decodeBody} from '../utils';
|
|
import {Response} from '../types';
|
|
import {promisify} from 'util';
|
|
import {readFileSync} from 'fs';
|
|
|
|
async function createMockResponse(input: string): Promise<Response> {
|
|
const inputData = await promisify(readFile)(
|
|
path.join(__dirname, 'fixtures', input),
|
|
'ascii',
|
|
);
|
|
const gzip = input.includes('gzip'); // if gzip in filename, assume it is a gzipped body
|
|
const testResponse: Response = {
|
|
id: '0',
|
|
timestamp: 0,
|
|
status: 200,
|
|
reason: 'dunno',
|
|
headers: gzip
|
|
? [
|
|
{
|
|
key: 'Content-Encoding',
|
|
value: 'gzip',
|
|
},
|
|
]
|
|
: [],
|
|
data: inputData.replace(/\s+?/g, '').trim(), // remove whitespace caused by copy past of the base64 data,
|
|
isMock: false,
|
|
insights: undefined,
|
|
totalChunks: 1,
|
|
index: 0,
|
|
};
|
|
return testResponse;
|
|
}
|
|
|
|
describe('network data encoding', () => {
|
|
const donatingExpected = readFileSync(
|
|
path.join(__dirname, 'fixtures', 'donating.md'),
|
|
'utf-8',
|
|
).trim();
|
|
const tinyLogoExpected = readFileSync(
|
|
path.join(__dirname, 'fixtures', 'tiny_logo.png'),
|
|
);
|
|
const tinyLogoBase64Expected = readFileSync(
|
|
path.join(__dirname, 'fixtures', 'tiny_logo.base64.txt'),
|
|
'utf-8',
|
|
);
|
|
|
|
test('donating.md.utf8.ios.txt', async () => {
|
|
const response = await createMockResponse('donating.md.utf8.ios.txt');
|
|
expect(decodeBody(response).trim()).toEqual(donatingExpected);
|
|
});
|
|
|
|
test('donating.md.utf8.gzip.ios.txt', async () => {
|
|
const response = await createMockResponse('donating.md.utf8.gzip.ios.txt');
|
|
expect(decodeBody(response).trim()).toEqual(donatingExpected);
|
|
});
|
|
|
|
test('donating.md.utf8.android.txt', async () => {
|
|
const response = await createMockResponse('donating.md.utf8.android.txt');
|
|
expect(decodeBody(response).trim()).toEqual(donatingExpected);
|
|
});
|
|
|
|
test('donating.md.utf8.gzip.android.txt', async () => {
|
|
const response = await createMockResponse(
|
|
'donating.md.utf8.gzip.android.txt',
|
|
);
|
|
expect(decodeBody(response).trim()).toEqual(donatingExpected);
|
|
});
|
|
|
|
test('tiny_logo.android.txt', async () => {
|
|
const response = await createMockResponse('tiny_logo.android.txt');
|
|
expect(response.data).toEqual(tinyLogoExpected.toString('base64'));
|
|
});
|
|
|
|
test('tiny_logo.android.txt - encoded', async () => {
|
|
const response = await createMockResponse('tiny_logo.android.txt');
|
|
// this compares to the correct base64 encoded src tag of the img in Flipper UI
|
|
expect(response.data).toEqual(tinyLogoBase64Expected.trim());
|
|
});
|
|
|
|
test('tiny_logo.ios.txt', async () => {
|
|
const response = await createMockResponse('tiny_logo.ios.txt');
|
|
expect(response.data).toEqual(tinyLogoExpected.toString('base64'));
|
|
});
|
|
|
|
test('tiny_logo.ios.txt - encoded', async () => {
|
|
const response = await createMockResponse('tiny_logo.ios.txt');
|
|
// this compares to the correct base64 encoded src tag of the img in Flipper UI
|
|
expect(response.data).toEqual(tinyLogoBase64Expected.trim());
|
|
});
|
|
});
|