Use TylerEnv on all parsing boundaries (#296)

I.e., anytime we read the env var, immediately turn it into the enum.
Throws a quick `IllegalArgumentExeception` at those points, so the
server should immediately stop if invalid.

* also exposes the hack that the JSON parser depends on if Tyler's env
is stage or prod. This is something that we still need to resolve
elsewhere, but at least we aren't grabbing env vars deep inside that
class anymore.

The only place that could have had more refactorings but didn't was
`SoapClientChooser`. Could have introduced a String jurisdiction
TylerEnv object to handle the mappings instead of a single string, but I
would have had to retype all of the jurisdiction keys, which would have
meant potential unnecessary errors.

A second attempt at #293, which got too big (had tried to include
jurisdiction to fix the `SoapClientChooser` as described above, but
jurisdiction has a much larger footprint, and needs to handle non-Tyler
jurisdictions as well, becomes dependent on deprecating JeffNet code,
etc.).

Fix #283.

Author: BryceStevenWilley

TylerEfmClient/src/main/java/edu/suffolk/litlab/efsp/tyler/TylerEnv.java

@@ -7,23 +7,28 @@ public enum TylerEnv {
   /// to "deploy patches and new releases prior to introduction into" PROD
   STAGE("stage");
 
-  private String path;
+  private String name;
 
-  private TylerEnv(String path) {
-    this.path = path;
+  private TylerEnv(String name) {
+    this.name = name;
   }
 
+  // ** Used for when the env determines a URL / filepath. */
   public String getPath() {
-    return path;
+    return name;
+  }
+
+  public String getName() {
+    return name;
   }
 
   public static TylerEnv parse(String value) {
-    if (value.equalsIgnoreCase(STAGE.getPath())) {
+    if (value.equalsIgnoreCase(STAGE.getName())) {
       return STAGE;
-    } else if (value.equalsIgnoreCase(PROD.getPath())) {
+    } else if (value.equalsIgnoreCase(PROD.getName())) {
       return PROD;
     } else {
-      throw new IllegalArgumentException("Can't make a `TylerEnv` from: " + value);
+      throw new IllegalArgumentException("Can't make a `TylerEnv` from: `" + value + "`'");
     }
   }
 }

proxyserver/src/main/java/edu/suffolk/litlab/efsp/docassemble/DocassembleToFilingInformationConverter.java

@@ -5,27 +5,34 @@
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.hubspot.algebra.Result;
 import edu.suffolk.litlab.efsp.model.FilingInformation;
+import edu.suffolk.litlab.efsp.tyler.TylerEnv;
 import edu.suffolk.litlab.efsp.utils.FilingError;
 import edu.suffolk.litlab.efsp.utils.InfoCollector;
 import edu.suffolk.litlab.efsp.utils.InterviewToFilingInformationConverter;
 import java.io.InputStream;
+import java.util.Optional;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public class DocassembleToFilingInformationConverter extends InterviewToFilingInformationConverter {
 
   private static Logger log =
       LoggerFactory.getLogger(DocassembleToFilingInformationConverter.class);
+  private final Optional<TylerEnv> tylerEnv;
 
-  public DocassembleToFilingInformationConverter(InputStream taxonomyCsv) {}
+  public DocassembleToFilingInformationConverter(
+      InputStream taxonomyCsv, Optional<TylerEnv> tylerEnv) {
+    this.tylerEnv = tylerEnv;
+  }
 
   @Override
   public Result<FilingInformation, FilingError> traverseInterview(
       String interviewContents, InfoCollector collector) {
     SimpleModule module = new SimpleModule();
     module.addDeserializer(
         FilingInformation.class,
-        new FilingInformationDocassembleJacksonDeserializer(FilingInformation.class, collector));
+        new FilingInformationDocassembleJacksonDeserializer(
+            FilingInformation.class, collector, tylerEnv));
     ObjectMapper mapper = new ObjectMapper();
     mapper.registerModule(module);
     try {

proxyserver/src/main/java/edu/suffolk/litlab/efsp/docassemble/FilingInformationDocassembleJacksonDeserializer.java

@@ -1,7 +1,5 @@
 package edu.suffolk.litlab.efsp.docassemble;
 
-import static edu.suffolk.litlab.efsp.stdlib.StdLib.GetEnv;
-
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.DeserializationContext;
@@ -16,6 +14,7 @@
 import edu.suffolk.litlab.efsp.model.LowerCourtInfo;
 import edu.suffolk.litlab.efsp.model.PartyId;
 import edu.suffolk.litlab.efsp.model.Person;
+import edu.suffolk.litlab.efsp.tyler.TylerEnv;
 import edu.suffolk.litlab.efsp.utils.FilingError;
 import edu.suffolk.litlab.efsp.utils.InfoCollector;
 import edu.suffolk.litlab.efsp.utils.InterviewVariable;
@@ -42,10 +41,14 @@ public class FilingInformationDocassembleJacksonDeserializer
   private static final long serialVersionUID = 1L;
   private final InfoCollector classCollector;
 
+  /** If Tyler is setup on this server, this is the env we're submitting to. */
+  private final Optional<TylerEnv> tylerEnv;
+
   public FilingInformationDocassembleJacksonDeserializer(
-      Class<FilingInformation> t, InfoCollector collector) {
+      Class<FilingInformation> t, InfoCollector collector, Optional<TylerEnv> env) {
     super(t);
     this.classCollector = collector;
+    this.tylerEnv = env;
   }
 
   /**
@@ -92,8 +95,7 @@ private static List<Person> collectPeople(
     return List.copyOf(people);
   }
 
-  public static FilingInformation fromNode(JsonNode node, InfoCollector collector)
-      throws FilingError {
+  public FilingInformation fromNode(JsonNode node, InfoCollector collector) throws FilingError {
     if (!node.isObject()) {
       FilingError err = FilingError.malformedInterview("interview isn't a json object");
       collector.error(err);
@@ -492,7 +494,7 @@ private static Optional<LocalDate> extractReturnDate(
     return maybeReturnDate;
   }
 
-  private static Optional<LowerCourtInfo> extractLowerCourt(JsonNode node, InfoCollector collector)
+  private Optional<LowerCourtInfo> extractLowerCourt(JsonNode node, InfoCollector collector)
       throws FilingError {
     if (node == null) {
       return Optional.empty();
@@ -523,8 +525,7 @@ private static Optional<LowerCourtInfo> extractLowerCourt(JsonNode node, InfoCol
       Optional<String> maybeCodeText = Optional.empty();
       // TODO(brycew): HACK HACK HACK! Should be a better way to handle lower court codes than
       // this, but it's broken on prod
-      var tylerEnv = GetEnv("TYLER_ENV");
-      if (tylerEnv.orElse("").equalsIgnoreCase("prod")) {
+      if (tylerEnv.isPresent() && tylerEnv.get() == TylerEnv.PROD) {
         maybeCodeText =
             JsonHelpers.getStringMember(node.get("trial_court"), "tyler_prod_lower_court_code");
       } else {

proxyserver/src/main/java/edu/suffolk/litlab/efsp/ecfcodes/CodeUpdater.java

@@ -514,9 +514,8 @@ public boolean replaceSome(
 
   /** Sets up the WSDL connection to Tyler, used for `getPolicy` to get the URL. */
   private static FilingReviewMDEPort loginWithTyler(
-      String jurisdiction, String env, String userEmail, String userPassword) {
-    Optional<TylerUserFactory> userFactory =
-        TylerClients.getEfmUserFactory(jurisdiction, TylerEnv.parse(env));
+      String jurisdiction, TylerEnv env, String userEmail, String userPassword) {
+    Optional<TylerUserFactory> userFactory = TylerClients.getEfmUserFactory(jurisdiction, env);
     if (userFactory.isEmpty()) {
       throw new RuntimeException("Can't find " + jurisdiction + " in Soap chooser for EFMUser");
     }
@@ -541,7 +540,7 @@ private static FilingReviewMDEPort loginWithTyler(
   }
 
   /** Downloads a single codes zip. For Debugging. */
-  public boolean downloadIndiv(List<String> args, String jurisdiction, String env) {
+  public boolean downloadIndiv(List<String> args, String jurisdiction, TylerEnv env) {
     if (args.size() < 3) {
       log.error(
           "Need to pass in args: downloadIndiv <jurisdiction> <table> <location or blank for"
@@ -557,7 +556,7 @@ public boolean downloadIndiv(List<String> args, String jurisdiction, String env)
     String table = args.get(2);
     String location = (args.size() == 4) ? args.get(3) : "";
     HeaderSigner hs = new HeaderSigner(this.pathToKeystore, this.x509Password);
-    String endpoint = TylerClients.getTylerServerRootUrl(jurisdiction, TylerEnv.parse(env));
+    String endpoint = TylerClients.getTylerServerRootUrl(jurisdiction, env);
     return downloadAndProcessZip(
         makeCodeUrl(endpoint, table, location),
         hs.signedCurrentTime().get(),
@@ -574,12 +573,12 @@ public boolean downloadIndiv(List<String> args, String jurisdiction, String env)
   }
 
   public static boolean executeCommand(
-      CodeDatabase cd, String jurisdiction, String env, List<String> args, String x509Password) {
+      CodeDatabase cd, String jurisdiction, TylerEnv env, List<String> args, String x509Password) {
     SoapX509CallbackHandler.setX509Password(x509Password);
     String command = args.get(0);
     try {
       cd.setAutoCommit(false);
-      String codesSite = TylerClients.getTylerServerRootUrl(jurisdiction, TylerEnv.parse(env));
+      String codesSite = TylerClients.getTylerServerRootUrl(jurisdiction, env);
       FilingReviewMDEPort filingPort =
           loginWithTyler(
               jurisdiction,
@@ -632,7 +631,7 @@ public static void main(String[] args) throws Exception {
             100);
 
     List<String> jurisdictions = List.of(System.getenv("TYLER_JURISDICTIONS").split(" "));
-    String env = System.getenv("TYLER_ENV");
+    var env = TylerEnv.parse(System.getenv("TYLER_ENV"));
     for (String jurisdiction : jurisdictions) {
       try (Connection conn = ds.getConnection()) {
         executeCommand(

proxyserver/src/main/java/edu/suffolk/litlab/efsp/ecfcodes/tyler/CodeDatabase.java

@@ -2,6 +2,7 @@
 
 import edu.suffolk.litlab.efsp.ecfcodes.CodeDatabaseAPI;
 import edu.suffolk.litlab.efsp.stdlib.SQLFunction;
+import edu.suffolk.litlab.efsp.tyler.TylerEnv;
 import jakarta.xml.bind.JAXBException;
 import java.io.InputStream;
 import java.sql.Connection;
@@ -43,12 +44,12 @@ public class CodeDatabase extends CodeDatabaseAPI {
   /** The DNS domain (tyler jurisdiction + tyler environment, illinois-stage). */
   private final String tylerDomain;
 
-  public CodeDatabase(String jurisdiction, String env, Connection conn) {
+  public CodeDatabase(String jurisdiction, TylerEnv env, Connection conn) {
     super(conn);
-    this.tylerDomain = jurisdiction + "-" + env;
+    this.tylerDomain = jurisdiction + "-" + env.getName();
   }
 
-  public static CodeDatabase fromDS(String jurisdiction, String env, DataSource ds) {
+  public static CodeDatabase fromDS(String jurisdiction, TylerEnv env, DataSource ds) {
     try {
       CodeDatabase cd = new CodeDatabase(jurisdiction, env, ds.getConnection());
       return cd;

proxyserver/src/main/java/edu/suffolk/litlab/efsp/server/EfspServer.java

@@ -28,6 +28,7 @@
 import edu.suffolk.litlab.efsp.server.utils.SendMessage;
 import edu.suffolk.litlab.efsp.server.utils.ServiceHelpers;
 import edu.suffolk.litlab.efsp.server.utils.SoapExceptionMapper;
+import edu.suffolk.litlab.efsp.tyler.TylerEnv;
 import edu.suffolk.litlab.efsp.utils.InterviewToFilingInformationConverter;
 import jakarta.ws.rs.core.MediaType;
 import java.security.NoSuchAlgorithmException;
@@ -194,9 +195,10 @@ public static void main(String[] args) throws Exception {
 
     setupDatabases(codeDs, userDs);
 
+    Optional<TylerEnv> tylerEnv = GetEnv("TYLER_ENV").map(TylerEnv::parse);
     InterviewToFilingInformationConverter daJsonConverter =
         new DocassembleToFilingInformationConverter(
-            EfspServer.class.getResourceAsStream("/taxonomy.csv"));
+            EfspServer.class.getResourceAsStream("/taxonomy.csv"), tylerEnv);
     Map<String, InterviewToFilingInformationConverter> converterMap =
         Map.of(
             "application/json", daJsonConverter,
@@ -211,7 +213,6 @@ public static void main(String[] args) throws Exception {
 
     Optional<String> tylerJurisdictions = GetEnv("TYLER_JURISDICTIONS");
     Optional<String> togaKeyStr = GetEnv("TOGA_CLIENT_KEYS");
-    Optional<String> tylerEnv = GetEnv("TYLER_ENV");
     List<String> jurisdictions = List.of(tylerJurisdictions.orElse("").split(" "));
     List<String> togaKeys = List.of(togaKeyStr.orElse("").split(" "));
     if (jurisdictions.size() > 0 && jurisdictions.size() != togaKeys.size()) {

proxyserver/src/main/java/edu/suffolk/litlab/efsp/server/auth/SecurityHub.java

@@ -4,6 +4,7 @@
 import edu.suffolk.litlab.efsp.db.LoginDatabase;
 import edu.suffolk.litlab.efsp.db.model.AtRest;
 import edu.suffolk.litlab.efsp.db.model.NewTokens;
+import edu.suffolk.litlab.efsp.tyler.TylerEnv;
 import java.sql.SQLException;
 import java.util.HashMap;
 import java.util.List;
@@ -41,7 +42,7 @@ public class SecurityHub {
    * @param jurisdictions a list of Tyler jurisdictions to connect to. See SoapClientChooser.
    */
   public SecurityHub(
-      Supplier<LoginDatabase> ldSupplier, Optional<String> env, List<String> jurisdictions) {
+      Supplier<LoginDatabase> ldSupplier, Optional<TylerEnv> env, List<String> jurisdictions) {
     this.ldSupplier = ldSupplier;
     if (env.isEmpty() || jurisdictions.isEmpty()) {
       this.tylerLoginObjs = List.of();

proxyserver/src/main/java/edu/suffolk/litlab/efsp/server/auth/TylerLogin.java

@@ -20,10 +20,9 @@ public class TylerLogin implements LoginInterface {
   private static final String HEADER_KEY_PREFIX = "TYLER-TOKEN";
   private final String jurisdiction;
 
-  public TylerLogin(String jurisdiction, String env) {
+  public TylerLogin(String jurisdiction, TylerEnv env) {
     this.jurisdiction = jurisdiction;
-    Optional<TylerUserFactory> maybeUserFactory =
-        TylerClients.getEfmUserFactory(jurisdiction, TylerEnv.parse(env));
+    Optional<TylerUserFactory> maybeUserFactory = TylerClients.getEfmUserFactory(jurisdiction, env);
     if (maybeUserFactory.isPresent()) {
       userServiceFactory = maybeUserFactory.get();
     } else {

proxyserver/src/main/java/edu/suffolk/litlab/efsp/server/ecf4/SoapClientChooser.java

@@ -1,5 +1,6 @@
 package edu.suffolk.litlab.efsp.server.ecf4;
 
+import edu.suffolk.litlab.efsp.tyler.TylerEnv;
 import https.docs_oasis_open_org.legalxml_courtfiling.ns.v5_0.wsdl.courtschedulingmde.CourtSchedulingMDE_Service;
 import java.net.URL;
 import java.util.Map;
@@ -18,6 +19,7 @@ public class SoapClientChooser {
 
   private static final Logger log = LoggerFactory.getLogger(SoapClientChooser.class);
 
+  // TODO(#284): finish this refactor to use TylerEnvs instead of strings
   static final Map<String, String> serviceMDEWsdls =
       Map.of(
           "illinois-stage", "wsdl/stage/illinois-ECF-4.0-ServiceMDEService.wsdl",
@@ -63,17 +65,17 @@ public static Optional<FilingReviewMDEService> getFilingReviewFactory(String wsd
   }
 
   public static Optional<FilingReviewMDEService> getFilingReviewFactory(
-      String jurisdiction, String env) {
-    return getFilingReviewFactory(jurisdiction + "-" + env);
+      String jurisdiction, TylerEnv env) {
+    return getFilingReviewFactory(jurisdiction + "-" + env.getName());
   }
 
   public static Optional<ServiceMDEService> getServiceFactory(String wsdlDomain) {
     Optional<URL> url = urlFromString(wsdlDomain, serviceMDEWsdls);
     return url.map(u -> new ServiceMDEService(u));
   }
 
-  public static Optional<ServiceMDEService> getServiceFactory(String jurisdiction, String env) {
-    return getServiceFactory(jurisdiction + "-" + env);
+  public static Optional<ServiceMDEService> getServiceFactory(String jurisdiction, TylerEnv env) {
+    return getServiceFactory(jurisdiction + "-" + env.getName());
   }
 
   public static Optional<CourtRecordMDEService> getCourtRecordFactory(String wsdlDomain) {
@@ -82,8 +84,8 @@ public static Optional<CourtRecordMDEService> getCourtRecordFactory(String wsdlD
   }
 
   public static Optional<CourtRecordMDEService> getCourtRecordFactory(
-      String jurisdiction, String env) {
-    return getCourtRecordFactory(jurisdiction + "-" + env);
+      String jurisdiction, TylerEnv env) {
+    return getCourtRecordFactory(jurisdiction + "-" + env.getName());
   }
 
   public static Optional<CourtSchedulingMDE_Service> getCourtSchedulingFactory(String wsdlDomain) {
@@ -92,8 +94,8 @@ public static Optional<CourtSchedulingMDE_Service> getCourtSchedulingFactory(Str
   }
 
   public static Optional<CourtSchedulingMDE_Service> getCourtSchedulingFactory(
-      String jurisdiction, String env) {
-    return getCourtSchedulingFactory(jurisdiction + "-" + env);
+      String jurisdiction, TylerEnv env) {
+    return getCourtSchedulingFactory(jurisdiction + "-" + env.getName());
   }
 
   private static Optional<URL> urlFromString(String wsdlDomain, Map<String, String> domainToWsdl) {

proxyserver/src/main/java/edu/suffolk/litlab/efsp/server/services/AdminUserService.java

@@ -123,21 +123,19 @@ public class AdminUserService {
 
   public AdminUserService(
       String jurisdiction,
-      String env,
+      TylerEnv env,
       Supplier<LoginDatabase> ldSupplier,
       Supplier<CodeDatabase> cdSupplier,
       Function<String, Result<NullValue, String>> passwordChecker) {
     this.jurisdiction = jurisdiction;
     this.passwordChecker = passwordChecker;
-    Optional<TylerUserFactory> maybeUserFactory =
-        TylerClients.getEfmUserFactory(jurisdiction, TylerEnv.parse(env));
+    Optional<TylerUserFactory> maybeUserFactory = TylerClients.getEfmUserFactory(jurisdiction, env);
     if (maybeUserFactory.isEmpty()) {
       throw new RuntimeException(
           "Can't find " + jurisdiction + " in the SoapClientChooser for EfmUser");
     }
     this.userFactory = maybeUserFactory.get();
-    Optional<TylerFirmFactory> maybeFirmFactory =
-        TylerClients.getEfmFirmFactory(jurisdiction, TylerEnv.parse(env));
+    Optional<TylerFirmFactory> maybeFirmFactory = TylerClients.getEfmFirmFactory(jurisdiction, env);
     if (maybeFirmFactory.isEmpty()) {
       throw new RuntimeException(
           "Can't find " + jurisdiction + " in the SoapClientChooser for EfmFirm factory");