Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix transposed escape functions #25534

Merged
merged 4 commits into from
Oct 22, 2022
Merged

fix transposed escape functions #25534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3acba95
fix transposed escape functions
gnoff Oct 22, 2022
796bfd7
add flow to escapeTextForBrowser to prevent future issues
gnoff Oct 22, 2022
3ba6560
make Chunk types opaque where possible
gnoff Oct 22, 2022
e47291d
add regression for title escaping in browser runtime
gnoff Oct 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/react-dom-bindings/src/server/ReactDOMLegacyServerStreamConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ export interface Destination {
destroy(error: Error): mixed;
}

export type PrecomputedChunk = string;
export type Chunk = string;
export opaque type PrecomputedChunk = string;
export opaque type Chunk = string;

export function scheduleWork(callback: () => void) {
callback();
Expand Down
6 changes: 3 additions & 3 deletions packages/react-dom-bindings/src/server/ReactDOMServerFormatConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2385,7 +2385,7 @@ export function writeInitialResources(
} else {
target.push(
precedencePlaceholderStart,
escapeTextForBrowser(stringToChunk(precedence)),
stringToChunk(escapeTextForBrowser(precedence)),
precedencePlaceholderEnd,
);
}
Expand Down Expand Up @@ -2417,7 +2417,7 @@ export function writeInitialResources(
case 'title': {
pushStartTitleImpl(target, r.props, responseState);
if (typeof r.props.children === 'string') {
target.push(escapeTextForBrowser(stringToChunk(r.props.children)));
target.push(stringToChunk(escapeTextForBrowser(r.props.children)));
}
pushEndInstance(target, target, 'title', r.props);
break;
Expand Down Expand Up @@ -2518,7 +2518,7 @@ export function writeImmediateResources(
case 'title': {
pushStartTitleImpl(target, r.props, responseState);
if (typeof r.props.children === 'string') {
target.push(escapeTextForBrowser(stringToChunk(r.props.children)));
target.push(stringToChunk(escapeTextForBrowser(r.props.children)));
}
pushEndInstance(target, target, 'title', r.props);
break;
Expand Down
6 changes: 4 additions & 2 deletions packages/react-dom-bindings/src/server/escapeTextForBrowser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* @flow
*/

// code copied and modified from escape-html
Expand Down Expand Up @@ -103,12 +105,12 @@ function escapeHtml(string) {
* @param {*} text Text value to escape.
* @return {string} An escaped string.
*/
function escapeTextForBrowser(text) {
function escapeTextForBrowser(text: string | number | boolean): string {
if (typeof text === 'boolean' || typeof text === 'number') {
// this shortcircuit helps perf for types that we know will never have
// special characters, especially given that this function is used often
// for numeric dom ids.
return '' + text;
return '' + (text: any);
}
return escapeHtml(text);
}
Expand Down
18 changes: 18 additions & 0 deletions packages/react-dom/src/__tests__/ReactDOMFizzServerBrowser-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,4 +484,22 @@ describe('ReactDOMFizzServerBrowser', () => {

expect(errors).toEqual(['uh oh', 'uh oh']);
});

// https://github.com/facebook/react/pull/25534/files - fix transposed escape functions
// @gate enableFloat
it('should encode title properly', async () => {
const stream = await ReactDOMFizzServer.renderToReadableStream(
<html>
<head>
<title>foo</title>
</head>
<body>bar</body>
</html>,
);

const result = await readResult(stream);
expect(result).toEqual(
'<!DOCTYPE html><html><head><title>foo</title></title></head><body>bar</body></html>',
);
});
});
4 changes: 2 additions & 2 deletions packages/react-server-dom-relay/src/ReactServerStreamConfigFB.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ export type Destination = {
error: mixed,
};

export type PrecomputedChunk = string;
export type Chunk = string;
export opaque type PrecomputedChunk = string;
export opaque type Chunk = string;

export function scheduleWork(callback: () => void) {
// We don't schedule work in this model, and instead expect performWork to always be called repeatedly.
Expand Down
2 changes: 1 addition & 1 deletion packages/react-server/src/ReactServerStreamConfigBrowser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
export type Destination = ReadableStreamController;

export type PrecomputedChunk = Uint8Array;
export type Chunk = Uint8Array;
export opaque type Chunk = Uint8Array;

export function scheduleWork(callback: () => void) {
callback();
Expand Down
2 changes: 1 addition & 1 deletion packages/react-server/src/ReactServerStreamConfigNode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface MightBeFlushable {
export type Destination = Writable & MightBeFlushable;

export type PrecomputedChunk = Uint8Array;
export type Chunk = string;
export opaque type Chunk = string;

export function scheduleWork(callback: () => void) {
setImmediate(callback);
Expand Down