fix: text length not computed properly

[RiccardoM]

Description

This PR fixes how the text lengths related to a Post or a FreeTextReactionValue are computed. Previously the count would only consider the byte size of the text. Instead, it's much better to count graphemes.

As per this comment:

There is a difference between bytes, runes, and graphemes, and it seems many people confuse the three. (In most use cases, it doesn't matter anyway.) For example, 🏳️‍🌈 (rainbow flag emoji) is 1 grapheme, 4 runes, and 14 bytes. The Go stdlib only has built-in functions for bytes and runes but not for graphemes.

By counting graphemes instead of runes or bytes, we can assure a consistent user experience with any application that implementes client-based char count.

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title
• added ! to the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• followed the guidelines for building modules
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• included comments for documenting Go code
• updated the relevant documentation or specification
• reviewed "Files changed" and left comments if necessary
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• confirmed the correct type prefix in the PR title
• confirmed ! in the type prefix if API or client breaking change
• confirmed all author checklist items have been addressed
• reviewed state machine logic
• reviewed API design and naming
• reviewed documentation is accurate
• reviewed tests and test coverage
• manually tested (if applicable)

[coderabbitai]

Warning

Rate Limit Exceeded

@RiccardoM has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 35 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between b085e04 and 036ca6b.

Walkthrough

The update introduces enhancements to the text length validation process for posts and reactions. Specifically, it adds methods to calculate the text length directly within the respective data structures (Post and FreeTextValue) and incorporates these methods into the validation logic. Additionally, new tests ensure these methods work correctly across various text scenarios.

Changes

Files	Change Summaries
.../keeper/posts.go, .../types/models.go, .../types/models_test.go	Updated ValidatePost to use GetTextLength(); added GetTextLength method and test in Post.
.../keeper/reactions.go, .../types/models.go, .../types/models_test.go	Updated validation to use GetLength(); added GetLength method and test in FreeTextValue.

"In the land of code where the snippets roam free,
A rabbit hopped in, as happy as can be. 🐇
With a flip and a hop, it refined the text check,
Making posts and reactions perfectly spec.
'Let's celebrate,' it said, with a cheerful decree,
For our code is now cleaner, as clean as can be!"
🎉🥕📝

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 3596aa8 and b085e04.

Files ignored due to path filters (2)

• go.mod is excluded by: !**/*.mod
• go.sum is excluded by: !**/*.sum

Files selected for processing (6)

• x/posts/keeper/posts.go (1 hunks)
• x/posts/types/models.go (2 hunks)
• x/posts/types/models_test.go (1 hunks)
• x/reactions/keeper/reactions.go (1 hunks)
• x/reactions/types/models.go (2 hunks)
• x/reactions/types/models_test.go (1 hunks)

Additional comments: 3

x/reactions/types/models.go (1)

• 126-130: LGTM!

x/reactions/types/models_test.go (1)

• 133-170: LGTM!

x/posts/types/models_test.go (1)

• 352-447: The test function TestPost_GetTextLength is well-structured and covers a variety of text scenarios including Latin text, non-Latin text, emojis, and mixed text. The use of table-driven tests is appropriate and enhances maintainability. The assertions made with require.Equal are correct and effectively validate the expected behavior of the GetTextLength method. Overall, the test function adheres to best practices for writing unit tests in Go.

[coderabbitai]

Ensure the uniseg.GraphemeClusterCount function handles all edge cases correctly, especially with complex grapheme clusters. Consider adding a comment to explain why grapheme counting is preferred over byte or rune counting for future maintainability.