feat: add custom compare node props

[zhugexinxin]

Description
add custom compare node props

Example
node = { type: 'p', attributes: { hidden: true } }

Context
If you don't do it, you may create an infinite loop when setting properties

Checks

• The new code matches the existing patterns and styles.
• The tests pass with yarn test.
• The linter passes with yarn lint. (Fix errors with yarn fix.)
• The relevant examples still work. (Run examples with yarn start.)
• You've added a changeset if changing functionality. (Add one with yarn changeset add.)

[changeset-bot]

⚠️ No Changeset found

Latest commit: ec93a84

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[dylans]

Hi @zhugexinxin could you please add a test showing what is failing currently that passes after this PR lands? Thanks!

[zhugexinxin]

Hi @zhugexinxin could you please add a test showing what is failing currently that passes after this PR lands? Thanks!

I'm not very good at testing, but I'm willing to try.
For the infinite loop test, I don't know how to write it, maybe I have to understand the jest api.

this is demo url https://codesandbox.io/s/xenodochial-gould-j35v1o?file=/src/App.js

let hasChanges = false

for (const k in props) {
  if (k === 'children' || k === 'text') {
    continue
  }

  if (props[k] !== node[k]) {
    hasChanges = true
    // Omit new properties from the old properties list
    if (node.hasOwnProperty(k)) properties[k] = node[k]
    // Omit properties that have been removed from the new properties list
    if (props[k] != null) newProperties[k] = props[k]
  }
}

if (hasChanges) {
  editor.apply({
    type: 'set_node',
    path,
    properties,
    newProperties,
  })
}

hasChanges always true

[zhugexinxin]

I don't know where is the problem at the moment and may need help and hints
I seem to be missing something, I'll fix this when I have time

[zhugexinxin]

tests have been added

[zhugexinxin]

@dylans
test:integration fail, but it succeeded on the local machine.
I really need this new version, what help do I need.

[dylans]

@dylans test:integration fail, but it succeeded on the local machine. I really need this new version, what help do I need.

Integration tests are somewhat flaky on GitHub Actions and timeout prematurely. I'll push an updated release now.

[zhugexinxin]

@dylans test:integration fail, but it succeeded on the local machine. I really need this new version, what help do I need.

Integration tests are somewhat flaky on GitHub Actions and timeout prematurely. I'll push an updated release now.

thank you!

[BitPhinix]

I'm not sure I get why compare is needed here. I don't really get the problem it solves. Couldn't the normalizeNode simply be written in a slightly different way to avoid an infinite loop?