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

Content Model: Improve cache behavior #1999

Merged
merged 6 commits into from
Aug 4, 2023
Merged

Content Model: Improve cache behavior #1999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
212b949
Content Model: Improve cache behavior
JiuqingSong Aug 2, 2023
dedf08f
fix build
JiuqingSong Aug 2, 2023
2aee948
Merge branch 'master' into u/jisong/cacheimprove2
JiuqingSong Aug 3, 2023
3ce3d55
Merge branch 'master' into u/jisong/cacheimprove2
JiuqingSong Aug 3, 2023
177ab6a
fix comment
JiuqingSong Aug 4, 2023
20816ca
Merge branch 'master' into u/jisong/cacheimprove2
JiuqingSong Aug 4, 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
1 change: 0 additions & 1 deletion ...ntent-model/roosterjs-content-model-dom/lib/domToModel/context/createDomToModelContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ export function createDomToModelContext(

defaultElementProcessors: defaultProcessorMap,
defaultFormatParsers: defaultFormatParsers,
allowCacheElement: !options?.disableCacheElement,
};

if (editorContext?.isRootRtl) {
Expand Down
17 changes: 1 addition & 16 deletions ...es-content-model/roosterjs-content-model-dom/lib/domToModel/processors/entityProcessor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,7 @@ export const entityProcessor: ElementProcessor<HTMLElement> = (group, element, c
context,
{ segment: isBlockEntity ? 'empty' : undefined, paragraph: 'empty' },
() => {
const wrapperToUse = context.allowCacheElement
? element
: (element.cloneNode(true /* deep */) as HTMLElement);

if (!context.allowCacheElement) {
wrapperToUse.style.backgroundColor = element.style.backgroundColor || 'inherit';
wrapperToUse.style.color = element.style.color || 'inherit';
JiuqingSong marked this conversation as resolved.
Show resolved Hide resolved
}

const entityModel = createEntity(
wrapperToUse,
isReadonly,
context.segmentFormat,
id,
type
);
const entityModel = createEntity(element, isReadonly, context.segmentFormat, id, type);

// TODO: Need to handle selection for editable entity
if (context.isInSelection) {
Expand Down
2 changes: 1 addition & 1 deletion packages-content-model/roosterjs-content-model-dom/lib/modelToDom/contentModelToDom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export function contentModelToDom(
doc: Document,
root: Node,
model: ContentModelDocument,
editorContext: EditorContext,
editorContext?: EditorContext,
option?: ModelToDomOption
): SelectionRangeEx | null {
const modelToDomContext = createModelToDomContext(editorContext, option);
Expand Down
7 changes: 5 additions & 2 deletions packages-content-model/roosterjs-content-model-dom/lib/modelToDom/handlers/handleDivider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,17 @@ export const handleDivider: ContentModelBlockHandler<ContentModelDivider> = (
context: ModelToDomContext,
refNode: Node | null
) => {
let element = divider.cachedElement;
let element = context.allowCacheElement ? divider.cachedElement : undefined;

if (element) {
refNode = reuseCachedElement(parent, element, refNode);
} else {
element = doc.createElement(divider.tagName);

divider.cachedElement = element;
if (context.allowCacheElement) {
divider.cachedElement = element;
}

parent.insertBefore(element, refNode);

applyFormat(element, context.formatAppliers.divider, divider.format, context);
Expand Down
10 changes: 9 additions & 1 deletion packages-content-model/roosterjs-content-model-dom/lib/modelToDom/handlers/handleEntity.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,15 @@ export const handleEntity: ContentModelBlockHandler<ContentModelEntity> = (
context: ModelToDomContext,
refNode: Node | null
) => {
const { wrapper, id, type, isReadonly, format } = entityModel;
const { id, type, isReadonly, format } = entityModel;
let wrapper = entityModel.wrapper;

if (!context.allowCacheElement) {
wrapper = wrapper.cloneNode(true /*deep*/) as HTMLElement;
wrapper.style.color = wrapper.style.color || 'inherit';
wrapper.style.backgroundColor = wrapper.style.backgroundColor || 'inherit';
}

const entity: Entity | null =
id && type
? {
Expand Down
7 changes: 5 additions & 2 deletions ...ontent-model/roosterjs-content-model-dom/lib/modelToDom/handlers/handleFormatContainer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const handleFormatContainer: ContentModelBlockHandler<ContentModelFormatC
context: ModelToDomContext,
refNode: Node | null
) => {
let element = container.cachedElement;
let element = context.allowCacheElement ? container.cachedElement : undefined;

if (element) {
refNode = reuseCachedElement(parent, element, refNode);
Expand All @@ -28,7 +28,10 @@ export const handleFormatContainer: ContentModelBlockHandler<ContentModelFormatC
} else if (!isBlockGroupEmpty(container)) {
const containerNode = doc.createElement(container.tagName);

container.cachedElement = containerNode;
if (context.allowCacheElement) {
container.cachedElement = containerNode;
}

parent.insertBefore(containerNode, refNode);

stackFormat(context, container.tagName, () => {
Expand Down
6 changes: 4 additions & 2 deletions ...ages-content-model/roosterjs-content-model-dom/lib/modelToDom/handlers/handleParagraph.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export const handleParagraph: ContentModelBlockHandler<ContentModelParagraph> =
context: ModelToDomContext,
refNode: Node | null
) => {
let container = paragraph.cachedElement;
let container = context.allowCacheElement ? paragraph.cachedElement : undefined;

if (container) {
refNode = reuseCachedElement(parent, container, refNode);
Expand Down Expand Up @@ -102,7 +102,9 @@ export const handleParagraph: ContentModelBlockHandler<ContentModelParagraph> =
refNode = container.nextSibling;

if (needParagraphWrapper) {
paragraph.cachedElement = container;
if (context.allowCacheElement) {
paragraph.cachedElement = container;
}
} else {
unwrap(container);
}
Expand Down
23 changes: 17 additions & 6 deletions packages-content-model/roosterjs-content-model-dom/lib/modelToDom/handlers/handleTable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const handleTable: ContentModelBlockHandler<ContentModelTable> = (
return refNode;
}

let tableNode = table.cachedElement;
let tableNode = context.allowCacheElement ? table.cachedElement : undefined;

if (tableNode) {
refNode = reuseCachedElement(parent, tableNode, refNode);
Expand All @@ -33,7 +33,10 @@ export const handleTable: ContentModelBlockHandler<ContentModelTable> = (
} else {
tableNode = doc.createElement('table');

table.cachedElement = tableNode;
if (context.allowCacheElement) {
table.cachedElement = tableNode;
}

parent.insertBefore(tableNode, refNode);

applyFormat(tableNode, context.formatAppliers.block, table.format, context);
Expand All @@ -55,12 +58,15 @@ export const handleTable: ContentModelBlockHandler<ContentModelTable> = (
continue;
}

const tr = tableRow.cachedElement || doc.createElement('tr');
const tr = (context.allowCacheElement && tableRow.cachedElement) || doc.createElement('tr');
tbody.appendChild(tr);
moveChildNodes(tr);

if (!tableRow.cachedElement) {
tableRow.cachedElement = tr;
if (context.allowCacheElement) {
tableRow.cachedElement = tr;
}

applyFormat(tr, context.formatAppliers.tableRow, tableRow.format, context);
}

Expand All @@ -85,7 +91,9 @@ export const handleTable: ContentModelBlockHandler<ContentModelTable> = (
}

if (!cell.spanAbove && !cell.spanLeft) {
let td = cell.cachedElement || doc.createElement(cell.isHeader ? 'th' : 'td');
let td =
(context.allowCacheElement && cell.cachedElement) ||
doc.createElement(cell.isHeader ? 'th' : 'td');

tr.appendChild(td);

Expand Down Expand Up @@ -120,7 +128,10 @@ export const handleTable: ContentModelBlockHandler<ContentModelTable> = (
}

if (!cell.cachedElement) {
cell.cachedElement = td;
if (context.allowCacheElement) {
cell.cachedElement = td;
}

applyFormat(td, context.formatAppliers.block, cell.format, context);
applyFormat(td, context.formatAppliers.tableCell, cell.format, context);
applyFormat(td, context.formatAppliers.tableCellBorder, cell.format, context);
Expand Down
4 changes: 0 additions & 4 deletions ...-model/roosterjs-content-model-dom/test/domToModel/context/createDomToModelContextTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ describe('createDomToModelContext', () => {
format: {},
tagName: '',
},
allowCacheElement: true,
...contextOptions,
});
});
Expand Down Expand Up @@ -69,7 +68,6 @@ describe('createDomToModelContext', () => {
format: {},
tagName: '',
},
allowCacheElement: true,
...contextOptions,
});
});
Expand Down Expand Up @@ -98,7 +96,6 @@ describe('createDomToModelContext', () => {
format: {},
tagName: '',
},
allowCacheElement: true,
...contextOptions,
});
});
Expand All @@ -123,7 +120,6 @@ describe('createDomToModelContext', () => {
format: {},
tagName: '',
},
allowCacheElement: true,
...contextOptions,
rangeEx: selectionContext,
});
Expand Down
65 changes: 0 additions & 65 deletions ...ntent-model/roosterjs-content-model-dom/test/domToModel/processors/entityProcessorTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,69 +197,4 @@ describe('entityProcessor', () => {
lineHeight: '20px',
});
});

it('Block element entity, clone element', () => {
const group = createContentModelDocument();
const div = document.createElement('div');

const clonedDiv = div.cloneNode(true /* deep */) as HTMLDivElement;
spyOn(Node.prototype, 'cloneNode').and.returnValue(clonedDiv);
context.allowCacheElement = false;

commitEntity(div, 'entity', true, 'entity_1');

entityProcessor(group, div, context);

expect(group).toEqual({
blockGroupType: 'Document',

blocks: [
{
blockType: 'Entity',
segmentType: 'Entity',
format: {},
id: 'entity_1',
type: 'entity',
isReadonly: true,
wrapper: clonedDiv,
},
],
});
});

it('Inline element entity, clone entity element', () => {
const group = createContentModelDocument();
const span = document.createElement('span');

const clonedSpan = span.cloneNode(true /* deep */) as HTMLDivElement;
spyOn(Node.prototype, 'cloneNode').and.returnValue(clonedSpan);
context.allowCacheElement = false;

commitEntity(span, 'entity', true, 'entity_1');

entityProcessor(group, span, context);

expect(group).toEqual({
blockGroupType: 'Document',

blocks: [
{
blockType: 'Paragraph',
isImplicit: true,
segments: [
{
blockType: 'Entity',
segmentType: 'Entity',
format: {},
id: 'entity_1',
type: 'entity',
isReadonly: true,
wrapper: clonedSpan,
},
],
format: {},
},
],
});
});
});
Loading