Skip to content

Adjust key generating in the library #29

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

Open
5ZYSZ3K wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adjust key generating in the library #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8875f2d
fix: adjust key generating in the library
5ZYSZ3K Mar 1, 2026
23b5fbf
fix: add tests for key generation
5ZYSZ3K Mar 1, 2026
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
138 changes: 138 additions & 0 deletions packages/render/src/__tests__/component.render-html.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -893,4 +893,142 @@ describe('RenderHTML', () => {
expect(queryByText('\n', { normalizer: (s) => s })).toBeNull();
});
});
describe('regarding key generation in renderChildren', () => {
it('should generate unique keys for sibling elements with the same tag name', () => {
const capturedKeys: string[] = [];
const renderChild = jest.fn(({ key }) => {
capturedKeys.push(key);
return null;
});
const DivRenderer: CustomTextualRenderer = jest.fn(function DivRenderer({
TDefaultRenderer,
...props
}) {
return (
<TDefaultRenderer {...props}>
<TNodeChildrenRenderer
renderChild={renderChild}
tnode={props.tnode}
/>
</TDefaultRenderer>
);
});
render(
<RenderHTML
source={{
html: '<div><p>One</p><p>Two</p></div>'
}}
debug={false}
renderers={{ div: DivRenderer }}
contentWidth={100}
/>
);
expect(capturedKeys.length).toBeGreaterThanOrEqual(2);
expect(new Set(capturedKeys).size).toBe(capturedKeys.length);
});
it('should generate unique keys for elements with the same tag and same nodeIndex in different subtrees', () => {
const capturedKeys: string[] = [];
const renderChild = jest.fn(({ key }) => {
capturedKeys.push(key);
return null;
});
const DivRenderer: CustomTextualRenderer = jest.fn(function DivRenderer({
TDefaultRenderer,
...props
}) {
return (
<TDefaultRenderer {...props}>
<TNodeChildrenRenderer
renderChild={renderChild}
tnode={props.tnode}
/>
</TDefaultRenderer>
);
});
render(
<RenderHTML
source={{
html: '<div><div><p>Nested One</p></div><div><p>Nested Two</p></div></div>'
}}
debug={false}
renderers={{ div: DivRenderer }}
contentWidth={100}
/>
);
expect(new Set(capturedKeys).size).toBe(capturedKeys.length);
});
it('should generate a key matching the exact expected string including parent path', () => {
const capturedKeys: string[] = [];
const renderChild = jest.fn(({ key }) => {
capturedKeys.push(key);
return null;
});
const DivRenderer: CustomTextualRenderer = jest.fn(function DivRenderer({
TDefaultRenderer,
...props
}) {
return (
<TDefaultRenderer {...props}>
<TNodeChildrenRenderer
renderChild={renderChild}
tnode={props.tnode}
/>
</TDefaultRenderer>
);
});
render(
<RenderHTML
source={{
html: '<div><p>One</p><p>Two</p></div>'
}}
debug={false}
renderers={{ div: DivRenderer }}
contentWidth={100}
/>
);
// The key encodes the full ancestor path: <p> at index 0 inside <div> at index 0
// inside synthetic <body> at index 0 inside TDocument (tagName "html") at index 0
expect(capturedKeys[0]).toBe(
'tnode_childTnode--p-0-div-0-body-0-html-0'
);
// Second <p> differs only in its own nodeIndex (1 instead of 0)
expect(capturedKeys[1]).toBe(
'tnode_childTnode--p-1-div-0-body-0-html-0'
);
});
it('should generate keys with the tnode_childTnode- prefix', () => {
const capturedKeys: string[] = [];
const renderChild = jest.fn(({ key }) => {
capturedKeys.push(key);
return null;
});
const DivRenderer: CustomTextualRenderer = jest.fn(function DivRenderer({
TDefaultRenderer,
...props
}) {
return (
<TDefaultRenderer {...props}>
<TNodeChildrenRenderer
renderChild={renderChild}
tnode={props.tnode}
/>
</TDefaultRenderer>
);
});
render(
<RenderHTML
source={{
html: '<div><p>One</p><p>Two</p></div>'
}}
debug={false}
renderers={{ div: DivRenderer }}
contentWidth={100}
/>
);
expect(capturedKeys.length).toBeGreaterThan(0);
for (const key of capturedKeys) {
expect(key).toMatch(/^tnode_childTnode-/);
}
});
});
});
12 changes: 11 additions & 1 deletion packages/render/src/renderChildren.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ import TNodeRenderer from './TNodeRenderer';
import { TChildrenRendererProps } from './shared-types';
import collapseTopMarginForChild from './helpers/collapseTopMarginForChild';

function generateKey(childTnode: TNode): string {
let key = "";
let currNode = childTnode as TNode | null;
while (currNode){
key = `${key}-${currNode.tagName}-${String(currNode.nodeIndex)}`
currNode = currNode.parent;
}
return `childTnode-${key}`
}

