use String Constant to replace hardcoded "s3" string literals to avoid migration not changing the string value stably (#69)

yiliuTo · web-flow · commit 001d92a7bdf1 · 2025-11-07T13:21:14.000+08:00
* move generate url to interface

* replace s3 string constant to storage
diff --git a/asset-manager/web/src/main/java/com/microsoft/migration/assets/config/WebMvcConfig.java b/asset-manager/web/src/main/java/com/microsoft/migration/assets/config/WebMvcConfig.java
@@ -1,5 +1,6 @@
 package com.microsoft.migration.assets.config;
 
+import com.microsoft.migration.assets.constants.StorageConstants;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.http.CacheControl;
 import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
@@ -37,8 +38,8 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) {
     @Override
     public void addInterceptors(InterceptorRegistry registry) {
         registry.addInterceptor(new FileOperationLoggingInterceptor())
-                .addPathPatterns("/s3/**")
-                .excludePathPatterns("/s3/view/**"); // Exclude file download endpoints from detailed logging
+                .addPathPatterns("/" + StorageConstants.STORAGE_PATH + "/**")
+                .excludePathPatterns("/" + StorageConstants.STORAGE_PATH + "/view/**"); // Exclude file download endpoints from detailed logging
     }
 
     /**
@@ -89,7 +90,7 @@ private String determineFileOperation(HttpServletRequest request) {
                 return "FILE_DOWNLOAD";
             } else if (uri.contains("/view-page/")) {
                 return "FILE_VIEW_PAGE";
-            } else if ("GET".equals(method) && uri.equals("/s3")) {
+            } else if ("GET".equals(method) && uri.equals("/" + StorageConstants.STORAGE_PATH)) {
                 return "FILE_LIST";
             } else {
                 return "FILE_OPERATION";
diff --git a/asset-manager/web/src/main/java/com/microsoft/migration/assets/constants/StorageConstants.java b/asset-manager/web/src/main/java/com/microsoft/migration/assets/constants/StorageConstants.java
@@ -0,0 +1,16 @@
+package com.microsoft.migration.assets.constants;
+
+/**
+ * Application constants for storage paths and configurations
+ */
+public final class StorageConstants {
+    
+    /**
+     * Base storage path for web endpoints
+     */
+    public static final String STORAGE_PATH = "storage";
+    
+    private StorageConstants() {
+        // Utility class - prevent instantiation
+    }
+}
diff --git a/asset-manager/web/src/main/java/com/microsoft/migration/assets/controller/HomeController.java b/asset-manager/web/src/main/java/com/microsoft/migration/assets/controller/HomeController.java
@@ -1,5 +1,6 @@
 package com.microsoft.migration.assets.controller;
 
+import com.microsoft.migration.assets.constants.StorageConstants;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 
@@ -8,6 +9,6 @@ public class HomeController {
 
     @GetMapping("/")
     public String home() {
-        return "redirect:/s3";
+        return "redirect:/" + StorageConstants.STORAGE_PATH;
     }
 }
diff --git a/asset-manager/web/src/main/java/com/microsoft/migration/assets/controller/S3Controller.java b/asset-manager/web/src/main/java/com/microsoft/migration/assets/controller/S3Controller.java
@@ -1,5 +1,6 @@
 package com.microsoft.migration.assets.controller;
 
+import com.microsoft.migration.assets.constants.StorageConstants;
 import com.microsoft.migration.assets.model.S3StorageItem;
 import com.microsoft.migration.assets.service.StorageService;
 import lombok.RequiredArgsConstructor;
@@ -19,7 +20,7 @@
 import java.util.Optional;
 
 @Controller
-@RequestMapping("/s3")
+@RequestMapping("/" + StorageConstants.STORAGE_PATH)
 @RequiredArgsConstructor
 public class S3Controller {
 
@@ -42,15 +43,15 @@ public String uploadObject(@RequestParam("file") MultipartFile file, RedirectAtt
         try {
             if (file.isEmpty()) {
                 redirectAttributes.addFlashAttribute("error", "Please select a file to upload");
-                return "redirect:/s3/upload";
+                return "redirect:/" + StorageConstants.STORAGE_PATH + "/upload";
             }
 
             storageService.uploadObject(file);
             redirectAttributes.addFlashAttribute("success", "File uploaded successfully");
-            return "redirect:/s3";
+            return "redirect:/" + StorageConstants.STORAGE_PATH;
         } catch (IOException e) {
             redirectAttributes.addFlashAttribute("error", "Failed to upload file: " + e.getMessage());
-            return "redirect:/s3/upload";
+            return "redirect:/" + StorageConstants.STORAGE_PATH + "/upload";
         }
     }
     
@@ -67,11 +68,11 @@ public String viewObjectPage(@PathVariable String key, Model model, RedirectAttr
                 return "view";
             } else {
                 redirectAttributes.addFlashAttribute("error", "Image not found");
-                return "redirect:/s3";
+                return "redirect:/" + StorageConstants.STORAGE_PATH;
             }
         } catch (Exception e) {
             redirectAttributes.addFlashAttribute("error", "Failed to view image: " + e.getMessage());
-            return "redirect:/s3";
+            return "redirect:/" + StorageConstants.STORAGE_PATH;
         }
     }
 
@@ -100,6 +101,6 @@ public String deleteObject(@PathVariable String key, RedirectAttributes redirect
         } catch (Exception e) {
             redirectAttributes.addFlashAttribute("error", "Failed to delete file: " + e.getMessage());
         }
-        return "redirect:/s3";
+        return "redirect:/" + StorageConstants.STORAGE_PATH;
     }
 }
diff --git a/asset-manager/web/src/main/java/com/microsoft/migration/assets/service/AwsS3Service.java b/asset-manager/web/src/main/java/com/microsoft/migration/assets/service/AwsS3Service.java
@@ -145,11 +145,6 @@ private String extractFilename(String key) {
         return lastSlashIndex >= 0 ? key.substring(lastSlashIndex + 1) : key;
     }
 
-    private String generateUrl(String key) {
-        // Use application proxy URL for consistent behavior across storage types
-        return "/s3/view/" + key;
-    }
-
     private String generateKey(String filename) {
         return UUID.randomUUID().toString() + "-" + filename;
     }
diff --git a/asset-manager/web/src/main/java/com/microsoft/migration/assets/service/LocalFileStorageService.java b/asset-manager/web/src/main/java/com/microsoft/migration/assets/service/LocalFileStorageService.java
@@ -141,9 +141,4 @@ public void deleteObject(String key) throws IOException {
     public String getStorageType() {
         return "local";
     }
-    
-    private String generateUrl(String key) {
-        // Generate a URL for the object (simplified path)
-        return "/s3/view/" + key;
-    }
 }
diff --git a/asset-manager/web/src/main/java/com/microsoft/migration/assets/service/StorageService.java b/asset-manager/web/src/main/java/com/microsoft/migration/assets/service/StorageService.java
@@ -1,5 +1,7 @@
 package com.microsoft.migration.assets.service;
 
+import com.microsoft.migration.assets.constants.StorageConstants;
+import com.microsoft.migration.assets.model.ImageProcessingMessage;
 import com.microsoft.migration.assets.model.S3StorageItem;
 import org.springframework.web.multipart.MultipartFile;
 
@@ -48,4 +50,11 @@ default String getThumbnailKey(String key) {
         }
         return key + "_thumbnail";
     }
+
+    /**
+     * Generate a URL for viewing the object
+     */
+    default String generateUrl(String key) {
+        return "/" + StorageConstants.STORAGE_PATH + "/view/" + key;
+    }
 }
diff --git a/asset-manager/web/src/main/resources/templates/layout.html b/asset-manager/web/src/main/resources/templates/layout.html
@@ -23,8 +23,8 @@
             <div class="d-flex align-items-center text-dark text-decoration-none">
                 <h1 class="fs-4">AWS S3 Asset Manager</h1>
                 <div class="ms-auto">
-                    <a class="btn btn-outline-primary me-2" th:href="@{/s3}">All Images</a>
-                    <a class="btn btn-primary" th:href="@{/s3/upload}">Upload New Image</a>
+                    <a class="btn btn-outline-primary me-2" th:href="@{/storage}">All Images</a>
+                    <a class="btn btn-primary" th:href="@{/storage/upload}">Upload New Image</a>
                 </div>
             </div>
         </header>
