avniproject/avni-webapp#1304 - moved category and status to database

petmongrels · petmongrels · commit 943f2047af2c · 2024-08-07T13:44:01.000+05:30
diff --git a/avni-server-api/src/main/java/org/avni/server/dao/OrganisationCategoryRepository.java b/avni-server-api/src/main/java/org/avni/server/dao/OrganisationCategoryRepository.java
@@ -0,0 +1,16 @@
+package org.avni.server.dao;
+
+import org.avni.server.domain.organisation.OrganisationCategory;
+import org.springframework.data.repository.query.Param;
+import org.springframework.data.rest.core.annotation.RepositoryRestResource;
+import org.springframework.data.rest.core.annotation.RestResource;
+import org.springframework.stereotype.Repository;
+
+import java.util.List;
+
+@Repository
+@RepositoryRestResource(collectionResourceRel = "organisationCategory", path = "organisationCategory")
+public interface OrganisationCategoryRepository extends AvniJpaRepository<OrganisationCategory, Long>, CHSRepository<OrganisationCategory> {
+    @RestResource(path = "findAllById", rel = "findAllById")
+    List<OrganisationCategory> findByIdIn(@Param("ids") Long[] ids);
+}
diff --git a/avni-server-api/src/main/java/org/avni/server/dao/OrganisationStatusRepository.java b/avni-server-api/src/main/java/org/avni/server/dao/OrganisationStatusRepository.java
@@ -0,0 +1,16 @@
+package org.avni.server.dao;
+
+import org.avni.server.domain.organisation.OrganisationStatus;
+import org.springframework.data.repository.query.Param;
+import org.springframework.data.rest.core.annotation.RepositoryRestResource;
+import org.springframework.data.rest.core.annotation.RestResource;
+import org.springframework.stereotype.Repository;
+
+import java.util.List;
+
+@Repository
+@RepositoryRestResource(collectionResourceRel = "organisationStatus", path = "organisationStatus")
+public interface OrganisationStatusRepository extends AvniJpaRepository<OrganisationStatus, Long>, CHSRepository<OrganisationStatus> {
+    @RestResource(path = "findAllById", rel = "findAllById")
+    List<OrganisationStatus> findByIdIn(@Param("ids") Long[] ids);
+}
diff --git a/avni-server-api/src/main/java/org/avni/server/domain/Organisation.java b/avni-server-api/src/main/java/org/avni/server/domain/Organisation.java
@@ -26,11 +26,11 @@ public class Organisation extends ETLEntity {
     private Account account;
 
     @NotNull
-    @Enumerated(EnumType.STRING)
+    @ManyToOne(fetch = FetchType.EAGER)
     private OrganisationCategory category;
 
     @NotNull
-    @Enumerated(EnumType.STRING)
+    @ManyToOne(fetch = FetchType.EAGER)
     private OrganisationStatus status;
 
     public Organisation() {
@@ -86,19 +86,29 @@ public String getEffectiveUsernameSuffix() {
         return usernameSuffix == null ? getDbUser() : usernameSuffix;
     }
 
+    @JsonIgnore
     public OrganisationCategory getCategory() {
         return category;
     }
 
+    public Long getCategoryId() {
+        return category.getId();
+    }
+
     public void setCategory(OrganisationCategory organisationCategory) {
         this.category = organisationCategory;
     }
 
+    @JsonIgnore
     public OrganisationStatus getStatus() {
         return status;
     }
 
     public void setStatus(OrganisationStatus status) {
         this.status = status;
     }
+
+    public Long getStatusId() {
+        return status.getId();
+    }
 }
diff --git a/avni-server-api/src/main/java/org/avni/server/domain/organisation/OrganisationCategory.java b/avni-server-api/src/main/java/org/avni/server/domain/organisation/OrganisationCategory.java
@@ -1,5 +1,19 @@
 package org.avni.server.domain.organisation;
 
-public enum OrganisationCategory {
-    Production, UAT, Prototype, Temporary, Trial
+import org.avni.server.domain.CHSEntity;
+
+import javax.persistence.Entity;
+
+@Entity
+public class OrganisationCategory extends CHSEntity {
+    public static final String Production = "Production";
+    private String name;
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
 }
diff --git a/avni-server-api/src/main/java/org/avni/server/domain/organisation/OrganisationStatus.java b/avni-server-api/src/main/java/org/avni/server/domain/organisation/OrganisationStatus.java
@@ -1,5 +1,18 @@
 package org.avni.server.domain.organisation;
 
-public enum OrganisationStatus {
-    Archived, Live
+import org.avni.server.domain.CHSEntity;
+
+import javax.persistence.Entity;
+
+@Entity
+public class OrganisationStatus extends CHSEntity {
+    private String name;
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
 }
diff --git a/avni-server-api/src/main/java/org/avni/server/framework/rest/RepositoryConfig.java b/avni-server-api/src/main/java/org/avni/server/framework/rest/RepositoryConfig.java
@@ -3,6 +3,8 @@
 import org.avni.server.domain.*;
 import org.avni.server.domain.accessControl.GroupPrivilege;
 import org.avni.server.domain.accessControl.Privilege;
+import org.avni.server.domain.organisation.OrganisationCategory;
+import org.avni.server.domain.organisation.OrganisationStatus;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.data.rest.webmvc.config.RepositoryRestConfigurerAdapter;
@@ -37,6 +39,8 @@ public void configureRepositoryRestConfiguration(RepositoryRestConfiguration con
         config.exposeIdsFor(CommentThread.class);
         config.exposeIdsFor(RuleFailureTelemetry.class);
         config.exposeIdsFor(Individual.class);
+        config.exposeIdsFor(OrganisationCategory.class);
+        config.exposeIdsFor(OrganisationStatus.class);
 
         //TODO
         /**
diff --git a/avni-server-api/src/main/java/org/avni/server/web/ImplementationController.java b/avni-server-api/src/main/java/org/avni/server/web/ImplementationController.java
@@ -109,7 +109,7 @@ public ResponseEntity delete(@Param("deleteMetadata") boolean deleteMetadata) {
             return new ResponseEntity<>("Super admin cannot delete implementation data", HttpStatus.FORBIDDEN);
         }
         Organisation organisation = organisationService.getCurrentOrganisation();
-        if (OrganisationCategory.Production.equals(organisation.getCategory())) {
+        if (OrganisationCategory.Production.equals(organisation.getCategory().getName())) {
             return new ResponseEntity<>("Production organisation's data cannot be deleted", HttpStatus.CONFLICT);
         }
 
diff --git a/avni-server-api/src/main/java/org/avni/server/web/OrganisationController.java b/avni-server-api/src/main/java/org/avni/server/web/OrganisationController.java
@@ -26,14 +26,18 @@ public class OrganisationController implements RestControllerResourceProcessor<O
     private final ImplementationRepository implementationRepository;
     private final AccessControlService accessControlService;
     private final OrganisationService organisationService;
+    private final OrganisationCategoryRepository organisationCategoryRepository;
+    private final OrganisationStatusRepository organisationStatusRepository;
 
     @Autowired
-    public OrganisationController(OrganisationRepository organisationRepository, AccountRepository accountRepository, ImplementationRepository implementationRepository, AccessControlService accessControlService, OrganisationService organisationService) {
+    public OrganisationController(OrganisationRepository organisationRepository, AccountRepository accountRepository, ImplementationRepository implementationRepository, AccessControlService accessControlService, OrganisationService organisationService, OrganisationCategoryRepository organisationCategoryRepository, OrganisationStatusRepository organisationStatusRepository) {
         this.organisationRepository = organisationRepository;
         this.accountRepository = accountRepository;
         this.implementationRepository = implementationRepository;
         this.accessControlService = accessControlService;
         this.organisationService = organisationService;
+        this.organisationCategoryRepository = organisationCategoryRepository;
+        this.organisationStatusRepository = organisationStatusRepository;
     }
 
     @RequestMapping(value = "/organisation", method = RequestMethod.POST)
@@ -50,8 +54,8 @@ public ResponseEntity save(@RequestBody OrganisationContract request) {
         org.setUuid(request.getUuid() == null ? UUID.randomUUID().toString() : request.getUuid());
         org.setDbUser(request.getDbUser());
         org.setSchemaName(request.getSchemaName());
-        org.setCategory(request.getCategory());
-        org.setStatus(request.getStatus());
+        org.setCategory(organisationCategoryRepository.findEntity(request.getCategoryId()));
+        org.setStatus(organisationStatusRepository.findEntity(request.getStatusId()));
         setAttributesOnOrganisation(request, org);
         setOrgAccountByIdOrDefault(org, request.getAccountId());
 
@@ -136,8 +140,8 @@ private void setAttributesOnOrganisation(@RequestBody OrganisationContract reque
         }
         organisation.setMediaDirectory(request.getMediaDirectory());
         organisation.setVoided(request.isVoided());
-        organisation.setCategory(request.getCategory());
-        organisation.setStatus(request.getStatus());
+        organisation.setCategory(organisationCategoryRepository.findEntity(request.getCategoryId()));
+        organisation.setStatus(organisationStatusRepository.findEntity(request.getStatusId()));
     }
 
     private void setOrgAccountByIdOrDefault(Organisation organisation, Long accountId) {
diff --git a/avni-server-api/src/main/java/org/avni/server/web/request/OrganisationContract.java b/avni-server-api/src/main/java/org/avni/server/web/request/OrganisationContract.java
@@ -9,8 +9,8 @@ public class OrganisationContract extends ETLContract {
     private String mediaDirectory;
     private String usernameSuffix;
     private Long accountId;
-    private OrganisationCategory category;
-    private OrganisationStatus status;
+    private Long categoryId;
+    private Long statusId;
 
     public static OrganisationContract fromEntity(Organisation organisation) {
         OrganisationContract organisationContract = new OrganisationContract();
@@ -20,12 +20,20 @@ public static OrganisationContract fromEntity(Organisation organisation) {
         organisationContract.setMediaDirectory(organisation.getMediaDirectory());
         organisationContract.setUsernameSuffix(organisation.getEffectiveUsernameSuffix());
         organisationContract.setAccountId(organisation.getAccount() == null ? null : organisation.getAccount().getId());
-        organisationContract.setCategory(organisation.getCategory());
-        organisationContract.setStatus(organisation.getStatus());
+        organisationContract.setCategoryId(organisation.getCategory().getId());
+        organisationContract.setStatusId(organisation.getStatus().getId());
         mapEntity(organisationContract, organisation);
         return organisationContract;
     }
 
+    private void setStatusId(Long id) {
+        this.statusId = id;
+    }
+
+    private void setCategoryId(Long id) {
+        this.categoryId = id;
+    }
+
     public Long getParentOrganisationId() {
         return parentOrganisationId;
     }
@@ -58,19 +66,11 @@ public void setMediaDirectory(String mediaDirectory) {
         this.mediaDirectory = mediaDirectory;
     }
 
-    public OrganisationCategory getCategory() {
-        return category;
-    }
-
-    public void setCategory(OrganisationCategory category) {
-        this.category = category;
-    }
-
-    public OrganisationStatus getStatus() {
-        return status;
+    public Long getCategoryId() {
+        return categoryId;
     }
 
-    public void setStatus(OrganisationStatus status) {
-        this.status = status;
+    public Long getStatusId() {
+        return statusId;
     }
 }
diff --git a/avni-server-api/src/main/java/org/avni/server/web/response/UserInfoWebResponse.java b/avni-server-api/src/main/java/org/avni/server/web/response/UserInfoWebResponse.java
@@ -9,11 +9,11 @@
 import java.util.List;
 
 public class UserInfoWebResponse extends UserInfoContract {
-    private OrganisationCategory organisationCategory;
     private long lastSessionTime;
     private boolean hasAllPrivileges;
     private List<UserPrivilegeWebResponse> privileges;
     private boolean isAdmin;
+    private String organisationCategoryName;
 
     private UserInfoWebResponse() {
     }
@@ -29,7 +29,7 @@ public static UserInfoWebResponse createForAdminUser(List<UserPrivilegeWebRespon
             response.setOrganisationId(contextOrganisation.getId());
             response.setOrganisationName(contextOrganisation.getName());
             response.setUsernameSuffix(contextOrganisation.getEffectiveUsernameSuffix());
-            response.organisationCategory = contextOrganisation.getCategory();
+            response.organisationCategoryName = contextOrganisation.getCategory().getName();
         }
         return response;
     }
@@ -39,7 +39,7 @@ public UserInfoWebResponse(String username, String orgName, Long orgId, String u
         this.privileges = privileges;
         this.hasAllPrivileges = hasAllPrivileges;
         this.lastSessionTime = lastSessionTime;
-        this.organisationCategory = organisationCategory;
+        this.organisationCategoryName = organisationCategory.getName();
     }
 
     public List<UserPrivilegeWebResponse> getPrivileges() {
@@ -62,7 +62,7 @@ public void setLastSessionTime(long lastSessionTime) {
         this.lastSessionTime = lastSessionTime;
     }
 
-    public OrganisationCategory getOrganisationCategory() {
-        return organisationCategory;
+    public String getOrganisationCategoryName() {
+        return organisationCategoryName;
     }
 }
diff --git a/avni-server-api/src/main/resources/db/migration/V1_339_3__OrgCategoryTable.sql b/avni-server-api/src/main/resources/db/migration/V1_339_3__OrgCategoryTable.sql
@@ -0,0 +1,30 @@
+create table if not exists organisation_category
+(
+    id                      serial primary key,
+    uuid                    varchar(255)                not null,
+    is_voided               boolean                     NOT NULL DEFAULT FALSE,
+    name                    varchar(255)                not null,
+    created_date_time       timestamp(3) with time zone not null,
+    last_modified_date_time timestamp(3) with time zone not null,
+    created_by_id           int                         not null,
+    last_modified_by_id     int                         not null
+);
+
+insert into organisation_category (uuid, name, created_date_time, last_modified_date_time, created_by_id, last_modified_by_id)
+values ('71e1bf3b-48fb-4d4f-90f3-71c39e15fbf0', 'Production', now(), now(), 1, 1),
+       ('95e89458-c152-4557-9929-85f1a275d6a3', 'UAT', now(), now(), 1, 1),
+       ('283af4ea-0024-4440-857f-c8a82328a61d', 'Prototype', now(), now(), 1, 1),
+       ('f0b0a48d-8d4b-4d13-8956-c1bc577b4971', 'Temporary', now(), now(), 1, 1),
+       ('470ecdab-f7be-4336-a52a-1fa280080168', 'Trial', now(), now(), 1, 1),
+       ('d75e667e-b7ea-40dd-8d85-1328943d3b65', 'Training', now(), now(), 1, 1),
+       ('27eeb3e7-2396-45ac-ba50-b1b50690bcfc', 'Dev', now(), now(), 1, 1);
+
+alter table organisation add column if not exists category_id int null;
+
+update organisation set category_id = organisation_category.id
+from organisation_category
+where organisation.category = organisation_category.name;
+
+alter table organisation drop column category;
+
+alter table organisation alter column category_id set not null;
diff --git a/avni-server-api/src/main/resources/db/migration/V1_339_4__OrgStatusTable.sql b/avni-server-api/src/main/resources/db/migration/V1_339_4__OrgStatusTable.sql
@@ -0,0 +1,25 @@
+create table if not exists organisation_status
+(
+    id                      serial primary key,
+    uuid                    varchar(255)                not null,
+    is_voided               boolean                     NOT NULL DEFAULT FALSE,
+    name                    varchar(255)                not null,
+    created_date_time       timestamp(3) with time zone not null,
+    last_modified_date_time timestamp(3) with time zone not null,
+    created_by_id           int                         not null,
+    last_modified_by_id     int                         not null
+);
+
+insert into organisation_status (uuid, name, created_date_time, last_modified_date_time, created_by_id, last_modified_by_id)
+values ('338be2e2-d0e5-4186-b113-b8197ce879c5', 'Live', now(), now(), 1, 1),
+       ('7e609db3-ff79-472c-8f28-5b12933faaf5', 'Archived', now(), now(), 1, 1);
+
+alter table organisation add column if not exists status_id int null;
+
+update organisation set status_id = organisation_status.id
+from organisation_status
+where organisation.status = organisation_status.name;
+
+alter table organisation drop column status;
+
+alter table organisation alter column status_id set not null;
diff --git a/avni-server-api/src/main/resources/db/migration/V1_339_5__AddVersions.sql b/avni-server-api/src/main/resources/db/migration/V1_339_5__AddVersions.sql
@@ -0,0 +1,2 @@
+alter table organisation_category add column if not exists version int not null default 1;
+alter table organisation_status add column if not exists version int not null default 1;
diff --git a/avni-server-api/src/test/java/org/avni/server/domain/factory/TestOrganisationBuilder.java b/avni-server-api/src/test/java/org/avni/server/domain/factory/TestOrganisationBuilder.java
@@ -12,7 +12,7 @@ public class TestOrganisationBuilder {
 
     public TestOrganisationBuilder withMandatoryFields() {
         String placeholder = UUID.randomUUID().toString();
-        return withUuid(placeholder).withDbUser("testDbUser").withName(placeholder).withSchemaName(placeholder).setCategory(OrganisationCategory.Production).withStatus(OrganisationStatus.Live);
+        return withUuid(placeholder).withDbUser("testDbUser").withName(placeholder).withSchemaName(placeholder);
     }
 
     public TestOrganisationBuilder setId(long id) {
diff --git a/avni-server-api/src/test/java/org/avni/server/service/builder/TestDataSetupService.java b/avni-server-api/src/test/java/org/avni/server/service/builder/TestDataSetupService.java
@@ -31,12 +31,20 @@ public class TestDataSetupService {
     private TestLocationService testLocationService;
     @Autowired
     private TestCatchmentService testCatchmentService;
+    @Autowired
+    private OrganisationCategoryRepository organisationCategoryRepository;
+    @Autowired
+    private OrganisationStatusRepository organisationStatusRepository;
 
     public TestOrganisationData setupOrganisation(String orgSuffix) {
         Group group = new TestGroupBuilder().withMandatoryFieldsForNewEntity().build();
         User user1 = new UserBuilder().withDefaultValuesForNewEntity().userName(String.format("user@%s", orgSuffix)).withAuditUser(userRepository.getDefaultSuperAdmin()).build();
         User user2 = new UserBuilder().withDefaultValuesForNewEntity().userName(String.format("user2@%s", orgSuffix)).withAuditUser(userRepository.getDefaultSuperAdmin()).build();
-        Organisation organisation = new TestOrganisationBuilder().withMandatoryFields().withAccount(accountRepository.getDefaultAccount()).build();
+        Organisation organisation = new TestOrganisationBuilder()
+                .setCategory(organisationCategoryRepository.findEntity(1L))
+                .withStatus(organisationStatusRepository.findEntity(1L))
+                .withMandatoryFields()
+                .withAccount(accountRepository.getDefaultAccount()).build();
         testOrganisationService.createOrganisation(organisation, user1);
         testOrganisationService.createUser(organisation, user2);
         userRepository.save(new UserBuilder(user1).withAuditUser(user1).build());
diff --git a/avni-server-api/src/test/java/org/avni/server/service/builder/TestOrganisationSetupService.java b/avni-server-api/src/test/java/org/avni/server/service/builder/TestOrganisationSetupService.java
diff --git a/avni-server-api/src/test/resources/test-data-openchs-organisation.sql b/avni-server-api/src/test/resources/test-data-openchs-organisation.sql
diff --git a/avni-server-api/src/test/resources/test-data.sql b/avni-server-api/src/test/resources/test-data.sql

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ public ResponseEntity delete(@Param("deleteMetadata") boolean deleteMetadata) {`
`109`	`109`	`return new ResponseEntity<>("Super admin cannot delete implementation data", HttpStatus.FORBIDDEN);`
`110`	`110`	`}`
`111`	`111`	`Organisation organisation = organisationService.getCurrentOrganisation();`
`112`		`- if (OrganisationCategory.Production.equals(organisation.getCategory())) {`
	`112`	`+ if (OrganisationCategory.Production.equals(organisation.getCategory().getName())) {`
`113`	`113`	`return new ResponseEntity<>("Production organisation's data cannot be deleted", HttpStatus.CONFLICT);`
`114`	`114`	`}`
`115`	`115`
Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,11 @@`
`9`	`9`	`import java.util.List;`
`10`	`10`
`11`	`11`	`public class UserInfoWebResponse extends UserInfoContract {`
`12`		`- private OrganisationCategory organisationCategory;`
`13`	`12`	`private long lastSessionTime;`
`14`	`13`	`private boolean hasAllPrivileges;`
`15`	`14`	`private List<UserPrivilegeWebResponse> privileges;`
`16`	`15`	`private boolean isAdmin;`
	`16`	`+ private String organisationCategoryName;`
`17`	`17`
`18`	`18`	`private UserInfoWebResponse() {`
`19`	`19`	`}`
`@@ -29,7 +29,7 @@ public static UserInfoWebResponse createForAdminUser(List<UserPrivilegeWebRespon`
`29`	`29`	`response.setOrganisationId(contextOrganisation.getId());`
`30`	`30`	`response.setOrganisationName(contextOrganisation.getName());`
`31`	`31`	`response.setUsernameSuffix(contextOrganisation.getEffectiveUsernameSuffix());`
`32`		`- response.organisationCategory = contextOrganisation.getCategory();`
	`32`	`+ response.organisationCategoryName = contextOrganisation.getCategory().getName();`
`33`	`33`	`}`
`34`	`34`	`return response;`
`35`	`35`	`}`
`@@ -39,7 +39,7 @@ public UserInfoWebResponse(String username, String orgName, Long orgId, String u`
`39`	`39`	`this.privileges = privileges;`
`40`	`40`	`this.hasAllPrivileges = hasAllPrivileges;`
`41`	`41`	`this.lastSessionTime = lastSessionTime;`
`42`		`- this.organisationCategory = organisationCategory;`
	`42`	`+ this.organisationCategoryName = organisationCategory.getName();`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`public List<UserPrivilegeWebResponse> getPrivileges() {`
`@@ -62,7 +62,7 @@ public void setLastSessionTime(long lastSessionTime) {`
`62`	`62`	`this.lastSessionTime = lastSessionTime;`
`63`	`63`	`}`
`64`	`64`
`65`		`- public OrganisationCategory getOrganisationCategory() {`
`66`		`- return organisationCategory;`
	`65`	`+ public String getOrganisationCategoryName() {`
	`66`	`+ return organisationCategoryName;`
`67`	`67`	`}`
`68`	`68`	`}`