feat(sync): align SyncHub production endpoint

Author: bruceblink

README.md

@@ -27,6 +27,7 @@ LatestNews 是一个以中文资讯聚合为核心的实时阅读应用，提供
 - 提供 v1 只读 API、节点清单、JSON Feed/RSS 和诊断导出，便于外部工具接入
 - 支持安装为 PWA，并提供离线与更新反馈
 - 支持缓存、限频抓取与登录用户强制刷新
+- 支持通过 `https://sync.likanug.app` 和 LatestNews API Key 同步阅读历史、收藏与偏好，也可覆盖服务地址接入自建 SyncHub
 
 ## 技术栈
 

shared/synchub-contract.ts

@@ -0,0 +1,20 @@
+export const defaultSyncHubEndpoint = "https://sync.likanug.app";
+
+export const latestNewsSyncHubCollections = ["reading-history", "favorites", "preferences"] as const;
+
+export type LatestNewsSyncHubCollection = (typeof latestNewsSyncHubCollections)[number];
+
+export function normalizeSyncHubEndpoint(value: string) {
+    return value.trim().replace(/\/+$/, "") || defaultSyncHubEndpoint;
+}
+
+export function latestNewsSyncHubURL(endpoint: string, collection: LatestNewsSyncHubCollection) {
+    return `${normalizeSyncHubEndpoint(endpoint)}/api/v1/metadata/latestnews/${collection}`;
+}
+
+export function syncHubHeaders(apiKey: string) {
+    return {
+        "Content-Type": "application/json",
+        "X-API-Key": apiKey.trim(),
+    };
+}

src/routes/history.tsx

@@ -14,7 +14,12 @@ import { useReadingState } from "~/hooks/useReadingState";
 import { getReadingStateList } from "@shared/reading-state";
 import { formatReadingHistoryExport } from "@shared/history-export";
 import { filterReadingHistory, hasReadingHistoryFilters } from "@shared/history-filter";