diff --git a/asset-manager/web/src/main/resources/templates/list.html b/asset-manager/web/src/main/resources/templates/list.html
@@ -7,7 +7,7 @@ <h2>Your Images</h2>
         <div class="row mt-4" id="imageContainer" th:if="${not #lists.isEmpty(objects)}">
             <div class="col-md-4 mb-4" th:each="object : ${objects}" th:attr="data-key=${object.key}">
                 <div class="card">
-                    <img th:src="@{'/s3/view/' + ${object.key}}" class="card-img-top" alt="Image preview" style="height: 200px; object-fit: cover;">
+                    <img th:src="@{'/storage/view/' + ${object.key}}" class="card-img-top" alt="Image preview" style="height: 200px; object-fit: cover;">
                     <div class="card-body">
                         <h5 class="card-title text-truncate" th:text="${object.name}">Image name</h5>
                         <p class="card-text">
@@ -17,8 +17,8 @@ <h5 class="card-title text-truncate" th:text="${object.name}">Image name</h5>
                             </small>
                         </p>
                         <div class="d-flex justify-content-between">
-                            <a th:href="@{'/s3/view-page/' + ${object.key}}" class="btn btn-primary btn-sm">View</a>
-                            <form th:action="@{'/s3/delete/' + ${object.key}}" method="post" onsubmit="return confirm('Are you sure you want to delete this file?');">
+                            <a th:href="@{'/storage/view-page/' + ${object.key}}" class="btn btn-primary btn-sm">View</a>
+                            <form th:action="@{'/storage/delete/' + ${object.key}}" method="post" onsubmit="return confirm('Are you sure you want to delete this file?');">
                                 <button type="submit" class="btn btn-danger btn-sm">Delete</button>
                             </form>
                         </div>
@@ -28,7 +28,7 @@ <h5 class="card-title text-truncate" th:text="${object.name}">Image name</h5>
         </div>
 
         <div class="alert alert-info" th:if="${#lists.isEmpty(objects)}">
-            No images found in the S3 bucket. <a th:href="@{/s3/upload}" class="alert-link">Upload your first image!</a>
+            No images found in the S3 bucket. <a th:href="@{/storage/upload}" class="alert-link">Upload your first image!</a>
         </div>
 
         <!-- Loading indicator for auto-refreshing -->
diff --git a/asset-manager/web/src/main/resources/templates/upload.html b/asset-manager/web/src/main/resources/templates/upload.html
@@ -4,7 +4,7 @@
     <div th:fragment="content">
         <h2>Upload Image to S3</h2>
         
-        <form th:action="@{/s3/upload}" method="post" enctype="multipart/form-data" class="mt-4" id="uploadForm">
+        <form th:action="@{/storage/upload}" method="post" enctype="multipart/form-data" class="mt-4" id="uploadForm">
             <div class="mb-3">
                 <label for="file" class="form-label">Select Image</label>
                 <input type="file" class="form-control" id="file" name="file" accept="image/*" required>
@@ -22,7 +22,7 @@ <h2>Upload Image to S3</h2>
             
             <div class="mt-4">
                 <button type="submit" class="btn btn-success me-2" id="uploadBtn">Upload</button>
-                <a th:href="@{/s3}" class="btn btn-secondary">Cancel</a>
+                <a th:href="@{/storage}" class="btn btn-secondary">Cancel</a>
             </div>
         </form>
 
diff --git a/asset-manager/web/src/main/resources/templates/view.html b/asset-manager/web/src/main/resources/templates/view.html
@@ -7,7 +7,7 @@
                 <div class="col-12">
                     <nav aria-label="breadcrumb">
                         <ol class="breadcrumb">
-                            <li class="breadcrumb-item"><a th:href="@{/s3}">Images</a></li>
+                            <li class="breadcrumb-item"><a th:href="@{/storage}">Images</a></li>
                             <li class="breadcrumb-item active" aria-current="page" th:text="${object.name}">Image Name</li>
                         </ol>
                     </nav>
@@ -18,10 +18,10 @@
                 <div class="card-header d-flex justify-content-between align-items-center">
                     <h3 class="card-title mb-0" th:text="${object.name}">Image Name</h3>
                     <div>
