Fix Thai diacritic input validation #2011

AbaSheger · 2025-02-13T08:45:59Z

Fixes #1996

Increase the @Size and @Column annotation limits for the text field in Letter.java to 3 characters.

Update @Size annotation for the text field to 3 characters.
Update @Column annotation for the text field to 3 characters.

Fixes elimu-ai#1996 Increase the `@Size` and `@Column` annotation limits for the `text` field in `Letter.java` to 3 characters. * Update `@Size` annotation for the `text` field to 3 characters. * Update `@Column` annotation for the `text` field to 3 characters.

codecov · 2025-02-13T08:47:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 16.06%. Comparing base (1edf66f) to head (1d046b0).

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #2011   +/-   ##
=========================================
  Coverage     16.06%   16.06%           
  Complexity      483      483           
=========================================
  Files           257      257           
  Lines          7819     7819           
  Branches        800      800           
=========================================
  Hits           1256     1256           
  Misses         6513     6513           
  Partials         50       50

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai · 2025-02-13T08:49:06Z

Walkthrough

The change updates the Letter class in the project by modifying the constraints applied to the text field. Specifically, both the @Size and the @Column annotations have been updated to allow a maximum of three characters instead of two.

Changes

File	Change Summary
`src/main/java/ai/elimu/model/content/Letter.java`	Updated `Letter` class: increased maximum length of the `text` field from 2 to 3 in the `@Size` and `@Column` annotations.

Suggested reviewers

jpatel3
tomaszsmy
SnehaHS65
nya-elimu

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1edf66f and 1d046b0.

📒 Files selected for processing (1)

src/main/java/ai/elimu/model/content/Letter.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

GitHub Check: build (windows-latest, 21)
GitHub Check: build (windows-latest, 17)
GitHub Check: build (ubuntu-latest, 21)
GitHub Check: build (ubuntu-latest, 17)
GitHub Check: test_ui_ENG

🔇 Additional comments (2)

src/main/java/ai/elimu/model/content/Letter.java (2)

12-14:
❓ Verification inconclusive

Verify database schema updates.

Since the column length is being modified, ensure that the database schema is updated accordingly.

Check if there's a database migration script:

🏁 Script executed:
#!/bin/bash
# Look for migration files that might handle the column length change
fd -e sql -e xml -e java migration
Length of output: 237
Action: Verify DB Schema Migrations for the Updated Letter Entity

The update in src/main/java/ai/elimu/model/content/Letter.java (lines 12–14) changes the text column’s length to 3. Although we found migration-related classes (e.g., in src/main/java/ai/elimu/dao/DbMigrationDao.java, src/main/java/ai/elimu/dao/jpa/DbMigrationDaoJpa.java, src/main/java/ai/elimu/model/DbMigration.java, and src/main/java/ai/elimu/util/db/DbMigrationHelper.java), please confirm that the migration process applies this schema change in your deployment environment.

Verify that the migration framework either automatically detects schema modifications or that an appropriate migration script has been created to update the column length in the database.

Ensure that the updated constraint is replicated in your production database to avoid inconsistencies.

12-13:
✅ Verification successful

LGTM! Consistent annotation updates for Thai diacritic support.

The @Size and @Column annotations are consistently updated to support 3 characters, which aligns with the PR objective to fix Thai diacritic input validation.

Let's verify if 3 characters is sufficient for Thai diacritics:

🌐 Web query:
What is the maximum number of characters needed for Thai diacritics?
💡 Result:

The Thai script combines consonants with various diacritical marks for vowels, tones, and other phonetic features. Based on structural analysis of composition rules:

Maximum Diacritic Combinations

A single Thai consonant can theoretically support up to three distinct non-vowel diacritic marks in combination:

Tone mark (mai ek, mai tho, etc.) placed above.

Vowel shortener (mai taikhu ◌็) positioned below.

Silent-letter indicator (thanthakhat ◌์) also above, though conflicting placements may limit practical use[1][3].

Key Considerations

Vowel components like sara i (◌ิ) or sara ue (◌ื) are written separately but do not count as standalone "diacritics" under strict definitions[1][5].

Composite characters often involve multiple Unicode code points due to stacking rules[2][5]. For example:

เกี๊ยะ combines ก + ◌ิ + ◌๊ + ◌็[5].

Valid combinations depend on consonant class, vowel length, and syllable type (live vs. dead)[1][7].

