fix: add null checks to list numbering functions#1904
Open
lloyd-lighthouse wants to merge 1 commit intosuperdoc-dev:mainfrom
Open
fix: add null checks to list numbering functions#1904lloyd-lighthouse wants to merge 1 commit intosuperdoc-dev:mainfrom
lloyd-lighthouse wants to merge 1 commit intosuperdoc-dev:mainfrom
Conversation
Added null safety to createNumbering, generateNumbering, and generateFromCustom functions to prevent runtime errors when lvlText is null or undefined.
Author
|
Hi team. Its strange that a version was released to fix numbering issues recently (#1675) However this is a similar issue, perhaps some sort of an edge case? This document works This document however, does not work We've tried our best to trace this issue down and think the suggested fix in this PR is a way for us to make sure we never encounter this issue again, but we are obviously new to this codebase and can only do a best guess realistically. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added null safety to the list numbering functions in
shared/common/list-numbering/index.tsto prevent runtime errors whenlvlTextis null or undefined.Changes
createNumberingto acceptlvlText: string | nulland return early if nullgenerateNumberingto acceptlvlText: string | nullwith null guardgenerateFromCustomto acceptlvlText: string | nullwith null guardstring | nullto reflect nullable returnsWhy
When
lvlTextis null, calling.replace()on it causes a runtime error. This fix ensures graceful handling by returning null early.Test Plan
lvlTextvalueslvlTextreturns null without throwing errorsBreaking Changes
None - this is a backwards-compatible fix. Functions that previously crashed on null input will now return null.