Compare commits
65 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0da57a2fb3 | |||
| 85c58fbd52 | |||
| 3aec0b84fe | |||
| bd1d3bde7c | |||
| 998471f6df | |||
| 1f9b1ecd30 | |||
| 1d71617f71 | |||
| d18fc2470b | |||
| f29696607a | |||
| a75318b811 | |||
| 20b9eb0fc9 | |||
| 17bc0ed680 | |||
| 5020fdcc19 | |||
| 885f6c2b01 | |||
| 2aff6287d2 | |||
| 3364a50c68 | |||
| 936828abae | |||
| ab7a964934 | |||
| 649fcc711c | |||
| 3b62f61288 | |||
| ba36e3ff4c | |||
| d837dd38bf | |||
| 53ce705572 | |||
| 836ee73d73 | |||
| dbbad274b6 | |||
| d58f46bc80 | |||
| 8f9a03a929 | |||
| f04da0a135 | |||
| a2ef7319e9 | |||
| e746b9cd31 | |||
| ddda61252b | |||
| 241fd38a56 | |||
| 3178f8a85a | |||
| 7434e5195e | |||
| 7f66aad779 | |||
| 916bdd9c7c | |||
| 98eb01f4ea | |||
| 51304d782a | |||
| 6e81a7eb36 | |||
| 8bee570cb2 | |||
| ed06d269c6 | |||
| 0214253b48 | |||
| afced01ba6 | |||
| 8812e5f5e3 | |||
| 01055ded02 | |||
| 01593dcbdc | |||
| afdd26cb59 | |||
| 4b4758a60f | |||
| f9360c15e3 | |||
| f382c27200 | |||
| a36700076e | |||
| 4a693c8fe9 | |||
| 50124af833 | |||
| 69a0149bbe | |||
| cf255e2380 | |||
| 2820823b36 | |||
| 7d7a8f1baf | |||
| e34e007f28 | |||
| 5b9338175e | |||
| c090bcdc9b | |||
| 2255243081 | |||
| 98b5f1575d | |||
| 044c870df7 | |||
| 1d5f775d33 | |||
| 88d5766e8e |
+45
-13
@@ -5,6 +5,10 @@ on:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
|
||||
env:
|
||||
GO_VERSION: "1.23.12"
|
||||
GOPROXY: "https://goproxy.cn,direct"
|
||||
|
||||
jobs:
|
||||
go:
|
||||
name: Go (api)
|
||||
@@ -25,11 +29,22 @@ jobs:
|
||||
env:
|
||||
OPENGOODS_DATABASE_URL: postgres://opengoods:opengoods@postgres:5432/opengoods?sslmode=disable
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: "1.23"
|
||||
cache-dependency-path: api/go.sum
|
||||
- name: Checkout
|
||||
working-directory: ${{ github.workspace }}
|
||||
run: |
|
||||
git config --global --add safe.directory '*'
|
||||
git init -q .
|
||||
git remote add origin "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git"
|
||||
git -c protocol.version=2 fetch -q --no-tags --depth 1 origin "${GITHUB_REF}"
|
||||
git checkout -q --force FETCH_HEAD
|
||||
- name: Setup Go
|
||||
working-directory: ${{ github.workspace }}
|
||||
run: |
|
||||
curl -fsSL -o /tmp/go.tgz "https://mirrors.aliyun.com/golang/go${GO_VERSION}.linux-amd64.tar.gz"
|
||||
rm -rf /usr/local/go
|
||||
tar -C /usr/local -xzf /tmp/go.tgz
|
||||
echo "/usr/local/go/bin" >> "$GITHUB_PATH"
|
||||
echo "$HOME/go/bin" >> "$GITHUB_PATH"
|
||||
- name: Apply migrations
|
||||
working-directory: .
|
||||
run: |
|
||||
@@ -44,14 +59,20 @@ jobs:
|
||||
python:
|
||||
name: Python (ingestion)
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: nikolaik/python-nodejs:python3.12-nodejs20
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ingestion
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.12"
|
||||
- name: Checkout
|
||||
working-directory: ${{ github.workspace }}
|
||||
run: |
|
||||
git config --global --add safe.directory '*'
|
||||
git init -q .
|
||||
git remote add origin "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git"
|
||||
git -c protocol.version=2 fetch -q --no-tags --depth 1 origin "${GITHUB_REF}"
|
||||
git checkout -q --force FETCH_HEAD
|
||||
- name: Install
|
||||
run: pip install -e ".[dev]"
|
||||
- name: Ruff lint
|
||||
@@ -77,10 +98,21 @@ jobs:
|
||||
env:
|
||||
DBURL: postgres://opengoods:opengoods@postgres:5432/opengoods?sslmode=disable
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: "1.23"
|
||||
- name: Checkout
|
||||
working-directory: ${{ github.workspace }}
|
||||
run: |
|
||||
git config --global --add safe.directory '*'
|
||||
git init -q .
|
||||
git remote add origin "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git"
|
||||
git -c protocol.version=2 fetch -q --no-tags --depth 1 origin "${GITHUB_REF}"
|
||||
git checkout -q --force FETCH_HEAD
|
||||
- name: Setup Go
|
||||
run: |
|
||||
curl -fsSL -o /tmp/go.tgz "https://mirrors.aliyun.com/golang/go${GO_VERSION}.linux-amd64.tar.gz"
|
||||
rm -rf /usr/local/go
|
||||
tar -C /usr/local -xzf /tmp/go.tgz
|
||||
echo "/usr/local/go/bin" >> "$GITHUB_PATH"
|
||||
echo "$HOME/go/bin" >> "$GITHUB_PATH"
|
||||
- name: Install golang-migrate
|
||||
run: go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@v4.18.1
|
||||
- name: Migrate up
|
||||
|
||||
@@ -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() {
|
||||
@@ -16,6 +28,7 @@ export default function App() {
|
||||
const [tab, setTab] = useState<Tab>("products");
|
||||
const [pending, setPending] = useState<number | null>(null);
|
||||
const [view, setView] = useState<View>({ name: "list" });
|
||||
const [navIds, setNavIds] = useState<string[]>([]);
|
||||
|
||||
useEffect(() => {
|
||||
if (!authed) return;
|
||||
@@ -71,6 +84,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 +122,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,12 +178,32 @@ 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 })} />
|
||||
<ProductList
|
||||
onOpen={(id, ids) => {
|
||||
setNavIds(ids);
|
||||
setView({ name: "detail", id });
|
||||
}}
|
||||
/>
|
||||
) : (
|
||||
<ProductDetail id={view.id} onBack={() => setView({ name: "list" })} />
|
||||
<ProductDetail
|
||||
id={view.id}
|
||||
ids={navIds}
|
||||
onNavigate={(id) => setView({ name: "detail", id })}
|
||||
onBack={() => setView({ name: "list" })}
|
||||
/>
|
||||
)}
|
||||
</main>
|
||||
</div>
|
||||
|
||||
@@ -51,16 +51,30 @@ export const api = {
|
||||
body: JSON.stringify({ username, password }),
|
||||
}),
|
||||
me: () => request<{ username: string }>("/me"),
|
||||
listProducts: (q: string, page: number, size: number) =>
|
||||
listProducts: (
|
||||
q: string,
|
||||
page: number,
|
||||
size: number,
|
||||
sort?: string,
|
||||
order?: string,
|
||||
) =>
|
||||
request<{
|
||||
items: import("./types").ProductRow[];
|
||||
page: number;
|
||||
size: number;
|
||||
total: number;
|
||||
completeness_fields: string[];
|
||||
}>(`/products?q=${encodeURIComponent(q)}&page=${page}&size=${size}`),
|
||||
}>(
|
||||
`/products?q=${encodeURIComponent(q)}&page=${page}&size=${size}` +
|
||||
(sort ? `&sort=${sort}&order=${order || "asc"}` : ""),
|
||||
),
|
||||
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",
|
||||
@@ -86,10 +100,57 @@ export const api = {
|
||||
request<{ status: string }>(`/products/${id}/msrp/${msrpId}`, {
|
||||
method: "DELETE",
|
||||
}),
|
||||
addBarcode: (id: string, body: unknown) =>
|
||||
request<import("./types").Barcode>(`/products/${id}/barcodes`, {
|
||||
method: "POST",
|
||||
body: JSON.stringify(body),
|
||||
}),
|
||||
deleteBarcode: (id: string, barcodeId: string) =>
|
||||
request<{ status: string }>(`/products/${id}/barcodes/${barcodeId}`, {
|
||||
method: "DELETE",
|
||||
}),
|
||||
setPrimaryBarcode: (id: string, barcodeId: string) =>
|
||||
request<import("./types").Barcode>(
|
||||
`/products/${id}/barcodes/${barcodeId}/primary`,
|
||||
{ method: "POST" },
|
||||
),
|
||||
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" }),
|
||||
listKindFields: (kind: string) =>
|
||||
request<{ items: import("./types").KindField[]; kind: string }>(
|
||||
`/kind-fields?kind=${encodeURIComponent(kind)}`,
|
||||
),
|
||||
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[];
|
||||
@@ -109,4 +170,37 @@ 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;
|
||||
quota_total?: 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,304 @@
|
||||
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, quota: 1000 },
|
||||
{ key: "registered", label: "注册用户 (registered)", rate: 300, quota: 100000 },
|
||||
{ key: "partner", label: "合作方 (partner)", rate: 600, quota: 0 },
|
||||
{ key: "internal", label: "内部 (internal)", rate: 6000, quota: 0 },
|
||||
];
|
||||
|
||||
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>
|
||||
<th className="px-4 py-2 font-medium"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody className="divide-y">
|
||||
{rows.length === 0 ? (
|
||||
<tr>
|
||||
<td colSpan={8} 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 text-gray-600">
|
||||
{k.quota_total > 0 ? (
|
||||
<span className={k.usage.total >= k.quota_total ? "text-red-600" : ""}>
|
||||
{k.usage.total.toLocaleString()} / {k.quota_total.toLocaleString()}
|
||||
</span>
|
||||
) : (
|
||||
<span className="text-gray-400">不限</span>
|
||||
)}
|
||||
</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 [quota, setQuota] = useState(1000);
|
||||
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);
|
||||
setQuota(def.quota);
|
||||
}
|
||||
}
|
||||
|
||||
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,
|
||||
quota_total: quota,
|
||||
});
|
||||
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>
|
||||
<label className="block">
|
||||
<span className="text-xs text-gray-500">累计配额(总调用次数,0=不限)</span>
|
||||
<input
|
||||
type="number"
|
||||
min={0}
|
||||
className="w-full border rounded-md px-3 py-2 text-sm mt-1"
|
||||
value={quota}
|
||||
onChange={(e) => setQuota(Math.max(0, parseInt(e.target.value || "0", 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>
|
||||
);
|
||||
}
|
||||
@@ -5,17 +5,28 @@ import {
|
||||
Brand,
|
||||
Category,
|
||||
FIELD_LABELS,
|
||||
KindField,
|
||||
ProductDetail as Detail,
|
||||
} from "../types";
|
||||
import {
|
||||
ArrowLeft,
|
||||
ChevronLeft,
|
||||
ChevronRight,
|
||||
Plus,
|
||||
Save,
|
||||
Trash2,
|
||||
AlertCircle,
|
||||
History,
|
||||
Star,
|
||||
} from "lucide-react";
|
||||
|
||||
const GTIN_TYPES = ["EAN13", "EAN8", "UPC", "ITF14", "GTIN14"];
|
||||
const PACK_LEVELS: { value: string; label: string }[] = [
|
||||
{ value: "each", label: "消费单元" },
|
||||
{ value: "case", label: "箱" },
|
||||
{ value: "pallet", label: "托盘" },
|
||||
];
|
||||
|
||||
const NUTRIMENT_KEYS: { key: string; label: string }[] = [
|
||||
{ key: "energy_kcal", label: "能量 (kcal)" },
|
||||
{ key: "energy_kj", label: "能量 (kJ)" },
|
||||
@@ -39,6 +50,9 @@ const ACTION_LABEL: Record<string, string> = {
|
||||
delete_image: "删除图片",
|
||||
add_msrp: "新增建议零售价",
|
||||
delete_msrp: "删除建议零售价",
|
||||
add_barcode: "新增条码",
|
||||
delete_barcode: "删除条码",
|
||||
set_primary_barcode: "设为主条码",
|
||||
};
|
||||
|
||||
function Card({
|
||||
@@ -77,10 +91,18 @@ const inputCls =
|
||||
export default function ProductDetail({
|
||||
id,
|
||||
onBack,
|
||||
ids = [],
|
||||
onNavigate,
|
||||
}: {
|
||||
id: string;
|
||||
onBack: () => void;
|
||||
ids?: string[];
|
||||
onNavigate?: (id: string) => void;
|
||||
}) {
|
||||
const navIndex = ids.indexOf(id);
|
||||
const prevId = navIndex > 0 ? ids[navIndex - 1] : null;
|
||||
const nextId =
|
||||
navIndex >= 0 && navIndex < ids.length - 1 ? ids[navIndex + 1] : null;
|
||||
const [d, setD] = useState<Detail | null>(null);
|
||||
const [brands, setBrands] = useState<Brand[]>([]);
|
||||
const [categories, setCategories] = useState<Category[]>([]);
|
||||
@@ -106,6 +128,8 @@ export default function ProductDetail({
|
||||
const [basis, setBasis] = useState("");
|
||||
const [serving, setServing] = useState("");
|
||||
const [nutriScore, setNutriScore] = useState("");
|
||||
const [kindFields, setKindFields] = useState<KindField[]>([]);
|
||||
const [attrs, setAttrs] = useState<Record<string, string>>({});
|
||||
|
||||
function hydrate(detail: Detail) {
|
||||
setD(detail);
|
||||
@@ -128,6 +152,13 @@ export default function ProductDetail({
|
||||
setBasis(detail.nutrition_basis || "");
|
||||
setServing(detail.serving_size || "");
|
||||
setNutriScore(detail.nutri_score || "");
|
||||
const am: Record<string, string> = {};
|
||||
if (detail.attributes) {
|
||||
for (const [k, v] of Object.entries(detail.attributes)) {
|
||||
am[k] = v == null ? "" : Array.isArray(v) ? v.join(", ") : String(v);
|
||||
}
|
||||
}
|
||||
setAttrs(am);
|
||||
}
|
||||
|
||||
function reload() {
|
||||
@@ -150,6 +181,41 @@ export default function ProductDetail({
|
||||
|
||||
const missing = useMemo(() => d?.missing ?? [], [d]);
|
||||
|
||||
const selectedKind = useMemo(() => {
|
||||
const c = categories.find((x) => x.id === categoryId);
|
||||
return c?.archive_kind || d?.archive_kind || "generic";
|
||||
}, [categories, categoryId, d]);
|
||||
|
||||
useEffect(() => {
|
||||
if (selectedKind && selectedKind !== "food") {
|
||||
api
|
||||
.listKindFields(selectedKind)
|
||||
.then((r) => setKindFields(r.items))
|
||||
.catch(() => setKindFields([]));
|
||||
} else {
|
||||
setKindFields([]);
|
||||
}
|
||||
}, [selectedKind]);
|
||||
|
||||
const specGroups = useMemo(() => {
|
||||
const groups: { label: string; fields: KindField[] }[] = [];
|
||||
for (const f of kindFields) {
|
||||
let g = groups.find((x) => x.label === f.group_label);
|
||||
if (!g) {
|
||||
g = { label: f.group_label, fields: [] };
|
||||
groups.push(g);
|
||||
}
|
||||
g.fields.push(f);
|
||||
}
|
||||
return groups;
|
||||
}, [kindFields]);
|
||||
|
||||
const attrLabels = useMemo(() => {
|
||||
const m: Record<string, string> = {};
|
||||
for (const f of kindFields) m[f.field_key] = f.label_zh;
|
||||
return m;
|
||||
}, [kindFields]);
|
||||
|
||||
function parseList(s: string): string[] {
|
||||
return s
|
||||
.split(",")
|
||||
@@ -166,6 +232,22 @@ export default function ProductDetail({
|
||||
const n = parseFloat(v);
|
||||
if (!Number.isNaN(n)) nm[k] = n;
|
||||
}
|
||||
let attributes: Record<string, unknown> | undefined;
|
||||
if (selectedKind !== "food") {
|
||||
attributes = {};
|
||||
for (const f of kindFields) {
|
||||
const raw = (attrs[f.field_key] ?? "").trim();
|
||||
if (raw === "") continue;
|
||||
if (f.field_type === "number") {
|
||||
const n = parseFloat(raw);
|
||||
if (!Number.isNaN(n)) attributes[f.field_key] = n;
|
||||
} else if (f.field_type === "list") {
|
||||
attributes[f.field_key] = parseList(raw);
|
||||
} else {
|
||||
attributes[f.field_key] = raw;
|
||||
}
|
||||
}
|
||||
}
|
||||
const body = {
|
||||
gtin: gtin.trim() || null,
|
||||
name: name.trim(),
|
||||
@@ -183,6 +265,7 @@ export default function ProductDetail({
|
||||
nutrition_basis: basis || null,
|
||||
serving_size: serving.trim() || null,
|
||||
nutri_score: nutriScore || null,
|
||||
...(attributes !== undefined ? { attributes } : {}),
|
||||
};
|
||||
try {
|
||||
const updated = await api.updateProduct(id, body);
|
||||
@@ -215,12 +298,35 @@ export default function ProductDetail({
|
||||
return (
|
||||
<div className="mx-auto max-w-5xl space-y-5">
|
||||
<div className="flex items-center justify-between">
|
||||
<button
|
||||
onClick={onBack}
|
||||
className="flex items-center gap-1 text-sm text-gray-600 hover:text-gray-900"
|
||||
>
|
||||
<ArrowLeft className="h-4 w-4" /> 返回列表
|
||||
</button>
|
||||
<div className="flex items-center gap-2">
|
||||
<button
|
||||
onClick={onBack}
|
||||
className="flex items-center gap-1 text-sm text-gray-600 hover:text-gray-900"
|
||||
>
|
||||
<ArrowLeft className="h-4 w-4" /> 返回列表
|
||||
</button>
|
||||
{ids.length > 1 && navIndex >= 0 && (
|
||||
<div className="ml-2 flex items-center gap-1 text-sm">
|
||||
<button
|
||||
onClick={() => prevId && onNavigate?.(prevId)}
|
||||
disabled={!prevId}
|
||||
className="flex items-center gap-1 rounded border border-gray-300 px-2 py-1 text-gray-600 hover:bg-gray-50 disabled:opacity-40"
|
||||
>
|
||||
<ChevronLeft className="h-4 w-4" /> 上一个
|
||||
</button>
|
||||
<span className="text-xs text-gray-400">
|
||||
{navIndex + 1} / {ids.length}
|
||||
</span>
|
||||
<button
|
||||
onClick={() => nextId && onNavigate?.(nextId)}
|
||||
disabled={!nextId}
|
||||
className="flex items-center gap-1 rounded border border-gray-300 px-2 py-1 text-gray-600 hover:bg-gray-50 disabled:opacity-40"
|
||||
>
|
||||
下一个 <ChevronRight className="h-4 w-4" />
|
||||
</button>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
<div className="flex items-center gap-3">
|
||||
{msg && <span className="text-sm text-emerald-600">{msg}</span>}
|
||||
{error && <span className="text-sm text-red-600">{error}</span>}
|
||||
@@ -240,7 +346,8 @@ export default function ProductDetail({
|
||||
{missing.length > 0 && (
|
||||
<div className="flex items-center gap-2 rounded-lg border border-amber-200 bg-amber-50 px-4 py-3 text-sm text-amber-700">
|
||||
<AlertCircle className="h-4 w-4" />
|
||||
待补全字段:{missing.map((f) => FIELD_LABELS[f] || f).join("、")}
|
||||
待补全字段:
|
||||
{missing.map((f) => FIELD_LABELS[f] || attrLabels[f] || f).join("、")}
|
||||
</div>
|
||||
)}
|
||||
|
||||
@@ -327,6 +434,7 @@ export default function ProductDetail({
|
||||
</div>
|
||||
</Card>
|
||||
|
||||
{selectedKind === "food" && (
|
||||
<Card title="配料与营养">
|
||||
<div className="mb-4 grid grid-cols-2 gap-4">
|
||||
<Field label="配料表">
|
||||
@@ -399,7 +507,77 @@ export default function ProductDetail({
|
||||
))}
|
||||
</div>
|
||||
</Card>
|
||||
)}
|
||||
|
||||
{selectedKind !== "food" && kindFields.length > 0 && (
|
||||
<Card title="规格参数">
|
||||
{specGroups.map((grp) => (
|
||||
<div key={grp.label} className="mb-4 last:mb-0">
|
||||
{grp.label && (
|
||||
<h4 className="mb-2 text-xs font-medium text-gray-500">
|
||||
{grp.label}
|
||||
</h4>
|
||||
)}
|
||||
<div className="grid grid-cols-3 gap-3">
|
||||
{grp.fields.map((f) => (
|
||||
<Field
|
||||
key={f.field_key}
|
||||
label={f.unit ? `${f.label_zh} (${f.unit})` : f.label_zh}
|
||||
>
|
||||
{f.field_type === "select" ? (
|
||||
<select
|
||||
className={inputCls}
|
||||
value={attrs[f.field_key] ?? ""}
|
||||
onChange={(e) =>
|
||||
setAttrs((prev) => ({
|
||||
...prev,
|
||||
[f.field_key]: e.target.value,
|
||||
}))
|
||||
}
|
||||
>
|
||||
<option value="">(未设置)</option>
|
||||
{f.options.map((o) => (
|
||||
<option key={o} value={o}>
|
||||
{o}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
) : f.field_type === "textarea" ? (
|
||||
<textarea
|
||||
className={inputCls}
|
||||
rows={3}
|
||||
value={attrs[f.field_key] ?? ""}
|
||||
onChange={(e) =>
|
||||
setAttrs((prev) => ({
|
||||
...prev,
|
||||
[f.field_key]: e.target.value,
|
||||
}))
|
||||
}
|
||||
/>
|
||||
) : (
|
||||
<input
|
||||
className={inputCls}
|
||||
type={f.field_type === "number" ? "number" : "text"}
|
||||
step={f.field_type === "number" ? "any" : undefined}
|
||||
placeholder={f.placeholder ?? undefined}
|
||||
value={attrs[f.field_key] ?? ""}
|
||||
onChange={(e) =>
|
||||
setAttrs((prev) => ({
|
||||
...prev,
|
||||
[f.field_key]: e.target.value,
|
||||
}))
|
||||
}
|
||||
/>
|
||||
)}
|
||||
</Field>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</Card>
|
||||
)}
|
||||
|
||||
<BarcodesCard product={d} onChange={reload} onError={setError} />
|
||||
<ImagesCard
|
||||
product={d}
|
||||
onChange={reload}
|
||||
@@ -435,6 +613,158 @@ export default function ProductDetail({
|
||||
);
|
||||
}
|
||||
|
||||
function BarcodesCard({
|
||||
product,
|
||||
onChange,
|
||||
onError,
|
||||
}: {
|
||||
product: Detail;
|
||||
onChange: () => void;
|
||||
onError: (m: string) => void;
|
||||
}) {
|
||||
const [gtin, setGtin] = useState("");
|
||||
const [gtinType, setGtinType] = useState("EAN13");
|
||||
const [packLevel, setPackLevel] = useState("each");
|
||||
const [region, setRegion] = useState("");
|
||||
const [busy, setBusy] = useState(false);
|
||||
|
||||
async function add() {
|
||||
if (!gtin.trim()) return;
|
||||
setBusy(true);
|
||||
try {
|
||||
await api.addBarcode(product.id, {
|
||||
gtin: gtin.trim(),
|
||||
gtin_type: gtinType,
|
||||
pack_level: packLevel,
|
||||
region: region.trim() || null,
|
||||
is_primary: false,
|
||||
});
|
||||
setGtin("");
|
||||
setRegion("");
|
||||
onChange();
|
||||
} catch (e) {
|
||||
onError(e instanceof Error ? e.message : "添加失败");
|
||||
} finally {
|
||||
setBusy(false);
|
||||
}
|
||||
}
|
||||
async function remove(barcodeId: string) {
|
||||
try {
|
||||
await api.deleteBarcode(product.id, barcodeId);
|
||||
onChange();
|
||||
} catch (e) {
|
||||
onError(e instanceof Error ? e.message : "删除失败");
|
||||
}
|
||||
}
|
||||
async function makePrimary(barcodeId: string) {
|
||||
try {
|
||||
await api.setPrimaryBarcode(product.id, barcodeId);
|
||||
onChange();
|
||||
} catch (e) {
|
||||
onError(e instanceof Error ? e.message : "设置失败");
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<Card title="条码(一品多码,主条码镜像到 GTIN)">
|
||||
<div className="mb-3 space-y-2">
|
||||
{product.barcodes.length === 0 && (
|
||||
<span className="text-sm text-gray-400">暂无条码</span>
|
||||
)}
|
||||
{product.barcodes.map((b) => (
|
||||
<div
|
||||
key={b.id}
|
||||
className="flex items-center gap-3 rounded border border-gray-100 bg-gray-50 px-3 py-2 text-sm"
|
||||
>
|
||||
<button
|
||||
onClick={() => !b.is_primary && makePrimary(b.id)}
|
||||
title={b.is_primary ? "主条码" : "设为主条码"}
|
||||
disabled={b.is_primary}
|
||||
className={
|
||||
b.is_primary
|
||||
? "text-amber-500"
|
||||
: "text-gray-300 hover:text-amber-500"
|
||||
}
|
||||
>
|
||||
<Star
|
||||
className="h-4 w-4"
|
||||
fill={b.is_primary ? "currentColor" : "none"}
|
||||
/>
|
||||
</button>
|
||||
<span className="font-mono font-medium text-gray-800">
|
||||
{b.gtin}
|
||||
</span>
|
||||
<span className="rounded bg-gray-200 px-1.5 py-0.5 text-[11px] text-gray-600">
|
||||
{b.gtin_type}
|
||||
</span>
|
||||
<span className="text-gray-500">
|
||||
{PACK_LEVELS.find((p) => p.value === b.pack_level)?.label ||
|
||||
b.pack_level}
|
||||
</span>
|
||||
<span className="flex-1 text-gray-400">{b.region || ""}</span>
|
||||
<button
|
||||
onClick={() => remove(b.id)}
|
||||
className="text-gray-400 hover:text-red-600"
|
||||
>
|
||||
<Trash2 className="h-4 w-4" />
|
||||
</button>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
<div className="flex flex-wrap items-end gap-2">
|
||||
<Field label="条码 (GTIN)">
|
||||
<input
|
||||
className="w-44 rounded border border-gray-300 px-3 py-2 text-sm"
|
||||
value={gtin}
|
||||
onChange={(e) => setGtin(e.target.value)}
|
||||
placeholder="8/12/13/14 位"
|
||||
/>
|
||||
</Field>
|
||||
<Field label="类型">
|
||||
<select
|
||||
className="rounded border border-gray-300 px-2 py-2 text-sm"
|
||||
value={gtinType}
|
||||
onChange={(e) => setGtinType(e.target.value)}
|
||||
>
|
||||
{GTIN_TYPES.map((t) => (
|
||||
<option key={t} value={t}>
|
||||
{t}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</Field>
|
||||
<Field label="包装层级">
|
||||
<select
|
||||
className="rounded border border-gray-300 px-2 py-2 text-sm"
|
||||
value={packLevel}
|
||||
onChange={(e) => setPackLevel(e.target.value)}
|
||||
>
|
||||
{PACK_LEVELS.map((p) => (
|
||||
<option key={p.value} value={p.value}>
|
||||
{p.label}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</Field>
|
||||
<Field label="地区(可选)">
|
||||
<input
|
||||
className="w-20 rounded border border-gray-300 px-3 py-2 text-sm"
|
||||
value={region}
|
||||
onChange={(e) => setRegion(e.target.value.toUpperCase())}
|
||||
/>
|
||||
</Field>
|
||||
<button
|
||||
onClick={add}
|
||||
disabled={busy}
|
||||
className="flex items-center gap-1 rounded bg-gray-700 px-3 py-2 text-sm text-white hover:bg-gray-800 disabled:opacity-60"
|
||||
>
|
||||
<Plus className="h-4 w-4" /> 添加
|
||||
</button>
|
||||
</div>
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
|
||||
function ImagesCard({
|
||||
product,
|
||||
onChange,
|
||||
|
||||
@@ -1,7 +1,15 @@
|
||||
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, ChevronUp, ChevronDown, ChevronsUpDown } from "lucide-react";
|
||||
|
||||
type SortKey =
|
||||
| "name"
|
||||
| "brand"
|
||||
| "gtin"
|
||||
| "category_path"
|
||||
| "status"
|
||||
| "quality_score";
|
||||
|
||||
const STATUS_LABEL: Record<string, string> = {
|
||||
active: "在用",
|
||||
@@ -24,32 +32,154 @@ function QualityBadge({ score }: { score: number }) {
|
||||
);
|
||||
}
|
||||
|
||||
function SortableTh({
|
||||
label,
|
||||
sortKey,
|
||||
sort,
|
||||
order,
|
||||
onSort,
|
||||
}: {
|
||||
label: string;
|
||||
sortKey: SortKey;
|
||||
sort: SortKey | "";
|
||||
order: "asc" | "desc";
|
||||
onSort: (key: SortKey) => void;
|
||||
}) {
|
||||
const active = sort === sortKey;
|
||||
return (
|
||||
<th className="px-4 py-3">
|
||||
<button
|
||||
type="button"
|
||||
onClick={() => onSort(sortKey)}
|
||||
className={`flex items-center gap-1 uppercase hover:text-gray-700 ${
|
||||
active ? "text-emerald-600" : ""
|
||||
}`}
|
||||
>
|
||||
{label}
|
||||
{!active ? (
|
||||
<ChevronsUpDown className="h-3.5 w-3.5 text-gray-300" />
|
||||
) : order === "asc" ? (
|
||||
<ChevronUp className="h-3.5 w-3.5" />
|
||||
) : (
|
||||
<ChevronDown className="h-3.5 w-3.5" />
|
||||
)}
|
||||
</button>
|
||||
</th>
|
||||
);
|
||||
}
|
||||
|
||||
export default function ProductList({
|
||||
onOpen,
|
||||
}: {
|
||||
onOpen: (id: string) => void;
|
||||
onOpen: (id: string, ids: string[]) => void;
|
||||
}) {
|
||||
const [q, setQ] = useState("");
|
||||
const [input, setInput] = useState("");
|
||||
const [page, setPage] = useState(1);
|
||||
const [size] = useState(20);
|
||||
const [size, setSize] = useState(20);
|
||||
const [sort, setSort] = useState<SortKey | "">("");
|
||||
const [order, setOrder] = useState<"asc" | "desc">("asc");
|
||||
const [jump, setJump] = useState("");
|
||||
const [rows, setRows] = useState<ProductRow[]>([]);
|
||||
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
|
||||
.listProducts(q, page, size)
|
||||
.listProducts(q, page, size, sort || undefined, order)
|
||||
.then((r) => {
|
||||
setRows(r.items);
|
||||
setTotal(r.total);
|
||||
})
|
||||
.catch((e) => setError(e.message))
|
||||
.finally(() => setLoading(false));
|
||||
}, [q, page, size]);
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
setSelected(new Set());
|
||||
reload();
|
||||
}, [q, page, size, sort, order]);
|
||||
|
||||
function toggleSort(key: SortKey) {
|
||||
setPage(1);
|
||||
if (sort !== key) {
|
||||
setSort(key);
|
||||
setOrder("asc");
|
||||
} else if (order === "asc") {
|
||||
setOrder("desc");
|
||||
} else {
|
||||
setSort("");
|
||||
setOrder("asc");
|
||||
}
|
||||
}
|
||||
|
||||
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));
|
||||
|
||||
@@ -79,38 +209,120 @@ 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, [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="px-4 py-3">名称</th>
|
||||
<th className="px-4 py-3">品牌</th>
|
||||
<th className="px-4 py-3">条码</th>
|
||||
<th className="px-4 py-3">品类</th>
|
||||
<th className="px-4 py-3">状态</th>
|
||||
<th className="px-4 py-3">质量分</th>
|
||||
<th className="w-10 px-4 py-3">
|
||||
<input
|
||||
type="checkbox"
|
||||
checked={rows.length > 0 && selected.size === rows.length}
|
||||
onChange={toggleAll}
|
||||
aria-label="全选"
|
||||
/>
|
||||
</th>
|
||||
<SortableTh label="名称" sortKey="name" sort={sort} order={order} onSort={toggleSort} />
|
||||
<SortableTh label="品牌" sortKey="brand" sort={sort} order={order} onSort={toggleSort} />
|
||||
<SortableTh label="条码" sortKey="gtin" sort={sort} order={order} onSort={toggleSort} />
|
||||
<SortableTh label="品类" sortKey="category_path" sort={sort} order={order} onSort={toggleSort} />
|
||||
<SortableTh label="状态" sortKey="status" sort={sort} order={order} onSort={toggleSort} />
|
||||
<SortableTh label="质量分" sortKey="quality_score" sort={sort} order={order} onSort={toggleSort} />
|
||||
<th className="px-4 py-3">缺失字段</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<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>
|
||||
@@ -118,9 +330,22 @@ export default function ProductList({
|
||||
rows.map((r) => (
|
||||
<tr
|
||||
key={r.id}
|
||||
onClick={() => onOpen(r.id)}
|
||||
className="cursor-pointer hover:bg-emerald-50/50"
|
||||
onClick={() => onOpen(r.id, rows.map((x) => x.id))}
|
||||
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">
|
||||
@@ -154,7 +379,25 @@ export default function ProductList({
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div className="mt-4 flex items-center justify-end gap-2 text-sm text-gray-600">
|
||||
<div className="mt-4 flex flex-wrap items-center justify-end gap-2 text-sm text-gray-600">
|
||||
<div className="mr-auto flex items-center gap-1">
|
||||
<span>每页</span>
|
||||
<select
|
||||
value={size}
|
||||
onChange={(e) => {
|
||||
setSize(Number(e.target.value));
|
||||
setPage(1);
|
||||
}}
|
||||
className="rounded border border-gray-300 px-2 py-1"
|
||||
>
|
||||
{[20, 50, 100].map((n) => (
|
||||
<option key={n} value={n}>
|
||||
{n}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
<span>条 · 共 {total} 条</span>
|
||||
</div>
|
||||
<button
|
||||
disabled={page <= 1}
|
||||
onClick={() => setPage((p) => p - 1)}
|
||||
@@ -172,6 +415,159 @@ export default function ProductList({
|
||||
>
|
||||
下一页
|
||||
</button>
|
||||
<form
|
||||
onSubmit={(e) => {
|
||||
e.preventDefault();
|
||||
const n = Number(jump);
|
||||
if (Number.isFinite(n) && n >= 1) {
|
||||
setPage(Math.min(Math.max(1, Math.trunc(n)), pages));
|
||||
setJump("");
|
||||
}
|
||||
}}
|
||||
className="flex items-center gap-1"
|
||||
>
|
||||
<span>跳至</span>
|
||||
<input
|
||||
value={jump}
|
||||
onChange={(e) => setJump(e.target.value.replace(/[^0-9]/g, ""))}
|
||||
placeholder={String(page)}
|
||||
className="w-14 rounded border border-gray-300 px-2 py-1 text-center"
|
||||
aria-label="跳转页码"
|
||||
/>
|
||||
<button
|
||||
type="submit"
|
||||
className="rounded border border-gray-300 px-3 py-1 hover:bg-gray-50"
|
||||
>
|
||||
前往
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
</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>
|
||||
|
||||
@@ -10,6 +10,15 @@ export interface ProductRow {
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface Barcode {
|
||||
id: string;
|
||||
gtin: string;
|
||||
gtin_type: string;
|
||||
pack_level: string;
|
||||
region: string | null;
|
||||
is_primary: boolean;
|
||||
}
|
||||
|
||||
export interface ProductImage {
|
||||
id: string;
|
||||
url: string;
|
||||
@@ -35,6 +44,8 @@ export interface ProductDetail {
|
||||
brand: string | null;
|
||||
category_id: string | null;
|
||||
category_path: string | null;
|
||||
archive_kind: string;
|
||||
attributes: Record<string, unknown>;
|
||||
net_content_value: number | null;
|
||||
net_content_unit: string | null;
|
||||
country_of_origin: string | null;
|
||||
@@ -47,6 +58,7 @@ export interface ProductDetail {
|
||||
nutrition_basis: string | null;
|
||||
serving_size: string | null;
|
||||
nutri_score: string | null;
|
||||
barcodes: Barcode[];
|
||||
images: ProductImage[];
|
||||
msrp: MSRP[];
|
||||
missing: string[];
|
||||
@@ -56,6 +68,7 @@ export interface ProductDetail {
|
||||
export interface Brand {
|
||||
id: string;
|
||||
name: string;
|
||||
product_count: number;
|
||||
}
|
||||
|
||||
export interface Category {
|
||||
@@ -64,6 +77,31 @@ export interface Category {
|
||||
name_en: string | null;
|
||||
path: string;
|
||||
level: number;
|
||||
parent_id: string | null;
|
||||
gpc_brick_code: string | null;
|
||||
archive_kind: string;
|
||||
product_count: number;
|
||||
}
|
||||
|
||||
export interface KindField {
|
||||
kind: string;
|
||||
field_key: string;
|
||||
group_label: string;
|
||||
label_zh: string;
|
||||
field_type: string;
|
||||
unit: string | null;
|
||||
options: string[];
|
||||
placeholder: string | null;
|
||||
sort_order: number;
|
||||
qualified: boolean;
|
||||
}
|
||||
|
||||
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 {
|
||||
@@ -74,6 +112,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;
|
||||
@@ -127,6 +186,26 @@ 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;
|
||||
quota_total: 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,
|
||||
|
||||
+14
-1
@@ -9,9 +9,11 @@ import (
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/cache"
|
||||
"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 +33,18 @@ 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")
|
||||
}
|
||||
|
||||
readCache := cache.New(cfg.RedisURL)
|
||||
if !readCache.Enabled() {
|
||||
log.Print("warning: Redis not configured; public API read cache disabled")
|
||||
}
|
||||
h := handler.New(store.New(pool).WithCache(readCache), publicweb.Dist()).
|
||||
WithRateLimit(limiter, cfg.AnonRateLimitPerMin).
|
||||
WithQuotas(cfg.AnonTotalQuota, cfg.RegisteredRateLimitPerMin, cfg.RegisteredQuotaTotal)
|
||||
|
||||
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 != "registered" && 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"})
|
||||
}
|
||||
@@ -15,6 +15,8 @@ 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.
|
||||
@@ -24,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).
|
||||
@@ -38,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()
|
||||
@@ -54,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)
|
||||
@@ -62,13 +76,30 @@ func (h *Handler) Router() http.Handler {
|
||||
r.Delete("/api/products/{id}/images/{imageID}", h.DeleteImage)
|
||||
r.Post("/api/products/{id}/msrp", h.AddMSRP)
|
||||
r.Delete("/api/products/{id}/msrp/{msrpID}", h.DeleteMSRP)
|
||||
r.Post("/api/products/{id}/barcodes", h.AddBarcode)
|
||||
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/kind-fields", h.ListKindFields)
|
||||
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.Post("/api/import/bypos", h.ImportBypos)
|
||||
|
||||
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))
|
||||
@@ -135,8 +166,10 @@ func (h *Handler) Me(w http.ResponseWriter, r *http.Request) {
|
||||
// ListProducts returns a paginated product list.
|
||||
func (h *Handler) ListProducts(w http.ResponseWriter, r *http.Request) {
|
||||
q := r.URL.Query().Get("q")
|
||||
sort := r.URL.Query().Get("sort")
|
||||
order := r.URL.Query().Get("order")
|
||||
page, size := pageParams(r)
|
||||
items, total, err := h.store.ListProducts(r.Context(), q, size, (page-1)*size)
|
||||
items, total, err := h.store.ListProducts(r.Context(), q, sort, order, size, (page-1)*size)
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
@@ -155,6 +188,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
|
||||
@@ -231,6 +357,68 @@ func (h *Handler) DeleteMSRP(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusOK, map[string]string{"status": "deleted"})
|
||||
}
|
||||
|
||||
// ---------- barcodes ----------
|
||||
|
||||
// AddBarcode validates and attaches a barcode to a product. A code already
|
||||
// owned by another product yields 409 with the conflicting product so the
|
||||
// operator can de-duplicate; an invalid GTIN yields 400.
|
||||
func (h *Handler) AddBarcode(w http.ResponseWriter, r *http.Request) {
|
||||
var in adminstore.BarcodeInput
|
||||
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "invalid body")
|
||||
return
|
||||
}
|
||||
b, err := h.store.AddBarcode(r.Context(), chi.URLParam(r, "id"), auth.UserFrom(r.Context()), in)
|
||||
if h.handleBarcodeErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusCreated, b)
|
||||
}
|
||||
|
||||
// DeleteBarcode removes a barcode; a primary one is replaced automatically.
|
||||
func (h *Handler) DeleteBarcode(w http.ResponseWriter, r *http.Request) {
|
||||
err := h.store.DeleteBarcode(r.Context(), chi.URLParam(r, "id"), chi.URLParam(r, "barcodeID"), auth.UserFrom(r.Context()))
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]string{"status": "deleted"})
|
||||
}
|
||||
|
||||
// SetPrimaryBarcode marks one barcode primary and mirrors it to product.gtin.
|
||||
func (h *Handler) SetPrimaryBarcode(w http.ResponseWriter, r *http.Request) {
|
||||
b, err := h.store.SetPrimaryBarcode(r.Context(), chi.URLParam(r, "id"), chi.URLParam(r, "barcodeID"), auth.UserFrom(r.Context()))
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, b)
|
||||
}
|
||||
|
||||
// handleBarcodeErr maps barcode-specific errors (GTIN validation, ownership
|
||||
// conflict) to client-facing statuses, falling back to handleErr otherwise.
|
||||
func (h *Handler) handleBarcodeErr(w http.ResponseWriter, err error) bool {
|
||||
if err == nil {
|
||||
return false
|
||||
}
|
||||
var conflict *adminstore.ConflictError
|
||||
if errors.As(err, &conflict) {
|
||||
writeJSON(w, http.StatusConflict, map[string]any{
|
||||
"error": map[string]string{"code": "barcode_conflict", "message": err.Error()},
|
||||
"conflict": map[string]string{
|
||||
"gtin": conflict.GTIN,
|
||||
"product_id": conflict.ProductID,
|
||||
"product_name": conflict.ProductName,
|
||||
},
|
||||
})
|
||||
return true
|
||||
}
|
||||
if errors.Is(err, gtin.ErrEmpty) || errors.Is(err, gtin.ErrFormat) ||
|
||||
errors.Is(err, gtin.ErrCheck) || errors.Is(err, gtin.ErrRestricted) {
|
||||
writeError(w, http.StatusBadRequest, "invalid_gtin", err.Error())
|
||||
return true
|
||||
}
|
||||
return h.handleErr(w, err)
|
||||
}
|
||||
|
||||
// ListBrands returns brand options.
|
||||
func (h *Handler) ListBrands(w http.ResponseWriter, r *http.Request) {
|
||||
items, err := h.store.ListBrands(r.Context())
|
||||
@@ -240,6 +428,20 @@ func (h *Handler) ListBrands(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusOK, map[string]any{"items": items})
|
||||
}
|
||||
|
||||
// ListKindFields returns the editable spec field template for an archive kind.
|
||||
func (h *Handler) ListKindFields(w http.ResponseWriter, r *http.Request) {
|
||||
kind := strings.TrimSpace(r.URL.Query().Get("kind"))
|
||||
if kind == "" {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "缺少 kind 参数")
|
||||
return
|
||||
}
|
||||
items, err := h.store.ListKindFields(r.Context(), kind)
|
||||
if h.handleErr(w, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]any{"items": items, "kind": kind})
|
||||
}
|
||||
|
||||
// ListCategories returns category options.
|
||||
func (h *Handler) ListCategories(w http.ResponseWriter, r *http.Request) {
|
||||
items, err := h.store.ListCategories(r.Context())
|
||||
@@ -249,6 +451,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,30 @@
|
||||
package adminhandler
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/adminstore"
|
||||
)
|
||||
|
||||
func (h *Handler) ImportBypos(w http.ResponseWriter, r *http.Request) {
|
||||
var records []adminstore.ByposRecord
|
||||
dec := json.NewDecoder(http.MaxBytesReader(w, r.Body, 50<<20))
|
||||
for dec.More() {
|
||||
var rec adminstore.ByposRecord
|
||||
if err := dec.Decode(&rec); err != nil {
|
||||
continue
|
||||
}
|
||||
records = append(records, rec)
|
||||
}
|
||||
if len(records) == 0 {
|
||||
writeError(w, http.StatusBadRequest, "empty", "\u6ca1\u6709\u53ef\u5bfc\u5165\u7684\u8bb0\u5f55")
|
||||
return
|
||||
}
|
||||
result, err := h.store.ImportByposRecords(r.Context(), records)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "import_error", err.Error())
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, result)
|
||||
}
|
||||
@@ -9,6 +9,7 @@ import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
@@ -50,8 +51,34 @@ type ProductRow struct {
|
||||
UpdatedAt string `json:"updated_at"`
|
||||
}
|
||||
|
||||
// productSortColumns whitelists the sortable list columns, mapping the API sort
|
||||
// key to a SQL expression. NULLs sort last regardless of direction.
|
||||
var productSortColumns = map[string]string{
|
||||
"name": "p.name",
|
||||
"brand": "b.name",
|
||||
"gtin": "p.gtin",
|
||||
"category_path": "c.path",
|
||||
"status": "p.status",
|
||||
"quality_score": "p.quality_score",
|
||||
"updated_at": "p.updated_at",
|
||||
}
|
||||
|
||||
// productOrderBy returns a safe ORDER BY clause for the given sort key/direction,
|
||||
// falling back to the default (most recently updated first) for unknown keys.
|
||||
func productOrderBy(sort, order string) string {
|
||||
col, ok := productSortColumns[sort]
|
||||
if !ok {
|
||||
return "p.updated_at DESC"
|
||||
}
|
||||
dir := "ASC"
|
||||
if strings.EqualFold(order, "desc") {
|
||||
dir = "DESC"
|
||||
}
|
||||
return col + " " + dir + " NULLS LAST, p.updated_at DESC"
|
||||
}
|
||||
|
||||
// ListProducts returns a paginated, optionally name/gtin-filtered list.
|
||||
func (s *Store) ListProducts(ctx context.Context, q string, limit, offset int) ([]ProductRow, int, error) {
|
||||
func (s *Store) ListProducts(ctx context.Context, q, sort, order string, limit, offset int) ([]ProductRow, int, error) {
|
||||
args := []any{}
|
||||
where := "WHERE 1=1"
|
||||
if q != "" {
|
||||
@@ -64,10 +91,15 @@ func (s *Store) ListProducts(ctx context.Context, q string, limit, offset int) (
|
||||
return nil, 0, err
|
||||
}
|
||||
|
||||
qualified, err := s.kindQualifiedKeys(ctx, s.pool)
|
||||
if err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
|
||||
args = append(args, limit, offset)
|
||||
sql := `
|
||||
SELECT p.id, p.gtin, p.name, b.name, c.path::text, p.status, p.quality_score,
|
||||
p.updated_at,
|
||||
p.updated_at, COALESCE(c.archive_kind, 'generic'), p.attributes,
|
||||
(p.brand_id IS NOT NULL) AS has_brand,
|
||||
(p.category_id IS NOT NULL) AS has_cat,
|
||||
(p.net_content_canonical IS NOT NULL) AS has_net,
|
||||
@@ -79,7 +111,8 @@ FROM product p
|
||||
LEFT JOIN brand b ON b.id = p.brand_id
|
||||
LEFT JOIN category c ON c.id = p.category_id
|
||||
LEFT JOIN food_detail f ON f.product_id = p.id ` + where +
|
||||
" ORDER BY p.updated_at DESC LIMIT $" + strconv.Itoa(len(args)-1) + " OFFSET $" + strconv.Itoa(len(args))
|
||||
" ORDER BY " + productOrderBy(sort, order) +
|
||||
" LIMIT $" + strconv.Itoa(len(args)-1) + " OFFSET $" + strconv.Itoa(len(args))
|
||||
|
||||
rows, err := s.pool.Query(ctx, sql, args...)
|
||||
if err != nil {
|
||||
@@ -91,13 +124,21 @@ LEFT JOIN food_detail f ON f.product_id = p.id ` + where +
|
||||
for rows.Next() {
|
||||
var r ProductRow
|
||||
var hasBrand, hasCat, hasNet, hasCountry, hasNutri, hasIng, hasImg bool
|
||||
var kind string
|
||||
var attributes []byte
|
||||
var updated time.Time
|
||||
if err := rows.Scan(&r.ID, &r.GTIN, &r.Name, &r.Brand, &r.CategoryPath, &r.Status,
|
||||
&r.QualityScore, &updated, &hasBrand, &hasCat, &hasNet, &hasCountry,
|
||||
&r.QualityScore, &updated, &kind, &attributes,
|
||||
&hasBrand, &hasCat, &hasNet, &hasCountry,
|
||||
&hasNutri, &hasIng, &hasImg); err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
r.UpdatedAt = updated.Format(time.RFC3339)
|
||||
attrs := map[string]any{}
|
||||
if len(attributes) > 0 {
|
||||
_ = json.Unmarshal(attributes, &attrs)
|
||||
}
|
||||
qkeys := qualified[kind]
|
||||
present := map[string]bool{
|
||||
"name": r.Name != "",
|
||||
"gtin": r.GTIN != nil && *r.GTIN != "",
|
||||
@@ -109,8 +150,11 @@ LEFT JOIN food_detail f ON f.product_id = p.id ` + where +
|
||||
"ingredients": hasIng,
|
||||
"image": hasImg,
|
||||
}
|
||||
for _, k := range qkeys {
|
||||
present[k] = attrPresent(attrs, k)
|
||||
}
|
||||
r.Missing = []string{}
|
||||
for _, f := range CompletenessFields {
|
||||
for _, f := range completenessKeys(kind, qkeys) {
|
||||
if !present[f] {
|
||||
r.Missing = append(r.Missing, f)
|
||||
}
|
||||
@@ -150,6 +194,8 @@ type ProductDetail struct {
|
||||
Brand *string `json:"brand"`
|
||||
CategoryID *string `json:"category_id"`
|
||||
CategoryPath *string `json:"category_path"`
|
||||
ArchiveKind string `json:"archive_kind"`
|
||||
Attributes map[string]any `json:"attributes"`
|
||||
NetContentValue *float64 `json:"net_content_value"`
|
||||
NetContentUnit *string `json:"net_content_unit"`
|
||||
CountryOfOrigin *string `json:"country_of_origin"`
|
||||
@@ -162,6 +208,7 @@ type ProductDetail struct {
|
||||
NutritionBasis *string `json:"nutrition_basis"`
|
||||
ServingSize *string `json:"serving_size"`
|
||||
NutriScore *string `json:"nutri_score"`
|
||||
Barcodes []Barcode `json:"barcodes"`
|
||||
Images []ProductImage `json:"images"`
|
||||
MSRP []MSRP `json:"msrp"`
|
||||
Missing []string `json:"missing"`
|
||||
@@ -172,9 +219,11 @@ type ProductDetail struct {
|
||||
func (s *Store) GetProduct(ctx context.Context, id string) (*ProductDetail, error) {
|
||||
var d ProductDetail
|
||||
var nutriments []byte
|
||||
var attributes []byte
|
||||
var updated time.Time
|
||||
err := s.pool.QueryRow(ctx, `
|
||||
SELECT p.id, p.gtin, p.name, p.brand_id, b.name, p.category_id, c.path::text,
|
||||
COALESCE(c.archive_kind, 'generic'), p.attributes,
|
||||
p.net_content_value, p.net_content_unit, p.country_of_origin, p.status,
|
||||
p.quality_score, p.updated_at,
|
||||
f.ingredients_text, f.allergens, f.additives, f.nutriments,
|
||||
@@ -185,6 +234,7 @@ LEFT JOIN category c ON c.id = p.category_id
|
||||
LEFT JOIN food_detail f ON f.product_id = p.id
|
||||
WHERE p.id = $1`, id).Scan(
|
||||
&d.ID, &d.GTIN, &d.Name, &d.BrandID, &d.Brand, &d.CategoryID, &d.CategoryPath,
|
||||
&d.ArchiveKind, &attributes,
|
||||
&d.NetContentValue, &d.NetContentUnit, &d.CountryOfOrigin, &d.Status,
|
||||
&d.QualityScore, &updated,
|
||||
&d.IngredientsText, &d.Allergens, &d.Additives, &nutriments,
|
||||
@@ -197,6 +247,10 @@ WHERE p.id = $1`, id).Scan(
|
||||
return nil, err
|
||||
}
|
||||
d.UpdatedAt = updated.Format(time.RFC3339)
|
||||
d.Attributes = map[string]any{}
|
||||
if len(attributes) > 0 {
|
||||
_ = json.Unmarshal(attributes, &d.Attributes)
|
||||
}
|
||||
if len(nutriments) > 0 {
|
||||
_ = json.Unmarshal(nutriments, &d.Nutriments)
|
||||
}
|
||||
@@ -207,6 +261,12 @@ WHERE p.id = $1`, id).Scan(
|
||||
d.Additives = []string{}
|
||||
}
|
||||
|
||||
bcs, err := s.listBarcodes(ctx, id)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
d.Barcodes = bcs
|
||||
|
||||
imgs, err := s.listImages(ctx, id)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
@@ -219,11 +279,15 @@ WHERE p.id = $1`, id).Scan(
|
||||
}
|
||||
d.MSRP = msrps
|
||||
|
||||
d.Missing = missingFromDetail(&d)
|
||||
qualified, err := s.kindQualifiedKeys(ctx, s.pool)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
d.Missing = missingFromDetail(&d, qualified[d.ArchiveKind])
|
||||
return &d, nil
|
||||
}
|
||||
|
||||
func missingFromDetail(d *ProductDetail) []string {
|
||||
func missingFromDetail(d *ProductDetail, qualifiedAttrKeys []string) []string {
|
||||
present := map[string]bool{
|
||||
"name": d.Name != "",
|
||||
"gtin": d.GTIN != nil && *d.GTIN != "",
|
||||
@@ -235,8 +299,11 @@ func missingFromDetail(d *ProductDetail) []string {
|
||||
"ingredients": d.IngredientsText != nil && *d.IngredientsText != "",
|
||||
"image": len(d.Images) > 0,
|
||||
}
|
||||
for _, k := range qualifiedAttrKeys {
|
||||
present[k] = attrPresent(d.Attributes, k)
|
||||
}
|
||||
missing := []string{}
|
||||
for _, f := range CompletenessFields {
|
||||
for _, f := range completenessKeys(d.ArchiveKind, qualifiedAttrKeys) {
|
||||
if !present[f] {
|
||||
missing = append(missing, f)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,136 @@
|
||||
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"`
|
||||
QuotaTotal int64 `json:"quota_total"`
|
||||
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"`
|
||||
QuotaTotal int64 `json:"quota_total"`
|
||||
}
|
||||
|
||||
// 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
|
||||
}
|
||||
quota := in.QuotaTotal
|
||||
if quota < 0 {
|
||||
quota = 0
|
||||
}
|
||||
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, quota_total, created_by)
|
||||
VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
|
||||
RETURNING id, name, key_prefix, owner_email, tier, rate_limit_per_min, quota_total, revoked_at, created_by, created_at`,
|
||||
strings.TrimSpace(in.Name), prefix, hash, owner, tier, rate, quota, createdBy,
|
||||
).Scan(&row.ID, &row.Name, &row.KeyPrefix, &row.OwnerEmail, &row.Tier,
|
||||
&row.RateLimitPerMin, &row.QuotaTotal, &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, quota_total, 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, &r.QuotaTotal, &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,270 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/gtin"
|
||||
)
|
||||
|
||||
// Barcode is one GS1 trade item number attached to a product.
|
||||
type Barcode struct {
|
||||
ID string `json:"id"`
|
||||
GTIN string `json:"gtin"`
|
||||
GTINType string `json:"gtin_type"`
|
||||
PackLevel string `json:"pack_level"`
|
||||
Region *string `json:"region"`
|
||||
IsPrimary bool `json:"is_primary"`
|
||||
}
|
||||
|
||||
// BarcodeInput is the payload for attaching a barcode to a product.
|
||||
type BarcodeInput struct {
|
||||
GTIN string `json:"gtin"`
|
||||
GTINType string `json:"gtin_type"`
|
||||
PackLevel string `json:"pack_level"`
|
||||
Region *string `json:"region"`
|
||||
IsPrimary bool `json:"is_primary"`
|
||||
}
|
||||
|
||||
// ConflictError signals that a barcode is already attached to another product,
|
||||
// so the operator must de-duplicate instead of creating a clash.
|
||||
type ConflictError struct {
|
||||
GTIN string
|
||||
ProductID string
|
||||
ProductName string
|
||||
}
|
||||
|
||||
func (e *ConflictError) Error() string { return "条码已被其他商品占用:" + e.GTIN }
|
||||
|
||||
func validPackLevel(p string) string {
|
||||
switch p {
|
||||
case "each", "case", "pallet":
|
||||
return p
|
||||
default:
|
||||
return "each"
|
||||
}
|
||||
}
|
||||
|
||||
func validGTINType(t, normalized string) string {
|
||||
switch t {
|
||||
case "EAN8", "UPC", "EAN13", "ITF14", "GTIN14":
|
||||
return t
|
||||
default:
|
||||
return gtin.InferType(normalized)
|
||||
}
|
||||
}
|
||||
|
||||
func (s *Store) listBarcodes(ctx context.Context, productID string) ([]Barcode, error) {
|
||||
rows, err := s.pool.Query(ctx,
|
||||
`SELECT id, gtin, gtin_type, pack_level, region, is_primary
|
||||
FROM product_barcode WHERE product_id = $1
|
||||
ORDER BY is_primary DESC, gtin`, productID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
out := []Barcode{}
|
||||
for rows.Next() {
|
||||
var b Barcode
|
||||
if err := rows.Scan(&b.ID, &b.GTIN, &b.GTINType, &b.PackLevel, &b.Region, &b.IsPrimary); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, b)
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// barcodeOwner returns the product currently owning a barcode, if any.
|
||||
func barcodeOwner(ctx context.Context, q pgx.Tx, code string) (productID, productName string, found bool, err error) {
|
||||
err = q.QueryRow(ctx,
|
||||
`SELECT pb.product_id, p.name FROM product_barcode pb
|
||||
JOIN product p ON p.id = pb.product_id WHERE pb.gtin = $1`, code).
|
||||
Scan(&productID, &productName)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return "", "", false, nil
|
||||
}
|
||||
if err != nil {
|
||||
return "", "", false, err
|
||||
}
|
||||
return productID, productName, true, nil
|
||||
}
|
||||
|
||||
// AddBarcode validates and attaches a barcode to a product, recording audit.
|
||||
// A barcode already owned by another product yields a *ConflictError.
|
||||
func (s *Store) AddBarcode(ctx context.Context, productID, actor string, in BarcodeInput) (*Barcode, error) {
|
||||
code, err := gtin.Normalize(in.GTIN)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer tx.Rollback(ctx)
|
||||
|
||||
// Product must exist.
|
||||
var exists bool
|
||||
if err := tx.QueryRow(ctx, "SELECT EXISTS(SELECT 1 FROM product WHERE id=$1)", productID).Scan(&exists); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if !exists {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
|
||||
// Globally unique: a barcode owned by any product (this one included)
|
||||
// is a conflict the operator must resolve by de-duplicating.
|
||||
if owner, name, found, err := barcodeOwner(ctx, tx, code); err != nil {
|
||||
return nil, err
|
||||
} else if found {
|
||||
return nil, &ConflictError{GTIN: code, ProductID: owner, ProductName: name}
|
||||
}
|
||||
|
||||
// Make this the primary barcode when requested or when none exists yet.
|
||||
makePrimary := in.IsPrimary
|
||||
if !makePrimary {
|
||||
var hasPrimary bool
|
||||
if err := tx.QueryRow(ctx,
|
||||
"SELECT EXISTS(SELECT 1 FROM product_barcode WHERE product_id=$1 AND is_primary)", productID).
|
||||
Scan(&hasPrimary); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
makePrimary = !hasPrimary
|
||||
}
|
||||
if makePrimary {
|
||||
if _, err := tx.Exec(ctx,
|
||||
"UPDATE product_barcode SET is_primary=false WHERE product_id=$1 AND is_primary", productID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
srcID, _ := s.manualSourceID(ctx, tx)
|
||||
var srcArg any
|
||||
if srcID != "" {
|
||||
srcArg = srcID
|
||||
}
|
||||
|
||||
var b Barcode
|
||||
err = tx.QueryRow(ctx, `
|
||||
INSERT INTO product_barcode (product_id, gtin, gtin_type, pack_level, region, is_primary, source_id)
|
||||
VALUES ($1,$2,$3,$4,$5,$6,$7)
|
||||
RETURNING id, gtin, gtin_type, pack_level, region, is_primary`,
|
||||
productID, code, validGTINType(in.GTINType, code), validPackLevel(in.PackLevel),
|
||||
in.Region, makePrimary, srcArg).
|
||||
Scan(&b.ID, &b.GTIN, &b.GTINType, &b.PackLevel, &b.Region, &b.IsPrimary)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if makePrimary {
|
||||
if _, err := tx.Exec(ctx, "UPDATE product SET gtin=$2 WHERE id=$1", productID, code); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
if _, err := s.recomputeQualityTx(ctx, tx, productID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
_ = s.writeAudit(ctx, actor, "add_barcode", "product", &productID, []string{"gtin"}, nil, b)
|
||||
return &b, nil
|
||||
}
|
||||
|
||||
// DeleteBarcode removes a barcode; if it was primary, another is promoted.
|
||||
func (s *Store) DeleteBarcode(ctx context.Context, productID, barcodeID, actor string) error {
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer tx.Rollback(ctx)
|
||||
|
||||
var code string
|
||||
var wasPrimary bool
|
||||
err = tx.QueryRow(ctx,
|
||||
"DELETE FROM product_barcode WHERE id=$1 AND product_id=$2 RETURNING gtin, is_primary",
|
||||
barcodeID, productID).Scan(&code, &wasPrimary)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if wasPrimary {
|
||||
var newID, newGTIN string
|
||||
e := tx.QueryRow(ctx,
|
||||
"SELECT id, gtin FROM product_barcode WHERE product_id=$1 ORDER BY gtin LIMIT 1", productID).
|
||||
Scan(&newID, &newGTIN)
|
||||
if e == nil {
|
||||
if _, err := tx.Exec(ctx, "UPDATE product_barcode SET is_primary=true WHERE id=$1", newID); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := tx.Exec(ctx, "UPDATE product SET gtin=$2 WHERE id=$1", productID, newGTIN); err != nil {
|
||||
return err
|
||||
}
|
||||
} else if errors.Is(e, pgx.ErrNoRows) {
|
||||
if _, err := tx.Exec(ctx, "UPDATE product SET gtin=NULL WHERE id=$1", productID); err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
return e
|
||||
}
|
||||
}
|
||||
|
||||
if _, err := s.recomputeQualityTx(ctx, tx, productID); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return err
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "delete_barcode", "product", &productID, []string{"gtin"},
|
||||
map[string]string{"gtin": code}, nil)
|
||||
return nil
|
||||
}
|
||||
|
||||
// SetPrimaryBarcode marks one barcode primary and mirrors it to product.gtin.
|
||||
func (s *Store) SetPrimaryBarcode(ctx context.Context, productID, barcodeID, actor string) (*Barcode, error) {
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer tx.Rollback(ctx)
|
||||
|
||||
var code string
|
||||
err = tx.QueryRow(ctx, "SELECT gtin FROM product_barcode WHERE id=$1 AND product_id=$2", barcodeID, productID).Scan(&code)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if _, err := tx.Exec(ctx, "UPDATE product_barcode SET is_primary=false WHERE product_id=$1 AND is_primary", productID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if _, err := tx.Exec(ctx, "UPDATE product_barcode SET is_primary=true WHERE id=$1", barcodeID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if _, err := tx.Exec(ctx, "UPDATE product SET gtin=$2 WHERE id=$1", productID, code); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
_ = s.writeAudit(ctx, actor, "set_primary_barcode", "product", &productID, []string{"gtin"}, nil,
|
||||
map[string]string{"gtin": code})
|
||||
|
||||
bcs, err := s.listBarcodes(ctx, productID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
for i := range bcs {
|
||||
if bcs[i].ID == barcodeID {
|
||||
return &bcs[i], nil
|
||||
}
|
||||
}
|
||||
return nil, ErrNotFound
|
||||
}
|
||||
@@ -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,298 @@
|
||||
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
|
||||
kind := DefaultKind
|
||||
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, archive_kind FROM category WHERE id = $1", *pid).Scan(&path, &level, &kind)
|
||||
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, archive_kind)
|
||||
VALUES ($1, $2, $3, $4::ltree, $5, $6, $7)
|
||||
RETURNING id, name_zh, name_en, path::text, level, parent_id::text, gpc_brick_code, archive_kind, 0`,
|
||||
name, trimPtr(in.NameEN), parentID, path, trimPtr(in.GPCBrickCode), level, kind).
|
||||
Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level, &c.ParentID, &c.GPCBrickCode, &c.ArchiveKind, &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, c.archive_kind,
|
||||
(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.ArchiveKind, &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,217 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
)
|
||||
|
||||
type ByposRecord struct {
|
||||
Barcode string `json:"barcode"`
|
||||
Name string `json:"name"`
|
||||
Spec string `json:"spec"`
|
||||
Unit string `json:"unit"`
|
||||
Area string `json:"area"`
|
||||
Manufacturer string `json:"manufacturer"`
|
||||
License string `json:"license"`
|
||||
InPrice string `json:"in_price"`
|
||||
SellPrice string `json:"sell_price"`
|
||||
Status string `json:"status"`
|
||||
RetMsg string `json:"retmsg"`
|
||||
FetchedAt string `json:"fetched_at"`
|
||||
Source string `json:"source"`
|
||||
}
|
||||
|
||||
type ImportByposResult struct {
|
||||
Loaded int `json:"loaded"`
|
||||
Skipped int `json:"skipped"`
|
||||
Errored int `json:"errored"`
|
||||
}
|
||||
|
||||
const byposSourceName = "bypos\u4e2d\u5fc3\u5e93"
|
||||
const byposSourceURL = "https://zc.bypos.net"
|
||||
|
||||
func (s *Store) ensureByposSource(ctx context.Context, tx pgx.Tx) (string, error) {
|
||||
var id string
|
||||
err := tx.QueryRow(ctx, `
|
||||
INSERT INTO source (name, homepage, license, trust_weight)
|
||||
VALUES ($1, $2, 'proprietary', 0.6)
|
||||
ON CONFLICT (name) DO UPDATE SET homepage = EXCLUDED.homepage
|
||||
RETURNING id`, byposSourceName, byposSourceURL).Scan(&id)
|
||||
return id, err
|
||||
}
|
||||
|
||||
func (s *Store) ensureManufacturer(ctx context.Context, tx pgx.Tx, name string, country *string) (string, error) {
|
||||
norm := strings.Join(strings.Fields(strings.ToLower(name)), " ")
|
||||
var id string
|
||||
err := tx.QueryRow(ctx, `
|
||||
INSERT INTO manufacturer (name, normalized_name, country)
|
||||
VALUES ($1, $2, $3)
|
||||
ON CONFLICT (normalized_name) DO UPDATE SET name = manufacturer.name
|
||||
RETURNING id`, name, norm, country).Scan(&id)
|
||||
return id, err
|
||||
}
|
||||
|
||||
func (s *Store) importByposRecord(ctx context.Context, tx pgx.Tx, rec ByposRecord, sourceID string) error {
|
||||
if rec.Status != "hit" || strings.TrimSpace(rec.Name) == "" {
|
||||
return nil
|
||||
}
|
||||
|
||||
barcode := strings.TrimSpace(rec.Barcode)
|
||||
name := strings.TrimSpace(rec.Name)
|
||||
|
||||
var country *string
|
||||
if strings.HasPrefix(barcode, "69") {
|
||||
c := "\u4e2d\u56fd"
|
||||
country = &c
|
||||
}
|
||||
|
||||
var manufacturerID *string
|
||||
if mfr := strings.TrimSpace(rec.Manufacturer); mfr != "" {
|
||||
mid, err := s.ensureManufacturer(ctx, tx, mfr, country)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
manufacturerID = &mid
|
||||
}
|
||||
|
||||
attrs := map[string]interface{}{}
|
||||
if v := strings.TrimSpace(rec.Spec); v != "" {
|
||||
attrs["spec"] = v
|
||||
}
|
||||
if v := strings.TrimSpace(rec.Unit); v != "" {
|
||||
attrs["pack_unit"] = v
|
||||
}
|
||||
if v := strings.TrimSpace(rec.Area); v != "" {
|
||||
attrs["origin_area"] = v
|
||||
}
|
||||
if v := strings.TrimSpace(rec.License); v != "" {
|
||||
attrs["production_license"] = v
|
||||
}
|
||||
attrsJSON, _ := json.Marshal(attrs)
|
||||
|
||||
var productID string
|
||||
if barcode != "" {
|
||||
err := tx.QueryRow(ctx, `
|
||||
INSERT INTO product (gtin, name, manufacturer_id, country_of_origin, attributes, status)
|
||||
VALUES ($1, $2, $3, $4, $5, 'active')
|
||||
ON CONFLICT (gtin) WHERE gtin IS NOT NULL DO UPDATE SET
|
||||
name = EXCLUDED.name,
|
||||
manufacturer_id = COALESCE(EXCLUDED.manufacturer_id, product.manufacturer_id),
|
||||
country_of_origin = COALESCE(EXCLUDED.country_of_origin, product.country_of_origin),
|
||||
attributes = product.attributes || EXCLUDED.attributes
|
||||
RETURNING id`, barcode, name, manufacturerID, country, attrsJSON).Scan(&productID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
err := tx.QueryRow(ctx, `
|
||||
INSERT INTO product (name, manufacturer_id, country_of_origin, attributes, status)
|
||||
VALUES ($1, $2, $3, $4, 'active')
|
||||
RETURNING id`, name, manufacturerID, country, attrsJSON).Scan(&productID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
_, _ = tx.Exec(ctx, "DELETE FROM product_msrp WHERE product_id = $1 AND source_id = $2", productID, sourceID)
|
||||
if sp := strings.TrimSpace(rec.SellPrice); sp != "" && sp != "0" {
|
||||
_, _ = tx.Exec(ctx, `
|
||||
INSERT INTO product_msrp (product_id, amount, currency, region, source_id, source_url)
|
||||
VALUES ($1, $2::numeric, 'CNY', 'CN', $3, $4)`, productID, sp, sourceID, byposSourceURL)
|
||||
}
|
||||
|
||||
_, _ = tx.Exec(ctx, "DELETE FROM product_source WHERE product_id = $1 AND source_id = $2", productID, sourceID)
|
||||
fields := []string{"name", "country_of_origin"}
|
||||
if manufacturerID != nil {
|
||||
fields = append(fields, "manufacturer")
|
||||
}
|
||||
if len(attrs) > 0 {
|
||||
fields = append(fields, "attributes")
|
||||
}
|
||||
if barcode != "" {
|
||||
fields = append(fields, "gtin")
|
||||
}
|
||||
rawJSON, _ := json.Marshal(rec)
|
||||
fetchedAt := strings.TrimSpace(rec.FetchedAt)
|
||||
if fetchedAt == "" {
|
||||
fetchedAt = ""
|
||||
}
|
||||
|
||||
if fetchedAt != "" {
|
||||
_, err := tx.Exec(ctx, `
|
||||
INSERT INTO product_source (product_id, source_id, url, fields, fetched_at, raw)
|
||||
VALUES ($1, $2, $3, $4, $5::timestamptz, $6)`,
|
||||
productID, sourceID, byposSourceURL, fields, fetchedAt, rawJSON)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
_, err := tx.Exec(ctx, `
|
||||
INSERT INTO product_source (product_id, source_id, url, fields, fetched_at, raw)
|
||||
VALUES ($1, $2, $3, $4, now(), $5)`,
|
||||
productID, sourceID, byposSourceURL, fields, rawJSON)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if barcode != "" {
|
||||
gtinType := "EAN13"
|
||||
switch len(barcode) {
|
||||
case 8:
|
||||
gtinType = "EAN8"
|
||||
case 12:
|
||||
gtinType = "UPC"
|
||||
case 14:
|
||||
gtinType = "GTIN14"
|
||||
}
|
||||
_, _ = tx.Exec(ctx, `
|
||||
INSERT INTO product_barcode (product_id, gtin, gtin_type, pack_level, is_primary, source_id)
|
||||
VALUES ($1, $2, $3, 'each', true, $4)
|
||||
ON CONFLICT (gtin) DO NOTHING`, productID, barcode, gtinType, sourceID)
|
||||
}
|
||||
|
||||
_, err := s.recomputeQualityTx(ctx, tx, productID)
|
||||
return err
|
||||
}
|
||||
|
||||
func (s *Store) ImportByposRecords(ctx context.Context, records []ByposRecord) (*ImportByposResult, error) {
|
||||
result := &ImportByposResult{}
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer tx.Rollback(ctx)
|
||||
|
||||
sourceID, err := s.ensureByposSource(ctx, tx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
for _, rec := range records {
|
||||
if rec.Status != "hit" || strings.TrimSpace(rec.Name) == "" {
|
||||
result.Skipped++
|
||||
continue
|
||||
}
|
||||
sp, spErr := tx.Begin(ctx)
|
||||
if spErr != nil {
|
||||
result.Errored++
|
||||
continue
|
||||
}
|
||||
if err := s.importByposRecord(ctx, sp, rec, sourceID); err != nil {
|
||||
sp.Rollback(ctx)
|
||||
result.Errored++
|
||||
} else {
|
||||
sp.Commit(ctx)
|
||||
result.Loaded++
|
||||
}
|
||||
}
|
||||
|
||||
if err := tx.Commit(ctx); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
@@ -0,0 +1,101 @@
|
||||
package adminstore
|
||||
|
||||
import "context"
|
||||
|
||||
// DefaultKind is used for products whose category has no archive kind (or no
|
||||
// category at all).
|
||||
const DefaultKind = "generic"
|
||||
|
||||
// FoodKind keeps the mature, dedicated food_detail path; every other kind is
|
||||
// driven generically by kind_field + product.attributes.
|
||||
const FoodKind = "food"
|
||||
|
||||
// genericBaseFields are the core completeness fields for any non-food kind.
|
||||
// Food keeps its own richer CompletenessFields list.
|
||||
var genericBaseFields = []string{"name", "gtin", "brand", "category", "image"}
|
||||
|
||||
// KindField describes one editable spec field for an archive kind. It drives
|
||||
// both the dynamic admin form and the kind-aware completeness computation.
|
||||
type KindField struct {
|
||||
Kind string `json:"kind"`
|
||||
FieldKey string `json:"field_key"`
|
||||
GroupLabel string `json:"group_label"`
|
||||
LabelZH string `json:"label_zh"`
|
||||
FieldType string `json:"field_type"`
|
||||
Unit *string `json:"unit"`
|
||||
Options []string `json:"options"`
|
||||
Placeholder *string `json:"placeholder"`
|
||||
SortOrder int `json:"sort_order"`
|
||||
Qualified bool `json:"qualified"`
|
||||
}
|
||||
|
||||
// ListKindFields returns the ordered field template for one archive kind.
|
||||
func (s *Store) ListKindFields(ctx context.Context, kind string) ([]KindField, error) {
|
||||
rows, err := s.pool.Query(ctx, `
|
||||
SELECT kind, field_key, group_label, label_zh, field_type, unit, options,
|
||||
placeholder, sort_order, qualified
|
||||
FROM kind_field WHERE kind = $1 ORDER BY sort_order, field_key`, kind)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
out := []KindField{}
|
||||
for rows.Next() {
|
||||
var f KindField
|
||||
if err := rows.Scan(&f.Kind, &f.FieldKey, &f.GroupLabel, &f.LabelZH,
|
||||
&f.FieldType, &f.Unit, &f.Options, &f.Placeholder, &f.SortOrder,
|
||||
&f.Qualified); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, f)
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// kindQualifiedKeys returns, per kind, the attribute keys that count toward the
|
||||
// completeness/qualified score. Loaded in one query so list views stay cheap.
|
||||
func (s *Store) kindQualifiedKeys(ctx context.Context, q queryer) (map[string][]string, error) {
|
||||
rows, err := s.pool.Query(ctx,
|
||||
"SELECT kind, field_key FROM kind_field WHERE qualified ORDER BY sort_order, field_key")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
m := map[string][]string{}
|
||||
for rows.Next() {
|
||||
var kind, key string
|
||||
if err := rows.Scan(&kind, &key); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
m[kind] = append(m[kind], key)
|
||||
}
|
||||
return m, rows.Err()
|
||||
}
|
||||
|
||||
// completenessKeys returns the ordered list of field keys that define a full
|
||||
// archive for the given kind.
|
||||
func completenessKeys(kind string, qualifiedAttrKeys []string) []string {
|
||||
if kind == FoodKind {
|
||||
return CompletenessFields
|
||||
}
|
||||
keys := make([]string, 0, len(genericBaseFields)+len(qualifiedAttrKeys))
|
||||
keys = append(keys, genericBaseFields...)
|
||||
keys = append(keys, qualifiedAttrKeys...)
|
||||
return keys
|
||||
}
|
||||
|
||||
// attrPresent reports whether an attribute value is meaningfully filled in.
|
||||
func attrPresent(attrs map[string]any, key string) bool {
|
||||
v, ok := attrs[key]
|
||||
if !ok || v == nil {
|
||||
return false
|
||||
}
|
||||
switch t := v.(type) {
|
||||
case string:
|
||||
return t != ""
|
||||
case []any:
|
||||
return len(t) > 0
|
||||
default:
|
||||
return true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// contains reports whether s holds v.
|
||||
func contains(s []string, v string) bool {
|
||||
for _, x := range s {
|
||||
if x == v {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// electronicsCategoryID returns the seeded electronics.phone category id,
|
||||
// skipping the test when the archive-kind migration is not applied.
|
||||
func electronicsCategoryID(t *testing.T, s *Store) string {
|
||||
t.Helper()
|
||||
ctx := context.Background()
|
||||
var hasTable bool
|
||||
if err := s.pool.QueryRow(ctx, "SELECT to_regclass('public.kind_field') IS NOT NULL").Scan(&hasTable); err != nil || !hasTable {
|
||||
t.Skip("archive-kind migration not applied (kind_field missing)")
|
||||
}
|
||||
var id string
|
||||
err := s.pool.QueryRow(ctx, "SELECT id FROM category WHERE path = 'electronics.phone'::ltree").Scan(&id)
|
||||
if err != nil {
|
||||
t.Skipf("electronics.phone category not seeded: %v", err)
|
||||
}
|
||||
return id
|
||||
}
|
||||
|
||||
func TestListKindFieldsElectronics(t *testing.T) {
|
||||
s := newTestStore(t)
|
||||
electronicsCategoryID(t, s) // ensures migration applied
|
||||
fields, err := s.ListKindFields(context.Background(), "electronics")
|
||||
if err != nil {
|
||||
t.Fatalf("list kind fields: %v", err)
|
||||
}
|
||||
if len(fields) == 0 {
|
||||
t.Fatal("expected seeded electronics fields, got none")
|
||||
}
|
||||
var sawQualified bool
|
||||
for _, f := range fields {
|
||||
if f.FieldKey == "model_number" && f.Qualified {
|
||||
sawQualified = true
|
||||
}
|
||||
}
|
||||
if !sawQualified {
|
||||
t.Fatal("expected model_number to be a qualified field")
|
||||
}
|
||||
}
|
||||
|
||||
// TestElectronicsArchiveKind verifies a non-food product uses the electronics
|
||||
// completeness rules: food fields (nutriments/ingredients) are not required,
|
||||
// and qualified spec fields drive both "missing" and the quality score.
|
||||
func TestElectronicsArchiveKind(t *testing.T) {
|
||||
s := newTestStore(t)
|
||||
ctx := context.Background()
|
||||
catID := electronicsCategoryID(t, s)
|
||||
|
||||
created, err := s.CreateProduct(ctx, "tester", ProductInput{
|
||||
Name: "测试手机 " + randomHex(6),
|
||||
CategoryID: &catID,
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("create product: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _, _ = s.pool.Exec(ctx, "DELETE FROM product WHERE id = $1", created.ID) })
|
||||
|
||||
if created.ArchiveKind != "electronics" {
|
||||
t.Fatalf("archive_kind = %q, want electronics", created.ArchiveKind)
|
||||
}
|
||||
// Food-only completeness fields must not be required for electronics.
|
||||
if contains(created.Missing, "nutriments") || contains(created.Missing, "ingredients") {
|
||||
t.Fatalf("electronics product should not require food fields: missing=%v", created.Missing)
|
||||
}
|
||||
// Qualified spec fields should appear as missing while empty.
|
||||
for _, k := range []string{"model_number", "ccc_cert", "screen_size"} {
|
||||
if !contains(created.Missing, k) {
|
||||
t.Fatalf("expected %q in missing, got %v", k, created.Missing)
|
||||
}
|
||||
}
|
||||
|
||||
scoreBefore := created.QualityScore
|
||||
|
||||
gtin := "69" + randomHex(11)
|
||||
brand := "TestPhoneCo"
|
||||
updated, err := s.UpdateProduct(ctx, created.ID, "tester", ProductInput{
|
||||
Name: created.Name,
|
||||
GTIN: >in,
|
||||
BrandName: &brand,
|
||||
CategoryID: &catID,
|
||||
Status: "active",
|
||||
Attributes: map[string]any{
|
||||
"model_number": "X-100",
|
||||
"ccc_cert": "2024010101234567",
|
||||
"screen_size": "6.1",
|
||||
"color": "黑色",
|
||||
},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("update product: %v", err)
|
||||
}
|
||||
|
||||
if got := updated.Attributes["model_number"]; got != "X-100" {
|
||||
t.Fatalf("attributes not persisted: %v", updated.Attributes)
|
||||
}
|
||||
for _, k := range []string{"model_number", "ccc_cert", "screen_size"} {
|
||||
if contains(updated.Missing, k) {
|
||||
t.Fatalf("%q should be filled, still missing: %v", k, updated.Missing)
|
||||
}
|
||||
}
|
||||
if updated.QualityScore <= scoreBefore {
|
||||
t.Fatalf("quality should rise after filling fields: before=%v after=%v", scoreBefore, updated.QualityScore)
|
||||
}
|
||||
}
|
||||
@@ -2,6 +2,7 @@ package adminstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"math"
|
||||
"time"
|
||||
|
||||
@@ -58,35 +59,56 @@ func (s *Store) computeQuality(ctx context.Context, q queryer, productID string)
|
||||
var netCanonical *float64
|
||||
var ingredients *string
|
||||
var hasNutri, hasImage bool
|
||||
var kind string
|
||||
var attributes []byte
|
||||
err := q.QueryRow(ctx, `
|
||||
SELECT p.name, p.gtin, p.brand_id, p.category_id, p.net_content_canonical,
|
||||
p.country_of_origin, f.ingredients_text,
|
||||
p.country_of_origin, COALESCE(c.archive_kind, 'generic'), p.attributes,
|
||||
f.ingredients_text,
|
||||
(f.nutriments IS NOT NULL AND f.nutriments::text <> '{}'),
|
||||
EXISTS (SELECT 1 FROM product_image pi WHERE pi.product_id = p.id)
|
||||
FROM product p LEFT JOIN food_detail f ON f.product_id = p.id
|
||||
FROM product p
|
||||
LEFT JOIN category c ON c.id = p.category_id
|
||||
LEFT JOIN food_detail f ON f.product_id = p.id
|
||||
WHERE p.id = $1`, productID).Scan(
|
||||
&name, >in, &brandID, &categoryID, &netCanonical, &country,
|
||||
&ingredients, &hasNutri, &hasImage)
|
||||
&kind, &attributes, &ingredients, &hasNutri, &hasImage)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
attrs := map[string]any{}
|
||||
if len(attributes) > 0 {
|
||||
_ = json.Unmarshal(attributes, &attrs)
|
||||
}
|
||||
qualified, err := s.kindQualifiedKeys(ctx, s.pool)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
qkeys := qualified[kind]
|
||||
|
||||
known := map[string]bool{
|
||||
"name": name != nil && *name != "",
|
||||
"gtin": gtin != nil && *gtin != "",
|
||||
"brand": brandID != nil,
|
||||
"category": categoryID != nil,
|
||||
"net_content": netCanonical != nil,
|
||||
"country_of_origin": country != nil && *country != "",
|
||||
"nutriments": hasNutri,
|
||||
"ingredients": ingredients != nil && *ingredients != "",
|
||||
"image": hasImage,
|
||||
}
|
||||
for _, k := range qkeys {
|
||||
known[k] = attrPresent(attrs, k)
|
||||
}
|
||||
keys := completenessKeys(kind, qkeys)
|
||||
present := 0
|
||||
bump := func(ok bool) {
|
||||
if ok {
|
||||
for _, k := range keys {
|
||||
if known[k] {
|
||||
present++
|
||||
}
|
||||
}
|
||||
bump(name != nil && *name != "")
|
||||
bump(gtin != nil && *gtin != "")
|
||||
bump(brandID != nil)
|
||||
bump(categoryID != nil)
|
||||
bump(netCanonical != nil)
|
||||
bump(country != nil && *country != "")
|
||||
bump(hasNutri)
|
||||
bump(ingredients != nil && *ingredients != "")
|
||||
bump(hasImage)
|
||||
completeness := float64(present) / float64(len(CompletenessFields))
|
||||
completeness := float64(present) / float64(len(keys))
|
||||
|
||||
var sourceCount int
|
||||
var sourceTrust *float64
|
||||
|
||||
@@ -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)
|
||||
}
|
||||
}
|
||||
@@ -31,6 +31,7 @@ type SubmissionInput struct {
|
||||
CountryOfOrigin *string `json:"country_of_origin"`
|
||||
IngredientsText *string `json:"ingredients_text"`
|
||||
Nutriments map[string]any `json:"nutriments"`
|
||||
Attributes map[string]any `json:"attributes"`
|
||||
NutritionBasis *string `json:"nutrition_basis"`
|
||||
ServingSize *string `json:"serving_size"`
|
||||
NutriScore *string `json:"nutri_score"`
|
||||
@@ -278,14 +279,19 @@ func (s *Store) ApproveSubmission(ctx context.Context, id, actor string) (*Produ
|
||||
|
||||
fields := submissionFields(in)
|
||||
|
||||
var attrJSON []byte
|
||||
if len(in.Attributes) > 0 {
|
||||
attrJSON, _ = json.Marshal(in.Attributes)
|
||||
}
|
||||
|
||||
if productID == "" {
|
||||
// Create a new product from the contribution.
|
||||
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,'active') RETURNING id`,
|
||||
net_content_value, net_content_unit, net_content_canonical, country_of_origin, attributes, status)
|
||||
VALUES ($1,$2,$3,$4,$5,$6,$7,$8,$9,COALESCE($10::jsonb,'{}'::jsonb),'active') RETURNING id`,
|
||||
in.GTIN, in.Name, brandID, in.CategoryID, gpc,
|
||||
in.NetContentValue, in.NetContentUnit, canonical, in.CountryOfOrigin).Scan(&productID)
|
||||
in.NetContentValue, in.NetContentUnit, canonical, in.CountryOfOrigin, attrJSON).Scan(&productID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -302,21 +308,29 @@ UPDATE product SET
|
||||
net_content_unit=COALESCE($7, net_content_unit),
|
||||
net_content_canonical=COALESCE($8, net_content_canonical),
|
||||
country_of_origin=COALESCE($9, country_of_origin),
|
||||
gtin=COALESCE($10, gtin)
|
||||
gtin=COALESCE($10, gtin),
|
||||
attributes=product.attributes || COALESCE($11::jsonb,'{}'::jsonb)
|
||||
WHERE id=$1`,
|
||||
productID, in.Name, brandID, in.CategoryID, gpc,
|
||||
in.NetContentValue, in.NetContentUnit, canonical, in.CountryOfOrigin, in.GTIN)
|
||||
in.NetContentValue, in.NetContentUnit, canonical, in.CountryOfOrigin, in.GTIN, attrJSON)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
// food_detail: upsert, preserving existing values where not provided.
|
||||
// food_detail: upsert only when the contribution carries food data, so a
|
||||
// non-food submission (drug/3C/generic) doesn't create an empty row.
|
||||
var nutriJSON []byte
|
||||
if len(in.Nutriments) > 0 {
|
||||
nutriJSON, _ = json.Marshal(in.Nutriments)
|
||||
}
|
||||
_, err = tx.Exec(ctx, `
|
||||
foodPresent := len(in.Nutriments) > 0 ||
|
||||
(in.IngredientsText != nil && *in.IngredientsText != "") ||
|
||||
(in.NutritionBasis != nil && *in.NutritionBasis != "") ||
|
||||
(in.ServingSize != nil && *in.ServingSize != "") ||
|
||||
(in.NutriScore != nil && *in.NutriScore != "")
|
||||
if foodPresent {
|
||||
_, err = tx.Exec(ctx, `
|
||||
INSERT INTO food_detail (product_id, ingredients_text, nutriments, nutrition_basis, serving_size, nutri_score)
|
||||
VALUES ($1,$2,$3,$4,$5,$6)
|
||||
ON CONFLICT (product_id) DO UPDATE SET
|
||||
@@ -325,9 +339,10 @@ ON CONFLICT (product_id) DO UPDATE SET
|
||||
nutrition_basis=COALESCE(EXCLUDED.nutrition_basis, food_detail.nutrition_basis),
|
||||
serving_size=COALESCE(EXCLUDED.serving_size, food_detail.serving_size),
|
||||
nutri_score=COALESCE(EXCLUDED.nutri_score, food_detail.nutri_score)`,
|
||||
productID, in.IngredientsText, nutriJSON, in.NutritionBasis, in.ServingSize, in.NutriScore)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
productID, in.IngredientsText, nutriJSON, in.NutritionBasis, in.ServingSize, in.NutriScore)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
for _, im := range in.Images {
|
||||
@@ -417,5 +432,14 @@ func submissionFields(in SubmissionInput) []string {
|
||||
add("ingredients", in.IngredientsText != nil && *in.IngredientsText != "")
|
||||
add("nutriments", len(in.Nutriments) > 0)
|
||||
add("image", len(in.Images) > 0)
|
||||
for k, v := range in.Attributes {
|
||||
if v == nil {
|
||||
continue
|
||||
}
|
||||
if s, ok := v.(string); ok && s == "" {
|
||||
continue
|
||||
}
|
||||
fields = append(fields, k)
|
||||
}
|
||||
return fields
|
||||
}
|
||||
|
||||
@@ -27,6 +27,9 @@ type ProductInput struct {
|
||||
NutritionBasis *string `json:"nutrition_basis"`
|
||||
ServingSize *string `json:"serving_size"`
|
||||
NutriScore *string `json:"nutri_score"`
|
||||
// Attributes carries non-food spec values (driven by kind_field) for the
|
||||
// generic archive kinds. Nil means "leave unchanged".
|
||||
Attributes map[string]any `json:"attributes"`
|
||||
}
|
||||
|
||||
func normBrand(name string) string { return strings.Join(strings.Fields(strings.ToLower(name)), " ") }
|
||||
@@ -86,10 +89,11 @@ func (s *Store) UpdateProduct(ctx context.Context, id, actor string, in ProductI
|
||||
brandID = &bid
|
||||
}
|
||||
|
||||
// Resolve category gpc brick code.
|
||||
// Resolve category gpc brick code + archive kind.
|
||||
var gpc *string
|
||||
kind := DefaultKind
|
||||
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) {
|
||||
if err := tx.QueryRow(ctx, "SELECT gpc_brick_code, archive_kind FROM category WHERE id = $1", *in.CategoryID).Scan(&gpc, &kind); err != nil && !errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
@@ -116,19 +120,28 @@ WHERE id=$11`,
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var nutriJSON []byte
|
||||
if in.Nutriments != nil {
|
||||
nutriJSON, _ = json.Marshal(in.Nutriments)
|
||||
// Non-food spec values live in product.attributes (nil means unchanged).
|
||||
if in.Attributes != nil {
|
||||
attrJSON, _ := json.Marshal(in.Attributes)
|
||||
if _, err = tx.Exec(ctx, "UPDATE product SET attributes=$1 WHERE id=$2", attrJSON, id); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
allergens := in.Allergens
|
||||
if allergens == nil {
|
||||
allergens = []string{}
|
||||
}
|
||||
additives := in.Additives
|
||||
if additives == nil {
|
||||
additives = []string{}
|
||||
}
|
||||
_, err = tx.Exec(ctx, `
|
||||
|
||||
if kind == FoodKind {
|
||||
var nutriJSON []byte
|
||||
if in.Nutriments != nil {
|
||||
nutriJSON, _ = json.Marshal(in.Nutriments)
|
||||
}
|
||||
allergens := in.Allergens
|
||||
if allergens == nil {
|
||||
allergens = []string{}
|
||||
}
|
||||
additives := in.Additives
|
||||
if additives == nil {
|
||||
additives = []string{}
|
||||
}
|
||||
_, err = tx.Exec(ctx, `
|
||||
INSERT INTO food_detail (product_id, ingredients_text, allergens, additives,
|
||||
nutriments, nutrition_basis, serving_size, nutri_score)
|
||||
VALUES ($1,$2,$3,$4,$5,$6,$7,$8)
|
||||
@@ -140,10 +153,11 @@ ON CONFLICT (product_id) DO UPDATE SET
|
||||
nutrition_basis=EXCLUDED.nutrition_basis,
|
||||
serving_size=EXCLUDED.serving_size,
|
||||
nutri_score=EXCLUDED.nutri_score`,
|
||||
id, in.IngredientsText, allergens, additives,
|
||||
nutriJSON, in.NutritionBasis, in.ServingSize, in.NutriScore)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
id, in.IngredientsText, allergens, additives,
|
||||
nutriJSON, in.NutritionBasis, in.ServingSize, in.NutriScore)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
if _, err := s.recomputeQualityTx(ctx, tx, id); err != nil {
|
||||
@@ -170,6 +184,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
|
||||
@@ -211,6 +298,9 @@ func diffFields(a, b *ProductDetail) []string {
|
||||
add("nutrition_basis", strEq(a.NutritionBasis, b.NutritionBasis))
|
||||
add("serving_size", strEq(a.ServingSize, b.ServingSize))
|
||||
add("nutri_score", strEq(a.NutriScore, b.NutriScore))
|
||||
aa, _ := json.Marshal(a.Attributes)
|
||||
ab, _ := json.Marshal(b.Attributes)
|
||||
add("attributes", string(aa) == string(ab))
|
||||
return changed
|
||||
}
|
||||
|
||||
@@ -330,15 +420,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 +442,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 +450,28 @@ 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"`
|
||||
ArchiveKind string `json:"archive_kind"`
|
||||
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, c.archive_kind,
|
||||
(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 +479,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.ArchiveKind, &c.ProductCount); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, c)
|
||||
@@ -393,6 +499,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)
|
||||
}
|
||||
}
|
||||
}
|
||||
Vendored
+126
@@ -0,0 +1,126 @@
|
||||
// Package cache is a Redis-backed, fail-open read cache for the public API.
|
||||
//
|
||||
// It caches hot product details and search results so repeated reads avoid
|
||||
// PostgreSQL. Like the ratelimit package, every operation fails open: if Redis
|
||||
// is unavailable or misconfigured the caller simply falls back to the database,
|
||||
// so the cache can never take the API down or serve stale data after Redis loss.
|
||||
//
|
||||
// Invalidation is global and O(1): keys are namespaced by an epoch counter
|
||||
// stored in Redis (og:cache:epoch). The Python ingestion bumps that counter
|
||||
// after a write run, which logically invalidates every cached entry at once
|
||||
// while old keys age out via their TTL. The epoch is read at most once per
|
||||
// refresh interval per process, so it adds no per-request round trip.
|
||||
package cache
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"log"
|
||||
"strconv"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/redis/go-redis/v9"
|
||||
)
|
||||
|
||||
// epochKey is the Redis key holding the global cache generation counter.
|
||||
const epochKey = "og:cache:epoch"
|
||||
|
||||
// epochRefresh bounds how often a process re-reads the epoch from Redis.
|
||||
const epochRefresh = 10 * time.Second
|
||||
|
||||
// opTimeout caps any single Redis operation so a slow backend never blocks a
|
||||
// request beyond this; on timeout the cache fails open.
|
||||
const opTimeout = 150 * time.Millisecond
|
||||
|
||||
// Cache wraps a Redis client. A nil-backed Cache (Redis unconfigured) disables
|
||||
// caching: every Get misses and every Set is a no-op.
|
||||
type Cache struct {
|
||||
rdb *redis.Client
|
||||
|
||||
mu sync.RWMutex
|
||||
epoch int64
|
||||
epochSetAt time.Time
|
||||
epochOK bool
|
||||
}
|
||||
|
||||
// New builds a Cache from a redis:// URL. On a parse error it logs and returns a
|
||||
// disabled (fail-open) cache so the server still boots.
|
||||
func New(redisURL string) *Cache {
|
||||
opt, err := redis.ParseURL(redisURL)
|
||||
if err != nil {
|
||||
log.Printf("cache: invalid redis url %q: %v (caching disabled)", redisURL, err)
|
||||
return &Cache{}
|
||||
}
|
||||
return &Cache{rdb: redis.NewClient(opt)}
|
||||
}
|
||||
|
||||
// Enabled reports whether a Redis backend is configured.
|
||||
func (c *Cache) Enabled() bool { return c != nil && c.rdb != nil }
|
||||
|
||||
// epochNow returns the current cache generation, reading it from Redis at most
|
||||
// once per epochRefresh. On any Redis error it keeps the last known value and
|
||||
// throttles re-reads so a down backend cannot slow the hot path.
|
||||
func (c *Cache) epochNow(ctx context.Context) int64 {
|
||||
c.mu.RLock()
|
||||
if c.epochOK && time.Since(c.epochSetAt) < epochRefresh {
|
||||
e := c.epoch
|
||||
c.mu.RUnlock()
|
||||
return e
|
||||
}
|
||||
c.mu.RUnlock()
|
||||
|
||||
cctx, cancel := context.WithTimeout(ctx, opTimeout)
|
||||
defer cancel()
|
||||
n, err := c.rdb.Get(cctx, epochKey).Int64()
|
||||
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
switch {
|
||||
case err == nil:
|
||||
c.epoch = n
|
||||
case errors.Is(err, redis.Nil):
|
||||
c.epoch = 0
|
||||
}
|
||||
c.epochSetAt = time.Now()
|
||||
c.epochOK = true
|
||||
return c.epoch
|
||||
}
|
||||
|
||||
// key namespaces a logical suffix under the current epoch.
|
||||
func (c *Cache) key(ctx context.Context, suffix string) string {
|
||||
return "og:v" + strconv.FormatInt(c.epochNow(ctx), 10) + ":" + suffix
|
||||
}
|
||||
|
||||
// GetJSON unmarshals the cached value for suffix into dest and reports a hit.
|
||||
// Any miss, decode error, or Redis error returns false (fail-open).
|
||||
func (c *Cache) GetJSON(ctx context.Context, suffix string, dest any) bool {
|
||||
if !c.Enabled() {
|
||||
return false
|
||||
}
|
||||
k := c.key(ctx, suffix)
|
||||
cctx, cancel := context.WithTimeout(ctx, opTimeout)
|
||||
defer cancel()
|
||||
b, err := c.rdb.Get(cctx, k).Bytes()
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
return json.Unmarshal(b, dest) == nil
|
||||
}
|
||||
|
||||
// SetJSON stores val (JSON-encoded) for suffix with the given TTL. Best effort:
|
||||
// marshal or Redis errors are ignored.
|
||||
func (c *Cache) SetJSON(ctx context.Context, suffix string, val any, ttl time.Duration) {
|
||||
if !c.Enabled() {
|
||||
return
|
||||
}
|
||||
b, err := json.Marshal(val)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
k := c.key(ctx, suffix)
|
||||
cctx, cancel := context.WithTimeout(ctx, opTimeout)
|
||||
defer cancel()
|
||||
_ = c.rdb.Set(cctx, k, b, ttl).Err()
|
||||
}
|
||||
Vendored
+84
@@ -0,0 +1,84 @@
|
||||
package cache
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// TestDisabledFailsOpen verifies a Cache without a Redis backend never panics,
|
||||
// always misses, and silently drops writes.
|
||||
func TestDisabledFailsOpen(t *testing.T) {
|
||||
c := New("not-a-valid-url") // parse error => disabled
|
||||
if c.Enabled() {
|
||||
t.Fatal("expected cache to be disabled for invalid url")
|
||||
}
|
||||
c.SetJSON(context.Background(), "k", map[string]int{"a": 1}, time.Minute)
|
||||
var dst map[string]int
|
||||
if c.GetJSON(context.Background(), "k", &dst) {
|
||||
t.Fatalf("disabled cache must always miss, got %+v", dst)
|
||||
}
|
||||
}
|
||||
|
||||
func testCache(t *testing.T) *Cache {
|
||||
t.Helper()
|
||||
url := os.Getenv("OPENGOODS_REDIS_URL")
|
||||
if url == "" {
|
||||
url = "redis://localhost:6379/0"
|
||||
}
|
||||
c := New(url)
|
||||
if !c.Enabled() {
|
||||
t.Skip("redis not configured")
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
|
||||
defer cancel()
|
||||
if err := c.rdb.Ping(ctx).Err(); err != nil {
|
||||
t.Skipf("redis not reachable: %v", err)
|
||||
}
|
||||
return c
|
||||
}
|
||||
|
||||
// TestRoundTrip stores then reads a value back.
|
||||
func TestRoundTrip(t *testing.T) {
|
||||
c := testCache(t)
|
||||
ctx := context.Background()
|
||||
suffix := fmt.Sprintf("test:rt:%d", time.Now().UnixNano())
|
||||
|
||||
c.SetJSON(ctx, suffix, map[string]any{"name": "foo", "n": float64(3)}, time.Minute)
|
||||
got := map[string]any{}
|
||||
if !c.GetJSON(ctx, suffix, &got) {
|
||||
t.Fatal("expected cache hit after set")
|
||||
}
|
||||
if got["name"] != "foo" || got["n"] != float64(3) {
|
||||
t.Fatalf("unexpected payload: %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestEpochInvalidation verifies that bumping the epoch counter logically drops
|
||||
// every previously cached entry.
|
||||
func TestEpochInvalidation(t *testing.T) {
|
||||
c := testCache(t)
|
||||
ctx := context.Background()
|
||||
suffix := fmt.Sprintf("test:epoch:%d", time.Now().UnixNano())
|
||||
|
||||
c.SetJSON(ctx, suffix, map[string]int{"v": 1}, time.Minute)
|
||||
var dst map[string]int
|
||||
if !c.GetJSON(ctx, suffix, &dst) {
|
||||
t.Fatal("expected hit before epoch bump")
|
||||
}
|
||||
|
||||
// Simulate an ingestion write bumping the global epoch.
|
||||
if err := c.rdb.Incr(ctx, epochKey).Err(); err != nil {
|
||||
t.Fatalf("incr epoch: %v", err)
|
||||
}
|
||||
// Force the process to re-read the epoch rather than use its cached value.
|
||||
c.mu.Lock()
|
||||
c.epochOK = false
|
||||
c.mu.Unlock()
|
||||
|
||||
if c.GetJSON(ctx, suffix, &dst) {
|
||||
t.Fatal("entry should be invisible after epoch bump")
|
||||
}
|
||||
}
|
||||
@@ -2,26 +2,44 @@ 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
|
||||
AnonTotalQuota int
|
||||
RegisteredRateLimitPerMin int
|
||||
RegisteredQuotaTotal 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),
|
||||
AnonTotalQuota: getenvInt("OPENGOODS_ANON_TOTAL_QUOTA", 1000),
|
||||
RegisteredRateLimitPerMin: getenvInt("OPENGOODS_REGISTERED_RATE_LIMIT_PER_MIN", 300),
|
||||
RegisteredQuotaTotal: getenvInt("OPENGOODS_REGISTERED_QUOTA_TOTAL", 100000),
|
||||
}
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
// Package gtin validates and normalizes GS1 trade item numbers (GTIN-8/12/13/14).
|
||||
// Only globally-unique GS1 codes are accepted: store-internal / variable-weight /
|
||||
// coupon codes (which are not globally unique) are rejected on purpose.
|
||||
package gtin
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Validation errors.
|
||||
var (
|
||||
ErrEmpty = errors.New("条码不能为空")
|
||||
ErrFormat = errors.New("条码必须为 8/12/13/14 位数字")
|
||||
ErrCheck = errors.New("条码校验位不正确")
|
||||
ErrRestricted = errors.New("店内码/变量重量码/优惠券码等非全球唯一码,不予收录")
|
||||
)
|
||||
|
||||
// Normalize trims and validates a GTIN, returning the cleaned digit string.
|
||||
// It enforces length, the GS1 mod-10 check digit, and rejects restricted
|
||||
// (non-globally-unique) number ranges.
|
||||
func Normalize(raw string) (string, error) {
|
||||
s := strings.TrimSpace(raw)
|
||||
if s == "" {
|
||||
return "", ErrEmpty
|
||||
}
|
||||
for _, c := range s {
|
||||
if c < '0' || c > '9' {
|
||||
return "", ErrFormat
|
||||
}
|
||||
}
|
||||
switch len(s) {
|
||||
case 8, 12, 13, 14:
|
||||
default:
|
||||
return "", ErrFormat
|
||||
}
|
||||
if !validCheckDigit(s) {
|
||||
return "", ErrCheck
|
||||
}
|
||||
if restricted(s) {
|
||||
return "", ErrRestricted
|
||||
}
|
||||
return s, nil
|
||||
}
|
||||
|
||||
// InferType returns the conventional GTIN type label for a normalized code.
|
||||
func InferType(s string) string {
|
||||
switch len(s) {
|
||||
case 8:
|
||||
return "EAN8"
|
||||
case 12:
|
||||
return "UPC"
|
||||
case 14:
|
||||
return "GTIN14"
|
||||
default:
|
||||
return "EAN13"
|
||||
}
|
||||
}
|
||||
|
||||
// validCheckDigit verifies the trailing GS1 mod-10 check digit. The digit
|
||||
// immediately left of the check digit carries weight 3, then weights alternate.
|
||||
func validCheckDigit(s string) bool {
|
||||
n := len(s)
|
||||
sum := 0
|
||||
for i := 0; i < n-1; i++ {
|
||||
d := int(s[i] - '0')
|
||||
if (n-1-i)%2 == 1 {
|
||||
sum += d * 3
|
||||
} else {
|
||||
sum += d
|
||||
}
|
||||
}
|
||||
check := (10 - (sum % 10)) % 10
|
||||
return check == int(s[n-1]-'0')
|
||||
}
|
||||
|
||||
// restricted reports whether a (length/check-digit valid) code falls in a
|
||||
// number range reserved for non-globally-unique use.
|
||||
func restricted(s string) bool {
|
||||
switch len(s) {
|
||||
case 13:
|
||||
p2 := s[:2]
|
||||
switch {
|
||||
case s[0] == '2': // 20-29 restricted distribution / in-store
|
||||
return true
|
||||
case p2 == "02": // 020-029 variable-measure within a store
|
||||
return true
|
||||
case p2 == "04": // 040-049 restricted circulation within a company
|
||||
return true
|
||||
case p2 == "05": // 050-059 coupons
|
||||
return true
|
||||
case p2 == "98" || p2 == "99": // 980-989/99 coupons & refund receipts
|
||||
return true
|
||||
}
|
||||
case 12: // UPC-A: leading number-system digit
|
||||
switch s[0] {
|
||||
case '2': // in-store / random weight
|
||||
return true
|
||||
case '4': // unrestricted in-store use
|
||||
return true
|
||||
case '5': // coupons
|
||||
return true
|
||||
}
|
||||
case 8: // EAN-8: 0/2 prefixes reserved for in-store use
|
||||
if s[0] == '0' || s[0] == '2' {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
package gtin
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestNormalizeValid(t *testing.T) {
|
||||
cases := []struct{ in, want, typ string }{
|
||||
{" 5449000000996 ", "5449000000996", "EAN13"}, // Coca-Cola EAN-13
|
||||
{"3017624010701", "3017624010701", "EAN13"}, // Nutella EAN-13
|
||||
{"036000291452", "036000291452", "UPC"}, // UPC-A
|
||||
{"96385074", "96385074", "EAN8"}, // EAN-8
|
||||
{"00012345600012", "00012345600012", "GTIN14"},
|
||||
{"6901234567892", "6901234567892", "EAN13"}, // China 690 prefix
|
||||
}
|
||||
for _, c := range cases {
|
||||
got, err := Normalize(c.in)
|
||||
if err != nil {
|
||||
t.Errorf("Normalize(%q) unexpected error: %v", c.in, err)
|
||||
continue
|
||||
}
|
||||
if got != c.want {
|
||||
t.Errorf("Normalize(%q) = %q, want %q", c.in, got, c.want)
|
||||
}
|
||||
if InferType(got) != c.typ {
|
||||
t.Errorf("InferType(%q) = %q, want %q", got, InferType(got), c.typ)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestNormalizeRejects(t *testing.T) {
|
||||
cases := []struct {
|
||||
in string
|
||||
want error
|
||||
}{
|
||||
{"", ErrEmpty},
|
||||
{"12ab5678", ErrFormat},
|
||||
{"12345", ErrFormat},
|
||||
{"5449000000997", ErrCheck}, // bad check digit
|
||||
{"2012345678903", ErrRestricted}, // 20-29 in-store EAN-13
|
||||
{"0212345678909", ErrRestricted}, // 02x variable measure
|
||||
{"212345678909", ErrRestricted}, // UPC number system 2
|
||||
{"02345673", ErrRestricted}, // EAN-8 in-store
|
||||
}
|
||||
for _, c := range cases {
|
||||
_, err := Normalize(c.in)
|
||||
if err != c.want {
|
||||
t.Errorf("Normalize(%q) error = %v, want %v", c.in, err, c.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
package handler
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"net/http"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/store"
|
||||
)
|
||||
|
||||
// emailRe is a deliberately permissive sanity check; real validation is the
|
||||
// unique constraint plus the user being able to receive their own key.
|
||||
var emailRe = regexp.MustCompile(`^[^@\s]+@[^@\s]+\.[^@\s]+$`)
|
||||
|
||||
const minPasswordLen = 8
|
||||
|
||||
type credentials struct {
|
||||
Email string `json:"email"`
|
||||
Password string `json:"password"`
|
||||
}
|
||||
|
||||
func decodeCredentials(w http.ResponseWriter, r *http.Request) (credentials, bool) {
|
||||
var c credentials
|
||||
if err := json.NewDecoder(http.MaxBytesReader(w, r.Body, 4096)).Decode(&c); err != nil {
|
||||
writeError(w, r, http.StatusBadRequest, "invalid_body", "请求格式无效")
|
||||
return credentials{}, false
|
||||
}
|
||||
c.Email = strings.TrimSpace(c.Email)
|
||||
if !emailRe.MatchString(c.Email) {
|
||||
writeError(w, r, http.StatusBadRequest, "invalid_email", "邮箱格式无效")
|
||||
return credentials{}, false
|
||||
}
|
||||
if len(c.Password) < minPasswordLen {
|
||||
writeError(w, r, http.StatusBadRequest, "weak_password", "密码至少需要 8 位")
|
||||
return credentials{}, false
|
||||
}
|
||||
return c, true
|
||||
}
|
||||
|
||||
// keyResponse is returned whenever a fresh plaintext key is issued; the key is
|
||||
// shown exactly once and cannot be recovered afterwards.
|
||||
type keyResponse struct {
|
||||
Email string `json:"email"`
|
||||
APIKey string `json:"api_key"`
|
||||
KeyPrefix string `json:"key_prefix"`
|
||||
RateLimitPerMin int `json:"rate_limit_per_min"`
|
||||
QuotaTotal int64 `json:"quota_total"`
|
||||
}
|
||||
|
||||
// Register creates an account and issues its first API key. POST {email, password}.
|
||||
func (h *Handler) Register(w http.ResponseWriter, r *http.Request) {
|
||||
c, ok := decodeCredentials(w, r)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
key, acct, err := h.store.RegisterUser(r.Context(), c.Email, c.Password, h.regRatePerMin, h.regQuotaTotal)
|
||||
if errors.Is(err, store.ErrEmailTaken) {
|
||||
writeError(w, r, http.StatusConflict, "email_taken", "该邮箱已注册,请直接登录查看或重置密钥")
|
||||
return
|
||||
}
|
||||
if h.handleErr(w, r, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusCreated, keyResponse{
|
||||
Email: acct.Email,
|
||||
APIKey: key,
|
||||
KeyPrefix: acct.KeyPrefix,
|
||||
RateLimitPerMin: acct.RateLimitPerMin,
|
||||
QuotaTotal: acct.QuotaTotal,
|
||||
})
|
||||
}
|
||||
|
||||
// AccountInfo verifies credentials and returns the account's key metadata plus
|
||||
// cumulative usage. POST {email, password}. The plaintext key is not returned.
|
||||
func (h *Handler) AccountInfo(w http.ResponseWriter, r *http.Request) {
|
||||
c, ok := decodeCredentials(w, r)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
acct, err := h.store.Authenticate(r.Context(), c.Email, c.Password)
|
||||
if errors.Is(err, store.ErrNotFound) {
|
||||
writeError(w, r, http.StatusUnauthorized, "invalid_credentials", "邮箱或密码错误")
|
||||
return
|
||||
}
|
||||
if h.handleErr(w, r, err) {
|
||||
return
|
||||
}
|
||||
used := h.limiter.TotalUsed(r.Context(), acct.KeyID)
|
||||
remaining := acct.QuotaTotal - used
|
||||
if remaining < 0 {
|
||||
remaining = 0
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]any{
|
||||
"email": acct.Email,
|
||||
"key_prefix": acct.KeyPrefix,
|
||||
"rate_limit_per_min": acct.RateLimitPerMin,
|
||||
"quota_total": acct.QuotaTotal,
|
||||
"quota_used": used,
|
||||
"quota_remaining": remaining,
|
||||
})
|
||||
}
|
||||
|
||||
// RegenerateKey revokes the account's current key and issues a new one, carrying
|
||||
// over cumulative usage so the quota cannot be reset. POST {email, password}.
|
||||
func (h *Handler) RegenerateKey(w http.ResponseWriter, r *http.Request) {
|
||||
c, ok := decodeCredentials(w, r)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
key, acct, oldKeyID, err := h.store.RegenerateKey(r.Context(), c.Email, c.Password, h.regRatePerMin, h.regQuotaTotal)
|
||||
if errors.Is(err, store.ErrNotFound) {
|
||||
writeError(w, r, http.StatusUnauthorized, "invalid_credentials", "邮箱或密码错误")
|
||||
return
|
||||
}
|
||||
if h.handleErr(w, r, err) {
|
||||
return
|
||||
}
|
||||
h.limiter.CopyTotal(r.Context(), oldKeyID, acct.KeyID)
|
||||
writeJSON(w, http.StatusOK, keyResponse{
|
||||
Email: acct.Email,
|
||||
APIKey: key,
|
||||
KeyPrefix: acct.KeyPrefix,
|
||||
RateLimitPerMin: acct.RateLimitPerMin,
|
||||
QuotaTotal: acct.QuotaTotal,
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,149 @@
|
||||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
"github.com/redis/go-redis/v9"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/ratelimit"
|
||||
"github.com/baicai2026-baicai/goods/api/internal/store"
|
||||
)
|
||||
|
||||
func cleanupCounter(t *testing.T, subject string) {
|
||||
t.Helper()
|
||||
redisURL := os.Getenv("OPENGOODS_REDIS_URL")
|
||||
if redisURL == "" {
|
||||
redisURL = "redis://localhost:6379/0"
|
||||
}
|
||||
opt, err := redis.ParseURL(redisURL)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
rdb := redis.NewClient(opt)
|
||||
defer rdb.Close()
|
||||
rdb.Del(context.Background(), "usage:total:"+subject)
|
||||
}
|
||||
|
||||
// newQuotaHandler builds a handler backed by the test DB and a live Redis
|
||||
// limiter, with a small anonymous quota so exhaustion is cheap to exercise.
|
||||
func newQuotaHandler(t *testing.T, anonQuota int) *Handler {
|
||||
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 hasUser bool
|
||||
if err := pool.QueryRow(ctx, "SELECT to_regclass('public.app_user') IS NOT NULL").Scan(&hasUser); err != nil || !hasUser {
|
||||
pool.Close()
|
||||
t.Skip("migrations not applied")
|
||||
}
|
||||
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)
|
||||
}
|
||||
t.Cleanup(pool.Close)
|
||||
return New(store.New(pool), nil).
|
||||
WithRateLimit(limiter, 1000).
|
||||
WithQuotas(anonQuota, 300, 100000)
|
||||
}
|
||||
|
||||
func cleanupAccount(t *testing.T, email string) {
|
||||
t.Helper()
|
||||
dsn := os.Getenv("OPENGOODS_DATABASE_URL")
|
||||
if dsn == "" {
|
||||
dsn = "postgres://opengoods:opengoods@localhost:5432/opengoods?sslmode=disable"
|
||||
}
|
||||
ctx := context.Background()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
defer pool.Close()
|
||||
_, _ = pool.Exec(ctx, "DELETE FROM app_user WHERE lower(email)=lower($1)", email)
|
||||
_, _ = pool.Exec(ctx, "DELETE FROM api_key WHERE owner_email=$1", email)
|
||||
}
|
||||
|
||||
func TestAnonTotalQuotaExhausts(t *testing.T) {
|
||||
h := newQuotaHandler(t, 3)
|
||||
// Unique client IP so the lifetime counter starts fresh for this test; the
|
||||
// counter never expires, so drop it afterwards to keep runs independent.
|
||||
n := time.Now().UnixNano()
|
||||
ip := fmt.Sprintf("203.%d.%d.%d", n/65536%256, n/256%256, n%256)
|
||||
t.Cleanup(func() { cleanupCounter(t, "ip:"+ip) })
|
||||
call := func() *httptest.ResponseRecorder {
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/"+APIVersion+"/stats", nil)
|
||||
req.RemoteAddr = ip + ":12345"
|
||||
rec := httptest.NewRecorder()
|
||||
h.Router().ServeHTTP(rec, req)
|
||||
return rec
|
||||
}
|
||||
for i := 1; i <= 3; i++ {
|
||||
if rec := call(); rec.Code != http.StatusOK {
|
||||
t.Fatalf("call %d should be allowed, got %d (%s)", i, rec.Code, rec.Body.String())
|
||||
}
|
||||
}
|
||||
rec := call()
|
||||
if rec.Code != http.StatusForbidden {
|
||||
t.Fatalf("4th call should be 403 quota_exhausted, got %d (%s)", rec.Code, rec.Body.String())
|
||||
}
|
||||
if !strings.Contains(rec.Body.String(), "quota_exhausted") {
|
||||
t.Fatalf("expected quota_exhausted error, got %s", rec.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegisterIssuesHigherQuotaKey(t *testing.T) {
|
||||
h := newQuotaHandler(t, 1000)
|
||||
email := fmt.Sprintf("h-user-%d@example.com", time.Now().UnixNano())
|
||||
t.Cleanup(func() { cleanupAccount(t, email) })
|
||||
|
||||
body := fmt.Sprintf(`{"email":%q,"password":"supersecret"}`, email)
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/"+APIVersion+"/register", strings.NewReader(body))
|
||||
req.RemoteAddr = "198.51.100.7:9999"
|
||||
rec := httptest.NewRecorder()
|
||||
h.Router().ServeHTTP(rec, req)
|
||||
if rec.Code != http.StatusCreated {
|
||||
t.Fatalf("register status = %d (%s)", rec.Code, rec.Body.String())
|
||||
}
|
||||
var resp keyResponse
|
||||
if err := json.NewDecoder(rec.Body).Decode(&resp); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if resp.APIKey == "" || resp.QuotaTotal != 100000 || resp.RateLimitPerMin != 300 {
|
||||
t.Fatalf("unexpected register response: %+v", resp)
|
||||
}
|
||||
|
||||
// A second registration with the same email conflicts.
|
||||
req2 := httptest.NewRequest(http.MethodPost, "/api/"+APIVersion+"/register", strings.NewReader(body))
|
||||
req2.RemoteAddr = "198.51.100.7:9999"
|
||||
rec2 := httptest.NewRecorder()
|
||||
h.Router().ServeHTTP(rec2, req2)
|
||||
if rec2.Code != http.StatusConflict {
|
||||
t.Fatalf("duplicate register status = %d (%s)", rec2.Code, rec2.Body.String())
|
||||
}
|
||||
}
|
||||
+136
-16
@@ -5,6 +5,7 @@
|
||||
package handler
|
||||
|
||||
import (
|
||||
_ "embed"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io/fs"
|
||||
@@ -15,26 +16,91 @@ 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
|
||||
|
||||
// defaultAnonTotalQuota is the lifetime number of calls an anonymous caller
|
||||
// (by IP) may make before being asked to register for a higher quota.
|
||||
defaultAnonTotalQuota = 1000
|
||||
|
||||
// defaultRegRatePerMin / defaultRegQuotaTotal are the per-minute budget and
|
||||
// cumulative quota granted to a self-registered API key.
|
||||
defaultRegRatePerMin = 300
|
||||
defaultRegQuotaTotal = 100000
|
||||
|
||||
// registerRatePerMin caps account registration/login attempts per IP to
|
||||
// curb abuse; these endpoints sit outside the metered quota group.
|
||||
registerRatePerMin = 10
|
||||
)
|
||||
|
||||
// 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
|
||||
anonTotalQuota int64
|
||||
regRatePerMin int
|
||||
regQuotaTotal int64
|
||||
}
|
||||
|
||||
// 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,
|
||||
anonTotalQuota: defaultAnonTotalQuota,
|
||||
regRatePerMin: defaultRegRatePerMin,
|
||||
regQuotaTotal: defaultRegQuotaTotal,
|
||||
}
|
||||
}
|
||||
|
||||
// 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
|
||||
}
|
||||
|
||||
// WithQuotas configures the cumulative free quota for anonymous callers and the
|
||||
// per-minute rate + cumulative quota self-registered keys receive. Non-positive
|
||||
// values keep the defaults.
|
||||
func (h *Handler) WithQuotas(anonTotal, regPerMin, regTotal int) *Handler {
|
||||
if anonTotal > 0 {
|
||||
h.anonTotalQuota = int64(anonTotal)
|
||||
}
|
||||
if regPerMin > 0 {
|
||||
h.regRatePerMin = regPerMin
|
||||
}
|
||||
if regTotal > 0 {
|
||||
h.regQuotaTotal = int64(regTotal)
|
||||
}
|
||||
return h
|
||||
}
|
||||
|
||||
// Router builds the top-level HTTP handler with middleware and routes mounted.
|
||||
@@ -47,16 +113,34 @@ 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("/kind-fields", h.ListKindFields)
|
||||
r.Get("/sources/{id}", h.SourceByID)
|
||||
r.Get("/stats", h.Stats)
|
||||
})
|
||||
|
||||
// Self-service account routes. Lightly IP-throttled to curb abuse but
|
||||
// outside the metered quota group so a user can always register or
|
||||
// check their key even after exhausting the free anonymous quota.
|
||||
r.Group(func(r chi.Router) {
|
||||
r.Use(h.registerLimit)
|
||||
r.Post("/register", h.Register)
|
||||
r.Post("/account", h.AccountInfo)
|
||||
r.Post("/account/regenerate", h.RegenerateKey)
|
||||
})
|
||||
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 +177,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 +210,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
|
||||
}
|
||||
@@ -171,6 +276,21 @@ func (h *Handler) ListCategories(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusOK, map[string]any{"items": items})
|
||||
}
|
||||
|
||||
// ListKindFields returns the read-only spec field template for an archive kind,
|
||||
// used by the contribution form to render kind-specific inputs.
|
||||
func (h *Handler) ListKindFields(w http.ResponseWriter, r *http.Request) {
|
||||
kind := strings.TrimSpace(r.URL.Query().Get("kind"))
|
||||
if kind == "" {
|
||||
writeError(w, r, http.StatusBadRequest, "bad_request", "missing kind")
|
||||
return
|
||||
}
|
||||
items, err := h.store.ListKindFields(r.Context(), kind)
|
||||
if h.handleErr(w, r, err) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]any{"items": items, "kind": kind})
|
||||
}
|
||||
|
||||
// SourceByID returns a single data source.
|
||||
func (h *Handler) SourceByID(w http.ResponseWriter, r *http.Request) {
|
||||
src, err := h.store.SourceByID(r.Context(), chi.URLParam(r, "id"))
|
||||
|
||||
@@ -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,142 @@
|
||||
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) {
|
||||
ip := clientIP(r)
|
||||
id := "ip:" + ip
|
||||
subject := "ip:" + ip // cumulative-quota counter subject
|
||||
limit := h.anonLimit
|
||||
quota := h.anonTotalQuota
|
||||
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
|
||||
subject = k.ID
|
||||
quota = k.QuotaTotal
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
// Attribute one call to the caller's lifetime counter, then enforce the
|
||||
// cumulative quota (quota <= 0 means unlimited). Keys also get daily and
|
||||
// last-used stats recorded for the admin console.
|
||||
var used int64
|
||||
if keyID != "" {
|
||||
h.limiter.RecordUsage(r.Context(), keyID)
|
||||
used = h.limiter.TotalUsed(r.Context(), keyID)
|
||||
} else {
|
||||
used = h.limiter.IncrTotal(r.Context(), subject)
|
||||
}
|
||||
if quota > 0 {
|
||||
remaining := quota - used
|
||||
if remaining < 0 {
|
||||
remaining = 0
|
||||
}
|
||||
w.Header().Set("X-Quota-Limit", strconv.FormatInt(quota, 10))
|
||||
w.Header().Set("X-Quota-Used", strconv.FormatInt(used, 10))
|
||||
w.Header().Set("X-Quota-Remaining", strconv.FormatInt(remaining, 10))
|
||||
if used > quota {
|
||||
if keyID == "" {
|
||||
writeError(w, r, http.StatusForbidden, "quota_exhausted",
|
||||
"免费额度(共 "+strconv.FormatInt(quota, 10)+" 次)已用尽,请注册账号获取更高配额的 API 密钥")
|
||||
} else {
|
||||
writeError(w, r, http.StatusForbidden, "quota_exhausted", "API 密钥配额已用尽")
|
||||
}
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if keyID != "" {
|
||||
next.ServeHTTP(w, r.WithContext(context.WithValue(r.Context(), apiKeyIDKey, keyID)))
|
||||
return
|
||||
}
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
// registerLimit throttles self-service account endpoints per client IP without
|
||||
// consuming the metered free quota, so a caller can still register or recover
|
||||
// their key after exhausting the anonymous quota.
|
||||
func (h *Handler) registerLimit(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
res := h.limiter.Allow(r.Context(), "register:"+clientIP(r), h.regRatePerMin, time.Minute)
|
||||
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
|
||||
}
|
||||
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,216 @@
|
||||
{
|
||||
"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" },
|
||||
{ "name": "account" }
|
||||
],
|
||||
"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" } }
|
||||
}
|
||||
},
|
||||
"/register": {
|
||||
"post": {
|
||||
"tags": ["account"],
|
||||
"summary": "Register an account and issue an API key",
|
||||
"description": "Self-service registration; returns the plaintext API key exactly once.",
|
||||
"security": [],
|
||||
"requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["email", "password"], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 } } } } } },
|
||||
"responses": { "201": { "description": "Account created; plaintext key returned once" }, "400": { "description": "Invalid email or weak password" }, "409": { "description": "Email already registered" } }
|
||||
}
|
||||
},
|
||||
"/account": {
|
||||
"post": {
|
||||
"tags": ["account"],
|
||||
"summary": "View account key metadata and cumulative quota usage",
|
||||
"security": [],
|
||||
"requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["email", "password"], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" } } } } } },
|
||||
"responses": { "200": { "description": "Account info with quota usage" }, "401": { "description": "Invalid credentials" } }
|
||||
}
|
||||
},
|
||||
"/account/regenerate": {
|
||||
"post": {
|
||||
"tags": ["account"],
|
||||
"summary": "Revoke the current key and issue a new one",
|
||||
"description": "Cumulative usage carries over; returns the plaintext key exactly once.",
|
||||
"security": [],
|
||||
"requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["email", "password"], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" } } } } } },
|
||||
"responses": { "200": { "description": "New plaintext key returned once" }, "401": { "description": "Invalid credentials" } }
|
||||
}
|
||||
}
|
||||
},
|
||||
"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,171 @@
|
||||
// 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)
|
||||
}
|
||||
|
||||
// IncrTotal increments the lifetime call counter for subject and returns the
|
||||
// new total. The counter never expires; it is the cumulative number of calls
|
||||
// attributed to a caller (an API key id, or "ip:<addr>" for anonymous callers).
|
||||
// Fails open returning 0 on any error so quota enforcement never takes the API
|
||||
// down.
|
||||
func (l *Limiter) IncrTotal(ctx context.Context, subject string) int64 {
|
||||
if !l.Enabled() || subject == "" {
|
||||
return 0
|
||||
}
|
||||
n, err := l.rdb.Incr(ctx, "usage:total:"+subject).Result()
|
||||
if err != nil {
|
||||
return 0
|
||||
}
|
||||
return n
|
||||
}
|
||||
|
||||
// CopyTotal carries a lifetime counter from one subject to another, used when a
|
||||
// key is regenerated so a caller cannot reset their cumulative quota. Best
|
||||
// effort: a missing or zero source counter is a no-op.
|
||||
func (l *Limiter) CopyTotal(ctx context.Context, from, to string) {
|
||||
if !l.Enabled() || from == "" || to == "" {
|
||||
return
|
||||
}
|
||||
n, err := l.rdb.Get(ctx, "usage:total:"+from).Int64()
|
||||
if err != nil || n == 0 {
|
||||
return
|
||||
}
|
||||
l.rdb.Set(ctx, "usage:total:"+to, n, 0)
|
||||
}
|
||||
|
||||
// TotalUsed reads the lifetime call counter for subject without incrementing.
|
||||
func (l *Limiter) TotalUsed(ctx context.Context, subject string) int64 {
|
||||
if !l.Enabled() || subject == "" {
|
||||
return 0
|
||||
}
|
||||
n, _ := l.rdb.Get(ctx, "usage:total:"+subject).Int64()
|
||||
return n
|
||||
}
|
||||
|
||||
// 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")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,169 @@
|
||||
package store
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"strings"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
"github.com/jackc/pgx/v5/pgconn"
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/apikey"
|
||||
)
|
||||
|
||||
// ErrEmailTaken is returned when registering an email that already exists.
|
||||
var ErrEmailTaken = errors.New("email already registered")
|
||||
|
||||
// Account is a self-registered public-API user and its current key metadata.
|
||||
type Account struct {
|
||||
ID string `json:"id"`
|
||||
Email string `json:"email"`
|
||||
KeyID string `json:"-"`
|
||||
KeyPrefix string `json:"key_prefix"`
|
||||
RateLimitPerMin int `json:"rate_limit_per_min"`
|
||||
QuotaTotal int64 `json:"quota_total"`
|
||||
}
|
||||
|
||||
// bcryptDummyHash is compared against on unknown-email logins to keep timing
|
||||
// roughly constant and avoid leaking which emails are registered.
|
||||
const bcryptDummyHash = "$2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy"
|
||||
|
||||
func isUniqueViolation(err error) bool {
|
||||
var pgErr *pgconn.PgError
|
||||
return errors.As(err, &pgErr) && pgErr.Code == "23505"
|
||||
}
|
||||
|
||||
// RegisterUser creates an account plus a self-issued API key with the given
|
||||
// per-minute rate and cumulative quota, returning the plaintext key (shown
|
||||
// once). Email uniqueness is case-insensitive; ErrEmailTaken signals a dupe.
|
||||
func (s *Store) RegisterUser(ctx context.Context, email, password string, ratePerMin int, quotaTotal int64) (plaintext string, acct Account, err error) {
|
||||
email = strings.TrimSpace(email)
|
||||
pwHash, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
|
||||
if err != nil {
|
||||
return "", Account{}, err
|
||||
}
|
||||
key, keyHash, prefix, err := apikey.Generate()
|
||||
if err != nil {
|
||||
return "", Account{}, err
|
||||
}
|
||||
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return "", Account{}, err
|
||||
}
|
||||
defer func() { _ = tx.Rollback(ctx) }()
|
||||
|
||||
var keyID string
|
||||
if err = tx.QueryRow(ctx,
|
||||
`INSERT INTO api_key (name, key_prefix, key_hash, owner_email, tier, rate_limit_per_min, quota_total, created_by)
|
||||
VALUES ($1,$2,$3,$4,'registered',$5,$6,'self-register') RETURNING id`,
|
||||
"user:"+strings.ToLower(email), prefix, keyHash, email, ratePerMin, quotaTotal,
|
||||
).Scan(&keyID); err != nil {
|
||||
return "", Account{}, err
|
||||
}
|
||||
|
||||
var userID string
|
||||
if err = tx.QueryRow(ctx,
|
||||
`INSERT INTO app_user (email, password_hash, api_key_id) VALUES ($1,$2,$3) RETURNING id`,
|
||||
email, string(pwHash), keyID,
|
||||
).Scan(&userID); err != nil {
|
||||
if isUniqueViolation(err) {
|
||||
return "", Account{}, ErrEmailTaken
|
||||
}
|
||||
return "", Account{}, err
|
||||
}
|
||||
|
||||
if err = tx.Commit(ctx); err != nil {
|
||||
return "", Account{}, err
|
||||
}
|
||||
return key, Account{
|
||||
ID: userID, Email: email, KeyID: keyID, KeyPrefix: prefix,
|
||||
RateLimitPerMin: ratePerMin, QuotaTotal: quotaTotal,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// Authenticate verifies an email/password pair and returns the account with its
|
||||
// current (non-revoked) key metadata. Returns ErrNotFound on unknown email or
|
||||
// wrong password.
|
||||
func (s *Store) Authenticate(ctx context.Context, email, password string) (Account, error) {
|
||||
email = strings.TrimSpace(email)
|
||||
var (
|
||||
userID, pwHash string
|
||||
keyID *string
|
||||
)
|
||||
err := s.pool.QueryRow(ctx,
|
||||
`SELECT id, password_hash, api_key_id FROM app_user WHERE lower(email) = lower($1)`, email,
|
||||
).Scan(&userID, &pwHash, &keyID)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
_ = bcrypt.CompareHashAndPassword([]byte(bcryptDummyHash), []byte(password))
|
||||
return Account{}, ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return Account{}, err
|
||||
}
|
||||
if err := bcrypt.CompareHashAndPassword([]byte(pwHash), []byte(password)); err != nil {
|
||||
return Account{}, ErrNotFound
|
||||
}
|
||||
|
||||
acct := Account{ID: userID, Email: email}
|
||||
if keyID != nil {
|
||||
acct.KeyID = *keyID
|
||||
_ = s.pool.QueryRow(ctx,
|
||||
`SELECT key_prefix, rate_limit_per_min, quota_total
|
||||
FROM api_key WHERE id = $1 AND revoked_at IS NULL`, *keyID,
|
||||
).Scan(&acct.KeyPrefix, &acct.RateLimitPerMin, &acct.QuotaTotal)
|
||||
}
|
||||
return acct, nil
|
||||
}
|
||||
|
||||
// RegenerateKey verifies credentials, revokes the account's current key, and
|
||||
// issues a fresh one with the same rate/quota, returning the plaintext key and
|
||||
// the previous key id (so cumulative usage can be carried over). Returns
|
||||
// ErrNotFound on bad credentials.
|
||||
func (s *Store) RegenerateKey(ctx context.Context, email, password string, ratePerMin int, quotaTotal int64) (plaintext string, acct Account, oldKeyID string, err error) {
|
||||
cur, err := s.Authenticate(ctx, email, password)
|
||||
if err != nil {
|
||||
return "", Account{}, "", err
|
||||
}
|
||||
key, keyHash, prefix, err := apikey.Generate()
|
||||
if err != nil {
|
||||
return "", Account{}, "", err
|
||||
}
|
||||
|
||||
oldKeyID = cur.KeyID
|
||||
|
||||
tx, err := s.pool.Begin(ctx)
|
||||
if err != nil {
|
||||
return "", Account{}, "", err
|
||||
}
|
||||
defer func() { _ = tx.Rollback(ctx) }()
|
||||
|
||||
if oldKeyID != "" {
|
||||
if _, err = tx.Exec(ctx,
|
||||
`UPDATE api_key SET revoked_at = now() WHERE id = $1`, oldKeyID); err != nil {
|
||||
return "", Account{}, "", err
|
||||
}
|
||||
}
|
||||
var newKeyID string
|
||||
if err = tx.QueryRow(ctx,
|
||||
`INSERT INTO api_key (name, key_prefix, key_hash, owner_email, tier, rate_limit_per_min, quota_total, created_by)
|
||||
VALUES ($1,$2,$3,$4,'registered',$5,$6,'self-register') RETURNING id`,
|
||||
"user:"+strings.ToLower(cur.Email), prefix, keyHash, cur.Email, ratePerMin, quotaTotal,
|
||||
).Scan(&newKeyID); err != nil {
|
||||
return "", Account{}, "", err
|
||||
}
|
||||
if _, err = tx.Exec(ctx,
|
||||
`UPDATE app_user SET api_key_id = $1 WHERE id = $2`, newKeyID, cur.ID); err != nil {
|
||||
return "", Account{}, "", err
|
||||
}
|
||||
if err = tx.Commit(ctx); err != nil {
|
||||
return "", Account{}, "", err
|
||||
}
|
||||
|
||||
cur.KeyID = newKeyID
|
||||
cur.KeyPrefix = prefix
|
||||
cur.RateLimitPerMin = ratePerMin
|
||||
cur.QuotaTotal = quotaTotal
|
||||
return key, cur, oldKeyID, nil
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
package store
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/apikey"
|
||||
)
|
||||
|
||||
func testStore(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 hasUser bool
|
||||
if err := pool.QueryRow(ctx, "SELECT to_regclass('public.app_user') IS NOT NULL").Scan(&hasUser); err != nil || !hasUser {
|
||||
pool.Close()
|
||||
t.Skip("migrations not applied")
|
||||
}
|
||||
t.Cleanup(pool.Close)
|
||||
return New(pool)
|
||||
}
|
||||
|
||||
func TestRegisterAuthenticateRegenerate(t *testing.T) {
|
||||
s := testStore(t)
|
||||
ctx := context.Background()
|
||||
email := fmt.Sprintf("user-%d@example.com", time.Now().UnixNano())
|
||||
|
||||
t.Cleanup(func() {
|
||||
_, _ = s.pool.Exec(ctx, "DELETE FROM app_user WHERE lower(email)=lower($1)", email)
|
||||
_, _ = s.pool.Exec(ctx, "DELETE FROM api_key WHERE owner_email=$1", email)
|
||||
})
|
||||
|
||||
key, acct, err := s.RegisterUser(ctx, email, "supersecret", 300, 100000)
|
||||
if err != nil {
|
||||
t.Fatalf("register: %v", err)
|
||||
}
|
||||
if key == "" || acct.KeyPrefix == "" || acct.QuotaTotal != 100000 || acct.RateLimitPerMin != 300 {
|
||||
t.Fatalf("unexpected account: %+v key=%q", acct, key)
|
||||
}
|
||||
|
||||
// The issued key resolves via the public auth path with its quota attached.
|
||||
k, err := s.APIKeyByHash(ctx, apikey.Hash(key))
|
||||
if err != nil {
|
||||
t.Fatalf("APIKeyByHash: %v", err)
|
||||
}
|
||||
if k.QuotaTotal != 100000 || k.RateLimitPerMin != 300 {
|
||||
t.Fatalf("key metadata mismatch: %+v", k)
|
||||
}
|
||||
|
||||
// Duplicate email is rejected.
|
||||
if _, _, err := s.RegisterUser(ctx, email, "anotherpass", 300, 100000); !errors.Is(err, ErrEmailTaken) {
|
||||
t.Fatalf("expected ErrEmailTaken, got %v", err)
|
||||
}
|
||||
|
||||
// Wrong password fails; correct password authenticates.
|
||||
if _, err := s.Authenticate(ctx, email, "wrong"); !errors.Is(err, ErrNotFound) {
|
||||
t.Fatalf("expected ErrNotFound for bad password, got %v", err)
|
||||
}
|
||||
got, err := s.Authenticate(ctx, email, "supersecret")
|
||||
if err != nil {
|
||||
t.Fatalf("authenticate: %v", err)
|
||||
}
|
||||
if got.KeyPrefix != acct.KeyPrefix {
|
||||
t.Fatalf("authenticate key prefix = %q want %q", got.KeyPrefix, acct.KeyPrefix)
|
||||
}
|
||||
|
||||
// Regeneration revokes the old key and issues a new one.
|
||||
newKey, regen, oldKeyID, err := s.RegenerateKey(ctx, email, "supersecret", 300, 100000)
|
||||
if err != nil {
|
||||
t.Fatalf("regenerate: %v", err)
|
||||
}
|
||||
if newKey == key || oldKeyID != acct.KeyID || regen.KeyID == oldKeyID {
|
||||
t.Fatalf("regenerate did not rotate key: old=%s new=%+v", oldKeyID, regen)
|
||||
}
|
||||
if _, err := s.APIKeyByHash(ctx, apikey.Hash(key)); !errors.Is(err, ErrNotFound) {
|
||||
t.Fatalf("old key should be revoked, got %v", err)
|
||||
}
|
||||
if _, err := s.APIKeyByHash(ctx, apikey.Hash(newKey)); err != nil {
|
||||
t.Fatalf("new key should be active: %v", err)
|
||||
}
|
||||
}
|
||||
+371
-37
@@ -4,19 +4,35 @@ package store
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/sha1"
|
||||
"encoding/hex"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/jackc/pgx/v5"
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"github.com/baicai2026-baicai/goods/api/internal/cache"
|
||||
)
|
||||
|
||||
// Cache TTLs for the public read cache. Product details are far less volatile
|
||||
// than search result sets, so they live longer; both are also invalidated
|
||||
// wholesale whenever ingestion bumps the cache epoch.
|
||||
const (
|
||||
productCacheTTL = 24 * time.Hour
|
||||
searchCacheTTL = time.Hour
|
||||
)
|
||||
|
||||
// ErrNotFound is returned when a requested row does not exist.
|
||||
var ErrNotFound = errors.New("not found")
|
||||
|
||||
// Store wraps a PostgreSQL connection pool.
|
||||
// Store wraps a PostgreSQL connection pool and an optional read cache.
|
||||
type Store struct {
|
||||
pool *pgxpool.Pool
|
||||
pool *pgxpool.Pool
|
||||
cache *cache.Cache
|
||||
}
|
||||
|
||||
// New constructs a Store from an existing pgx pool.
|
||||
@@ -24,11 +40,71 @@ func New(pool *pgxpool.Pool) *Store {
|
||||
return &Store{pool: pool}
|
||||
}
|
||||
|
||||
// WithCache attaches a Redis-backed read cache. A nil or disabled cache leaves
|
||||
// the Store reading straight from PostgreSQL.
|
||||
func (s *Store) WithCache(c *cache.Cache) *Store {
|
||||
s.cache = c
|
||||
return s
|
||||
}
|
||||
|
||||
// cacheGet reads a cached JSON value into dest, reporting a hit. It is a no-op
|
||||
// miss when no cache is attached.
|
||||
func (s *Store) cacheGet(ctx context.Context, suffix string, dest any) bool {
|
||||
if s.cache == nil {
|
||||
return false
|
||||
}
|
||||
return s.cache.GetJSON(ctx, suffix, dest)
|
||||
}
|
||||
|
||||
// cacheSet stores a JSON value when a cache is attached.
|
||||
func (s *Store) cacheSet(ctx context.Context, suffix string, val any, ttl time.Duration) {
|
||||
if s.cache == nil {
|
||||
return
|
||||
}
|
||||
s.cache.SetJSON(ctx, suffix, val, ttl)
|
||||
}
|
||||
|
||||
// Ping verifies database connectivity.
|
||||
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"`
|
||||
GTINType string `json:"gtin_type"`
|
||||
PackLevel string `json:"pack_level"`
|
||||
Region *string `json:"region"`
|
||||
IsPrimary bool `json:"is_primary"`
|
||||
}
|
||||
|
||||
// ProductSpec is one labeled spec line for a non-food product, rendered from
|
||||
// the product's attributes JSONB against its archive kind's field template.
|
||||
type ProductSpec struct {
|
||||
Key string `json:"key"`
|
||||
Label string `json:"label"`
|
||||
Value string `json:"value"`
|
||||
Unit string `json:"unit,omitempty"`
|
||||
}
|
||||
|
||||
// Product is the full public view of a product.
|
||||
type Product struct {
|
||||
ID string `json:"id"`
|
||||
@@ -37,10 +113,13 @@ type Product struct {
|
||||
Brand *string `json:"brand"`
|
||||
CategoryPath *string `json:"category_path"`
|
||||
GPCBrickCode *string `json:"gpc_brick_code"`
|
||||
ArchiveKind string `json:"archive_kind"`
|
||||
NetContentValue *float64 `json:"net_content_value"`
|
||||
NetContentUnit *string `json:"net_content_unit"`
|
||||
CountryOfOrigin *string `json:"country_of_origin"`
|
||||
QualityScore float64 `json:"quality_score"`
|
||||
Barcodes []Barcode `json:"barcodes"`
|
||||
Specs []ProductSpec `json:"specs,omitempty"`
|
||||
Nutriments map[string]any `json:"nutriments,omitempty"`
|
||||
NutritionBasis *string `json:"nutrition_basis,omitempty"`
|
||||
NutriScore *string `json:"nutri_score,omitempty"`
|
||||
@@ -49,17 +128,50 @@ type Product struct {
|
||||
Additives []string `json:"additives,omitempty"`
|
||||
}
|
||||
|
||||
// ProductBarcodes returns every barcode attached to a product, primary first.
|
||||
func (s *Store) ProductBarcodes(ctx context.Context, productID string) ([]Barcode, error) {
|
||||
rows, err := s.pool.Query(ctx,
|
||||
`SELECT gtin, gtin_type, pack_level, region, is_primary
|
||||
FROM product_barcode WHERE product_id = $1
|
||||
ORDER BY is_primary DESC, gtin`, productID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
out := []Barcode{}
|
||||
for rows.Next() {
|
||||
var b Barcode
|
||||
if err := rows.Scan(&b.GTIN, &b.GTINType, &b.PackLevel, &b.Region, &b.IsPrimary); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, b)
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// 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 = `
|
||||
SELECT p.id, p.gtin, p.name, b.name, c.path::text, p.gpc_brick_code,
|
||||
COALESCE(c.archive_kind, 'generic'), p.attributes,
|
||||
p.net_content_value, p.net_content_unit, p.country_of_origin, p.quality_score,
|
||||
f.nutriments, f.nutrition_basis, f.nutri_score, f.ingredients_text,
|
||||
f.allergens, f.additives
|
||||
@@ -69,61 +181,196 @@ LEFT JOIN category c ON c.id = p.category_id
|
||||
LEFT JOIN food_detail f ON f.product_id = p.id
|
||||
`
|
||||
|
||||
func scanProduct(row pgx.Row) (*Product, error) {
|
||||
func scanProduct(row pgx.Row) (*Product, []byte, error) {
|
||||
var p Product
|
||||
var attributes []byte
|
||||
err := row.Scan(
|
||||
&p.ID, &p.GTIN, &p.Name, &p.Brand, &p.CategoryPath, &p.GPCBrickCode,
|
||||
&p.ArchiveKind, &attributes,
|
||||
&p.NetContentValue, &p.NetContentUnit, &p.CountryOfOrigin, &p.QualityScore,
|
||||
&p.Nutriments, &p.NutritionBasis, &p.NutriScore, &p.Ingredients,
|
||||
&p.Allergens, &p.Additives,
|
||||
)
|
||||
if errors.Is(err, pgx.ErrNoRows) {
|
||||
return nil, ErrNotFound
|
||||
return nil, nil, ErrNotFound
|
||||
}
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
return &p, attributes, nil
|
||||
}
|
||||
|
||||
// buildSpecs renders the labeled, ordered spec list for a non-food product from
|
||||
// its attributes JSONB against its archive kind's field template.
|
||||
func (s *Store) buildSpecs(ctx context.Context, kind string, attributes []byte) ([]ProductSpec, error) {
|
||||
if kind == "" || kind == "food" || len(attributes) == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
attrs := map[string]any{}
|
||||
if err := json.Unmarshal(attributes, &attrs); err != nil || len(attrs) == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
rows, err := s.pool.Query(ctx,
|
||||
"SELECT field_key, label_zh, COALESCE(unit, '') FROM kind_field WHERE kind = $1 ORDER BY sort_order, field_key", kind)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &p, nil
|
||||
defer rows.Close()
|
||||
specs := []ProductSpec{}
|
||||
for rows.Next() {
|
||||
var key, label, unit string
|
||||
if err := rows.Scan(&key, &label, &unit); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
v, ok := attrs[key]
|
||||
if !ok || v == nil {
|
||||
continue
|
||||
}
|
||||
val := stringifyAttr(v)
|
||||
if val == "" {
|
||||
continue
|
||||
}
|
||||
specs = append(specs, ProductSpec{Key: key, Label: label, Value: val, Unit: unit})
|
||||
}
|
||||
return specs, rows.Err()
|
||||
}
|
||||
|
||||
// ProductByGTIN looks up an active product by its barcode.
|
||||
// stringifyAttr renders a JSON attribute value as display text.
|
||||
func stringifyAttr(v any) string {
|
||||
switch t := v.(type) {
|
||||
case string:
|
||||
return t
|
||||
case float64:
|
||||
return strconv.FormatFloat(t, 'f', -1, 64)
|
||||
case bool:
|
||||
if t {
|
||||
return "是"
|
||||
}
|
||||
return "否"
|
||||
case []any:
|
||||
parts := make([]string, 0, len(t))
|
||||
for _, e := range t {
|
||||
parts = append(parts, stringifyAttr(e))
|
||||
}
|
||||
return strings.Join(parts, "、")
|
||||
default:
|
||||
return ""
|
||||
}
|
||||
}
|
||||
|
||||
// ProductByGTIN looks up an active product by any of its barcodes.
|
||||
func (s *Store) ProductByGTIN(ctx context.Context, gtin string) (*Product, error) {
|
||||
row := s.pool.QueryRow(ctx, productSelect+" WHERE p.gtin = $1 AND p.status = 'active'", gtin)
|
||||
return scanProduct(row)
|
||||
const suffix = "prod:gtin:"
|
||||
if cached := new(Product); s.cacheGet(ctx, suffix+gtin, cached) {
|
||||
return cached, nil
|
||||
}
|
||||
row := s.pool.QueryRow(ctx, productSelect+`
|
||||
WHERE p.status = 'active'
|
||||
AND (p.gtin = $1 OR EXISTS (
|
||||
SELECT 1 FROM product_barcode pb
|
||||
WHERE pb.product_id = p.id AND pb.gtin = $1))
|
||||
LIMIT 1`, gtin)
|
||||
p, attrs, err := scanProduct(row)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if p.Barcodes, err = s.ProductBarcodes(ctx, p.ID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if p.Specs, err = s.buildSpecs(ctx, p.ArchiveKind, attrs); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
s.cacheSet(ctx, suffix+gtin, p, productCacheTTL)
|
||||
return p, nil
|
||||
}
|
||||
|
||||
// ProductByID looks up a product by its UUID.
|
||||
func (s *Store) ProductByID(ctx context.Context, id string) (*Product, error) {
|
||||
const suffix = "prod:id:"
|
||||
if cached := new(Product); s.cacheGet(ctx, suffix+id, cached) {
|
||||
return cached, nil
|
||||
}
|
||||
row := s.pool.QueryRow(ctx, productSelect+" WHERE p.id = $1", id)
|
||||
return scanProduct(row)
|
||||
p, attrs, err := scanProduct(row)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if p.Barcodes, err = s.ProductBarcodes(ctx, p.ID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if p.Specs, err = s.buildSpecs(ctx, p.ArchiveKind, attrs); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
s.cacheSet(ctx, suffix+id, p, productCacheTTL)
|
||||
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) {
|
||||
args := []any{}
|
||||
where := "WHERE p.status = 'active'"
|
||||
if q != "" {
|
||||
args = append(args, q)
|
||||
where += " AND p.name ILIKE '%' || $1 || '%'"
|
||||
}
|
||||
if category != "" {
|
||||
args = append(args, category)
|
||||
where += " AND c.path <@ $" + strconv.Itoa(len(args)) + "::ltree"
|
||||
// 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) {
|
||||
suffix := searchCacheSuffix(f, limit, offset)
|
||||
if entry := new(searchCacheEntry); s.cacheGet(ctx, suffix, entry) {
|
||||
return entry.Items, entry.Total, nil
|
||||
}
|
||||
|
||||
countSQL := "SELECT count(*) FROM product p LEFT JOIN category c ON c.id = p.category_id " + where
|
||||
args := []any{}
|
||||
where := "WHERE p.status = 'active'"
|
||||
|
||||
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 '%' || ` + q + ` || '%'))`
|
||||
}
|
||||
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 `
|
||||
|
||||
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 {
|
||||
@@ -134,12 +381,34 @@ 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)
|
||||
}
|
||||
return out, total, rows.Err()
|
||||
if err := rows.Err(); err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
s.cacheSet(ctx, suffix, searchCacheEntry{Items: out, Total: total}, searchCacheTTL)
|
||||
return out, total, nil
|
||||
}
|
||||
|
||||
// searchCacheEntry is the cached payload for a SearchProducts call.
|
||||
type searchCacheEntry struct {
|
||||
Items []ProductSummary `json:"items"`
|
||||
Total int `json:"total"`
|
||||
}
|
||||
|
||||
// searchCacheSuffix derives a stable cache key from the full filter set and
|
||||
// paging window so distinct queries never collide.
|
||||
func searchCacheSuffix(f SearchFilters, limit, offset int) string {
|
||||
raw := strings.Join([]string{
|
||||
f.Query, f.Category, f.Brand, f.Country,
|
||||
strconv.Itoa(limit), strconv.Itoa(offset),
|
||||
}, "\x1f")
|
||||
sum := sha1.Sum([]byte(raw))
|
||||
return "search:" + hex.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
// Nutriments returns just the nutrition payload for a product.
|
||||
@@ -232,12 +501,13 @@ type Category struct {
|
||||
Path string `json:"path"`
|
||||
GPCBrickCode *string `json:"gpc_brick_code"`
|
||||
Level int `json:"level"`
|
||||
ArchiveKind string `json:"archive_kind"`
|
||||
}
|
||||
|
||||
// ListCategories returns the full category tree ordered by path.
|
||||
func (s *Store) ListCategories(ctx context.Context) ([]Category, error) {
|
||||
rows, err := s.pool.Query(ctx,
|
||||
"SELECT id, name_zh, name_en, path::text, gpc_brick_code, level FROM category ORDER BY path")
|
||||
"SELECT id, name_zh, name_en, path::text, gpc_brick_code, level, COALESCE(archive_kind, 'generic') FROM category ORDER BY path")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -245,7 +515,7 @@ 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.GPCBrickCode, &c.Level); err != nil {
|
||||
if err := rows.Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.GPCBrickCode, &c.Level, &c.ArchiveKind); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, c)
|
||||
@@ -253,6 +523,70 @@ func (s *Store) ListCategories(ctx context.Context) ([]Category, error) {
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
// KindField describes one editable spec field for an archive kind. It drives
|
||||
// the dynamic contribution form (public, read-only view of the template).
|
||||
type KindField struct {
|
||||
Kind string `json:"kind"`
|
||||
FieldKey string `json:"field_key"`
|
||||
GroupLabel string `json:"group_label"`
|
||||
LabelZH string `json:"label_zh"`
|
||||
FieldType string `json:"field_type"`
|
||||
Unit *string `json:"unit"`
|
||||
Options []string `json:"options"`
|
||||
Placeholder *string `json:"placeholder"`
|
||||
SortOrder int `json:"sort_order"`
|
||||
Qualified bool `json:"qualified"`
|
||||
}
|
||||
|
||||
// ListKindFields returns the ordered field template for one archive kind so the
|
||||
// public contribution form can render kind-specific inputs.
|
||||
func (s *Store) ListKindFields(ctx context.Context, kind string) ([]KindField, error) {
|
||||
rows, err := s.pool.Query(ctx, `
|
||||
SELECT kind, field_key, group_label, label_zh, field_type, unit, options,
|
||||
placeholder, sort_order, qualified
|
||||
FROM kind_field WHERE kind = $1 ORDER BY sort_order, field_key`, kind)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
out := []KindField{}
|
||||
for rows.Next() {
|
||||
var f KindField
|
||||
if err := rows.Scan(&f.Kind, &f.FieldKey, &f.GroupLabel, &f.LabelZH,
|
||||
&f.FieldType, &f.Unit, &f.Options, &f.Placeholder, &f.SortOrder,
|
||||
&f.Qualified); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, f)
|
||||
}
|
||||
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
|
||||
QuotaTotal int64
|
||||
}
|
||||
|
||||
// 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, quota_total
|
||||
FROM api_key WHERE key_hash = $1 AND revoked_at IS NULL`, hash,
|
||||
).Scan(&k.ID, &k.Name, &k.RateLimitPerMin, &k.QuotaTotal)
|
||||
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),引用时请注明天工商品档案公共仓及原始来源。
|
||||
@@ -0,0 +1,112 @@
|
||||
# 可扩展性设计与路线图 (Scalability Roadmap)
|
||||
|
||||
本文档回答一个长期问题:随着商品越来越多、品类越来越杂(食品 / 电子 3C / 药品 /
|
||||
……),**检索与新增会不会压垮数据库?要不要按品类「分表」?**
|
||||
|
||||
> 结论先行:**现阶段不要按品类手动分表。** 现有「单表 + JSONB + archive_kind 框架」
|
||||
> 的设计方向是对的。扩展应当靠 **分区(非分表) + 读副本 + 缓存 + 专用搜索引擎**,
|
||||
> 按数据量分阶段推进,避免提前过度设计。
|
||||
|
||||
---
|
||||
|
||||
## 1. 现状盘点
|
||||
|
||||
### 1.1 数据模型
|
||||
- 所有商品落在**一张 `product` 表**;非食品的领域字段存 `product.attributes`(JSONB)。
|
||||
- 食品有独立明细表 `food_detail`(配料 / 营养 / 过敏原等结构化字段)。
|
||||
- `0010_archive_kinds` 引入 **archive_kind 框架**:每个品类带一个 `archive_kind`
|
||||
(`food` / `electronics` / `generic`),`kind_field` 表按 kind 定义字段模板,
|
||||
驱动后台动态表单与合格度评分。
|
||||
- **加新品类(如药品)不需要新建表**:只要新增一组 `kind_field` 行 + 一棵品类子树;
|
||||
仅当某品类有大量需被独立筛选/排序的结构化字段时,才考虑像 `food_detail` 那样补一张
|
||||
明细表。
|
||||
|
||||
### 1.2 已有索引(检索性能的基础)
|
||||
| 对象 | 索引 | 用途 |
|
||||
|------|------|------|
|
||||
| `product.gtin` | 唯一索引 | 条码精确查 |
|
||||
| `product.name` | trigram GIN (`pg_trgm`) | 名称模糊/相似匹配 |
|
||||
| `product.search_tsv` | 全文 GIN (`tsvector`) | 全文检索 |
|
||||
| `product.attributes` | JSONB GIN | 属性过滤 |
|
||||
| `brand.name` | trigram GIN | 品牌模糊匹配 |
|
||||
| `product.country_of_origin` | btree | 产地精确/前缀过滤 |
|
||||
| category / brand / updated_at | btree | 关联与增量 |
|
||||
|
||||
### 1.3 检索方式
|
||||
- 有关键词时:`name ILIKE` ∪ `word_similarity ≥ 阈值(~0.42)` ∪ 条码匹配,
|
||||
排序按 `相似度 × (0.5 + quality_score)`。
|
||||
- 无关键词时:按 `quality_score` 排序。
|
||||
- 翻页:`LIMIT / OFFSET`。
|
||||
|
||||
### 1.4 写入特征
|
||||
- 写库**只有** Python ingestion 一条路径(批量 ETL),不是高并发 OLTP。
|
||||
- 插入瓶颈极低;`search_tsv` 由触发器逐行重算,正常增量下开销可忽略。
|
||||
|
||||
---
|
||||
|
||||
## 2. 为什么不建议按品类「分表」
|
||||
|
||||
1. **核心场景是全局检索**:用户通常不知道商品属于哪个品类,搜索要跨所有品类。
|
||||
按品类拆成多表后,一次搜索得 `UNION ALL` 所有表,**更慢、代码更复杂、排序更难统一**。
|
||||
2. **单表足够能打**:Postgres 单表配好索引,**几千万行**量级的检索完全可承载。
|
||||
"表大"很少是真正瓶颈,"搜索方式"和"读并发"才是。
|
||||
3. **分表会侵蚀框架优势**:archive_kind 框架的价值就是"加品类零建表";手动分表等于
|
||||
把这套通用能力又拆碎。
|
||||
|
||||
> 区分两个概念:**分表(sharding,应用层拆多张表)** ≠ **分区(Postgres 原生
|
||||
> declarative partitioning,对上层透明的一张逻辑表)**。后者在超大规模时才有意义,
|
||||
> 见第 3 阶段。
|
||||
|
||||
---
|
||||
|
||||
## 3. 分阶段路线图(按数据量触发,不提前做)
|
||||
|
||||
### 阶段 0 — 现在 ~ 数百万条:维持现状 + 低成本优化
|
||||
触发:当前规模。改动小、收益稳,建议尽早做:
|
||||
- **深翻页改 keyset 分页**:`OFFSET` 越翻越慢(需扫描并丢弃前 N 行);改用
|
||||
`WHERE (score, id) < (:last_score, :last_id)` 形式的游标分页。
|
||||
- **部分索引**:绝大多数查询限定 `status='active'`,可建
|
||||
`CREATE INDEX ... WHERE status='active'` 缩小索引、提速。
|
||||
- **常用筛选复合索引**:如 `(category_id, quality_score DESC)`、
|
||||
`(archive_kind, quality_score DESC)` 配合域内列表。
|
||||
- **Redis 缓存**(已在技术栈内):缓存热门搜索结果与商品详情,挡住重复读。
|
||||
|
||||
### 阶段 1 — 千万级以上:读扩展 + 调优
|
||||
触发:单库读 QPS 升高、P99 变慢。
|
||||
- **只读副本(read replica)**:本服务是**只读公益 API**,天然适合一主多从,
|
||||
把检索/详情读流量分到副本,主库只承接 ingestion 写入。
|
||||
- **索引与查询调优**:按慢查询日志补/删索引,`EXPLAIN ANALYZE` 校核计划。
|
||||
- **(可选)Postgres 原生分区**:若多数检索"限定单一域"(只搜药品 / 只搜食品),
|
||||
可按 `archive_kind` 做 **LIST 分区**(对上层透明,仍是一张逻辑表)。主要利好
|
||||
**维护**(分区级 vacuum / 归档)与**域内查询裁剪**;对真正的全局搜索帮助有限。
|
||||
|
||||
### 阶段 2 — 搜索相关性/规模成为痛点:引入专用搜索引擎
|
||||
触发:`pg_trgm`/`tsvector` 在相关性排序、跨字段检索、规模上吃力。
|
||||
- 把**检索**迁到专用倒排引擎:**OpenSearch / Meilisearch / Typesense**,
|
||||
或 Postgres 内的 **ParadeDB(`pg_search`,BM25)**。
|
||||
- **Postgres 仍是唯一事实来源**;搜索引擎只做索引,由 ingestion 在写库后同步。
|
||||
- 这才是"搜索量大"的正解,**比分表有效得多**。
|
||||
|
||||
---
|
||||
|
||||
## 4. 大批量导入的建议
|
||||
- 海量初始化/回填用 `COPY` 而非逐行 `INSERT`。
|
||||
- 超大批量时可"先停建二级索引 → COPY → 重建索引",比边插边维护索引快得多。
|
||||
- ETL 控制并发与批大小,避免与在线读争抢。
|
||||
|
||||
---
|
||||
|
||||
## 5. 药品档案怎么落地(回到最初的问题)
|
||||
在上述设计下,加"药品"属于**阶段 0 的常规扩展**,不触动架构:
|
||||
1. 新增 `drug` 的 `kind_field` 模板(批准文号 / 通用名 / 商品名 / 剂型 / 规格 /
|
||||
生产企业 / OTC 分类 / 适应症 / 用法用量 / 不良反应 / 禁忌 / 注意事项 / 贮藏 /
|
||||
有效期 等),`qualified` 标记关键字段参与合格度评分。
|
||||
2. 加一棵药品品类子树,并把这些品类的 `archive_kind` 置为 `drug`。
|
||||
3. 仅当药品需要**被独立筛选/排序的强结构化字段**(如按批准文号精确查、按 OTC 分类
|
||||
过滤)时,才考虑补一张 `drug_detail` 明细表;否则继续走 `attributes` JSONB。
|
||||
|
||||
---
|
||||
|
||||
## 6. 版本
|
||||
- 本路线图随规模演进更新;任何落地改动需同步:迁移(SQL) + 本文档 +(涉及对外字段时)
|
||||
`docs/data-contract.md` / `docs/openapi.yaml`。
|
||||
@@ -0,0 +1,116 @@
|
||||
"""Adapter for the bypos-collector output (central product library zc.bypos.net).
|
||||
|
||||
The ``bypos-collector`` tool (see ``tools/bypos-collector``) queries the same
|
||||
central product library that the 云店 POS uses when adding a product by barcode,
|
||||
and writes one JSON object per line (JSONL) with these fields::
|
||||
|
||||
barcode name spec unit area manufacturer license
|
||||
in_price sell_price status retmsg fetched_at source
|
||||
|
||||
This module turns one such record into the internal product shape consumed by
|
||||
:func:`opengoods.etl.load.load_bypos_record`. It is a pure function (no DB, no
|
||||
network) so it is easy to unit-test.
|
||||
|
||||
The central library is a Chinese retail catalogue: it provides 品名/规格/单位/
|
||||
产地/厂商/建议价 but **not** ingredients or nutrition, so no ``food`` block is
|
||||
produced.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from decimal import Decimal, InvalidOperation
|
||||
|
||||
from opengoods.etl.transform import _clamp, is_valid_gtin, parse_quantity
|
||||
from opengoods.units import UnitError, normalize
|
||||
|
||||
SOURCE_NAME = "bypos中心库"
|
||||
SOURCE_HOMEPAGE = "https://zc.bypos.net"
|
||||
# Vendor catalogue data; not an open-licensed dataset. Display facts only.
|
||||
SOURCE_LICENSE = "proprietary"
|
||||
SOURCE_TRUST = 0.6
|
||||
|
||||
|
||||
def _to_price(text: str | None) -> Decimal | None:
|
||||
"""Parse a price string to a positive Decimal, or None for empty/zero."""
|
||||
if not text:
|
||||
return None
|
||||
try:
|
||||
amount = Decimal(str(text).strip())
|
||||
except (InvalidOperation, ValueError):
|
||||
return None
|
||||
if amount <= 0:
|
||||
return None
|
||||
return amount
|
||||
|
||||
|
||||
def _net_content(spec: str | None) -> tuple[Decimal | None, str | None, Decimal | None]:
|
||||
"""Best-effort parse a spec like '500mL'/'5kg' to (value, unit, canonical).
|
||||
|
||||
Packaging-style specs ('20支', '1X24', '盒') have no mass/volume unit and
|
||||
yield ``(None, None, None)`` — the raw spec is kept in attributes instead.
|
||||
"""
|
||||
parsed = parse_quantity(spec or "")
|
||||
if not parsed:
|
||||
return None, None, None
|
||||
value, unit = parsed
|
||||
try:
|
||||
norm = normalize(value, unit)
|
||||
except UnitError:
|
||||
return None, None, None
|
||||
return norm.value, norm.unit, norm.canonical_value
|
||||
|
||||
|
||||
def transform_bypos(rec: dict) -> dict | None:
|
||||
"""Transform one bypos-collector JSONL record into an internal product dict.
|
||||
|
||||
Returns ``None`` for non-hit rows or rows without a usable name.
|
||||
"""
|
||||
if rec.get("status") != "hit":
|
||||
return None
|
||||
name = (rec.get("name") or "").strip()
|
||||
if not name:
|
||||
return None
|
||||
|
||||
barcode = str(rec.get("barcode") or "").strip()
|
||||
gtin = barcode if barcode and is_valid_gtin(barcode) else None
|
||||
|
||||
net_value, net_unit, net_canonical = _net_content(rec.get("spec"))
|
||||
|
||||
spec = (rec.get("spec") or "").strip()
|
||||
pack_unit = (rec.get("unit") or "").strip()
|
||||
area = (rec.get("area") or "").strip()
|
||||
manufacturer = (rec.get("manufacturer") or "").strip() or None
|
||||
license_no = (rec.get("license") or "").strip()
|
||||
in_price = _to_price(rec.get("in_price"))
|
||||
sell_price = _to_price(rec.get("sell_price"))
|
||||
|
||||
attributes: dict[str, object] = {}
|
||||
if spec:
|
||||
attributes["spec"] = spec
|
||||
if pack_unit:
|
||||
attributes["pack_unit"] = pack_unit
|
||||
if area:
|
||||
attributes["origin_area"] = area
|
||||
if license_no:
|
||||
attributes["production_license"] = license_no
|
||||
if in_price is not None:
|
||||
attributes["suggested_in_price"] = float(in_price)
|
||||
if sell_price is not None:
|
||||
attributes["suggested_retail_price"] = float(sell_price)
|
||||
|
||||
# Domestic GS1-China barcodes (69x) are China-made; area is a province/city,
|
||||
# kept separately in attributes.origin_area.
|
||||
country = "中国" if gtin and gtin.startswith("69") else None
|
||||
|
||||
return {
|
||||
"gtin": gtin,
|
||||
"name": name,
|
||||
"manufacturer": manufacturer,
|
||||
"net_content_value": net_value,
|
||||
"net_content_unit": _clamp(net_unit, 16),
|
||||
"net_content_canonical": net_canonical,
|
||||
"country_of_origin": country,
|
||||
"attributes": attributes,
|
||||
"msrp": sell_price,
|
||||
"fetched_at": (rec.get("fetched_at") or "").strip() or None,
|
||||
}
|
||||
@@ -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.
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
"""Read-cache invalidation signal for the public API.
|
||||
|
||||
The Go API caches hot product details and search results in Redis, namespacing
|
||||
every key by a global generation counter (``og:cache:epoch``). Bumping that
|
||||
counter logically invalidates the entire cache in one O(1) operation while the
|
||||
old keys age out via their TTL.
|
||||
|
||||
Ingestion is the only writer to the database, so after a run that changed data
|
||||
it calls :func:`bump_cache_epoch` to make those changes visible immediately
|
||||
instead of waiting for per-key TTLs to expire.
|
||||
|
||||
Like the API's cache, this is strictly best effort and fails open: if Redis is
|
||||
unconfigured or unreachable the ingestion run still succeeds, and stale entries
|
||||
simply expire on their own.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import os
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
EPOCH_KEY = "og:cache:epoch"
|
||||
|
||||
|
||||
def default_redis_url() -> str | None:
|
||||
"""Return the configured Redis URL, or ``None`` when caching is disabled."""
|
||||
return os.environ.get("OPENGOODS_REDIS_URL") or None
|
||||
|
||||
|
||||
def bump_cache_epoch(url: str | None = None) -> bool:
|
||||
"""Increment the API cache generation counter.
|
||||
|
||||
Returns ``True`` if the counter was bumped, ``False`` if caching is disabled
|
||||
or Redis was unreachable. Never raises: invalidation failures must not fail
|
||||
an ingestion run.
|
||||
"""
|
||||
url = url or default_redis_url()
|
||||
if not url:
|
||||
return False
|
||||
try:
|
||||
import redis # imported lazily so the dependency is optional at runtime
|
||||
|
||||
client = redis.Redis.from_url(url, socket_timeout=2, socket_connect_timeout=2)
|
||||
new_epoch = client.incr(EPOCH_KEY)
|
||||
client.close()
|
||||
logger.info("bumped API cache epoch to %s", new_epoch)
|
||||
return True
|
||||
except Exception as exc: # noqa: BLE001 - invalidation is best effort
|
||||
logger.warning("cache epoch bump skipped: %s", exc)
|
||||
return False
|
||||
@@ -7,17 +7,24 @@ source with field-level provenance in `product_source`.
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
from typing import Any
|
||||
|
||||
import psycopg
|
||||
from psycopg.types.json import Jsonb
|
||||
|
||||
from opengoods.adapters.bypos import SOURCE_HOMEPAGE as SOURCE_HOMEPAGE_BYPOS
|
||||
from opengoods.adapters.bypos import SOURCE_LICENSE as SOURCE_LICENSE_BYPOS
|
||||
from opengoods.adapters.bypos import SOURCE_NAME as SOURCE_NAME_BYPOS
|
||||
from opengoods.adapters.bypos import SOURCE_TRUST as SOURCE_TRUST_BYPOS
|
||||
from opengoods.adapters.openfoodfacts import OFF_LICENSE, SOURCE_NAME
|
||||
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(
|
||||
@@ -70,6 +77,23 @@ def _ensure_brand(conn: psycopg.Connection, name: str | None) -> str | None:
|
||||
return row[0]
|
||||
|
||||
|
||||
def _ensure_manufacturer(
|
||||
conn: psycopg.Connection, name: str | None, country: str | None = None
|
||||
) -> str | None:
|
||||
if not name:
|
||||
return None
|
||||
row = conn.execute(
|
||||
"""
|
||||
INSERT INTO manufacturer (name, normalized_name, country)
|
||||
VALUES (%s, %s, %s)
|
||||
ON CONFLICT (normalized_name) DO UPDATE SET name = manufacturer.name
|
||||
RETURNING id
|
||||
""",
|
||||
(name, _normalize_brand(name), country),
|
||||
).fetchone()
|
||||
return row[0]
|
||||
|
||||
|
||||
def _category_id(conn: psycopg.Connection, path: str | None) -> tuple[str | None, str | None]:
|
||||
if not path:
|
||||
return None, None
|
||||
@@ -196,6 +220,159 @@ 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 ensure_bypos_source(conn: psycopg.Connection) -> str:
|
||||
"""Upsert the bypos central-library source row and return its id."""
|
||||
return ensure_source_named(
|
||||
conn,
|
||||
SOURCE_NAME_BYPOS,
|
||||
SOURCE_HOMEPAGE_BYPOS,
|
||||
SOURCE_LICENSE_BYPOS,
|
||||
SOURCE_TRUST_BYPOS,
|
||||
)
|
||||
|
||||
|
||||
def load_bypos_record(
|
||||
conn: psycopg.Connection, rec: dict[str, Any], source_id: str, raw: dict
|
||||
) -> str:
|
||||
"""Upsert one transformed bypos record; return the product id.
|
||||
|
||||
Unlike OFF records these have no ingredients/nutrition, so no ``food_detail``
|
||||
row is written. The suggested retail price (if any) is stored as a CNY MSRP
|
||||
snapshot, and provenance/MSRP rows are keyed by source so a re-import
|
||||
refreshes rather than duplicates them.
|
||||
"""
|
||||
manufacturer_id = _ensure_manufacturer(
|
||||
conn, rec.get("manufacturer"), rec.get("country_of_origin")
|
||||
)
|
||||
attrs = rec.get("attributes") or {}
|
||||
fields = ["name", "net_content", "country_of_origin"]
|
||||
if manufacturer_id:
|
||||
fields.append("manufacturer")
|
||||
if attrs:
|
||||
fields.append("attributes")
|
||||
|
||||
if rec.get("gtin"):
|
||||
fields.append("gtin")
|
||||
prod = conn.execute(
|
||||
"""
|
||||
INSERT INTO product (gtin, name, manufacturer_id,
|
||||
net_content_value, net_content_unit, net_content_canonical,
|
||||
country_of_origin, attributes)
|
||||
VALUES (%s,%s,%s,%s,%s,%s,%s,%s)
|
||||
ON CONFLICT (gtin) WHERE gtin IS NOT NULL DO UPDATE SET
|
||||
name = EXCLUDED.name,
|
||||
manufacturer_id = COALESCE(EXCLUDED.manufacturer_id, product.manufacturer_id),
|
||||
net_content_value = COALESCE(EXCLUDED.net_content_value, product.net_content_value),
|
||||
net_content_unit = COALESCE(EXCLUDED.net_content_unit, product.net_content_unit),
|
||||
net_content_canonical = COALESCE(
|
||||
EXCLUDED.net_content_canonical, product.net_content_canonical),
|
||||
country_of_origin = COALESCE(EXCLUDED.country_of_origin, product.country_of_origin),
|
||||
attributes = product.attributes || EXCLUDED.attributes
|
||||
RETURNING id
|
||||
""",
|
||||
(
|
||||
rec["gtin"],
|
||||
rec["name"],
|
||||
manufacturer_id,
|
||||
rec.get("net_content_value"),
|
||||
rec.get("net_content_unit"),
|
||||
rec.get("net_content_canonical"),
|
||||
rec.get("country_of_origin"),
|
||||
Jsonb(attrs),
|
||||
),
|
||||
).fetchone()
|
||||
else:
|
||||
prod = conn.execute(
|
||||
"""
|
||||
INSERT INTO product (name, manufacturer_id,
|
||||
net_content_value, net_content_unit, net_content_canonical,
|
||||
country_of_origin, attributes)
|
||||
VALUES (%s,%s,%s,%s,%s,%s,%s)
|
||||
RETURNING id
|
||||
""",
|
||||
(
|
||||
rec["name"],
|
||||
manufacturer_id,
|
||||
rec.get("net_content_value"),
|
||||
rec.get("net_content_unit"),
|
||||
rec.get("net_content_canonical"),
|
||||
rec.get("country_of_origin"),
|
||||
Jsonb(attrs),
|
||||
),
|
||||
).fetchone()
|
||||
product_id = prod[0]
|
||||
|
||||
# Refresh this source's MSRP snapshot (suggested retail price, CNY).
|
||||
conn.execute(
|
||||
"DELETE FROM product_msrp WHERE product_id = %s AND source_id = %s",
|
||||
(product_id, source_id),
|
||||
)
|
||||
if rec.get("msrp") is not None:
|
||||
conn.execute(
|
||||
"""
|
||||
INSERT INTO product_msrp (product_id, amount, currency, region, source_id, source_url)
|
||||
VALUES (%s,%s,'CNY','CN',%s,%s)
|
||||
""",
|
||||
(product_id, rec["msrp"], source_id, SOURCE_HOMEPAGE_BYPOS),
|
||||
)
|
||||
fields.append("msrp")
|
||||
|
||||
# Refresh this source's provenance row (one per source for idempotency).
|
||||
conn.execute(
|
||||
"DELETE FROM product_source WHERE product_id = %s AND source_id = %s",
|
||||
(product_id, source_id),
|
||||
)
|
||||
conn.execute(
|
||||
"""
|
||||
INSERT INTO product_source (product_id, source_id, url, fields, fetched_at, raw)
|
||||
VALUES (%s,%s,%s,%s, COALESCE(%s::timestamptz, now()), %s)
|
||||
""",
|
||||
(
|
||||
product_id,
|
||||
source_id,
|
||||
SOURCE_HOMEPAGE_BYPOS,
|
||||
fields,
|
||||
rec.get("fetched_at"),
|
||||
Jsonb(_jsonable(raw)),
|
||||
),
|
||||
)
|
||||
|
||||
update_quality(conn, product_id)
|
||||
return product_id
|
||||
|
||||
|
||||
def load_bypos_record_safe(
|
||||
conn: psycopg.Connection, rec: dict[str, Any], source_id: str, raw: dict
|
||||
) -> bool:
|
||||
"""Load one bypos record inside a savepoint (see :func:`load_record_safe`)."""
|
||||
try:
|
||||
with conn.transaction():
|
||||
load_bypos_record(conn, rec, source_id, raw)
|
||||
return True
|
||||
except Exception as exc: # noqa: BLE001 - per-record isolation is intentional
|
||||
logger.warning("skipping bypos 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,
|
||||
|
||||
@@ -12,6 +12,7 @@ import sys
|
||||
|
||||
import psycopg
|
||||
|
||||
from opengoods.cache import bump_cache_epoch
|
||||
from opengoods.etl.dedup import dedup_all
|
||||
from opengoods.etl.load import default_dsn
|
||||
|
||||
@@ -23,6 +24,8 @@ def run(args: argparse.Namespace) -> int:
|
||||
conn.rollback()
|
||||
else:
|
||||
conn.commit()
|
||||
if not args.dry_run and summary["merged"]:
|
||||
bump_cache_epoch()
|
||||
mode = "dry-run" if args.dry_run else "applied"
|
||||
print(f"{mode} groups={summary['groups']} merged={summary['merged']}")
|
||||
return 0
|
||||
|
||||
@@ -0,0 +1,80 @@
|
||||
"""Import products collected by the bypos-collector tool into OpenGoods.
|
||||
|
||||
The ``tools/bypos-collector`` program writes one product per line (JSONL). This
|
||||
job reads such a file, transforms each ``hit`` record into the internal product
|
||||
shape, and upserts it into the database under the ``bypos中心库`` source with
|
||||
field-level provenance.
|
||||
|
||||
Usage::
|
||||
|
||||
python -m opengoods.jobs.import_bypos --input products.jsonl
|
||||
python -m opengoods.jobs.import_bypos --input products.jsonl --limit 500
|
||||
|
||||
Re-running is safe: products are upserted by GTIN and the source's MSRP/
|
||||
provenance rows are refreshed rather than duplicated.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import gzip
|
||||
import json
|
||||
import sys
|
||||
from collections.abc import Iterator
|
||||
|
||||
import psycopg
|
||||
|
||||
from opengoods.adapters.bypos import transform_bypos
|
||||
from opengoods.cache import bump_cache_epoch
|
||||
from opengoods.etl.load import default_dsn, ensure_bypos_source, load_bypos_record_safe
|
||||
|
||||
|
||||
def _read_jsonl(path: str) -> Iterator[dict]:
|
||||
opener = gzip.open if path.endswith(".gz") else open
|
||||
with opener(path, "rt", encoding="utf-8") as fh:
|
||||
for line in fh:
|
||||
line = line.strip()
|
||||
if not line:
|
||||
continue
|
||||
try:
|
||||
yield json.loads(line)
|
||||
except json.JSONDecodeError:
|
||||
continue
|
||||
|
||||
|
||||
def run(args: argparse.Namespace) -> int:
|
||||
loaded = skipped = errored = 0
|
||||
with psycopg.connect(args.dsn, autocommit=False) as conn:
|
||||
source_id = ensure_bypos_source(conn)
|
||||
yielded = 0
|
||||
for raw in _read_jsonl(args.input):
|
||||
if args.limit and yielded >= args.limit:
|
||||
break
|
||||
rec = transform_bypos(raw)
|
||||
if rec is None:
|
||||
skipped += 1
|
||||
continue
|
||||
yielded += 1
|
||||
if load_bypos_record_safe(conn, rec, source_id, raw):
|
||||
loaded += 1
|
||||
else:
|
||||
errored += 1
|
||||
conn.commit()
|
||||
if loaded:
|
||||
bump_cache_epoch()
|
||||
print(f"loaded={loaded} skipped={skipped} errored={errored}")
|
||||
return 0
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
parser = argparse.ArgumentParser(description="Import bypos-collector JSONL into OpenGoods")
|
||||
parser.add_argument(
|
||||
"--input", required=True, help="path to a bypos-collector JSONL (.jsonl or .jsonl.gz)"
|
||||
)
|
||||
parser.add_argument("--limit", type=int, default=0, help="max hit records to load (0 = all)")
|
||||
parser.add_argument("--dsn", default=default_dsn(), help="PostgreSQL DSN")
|
||||
return run(parser.parse_args(argv))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -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,39 @@ 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.cache import bump_cache_epoch
|
||||
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 +63,14 @@ 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}")
|
||||
if loaded:
|
||||
bump_cache_epoch()
|
||||
print(f"loaded={loaded} skipped={skipped} errored={errored}")
|
||||
return 0
|
||||
|
||||
|
||||
@@ -56,7 +79,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,15 @@ 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.cache import bump_cache_epoch
|
||||
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 +39,23 @@ 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}")
|
||||
if loaded:
|
||||
bump_cache_epoch()
|
||||
print(
|
||||
f"since={since} loaded={loaded} skipped={skipped} "
|
||||
f"errored={errored} watermark={high_watermark}"
|
||||
)
|
||||
return 0
|
||||
|
||||
|
||||
|
||||
@@ -6,6 +6,7 @@ requires-python = ">=3.11"
|
||||
dependencies = [
|
||||
"httpx>=0.27",
|
||||
"psycopg[binary]>=3.2",
|
||||
"redis>=5.0,<6",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
|
||||
@@ -0,0 +1,155 @@
|
||||
"""Tests for the bypos-collector adapter/transform and DB loader.
|
||||
|
||||
The pure-function tests run anywhere; the DB roundtrip is skipped automatically
|
||||
when no database is reachable or migrations are not applied.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from decimal import Decimal
|
||||
|
||||
import pytest
|
||||
|
||||
from opengoods.adapters.bypos import transform_bypos
|
||||
|
||||
psycopg = pytest.importorskip("psycopg")
|
||||
|
||||
# A real central-library "hit" row as emitted by the collector.
|
||||
HIT = {
|
||||
"barcode": "6901028941068",
|
||||
"name": "泰山合悦",
|
||||
"spec": "20支",
|
||||
"unit": "盒",
|
||||
"area": "广东",
|
||||
"manufacturer": "",
|
||||
"license": "",
|
||||
"in_price": "22.50",
|
||||
"sell_price": "28.00",
|
||||
"status": "hit",
|
||||
"retmsg": "获取商品信息成功",
|
||||
"fetched_at": "2026-06-24T02:08:34Z",
|
||||
"source": "zc.bypos.net",
|
||||
}
|
||||
|
||||
# A hit with a real mass/volume spec that should normalize to net content.
|
||||
HIT_VOLUME = {
|
||||
"barcode": "6920459905012",
|
||||
"name": "康师傅冰红茶490ml",
|
||||
"spec": "490毫升",
|
||||
"unit": "瓶",
|
||||
"area": "浙江杭州",
|
||||
"manufacturer": "",
|
||||
"license": "",
|
||||
"in_price": "2.20",
|
||||
"sell_price": "3.00",
|
||||
"status": "hit",
|
||||
"fetched_at": "2026-06-24T02:08:34Z",
|
||||
"source": "zc.bypos.net",
|
||||
}
|
||||
|
||||
|
||||
def test_transform_skips_non_hit():
|
||||
assert transform_bypos({**HIT, "status": "miss", "name": ""}) is None
|
||||
assert transform_bypos({**HIT, "status": "invalid"}) is None
|
||||
|
||||
|
||||
def test_transform_skips_missing_name():
|
||||
assert transform_bypos({**HIT, "name": " "}) is None
|
||||
|
||||
|
||||
def test_transform_packaging_spec_kept_raw():
|
||||
rec = transform_bypos(HIT)
|
||||
assert rec is not None
|
||||
assert rec["gtin"] == "6901028941068"
|
||||
assert rec["name"] == "泰山合悦"
|
||||
# '20支' is a count, not mass/volume -> no net_content, raw spec retained.
|
||||
assert rec["net_content_value"] is None
|
||||
assert rec["net_content_unit"] is None
|
||||
assert rec["attributes"]["spec"] == "20支"
|
||||
assert rec["attributes"]["pack_unit"] == "盒"
|
||||
assert rec["attributes"]["origin_area"] == "广东"
|
||||
assert rec["attributes"]["suggested_in_price"] == 22.5
|
||||
assert rec["attributes"]["suggested_retail_price"] == 28.0
|
||||
assert rec["msrp"] == Decimal("28.00")
|
||||
assert rec["country_of_origin"] == "中国"
|
||||
|
||||
|
||||
def test_transform_volume_spec_normalized():
|
||||
rec = transform_bypos(HIT_VOLUME)
|
||||
assert rec is not None
|
||||
assert rec["net_content_value"] == Decimal("490")
|
||||
assert rec["net_content_unit"] == "ml"
|
||||
assert rec["net_content_canonical"] == Decimal("490")
|
||||
assert rec["attributes"]["origin_area"] == "浙江杭州"
|
||||
|
||||
|
||||
def test_transform_zero_price_dropped():
|
||||
rec = transform_bypos({**HIT, "in_price": "0.00", "sell_price": "0.00"})
|
||||
assert rec is not None
|
||||
assert rec["msrp"] is None
|
||||
assert "suggested_in_price" not in rec["attributes"]
|
||||
assert "suggested_retail_price" not in rec["attributes"]
|
||||
|
||||
|
||||
def test_transform_invalid_barcode_no_gtin():
|
||||
rec = transform_bypos({**HIT, "barcode": "123"})
|
||||
assert rec is not None
|
||||
assert rec["gtin"] is None
|
||||
assert rec["country_of_origin"] is None
|
||||
|
||||
|
||||
# --- DB roundtrip (skipped without a database) ---------------------------------
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
def conn():
|
||||
from opengoods.etl.load import default_dsn
|
||||
|
||||
try:
|
||||
c = psycopg.connect(default_dsn(), connect_timeout=3)
|
||||
except psycopg.OperationalError as exc: # pragma: no cover - env dependent
|
||||
pytest.skip(f"no database available: {exc}")
|
||||
has_product = c.execute("SELECT to_regclass('public.product') IS NOT NULL").fetchone()[0]
|
||||
if not has_product:
|
||||
c.close()
|
||||
pytest.skip("migrations not applied")
|
||||
yield c
|
||||
c.rollback()
|
||||
c.close()
|
||||
|
||||
|
||||
def test_load_bypos_roundtrip(conn):
|
||||
from opengoods.etl.load import ensure_bypos_source, load_bypos_record
|
||||
|
||||
source_id = ensure_bypos_source(conn)
|
||||
rec = transform_bypos(HIT_VOLUME)
|
||||
product_id = load_bypos_record(conn, rec, source_id, HIT_VOLUME)
|
||||
|
||||
row = conn.execute(
|
||||
"SELECT name, gtin, net_content_unit, country_of_origin, attributes ->> 'pack_unit' "
|
||||
"FROM product WHERE id = %s",
|
||||
(product_id,),
|
||||
).fetchone()
|
||||
assert row[0] == "康师傅冰红茶490ml"
|
||||
assert row[1] == "6920459905012"
|
||||
assert row[2] == "ml"
|
||||
assert row[3] == "中国"
|
||||
assert row[4] == "瓶"
|
||||
|
||||
msrp = conn.execute(
|
||||
"SELECT amount, currency FROM product_msrp WHERE product_id = %s AND source_id = %s",
|
||||
(product_id, source_id),
|
||||
).fetchone()
|
||||
assert msrp[0] == Decimal("3.00")
|
||||
assert msrp[1] == "CNY"
|
||||
|
||||
# Re-import is idempotent: still one MSRP and one provenance row per source.
|
||||
load_bypos_record(conn, rec, source_id, HIT_VOLUME)
|
||||
counts = conn.execute(
|
||||
"SELECT (SELECT count(*) FROM product_msrp WHERE product_id=%s AND source_id=%s), "
|
||||
"(SELECT count(*) FROM product_source WHERE product_id=%s AND source_id=%s)",
|
||||
(product_id, source_id, product_id, source_id),
|
||||
).fetchone()
|
||||
assert counts == (1, 1)
|
||||
|
||||
conn.rollback()
|
||||
@@ -0,0 +1,44 @@
|
||||
"""Tests for the best-effort API cache invalidation signal."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import sys
|
||||
|
||||
import opengoods.cache as cache
|
||||
|
||||
|
||||
def test_disabled_when_no_url(monkeypatch):
|
||||
monkeypatch.delenv("OPENGOODS_REDIS_URL", raising=False)
|
||||
assert cache.default_redis_url() is None
|
||||
assert cache.bump_cache_epoch() is False
|
||||
|
||||
|
||||
def test_bump_fails_open_when_unreachable(monkeypatch):
|
||||
# An unroutable URL must not raise; the run still succeeds.
|
||||
monkeypatch.setenv("OPENGOODS_REDIS_URL", "redis://127.0.0.1:1/0")
|
||||
assert cache.bump_cache_epoch() is False
|
||||
|
||||
|
||||
def test_bump_increments_epoch(monkeypatch):
|
||||
calls = {}
|
||||
|
||||
class FakeClient:
|
||||
def incr(self, key):
|
||||
calls["key"] = key
|
||||
return 7
|
||||
|
||||
def close(self):
|
||||
calls["closed"] = True
|
||||
|
||||
class FakeRedis:
|
||||
@staticmethod
|
||||
def from_url(url, **kwargs):
|
||||
calls["url"] = url
|
||||
return FakeClient()
|
||||
|
||||
monkeypatch.setitem(sys.modules, "redis", type("M", (), {"Redis": FakeRedis}))
|
||||
|
||||
assert cache.bump_cache_epoch("redis://example:6379/0") is True
|
||||
assert calls["key"] == "og:cache:epoch"
|
||||
assert calls["url"] == "redis://example:6379/0"
|
||||
assert calls["closed"] is True
|
||||
@@ -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 product_barcode;
|
||||
@@ -0,0 +1,36 @@
|
||||
-- Multi-barcode support: one product can carry many GS1 barcodes
|
||||
-- (consumer unit EAN-13/UPC, case ITF-14, regional re-labels, etc.).
|
||||
-- product.gtin is kept as the denormalized "primary" barcode for
|
||||
-- backward compatibility and is mirrored from the is_primary row here.
|
||||
|
||||
CREATE TABLE product_barcode (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||
product_id UUID NOT NULL REFERENCES product(id) ON DELETE CASCADE,
|
||||
gtin VARCHAR(14) NOT NULL,
|
||||
gtin_type VARCHAR(8) NOT NULL DEFAULT 'EAN13',
|
||||
pack_level VARCHAR(8) NOT NULL DEFAULT 'each',
|
||||
region VARCHAR(8),
|
||||
is_primary BOOLEAN NOT NULL DEFAULT false,
|
||||
source_id UUID REFERENCES source(id),
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||
CONSTRAINT product_barcode_type_chk CHECK (gtin_type IN ('EAN8','UPC','EAN13','ITF14','GTIN14')),
|
||||
CONSTRAINT product_barcode_pack_chk CHECK (pack_level IN ('each','case','pallet'))
|
||||
);
|
||||
|
||||
-- A barcode is globally unique: one code maps to exactly one product.
|
||||
CREATE UNIQUE INDEX idx_product_barcode_gtin ON product_barcode (gtin);
|
||||
CREATE INDEX idx_product_barcode_product ON product_barcode (product_id);
|
||||
-- At most one primary barcode per product.
|
||||
CREATE UNIQUE INDEX idx_product_barcode_primary ON product_barcode (product_id) WHERE is_primary;
|
||||
|
||||
-- Backfill: lift each product's existing gtin into the new table as primary.
|
||||
INSERT INTO product_barcode (product_id, gtin, gtin_type, pack_level, is_primary)
|
||||
SELECT id, gtin,
|
||||
CASE WHEN length(gtin) = 8 THEN 'EAN8'
|
||||
WHEN length(gtin) = 12 THEN 'UPC'
|
||||
WHEN length(gtin) = 14 THEN 'GTIN14'
|
||||
ELSE 'EAN13' END,
|
||||
'each', true
|
||||
FROM product
|
||||
WHERE gtin IS NOT NULL AND gtin <> ''
|
||||
ON CONFLICT (gtin) DO NOTHING;
|
||||
@@ -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);
|
||||
@@ -0,0 +1,9 @@
|
||||
-- Detach any products from the seeded 3C categories, then remove them.
|
||||
UPDATE product SET category_id = NULL
|
||||
WHERE category_id IN (SELECT id FROM category WHERE path <@ 'electronics');
|
||||
|
||||
DELETE FROM category WHERE path <@ 'electronics';
|
||||
|
||||
DROP TABLE IF EXISTS kind_field;
|
||||
|
||||
ALTER TABLE category DROP COLUMN IF EXISTS archive_kind;
|
||||
@@ -0,0 +1,64 @@
|
||||
-- Generic, extensible "archive kind" (档案模式) framework.
|
||||
-- Instead of a dedicated detail table per domain (food/electronics/drug/...),
|
||||
-- each category belongs to an archive_kind, and a metadata table (kind_field)
|
||||
-- describes the editable spec fields for that kind. Non-food spec values live
|
||||
-- in the existing product.attributes JSONB. Adding a new domain later (drug,
|
||||
-- machinery, ...) is just: seed kind_field rows + a category subtree.
|
||||
|
||||
ALTER TABLE category ADD COLUMN archive_kind VARCHAR(24) NOT NULL DEFAULT 'generic';
|
||||
|
||||
-- The existing seeded tree is the food domain.
|
||||
UPDATE category SET archive_kind = 'food' WHERE path <@ 'food';
|
||||
|
||||
-- Field template per archive kind: drives the dynamic admin form and the
|
||||
-- kind-aware completeness/qualified computation.
|
||||
CREATE TABLE kind_field (
|
||||
kind VARCHAR(24) NOT NULL,
|
||||
field_key VARCHAR(64) NOT NULL,
|
||||
group_label TEXT NOT NULL DEFAULT '',
|
||||
label_zh TEXT NOT NULL,
|
||||
field_type VARCHAR(16) NOT NULL DEFAULT 'text',
|
||||
unit TEXT,
|
||||
options TEXT[] NOT NULL DEFAULT '{}',
|
||||
placeholder TEXT,
|
||||
sort_order INT NOT NULL DEFAULT 0,
|
||||
qualified BOOLEAN NOT NULL DEFAULT false,
|
||||
PRIMARY KEY (kind, field_key),
|
||||
CONSTRAINT kind_field_type_chk CHECK (field_type IN ('text','number','textarea','select','list'))
|
||||
);
|
||||
|
||||
-- Seed the electronics (3C) field template.
|
||||
INSERT INTO kind_field (kind, field_key, group_label, label_zh, field_type, unit, sort_order, qualified) VALUES
|
||||
('electronics','model_number', '基础规格','型号', 'text', NULL, 10, true),
|
||||
('electronics','ccc_cert', '基础规格','3C认证号(CCC)','text', NULL, 20, true),
|
||||
('electronics','color', '基础规格','颜色', 'text', NULL, 30, false),
|
||||
('electronics','release_year', '基础规格','发布年份', 'number', NULL, 40, false),
|
||||
('electronics','warranty_months','基础规格','保修期', 'number', '月', 50, false),
|
||||
('electronics','dimensions', '外形','尺寸(长x宽x高)', 'text', 'mm', 60, false),
|
||||
('electronics','weight', '外形','重量', 'number', 'g', 70, false),
|
||||
('electronics','power', '外形','电源/功率', 'text', NULL, 80, false),
|
||||
('electronics','os', '关键参数','操作系统', 'text', NULL, 90, false),
|
||||
('electronics','cpu', '关键参数','处理器', 'text', NULL, 100, false),
|
||||
('electronics','ram', '关键参数','内存', 'text', NULL, 110, false),
|
||||
('electronics','storage', '关键参数','存储', 'text', NULL, 120, false),
|
||||
('electronics','screen_size', '关键参数','屏幕尺寸', 'text', NULL, 130, true),
|
||||
('electronics','battery', '关键参数','电池容量', 'text', NULL, 140, false),
|
||||
('electronics','ports', '关键参数','接口', 'text', NULL, 150, false);
|
||||
|
||||
-- Seed the 3C category tree.
|
||||
INSERT INTO category (name_zh, name_en, parent_id, path, level, archive_kind)
|
||||
VALUES ('电子数码', 'Electronics', NULL, 'electronics', 0, 'electronics');
|
||||
|
||||
INSERT INTO category (name_zh, name_en, parent_id, path, level, archive_kind)
|
||||
SELECT v.name_zh, v.name_en, c.id, v.path::ltree, 1, 'electronics'
|
||||
FROM (VALUES
|
||||
('手机', 'Smartphone', 'electronics.phone'),
|
||||
('笔记本电脑', 'Laptop', 'electronics.laptop'),
|
||||
('平板电脑', 'Tablet', 'electronics.tablet'),
|
||||
('智能手表', 'Smartwatch', 'electronics.watch'),
|
||||
('耳机', 'Headphone', 'electronics.headphone'),
|
||||
('相机', 'Camera', 'electronics.camera'),
|
||||
('电视', 'TV', 'electronics.tv'),
|
||||
('家用电器', 'Home appliance', 'electronics.appliance')
|
||||
) AS v(name_zh, name_en, path)
|
||||
JOIN category c ON c.path = 'electronics';
|
||||
@@ -0,0 +1,10 @@
|
||||
DROP TABLE IF EXISTS app_user;
|
||||
|
||||
-- Demote any self-registered keys before restoring the narrower tier check.
|
||||
UPDATE api_key SET tier = 'free' WHERE tier = 'registered';
|
||||
|
||||
ALTER TABLE api_key DROP CONSTRAINT IF EXISTS api_key_tier_chk;
|
||||
ALTER TABLE api_key ADD CONSTRAINT api_key_tier_chk
|
||||
CHECK (tier IN ('free', 'partner', 'internal'));
|
||||
|
||||
ALTER TABLE api_key DROP COLUMN IF EXISTS quota_total;
|
||||
@@ -0,0 +1,27 @@
|
||||
-- Cumulative usage quotas + self-service user registration for the public API.
|
||||
--
|
||||
-- The free anonymous tier is capped at a lifetime number of calls (enforced in
|
||||
-- Redis, keyed by client IP). To keep calling beyond the free quota a caller
|
||||
-- registers an account and self-issues an API key with a higher quota.
|
||||
-- quota_total = 0 means unlimited.
|
||||
--
|
||||
-- Registration is the one place the public server writes to PostgreSQL (it
|
||||
-- inserts an app_user and its api_key); every other public route stays
|
||||
-- read-only. Request counting still lives entirely in Redis.
|
||||
|
||||
ALTER TABLE api_key ADD COLUMN IF NOT EXISTS quota_total BIGINT NOT NULL DEFAULT 0;
|
||||
|
||||
ALTER TABLE api_key DROP CONSTRAINT IF EXISTS api_key_tier_chk;
|
||||
ALTER TABLE api_key ADD CONSTRAINT api_key_tier_chk
|
||||
CHECK (tier IN ('free', 'registered', 'partner', 'internal'));
|
||||
|
||||
CREATE TABLE IF NOT EXISTS app_user (
|
||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||
email TEXT NOT NULL,
|
||||
password_hash TEXT NOT NULL,
|
||||
api_key_id UUID REFERENCES api_key (id) ON DELETE SET NULL,
|
||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||
);
|
||||
|
||||
-- Case-insensitive uniqueness so each email registers at most once.
|
||||
CREATE UNIQUE INDEX IF NOT EXISTS idx_app_user_email ON app_user (lower(email));
|
||||
@@ -0,0 +1,2 @@
|
||||
DROP INDEX IF EXISTS idx_product_active_category;
|
||||
DROP INDEX IF EXISTS idx_product_active_quality;
|
||||
@@ -0,0 +1,15 @@
|
||||
-- 检索优化(可扩展性路线图 阶段0):为最常见的"浏览"路径补部分/复合索引。
|
||||
-- 搜索查询恒带 WHERE status = 'active';无关键词时按 quality_score DESC, name 排序。
|
||||
-- 现有索引无法同时满足"过滤 active + 按 quality_score/name 排序",深翻页时需要对全部
|
||||
-- active 行排序。下面的部分复合索引让规划器直接走索引顺序扫描,省掉排序、加速深翻页与
|
||||
-- count(*)。索引只覆盖 active 行,体积更小。
|
||||
|
||||
-- 默认浏览(无关键词、无品类):ORDER BY quality_score DESC, name
|
||||
CREATE INDEX IF NOT EXISTS idx_product_active_quality
|
||||
ON product (quality_score DESC, name)
|
||||
WHERE status = 'active';
|
||||
|
||||
-- 品类内浏览:先按 category_id 收敛,再按 quality_score 排序
|
||||
CREATE INDEX IF NOT EXISTS idx_product_active_category
|
||||
ON product (category_id, quality_score DESC)
|
||||
WHERE status = 'active';
|
||||
@@ -0,0 +1,8 @@
|
||||
-- Reverse 0013: detach products from the seeded drug categories, drop the drug
|
||||
-- category subtree, and remove the drug field template.
|
||||
UPDATE product SET category_id = NULL
|
||||
WHERE category_id IN (SELECT id FROM category WHERE path <@ 'drug');
|
||||
|
||||
DELETE FROM category WHERE path <@ 'drug';
|
||||
|
||||
DELETE FROM kind_field WHERE kind = 'drug';
|
||||
@@ -0,0 +1,43 @@
|
||||
-- Drug (药品) archive kind: a new domain on the generic archive_kind framework
|
||||
-- (see 0010). No new table — drug spec values live in product.attributes JSONB,
|
||||
-- driven by the kind_field template below, plus a 'drug' category subtree.
|
||||
|
||||
-- Field template for the drug domain. field_type is constrained to
|
||||
-- text/number/textarea/select/list by kind_field_type_chk. The `qualified`
|
||||
-- fields are the identifying / regulatory essentials that count toward the
|
||||
-- kind-aware completeness score.
|
||||
INSERT INTO kind_field (kind, field_key, group_label, label_zh, field_type, unit, options, sort_order, qualified) VALUES
|
||||
('drug','approval_number', '基础信息','批准文号', 'text', NULL, '{}', 10, true),
|
||||
('drug','generic_name', '基础信息','通用名', 'text', NULL, '{}', 20, true),
|
||||
('drug','trade_name', '基础信息','商品名', 'text', NULL, '{}', 30, false),
|
||||
('drug','dosage_form', '基础信息','剂型', 'select', NULL, '{片剂,胶囊剂,颗粒剂,散剂,丸剂,注射剂,口服液,糖浆剂,软膏剂,乳膏剂,凝胶剂,滴剂,喷雾剂,气雾剂,栓剂,贴剂,其他}', 40, true),
|
||||
('drug','specification', '基础信息','规格', 'text', NULL, '{}', 50, true),
|
||||
('drug','pack_spec', '基础信息','包装规格', 'text', NULL, '{}', 60, false),
|
||||
('drug','rx_class', '分类与企业','处方分类', 'select', NULL, '{处方药,甲类OTC,乙类OTC}', 70, true),
|
||||
('drug','manufacturer', '分类与企业','生产企业', 'text', NULL, '{}', 80, true),
|
||||
('drug','mah', '分类与企业','上市许可持有人','text', NULL, '{}', 90, false),
|
||||
('drug','indications', '说明书','适应症/功能主治', 'textarea', NULL, '{}', 100, true),
|
||||
('drug','dosage_usage', '说明书','用法用量', 'textarea', NULL, '{}', 110, false),
|
||||
('drug','adverse_reactions', '说明书','不良反应', 'textarea', NULL, '{}', 120, false),
|
||||
('drug','contraindications', '说明书','禁忌', 'textarea', NULL, '{}', 130, false),
|
||||
('drug','precautions', '说明书','注意事项', 'textarea', NULL, '{}', 140, false),
|
||||
('drug','interactions', '说明书','药物相互作用', 'textarea', NULL, '{}', 150, false),
|
||||
('drug','storage', '贮藏与有效期','贮藏', 'text', NULL, '{}', 160, false),
|
||||
('drug','shelf_life', '贮藏与有效期','有效期', 'text', NULL, '{}', 170, false),
|
||||
('drug','spec_source', '贮藏与有效期','说明书来源', 'text', NULL, '{}', 180, false);
|
||||
|
||||
-- Drug category tree. ltree labels are English slugs (no spaces/Chinese);
|
||||
-- Chinese names live in category.name_zh.
|
||||
INSERT INTO category (name_zh, name_en, parent_id, path, level, archive_kind)
|
||||
VALUES ('药品', 'Drug', NULL, 'drug', 0, 'drug');
|
||||
|
||||
INSERT INTO category (name_zh, name_en, parent_id, path, level, archive_kind)
|
||||
SELECT v.name_zh, v.name_en, c.id, v.path::ltree, 1, 'drug'
|
||||
FROM (VALUES
|
||||
('化学药品', 'Chemical drug', 'drug.chemical'),
|
||||
('中成药', 'Chinese patent medicine', 'drug.tcm_patent'),
|
||||
('中药饮片', 'Chinese herbal pieces', 'drug.tcm_herb'),
|
||||
('生物制品', 'Biological product', 'drug.biological'),
|
||||
('疫苗', 'Vaccine', 'drug.vaccine')
|
||||
) AS v(name_zh, name_en, path)
|
||||
JOIN category c ON c.path = 'drug';
|
||||
@@ -3,7 +3,18 @@
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>天工商品档案公共仓</title>
|
||||
<meta name="theme-color" content="#059669" />
|
||||
<meta
|
||||
name="description"
|
||||
content="天工商品档案公共仓——公益、开放、可溯源的商品事实查询与开放 API。"
|
||||
/>
|
||||
<title>天工 · 商品档案公共仓</title>
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
<link
|
||||
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&display=swap"
|
||||
rel="stylesheet"
|
||||
/>
|
||||
</head>
|
||||
<body>
|
||||
<div id="root"></div>
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
9ef4c7d0ea804c11bc637f4e82198e98af908894
|
||||
+86
-44
@@ -1,65 +1,86 @@
|
||||
import { useState } from "react";
|
||||
import { Boxes, Search, PlusCircle, Code2 } from "lucide-react";
|
||||
import { useEffect, useState } from "react";
|
||||
import { Boxes, Search, PlusCircle, Code2, KeyRound, Headset } from "lucide-react";
|
||||
import Home from "./components/Home";
|
||||
import ProductView from "./components/ProductView";
|
||||
import Contribute from "./components/Contribute";
|
||||
import ApiDocs from "./components/ApiDocs";
|
||||
import Account from "./components/Account";
|
||||
import Contact from "./components/Contact";
|
||||
import { api } from "./api";
|
||||
|
||||
type View =
|
||||
| { name: "home" }
|
||||
| { name: "product"; id: string }
|
||||
| { name: "contribute" }
|
||||
| { name: "api" };
|
||||
| { name: "api" }
|
||||
| { name: "account" }
|
||||
| { name: "contact" };
|
||||
|
||||
const NAV: { key: View["name"]; label: string; icon: typeof Search }[] = [
|
||||
{ key: "home", label: "检索", icon: Search },
|
||||
{ key: "contribute", label: "贡献档案", icon: PlusCircle },
|
||||
{ key: "api", label: "API", icon: Code2 },
|
||||
{ key: "account", label: "API 密钥", icon: KeyRound },
|
||||
{ key: "contact", label: "联系我们", icon: Headset },
|
||||
];
|
||||
|
||||
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">
|
||||
<header className="bg-white border-b">
|
||||
<div className="max-w-5xl mx-auto px-4 h-14 flex items-center justify-between">
|
||||
<header className="sticky top-0 z-30 border-b border-gray-200/70 bg-white/80 backdrop-blur-md">
|
||||
<div className="max-w-5xl mx-auto px-4 h-16 flex items-center justify-between gap-4">
|
||||
<button
|
||||
className="flex items-center gap-2 font-semibold text-gray-800"
|
||||
className="flex items-center gap-2.5 font-semibold text-gray-800 group"
|
||||
onClick={() => setView({ name: "home" })}
|
||||
>
|
||||
<Boxes className="w-6 h-6 text-emerald-600" />
|
||||
天工<span className="text-gray-400 font-normal text-sm">商品档案公共仓</span>
|
||||
<span className="grid h-9 w-9 place-items-center rounded-xl bg-gradient-to-br from-brand-500 to-brand-700 text-white shadow-glow transition group-hover:scale-105">
|
||||
<Boxes className="w-5 h-5" />
|
||||
</span>
|
||||
<span className="flex items-baseline gap-1.5">
|
||||
<span className="text-lg tracking-tight">天工</span>
|
||||
<span className="hidden sm:inline text-gray-400 font-normal text-xs">
|
||||
商品档案公共仓
|
||||
</span>
|
||||
</span>
|
||||
</button>
|
||||
<nav className="flex items-center gap-1 text-sm">
|
||||
<button
|
||||
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${
|
||||
view.name === "home" ? "bg-emerald-50 text-emerald-700" : "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
onClick={() => setView({ name: "home" })}
|
||||
>
|
||||
<Search className="w-4 h-4" /> 检索
|
||||
</button>
|
||||
<button
|
||||
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${
|
||||
view.name === "contribute" ? "bg-emerald-50 text-emerald-700" : "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
onClick={() => setView({ name: "contribute" })}
|
||||
>
|
||||
<PlusCircle className="w-4 h-4" /> 贡献档案
|
||||
</button>
|
||||
<button
|
||||
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${
|
||||
view.name === "api" ? "bg-emerald-50 text-emerald-700" : "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
onClick={() => setView({ name: "api" })}
|
||||
>
|
||||
<Code2 className="w-4 h-4" /> API
|
||||
</button>
|
||||
<nav className="flex items-center gap-0.5 text-sm">
|
||||
{NAV.map(({ key, label, icon: Icon }) => {
|
||||
const active =
|
||||
view.name === key || (key === "home" && view.name === "product");
|
||||
return (
|
||||
<button
|
||||
key={key}
|
||||
className={`px-3 py-1.5 rounded-lg flex items-center gap-1.5 font-medium transition ${
|
||||
active
|
||||
? "bg-brand-50 text-brand-700"
|
||||
: "text-gray-600 hover:bg-gray-100"
|
||||
}`}
|
||||
onClick={() => setView({ name: key } as View)}
|
||||
>
|
||||
<Icon className="w-4 h-4" />
|
||||
<span className="hidden sm:inline">{label}</span>
|
||||
</button>
|
||||
);
|
||||
})}
|
||||
</nav>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main className="flex-1 max-w-5xl w-full mx-auto px-4 py-6">
|
||||
<main className="flex-1 max-w-5xl w-full mx-auto px-4 py-8">
|
||||
{view.name === "home" && (
|
||||
<Home
|
||||
onOpen={(id) => setView({ name: "product", id })}
|
||||
onContribute={() => setView({ name: "contribute" })}
|
||||
onApi={() => setView({ name: "api" })}
|
||||
/>
|
||||
)}
|
||||
{view.name === "product" && (
|
||||
@@ -68,17 +89,38 @@ export default function App() {
|
||||
{view.name === "contribute" && (
|
||||
<Contribute onDone={() => setView({ name: "home" })} />
|
||||
)}
|
||||
{view.name === "api" && <ApiDocs />}
|
||||
{view.name === "api" && <ApiDocs onRegister={() => setView({ name: "account" })} />}
|
||||
{view.name === "account" && <Account />}
|
||||
{view.name === "contact" && <Contact />}
|
||||
</main>
|
||||
|
||||
<footer className="border-t bg-white">
|
||||
<div className="max-w-5xl mx-auto px-4 py-4 text-xs text-gray-400 leading-relaxed">
|
||||
天工商品档案公共仓 是公益性「商品事实库」,仅收录客观商品信息(条码、品牌、品类、营养、官方建议零售价快照等),不含任何购买/交易功能。
|
||||
公众投稿须经人工审核后方可收纳。
|
||||
<button onClick={() => setView({ name: "api" })} className="ml-1 text-emerald-600 hover:underline">
|
||||
API 调用说明
|
||||
</button>
|
||||
<div className="mt-2">
|
||||
<footer className="border-t border-gray-200/70 bg-white/60">
|
||||
<div className="max-w-5xl mx-auto px-4 py-6 text-xs text-gray-400 leading-relaxed text-center">
|
||||
{qualified != null && (
|
||||
<div className="mb-3 inline-flex items-center gap-1.5 rounded-full border border-brand-100 bg-brand-50 px-3 py-1 text-gray-500">
|
||||
已收录
|
||||
<span className="font-semibold text-brand-600">
|
||||
{qualified.toLocaleString()}
|
||||
</span>
|
||||
条合格商品档案
|
||||
</div>
|
||||
)}
|
||||
<p className="max-w-2xl mx-auto">
|
||||
天工是一个公益性商品档案库,主要收录商品名称、条码、品类、配料等官方快照,不涉及任何交易行为。
|
||||
<button
|
||||
onClick={() => setView({ name: "api" })}
|
||||
className="ml-1 text-brand-600 font-medium hover:underline"
|
||||
>
|
||||
API 调用说明
|
||||
</button>
|
||||
<button
|
||||
onClick={() => setView({ name: "contact" })}
|
||||
className="ml-1 text-brand-600 font-medium hover:underline"
|
||||
>
|
||||
联系我们
|
||||
</button>
|
||||
</p>
|
||||
<div className="mt-3">
|
||||
<a
|
||||
href="https://beian.miit.gov.cn/"
|
||||
target="_blank"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import type { Category, Product, ProductSummary, SubmissionInput } from "./types";
|
||||
import type { Category, KindField, Product, ProductSummary, SubmissionInput } from "./types";
|
||||
|
||||
async function req<T>(path: string, init?: RequestInit): Promise<T> {
|
||||
const res = await fetch(path, {
|
||||
@@ -25,16 +25,70 @@ export interface SearchResult {
|
||||
total: number;
|
||||
}
|
||||
|
||||
export interface SearchFilters {
|
||||
brand?: string;
|
||||
country?: string;
|
||||
}
|
||||
|
||||
export interface Stats {
|
||||
total: number;
|
||||
qualified: number;
|
||||
min_score: number;
|
||||
}
|
||||
|
||||
export interface KeyResponse {
|
||||
email: string;
|
||||
api_key: string;
|
||||
key_prefix: string;
|
||||
rate_limit_per_min: number;
|
||||
quota_total: number;
|
||||
}
|
||||
|
||||
export interface AccountInfo {
|
||||
email: string;
|
||||
key_prefix: string;
|
||||
rate_limit_per_min: number;
|
||||
quota_total: number;
|
||||
quota_used: number;
|
||||
quota_remaining: 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`),
|
||||
kindFields: (kind: string) =>
|
||||
req<{ items: KindField[]; kind: string }>(
|
||||
`/api/v1/kind-fields?kind=${encodeURIComponent(kind)}`,
|
||||
),
|
||||
submit: (input: SubmissionInput) =>
|
||||
req<{ id: string; status: string }>(`/api/public/submissions`, {
|
||||
method: "POST",
|
||||
body: JSON.stringify(input),
|
||||
}),
|
||||
register: (email: string, password: string) =>
|
||||
req<KeyResponse>(`/api/v1/register`, {
|
||||
method: "POST",
|
||||
body: JSON.stringify({ email, password }),
|
||||
}),
|
||||
account: (email: string, password: string) =>
|
||||
req<AccountInfo>(`/api/v1/account`, {
|
||||
method: "POST",
|
||||
body: JSON.stringify({ email, password }),
|
||||
}),
|
||||
regenerate: (email: string, password: string) =>
|
||||
req<KeyResponse>(`/api/v1/account/regenerate`, {
|
||||
method: "POST",
|
||||
body: JSON.stringify({ email, password }),
|
||||
}),
|
||||
};
|
||||
|
||||
@@ -0,0 +1,192 @@
|
||||
import { useState } from "react";
|
||||
import { Check, Copy, KeyRound, AlertTriangle } from "lucide-react";
|
||||
import { api, type AccountInfo, type KeyResponse } from "../api";
|
||||
|
||||
function KeyReveal({ data }: { data: KeyResponse }) {
|
||||
const [copied, setCopied] = useState(false);
|
||||
return (
|
||||
<div className="mt-4 rounded-lg border border-brand-100 bg-brand-50 p-4">
|
||||
<div className="flex items-start gap-2 text-amber-700 text-sm">
|
||||
<AlertTriangle className="w-4 h-4 mt-0.5 shrink-0" />
|
||||
<span>请立即复制保存此密钥,它只显示这一次,无法再次查看。</span>
|
||||
</div>
|
||||
<div className="mt-3 flex items-center gap-2">
|
||||
<code className="flex-1 break-all bg-white border rounded-md px-3 py-2 text-sm font-mono text-gray-800">
|
||||
{data.api_key}
|
||||
</code>
|
||||
<button
|
||||
onClick={async () => {
|
||||
try {
|
||||
await navigator.clipboard.writeText(data.api_key);
|
||||
setCopied(true);
|
||||
setTimeout(() => setCopied(false), 1200);
|
||||
} catch {
|
||||
/* clipboard unavailable */
|
||||
}
|
||||
}}
|
||||
className="text-gray-400 hover:text-gray-600 shrink-0"
|
||||
title="复制"
|
||||
>
|
||||
{copied ? <Check className="w-5 h-5 text-brand-600" /> : <Copy className="w-5 h-5" />}
|
||||
</button>
|
||||
</div>
|
||||
<div className="mt-3 text-sm text-gray-600">
|
||||
配额:每分钟 <strong>{data.rate_limit_per_min}</strong> 次 · 累计{" "}
|
||||
<strong>{data.quota_total.toLocaleString()}</strong> 次
|
||||
</div>
|
||||
<div className="mt-2 text-xs text-gray-500">
|
||||
调用时通过请求头携带:
|
||||
<code className="font-mono">X-API-Key: {data.api_key.slice(0, 12)}…</code>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export default function Account() {
|
||||
const [mode, setMode] = useState<"register" | "manage">("register");
|
||||
const [email, setEmail] = useState("");
|
||||
const [password, setPassword] = useState("");
|
||||
const [loading, setLoading] = useState(false);
|
||||
const [error, setError] = useState<string | null>(null);
|
||||
const [issued, setIssued] = useState<KeyResponse | null>(null);
|
||||
const [info, setInfo] = useState<AccountInfo | null>(null);
|
||||
|
||||
const reset = () => {
|
||||
setError(null);
|
||||
setIssued(null);
|
||||
setInfo(null);
|
||||
};
|
||||
|
||||
async function submit(e: React.FormEvent) {
|
||||
e.preventDefault();
|
||||
reset();
|
||||
if (password.length < 8) {
|
||||
setError("密码至少需要 8 位");
|
||||
return;
|
||||
}
|
||||
setLoading(true);
|
||||
try {
|
||||
if (mode === "register") {
|
||||
setIssued(await api.register(email, password));
|
||||
} else {
|
||||
setInfo(await api.account(email, password));
|
||||
}
|
||||
} catch (err) {
|
||||
setError(err instanceof Error ? err.message : "操作失败");
|
||||
} finally {
|
||||
setLoading(false);
|
||||
}
|
||||
}
|
||||
|
||||
async function regenerate() {
|
||||
reset();
|
||||
setLoading(true);
|
||||
try {
|
||||
setIssued(await api.regenerate(email, password));
|
||||
} catch (err) {
|
||||
setError(err instanceof Error ? err.message : "操作失败");
|
||||
} finally {
|
||||
setLoading(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="max-w-xl mx-auto space-y-5">
|
||||
<div className="card p-5">
|
||||
<h1 className="flex items-center gap-2 text-2xl font-bold text-gray-800">
|
||||
<KeyRound className="w-6 h-6 text-brand-600" /> API 密钥
|
||||
</h1>
|
||||
<p className="mt-2 text-sm text-gray-600 leading-relaxed">
|
||||
匿名调用免费,但每个来源 IP 累计共 <strong>1000</strong> 次。注册一个账号即可自助领取专属 API
|
||||
密钥,获得更高的每分钟频率与累计调用配额。
|
||||
</p>
|
||||
|
||||
<div className="mt-4 inline-flex rounded-md border bg-gray-50 p-0.5 text-sm">
|
||||
<button
|
||||
className={`px-4 py-1.5 rounded ${
|
||||
mode === "register" ? "bg-white shadow-sm text-brand-700" : "text-gray-500"
|
||||
}`}
|
||||
onClick={() => {
|
||||
setMode("register");
|
||||
reset();
|
||||
}}
|
||||
>
|
||||
注册领取
|
||||
</button>
|
||||
<button
|
||||
className={`px-4 py-1.5 rounded ${
|
||||
mode === "manage" ? "bg-white shadow-sm text-brand-700" : "text-gray-500"
|
||||
}`}
|
||||
onClick={() => {
|
||||
setMode("manage");
|
||||
reset();
|
||||
}}
|
||||
>
|
||||
查看 / 重置
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<form onSubmit={submit} className="mt-4 space-y-3">
|
||||
<div>
|
||||
<label className="block text-sm text-gray-600 mb-1">邮箱</label>
|
||||
<input
|
||||
type="email"
|
||||
required
|
||||
value={email}
|
||||
onChange={(e) => setEmail(e.target.value)}
|
||||
placeholder="you@example.com"
|
||||
className="w-full border rounded-md px-3 py-2 text-sm focus:outline-none focus:ring-2 focus:ring-brand-500"
|
||||
/>
|
||||
</div>
|
||||
<div>
|
||||
<label className="block text-sm text-gray-600 mb-1">密码(至少 8 位)</label>
|
||||
<input
|
||||
type="password"
|
||||
required
|
||||
value={password}
|
||||
onChange={(e) => setPassword(e.target.value)}
|
||||
placeholder="••••••••"
|
||||
className="w-full border rounded-md px-3 py-2 text-sm focus:outline-none focus:ring-2 focus:ring-brand-500"
|
||||
/>
|
||||
</div>
|
||||
{error && <div className="text-sm text-red-600">{error}</div>}
|
||||
<button
|
||||
type="submit"
|
||||
disabled={loading}
|
||||
className="w-full bg-brand-600 text-white rounded-md py-2 text-sm font-medium hover:bg-brand-700 disabled:opacity-50"
|
||||
>
|
||||
{loading ? "处理中…" : mode === "register" ? "注册并领取密钥" : "查询账号"}
|
||||
</button>
|
||||
</form>
|
||||
|
||||
{issued && <KeyReveal data={issued} />}
|
||||
|
||||
{info && (
|
||||
<div className="mt-4 rounded-lg border bg-gray-50 p-4 text-sm text-gray-700 space-y-1.5">
|
||||
<div>
|
||||
邮箱:<span className="font-medium">{info.email}</span>
|
||||
</div>
|
||||
<div>
|
||||
密钥前缀:<code className="font-mono">{info.key_prefix}…</code>
|
||||
</div>
|
||||
<div>
|
||||
每分钟频率:<strong>{info.rate_limit_per_min}</strong> 次
|
||||
</div>
|
||||
<div>
|
||||
累计配额:已用 <strong>{info.quota_used.toLocaleString()}</strong> /{" "}
|
||||
{info.quota_total.toLocaleString()} 次(剩余{" "}
|
||||
<strong className="text-brand-600">{info.quota_remaining.toLocaleString()}</strong>)
|
||||
</div>
|
||||
<button
|
||||
onClick={regenerate}
|
||||
disabled={loading}
|
||||
className="mt-2 text-brand-600 hover:underline disabled:opacity-50"
|
||||
>
|
||||
忘记密钥?重置并生成新密钥
|
||||
</button>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -20,7 +20,7 @@ function CopyBtn({ text }: { text: string }) {
|
||||
className="text-gray-400 hover:text-gray-600"
|
||||
title="复制"
|
||||
>
|
||||
{done ? <Check className="w-4 h-4 text-emerald-600" /> : <Copy className="w-4 h-4" />}
|
||||
{done ? <Check className="w-4 h-4 text-brand-600" /> : <Copy className="w-4 h-4" />}
|
||||
</button>
|
||||
);
|
||||
}
|
||||
@@ -39,7 +39,7 @@ function Code({ children }: { children: string }) {
|
||||
}
|
||||
|
||||
function Method({ m }: { m: string }) {
|
||||
const color = m === "GET" ? "bg-sky-100 text-sky-700" : "bg-emerald-100 text-emerald-700";
|
||||
const color = m === "GET" ? "bg-sky-100 text-sky-700" : "bg-brand-100 text-brand-700";
|
||||
return <span className={`text-xs font-mono font-semibold rounded px-1.5 py-0.5 ${color}`}>{m}</span>;
|
||||
}
|
||||
|
||||
@@ -63,7 +63,7 @@ function Endpoint({
|
||||
response: string;
|
||||
}) {
|
||||
return (
|
||||
<div className="bg-white border rounded-lg p-5">
|
||||
<div className="card p-5">
|
||||
<div className="flex items-center gap-2 flex-wrap">
|
||||
<Method m={method} />
|
||||
<code className="text-sm text-gray-800 font-mono break-all">{path}</code>
|
||||
@@ -102,10 +102,10 @@ function Endpoint({
|
||||
);
|
||||
}
|
||||
|
||||
export default function ApiDocs() {
|
||||
export default function ApiDocs({ onRegister }: { onRegister?: () => void }) {
|
||||
return (
|
||||
<div className="space-y-5">
|
||||
<div className="bg-white border rounded-lg p-5">
|
||||
<div className="card p-5">
|
||||
<h1 className="text-2xl font-bold text-gray-800">API 调用说明</h1>
|
||||
<p className="mt-2 text-gray-600 text-sm leading-relaxed">
|
||||
天工商品档案公共仓提供<strong>公开、只读、免鉴权</strong>的商品事实 REST API,任何人都可直接调用,
|
||||
@@ -117,7 +117,11 @@ 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;匿名调用按来源 IP 累计共 <strong>1000</strong> 次,
|
||||
用满后需<button onClick={onRegister} className="text-brand-600 hover:underline">注册账号</button>
|
||||
领取更高配额密钥(见下文「鉴权与配额」)。
|
||||
</li>
|
||||
<li>
|
||||
分页参数 <code className="font-mono">page</code>(默认 1)、
|
||||
<code className="font-mono">size</code>(默认 20,最大 100)。
|
||||
@@ -131,6 +135,70 @@ export default function ApiDocs() {
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="card 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 计一个
|
||||
<strong>累计总配额(共 1000 次)</strong>,用满后返回
|
||||
<code className="font-mono">403</code>(错误码 <code className="font-mono">quota_exhausted</code>),
|
||||
需<button onClick={onRegister} className="text-brand-600 hover:underline">注册账号</button>
|
||||
自助领取更高配额的 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>频率限制与<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>
|
||||
<tr>
|
||||
<td className="pr-4 py-0.5 font-mono text-gray-700">X-Quota-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-Quota-Used</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-Quota-Remaining</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>);累计配额用尽返回
|
||||
<code className="font-mono">403</code>(错误码 <code className="font-mono">quota_exhausted</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 +232,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
|
||||
}`}
|
||||
@@ -270,6 +343,70 @@ export default function ApiDocs() {
|
||||
}`}
|
||||
/>
|
||||
|
||||
<Endpoint
|
||||
method="POST"
|
||||
path="/api/v1/register"
|
||||
title="注册账号并领取 API 密钥"
|
||||
desc="用邮箱 + 密码(至少 8 位)注册,自助领取一枚更高配额的 API 密钥。明文密钥只在本次响应返回一次,请妥善保存。"
|
||||
params={[
|
||||
{ name: "email", required: true, desc: "邮箱(唯一)" },
|
||||
{ name: "password", required: true, desc: "密码,至少 8 位" },
|
||||
]}
|
||||
example={`curl -X POST ${BASE}/register \\
|
||||
-H "Content-Type: application/json" \\
|
||||
-d '{"email":"you@example.com","password":"your-password"}'`}
|
||||
response={`{
|
||||
"email": "you@example.com",
|
||||
"api_key": "og_live_xxxxxxxxxxxx",
|
||||
"key_prefix": "og_live_xxxx",
|
||||
"rate_limit_per_min": 300,
|
||||
"quota_total": 100000
|
||||
}`}
|
||||
/>
|
||||
|
||||
<Endpoint
|
||||
method="POST"
|
||||
path="/api/v1/account"
|
||||
title="查看账号与配额用量"
|
||||
desc="用邮箱 + 密码查询当前密钥前缀、频率/累计配额上限及已用量(不返回明文密钥)。"
|
||||
params={[
|
||||
{ name: "email", required: true, desc: "注册邮箱" },
|
||||
{ name: "password", required: true, desc: "账号密码" },
|
||||
]}
|
||||
example={`curl -X POST ${BASE}/account \\
|
||||
-H "Content-Type: application/json" \\
|
||||
-d '{"email":"you@example.com","password":"your-password"}'`}
|
||||
response={`{
|
||||
"email": "you@example.com",
|
||||
"key_prefix": "og_live_xxxx",
|
||||
"rate_limit_per_min": 300,
|
||||
"quota_total": 100000,
|
||||
"quota_used": 1234,
|
||||
"quota_remaining": 98766
|
||||
}`}
|
||||
/>
|
||||
|
||||
<Endpoint
|
||||
method="POST"
|
||||
path="/api/v1/account/regenerate"
|
||||
title="重置 API 密钥"
|
||||
desc="吊销当前密钥并生成新密钥(累计用量会延续,不会因重置而清零)。明文新密钥只返回一次。"
|
||||
params={[
|
||||
{ name: "email", required: true, desc: "注册邮箱" },
|
||||
{ name: "password", required: true, desc: "账号密码" },
|
||||
]}
|
||||
example={`curl -X POST ${BASE}/account/regenerate \\
|
||||
-H "Content-Type: application/json" \\
|
||||
-d '{"email":"you@example.com","password":"your-password"}'`}
|
||||
response={`{
|
||||
"email": "you@example.com",
|
||||
"api_key": "og_live_yyyyyyyyyyyy",
|
||||
"key_prefix": "og_live_yyyy",
|
||||
"rate_limit_per_min": 300,
|
||||
"quota_total": 100000
|
||||
}`}
|
||||
/>
|
||||
|
||||
<div className="text-xs text-gray-400 leading-relaxed">
|
||||
数据可能存在误差或滞后,按「现状」提供,不构成医疗/购买建议。商品资料版权归各原始来源所有,
|
||||
请遵循其许可(如 OpenFoodFacts 的 ODbL)。
|
||||
|
||||
@@ -0,0 +1,113 @@
|
||||
import { useState } from "react";
|
||||
import { Phone, Mail, Globe, MessageSquare, Copy, Check, Headset } from "lucide-react";
|
||||
|
||||
type Channel = {
|
||||
key: string;
|
||||
icon: typeof Phone;
|
||||
label: string;
|
||||
value: string;
|
||||
href?: string;
|
||||
copy: string;
|
||||
};
|
||||
|
||||
const CHANNELS: Channel[] = [
|
||||
{
|
||||
key: "phone",
|
||||
icon: Phone,
|
||||
label: "电话",
|
||||
value: "188 6595 7520",
|
||||
href: "tel:18865957520",
|
||||
copy: "18865957520",
|
||||
},
|
||||
{
|
||||
key: "email",
|
||||
icon: Mail,
|
||||
label: "邮箱",
|
||||
value: "1115084741@qq.com",
|
||||
href: "mailto:1115084741@qq.com",
|
||||
copy: "1115084741@qq.com",
|
||||
},
|
||||
{
|
||||
key: "site",
|
||||
icon: Globe,
|
||||
label: "官网",
|
||||
value: "www.wenyaoyu.com",
|
||||
href: "https://www.wenyaoyu.com",
|
||||
copy: "https://www.wenyaoyu.com",
|
||||
},
|
||||
{
|
||||
key: "wechat",
|
||||
icon: MessageSquare,
|
||||
label: "微信",
|
||||
value: "s-b-m-y",
|
||||
copy: "s-b-m-y",
|
||||
},
|
||||
];
|
||||
|
||||
export default function Contact() {
|
||||
const [copied, setCopied] = useState<string | null>(null);
|
||||
|
||||
async function copy(channel: Channel) {
|
||||
try {
|
||||
await navigator.clipboard.writeText(channel.copy);
|
||||
setCopied(channel.key);
|
||||
setTimeout(() => setCopied((k) => (k === channel.key ? null : k)), 1500);
|
||||
} catch {
|
||||
/* clipboard unavailable */
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="max-w-3xl mx-auto animate-fade-up">
|
||||
<div className="text-center">
|
||||
<span className="mx-auto grid h-14 w-14 place-items-center rounded-2xl bg-gradient-to-br from-brand-500 to-brand-700 text-white shadow-glow">
|
||||
<Headset className="w-7 h-7" />
|
||||
</span>
|
||||
<h1 className="mt-4 text-2xl font-semibold tracking-tight text-gray-900">联系我们</h1>
|
||||
<p className="mx-auto mt-2 max-w-xl text-sm text-gray-500">
|
||||
欢迎交流与对接合作。无论是数据接入、商务合作还是问题反馈,都可以通过以下任一方式联系我们。
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div className="mt-8 grid grid-cols-1 sm:grid-cols-2 gap-4">
|
||||
{CHANNELS.map((c) => {
|
||||
const Icon = c.icon;
|
||||
return (
|
||||
<div key={c.key} className="card p-5 flex items-center gap-4">
|
||||
<span className="grid h-11 w-11 shrink-0 place-items-center rounded-xl bg-brand-50 text-brand-600">
|
||||
<Icon className="w-5 h-5" />
|
||||
</span>
|
||||
<div className="min-w-0 flex-1">
|
||||
<div className="text-xs font-medium text-gray-400">{c.label}</div>
|
||||
{c.href ? (
|
||||
<a
|
||||
href={c.href}
|
||||
target={c.key === "site" ? "_blank" : undefined}
|
||||
rel={c.key === "site" ? "noreferrer" : undefined}
|
||||
className="block truncate font-medium text-gray-800 hover:text-brand-600 hover:underline"
|
||||
>
|
||||
{c.value}
|
||||
</a>
|
||||
) : (
|
||||
<div className="truncate font-medium text-gray-800">{c.value}</div>
|
||||
)}
|
||||
</div>
|
||||
<button
|
||||
type="button"
|
||||
onClick={() => copy(c)}
|
||||
title="复制"
|
||||
className="shrink-0 grid h-9 w-9 place-items-center rounded-lg border border-gray-200 text-gray-400 transition hover:bg-gray-50 hover:text-brand-600"
|
||||
>
|
||||
{copied === c.key ? (
|
||||
<Check className="w-4 h-4 text-brand-600" />
|
||||
) : (
|
||||
<Copy className="w-4 h-4" />
|
||||
)}
|
||||
</button>
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { useEffect, useMemo, useState } from "react";
|
||||
import { CheckCircle2, PlusCircle, Trash2 } from "lucide-react";
|
||||
import { api } from "../api";
|
||||
import type { Category, SubmissionImage, SubmissionInput } from "../types";
|
||||
import type { Category, KindField, SubmissionImage, SubmissionInput } from "../types";
|
||||
|
||||
const NUTRI_FIELDS: { key: string; label: string }[] = [
|
||||
{ key: "energy_kcal", label: "能量 (kcal)" },
|
||||
@@ -35,6 +35,8 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
const [ingredients, setIngredients] = useState("");
|
||||
const [basis, setBasis] = useState("");
|
||||
const [nutri, setNutri] = useState<Record<string, string>>({});
|
||||
const [kindFields, setKindFields] = useState<KindField[]>([]);
|
||||
const [attrs, setAttrs] = useState<Record<string, string>>({});
|
||||
const [images, setImages] = useState<SubmissionImage[]>([]);
|
||||
const [imageURL, setImageURL] = useState("");
|
||||
const [submitter, setSubmitter] = useState("");
|
||||
@@ -45,6 +47,33 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
api.categories().then((r) => setCategories(r.items)).catch(() => undefined);
|
||||
}, []);
|
||||
|
||||
// Derive the archive kind from the selected category. No category => generic.
|
||||
const kind = useMemo(() => {
|
||||
const c = categories.find((x) => x.id === categoryID);
|
||||
return c?.archive_kind || "generic";
|
||||
}, [categories, categoryID]);
|
||||
|
||||
// Fetch the kind-specific field template for non-food kinds.
|
||||
useEffect(() => {
|
||||
setAttrs({});
|
||||
if (kind === "food" || kind === "generic") {
|
||||
setKindFields([]);
|
||||
return;
|
||||
}
|
||||
let alive = true;
|
||||
api
|
||||
.kindFields(kind)
|
||||
.then((r) => {
|
||||
if (alive) setKindFields(r.items);
|
||||
})
|
||||
.catch(() => {
|
||||
if (alive) setKindFields([]);
|
||||
});
|
||||
return () => {
|
||||
alive = false;
|
||||
};
|
||||
}, [kind]);
|
||||
|
||||
async function submit(e: React.FormEvent) {
|
||||
e.preventDefault();
|
||||
if (name.trim() === "") {
|
||||
@@ -55,9 +84,31 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
setError("");
|
||||
|
||||
const nutriments: Record<string, number> = {};
|
||||
for (const [k, v] of Object.entries(nutri)) {
|
||||
const n = parseFloat(v);
|
||||
if (!Number.isNaN(n)) nutriments[k] = n;
|
||||
if (kind === "food") {
|
||||
for (const [k, v] of Object.entries(nutri)) {
|
||||
const n = parseFloat(v);
|
||||
if (!Number.isNaN(n)) nutriments[k] = n;
|
||||
}
|
||||
}
|
||||
|
||||
const attributes: Record<string, unknown> = {};
|
||||
if (kind !== "food" && kind !== "generic") {
|
||||
for (const f of kindFields) {
|
||||
const raw = (attrs[f.field_key] || "").trim();
|
||||
if (raw === "") continue;
|
||||
if (f.field_type === "number") {
|
||||
const n = parseFloat(raw);
|
||||
if (!Number.isNaN(n)) attributes[f.field_key] = n;
|
||||
} else if (f.field_type === "list") {
|
||||
const parts = raw
|
||||
.split(/[\n,,、]/)
|
||||
.map((s) => s.trim())
|
||||
.filter((s) => s !== "");
|
||||
if (parts.length) attributes[f.field_key] = parts;
|
||||
} else {
|
||||
attributes[f.field_key] = raw;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const input: SubmissionInput = {
|
||||
@@ -68,9 +119,10 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
net_content_value: field(netValue) ? parseFloat(netValue) : null,
|
||||
net_content_unit: field(netUnit),
|
||||
country_of_origin: field(country),
|
||||
ingredients_text: field(ingredients),
|
||||
ingredients_text: kind === "food" ? field(ingredients) : null,
|
||||
nutriments: Object.keys(nutriments).length ? nutriments : null,
|
||||
nutrition_basis: basis || null,
|
||||
attributes: Object.keys(attributes).length ? attributes : null,
|
||||
nutrition_basis: kind === "food" && basis ? basis : null,
|
||||
images: images.length ? images : undefined,
|
||||
submitter_name: field(submitter),
|
||||
submitter_contact: field(contact),
|
||||
@@ -89,38 +141,91 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
|
||||
if (done) {
|
||||
return (
|
||||
<div className="max-w-xl mx-auto text-center py-16">
|
||||
<CheckCircle2 className="w-14 h-14 text-emerald-500 mx-auto" />
|
||||
<div className="max-w-xl mx-auto text-center py-16 animate-fade-up">
|
||||
<span className="mx-auto grid h-16 w-16 place-items-center rounded-2xl bg-brand-50">
|
||||
<CheckCircle2 className="w-9 h-9 text-brand-600" />
|
||||
</span>
|
||||
<h1 className="mt-4 text-xl font-semibold text-gray-800">已提交,等待审核</h1>
|
||||
<p className="mt-2 text-gray-500">
|
||||
感谢你的贡献!资料将由管理员人工审核,通过后会收录进公共商品库。
|
||||
</p>
|
||||
<button
|
||||
onClick={onDone}
|
||||
className="mt-6 px-5 py-2 rounded-lg bg-emerald-600 text-white hover:bg-emerald-700"
|
||||
>
|
||||
<button onClick={onDone} className="btn-primary mt-6">
|
||||
返回首页
|
||||
</button>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
const input =
|
||||
"w-full border rounded-md px-3 py-2 text-sm focus:outline-none focus:ring-2 focus:ring-emerald-400";
|
||||
const label = "block text-xs text-gray-500 mb-1";
|
||||
const input = "input";
|
||||
const label = "block text-xs font-medium text-gray-500 mb-1";
|
||||
|
||||
// Group the kind fields by their group label, preserving template order.
|
||||
const groups: { label: string; fields: KindField[] }[] = [];
|
||||
for (const f of kindFields) {
|
||||
let g = groups.find((x) => x.label === f.group_label);
|
||||
if (!g) {
|
||||
g = { label: f.group_label, fields: [] };
|
||||
groups.push(g);
|
||||
}
|
||||
g.fields.push(f);
|
||||
}
|
||||
|
||||
const KIND_LABEL: Record<string, string> = {
|
||||
drug: "药品",
|
||||
electronics: "数码 3C",
|
||||
food: "食品",
|
||||
generic: "通用",
|
||||
};
|
||||
|
||||
function renderField(f: KindField) {
|
||||
const val = attrs[f.field_key] || "";
|
||||
const set = (v: string) => setAttrs((p) => ({ ...p, [f.field_key]: v }));
|
||||
const lbl = f.unit ? `${f.label_zh} (${f.unit})` : f.label_zh;
|
||||
return (
|
||||
<div key={f.field_key} className={f.field_type === "textarea" || f.field_type === "list" ? "sm:col-span-2" : ""}>
|
||||
<label className={label}>
|
||||
{lbl}
|
||||
{f.qualified && <span className="text-brand-500"> *</span>}
|
||||
</label>
|
||||
{f.field_type === "select" ? (
|
||||
<select className={input} value={val} onChange={(e) => set(e.target.value)}>
|
||||
<option value="">(未选择)</option>
|
||||
{(f.options || []).map((o) => (
|
||||
<option key={o} value={o}>
|
||||
{o}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
) : f.field_type === "textarea" ? (
|
||||
<textarea className={input} rows={3} value={val} placeholder={f.placeholder || ""} onChange={(e) => set(e.target.value)} />
|
||||
) : f.field_type === "list" ? (
|
||||
<textarea className={input} rows={2} value={val} placeholder={f.placeholder || "每行一项,或用、逗号分隔"} onChange={(e) => set(e.target.value)} />
|
||||
) : (
|
||||
<input
|
||||
type={f.field_type === "number" ? "number" : "text"}
|
||||
step={f.field_type === "number" ? "any" : undefined}
|
||||
className={input}
|
||||
value={val}
|
||||
placeholder={f.placeholder || ""}
|
||||
onChange={(e) => set(e.target.value)}
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<form onSubmit={submit} className="max-w-3xl mx-auto">
|
||||
<h1 className="text-xl font-semibold text-gray-800">贡献商品档案</h1>
|
||||
<form onSubmit={submit} className="max-w-3xl mx-auto animate-fade-up">
|
||||
<h1 className="text-2xl font-semibold tracking-tight text-gray-900">贡献商品档案</h1>
|
||||
<p className="mt-1 text-sm text-gray-500">
|
||||
任何人都可以提交新商品资料。提交后会进入审核队列,<b>通过人工审核后才会收纳</b>。带 * 为必填。
|
||||
任何人都可以提交新商品资料。提交后会进入审核队列,<b>通过人工审核后才会收纳</b>。除商品名称外均为选填,按品类填写对应资料即可。
|
||||
</p>
|
||||
|
||||
{error && (
|
||||
<div className="mt-4 bg-red-50 text-red-700 text-sm rounded-md px-4 py-2">{error}</div>
|
||||
<div className="mt-4 rounded-xl bg-red-50 px-4 py-2.5 text-sm text-red-700">{error}</div>
|
||||
)}
|
||||
|
||||
<div className="bg-white border rounded-lg p-5 mt-4">
|
||||
<div className="card p-5 mt-4">
|
||||
<h2 className="font-medium text-gray-700 mb-3">基础信息</h2>
|
||||
<div className="grid grid-cols-1 sm:grid-cols-2 gap-4">
|
||||
<div className="sm:col-span-2">
|
||||
@@ -145,6 +250,11 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
{categoryID && (
|
||||
<p className="mt-1 text-xs text-gray-400">
|
||||
档案类型:{KIND_LABEL[kind] || kind}
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
<div>
|
||||
<label className={label}>产地</label>
|
||||
@@ -167,41 +277,58 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="bg-white border rounded-lg p-5 mt-4">
|
||||
<h2 className="font-medium text-gray-700 mb-3">配料与营养</h2>
|
||||
<label className={label}>配料表</label>
|
||||
<textarea
|
||||
className={input}
|
||||
rows={3}
|
||||
value={ingredients}
|
||||
onChange={(e) => setIngredients(e.target.value)}
|
||||
/>
|
||||
<div className="mt-3">
|
||||
<label className={label}>营养基准</label>
|
||||
<select className={input} value={basis} onChange={(e) => setBasis(e.target.value)}>
|
||||
<option value="">(未设置)</option>
|
||||
<option value="per_100g">每 100g</option>
|
||||
<option value="per_100ml">每 100ml</option>
|
||||
<option value="per_serving">每份</option>
|
||||
</select>
|
||||
{kind === "food" && (
|
||||
<div className="card p-5 mt-4">
|
||||
<h2 className="font-medium text-gray-700 mb-3">配料与营养</h2>
|
||||
<label className={label}>配料表</label>
|
||||
<textarea
|
||||
className={input}
|
||||
rows={3}
|
||||
value={ingredients}
|
||||
onChange={(e) => setIngredients(e.target.value)}
|
||||
/>
|
||||
<div className="mt-3">
|
||||
<label className={label}>营养基准</label>
|
||||
<select className={input} value={basis} onChange={(e) => setBasis(e.target.value)}>
|
||||
<option value="">(未设置)</option>
|
||||
<option value="per_100g">每 100g</option>
|
||||
<option value="per_100ml">每 100ml</option>
|
||||
<option value="per_serving">每份</option>
|
||||
</select>
|
||||
</div>
|
||||
<div className="grid grid-cols-2 sm:grid-cols-4 gap-3 mt-3">
|
||||
{NUTRI_FIELDS.map((f) => (
|
||||
<div key={f.key}>
|
||||
<label className={label}>{f.label}</label>
|
||||
<input
|
||||
type="number"
|
||||
step="any"
|
||||
className={input}
|
||||
value={nutri[f.key] || ""}
|
||||
onChange={(e) => setNutri({ ...nutri, [f.key]: e.target.value })}
|
||||
/>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
<div className="grid grid-cols-2 sm:grid-cols-4 gap-3 mt-3">
|
||||
{NUTRI_FIELDS.map((f) => (
|
||||
<div key={f.key}>
|
||||
<label className={label}>{f.label}</label>
|
||||
<input
|
||||
type="number"
|
||||
step="any"
|
||||
className={input}
|
||||
value={nutri[f.key] || ""}
|
||||
onChange={(e) => setNutri({ ...nutri, [f.key]: e.target.value })}
|
||||
/>
|
||||
)}
|
||||
|
||||
{kind !== "food" && kind !== "generic" && kindFields.length > 0 && (
|
||||
<div className="card p-5 mt-4">
|
||||
<h2 className="font-medium text-gray-700 mb-1">{KIND_LABEL[kind] || kind}资料</h2>
|
||||
<p className="text-xs text-gray-400 mb-3">带 * 为该品类的关键字段,建议尽量填写。</p>
|
||||
{groups.map((g) => (
|
||||
<div key={g.label} className="mt-3 first:mt-0">
|
||||
{g.label && <h3 className="text-xs font-semibold text-gray-400 mb-2">{g.label}</h3>}
|
||||
<div className="grid grid-cols-1 sm:grid-cols-2 gap-4">
|
||||
{g.fields.map(renderField)}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
<div className="bg-white border rounded-lg p-5 mt-4">
|
||||
<div className="card p-5 mt-4">
|
||||
<h2 className="font-medium text-gray-700 mb-3">图片(仅填 URL)</h2>
|
||||
{images.length > 0 && (
|
||||
<ul className="mb-3 space-y-1">
|
||||
@@ -234,14 +361,14 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
setImageURL("");
|
||||
}
|
||||
}}
|
||||
className="shrink-0 px-3 rounded-md border text-sm flex items-center gap-1 hover:bg-gray-50"
|
||||
className="shrink-0 px-3 rounded-xl border border-gray-200 text-sm flex items-center gap-1 hover:bg-gray-50"
|
||||
>
|
||||
<PlusCircle className="w-4 h-4" /> 添加
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="bg-white border rounded-lg p-5 mt-4">
|
||||
<div className="card p-5 mt-4">
|
||||
<h2 className="font-medium text-gray-700 mb-3">联系方式(选填)</h2>
|
||||
<div className="grid grid-cols-1 sm:grid-cols-2 gap-4">
|
||||
<div>
|
||||
@@ -260,11 +387,7 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
|
||||
</div>
|
||||
|
||||
<div className="mt-5 flex items-center gap-3">
|
||||
<button
|
||||
type="submit"
|
||||
disabled={submitting}
|
||||
className="px-6 py-2.5 rounded-lg bg-emerald-600 text-white font-medium hover:bg-emerald-700 disabled:opacity-60"
|
||||
>
|
||||
<button type="submit" disabled={submitting} className="btn-primary px-6">
|
||||
{submitting ? "提交中…" : "提交审核"}
|
||||
</button>
|
||||
<button type="button" onClick={onDone} className="text-sm text-gray-500 hover:underline">
|
||||
|
||||
@@ -1,16 +1,34 @@
|
||||
import { useState } from "react";
|
||||
import { Search, PlusCircle, Code2 } from "lucide-react";
|
||||
import { Search, PlusCircle, Code2, ScanBarcode, ShieldCheck, ArrowRight } from "lucide-react";
|
||||
import { api } from "../api";
|
||||
import type { ProductSummary } from "../types";
|
||||
|
||||
const EXAMPLES = ["可乐", "Nutella", "牛奶", "5449000000996"];
|
||||
|
||||
const FEATURES = [
|
||||
{
|
||||
icon: Search,
|
||||
title: "客观可查",
|
||||
desc: "按名称或条码检索商品的成分、营养、规格等官方事实。",
|
||||
},
|
||||
{
|
||||
icon: ShieldCheck,
|
||||
title: "可溯源",
|
||||
desc: "每条资料标注数据来源与质量分,公开透明、人人可核。",
|
||||
},
|
||||
{
|
||||
icon: Code2,
|
||||
title: "开放 API",
|
||||
desc: "免鉴权只读 REST 接口,开发者可直接接入商品档案。",
|
||||
},
|
||||
];
|
||||
|
||||
export default function Home({
|
||||
onOpen,
|
||||
onContribute,
|
||||
onApi,
|
||||
}: {
|
||||
onOpen: (id: string) => void;
|
||||
onContribute: () => void;
|
||||
onApi: () => void;
|
||||
}) {
|
||||
const [q, setQ] = useState("");
|
||||
const [items, setItems] = useState<ProductSummary[]>([]);
|
||||
@@ -19,12 +37,14 @@ export default function Home({
|
||||
const [loading, setLoading] = useState(false);
|
||||
const [error, setError] = useState("");
|
||||
|
||||
async function run(e?: React.FormEvent) {
|
||||
async function run(term?: string, e?: React.FormEvent) {
|
||||
e?.preventDefault();
|
||||
const keyword = (term ?? q).trim();
|
||||
if (term !== undefined) setQ(term);
|
||||
setLoading(true);
|
||||
setError("");
|
||||
try {
|
||||
const res = await api.search(q.trim(), 1, 30);
|
||||
const res = await api.search(keyword, 1, 30);
|
||||
setItems(res.items);
|
||||
setTotal(res.total);
|
||||
setSearched(true);
|
||||
@@ -36,82 +56,116 @@ export default function Home({
|
||||
}
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div className="text-center py-10">
|
||||
<h1 className="text-3xl font-bold text-gray-800">天工商品档案公共仓</h1>
|
||||
<p className="mt-2 text-gray-500">
|
||||
输入商品名称或条码,检索客观、可溯源的商品资料。人人可查,人人可贡献。
|
||||
</p>
|
||||
<form onSubmit={run} className="mt-6 max-w-2xl mx-auto flex gap-2">
|
||||
<div className="flex-1 flex items-center gap-2 bg-white border rounded-lg px-3 shadow-sm focus-within:ring-2 focus-within:ring-emerald-400">
|
||||
<Search className="w-5 h-5 text-gray-400" />
|
||||
<input
|
||||
autoFocus
|
||||
value={q}
|
||||
onChange={(e) => setQ(e.target.value)}
|
||||
placeholder="例如:可乐、Nutella、5449000000996"
|
||||
className="flex-1 py-3 outline-none bg-transparent"
|
||||
/>
|
||||
<div className="animate-fade-up">
|
||||
<section className="relative overflow-hidden rounded-3xl border border-gray-100 bg-gradient-to-b from-white to-brand-50/40 px-6 py-14 text-center shadow-card">
|
||||
<div
|
||||
aria-hidden
|
||||
className="pointer-events-none absolute -top-24 left-1/2 h-72 w-[42rem] -translate-x-1/2 rounded-full bg-brand-200/30 blur-3xl"
|
||||
/>
|
||||
<div className="relative">
|
||||
<span className="inline-flex items-center gap-1.5 rounded-full border border-brand-200 bg-white/70 px-3 py-1 text-xs font-medium text-brand-700">
|
||||
<ShieldCheck className="w-3.5 h-3.5" /> 公益 · 开放 · 可溯源
|
||||
</span>
|
||||
<h1 className="mt-5 text-4xl sm:text-5xl font-extrabold tracking-tight text-gray-900">
|
||||
天<span className="bg-gradient-to-r from-brand-600 to-emerald-500 bg-clip-text text-transparent">工</span>
|
||||
</h1>
|
||||
<p className="mx-auto mt-3 max-w-xl text-gray-500">
|
||||
输入商品名称或条码,检索客观、可溯源的商品资料。人人可查,人人可贡献。
|
||||
</p>
|
||||
|
||||
<form onSubmit={(e) => run(undefined, e)} className="mx-auto mt-7 flex max-w-2xl gap-2">
|
||||
<div className="flex flex-1 items-center gap-2 rounded-xl border border-gray-200 bg-white px-3.5 shadow-sm transition focus-within:border-brand-400 focus-within:ring-4 focus-within:ring-brand-500/10">
|
||||
<Search className="h-5 w-5 shrink-0 text-gray-400" />
|
||||
<input
|
||||
autoFocus
|
||||
value={q}
|
||||
onChange={(e) => setQ(e.target.value)}
|
||||
placeholder="例如:可乐、Nutella、5449000000996"
|
||||
className="flex-1 bg-transparent py-3.5 outline-none"
|
||||
/>
|
||||
</div>
|
||||
<button type="submit" disabled={loading} className="btn-primary px-7">
|
||||
{loading ? "检索中…" : "检索"}
|
||||
</button>
|
||||
</form>
|
||||
|
||||
<div className="mt-4 flex flex-wrap items-center justify-center gap-2">
|
||||
<span className="text-xs text-gray-400">试试:</span>
|
||||
{EXAMPLES.map((ex) => (
|
||||
<button key={ex} type="button" className="chip" onClick={() => run(ex)}>
|
||||
<ScanBarcode className="w-3 h-3" /> {ex}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
<button
|
||||
type="submit"
|
||||
disabled={loading}
|
||||
className="px-6 rounded-lg bg-emerald-600 text-white font-medium hover:bg-emerald-700 disabled:opacity-60"
|
||||
>
|
||||
{loading ? "检索中…" : "检索"}
|
||||
</button>
|
||||
</form>
|
||||
<button
|
||||
onClick={onApi}
|
||||
className="mt-4 inline-flex items-center gap-1.5 text-sm text-emerald-700 hover:underline"
|
||||
>
|
||||
<Code2 className="w-4 h-4" /> 开发者?查看 API 调用说明,免鉴权接入商品档案
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{error && (
|
||||
<div className="max-w-2xl mx-auto bg-red-50 text-red-700 text-sm rounded-md px-4 py-2">
|
||||
<div className="mx-auto mt-6 max-w-2xl rounded-xl bg-red-50 px-4 py-2.5 text-sm text-red-700">
|
||||
{error}
|
||||
</div>
|
||||
)}
|
||||
|
||||
{searched && (
|
||||
<div className="mt-2">
|
||||
<div className="text-sm text-gray-500 mb-2">
|
||||
共 {total} 条结果{q ? `(关键词:${q})` : ""}
|
||||
{searched ? (
|
||||
<div className="mt-8">
|
||||
<div className="mb-3 text-sm text-gray-500">
|
||||
共 <span className="font-semibold text-gray-700">{total}</span> 条结果
|
||||
{q ? `(关键词:${q})` : ""}
|
||||
</div>
|
||||
{items.length === 0 ? (
|
||||
<div className="bg-white border rounded-lg p-8 text-center text-gray-500">
|
||||
<div className="card p-10 text-center text-gray-500">
|
||||
<p>没有找到相关商品。</p>
|
||||
<button
|
||||
onClick={onContribute}
|
||||
className="mt-3 inline-flex items-center gap-1.5 text-emerald-700 hover:underline"
|
||||
className="mt-3 inline-flex items-center gap-1.5 font-medium text-brand-700 hover:underline"
|
||||
>
|
||||
<PlusCircle className="w-4 h-4" /> 你知道这个商品?去贡献档案
|
||||
</button>
|
||||
</div>
|
||||
) : (
|
||||
<ul className="bg-white border rounded-lg divide-y">
|
||||
<ul className="card divide-y divide-gray-100 overflow-hidden">
|
||||
{items.map((p) => (
|
||||
<li key={p.id}>
|
||||
<button
|
||||
onClick={() => onOpen(p.id)}
|
||||
className="w-full text-left px-4 py-3 hover:bg-gray-50 flex items-center justify-between gap-4"
|
||||
className="group flex w-full items-center justify-between gap-4 px-4 py-3.5 text-left transition hover:bg-brand-50/50"
|
||||
>
|
||||
<div>
|
||||
<div className="font-medium text-gray-800">{p.name}</div>
|
||||
<div className="text-xs text-gray-500 mt-0.5">
|
||||
<div className="min-w-0">
|
||||
<div className="truncate font-medium text-gray-800 group-hover:text-brand-700">
|
||||
{p.name}
|
||||
</div>
|
||||
<div className="mt-0.5 text-xs text-gray-500">
|
||||
{p.brand || "未知品牌"}
|
||||
{p.gtin ? ` · ${p.gtin}` : ""}
|
||||
</div>
|
||||
</div>
|
||||
<span className="text-xs text-gray-400">{p.category_path || ""}</span>
|
||||
<div className="flex shrink-0 items-center gap-3">
|
||||
<span className="text-right text-xs text-gray-400">
|
||||
<span className="block">{p.category_path || ""}</span>
|
||||
{p.country_of_origin ? (
|
||||
<span className="block">产地:{p.country_of_origin}</span>
|
||||
) : null}
|
||||
</span>
|
||||
<ArrowRight className="h-4 w-4 text-gray-300 transition group-hover:translate-x-0.5 group-hover:text-brand-500" />
|
||||
</div>
|
||||
</button>
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
)}
|
||||
</div>
|
||||
) : (
|
||||
<div className="mt-8 grid gap-4 sm:grid-cols-3">
|
||||
{FEATURES.map(({ icon: Icon, title, desc }) => (
|
||||
<div key={title} className="card p-5 transition hover:shadow-card-hover">
|
||||
<span className="grid h-10 w-10 place-items-center rounded-xl bg-brand-50 text-brand-600">
|
||||
<Icon className="h-5 w-5" />
|
||||
</span>
|
||||
<h3 className="mt-3 font-semibold text-gray-800">{title}</h3>
|
||||
<p className="mt-1 text-sm leading-relaxed text-gray-500">{desc}</p>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
|
||||
@@ -28,11 +28,11 @@ export default function ProductView({ id, onBack }: { id: string; onBack: () =>
|
||||
<button onClick={onBack} className="text-sm text-gray-500 flex items-center gap-1 mb-4">
|
||||
<ArrowLeft className="w-4 h-4" /> 返回
|
||||
</button>
|
||||
<div className="bg-red-50 text-red-700 text-sm rounded-md px-4 py-3">{error}</div>
|
||||
<div className="rounded-xl bg-red-50 px-4 py-3 text-sm text-red-700">{error}</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
if (!p) return <div className="text-gray-400">加载中…</div>;
|
||||
if (!p) return <div className="text-gray-400 animate-pulse">加载中…</div>;
|
||||
|
||||
const basisLabel: Record<string, string> = {
|
||||
per_100g: "每 100g",
|
||||
@@ -45,14 +45,14 @@ export default function ProductView({ id, onBack }: { id: string; onBack: () =>
|
||||
|
||||
return (
|
||||
<div>
|
||||
<button onClick={onBack} className="text-sm text-gray-500 flex items-center gap-1 mb-4">
|
||||
<button onClick={onBack} className="mb-4 inline-flex items-center gap-1 text-sm text-gray-500 hover:text-gray-700">
|
||||
<ArrowLeft className="w-4 h-4" /> 返回检索
|
||||
</button>
|
||||
|
||||
<div className="bg-white border rounded-lg p-5">
|
||||
<div className="card p-6 animate-fade-up">
|
||||
<div className="flex items-start justify-between gap-4">
|
||||
<h1 className="text-xl font-semibold text-gray-800">{p.name}</h1>
|
||||
<span className="shrink-0 text-xs bg-emerald-50 text-emerald-700 rounded px-2 py-1">
|
||||
<h1 className="text-2xl font-semibold tracking-tight text-gray-900">{p.name}</h1>
|
||||
<span className="shrink-0 rounded-full border border-brand-100 bg-brand-50 px-2.5 py-1 text-xs font-medium text-brand-700">
|
||||
质量分 {Math.round(p.quality_score * 100)}
|
||||
</span>
|
||||
</div>
|
||||
@@ -60,6 +60,29 @@ export default function ProductView({ id, onBack }: { id: string; onBack: () =>
|
||||
<div className="mt-4">
|
||||
<Row label="品牌" value={p.brand} />
|
||||
<Row label="条码 (GTIN)" value={p.gtin} />
|
||||
{(() => {
|
||||
const others = (p.barcodes || []).filter(
|
||||
(b) => !b.is_primary && b.gtin !== p.gtin,
|
||||
);
|
||||
return others.length ? (
|
||||
<Row
|
||||
label="其他条码"
|
||||
value={
|
||||
<div className="flex flex-wrap gap-1.5">
|
||||
{others.map((b) => (
|
||||
<span
|
||||
key={b.gtin}
|
||||
className="font-mono text-xs bg-gray-100 text-gray-600 rounded px-1.5 py-0.5"
|
||||
title={`${b.gtin_type} · ${b.pack_level}`}
|
||||
>
|
||||
{b.gtin}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
}
|
||||
/>
|
||||
) : null;
|
||||
})()}
|
||||
<Row label="品类" value={p.category_path} />
|
||||
<Row
|
||||
label="净含量"
|
||||
@@ -83,8 +106,25 @@ export default function ProductView({ id, onBack }: { id: string; onBack: () =>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{p.specs && p.specs.length > 0 && (
|
||||
<div className="card p-6 mt-4">
|
||||
<h2 className="font-medium text-gray-700 mb-2">规格参数</h2>
|
||||
<div className="grid grid-cols-1 sm:grid-cols-2 gap-2 text-sm">
|
||||
{p.specs.map((s) => (
|
||||
<div key={s.key} className="bg-gray-50 rounded px-3 py-2">
|
||||
<div className="text-gray-400 text-xs">{s.label}</div>
|
||||
<div className="text-gray-800">
|
||||
{s.value}
|
||||
{s.unit ? ` ${s.unit}` : ""}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{nutriEntries.length > 0 && (
|
||||
<div className="bg-white border rounded-lg p-5 mt-4">
|
||||
<div className="card p-6 mt-4">
|
||||
<h2 className="font-medium text-gray-700 mb-2">
|
||||
营养成分
|
||||
{p.nutrition_basis ? `(${basisLabel[p.nutrition_basis] || p.nutrition_basis})` : ""}
|
||||
|
||||
@@ -10,7 +10,36 @@ body,
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
background: #f3f4f6;
|
||||
font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue",
|
||||
Arial, "PingFang SC", "Microsoft YaHei", sans-serif;
|
||||
color: #1f2937;
|
||||
font-family: theme("fontFamily.sans");
|
||||
-webkit-font-smoothing: antialiased;
|
||||
text-rendering: optimizeLegibility;
|
||||
background-color: #f6f8f7;
|
||||
background-image:
|
||||
radial-gradient(60rem 60rem at 100% -10%, rgba(16, 185, 129, 0.10), transparent 60%),
|
||||
radial-gradient(50rem 50rem at -10% 0%, rgba(45, 212, 191, 0.10), transparent 55%);
|
||||
background-attachment: fixed;
|
||||
}
|
||||
|
||||
@layer components {
|
||||
.card {
|
||||
@apply bg-white rounded-2xl border border-gray-100;
|
||||
box-shadow: theme("boxShadow.card");
|
||||
}
|
||||
|
||||
.input {
|
||||
@apply w-full rounded-xl border border-gray-200 bg-white px-3.5 py-2.5 text-sm text-gray-800 placeholder:text-gray-400 transition focus:outline-none focus:border-brand-400 focus:ring-4 focus:ring-brand-500/10;
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
@apply inline-flex items-center justify-center gap-1.5 rounded-xl bg-brand-600 px-5 py-2.5 text-sm font-semibold text-white shadow-sm transition hover:bg-brand-700 active:bg-brand-800 disabled:opacity-60;
|
||||
}
|
||||
|
||||
.btn-ghost {
|
||||
@apply inline-flex items-center justify-center gap-1.5 rounded-xl px-3.5 py-2 text-sm font-medium text-gray-600 transition hover:bg-gray-100;
|
||||
}
|
||||
|
||||
.chip {
|
||||
@apply inline-flex items-center gap-1 rounded-full border border-gray-200 bg-white/70 px-3 py-1 text-xs font-medium text-gray-600 transition hover:border-brand-300 hover:text-brand-700 hover:bg-brand-50;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,14 +4,35 @@ 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 {
|
||||
gtin: string;
|
||||
gtin_type: string;
|
||||
pack_level: string;
|
||||
region: string | null;
|
||||
is_primary: boolean;
|
||||
}
|
||||
|
||||
export interface ProductSpec {
|
||||
key: string;
|
||||
label: string;
|
||||
value: string;
|
||||
unit?: string;
|
||||
}
|
||||
|
||||
export interface Product {
|
||||
id: string;
|
||||
gtin: string | null;
|
||||
barcodes?: Barcode[] | null;
|
||||
name: string;
|
||||
brand: string | null;
|
||||
category_path: string | null;
|
||||
archive_kind?: string;
|
||||
specs?: ProductSpec[] | null;
|
||||
net_content_value: number | null;
|
||||
net_content_unit: string | null;
|
||||
country_of_origin: string | null;
|
||||
@@ -30,6 +51,20 @@ export interface Category {
|
||||
name_en: string | null;
|
||||
path: string;
|
||||
level: number;
|
||||
archive_kind: string;
|
||||
}
|
||||
|
||||
export interface KindField {
|
||||
kind: string;
|
||||
field_key: string;
|
||||
group_label: string;
|
||||
label_zh: string;
|
||||
field_type: "text" | "number" | "textarea" | "select" | "list";
|
||||
unit: string | null;
|
||||
options: string[] | null;
|
||||
placeholder: string | null;
|
||||
sort_order: number;
|
||||
qualified: boolean;
|
||||
}
|
||||
|
||||
export interface SubmissionImage {
|
||||
@@ -47,6 +82,7 @@ export interface SubmissionInput {
|
||||
country_of_origin?: string | null;
|
||||
ingredients_text?: string | null;
|
||||
nutriments?: Record<string, number> | null;
|
||||
attributes?: Record<string, unknown> | null;
|
||||
nutrition_basis?: string | null;
|
||||
serving_size?: string | null;
|
||||
nutri_score?: string | null;
|
||||
|
||||
@@ -1,6 +1,55 @@
|
||||
/** @type {import('tailwindcss').Config} */
|
||||
export default {
|
||||
content: ["./index.html", "./src/**/*.{ts,tsx}"],
|
||||
theme: { extend: {} },
|
||||
theme: {
|
||||
extend: {
|
||||
colors: {
|
||||
brand: {
|
||||
50: "#ecfdf5",
|
||||
100: "#d1fae5",
|
||||
200: "#a7f3d0",
|
||||
300: "#6ee7b7",
|
||||
400: "#34d399",
|
||||
500: "#10b981",
|
||||
600: "#059669",
|
||||
700: "#047857",
|
||||
800: "#065f46",
|
||||
900: "#064e3b",
|
||||
},
|
||||
},
|
||||
fontFamily: {
|
||||
sans: [
|
||||
"Inter",
|
||||
"system-ui",
|
||||
"-apple-system",
|
||||
"Segoe UI",
|
||||
"Roboto",
|
||||
"Helvetica Neue",
|
||||
"Arial",
|
||||
"PingFang SC",
|
||||
"Microsoft YaHei",
|
||||
"sans-serif",
|
||||
],
|
||||
},
|
||||
boxShadow: {
|
||||
card: "0 1px 2px rgba(16,24,40,0.04), 0 4px 16px -8px rgba(16,24,40,0.10)",
|
||||
"card-hover": "0 10px 30px -10px rgba(16,24,40,0.18)",
|
||||
glow: "0 12px 40px -12px rgba(5,150,105,0.45)",
|
||||
},
|
||||
borderRadius: {
|
||||
"2xl": "1rem",
|
||||
"3xl": "1.5rem",
|
||||
},
|
||||
keyframes: {
|
||||
"fade-up": {
|
||||
"0%": { opacity: "0", transform: "translateY(8px)" },
|
||||
"100%": { opacity: "1", transform: "translateY(0)" },
|
||||
},
|
||||
},
|
||||
animation: {
|
||||
"fade-up": "fade-up 0.4s ease-out both",
|
||||
},
|
||||
},
|
||||
},
|
||||
plugins: [],
|
||||
};
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# build artifacts
|
||||
bypos-collector.exe
|
||||
bypos-collector
|
||||
bypos-collector-linux
|
||||
*.exe
|
||||
# collected data / outputs
|
||||
*.jsonl
|
||||
*.csv
|
||||
*.log
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user