- Created personal_id_credential table #3199

jaypanchal-13 · 2025-06-13T12:52:43Z

Created personal_id_credential table
Added migration
Upgraded db
Ticket -> https://dimagi.atlassian.net/browse/CCCT-1336

Product Description

Technical Summary

Feature Flag

Safety Assurance

Safety story

Automated test coverage

QA Plan

Labels and Review

Do we need to enhance the manual QA test coverage ? If yes, the "QA Note" label is set correctly
Does the PR introduce any major changes worth communicating ? If yes, the "Release Note" label is set and a "Release Note" is specified in PR description.
Risk label is set correctly
The set of people pinged as reviewers is appropriate for the level of risk of the change

- Added migration

coderabbitai · 2025-06-13T12:55:17Z

📝 Walkthrough

Walkthrough

A new database model class, PersonalIdCredential, was introduced to represent records in a new personal_id_credential table. This class includes fields for app name, slug, type, issued date, title, and credential, along with corresponding constructors, getters, setters, and a static method to parse instances from JSON. The database schema was updated: the version constant was incremented from 15 to 16, and logic was added to create the new table during database creation and upgrade. Upgrade logic for version 15 to 16 was implemented to add the new table.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant DatabaseOpenHelper
    participant Database
    participant PersonalIdCredential

    App->>DatabaseOpenHelper: onCreate(SQLiteDatabase db)
    DatabaseOpenHelper->>Database: Execute SQL to create tables
    DatabaseOpenHelper->>Database: Create PersonalIdCredential table

    App->>DatabaseOpenHelper: onUpgrade(db, oldVersion=15, newVersion=16)
    DatabaseOpenHelper->>Database: upgradeFifteenSixteen(db)
    DatabaseOpenHelper->>Database: Add PersonalIdCredential table

    App->>PersonalIdCredential: fromJson(JSONArray)
    PersonalIdCredential->>PersonalIdCredential: Parse JSON, create instances

Suggested reviewers

pm-dimagi
Jignesh-dimagi

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate Unit Tests

Create PR with Unit Tests
Commit Unit Tests in branch CCCT-1336-create-credential-table
Post Copyable Unit Tests in Comment

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

🪧 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 auto-generate unit tests to generate unit tests for 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.

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.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (4)

app/src/org/commcare/models/database/connect/DatabaseConnectOpenHelper.java (1)

54-57: Document missing V.15 entry for historical clarity

The changelog jumps from V.14 to V.16. Even if V.15 contained no schema change, leaving a placeholder entry keeps the version history unambiguous for future maintainers.
app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java (3)
18-21: Add serialVersionUID to maintain serialization compatibility