-import { getSyncHubConfig, saveSyncHubConfig, clearSyncHubConfig } from "~/services/synchub.service";
+import {
+    getSyncHubConfig,
+    saveSyncHubConfig,
+    clearSyncHubConfig,
+    defaultSyncHubEndpoint,
+} from "~/services/synchub.service";
 
 export const Route = createFileRoute("/history")({
     component: HistoryPage,
@@ -173,7 +178,7 @@ function HistoryPage() {
                 <input
                     value={syncHubEndpoint}
                     onChange={(event) => setSyncHubEndpoint(event.target.value)}
-                    placeholder="SyncHub 服务地址"
+                    placeholder={defaultSyncHubEndpoint}
                     className="min-w-0 rounded-xl border border-zinc-200 bg-white px-3 py-2 text-sm outline-none focus:border-cyan-500 dark:border-zinc-700 dark:bg-zinc-800"
                 />
                 <input
@@ -192,11 +197,13 @@ function HistoryPage() {
                 >
                     保存同步
                 </button>
-                {(syncHubEndpoint || syncHubApiKey) && (
+                {(syncHubEndpoint !== defaultSyncHubEndpoint || syncHubApiKey) && (
                     <button
                         type="button"
                         onClick={() => {
                             clearSyncHubConfig();
+                            setSyncHubEndpoint(defaultSyncHubEndpoint);
+                            setSyncHubApiKey("");
                             window.location.reload();
                         }}
                         className="rounded-xl border border-zinc-200 px-3 py-2 text-sm dark:border-zinc-700"

src/services/synchub.service.ts

@@ -2,6 +2,16 @@ import type { ColorScheme } from "~/hooks/useDark";
 import type { HistoryItem } from "~/atoms/historyAtom";
 import type { PrimitiveMetadata } from "@shared/types";
 import type { ReadingState } from "@shared/reading-state";
+import type { LatestNewsSyncHubCollection } from "@shared/synchub-contract";
+
+import {
+    syncHubHeaders,
+    latestNewsSyncHubURL,
+    defaultSyncHubEndpoint,
+    normalizeSyncHubEndpoint,
+} from "@shared/synchub-contract";
+
+export { defaultSyncHubEndpoint } from "@shared/synchub-contract";
 
 export interface UserPreferences {
     colorScheme: ColorScheme;
@@ -12,29 +22,32 @@ export interface SyncHubConfig {
     endpoint: string;
     apiKey: string;
 }
-const storageKey = "latestnews-synchub-sync";
 
-function endpoint(value: string) {
-    return value.trim().replace(/\/+$/, "");
-}
+const storageKey = "latestnews-synchub-sync";
 
 export function getSyncHubConfig(): SyncHubConfig {
     try {
         const raw = localStorage.getItem(storageKey);
         const value = raw ? (JSON.parse(raw) as Partial<SyncHubConfig>) : {};
         return {
-            endpoint: typeof value.endpoint === "string" ? endpoint(value.endpoint) : "",
+            endpoint:
+                typeof value.endpoint === "string" && value.endpoint.trim()
+                    ? normalizeSyncHubEndpoint(value.endpoint)
+                    : defaultSyncHubEndpoint,
             apiKey: typeof value.apiKey === "string" ? value.apiKey.trim() : "",
         };
     } catch {
-        return { endpoint: "", apiKey: "" };
+        return { endpoint: defaultSyncHubEndpoint, apiKey: "" };
     }
 }
 
 export function saveSyncHubConfig(config: SyncHubConfig) {
     localStorage.setItem(
         storageKey,
-        JSON.stringify({ endpoint: endpoint(config.endpoint), apiKey: config.apiKey.trim() })
+        JSON.stringify({
+            endpoint: normalizeSyncHubEndpoint(config.endpoint),
+            apiKey: config.apiKey.trim(),
+        })
     );
 }
 export function clearSyncHubConfig() {
@@ -44,14 +57,12 @@ export function isSyncHubConfigured(config = getSyncHubConfig()) {
     return /^https?:\/\//i.test(config.endpoint) && config.apiKey.startsWith("shk_");
 }
 
-type Collection = "reading-history" | "favorites" | "preferences";
-
-async function request<T>(collection: Collection, init?: RequestInit): Promise<T | null> {
+async function request<T>(collection: LatestNewsSyncHubCollection, init?: RequestInit): Promise<T | null> {
     const config = getSyncHubConfig();
     if (!isSyncHubConfigured(config)) return null;
-    const response = await fetch(`${config.endpoint}/api/v1/metadata/latestnews/${collection}`, {
+    const response = await fetch(latestNewsSyncHubURL(config.endpoint, collection), {
         ...init,
-        headers: { "Content-Type": "application/json", "X-API-Key": config.apiKey, ...init?.headers },
+        headers: { ...syncHubHeaders(config.apiKey), ...init?.headers },
     });
     const result = (await response.json()) as { code: number; message?: string; data?: { payload: T | null } };
     if (!response.ok || result.code !== 0) throw new Error(result.message || "SyncHub request failed");

test/synchub-service.test.ts

@@ -0,0 +1,28 @@
+import { it, expect, describe } from "vitest";
+
+import {
+    syncHubHeaders,
+    latestNewsSyncHubURL,
+    defaultSyncHubEndpoint,
+    normalizeSyncHubEndpoint,
+    latestNewsSyncHubCollections,
+} from "../shared/synchub-contract";
+
+describe("SyncHub service contract", () => {
+    it("defaults to the production SyncHub endpoint", async () => {
+        expect(defaultSyncHubEndpoint).toBe("https://sync.likanug.app");
+        expect(normalizeSyncHubEndpoint("")).toBe(defaultSyncHubEndpoint);
+        expect(normalizeSyncHubEndpoint(" https://self-hosted.example/ ")).toBe("https://self-hosted.example");
+    });
+
+    it("uses the LatestNews application route and API key header", async () => {
+        expect(latestNewsSyncHubCollections).toEqual(["reading-history", "favorites", "preferences"]);
+        expect(latestNewsSyncHubURL("https://sync.likanug.app/", "favorites")).toBe(
+            "https://sync.likanug.app/api/v1/metadata/latestnews/favorites"
+        );
+        expect(syncHubHeaders(" shk_latestnews ")).toEqual({
+            "Content-Type": "application/json",
+            "X-API-Key": "shk_latestnews",
+        });
+    });
+});