From 29bd0590ca34d731f0e9a07e41b1180bea58635a Mon Sep 17 00:00:00 2001
From: guqing <38999863+guqing@users.noreply.github.com>
Date: Thu, 25 Jan 2024 11:27:52 +0800
Subject: [PATCH] fix: resolve unequal schemes built from same Extension
 blocking unregister (#5245)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

#### What type of PR is this?
/kind bug
/area core
/milestone 2.12.x

#### What this PR does / why we need it:
修复同一个自定义模型构建出的 Scheme 不相等导致无法正确从 SchemeManager 中移除的问题

#### Which issue(s) this PR fixes:
Fixes #5243

#### Does this PR introduce a user-facing change?
```release-note
修复同一个自定义模型构建出的 Scheme 不相等导致无法正确从 SchemeManager 中移除的问题
```
---
 .../java/run/halo/app/extension/Scheme.java   | 17 +++++++
 .../run/halo/app/extension/SchemeTest.java    | 45 +++++++++++++++++++
 2 files changed, 62 insertions(+)

diff --git a/api/src/main/java/run/halo/app/extension/Scheme.java b/api/src/main/java/run/halo/app/extension/Scheme.java
index db1e2ebf83..a0deb491fc 100644
--- a/api/src/main/java/run/halo/app/extension/Scheme.java
+++ b/api/src/main/java/run/halo/app/extension/Scheme.java
@@ -72,4 +72,21 @@ public static GVK getGvkFromType(@NonNull Class<? extends Extension> type) {
             "Missing annotation " + GVK.class.getName() + " on type " + type.getName());
         return gvk;
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        Scheme scheme = (Scheme) o;
+        return groupVersionKind.equals(scheme.groupVersionKind);
+    }
+
+    @Override
+    public int hashCode() {
+        return groupVersionKind.hashCode();
+    }
 }
diff --git a/application/src/test/java/run/halo/app/extension/SchemeTest.java b/application/src/test/java/run/halo/app/extension/SchemeTest.java
index d74c37a67f..83e8332214 100644
--- a/application/src/test/java/run/halo/app/extension/SchemeTest.java
+++ b/application/src/test/java/run/halo/app/extension/SchemeTest.java
@@ -1,9 +1,11 @@
 package run.halo.app.extension;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import org.junit.jupiter.api.Test;
 
@@ -66,4 +68,47 @@ void shouldCreateSchemeSuccessfully() {
         assertEquals(FakeExtension.class, scheme.type());
     }
 
+    @Test
+    void equalsAndHashCodeTest() {
+        var scheme1 = Scheme.buildFromType(FakeExtension.class);
+        var scheme2 = Scheme.buildFromType(FakeExtension.class);
+        assertEquals(scheme1, scheme2);
+        assertEquals(scheme1.hashCode(), scheme2.hashCode());
+
+        // openApiSchema is not included in equals and hashCode.
+        var scheme3 = new Scheme(FakeExtension.class, scheme1.groupVersionKind(),
+            scheme1.plural(), scheme1.singular(), JsonNodeFactory.instance.objectNode());
+        assertEquals(scheme1, scheme3);
+
+        // singular and plural are not included in equals and hashCode.
+        var scheme4 = new Scheme(FakeExtension.class, scheme1.groupVersionKind(),
+            scheme1.plural(), "other", scheme1.openApiSchema());
+        assertEquals(scheme1, scheme4);
+
+        // plural is not included in equals and hashCode.
+        var scheme5 = new Scheme(FakeExtension.class, scheme1.groupVersionKind(),
+            "other", scheme1.singular(), scheme1.openApiSchema());
+        assertEquals(scheme1, scheme5);
+
+        // type is not included in equals and hashCode.
+        var scheme6 = new Scheme(FakeExtension.class, scheme1.groupVersionKind(),
+            scheme1.plural(), scheme1.singular(), scheme1.openApiSchema());
+        assertEquals(scheme1, scheme6);
+
+        // groupVersionKind is included in equals and hashCode.
+        var scheme7 = new Scheme(FakeExtension.class,
+            new GroupVersionKind("other.halo.run", "v1alpha1", "Fake"),
+            scheme1.plural(), scheme1.singular(), scheme1.openApiSchema());
+        assertNotEquals(scheme1, scheme7);
+
+        scheme7 = new Scheme(FakeExtension.class,
+            new GroupVersionKind("fake.halo.run", "v1alpha2", "Fake"),
+            scheme1.plural(), scheme1.singular(), scheme1.openApiSchema());
+        assertNotEquals(scheme1, scheme7);
+
+        scheme7 = new Scheme(FakeExtension.class,
+            new GroupVersionKind("fake.halo.run", "v1alpha1", "Other"),
+            scheme1.plural(), scheme1.singular(), scheme1.openApiSchema());
+        assertNotEquals(scheme1, scheme7);
+    }
 }
\ No newline at end of file