Serializable classes should declare an explicit private static final long serialVersionUID to avoid unexpected InvalidClassException if the class shape changes.
 public class PersonalIdCredential extends Persisted implements Serializable {
+    private static final long serialVersionUID = 1L;
22-28: Reuse defined meta constants when parsing JSON

The key strings are duplicated later in fromJson. Referencing the existing META_* constants prevents drift if a column name ever changes.
-                credential.setAppName(obj.optString("app_name"));
-                credential.setSlug(obj.optString("slug"));
-                credential.setType(obj.optString("type"));
-                credential.setIssuedDate(obj.optString("issued_date"));
-                credential.setTitle(obj.optString("title"));
-                credential.setCredential(obj.optString("credential"));
+                credential.setAppName(obj.optString(META_APP_NAME));
+                credential.setSlug(obj.optString(META_SLUG));
+                credential.setType(obj.optString(META_TYPE));
+                credential.setIssuedDate(obj.optString(META_ISSUED_DATE));
+                credential.setTitle(obj.optString(META_TITLE));
+                credential.setCredential(obj.optString(META_CREDENTIAL));
95-97: Replace printStackTrace with structured logging

printStackTrace can flood logcat in production and bypass existing crash reporting. Use CrashUtil.log(e) (or the project’s preferred logger) instead.
-            } catch (JSONException e) {
-                e.printStackTrace();
+            } catch (JSONException e) {
+                CrashUtil.log(e);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 443f9c3 and c77970d.

📒 Files selected for processing (3)

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java (1 hunks)
app/src/org/commcare/models/database/connect/ConnectDatabaseUpgrader.java (3 hunks)
app/src/org/commcare/models/database/connect/DatabaseConnectOpenHelper.java (3 hunks)

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

GitHub Check: Lint Code Base

🔇 Additional comments (2)

app/src/org/commcare/models/database/connect/DatabaseConnectOpenHelper.java (1)

134-136: Table creation looks correct

The new TableBuilder(PersonalIdCredential.class) invocation cleanly integrates the table into fresh installs. No further action required.

app/src/org/commcare/models/database/connect/ConnectDatabaseUpgrader.java (1)

117-120: Sequential upgrade path intact

The additional branch for oldVersion == 15 maintains the one-step-at-a-time upgrade contract used throughout the class. Good consistency.

coderabbitai · 2025-06-13T12:55:20Z

app/src/org/commcare/models/database/connect/ConnectDatabaseUpgrader.java

+    private void upgradeFifteenSixteen(SQLiteDatabase db) {
+        addTableForNewModel(db, PersonalIdCredential.STORAGE_KEY, new PersonalIdCredential());
+    }


🛠️ Refactor suggestion

Consider explicit logging / idempotency guard

addTableForNewModel is wrapped in a transaction, but if the upgrade is accidentally re-run (for example after a partially-applied migration) the CREATE TABLE will throw.
Adding a IF NOT EXISTS in TableBuilder#getTableCreateString() or catching the specific exception here would make the upgrade idempotent and safer on retry.

🤖 Prompt for AI Agents

In app/src/org/commcare/models/database/connect/ConnectDatabaseUpgrader.java around lines 592 to 594, the upgrade method calls addTableForNewModel which attempts to create a table but does not handle the case where the table already exists, causing an exception if the upgrade is retried. To fix this, modify the table creation logic in TableBuilder#getTableCreateString() to include "IF NOT EXISTS" in the CREATE TABLE statement or catch the specific exception thrown when the table exists in upgradeFifteenSixteen and handle it gracefully to make the upgrade idempotent and safe to rerun.

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java

…edential-table

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java

shubham1g5

Nothing blocking, but would be good to correct nomenclature here.

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java

shubham1g5 · 2025-06-17T06:17:29Z

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java

+
+    @Persisting(2)
+    @MetaField(META_SLUG)
+    private String slug;


left a comment on spec reg. the nomenclature here.

@shubham1g5 Renamed to app_id as of now

shubham1g5 · 2025-06-17T12:39:06Z

@jaypanchal-13 Seems like FormStorageTest is failing at the moment and we need to add the new model class in this list

jaypanchal-13 · 2025-06-17T12:52:29Z

@jaypanchal-13 Seems like FormStorageTest is failing at the moment and we need to add the new model class in this list

@shubham1g5 added

shubham1g5 · 2025-06-17T13:53:56Z

app/unit-tests/src/org/commcare/android/tests/processing/FormStorageTest.java

            , "org.commcare.android.database.global.models.GlobalErrorRecord"

            ,"org.commcare.android.database.connect.models.ConnectUserRecordV14"
+            ,"org.commcare.android.database.connect.models.PersonalIdCredential"


can we add a comment above this line saying //Added in 2.58 similar to other version comments above

- Created personal_id_credential table

c77970d

- Added migration

jaypanchal-13 requested review from Jignesh-dimagi, OrangeAndGreen, pm-dimagi and shubham1g5 June 13, 2025 12:52

jaypanchal-13 added the skip-integration-tests Skip android tests. label Jun 13, 2025

coderabbitai bot reviewed Jun 13, 2025

View reviewed changes

Jignesh-dimagi reviewed Jun 13, 2025

View reviewed changes

- Solved comments

60ba471

jaypanchal-13 requested a review from Jignesh-dimagi June 13, 2025 13:58

jaypanchal-13 added 2 commits June 16, 2025 10:12

Merge remote-tracking branch 'origin/master' into CCCT-1336-create-cr…

f41ddb4

…edential-table

Added logic for getting corrupted items

cd74187

Jignesh-dimagi reviewed Jun 16, 2025

View reviewed changes

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java Outdated Show resolved Hide resolved

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java Outdated Show resolved Hide resolved

jaypanchal-13 added 2 commits June 16, 2025 13:14

Added logic for getting corrupted items

b64ed35

Added logic for getting corrupted items

95297b8

jaypanchal-13 requested a review from Jignesh-dimagi June 16, 2025 07:54

Jignesh-dimagi reviewed Jun 16, 2025

View reviewed changes

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java Outdated Show resolved Hide resolved

app/src/org/commcare/android/database/connect/models/PersonalIdCredential.java Outdated Show resolved Hide resolved

Added logic for handling valid and corrupt list together

9680745

jaypanchal-13 requested a review from Jignesh-dimagi June 16, 2025 12:41

Jignesh-dimagi previously approved these changes Jun 17, 2025

View reviewed changes

shubham1g5 reviewed Jun 17, 2025

View reviewed changes

Renamed table name and slug field

5f48d33

jaypanchal-13 dismissed Jignesh-dimagi’s stale review via 5f48d33 June 17, 2025 09:35

jaypanchal-13 requested a review from shubham1g5 June 17, 2025 12:33

Added model in list of FormStorageTest.java

98f125a

shubham1g5 reviewed Jun 17, 2025

View reviewed changes

Added comment

2328928

jaypanchal-13 requested a review from shubham1g5 June 17, 2025 13:57

shubham1g5 approved these changes Jun 17, 2025

View reviewed changes

jaypanchal-13 merged commit 491f498 into master Jun 18, 2025
5 of 7 checks passed

coderabbitai bot mentioned this pull request Jun 18, 2025

Api call for credentials and insert data in table #3202

Closed

4 tasks

coderabbitai bot mentioned this pull request Aug 18, 2025

Created table's for push notification history #3301

Merged

4 tasks

This was referenced Sep 17, 2025

Fixes Connect DB upgrade #3345

Merged

Rename Credential to work history #3344

Merged

coderabbitai bot mentioned this pull request Sep 26, 2025

Commcare 2.59 backmerge #3350

Merged

Uh oh!

- Created personal_id_credential table #3199

- Created personal_id_credential table #3199

Uh oh!

Conversation

jaypanchal-13 commented Jun 13, 2025

Product Description

Technical Summary

Feature Flag

Safety Assurance

Safety story

Automated test coverage

QA Plan

Labels and Review

Uh oh!

coderabbitai bot commented Jun 13, 2025

Walkthrough

Sequence Diagram(s)

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shubham1g5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shubham1g5 Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

jaypanchal-13 Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

shubham1g5 commented Jun 17, 2025

Uh oh!

jaypanchal-13 commented Jun 17, 2025

Uh oh!

shubham1g5 Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

CodeRabbit Configuration File (`.coderabbit.yaml`)