Skip to content

Deterministic entity keys #165

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Deterministic entity keys #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions src/markdown-to-draft.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,6 @@ const DefaultBlockStyles = {
del_open: 'STRIKETHROUGH'
};

// Key generator for entityMap items
var idCounter = -1;
function generateUniqueKey() {
idCounter++;
return idCounter;
}

/*
* Handle inline content in a block level item
* parses for BlockEntities (links, images) and BlockStyles (em, strong)
Expand All @@ -124,7 +117,7 @@ function generateUniqueKey() {
* blockEntityRanges: block-level representation of block entities including key to access the block entity from the global map
* blockStyleRanges: block-level representation of styles (eg strong, em)
*/
function parseInline(inlineItem, BlockEntities, BlockStyles) {
function parseInline(inlineItem, BlockEntities, BlockStyles, generateUniqueKey) {
var content = '', blockEntities = {}, blockEntityRanges = [], blockInlineStyleRanges = [];
inlineItem.children.forEach(function (child) {
if (child.type === 'text') {
Expand Down Expand Up @@ -189,6 +182,13 @@ function markdownToDraft(string, options = {}) {
const remarkableOptions = typeof options.remarkableOptions === 'object' ? options.remarkableOptions : null;
const md = new Remarkable(remarkablePreset, remarkableOptions);

// Key generator for entityMap items
var idCounter = -1;
function generateUniqueKey() {
idCounter++;
return idCounter;
}

// if tables are not explicitly enabled, disable them by default
if (
!remarkableOptions ||
Expand Down Expand Up @@ -248,7 +248,7 @@ function markdownToDraft(string, options = {}) {
if (itemType === 'inline') {
// Parse inline content and apply it to the most recently created block level item,
// which is where the inline content will belong.
var {content, blockEntities, blockEntityRanges, blockInlineStyleRanges} = parseInline(item, BlockEntities, BlockStyles);
var {content, blockEntities, blockEntityRanges, blockInlineStyleRanges} = parseInline(item, BlockEntities, BlockStyles, generateUniqueKey);
var blockToModify = blocks[blocks.length - 1];
blockToModify.text = content;
blockToModify.inlineStyleRanges = blockInlineStyleRanges;
Expand Down
11 changes: 11 additions & 0 deletions test/markdown-to-draft.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,4 +718,15 @@ describe('markdownToDraft', function () {
});
});

describe('determinism', function () {
it('has the same entity keys when run in sequence', function () {
var markdown = 'I have [an entity](https://example.com)';
var conversionResult1 = markdownToDraft(markdown, {});
var conversionResult2 = markdownToDraft(markdown, {});

expect(Object.keys(conversionResult1.entityMap))
.toEqual(Object.keys(conversionResult2.entityMap));
});
});

});