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

Rich text: try removing store change on focus #48342

Merged
merged 5 commits into from
Feb 23, 2023
Merged

Rich text: try removing store change on focus #48342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ff40e15
Rich text: try removing store change on focus
ellatrix Feb 23, 2023
150f638
Fix failure
ellatrix Feb 23, 2023
5fd5b61
Check for selection change as well for focus metric
ellatrix Feb 23, 2023
9d84fd6
Pull in metric changes
ellatrix Feb 23, 2023
83119aa
Correct rect in Firefox
ellatrix Feb 23, 2023
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
10 changes: 7 additions & 3 deletions packages/block-editor/src/components/rich-text/use-input-rules.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ function findSelection( blocks ) {
blocks[ i ].attributes[ attributeKey ] = blocks[ i ].attributes[
attributeKey
].replace( START_OF_SELECTED_AREA, '' );
return blocks[ i ].clientId;
return [ blocks[ i ].clientId, attributeKey, 0, 0 ];
}

const nestedSelection = findSelection( blocks[ i ].innerBlocks );
Expand All @@ -38,6 +38,8 @@ function findSelection( blocks ) {
return nestedSelection;
}
}

return [];
}

export function useInputRules( props ) {
Expand Down Expand Up @@ -86,9 +88,11 @@ export function useInputRules( props ) {
} );
const block = transformation.transform( content );

selectionChange( findSelection( [ block ] ) );
selectionChange( ...findSelection( [ block ] ) );
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason this fixes the failing test is because we preset selection in the store after replacing the input rule. So when the new block is created, the selection is already correct at the time of the focus event.

onReplace( [ block ] );
__unstableMarkAutomaticChange();

return true;
}

function onInput( event ) {
Expand All @@ -106,7 +110,7 @@ export function useInputRules( props ) {
}

if ( __unstableAllowPrefixTransformations && inputRule ) {
inputRule();
if ( inputRule() ) return;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably not needed for this PR, but still good to return here.

}

const value = getValue();
Expand Down
2 changes: 1 addition & 1 deletion packages/dom/src/dom/get-rectangle-from-range.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export default function getRectangleFromRange( range ) {
// by adding a temporary text node with zero-width space to the range.
//
// See: https://stackoverflow.com/a/6847328/995445
if ( ! rect ) {
if ( ! rect || rect.height === 0 ) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ranges set by Firefox might have 0 height (when it's collapsed on an empty string). This PR probably changes something where we're overriding the range set by Firefox, which is fine.

assertIsDefined( ownerDocument, 'ownerDocument' );
const padNode = ownerDocument.createTextNode( '\u200b' );
// Do not modify the live range.
Expand Down
26 changes: 14 additions & 12 deletions packages/e2e-tests/specs/performance/post-editor.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
getHoverEventDurations,
getSelectionEventDurations,
getLoadingDurations,
sum,
} from './utils';

jest.setTimeout( 1000000 );
Expand Down Expand Up @@ -235,22 +236,26 @@ describe( 'Post Editor Performance', () => {
it( 'Selecting blocks', async () => {
await load1000Paragraphs();
const paragraphs = await canvas().$$( '.wp-block' );
await page.tracing.start( {
path: traceFile,
screenshots: false,
categories: [ 'devtools.timeline' ],
} );
await paragraphs[ 0 ].click();
for ( let j = 1; j <= 10; j++ ) {
// Wait for the browser to be idle before starting the monitoring.
// eslint-disable-next-line no-restricted-syntax
await page.waitForTimeout( 1000 );
await page.tracing.start( {
path: traceFile,
screenshots: false,
categories: [ 'devtools.timeline' ],
} );
await paragraphs[ j ].click();
await page.tracing.stop();
traceResults = JSON.parse( readFile( traceFile ) );
const allDurations = getSelectionEventDurations( traceResults );
results.focus.push(
allDurations.reduce( ( acc, eventDurations ) => {
return acc + sum( eventDurations );
}, 0 )
Comment on lines +254 to +256
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This smells like it should be

sum( allDurations.map( sum ) )

No?

);
}
await page.tracing.stop();
traceResults = JSON.parse( readFile( traceFile ) );
const [ focusEvents ] = getSelectionEventDurations( traceResults );
results.focus = focusEvents;
} );

it( 'Opening persistent list view', async () => {
Expand Down Expand Up @@ -292,9 +297,6 @@ describe( 'Post Editor Performance', () => {
} );

it( 'Searching the inserter', async () => {
function sum( arr ) {
return arr.reduce( ( a, b ) => a + b, 0 );
}
await load1000Paragraphs();
await openGlobalBlockInserter();
for ( let j = 0; j < 10; j++ ) {
Expand Down
13 changes: 12 additions & 1 deletion packages/e2e-tests/specs/performance/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ function isFocusEvent( item ) {
return isEvent( item ) && item.args.data.type === 'focus';
}

function isFocusInEvent( item ) {
return isEvent( item ) && item.args.data.type === 'focusin';
}

function isClickEvent( item ) {
return isEvent( item ) && item.args.data.type === 'click';
}
Expand Down Expand Up @@ -68,7 +72,10 @@ export function getTypingEventDurations( trace ) {
}

export function getSelectionEventDurations( trace ) {
return [ getEventDurationsForType( trace, isFocusEvent ) ];
return [
getEventDurationsForType( trace, isFocusEvent ),
getEventDurationsForType( trace, isFocusInEvent ),
];
}

export function getClickEventDurations( trace ) {
Expand Down Expand Up @@ -113,3 +120,7 @@ export async function getLoadingDurations() {
};
} );
}

export function sum( arr ) {
return arr.reduce( ( a, b ) => a + b, 0 );
}
1 change: 0 additions & 1 deletion packages/rich-text/src/component/use-input-and-selection.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,6 @@ export function useInputAndSelection( props ) {
end: index,
activeFormats: EMPTY_ACTIVE_FORMATS,
};
onSelectionChange( index, index );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this should be a small (maybe not noticeable) perf improvement, right?

Copy link
Member Author

@ellatrix ellatrix Feb 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a huge improvement for focus:

┌──────────────────────┬──────────────────────────────────────────┬──────────────┐
│       (index)        │ fec7ea5acdf2c45e0ecbab96200aa945eb8daed5 │    trunk     │
├──────────────────────┼──────────────────────────────────────────┼──────────────┤
│        focus         │                '0.27 ms'                 │  '32.6 ms'   │
│       minFocus       │                '0.24 ms'                 │  '0.41 ms'   │
│       maxFocus       │                '0.36 ms'                 │  '48.82 ms'  │

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should update the metric though. It feels now that we should be computing "focus + selection change". It seems the time has moved to another event that we don't take into consideration in the metric itself?

} else {
applyRecord( record.current );
onSelectionChange( record.current.start, record.current.end );
Expand Down