Add checksumMd5 column to Image table
#356
Conversation
WalkthroughThis change introduces database schema version 30, adding a Changes
Sequence Diagram(s)sequenceDiagram
participant App
participant GsonToRoomConverter
participant RoomDb
participant FileHelper
App->>GsonToRoomConverter: Convert ImageGson to Image
GsonToRoomConverter->>Image: Set checksumMd5 property
App->>RoomDb: Store Image entity (with checksumMd5)
App->>FileHelper: Request image file for Image
FileHelper->>File: Generate filename using checksumMd5
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes found. Possibly related PRs
elimu.ai's mission is to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months. ✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
app/src/main/java/ai/elimu/content_provider/util/FileHelper.kt (2)
18-27: 🛠️ Refactor suggestionValidation still checks
id/revisionNumberinstead ofchecksumMd5The early-return guard is now irrelevant to the new naming scheme and may block valid images whose IDs were trimmed from the feed.
-if ((imageGson.id == null) || (imageGson.revisionNumber == null)) { +if (imageGson.checksumMd5.isNullOrBlank()) { return null }
32-41: 🛠️ Refactor suggestionDuplicate issue in entity overload
Same mismatch as above; validate
checksumMd5, not the obsolete fields.-if ((imageGson.id == null) || (imageGson.revisionNumber == null)) { +if (imageGson.checksumMd5.isBlank()) { return null }
🧹 Nitpick comments (2)
app/src/main/java/ai/elimu/content_provider/room/entity/Image.kt (1)
14-14: Consider avoidinglateinitfor a database-backed NOT NULL column
lateinit var checksumMd5: Stringsilently allows the field to be left unset in Kotlin code until first access, hiding bugs until runtime.
Prefer an explicit non-nullable constructor parameter or default value:var checksumMd5: String = ""This keeps compile-time guarantees aligned with the NOT NULL schema.
app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java (1)
402-409: IncorrectLog.iusage prints a literal%s
Log.i(String tag, String msg)does not performprintf-style formatting:Log.i("migrate sql: %s", sql);Results in tag =
"migrate sql: %s"and message =sql.
Use proper formatting to avoid confusing logcat output:-Log.i("migrate sql: %s", sql); +Log.i(getClass().getName(), String.format("migrate sql: %s", sql));
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
app/schemas/ai.elimu.content_provider.room.db.RoomDb/30.json(1 hunks)app/src/main/java/ai/elimu/content_provider/room/GsonToRoomConverter.kt(1 hunks)app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java(3 hunks)app/src/main/java/ai/elimu/content_provider/room/entity/Image.kt(1 hunks)app/src/main/java/ai/elimu/content_provider/util/FileHelper.kt(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: build (macos-latest, 21)
- GitHub Check: build (windows-latest, 21)
- GitHub Check: test (29)
- GitHub Check: test (28)
- GitHub Check: build (ubuntu-latest, 21)
- GitHub Check: build (macos-latest, 17)
- GitHub Check: lint
- GitHub Check: build (windows-latest, 17)
- GitHub Check: build (ubuntu-latest, 17)
🔇 Additional comments (2)
app/src/main/java/ai/elimu/content_provider/room/GsonToRoomConverter.kt (1)
160-165:❓ Verification inconclusive
Guard against nullable
checksumMd5before assignment
Image.checksumMd5islateinit varand markedNOT NULLin the DB.
IfimageGson.checksumMd5arrives asnull(or blank) this line will throw at runtime or violate the column constraint, jeopardising elimu.ai's mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months.-// Image -image.title = imageGson.title -image.imageFormat = imageGson.imageFormat -image.checksumMd5 = imageGson.checksumMd5 +// Image +image.title = imageGson.title +image.imageFormat = imageGson.imageFormat +image.checksumMd5 = requireNotNull(imageGson.checksumMd5) { + "checksumMd5 must be non-null for image id=${imageGson.id}" +}
To uphold elimu.ai’s mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months, let’s verify the nullability of
checksumMd5in both the JSON model and the Room entity:
🏁 Script executed:
#!/bin/bash # Locate and show the ImageGson declaration echo "=== ImageGson Definition ===" rg --color=never -n "data class ImageGson" -A3 || echo "ImageGson class not found" echo # Show checksumMd5 property in ImageGson echo "=== checksumMd5 in ImageGson ===" rg --color=never -n "checksumMd5" -B1 -A1 || echo "checksumMd5 not found in ImageGson" echo # Locate and show the Room Image entity declaration echo "=== Image Entity Definition ===" rg --color=never -n "class Image" -A3 || echo "Image entity not found" echo # Show checksumMd5 property in Image entity echo "=== checksumMd5 in Image Entity ===" rg --color=never -n "checksumMd5" -B1 -A1 || echo "checksumMd5 not found in Image entity"Length of output: 7737
To confirm whether
imageGson.checksumMd5can actually benull, let’s locate and inspect theImageGsonclass definition:
🏁 Script executed:
#!/bin/bash # List all files referencing ImageGson echo "=== Files containing ImageGson ===" rg --color=never -l "ImageGson" || echo "No references found" # For each, show nearby class declaration and property definitions for file in $(rg --color=never -l "ImageGson"); do echo echo "=== Inspecting $file ===" rg --color=never -n "class ImageGson|data class ImageGson" -A5 -B2 "$file" || echo "No class keyword around ImageGson" doneLength of output: 5365
Verify nullability of
checksumMd5in ImageGson before assignmentTo uphold elimu.ai’s mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months, we must ensure no runtime or DB NOT NULL violations creep in.
• File: app/src/main/java/ai/elimu/content_provider/room/GsonToRoomConverter.kt
Line 163:image.checksumMd5 = imageGson.checksumMd5
•Image.checksumMd5is alateinit varmapped to aTEXT NOT NULLcolumn.
• We couldn’t locate theImageGsonclass in source—please confirm if itschecksumMd5property is nullable (String?) or always non-null.If it can be null or blank, guard or default it, for example:
image.checksumMd5 = requireNotNull(imageGson.checksumMd5) { "checksumMd5 must be non-null for image id=${imageGson.id}" } // or, to allow empty strings: image.checksumMd5 = imageGson.checksumMd5.orEmpty()app/schemas/ai.elimu.content_provider.room.db.RoomDb/30.json (1)
320-366: Schema looks consistent with code changes – nice work
checksumMd5is declaredTEXT NOT NULL, matching the entity and migration.
No further action needed.
Issue Number
Purpose
checksumMd5column toImagetablechecksumMd5to read image files from diskTechnical Details
Screenshots
Testing Instructions
Regression Tests
UI Tests
Content Tests
eng.elimu.ai)hin.elimu.ai)tgl.elimu.ai)tha.elimu.ai)vie.elimu.ai)Summary by CodeRabbit
New Features
Bug Fixes
Chores