SEL-559: Update td1 regex

[seshanthS]

Summary by CodeRabbit

• New Features

  • Added support for detecting and processing ID cards (TD1 format) based on OCR text.

• Bug Fixes

  • Improved validation and error logging for missing or incorrect ID card fields during OCR processing.

• Style

  • Enhanced clarity in debug and logging messages related to document detection and processing.

[coderabbitai]

Walkthrough

The update enhances the OCR utility to detect and process ID cards (TD1 format) by identifying the "ID" document code within OCR text. It introduces new regular expressions for extracting and validating key fields from ID cards, adds detailed logging for field validation, and adjusts the control flow to handle ID cards before existing TD1 logic.

Changes

File(s)	Change Summary
.../passportreader/utils/OcrUtils.kt	Added ID card (TD1) detection and extraction logic, new regex patterns, field validation, and improved logging.

Sequence Diagram(s)

sequenceDiagram
    participant OCRUtils
    participant OCRText
    participant Callback

    OCRUtils->>OCRText: Receive OCR text
    OCRUtils->>OCRUtils: Check for "ID" document code using regex
    alt "ID" code found
        OCRUtils->>OCRUtils: Extract fields (doc. number, country, DOB, gender, expiry)
        OCRUtils->>OCRUtils: Validate fields and check digits
        alt All fields valid
            OCRUtils->>Callback: Invoke with dummy MRZInfo
        else Any field invalid
            OCRUtils->>OCRUtils: Log specific debug messages
        end
    else No "ID" code found
        OCRUtils->>OCRUtils: Proceed with existing TD1 line matching logic
    end

Loading

Poem

In lines of code, a passport's tale,
Now ID cards can join the trail.
Regex patterns, sharp and keen,
Extract the fields, keep data clean.
With logs to guide and checks in place,
The OCR dances—swift with grace!
📜✨🔍

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9101852 and e56f0a1.

📒 Files selected for processing (1)

• app/android/android-passport-reader/app/src/main/java/example/jllarraz/com/passportreader/utils/OcrUtils.kt (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• app/android/android-passport-reader/app/src/main/java/example/jllarraz/com/passportreader/utils/OcrUtils.kt

⏰ Context from checks skipped due to timeout of 300000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

❤️ 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need 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)

• @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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.

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.

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c195d27 and 2b32ee5.

📒 Files selected for processing (1)