const mapCollapsibleChildren = (
propsForChildren: TChildrenRendererProps['propsForChildren'],
renderChild: TChildrenRendererProps['renderChild'],
Expand All @@ -16,7 +26,7 @@ const mapCollapsibleChildren = (
? null
: collapseTopMarginForChild(n, tchildren);
const propsFromParent = { ...propsForChildren, collapsedMarginTop };
const key = childTnode.nodeIndex;
const key = `tnode_${generateKey(childTnode)}`;
const childElement = React.createElement(TNodeRenderer, {
propsFromParent,
tnode: childTnode,
Expand Down
10 changes: 5 additions & 5 deletions packages/transient-render-engine/src/__tests__/__snapshots__/TRenderEngine.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,11 +132,11 @@ exports[`TRenderEngine > buildTTree method should support disabling whitespace c
<TText tagName="span" nodeIndex={1} data="phrasing content" webStyles={{ whiteSpace: "normal"}} />
<TText anonymous nodeIndex={2} data="\\n" webStyles={{ whiteSpace: "normal"}} />
</TPhrasing>
<TBlock tagName="img" nodeIndex={3} src="https://domain.com/logo.jpg" webStyles={{ whiteSpace: "normal"}} />
<TPhrasing anonymous nodeIndex={0} webStyles={{ whiteSpace: "normal"}}>
<TText anonymous nodeIndex={4} data="\\n and this is " webStyles={{ whiteSpace: "normal"}} />
<TText tagName="strong" nodeIndex={5} data="too" webStyles={{ whiteSpace: "normal"}} />
<TText anonymous nodeIndex={6} data=".\\n" webStyles={{ whiteSpace: "normal"}} />
<TBlock tagName="img" nodeIndex={1} src="https://domain.com/logo.jpg" webStyles={{ whiteSpace: "normal"}} />
<TPhrasing anonymous nodeIndex={2} webStyles={{ whiteSpace: "normal"}}>
<TText anonymous nodeIndex={0} data="\\n and this is " webStyles={{ whiteSpace: "normal"}} />
<TText tagName="strong" nodeIndex={1} data="too" webStyles={{ whiteSpace: "normal"}} />
<TText anonymous nodeIndex={2} data=".\\n" webStyles={{ whiteSpace: "normal"}} />
</TPhrasing>
</TBlock>
</TBlock>
Expand Down
14 changes: 7 additions & 7 deletions packages/transient-render-engine/src/flow/__tests__/__snapshots__/hoist.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ exports[`hoist function should comply with RFC002 example (hoisting) 1`] = `
<TText tagName="span" nodeIndex={1} data="phrasing content" />
<TText anonymous nodeIndex={2} data="\\n" />
</TPhrasing>
<TBlock tagName="img" nodeIndex={3} src="https://domain.com/logo.jpg" />
<TPhrasing anonymous nodeIndex={0}>
<TText anonymous nodeIndex={4} data="\\n and this is " />
<TText tagName="strong" nodeIndex={5} data="too" />
<TText anonymous nodeIndex={6} data=".\\n" />
<TBlock tagName="img" nodeIndex={1} src="https://domain.com/logo.jpg" />
<TPhrasing anonymous nodeIndex={2}>
<TText anonymous nodeIndex={0} data="\\n and this is " />
<TText tagName="strong" nodeIndex={1} data="too" />
<TText anonymous nodeIndex={2} data=".\\n" />
</TPhrasing>
</TBlock>
`;

exports[`hoist function should hoist multiple blocks 1`] = `
<TBlock tagName="span" nodeIndex={0}>
<TBlock tagName="div" nodeIndex={0} />
<TPhrasing anonymous nodeIndex={0}>
<TText anonymous nodeIndex={1} data="Hello" />
<TPhrasing anonymous nodeIndex={1}>
<TText anonymous nodeIndex={0} data="Hello" />
</TPhrasing>
<TBlock tagName="img" nodeIndex={2} />
</TBlock>
Expand Down
8 changes: 4 additions & 4 deletions packages/transient-render-engine/src/flow/hoist.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ function groupText(tnode: TBlockImpl): TNodeImpl {
// some React Native styles working only for the uppermost Text element
// such as "textAlign" are preserved.
parentStyles: tnode.styles,
parent: null
parent: tnode
};
let wrapper = new TPhrasingCtor(wrapperInit);
let wrapperChildren: TNodeImpl[] = [];
Expand All @@ -26,18 +26,18 @@ function groupText(tnode: TBlockImpl): TNodeImpl {
} else {
if (wrapperChildren.length) {
newChildren.push(wrapper);
wrapper.bindChildren(wrapperChildren);
Copy link
Collaborator Author

@5ZYSZ3K 5ZYSZ3K Mar 1, 2026

Choose a reason for hiding this comment

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

@jsamr I've checked the usage of nodeIndex, and it seems like the only thing that could break because of that is removing top and bottom margins in <li> components, but I tested it and it seems like it's working fine

wrapper.bindChildren(wrapperChildren, true);
wrapper = new TPhrasingCtor(wrapperInit);
wrapperChildren = [];
}
newChildren.push(child);
}
}
if (wrapperChildren.length) {
wrapper.bindChildren(wrapperChildren);
wrapper.bindChildren(wrapperChildren, true);
newChildren.push(wrapper);
}
tnode.bindChildren(newChildren);
tnode.bindChildren(newChildren, true);
return tnode;
}

Expand Down