-                        <a th:href="@{'/s3/view/' + ${object.key}}" download class="btn btn-outline-primary btn-sm me-2">
+                        <a th:href="@{'/storage/view/' + ${object.key}}" download class="btn btn-outline-primary btn-sm me-2">
                             <i class="bi bi-download"></i> Download
                         </a>
-                        <form th:action="@{'/s3/delete/' + ${object.key}}" method="post" class="d-inline" 
+                        <form th:action="@{'/storage/delete/' + ${object.key}}" method="post" class="d-inline" 
                               onsubmit="return confirm('Are you sure you want to delete this file?');">
                             <button type="submit" class="btn btn-outline-danger btn-sm">
                                 <i class="bi bi-trash"></i> Delete
@@ -30,7 +30,7 @@ <h3 class="card-title mb-0" th:text="${object.name}">Image Name</h3>
                     </div>
                 </div>
                 <div class="card-body text-center">
-                    <img th:src="@{'/s3/view/' + ${object.key}}" class="img-fluid" alt="Image preview" style="max-height: 70vh;">
+                    <img th:src="@{'/storage/view/' + ${object.key}}" class="img-fluid" alt="Image preview" style="max-height: 70vh;">
                 </div>
                 <div class="card-footer">
                     <div class="row">
@@ -48,7 +48,7 @@ <h3 class="card-title mb-0" th:text="${object.name}">Image Name</h3>
             </div>
             
             <div class="mt-3">
-                <a th:href="@{/s3}" class="btn btn-secondary">Back to Images</a>
+                <a th:href="@{/storage}" class="btn btn-secondary">Back to Images</a>
             </div>
         </div>
     </div>

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package com.microsoft.migration.assets.controller;`
`2`	`2`
	`3`	`+import com.microsoft.migration.assets.constants.StorageConstants;`
`3`	`4`	`import org.springframework.stereotype.Controller;`
`4`	`5`	`import org.springframework.web.bind.annotation.GetMapping;`
`5`	`6`
`@@ -8,6 +9,6 @@ public class HomeController {`
`8`	`9`
`9`	`10`	`@GetMapping("/")`
`10`	`11`	`public String home() {`
`11`		`- return "redirect:/s3";`
	`12`	`+ return "redirect:/" + StorageConstants.STORAGE_PATH;`
`12`	`13`	`}`
`13`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -145,11 +145,6 @@ private String extractFilename(String key) {`
`145`	`145`	`return lastSlashIndex >= 0 ? key.substring(lastSlashIndex + 1) : key;`
`146`	`146`	`}`
`147`	`147`
`148`		`- private String generateUrl(String key) {`
`149`		`- // Use application proxy URL for consistent behavior across storage types`
`150`		`- return "/s3/view/" + key;`
`151`		`- }`
`152`		`-`
`153`	`148`	`private String generateKey(String filename) {`
`154`	`149`	`return UUID.randomUUID().toString() + "-" + filename;`
`155`	`150`	`}`
Original file line number	Diff line number	Diff line change
`@@ -141,9 +141,4 @@ public void deleteObject(String key) throws IOException {`
`141`	`141`	`public String getStorageType() {`
`142`	`142`	`return "local";`
`143`	`143`	`}`
`144`		`-`
`145`		`- private String generateUrl(String key) {`
`146`		`- // Generate a URL for the object (simplified path)`
`147`		`- return "/s3/view/" + key;`
`148`		`- }`
`149`	`144`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`package com.microsoft.migration.assets.service;`
`2`	`2`
	`3`	`+import com.microsoft.migration.assets.constants.StorageConstants;`
	`4`	`+import com.microsoft.migration.assets.model.ImageProcessingMessage;`
`3`	`5`	`import com.microsoft.migration.assets.model.S3StorageItem;`
`4`	`6`	`import org.springframework.web.multipart.MultipartFile;`
`5`	`7`
`@@ -48,4 +50,11 @@ default String getThumbnailKey(String key) {`
`48`	`50`	`}`
`49`	`51`	`return key + "_thumbnail";`
`50`	`52`	`}`
	`53`	`+`
	`54`	`+ /**`
	`55`	`+ * Generate a URL for viewing the object`
	`56`	`+ */`
	`57`	`+ default String generateUrl(String key) {`
	`58`	`+ return "/" + StorageConstants.STORAGE_PATH + "/view/" + key;`
	`59`	`+ }`
`51`	`60`	`}`