• app/android/android-passport-reader/app/src/main/java/example/jllarraz/com/passportreader/utils/OcrUtils.kt (3 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

app/android/**/*

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

⏰ Context from checks skipped due to timeout of 300000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build

🔇 Additional comments (4)

app/android/android-passport-reader/app/src/main/java/example/jllarraz/com/passportreader/utils/OcrUtils.kt (4)

24-26: LGTM - Well-structured regex constant

The document code regex pattern is properly defined as a class-level constant, which is good for performance and maintainability. The pattern correctly matches the expected TD1 document code format.

---

53-60: Standard pattern compilation approach

The pattern compilation and matcher creation follows the established approach in the codebase. Implementation is consistent and appropriate.

---

111-111: Improved logging clarity

The updated logging message "TD1Line1 and TD1Line2 found" is more descriptive and helpful for debugging OCR processing flow.

---

94-94: Consistent logging approach

The "cleanDocumentNumber" logging is now consistent across different document processing paths, which improves debugging consistency.

Also applies to: 122-122

[coderabbitai]

🛠️ Refactor suggestion

Enhance field validation for completeness and security

The validation logic is good but could be more comprehensive. Consider validating additional fields and their formats to ensure data integrity.

// Only proceed if all required fields are present and non-empty
- if (!countryCode.isNullOrEmpty() && !documentNumber.isNullOrEmpty() && !dateOfBirth.isNullOrEmpty() && !expirationDate.isNullOrEmpty() && checkDigitDocumentNumber != null) {
+ if (!countryCode.isNullOrEmpty() && !documentNumber.isNullOrEmpty() && !dateOfBirth.isNullOrEmpty() && 
+     !expirationDate.isNullOrEmpty() && !gender.isNullOrEmpty() && checkDigitDocumentNumber != null && 
+     checkDigitDateOfBirth != null && checkDigitExpiration != null) {
+     
+     // Validate field formats
+     if (!countryCode.matches("[A-Z]{3}".toRegex())) {
+         Log.d(TAG, "Invalid country code format")
+         return
+     }
+     if (!dateOfBirth.matches("[0-9]{6}".toRegex())) {
+         Log.d(TAG, "Invalid date of birth format")
+         return
+     }
+     if (!expirationDate.matches("[0-9]{6}".toRegex())) {
+         Log.d(TAG, "Invalid expiration date format")
+         return
+     }

Also add logging for the additional fields:

    } else {
        if (countryCode.isNullOrEmpty()) Log.d(TAG, "Missing or invalid countryCode")
        if (documentNumber.isNullOrEmpty()) Log.d(TAG, "Missing or invalid documentNumber")
        if (dateOfBirth.isNullOrEmpty()) Log.d(TAG, "Missing or invalid dateOfBirth")
        if (expirationDate.isNullOrEmpty()) Log.d(TAG, "Missing or invalid expirationDate")
+       if (gender.isNullOrEmpty()) Log.d(TAG, "Missing or invalid gender")
        if (checkDigitDocumentNumber == null) Log.d(TAG, "Missing or invalid checkDigitDocumentNumber")
+       if (checkDigitDateOfBirth == null) Log.d(TAG, "Missing or invalid checkDigitDateOfBirth")
+       if (checkDigitExpiration == null) Log.d(TAG, "Missing or invalid checkDigitExpiration")
    }

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	if (!countryCode.isNullOrEmpty() && !documentNumber.isNullOrEmpty() && !dateOfBirth.isNullOrEmpty() && !expirationDate.isNullOrEmpty() && checkDigitDocumentNumber != null) {
	val cleanDocumentNumber = cleanDocumentNumber(documentNumber, checkDigitDocumentNumber)
	Log.d(TAG, "cleanDocumentNumber")
	if (cleanDocumentNumber != null) {
	val mrzInfo = createDummyMrz("ID", countryCode, documentNumber, dateOfBirth, expirationDate)
	// Log.d(TAG, "MRZ-TD1: $mrzInfo")
	callback.onMRZRead(mrzInfo, timeRequired)
	return
	}
	} else {
	if (countryCode.isNullOrEmpty()) Log.d(TAG, "Missing or invalid countryCode")
	if (documentNumber.isNullOrEmpty()) Log.d(TAG, "Missing or invalid documentNumber")
	if (dateOfBirth.isNullOrEmpty()) Log.d(TAG, "Missing or invalid dateOfBirth")
	if (expirationDate.isNullOrEmpty()) Log.d(TAG, "Missing or invalid expirationDate")
	if (checkDigitDocumentNumber == null) Log.d(TAG, "Missing or invalid checkDigitDocumentNumber")
	}
	}
	if (!countryCode.isNullOrEmpty() && !documentNumber.isNullOrEmpty() &&
	!dateOfBirth.isNullOrEmpty() && !expirationDate.isNullOrEmpty() &&
	!gender.isNullOrEmpty() && checkDigitDocumentNumber != null &&
	checkDigitDateOfBirth != null && checkDigitExpiration != null) {
	// Validate field formats
	if (!countryCode.matches("[A-Z]{3}".toRegex())) {
	Log.d(TAG, "Invalid country code format")
	return
	}
	if (!dateOfBirth.matches("[0-9]{6}".toRegex())) {
	Log.d(TAG, "Invalid date of birth format")
	return
	}
	if (!expirationDate.matches("[0-9]{6}".toRegex())) {
	Log.d(TAG, "Invalid expiration date format")
	return
	}
	val cleanDocumentNumber = cleanDocumentNumber(documentNumber, checkDigitDocumentNumber)
	Log.d(TAG, "cleanDocumentNumber")
	if (cleanDocumentNumber != null) {
	val mrzInfo = createDummyMrz("ID", countryCode, documentNumber, dateOfBirth, expirationDate)
	// Log.d(TAG, "MRZ-TD1: $mrzInfo")
	callback.onMRZRead(mrzInfo, timeRequired)
	return
	}
	} else {
	if (countryCode.isNullOrEmpty()) Log.d(TAG, "Missing or invalid countryCode")
	if (documentNumber.isNullOrEmpty()) Log.d(TAG, "Missing or invalid documentNumber")
	if (dateOfBirth.isNullOrEmpty()) Log.d(TAG, "Missing or invalid dateOfBirth")
	if (expirationDate.isNullOrEmpty()) Log.d(TAG, "Missing or invalid expirationDate")
	if (gender.isNullOrEmpty()) Log.d(TAG, "Missing or invalid gender")
	if (checkDigitDocumentNumber == null) Log.d(TAG, "Missing or invalid checkDigitDocumentNumber")
	if (checkDigitDateOfBirth == null) Log.d(TAG, "Missing or invalid checkDigitDateOfBirth")
	if (checkDigitExpiration == null) Log.d(TAG, "Missing or invalid checkDigitExpiration")
	}

🤖 Prompt for AI Agents

In
app/android/android-passport-reader/app/src/main/java/example/jllarraz/com/passportreader/utils/OcrUtils.kt
around lines 92 to 108, the current validation only checks a subset of fields
for null or emptiness. To improve data integrity and security, extend the
validation to include all relevant fields such as names, nationality, sex, and
document type, verifying their presence and format where applicable. Add
corresponding log statements for each additional field that fails validation to
aid debugging and ensure completeness before proceeding.

[transphorm]

my passport scanned fine during testing and i was able to complete the flow