Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 8812e5f5e3 | |||
| 01055ded02 | |||
| 01593dcbdc | |||
| afdd26cb59 | |||
| 4b4758a60f | |||
| f9360c15e3 | |||
| f382c27200 | |||
| a36700076e | |||
| 4a693c8fe9 | |||
| 50124af833 | |||
| 69a0149bbe | |||
| cf255e2380 | |||
| 2820823b36 | |||
| 7d7a8f1baf | |||
| e34e007f28 | |||
| c090bcdc9b | |||
| 2255243081 | |||
| 044c870df7 |
@@ -4,9 +4,21 @@ import Login from "./components/Login";
|
||||
import ProductList from "./components/ProductList";
|
||||
import ProductDetail from "./components/ProductDetail";
|
||||
import SubmissionsPage from "./components/SubmissionsPage";
|
||||
import { Inbox, LogOut, Package } from "lucide-react";
|
||||
import ApiKeysPage from "./components/ApiKeysPage";
|
||||
import CategoriesPage from "./components/CategoriesPage";
|
||||
import BrandsPage from "./components/BrandsPage";
|
||||
import StatsPage from "./components/StatsPage";
|
||||
import AuditLogPage from "./components/AuditLogPage";
|
||||
import { BarChart3, FolderTree, Inbox, KeyRound, LogOut, Package, ScrollText, Tag } from "lucide-react";
|
||||
|
||||
type Tab = "products" | "submissions";
|
||||
type Tab =
|
||||
| "overview"
|
||||
| "products"
|
||||
| "submissions"
|
||||
| "categories"
|
||||
| "brands"
|
||||
| "audit"
|
||||
| "keys";
|
||||
type View = { name: "list" } | { name: "detail"; id: string };
|
||||
|
||||
export default function App() {
|
||||
@@ -71,6 +83,16 @@ export default function App() {
|
||||
天工商品档案公共仓 · 后台
|
||||
</div>
|
||||
<nav className="flex items-center gap-1 text-sm">
|
||||
<button
|
||||
onClick={() => setTab("overview")}
|
||||
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${
|
||||
tab === "overview"
|
||||
? "bg-emerald-50 text-emerald-700"
|
||||
: "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
>
|
||||
<BarChart3 className="h-4 w-4" /> 数据概览
|
||||
</button>
|
||||
<button
|
||||
onClick={() => {
|
||||
setTab("products");
|
||||
@@ -99,6 +121,49 @@ export default function App() {
|
||||
</span>
|
||||
)}
|
||||
</button>
|
||||
<button
|
||||
onClick={() => {
|
||||
setTab("categories");
|
||||
setView({ name: "list" });
|
||||
}}
|
||||
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${
|
||||
tab === "categories"
|
||||
? "bg-emerald-50 text-emerald-700"
|
||||
: "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
>
|
||||
<FolderTree className="h-4 w-4" /> 分类管理
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setTab("brands")}
|
||||
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${
|
||||
tab === "brands"
|
||||
? "bg-emerald-50 text-emerald-700"
|
||||
: "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
>
|
||||
<Tag className="h-4 w-4" /> 品牌管理
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setTab("audit")}
|
||||
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${
|
||||
tab === "audit"
|
||||
? "bg-emerald-50 text-emerald-700"
|
||||
: "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
>
|
||||
<ScrollText className="h-4 w-4" /> 操作日志
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setTab("keys")}
|
||||
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${
|
||||
tab === "keys"
|
||||
? "bg-emerald-50 text-emerald-700"
|
||||
: "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
>
|
||||
<KeyRound className="h-4 w-4" /> API 密钥
|
||||
</button>
|
||||
</nav>
|
||||
</div>
|
||||
<div className="flex items-center gap-4 text-sm text-gray-600">
|
||||
@@ -112,7 +177,17 @@ export default function App() {
|
||||
</div>
|
||||
</header>
|
||||
<main className="flex-1 overflow-auto p-6">
|
||||
{tab === "submissions" ? (
|
||||
{tab === "overview" ? (
|
||||
<StatsPage />
|
||||
) : tab === "audit" ? (
|
||||
<AuditLogPage />
|
||||
) : tab === "keys" ? (
|
||||
<ApiKeysPage />
|
||||
) : tab === "categories" ? (
|
||||
<CategoriesPage />
|
||||
) : tab === "brands" ? (
|
||||
<BrandsPage />
|
||||
) : tab === "submissions" ? (
|
||||
<SubmissionsPage onPending={setPending} />
|
||||
) : view.name === "list" ? (
|
||||
<ProductList onOpen={(id) => setView({ name: "detail", id })} />
|
||||
|
||||
@@ -61,6 +61,11 @@ export const api = {
|
||||
}>(`/products?q=${encodeURIComponent(q)}&page=${page}&size=${size}`),
|
||||
getProduct: (id: string) =>
|
||||
request<import("./types").ProductDetail>(`/products/${id}`),
|
||||
createProduct: (body: unknown) =>
|
||||
request<import("./types").ProductDetail>("/products", {
|
||||
method: "POST",
|
||||
body: JSON.stringify(body),
|
||||
}),
|
||||
updateProduct: (id: string, body: unknown) =>
|
||||
request<import("./types").ProductDetail>(`/products/${id}`, {
|
||||
method: "PUT",
|
||||
@@ -102,8 +107,37 @@ export const api = {
|
||||
),
|
||||
listBrands: () =>
|
||||
request<{ items: import("./types").Brand[] }>("/brands"),
|
||||
createBrand: (name: string) =>
|
||||
request<import("./types").Brand>("/brands", {
|
||||
method: "POST",
|
||||
body: JSON.stringify({ name }),
|
||||
}),
|
||||
updateBrand: (id: string, name: string) =>
|
||||
request<import("./types").Brand>(`/brands/${id}`, {
|
||||
method: "PUT",
|
||||
body: JSON.stringify({ name }),
|
||||
}),
|
||||
mergeBrands: (id: string, targetId: string) =>
|
||||
request<import("./types").Brand>(`/brands/${id}/merge`, {
|
||||
method: "POST",
|
||||
body: JSON.stringify({ target_id: targetId }),
|
||||
}),
|
||||
deleteBrand: (id: string) =>
|
||||
request<{ status: string }>(`/brands/${id}`, { method: "DELETE" }),
|
||||
listCategories: () =>
|
||||
request<{ items: import("./types").Category[] }>("/categories"),
|
||||
createCategory: (body: import("./types").CategoryInput) =>
|
||||
request<import("./types").Category>("/categories", {
|
||||
method: "POST",
|
||||
body: JSON.stringify(body),
|
||||
}),
|
||||
updateCategory: (id: string, body: import("./types").CategoryInput) =>
|
||||
request<import("./types").Category>(`/categories/${id}`, {
|
||||
method: "PUT",
|
||||
body: JSON.stringify(body),
|
||||
}),
|
||||
deleteCategory: (id: string) =>
|
||||
request<{ status: string }>(`/categories/${id}`, { method: "DELETE" }),
|
||||
listSubmissions: (status: string, page: number, size: number) =>
|
||||
request<{
|
||||
items: import("./types").SubmissionRow[];
|
||||
@@ -123,4 +157,36 @@ export const api = {
|
||||
method: "POST",
|
||||
body: JSON.stringify({ note }),
|
||||
}),
|
||||
listApiKeys: () =>
|
||||
request<{ items: import("./types").ApiKey[] }>("/keys"),
|
||||
createApiKey: (body: {
|
||||
name: string;
|
||||
owner_email?: string;
|
||||
tier?: string;
|
||||
rate_limit_per_min?: number;
|
||||
}) =>
|
||||
request<{ key: string; item: import("./types").ApiKey; warning: string }>(
|
||||
"/keys",
|
||||
{ method: "POST", body: JSON.stringify(body) },
|
||||
),
|
||||
revokeApiKey: (id: string) =>
|
||||
request<{ status: string }>(`/keys/${id}`, { method: "DELETE" }),
|
||||
stats: () => request<import("./types").AdminStats>("/stats"),
|
||||
auditLog: (page: number, size: number) =>
|
||||
request<{
|
||||
items: import("./types").AuditLogRow[];
|
||||
page: number;
|
||||
size: number;
|
||||
total: number;
|
||||
}>(`/audit?page=${page}&size=${size}`),
|
||||
bulkProducts: (body: {
|
||||
ids: string[];
|
||||
action: "status" | "category";
|
||||
status?: string;
|
||||
category_id?: string | null;
|
||||
}) =>
|
||||
request<{ status: string; affected: number }>("/products/bulk", {
|
||||
method: "POST",
|
||||
body: JSON.stringify(body),
|
||||
}),
|
||||
};
|
||||
|
||||
@@ -0,0 +1,278 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { api, ApiError } from "../api";
|
||||
import type { ApiKey } from "../types";
|
||||
import { Copy, KeyRound, Plus, Trash2 } from "lucide-react";
|
||||
|
||||
const TIERS = [
|
||||
{ key: "free", label: "免费 (free)", rate: 120 },
|
||||
{ key: "partner", label: "合作方 (partner)", rate: 600 },
|
||||
{ key: "internal", label: "内部 (internal)", rate: 6000 },
|
||||
];
|
||||
|
||||
function tierLabel(tier: string): string {
|
||||
return TIERS.find((t) => t.key === tier)?.label ?? tier;
|
||||
}
|
||||
|
||||
export default function ApiKeysPage() {
|
||||
const [rows, setRows] = useState<ApiKey[]>([]);
|
||||
const [error, setError] = useState("");
|
||||
const [creating, setCreating] = useState(false);
|
||||
const [newKey, setNewKey] = useState<string | null>(null);
|
||||
|
||||
async function load() {
|
||||
setError("");
|
||||
try {
|
||||
const res = await api.listApiKeys();
|
||||
setRows(res.items);
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "加载失败");
|
||||
}
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
load();
|
||||
}, []);
|
||||
|
||||
async function revoke(id: string, name: string) {
|
||||
if (!confirm(`确认吊销密钥「${name}」?使用该密钥的请求将立即被拒绝。`)) return;
|
||||
try {
|
||||
await api.revokeApiKey(id);
|
||||
await load();
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "操作失败");
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="mx-auto max-w-4xl">
|
||||
<div className="flex items-center justify-between mb-4">
|
||||
<div>
|
||||
<h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2">
|
||||
<KeyRound className="h-5 w-5 text-emerald-600" /> API 密钥
|
||||
</h2>
|
||||
<p className="text-sm text-gray-500 mt-1">
|
||||
公开 API 免费只读,匿名也可调用(低额度)。签发密钥可获得更高速率上限并归属用量。
|
||||
</p>
|
||||
</div>
|
||||
<button
|
||||
onClick={() => setCreating(true)}
|
||||
className="px-4 py-2 rounded-lg bg-emerald-600 text-white text-sm font-medium hover:bg-emerald-700 flex items-center gap-1.5"
|
||||
>
|
||||
<Plus className="h-4 w-4" /> 签发密钥
|
||||
</button>
|
||||
</div>
|
||||
|
||||
{error && (
|
||||
<div className="mb-3 bg-red-50 text-red-700 text-sm rounded px-4 py-2">{error}</div>
|
||||
)}
|
||||
|
||||
{newKey && (
|
||||
<div className="mb-4 bg-amber-50 border border-amber-200 rounded-lg p-4">
|
||||
<div className="text-sm font-medium text-amber-800 mb-1">
|
||||
密钥已生成,请立即复制保存——它只显示这一次。
|
||||
</div>
|
||||
<div className="flex items-center gap-2">
|
||||
<code className="flex-1 bg-white border rounded px-3 py-2 text-sm break-all">
|
||||
{newKey}
|
||||
</code>
|
||||
<button
|
||||
onClick={() => navigator.clipboard?.writeText(newKey)}
|
||||
className="px-3 py-2 rounded border text-sm text-gray-600 hover:bg-gray-50 flex items-center gap-1"
|
||||
>
|
||||
<Copy className="h-4 w-4" /> 复制
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setNewKey(null)}
|
||||
className="px-3 py-2 rounded text-sm text-gray-500 hover:bg-gray-100"
|
||||
>
|
||||
我已保存
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{creating && (
|
||||
<CreateKeyForm
|
||||
onClose={() => setCreating(false)}
|
||||
onCreated={(plaintext) => {
|
||||
setCreating(false);
|
||||
setNewKey(plaintext);
|
||||
load();
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
|
||||
<div className="bg-white border rounded-lg overflow-hidden">
|
||||
<table className="w-full text-sm">
|
||||
<thead className="bg-gray-50 text-gray-500 text-left">
|
||||
<tr>
|
||||
<th className="px-4 py-2 font-medium">名称</th>
|
||||
<th className="px-4 py-2 font-medium">前缀</th>
|
||||
<th className="px-4 py-2 font-medium">级别</th>
|
||||
<th className="px-4 py-2 font-medium">速率/分钟</th>
|
||||
<th className="px-4 py-2 font-medium">用量(今日/累计)</th>
|
||||
<th className="px-4 py-2 font-medium">状态</th>
|
||||
<th className="px-4 py-2 font-medium"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody className="divide-y">
|
||||
{rows.length === 0 ? (
|
||||
<tr>
|
||||
<td colSpan={7} className="px-4 py-8 text-center text-gray-400">
|
||||
暂无密钥
|
||||
</td>
|
||||
</tr>
|
||||
) : (
|
||||
rows.map((k) => (
|
||||
<tr key={k.id} className={k.revoked_at ? "opacity-50" : ""}>
|
||||
<td className="px-4 py-2 text-gray-800">
|
||||
{k.name}
|
||||
{k.owner_email && (
|
||||
<span className="block text-xs text-gray-400">{k.owner_email}</span>
|
||||
)}
|
||||
</td>
|
||||
<td className="px-4 py-2 text-gray-500">
|
||||
<code>{k.key_prefix}…</code>
|
||||
</td>
|
||||
<td className="px-4 py-2 text-gray-600">{tierLabel(k.tier)}</td>
|
||||
<td className="px-4 py-2 text-gray-600">{k.rate_limit_per_min}</td>
|
||||
<td className="px-4 py-2 text-gray-600">
|
||||
{k.usage.today} / {k.usage.total}
|
||||
</td>
|
||||
<td className="px-4 py-2">
|
||||
{k.revoked_at ? (
|
||||
<span className="text-xs rounded px-2 py-0.5 bg-red-50 text-red-700">
|
||||
已吊销
|
||||
</span>
|
||||
) : (
|
||||
<span className="text-xs rounded px-2 py-0.5 bg-emerald-50 text-emerald-700">
|
||||
启用中
|
||||
</span>
|
||||
)}
|
||||
</td>
|
||||
<td className="px-4 py-2 text-right">
|
||||
{!k.revoked_at && (
|
||||
<button
|
||||
onClick={() => revoke(k.id, k.name)}
|
||||
className="text-gray-400 hover:text-red-600"
|
||||
title="吊销"
|
||||
>
|
||||
<Trash2 className="h-4 w-4" />
|
||||
</button>
|
||||
)}
|
||||
</td>
|
||||
</tr>
|
||||
))
|
||||
)}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function CreateKeyForm({
|
||||
onClose,
|
||||
onCreated,
|
||||
}: {
|
||||
onClose: () => void;
|
||||
onCreated: (plaintext: string) => void;
|
||||
}) {
|
||||
const [name, setName] = useState("");
|
||||
const [ownerEmail, setOwnerEmail] = useState("");
|
||||
const [tier, setTier] = useState("free");
|
||||
const [rate, setRate] = useState(120);
|
||||
const [busy, setBusy] = useState(false);
|
||||
const [error, setError] = useState("");
|
||||
|
||||
function pickTier(t: string) {
|
||||
setTier(t);
|
||||
const def = TIERS.find((x) => x.key === t);
|
||||
if (def) setRate(def.rate);
|
||||
}
|
||||
|
||||
async function submit() {
|
||||
if (!name.trim()) {
|
||||
setError("名称不能为空");
|
||||
return;
|
||||
}
|
||||
setBusy(true);
|
||||
setError("");
|
||||
try {
|
||||
const res = await api.createApiKey({
|
||||
name: name.trim(),
|
||||
owner_email: ownerEmail.trim() || undefined,
|
||||
tier,
|
||||
rate_limit_per_min: rate,
|
||||
});
|
||||
onCreated(res.key);
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "创建失败");
|
||||
} finally {
|
||||
setBusy(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="mb-4 bg-white border rounded-lg p-5">
|
||||
<h3 className="font-medium text-gray-700 mb-3">签发新密钥</h3>
|
||||
{error && <div className="mb-3 bg-red-50 text-red-700 text-sm rounded px-3 py-2">{error}</div>}
|
||||
<div className="grid grid-cols-2 gap-4">
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">名称 *</span>
|
||||
<input
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={name}
|
||||
onChange={(e) => setName(e.target.value)}
|
||||
placeholder="例如:我的 App / 合作方 X"
|
||||
/>
|
||||
</label>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">负责人邮箱(可选)</span>
|
||||
<input
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={ownerEmail}
|
||||
onChange={(e) => setOwnerEmail(e.target.value)}
|
||||
placeholder="owner@example.com"
|
||||
/>
|
||||
</label>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">级别</span>
|
||||
<select
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1 bg-white"
|
||||
value={tier}
|
||||
onChange={(e) => pickTier(e.target.value)}
|
||||
>
|
||||
{TIERS.map((t) => (
|
||||
<option key={t.key} value={t.key}>
|
||||
{t.label}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</label>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">速率上限(次/分钟)</span>
|
||||
<input
|
||||
type="number"
|
||||
min={1}
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={rate}
|
||||
onChange={(e) => setRate(Math.max(1, parseInt(e.target.value || "1", 10)))}
|
||||
/>
|
||||
</label>
|
||||
</div>
|
||||
<div className="mt-4 flex gap-2">
|
||||
<button
|
||||
onClick={submit}
|
||||
disabled={busy}
|
||||
className="px-4 py-2 rounded bg-emerald-600 text-white text-sm hover:bg-emerald-700 disabled:opacity-60"
|
||||
>
|
||||
生成
|
||||
</button>
|
||||
<button onClick={onClose} className="px-4 py-2 rounded border text-sm text-gray-600">
|
||||
取消
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,115 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { api, ApiError } from "../api";
|
||||
import type { AuditLogRow } from "../types";
|
||||
import { ScrollText } from "lucide-react";
|
||||
|
||||
const ACTION_LABEL: Record<string, string> = {
|
||||
create: "新建",
|
||||
update: "修改",
|
||||
delete: "删除",
|
||||
add_image: "添加图片",
|
||||
delete_image: "删除图片",
|
||||
bulk_status: "批量改状态",
|
||||
bulk_category: "批量改分类",
|
||||
};
|
||||
|
||||
const ENTITY_LABEL: Record<string, string> = {
|
||||
product: "商品",
|
||||
category: "分类",
|
||||
brand: "品牌",
|
||||
};
|
||||
|
||||
export default function AuditLogPage() {
|
||||
const [rows, setRows] = useState<AuditLogRow[]>([]);
|
||||
const [total, setTotal] = useState(0);
|
||||
const [page, setPage] = useState(1);
|
||||
const size = 30;
|
||||
const [error, setError] = useState("");
|
||||
|
||||
useEffect(() => {
|
||||
setError("");
|
||||
api
|
||||
.auditLog(page, size)
|
||||
.then((r) => {
|
||||
setRows(r.items);
|
||||
setTotal(r.total);
|
||||
})
|
||||
.catch((e) => setError(e instanceof ApiError ? e.message : "加载失败"));
|
||||
}, [page]);
|
||||
|
||||
const pages = Math.max(1, Math.ceil(total / size));
|
||||
|
||||
return (
|
||||
<div className="mx-auto max-w-5xl">
|
||||
<h2 className="mb-4 flex items-center gap-2 text-lg font-semibold text-gray-800">
|
||||
<ScrollText className="h-5 w-5 text-emerald-600" /> 操作日志
|
||||
<span className="text-sm font-normal text-gray-400">共 {total} 条</span>
|
||||
</h2>
|
||||
|
||||
{error && (
|
||||
<div className="mb-3 rounded bg-red-50 px-4 py-2 text-sm text-red-700">{error}</div>
|
||||
)}
|
||||
|
||||
<div className="overflow-hidden rounded-lg border bg-white">
|
||||
<table className="w-full text-sm">
|
||||
<thead className="bg-gray-50 text-left text-xs uppercase text-gray-500">
|
||||
<tr>
|
||||
<th className="px-4 py-2 font-medium">时间</th>
|
||||
<th className="px-4 py-2 font-medium">操作人</th>
|
||||
<th className="px-4 py-2 font-medium">动作</th>
|
||||
<th className="px-4 py-2 font-medium">对象</th>
|
||||
<th className="px-4 py-2 font-medium">字段</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody className="divide-y">
|
||||
{rows.length === 0 ? (
|
||||
<tr>
|
||||
<td colSpan={5} className="px-4 py-8 text-center text-gray-400">
|
||||
暂无记录
|
||||
</td>
|
||||
</tr>
|
||||
) : (
|
||||
rows.map((e) => (
|
||||
<tr key={e.id} className="hover:bg-gray-50">
|
||||
<td className="whitespace-nowrap px-4 py-2 text-gray-500">
|
||||
{new Date(e.created_at).toLocaleString()}
|
||||
</td>
|
||||
<td className="px-4 py-2 text-gray-700">{e.actor}</td>
|
||||
<td className="px-4 py-2 text-gray-700">
|
||||
{ACTION_LABEL[e.action] || e.action}
|
||||
</td>
|
||||
<td className="px-4 py-2 text-gray-600">
|
||||
{ENTITY_LABEL[e.entity] || e.entity}
|
||||
</td>
|
||||
<td className="px-4 py-2 text-xs text-gray-400">
|
||||
{e.fields.length ? e.fields.join(", ") : "—"}
|
||||
</td>
|
||||
</tr>
|
||||
))
|
||||
)}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div className="mt-4 flex items-center justify-end gap-2 text-sm text-gray-600">
|
||||
<button
|
||||
disabled={page <= 1}
|
||||
onClick={() => setPage((p) => p - 1)}
|
||||
className="rounded border border-gray-300 px-3 py-1 disabled:opacity-50"
|
||||
>
|
||||
上一页
|
||||
</button>
|
||||
<span>
|
||||
{page} / {pages}
|
||||
</span>
|
||||
<button
|
||||
disabled={page >= pages}
|
||||
onClick={() => setPage((p) => p + 1)}
|
||||
className="rounded border border-gray-300 px-3 py-1 disabled:opacity-50"
|
||||
>
|
||||
下一页
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,305 @@
|
||||
import { useEffect, useMemo, useState } from "react";
|
||||
import { api, ApiError } from "../api";
|
||||
import type { Brand } from "../types";
|
||||
import { Tag, Pencil, Plus, Trash2, GitMerge, Search } from "lucide-react";
|
||||
|
||||
type EditState = { id: string; name: string };
|
||||
type MergeState = { source: Brand; targetId: string };
|
||||
|
||||
export default function BrandsPage() {
|
||||
const [rows, setRows] = useState<Brand[]>([]);
|
||||
const [error, setError] = useState("");
|
||||
const [query, setQuery] = useState("");
|
||||
const [creating, setCreating] = useState(false);
|
||||
const [newName, setNewName] = useState("");
|
||||
const [edit, setEdit] = useState<EditState | null>(null);
|
||||
const [merge, setMerge] = useState<MergeState | null>(null);
|
||||
const [busy, setBusy] = useState(false);
|
||||
|
||||
async function load() {
|
||||
setError("");
|
||||
try {
|
||||
const res = await api.listBrands();
|
||||
setRows(res.items);
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "加载失败");
|
||||
}
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
load();
|
||||
}, []);
|
||||
|
||||
const filtered = useMemo(() => {
|
||||
const q = query.trim().toLowerCase();
|
||||
if (!q) return rows;
|
||||
return rows.filter((b) => b.name.toLowerCase().includes(q));
|
||||
}, [rows, query]);
|
||||
|
||||
function fail(e: unknown, fallback: string) {
|
||||
setError(e instanceof ApiError ? e.message : fallback);
|
||||
}
|
||||
|
||||
async function create() {
|
||||
if (!newName.trim()) return;
|
||||
setBusy(true);
|
||||
setError("");
|
||||
try {
|
||||
await api.createBrand(newName.trim());
|
||||
setNewName("");
|
||||
setCreating(false);
|
||||
await load();
|
||||
} catch (e) {
|
||||
fail(e, "新建失败");
|
||||
} finally {
|
||||
setBusy(false);
|
||||
}
|
||||
}
|
||||
|
||||
async function saveEdit() {
|
||||
if (!edit || !edit.name.trim()) return;
|
||||
setBusy(true);
|
||||
setError("");
|
||||
try {
|
||||
await api.updateBrand(edit.id, edit.name.trim());
|
||||
setEdit(null);
|
||||
await load();
|
||||
} catch (e) {
|
||||
fail(e, "保存失败");
|
||||
} finally {
|
||||
setBusy(false);
|
||||
}
|
||||
}
|
||||
|
||||
async function remove(b: Brand) {
|
||||
if (!confirm(`确认删除品牌「${b.name}」?`)) return;
|
||||
setError("");
|
||||
try {
|
||||
await api.deleteBrand(b.id);
|
||||
await load();
|
||||
} catch (e) {
|
||||
fail(e, "删除失败");
|
||||
}
|
||||
}
|
||||
|
||||
async function doMerge() {
|
||||
if (!merge || !merge.targetId) return;
|
||||
const target = rows.find((b) => b.id === merge.targetId);
|
||||
if (
|
||||
!confirm(
|
||||
`将「${merge.source.name}」的 ${merge.source.product_count} 个商品并入「${target?.name}」,并删除「${merge.source.name}」?`,
|
||||
)
|
||||
)
|
||||
return;
|
||||
setBusy(true);
|
||||
setError("");
|
||||
try {
|
||||
await api.mergeBrands(merge.source.id, merge.targetId);
|
||||
setMerge(null);
|
||||
await load();
|
||||
} catch (e) {
|
||||
fail(e, "合并失败");
|
||||
} finally {
|
||||
setBusy(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="mx-auto max-w-4xl">
|
||||
<div className="flex items-center justify-between mb-4">
|
||||
<div>
|
||||
<h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2">
|
||||
<Tag className="h-5 w-5 text-emerald-600" /> 品牌管理
|
||||
</h2>
|
||||
<p className="text-sm text-gray-500 mt-1">
|
||||
维护品牌名录。可重命名、删除未被引用的品牌,或将重复品牌合并到一起。
|
||||
</p>
|
||||
</div>
|
||||
<button
|
||||
onClick={() => {
|
||||
setCreating(true);
|
||||
setNewName("");
|
||||
}}
|
||||
className="px-4 py-2 rounded-lg bg-emerald-600 text-white text-sm font-medium hover:bg-emerald-700 flex items-center gap-1.5"
|
||||
>
|
||||
<Plus className="h-4 w-4" /> 新建品牌
|
||||
</button>
|
||||
</div>
|
||||
|
||||
{error && (
|
||||
<div className="mb-3 bg-red-50 text-red-700 text-sm rounded px-4 py-2">{error}</div>
|
||||
)}
|
||||
|
||||
<div className="mb-3 relative w-72">
|
||||
<Search className="absolute left-2 top-2.5 h-4 w-4 text-gray-400" />
|
||||
<input
|
||||
value={query}
|
||||
onChange={(e) => setQuery(e.target.value)}
|
||||
placeholder="筛选品牌名"
|
||||
className="w-full rounded border border-gray-300 py-2 pl-8 pr-3 text-sm focus:border-emerald-500 focus:outline-none"
|
||||
/>
|
||||
</div>
|
||||
|
||||
{creating && (
|
||||
<div className="mb-4 bg-white border rounded-lg p-5">
|
||||
<h3 className="font-medium text-gray-700 mb-3">新建品牌</h3>
|
||||
<div className="flex items-end gap-2">
|
||||
<label className="block flex-1">
|
||||
<span className="text-xs text-gray-500">品牌名称 *</span>
|
||||
<input
|
||||
autoFocus
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={newName}
|
||||
onChange={(e) => setNewName(e.target.value)}
|
||||
onKeyDown={(e) => e.key === "Enter" && create()}
|
||||
placeholder="例如:可口可乐"
|
||||
/>
|
||||
</label>
|
||||
<button
|
||||
onClick={create}
|
||||
disabled={busy}
|
||||
className="px-4 py-2 rounded bg-emerald-600 text-white text-sm hover:bg-emerald-700 disabled:opacity-60"
|
||||
>
|
||||
保存
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setCreating(false)}
|
||||
className="px-4 py-2 rounded border text-sm text-gray-600"
|
||||
>
|
||||
取消
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{merge && (
|
||||
<div className="mb-4 bg-white border rounded-lg p-5">
|
||||
<h3 className="font-medium text-gray-700 mb-3 flex items-center gap-1.5">
|
||||
<GitMerge className="h-4 w-4 text-emerald-600" /> 合并品牌
|
||||
</h3>
|
||||
<p className="text-sm text-gray-500 mb-3">
|
||||
把「{merge.source.name}」({merge.source.product_count} 个商品)合并到下面选择的品牌,源品牌将被删除。
|
||||
</p>
|
||||
<div className="flex items-end gap-2">
|
||||
<label className="block flex-1">
|
||||
<span className="text-xs text-gray-500">合并到</span>
|
||||
<select
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1 bg-white"
|
||||
value={merge.targetId}
|
||||
onChange={(e) => setMerge({ ...merge, targetId: e.target.value })}
|
||||
>
|
||||
<option value="">(请选择目标品牌)</option>
|
||||
{rows
|
||||
.filter((b) => b.id !== merge.source.id)
|
||||
.map((b) => (
|
||||
<option key={b.id} value={b.id}>
|
||||
{b.name}({b.product_count})
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</label>
|
||||
<button
|
||||
onClick={doMerge}
|
||||
disabled={busy || !merge.targetId}
|
||||
className="px-4 py-2 rounded bg-emerald-600 text-white text-sm hover:bg-emerald-700 disabled:opacity-60"
|
||||
>
|
||||
合并
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setMerge(null)}
|
||||
className="px-4 py-2 rounded border text-sm text-gray-600"
|
||||
>
|
||||
取消
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
<div className="bg-white border rounded-lg overflow-hidden">
|
||||
<table className="w-full text-sm">
|
||||
<thead className="bg-gray-50 text-gray-500 text-left">
|
||||
<tr>
|
||||
<th className="px-4 py-2 font-medium">品牌</th>
|
||||
<th className="px-4 py-2 font-medium">商品数</th>
|
||||
<th className="px-4 py-2 font-medium"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody className="divide-y">
|
||||
{filtered.length === 0 ? (
|
||||
<tr>
|
||||
<td colSpan={3} className="px-4 py-8 text-center text-gray-400">
|
||||
{rows.length === 0 ? "暂无品牌" : "无匹配品牌"}
|
||||
</td>
|
||||
</tr>
|
||||
) : (
|
||||
filtered.map((b) => (
|
||||
<tr key={b.id} className="hover:bg-gray-50">
|
||||
<td className="px-4 py-2 text-gray-800">
|
||||
{edit && edit.id === b.id ? (
|
||||
<input
|
||||
autoFocus
|
||||
className="border rounded px-2 py-1 text-sm w-64"
|
||||
value={edit.name}
|
||||
onChange={(e) => setEdit({ ...edit, name: e.target.value })}
|
||||
onKeyDown={(e) => {
|
||||
if (e.key === "Enter") saveEdit();
|
||||
if (e.key === "Escape") setEdit(null);
|
||||
}}
|
||||
/>
|
||||
) : (
|
||||
<span className="font-medium">{b.name}</span>
|
||||
)}
|
||||
</td>
|
||||
<td className="px-4 py-2 text-gray-600">{b.product_count}</td>
|
||||
<td className="px-4 py-2 text-right whitespace-nowrap">
|
||||
{edit && edit.id === b.id ? (
|
||||
<>
|
||||
<button
|
||||
onClick={saveEdit}
|
||||
disabled={busy}
|
||||
className="text-emerald-600 hover:text-emerald-700 text-xs mr-3"
|
||||
>
|
||||
保存
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setEdit(null)}
|
||||
className="text-gray-400 hover:text-gray-600 text-xs"
|
||||
>
|
||||
取消
|
||||
</button>
|
||||
</>
|
||||
) : (
|
||||
<>
|
||||
<button
|
||||
onClick={() => setEdit({ id: b.id, name: b.name })}
|
||||
className="text-gray-400 hover:text-emerald-600 mr-3"
|
||||
title="重命名"
|
||||
>
|
||||
<Pencil className="h-4 w-4" />
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setMerge({ source: b, targetId: "" })}
|
||||
className="text-gray-400 hover:text-emerald-600 mr-3"
|
||||
title="合并到其它品牌"
|
||||
>
|
||||
<GitMerge className="h-4 w-4" />
|
||||
</button>
|
||||
<button
|
||||
onClick={() => remove(b)}
|
||||
className="text-gray-400 hover:text-red-600"
|
||||
title="删除"
|
||||
>
|
||||
<Trash2 className="h-4 w-4" />
|
||||
</button>
|
||||
</>
|
||||
)}
|
||||
</td>
|
||||
</tr>
|
||||
))
|
||||
)}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,311 @@
|
||||
import { useEffect, useMemo, useState } from "react";
|
||||
import { api, ApiError } from "../api";
|
||||
import type { Category, CategoryInput } from "../types";
|
||||
import { FolderTree, Pencil, Plus, Trash2 } from "lucide-react";
|
||||
|
||||
type FormState = {
|
||||
mode: "create" | "edit";
|
||||
id?: string;
|
||||
name_zh: string;
|
||||
name_en: string;
|
||||
slug: string;
|
||||
parent_id: string; // "" = top level
|
||||
gpc_brick_code: string;
|
||||
};
|
||||
|
||||
function emptyForm(parentId = ""): FormState {
|
||||
return {
|
||||
mode: "create",
|
||||
name_zh: "",
|
||||
name_en: "",
|
||||
slug: "",
|
||||
parent_id: parentId,
|
||||
gpc_brick_code: "",
|
||||
};
|
||||
}
|
||||
|
||||
export default function CategoriesPage() {
|
||||
const [rows, setRows] = useState<Category[]>([]);
|
||||
const [error, setError] = useState("");
|
||||
const [form, setForm] = useState<FormState | null>(null);
|
||||
|
||||
async function load() {
|
||||
setError("");
|
||||
try {
|
||||
const res = await api.listCategories();
|
||||
setRows(res.items);
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "加载失败");
|
||||
}
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
load();
|
||||
}, []);
|
||||
|
||||
async function remove(c: Category) {
|
||||
if (!confirm(`确认删除分类「${c.name_zh}」(${c.path})?`)) return;
|
||||
setError("");
|
||||
try {
|
||||
await api.deleteCategory(c.id);
|
||||
await load();
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "删除失败");
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="mx-auto max-w-5xl">
|
||||
<div className="flex items-center justify-between mb-4">
|
||||
<div>
|
||||
<h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2">
|
||||
<FolderTree className="h-5 w-5 text-emerald-600" /> 分类管理
|
||||
</h2>
|
||||
<p className="text-sm text-gray-500 mt-1">
|
||||
维护商品分类树。英文标识(slug)用于分类路径,新建后不可修改;可重命名、移动层级、删除空分类。
|
||||
</p>
|
||||
</div>
|
||||
<button
|
||||
onClick={() => setForm(emptyForm())}
|
||||
className="px-4 py-2 rounded-lg bg-emerald-600 text-white text-sm font-medium hover:bg-emerald-700 flex items-center gap-1.5"
|
||||
>
|
||||
<Plus className="h-4 w-4" /> 新建顶级分类
|
||||
</button>
|
||||
</div>
|
||||
|
||||
{error && (
|
||||
<div className="mb-3 bg-red-50 text-red-700 text-sm rounded px-4 py-2">{error}</div>
|
||||
)}
|
||||
|
||||
{form && (
|
||||
<CategoryForm
|
||||
form={form}
|
||||
categories={rows}
|
||||
onClose={() => setForm(null)}
|
||||
onSaved={() => {
|
||||
setForm(null);
|
||||
load();
|
||||
}}
|
||||
onError={setError}
|
||||
/>
|
||||
)}
|
||||
|
||||
<div className="bg-white border rounded-lg overflow-hidden">
|
||||
<table className="w-full text-sm">
|
||||
<thead className="bg-gray-50 text-gray-500 text-left">
|
||||
<tr>
|
||||
<th className="px-4 py-2 font-medium">名称</th>
|
||||
<th className="px-4 py-2 font-medium">路径</th>
|
||||
<th className="px-4 py-2 font-medium">GPC</th>
|
||||
<th className="px-4 py-2 font-medium">商品数</th>
|
||||
<th className="px-4 py-2 font-medium"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody className="divide-y">
|
||||
{rows.length === 0 ? (
|
||||
<tr>
|
||||
<td colSpan={5} className="px-4 py-8 text-center text-gray-400">
|
||||
暂无分类
|
||||
</td>
|
||||
</tr>
|
||||
) : (
|
||||
rows.map((c) => (
|
||||
<tr key={c.id} className="hover:bg-gray-50">
|
||||
<td className="px-4 py-2 text-gray-800">
|
||||
<span style={{ paddingLeft: `${c.level * 18}px` }} className="inline-flex items-center gap-2">
|
||||
{c.level > 0 && <span className="text-gray-300">└</span>}
|
||||
<span className="font-medium">{c.name_zh}</span>
|
||||
{c.name_en && <span className="text-xs text-gray-400">{c.name_en}</span>}
|
||||
</span>
|
||||
</td>
|
||||
<td className="px-4 py-2 text-gray-500">
|
||||
<code className="text-xs">{c.path}</code>
|
||||
</td>
|
||||
<td className="px-4 py-2 text-gray-500 text-xs">{c.gpc_brick_code || "—"}</td>
|
||||
<td className="px-4 py-2 text-gray-600">{c.product_count}</td>
|
||||
<td className="px-4 py-2 text-right whitespace-nowrap">
|
||||
<button
|
||||
onClick={() => setForm(emptyForm(c.id))}
|
||||
className="text-gray-400 hover:text-emerald-600 mr-3"
|
||||
title="新增子分类"
|
||||
>
|
||||
<Plus className="h-4 w-4" />
|
||||
</button>
|
||||
<button
|
||||
onClick={() =>
|
||||
setForm({
|
||||
mode: "edit",
|
||||
id: c.id,
|
||||
name_zh: c.name_zh,
|
||||
name_en: c.name_en ?? "",
|
||||
slug: c.path,
|
||||
parent_id: c.parent_id ?? "",
|
||||
gpc_brick_code: c.gpc_brick_code ?? "",
|
||||
})
|
||||
}
|
||||
className="text-gray-400 hover:text-emerald-600 mr-3"
|
||||
title="编辑"
|
||||
>
|
||||
<Pencil className="h-4 w-4" />
|
||||
</button>
|
||||
<button
|
||||
onClick={() => remove(c)}
|
||||
className="text-gray-400 hover:text-red-600"
|
||||
title="删除"
|
||||
>
|
||||
<Trash2 className="h-4 w-4" />
|
||||
</button>
|
||||
</td>
|
||||
</tr>
|
||||
))
|
||||
)}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function CategoryForm({
|
||||
form,
|
||||
categories,
|
||||
onClose,
|
||||
onSaved,
|
||||
onError,
|
||||
}: {
|
||||
form: FormState;
|
||||
categories: Category[];
|
||||
onClose: () => void;
|
||||
onSaved: () => void;
|
||||
onError: (msg: string) => void;
|
||||
}) {
|
||||
const [state, setState] = useState<FormState>(form);
|
||||
const [busy, setBusy] = useState(false);
|
||||
|
||||
// When editing, the node itself and its descendants are not valid parents.
|
||||
const parentOptions = useMemo(() => {
|
||||
if (state.mode === "create") return categories;
|
||||
const self = categories.find((c) => c.id === state.id);
|
||||
if (!self) return categories;
|
||||
return categories.filter(
|
||||
(c) => c.id !== self.id && !c.path.startsWith(self.path + "."),
|
||||
);
|
||||
}, [categories, state.mode, state.id]);
|
||||
|
||||
function set<K extends keyof FormState>(key: K, value: FormState[K]) {
|
||||
setState((s) => ({ ...s, [key]: value }));
|
||||
}
|
||||
|
||||
async function submit() {
|
||||
if (!state.name_zh.trim()) {
|
||||
onError("分类名称不能为空");
|
||||
return;
|
||||
}
|
||||
setBusy(true);
|
||||
onError("");
|
||||
const body: CategoryInput = {
|
||||
name_zh: state.name_zh.trim(),
|
||||
name_en: state.name_en.trim() || null,
|
||||
parent_id: state.parent_id || null,
|
||||
gpc_brick_code: state.gpc_brick_code.trim() || null,
|
||||
};
|
||||
if (state.mode === "create") body.slug = state.slug.trim() || null;
|
||||
try {
|
||||
if (state.mode === "create") {
|
||||
await api.createCategory(body);
|
||||
} else if (state.id) {
|
||||
await api.updateCategory(state.id, body);
|
||||
}
|
||||
onSaved();
|
||||
} catch (e) {
|
||||
onError(e instanceof ApiError ? e.message : "保存失败");
|
||||
} finally {
|
||||
setBusy(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="mb-4 bg-white border rounded-lg p-5">
|
||||
<h3 className="font-medium text-gray-700 mb-3">
|
||||
{state.mode === "create" ? "新建分类" : "编辑分类"}
|
||||
</h3>
|
||||
<div className="grid grid-cols-2 gap-4">
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">中文名称 *</span>
|
||||
<input
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={state.name_zh}
|
||||
onChange={(e) => set("name_zh", e.target.value)}
|
||||
placeholder="例如:饮料"
|
||||
/>
|
||||
</label>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">英文名称(可选)</span>
|
||||
<input
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={state.name_en}
|
||||
onChange={(e) => set("name_en", e.target.value)}
|
||||
placeholder="Beverages"
|
||||
/>
|
||||
</label>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">上级分类</span>
|
||||
<select
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1 bg-white"
|
||||
value={state.parent_id}
|
||||
onChange={(e) => set("parent_id", e.target.value)}
|
||||
>
|
||||
<option value="">(顶级分类)</option>
|
||||
{parentOptions.map((c) => (
|
||||
<option key={c.id} value={c.id}>
|
||||
{"\u00A0".repeat(c.level * 2)}
|
||||
{c.name_zh} ({c.path})
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</label>
|
||||
{state.mode === "create" ? (
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">英文标识 slug(可选,留空自动生成)</span>
|
||||
<input
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={state.slug}
|
||||
onChange={(e) => set("slug", e.target.value)}
|
||||
placeholder="beverages"
|
||||
/>
|
||||
</label>
|
||||
) : (
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">路径(不可修改)</span>
|
||||
<input
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1 bg-gray-50 text-gray-400"
|
||||
value={state.slug}
|
||||
disabled
|
||||
/>
|
||||
</label>
|
||||
)}
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">GPC Brick 编码(可选)</span>
|
||||
<input
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={state.gpc_brick_code}
|
||||
onChange={(e) => set("gpc_brick_code", e.target.value)}
|
||||
placeholder="10000224"
|
||||
/>
|
||||
</label>
|
||||
</div>
|
||||
<div className="mt-4 flex gap-2">
|
||||
<button
|
||||
onClick={submit}
|
||||
disabled={busy}
|
||||
className="px-4 py-2 rounded bg-emerald-600 text-white text-sm hover:bg-emerald-700 disabled:opacity-60"
|
||||
>
|
||||
保存
|
||||
</button>
|
||||
<button onClick={onClose} className="px-4 py-2 rounded border text-sm text-gray-600">
|
||||
取消
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { api } from "../api";
|
||||
import { FIELD_LABELS, ProductRow } from "../types";
|
||||
import { Search, AlertCircle } from "lucide-react";
|
||||
import { api, ApiError } from "../api";
|
||||
import { Brand, Category, FIELD_LABELS, ProductRow } from "../types";
|
||||
import { Search, AlertCircle, Plus } from "lucide-react";
|
||||
|
||||
const STATUS_LABEL: Record<string, string> = {
|
||||
active: "在用",
|
||||
@@ -37,8 +37,14 @@ export default function ProductList({
|
||||
const [total, setTotal] = useState(0);
|
||||
const [loading, setLoading] = useState(false);
|
||||
const [error, setError] = useState("");
|
||||
const [creating, setCreating] = useState(false);
|
||||
const [selected, setSelected] = useState<Set<string>>(new Set());
|
||||
const [categories, setCategories] = useState<Category[]>([]);
|
||||
const [bulkStatus, setBulkStatus] = useState("");
|
||||
const [bulkCategory, setBulkCategory] = useState("");
|
||||
const [bulkBusy, setBulkBusy] = useState(false);
|
||||
|
||||
useEffect(() => {
|
||||
function reload() {
|
||||
setLoading(true);
|
||||
setError("");
|
||||
api
|
||||
@@ -49,8 +55,72 @@ export default function ProductList({
|
||||
})
|
||||
.catch((e) => setError(e.message))
|
||||
.finally(() => setLoading(false));
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
setSelected(new Set());
|
||||
reload();
|
||||
}, [q, page, size]);
|
||||
|
||||
useEffect(() => {
|
||||
api.listCategories().then((r) => setCategories(r.items)).catch(() => {});
|
||||
}, []);
|
||||
|
||||
function toggle(id: string) {
|
||||
setSelected((prev) => {
|
||||
const next = new Set(prev);
|
||||
if (next.has(id)) next.delete(id);
|
||||
else next.add(id);
|
||||
return next;
|
||||
});
|
||||
}
|
||||
|
||||
function toggleAll() {
|
||||
setSelected((prev) =>
|
||||
prev.size === rows.length ? new Set() : new Set(rows.map((r) => r.id)),
|
||||
);
|
||||
}
|
||||
|
||||
async function applyBulkStatus() {
|
||||
if (!bulkStatus || selected.size === 0) return;
|
||||
setBulkBusy(true);
|
||||
setError("");
|
||||
try {
|
||||
await api.bulkProducts({
|
||||
ids: [...selected],
|
||||
action: "status",
|
||||
status: bulkStatus,
|
||||
});
|
||||
setSelected(new Set());
|
||||
setBulkStatus("");
|
||||
reload();
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "批量操作失败");
|
||||
} finally {
|
||||
setBulkBusy(false);
|
||||
}
|
||||
}
|
||||
|
||||
async function applyBulkCategory() {
|
||||
if (selected.size === 0) return;
|
||||
setBulkBusy(true);
|
||||
setError("");
|
||||
try {
|
||||
await api.bulkProducts({
|
||||
ids: [...selected],
|
||||
action: "category",
|
||||
category_id: bulkCategory || null,
|
||||
});
|
||||
setSelected(new Set());
|
||||
setBulkCategory("");
|
||||
reload();
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "批量操作失败");
|
||||
} finally {
|
||||
setBulkBusy(false);
|
||||
}
|
||||
}
|
||||
|
||||
const pages = Math.max(1, Math.ceil(total / size));
|
||||
|
||||
return (
|
||||
@@ -79,19 +149,101 @@ export default function ProductList({
|
||||
<button className="rounded bg-emerald-600 px-3 py-2 text-sm text-white hover:bg-emerald-700">
|
||||
搜索
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
onClick={() => setCreating(true)}
|
||||
className="flex items-center gap-1 rounded bg-gray-700 px-3 py-2 text-sm text-white hover:bg-gray-800"
|
||||
>
|
||||
<Plus className="h-4 w-4" /> 新建商品
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
|
||||
{creating && (
|
||||
<CreateProductModal
|
||||
onClose={() => setCreating(false)}
|
||||
onCreated={(id) => {
|
||||
setCreating(false);
|
||||
onOpen(id);
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
|
||||
{error && (
|
||||
<div className="mb-3 rounded bg-red-50 px-3 py-2 text-sm text-red-600">
|
||||
{error}
|
||||
</div>
|
||||
)}
|
||||
|
||||
{selected.size > 0 && (
|
||||
<div className="mb-3 flex flex-wrap items-center gap-3 rounded-lg border border-emerald-200 bg-emerald-50 px-4 py-3 text-sm">
|
||||
<span className="font-medium text-emerald-800">
|
||||
已选 {selected.size} 项
|
||||
</span>
|
||||
<div className="flex items-center gap-1.5">
|
||||
<span className="text-gray-500">改状态</span>
|
||||
<select
|
||||
value={bulkStatus}
|
||||
onChange={(e) => setBulkStatus(e.target.value)}
|
||||
className="rounded border border-gray-300 bg-white px-2 py-1"
|
||||
>
|
||||
<option value="">选择</option>
|
||||
<option value="active">在用</option>
|
||||
<option value="deprecated">已停用</option>
|
||||
<option value="merged">已合并</option>
|
||||
</select>
|
||||
<button
|
||||
onClick={applyBulkStatus}
|
||||
disabled={bulkBusy || !bulkStatus}
|
||||
className="rounded bg-emerald-600 px-3 py-1 text-white hover:bg-emerald-700 disabled:opacity-50"
|
||||
>
|
||||
应用
|
||||
</button>
|
||||
</div>
|
||||
<div className="flex items-center gap-1.5">
|
||||
<span className="text-gray-500">改分类</span>
|
||||
<select
|
||||
value={bulkCategory}
|
||||
onChange={(e) => setBulkCategory(e.target.value)}
|
||||
className="rounded border border-gray-300 bg-white px-2 py-1"
|
||||
>
|
||||
<option value="">(未分类)</option>
|
||||
{categories.map((c) => (
|
||||
<option key={c.id} value={c.id}>
|
||||
{"\u00A0".repeat(c.level * 2)}
|
||||
{c.name_zh}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
<button
|
||||
onClick={applyBulkCategory}
|
||||
disabled={bulkBusy}
|
||||
className="rounded bg-emerald-600 px-3 py-1 text-white hover:bg-emerald-700 disabled:opacity-50"
|
||||
>
|
||||
应用
|
||||
</button>
|
||||
</div>
|
||||
<button
|
||||
onClick={() => setSelected(new Set())}
|
||||
className="text-gray-500 hover:text-gray-700"
|
||||
>
|
||||
取消选择
|
||||
</button>
|
||||
</div>
|
||||
)}
|
||||
|
||||
<div className="overflow-hidden rounded-lg border border-gray-200 bg-white">
|
||||
<table className="w-full text-sm">
|
||||
<thead className="bg-gray-50 text-left text-xs uppercase text-gray-500">
|
||||
<tr>
|
||||
<th className="w-10 px-4 py-3">
|
||||
<input
|
||||
type="checkbox"
|
||||
checked={rows.length > 0 && selected.size === rows.length}
|
||||
onChange={toggleAll}
|
||||
aria-label="全选"
|
||||
/>
|
||||
</th>
|
||||
<th className="px-4 py-3">名称</th>
|
||||
<th className="px-4 py-3">品牌</th>
|
||||
<th className="px-4 py-3">条码</th>
|
||||
@@ -104,13 +256,13 @@ export default function ProductList({
|
||||
<tbody className="divide-y divide-gray-100">
|
||||
{loading ? (
|
||||
<tr>
|
||||
<td colSpan={7} className="px-4 py-8 text-center text-gray-400">
|
||||
<td colSpan={8} className="px-4 py-8 text-center text-gray-400">
|
||||
加载中…
|
||||
</td>
|
||||
</tr>
|
||||
) : rows.length === 0 ? (
|
||||
<tr>
|
||||
<td colSpan={7} className="px-4 py-8 text-center text-gray-400">
|
||||
<td colSpan={8} className="px-4 py-8 text-center text-gray-400">
|
||||
暂无数据
|
||||
</td>
|
||||
</tr>
|
||||
@@ -119,8 +271,21 @@ export default function ProductList({
|
||||
<tr
|
||||
key={r.id}
|
||||
onClick={() => onOpen(r.id)}
|
||||
className="cursor-pointer hover:bg-emerald-50/50"
|
||||
className={`cursor-pointer hover:bg-emerald-50/50 ${
|
||||
selected.has(r.id) ? "bg-emerald-50/60" : ""
|
||||
}`}
|
||||
>
|
||||
<td
|
||||
className="px-4 py-3"
|
||||
onClick={(e) => e.stopPropagation()}
|
||||
>
|
||||
<input
|
||||
type="checkbox"
|
||||
checked={selected.has(r.id)}
|
||||
onChange={() => toggle(r.id)}
|
||||
aria-label="选择"
|
||||
/>
|
||||
</td>
|
||||
<td className="px-4 py-3 font-medium text-gray-800">{r.name}</td>
|
||||
<td className="px-4 py-3 text-gray-600">{r.brand || "—"}</td>
|
||||
<td className="px-4 py-3 font-mono text-xs text-gray-500">
|
||||
@@ -176,3 +341,130 @@ export default function ProductList({
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function CreateProductModal({
|
||||
onClose,
|
||||
onCreated,
|
||||
}: {
|
||||
onClose: () => void;
|
||||
onCreated: (id: string) => void;
|
||||
}) {
|
||||
const [name, setName] = useState("");
|
||||
const [gtin, setGtin] = useState("");
|
||||
const [brand, setBrand] = useState("");
|
||||
const [categoryId, setCategoryId] = useState("");
|
||||
const [brands, setBrands] = useState<Brand[]>([]);
|
||||
const [categories, setCategories] = useState<Category[]>([]);
|
||||
const [busy, setBusy] = useState(false);
|
||||
const [error, setError] = useState("");
|
||||
|
||||
useEffect(() => {
|
||||
api.listBrands().then((r) => setBrands(r.items)).catch(() => {});
|
||||
api.listCategories().then((r) => setCategories(r.items)).catch(() => {});
|
||||
}, []);
|
||||
|
||||
async function submit() {
|
||||
if (!name.trim()) {
|
||||
setError("名称不能为空");
|
||||
return;
|
||||
}
|
||||
setBusy(true);
|
||||
setError("");
|
||||
try {
|
||||
const created = await api.createProduct({
|
||||
name: name.trim(),
|
||||
gtin: gtin.trim() || null,
|
||||
brand_name: brand.trim() || null,
|
||||
category_id: categoryId || null,
|
||||
status: "active",
|
||||
});
|
||||
onCreated(created.id);
|
||||
} catch (e) {
|
||||
setError(e instanceof ApiError ? e.message : "新建失败");
|
||||
} finally {
|
||||
setBusy(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="fixed inset-0 z-20 flex items-center justify-center bg-black/30">
|
||||
<div className="w-full max-w-md rounded-lg bg-white p-6 shadow-lg">
|
||||
<h3 className="mb-4 text-base font-semibold text-gray-800">新建商品</h3>
|
||||
{error && (
|
||||
<div className="mb-3 rounded bg-red-50 px-3 py-2 text-sm text-red-600">
|
||||
{error}
|
||||
</div>
|
||||
)}
|
||||
<div className="space-y-3">
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">名称 *</span>
|
||||
<input
|
||||
autoFocus
|
||||
className="mt-1 w-full rounded border border-gray-300 px-3 py-2 text-sm"
|
||||
value={name}
|
||||
onChange={(e) => setName(e.target.value)}
|
||||
placeholder="商品名称"
|
||||
/>
|
||||
</label>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">条码 (GTIN,可选)</span>
|
||||
<input
|
||||
className="mt-1 w-full rounded border border-gray-300 px-3 py-2 text-sm"
|
||||
value={gtin}
|
||||
onChange={(e) => setGtin(e.target.value)}
|
||||
placeholder="8/12/13/14 位"
|
||||
/>
|
||||
</label>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">品牌(不存在将自动创建,可选)</span>
|
||||
<input
|
||||
list="create-brand-list"
|
||||
className="mt-1 w-full rounded border border-gray-300 px-3 py-2 text-sm"
|
||||
value={brand}
|
||||
onChange={(e) => setBrand(e.target.value)}
|
||||
/>
|
||||
<datalist id="create-brand-list">
|
||||
{brands.map((b) => (
|
||||
<option key={b.id} value={b.name} />
|
||||
))}
|
||||
</datalist>
|
||||
</label>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">品类(可选)</span>
|
||||
<select
|
||||
className="mt-1 w-full rounded border border-gray-300 bg-white px-3 py-2 text-sm"
|
||||
value={categoryId}
|
||||
onChange={(e) => setCategoryId(e.target.value)}
|
||||
>
|
||||
<option value="">(未分类)</option>
|
||||
{categories.map((c) => (
|
||||
<option key={c.id} value={c.id}>
|
||||
{"\u00A0".repeat(c.level * 2)}
|
||||
{c.name_zh} ({c.path})
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</label>
|
||||
</div>
|
||||
<p className="mt-3 text-xs text-gray-400">
|
||||
创建后将进入详情页,可继续补全营养、图片、多条码等信息。
|
||||
</p>
|
||||
<div className="mt-4 flex justify-end gap-2">
|
||||
<button
|
||||
onClick={onClose}
|
||||
className="rounded border px-4 py-2 text-sm text-gray-600"
|
||||
>
|
||||
取消
|
||||
</button>
|
||||
<button
|
||||
onClick={submit}
|
||||
disabled={busy}
|
||||
className="rounded bg-emerald-600 px-4 py-2 text-sm text-white hover:bg-emerald-700 disabled:opacity-60"
|
||||
>
|
||||
{busy ? "创建中…" : "创建并编辑"}
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,125 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { api, ApiError } from "../api";
|
||||
import type { AdminStats } from "../types";
|
||||
import { BarChart3, Package, CheckCircle2, Tag, FolderTree, Inbox } from "lucide-react";
|
||||
|
||||
const STATUS_LABEL: Record<string, string> = {
|
||||
active: "在用",
|
||||
merged: "已合并",
|
||||
deprecated: "已停用",
|
||||
};
|
||||
|
||||
function Card({
|
||||
icon,
|
||||
label,
|
||||
value,
|
||||
hint,
|
||||
}: {
|
||||
icon: React.ReactNode;
|
||||
label: string;
|
||||
value: string | number;
|
||||
hint?: string;
|
||||
}) {
|
||||
return (
|
||||
<div className="rounded-lg border bg-white p-5">
|
||||
<div className="flex items-center gap-2 text-sm text-gray-500">
|
||||
{icon}
|
||||
{label}
|
||||
</div>
|
||||
<div className="mt-2 text-2xl font-semibold text-gray-800">{value}</div>
|
||||
{hint && <div className="mt-1 text-xs text-gray-400">{hint}</div>}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export default function StatsPage() {
|
||||
const [stats, setStats] = useState<AdminStats | null>(null);
|
||||
const [error, setError] = useState("");
|
||||
|
||||
useEffect(() => {
|
||||
api
|
||||
.stats()
|
||||
.then(setStats)
|
||||
.catch((e) => setError(e instanceof ApiError ? e.message : "加载失败"));
|
||||
}, []);
|
||||
|
||||
return (
|
||||
<div className="mx-auto max-w-5xl">
|
||||
<h2 className="mb-4 flex items-center gap-2 text-lg font-semibold text-gray-800">
|
||||
<BarChart3 className="h-5 w-5 text-emerald-600" /> 数据概览
|
||||
</h2>
|
||||
|
||||
{error && (
|
||||
<div className="mb-3 rounded bg-red-50 px-4 py-2 text-sm text-red-700">{error}</div>
|
||||
)}
|
||||
|
||||
{!stats ? (
|
||||
<div className="text-sm text-gray-400">加载中…</div>
|
||||
) : (
|
||||
<>
|
||||
<div className="grid grid-cols-2 gap-4 md:grid-cols-3">
|
||||
<Card
|
||||
icon={<Package className="h-4 w-4" />}
|
||||
label="商品总数"
|
||||
value={stats.products.toLocaleString()}
|
||||
/>
|
||||
<Card
|
||||
icon={<CheckCircle2 className="h-4 w-4 text-emerald-600" />}
|
||||
label="合格档案"
|
||||
value={stats.qualified.toLocaleString()}
|
||||
hint={`质量分 ≥ ${stats.min_score} 且在用`}
|
||||
/>
|
||||
<Card
|
||||
icon={<BarChart3 className="h-4 w-4" />}
|
||||
label="平均质量分"
|
||||
value={Math.round(stats.avg_quality * 100)}
|
||||
hint="满分 100"
|
||||
/>
|
||||
<Card
|
||||
icon={<Tag className="h-4 w-4" />}
|
||||
label="品牌数"
|
||||
value={stats.brands.toLocaleString()}
|
||||
/>
|
||||
<Card
|
||||
icon={<FolderTree className="h-4 w-4" />}
|
||||
label="分类数"
|
||||
value={stats.categories.toLocaleString()}
|
||||
/>
|
||||
<Card
|
||||
icon={<Inbox className="h-4 w-4" />}
|
||||
label="待审核投稿"
|
||||
value={stats.pending_submissions.toLocaleString()}
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="mt-6 rounded-lg border bg-white p-5">
|
||||
<h3 className="mb-3 text-sm font-medium text-gray-700">按状态分布</h3>
|
||||
<div className="space-y-2">
|
||||
{Object.keys(stats.by_status).length === 0 ? (
|
||||
<div className="text-sm text-gray-400">暂无数据</div>
|
||||
) : (
|
||||
Object.entries(stats.by_status).map(([st, n]) => {
|
||||
const pct = stats.products > 0 ? (n / stats.products) * 100 : 0;
|
||||
return (
|
||||
<div key={st} className="flex items-center gap-3 text-sm">
|
||||
<span className="w-16 text-gray-600">
|
||||
{STATUS_LABEL[st] || st}
|
||||
</span>
|
||||
<div className="h-3 flex-1 overflow-hidden rounded bg-gray-100">
|
||||
<div
|
||||
className="h-full bg-emerald-500"
|
||||
style={{ width: `${pct}%` }}
|
||||
/>
|
||||
</div>
|
||||
<span className="w-12 text-right text-gray-500">{n}</span>
|
||||
</div>
|
||||
);
|
||||
})
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -56,7 +56,7 @@ export default function SubmissionsPage({ onPending }: { onPending?: (n: number)
|
||||
}
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div className="mx-auto max-w-5xl">
|
||||
<div className="flex items-center gap-2 mb-4">
|
||||
{STATUS_TABS.map((t) => (
|
||||
<button
|
||||
@@ -193,7 +193,7 @@ function SubmissionView({ id, onBack }: { id: string; onBack: () => void }) {
|
||||
const nutri = Object.entries(p.nutriments || {});
|
||||
|
||||
return (
|
||||
<div className="max-w-3xl">
|
||||
<div className="mx-auto max-w-3xl">
|
||||
<button onClick={onBack} className="text-sm text-gray-500 flex items-center gap-1 mb-4">
|
||||
<ArrowLeft className="h-4 w-4" /> 返回投稿队列
|
||||
</button>
|
||||
|
||||
@@ -66,6 +66,7 @@ export interface ProductDetail {
|
||||
export interface Brand {
|
||||
id: string;
|
||||
name: string;
|
||||
product_count: number;
|
||||
}
|
||||
|
||||
export interface Category {
|
||||
@@ -74,6 +75,17 @@ export interface Category {
|
||||
name_en: string | null;
|
||||
path: string;
|
||||
level: number;
|
||||
parent_id: string | null;
|
||||
gpc_brick_code: string | null;
|
||||
product_count: number;
|
||||
}
|
||||
|
||||
export interface CategoryInput {
|
||||
name_zh: string;
|
||||
name_en?: string | null;
|
||||
slug?: string | null;
|
||||
parent_id?: string | null;
|
||||
gpc_brick_code?: string | null;
|
||||
}
|
||||
|
||||
export interface AuditEntry {
|
||||
@@ -84,6 +96,27 @@ export interface AuditEntry {
|
||||
created_at: string;
|
||||
}
|
||||
|
||||
export interface AuditLogRow {
|
||||
id: string;
|
||||
actor: string;
|
||||
action: string;
|
||||
entity: string;
|
||||
entity_id: string | null;
|
||||
fields: string[];
|
||||
created_at: string;
|
||||
}
|
||||
|
||||
export interface AdminStats {
|
||||
products: number;
|
||||
qualified: number;
|
||||
min_score: number;
|
||||
by_status: Record<string, number>;
|
||||
brands: number;
|
||||
categories: number;
|
||||
pending_submissions: number;
|
||||
avg_quality: number;
|
||||
}
|
||||
|
||||
export interface SubmissionRow {
|
||||
id: string;
|
||||
gtin: string | null;
|
||||
@@ -137,6 +170,25 @@ export interface SubmissionDetail {
|
||||
existing_product?: ProductDetail;
|
||||
}
|
||||
|
||||
export interface ApiKeyUsage {
|
||||
total: number;
|
||||
today: number;
|
||||
last_used_at?: number | null;
|
||||
}
|
||||
|
||||
export interface ApiKey {
|
||||
id: string;
|
||||
name: string;
|
||||
key_prefix: string;
|
||||
owner_email: string | null;
|
||||
tier: string;
|
||||
rate_limit_per_min: number;
|
||||
revoked_at: string | null;
|
||||
created_by: string | null;
|
||||
created_at: string;
|
||||
usage: ApiKeyUsage;
|
||||
}
|
||||
|
||||
export const FIELD_LABELS: Record<string, string> = {
|
||||
name: "名称",
|
||||
gtin: "条码",
|
||||
|
||||
@@ -17,6 +17,7 @@ import (
|
||||
"github.com/baicai2026-baicai/goods/api/internal/adminstore"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/adminweb"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/auth"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/ratelimit"
|
||||
)
|
||||
|
||||
func getenv(key, fallback string) string {
|
||||
@@ -69,7 +70,9 @@ func main() {
|
||||
}
|
||||
|
||||
authn := auth.New(username, passwordHash, secret, 12*time.Hour)
|
||||
h := adminhandler.New(adminstore.New(pool), authn, basePath, adminweb.Dist())
|
||||
usage := ratelimit.New(getenv("OPENGOODS_REDIS_URL", "redis://localhost:6379/0"))
|
||||
h := adminhandler.New(adminstore.New(pool), authn, basePath, adminweb.Dist()).
|
||||
WithUsage(usage)
|
||||
|
||||
srv := &http.Server{
|
||||
Addr: addr,
|
||||
|
||||
@@ -12,6 +12,7 @@ import (
|
||||
"github.com/baicai2026-baicai/goods/api/internal/config"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/handler"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/publicweb"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/ratelimit"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/store"
|
||||
)
|
||||
|
||||
@@ -31,7 +32,12 @@ func main() {
|
||||
log.Printf("warning: database not reachable at startup: %v", err)
|
||||
}
|
||||
|
||||
h := handler.New(store.New(pool), publicweb.Dist())
|
||||
limiter := ratelimit.New(cfg.RedisURL)
|
||||
if !limiter.Enabled() {
|
||||
log.Print("warning: Redis not configured; public API rate limiting disabled")
|
||||
}
|
||||
h := handler.New(store.New(pool), publicweb.Dist()).
|
||||
WithRateLimit(limiter, cfg.AnonRateLimitPerMin)
|
||||
|
||||
srv := &http.Server{
|
||||
Addr: cfg.Addr,
|
||||
|
||||
@@ -5,13 +5,17 @@ go 1.23.4
|
||||
require (
|
||||
github.com/go-chi/chi/v5 v5.1.0
|
||||
github.com/jackc/pgx/v5 v5.7.2
|
||||
github.com/redis/go-redis/v9 v9.18.0
|
||||
golang.org/x/crypto v0.31.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/cespare/xxhash/v2 v2.3.0 // indirect
|
||||
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
|
||||
github.com/jackc/pgpassfile v1.0.0 // indirect
|
||||
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
|
||||
github.com/jackc/puddle/v2 v2.2.2 // indirect
|
||||
go.uber.org/atomic v1.11.0 // indirect
|
||||
golang.org/x/sync v0.10.0 // indirect
|
||||
golang.org/x/text v0.21.0 // indirect
|
||||
)
|
||||
|
||||
+16
@@ -1,6 +1,14 @@
|
||||
github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs=
|
||||
github.com/bsm/ginkgo/v2 v2.12.0/go.mod h1:SwYbGRRDovPVboqFv0tPTcG1sN61LM1Z4ARdbAV9g4c=
|
||||
github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA=
|
||||
github.com/bsm/gomega v1.27.10/go.mod h1:JyEr/xRbxbtgWNi8tIEVPUYZ5Dzef52k01W3YH0H+O0=
|
||||
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
|
||||
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
|
||||
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
|
||||
github.com/go-chi/chi/v5 v5.1.0 h1:acVI1TYaD+hhedDJ3r54HyA6sExp3HfXq7QWEEY/xMw=
|
||||
github.com/go-chi/chi/v5 v5.1.0/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
|
||||
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
|
||||
@@ -11,13 +19,21 @@ github.com/jackc/pgx/v5 v5.7.2 h1:mLoDLV6sonKlvjIEsV56SkWNCnuNv531l94GaIzO+XI=
|
||||
github.com/jackc/pgx/v5 v5.7.2/go.mod h1:ncY89UGWxg82EykZUwSpUKEfccBGGYq1xjrOpsbsfGQ=
|
||||
github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
|
||||
github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
|
||||
github.com/klauspost/cpuid/v2 v2.0.9 h1:lgaqFMSdTdQYdZ04uHyN2d/eKdOMyi2YLSvlQIBFYa4=
|
||||
github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/redis/go-redis/v9 v9.18.0 h1:pMkxYPkEbMPwRdenAzUNyFNrDgHx9U+DrBabWNfSRQs=
|
||||
github.com/redis/go-redis/v9 v9.18.0/go.mod h1:k3ufPphLU5YXwNTUcCRXGxUoF1fqxnhFQmscfkCoDA0=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
||||
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
||||
github.com/zeebo/xxh3 v1.0.2 h1:xZmwmqxHZA8AI603jOQ0tMqmBr9lPeFwGg6d+xy9DC0=
|
||||
github.com/zeebo/xxh3 v1.0.2/go.mod h1:5NWz9Sef7zIDm2JHfFlcQvNekmcEl9ekUZQQKCYaDcA=
|
||||
go.uber.org/atomic v1.11.0 h1:ZvwS0R+56ePWxUNi+Atn9dWONBPp/AUETXlHW0DxSjE=
|
||||
go.uber.org/atomic v1.11.0/go.mod h1:LUxbIzbOniOlMKjJjyPfpl4v+PKK2cNJn91OQbhoJI0=
|
||||
golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=
|
||||
golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
|
||||
golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ=
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
package adminhandler
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/go-chi/chi/v5"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/adminstore"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/auth"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/ratelimit"
|
||||
)
|
||||
|
||||
// apiKeyView is an issued key plus its usage counters.
|
||||
type apiKeyView struct {
|
||||
adminstore.APIKeyRow
|
||||
Usage ratelimit.UsageStat `json:"usage"`
|
||||
}
|
||||
|
||||
// ListAPIKeys returns all issued keys with usage stats merged in.
|
||||
func (h *Handler) ListAPIKeys(w http.ResponseWriter, r *http.Request) {
|
||||
keys, err := h.store.ListAPIKeys(r.Context())
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
views := make([]apiKeyView, 0, len(keys))
|
||||
for _, k := range keys {
|
||||
v := apiKeyView{APIKeyRow: k}
|
||||
if h.usage != nil {
|
||||
v.Usage = h.usage.Usage(r.Context(), k.ID)
|
||||
}
|
||||
views = append(views, v)
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]any{"items": views})
|
||||
}
|
||||
|
||||
// CreateAPIKey issues a new key and returns its plaintext exactly once.
|
||||
func (h *Handler) CreateAPIKey(w http.ResponseWriter, r *http.Request) {
|
||||
var in adminstore.APIKeyInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
if strings.TrimSpace(in.Name) == "" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "名称不能为空")
|
||||
return
|
||||
}
|
||||
if in.Tier != "" && in.Tier != "free" && in.Tier != "partner" && in.Tier != "internal" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "tier 取值无效")
|
||||
return
|
||||
}
|
||||
plaintext, row, err := h.store.CreateAPIKey(r.Context(), in, auth.UserFrom(r.Context()))
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusCreated, map[string]any{
|
||||
"key": plaintext,
|
||||
"item": row,
|
||||
"warning": "请立即复制保存此密钥,它只显示这一次,无法再次查看。",
|
||||
})
|
||||
}
|
||||
|
||||
// RevokeAPIKey disables a key. Subsequent requests with it are rejected.
|
||||
func (h *Handler) RevokeAPIKey(w http.ResponseWriter, r *http.Request) {
|
||||
if err := h.store.RevokeAPIKey(r.Context(), chi.URLParam(r, "id")); h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]string{"status": "revoked"})
|
||||
}
|
||||
@@ -16,6 +16,7 @@ import (
|
||||
"github.com/baicai2026-baicai/goods/api/internal/adminstore"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/auth"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/gtin"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/ratelimit"
|
||||
)
|
||||
|
||||
// Handler holds the admin dependencies.
|
||||
@@ -25,6 +26,7 @@ type Handler struct {
|
||||
basePath string
|
||||
spa fs.FS
|
||||
submitLimit *rateLimiter
|
||||
usage *ratelimit.Limiter
|
||||
}
|
||||
|
||||
// New constructs an admin Handler. basePath is e.g. "/ping" (no trailing slash).
|
||||
@@ -39,6 +41,13 @@ func New(store *adminstore.Store, authn *auth.Authenticator, basePath string, sp
|
||||
}
|
||||
}
|
||||
|
||||
// WithUsage attaches a Redis-backed limiter used to read per-key usage counters
|
||||
// for the API-key management view. Optional; without it usage shows as zero.
|
||||
func (h *Handler) WithUsage(l *ratelimit.Limiter) *Handler {
|
||||
h.usage = l
|
||||
return h
|
||||
}
|
||||
|
||||
// Router builds the HTTP handler.
|
||||
func (h *Handler) Router() http.Handler {
|
||||
r := chi.NewRouter()
|
||||
@@ -55,7 +64,11 @@ func (h *Handler) Router() http.Handler {
|
||||
r.Group(func(r chi.Router) {
|
||||
r.Use(h.authn.Middleware)
|
||||
r.Get("/api/me", h.Me)
|
||||
r.Get("/api/stats", h.Stats)
|
||||
r.Get("/api/audit", h.ListAllAudit)
|
||||
r.Get("/api/products", h.ListProducts)
|
||||
r.Post("/api/products", h.CreateProduct)
|
||||
r.Post("/api/products/bulk", h.BulkProducts)
|
||||
r.Get("/api/products/{id}", h.GetProduct)
|
||||
r.Put("/api/products/{id}", h.UpdateProduct)
|
||||
r.Get("/api/products/{id}/audit", h.ListAudit)
|
||||
@@ -67,12 +80,23 @@ func (h *Handler) Router() http.Handler {
|
||||
r.Delete("/api/products/{id}/barcodes/{barcodeID}", h.DeleteBarcode)
|
||||
r.Post("/api/products/{id}/barcodes/{barcodeID}/primary", h.SetPrimaryBarcode)
|
||||
r.Get("/api/brands", h.ListBrands)
|
||||
r.Post("/api/brands", h.CreateBrand)
|
||||
r.Put("/api/brands/{id}", h.UpdateBrand)
|
||||
r.Post("/api/brands/{id}/merge", h.MergeBrands)
|
||||
r.Delete("/api/brands/{id}", h.DeleteBrand)
|
||||
r.Get("/api/categories", h.ListCategories)
|
||||
r.Post("/api/categories", h.CreateCategory)
|
||||
r.Put("/api/categories/{id}", h.UpdateCategory)
|
||||
r.Delete("/api/categories/{id}", h.DeleteCategory)
|
||||
|
||||
r.Get("/api/submissions", h.ListSubmissions)
|
||||
r.Get("/api/submissions/{id}", h.GetSubmission)
|
||||
r.Post("/api/submissions/{id}/approve", h.ApproveSubmission)
|
||||
r.Post("/api/submissions/{id}/reject", h.RejectSubmission)
|
||||
|
||||
r.Get("/api/keys", h.ListAPIKeys)
|
||||
r.Post("/api/keys", h.CreateAPIKey)
|
||||
r.Delete("/api/keys/{id}", h.RevokeAPIKey)
|
||||
})
|
||||
|
||||
r.Handle("/*", http.HandlerFunc(h.serveSPA))
|
||||
@@ -159,6 +183,99 @@ func (h *Handler) GetProduct(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusOK, d)
|
||||
}
|
||||
|
||||
// CreateProduct adds a new product with core fields; the rest is filled in via
|
||||
// the detail editor.
|
||||
func (h *Handler) CreateProduct(w http.ResponseWriter, r *http.Request) {
|
||||
var in adminstore.ProductInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
if strings.TrimSpace(in.Name) == "" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "名称不能为空")
|
||||
return
|
||||
}
|
||||
d, err := h.store.CreateProduct(r.Context(), auth.UserFrom(r.Context()), in)
|
||||
if errors.Is(err, adminstore.ErrDuplicateGTIN) {
|
||||
writeError(w, http.StatusConflict, "duplicate_gtin", "该条码(GTIN)已被其它商品使用")
|
||||
return
|
||||
}
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusCreated, d)
|
||||
}
|
||||
|
||||
// Stats returns the dashboard overview counters.
|
||||
func (h *Handler) Stats(w http.ResponseWriter, r *http.Request) {
|
||||
st, err := h.store.Stats(r.Context())
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, st)
|
||||
}
|
||||
|
||||
// ListAllAudit returns a page of the global operations audit log.
|
||||
func (h *Handler) ListAllAudit(w http.ResponseWriter, r *http.Request) {
|
||||
page, size := pageParams(r)
|
||||
items, total, err := h.store.ListAllAudit(r.Context(), size, (page-1)*size)
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]any{
|
||||
"items": items, "page": page, "size": size, "total": total,
|
||||
})
|
||||
}
|
||||
|
||||
type bulkInput struct {
|
||||
IDs []string `json:"ids"`
|
||||
Action string `json:"action"`
|
||||
Status string `json:"status"`
|
||||
CategoryID *string `json:"category_id"`
|
||||
}
|
||||
|
||||
// BulkProducts applies a status or category change to many products at once.
|
||||
func (h *Handler) BulkProducts(w http.ResponseWriter, r *http.Request) {
|
||||
var in bulkInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
if len(in.IDs) == 0 {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "未选择任何商品")
|
||||
return
|
||||
}
|
||||
actor := auth.UserFrom(r.Context())
|
||||
var (
|
||||
affected int
|
||||
err error
|
||||
)
|
||||
switch in.Action {
|
||||
case "status":
|
||||
affected, err = h.store.BulkSetStatus(r.Context(), actor, in.IDs, in.Status)
|
||||
case "category":
|
||||
affected, err = h.store.BulkSetCategory(r.Context(), actor, in.IDs, in.CategoryID)
|
||||
default:
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "未知的批量操作")
|
||||
return
|
||||
}
|
||||
switch {
|
||||
case errors.Is(err, adminstore.ErrInvalidStatus):
|
||||
writeError(w, http.StatusBadRequest, "invalid_status", "无效的状态值")
|
||||
return
|
||||
case errors.Is(err, adminstore.ErrInvalidParent):
|
||||
writeError(w, http.StatusBadRequest, "invalid_parent", "目标分类无效")
|
||||
return
|
||||
case errors.Is(err, adminstore.ErrNoTargets):
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "未选择任何商品")
|
||||
return
|
||||
}
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]any{"status": "ok", "affected": affected})
|
||||
}
|
||||
|
||||
// UpdateProduct applies an edit.
|
||||
func (h *Handler) UpdateProduct(w http.ResponseWriter, r *http.Request) {
|
||||
var in adminstore.ProductInput
|
||||
@@ -315,6 +432,164 @@ func (h *Handler) ListCategories(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusOK, map[string]any{"items": items})
|
||||
}
|
||||
|
||||
// CreateCategory adds a category node.
|
||||
func (h *Handler) CreateCategory(w http.ResponseWriter, r *http.Request) {
|
||||
var in adminstore.CategoryInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
if strings.TrimSpace(in.NameZH) == "" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "分类名称不能为空")
|
||||
return
|
||||
}
|
||||
c, err := h.store.CreateCategory(r.Context(), auth.UserFrom(r.Context()), in)
|
||||
if h.handleCategoryErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusCreated, c)
|
||||
}
|
||||
|
||||
// UpdateCategory renames and/or moves a category node.
|
||||
func (h *Handler) UpdateCategory(w http.ResponseWriter, r *http.Request) {
|
||||
var in adminstore.CategoryInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
if strings.TrimSpace(in.NameZH) == "" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "分类名称不能为空")
|
||||
return
|
||||
}
|
||||
c, err := h.store.UpdateCategory(r.Context(), chi.URLParam(r, "id"), auth.UserFrom(r.Context()), in)
|
||||
if h.handleCategoryErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, c)
|
||||
}
|
||||
|
||||
// DeleteCategory removes a leaf category that no product uses.
|
||||
func (h *Handler) DeleteCategory(w http.ResponseWriter, r *http.Request) {
|
||||
err := h.store.DeleteCategory(r.Context(), chi.URLParam(r, "id"), auth.UserFrom(r.Context()))
|
||||
if h.handleCategoryErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]string{"status": "deleted"})
|
||||
}
|
||||
|
||||
// handleCategoryErr maps category-specific errors to client statuses, falling
|
||||
// back to handleErr otherwise.
|
||||
func (h *Handler) handleCategoryErr(w http.ResponseWriter, err error) bool {
|
||||
if err == nil {
|
||||
return false
|
||||
}
|
||||
switch {
|
||||
case errors.Is(err, adminstore.ErrDuplicatePath):
|
||||
writeError(w, http.StatusConflict, "duplicate_path", "该分类路径已存在,请换一个英文标识(slug)")
|
||||
return true
|
||||
case errors.Is(err, adminstore.ErrCategoryHasChildren):
|
||||
writeError(w, http.StatusConflict, "has_children", "该分类存在子分类,请先删除或移动其子分类")
|
||||
return true
|
||||
case errors.Is(err, adminstore.ErrCategoryInUse):
|
||||
writeError(w, http.StatusConflict, "in_use", "仍有商品归属于该分类,请先改归其它分类")
|
||||
return true
|
||||
case errors.Is(err, adminstore.ErrInvalidParent):
|
||||
writeError(w, http.StatusBadRequest, "invalid_parent", "上级分类无效(不存在或不能移动到自身/子级下)")
|
||||
return true
|
||||
}
|
||||
return h.handleErr(w, err)
|
||||
}
|
||||
|
||||
type brandInput struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
type brandMergeInput struct {
|
||||
TargetID string `json:"target_id"`
|
||||
}
|
||||
|
||||
// CreateBrand adds a brand.
|
||||
func (h *Handler) CreateBrand(w http.ResponseWriter, r *http.Request) {
|
||||
var in brandInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
if strings.TrimSpace(in.Name) == "" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "品牌名称不能为空")
|
||||
return
|
||||
}
|
||||
b, err := h.store.CreateBrand(r.Context(), auth.UserFrom(r.Context()), in.Name)
|
||||
if h.handleBrandErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusCreated, b)
|
||||
}
|
||||
|
||||
// UpdateBrand renames a brand.
|
||||
func (h *Handler) UpdateBrand(w http.ResponseWriter, r *http.Request) {
|
||||
var in brandInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
if strings.TrimSpace(in.Name) == "" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "品牌名称不能为空")
|
||||
return
|
||||
}
|
||||
b, err := h.store.UpdateBrand(r.Context(), chi.URLParam(r, "id"), auth.UserFrom(r.Context()), in.Name)
|
||||
if h.handleBrandErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, b)
|
||||
}
|
||||
|
||||
// MergeBrands folds one brand's products into another, then deletes the source.
|
||||
func (h *Handler) MergeBrands(w http.ResponseWriter, r *http.Request) {
|
||||
var in brandMergeInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
if strings.TrimSpace(in.TargetID) == "" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "请选择合并目标品牌")
|
||||
return
|
||||
}
|
||||
b, err := h.store.MergeBrands(r.Context(), chi.URLParam(r, "id"), in.TargetID, auth.UserFrom(r.Context()))
|
||||
if h.handleBrandErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, b)
|
||||
}
|
||||
|
||||
// DeleteBrand removes a brand no product references.
|
||||
func (h *Handler) DeleteBrand(w http.ResponseWriter, r *http.Request) {
|
||||
err := h.store.DeleteBrand(r.Context(), chi.URLParam(r, "id"), auth.UserFrom(r.Context()))
|
||||
if h.handleBrandErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]string{"status": "deleted"})
|
||||
}
|
||||
|
||||
// handleBrandErr maps brand-specific errors to client statuses.
|
||||
func (h *Handler) handleBrandErr(w http.ResponseWriter, err error) bool {
|
||||
if err == nil {
|
||||
return false
|
||||
}
|
||||
switch {
|
||||
case errors.Is(err, adminstore.ErrDuplicateBrand):
|
||||
writeError(w, http.StatusConflict, "duplicate_brand", "该品牌名称已存在")
|
||||
return true
|
||||
case errors.Is(err, adminstore.ErrBrandInUse):
|
||||
writeError(w, http.StatusConflict, "in_use", "仍有商品使用该品牌,请先改用其它品牌或合并")
|
||||
return true
|
||||
case errors.Is(err, adminstore.ErrInvalidMerge):
|
||||
writeError(w, http.StatusBadRequest, "invalid_merge", "合并目标无效(不存在或与源品牌相同)")
|
||||
return true
|
||||
}
|
||||
return h.handleErr(w, err)
|
||||
}
|
||||
|
||||
// ---------- submissions ----------
|
||||
|
||||
// CreateSubmission accepts an anonymous public contribution into the queue.
|
||||
|
||||
@@ -0,0 +1,130 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgconn"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/apikey"
|
||||
)
|
||||
|
||||
// APIKeyRow is an admin-facing view of an issued API key (never the secret).
|
||||
type APIKeyRow struct {
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
KeyPrefix string `json:"key_prefix"`
|
||||
OwnerEmail *string `json:"owner_email"`
|
||||
Tier string `json:"tier"`
|
||||
RateLimitPerMin int `json:"rate_limit_per_min"`
|
||||
RevokedAt *string `json:"revoked_at"`
|
||||
CreatedBy *string `json:"created_by"`
|
||||
CreatedAt string `json:"created_at"`
|
||||
}
|
||||
|
||||
// APIKeyInput holds the fields accepted when issuing a key.
|
||||
type APIKeyInput struct {
|
||||
Name string `json:"name"`
|
||||
OwnerEmail string `json:"owner_email"`
|
||||
Tier string `json:"tier"`
|
||||
RateLimitPerMin int `json:"rate_limit_per_min"`
|
||||
}
|
||||
|
||||
// CreateAPIKey issues a new key, returning the one-time plaintext alongside the
|
||||
// stored row. Only the SHA-256 hash and a short display prefix are persisted.
|
||||
func (s *Store) CreateAPIKey(ctx context.Context, in APIKeyInput, createdBy string) (plaintext string, row APIKeyRow, err error) {
|
||||
tier := in.Tier
|
||||
if tier == "" {
|
||||
tier = "free"
|
||||
}
|
||||
rate := in.RateLimitPerMin
|
||||
if rate <= 0 {
|
||||
rate = 120
|
||||
}
|
||||
var owner *string
|
||||
if e := strings.TrimSpace(in.OwnerEmail); e != "" {
|
||||
owner = &e
|
||||
}
|
||||
|
||||
key, hash, prefix, err := apikey.Generate()
|
||||
if err != nil {
|
||||
return "", row, err
|
||||
}
|
||||
|
||||
var revoked, created *time.Time
|
||||
var createdByOut *string
|
||||
err = s.pool.QueryRow(ctx, `
|
||||
INSERT INTO api_key (name, key_prefix, key_hash, owner_email, tier, rate_limit_per_min, created_by)
|
||||
VALUES ($1, $2, $3, $4, $5, $6, $7)
|
||||
RETURNING id, name, key_prefix, owner_email, tier, rate_limit_per_min, revoked_at, created_by, created_at`,
|
||||
strings.TrimSpace(in.Name), prefix, hash, owner, tier, rate, createdBy,
|
||||
).Scan(&row.ID, &row.Name, &row.KeyPrefix, &row.OwnerEmail, &row.Tier,
|
||||
&row.RateLimitPerMin, &revoked, &createdByOut, &created)
|
||||
if err != nil {
|
||||
return "", row, err
|
||||
}
|
||||
row.CreatedBy = createdByOut
|
||||
if created != nil {
|
||||
row.CreatedAt = created.Format(time.RFC3339)
|
||||
}
|
||||
return key, row, nil
|
||||
}
|
||||
|
||||
// ListAPIKeys returns all keys (active first, newest first).
|
||||
func (s *Store) ListAPIKeys(ctx context.Context) ([]APIKeyRow, error) {
|
||||
rows, err := s.pool.Query(ctx, `
|
||||
SELECT id, name, key_prefix, owner_email, tier, rate_limit_per_min, revoked_at, created_by, created_at
|
||||
FROM api_key
|
||||
ORDER BY (revoked_at IS NULL) DESC, created_at DESC`)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
out := []APIKeyRow{}
|
||||
for rows.Next() {
|
||||
var r APIKeyRow
|
||||
var revoked, created *time.Time
|
||||
if err := rows.Scan(&r.ID, &r.Name, &r.KeyPrefix, &r.OwnerEmail, &r.Tier,
|
||||
&r.RateLimitPerMin, &revoked, &r.CreatedBy, &created); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if revoked != nil {
|
||||
v := revoked.Format(time.RFC3339)
|
||||
r.RevokedAt = &v
|
||||
}
|
||||
if created != nil {
|
||||
r.CreatedAt = created.Format(time.RFC3339)
|
||||
}
|
||||
out = append(out, r)
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// RevokeAPIKey marks a key revoked. Revoking an already-revoked or missing key
|
||||
// returns ErrNotFound.
|
||||
func (s *Store) RevokeAPIKey(ctx context.Context, id string) error {
|
||||
tag, err := s.pool.Exec(ctx,
|
||||
"UPDATE api_key SET revoked_at = now() WHERE id = $1 AND revoked_at IS NULL", id)
|
||||
if err != nil {
|
||||
if isInvalidUUID(err) {
|
||||
return ErrNotFound
|
||||
}
|
||||
return err
|
||||
}
|
||||
if tag.RowsAffected() == 0 {
|
||||
return ErrNotFound
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// isInvalidUUID reports whether err is a Postgres invalid-UUID-text error,
|
||||
// which happens when a non-UUID id is supplied.
|
||||
func isInvalidUUID(err error) bool {
|
||||
var pgErr *pgconn.PgError
|
||||
if errors.As(err, &pgErr) {
|
||||
return pgErr.Code == "22P02"
|
||||
}
|
||||
return false
|
||||
}
|
||||
@@ -0,0 +1,154 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
)
|
||||
|
||||
// Brand-management errors, mapped to client statuses by the handler.
|
||||
var (
|
||||
// ErrDuplicateBrand is returned when a brand name already exists.
|
||||
ErrDuplicateBrand = errors.New("duplicate brand name")
|
||||
// ErrBrandInUse blocks deleting a brand still referenced by products.
|
||||
ErrBrandInUse = errors.New("brand in use")
|
||||
// ErrInvalidMerge is returned when a merge target is missing or equal to
|
||||
// the source.
|
||||
ErrInvalidMerge = errors.New("invalid merge target")
|
||||
)
|
||||
|
||||
// CreateBrand inserts a new brand. Names are unique by normalized form.
|
||||
func (s *Store) CreateBrand(ctx context.Context, actor, name string) (*Brand, error) {
|
||||
name = strings.TrimSpace(name)
|
||||
if name == "" {
|
||||
return nil, errors.New("name required")
|
||||
}
|
||||
var b Brand
|
||||
err := s.pool.QueryRow(ctx,
|
||||
`INSERT INTO brand (name, normalized_name) VALUES ($1, $2) RETURNING id, name, 0`,
|
||||
name, normBrand(name)).Scan(&b.ID, &b.Name, &b.ProductCount)
|
||||
if isUniqueViolation(err) {
|
||||
return nil, ErrDuplicateBrand
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "create", "brand", &b.ID, []string{"name"}, nil, b)
|
||||
return &b, nil
|
||||
}
|
||||
|
||||
// UpdateBrand renames a brand, keeping the normalized name in sync.
|
||||
func (s *Store) UpdateBrand(ctx context.Context, id, actor, name string) (*Brand, error) {
|
||||
name = strings.TrimSpace(name)
|
||||
if name == "" {
|
||||
return nil, errors.New("name required")
|
||||
}
|
||||
ct, err := s.pool.Exec(ctx,
|
||||
"UPDATE brand SET name = $1, normalized_name = $2 WHERE id = $3",
|
||||
name, normBrand(name), id)
|
||||
if isUniqueViolation(err) {
|
||||
return nil, ErrDuplicateBrand
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if ct.RowsAffected() == 0 {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
out, err := s.getBrand(ctx, id)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "update", "brand", &id, []string{"name"}, nil, out)
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// MergeBrands reassigns every product of src to dst, then deletes src. Useful
|
||||
// for collapsing duplicate brands (e.g. "可口可乐" and "Coca-Cola").
|
||||
func (s *Store) MergeBrands(ctx context.Context, srcID, dstID, actor string) (*Brand, error) {
|
||||
if srcID == dstID {
|
||||
return nil, ErrInvalidMerge
|
||||
}
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer tx.Rollback(ctx)
|
||||
|
||||
var dstName string
|
||||
err = tx.QueryRow(ctx, "SELECT name FROM brand WHERE id = $1", dstID).Scan(&dstName)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrInvalidMerge
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var srcName string
|
||||
err = tx.QueryRow(ctx, "SELECT name FROM brand WHERE id = $1", srcID).Scan(&srcName)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if _, err := tx.Exec(ctx, "UPDATE product SET brand_id = $1 WHERE brand_id = $2", dstID, srcID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if _, err := tx.Exec(ctx, "DELETE FROM brand WHERE id = $1", srcID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
out, err := s.getBrand(ctx, dstID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "merge", "brand", &srcID, []string{"name"},
|
||||
map[string]string{"name": srcName},
|
||||
map[string]string{"merged_into": dstName, "merged_into_id": dstID})
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// DeleteBrand removes a brand not referenced by any product.
|
||||
func (s *Store) DeleteBrand(ctx context.Context, id, actor string) error {
|
||||
before, err := s.getBrand(ctx, id)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if before.ProductCount > 0 {
|
||||
return fmt.Errorf("%w: %d products", ErrBrandInUse, before.ProductCount)
|
||||
}
|
||||
ct, err := s.pool.Exec(ctx, "DELETE FROM brand WHERE id = $1", id)
|
||||
if err != nil {
|
||||
if isForeignKeyViolation(err) {
|
||||
return ErrBrandInUse
|
||||
}
|
||||
return err
|
||||
}
|
||||
if ct.RowsAffected() == 0 {
|
||||
return ErrNotFound
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "delete", "brand", &id, []string{"name"}, before, nil)
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *Store) getBrand(ctx context.Context, id string) (*Brand, error) {
|
||||
var b Brand
|
||||
err := s.pool.QueryRow(ctx, `
|
||||
SELECT b.id, b.name,
|
||||
(SELECT count(*) FROM product p WHERE p.brand_id = b.id)
|
||||
FROM brand b WHERE b.id = $1`, id).Scan(&b.ID, &b.Name, &b.ProductCount)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &b, nil
|
||||
}
|
||||
@@ -0,0 +1,78 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestBrandLifecycle(t *testing.T) {
|
||||
s := newTestStore(t)
|
||||
ctx := context.Background()
|
||||
|
||||
a, err := s.CreateBrand(ctx, "tester", "品牌A "+randomHex(4))
|
||||
if err != nil {
|
||||
t.Fatalf("create A: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _, _ = s.pool.Exec(ctx, "DELETE FROM brand WHERE id = $1", a.ID) })
|
||||
|
||||
b, err := s.CreateBrand(ctx, "tester", "品牌B "+randomHex(4))
|
||||
if err != nil {
|
||||
t.Fatalf("create B: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _, _ = s.pool.Exec(ctx, "DELETE FROM brand WHERE id = $1", b.ID) })
|
||||
|
||||
// Duplicate (normalized) name must be rejected.
|
||||
if _, err := s.CreateBrand(ctx, "tester", " "+a.Name+" "); !errors.Is(err, ErrDuplicateBrand) {
|
||||
t.Fatalf("expected ErrDuplicateBrand, got %v", err)
|
||||
}
|
||||
|
||||
// Rename.
|
||||
renamed, err := s.UpdateBrand(ctx, a.ID, "tester", "品牌A改名")
|
||||
if err != nil {
|
||||
t.Fatalf("rename: %v", err)
|
||||
}
|
||||
if renamed.Name != "品牌A改名" {
|
||||
t.Fatalf("rename not applied: %q", renamed.Name)
|
||||
}
|
||||
|
||||
// Attach a product to brand A so deletion is blocked and merge moves it.
|
||||
var prodID string
|
||||
err = s.pool.QueryRow(ctx,
|
||||
"INSERT INTO product (name, brand_id, status) VALUES ($1,$2,'active') RETURNING id",
|
||||
"测试商品 "+randomHex(4), a.ID).Scan(&prodID)
|
||||
if err != nil {
|
||||
t.Fatalf("insert product: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _, _ = s.pool.Exec(ctx, "DELETE FROM product WHERE id = $1", prodID) })
|
||||
|
||||
// Deleting an in-use brand must fail.
|
||||
if err := s.DeleteBrand(ctx, a.ID, "tester"); !errors.Is(err, ErrBrandInUse) {
|
||||
t.Fatalf("expected ErrBrandInUse, got %v", err)
|
||||
}
|
||||
|
||||
// Merge A into B: product reassigned, A deleted.
|
||||
merged, err := s.MergeBrands(ctx, a.ID, b.ID, "tester")
|
||||
if err != nil {
|
||||
t.Fatalf("merge: %v", err)
|
||||
}
|
||||
if merged.ID != b.ID || merged.ProductCount < 1 {
|
||||
t.Fatalf("merge result wrong: %+v", merged)
|
||||
}
|
||||
if _, err := s.getBrand(ctx, a.ID); !errors.Is(err, ErrNotFound) {
|
||||
t.Fatalf("source brand should be gone, got %v", err)
|
||||
}
|
||||
|
||||
// Self-merge is invalid.
|
||||
if _, err := s.MergeBrands(ctx, b.ID, b.ID, "tester"); !errors.Is(err, ErrInvalidMerge) {
|
||||
t.Fatalf("expected ErrInvalidMerge, got %v", err)
|
||||
}
|
||||
|
||||
// After moving the product away from B, B can be deleted.
|
||||
if _, err := s.pool.Exec(ctx, "DELETE FROM product WHERE id = $1", prodID); err != nil {
|
||||
t.Fatalf("cleanup product: %v", err)
|
||||
}
|
||||
if err := s.DeleteBrand(ctx, b.ID, "tester"); err != nil {
|
||||
t.Fatalf("delete unused brand: %v", err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
)
|
||||
|
||||
// Bulk-operation errors.
|
||||
var (
|
||||
// ErrNoTargets is returned when a bulk request selects no products.
|
||||
ErrNoTargets = errors.New("no products selected")
|
||||
// ErrInvalidStatus is returned for an unknown product status value.
|
||||
ErrInvalidStatus = errors.New("invalid status")
|
||||
)
|
||||
|
||||
var validStatus = map[string]bool{"active": true, "merged": true, "deprecated": true}
|
||||
|
||||
// BulkSetStatus updates the status of every selected product in one statement.
|
||||
func (s *Store) BulkSetStatus(ctx context.Context, actor string, ids []string, status string) (int, error) {
|
||||
if len(ids) == 0 {
|
||||
return 0, ErrNoTargets
|
||||
}
|
||||
if !validStatus[status] {
|
||||
return 0, ErrInvalidStatus
|
||||
}
|
||||
ct, err := s.pool.Exec(ctx,
|
||||
"UPDATE product SET status = $1 WHERE id = ANY($2)", status, ids)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
n := int(ct.RowsAffected())
|
||||
_ = s.writeAudit(ctx, actor, "bulk_status", "product", nil,
|
||||
[]string{"status"}, map[string]any{"ids": ids}, map[string]any{"status": status})
|
||||
return n, nil
|
||||
}
|
||||
|
||||
// BulkSetCategory reassigns the category of every selected product, syncing the
|
||||
// GPC brick code and recomputing quality for each one.
|
||||
func (s *Store) BulkSetCategory(ctx context.Context, actor string, ids []string, categoryID *string) (int, error) {
|
||||
if len(ids) == 0 {
|
||||
return 0, ErrNoTargets
|
||||
}
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
defer tx.Rollback(ctx)
|
||||
|
||||
var gpc *string
|
||||
if categoryID != nil && *categoryID != "" {
|
||||
if err := tx.QueryRow(ctx, "SELECT gpc_brick_code FROM category WHERE id = $1", *categoryID).Scan(&gpc); err != nil {
|
||||
return 0, ErrInvalidParent
|
||||
}
|
||||
} else {
|
||||
categoryID = nil
|
||||
}
|
||||
|
||||
ct, err := tx.Exec(ctx,
|
||||
"UPDATE product SET category_id = $1, gpc_brick_code = $2 WHERE id = ANY($3)",
|
||||
categoryID, gpc, ids)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
for _, id := range ids {
|
||||
if _, err := s.recomputeQualityTx(ctx, tx, id); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
}
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
n := int(ct.RowsAffected())
|
||||
cat := ""
|
||||
if categoryID != nil {
|
||||
cat = *categoryID
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "bulk_category", "product", nil,
|
||||
[]string{"category"}, map[string]any{"ids": ids}, map[string]any{"category_id": cat})
|
||||
return n, nil
|
||||
}
|
||||
@@ -0,0 +1,297 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/rand"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
"fmt"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
"github.com/jackc/pgx/v5/pgconn"
|
||||
)
|
||||
|
||||
// randomHex returns n random lowercase hex characters for fallback ltree slugs.
|
||||
func randomHex(n int) string {
|
||||
b := make([]byte, (n+1)/2)
|
||||
if _, err := rand.Read(b); err != nil {
|
||||
return "x"
|
||||
}
|
||||
return hex.EncodeToString(b)[:n]
|
||||
}
|
||||
|
||||
// Category-management errors, mapped to client statuses by the handler.
|
||||
var (
|
||||
// ErrDuplicatePath is returned when a category path already exists.
|
||||
ErrDuplicatePath = errors.New("duplicate category path")
|
||||
// ErrCategoryHasChildren blocks deleting a node that still has children.
|
||||
ErrCategoryHasChildren = errors.New("category has children")
|
||||
// ErrCategoryInUse blocks deleting a node still referenced by products.
|
||||
ErrCategoryInUse = errors.New("category in use")
|
||||
// ErrInvalidParent is returned for a missing parent or an illegal move
|
||||
// (onto itself or one of its own descendants).
|
||||
ErrInvalidParent = errors.New("invalid parent category")
|
||||
)
|
||||
|
||||
// CategoryInput is the payload accepted when creating or editing a category.
|
||||
// Slug is the ltree label (ASCII); when empty it is derived from NameEN, then
|
||||
// from a random suffix, since ltree labels cannot contain CJK or spaces.
|
||||
type CategoryInput struct {
|
||||
NameZH string `json:"name_zh"`
|
||||
NameEN *string `json:"name_en"`
|
||||
Slug *string `json:"slug"`
|
||||
ParentID *string `json:"parent_id"`
|
||||
GPCBrickCode *string `json:"gpc_brick_code"`
|
||||
}
|
||||
|
||||
var slugInvalid = regexp.MustCompile(`[^a-z0-9_]+`)
|
||||
|
||||
// slugify converts a string into a valid ltree label ([a-z0-9_]).
|
||||
func slugify(s string) string {
|
||||
s = strings.ToLower(strings.TrimSpace(s))
|
||||
s = slugInvalid.ReplaceAllString(s, "_")
|
||||
s = strings.Trim(s, "_")
|
||||
for strings.Contains(s, "__") {
|
||||
s = strings.ReplaceAll(s, "__", "_")
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
// resolveSlug picks an ltree label from the explicit slug, then NameEN, then a
|
||||
// random fallback so a Chinese-only category still gets a valid path label.
|
||||
func resolveSlug(in CategoryInput) string {
|
||||
if in.Slug != nil {
|
||||
if s := slugify(*in.Slug); s != "" {
|
||||
return s
|
||||
}
|
||||
}
|
||||
if in.NameEN != nil {
|
||||
if s := slugify(*in.NameEN); s != "" {
|
||||
return s
|
||||
}
|
||||
}
|
||||
return "cat_" + randomHex(6)
|
||||
}
|
||||
|
||||
func trimPtr(p *string) *string {
|
||||
if p == nil {
|
||||
return nil
|
||||
}
|
||||
t := strings.TrimSpace(*p)
|
||||
if t == "" {
|
||||
return nil
|
||||
}
|
||||
return &t
|
||||
}
|
||||
|
||||
// CreateCategory inserts a new category node. With no parent it becomes a root
|
||||
// (level 0); otherwise its path is parentPath.slug and level is parentLevel+1.
|
||||
func (s *Store) CreateCategory(ctx context.Context, actor string, in CategoryInput) (*Category, error) {
|
||||
name := strings.TrimSpace(in.NameZH)
|
||||
if name == "" {
|
||||
return nil, errors.New("name_zh required")
|
||||
}
|
||||
|
||||
parentPath := ""
|
||||
parentLevel := -1
|
||||
var parentID *string
|
||||
if pid := trimPtr(in.ParentID); pid != nil {
|
||||
var path string
|
||||
var level int
|
||||
err := s.pool.QueryRow(ctx, "SELECT path::text, level FROM category WHERE id = $1", *pid).Scan(&path, &level)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrInvalidParent
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
parentPath, parentLevel, parentID = path, level, pid
|
||||
}
|
||||
|
||||
slug := resolveSlug(in)
|
||||
path := slug
|
||||
if parentPath != "" {
|
||||
path = parentPath + "." + slug
|
||||
}
|
||||
level := parentLevel + 1
|
||||
|
||||
var c Category
|
||||
err := s.pool.QueryRow(ctx, `
|
||||
INSERT INTO category (name_zh, name_en, parent_id, path, gpc_brick_code, level)
|
||||
VALUES ($1, $2, $3, $4::ltree, $5, $6)
|
||||
RETURNING id, name_zh, name_en, path::text, level, parent_id::text, gpc_brick_code, 0`,
|
||||
name, trimPtr(in.NameEN), parentID, path, trimPtr(in.GPCBrickCode), level).
|
||||
Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level, &c.ParentID, &c.GPCBrickCode, &c.ProductCount)
|
||||
if isUniqueViolation(err) {
|
||||
return nil, ErrDuplicatePath
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
_ = s.writeAudit(ctx, actor, "create", "category", &c.ID, []string{"name_zh", "path"}, nil, c)
|
||||
return &c, nil
|
||||
}
|
||||
|
||||
// UpdateCategory renames a node and/or moves it under a new parent. Moving
|
||||
// rewrites the path of the node and every descendant via ltree, keeping level
|
||||
// in sync. Moving a node onto itself or a descendant is rejected.
|
||||
func (s *Store) UpdateCategory(ctx context.Context, id, actor string, in CategoryInput) (*Category, error) {
|
||||
name := strings.TrimSpace(in.NameZH)
|
||||
if name == "" {
|
||||
return nil, errors.New("name_zh required")
|
||||
}
|
||||
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer tx.Rollback(ctx)
|
||||
|
||||
var oldPath string
|
||||
var oldLevel int
|
||||
var oldParent *string
|
||||
err = tx.QueryRow(ctx, "SELECT path::text, level, parent_id::text FROM category WHERE id = $1", id).
|
||||
Scan(&oldPath, &oldLevel, &oldParent)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if _, err := tx.Exec(ctx,
|
||||
"UPDATE category SET name_zh = $1, name_en = $2, gpc_brick_code = $3 WHERE id = $4",
|
||||
name, trimPtr(in.NameEN), trimPtr(in.GPCBrickCode), id); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
newParent := trimPtr(in.ParentID)
|
||||
if !strEq(newParent, oldParent) {
|
||||
if err := s.moveCategoryTx(ctx, tx, id, oldPath, newParent); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
out, err := s.getCategory(ctx, id)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "update", "category", &id, []string{"name_zh", "name_en", "gpc_brick_code", "parent_id"}, nil, out)
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// moveCategoryTx re-parents a subtree. The node's slug (last path label) is
|
||||
// preserved; only its ancestor prefix and level change.
|
||||
func (s *Store) moveCategoryTx(ctx context.Context, tx pgx.Tx, id, oldPath string, newParent *string) error {
|
||||
slug := oldPath
|
||||
if i := strings.LastIndex(oldPath, "."); i >= 0 {
|
||||
slug = oldPath[i+1:]
|
||||
}
|
||||
|
||||
newBase := slug
|
||||
if newParent != nil {
|
||||
var parentPath string
|
||||
err := tx.QueryRow(ctx, "SELECT path::text FROM category WHERE id = $1", *newParent).Scan(&parentPath)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return ErrInvalidParent
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Disallow moving a node under itself or one of its descendants.
|
||||
if parentPath == oldPath || strings.HasPrefix(parentPath, oldPath+".") {
|
||||
return ErrInvalidParent
|
||||
}
|
||||
newBase = parentPath + "." + slug
|
||||
}
|
||||
|
||||
// Rewrite the node and all descendants in one statement; level tracks depth.
|
||||
_, err := tx.Exec(ctx, `
|
||||
UPDATE category
|
||||
SET path = ($1::ltree || subpath(path, nlevel($2::ltree) - 1)),
|
||||
level = nlevel($1::ltree) + (nlevel(path) - nlevel($2::ltree)) - 1
|
||||
WHERE path = $2::ltree OR path <@ $2::ltree`, newBase, oldPath)
|
||||
if isUniqueViolation(err) {
|
||||
return ErrDuplicatePath
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
_, err = tx.Exec(ctx, "UPDATE category SET parent_id = $1 WHERE id = $2", newParent, id)
|
||||
return err
|
||||
}
|
||||
|
||||
// DeleteCategory removes a leaf node not referenced by any product. Nodes with
|
||||
// children or in-use nodes are rejected with a specific error.
|
||||
func (s *Store) DeleteCategory(ctx context.Context, id, actor string) error {
|
||||
before, err := s.getCategory(ctx, id)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var children int
|
||||
if err := s.pool.QueryRow(ctx, "SELECT count(*) FROM category WHERE parent_id = $1", id).Scan(&children); err != nil {
|
||||
return err
|
||||
}
|
||||
if children > 0 {
|
||||
return ErrCategoryHasChildren
|
||||
}
|
||||
|
||||
var products int
|
||||
if err := s.pool.QueryRow(ctx, "SELECT count(*) FROM product WHERE category_id = $1", id).Scan(&products); err != nil {
|
||||
return err
|
||||
}
|
||||
if products > 0 {
|
||||
return fmt.Errorf("%w: %d products", ErrCategoryInUse, products)
|
||||
}
|
||||
|
||||
ct, err := s.pool.Exec(ctx, "DELETE FROM category WHERE id = $1", id)
|
||||
if err != nil {
|
||||
// A concurrent product assignment can still trip the FK.
|
||||
if isForeignKeyViolation(err) {
|
||||
return ErrCategoryInUse
|
||||
}
|
||||
return err
|
||||
}
|
||||
if ct.RowsAffected() == 0 {
|
||||
return ErrNotFound
|
||||
}
|
||||
|
||||
_ = s.writeAudit(ctx, actor, "delete", "category", &id, []string{"path"}, before, nil)
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *Store) getCategory(ctx context.Context, id string) (*Category, error) {
|
||||
var c Category
|
||||
err := s.pool.QueryRow(ctx, `
|
||||
SELECT c.id, c.name_zh, c.name_en, c.path::text, c.level, c.parent_id::text,
|
||||
c.gpc_brick_code,
|
||||
(SELECT count(*) FROM product p WHERE p.category_id = c.id)
|
||||
FROM category c WHERE c.id = $1`, id).
|
||||
Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level, &c.ParentID, &c.GPCBrickCode, &c.ProductCount)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &c, nil
|
||||
}
|
||||
|
||||
func isUniqueViolation(err error) bool {
|
||||
var pgErr *pgconn.PgError
|
||||
return errors.As(err, &pgErr) && pgErr.Code == "23505"
|
||||
}
|
||||
|
||||
func isForeignKeyViolation(err error) bool {
|
||||
var pgErr *pgconn.PgError
|
||||
return errors.As(err, &pgErr) && pgErr.Code == "23503"
|
||||
}
|
||||
@@ -0,0 +1,130 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
)
|
||||
|
||||
// newTestStore connects to the test database, skipping when it is unreachable
|
||||
// or migrations have not been applied.
|
||||
func newTestStore(t *testing.T) *Store {
|
||||
t.Helper()
|
||||
dsn := os.Getenv("OPENGOODS_DATABASE_URL")
|
||||
if dsn == "" {
|
||||
dsn = "postgres://opengoods:opengoods@localhost:5432/opengoods?sslmode=disable"
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||||
defer cancel()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
t.Skipf("no database: %v", err)
|
||||
}
|
||||
if err := pool.Ping(ctx); err != nil {
|
||||
pool.Close()
|
||||
t.Skipf("database not reachable: %v", err)
|
||||
}
|
||||
var hasTable bool
|
||||
if err := pool.QueryRow(ctx, "SELECT to_regclass('public.category') IS NOT NULL").Scan(&hasTable); err != nil || !hasTable {
|
||||
pool.Close()
|
||||
t.Skip("migrations not applied (category missing)")
|
||||
}
|
||||
t.Cleanup(pool.Close)
|
||||
return New(pool)
|
||||
}
|
||||
|
||||
func ptr(s string) *string { return &s }
|
||||
|
||||
func TestCategoryLifecycle(t *testing.T) {
|
||||
s := newTestStore(t)
|
||||
ctx := context.Background()
|
||||
|
||||
root, err := s.CreateCategory(ctx, "tester", CategoryInput{
|
||||
NameZH: "测试根", Slug: ptr("test_root_" + randomHex(6)),
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("create root: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _, _ = s.pool.Exec(ctx, "DELETE FROM category WHERE path <@ $1::ltree", root.Path) })
|
||||
|
||||
if root.Level != 0 || root.ParentID != nil {
|
||||
t.Fatalf("root level/parent wrong: level=%d parent=%v", root.Level, root.ParentID)
|
||||
}
|
||||
|
||||
child, err := s.CreateCategory(ctx, "tester", CategoryInput{
|
||||
NameZH: "测试子", NameEN: ptr("Test Child"), ParentID: &root.ID,
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("create child: %v", err)
|
||||
}
|
||||
if child.Level != 1 || child.ParentID == nil || *child.ParentID != root.ID {
|
||||
t.Fatalf("child hierarchy wrong: %+v", child)
|
||||
}
|
||||
|
||||
// Deleting a node with children must fail.
|
||||
if err := s.DeleteCategory(ctx, root.ID, "tester"); !errors.Is(err, ErrCategoryHasChildren) {
|
||||
t.Fatalf("expected ErrCategoryHasChildren, got %v", err)
|
||||
}
|
||||
|
||||
// Rename child.
|
||||
renamed, err := s.UpdateCategory(ctx, child.ID, "tester", CategoryInput{NameZH: "测试子-改名"})
|
||||
if err != nil {
|
||||
t.Fatalf("rename: %v", err)
|
||||
}
|
||||
if renamed.NameZH != "测试子-改名" {
|
||||
t.Fatalf("rename not applied: %q", renamed.NameZH)
|
||||
}
|
||||
|
||||
// Move child to a second root, descendants' path/level should follow.
|
||||
root2, err := s.CreateCategory(ctx, "tester", CategoryInput{
|
||||
NameZH: "测试根2", Slug: ptr("test_root2_" + randomHex(6)),
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("create root2: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _, _ = s.pool.Exec(ctx, "DELETE FROM category WHERE path <@ $1::ltree", root2.Path) })
|
||||
|
||||
moved, err := s.UpdateCategory(ctx, child.ID, "tester", CategoryInput{NameZH: "测试子-改名", ParentID: &root2.ID})
|
||||
if err != nil {
|
||||
t.Fatalf("move: %v", err)
|
||||
}
|
||||
if moved.ParentID == nil || *moved.ParentID != root2.ID {
|
||||
t.Fatalf("move parent wrong: %+v", moved)
|
||||
}
|
||||
if moved.Level != 1 {
|
||||
t.Fatalf("moved level wrong: %d", moved.Level)
|
||||
}
|
||||
|
||||
// Moving a node under itself must be rejected.
|
||||
if _, err := s.UpdateCategory(ctx, root2.ID, "tester", CategoryInput{NameZH: "测试根2", ParentID: &child.ID}); !errors.Is(err, ErrInvalidParent) {
|
||||
t.Fatalf("expected ErrInvalidParent for self-move, got %v", err)
|
||||
}
|
||||
|
||||
// Duplicate path on create must be rejected.
|
||||
if _, err := s.CreateCategory(ctx, "tester", CategoryInput{NameZH: "dup", Slug: ptr(root.Path)}); !errors.Is(err, ErrDuplicatePath) {
|
||||
t.Fatalf("expected ErrDuplicatePath, got %v", err)
|
||||
}
|
||||
|
||||
// Now the leaf can be deleted.
|
||||
if err := s.DeleteCategory(ctx, child.ID, "tester"); err != nil {
|
||||
t.Fatalf("delete leaf: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSlugify(t *testing.T) {
|
||||
cases := map[string]string{
|
||||
"Cooking Oil": "cooking_oil",
|
||||
" Hello--Wld": "hello_wld",
|
||||
"食品": "",
|
||||
"a__b": "a_b",
|
||||
}
|
||||
for in, want := range cases {
|
||||
if got := slugify(in); got != want {
|
||||
t.Errorf("slugify(%q) = %q, want %q", in, got, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
package adminstore
|
||||
|
||||
import "context"
|
||||
|
||||
// QualifiedMinScore is the quality_score threshold at or above which a product
|
||||
// counts as "qualified" (合格) in admin and public stats.
|
||||
const QualifiedMinScore = 0.6
|
||||
|
||||
// AdminStats summarizes the catalog for the admin overview dashboard.
|
||||
type AdminStats struct {
|
||||
Products int `json:"products"`
|
||||
Qualified int `json:"qualified"`
|
||||
MinScore float64 `json:"min_score"`
|
||||
ByStatus map[string]int `json:"by_status"`
|
||||
Brands int `json:"brands"`
|
||||
Categories int `json:"categories"`
|
||||
Pending int `json:"pending_submissions"`
|
||||
AvgQuality float64 `json:"avg_quality"`
|
||||
}
|
||||
|
||||
// Stats gathers the dashboard counters in a handful of aggregate queries.
|
||||
func (s *Store) Stats(ctx context.Context) (*AdminStats, error) {
|
||||
out := &AdminStats{MinScore: QualifiedMinScore, ByStatus: map[string]int{}}
|
||||
|
||||
if err := s.pool.QueryRow(ctx, `
|
||||
SELECT count(*),
|
||||
count(*) FILTER (WHERE quality_score >= $1 AND status = 'active'),
|
||||
COALESCE(avg(quality_score), 0)
|
||||
FROM product`, QualifiedMinScore).Scan(&out.Products, &out.Qualified, &out.AvgQuality); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
rows, err := s.pool.Query(ctx, "SELECT status, count(*) FROM product GROUP BY status")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
for rows.Next() {
|
||||
var st string
|
||||
var n int
|
||||
if err := rows.Scan(&st, &n); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out.ByStatus[st] = n
|
||||
}
|
||||
if err := rows.Err(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err := s.pool.QueryRow(ctx, "SELECT count(*) FROM brand").Scan(&out.Brands); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := s.pool.QueryRow(ctx, "SELECT count(*) FROM category").Scan(&out.Categories); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := s.pool.QueryRow(ctx,
|
||||
"SELECT count(*) FROM submission WHERE status = 'pending'").Scan(&out.Pending); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
@@ -0,0 +1,71 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestStatsAndBulk(t *testing.T) {
|
||||
s := newTestStore(t)
|
||||
ctx := context.Background()
|
||||
|
||||
base, err := s.Stats(ctx)
|
||||
if err != nil {
|
||||
t.Fatalf("stats: %v", err)
|
||||
}
|
||||
|
||||
var p1, p2 string
|
||||
if err := s.pool.QueryRow(ctx,
|
||||
"INSERT INTO product (name, status) VALUES ($1,'active') RETURNING id",
|
||||
"批量测试1 "+randomHex(4)).Scan(&p1); err != nil {
|
||||
t.Fatalf("insert p1: %v", err)
|
||||
}
|
||||
if err := s.pool.QueryRow(ctx,
|
||||
"INSERT INTO product (name, status) VALUES ($1,'active') RETURNING id",
|
||||
"批量测试2 "+randomHex(4)).Scan(&p2); err != nil {
|
||||
t.Fatalf("insert p2: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _, _ = s.pool.Exec(ctx, "DELETE FROM product WHERE id = ANY($1)", []string{p1, p2}) })
|
||||
|
||||
after, err := s.Stats(ctx)
|
||||
if err != nil {
|
||||
t.Fatalf("stats after: %v", err)
|
||||
}
|
||||
if after.Products != base.Products+2 {
|
||||
t.Fatalf("product count: got %d want %d", after.Products, base.Products+2)
|
||||
}
|
||||
|
||||
// Bulk set status to deprecated.
|
||||
n, err := s.BulkSetStatus(ctx, "tester", []string{p1, p2}, "deprecated")
|
||||
if err != nil || n != 2 {
|
||||
t.Fatalf("bulk status: n=%d err=%v", n, err)
|
||||
}
|
||||
var deprecated int
|
||||
if err := s.pool.QueryRow(ctx,
|
||||
"SELECT count(*) FROM product WHERE id = ANY($1) AND status='deprecated'",
|
||||
[]string{p1, p2}).Scan(&deprecated); err != nil {
|
||||
t.Fatalf("verify: %v", err)
|
||||
}
|
||||
if deprecated != 2 {
|
||||
t.Fatalf("expected 2 deprecated, got %d", deprecated)
|
||||
}
|
||||
|
||||
// Invalid status rejected.
|
||||
if _, err := s.BulkSetStatus(ctx, "tester", []string{p1}, "nope"); err != ErrInvalidStatus {
|
||||
t.Fatalf("expected ErrInvalidStatus, got %v", err)
|
||||
}
|
||||
|
||||
// Empty selection rejected.
|
||||
if _, err := s.BulkSetStatus(ctx, "tester", nil, "active"); err != ErrNoTargets {
|
||||
t.Fatalf("expected ErrNoTargets, got %v", err)
|
||||
}
|
||||
|
||||
// Global audit log should contain the bulk_status entry.
|
||||
rows, total, err := s.ListAllAudit(ctx, 10, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("audit: %v", err)
|
||||
}
|
||||
if total == 0 || len(rows) == 0 {
|
||||
t.Fatalf("expected audit rows, got total=%d", total)
|
||||
}
|
||||
}
|
||||
@@ -170,6 +170,79 @@ ON CONFLICT (product_id) DO UPDATE SET
|
||||
return after, nil
|
||||
}
|
||||
|
||||
// ErrDuplicateGTIN is returned when a product GTIN already exists.
|
||||
var ErrDuplicateGTIN = errors.New("duplicate gtin")
|
||||
|
||||
// CreateProduct inserts a new product from the admin UI. Only the core fields
|
||||
// are required; the operator completes the rest in the detail editor.
|
||||
func (s *Store) CreateProduct(ctx context.Context, actor string, in ProductInput) (*ProductDetail, error) {
|
||||
if strings.TrimSpace(in.Name) == "" {
|
||||
return nil, errors.New("name required")
|
||||
}
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer tx.Rollback(ctx)
|
||||
|
||||
brandID := in.BrandID
|
||||
if in.BrandName != nil && strings.TrimSpace(*in.BrandName) != "" {
|
||||
bid, err := s.ensureBrand(ctx, tx, strings.TrimSpace(*in.BrandName))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
brandID = &bid
|
||||
}
|
||||
|
||||
var gpc *string
|
||||
if in.CategoryID != nil && *in.CategoryID != "" {
|
||||
if err := tx.QueryRow(ctx, "SELECT gpc_brick_code FROM category WHERE id = $1", *in.CategoryID).Scan(&gpc); err != nil && !errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
canonical, err := s.netCanonical(ctx, tx, in.NetContentValue, in.NetContentUnit)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
status := in.Status
|
||||
if status == "" {
|
||||
status = "active"
|
||||
}
|
||||
|
||||
var id string
|
||||
err = tx.QueryRow(ctx, `
|
||||
INSERT INTO product (gtin, name, brand_id, category_id, gpc_brick_code,
|
||||
net_content_value, net_content_unit, net_content_canonical,
|
||||
country_of_origin, status)
|
||||
VALUES ($1,$2,$3,$4,$5,$6,$7,$8,$9,$10)
|
||||
RETURNING id`,
|
||||
in.GTIN, in.Name, brandID, in.CategoryID, gpc,
|
||||
in.NetContentValue, in.NetContentUnit, canonical,
|
||||
in.CountryOfOrigin, status).Scan(&id)
|
||||
if isUniqueViolation(err) {
|
||||
return nil, ErrDuplicateGTIN
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if _, err := s.recomputeQualityTx(ctx, tx, id); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
after, err := s.GetProduct(ctx, id)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "create", "product", &id, []string{"name"}, nil, after)
|
||||
return after, nil
|
||||
}
|
||||
|
||||
func strEq(a, b *string) bool {
|
||||
if a == nil && b == nil {
|
||||
return true
|
||||
@@ -330,15 +403,21 @@ func (s *Store) DeleteMSRP(ctx context.Context, productID, msrpID, actor string)
|
||||
|
||||
// ---------- dictionaries ----------
|
||||
|
||||
// Brand is a brand option for the edit form.
|
||||
// Brand is a brand option for the edit form and the management view.
|
||||
type Brand struct {
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
ProductCount int `json:"product_count"`
|
||||
}
|
||||
|
||||
// ListBrands returns all brands ordered by name.
|
||||
// ListBrands returns all brands ordered by name, with the number of products
|
||||
// referencing each one.
|
||||
func (s *Store) ListBrands(ctx context.Context) ([]Brand, error) {
|
||||
rows, err := s.pool.Query(ctx, "SELECT id, name FROM brand ORDER BY name")
|
||||
rows, err := s.pool.Query(ctx, `
|
||||
SELECT b.id, b.name,
|
||||
(SELECT count(*) FROM product p WHERE p.brand_id = b.id) AS product_count
|
||||
FROM brand b
|
||||
ORDER BY b.name`)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -346,7 +425,7 @@ func (s *Store) ListBrands(ctx context.Context) ([]Brand, error) {
|
||||
out := []Brand{}
|
||||
for rows.Next() {
|
||||
var b Brand
|
||||
if err := rows.Scan(&b.ID, &b.Name); err != nil {
|
||||
if err := rows.Scan(&b.ID, &b.Name, &b.ProductCount); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, b)
|
||||
@@ -354,19 +433,27 @@ func (s *Store) ListBrands(ctx context.Context) ([]Brand, error) {
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// Category is a category option for the edit form.
|
||||
// Category is a category option for the edit form and the management view.
|
||||
type Category struct {
|
||||
ID string `json:"id"`
|
||||
NameZH string `json:"name_zh"`
|
||||
NameEN *string `json:"name_en"`
|
||||
Path string `json:"path"`
|
||||
Level int `json:"level"`
|
||||
ID string `json:"id"`
|
||||
NameZH string `json:"name_zh"`
|
||||
NameEN *string `json:"name_en"`
|
||||
Path string `json:"path"`
|
||||
Level int `json:"level"`
|
||||
ParentID *string `json:"parent_id"`
|
||||
GPCBrickCode *string `json:"gpc_brick_code"`
|
||||
ProductCount int `json:"product_count"`
|
||||
}
|
||||
|
||||
// ListCategories returns the full category tree.
|
||||
// ListCategories returns the full category tree (path order) with the number of
|
||||
// products directly assigned to each node.
|
||||
func (s *Store) ListCategories(ctx context.Context) ([]Category, error) {
|
||||
rows, err := s.pool.Query(ctx,
|
||||
"SELECT id, name_zh, name_en, path::text, level FROM category ORDER BY path")
|
||||
rows, err := s.pool.Query(ctx, `
|
||||
SELECT c.id, c.name_zh, c.name_en, c.path::text, c.level, c.parent_id::text,
|
||||
c.gpc_brick_code,
|
||||
(SELECT count(*) FROM product p WHERE p.category_id = c.id) AS product_count
|
||||
FROM category c
|
||||
ORDER BY c.path`)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -374,7 +461,8 @@ func (s *Store) ListCategories(ctx context.Context) ([]Category, error) {
|
||||
out := []Category{}
|
||||
for rows.Next() {
|
||||
var c Category
|
||||
if err := rows.Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level); err != nil {
|
||||
if err := rows.Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level,
|
||||
&c.ParentID, &c.GPCBrickCode, &c.ProductCount); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, c)
|
||||
@@ -393,6 +481,44 @@ type AuditEntry struct {
|
||||
CreatedAt string `json:"created_at"`
|
||||
}
|
||||
|
||||
// AuditLogRow is one global audit-log row for the operations log view.
|
||||
type AuditLogRow struct {
|
||||
ID string `json:"id"`
|
||||
Actor string `json:"actor"`
|
||||
Action string `json:"action"`
|
||||
Entity string `json:"entity"`
|
||||
EntityID *string `json:"entity_id"`
|
||||
Fields []string `json:"fields"`
|
||||
CreatedAt string `json:"created_at"`
|
||||
}
|
||||
|
||||
// ListAllAudit returns a page of the global audit log, newest first, along with
|
||||
// the total row count.
|
||||
func (s *Store) ListAllAudit(ctx context.Context, limit, offset int) ([]AuditLogRow, int, error) {
|
||||
var total int
|
||||
if err := s.pool.QueryRow(ctx, "SELECT count(*) FROM audit_log").Scan(&total); err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
rows, err := s.pool.Query(ctx, `
|
||||
SELECT id, actor, action, entity, entity_id::text, fields, created_at::text
|
||||
FROM audit_log
|
||||
ORDER BY created_at DESC
|
||||
LIMIT $1 OFFSET $2`, limit, offset)
|
||||
if err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
defer rows.Close()
|
||||
out := []AuditLogRow{}
|
||||
for rows.Next() {
|
||||
var e AuditLogRow
|
||||
if err := rows.Scan(&e.ID, &e.Actor, &e.Action, &e.Entity, &e.EntityID, &e.Fields, &e.CreatedAt); err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
out = append(out, e)
|
||||
}
|
||||
return out, total, rows.Err()
|
||||
}
|
||||
|
||||
// ListAudit returns audit history for one product, newest first.
|
||||
func (s *Store) ListAudit(ctx context.Context, productID string, limit int) ([]AuditEntry, error) {
|
||||
rows, err := s.pool.Query(ctx, `
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
// Package apikey handles generation and hashing of public-API keys.
|
||||
//
|
||||
// A key looks like "og_live_<random>". Only the SHA-256 hash is ever persisted;
|
||||
// the plaintext is returned once at creation time and cannot be recovered.
|
||||
package apikey
|
||||
|
||||
import (
|
||||
"crypto/rand"
|
||||
"crypto/sha256"
|
||||
"encoding/base64"
|
||||
"encoding/hex"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Prefix is the human-readable scheme prefix every key carries.
|
||||
const Prefix = "og_live_"
|
||||
|
||||
// prefixLen is how many leading characters (including Prefix) are stored in
|
||||
// api_key.key_prefix for identifying a key without revealing its secret.
|
||||
const prefixLen = 12
|
||||
|
||||
// Generate returns a new random key (plaintext), its SHA-256 hash, and a short
|
||||
// display prefix. The plaintext must be shown to the caller exactly once.
|
||||
func Generate() (key, hash, displayPrefix string, err error) {
|
||||
buf := make([]byte, 24)
|
||||
if _, err = rand.Read(buf); err != nil {
|
||||
return "", "", "", err
|
||||
}
|
||||
// URL-safe, no padding => stable, copy-pasteable token body.
|
||||
body := base64.RawURLEncoding.EncodeToString(buf)
|
||||
key = Prefix + body
|
||||
hash = Hash(key)
|
||||
displayPrefix = key
|
||||
if len(displayPrefix) > prefixLen {
|
||||
displayPrefix = displayPrefix[:prefixLen]
|
||||
}
|
||||
return key, hash, displayPrefix, nil
|
||||
}
|
||||
|
||||
// Hash returns the hex-encoded SHA-256 of a key, used for storage and lookup.
|
||||
func Hash(key string) string {
|
||||
sum := sha256.Sum256([]byte(strings.TrimSpace(key)))
|
||||
return hex.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
// Looks like a key issued by this service (cheap pre-check before hashing).
|
||||
func IsWellFormed(key string) bool {
|
||||
return strings.HasPrefix(key, Prefix) && len(key) > len(Prefix)+8
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
package apikey
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestGenerate(t *testing.T) {
|
||||
key, hash, prefix, err := Generate()
|
||||
if err != nil {
|
||||
t.Fatalf("Generate: %v", err)
|
||||
}
|
||||
if !IsWellFormed(key) {
|
||||
t.Fatalf("generated key not well-formed: %q", key)
|
||||
}
|
||||
if Hash(key) != hash {
|
||||
t.Fatalf("Hash(key) != returned hash")
|
||||
}
|
||||
if len(prefix) != prefixLen || key[:prefixLen] != prefix {
|
||||
t.Fatalf("prefix %q not a %d-char prefix of key %q", prefix, prefixLen, key)
|
||||
}
|
||||
if len(hash) != 64 {
|
||||
t.Fatalf("hash not hex sha-256: %q", hash)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGenerateUnique(t *testing.T) {
|
||||
seen := map[string]bool{}
|
||||
for i := 0; i < 100; i++ {
|
||||
k, _, _, err := Generate()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if seen[k] {
|
||||
t.Fatalf("duplicate key generated: %q", k)
|
||||
}
|
||||
seen[k] = true
|
||||
}
|
||||
}
|
||||
|
||||
func TestHashStableAndTrimmed(t *testing.T) {
|
||||
if Hash("og_live_abc") != Hash(" og_live_abc ") {
|
||||
t.Fatal("Hash should ignore surrounding whitespace")
|
||||
}
|
||||
if Hash("a") == Hash("b") {
|
||||
t.Fatal("distinct inputs must hash differently")
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsWellFormed(t *testing.T) {
|
||||
cases := map[string]bool{
|
||||
"og_live_abcdefghijkl": true, // body longer than 8 chars
|
||||
"og_live_": false, // empty body
|
||||
"og_live_abc": false, // body too short
|
||||
"nope_abcdefghijkl": false, // wrong prefix
|
||||
"": false,
|
||||
}
|
||||
for in, want := range cases {
|
||||
if got := IsWellFormed(in); got != want {
|
||||
t.Errorf("IsWellFormed(%q) = %v, want %v", in, got, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2,26 +2,38 @@ package config
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strconv"
|
||||
)
|
||||
|
||||
// Config holds runtime configuration for the OpenGoods API server.
|
||||
// Values are read from environment variables with sensible defaults so the
|
||||
// server can boot in a local Docker Compose setup without extra configuration.
|
||||
type Config struct {
|
||||
Addr string
|
||||
DatabaseURL string
|
||||
RedisURL string
|
||||
Addr string
|
||||
DatabaseURL string
|
||||
RedisURL string
|
||||
AnonRateLimitPerMin int
|
||||
}
|
||||
|
||||
// Load reads configuration from the environment.
|
||||
func Load() Config {
|
||||
return Config{
|
||||
Addr: getenv("OPENGOODS_ADDR", ":8080"),
|
||||
DatabaseURL: getenv("OPENGOODS_DATABASE_URL", "postgres://opengoods:opengoods@localhost:5432/opengoods?sslmode=disable"),
|
||||
RedisURL: getenv("OPENGOODS_REDIS_URL", "redis://localhost:6379/0"),
|
||||
Addr: getenv("OPENGOODS_ADDR", ":8080"),
|
||||
DatabaseURL: getenv("OPENGOODS_DATABASE_URL", "postgres://opengoods:opengoods@localhost:5432/opengoods?sslmode=disable"),
|
||||
RedisURL: getenv("OPENGOODS_REDIS_URL", "redis://localhost:6379/0"),
|
||||
AnonRateLimitPerMin: getenvInt("OPENGOODS_ANON_RATE_LIMIT_PER_MIN", 60),
|
||||
}
|
||||
}
|
||||
|
||||
func getenvInt(key string, fallback int) int {
|
||||
if v, ok := os.LookupEnv(key); ok && v != "" {
|
||||
if n, err := strconv.Atoi(v); err == nil && n > 0 {
|
||||
return n
|
||||
}
|
||||
}
|
||||
return fallback
|
||||
}
|
||||
|
||||
func getenv(key, fallback string) string {
|
||||
if v, ok := os.LookupEnv(key); ok && v != "" {
|
||||
return v
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
package handler
|
||||
|
||||
import (
|
||||
_ "embed"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io/fs"
|
||||
@@ -15,26 +16,52 @@ import (
|
||||
"github.com/go-chi/chi/v5"
|
||||
"github.com/go-chi/chi/v5/middleware"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/ratelimit"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/store"
|
||||
)
|
||||
|
||||
//go:embed openapi.json
|
||||
var openAPISpec []byte
|
||||
|
||||
// APIVersion is the current public API version prefix.
|
||||
const APIVersion = "v1"
|
||||
|
||||
// QualifiedMinScore is the quality_score threshold at or above which a product
|
||||
// record is considered "qualified" (合格) for public stats.
|
||||
const QualifiedMinScore = 0.6
|
||||
|
||||
const (
|
||||
defaultPageSize = 20
|
||||
maxPageSize = 100
|
||||
|
||||
// defaultAnonLimit is the per-minute request budget for unauthenticated
|
||||
// callers (identified by client IP) when none is configured.
|
||||
defaultAnonLimit = 60
|
||||
)
|
||||
|
||||
// Handler holds dependencies shared by the HTTP routes.
|
||||
type Handler struct {
|
||||
store *store.Store
|
||||
spa fs.FS
|
||||
store *store.Store
|
||||
spa fs.FS
|
||||
limiter *ratelimit.Limiter
|
||||
anonLimit int
|
||||
}
|
||||
|
||||
// New constructs a Handler backed by the given store. spa may be nil (JSON-only).
|
||||
// Rate limiting is disabled until WithRateLimit is called.
|
||||
func New(s *store.Store, spa fs.FS) *Handler {
|
||||
return &Handler{store: s, spa: spa}
|
||||
return &Handler{store: s, spa: spa, anonLimit: defaultAnonLimit}
|
||||
}
|
||||
|
||||
// WithRateLimit attaches a Redis-backed limiter and the anonymous per-minute
|
||||
// budget, enabling rate limiting + usage tracking on the public API routes.
|
||||
// A non-positive anonPerMin keeps the default.
|
||||
func (h *Handler) WithRateLimit(l *ratelimit.Limiter, anonPerMin int) *Handler {
|
||||
h.limiter = l
|
||||
if anonPerMin > 0 {
|
||||
h.anonLimit = anonPerMin
|
||||
}
|
||||
return h
|
||||
}
|
||||
|
||||
// Router builds the top-level HTTP handler with middleware and routes mounted.
|
||||
@@ -47,16 +74,23 @@ func (h *Handler) Router() http.Handler {
|
||||
r.Get("/healthz", h.Healthz)
|
||||
|
||||
r.Route("/api/"+APIVersion, func(r chi.Router) {
|
||||
r.Route("/products", func(r chi.Router) {
|
||||
r.Get("/barcode/{gtin}", h.ProductByBarcode)
|
||||
r.Get("/search", h.SearchProducts)
|
||||
r.Get("/{id}", h.ProductByID)
|
||||
r.Get("/{id}/nutriments", h.ProductNutriments)
|
||||
r.Get("/{id}/msrp", h.ProductMSRP)
|
||||
// Machine-readable spec; not rate limited so tooling can always fetch it.
|
||||
r.Get("/openapi.json", h.OpenAPI)
|
||||
|
||||
r.Group(func(r chi.Router) {
|
||||
r.Use(h.rateLimit)
|
||||
r.Route("/products", func(r chi.Router) {
|
||||
r.Get("/barcode/{gtin}", h.ProductByBarcode)
|
||||
r.Get("/search", h.SearchProducts)
|
||||
r.Get("/{id}", h.ProductByID)
|
||||
r.Get("/{id}/nutriments", h.ProductNutriments)
|
||||
r.Get("/{id}/msrp", h.ProductMSRP)
|
||||
})
|
||||
r.Get("/brands", h.ListBrands)
|
||||
r.Get("/categories", h.ListCategories)
|
||||
r.Get("/sources/{id}", h.SourceByID)
|
||||
r.Get("/stats", h.Stats)
|
||||
})
|
||||
r.Get("/brands", h.ListBrands)
|
||||
r.Get("/categories", h.ListCategories)
|
||||
r.Get("/sources/{id}", h.SourceByID)
|
||||
})
|
||||
|
||||
// Public SPA (homepage + search + contribute). API routes above take
|
||||
@@ -93,6 +127,21 @@ func (h *Handler) Healthz(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusOK, map[string]string{"status": "ok"})
|
||||
}
|
||||
|
||||
// Stats returns catalog totals and the count of qualified records.
|
||||
func (h *Handler) Stats(w http.ResponseWriter, r *http.Request) {
|
||||
st, err := h.store.Stats(r.Context(), QualifiedMinScore)
|
||||
if h.handleErr(w, r, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, st)
|
||||
}
|
||||
|
||||
// OpenAPI serves the embedded OpenAPI 3 specification for the public API.
|
||||
func (h *Handler) OpenAPI(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||
_, _ = w.Write(openAPISpec)
|
||||
}
|
||||
|
||||
// ProductByBarcode returns a product by its GTIN.
|
||||
func (h *Handler) ProductByBarcode(w http.ResponseWriter, r *http.Request) {
|
||||
p, err := h.store.ProductByGTIN(r.Context(), chi.URLParam(r, "gtin"))
|
||||
@@ -111,13 +160,19 @@ func (h *Handler) ProductByID(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusOK, p)
|
||||
}
|
||||
|
||||
// SearchProducts runs a fuzzy name search with optional category filter + paging.
|
||||
// SearchProducts runs a trigram-fuzzy name search with optional
|
||||
// category/brand/country filters, ranked by relevance, plus paging.
|
||||
func (h *Handler) SearchProducts(w http.ResponseWriter, r *http.Request) {
|
||||
q := r.URL.Query().Get("q")
|
||||
category := r.URL.Query().Get("category")
|
||||
qv := r.URL.Query()
|
||||
filters := store.SearchFilters{
|
||||
Query: strings.TrimSpace(qv.Get("q")),
|
||||
Category: strings.TrimSpace(qv.Get("category")),
|
||||
Brand: strings.TrimSpace(qv.Get("brand")),
|
||||
Country: strings.TrimSpace(qv.Get("country")),
|
||||
}
|
||||
page, size := pageParams(r)
|
||||
|
||||
items, total, err := h.store.SearchProducts(r.Context(), q, category, size, (page-1)*size)
|
||||
items, total, err := h.store.SearchProducts(r.Context(), filters, size, (page-1)*size)
|
||||
if h.handleErr(w, r, err) {
|
||||
return
|
||||
}
|
||||
|
||||
@@ -116,6 +116,101 @@ func TestSearchProducts(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestSearchFuzzyAndFilters(t *testing.T) {
|
||||
h, _ := newTestHandler(t)
|
||||
ctx := context.Background()
|
||||
dsn := os.Getenv("OPENGOODS_DATABASE_URL")
|
||||
if dsn == "" {
|
||||
dsn = "postgres://opengoods:opengoods@localhost:5432/opengoods?sslmode=disable"
|
||||
}
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
t.Skipf("no database: %v", err)
|
||||
}
|
||||
defer pool.Close()
|
||||
|
||||
_, err = pool.Exec(ctx,
|
||||
"INSERT INTO brand (name, normalized_name) VALUES ('ZZ Test Brand','zz test brand') ON CONFLICT DO NOTHING")
|
||||
if err != nil {
|
||||
t.Fatalf("seed brand: %v", err)
|
||||
}
|
||||
_, err = pool.Exec(ctx, `
|
||||
INSERT INTO product (name, brand_id, country_of_origin, quality_score, status)
|
||||
VALUES ('ZZ Hazelnut Chocolate', (SELECT id FROM brand WHERE name='ZZ Test Brand'), 'Testland', 0.5, 'active')`)
|
||||
if err != nil {
|
||||
t.Fatalf("seed product: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(ctx, "DELETE FROM product WHERE name='ZZ Hazelnut Chocolate'")
|
||||
_, _ = pool.Exec(ctx, "DELETE FROM brand WHERE name='ZZ Test Brand'")
|
||||
})
|
||||
|
||||
decode := func(path string) []store.ProductSummary {
|
||||
rec := doGET(t, h, path)
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("%s -> status %d", path, rec.Code)
|
||||
}
|
||||
var body struct {
|
||||
Items []store.ProductSummary `json:"items"`
|
||||
}
|
||||
if err := json.NewDecoder(rec.Body).Decode(&body); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return body.Items
|
||||
}
|
||||
has := func(items []store.ProductSummary, name string) *store.ProductSummary {
|
||||
for i := range items {
|
||||
if items[i].Name == name {
|
||||
return &items[i]
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Typo "choclate" should fuzzy-match via word_similarity and carry a score.
|
||||
got := has(decode("/api/"+APIVersion+"/products/search?q=choclate"), "ZZ Hazelnut Chocolate")
|
||||
if got == nil {
|
||||
t.Fatal("fuzzy query 'choclate' did not match 'ZZ Hazelnut Chocolate'")
|
||||
}
|
||||
if got.Score == nil || *got.Score <= 0 {
|
||||
t.Fatalf("expected positive fuzzy score, got %v", got.Score)
|
||||
}
|
||||
|
||||
// Brand filter.
|
||||
if has(decode("/api/"+APIVersion+"/products/search?brand=ZZ+Test+Brand"), "ZZ Hazelnut Chocolate") == nil {
|
||||
t.Fatal("brand filter did not return the product")
|
||||
}
|
||||
// Country filter (case-insensitive prefix).
|
||||
if has(decode("/api/"+APIVersion+"/products/search?country=test"), "ZZ Hazelnut Chocolate") == nil {
|
||||
t.Fatal("country filter did not return the product")
|
||||
}
|
||||
// Non-matching country excludes it.
|
||||
if has(decode("/api/"+APIVersion+"/products/search?country=france"), "ZZ Hazelnut Chocolate") != nil {
|
||||
t.Fatal("country filter 'france' should not return the product")
|
||||
}
|
||||
}
|
||||
|
||||
func TestOpenAPISpec(t *testing.T) {
|
||||
h, _ := newTestHandler(t)
|
||||
rec := doGET(t, h, "/api/"+APIVersion+"/openapi.json")
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d", rec.Code)
|
||||
}
|
||||
var spec struct {
|
||||
OpenAPI string `json:"openapi"`
|
||||
Paths map[string]any `json:"paths"`
|
||||
}
|
||||
if err := json.NewDecoder(rec.Body).Decode(&spec); err != nil {
|
||||
t.Fatalf("openapi.json is not valid JSON: %v", err)
|
||||
}
|
||||
if spec.OpenAPI == "" || len(spec.Paths) == 0 {
|
||||
t.Fatalf("unexpected spec: %+v", spec)
|
||||
}
|
||||
if _, ok := spec.Paths["/products/search"]; !ok {
|
||||
t.Fatal("spec missing /products/search path")
|
||||
}
|
||||
}
|
||||
|
||||
func TestListCategories(t *testing.T) {
|
||||
h, _ := newTestHandler(t)
|
||||
rec := doGET(t, h, "/api/"+APIVersion+"/categories")
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"net"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/apikey"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/store"
|
||||
)
|
||||
|
||||
type ctxKey int
|
||||
|
||||
const apiKeyIDKey ctxKey = 0
|
||||
|
||||
// rateLimit authenticates an optional API key and enforces a per-minute budget
|
||||
// on the public API. Anonymous callers are limited by client IP at a lower
|
||||
// budget; a valid key raises the budget and attributes usage. An API key that
|
||||
// is present but invalid or revoked is rejected with 401. Rate-limit headers
|
||||
// are set on every response; over-budget callers get 429 + Retry-After.
|
||||
func (h *Handler) rateLimit(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
id := "ip:" + clientIP(r)
|
||||
limit := h.anonLimit
|
||||
keyID := ""
|
||||
|
||||
if raw := presentedKey(r); raw != "" {
|
||||
if !apikey.IsWellFormed(raw) {
|
||||
writeError(w, r, http.StatusUnauthorized, "invalid_api_key", "API key 格式无效")
|
||||
return
|
||||
}
|
||||
k, err := h.store.APIKeyByHash(r.Context(), apikey.Hash(raw))
|
||||
if errors.Is(err, store.ErrNotFound) {
|
||||
writeError(w, r, http.StatusUnauthorized, "invalid_api_key", "API key 无效或已吊销")
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
writeError(w, r, http.StatusInternalServerError, "internal_error", "internal server error")
|
||||
return
|
||||
}
|
||||
keyID = k.ID
|
||||
limit = k.RateLimitPerMin
|
||||
id = "key:" + k.ID
|
||||
}
|
||||
|
||||
res := h.limiter.Allow(r.Context(), id, limit, time.Minute)
|
||||
w.Header().Set("X-RateLimit-Limit", strconv.Itoa(res.Limit))
|
||||
w.Header().Set("X-RateLimit-Remaining", strconv.Itoa(res.Remaining))
|
||||
w.Header().Set("X-RateLimit-Reset", strconv.FormatInt(res.ResetUnix, 10))
|
||||
if !res.Allowed {
|
||||
retry := res.ResetUnix - time.Now().Unix()
|
||||
if retry < 1 {
|
||||
retry = 1
|
||||
}
|
||||
w.Header().Set("Retry-After", strconv.FormatInt(retry, 10))
|
||||
writeError(w, r, http.StatusTooManyRequests, "rate_limited", "请求过于频繁,请稍后再试")
|
||||
return
|
||||
}
|
||||
|
||||
if keyID != "" {
|
||||
h.limiter.RecordUsage(r.Context(), keyID)
|
||||
next.ServeHTTP(w, r.WithContext(context.WithValue(r.Context(), apiKeyIDKey, keyID)))
|
||||
return
|
||||
}
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
// presentedKey extracts an API key from the X-API-Key header or a Bearer token.
|
||||
func presentedKey(r *http.Request) string {
|
||||
if v := strings.TrimSpace(r.Header.Get("X-API-Key")); v != "" {
|
||||
return v
|
||||
}
|
||||
if v := r.Header.Get("Authorization"); strings.HasPrefix(v, "Bearer ") {
|
||||
return strings.TrimSpace(strings.TrimPrefix(v, "Bearer "))
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// clientIP returns the caller IP, preferring chi's RealIP-normalized RemoteAddr.
|
||||
func clientIP(r *http.Request) string {
|
||||
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
|
||||
return host
|
||||
}
|
||||
return r.RemoteAddr
|
||||
}
|
||||
@@ -0,0 +1,120 @@
|
||||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/apikey"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/ratelimit"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/store"
|
||||
)
|
||||
|
||||
// newRateLimitedHandler builds a handler backed by the test DB and a live Redis
|
||||
// limiter, plus a freshly issued API key with the given per-minute limit. It
|
||||
// skips when either backend is unavailable.
|
||||
func newRateLimitedHandler(t *testing.T, keyLimit int) (h *Handler, plaintextKey string) {
|
||||
t.Helper()
|
||||
dsn := os.Getenv("OPENGOODS_DATABASE_URL")
|
||||
if dsn == "" {
|
||||
dsn = "postgres://opengoods:opengoods@localhost:5432/opengoods?sslmode=disable"
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||||
defer cancel()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
t.Skipf("no database: %v", err)
|
||||
}
|
||||
if err := pool.Ping(ctx); err != nil {
|
||||
pool.Close()
|
||||
t.Skipf("database not reachable: %v", err)
|
||||
}
|
||||
var hasTable bool
|
||||
if err := pool.QueryRow(ctx, "SELECT to_regclass('public.api_key') IS NOT NULL").Scan(&hasTable); err != nil || !hasTable {
|
||||
pool.Close()
|
||||
t.Skip("migrations not applied (api_key missing)")
|
||||
}
|
||||
|
||||
redisURL := os.Getenv("OPENGOODS_REDIS_URL")
|
||||
if redisURL == "" {
|
||||
redisURL = "redis://localhost:6379/0"
|
||||
}
|
||||
limiter := ratelimit.New(redisURL)
|
||||
pingCtx, pingCancel := context.WithTimeout(context.Background(), time.Second)
|
||||
defer pingCancel()
|
||||
if err := limiter.Ping(pingCtx); err != nil {
|
||||
pool.Close()
|
||||
t.Skipf("redis not reachable: %v", err)
|
||||
}
|
||||
|
||||
key, hash, prefix, err := apikey.Generate()
|
||||
if err != nil {
|
||||
pool.Close()
|
||||
t.Fatal(err)
|
||||
}
|
||||
name := fmt.Sprintf("test-key-%d", time.Now().UnixNano())
|
||||
if _, err := pool.Exec(context.Background(),
|
||||
`INSERT INTO api_key (name, key_prefix, key_hash, rate_limit_per_min) VALUES ($1,$2,$3,$4)`,
|
||||
name, prefix, hash, keyLimit); err != nil {
|
||||
pool.Close()
|
||||
t.Fatalf("insert api_key: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), "DELETE FROM api_key WHERE key_hash=$1", hash)
|
||||
pool.Close()
|
||||
})
|
||||
|
||||
return New(store.New(pool), nil).WithRateLimit(limiter, 60), key
|
||||
}
|
||||
|
||||
func TestRateLimitHeadersAndKeyAuth(t *testing.T) {
|
||||
h, key := newRateLimitedHandler(t, 100)
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/"+APIVersion+"/categories", nil)
|
||||
req.Header.Set("X-API-Key", key)
|
||||
rec := httptest.NewRecorder()
|
||||
h.Router().ServeHTTP(rec, req)
|
||||
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
if got := rec.Header().Get("X-RateLimit-Limit"); got != "100" {
|
||||
t.Fatalf("X-RateLimit-Limit = %q, want 100 (key limit)", got)
|
||||
}
|
||||
if rec.Header().Get("X-RateLimit-Remaining") == "" {
|
||||
t.Fatal("missing X-RateLimit-Remaining header")
|
||||
}
|
||||
}
|
||||
|
||||
func TestInvalidKeyRejected(t *testing.T) {
|
||||
h, _ := newRateLimitedHandler(t, 100)
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/"+APIVersion+"/categories", nil)
|
||||
req.Header.Set("X-API-Key", "og_live_thiskeydoesnotexist123456")
|
||||
rec := httptest.NewRecorder()
|
||||
h.Router().ServeHTTP(rec, req)
|
||||
if rec.Code != http.StatusUnauthorized {
|
||||
t.Fatalf("status = %d, want 401; body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestRateLimitExceeded(t *testing.T) {
|
||||
h, key := newRateLimitedHandler(t, 1)
|
||||
do := func() int {
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/"+APIVersion+"/categories", nil)
|
||||
req.Header.Set("X-API-Key", key)
|
||||
rec := httptest.NewRecorder()
|
||||
h.Router().ServeHTTP(rec, req)
|
||||
return rec.Code
|
||||
}
|
||||
if code := do(); code != http.StatusOK {
|
||||
t.Fatalf("first request status = %d, want 200", code)
|
||||
}
|
||||
if code := do(); code != http.StatusTooManyRequests {
|
||||
t.Fatalf("second request status = %d, want 429", code)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,186 @@
|
||||
{
|
||||
"openapi": "3.0.3",
|
||||
"info": {
|
||||
"title": "OpenGoods / 天工商品档案公共仓 API",
|
||||
"version": "1.0.0",
|
||||
"description": "Public, read-only product-facts REST API. Anonymous access is allowed at a lower per-minute rate; an optional API key grants a higher rate limit and attributes usage. No purchase or commerce endpoints by design.",
|
||||
"license": { "name": "Data under each source's license (e.g. ODbL)" }
|
||||
},
|
||||
"servers": [{ "url": "https://goods.tangshasha.com/api/v1" }],
|
||||
"tags": [
|
||||
{ "name": "products" },
|
||||
{ "name": "catalog" },
|
||||
{ "name": "meta" }
|
||||
],
|
||||
"security": [{ "ApiKeyHeader": [] }, { "BearerKey": [] }, {}],
|
||||
"paths": {
|
||||
"/products/search": {
|
||||
"get": {
|
||||
"tags": ["products"],
|
||||
"summary": "Search products",
|
||||
"description": "Trigram-fuzzy name search (typo-tolerant) with optional category/brand/country filters, ranked by name similarity blended with data quality_score.",
|
||||
"parameters": [
|
||||
{ "name": "q", "in": "query", "schema": { "type": "string" }, "description": "Keyword (name or barcode); fuzzy-matched. Empty returns all, ordered by quality_score." },
|
||||
{ "name": "category", "in": "query", "schema": { "type": "string" }, "description": "Category code (matches the subtree), e.g. food.beverages." },
|
||||
{ "name": "brand", "in": "query", "schema": { "type": "string" }, "description": "Brand name (fuzzy)." },
|
||||
{ "name": "country", "in": "query", "schema": { "type": "string" }, "description": "Country of origin (case-insensitive prefix)." },
|
||||
{ "name": "page", "in": "query", "schema": { "type": "integer", "default": 1, "minimum": 1 } },
|
||||
{ "name": "size", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 100 } }
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Paged search results.",
|
||||
"headers": {
|
||||
"X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Max requests in the current window." },
|
||||
"X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Remaining requests in the window." },
|
||||
"X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the window resets." }
|
||||
},
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSummary" } },
|
||||
"page": { "type": "integer" },
|
||||
"size": { "type": "integer" },
|
||||
"total": { "type": "integer" }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": { "$ref": "#/components/responses/InvalidApiKey" },
|
||||
"429": { "$ref": "#/components/responses/RateLimited" }
|
||||
}
|
||||
}
|
||||
},
|
||||
"/products/barcode/{gtin}": {
|
||||
"get": {
|
||||
"tags": ["products"],
|
||||
"summary": "Get product by barcode (GTIN)",
|
||||
"parameters": [{ "name": "gtin", "in": "path", "required": true, "schema": { "type": "string" } }],
|
||||
"responses": {
|
||||
"200": { "description": "Product", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } },
|
||||
"404": { "$ref": "#/components/responses/NotFound" },
|
||||
"429": { "$ref": "#/components/responses/RateLimited" }
|
||||
}
|
||||
}
|
||||
},
|
||||
"/products/{id}": {
|
||||
"get": {
|
||||
"tags": ["products"],
|
||||
"summary": "Get product detail by UUID",
|
||||
"parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }],
|
||||
"responses": {
|
||||
"200": { "description": "Product", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } },
|
||||
"404": { "$ref": "#/components/responses/NotFound" }
|
||||
}
|
||||
}
|
||||
},
|
||||
"/products/{id}/nutriments": {
|
||||
"get": {
|
||||
"tags": ["products"],
|
||||
"summary": "Get product nutriments",
|
||||
"parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }],
|
||||
"responses": { "200": { "description": "Nutriments" }, "404": { "$ref": "#/components/responses/NotFound" } }
|
||||
}
|
||||
},
|
||||
"/products/{id}/msrp": {
|
||||
"get": {
|
||||
"tags": ["products"],
|
||||
"summary": "Get manufacturer suggested retail price snapshots (reference only)",
|
||||
"parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }],
|
||||
"responses": { "200": { "description": "MSRP snapshots" } }
|
||||
}
|
||||
},
|
||||
"/brands": {
|
||||
"get": {
|
||||
"tags": ["catalog"],
|
||||
"summary": "List brands",
|
||||
"parameters": [
|
||||
{ "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } },
|
||||
{ "name": "size", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 100 } }
|
||||
],
|
||||
"responses": { "200": { "description": "Paged brands" } }
|
||||
}
|
||||
},
|
||||
"/categories": {
|
||||
"get": { "tags": ["catalog"], "summary": "List the category tree", "responses": { "200": { "description": "Category tree" } } }
|
||||
},
|
||||
"/sources/{id}": {
|
||||
"get": {
|
||||
"tags": ["meta"],
|
||||
"summary": "Get a data source",
|
||||
"parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }],
|
||||
"responses": { "200": { "description": "Source" }, "404": { "$ref": "#/components/responses/NotFound" } }
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"securitySchemes": {
|
||||
"ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "API key, e.g. og_live_xxx. Optional." },
|
||||
"BearerKey": { "type": "http", "scheme": "bearer", "description": "Authorization: Bearer og_live_xxx. Optional." }
|
||||
},
|
||||
"responses": {
|
||||
"NotFound": {
|
||||
"description": "Resource not found.",
|
||||
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }
|
||||
},
|
||||
"RateLimited": {
|
||||
"description": "Rate limit exceeded.",
|
||||
"headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait before retrying." } },
|
||||
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }
|
||||
},
|
||||
"InvalidApiKey": {
|
||||
"description": "API key invalid or revoked.",
|
||||
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }
|
||||
}
|
||||
},
|
||||
"schemas": {
|
||||
"Error": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"error": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": { "type": "string" },
|
||||
"message": { "type": "string" },
|
||||
"request_id": { "type": "string" }
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ProductSummary": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": { "type": "string", "format": "uuid" },
|
||||
"gtin": { "type": "string", "nullable": true },
|
||||
"name": { "type": "string" },
|
||||
"brand": { "type": "string", "nullable": true },
|
||||
"category_path": { "type": "string", "nullable": true },
|
||||
"country_of_origin": { "type": "string", "nullable": true },
|
||||
"quality_score": { "type": "number", "format": "float" },
|
||||
"score": { "type": "number", "format": "float", "nullable": true, "description": "Relevance (name word-similarity) when q is provided; null otherwise." }
|
||||
}
|
||||
},
|
||||
"Product": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": { "type": "string", "format": "uuid" },
|
||||
"gtin": { "type": "string", "nullable": true },
|
||||
"name": { "type": "string" },
|
||||
"brand": { "type": "string", "nullable": true },
|
||||
"category_path": { "type": "string", "nullable": true },
|
||||
"net_content_value": { "type": "number", "nullable": true },
|
||||
"net_content_unit": { "type": "string", "nullable": true },
|
||||
"country_of_origin": { "type": "string", "nullable": true },
|
||||
"quality_score": { "type": "number", "format": "float" },
|
||||
"nutriments": { "type": "object", "additionalProperties": true, "nullable": true },
|
||||
"nutrition_basis": { "type": "string", "nullable": true },
|
||||
"nutri_score": { "type": "string", "nullable": true },
|
||||
"ingredients_text": { "type": "string", "nullable": true }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
// Package ratelimit provides a Redis-backed fixed-window rate limiter and
|
||||
// lightweight per-key usage counters for the public API.
|
||||
//
|
||||
// All state lives in Redis so it is shared across API replicas and visible to
|
||||
// the admin console, and so the public server keeps its read-only contract
|
||||
// against PostgreSQL. Every operation fails open: if Redis is unavailable the
|
||||
// limiter allows the request rather than taking the API down.
|
||||
package ratelimit
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"time"
|
||||
|
||||
"github.com/redis/go-redis/v9"
|
||||
)
|
||||
|
||||
// Limiter throttles callers and records usage. A nil-backed Limiter (when Redis
|
||||
// could not be configured) disables limiting and usage tracking.
|
||||
type Limiter struct {
|
||||
rdb *redis.Client
|
||||
}
|
||||
|
||||
// Result describes the outcome of an Allow check and the headers to surface.
|
||||
type Result struct {
|
||||
Allowed bool
|
||||
Limit int
|
||||
Remaining int
|
||||
ResetUnix int64
|
||||
}
|
||||
|
||||
// UsageStat is the aggregated usage for a single API key.
|
||||
type UsageStat struct {
|
||||
Total int64 `json:"total"`
|
||||
Today int64 `json:"today"`
|
||||
LastUsedAt *int64 `json:"last_used_at,omitempty"`
|
||||
}
|
||||
|
||||
// New builds a Limiter from a redis:// URL. On a parse error it logs and returns
|
||||
// a fail-open limiter (Redis disabled) so the server still boots.
|
||||
func New(redisURL string) *Limiter {
|
||||
opt, err := redis.ParseURL(redisURL)
|
||||
if err != nil {
|
||||
log.Printf("ratelimit: invalid redis url %q: %v (rate limiting disabled)", redisURL, err)
|
||||
return &Limiter{}
|
||||
}
|
||||
return &Limiter{rdb: redis.NewClient(opt)}
|
||||
}
|
||||
|
||||
// Enabled reports whether a Redis backend is configured.
|
||||
func (l *Limiter) Enabled() bool { return l != nil && l.rdb != nil }
|
||||
|
||||
// Ping verifies the Redis backend is reachable. Returns an error if disabled or
|
||||
// unreachable.
|
||||
func (l *Limiter) Ping(ctx context.Context) error {
|
||||
if !l.Enabled() {
|
||||
return redis.ErrClosed
|
||||
}
|
||||
return l.rdb.Ping(ctx).Err()
|
||||
}
|
||||
|
||||
// Allow records a hit for id within a fixed window and reports whether the
|
||||
// caller is under limit. Fails open (Allowed=true) on any Redis error.
|
||||
func (l *Limiter) Allow(ctx context.Context, id string, limit int, window time.Duration) Result {
|
||||
reset := func() int64 {
|
||||
win := int64(window / time.Second)
|
||||
if win < 1 {
|
||||
win = 1
|
||||
}
|
||||
return (time.Now().Unix()/win + 1) * win
|
||||
}
|
||||
if !l.Enabled() {
|
||||
return Result{Allowed: true, Limit: limit, Remaining: limit, ResetUnix: reset()}
|
||||
}
|
||||
win := int64(window / time.Second)
|
||||
if win < 1 {
|
||||
win = 1
|
||||
}
|
||||
bucket := time.Now().Unix() / win
|
||||
key := fmt.Sprintf("rl:%s:%d", id, bucket)
|
||||
|
||||
n, err := l.rdb.Incr(ctx, key).Result()
|
||||
if err != nil {
|
||||
return Result{Allowed: true, Limit: limit, Remaining: limit, ResetUnix: (bucket + 1) * win}
|
||||
}
|
||||
if n == 1 {
|
||||
l.rdb.Expire(ctx, key, time.Duration(win)*time.Second)
|
||||
}
|
||||
remaining := limit - int(n)
|
||||
if remaining < 0 {
|
||||
remaining = 0
|
||||
}
|
||||
return Result{
|
||||
Allowed: int(n) <= limit,
|
||||
Limit: limit,
|
||||
Remaining: remaining,
|
||||
ResetUnix: (bucket + 1) * win,
|
||||
}
|
||||
}
|
||||
|
||||
// RecordUsage increments total/daily counters and stamps last-used for a key.
|
||||
// Best-effort: errors are ignored.
|
||||
func (l *Limiter) RecordUsage(ctx context.Context, keyID string) {
|
||||
if !l.Enabled() || keyID == "" {
|
||||
return
|
||||
}
|
||||
now := time.Now()
|
||||
day := now.Format("20060102")
|
||||
pipe := l.rdb.Pipeline()
|
||||
pipe.Incr(ctx, "usage:total:"+keyID)
|
||||
dayKey := "usage:day:" + keyID + ":" + day
|
||||
pipe.Incr(ctx, dayKey)
|
||||
pipe.Expire(ctx, dayKey, 90*24*time.Hour)
|
||||
pipe.Set(ctx, "usage:last:"+keyID, now.Unix(), 0)
|
||||
_, _ = pipe.Exec(ctx)
|
||||
}
|
||||
|
||||
// Usage reads aggregated usage for a key. Returns a zero-value stat on error.
|
||||
func (l *Limiter) Usage(ctx context.Context, keyID string) UsageStat {
|
||||
var st UsageStat
|
||||
if !l.Enabled() || keyID == "" {
|
||||
return st
|
||||
}
|
||||
day := time.Now().Format("20060102")
|
||||
st.Total, _ = l.rdb.Get(ctx, "usage:total:"+keyID).Int64()
|
||||
st.Today, _ = l.rdb.Get(ctx, "usage:day:"+keyID+":"+day).Int64()
|
||||
if v, err := l.rdb.Get(ctx, "usage:last:"+keyID).Int64(); err == nil {
|
||||
st.LastUsedAt = &v
|
||||
}
|
||||
return st
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
package ratelimit
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// TestDisabledFailsOpen verifies that a Limiter without a Redis backend allows
|
||||
// all requests and reports usage as zero rather than erroring.
|
||||
func TestDisabledFailsOpen(t *testing.T) {
|
||||
l := New("not-a-valid-url") // parse error => disabled
|
||||
if l.Enabled() {
|
||||
t.Fatal("expected limiter to be disabled for invalid url")
|
||||
}
|
||||
res := l.Allow(context.Background(), "x", 1, time.Minute)
|
||||
if !res.Allowed || res.Remaining != 1 {
|
||||
t.Fatalf("disabled limiter must fail open: %+v", res)
|
||||
}
|
||||
// Must not panic and must return zero usage.
|
||||
l.RecordUsage(context.Background(), "k1")
|
||||
if u := l.Usage(context.Background(), "k1"); u.Total != 0 {
|
||||
t.Fatalf("disabled usage should be zero, got %+v", u)
|
||||
}
|
||||
}
|
||||
|
||||
// TestNilReceiverSafe ensures a nil *Limiter is safe to use (handler default).
|
||||
func TestNilReceiverSafe(t *testing.T) {
|
||||
var l *Limiter
|
||||
if l.Enabled() {
|
||||
t.Fatal("nil limiter must report disabled")
|
||||
}
|
||||
res := l.Allow(context.Background(), "x", 5, time.Minute)
|
||||
if !res.Allowed {
|
||||
t.Fatal("nil limiter must fail open")
|
||||
}
|
||||
l.RecordUsage(context.Background(), "k")
|
||||
_ = l.Usage(context.Background(), "k")
|
||||
}
|
||||
|
||||
func testLimiter(t *testing.T) *Limiter {
|
||||
t.Helper()
|
||||
url := os.Getenv("OPENGOODS_REDIS_URL")
|
||||
if url == "" {
|
||||
url = "redis://localhost:6379/0"
|
||||
}
|
||||
l := New(url)
|
||||
if !l.Enabled() {
|
||||
t.Skip("redis not configured")
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
|
||||
defer cancel()
|
||||
if err := l.rdb.Ping(ctx).Err(); err != nil {
|
||||
t.Skipf("redis not reachable: %v", err)
|
||||
}
|
||||
return l
|
||||
}
|
||||
|
||||
func TestAllowFixedWindow(t *testing.T) {
|
||||
l := testLimiter(t)
|
||||
ctx := context.Background()
|
||||
id := fmt.Sprintf("test:%d", time.Now().UnixNano())
|
||||
|
||||
for i := 1; i <= 2; i++ {
|
||||
if res := l.Allow(ctx, id, 2, time.Minute); !res.Allowed {
|
||||
t.Fatalf("request %d should be allowed: %+v", i, res)
|
||||
}
|
||||
}
|
||||
res := l.Allow(ctx, id, 2, time.Minute)
|
||||
if res.Allowed {
|
||||
t.Fatalf("3rd request over limit 2 should be denied: %+v", res)
|
||||
}
|
||||
if res.Remaining != 0 {
|
||||
t.Fatalf("remaining should be 0 when over limit, got %d", res.Remaining)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRecordAndReadUsage(t *testing.T) {
|
||||
l := testLimiter(t)
|
||||
ctx := context.Background()
|
||||
key := fmt.Sprintf("usagekey:%d", time.Now().UnixNano())
|
||||
|
||||
l.RecordUsage(ctx, key)
|
||||
l.RecordUsage(ctx, key)
|
||||
u := l.Usage(ctx, key)
|
||||
if u.Total != 2 || u.Today != 2 {
|
||||
t.Fatalf("expected total=2 today=2, got %+v", u)
|
||||
}
|
||||
if u.LastUsedAt == nil {
|
||||
t.Fatal("expected last-used timestamp to be set")
|
||||
}
|
||||
}
|
||||
+109
-22
@@ -29,6 +29,24 @@ func (s *Store) Ping(ctx context.Context) error {
|
||||
return s.pool.Ping(ctx)
|
||||
}
|
||||
|
||||
// PublicStats summarizes the public catalog for the homepage.
|
||||
type PublicStats struct {
|
||||
Total int `json:"total"`
|
||||
Qualified int `json:"qualified"`
|
||||
MinScore float64 `json:"min_score"`
|
||||
}
|
||||
|
||||
// Stats returns active-product totals and the number of qualified records whose
|
||||
// quality_score meets minScore.
|
||||
func (s *Store) Stats(ctx context.Context, minScore float64) (PublicStats, error) {
|
||||
st := PublicStats{MinScore: minScore}
|
||||
err := s.pool.QueryRow(ctx, `
|
||||
SELECT count(*) FILTER (WHERE status = 'active'),
|
||||
count(*) FILTER (WHERE status = 'active' AND quality_score >= $1)
|
||||
FROM product`, minScore).Scan(&st.Total, &st.Qualified)
|
||||
return st, err
|
||||
}
|
||||
|
||||
// Barcode is one GS1 trade item number attached to a product.
|
||||
type Barcode struct {
|
||||
GTIN string `json:"gtin"`
|
||||
@@ -82,11 +100,22 @@ func (s *Store) ProductBarcodes(ctx context.Context, productID string) ([]Barcod
|
||||
|
||||
// ProductSummary is a lightweight row used in search/listing responses.
|
||||
type ProductSummary struct {
|
||||
ID string `json:"id"`
|
||||
GTIN *string `json:"gtin"`
|
||||
Name string `json:"name"`
|
||||
Brand *string `json:"brand"`
|
||||
CategoryPath *string `json:"category_path"`
|
||||
ID string `json:"id"`
|
||||
GTIN *string `json:"gtin"`
|
||||
Name string `json:"name"`
|
||||
Brand *string `json:"brand"`
|
||||
CategoryPath *string `json:"category_path"`
|
||||
Country *string `json:"country_of_origin"`
|
||||
QualityScore float64 `json:"quality_score"`
|
||||
Score *float64 `json:"score,omitempty"`
|
||||
}
|
||||
|
||||
// SearchFilters bundles the optional filters accepted by SearchProducts.
|
||||
type SearchFilters struct {
|
||||
Query string // fuzzy name / barcode query
|
||||
Category string // ltree path; matches the subtree
|
||||
Brand string // fuzzy brand name
|
||||
Country string // country_of_origin prefix (case-insensitive)
|
||||
}
|
||||
|
||||
const productSelect = `
|
||||
@@ -148,34 +177,67 @@ func (s *Store) ProductByID(ctx context.Context, id string) (*Product, error) {
|
||||
return p, nil
|
||||
}
|
||||
|
||||
// SearchProducts performs a fuzzy name search with optional category subtree filter.
|
||||
func (s *Store) SearchProducts(ctx context.Context, q, category string, limit, offset int) ([]ProductSummary, int, error) {
|
||||
// fuzzyThreshold is the minimum word_similarity for a name to be considered a
|
||||
// fuzzy match. ~0.42 tolerates common typos (e.g. "choclate"→"Chocolate")
|
||||
// without returning unrelated products.
|
||||
const fuzzyThreshold = "0.42"
|
||||
|
||||
// SearchProducts runs a trigram-fuzzy name search with optional category /
|
||||
// brand / country filters. When a query is present, matching is inclusive
|
||||
// (substring OR trigram-similar OR barcode), and results are ranked by name
|
||||
// similarity blended with quality_score so the best, most-complete records
|
||||
// surface first. Without a query, results are ordered by quality_score.
|
||||
func (s *Store) SearchProducts(ctx context.Context, f SearchFilters, limit, offset int) ([]ProductSummary, int, error) {
|
||||
args := []any{}
|
||||
where := "WHERE p.status = 'active'"
|
||||
if q != "" {
|
||||
args = append(args, q)
|
||||
where += ` AND (p.name ILIKE '%' || $1 || '%'
|
||||
|
||||
qIdx := 0
|
||||
if f.Query != "" {
|
||||
args = append(args, f.Query)
|
||||
qIdx = len(args)
|
||||
q := "$" + strconv.Itoa(qIdx)
|
||||
where += ` AND (p.name ILIKE '%' || ` + q + ` || '%'
|
||||
OR word_similarity(` + q + `, p.name) >= ` + fuzzyThreshold + `
|
||||
OR EXISTS (SELECT 1 FROM product_barcode pb
|
||||
WHERE pb.product_id = p.id AND pb.gtin ILIKE '%' || $1 || '%'))`
|
||||
WHERE pb.product_id = p.id AND pb.gtin ILIKE '%' || ` + q + ` || '%'))`
|
||||
}
|
||||
if category != "" {
|
||||
args = append(args, category)
|
||||
if f.Category != "" {
|
||||
args = append(args, f.Category)
|
||||
where += " AND c.path <@ $" + strconv.Itoa(len(args)) + "::ltree"
|
||||
}
|
||||
if f.Brand != "" {
|
||||
args = append(args, f.Brand)
|
||||
where += " AND b.name ILIKE '%' || $" + strconv.Itoa(len(args)) + " || '%'"
|
||||
}
|
||||
if f.Country != "" {
|
||||
args = append(args, f.Country)
|
||||
where += " AND p.country_of_origin ILIKE $" + strconv.Itoa(len(args)) + " || '%'"
|
||||
}
|
||||
|
||||
from := `FROM product p
|
||||
LEFT JOIN brand b ON b.id = p.brand_id
|
||||
LEFT JOIN category c ON c.id = p.category_id `
|
||||
|
||||
countSQL := "SELECT count(*) FROM product p LEFT JOIN category c ON c.id = p.category_id " + where
|
||||
var total int
|
||||
if err := s.pool.QueryRow(ctx, countSQL, args...).Scan(&total); err != nil {
|
||||
if err := s.pool.QueryRow(ctx, "SELECT count(*) "+from+where, args...).Scan(&total); err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
|
||||
// Ranking: when querying, similarity drives order, multiplied by a
|
||||
// quality factor floored at 0.5 so low-quality records aren't zeroed out.
|
||||
scoreExpr := "NULL::real"
|
||||
orderBy := "p.quality_score DESC, p.name"
|
||||
if f.Query != "" {
|
||||
q := "$" + strconv.Itoa(qIdx)
|
||||
scoreExpr = "word_similarity(" + q + ", p.name)"
|
||||
orderBy = scoreExpr + " * (0.5 + p.quality_score) DESC, p.quality_score DESC, p.name"
|
||||
}
|
||||
|
||||
args = append(args, limit, offset)
|
||||
listSQL := `
|
||||
SELECT p.id, p.gtin, p.name, b.name, c.path::text
|
||||
FROM product p
|
||||
LEFT JOIN brand b ON b.id = p.brand_id
|
||||
LEFT JOIN category c ON c.id = p.category_id ` + where +
|
||||
" ORDER BY p.name LIMIT $" + strconv.Itoa(len(args)-1) + " OFFSET $" + strconv.Itoa(len(args))
|
||||
listSQL := "SELECT p.id, p.gtin, p.name, b.name, c.path::text, p.country_of_origin, p.quality_score, " +
|
||||
scoreExpr + " AS score " + from + where +
|
||||
" ORDER BY " + orderBy +
|
||||
" LIMIT $" + strconv.Itoa(len(args)-1) + " OFFSET $" + strconv.Itoa(len(args))
|
||||
|
||||
rows, err := s.pool.Query(ctx, listSQL, args...)
|
||||
if err != nil {
|
||||
@@ -186,7 +248,8 @@ LEFT JOIN category c ON c.id = p.category_id ` + where +
|
||||
out := []ProductSummary{}
|
||||
for rows.Next() {
|
||||
var ps ProductSummary
|
||||
if err := rows.Scan(&ps.ID, &ps.GTIN, &ps.Name, &ps.Brand, &ps.CategoryPath); err != nil {
|
||||
if err := rows.Scan(&ps.ID, &ps.GTIN, &ps.Name, &ps.Brand, &ps.CategoryPath,
|
||||
&ps.Country, &ps.QualityScore, &ps.Score); err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
out = append(out, ps)
|
||||
@@ -305,6 +368,30 @@ func (s *Store) ListCategories(ctx context.Context) ([]Category, error) {
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// APIKey is the minimal metadata the public API needs to authorize a caller.
|
||||
type APIKey struct {
|
||||
ID string
|
||||
Name string
|
||||
RateLimitPerMin int
|
||||
}
|
||||
|
||||
// APIKeyByHash returns the active (non-revoked) key matching a SHA-256 hash,
|
||||
// or ErrNotFound if no such active key exists.
|
||||
func (s *Store) APIKeyByHash(ctx context.Context, hash string) (*APIKey, error) {
|
||||
var k APIKey
|
||||
err := s.pool.QueryRow(ctx,
|
||||
`SELECT id, name, rate_limit_per_min
|
||||
FROM api_key WHERE key_hash = $1 AND revoked_at IS NULL`, hash,
|
||||
).Scan(&k.ID, &k.Name, &k.RateLimitPerMin)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &k, nil
|
||||
}
|
||||
|
||||
// Source describes a data source with its license and trust weight.
|
||||
type Source struct {
|
||||
ID string `json:"id"`
|
||||
|
||||
+117
@@ -0,0 +1,117 @@
|
||||
# OpenGoods 公共 API 开发者文档
|
||||
|
||||
天工商品档案公共仓(OpenGoods)提供**公开、只读**的商品事实 REST API:按条码/名称查询商品的客观资料(品牌、品类、净含量、产地、配料、营养成分、Nutri-Score、厂商建议零售价快照等)。返回均为 JSON(UTF-8)。**本服务不含任何购买/交易接口。**
|
||||
|
||||
- 基础地址:`https://goods.tangshasha.com/api/v1`
|
||||
- 机器可读规范(OpenAPI 3):`GET /api/v1/openapi.json`
|
||||
- 交互式文档:站点「API 调用说明」页
|
||||
|
||||
## 鉴权
|
||||
|
||||
API 默认**匿名可用**,无需任何凭证即可调用。匿名请求按来源 IP 计入一个较低的默认每分钟额度。
|
||||
|
||||
如需更高额度并让用量归属到你,可向运营方申请一枚 **API Key**(形如 `og_live_xxxxxxxx`),请求时二选一携带:
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: og_live_xxxxxxxx" \
|
||||
"https://goods.tangshasha.com/api/v1/products/search?q=牛奶"
|
||||
|
||||
# 或
|
||||
curl -H "Authorization: Bearer og_live_xxxxxxxx" \
|
||||
"https://goods.tangshasha.com/api/v1/products/search?q=牛奶"
|
||||
```
|
||||
|
||||
> 仅在创建时返回一次明文 Key,请妥善保存。服务端只存储其 SHA-256 哈希。
|
||||
|
||||
## 限流
|
||||
|
||||
采用**固定窗口**限流(每分钟)。每个响应都会回写以下响应头:
|
||||
|
||||
| 响应头 | 含义 |
|
||||
| --- | --- |
|
||||
| `X-RateLimit-Limit` | 当前窗口允许的最大请求数 |
|
||||
| `X-RateLimit-Remaining` | 当前窗口剩余可用次数 |
|
||||
| `X-RateLimit-Reset` | 窗口重置的 Unix 时间戳(秒) |
|
||||
| `Retry-After` | 仅在超额(429)时返回,建议等待的秒数 |
|
||||
|
||||
- 超过额度:`429 Too Many Requests`,错误码 `rate_limited`。
|
||||
- Key 无效或已吊销:`401 Unauthorized`,错误码 `invalid_api_key`。
|
||||
|
||||
## 错误格式
|
||||
|
||||
非 2xx 响应体统一为:
|
||||
|
||||
```json
|
||||
{ "error": { "code": "not_found", "message": "…", "request_id": "…" } }
|
||||
```
|
||||
|
||||
## 分页
|
||||
|
||||
列表类接口支持 `page`(默认 `1`)与 `size`(默认 `20`,最大 `100`),响应含 `page`/`size`/`total`。
|
||||
|
||||
## 端点
|
||||
|
||||
### `GET /products/search` — 搜索商品
|
||||
|
||||
按名称做三元组(trigram)模糊搜索,**可容忍错别字**;支持品类/品牌/产地过滤;结果按相关度(名称相似度 × 数据质量分)排序。
|
||||
|
||||
| 参数 | 必填 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `q` | 否 | 关键词(名称/条码),模糊匹配;留空则按质量分返回全部 |
|
||||
| `category` | 否 | 品类编码(含子树),如 `food.beverages` |
|
||||
| `brand` | 否 | 品牌名(模糊匹配),如 `Ferrero` |
|
||||
| `country` | 否 | 产地前缀(不区分大小写),如 `China` |
|
||||
| `page` | 否 | 页码,默认 1 |
|
||||
| `size` | 否 | 每页条数,默认 20,最大 100 |
|
||||
|
||||
```bash
|
||||
curl "https://goods.tangshasha.com/api/v1/products/search?q=nutela&country=Italy"
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"items": [
|
||||
{
|
||||
"id": "…",
|
||||
"gtin": "3017624010701",
|
||||
"name": "Nutella",
|
||||
"brand": "Ferrero",
|
||||
"category_path": "food.snacks.chocolate",
|
||||
"country_of_origin": "Italy",
|
||||
"quality_score": 0.81,
|
||||
"score": 0.71
|
||||
}
|
||||
],
|
||||
"page": 1,
|
||||
"size": 20,
|
||||
"total": 1
|
||||
}
|
||||
```
|
||||
|
||||
`score` 为名称相关度(提供 `q` 时返回,0–1),未提供 `q` 时为 `null`。
|
||||
|
||||
### `GET /products/barcode/{gtin}` — 按条码查询
|
||||
|
||||
```bash
|
||||
curl "https://goods.tangshasha.com/api/v1/products/barcode/5449000000996"
|
||||
```
|
||||
|
||||
### `GET /products/{id}` — 商品详情
|
||||
|
||||
按商品 UUID 获取完整档案(含配料、营养、添加剂、图片、MSRP 等)。
|
||||
|
||||
### `GET /products/{id}/nutriments` — 商品营养成分
|
||||
|
||||
### `GET /products/{id}/msrp` — 厂商建议零售价快照
|
||||
|
||||
官方建议零售价历史快照,仅供参考,不含任何购买入口。
|
||||
|
||||
### `GET /brands` — 品牌列表(分页)
|
||||
|
||||
### `GET /categories` — 品类树
|
||||
|
||||
### `GET /sources/{id}` — 数据来源
|
||||
|
||||
## 免责声明
|
||||
|
||||
数据可能存在误差或滞后,按「现状」提供,不构成医疗/购买建议。商品资料版权归各原始来源所有,请遵循其许可(如 OpenFoodFacts 的 ODbL),引用时请注明天工商品档案公共仓及原始来源。
|
||||
@@ -27,6 +27,9 @@ _DEFAULT_MIN_INTERVAL = 4.0
|
||||
_API_URL = "https://world.openfoodfacts.org/api/v2/product/{barcode}.json"
|
||||
_SEARCH_URL = "https://world.openfoodfacts.org/api/v2/search"
|
||||
|
||||
# HTTP statuses worth retrying: rate limiting and transient server errors.
|
||||
_RETRY_STATUS = frozenset({429, 500, 502, 503, 504})
|
||||
|
||||
# Fields requested from the search API so a returned product can be transformed
|
||||
# without an extra per-barcode round trip.
|
||||
_SEARCH_FIELDS = (
|
||||
@@ -46,9 +49,13 @@ class OpenFoodFactsAdapter:
|
||||
self,
|
||||
client: httpx.Client | None = None,
|
||||
min_interval: float = _DEFAULT_MIN_INTERVAL,
|
||||
max_retries: int = 4,
|
||||
backoff_base: float = 2.0,
|
||||
) -> None:
|
||||
self._client = client or httpx.Client(headers={"User-Agent": USER_AGENT}, timeout=30.0)
|
||||
self._min_interval = min_interval
|
||||
self._max_retries = max_retries
|
||||
self._backoff_base = backoff_base
|
||||
self._last_call = 0.0
|
||||
|
||||
def _throttle(self) -> None:
|
||||
@@ -58,11 +65,49 @@ class OpenFoodFactsAdapter:
|
||||
time.sleep(wait)
|
||||
self._last_call = time.monotonic()
|
||||
|
||||
def _get(self, url: str, params: dict | None = None) -> httpx.Response:
|
||||
"""GET with throttling and retry/backoff on transient errors.
|
||||
|
||||
Retries on connection/timeout errors and on retryable HTTP statuses
|
||||
(429 and 5xx, which OFF returns intermittently when overloaded), using
|
||||
exponential backoff that honours a ``Retry-After`` header when present.
|
||||
"""
|
||||
last_exc: Exception | None = None
|
||||
for attempt in range(self._max_retries + 1):
|
||||
self._throttle()
|
||||
try:
|
||||
resp = self._client.get(url, params=params)
|
||||
except httpx.TransportError as exc:
|
||||
last_exc = exc
|
||||
else:
|
||||
if resp.status_code < 400 or resp.status_code not in _RETRY_STATUS:
|
||||
resp.raise_for_status()
|
||||
return resp
|
||||
last_exc = httpx.HTTPStatusError(
|
||||
f"retryable status {resp.status_code}", request=resp.request, response=resp
|
||||
)
|
||||
if attempt < self._max_retries:
|
||||
retry_after = self._retry_after(last_exc)
|
||||
time.sleep(retry_after if retry_after is not None else self._backoff_base**attempt)
|
||||
assert last_exc is not None
|
||||
raise last_exc
|
||||
|
||||
@staticmethod
|
||||
def _retry_after(exc: Exception | None) -> float | None:
|
||||
resp = getattr(exc, "response", None)
|
||||
if resp is None:
|
||||
return None
|
||||
value = resp.headers.get("Retry-After")
|
||||
if not value:
|
||||
return None
|
||||
try:
|
||||
return float(value)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
def fetch_barcode(self, barcode: str) -> dict | None:
|
||||
"""Fetch a single product by barcode; return the raw `product` dict."""
|
||||
self._throttle()
|
||||
resp = self._client.get(_API_URL.format(barcode=barcode))
|
||||
resp.raise_for_status()
|
||||
resp = self._get(_API_URL.format(barcode=barcode))
|
||||
payload = resp.json()
|
||||
if payload.get("status") != 1:
|
||||
return None
|
||||
@@ -91,8 +136,7 @@ class OpenFoodFactsAdapter:
|
||||
``last_modified_t`` they processed as the next watermark.
|
||||
"""
|
||||
for page in range(1, max_pages + 1):
|
||||
self._throttle()
|
||||
resp = self._client.get(
|
||||
resp = self._get(
|
||||
_SEARCH_URL,
|
||||
params={
|
||||
"fields": _SEARCH_FIELDS,
|
||||
@@ -101,7 +145,6 @@ class OpenFoodFactsAdapter:
|
||||
"page_size": page_size,
|
||||
},
|
||||
)
|
||||
resp.raise_for_status()
|
||||
products = resp.json().get("products") or []
|
||||
if not products:
|
||||
return
|
||||
@@ -114,6 +157,60 @@ class OpenFoodFactsAdapter:
|
||||
if reached_old or len(products) < page_size:
|
||||
return
|
||||
|
||||
def fetch_by_country(
|
||||
self,
|
||||
country: str,
|
||||
*,
|
||||
page_size: int = 100,
|
||||
max_pages: int = 10,
|
||||
sort_by: str = "unique_scans_n",
|
||||
) -> Iterator[dict]:
|
||||
"""Yield products sold in ``country`` (an OFF ``countries_tags_en`` slug).
|
||||
|
||||
Used to seed a market-specific catalogue (e.g. ``china``). Results are
|
||||
sorted by ``sort_by`` (default ``unique_scans_n`` so the most-scanned,
|
||||
best-known products come first) and de-duplicated across pages, since
|
||||
OFF's popularity ordering is not stable between page requests.
|
||||
"""
|
||||
seen: set[str] = set()
|
||||
for page in range(1, max_pages + 1):
|
||||
resp = self._get(
|
||||
_SEARCH_URL,
|
||||
params={
|
||||
"fields": _SEARCH_FIELDS,
|
||||
"countries_tags_en": country,
|
||||
"sort_by": sort_by,
|
||||
"page": page,
|
||||
"page_size": page_size,
|
||||
},
|
||||
)
|
||||
products = resp.json().get("products") or []
|
||||
if not products:
|
||||
return
|
||||
new_on_page = 0
|
||||
for prod in products:
|
||||
code = str(prod.get("code") or "")
|
||||
if code and code in seen:
|
||||
continue
|
||||
if code:
|
||||
seen.add(code)
|
||||
new_on_page += 1
|
||||
yield prod
|
||||
if len(products) < page_size or new_on_page == 0:
|
||||
return
|
||||
|
||||
|
||||
def is_cn_gs1(code: str | None) -> bool:
|
||||
"""Return True for a GS1 China company prefix (barcodes starting 690-699).
|
||||
|
||||
These identify products registered with GS1 China, i.e. genuinely domestic
|
||||
items, as opposed to imported goods merely tagged as sold in China.
|
||||
"""
|
||||
if not code:
|
||||
return False
|
||||
code = code.strip()
|
||||
return len(code) >= 3 and code[:2] == "69" and code[2].isdigit()
|
||||
|
||||
|
||||
def read_dump(path: str | Path) -> Iterator[dict]:
|
||||
"""Yield raw product records from an OFF JSONL dump file.
|
||||
|
||||
@@ -7,6 +7,7 @@ source with field-level provenance in `product_source`.
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
from typing import Any
|
||||
|
||||
@@ -18,6 +19,8 @@ from opengoods.etl.quality import update_quality
|
||||
|
||||
OFF_HOMEPAGE = "https://world.openfoodfacts.org"
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def default_dsn() -> str:
|
||||
return os.environ.get(
|
||||
@@ -196,6 +199,25 @@ def load_record(conn: psycopg.Connection, rec: dict[str, Any], source_id: str, r
|
||||
return product_id
|
||||
|
||||
|
||||
def load_record_safe(
|
||||
conn: psycopg.Connection, rec: dict[str, Any], source_id: str, raw: dict
|
||||
) -> bool:
|
||||
"""Load one record inside a savepoint.
|
||||
|
||||
On success the record's writes stay in the surrounding transaction. On any
|
||||
error, only this record's writes are rolled back (to the savepoint) and the
|
||||
batch continues, so a single malformed source record cannot abort a large
|
||||
import. Returns True if loaded, False if skipped due to an error.
|
||||
"""
|
||||
try:
|
||||
with conn.transaction():
|
||||
load_record(conn, rec, source_id, raw)
|
||||
return True
|
||||
except Exception as exc: # noqa: BLE001 - per-record isolation is intentional
|
||||
logger.warning("skipping record gtin=%s: %s", rec.get("gtin"), exc)
|
||||
return False
|
||||
|
||||
|
||||
def _jsonable(raw: dict) -> dict:
|
||||
"""Drop values that are not JSON-serializable from a raw record."""
|
||||
try:
|
||||
|
||||
@@ -78,6 +78,14 @@ def map_category(raw: dict) -> str | None:
|
||||
return None
|
||||
|
||||
|
||||
def _clamp(value: str | None, max_len: int) -> str | None:
|
||||
"""Trim a string to fit a bounded DB column; external data length varies."""
|
||||
if value is None:
|
||||
return None
|
||||
value = value.strip()
|
||||
return value[:max_len] or None
|
||||
|
||||
|
||||
def _clean_tags(tags: list[str] | None, prefix: str = "") -> list[str]:
|
||||
out: list[str] = []
|
||||
for t in tags or []:
|
||||
@@ -143,16 +151,16 @@ def transform(raw: dict) -> dict | None:
|
||||
"brand": brand,
|
||||
"category_path": map_category(raw),
|
||||
"net_content_value": net_value,
|
||||
"net_content_unit": net_unit,
|
||||
"net_content_unit": _clamp(net_unit, 16),
|
||||
"net_content_canonical": net_canonical,
|
||||
"country_of_origin": (raw.get("countries") or "").split(",")[0].strip() or None,
|
||||
"country_of_origin": _clamp((raw.get("countries") or "").split(",")[0].strip() or None, 64),
|
||||
"food": {
|
||||
"ingredients_text": raw.get("ingredients_text") or None,
|
||||
"allergens": _clean_tags(raw.get("allergens_tags")),
|
||||
"additives": _clean_tags(raw.get("additives_tags")),
|
||||
"nutriments": transform_nutriments(raw.get("nutriments") or {}),
|
||||
"nutrition_basis": "per_100g",
|
||||
"serving_size": raw.get("serving_size") or None,
|
||||
"serving_size": _clamp(raw.get("serving_size") or None, 32),
|
||||
"nutri_score": (raw.get("nutriscore_grade") or "").upper()[:1] or None,
|
||||
},
|
||||
"image_url": raw.get("image_front_url") or raw.get("image_url") or None,
|
||||
|
||||
@@ -7,6 +7,11 @@ Usage:
|
||||
# from a downloaded OFF JSONL dump (optionally .gz), limited to N records
|
||||
python -m opengoods.jobs.seed_off --dump products.jsonl.gz --limit 1000
|
||||
|
||||
# market-focused: the most-scanned products sold in China, restricted to
|
||||
# genuine GS1-China (69x) barcodes
|
||||
python -m opengoods.jobs.seed_off --country china --domestic-only \
|
||||
--max-pages 20 --limit 1000
|
||||
|
||||
The OFF read API is rate-limited client-side; for large imports use a dump.
|
||||
"""
|
||||
|
||||
@@ -18,25 +23,38 @@ from collections.abc import Iterator
|
||||
|
||||
import psycopg
|
||||
|
||||
from opengoods.adapters.openfoodfacts import OpenFoodFactsAdapter, read_dump
|
||||
from opengoods.etl.load import default_dsn, ensure_source, load_record
|
||||
from opengoods.adapters.openfoodfacts import (
|
||||
OpenFoodFactsAdapter,
|
||||
is_cn_gs1,
|
||||
read_dump,
|
||||
)
|
||||
from opengoods.etl.load import default_dsn, ensure_source, load_record_safe
|
||||
from opengoods.etl.transform import transform
|
||||
|
||||
|
||||
def _raw_records(args: argparse.Namespace) -> Iterator[dict]:
|
||||
if args.dump:
|
||||
records = read_dump(args.dump)
|
||||
records: Iterator[dict] = read_dump(args.dump)
|
||||
elif args.country:
|
||||
adapter = OpenFoodFactsAdapter(min_interval=args.min_interval)
|
||||
records = adapter.fetch_by_country(
|
||||
args.country, page_size=args.page_size, max_pages=args.max_pages
|
||||
)
|
||||
else:
|
||||
adapter = OpenFoodFactsAdapter(min_interval=args.min_interval)
|
||||
records = adapter.fetch(args.barcodes)
|
||||
for i, rec in enumerate(records):
|
||||
if args.limit and i >= args.limit:
|
||||
yielded = 0
|
||||
for rec in records:
|
||||
if args.domestic_only and not is_cn_gs1(str(rec.get("code") or "")):
|
||||
continue
|
||||
if args.limit and yielded >= args.limit:
|
||||
break
|
||||
yielded += 1
|
||||
yield rec
|
||||
|
||||
|
||||
def run(args: argparse.Namespace) -> int:
|
||||
loaded = skipped = 0
|
||||
loaded = skipped = errored = 0
|
||||
with psycopg.connect(args.dsn, autocommit=False) as conn:
|
||||
source_id = ensure_source(conn)
|
||||
for raw in _raw_records(args):
|
||||
@@ -44,10 +62,12 @@ def run(args: argparse.Namespace) -> int:
|
||||
if rec is None:
|
||||
skipped += 1
|
||||
continue
|
||||
load_record(conn, rec, source_id, raw)
|
||||
loaded += 1
|
||||
if load_record_safe(conn, rec, source_id, raw):
|
||||
loaded += 1
|
||||
else:
|
||||
errored += 1
|
||||
conn.commit()
|
||||
print(f"loaded={loaded} skipped={skipped}")
|
||||
print(f"loaded={loaded} skipped={skipped} errored={errored}")
|
||||
return 0
|
||||
|
||||
|
||||
@@ -56,7 +76,18 @@ def main(argv: list[str] | None = None) -> int:
|
||||
src = parser.add_mutually_exclusive_group(required=True)
|
||||
src.add_argument("--barcodes", nargs="+", help="barcodes to fetch via the OFF API")
|
||||
src.add_argument("--dump", help="path to an OFF JSONL dump (.jsonl or .jsonl.gz)")
|
||||
src.add_argument(
|
||||
"--country",
|
||||
help="OFF countries_tags_en slug to seed from, e.g. 'china' (most-scanned first)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--domestic-only",
|
||||
action="store_true",
|
||||
help="keep only genuine GS1-China (69x) barcodes; drop imported goods",
|
||||
)
|
||||
parser.add_argument("--limit", type=int, default=0, help="max records to load (0 = all)")
|
||||
parser.add_argument("--page-size", type=int, default=100, help="search page size")
|
||||
parser.add_argument("--max-pages", type=int, default=10, help="max search pages (country mode)")
|
||||
parser.add_argument("--min-interval", type=float, default=4.0, help="API throttle seconds")
|
||||
parser.add_argument("--dsn", default=default_dsn(), help="PostgreSQL DSN")
|
||||
return run(parser.parse_args(argv))
|
||||
|
||||
@@ -17,14 +17,14 @@ import sys
|
||||
import psycopg
|
||||
|
||||
from opengoods.adapters.openfoodfacts import SOURCE_NAME, OpenFoodFactsAdapter
|
||||
from opengoods.etl.load import default_dsn, ensure_source, load_record
|
||||
from opengoods.etl.load import default_dsn, ensure_source, load_record_safe
|
||||
from opengoods.etl.state import get_watermark, set_watermark
|
||||
from opengoods.etl.transform import transform
|
||||
|
||||
|
||||
def run(args: argparse.Namespace) -> int:
|
||||
adapter = OpenFoodFactsAdapter(min_interval=args.min_interval)
|
||||
loaded = skipped = 0
|
||||
loaded = skipped = errored = 0
|
||||
high_watermark = 0
|
||||
with psycopg.connect(args.dsn, autocommit=False) as conn:
|
||||
source_id = ensure_source(conn)
|
||||
@@ -38,16 +38,21 @@ def run(args: argparse.Namespace) -> int:
|
||||
if rec is None:
|
||||
skipped += 1
|
||||
continue
|
||||
load_record(conn, rec, source_id, raw)
|
||||
loaded += 1
|
||||
if load_record_safe(conn, rec, source_id, raw):
|
||||
loaded += 1
|
||||
else:
|
||||
errored += 1
|
||||
set_watermark(
|
||||
conn,
|
||||
SOURCE_NAME,
|
||||
high_watermark,
|
||||
stats={"loaded": loaded, "skipped": skipped, "since": since},
|
||||
stats={"loaded": loaded, "skipped": skipped, "errored": errored, "since": since},
|
||||
)
|
||||
conn.commit()
|
||||
print(f"since={since} loaded={loaded} skipped={skipped} watermark={high_watermark}")
|
||||
print(
|
||||
f"since={since} loaded={loaded} skipped={skipped} "
|
||||
f"errored={errored} watermark={high_watermark}"
|
||||
)
|
||||
return 0
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from opengoods.etl.load import default_dsn, ensure_source, load_record
|
||||
from opengoods.etl.load import default_dsn, ensure_source, load_record, load_record_safe
|
||||
from opengoods.etl.transform import transform
|
||||
|
||||
psycopg = pytest.importorskip("psycopg")
|
||||
@@ -59,3 +59,25 @@ def test_load_record_roundtrip(conn):
|
||||
assert prov[0] >= 1
|
||||
|
||||
conn.rollback() # keep the test DB clean
|
||||
|
||||
|
||||
def test_load_record_safe_isolates_bad_record(conn):
|
||||
source_id = ensure_source(conn)
|
||||
|
||||
# Unique gtin so the good record is a fresh INSERT, not an upsert/update.
|
||||
good = transform(FIXTURE)
|
||||
good["gtin"] = "4006381333931"
|
||||
assert load_record_safe(conn, good, source_id, FIXTURE) is True
|
||||
after_good = conn.execute("SELECT count(*) FROM product").fetchone()[0]
|
||||
|
||||
# A record whose name violates NOT NULL must not abort the batch.
|
||||
bad = dict(good)
|
||||
bad["gtin"] = "5000112637922"
|
||||
bad["name"] = None
|
||||
assert load_record_safe(conn, bad, source_id, {}) is False
|
||||
|
||||
# The good record survived the bad one's rollback-to-savepoint.
|
||||
after_bad = conn.execute("SELECT count(*) FROM product").fetchone()[0]
|
||||
assert after_bad == after_good
|
||||
|
||||
conn.rollback() # keep the test DB clean
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
import httpx
|
||||
|
||||
from opengoods.adapters.openfoodfacts import OpenFoodFactsAdapter, is_cn_gs1
|
||||
|
||||
|
||||
def _adapter(handler, **kwargs):
|
||||
client = httpx.Client(transport=httpx.MockTransport(handler))
|
||||
return OpenFoodFactsAdapter(client=client, min_interval=0, backoff_base=0, **kwargs)
|
||||
|
||||
|
||||
def test_is_cn_gs1():
|
||||
assert is_cn_gs1("6901234567892") # GS1 China prefix
|
||||
assert is_cn_gs1("690")
|
||||
assert not is_cn_gs1("3017624010701") # France
|
||||
assert not is_cn_gs1("5449000000996") # Belgium
|
||||
assert not is_cn_gs1("")
|
||||
assert not is_cn_gs1(None)
|
||||
assert not is_cn_gs1("69") # too short to carry a prefix digit
|
||||
|
||||
|
||||
def test_fetch_by_country_passes_filter_and_paginates():
|
||||
seen_params = []
|
||||
|
||||
def handler(request: httpx.Request) -> httpx.Response:
|
||||
seen_params.append(dict(request.url.params))
|
||||
page = int(request.url.params.get("page", "1"))
|
||||
if page == 1:
|
||||
return httpx.Response(
|
||||
200,
|
||||
json={"products": [{"code": "6901"}, {"code": "6902"}]},
|
||||
)
|
||||
return httpx.Response(200, json={"products": []})
|
||||
|
||||
adapter = _adapter(handler)
|
||||
out = list(adapter.fetch_by_country("china", page_size=2, max_pages=5))
|
||||
assert [p["code"] for p in out] == ["6901", "6902"]
|
||||
assert seen_params[0]["countries_tags_en"] == "china"
|
||||
assert seen_params[0]["sort_by"] == "unique_scans_n"
|
||||
|
||||
|
||||
def test_fetch_by_country_dedupes_across_pages():
|
||||
def handler(request: httpx.Request) -> httpx.Response:
|
||||
page = int(request.url.params.get("page", "1"))
|
||||
if page == 1:
|
||||
return httpx.Response(200, json={"products": [{"code": "6901"}, {"code": "6902"}]})
|
||||
if page == 2:
|
||||
# OFF popularity ordering is unstable; a repeat appears on page 2
|
||||
return httpx.Response(200, json={"products": [{"code": "6902"}, {"code": "6903"}]})
|
||||
return httpx.Response(200, json={"products": []})
|
||||
|
||||
adapter = _adapter(handler)
|
||||
out = [p["code"] for p in adapter.fetch_by_country("china", page_size=2, max_pages=5)]
|
||||
assert out == ["6901", "6902", "6903"]
|
||||
@@ -0,0 +1,59 @@
|
||||
import httpx
|
||||
import pytest
|
||||
|
||||
from opengoods.adapters.openfoodfacts import OpenFoodFactsAdapter
|
||||
|
||||
|
||||
def _adapter(handler, **kwargs):
|
||||
client = httpx.Client(transport=httpx.MockTransport(handler))
|
||||
return OpenFoodFactsAdapter(client=client, min_interval=0, backoff_base=0, **kwargs)
|
||||
|
||||
|
||||
def test_retries_transient_5xx_then_succeeds():
|
||||
calls = {"n": 0}
|
||||
|
||||
def handler(request: httpx.Request) -> httpx.Response:
|
||||
calls["n"] += 1
|
||||
if calls["n"] < 3:
|
||||
return httpx.Response(503)
|
||||
return httpx.Response(200, json={"status": 1, "product": {"code": "x"}})
|
||||
|
||||
adapter = _adapter(handler, max_retries=4)
|
||||
assert adapter.fetch_barcode("x") == {"code": "x"}
|
||||
assert calls["n"] == 3 # two 503s retried, third succeeds
|
||||
|
||||
|
||||
def test_retries_exhausted_raises():
|
||||
def handler(request: httpx.Request) -> httpx.Response:
|
||||
return httpx.Response(503)
|
||||
|
||||
adapter = _adapter(handler, max_retries=2)
|
||||
with pytest.raises(httpx.HTTPStatusError):
|
||||
adapter.fetch_barcode("x")
|
||||
|
||||
|
||||
def test_non_retryable_4xx_not_retried():
|
||||
calls = {"n": 0}
|
||||
|
||||
def handler(request: httpx.Request) -> httpx.Response:
|
||||
calls["n"] += 1
|
||||
return httpx.Response(404)
|
||||
|
||||
adapter = _adapter(handler, max_retries=4)
|
||||
with pytest.raises(httpx.HTTPStatusError):
|
||||
adapter.fetch_barcode("x")
|
||||
assert calls["n"] == 1 # 404 is not retried
|
||||
|
||||
|
||||
def test_retries_connection_error_then_succeeds():
|
||||
calls = {"n": 0}
|
||||
|
||||
def handler(request: httpx.Request) -> httpx.Response:
|
||||
calls["n"] += 1
|
||||
if calls["n"] == 1:
|
||||
raise httpx.ConnectError("boom")
|
||||
return httpx.Response(200, json={"status": 1, "product": {"code": "y"}})
|
||||
|
||||
adapter = _adapter(handler, max_retries=4)
|
||||
assert adapter.fetch_barcode("y") == {"code": "y"}
|
||||
assert calls["n"] == 2
|
||||
@@ -65,3 +65,14 @@ def test_transform_full_record():
|
||||
|
||||
def test_transform_drops_unnamed():
|
||||
assert transform({"code": "0000000000000"}) is None
|
||||
|
||||
|
||||
def test_transform_clamps_long_serving_size():
|
||||
raw = {
|
||||
"code": "3017624010701",
|
||||
"product_name": "X",
|
||||
"serving_size": "1 portion (30 g) / 1 portion (30 g) / extra long descriptive text here",
|
||||
}
|
||||
rec = transform(raw)
|
||||
assert rec is not None
|
||||
assert len(rec["food"]["serving_size"]) == 32
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
DROP TABLE IF EXISTS api_key;
|
||||
@@ -0,0 +1,24 @@
|
||||
-- API keys for the public read-only API. Keys grant higher rate limits and let
|
||||
-- usage be attributed to a caller; the API itself stays free and read-only.
|
||||
-- Only the SHA-256 hash of a key is stored; the plaintext is shown once at
|
||||
-- creation time. Keys are issued/revoked from the admin console. The public
|
||||
-- server only ever SELECTs from this table (request counting lives in Redis),
|
||||
-- preserving its read-only contract against PostgreSQL.
|
||||
CREATE TABLE IF NOT EXISTS api_key (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||
name TEXT NOT NULL,
|
||||
key_prefix VARCHAR(20) NOT NULL, -- shown for identification, e.g. og_live_AbC1
|
||||
key_hash TEXT NOT NULL UNIQUE, -- hex SHA-256 of the full key
|
||||
owner_email TEXT,
|
||||
tier VARCHAR(16) NOT NULL DEFAULT 'free',
|
||||
rate_limit_per_min INT NOT NULL DEFAULT 120,
|
||||
revoked_at TIMESTAMPTZ,
|
||||
created_by TEXT,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||
CONSTRAINT api_key_tier_chk CHECK (tier IN ('free', 'partner', 'internal')),
|
||||
CONSTRAINT api_key_rate_chk CHECK (rate_limit_per_min > 0)
|
||||
);
|
||||
|
||||
-- Fast lookup of active keys by their hash on every authenticated request.
|
||||
CREATE INDEX IF NOT EXISTS idx_api_key_active_hash
|
||||
ON api_key (key_hash) WHERE revoked_at IS NULL;
|
||||
@@ -0,0 +1,2 @@
|
||||
DROP INDEX IF EXISTS idx_product_country;
|
||||
DROP INDEX IF EXISTS idx_brand_name_trgm;
|
||||
@@ -0,0 +1,9 @@
|
||||
-- Search upgrade: trigram-based fuzzy matching + brand/country filters.
|
||||
-- pg_trgm and the product.name GIN index already exist (see 0001). Add a
|
||||
-- matching trigram index on brand.name so brand filtering / fuzzy brand
|
||||
-- lookups can use an index instead of a sequential scan.
|
||||
CREATE INDEX IF NOT EXISTS idx_brand_name_trgm ON brand USING gin (name gin_trgm_ops);
|
||||
|
||||
-- country_of_origin is filtered by exact/prefix match; a plain btree index
|
||||
-- keeps that cheap as the catalog grows.
|
||||
CREATE INDEX IF NOT EXISTS idx_product_country ON product (country_of_origin);
|
||||
@@ -1,9 +1,10 @@
|
||||
import { useState } from "react";
|
||||
import { useEffect, useState } from "react";
|
||||
import { Boxes, Search, PlusCircle, Code2 } from "lucide-react";
|
||||
import Home from "./components/Home";
|
||||
import ProductView from "./components/ProductView";
|
||||
import Contribute from "./components/Contribute";
|
||||
import ApiDocs from "./components/ApiDocs";
|
||||
import { api } from "./api";
|
||||
|
||||
type View =
|
||||
| { name: "home" }
|
||||
@@ -13,6 +14,14 @@ type View =
|
||||
|
||||
export default function App() {
|
||||
const [view, setView] = useState<View>({ name: "home" });
|
||||
const [qualified, setQualified] = useState<number | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
api
|
||||
.stats()
|
||||
.then((s) => setQualified(s.qualified))
|
||||
.catch(() => setQualified(null));
|
||||
}, []);
|
||||
|
||||
return (
|
||||
<div className="min-h-full flex flex-col">
|
||||
@@ -73,8 +82,16 @@ export default function App() {
|
||||
|
||||
<footer className="border-t bg-white">
|
||||
<div className="max-w-5xl mx-auto px-4 py-4 text-xs text-gray-400 leading-relaxed">
|
||||
天工商品档案公共仓 是公益性「商品事实库」,仅收录客观商品信息(条码、品牌、品类、营养、官方建议零售价快照等),不含任何购买/交易功能。
|
||||
公众投稿须经人工审核后方可收纳。
|
||||
{qualified != null && (
|
||||
<div className="mb-2 text-gray-500">
|
||||
目前已收录
|
||||
<span className="mx-1 font-semibold text-emerald-600">
|
||||
{qualified.toLocaleString()}
|
||||
</span>
|
||||
条合格商品档案
|
||||
</div>
|
||||
)}
|
||||
天工是一个公益性商品档案库。主要收录商品名称,条码,品类,配料等官方快照。不涉及任何交易行为。
|
||||
<button onClick={() => setView({ name: "api" })} className="ml-1 text-emerald-600 hover:underline">
|
||||
API 调用说明
|
||||
</button>
|
||||
|
||||
@@ -25,11 +25,29 @@ export interface SearchResult {
|
||||
total: number;
|
||||
}
|
||||
|
||||
export interface SearchFilters {
|
||||
brand?: string;
|
||||
country?: string;
|
||||
}
|
||||
|
||||
export interface Stats {
|
||||
total: number;
|
||||
qualified: number;
|
||||
min_score: number;
|
||||
}
|
||||
|
||||
export const api = {
|
||||
search: (q: string, page = 1, size = 20) =>
|
||||
req<SearchResult>(
|
||||
`/api/v1/products/search?q=${encodeURIComponent(q)}&page=${page}&size=${size}`,
|
||||
),
|
||||
stats: () => req<Stats>(`/api/v1/stats`),
|
||||
search: (q: string, page = 1, size = 20, filters: SearchFilters = {}) => {
|
||||
const params = new URLSearchParams({
|
||||
q,
|
||||
page: String(page),
|
||||
size: String(size),
|
||||
});
|
||||
if (filters.brand) params.set("brand", filters.brand);
|
||||
if (filters.country) params.set("country", filters.country);
|
||||
return req<SearchResult>(`/api/v1/products/search?${params.toString()}`);
|
||||
},
|
||||
product: (id: string) => req<Product>(`/api/v1/products/${id}`),
|
||||
categories: () => req<{ items: Category[] }>(`/api/v1/categories`),
|
||||
submit: (input: SubmissionInput) =>
|
||||
|
||||
@@ -117,7 +117,7 @@ export default function ApiDocs() {
|
||||
基础地址:<code className="font-mono bg-gray-100 rounded px-1.5 py-0.5">{BASE}</code>
|
||||
</div>
|
||||
<ul className="mt-2 list-disc pl-5 text-gray-600 space-y-1">
|
||||
<li>无需 API Key / Token,直接 GET 即可。</li>
|
||||
<li>无需 API Key / Token 即可直接 GET;带 Key 可获得更高频率上限(见下文「鉴权与限流」)。</li>
|
||||
<li>
|
||||
分页参数 <code className="font-mono">page</code>(默认 1)、
|
||||
<code className="font-mono">size</code>(默认 20,最大 100)。
|
||||
@@ -131,6 +131,53 @@ export default function ApiDocs() {
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="bg-white border rounded-lg p-5">
|
||||
<h2 className="text-lg font-semibold text-gray-800">鉴权与限流</h2>
|
||||
<p className="mt-2 text-gray-600 text-sm leading-relaxed">
|
||||
API 默认<strong>匿名可用</strong>:无需任何凭证即可调用,按来源 IP 计入一个较低的默认频率额度。
|
||||
如需更高额度并让用量归属到你,可在运营方申请一枚 API Key,请求时通过请求头携带:
|
||||
</p>
|
||||
<div className="mt-3">
|
||||
<Code>{`# 二选一
|
||||
curl -H "X-API-Key: og_live_xxxxxxxx" ${BASE}/products/search?q=牛奶
|
||||
curl -H "Authorization: Bearer og_live_xxxxxxxx" ${BASE}/products/search?q=牛奶`}</Code>
|
||||
</div>
|
||||
<p className="mt-3 text-gray-600 text-sm leading-relaxed">
|
||||
采用<strong>固定窗口</strong>限流(每分钟)。每个响应都会回写以下响应头,便于客户端自适应:
|
||||
</p>
|
||||
<table className="mt-3 w-full text-sm">
|
||||
<thead className="text-gray-400 text-left">
|
||||
<tr>
|
||||
<th className="font-medium pr-4 pb-1">响应头</th>
|
||||
<th className="font-medium pb-1">含义</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody className="align-top">
|
||||
<tr>
|
||||
<td className="pr-4 py-0.5 font-mono text-gray-700">X-RateLimit-Limit</td>
|
||||
<td className="py-0.5 text-gray-600">当前窗口允许的最大请求数</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td className="pr-4 py-0.5 font-mono text-gray-700">X-RateLimit-Remaining</td>
|
||||
<td className="py-0.5 text-gray-600">当前窗口剩余可用次数</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td className="pr-4 py-0.5 font-mono text-gray-700">X-RateLimit-Reset</td>
|
||||
<td className="py-0.5 text-gray-600">窗口重置的 Unix 时间戳(秒)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td className="pr-4 py-0.5 font-mono text-gray-700">Retry-After</td>
|
||||
<td className="py-0.5 text-gray-600">超额时返回,建议等待的秒数</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p className="mt-3 text-gray-600 text-sm leading-relaxed">
|
||||
超过额度返回 <code className="font-mono">429 Too Many Requests</code>,错误码
|
||||
<code className="font-mono">rate_limited</code>;无效或已吊销的 Key 返回
|
||||
<code className="font-mono">401</code>,错误码 <code className="font-mono">invalid_api_key</code>。
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<Endpoint
|
||||
method="GET"
|
||||
path="/healthz"
|
||||
@@ -164,19 +211,24 @@ export default function ApiDocs() {
|
||||
method="GET"
|
||||
path="/api/v1/products/search"
|
||||
title="搜索商品"
|
||||
desc="按名称模糊搜索,可按品类过滤,支持分页。"
|
||||
desc="按名称做三元组(trigram)模糊搜索,可容忍错别字;支持品类/品牌/产地过滤;结果按相关度(名称相似度 × 数据质量分)排序。"
|
||||
params={[
|
||||
{ name: "q", desc: "关键词(名称/条码),留空返回全部" },
|
||||
{ name: "category", desc: "品类编码过滤,如 food.beverages" },
|
||||
{ name: "q", desc: "关键词(名称/条码),支持模糊匹配;留空则按质量分返回全部" },
|
||||
{ name: "category", desc: "品类编码(含子树),如 food.beverages" },
|
||||
{ name: "brand", desc: "品牌名(模糊匹配),如 Ferrero" },
|
||||
{ name: "country", desc: "产地前缀(不区分大小写),如 China" },
|
||||
{ name: "page", desc: "页码,默认 1" },
|
||||
{ name: "size", desc: "每页条数,默认 20,最大 100" },
|
||||
]}
|
||||
example={`curl "${BASE}/products/search?q=nutella&page=1&size=20"`}
|
||||
example={`curl "${BASE}/products/search?q=nutela&country=Italy&page=1&size=20"`}
|
||||
response={`{
|
||||
"items": [
|
||||
{ "id": "…", "gtin": "3017624010701",
|
||||
"name": "Nutella", "brand": "Ferrero",
|
||||
"category_path": "food.snacks.chocolate" }
|
||||
"category_path": "food.snacks.chocolate",
|
||||
"country_of_origin": "Italy",
|
||||
"quality_score": 0.81,
|
||||
"score": 0.71 }
|
||||
],
|
||||
"page": 1, "size": 20, "total": 1
|
||||
}`}
|
||||
|
||||
@@ -38,7 +38,7 @@ export default function Home({
|
||||
return (
|
||||
<div>
|
||||
<div className="text-center py-10">
|
||||
<h1 className="text-3xl font-bold text-gray-800">天工商品档案公共仓</h1>
|
||||
<h1 className="text-3xl font-bold text-gray-800">天工</h1>
|
||||
<p className="mt-2 text-gray-500">
|
||||
输入商品名称或条码,检索客观、可溯源的商品资料。人人可查,人人可贡献。
|
||||
</p>
|
||||
@@ -105,7 +105,12 @@ export default function Home({
|
||||
{p.gtin ? ` · ${p.gtin}` : ""}
|
||||
</div>
|
||||
</div>
|
||||
<span className="text-xs text-gray-400">{p.category_path || ""}</span>
|
||||
<span className="text-xs text-gray-400 text-right">
|
||||
<span className="block">{p.category_path || ""}</span>
|
||||
{p.country_of_origin ? (
|
||||
<span className="block text-gray-400">产地:{p.country_of_origin}</span>
|
||||
) : null}
|
||||
</span>
|
||||
</button>
|
||||
</li>
|
||||
))}
|
||||
|
||||
@@ -4,6 +4,9 @@ export interface ProductSummary {
|
||||
name: string;
|
||||
brand: string | null;
|
||||
category_path: string | null;
|
||||
country_of_origin?: string | null;
|
||||
quality_score?: number;
|
||||
score?: number | null;
|
||||
}
|
||||
|
||||
export interface Barcode {
|
||||
|
||||
Reference in New Issue
Block a user