fix: the code block wrap state shoud be persisted in database

[akumatus]

TL;DR

This Pull Request moves the wrap property from temporary state to persistent data model. When user refreshes the web browser, the code block warp style keeps.

Fix affine-design/issue/BS-297.

What changed?

• In code-block.ts, the _wrap private state variable has been removed, and all references to it have instead been directed to this.model.wrap.
• A setWrap function has been added to handle updating the wrap property in the block model, which can be persisted in database.

How to test?

Test this change by creating a code block in document and toggle the wrap icon. Check if this modifies the wrap state in the model and updates the UI accordingly. Refresh the browser, the code block warp styles keeps.

---

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
blocksuite	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 16, 2024 6:39am

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
blocksuite-docs	⬜️ Ignored (Inspect)	Visit Preview		May 16, 2024 6:39am

[graphite-app]

Your org has enabled the Graphite merge queue for merging into master

Add the label “merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

[akumatus]

• fix: the code block wrap state shoud be persisted in database #7062 👈
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @akumatus and the rest of your teammates on Graphite

[Flrande]

Can you add a test for this case?

[doodlewind]

Need to test that for legacy data without the wrap field, whether the backward compatibility could be supported.

[akumatus]

Can you add a test for this case?

@Flrande Thanks for your comments! I have added several tests in tests/code.spec.ts.

[akumatus]

Need to test that for legacy data without the wrap field, whether the backward compatibility could be supported.

blocksuite/packages/framework/store/src/store/doc/block.ts

Line 216 in 0cbbba6

const defaultProps = schema.model.props?.(internalPrimitives);

blocksuite/packages/framework/store/src/store/doc/crud.ts

Line 81 in 0cbbba6

const defaultProps = schema.model.props?.(internalPrimitives) ?? {};

@doodlewind I suppose that legacy data will filled with default wrap:false value, because of the above code. But I don't know how to write the test in that case, could you give me a hint?

[Flrande]

Need to test that for legacy data without the wrap field, whether the backward compatibility could be supported.

blocksuite/packages/framework/store/src/store/doc/block.ts

Line 216 in 0cbbba6

const defaultProps = schema.model.props?.(internalPrimitives);

@doodlewind I suppose that legacy data will filled with default wrap:false value, because of the above code. But I don't know how to write the test in that case, could you give me a hint?

You can test by importing an old snapshot.

[akumatus]

Need to test that for legacy data without the wrap field, whether the backward compatibility could be supported.

I have tested both import old snapshot and paste old code block cases, and everything works fine!

[donteatfriedrice]

If we move the wrap property to the model, we may need to disable the wrap code button in code toolbar when readonly mode.

Screen.Recording.2024-05-16.at.01.29.05.mov

[doodlewind]

LGTM, for the feedback in #7062 (comment), it could be implemented in a standalone PR or simply marked help wanted!

[akumatus]

If we move the wrap property to the model, we may need to disable the wrap code button in code toolbar when readonly mode.

Screen.Recording.2024-05-16.at.01.29.05.mov

Got it! Thanks for your comment, it helps a lot.

[graphite-app]

Merge activity

• May 16, 2:35 AM EDT: The merge label 'merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
• May 16, 2:35 AM EDT: Saul-Mirone added this pull request to the Graphite merge queue.
• May 16, 2:44 AM EDT: Saul-Mirone merged this pull request with the Graphite merge queue.