refactor: auth provider sorting logic for better maintainability and …

…clarity (#6846) * refactor: auth provider sorting logic for better maintainability and clarity * Refine UI * chore: remove other auth type * Remove other auth providers --------- Co-authored-by: Ryan Wang <[email protected]>
halo-dev · Oct 14, 2024 · 82498dc · 82498dc
1 parent 4059f15
commit 82498dc
Show file tree

Hide file tree

Showing 20 changed files with 411 additions and 255 deletions.
diff --git a/api-docs/openapi/v3_0/aggregated.json b/api-docs/openapi/v3_0/aggregated.json
@@ -16034,6 +16034,7 @@
       },
       "AuthProviderSpec": {
         "required": [
+          "authType",
           "authenticationUrl",
           "displayName"
         ],
@@ -16072,10 +16073,6 @@
           "method": {
             "type": "string"
           },
-          "priority": {
-            "type": "integer",
-            "format": "int32"
-          },
           "rememberMeSupport": {
             "type": "boolean"
           },
@@ -18297,6 +18294,13 @@
         ],
         "type": "object",
         "properties": {
+          "authType": {
+            "type": "string",
+            "enum": [
+              "FORM",
+              "OAUTH2"
+            ]
+          },
           "authenticationUrl": {
             "type": "string"
           },
@@ -18324,6 +18328,10 @@
           "name": {
             "type": "string"
           },
+          "priority": {
+            "type": "integer",
+            "format": "int32"
+          },
           "privileged": {
             "type": "boolean"
           },

diff --git a/api-docs/openapi/v3_0/apis_console.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_console.api_v1alpha1.json
@@ -3568,6 +3568,7 @@
       },
       "AuthProviderSpec": {
         "required": [
+          "authType",
           "authenticationUrl",
           "displayName"
         ],
@@ -3606,10 +3607,6 @@
           "method": {
             "type": "string"
           },
-          "priority": {
-            "type": "integer",
-            "format": "int32"
-          },
           "rememberMeSupport": {
             "type": "boolean"
           },
@@ -4435,6 +4432,13 @@
         ],
         "type": "object",
         "properties": {
+          "authType": {
+            "type": "string",
+            "enum": [
+              "FORM",
+              "OAUTH2"
+            ]
+          },
           "authenticationUrl": {
             "type": "string"
           },
@@ -4462,6 +4466,10 @@
           "name": {
             "type": "string"
           },
+          "priority": {
+            "type": "integer",
+            "format": "int32"
+          },
           "privileged": {
             "type": "boolean"
           },

diff --git a/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json
@@ -8666,6 +8666,7 @@
       },
       "AuthProviderSpec": {
         "required": [
+          "authType",
           "authenticationUrl",
           "displayName"
         ],
@@ -8704,10 +8705,6 @@
           "method": {
             "type": "string"
           },
-          "priority": {
-            "type": "integer",
-            "format": "int32"
-          },
           "rememberMeSupport": {
             "type": "boolean"
           },

diff --git a/api/src/main/java/run/halo/app/core/extension/AuthProvider.java b/api/src/main/java/run/halo/app/core/extension/AuthProvider.java
@@ -6,7 +6,9 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
+import lombok.Getter;
 import lombok.ToString;
+import org.springframework.lang.NonNull;
 import run.halo.app.extension.AbstractExtension;
 import run.halo.app.extension.GVK;
 
@@ -55,19 +57,23 @@ public static class AuthProviderSpec {
         /**
          * Auth type: form or oauth2.
          */
-        private AuthType authType;
+        @Getter(onMethod_ = @NonNull)
+        @Schema(requiredMode = REQUIRED)
+        private AuthType authType = AuthType.OAUTH2;
 
         private String bindingUrl;
 
         private String unbindUrl;
 
-        private int priority;
-
         @Schema(requiredMode = NOT_REQUIRED)
         private SettingRef settingRef;
 
         @Schema(requiredMode = NOT_REQUIRED)
         private ConfigMapRef configMapRef;
+
+        public void setAuthType(AuthType authType) {
+            this.authType = (authType == null ? AuthType.OAUTH2 : authType);
+        }
     }
 
     @Data
@@ -89,7 +95,6 @@ public static class ConfigMapRef {
 
     public enum AuthType {
         FORM,
-        OAUTH2,
-        ;
+        OAUTH2
     }
 }
diff --git a/api/src/main/java/run/halo/app/extension/Unstructured.java b/api/src/main/java/run/halo/app/extension/Unstructured.java
@@ -72,7 +72,7 @@ public MetadataOperator getMetadata() {
         return new UnstructuredMetadata();
     }
 
-    @EqualsAndHashCode(exclude = "version")
+    @EqualsAndHashCode(exclude = "tatersion")
     class UnstructuredMetadata implements MetadataOperator {
 
         @Override

diff --git a/api/src/main/java/run/halo/app/infra/SystemSetting.java b/api/src/main/java/run/halo/app/infra/SystemSetting.java
@@ -2,8 +2,9 @@
 
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
-import java.util.Set;
+import java.util.List;
 import lombok.Data;
+import lombok.experimental.Accessors;
 import org.springframework.boot.convert.ApplicationConversionService;
 import run.halo.app.extension.ConfigMap;
 import run.halo.app.infra.utils.JsonUtils;
@@ -113,7 +114,15 @@ public static class Menu {
     @Data
     public static class AuthProvider {
         public static final String GROUP = "authProvider";
-        private Set<String> enabled;
+        private List<AuthProviderState> states;
+    }
+
+    @Data
+    @Accessors(chain = true)
+    public static class AuthProviderState {
+        private String name;
+        private boolean enabled;
+        private int priority;
     }
 
     /**

diff --git a/application/src/main/java/run/halo/app/security/AuthProviderService.java b/application/src/main/java/run/halo/app/security/AuthProviderService.java
@@ -19,6 +19,9 @@ public interface AuthProviderService {
 
     Mono<List<ListedAuthProvider>> listAll();
 
+    /**
+     * Return a list of enabled AuthProviders sorted by priority.
+     */
     Flux<AuthProvider> getEnabledProviders();
 
 }