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.

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

perf[react-native]: Memoized Blocks Component to free up UI thread. #3814

Merged
merged 7 commits into from
Jan 24, 2025
Merged
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/early-pillows-jog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@builder.io/sdk-react-native": patch
---

- Enchanced performance: Implemented memoization for the Blocks components
- Flatlist usage: Configured Flatlist for smoother rendering of block components
These changes aims to improve UI responsiveness and reduce rendering overhead
2 changes: 2 additions & 0 deletions .changeset/nice-llamas-kneel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
99 changes: 65 additions & 34 deletions examples/nextjs-app-dir-v2/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/nextjs-app-dir-v2/package.json
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@
"lint": "next lint"
},
"dependencies": {
"@builder.io/sdk-react": "^1.0.23",
"@builder.io/sdk-react": "^3.0.1",
samijaber marked this conversation as resolved.
Show resolved Hide resolved
"next": "14.1.1",
"react": "^18",
"react-dom": "^18"
15 changes: 15 additions & 0 deletions examples/nextjs-app-dir-v2/src/app/components/MyFunComponent.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
'use client';
import { useState } from 'react';

export const MyFunComponent = (props: { text: string }) => {
const [count, setCount] = useState(0);
return (
<div>
<h3>{props.text.toUpperCase()}</h3>
<p>{count}</p>
<button onClick={() => setCount(prev => prev + 1) }>Click me</button>
</div>
);
};

export default MyFunComponent;
18 changes: 18 additions & 0 deletions examples/nextjs-app-dir-v2/src/app/components/register.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

'use client';
import dynamic from 'next/dynamic';
import { type RegisteredComponent } from "@builder.io/sdk-react";

export const customComponents: RegisteredComponent[] = [
{
component: dynamic(() => import('./MyFunComponent')),
name: 'MyFunComponent',
inputs: [
{
name: 'text',
type: 'string',
defaultValue: 'Hello world',
},
],
},
];
4 changes: 2 additions & 2 deletions packages/sdks-tests/src/e2e-tests/styles.spec.ts
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ test.describe('Styles', () => {

const FIRST_BLOCK_SELECTOR = checkIsRN(sdk)
? // ScrollView adds an extra div wrapper
`${getClassSelector('builder-blocks', sdk)} > div > div`
`${getClassSelector('builder-blocks', sdk)} > div > div > div > div > div`
: sdk === 'angular'
? `div[builder-id="builder-1098ca09970149b3bc4cd43643bd0545"]`
: `${getClassSelector('builder-blocks', sdk)} > div`;
@@ -60,7 +60,7 @@ test.describe('Styles', () => {
};

// RN SDK does not use ScrollView in Symbol
const FIRST_BLOCK_SYMBOL_SELECTOR = `${getClassSelector('builder-blocks', sdk)} > div`;
const FIRST_BLOCK_SYMBOL_SELECTOR = checkIsRN(sdk) ? `${getClassSelector('builder-blocks', sdk)} > div > div > div` : `${getClassSelector('builder-blocks', sdk)} > div`;

const locator = page
.locator(FIRST_BLOCK_SYMBOL_SELECTOR)
83 changes: 83 additions & 0 deletions packages/sdks/mitosis.config.cjs
Original file line number Diff line number Diff line change
@@ -163,6 +163,88 @@ const ADD_IS_STRICT_STYLE_MODE_TO_CONTEXT_PLUGIN = () => ({
},
});

const MEMOIZING_BLOCKS_COMPONENT_PLUGIN = () => ({
json: {
post: (json) => {
if (json.name === 'Block') {
json.imports.push({
imports: { memo: 'memo' },
path: 'react',
});
}
if (json.name === 'Blocks') {
json.imports.push({
imports: { memo: 'memo' },
path: 'react',
});

json.hooks.init = {
code: `
${json.hooks.init?.code || ''}
const renderItem = React.useCallback(({ item }: { item: any }) => (
<Block
block={item}
linkComponent={props.linkComponent}
context={props.context || builderContext}
registeredComponents={
props.registeredComponents || componentsContext?.registeredComponents
}
/>
), [
props.linkComponent,
props.context,
props.registeredComponents,
builderContext,
componentsContext?.registeredComponents
]);
// Memoize keyExtractor
const keyExtractor = React.useCallback((item: any) =>
item.id.toString()
, []);
`,
};

json.children[0].children[0].children[0] = {
'@type': '@builder.io/mitosis/node',
name: 'FlatList',
meta: {},
scope: {},
properties: {},
bindings: {
data: { code: 'props.blocks', type: 'single' },
renderItem: { code: 'renderItem', type: 'single' },
keyExtractor: { code: 'keyExtractor', type: 'single' },
removeClippedSubviews: { code: 'true', type: 'single' },
maxToRenderPerBatch: { code: '10', type: 'single' },
windowSize: { code: '5', type: 'single' },
initialNumToRender: { code: '5', type: 'single' },
},
children: [],
};
}
return json;
},
},
code: {
post: (code, json) => {
if (json.name === 'Blocks') {
return code.replace(
'export default Blocks',
'export default memo(Blocks)'
);
}
if (json.name === 'Block') {
return code.replace(
'export default Block',
'export default memo(Block)'
);
}
return code;
},
},
});

const INJECT_ENABLE_EDITOR_ON_EVENT_HOOKS_PLUGIN = () => ({
json: {
pre: (json) => {
@@ -892,6 +974,7 @@ module.exports = {
INJECT_ENABLE_EDITOR_ON_EVENT_HOOKS_PLUGIN,
REMOVE_SET_CONTEXT_PLUGIN_FOR_FORM,
ADD_IS_STRICT_STYLE_MODE_TO_CONTEXT_PLUGIN,
MEMOIZING_BLOCKS_COMPONENT_PLUGIN,
() => ({
json: {
pre: (json) => {
2 changes: 1 addition & 1 deletion packages/sdks/output/react-native/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@builder.io/sdk-react-native",
"description": "Builder.io SDK for React Native",
"version": "3.0.3",
"version": "3.0.1-1",
"homepage": "https://github.com/BuilderIO/builder/tree/main/packages/sdks/output/react-native",
"repository": {
"type": "git",

Unchanged files with check annotations Beta

import { expect } from '@playwright/test';

Check failure on line 1 in packages/sdks-tests/src/snippet-tests/api-endpoint.spec.ts

GitHub Actions / Gen 1 SDK Snippets (gen1-next14-pages)

[gen1-next14-pages] › api-endpoint.spec.ts:12:5 › API Endpoint › Live › records API calls after page load

1) [gen1-next14-pages] › api-endpoint.spec.ts:12:5 › API Endpoint › Live › records API calls after page load Test timeout of 30000ms exceeded.
import { findTextInPage, test } from '../helpers/index.js';
test.describe('API Endpoint', () => {
let queryApiInvocations = 0;
const responsePromise = page.waitForResponse(urlMatchForContentAPI);

Check failure on line 20 in packages/sdks-tests/src/snippet-tests/api-endpoint.spec.ts

GitHub Actions / Gen 1 SDK Snippets (gen1-next14-pages)

[gen1-next14-pages] › api-endpoint.spec.ts:12:5 › API Endpoint › Live › records API calls after page load

1) [gen1-next14-pages] › api-endpoint.spec.ts:12:5 › API Endpoint › Live › records API calls after page load Error: page.waitForResponse: Test timeout of 30000ms exceeded. =========================== logs =========================== waiting for response /https:\/\/cdn\.builder\.io\/api\/v3\/content/ ============================================================ 18 | let queryApiInvocations = 0; 19 | > 20 | const responsePromise = page.waitForResponse(urlMatchForContentAPI); | ^ 21 | 22 | await page.route(urlMatchForQueryAPI, route => { 23 | queryApiInvocations++; at /home/runner/work/builder/builder/packages/sdks-tests/src/snippet-tests/api-endpoint.spec.ts:20:36
await page.route(urlMatchForQueryAPI, route => {
queryApiInvocations++;