Practical Limits

Most syllables use 1–2 functional marks due to phonological constraints:

Tone + mai taikhu[1].

Tone + thanthakhat[3].
Exceeding this typically requires rare or obsolete forms[3][5].

In summary, while technical encoding permits three non-vowel marks per consonant[5], standard usage rarely exceeds two for clarity[1][7].

Citations:

1: https://en.wikipedia.org/wiki/Thai_script

2: https://pubs.opengroup.org/onlinepubs/9638399/overview.htm

3: https://www.icann.org/en/system/files/files/proposal-thai-lgr-15dec16-en.pdf

4: https://www.babelstreet.com/blog/analyzing-thai-names-superstition-history-and-foreign-influence

5: https://r12a.github.io/scripts/thai/th.html

6: https://en.wikipedia.org/wiki/Thai_language

7: https://www.thaipod101.com/blog/2021/01/18/thai-tones/
Annotation Updates Verified: 3-Character Limit is Appropriate for Thai Diacritic Input

After reviewing the annotations in src/main/java/ai/elimu/model/content/Letter.java (lines 12–13) and verifying with external Thai script composition rules, the update to use a 3-character limit is appropriate. The web query confirms that a single Thai consonant can theoretically support up to three distinct non-vowel diacritic marks. This change correctly accommodates the intended Thai diacritic input validation without exceeding practical usage scenarios.

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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

🪧 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>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
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/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

jo-elimu · 2025-02-13T08:50:53Z

src/main/java/ai/elimu/model/content/Letter.java

-    @Size(max = 2)
-    @Column(length = 2)
+    @Size(max = 3)
+    @Column(length = 3)


Thank you, @AbaSheger.

Since this change involves modification of a database column, will we have to prepare a database migration script as well?

Try launching the webapp on localhost, and see if anything changes in the jpa-schema-export.sql file. If it does, we will have to prepare a DB Migration.

Warning
Note that the database schema (jpa-schema-export.sql) will not be automatically re-generated when you compile the source with mvn compile; Instead, you will have to run the webapp locally with mvn jetty:run for this file to be re-generated.

Got it. I'll launch the webapp on localhost and check for any changes in the jpa-schema-export.sql file. If there are modifications, I'll proceed with preparing a DB migration script. Will update you

jo-elimu

#2011 (comment)

jo-elimu · 2025-04-12T05:16:54Z

@AbaSheger Do you need assistance with this PR?

AbaSheger · 2025-04-12T20:48:37Z

@AbaSheger Do you need assistance with this PR?

Thanks for asking, I got busy with school work. I will get back to this and ask you if I need help.

AbaSheger requested a review from a team as a code owner February 13, 2025 08:46

AbaSheger requested review from jpatel3, jo-elimu and alexander-kuruvilla February 13, 2025 08:46

coderabbitai bot approved these changes Feb 13, 2025

View reviewed changes

jo-elimu reviewed Feb 13, 2025

View reviewed changes

jo-elimu requested changes Feb 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Thai diacritic input validation #2011

Fix Thai diacritic input validation #2011

AbaSheger commented Feb 13, 2025

codecov bot commented Feb 13, 2025 •

edited

Loading

coderabbitai bot commented Feb 13, 2025

Maximum Diacritic Combinations

Key Considerations

Practical Limits

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

jo-elimu Feb 13, 2025 •

edited

Loading

AbaSheger Feb 13, 2025

jo-elimu left a comment

jo-elimu commented Apr 12, 2025

AbaSheger commented Apr 12, 2025

Fix Thai diacritic input validation #2011

Are you sure you want to change the base?

Fix Thai diacritic input validation #2011

Conversation

AbaSheger commented Feb 13, 2025

codecov bot commented Feb 13, 2025 • edited Loading

Codecov Report

coderabbitai bot commented Feb 13, 2025

Walkthrough

Changes

Suggested reviewers

Maximum Diacritic Combinations

Key Considerations

Practical Limits

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

jo-elimu Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

AbaSheger Feb 13, 2025

Choose a reason for hiding this comment

jo-elimu left a comment

Choose a reason for hiding this comment

jo-elimu commented Apr 12, 2025

AbaSheger commented Apr 12, 2025

codecov bot commented Feb 13, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

jo-elimu Feb 13, 2025 •

edited

Loading