Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add not-null constraint for column trackedentitytypeid in trackedentity table [DHIS2-15066] #19112

Open
wants to merge 28 commits into
base: master
Choose a base branch
from

Conversation

zubaira
Copy link
Contributor

@zubaira zubaira commented Nov 9, 2024

DHIS2-15066

  • PR checks for NULL values in the trackedentitytypeid column of the trackedentity table, updates missing values based on the programid from the enrollment table, and then safely alters the column to NOT NULL if no inconsistencies are found.
  • Moreover it changes createTrackedEntity method signature in TestBase.java to make sure user provide a non-null TrackedEntityType to TrackedEntity.

@zubaira zubaira marked this pull request as ready for review November 19, 2024 08:35
@zubaira zubaira requested a review from a team as a code owner November 19, 2024 08:35
@zubaira zubaira changed the title feat: Add not-null constraint for column trackedentitytypeid in trackedentity table [DHIS2-15066] feat: [WIP] Add not-null constraint for column trackedentitytypeid in trackedentity table [DHIS2-15066] Nov 20, 2024
@zubaira zubaira changed the title feat: [WIP] Add not-null constraint for column trackedentitytypeid in trackedentity table [DHIS2-15066] feat: Add not-null constraint for column trackedentitytypeid in trackedentity table [DHIS2-15066] Nov 21, 2024
Copy link
Contributor

@enricocolasante enricocolasante left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are having discussion about the approach here (that is the same for organisationunitid column in event and enrollment) and we are trying to avoid to create dummy data that are likely entering the DB and never being deleted.

I think we should fix this the same way in all the places where we found it.
As soon as we have a strategy we should go back to this PR and see what we should do.

Comment on lines 163 to 164
femaleA.setTrackedEntityType(trackedEntityType);
femaleB.setTrackedEntityType(trackedEntityType);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setTrackedEntityType

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -311,7 +312,8 @@ private TrackedEntity teWithDeleteEnrollments() {
Enrollment enrollment = new Enrollment();
enrollment.setDeleted(true);

TrackedEntity trackedEntity = createTrackedEntity(organisationUnit);
TrackedEntity trackedEntity =
createTrackedEntity(organisationUnit, createTrackedEntityType('B'));
trackedEntity.setUid(TE_ID.getValue());
trackedEntity.setEnrollments(Sets.newHashSet(enrollment));
trackedEntity.setTrackedEntityType(trackedEntityType);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setTrackedEntityType

@@ -389,7 +389,8 @@ void verifyValidationFailsForEnrollmentDeletionAndUserWithoutTrackedEntityTypeRe
}

private TrackedEntity teWithNoEnrollments() {
TrackedEntity trackedEntity = createTrackedEntity(organisationUnit);
TrackedEntity trackedEntity =
createTrackedEntity(organisationUnit, createTrackedEntityType('C'));
trackedEntity.setUid(TE_ID.getValue());
trackedEntity.setEnrollments(Sets.newHashSet());
trackedEntity.setTrackedEntityType(trackedEntityType);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setTrackedEntityType

@@ -263,7 +263,7 @@ private TrackedEntityType trackedEntityType(String uid, char uniqueChar) {
}

private TrackedEntity trackedEntity(UID uid, TrackedEntityType type, OrganisationUnit orgUnit) {
TrackedEntity te = createTrackedEntity(orgUnit);
TrackedEntity te = createTrackedEntity(orgUnit, createTrackedEntityType('R'));
te.setUid(uid.getValue());
te.setTrackedEntityType(type);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setTrackedEntityType

WHERE trackedentitytypeid IS NULL
)
LOOP
UPDATE trackedentity
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we shouldn't update any record.
We should only apply the constraint.
The we can suggest such a script in the migration notes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is a lower possibility of errors if we handle the task ourselves rather than leaving it to the user. Therefore, we should aim to complete as much of the migration process as possible and leave as little as necessary for the user to manage.

Comment on lines 28 to 32
SELECT COUNT(*) INTO inconsistent_records_count FROM trackedentity WHERE trackedentitytypeid IS NULL;

IF inconsistent_records_count = 0 THEN
ALTER TABLE trackedentity ALTER COLUMN trackedentitytypeid SET NOT NULL;
ELSE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This logic is a little bit redundant.
You can apply the constraint and if it fails then you raise the exception.

@ameenhere
Copy link
Contributor

Before we merge this, can we make sure we update the dev db snapshot to have this "fixing scripts" run? So that we don't break dev again for Phil to fix later.

Copy link

sonarcloud bot commented Dec 6, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants