From a7b37c1fb3d6eaa0bf3b6d88cec0a60567fbee1e Mon Sep 17 00:00:00 2001
From: Steven Grimm <1248649+sgrimm@users.noreply.github.com>
Date: Wed, 20 Nov 2024 09:11:49 -0800
Subject: [PATCH] Clean up AdminDocumentProducerController (#2620)

A few changes to bring this controller in line with the other admin UI
controllers:

* Remove its copy of the RedirectAttributes extension properties for setting
  success and failure messages. Those extensions are already available as
  top-level functions.

* Don't require its URL to have a trailing slash, which means no need for
  the auto-redirect to add a trailing slash. All the form target URLs in
  its HTML page are full paths, so there's no issue with relative paths
  needing the trailing slash to resolve properly.

* Simplify the redirect function and rename it to match the names of the
  redirect functions in other controllers.
---
 .../admin/AdminDocumentProducerController.kt  | 47 ++-----------------
 1 file changed, 5 insertions(+), 42 deletions(-)

diff --git a/src/main/kotlin/com/terraformation/backend/admin/AdminDocumentProducerController.kt b/src/main/kotlin/com/terraformation/backend/admin/AdminDocumentProducerController.kt
index 4926494b6b74..9acab1042bd2 100644
--- a/src/main/kotlin/com/terraformation/backend/admin/AdminDocumentProducerController.kt
+++ b/src/main/kotlin/com/terraformation/backend/admin/AdminDocumentProducerController.kt
@@ -27,13 +27,7 @@ class AdminDocumentProducerController(
     private val manifestImporter: ManifestImporter,
     private val variableService: VariableService,
 ) {
-  /** Redirects /admin to /admin/ so relative URLs in the UI will work. */
   @GetMapping
-  fun redirectToTrailingSlash(): String {
-    return documentProducerAdminHome()
-  }
-
-  @GetMapping("/")
   fun getIndex(model: Model): String {
     model.addAttribute("documentTemplates", documentTemplatesDao.findAll().sortedBy { it.id })
 
@@ -55,7 +49,7 @@ class AdminDocumentProducerController(
       redirectAttributes.failureMessage = "Failed to add document template: ${e.message}"
     }
 
-    return documentProducerAdminHome()
+    return redirectToDocumentProducer()
   }
 
   @PostMapping("/upgradeAllVariables")
@@ -67,7 +61,7 @@ class AdminDocumentProducerController(
       redirectAttributes.failureMessage = "Failed to upgrade: ${e.message}"
     }
 
-    return documentProducerAdminHome()
+    return redirectToDocumentProducer()
   }
 
   @PostMapping(consumes = [MediaType.MULTIPART_FORM_DATA_VALUE], path = ["/uploadAllVariables"])
@@ -89,7 +83,7 @@ class AdminDocumentProducerController(
       redirectAttributes.failureMessage = "Error attempting to import variables: $e"
     }
 
-    return documentProducerAdminHome()
+    return redirectToDocumentProducer()
   }
 
   @PostMapping(consumes = [MediaType.MULTIPART_FORM_DATA_VALUE], path = ["/uploadManifest"])
@@ -103,7 +97,6 @@ class AdminDocumentProducerController(
       documentTemplateIdString: String,
       redirectAttributes: RedirectAttributes,
   ): String {
-    val fileName = file.originalFilename ?: "manifest.csv"
     val documentTemplateId = DocumentTemplateId(documentTemplateIdString.toLong())
 
     try {
@@ -120,38 +113,8 @@ class AdminDocumentProducerController(
       redirectAttributes.failureMessage = "Error attempting to import manifest: $e"
     }
 
-    return documentProducerAdminHome()
+    return redirectToDocumentProducer()
   }
 
-  private var RedirectAttributes.failureMessage: String?
-    get() = flashAttributes["failureMessage"]?.toString()
-    set(value) {
-      addFlashAttribute("failureMessage", value)
-    }
-
-  private var RedirectAttributes.failureDetails: List<String>?
-    get() {
-      val attribute = flashAttributes["failureDetails"]
-      return if (attribute is List<*>) {
-        attribute.map { "$it" }
-      } else {
-        null
-      }
-    }
-    set(value) {
-      addFlashAttribute("failureDetails", value)
-    }
-
-  private var RedirectAttributes.successMessage: String?
-    get() = flashAttributes["successMessage"]?.toString()
-    set(value) {
-      addFlashAttribute("successMessage", value)
-    }
-
-  /** Returns a redirect view name for an admin endpoint. */
-  private fun redirect(endpoint: String) = "redirect:/admin$endpoint"
-
-  // Convenience methods to redirect to the GET endpoint for each kind of thing.
-
-  private fun documentProducerAdminHome() = redirect("/document-producer/")
+  private fun redirectToDocumentProducer() = "redirect:/admin/document-producer"
 }