refactor: add extension point definition

halo-dev · Dec 10, 2024 · 11407c2 · 11407c2
1 parent a60f14f
commit 11407c2
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 4 deletions.
diff --git a/app/src/main/java/run/halo/feed/RssXmlBuilder.java b/app/src/main/java/run/halo/feed/RssXmlBuilder.java
@@ -232,7 +232,7 @@ private String getDescriptionWithTelemetry(RSS2.Item item) {
         );
 
         // Append telemetry image to description
-        return item.getDescription() + telemetryImageHtml;
+        return telemetryImageHtml + item.getDescription();
     }
 
     static <T> List<T> nullSafeList(List<T> list) {

diff --git a/app/src/main/java/run/halo/feed/telemetry/TelemetryEndpoint.java b/app/src/main/java/run/halo/feed/telemetry/TelemetryEndpoint.java
@@ -2,6 +2,8 @@
 
 import lombok.RequiredArgsConstructor;
 import org.springframework.context.annotation.Bean;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.core.io.Resource;
 import org.springframework.http.CacheControl;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.MediaType;
@@ -16,10 +18,15 @@
 @RequiredArgsConstructor
 public class TelemetryEndpoint {
     public static final String TELEMETRY_PATH = "/plugins/feed/assets/telemetry.gif";
-    static final String ONE_PIXEL_GIF_BASE64 =
-        "R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7";
+    static final Resource ONE_PIXEL;
     private final TelemetryRecorderDelegator telemetryRecorderDelegator;
 
+    static {
+        // RSS readers may thumbnail images, and using base64 images may cause RSS readers to
+        // fail to parse correctly.
+        ONE_PIXEL = new ClassPathResource("1pixel.png", TelemetryEndpoint.class.getClassLoader());
+    }
+
     @Bean
     public RouterFunction<ServerResponse> telemetryImageRouter() {
         return RouterFunctions.route()
@@ -28,7 +35,7 @@ public RouterFunction<ServerResponse> telemetryImageRouter() {
                 return ServerResponse.ok()
                     .header(HttpHeaders.CONTENT_TYPE, MediaType.IMAGE_GIF_VALUE)
                     .cacheControl(CacheControl.noCache())
-                    .bodyValue(ONE_PIXEL_GIF_BASE64);
+                    .bodyValue(ONE_PIXEL);
             })
             .build();
     }

diff --git a/app/src/main/resources/1pixel.png b/app/src/main/resources/1pixel.png
diff --git a/app/src/main/resources/extensions/ext-definition.yaml b/app/src/main/resources/extensions/ext-definition.yaml
@@ -10,6 +10,17 @@ spec:
   icon: "/plugins/PluginFeed/assets/logo.svg"
 ---
 apiVersion: plugin.halo.run/v1alpha1
+kind: ExtensionPointDefinition
+metadata:
+  name: feed-telemetry-recorder
+spec:
+  className: run.halo.feed.TelemetryRecorder
+  displayName: "遥测内容访问量记录器"
+  description: "用于扩展 RSS 内容访问量的存储方式，如上报到 Umami"
+  type: MULTI_INSTANCE
+  icon: "/plugins/PluginFeed/assets/logo.svg"
+---
+apiVersion: plugin.halo.run/v1alpha1
 kind: ExtensionDefinition
 metadata:
   name: feed-category-post-rss-item