Merge pull request #157 from DTS-STN/ken/flag-hide-manifest

Add feature-flag for hiding manifest numbers

Author: stefan-oconnell

src/main/java/ca/gov/dtsstn/passport/api/config/properties/ApplicationProperties.java

@@ -11,12 +11,14 @@
 @Validated
 @ConfigurationProperties("application")
 @EnableConfigurationProperties({
+	FeatureFlagsProperties.class,
 	GcNotifyProperties.class,
 	JmsProperties.class,
 	SecurityProperties.class,
 	SwaggerUiProperties.class
 })
 public record ApplicationProperties(
+	@NestedConfigurationProperty FeatureFlagsProperties featureFlags,
 	@NestedConfigurationProperty GcNotifyProperties gcnotify,
 	@NestedConfigurationProperty JmsProperties jms,
 	@NestedConfigurationProperty SecurityProperties security,

src/main/java/ca/gov/dtsstn/passport/api/config/properties/FeatureFlagsProperties.java

@@ -0,0 +1,21 @@
+package ca.gov.dtsstn.passport.api.config.properties;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+import java.util.List;
+
+/**
+ * @author Ken Blanchard ([email protected])
+ */
+@ConfigurationProperties("application.feature-flags")
+public class FeatureFlagsProperties {
+	private List<String> hiddenManifests = List.of();
+
+  public List<String> getHiddenManifests() {
+      return hiddenManifests;
+  }
+
+  public void setHiddenManifests(List<String> list) {
+      this.hiddenManifests = list;
+  }
+}

src/main/java/ca/gov/dtsstn/passport/api/config/properties/HideManifestProperties.java

@@ -0,0 +1,25 @@
+package ca.gov.dtsstn.passport.api.config.properties;
+
+import java.util.Map;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * Configuration properties for hiding the manifest numbers from client/public view.
+ * 
+ * Mapping of status code to boolean value.
+ *
+ * @author Ken Blanchard ([email protected])
+ */
+@ConfigurationProperties("application.feature-flags.hide-manifest")
+public class HideManifestProperties {
+  private Map<String, Boolean> map;
+
+  public Map<String, Boolean> getMap() {
+      return map;
+  }
+
+  public void setMap(Map<String, Boolean> map) {
+      this.map = map;
+  }
+}

src/main/java/ca/gov/dtsstn/passport/api/data/entity/StatusCodeEntity.java

@@ -16,7 +16,7 @@
 @Entity(name = "StatusCode")
 public class StatusCodeEntity extends AbstractEntity {
 
-	@Column(length = 16, nullable = false)
+	@Column(length = 64, nullable = false)
 	private String code;
 
 	@Column(length = 8, nullable = false)

src/main/java/ca/gov/dtsstn/passport/api/web/model/mapper/CertificateApplicationModelMapper.java

@@ -18,6 +18,7 @@
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
+import ca.gov.dtsstn.passport.api.config.properties.FeatureFlagsProperties;
 import ca.gov.dtsstn.passport.api.service.SourceCodeService;
 import ca.gov.dtsstn.passport.api.service.StatusCodeService;
 import ca.gov.dtsstn.passport.api.service.domain.PassportStatus;
@@ -38,6 +39,9 @@
 @Mapper(componentModel = "spring")
 public abstract class CertificateApplicationModelMapper {
 
+	@Autowired
+	private FeatureFlagsProperties featureFlagsProperties;
+
 	@Autowired
 	protected SourceCodeService sourceCodeService;
 
@@ -162,6 +166,8 @@ protected String findApplicationRegisterSid(@Nullable Iterable<CertificateApplic
 	protected List<CertificateApplicationIdentificationModel> getCertificateApplicationIdentifications(@Nullable PassportStatus passportStatus) {
 		if (passportStatus == null) { return null; }
 
+    boolean displayManifest = !isStatusManifestHidden(passportStatus);
+
 		final CertificateApplicationIdentificationModel applicationRegisterSid = Optional.ofNullable(passportStatus.getApplicationRegisterSid())
 			.map(xxx -> ImmutableCertificateApplicationIdentificationModel.builder()
 				.identificationCategoryText(CertificateApplicationIdentificationModel.APPLICATION_REGISTER_SID_CATEGORY_TEXT)
@@ -177,15 +183,27 @@ protected List<CertificateApplicationIdentificationModel> getCertificateApplicat
 			.orElse(null);
 
 		final CertificateApplicationIdentificationModel manifestNumber = Optional.ofNullable(passportStatus.getManifestNumber())
-			.map(xxx -> ImmutableCertificateApplicationIdentificationModel.builder()
-				.identificationCategoryText(CertificateApplicationIdentificationModel.MANIFEST_NUMBER_CATEGORY_TEXT)
-				.identificationId(passportStatus.getManifestNumber())
-				.build())
-			.orElse(null);
+          .filter(xxx -> displayManifest)
+					.map(xxx -> ImmutableCertificateApplicationIdentificationModel.builder()
+						.identificationCategoryText(CertificateApplicationIdentificationModel.MANIFEST_NUMBER_CATEGORY_TEXT)
+						.identificationId(passportStatus.getManifestNumber())
+						.build())
+					.orElse(null);
 
 		return Stream.of(applicationRegisterSid, fileNumber, manifestNumber).filter(Objects::nonNull).toList();
 	}
 
+	private boolean isStatusManifestHidden(@Nullable PassportStatus passportStatus) {
+		return Optional.ofNullable(passportStatus)
+				.map(PassportStatus::getStatusCodeId)
+				.flatMap(statusCodeService::read)
+				.map(StatusCode::getCode)
+				.map(code -> {
+					return featureFlagsProperties.getHiddenManifests().contains(code);
+				})
+        .orElse(false);
+	}
+
 	@Nullable
 	@Named("getPersonGivenNames")
 	protected List<String> getPersonGivenNames(@Nullable PassportStatus passportStatus) {

src/main/resources/application-local.yaml.sample

@@ -25,6 +25,9 @@ spring:
 application:
   database-initializer:
     run-on-startup: true
+  feature-flags:
+    # List of statuses, whose manifests should not be sent to the client.
+    hidden-manifests: ['PASSPORT_ISSUED_SHIPPING_CANADA_POST'] 
   gcnotify:
     english-api-key: gcntfy-project-00000000-0000-0000-0000-000000000000-00000000-0000-0000-0000-000000000000
     french-api-key: gcntfy-project-00000000-0000-0000-0000-000000000000-00000000-0000-0000-0000-000000000000
@@ -36,4 +39,4 @@ application:
   security:
     oauth:
       client-id: 2652573b-9b11-4f03-a3b8-eb38f1b00312
-      tenant-id: 9ed55846-8a81-4246-acd8-b1a01abfc0d1
+      tenant-id: 9ed55846-8a81-4246-acd8-b1a01abfc0d1

src/test/java/ca/gov/dtsstn/passport/api/web/model/mapper/CertificateApplicationModelMapperTests.java

@@ -3,6 +3,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
@@ -273,7 +274,7 @@ void testToModel_nonnull() {
 			.extracting(StatusDateModel::getDate)
 			.isEqualTo(statusDate.toString());
 
-		verify(statusCodeService).read(any());
+		verify(statusCodeService, times(2)).read(any());
 	}
 
 	@Test