Compare commits

..

30 Commits

Author SHA1 Message Date
rosemariejebbjtxbfp 3b62f61288 docs: 新增可扩展性设计与路线图 (scalability roadmap)
CI / Go (api) (pull_request) Successful in 59s
CI / Python (ingestion) (pull_request) Failing after 20s
CI / Migrations (postgres) (pull_request) Successful in 34s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-24 05:29:08 +00:00
lixu ba36e3ff4c Merge pull request '新增联系我们页面' (#25) from devin/1782277231-contact-us into main
CI / Go (api) (push) Failing after 32s
CI / Python (ingestion) (push) Failing after 31s
CI / Migrations (postgres) (push) Successful in 35s
2026-06-24 13:02:07 +08:00
rosemariejebbjtxbfp d837dd38bf feat(public-frontend): 新增联系我们页面
CI / Go (api) (pull_request) Successful in 56s
CI / Python (ingestion) (pull_request) Failing after 1m31s
CI / Migrations (postgres) (pull_request) Failing after 32s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-24 05:00:31 +00:00
lixu 53ce705572 Merge pull request '移除首页 API 调用说明入口' (#23) from devin/1782276245-home-remove-api-cta into main
CI / Go (api) (push) Failing after 16m4s
CI / Python (ingestion) (push) Failing after 17s
CI / Migrations (postgres) (push) Successful in 29s
2026-06-24 12:46:03 +08:00
rosemariejebbjtxbfp 836ee73d73 feat(public-frontend): 移除首页 API 调用说明入口
CI / Go (api) (pull_request) Failing after 1m31s
CI / Python (ingestion) (pull_request) Failing after 16s
CI / Migrations (postgres) (pull_request) Successful in 25s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-24 04:44:05 +00:00
lixu dbbad274b6 Merge pull request 'feat(public-frontend): 公开前端 UI 视觉升级' (#22) from devin/1782270985-public-ui-redesign into main
CI / Go (api) (push) Successful in 55s
CI / Python (ingestion) (push) Failing after 14s
CI / Migrations (postgres) (push) Successful in 23s
2026-06-24 12:36:17 +08:00
rosemariejebbjtxbfp d58f46bc80 feat(public-frontend): 公开前端 UI 视觉升级
CI / Go (api) (pull_request) Failing after 32s
CI / Python (ingestion) (pull_request) Failing after 31s
CI / Migrations (postgres) (pull_request) Failing after 32s
引入统一品牌主题(色阶/字体/阴影/动效),重做首页 hero、卡片、导航与页脚,统一各页面的卡片/输入框/按钮样式。

- tailwind: 新增 brand 色阶、Inter 字体、card/glow 阴影与 fade-up 动效
- index.html: 引入 Inter 字体与 theme-color/description meta
- index.css: 双径向渐变背景 + @layer 组件类(.card/.input/.btn-primary 等)
- App/Home/ProductView/Contribute/ApiDocs/Account: 套用新设计系统

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-24 03:16:41 +00:00
lixu 8f9a03a929 Merge pull request 'feat(ingestion): import bypos-collector JSONL into goods' (#20) from devin/1782268418-bypos-importer into main
CI / Python (ingestion) (push) Successful in 11s
CI / Migrations (postgres) (push) Successful in 24s
CI / Go (api) (push) Successful in 49s
2026-06-24 10:35:27 +08:00
novaalphastrikeomegaz663 f04da0a135 feat(ingestion): import bypos-collector JSONL into goods
CI / Python (ingestion) (pull_request) Successful in 16s
CI / Migrations (postgres) (pull_request) Successful in 24s
CI / Go (api) (pull_request) Successful in 51s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-24 02:33:45 +00:00
lixu a2ef7319e9 Merge pull request 'chore(tools): add bypos-collector (条码批量采集器源码备份)' (#19) from devin/1782267629-add-bypos-collector into main
CI / Python (ingestion) (push) Successful in 11s
CI / Migrations (postgres) (push) Successful in 22s
CI / Go (api) (push) Successful in 48s
2026-06-24 10:27:15 +08:00
novaalphastrikeomegaz663 e746b9cd31 chore(tools): add bypos-collector (条码批量采集器源码备份)
CI / Python (ingestion) (pull_request) Successful in 12s
CI / Migrations (postgres) (pull_request) Successful in 23s
CI / Go (api) (pull_request) Successful in 48s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-24 02:20:34 +00:00
lixu ddda61252b Merge pull request '后台商品档案:点击表头排序' (#18) from devin/1782028836-product-sort into main
CI / Go (api) (push) Successful in 9s
CI / Python (ingestion) (push) Successful in 10s
CI / Migrations (postgres) (push) Successful in 15s
2026-06-21 16:01:56 +08:00
sulaimaannaasif6866 241fd38a56 feat(admin): sortable product list column headers
CI / Go (api) (pull_request) Successful in 11s
CI / Python (ingestion) (pull_request) Successful in 9s
CI / Migrations (postgres) (pull_request) Successful in 14s
Click a column header (名称/品牌/条码/品类/状态/质量分) to sort asc, click
again for desc, and a third time to clear back to the default
most-recently-updated order. Sort key/direction are whitelisted server-side.

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 08:00:36 +00:00
lixu 3178f8a85a Merge pull request 'API 配额分级:免费累计 1000 次 + 公开注册自助领取更高配额密钥' (#17) from devin/1782026795-api-quota-registration into main
CI / Go (api) (push) Successful in 10s
CI / Python (ingestion) (push) Successful in 9s
CI / Migrations (postgres) (push) Successful in 17s
2026-06-21 15:28:59 +08:00
sulaimaannaasif6866 7434e5195e feat(api): tiered cumulative quota + self-service registration
CI / Go (api) (pull_request) Successful in 15s
CI / Python (ingestion) (pull_request) Successful in 10s
CI / Migrations (postgres) (pull_request) Successful in 16s
Anonymous callers get a free cumulative quota (1000 calls per IP); once
exhausted they get 403 quota_exhausted and must register. Public users can
self-register (email+password) to obtain a higher-quota API key, view usage,
and regenerate the key. Quota counters live in Redis; the public API stays
read-only except for the registration writes.

- migration 0011: app_user table + api_key.quota_total + 'registered' tier
- ratelimit: IncrTotal/TotalUsed/CopyTotal lifetime counters
- middleware: enforce cumulative quota + X-Quota-* headers
- store: RegisterUser/Authenticate/RegenerateKey (bcrypt)
- handlers: POST /api/v1/register, /account, /account/regenerate
- admin: quota_total column + registered tier
- public: 'API 密钥' account page + API docs quota section

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 07:26:41 +00:00
lixu 7f66aad779 Merge pull request 'feat: 可扩展档案模式框架 + 内置 3C(电子) 模式' (#16) from devin/1782022411-archive-kind-3c into main
CI / Go (api) (push) Successful in 12s
CI / Python (ingestion) (push) Successful in 10s
CI / Migrations (postgres) (push) Successful in 14s
2026-06-21 14:15:21 +08:00
sulaimaannaasif6866 916bdd9c7c feat: 可扩展档案模式框架 + 内置 3C(电子) 模式
CI / Go (api) (pull_request) Successful in 13s
CI / Python (ingestion) (pull_request) Successful in 9s
CI / Migrations (postgres) (pull_request) Successful in 14s
- 新增 category.archive_kind 与 kind_field 字段模板表(迁移 0010)
- 种子 electronics 字段模板 + 3C 品类树(手机/笔记本/平板等)
- 后端按档案模式动态计算完整度/合格:食品沿用 food_detail,
  其它模式走 product.attributes + kind_field
- 新增 GET /api/kind-fields?kind= 接口
- 后台编辑页按品类模式动态渲染规格参数表单
- 公开详情页/接口输出带标签的规格表

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 06:13:42 +00:00
lixu 98eb01f4ea Merge pull request 'feat(admin): 商品编辑页 上一个/下一个 导航' (#15) from devin/1782021020-detail-prevnext into main
CI / Go (api) (push) Successful in 9s
CI / Python (ingestion) (push) Successful in 11s
CI / Migrations (postgres) (push) Successful in 14s
2026-06-21 13:51:19 +08:00
sulaimaannaasif6866 51304d782a feat(admin): 商品编辑页增加上一个/下一个导航
CI / Go (api) (pull_request) Successful in 9s
CI / Python (ingestion) (pull_request) Successful in 10s
CI / Migrations (postgres) (pull_request) Successful in 14s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 05:50:20 +00:00
lixu 6e81a7eb36 Merge pull request 'feat(admin): 商品列表分页增强(每页数量+跳页)' (#14) from devin/1782012403-list-pagination into main
CI / Go (api) (push) Successful in 8s
CI / Python (ingestion) (push) Successful in 9s
CI / Migrations (postgres) (push) Successful in 14s
2026-06-21 11:27:41 +08:00
sulaimaannaasif6866 8bee570cb2 feat(admin): 商品列表底部增加每页数量与跳页控制
CI / Go (api) (pull_request) Successful in 9s
CI / Python (ingestion) (pull_request) Successful in 9s
CI / Migrations (postgres) (pull_request) Successful in 14s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 03:26:43 +00:00
lixu ed06d269c6 Merge pull request 'style(public): 页脚内容居中' (#13) from devin/1782012124-footer-center into main
CI / Go (api) (push) Successful in 9s
CI / Python (ingestion) (push) Successful in 9s
CI / Migrations (postgres) (push) Successful in 18s
2026-06-21 11:23:02 +08:00
sulaimaannaasif6866 0214253b48 style(public): 页脚内容居中
CI / Go (api) (pull_request) Successful in 8s
CI / Python (ingestion) (pull_request) Successful in 9s
CI / Migrations (postgres) (pull_request) Successful in 14s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 03:22:04 +00:00
lixu afced01ba6 Merge pull request 'style(public): 更新页脚免责文案' (#12) from devin/1782011674-footer-text into main
CI / Go (api) (push) Successful in 9s
CI / Python (ingestion) (push) Successful in 10s
CI / Migrations (postgres) (push) Successful in 14s
2026-06-21 11:15:29 +08:00
sulaimaannaasif6866 8812e5f5e3 style(public): 更新页脚免责文案
CI / Go (api) (pull_request) Successful in 9s
CI / Python (ingestion) (pull_request) Successful in 10s
CI / Migrations (postgres) (pull_request) Successful in 13s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 03:14:34 +00:00
lixu 01055ded02 Merge pull request 'style(admin): 后台各页容器统一居中' (#11) from devin/1782011126-admin-center into main
CI / Go (api) (push) Successful in 8s
CI / Python (ingestion) (push) Successful in 9s
CI / Migrations (postgres) (push) Successful in 15s
2026-06-21 11:06:31 +08:00
sulaimaannaasif6866 01593dcbdc style(admin): 后台各页容器统一居中 (mx-auto)
CI / Go (api) (pull_request) Successful in 8s
CI / Python (ingestion) (pull_request) Successful in 13s
CI / Migrations (postgres) (pull_request) Successful in 14s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 03:05:26 +00:00
lixu afdd26cb59 Merge pull request 'feat(public): 首页移除品牌/产地筛选,合格档案数移至页脚' (#10) from devin/1782010793-home-tweaks into main
CI / Go (api) (push) Successful in 8s
CI / Python (ingestion) (push) Successful in 10s
CI / Migrations (postgres) (push) Successful in 14s
2026-06-21 11:01:03 +08:00
sulaimaannaasif6866 4b4758a60f feat(public): 首页移除品牌/产地筛选,合格档案数移至页脚
CI / Go (api) (pull_request) Successful in 14s
CI / Python (ingestion) (pull_request) Successful in 10s
CI / Migrations (postgres) (pull_request) Successful in 14s
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-06-21 02:59:53 +00:00
lixu f9360c15e3 Merge pull request 'feat(admin): 后台完善 — 分类管理 + 品牌管理 + 新建商品' (#9) from devin/1782002626-admin-category-management into main
CI / Go (api) (push) Successful in 10s
CI / Python (ingestion) (push) Successful in 9s
CI / Migrations (postgres) (push) Successful in 15s
feat(admin): 后台完善 — 分类/品牌管理、新建商品、数据概览、操作日志、批量操作 + 首页 (#9)
2026-06-21 10:00:38 +08:00
60 changed files with 4113 additions and 301 deletions
+13 -2
View File
@@ -28,6 +28,7 @@ export default function App() {
const [tab, setTab] = useState<Tab>("products"); const [tab, setTab] = useState<Tab>("products");
const [pending, setPending] = useState<number | null>(null); const [pending, setPending] = useState<number | null>(null);
const [view, setView] = useState<View>({ name: "list" }); const [view, setView] = useState<View>({ name: "list" });
const [navIds, setNavIds] = useState<string[]>([]);
useEffect(() => { useEffect(() => {
if (!authed) return; if (!authed) return;
@@ -190,9 +191,19 @@ export default function App() {
) : tab === "submissions" ? ( ) : tab === "submissions" ? (
<SubmissionsPage onPending={setPending} /> <SubmissionsPage onPending={setPending} />
) : view.name === "list" ? ( ) : 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> </main>
</div> </div>
+16 -2
View File
@@ -51,14 +51,23 @@ export const api = {
body: JSON.stringify({ username, password }), body: JSON.stringify({ username, password }),
}), }),
me: () => request<{ username: string }>("/me"), me: () => request<{ username: string }>("/me"),
listProducts: (q: string, page: number, size: number) => listProducts: (
q: string,
page: number,
size: number,
sort?: string,
order?: string,
) =>
request<{ request<{
items: import("./types").ProductRow[]; items: import("./types").ProductRow[];
page: number; page: number;
size: number; size: number;
total: number; total: number;
completeness_fields: string[]; 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) => getProduct: (id: string) =>
request<import("./types").ProductDetail>(`/products/${id}`), request<import("./types").ProductDetail>(`/products/${id}`),
createProduct: (body: unknown) => createProduct: (body: unknown) =>
@@ -124,6 +133,10 @@ export const api = {
}), }),
deleteBrand: (id: string) => deleteBrand: (id: string) =>
request<{ status: string }>(`/brands/${id}`, { method: "DELETE" }), request<{ status: string }>(`/brands/${id}`, { method: "DELETE" }),
listKindFields: (kind: string) =>
request<{ items: import("./types").KindField[]; kind: string }>(
`/kind-fields?kind=${encodeURIComponent(kind)}`,
),
listCategories: () => listCategories: () =>
request<{ items: import("./types").Category[] }>("/categories"), request<{ items: import("./types").Category[] }>("/categories"),
createCategory: (body: import("./types").CategoryInput) => createCategory: (body: import("./types").CategoryInput) =>
@@ -164,6 +177,7 @@ export const api = {
owner_email?: string; owner_email?: string;
tier?: string; tier?: string;
rate_limit_per_min?: number; rate_limit_per_min?: number;
quota_total?: number;
}) => }) =>
request<{ key: string; item: import("./types").ApiKey; warning: string }>( request<{ key: string; item: import("./types").ApiKey; warning: string }>(
"/keys", "/keys",
+32 -6
View File
@@ -4,9 +4,10 @@ import type { ApiKey } from "../types";
import { Copy, KeyRound, Plus, Trash2 } from "lucide-react"; import { Copy, KeyRound, Plus, Trash2 } from "lucide-react";
const TIERS = [ const TIERS = [
{ key: "free", label: "免费 (free)", rate: 120 }, { key: "free", label: "免费 (free)", rate: 120, quota: 1000 },
{ key: "partner", label: "合作方 (partner)", rate: 600 }, { key: "registered", label: "注册用户 (registered)", rate: 300, quota: 100000 },
{ key: "internal", label: "内部 (internal)", rate: 6000 }, { key: "partner", label: "合作方 (partner)", rate: 600, quota: 0 },
{ key: "internal", label: "内部 (internal)", rate: 6000, quota: 0 },
]; ];
function tierLabel(tier: string): string { function tierLabel(tier: string): string {
@@ -44,7 +45,7 @@ export default function ApiKeysPage() {
} }
return ( return (
<div className="max-w-4xl"> <div className="mx-auto max-w-4xl">
<div className="flex items-center justify-between mb-4"> <div className="flex items-center justify-between mb-4">
<div> <div>
<h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2"> <h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2">
@@ -111,6 +112,7 @@ export default function ApiKeysPage() {
<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> <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> </tr>
@@ -118,7 +120,7 @@ export default function ApiKeysPage() {
<tbody className="divide-y"> <tbody className="divide-y">
{rows.length === 0 ? ( {rows.length === 0 ? (
<tr> <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> </td>
</tr> </tr>
@@ -139,6 +141,15 @@ export default function ApiKeysPage() {
<td className="px-4 py-2 text-gray-600"> <td className="px-4 py-2 text-gray-600">
{k.usage.today} / {k.usage.total} {k.usage.today} / {k.usage.total}
</td> </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"> <td className="px-4 py-2">
{k.revoked_at ? ( {k.revoked_at ? (
<span className="text-xs rounded px-2 py-0.5 bg-red-50 text-red-700"> <span className="text-xs rounded px-2 py-0.5 bg-red-50 text-red-700">
@@ -182,13 +193,17 @@ function CreateKeyForm({
const [ownerEmail, setOwnerEmail] = useState(""); const [ownerEmail, setOwnerEmail] = useState("");
const [tier, setTier] = useState("free"); const [tier, setTier] = useState("free");
const [rate, setRate] = useState(120); const [rate, setRate] = useState(120);
const [quota, setQuota] = useState(1000);
const [busy, setBusy] = useState(false); const [busy, setBusy] = useState(false);
const [error, setError] = useState(""); const [error, setError] = useState("");
function pickTier(t: string) { function pickTier(t: string) {
setTier(t); setTier(t);
const def = TIERS.find((x) => x.key === t); const def = TIERS.find((x) => x.key === t);
if (def) setRate(def.rate); if (def) {
setRate(def.rate);
setQuota(def.quota);
}
} }
async function submit() { async function submit() {
@@ -204,6 +219,7 @@ function CreateKeyForm({
owner_email: ownerEmail.trim() || undefined, owner_email: ownerEmail.trim() || undefined,
tier, tier,
rate_limit_per_min: rate, rate_limit_per_min: rate,
quota_total: quota,
}); });
onCreated(res.key); onCreated(res.key);
} catch (e) { } catch (e) {
@@ -260,6 +276,16 @@ function CreateKeyForm({
onChange={(e) => setRate(Math.max(1, parseInt(e.target.value || "1", 10)))} onChange={(e) => setRate(Math.max(1, parseInt(e.target.value || "1", 10)))}
/> />
</label> </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>
<div className="mt-4 flex gap-2"> <div className="mt-4 flex gap-2">
<button <button
@@ -40,7 +40,7 @@ export default function AuditLogPage() {
const pages = Math.max(1, Math.ceil(total / size)); const pages = Math.max(1, Math.ceil(total / size));
return ( return (
<div className="max-w-5xl"> <div className="mx-auto max-w-5xl">
<h2 className="mb-4 flex items-center gap-2 text-lg font-semibold text-gray-800"> <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" /> <ScrollText className="h-5 w-5 text-emerald-600" />
<span className="text-sm font-normal text-gray-400"> {total} </span> <span className="text-sm font-normal text-gray-400"> {total} </span>
+1 -1
View File
@@ -105,7 +105,7 @@ export default function BrandsPage() {
} }
return ( return (
<div className="max-w-4xl"> <div className="mx-auto max-w-4xl">
<div className="flex items-center justify-between mb-4"> <div className="flex items-center justify-between mb-4">
<div> <div>
<h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2"> <h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2">
@@ -55,7 +55,7 @@ export default function CategoriesPage() {
} }
return ( return (
<div className="max-w-5xl"> <div className="mx-auto max-w-5xl">
<div className="flex items-center justify-between mb-4"> <div className="flex items-center justify-between mb-4">
<div> <div>
<h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2"> <h2 className="text-lg font-semibold text-gray-800 flex items-center gap-2">
+173 -7
View File
@@ -5,10 +5,13 @@ import {
Brand, Brand,
Category, Category,
FIELD_LABELS, FIELD_LABELS,
KindField,
ProductDetail as Detail, ProductDetail as Detail,
} from "../types"; } from "../types";
import { import {
ArrowLeft, ArrowLeft,
ChevronLeft,
ChevronRight,
Plus, Plus,
Save, Save,
Trash2, Trash2,
@@ -88,10 +91,18 @@ const inputCls =
export default function ProductDetail({ export default function ProductDetail({
id, id,
onBack, onBack,
ids = [],
onNavigate,
}: { }: {
id: string; id: string;
onBack: () => void; 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 [d, setD] = useState<Detail | null>(null);
const [brands, setBrands] = useState<Brand[]>([]); const [brands, setBrands] = useState<Brand[]>([]);
const [categories, setCategories] = useState<Category[]>([]); const [categories, setCategories] = useState<Category[]>([]);
@@ -117,6 +128,8 @@ export default function ProductDetail({
const [basis, setBasis] = useState(""); const [basis, setBasis] = useState("");
const [serving, setServing] = useState(""); const [serving, setServing] = useState("");
const [nutriScore, setNutriScore] = useState(""); const [nutriScore, setNutriScore] = useState("");
const [kindFields, setKindFields] = useState<KindField[]>([]);
const [attrs, setAttrs] = useState<Record<string, string>>({});
function hydrate(detail: Detail) { function hydrate(detail: Detail) {
setD(detail); setD(detail);
@@ -139,6 +152,13 @@ export default function ProductDetail({
setBasis(detail.nutrition_basis || ""); setBasis(detail.nutrition_basis || "");
setServing(detail.serving_size || ""); setServing(detail.serving_size || "");
setNutriScore(detail.nutri_score || ""); 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() { function reload() {
@@ -161,6 +181,41 @@ export default function ProductDetail({
const missing = useMemo(() => d?.missing ?? [], [d]); 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[] { function parseList(s: string): string[] {
return s return s
.split(",") .split(",")
@@ -177,6 +232,22 @@ export default function ProductDetail({
const n = parseFloat(v); const n = parseFloat(v);
if (!Number.isNaN(n)) nm[k] = n; 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 = { const body = {
gtin: gtin.trim() || null, gtin: gtin.trim() || null,
name: name.trim(), name: name.trim(),
@@ -194,6 +265,7 @@ export default function ProductDetail({
nutrition_basis: basis || null, nutrition_basis: basis || null,
serving_size: serving.trim() || null, serving_size: serving.trim() || null,
nutri_score: nutriScore || null, nutri_score: nutriScore || null,
...(attributes !== undefined ? { attributes } : {}),
}; };
try { try {
const updated = await api.updateProduct(id, body); const updated = await api.updateProduct(id, body);
@@ -226,12 +298,35 @@ export default function ProductDetail({
return ( return (
<div className="mx-auto max-w-5xl space-y-5"> <div className="mx-auto max-w-5xl space-y-5">
<div className="flex items-center justify-between"> <div className="flex items-center justify-between">
<button <div className="flex items-center gap-2">
onClick={onBack} <button
className="flex items-center gap-1 text-sm text-gray-600 hover:text-gray-900" onClick={onBack}
> className="flex items-center gap-1 text-sm text-gray-600 hover:text-gray-900"
<ArrowLeft className="h-4 w-4" /> >
</button> <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"> <div className="flex items-center gap-3">
{msg && <span className="text-sm text-emerald-600">{msg}</span>} {msg && <span className="text-sm text-emerald-600">{msg}</span>}
{error && <span className="text-sm text-red-600">{error}</span>} {error && <span className="text-sm text-red-600">{error}</span>}
@@ -251,7 +346,8 @@ export default function ProductDetail({
{missing.length > 0 && ( {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"> <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" /> <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> </div>
)} )}
@@ -338,6 +434,7 @@ export default function ProductDetail({
</div> </div>
</Card> </Card>
{selectedKind === "food" && (
<Card title="配料与营养"> <Card title="配料与营养">
<div className="mb-4 grid grid-cols-2 gap-4"> <div className="mb-4 grid grid-cols-2 gap-4">
<Field label="配料表"> <Field label="配料表">
@@ -410,6 +507,75 @@ export default function ProductDetail({
))} ))}
</div> </div>
</Card> </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} /> <BarcodesCard product={d} onChange={reload} onError={setError} />
<ImagesCard <ImagesCard
+118 -14
View File
@@ -1,7 +1,15 @@
import { useEffect, useState } from "react"; import { useEffect, useState } from "react";
import { api, ApiError } from "../api"; import { api, ApiError } from "../api";
import { Brand, Category, FIELD_LABELS, ProductRow } from "../types"; import { Brand, Category, FIELD_LABELS, ProductRow } from "../types";
import { Search, AlertCircle, Plus } from "lucide-react"; 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> = { const STATUS_LABEL: Record<string, string> = {
active: "在用", active: "在用",
@@ -24,15 +32,54 @@ 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({ export default function ProductList({
onOpen, onOpen,
}: { }: {
onOpen: (id: string) => void; onOpen: (id: string, ids: string[]) => void;
}) { }) {
const [q, setQ] = useState(""); const [q, setQ] = useState("");
const [input, setInput] = useState(""); const [input, setInput] = useState("");
const [page, setPage] = useState(1); 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 [rows, setRows] = useState<ProductRow[]>([]);
const [total, setTotal] = useState(0); const [total, setTotal] = useState(0);
const [loading, setLoading] = useState(false); const [loading, setLoading] = useState(false);
@@ -48,7 +95,7 @@ export default function ProductList({
setLoading(true); setLoading(true);
setError(""); setError("");
api api
.listProducts(q, page, size) .listProducts(q, page, size, sort || undefined, order)
.then((r) => { .then((r) => {
setRows(r.items); setRows(r.items);
setTotal(r.total); setTotal(r.total);
@@ -60,7 +107,20 @@ export default function ProductList({
useEffect(() => { useEffect(() => {
setSelected(new Set()); setSelected(new Set());
reload(); reload();
}, [q, page, size]); }, [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(() => { useEffect(() => {
api.listCategories().then((r) => setCategories(r.items)).catch(() => {}); api.listCategories().then((r) => setCategories(r.items)).catch(() => {});
@@ -164,7 +224,7 @@ export default function ProductList({
onClose={() => setCreating(false)} onClose={() => setCreating(false)}
onCreated={(id) => { onCreated={(id) => {
setCreating(false); setCreating(false);
onOpen(id); onOpen(id, [id]);
}} }}
/> />
)} )}
@@ -244,12 +304,12 @@ export default function ProductList({
aria-label="全选" aria-label="全选"
/> />
</th> </th>
<th className="px-4 py-3"></th> <SortableTh label="名称" sortKey="name" sort={sort} order={order} onSort={toggleSort} />
<th className="px-4 py-3"></th> <SortableTh label="品牌" sortKey="brand" sort={sort} order={order} onSort={toggleSort} />
<th className="px-4 py-3"></th> <SortableTh label="条码" sortKey="gtin" sort={sort} order={order} onSort={toggleSort} />
<th className="px-4 py-3"></th> <SortableTh label="品类" sortKey="category_path" sort={sort} order={order} onSort={toggleSort} />
<th className="px-4 py-3"></th> <SortableTh label="状态" sortKey="status" sort={sort} order={order} onSort={toggleSort} />
<th className="px-4 py-3"></th> <SortableTh label="质量分" sortKey="quality_score" sort={sort} order={order} onSort={toggleSort} />
<th className="px-4 py-3"></th> <th className="px-4 py-3"></th>
</tr> </tr>
</thead> </thead>
@@ -270,7 +330,7 @@ export default function ProductList({
rows.map((r) => ( rows.map((r) => (
<tr <tr
key={r.id} key={r.id}
onClick={() => onOpen(r.id)} onClick={() => onOpen(r.id, rows.map((x) => x.id))}
className={`cursor-pointer hover:bg-emerald-50/50 ${ className={`cursor-pointer hover:bg-emerald-50/50 ${
selected.has(r.id) ? "bg-emerald-50/60" : "" selected.has(r.id) ? "bg-emerald-50/60" : ""
}`} }`}
@@ -319,7 +379,25 @@ export default function ProductList({
</table> </table>
</div> </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 <button
disabled={page <= 1} disabled={page <= 1}
onClick={() => setPage((p) => p - 1)} onClick={() => setPage((p) => p - 1)}
@@ -337,6 +415,32 @@ export default function ProductList({
> >
</button> </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>
</div> </div>
); );
+1 -1
View File
@@ -44,7 +44,7 @@ export default function StatsPage() {
}, []); }, []);
return ( return (
<div className="max-w-5xl"> <div className="mx-auto max-w-5xl">
<h2 className="mb-4 flex items-center gap-2 text-lg font-semibold text-gray-800"> <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" /> <BarChart3 className="h-5 w-5 text-emerald-600" />
</h2> </h2>
@@ -56,7 +56,7 @@ export default function SubmissionsPage({ onPending }: { onPending?: (n: number)
} }
return ( return (
<div> <div className="mx-auto max-w-5xl">
<div className="flex items-center gap-2 mb-4"> <div className="flex items-center gap-2 mb-4">
{STATUS_TABS.map((t) => ( {STATUS_TABS.map((t) => (
<button <button
@@ -193,7 +193,7 @@ function SubmissionView({ id, onBack }: { id: string; onBack: () => void }) {
const nutri = Object.entries(p.nutriments || {}); const nutri = Object.entries(p.nutriments || {});
return ( 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"> <button onClick={onBack} className="text-sm text-gray-500 flex items-center gap-1 mb-4">
<ArrowLeft className="h-4 w-4" /> 稿 <ArrowLeft className="h-4 w-4" /> 稿
</button> </button>
+17
View File
@@ -44,6 +44,8 @@ export interface ProductDetail {
brand: string | null; brand: string | null;
category_id: string | null; category_id: string | null;
category_path: string | null; category_path: string | null;
archive_kind: string;
attributes: Record<string, unknown>;
net_content_value: number | null; net_content_value: number | null;
net_content_unit: string | null; net_content_unit: string | null;
country_of_origin: string | null; country_of_origin: string | null;
@@ -77,9 +79,23 @@ export interface Category {
level: number; level: number;
parent_id: string | null; parent_id: string | null;
gpc_brick_code: string | null; gpc_brick_code: string | null;
archive_kind: string;
product_count: number; 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 { export interface CategoryInput {
name_zh: string; name_zh: string;
name_en?: string | null; name_en?: string | null;
@@ -183,6 +199,7 @@ export interface ApiKey {
owner_email: string | null; owner_email: string | null;
tier: string; tier: string;
rate_limit_per_min: number; rate_limit_per_min: number;
quota_total: number;
revoked_at: string | null; revoked_at: string | null;
created_by: string | null; created_by: string | null;
created_at: string; created_at: string;
+2 -1
View File
@@ -37,7 +37,8 @@ func main() {
log.Print("warning: Redis not configured; public API rate limiting disabled") log.Print("warning: Redis not configured; public API rate limiting disabled")
} }
h := handler.New(store.New(pool), publicweb.Dist()). h := handler.New(store.New(pool), publicweb.Dist()).
WithRateLimit(limiter, cfg.AnonRateLimitPerMin) WithRateLimit(limiter, cfg.AnonRateLimitPerMin).
WithQuotas(cfg.AnonTotalQuota, cfg.RegisteredRateLimitPerMin, cfg.RegisteredQuotaTotal)
srv := &http.Server{ srv := &http.Server{
Addr: cfg.Addr, Addr: cfg.Addr,
+1 -1
View File
@@ -46,7 +46,7 @@ func (h *Handler) CreateAPIKey(w http.ResponseWriter, r *http.Request) {
writeError(w, http.StatusBadRequest, "bad_request", "名称不能为空") writeError(w, http.StatusBadRequest, "bad_request", "名称不能为空")
return return
} }
if in.Tier != "" && in.Tier != "free" && in.Tier != "partner" && in.Tier != "internal" { if in.Tier != "" && in.Tier != "free" && in.Tier != "registered" && in.Tier != "partner" && in.Tier != "internal" {
writeError(w, http.StatusBadRequest, "bad_request", "tier 取值无效") writeError(w, http.StatusBadRequest, "bad_request", "tier 取值无效")
return return
} }
+18 -1
View File
@@ -84,6 +84,7 @@ func (h *Handler) Router() http.Handler {
r.Put("/api/brands/{id}", h.UpdateBrand) r.Put("/api/brands/{id}", h.UpdateBrand)
r.Post("/api/brands/{id}/merge", h.MergeBrands) r.Post("/api/brands/{id}/merge", h.MergeBrands)
r.Delete("/api/brands/{id}", h.DeleteBrand) r.Delete("/api/brands/{id}", h.DeleteBrand)
r.Get("/api/kind-fields", h.ListKindFields)
r.Get("/api/categories", h.ListCategories) r.Get("/api/categories", h.ListCategories)
r.Post("/api/categories", h.CreateCategory) r.Post("/api/categories", h.CreateCategory)
r.Put("/api/categories/{id}", h.UpdateCategory) r.Put("/api/categories/{id}", h.UpdateCategory)
@@ -163,8 +164,10 @@ func (h *Handler) Me(w http.ResponseWriter, r *http.Request) {
// ListProducts returns a paginated product list. // ListProducts returns a paginated product list.
func (h *Handler) ListProducts(w http.ResponseWriter, r *http.Request) { func (h *Handler) ListProducts(w http.ResponseWriter, r *http.Request) {
q := r.URL.Query().Get("q") q := r.URL.Query().Get("q")
sort := r.URL.Query().Get("sort")
order := r.URL.Query().Get("order")
page, size := pageParams(r) 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) { if h.handleErr(w, err) {
return return
} }
@@ -423,6 +426,20 @@ func (h *Handler) ListBrands(w http.ResponseWriter, r *http.Request) {
writeJSON(w, http.StatusOK, map[string]any{"items": items}) 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. // ListCategories returns category options.
func (h *Handler) ListCategories(w http.ResponseWriter, r *http.Request) { func (h *Handler) ListCategories(w http.ResponseWriter, r *http.Request) {
items, err := h.store.ListCategories(r.Context()) items, err := h.store.ListCategories(r.Context())
+68 -8
View File
@@ -9,6 +9,7 @@ import (
"encoding/json" "encoding/json"
"errors" "errors"
"strconv" "strconv"
"strings"
"time" "time"
"github.com/jackc/pgx/v5" "github.com/jackc/pgx/v5"
@@ -50,8 +51,34 @@ type ProductRow struct {
UpdatedAt string `json:"updated_at"` 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. // 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{} args := []any{}
where := "WHERE 1=1" where := "WHERE 1=1"
if q != "" { if q != "" {
@@ -64,10 +91,15 @@ func (s *Store) ListProducts(ctx context.Context, q string, limit, offset int) (
return nil, 0, err return nil, 0, err
} }
qualified, err := s.kindQualifiedKeys(ctx, s.pool)
if err != nil {
return nil, 0, err
}
args = append(args, limit, offset) args = append(args, limit, offset)
sql := ` sql := `
SELECT p.id, p.gtin, p.name, b.name, c.path::text, p.status, p.quality_score, 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.brand_id IS NOT NULL) AS has_brand,
(p.category_id IS NOT NULL) AS has_cat, (p.category_id IS NOT NULL) AS has_cat,
(p.net_content_canonical IS NOT NULL) AS has_net, (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 brand b ON b.id = p.brand_id
LEFT JOIN category c ON c.id = p.category_id LEFT JOIN category c ON c.id = p.category_id
LEFT JOIN food_detail f ON f.product_id = p.id ` + where + 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...) rows, err := s.pool.Query(ctx, sql, args...)
if err != nil { if err != nil {
@@ -91,13 +124,21 @@ LEFT JOIN food_detail f ON f.product_id = p.id ` + where +
for rows.Next() { for rows.Next() {
var r ProductRow var r ProductRow
var hasBrand, hasCat, hasNet, hasCountry, hasNutri, hasIng, hasImg bool var hasBrand, hasCat, hasNet, hasCountry, hasNutri, hasIng, hasImg bool
var kind string
var attributes []byte
var updated time.Time var updated time.Time
if err := rows.Scan(&r.ID, &r.GTIN, &r.Name, &r.Brand, &r.CategoryPath, &r.Status, 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 { &hasNutri, &hasIng, &hasImg); err != nil {
return nil, 0, err return nil, 0, err
} }
r.UpdatedAt = updated.Format(time.RFC3339) 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{ present := map[string]bool{
"name": r.Name != "", "name": r.Name != "",
"gtin": r.GTIN != nil && *r.GTIN != "", "gtin": r.GTIN != nil && *r.GTIN != "",
@@ -109,8 +150,11 @@ LEFT JOIN food_detail f ON f.product_id = p.id ` + where +
"ingredients": hasIng, "ingredients": hasIng,
"image": hasImg, "image": hasImg,
} }
for _, k := range qkeys {
present[k] = attrPresent(attrs, k)
}
r.Missing = []string{} r.Missing = []string{}
for _, f := range CompletenessFields { for _, f := range completenessKeys(kind, qkeys) {
if !present[f] { if !present[f] {
r.Missing = append(r.Missing, f) r.Missing = append(r.Missing, f)
} }
@@ -150,6 +194,8 @@ type ProductDetail struct {
Brand *string `json:"brand"` Brand *string `json:"brand"`
CategoryID *string `json:"category_id"` CategoryID *string `json:"category_id"`
CategoryPath *string `json:"category_path"` CategoryPath *string `json:"category_path"`
ArchiveKind string `json:"archive_kind"`
Attributes map[string]any `json:"attributes"`
NetContentValue *float64 `json:"net_content_value"` NetContentValue *float64 `json:"net_content_value"`
NetContentUnit *string `json:"net_content_unit"` NetContentUnit *string `json:"net_content_unit"`
CountryOfOrigin *string `json:"country_of_origin"` CountryOfOrigin *string `json:"country_of_origin"`
@@ -173,9 +219,11 @@ type ProductDetail struct {
func (s *Store) GetProduct(ctx context.Context, id string) (*ProductDetail, error) { func (s *Store) GetProduct(ctx context.Context, id string) (*ProductDetail, error) {
var d ProductDetail var d ProductDetail
var nutriments []byte var nutriments []byte
var attributes []byte
var updated time.Time var updated time.Time
err := s.pool.QueryRow(ctx, ` err := s.pool.QueryRow(ctx, `
SELECT p.id, p.gtin, p.name, p.brand_id, b.name, p.category_id, c.path::text, 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.net_content_value, p.net_content_unit, p.country_of_origin, p.status,
p.quality_score, p.updated_at, p.quality_score, p.updated_at,
f.ingredients_text, f.allergens, f.additives, f.nutriments, f.ingredients_text, f.allergens, f.additives, f.nutriments,
@@ -186,6 +234,7 @@ LEFT JOIN category c ON c.id = p.category_id
LEFT JOIN food_detail f ON f.product_id = p.id LEFT JOIN food_detail f ON f.product_id = p.id
WHERE p.id = $1`, id).Scan( WHERE p.id = $1`, id).Scan(
&d.ID, &d.GTIN, &d.Name, &d.BrandID, &d.Brand, &d.CategoryID, &d.CategoryPath, &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.NetContentValue, &d.NetContentUnit, &d.CountryOfOrigin, &d.Status,
&d.QualityScore, &updated, &d.QualityScore, &updated,
&d.IngredientsText, &d.Allergens, &d.Additives, &nutriments, &d.IngredientsText, &d.Allergens, &d.Additives, &nutriments,
@@ -198,6 +247,10 @@ WHERE p.id = $1`, id).Scan(
return nil, err return nil, err
} }
d.UpdatedAt = updated.Format(time.RFC3339) d.UpdatedAt = updated.Format(time.RFC3339)
d.Attributes = map[string]any{}
if len(attributes) > 0 {
_ = json.Unmarshal(attributes, &d.Attributes)
}
if len(nutriments) > 0 { if len(nutriments) > 0 {
_ = json.Unmarshal(nutriments, &d.Nutriments) _ = json.Unmarshal(nutriments, &d.Nutriments)
} }
@@ -226,11 +279,15 @@ WHERE p.id = $1`, id).Scan(
} }
d.MSRP = msrps 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 return &d, nil
} }
func missingFromDetail(d *ProductDetail) []string { func missingFromDetail(d *ProductDetail, qualifiedAttrKeys []string) []string {
present := map[string]bool{ present := map[string]bool{
"name": d.Name != "", "name": d.Name != "",
"gtin": d.GTIN != nil && *d.GTIN != "", "gtin": d.GTIN != nil && *d.GTIN != "",
@@ -242,8 +299,11 @@ func missingFromDetail(d *ProductDetail) []string {
"ingredients": d.IngredientsText != nil && *d.IngredientsText != "", "ingredients": d.IngredientsText != nil && *d.IngredientsText != "",
"image": len(d.Images) > 0, "image": len(d.Images) > 0,
} }
for _, k := range qualifiedAttrKeys {
present[k] = attrPresent(d.Attributes, k)
}
missing := []string{} missing := []string{}
for _, f := range CompletenessFields { for _, f := range completenessKeys(d.ArchiveKind, qualifiedAttrKeys) {
if !present[f] { if !present[f] {
missing = append(missing, f) missing = append(missing, f)
} }
+13 -7
View File
@@ -19,6 +19,7 @@ type APIKeyRow struct {
OwnerEmail *string `json:"owner_email"` OwnerEmail *string `json:"owner_email"`
Tier string `json:"tier"` Tier string `json:"tier"`
RateLimitPerMin int `json:"rate_limit_per_min"` RateLimitPerMin int `json:"rate_limit_per_min"`
QuotaTotal int64 `json:"quota_total"`
RevokedAt *string `json:"revoked_at"` RevokedAt *string `json:"revoked_at"`
CreatedBy *string `json:"created_by"` CreatedBy *string `json:"created_by"`
CreatedAt string `json:"created_at"` CreatedAt string `json:"created_at"`
@@ -30,6 +31,7 @@ type APIKeyInput struct {
OwnerEmail string `json:"owner_email"` OwnerEmail string `json:"owner_email"`
Tier string `json:"tier"` Tier string `json:"tier"`
RateLimitPerMin int `json:"rate_limit_per_min"` RateLimitPerMin int `json:"rate_limit_per_min"`
QuotaTotal int64 `json:"quota_total"`
} }
// CreateAPIKey issues a new key, returning the one-time plaintext alongside the // CreateAPIKey issues a new key, returning the one-time plaintext alongside the
@@ -43,6 +45,10 @@ func (s *Store) CreateAPIKey(ctx context.Context, in APIKeyInput, createdBy stri
if rate <= 0 { if rate <= 0 {
rate = 120 rate = 120
} }
quota := in.QuotaTotal
if quota < 0 {
quota = 0
}
var owner *string var owner *string
if e := strings.TrimSpace(in.OwnerEmail); e != "" { if e := strings.TrimSpace(in.OwnerEmail); e != "" {
owner = &e owner = &e
@@ -56,12 +62,12 @@ func (s *Store) CreateAPIKey(ctx context.Context, in APIKeyInput, createdBy stri
var revoked, created *time.Time var revoked, created *time.Time
var createdByOut *string var createdByOut *string
err = s.pool.QueryRow(ctx, ` err = s.pool.QueryRow(ctx, `
INSERT INTO api_key (name, key_prefix, key_hash, owner_email, tier, rate_limit_per_min, created_by) 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) VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
RETURNING id, name, key_prefix, owner_email, tier, rate_limit_per_min, revoked_at, created_by, created_at`, 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, createdBy, strings.TrimSpace(in.Name), prefix, hash, owner, tier, rate, quota, createdBy,
).Scan(&row.ID, &row.Name, &row.KeyPrefix, &row.OwnerEmail, &row.Tier, ).Scan(&row.ID, &row.Name, &row.KeyPrefix, &row.OwnerEmail, &row.Tier,
&row.RateLimitPerMin, &revoked, &createdByOut, &created) &row.RateLimitPerMin, &row.QuotaTotal, &revoked, &createdByOut, &created)
if err != nil { if err != nil {
return "", row, err return "", row, err
} }
@@ -75,7 +81,7 @@ RETURNING id, name, key_prefix, owner_email, tier, rate_limit_per_min, revoked_a
// ListAPIKeys returns all keys (active first, newest first). // ListAPIKeys returns all keys (active first, newest first).
func (s *Store) ListAPIKeys(ctx context.Context) ([]APIKeyRow, error) { func (s *Store) ListAPIKeys(ctx context.Context) ([]APIKeyRow, error) {
rows, err := s.pool.Query(ctx, ` rows, err := s.pool.Query(ctx, `
SELECT id, name, key_prefix, owner_email, tier, rate_limit_per_min, revoked_at, created_by, created_at SELECT id, name, key_prefix, owner_email, tier, rate_limit_per_min, quota_total, revoked_at, created_by, created_at
FROM api_key FROM api_key
ORDER BY (revoked_at IS NULL) DESC, created_at DESC`) ORDER BY (revoked_at IS NULL) DESC, created_at DESC`)
if err != nil { if err != nil {
@@ -87,7 +93,7 @@ ORDER BY (revoked_at IS NULL) DESC, created_at DESC`)
var r APIKeyRow var r APIKeyRow
var revoked, created *time.Time var revoked, created *time.Time
if err := rows.Scan(&r.ID, &r.Name, &r.KeyPrefix, &r.OwnerEmail, &r.Tier, if err := rows.Scan(&r.ID, &r.Name, &r.KeyPrefix, &r.OwnerEmail, &r.Tier,
&r.RateLimitPerMin, &revoked, &r.CreatedBy, &created); err != nil { &r.RateLimitPerMin, &r.QuotaTotal, &revoked, &r.CreatedBy, &created); err != nil {
return nil, err return nil, err
} }
if revoked != nil { if revoked != nil {
+9 -8
View File
@@ -96,11 +96,12 @@ func (s *Store) CreateCategory(ctx context.Context, actor string, in CategoryInp
parentPath := "" parentPath := ""
parentLevel := -1 parentLevel := -1
kind := DefaultKind
var parentID *string var parentID *string
if pid := trimPtr(in.ParentID); pid != nil { if pid := trimPtr(in.ParentID); pid != nil {
var path string var path string
var level int var level int
err := s.pool.QueryRow(ctx, "SELECT path::text, level FROM category WHERE id = $1", *pid).Scan(&path, &level) 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) { if errors.Is(err, pgx.ErrNoRows) {
return nil, ErrInvalidParent return nil, ErrInvalidParent
} }
@@ -119,11 +120,11 @@ func (s *Store) CreateCategory(ctx context.Context, actor string, in CategoryInp
var c Category var c Category
err := s.pool.QueryRow(ctx, ` err := s.pool.QueryRow(ctx, `
INSERT INTO category (name_zh, name_en, parent_id, path, gpc_brick_code, level) INSERT INTO category (name_zh, name_en, parent_id, path, gpc_brick_code, level, archive_kind)
VALUES ($1, $2, $3, $4::ltree, $5, $6) VALUES ($1, $2, $3, $4::ltree, $5, $6, $7)
RETURNING id, name_zh, name_en, path::text, level, parent_id::text, gpc_brick_code, 0`, 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). 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.ProductCount) Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level, &c.ParentID, &c.GPCBrickCode, &c.ArchiveKind, &c.ProductCount)
if isUniqueViolation(err) { if isUniqueViolation(err) {
return nil, ErrDuplicatePath return nil, ErrDuplicatePath
} }
@@ -273,10 +274,10 @@ func (s *Store) getCategory(ctx context.Context, id string) (*Category, error) {
var c Category var c Category
err := s.pool.QueryRow(ctx, ` err := s.pool.QueryRow(ctx, `
SELECT c.id, c.name_zh, c.name_en, c.path::text, c.level, c.parent_id::text, SELECT c.id, c.name_zh, c.name_en, c.path::text, c.level, c.parent_id::text,
c.gpc_brick_code, c.gpc_brick_code, c.archive_kind,
(SELECT count(*) FROM product p WHERE p.category_id = c.id) (SELECT count(*) FROM product p WHERE p.category_id = c.id)
FROM category c WHERE c.id = $1`, id). FROM category c WHERE c.id = $1`, id).
Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level, &c.ParentID, &c.GPCBrickCode, &c.ProductCount) 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) { if errors.Is(err, pgx.ErrNoRows) {
return nil, ErrNotFound return nil, ErrNotFound
} }
+101
View File
@@ -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
}
}
+119
View File
@@ -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: &gtin,
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)
}
}
+37 -15
View File
@@ -2,6 +2,7 @@ package adminstore
import ( import (
"context" "context"
"encoding/json"
"math" "math"
"time" "time"
@@ -58,35 +59,56 @@ func (s *Store) computeQuality(ctx context.Context, q queryer, productID string)
var netCanonical *float64 var netCanonical *float64
var ingredients *string var ingredients *string
var hasNutri, hasImage bool var hasNutri, hasImage bool
var kind string
var attributes []byte
err := q.QueryRow(ctx, ` err := q.QueryRow(ctx, `
SELECT p.name, p.gtin, p.brand_id, p.category_id, p.net_content_canonical, 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 <> '{}'), (f.nutriments IS NOT NULL AND f.nutriments::text <> '{}'),
EXISTS (SELECT 1 FROM product_image pi WHERE pi.product_id = p.id) 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( WHERE p.id = $1`, productID).Scan(
&name, &gtin, &brandID, &categoryID, &netCanonical, &country, &name, &gtin, &brandID, &categoryID, &netCanonical, &country,
&ingredients, &hasNutri, &hasImage) &kind, &attributes, &ingredients, &hasNutri, &hasImage)
if err != nil { if err != nil {
return 0, err 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 present := 0
bump := func(ok bool) { for _, k := range keys {
if ok { if known[k] {
present++ present++
} }
} }
bump(name != nil && *name != "") completeness := float64(present) / float64(len(keys))
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))
var sourceCount int var sourceCount int
var sourceTrust *float64 var sourceTrust *float64
+38 -20
View File
@@ -27,6 +27,9 @@ type ProductInput struct {
NutritionBasis *string `json:"nutrition_basis"` NutritionBasis *string `json:"nutrition_basis"`
ServingSize *string `json:"serving_size"` ServingSize *string `json:"serving_size"`
NutriScore *string `json:"nutri_score"` 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)), " ") } 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 brandID = &bid
} }
// Resolve category gpc brick code. // Resolve category gpc brick code + archive kind.
var gpc *string var gpc *string
kind := DefaultKind
if in.CategoryID != nil && *in.CategoryID != "" { 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 return nil, err
} }
} }
@@ -116,19 +120,28 @@ WHERE id=$11`,
return nil, err return nil, err
} }
var nutriJSON []byte // Non-food spec values live in product.attributes (nil means unchanged).
if in.Nutriments != nil { if in.Attributes != nil {
nutriJSON, _ = json.Marshal(in.Nutriments) 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 { if kind == FoodKind {
allergens = []string{} var nutriJSON []byte
} if in.Nutriments != nil {
additives := in.Additives nutriJSON, _ = json.Marshal(in.Nutriments)
if additives == nil { }
additives = []string{} allergens := in.Allergens
} if allergens == nil {
_, err = tx.Exec(ctx, ` allergens = []string{}
}
additives := in.Additives
if additives == nil {
additives = []string{}
}
_, err = tx.Exec(ctx, `
INSERT INTO food_detail (product_id, ingredients_text, allergens, additives, INSERT INTO food_detail (product_id, ingredients_text, allergens, additives,
nutriments, nutrition_basis, serving_size, nutri_score) nutriments, nutrition_basis, serving_size, nutri_score)
VALUES ($1,$2,$3,$4,$5,$6,$7,$8) 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, nutrition_basis=EXCLUDED.nutrition_basis,
serving_size=EXCLUDED.serving_size, serving_size=EXCLUDED.serving_size,
nutri_score=EXCLUDED.nutri_score`, nutri_score=EXCLUDED.nutri_score`,
id, in.IngredientsText, allergens, additives, id, in.IngredientsText, allergens, additives,
nutriJSON, in.NutritionBasis, in.ServingSize, in.NutriScore) nutriJSON, in.NutritionBasis, in.ServingSize, in.NutriScore)
if err != nil { if err != nil {
return nil, err return nil, err
}
} }
if _, err := s.recomputeQualityTx(ctx, tx, id); err != nil { if _, err := s.recomputeQualityTx(ctx, tx, id); err != nil {
@@ -284,6 +298,9 @@ func diffFields(a, b *ProductDetail) []string {
add("nutrition_basis", strEq(a.NutritionBasis, b.NutritionBasis)) add("nutrition_basis", strEq(a.NutritionBasis, b.NutritionBasis))
add("serving_size", strEq(a.ServingSize, b.ServingSize)) add("serving_size", strEq(a.ServingSize, b.ServingSize))
add("nutri_score", strEq(a.NutriScore, b.NutriScore)) 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 return changed
} }
@@ -442,6 +459,7 @@ type Category struct {
Level int `json:"level"` Level int `json:"level"`
ParentID *string `json:"parent_id"` ParentID *string `json:"parent_id"`
GPCBrickCode *string `json:"gpc_brick_code"` GPCBrickCode *string `json:"gpc_brick_code"`
ArchiveKind string `json:"archive_kind"`
ProductCount int `json:"product_count"` ProductCount int `json:"product_count"`
} }
@@ -450,7 +468,7 @@ type Category struct {
func (s *Store) ListCategories(ctx context.Context) ([]Category, error) { func (s *Store) ListCategories(ctx context.Context) ([]Category, error) {
rows, err := s.pool.Query(ctx, ` rows, err := s.pool.Query(ctx, `
SELECT c.id, c.name_zh, c.name_en, c.path::text, c.level, c.parent_id::text, SELECT c.id, c.name_zh, c.name_en, c.path::text, c.level, c.parent_id::text,
c.gpc_brick_code, c.gpc_brick_code, c.archive_kind,
(SELECT count(*) FROM product p WHERE p.category_id = c.id) AS product_count (SELECT count(*) FROM product p WHERE p.category_id = c.id) AS product_count
FROM category c FROM category c
ORDER BY c.path`) ORDER BY c.path`)
@@ -462,7 +480,7 @@ ORDER BY c.path`)
for rows.Next() { for rows.Next() {
var c Category var c Category
if err := rows.Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level, if err := rows.Scan(&c.ID, &c.NameZH, &c.NameEN, &c.Path, &c.Level,
&c.ParentID, &c.GPCBrickCode, &c.ProductCount); err != nil { &c.ParentID, &c.GPCBrickCode, &c.ArchiveKind, &c.ProductCount); err != nil {
return nil, err return nil, err
} }
out = append(out, c) out = append(out, c)
+14 -8
View File
@@ -9,19 +9,25 @@ import (
// Values are read from environment variables with sensible defaults so the // Values are read from environment variables with sensible defaults so the
// server can boot in a local Docker Compose setup without extra configuration. // server can boot in a local Docker Compose setup without extra configuration.
type Config struct { type Config struct {
Addr string Addr string
DatabaseURL string DatabaseURL string
RedisURL string RedisURL string
AnonRateLimitPerMin int AnonRateLimitPerMin int
AnonTotalQuota int
RegisteredRateLimitPerMin int
RegisteredQuotaTotal int
} }
// Load reads configuration from the environment. // Load reads configuration from the environment.
func Load() Config { func Load() Config {
return Config{ return Config{
Addr: getenv("OPENGOODS_ADDR", ":8080"), Addr: getenv("OPENGOODS_ADDR", ":8080"),
DatabaseURL: getenv("OPENGOODS_DATABASE_URL", "postgres://opengoods:opengoods@localhost:5432/opengoods?sslmode=disable"), DatabaseURL: getenv("OPENGOODS_DATABASE_URL", "postgres://opengoods:opengoods@localhost:5432/opengoods?sslmode=disable"),
RedisURL: getenv("OPENGOODS_REDIS_URL", "redis://localhost:6379/0"), RedisURL: getenv("OPENGOODS_REDIS_URL", "redis://localhost:6379/0"),
AnonRateLimitPerMin: getenvInt("OPENGOODS_ANON_RATE_LIMIT_PER_MIN", 60), 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),
} }
} }
+128
View File
@@ -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,
})
}
+149
View File
@@ -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())
}
}
+54 -5
View File
@@ -37,20 +37,43 @@ const (
// defaultAnonLimit is the per-minute request budget for unauthenticated // defaultAnonLimit is the per-minute request budget for unauthenticated
// callers (identified by client IP) when none is configured. // callers (identified by client IP) when none is configured.
defaultAnonLimit = 60 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. // Handler holds dependencies shared by the HTTP routes.
type Handler struct { type Handler struct {
store *store.Store store *store.Store
spa fs.FS spa fs.FS
limiter *ratelimit.Limiter limiter *ratelimit.Limiter
anonLimit int anonLimit int
anonTotalQuota int64
regRatePerMin int
regQuotaTotal int64
} }
// New constructs a Handler backed by the given store. spa may be nil (JSON-only). // New constructs a Handler backed by the given store. spa may be nil (JSON-only).
// Rate limiting is disabled until WithRateLimit is called. // Rate limiting is disabled until WithRateLimit is called.
func New(s *store.Store, spa fs.FS) *Handler { func New(s *store.Store, spa fs.FS) *Handler {
return &Handler{store: s, spa: spa, anonLimit: defaultAnonLimit} 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 // WithRateLimit attaches a Redis-backed limiter and the anonymous per-minute
@@ -64,6 +87,22 @@ func (h *Handler) WithRateLimit(l *ratelimit.Limiter, anonPerMin int) *Handler {
return h 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. // Router builds the top-level HTTP handler with middleware and routes mounted.
func (h *Handler) Router() http.Handler { func (h *Handler) Router() http.Handler {
r := chi.NewRouter() r := chi.NewRouter()
@@ -91,6 +130,16 @@ func (h *Handler) Router() http.Handler {
r.Get("/sources/{id}", h.SourceByID) r.Get("/sources/{id}", h.SourceByID)
r.Get("/stats", h.Stats) 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)
})
}) })
// Public SPA (homepage + search + contribute). API routes above take // Public SPA (homepage + search + contribute). API routes above take
+53 -1
View File
@@ -24,8 +24,11 @@ const apiKeyIDKey ctxKey = 0
// are set on every response; over-budget callers get 429 + Retry-After. // are set on every response; over-budget callers get 429 + Retry-After.
func (h *Handler) rateLimit(next http.Handler) http.Handler { func (h *Handler) rateLimit(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
id := "ip:" + clientIP(r) ip := clientIP(r)
id := "ip:" + ip
subject := "ip:" + ip // cumulative-quota counter subject
limit := h.anonLimit limit := h.anonLimit
quota := h.anonTotalQuota
keyID := "" keyID := ""
if raw := presentedKey(r); raw != "" { if raw := presentedKey(r); raw != "" {
@@ -45,6 +48,8 @@ func (h *Handler) rateLimit(next http.Handler) http.Handler {
keyID = k.ID keyID = k.ID
limit = k.RateLimitPerMin limit = k.RateLimitPerMin
id = "key:" + k.ID id = "key:" + k.ID
subject = k.ID
quota = k.QuotaTotal
} }
res := h.limiter.Allow(r.Context(), id, limit, time.Minute) res := h.limiter.Allow(r.Context(), id, limit, time.Minute)
@@ -61,8 +66,36 @@ func (h *Handler) rateLimit(next http.Handler) http.Handler {
return 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 != "" { if keyID != "" {
h.limiter.RecordUsage(r.Context(), 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))) next.ServeHTTP(w, r.WithContext(context.WithValue(r.Context(), apiKeyIDKey, keyID)))
return return
} }
@@ -70,6 +103,25 @@ func (h *Handler) rateLimit(next http.Handler) http.Handler {
}) })
} }
// 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. // presentedKey extracts an API key from the X-API-Key header or a Bearer token.
func presentedKey(r *http.Request) string { func presentedKey(r *http.Request) string {
if v := strings.TrimSpace(r.Header.Get("X-API-Key")); v != "" { if v := strings.TrimSpace(r.Header.Get("X-API-Key")); v != "" {
+31 -1
View File
@@ -10,7 +10,8 @@
"tags": [ "tags": [
{ "name": "products" }, { "name": "products" },
{ "name": "catalog" }, { "name": "catalog" },
{ "name": "meta" } { "name": "meta" },
{ "name": "account" }
], ],
"security": [{ "ApiKeyHeader": [] }, { "BearerKey": [] }, {}], "security": [{ "ApiKeyHeader": [] }, { "BearerKey": [] }, {}],
"paths": { "paths": {
@@ -114,6 +115,35 @@
"parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }], "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }],
"responses": { "200": { "description": "Source" }, "404": { "$ref": "#/components/responses/NotFound" } } "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": { "components": {
+39
View File
@@ -116,6 +116,45 @@ func (l *Limiter) RecordUsage(ctx context.Context, keyID string) {
_, _ = pipe.Exec(ctx) _, _ = 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. // Usage reads aggregated usage for a key. Returns a zero-value stat on error.
func (l *Limiter) Usage(ctx context.Context, keyID string) UsageStat { func (l *Limiter) Usage(ctx context.Context, keyID string) UsageStat {
var st UsageStat var st UsageStat
+169
View File
@@ -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
}
+99
View File
@@ -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)
}
}
+88 -7
View File
@@ -4,8 +4,10 @@ package store
import ( import (
"context" "context"
"encoding/json"
"errors" "errors"
"strconv" "strconv"
"strings"
"github.com/jackc/pgx/v5" "github.com/jackc/pgx/v5"
"github.com/jackc/pgx/v5/pgxpool" "github.com/jackc/pgx/v5/pgxpool"
@@ -56,6 +58,15 @@ type Barcode struct {
IsPrimary bool `json:"is_primary"` 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. // Product is the full public view of a product.
type Product struct { type Product struct {
ID string `json:"id"` ID string `json:"id"`
@@ -64,11 +75,13 @@ type Product struct {
Brand *string `json:"brand"` Brand *string `json:"brand"`
CategoryPath *string `json:"category_path"` CategoryPath *string `json:"category_path"`
GPCBrickCode *string `json:"gpc_brick_code"` GPCBrickCode *string `json:"gpc_brick_code"`
ArchiveKind string `json:"archive_kind"`
NetContentValue *float64 `json:"net_content_value"` NetContentValue *float64 `json:"net_content_value"`
NetContentUnit *string `json:"net_content_unit"` NetContentUnit *string `json:"net_content_unit"`
CountryOfOrigin *string `json:"country_of_origin"` CountryOfOrigin *string `json:"country_of_origin"`
QualityScore float64 `json:"quality_score"` QualityScore float64 `json:"quality_score"`
Barcodes []Barcode `json:"barcodes"` Barcodes []Barcode `json:"barcodes"`
Specs []ProductSpec `json:"specs,omitempty"`
Nutriments map[string]any `json:"nutriments,omitempty"` Nutriments map[string]any `json:"nutriments,omitempty"`
NutritionBasis *string `json:"nutrition_basis,omitempty"` NutritionBasis *string `json:"nutrition_basis,omitempty"`
NutriScore *string `json:"nutri_score,omitempty"` NutriScore *string `json:"nutri_score,omitempty"`
@@ -120,6 +133,7 @@ type SearchFilters struct {
const productSelect = ` const productSelect = `
SELECT p.id, p.gtin, p.name, b.name, c.path::text, p.gpc_brick_code, 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, 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.nutriments, f.nutrition_basis, f.nutri_score, f.ingredients_text,
f.allergens, f.additives f.allergens, f.additives
@@ -129,21 +143,81 @@ LEFT JOIN category c ON c.id = p.category_id
LEFT JOIN food_detail f ON f.product_id = p.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 p Product
var attributes []byte
err := row.Scan( err := row.Scan(
&p.ID, &p.GTIN, &p.Name, &p.Brand, &p.CategoryPath, &p.GPCBrickCode, &p.ID, &p.GTIN, &p.Name, &p.Brand, &p.CategoryPath, &p.GPCBrickCode,
&p.ArchiveKind, &attributes,
&p.NetContentValue, &p.NetContentUnit, &p.CountryOfOrigin, &p.QualityScore, &p.NetContentValue, &p.NetContentUnit, &p.CountryOfOrigin, &p.QualityScore,
&p.Nutriments, &p.NutritionBasis, &p.NutriScore, &p.Ingredients, &p.Nutriments, &p.NutritionBasis, &p.NutriScore, &p.Ingredients,
&p.Allergens, &p.Additives, &p.Allergens, &p.Additives,
) )
if errors.Is(err, pgx.ErrNoRows) { 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 { if err != nil {
return nil, err 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()
}
// 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. // ProductByGTIN looks up an active product by any of its barcodes.
@@ -154,26 +228,32 @@ func (s *Store) ProductByGTIN(ctx context.Context, gtin string) (*Product, error
SELECT 1 FROM product_barcode pb SELECT 1 FROM product_barcode pb
WHERE pb.product_id = p.id AND pb.gtin = $1)) WHERE pb.product_id = p.id AND pb.gtin = $1))
LIMIT 1`, gtin) LIMIT 1`, gtin)
p, err := scanProduct(row) p, attrs, err := scanProduct(row)
if err != nil { if err != nil {
return nil, err return nil, err
} }
if p.Barcodes, err = s.ProductBarcodes(ctx, p.ID); err != nil { if p.Barcodes, err = s.ProductBarcodes(ctx, p.ID); err != nil {
return nil, err return nil, err
} }
if p.Specs, err = s.buildSpecs(ctx, p.ArchiveKind, attrs); err != nil {
return nil, err
}
return p, nil return p, nil
} }
// ProductByID looks up a product by its UUID. // ProductByID looks up a product by its UUID.
func (s *Store) ProductByID(ctx context.Context, id string) (*Product, error) { func (s *Store) ProductByID(ctx context.Context, id string) (*Product, error) {
row := s.pool.QueryRow(ctx, productSelect+" WHERE p.id = $1", id) row := s.pool.QueryRow(ctx, productSelect+" WHERE p.id = $1", id)
p, err := scanProduct(row) p, attrs, err := scanProduct(row)
if err != nil { if err != nil {
return nil, err return nil, err
} }
if p.Barcodes, err = s.ProductBarcodes(ctx, p.ID); err != nil { if p.Barcodes, err = s.ProductBarcodes(ctx, p.ID); err != nil {
return nil, err return nil, err
} }
if p.Specs, err = s.buildSpecs(ctx, p.ArchiveKind, attrs); err != nil {
return nil, err
}
return p, nil return p, nil
} }
@@ -373,6 +453,7 @@ type APIKey struct {
ID string ID string
Name string Name string
RateLimitPerMin int RateLimitPerMin int
QuotaTotal int64
} }
// APIKeyByHash returns the active (non-revoked) key matching a SHA-256 hash, // APIKeyByHash returns the active (non-revoked) key matching a SHA-256 hash,
@@ -380,9 +461,9 @@ type APIKey struct {
func (s *Store) APIKeyByHash(ctx context.Context, hash string) (*APIKey, error) { func (s *Store) APIKeyByHash(ctx context.Context, hash string) (*APIKey, error) {
var k APIKey var k APIKey
err := s.pool.QueryRow(ctx, err := s.pool.QueryRow(ctx,
`SELECT id, name, rate_limit_per_min `SELECT id, name, rate_limit_per_min, quota_total
FROM api_key WHERE key_hash = $1 AND revoked_at IS NULL`, hash, FROM api_key WHERE key_hash = $1 AND revoked_at IS NULL`, hash,
).Scan(&k.ID, &k.Name, &k.RateLimitPerMin) ).Scan(&k.ID, &k.Name, &k.RateLimitPerMin, &k.QuotaTotal)
if errors.Is(err, pgx.ErrNoRows) { if errors.Is(err, pgx.ErrNoRows) {
return nil, ErrNotFound return nil, ErrNotFound
} }
+112
View File
@@ -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`
+116
View File
@@ -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,
}
+155
View File
@@ -14,6 +14,10 @@ from typing import Any
import psycopg import psycopg
from psycopg.types.json import Jsonb 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.adapters.openfoodfacts import OFF_LICENSE, SOURCE_NAME
from opengoods.etl.quality import update_quality from opengoods.etl.quality import update_quality
@@ -73,6 +77,23 @@ def _ensure_brand(conn: psycopg.Connection, name: str | None) -> str | None:
return row[0] 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]: def _category_id(conn: psycopg.Connection, path: str | None) -> tuple[str | None, str | None]:
if not path: if not path:
return None, None return None, None
@@ -218,6 +239,140 @@ def load_record_safe(
return False 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: def _jsonable(raw: dict) -> dict:
"""Drop values that are not JSON-serializable from a raw record.""" """Drop values that are not JSON-serializable from a raw record."""
try: try:
+77
View File
@@ -0,0 +1,77 @@
"""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.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()
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())
+155
View File
@@ -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()
+9
View File
@@ -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;
+64
View File
@@ -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';
+10
View File
@@ -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;
+27
View File
@@ -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));
+12 -1
View File
@@ -3,7 +3,18 @@
<head> <head>
<meta charset="UTF-8" /> <meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <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> </head>
<body> <body>
<div id="root"></div> <div id="root"></div>
+86 -44
View File
@@ -1,65 +1,86 @@
import { useState } from "react"; import { useEffect, useState } from "react";
import { Boxes, Search, PlusCircle, Code2 } from "lucide-react"; import { Boxes, Search, PlusCircle, Code2, KeyRound, Headset } from "lucide-react";
import Home from "./components/Home"; import Home from "./components/Home";
import ProductView from "./components/ProductView"; import ProductView from "./components/ProductView";
import Contribute from "./components/Contribute"; import Contribute from "./components/Contribute";
import ApiDocs from "./components/ApiDocs"; import ApiDocs from "./components/ApiDocs";
import Account from "./components/Account";
import Contact from "./components/Contact";
import { api } from "./api";
type View = type View =
| { name: "home" } | { name: "home" }
| { name: "product"; id: string } | { name: "product"; id: string }
| { name: "contribute" } | { 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() { export default function App() {
const [view, setView] = useState<View>({ name: "home" }); 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 ( return (
<div className="min-h-full flex flex-col"> <div className="min-h-full flex flex-col">
<header className="bg-white border-b"> <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-14 flex items-center justify-between"> <div className="max-w-5xl mx-auto px-4 h-16 flex items-center justify-between gap-4">
<button <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" })} onClick={() => setView({ name: "home" })}
> >
<Boxes className="w-6 h-6 text-emerald-600" /> <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">
<span className="text-gray-400 font-normal text-sm"></span> <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> </button>
<nav className="flex items-center gap-1 text-sm"> <nav className="flex items-center gap-0.5 text-sm">
<button {NAV.map(({ key, label, icon: Icon }) => {
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${ const active =
view.name === "home" ? "bg-emerald-50 text-emerald-700" : "text-gray-600 hover:bg-gray-100" view.name === key || (key === "home" && view.name === "product");
}`} return (
onClick={() => setView({ name: "home" })} <button
> key={key}
<Search className="w-4 h-4" /> className={`px-3 py-1.5 rounded-lg flex items-center gap-1.5 font-medium transition ${
</button> active
<button ? "bg-brand-50 text-brand-700"
className={`px-3 py-1.5 rounded-md flex items-center gap-1.5 ${ : "text-gray-600 hover:bg-gray-100"
view.name === "contribute" ? "bg-emerald-50 text-emerald-700" : "text-gray-600 hover:bg-gray-100" }`}
}`} onClick={() => setView({ name: key } as View)}
onClick={() => setView({ name: "contribute" })} >
> <Icon className="w-4 h-4" />
<PlusCircle className="w-4 h-4" /> <span className="hidden sm:inline">{label}</span>
</button> </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> </nav>
</div> </div>
</header> </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" && ( {view.name === "home" && (
<Home <Home
onOpen={(id) => setView({ name: "product", id })} onOpen={(id) => setView({ name: "product", id })}
onContribute={() => setView({ name: "contribute" })} onContribute={() => setView({ name: "contribute" })}
onApi={() => setView({ name: "api" })}
/> />
)} )}
{view.name === "product" && ( {view.name === "product" && (
@@ -68,17 +89,38 @@ export default function App() {
{view.name === "contribute" && ( {view.name === "contribute" && (
<Contribute onDone={() => setView({ name: "home" })} /> <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> </main>
<footer className="border-t bg-white"> <footer className="border-t border-gray-200/70 bg-white/60">
<div className="max-w-5xl mx-auto px-4 py-4 text-xs text-gray-400 leading-relaxed"> <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">
<button onClick={() => setView({ name: "api" })} className="ml-1 text-emerald-600 hover:underline">
API <span className="font-semibold text-brand-600">
</button> {qualified.toLocaleString()}
<div className="mt-2"> </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 <a
href="https://beian.miit.gov.cn/" href="https://beian.miit.gov.cn/"
target="_blank" target="_blank"
+32
View File
@@ -36,6 +36,23 @@ export interface Stats {
min_score: 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 = { export const api = {
stats: () => req<Stats>(`/api/v1/stats`), stats: () => req<Stats>(`/api/v1/stats`),
search: (q: string, page = 1, size = 20, filters: SearchFilters = {}) => { search: (q: string, page = 1, size = 20, filters: SearchFilters = {}) => {
@@ -55,4 +72,19 @@ export const api = {
method: "POST", method: "POST",
body: JSON.stringify(input), 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 }),
}),
}; };
+192
View File
@@ -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>
);
}
+99 -14
View File
@@ -20,7 +20,7 @@ function CopyBtn({ text }: { text: string }) {
className="text-gray-400 hover:text-gray-600" className="text-gray-400 hover:text-gray-600"
title="复制" 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> </button>
); );
} }
@@ -39,7 +39,7 @@ function Code({ children }: { children: string }) {
} }
function Method({ m }: { m: 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>; 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; response: string;
}) { }) {
return ( return (
<div className="bg-white border rounded-lg p-5"> <div className="card p-5">
<div className="flex items-center gap-2 flex-wrap"> <div className="flex items-center gap-2 flex-wrap">
<Method m={method} /> <Method m={method} />
<code className="text-sm text-gray-800 font-mono break-all">{path}</code> <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 ( return (
<div className="space-y-5"> <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> <h1 className="text-2xl font-bold text-gray-800">API </h1>
<p className="mt-2 text-gray-600 text-sm leading-relaxed"> <p className="mt-2 text-gray-600 text-sm leading-relaxed">
<strong></strong> REST API <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> <code className="font-mono bg-gray-100 rounded px-1.5 py-0.5">{BASE}</code>
</div> </div>
<ul className="mt-2 list-disc pl-5 text-gray-600 space-y-1"> <ul className="mt-2 list-disc pl-5 text-gray-600 space-y-1">
<li> API Key / Token GET Key </li> <li>
API Key / Token GET IP <strong>1000</strong>
<button onClick={onRegister} className="text-brand-600 hover:underline"></button>
</li>
<li> <li>
<code className="font-mono">page</code> 1 <code className="font-mono">page</code> 1
<code className="font-mono">size</code> 20 100 <code className="font-mono">size</code> 20 100
@@ -131,11 +135,14 @@ export default function ApiDocs() {
</div> </div>
</div> </div>
<div className="bg-white border rounded-lg p-5"> <div className="card p-5">
<h2 className="text-lg font-semibold text-gray-800"></h2> <h2 className="text-lg font-semibold text-gray-800"></h2>
<p className="mt-2 text-gray-600 text-sm leading-relaxed"> <p className="mt-2 text-gray-600 text-sm leading-relaxed">
API <strong></strong> IP API <strong></strong> IP
API Key <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> </p>
<div className="mt-3"> <div className="mt-3">
<Code>{`# 二选一 <Code>{`# 二选一
@@ -143,7 +150,7 @@ curl -H "X-API-Key: og_live_xxxxxxxx" ${BASE}/products/search?q=牛奶
curl -H "Authorization: Bearer og_live_xxxxxxxx" ${BASE}/products/search?q=牛奶`}</Code> curl -H "Authorization: Bearer og_live_xxxxxxxx" ${BASE}/products/search?q=牛奶`}</Code>
</div> </div>
<p className="mt-3 text-gray-600 text-sm leading-relaxed"> <p className="mt-3 text-gray-600 text-sm leading-relaxed">
<strong></strong>便 <strong></strong><strong></strong>便
</p> </p>
<table className="mt-3 w-full text-sm"> <table className="mt-3 w-full text-sm">
<thead className="text-gray-400 text-left"> <thead className="text-gray-400 text-left">
@@ -169,12 +176,26 @@ curl -H "Authorization: Bearer og_live_xxxxxxxx" ${BASE}/products/search?q=牛
<td className="pr-4 py-0.5 font-mono text-gray-700">Retry-After</td> <td className="pr-4 py-0.5 font-mono text-gray-700">Retry-After</td>
<td className="py-0.5 text-gray-600"></td> <td className="py-0.5 text-gray-600"></td>
</tr> </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> </tbody>
</table> </table>
<p className="mt-3 text-gray-600 text-sm leading-relaxed"> <p className="mt-3 text-gray-600 text-sm leading-relaxed">
<code className="font-mono">429 Too Many Requests</code> <code className="font-mono">429 Too Many Requests</code>
<code className="font-mono">rate_limited</code> Key <code className="font-mono">rate_limited</code>
<code className="font-mono">401</code> <code className="font-mono">invalid_api_key</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> </p>
</div> </div>
@@ -322,6 +343,70 @@ curl -H "Authorization: Bearer og_live_xxxxxxxx" ${BASE}/products/search?q=牛
}`} }`}
/> />
<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"> <div className="text-xs text-gray-400 leading-relaxed">
/ /
OpenFoodFacts ODbL OpenFoodFacts ODbL
+113
View File
@@ -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>
);
}
+16 -22
View File
@@ -89,38 +89,36 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
if (done) { if (done) {
return ( return (
<div className="max-w-xl mx-auto text-center py-16"> <div className="max-w-xl mx-auto text-center py-16 animate-fade-up">
<CheckCircle2 className="w-14 h-14 text-emerald-500 mx-auto" /> <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> <h1 className="mt-4 text-xl font-semibold text-gray-800"></h1>
<p className="mt-2 text-gray-500"> <p className="mt-2 text-gray-500">
</p> </p>
<button <button onClick={onDone} className="btn-primary mt-6">
onClick={onDone}
className="mt-6 px-5 py-2 rounded-lg bg-emerald-600 text-white hover:bg-emerald-700"
>
</button> </button>
</div> </div>
); );
} }
const input = const input = "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 font-medium text-gray-500 mb-1";
const label = "block text-xs text-gray-500 mb-1";
return ( return (
<form onSubmit={submit} className="max-w-3xl mx-auto"> <form onSubmit={submit} className="max-w-3xl mx-auto animate-fade-up">
<h1 className="text-xl font-semibold text-gray-800"></h1> <h1 className="text-2xl font-semibold tracking-tight text-gray-900"></h1>
<p className="mt-1 text-sm text-gray-500"> <p className="mt-1 text-sm text-gray-500">
<b></b> * <b></b> *
</p> </p>
{error && ( {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> <h2 className="font-medium text-gray-700 mb-3"></h2>
<div className="grid grid-cols-1 sm:grid-cols-2 gap-4"> <div className="grid grid-cols-1 sm:grid-cols-2 gap-4">
<div className="sm:col-span-2"> <div className="sm:col-span-2">
@@ -167,7 +165,7 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
</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"></h2> <h2 className="font-medium text-gray-700 mb-3"></h2>
<label className={label}></label> <label className={label}></label>
<textarea <textarea
@@ -201,7 +199,7 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
</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> <h2 className="font-medium text-gray-700 mb-3"> URL</h2>
{images.length > 0 && ( {images.length > 0 && (
<ul className="mb-3 space-y-1"> <ul className="mb-3 space-y-1">
@@ -234,14 +232,14 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
setImageURL(""); 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" /> <PlusCircle className="w-4 h-4" />
</button> </button>
</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"></h2> <h2 className="font-medium text-gray-700 mb-3"></h2>
<div className="grid grid-cols-1 sm:grid-cols-2 gap-4"> <div className="grid grid-cols-1 sm:grid-cols-2 gap-4">
<div> <div>
@@ -260,11 +258,7 @@ export default function Contribute({ onDone }: { onDone: () => void }) {
</div> </div>
<div className="mt-5 flex items-center gap-3"> <div className="mt-5 flex items-center gap-3">
<button <button type="submit" disabled={submitting} className="btn-primary px-6">
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"
>
{submitting ? "提交中…" : "提交审核"} {submitting ? "提交中…" : "提交审核"}
</button> </button>
<button type="button" onClick={onDone} className="text-sm text-gray-500 hover:underline"> <button type="button" onClick={onDone} className="text-sm text-gray-500 hover:underline">
+102 -89
View File
@@ -1,43 +1,50 @@
import { useEffect, useState } from "react"; 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 { api } from "../api";
import type { ProductSummary } from "../types"; 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({ export default function Home({
onOpen, onOpen,
onContribute, onContribute,
onApi,
}: { }: {
onOpen: (id: string) => void; onOpen: (id: string) => void;
onContribute: () => void; onContribute: () => void;
onApi: () => void;
}) { }) {
const [q, setQ] = useState(""); const [q, setQ] = useState("");
const [brand, setBrand] = useState("");
const [country, setCountry] = useState("");
const [items, setItems] = useState<ProductSummary[]>([]); const [items, setItems] = useState<ProductSummary[]>([]);
const [total, setTotal] = useState(0); const [total, setTotal] = useState(0);
const [searched, setSearched] = useState(false); const [searched, setSearched] = useState(false);
const [loading, setLoading] = useState(false); const [loading, setLoading] = useState(false);
const [error, setError] = useState(""); const [error, setError] = useState("");
const [qualified, setQualified] = useState<number | null>(null);
useEffect(() => { async function run(term?: string, e?: React.FormEvent) {
api
.stats()
.then((s) => setQualified(s.qualified))
.catch(() => setQualified(null));
}, []);
async function run(e?: React.FormEvent) {
e?.preventDefault(); e?.preventDefault();
const keyword = (term ?? q).trim();
if (term !== undefined) setQ(term);
setLoading(true); setLoading(true);
setError(""); setError("");
try { try {
const res = await api.search(q.trim(), 1, 30, { const res = await api.search(keyword, 1, 30);
brand: brand.trim() || undefined,
country: country.trim() || undefined,
});
setItems(res.items); setItems(res.items);
setTotal(res.total); setTotal(res.total);
setSearched(true); setSearched(true);
@@ -49,110 +56,116 @@ export default function Home({
} }
return ( return (
<div> <div className="animate-fade-up">
<div className="text-center py-10"> <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">
<h1 className="text-3xl font-bold text-gray-800"></h1> <div
<p className="mt-2 text-gray-500"> 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"
</p> />
{qualified != null && ( <div className="relative">
<p className="mt-3 text-sm text-gray-500"> <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 className="mx-1 font-semibold text-emerald-600"> </span>
{qualified.toLocaleString()} <h1 className="mt-5 text-4xl sm:text-5xl font-extrabold tracking-tight text-gray-900">
</span> <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> </p>
)}
<form onSubmit={run} className="mt-6 max-w-2xl mx-auto flex gap-2"> <form onSubmit={(e) => run(undefined, e)} className="mx-auto mt-7 flex max-w-2xl 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"> <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="w-5 h-5 text-gray-400" /> <Search className="h-5 w-5 shrink-0 text-gray-400" />
<input <input
autoFocus autoFocus
value={q} value={q}
onChange={(e) => setQ(e.target.value)} onChange={(e) => setQ(e.target.value)}
placeholder="例如:可乐、Nutella、5449000000996" placeholder="例如:可乐、Nutella、5449000000996"
className="flex-1 py-3 outline-none bg-transparent" 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> </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>
<div className="mt-3 max-w-2xl mx-auto flex flex-wrap items-center justify-center gap-2 text-sm">
<input
value={brand}
onChange={(e) => setBrand(e.target.value)}
placeholder="按品牌筛选(如 Ferrero"
className="flex-1 min-w-[14rem] bg-white border rounded-lg px-3 py-2 outline-none focus:ring-2 focus:ring-emerald-300"
/>
<input
value={country}
onChange={(e) => setCountry(e.target.value)}
placeholder="按产地筛选(如 China"
className="flex-1 min-w-[14rem] bg-white border rounded-lg px-3 py-2 outline-none focus:ring-2 focus:ring-emerald-300"
/>
</div> </div>
<button </section>
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>
{error && ( {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} {error}
</div> </div>
)} )}
{searched && ( {searched ? (
<div className="mt-2"> <div className="mt-8">
<div className="text-sm text-gray-500 mb-2"> <div className="mb-3 text-sm text-gray-500">
{total} {q ? `(关键词:${q}` : ""} <span className="font-semibold text-gray-700">{total}</span>
{q ? `(关键词:${q}` : ""}
</div> </div>
{items.length === 0 ? ( {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> <p></p>
<button <button
onClick={onContribute} 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" /> <PlusCircle className="w-4 h-4" />
</button> </button>
</div> </div>
) : ( ) : (
<ul className="bg-white border rounded-lg divide-y"> <ul className="card divide-y divide-gray-100 overflow-hidden">
{items.map((p) => ( {items.map((p) => (
<li key={p.id}> <li key={p.id}>
<button <button
onClick={() => onOpen(p.id)} 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="min-w-0">
<div className="font-medium text-gray-800">{p.name}</div> <div className="truncate font-medium text-gray-800 group-hover:text-brand-700">
<div className="text-xs text-gray-500 mt-0.5"> {p.name}
</div>
<div className="mt-0.5 text-xs text-gray-500">
{p.brand || "未知品牌"} {p.brand || "未知品牌"}
{p.gtin ? ` · ${p.gtin}` : ""} {p.gtin ? ` · ${p.gtin}` : ""}
</div> </div>
</div> </div>
<span className="text-xs text-gray-400 text-right"> <div className="flex shrink-0 items-center gap-3">
<span className="block">{p.category_path || ""}</span> <span className="text-right text-xs text-gray-400">
{p.country_of_origin ? ( <span className="block">{p.category_path || ""}</span>
<span className="block text-gray-400">{p.country_of_origin}</span> {p.country_of_origin ? (
) : null} <span className="block">{p.country_of_origin}</span>
</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> </button>
</li> </li>
))} ))}
</ul> </ul>
)} )}
</div> </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> </div>
); );
+24 -7
View File
@@ -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"> <button onClick={onBack} className="text-sm text-gray-500 flex items-center gap-1 mb-4">
<ArrowLeft className="w-4 h-4" /> <ArrowLeft className="w-4 h-4" />
</button> </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> </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> = { const basisLabel: Record<string, string> = {
per_100g: "每 100g", per_100g: "每 100g",
@@ -45,14 +45,14 @@ export default function ProductView({ id, onBack }: { id: string; onBack: () =>
return ( return (
<div> <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" /> <ArrowLeft className="w-4 h-4" />
</button> </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"> <div className="flex items-start justify-between gap-4">
<h1 className="text-xl font-semibold text-gray-800">{p.name}</h1> <h1 className="text-2xl font-semibold tracking-tight text-gray-900">{p.name}</h1>
<span className="shrink-0 text-xs bg-emerald-50 text-emerald-700 rounded px-2 py-1"> <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)} {Math.round(p.quality_score * 100)}
</span> </span>
</div> </div>
@@ -106,8 +106,25 @@ export default function ProductView({ id, onBack }: { id: string; onBack: () =>
</div> </div>
</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 && ( {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"> <h2 className="font-medium text-gray-700 mb-2">
{p.nutrition_basis ? `${basisLabel[p.nutrition_basis] || p.nutrition_basis}` : ""} {p.nutrition_basis ? `${basisLabel[p.nutrition_basis] || p.nutrition_basis}` : ""}
+32 -3
View File
@@ -10,7 +10,36 @@ body,
body { body {
margin: 0; margin: 0;
background: #f3f4f6; color: #1f2937;
font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", font-family: theme("fontFamily.sans");
Arial, "PingFang SC", "Microsoft YaHei", sans-serif; -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;
}
} }
+9
View File
@@ -17,6 +17,13 @@ export interface Barcode {
is_primary: boolean; is_primary: boolean;
} }
export interface ProductSpec {
key: string;
label: string;
value: string;
unit?: string;
}
export interface Product { export interface Product {
id: string; id: string;
gtin: string | null; gtin: string | null;
@@ -24,6 +31,8 @@ export interface Product {
name: string; name: string;
brand: string | null; brand: string | null;
category_path: string | null; category_path: string | null;
archive_kind?: string;
specs?: ProductSpec[] | null;
net_content_value: number | null; net_content_value: number | null;
net_content_unit: string | null; net_content_unit: string | null;
country_of_origin: string | null; country_of_origin: string | null;
+50 -1
View File
@@ -1,6 +1,55 @@
/** @type {import('tailwindcss').Config} */ /** @type {import('tailwindcss').Config} */
export default { export default {
content: ["./index.html", "./src/**/*.{ts,tsx}"], 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: [], plugins: [],
}; };
+9
View File
@@ -0,0 +1,9 @@
# build artifacts
bypos-collector.exe
bypos-collector
bypos-collector-linux
*.exe
# collected data / outputs
*.jsonl
*.csv
*.log
+82
View File
@@ -0,0 +1,82 @@
# bypos-collector
按条码批量采集商品档案的小工具(单文件 Windows/Linux 程序,自带本地 Web 控制台)。
数据来源是云店「新增商品」输入条码时所查的同一个中心商品库 `zc.bypos.net`
采集结果落地为 JSONL,供后续导入本项目(天工/goods)。
> 这是一个**独立模块**(有自己的 `go.mod`),与 `api/` 主服务互不影响,
> CI 不会编译它。放在 `tools/` 下仅作代码留存与后期迭代。
## 目录
| 文件 | 说明 |
| --- | --- |
| `main.go` | 入口:本地 HTTP 服务 + 启动浏览器 + API 路由(start/stop/stats/download/export.csv) |
| `collect.go` | 核心:签名、EAN-13 校验位、范围/清单枚举、并发+限速、JSONL 落库、断点续采 |
| `web/index.html` | 内嵌(`go:embed`)的控制台界面 |
| `build.sh` | 交叉编译出 `bypos-collector.exe`(windows/amd64)与 linux 测试二进制 |
| `使用说明.md` | 面向使用者的操作说明 |
## 构建
```bash
./build.sh
# 产物:bypos-collector.exe(发给 Windows 用户)/ bypos-collector-linux(本地测试)
```
二进制与采集产物(`*.jsonl`/`*.csv`)已在 `.gitignore` 中排除,不入库。
## 接口与签名(逆向所得,后期迭代参考)
云店新增商品页输入条码时,前端经服务端代理 `/prod-api/ZmSvr/httpUtil/getGet`
转发到中心库:
```
GET http://zc.bypos.net/byGoodsService/byMessage.asmx/GetGoodsinfo
?sdogid=<账号id>&regnum=1&barcode=<条码>
&sparm1=<md5(sdogid)> # 常量,随账号固定
&sparm2=<md5(barcode + tsMs)> # tsMs = 当前秒*1000(末尾恒为 000)
&sparm3=<tsMs 前 10 位 = 秒级时间戳>
&sparm4=&barcodetype=yunpos
```
返回 `<string>{...json...}</string>`,内层 JSON 字段:
| 上游字段 | 含义 | 归一化字段 |
| --- | --- | --- |
| item_name | 品名 | name |
| item_size | 规格 | spec |
| unit_no | 单位 | unit |
| item_area | 产地/地区 | area |
| birth_com | 生产企业(常空) | manufacturer |
| birth_doc | 生产许可(常空) | license |
| inprice | 建议进价 | in_price |
| sellprice | 建议零售价 | sell_price |
| retcode | 1=命中,0=失败 | status(hit/miss/invalid) |
`retmsg` 含「非国标条码 / 参数异常」=> invalid;含「条码不存在」=> miss。
## 配置
- `sdogid`:中心库账号 id(本项目所属云店账号的授权 id)。默认值见
`collect.go``defaultSdogID`,也可用 `-sdogid` 参数或控制台覆盖。
**这是账号级凭证**——若本仓库对外公开,建议改为从环境变量/外部配置读取。
## 导入 goods/天工库
采集得到的 JSONL 用 ingestion 里的导入任务入库(只导入 `status=hit` 的记录,
按 GTIN 去重 upsert,重复导入幂等):
```bash
cd ingestion
python -m opengoods.jobs.import_bypos --input products.jsonl
# 可选:--limit N 限制条数;--dsn 指定数据库
```
字段映射:`barcode→gtin``name→name``spec`(可解析的质量/体积如 500mL/5kg)
`→net_content`、其余规格/单位/产地/许可/进价留存到 `attributes``sell_price→`
CNY MSRP 快照。来源记为 `bypos中心库`,带字段级 provenance。
## 注意
批量自动查询比页面逐条更"重",上游可能对账号限频。请低速、分前缀/品类分批采集。
+11
View File
@@ -0,0 +1,11 @@
#!/usr/bin/env bash
# Build the bypos-collector for Windows (and a Linux binary for local testing).
set -euo pipefail
cd "$(dirname "$0")"
gofmt -w ./*.go
go vet ./...
echo "building windows/amd64 .exe ..."
GOOS=windows GOARCH=amd64 go build -ldflags "-s -w" -o bypos-collector.exe .
echo "building linux/amd64 (for testing) ..."
go build -o bypos-collector-linux .
ls -la bypos-collector.exe bypos-collector-linux
+481
View File
@@ -0,0 +1,481 @@
package main
import (
"context"
"crypto/md5"
"encoding/hex"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"path/filepath"
"regexp"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
)
// ---- upstream config ----
// sdogid is the 云店 account license id observed in the live request. It is
// configurable so the tool is not tied to a single account.
const defaultSdogID = "137966"
const endpoint = "http://zc.bypos.net/byGoodsService/byMessage.asmx/GetGoodsinfo"
var stringTagRe = regexp.MustCompile(`(?s)<string[^>]*>(.*)</string>`)
// Product is the normalized record we persist (one JSON object per line).
type Product struct {
Barcode string `json:"barcode"`
Name string `json:"name"` // item_name 品名
Spec string `json:"spec"` // item_size 规格
Unit string `json:"unit"` // unit_no 单位
Area string `json:"area"` // item_area 产地/地区
Manufacturer string `json:"manufacturer"` // birth_com 生产企业
License string `json:"license"` // birth_doc 生产许可
InPrice string `json:"in_price"` // 建议进价
SellPrice string `json:"sell_price"` // 建议零售价
Status string `json:"status"` // hit / miss / invalid / error
RetMsg string `json:"retmsg"` // 原始返回信息
FetchedAt string `json:"fetched_at"` // RFC3339
Source string `json:"source"` // zc.bypos.net
}
// upstream raw fields
type rawResp struct {
RetCode string `json:"retcode"`
RetMsg string `json:"retmsg"`
Barcode string `json:"barcode"`
ItemName string `json:"item_name"`
UnitNo string `json:"unit_no"`
ItemSize string `json:"item_size"`
ItemArea string `json:"item_area"`
BirthCom string `json:"birth_com"`
BirthDoc string `json:"birth_doc"`
InPrice string `json:"inprice"`
SellPrice string `json:"sellprice"`
}
func md5hex(s string) string {
h := md5.Sum([]byte(s))
return hex.EncodeToString(h[:])
}
// ean13Check computes the EAN-13 check digit for a 12-digit body.
func ean13Check(body string) (string, bool) {
if len(body) != 12 {
return "", false
}
sum := 0
for i := 0; i < 12; i++ {
c := body[i]
if c < '0' || c > '9' {
return "", false
}
d := int(c - '0')
if i%2 == 0 {
sum += d
} else {
sum += d * 3
}
}
chk := (10 - (sum % 10)) % 10
return body + strconv.Itoa(chk), true
}
// lookup queries the upstream central library for one barcode.
func (c *Collector) lookup(ctx context.Context, barcode string) (*Product, error) {
tsMs := strconv.FormatInt(time.Now().Unix()*1000, 10) // always ends in 000
sparm1 := md5hex(c.sdogID)
sparm2 := md5hex(barcode + tsMs)
sparm3 := tsMs[:10]
q := url.Values{}
q.Set("sdogid", c.sdogID)
q.Set("regnum", "1")
q.Set("barcode", barcode)
q.Set("sparm1", sparm1)
q.Set("sparm2", sparm2)
q.Set("sparm3", sparm3)
q.Set("sparm4", "")
q.Set("barcodetype", "yunpos")
reqURL := endpoint + "?" + q.Encode()
req, _ := http.NewRequestWithContext(ctx, "GET", reqURL, nil)
req.Header.Set("User-Agent", "Mozilla/5.0")
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
b, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
inner := b
if m := stringTagRe.FindSubmatch(b); m != nil {
inner = m[1]
}
var r rawResp
if err := json.Unmarshal(inner, &r); err != nil {
return nil, fmt.Errorf("parse: %v (body=%.120s)", err, string(b))
}
p := &Product{
Barcode: barcode,
RetMsg: r.RetMsg,
FetchedAt: time.Now().Format(time.RFC3339),
Source: "zc.bypos.net",
}
if r.RetCode == "1" {
p.Status = "hit"
p.Name = strings.TrimSpace(r.ItemName)
p.Spec = strings.TrimSpace(r.ItemSize)
p.Unit = strings.TrimSpace(r.UnitNo)
p.Area = strings.TrimSpace(r.ItemArea)
p.Manufacturer = strings.TrimSpace(r.BirthCom)
p.License = strings.TrimSpace(r.BirthDoc)
p.InPrice = strings.TrimSpace(r.InPrice)
p.SellPrice = strings.TrimSpace(r.SellPrice)
} else if strings.Contains(r.RetMsg, "非国标") || strings.Contains(r.RetMsg, "参数异常") {
p.Status = "invalid"
} else {
p.Status = "miss"
}
return p, nil
}
// ---- job / collector state ----
type Stats struct {
Running bool `json:"running"`
Total int64 `json:"total"`
Done int64 `json:"done"`
Hits int64 `json:"hits"`
Miss int64 `json:"miss"`
Invalid int64 `json:"invalid"`
Errors int64 `json:"errors"`
Skipped int64 `json:"skipped"`
Current string `json:"current"`
OutFile string `json:"out_file"`
StartedAt string `json:"started_at"`
Message string `json:"message"`
}
type Collector struct {
mu sync.Mutex
client *http.Client
sdogID string
outPath string
outFile *os.File
cancel context.CancelFunc
wg sync.WaitGroup
// atomic counters
total, done, hits, miss, invalid, errors, skipped int64
running int32
current atomic.Value // string
startedAt string
message string
seen map[string]struct{} // barcodes already in output (dedupe / resume)
recent []Product // ring of last results for UI
}
func NewCollector(sdogID string) *Collector {
if sdogID == "" {
sdogID = defaultSdogID
}
c := &Collector{
client: &http.Client{Timeout: 25 * time.Second},
sdogID: sdogID,
seen: map[string]struct{}{},
}
c.current.Store("")
return c
}
func (c *Collector) isRunning() bool { return atomic.LoadInt32(&c.running) == 1 }
func (c *Collector) snapshot() Stats {
cur, _ := c.current.Load().(string)
c.mu.Lock()
msg := c.message
out := c.outPath
started := c.startedAt
c.mu.Unlock()
return Stats{
Running: c.isRunning(),
Total: atomic.LoadInt64(&c.total),
Done: atomic.LoadInt64(&c.done),
Hits: atomic.LoadInt64(&c.hits),
Miss: atomic.LoadInt64(&c.miss),
Invalid: atomic.LoadInt64(&c.invalid),
Errors: atomic.LoadInt64(&c.errors),
Skipped: atomic.LoadInt64(&c.skipped),
Current: cur,
OutFile: out,
StartedAt: started,
Message: msg,
}
}
func (c *Collector) recentResults() []Product {
c.mu.Lock()
defer c.mu.Unlock()
out := make([]Product, len(c.recent))
copy(out, c.recent)
return out
}
func (c *Collector) pushRecent(p Product) {
c.mu.Lock()
c.recent = append(c.recent, p)
if len(c.recent) > 60 {
c.recent = c.recent[len(c.recent)-60:]
}
c.mu.Unlock()
}
// loadSeen reads an existing output file to build the dedupe set (for resume).
func (c *Collector) loadSeen(path string) error {
c.seen = map[string]struct{}{}
f, err := os.Open(path)
if err != nil {
if os.IsNotExist(err) {
return nil
}
return err
}
defer f.Close()
dec := json.NewDecoder(f)
for {
var p Product
if err := dec.Decode(&p); err != nil {
break
}
if p.Barcode != "" {
c.seen[p.Barcode] = struct{}{}
}
}
return nil
}
type JobReq struct {
Mode string `json:"mode"` // "range" | "list"
StartBody string `json:"start_body"` // 12-digit body (range mode)
EndBody string `json:"end_body"` // 12-digit body (range mode)
List string `json:"list"` // newline/space separated barcodes (list mode)
Concurrency int `json:"concurrency"` // parallel requests
DelayMs int `json:"delay_ms"` // min interval between request starts
LogMiss bool `json:"log_miss"` // also write miss/invalid lines
OutFile string `json:"out_file"`
SdogID string `json:"sdog_id"`
}
func sanitizeBarcodes(s string) []string {
fields := regexp.MustCompile(`[^0-9]+`).Split(s, -1)
var out []string
for _, f := range fields {
if f != "" {
out = append(out, f)
}
}
return out
}
// Start launches a collection job. Returns error if validation fails or busy.
func (c *Collector) Start(req JobReq) error {
if c.isRunning() {
return fmt.Errorf("已有任务在运行")
}
if req.Concurrency <= 0 {
req.Concurrency = 3
}
if req.Concurrency > 20 {
req.Concurrency = 20
}
if req.DelayMs < 0 {
req.DelayMs = 0
}
if req.OutFile == "" {
req.OutFile = "products.jsonl"
}
if req.SdogID != "" {
c.sdogID = req.SdogID
}
// Build the list of barcodes to query.
var barcodes []string
switch req.Mode {
case "list":
barcodes = sanitizeBarcodes(req.List)
if len(barcodes) == 0 {
return fmt.Errorf("条码清单为空")
}
case "range":
start, err := strconv.ParseInt(req.StartBody, 10, 64)
if err != nil || len(req.StartBody) != 12 {
return fmt.Errorf("起始码必须是 12 位数字(不含校验位)")
}
end, err := strconv.ParseInt(req.EndBody, 10, 64)
if err != nil || len(req.EndBody) != 12 {
return fmt.Errorf("结束码必须是 12 位数字(不含校验位)")
}
if end < start {
return fmt.Errorf("结束码不能小于起始码")
}
if end-start+1 > 5_000_000 {
return fmt.Errorf("单次范围过大(>500万),请缩小区间分批采集")
}
for v := start; v <= end; v++ {
body := fmt.Sprintf("%012d", v)
full, ok := ean13Check(body)
if ok {
barcodes = append(barcodes, full)
}
}
default:
return fmt.Errorf("未知模式: %s", req.Mode)
}
abs, _ := filepath.Abs(req.OutFile)
if err := c.loadSeen(abs); err != nil {
return fmt.Errorf("读取已有文件失败: %v", err)
}
f, err := os.OpenFile(abs, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
if err != nil {
return fmt.Errorf("打开输出文件失败: %v", err)
}
c.outFile = f
c.outPath = abs
// reset counters
atomic.StoreInt64(&c.total, int64(len(barcodes)))
atomic.StoreInt64(&c.done, 0)
atomic.StoreInt64(&c.hits, 0)
atomic.StoreInt64(&c.miss, 0)
atomic.StoreInt64(&c.invalid, 0)
atomic.StoreInt64(&c.errors, 0)
atomic.StoreInt64(&c.skipped, 0)
c.mu.Lock()
c.recent = nil
c.startedAt = time.Now().Format(time.RFC3339)
c.message = ""
c.mu.Unlock()
atomic.StoreInt32(&c.running, 1)
ctx, cancel := context.WithCancel(context.Background())
c.cancel = cancel
go c.run(ctx, barcodes, req)
return nil
}
func (c *Collector) Stop() {
if c.cancel != nil {
c.cancel()
}
}
func (c *Collector) run(ctx context.Context, barcodes []string, req JobReq) {
defer func() {
atomic.StoreInt32(&c.running, 0)
if c.outFile != nil {
c.outFile.Sync()
c.outFile.Close()
c.outFile = nil
}
c.current.Store("")
}()
jobs := make(chan string, req.Concurrency*2)
var writeMu sync.Mutex
// global rate limiter: one token every DelayMs
var ticker *time.Ticker
if req.DelayMs > 0 {
ticker = time.NewTicker(time.Duration(req.DelayMs) * time.Millisecond)
defer ticker.Stop()
}
worker := func() {
defer c.wg.Done()
for bc := range jobs {
if ctx.Err() != nil {
return
}
if ticker != nil {
select {
case <-ticker.C:
case <-ctx.Done():
return
}
}
c.current.Store(bc)
p, err := c.lookup(ctx, bc)
if err != nil {
if ctx.Err() != nil {
return
}
atomic.AddInt64(&c.errors, 1)
atomic.AddInt64(&c.done, 1)
ep := Product{Barcode: bc, Status: "error", RetMsg: err.Error(), FetchedAt: time.Now().Format(time.RFC3339), Source: "zc.bypos.net"}
c.pushRecent(ep)
continue
}
switch p.Status {
case "hit":
atomic.AddInt64(&c.hits, 1)
case "miss":
atomic.AddInt64(&c.miss, 1)
case "invalid":
atomic.AddInt64(&c.invalid, 1)
}
atomic.AddInt64(&c.done, 1)
c.pushRecent(*p)
if p.Status == "hit" || req.LogMiss {
line, _ := json.Marshal(p)
writeMu.Lock()
c.outFile.Write(line)
c.outFile.Write([]byte("\n"))
c.seen[bc] = struct{}{}
writeMu.Unlock()
}
}
}
for i := 0; i < req.Concurrency; i++ {
c.wg.Add(1)
go worker()
}
for _, bc := range barcodes {
if ctx.Err() != nil {
break
}
if _, ok := c.seen[bc]; ok {
atomic.AddInt64(&c.skipped, 1)
atomic.AddInt64(&c.done, 1)
continue
}
select {
case jobs <- bc:
case <-ctx.Done():
}
}
close(jobs)
c.wg.Wait()
c.mu.Lock()
if ctx.Err() != nil {
c.message = "已停止"
} else {
c.message = "采集完成"
}
c.mu.Unlock()
}
+3
View File
@@ -0,0 +1,3 @@
module byposcollector
go 1.23.4
+156
View File
@@ -0,0 +1,156 @@
package main
import (
"embed"
"encoding/csv"
"encoding/json"
"flag"
"fmt"
"io"
"io/fs"
"log"
"net"
"net/http"
"os"
"os/exec"
"runtime"
"time"
)
//go:embed web/*
var webFS embed.FS
var collector = NewCollector("")
func main() {
addr := flag.String("addr", "127.0.0.1:8765", "本地监听地址")
noOpen := flag.Bool("no-open", false, "不自动打开浏览器")
sdog := flag.String("sdogid", "", "中心库账号 id(默认使用内置值)")
flag.Parse()
if *sdog != "" {
collector.sdogID = *sdog
}
sub, _ := fs.Sub(webFS, "web")
mux := http.NewServeMux()
mux.Handle("/", http.FileServer(http.FS(sub)))
mux.HandleFunc("/api/start", handleStart)
mux.HandleFunc("/api/stop", handleStop)
mux.HandleFunc("/api/stats", handleStats)
mux.HandleFunc("/api/download", handleDownload)
mux.HandleFunc("/api/export.csv", handleExportCSV)
ln, err := net.Listen("tcp", *addr)
if err != nil {
log.Fatalf("无法监听 %s: %v", *addr, err)
}
realAddr := ln.Addr().String()
urlStr := "http://" + realAddr + "/"
fmt.Println("==============================================")
fmt.Println(" 中心库商品采集器 bypos-collector")
fmt.Println(" 控制台: " + urlStr)
fmt.Println(" 关闭本窗口即停止程序")
fmt.Println("==============================================")
if !*noOpen {
go openBrowser(urlStr)
}
log.Fatal(http.Serve(ln, mux))
}
func openBrowser(url string) {
time.Sleep(600 * time.Millisecond)
var cmd string
var args []string
switch runtime.GOOS {
case "windows":
cmd = "rundll32"
args = []string{"url.dll,FileProtocolHandler", url}
case "darwin":
cmd = "open"
args = []string{url}
default:
cmd = "xdg-open"
args = []string{url}
}
_ = exec.Command(cmd, args...).Start()
}
func writeJSON(w http.ResponseWriter, code int, v interface{}) {
w.Header().Set("Content-Type", "application/json; charset=utf-8")
w.WriteHeader(code)
json.NewEncoder(w).Encode(v)
}
func handleStart(w http.ResponseWriter, r *http.Request) {
if r.Method != "POST" {
http.Error(w, "method", 405)
return
}
var req JobReq
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeJSON(w, 400, map[string]string{"error": "请求格式错误"})
return
}
if err := collector.Start(req); err != nil {
writeJSON(w, 400, map[string]string{"error": err.Error()})
return
}
writeJSON(w, 200, map[string]string{"ok": "started"})
}
func handleStop(w http.ResponseWriter, r *http.Request) {
collector.Stop()
writeJSON(w, 200, map[string]string{"ok": "stopping"})
}
func handleStats(w http.ResponseWriter, r *http.Request) {
writeJSON(w, 200, map[string]interface{}{
"stats": collector.snapshot(),
"recent": collector.recentResults(),
})
}
func handleDownload(w http.ResponseWriter, r *http.Request) {
s := collector.snapshot()
if s.OutFile == "" {
http.Error(w, "no output yet", 404)
return
}
f, err := os.Open(s.OutFile)
if err != nil {
http.Error(w, err.Error(), 404)
return
}
defer f.Close()
w.Header().Set("Content-Type", "application/x-ndjson; charset=utf-8")
w.Header().Set("Content-Disposition", "attachment; filename=products.jsonl")
io.Copy(w, f)
}
func handleExportCSV(w http.ResponseWriter, r *http.Request) {
s := collector.snapshot()
if s.OutFile == "" {
http.Error(w, "no output yet", 404)
return
}
f, err := os.Open(s.OutFile)
if err != nil {
http.Error(w, err.Error(), 404)
return
}
defer f.Close()
w.Header().Set("Content-Type", "text/csv; charset=utf-8")
w.Header().Set("Content-Disposition", "attachment; filename=products.csv")
w.Write([]byte{0xEF, 0xBB, 0xBF}) // UTF-8 BOM so Excel reads Chinese correctly
cw := csv.NewWriter(w)
cw.Write([]string{"barcode", "name", "spec", "unit", "area", "manufacturer", "license", "in_price", "sell_price", "status", "fetched_at"})
dec := json.NewDecoder(f)
for {
var p Product
if err := dec.Decode(&p); err != nil {
break
}
cw.Write([]string{p.Barcode, p.Name, p.Spec, p.Unit, p.Area, p.Manufacturer, p.License, p.InPrice, p.SellPrice, p.Status, p.FetchedAt})
}
cw.Flush()
}
+206
View File
@@ -0,0 +1,206 @@
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>中心库商品采集器</title>
<style>
* { box-sizing: border-box; }
body { font-family: -apple-system, "Microsoft YaHei", Arial, sans-serif; margin: 0; background:#f4f6f9; color:#222; }
header { background:#1f6feb; color:#fff; padding:14px 22px; font-size:18px; font-weight:600; }
.wrap { max-width:1080px; margin:18px auto; padding:0 16px; }
.card { background:#fff; border:1px solid #e3e8ef; border-radius:10px; padding:18px 20px; margin-bottom:16px; }
.card h3 { margin:0 0 12px; font-size:15px; color:#1f6feb; }
label { display:block; font-size:13px; color:#555; margin:8px 0 4px; }
input[type=text], input[type=number], textarea, select {
width:100%; padding:8px 10px; border:1px solid #cdd5e0; border-radius:6px; font-size:14px;
}
textarea { height:90px; font-family:monospace; }
.row { display:flex; gap:14px; flex-wrap:wrap; }
.row > div { flex:1; min-width:160px; }
.tabs { display:flex; gap:8px; margin-bottom:12px; }
.tab { padding:7px 16px; border:1px solid #cdd5e0; border-radius:20px; cursor:pointer; font-size:13px; background:#fff; }
.tab.active { background:#1f6feb; color:#fff; border-color:#1f6feb; }
button.primary { background:#1f6feb; color:#fff; border:none; padding:10px 22px; border-radius:6px; font-size:14px; cursor:pointer; }
button.danger { background:#d1242f; color:#fff; border:none; padding:10px 22px; border-radius:6px; font-size:14px; cursor:pointer; }
button.ghost { background:#fff; color:#1f6feb; border:1px solid #1f6feb; padding:8px 16px; border-radius:6px; cursor:pointer; font-size:13px; }
button:disabled { opacity:.5; cursor:not-allowed; }
.stats { display:flex; gap:10px; flex-wrap:wrap; }
.stat { flex:1; min-width:90px; background:#f7f9fc; border:1px solid #e3e8ef; border-radius:8px; padding:10px; text-align:center; }
.stat .n { font-size:22px; font-weight:700; }
.stat .l { font-size:12px; color:#777; margin-top:2px; }
.bar { height:10px; background:#e3e8ef; border-radius:6px; overflow:hidden; margin:10px 0; }
.bar > div { height:100%; background:#2da44e; width:0%; transition:width .4s; }
table { width:100%; border-collapse:collapse; font-size:13px; }
th, td { text-align:left; padding:6px 8px; border-bottom:1px solid #eef1f5; white-space:nowrap; overflow:hidden; text-overflow:ellipsis; max-width:180px; }
th { color:#888; font-weight:600; }
.hit { color:#2da44e; } .miss { color:#999; } .invalid { color:#d1242f; } .error { color:#bf8700; }
.hint { font-size:12px; color:#888; margin-top:6px; line-height:1.5; }
.est { font-size:13px; color:#1f6feb; margin-top:6px; }
</style>
</head>
<body>
<header>中心库商品采集器 · bypos-collector</header>
<div class="wrap">
<div class="card">
<h3>① 规划采集范围</h3>
<div class="tabs">
<div class="tab active" data-mode="range" onclick="setMode('range')">按条码范围</div>
<div class="tab" data-mode="list" onclick="setMode('list')">按条码清单</div>
</div>
<div id="pane-range">
<div class="hint">EAN-13 国标条码共 13 位,最后一位是校验位由程序自动计算。下面填<b>前 12 位</b>(本体),程序逐个枚举并补校验位查询。常见前缀:69 开头为中国大陆。</div>
<label>快捷填充前缀(可选)</label>
<div class="row">
<div><input type="text" id="prefix" placeholder="如 690100,点下方按钮自动算区间"/></div>
<div style="flex:0"><button class="ghost" onclick="fillFromPrefix()">用前缀填充区间</button></div>
</div>
<div class="row">
<div>
<label>起始本体(12 位)</label>
<input type="text" id="start" value="690100000000" maxlength="12"/>
</div>
<div>
<label>结束本体(12 位)</label>
<input type="text" id="end" value="690100000999" maxlength="12"/>
</div>
</div>
<div class="est" id="est"></div>
</div>
<div id="pane-list" style="display:none">
<label>粘贴条码清单(每行一个,或用空格/逗号分隔)</label>
<textarea id="list" placeholder="6901028941068&#10;6920202888883"></textarea>
</div>
</div>
<div class="card">
<h3>② 采集参数</h3>
<div class="row">
<div>
<label>并发数</label>
<input type="number" id="concurrency" value="3" min="1" max="20"/>
</div>
<div>
<label>每次请求间隔(毫秒)</label>
<input type="number" id="delay" value="300" min="0"/>
</div>
<div>
<label>输出文件名</label>
<input type="text" id="outfile" value="products.jsonl"/>
</div>
</div>
<label style="margin-top:12px"><input type="checkbox" id="logmiss"/> 同时记录未命中/无效条码(默认只存命中)</label>
<div class="hint">速度越快越容易触发上游频控。建议并发 3、间隔 300ms 起步,稳定后再调。已采过的条码会自动跳过(断点续采)。</div>
</div>
<div class="card">
<h3>③ 运行</h3>
<div style="margin-bottom:12px">
<button class="primary" id="btnStart" onclick="start()">开始采集</button>
<button class="danger" id="btnStop" onclick="stop()" disabled>停止</button>
<button class="ghost" onclick="window.open('/api/download')">下载 JSONL</button>
<button class="ghost" onclick="window.open('/api/export.csv')">导出 CSV(Excel)</button>
</div>
<div class="bar"><div id="prog"></div></div>
<div class="stats">
<div class="stat"><div class="n" id="s-done">0</div><div class="l">已处理</div></div>
<div class="stat"><div class="n" id="s-total">0</div><div class="l">总计</div></div>
<div class="stat"><div class="n hit" id="s-hits">0</div><div class="l">命中</div></div>
<div class="stat"><div class="n miss" id="s-miss">0</div><div class="l">未命中</div></div>
<div class="stat"><div class="n invalid" id="s-invalid">0</div><div class="l">无效</div></div>
<div class="stat"><div class="n error" id="s-errors">0</div><div class="l">错误</div></div>
<div class="stat"><div class="n" id="s-skipped">0</div><div class="l">跳过</div></div>
</div>
<div class="hint" id="msg"></div>
</div>
<div class="card">
<h3>④ 实时结果(最近 60 条)</h3>
<div style="max-height:340px; overflow:auto">
<table>
<thead><tr><th>条码</th><th>品名</th><th>规格</th><th>单位</th><th>产地</th><th>进价</th><th>零售价</th><th>状态</th></tr></thead>
<tbody id="rows"></tbody>
</table>
</div>
</div>
</div>
<script>
let mode = 'range';
function setMode(m){
mode = m;
document.querySelectorAll('.tab').forEach(t=>t.classList.toggle('active', t.dataset.mode===m));
document.getElementById('pane-range').style.display = m==='range'?'block':'none';
document.getElementById('pane-list').style.display = m==='list'?'block':'none';
}
function fillFromPrefix(){
let p = document.getElementById('prefix').value.replace(/[^0-9]/g,'');
if(!p){ alert('请先填前缀'); return; }
if(p.length>=12){ alert('前缀太长,应少于 12 位'); return; }
let pad = 12 - p.length;
document.getElementById('start').value = p + '0'.repeat(pad);
document.getElementById('end').value = p + '9'.repeat(pad);
updateEst();
}
function updateEst(){
let s = document.getElementById('start').value.replace(/[^0-9]/g,'');
let e = document.getElementById('end').value.replace(/[^0-9]/g,'');
if(s.length===12 && e.length===12){
let n = (BigInt(e) - BigInt(s)) + 1n;
document.getElementById('est').textContent = '本次将查询约 ' + n.toString() + ' 个条码';
} else {
document.getElementById('est').textContent = '';
}
}
document.getElementById('start').addEventListener('input', updateEst);
document.getElementById('end').addEventListener('input', updateEst);
updateEst();
async function start(){
let body = {
mode: mode,
start_body: document.getElementById('start').value.trim(),
end_body: document.getElementById('end').value.trim(),
list: document.getElementById('list').value,
concurrency: parseInt(document.getElementById('concurrency').value)||3,
delay_ms: parseInt(document.getElementById('delay').value)||0,
log_miss: document.getElementById('logmiss').checked,
out_file: document.getElementById('outfile').value.trim()
};
let r = await fetch('/api/start', {method:'POST', headers:{'Content-Type':'application/json'}, body:JSON.stringify(body)});
let j = await r.json();
if(j.error){ alert('启动失败: ' + j.error); return; }
}
async function stop(){ await fetch('/api/stop', {method:'POST'}); }
function esc(s){ return (s||'').replace(/[&<>]/g, c=>({'&':'&amp;','<':'&lt;','>':'&gt;'}[c])); }
async function poll(){
try{
let r = await fetch('/api/stats'); let j = await r.json();
let s = j.stats;
document.getElementById('s-done').textContent = s.done;
document.getElementById('s-total').textContent = s.total;
document.getElementById('s-hits').textContent = s.hits;
document.getElementById('s-miss').textContent = s.miss;
document.getElementById('s-invalid').textContent = s.invalid;
document.getElementById('s-errors').textContent = s.errors;
document.getElementById('s-skipped').textContent = s.skipped;
let pct = s.total>0 ? Math.floor(s.done*100/s.total) : 0;
document.getElementById('prog').style.width = pct + '%';
document.getElementById('msg').textContent = (s.running? ('采集中… 当前 '+s.current) : (s.message||'空闲'));
document.getElementById('btnStart').disabled = s.running;
document.getElementById('btnStop').disabled = !s.running;
let rows = (j.recent||[]).slice().reverse().map(p=>
'<tr><td>'+esc(p.barcode)+'</td><td>'+esc(p.name)+'</td><td>'+esc(p.spec)+'</td><td>'+esc(p.unit)+'</td><td>'+esc(p.area)+'</td><td>'+esc(p.in_price)+'</td><td>'+esc(p.sell_price)+'</td><td class="'+p.status+'">'+esc(p.status)+'</td></tr>'
).join('');
document.getElementById('rows').innerHTML = rows;
}catch(e){}
}
setInterval(poll, 1000); poll();
</script>
</body>
</html>
+68
View File
@@ -0,0 +1,68 @@
# 中心库商品采集器 bypos-collector 使用说明
一个单文件 Windows 小程序,通过云店「新增商品」用到的同一个中心商品库
(`zc.bypos.net`)按条码批量采集商品档案(品名/规格/单位/产地/厂商/建议进价/建议零售价),
存到本地,供后续导入天工(goods)系统。
## 一、运行
1.`bypos-collector.exe` 放到任意空文件夹(采集结果会生成在同一文件夹)。
2. 双击运行。会弹出一个黑色命令行窗口(不要关它),并自动打开浏览器控制台
`http://127.0.0.1:8765/`
- 若没自动打开,手动在浏览器输入上面这个地址。
3. 用完直接关掉那个命令行窗口即可退出。
## 二、采集
控制台分四步:
**① 规划采集范围** —— 两种方式二选一:
- **按条码范围**:EAN-13 国标条码共 13 位,最后一位是校验位,程序自动算。
你只填**前 12 位**的起止区间。可在「快捷填充前缀」里填如 `690100`,
点按钮自动生成区间(`690100000000` ~ `690100999999`)。
- **按条码清单**:直接粘贴一批条码(每行一个,或空格/逗号分隔)。
**② 采集参数**:
- 并发数(默认 3)、请求间隔(默认 300ms):**越慢越安全**,上游可能对账号限频。
- 输出文件名(默认 `products.jsonl`)。
- 「同时记录未命中/无效条码」:默认只存命中的;勾上会把未命中也记下来。
**③ 运行**:点「开始采集」。进度、命中/未命中/错误实时显示。
已经采过的条码会自动跳过(可随时停了再开,断点续采)。
**④ 实时结果**:最近 60 条滚动显示。
## 三、导出
- 「下载 JSONL」:原始数据(每行一个 JSON),用于导入天工系统。
- 「导出 CSV」:Excel 可直接打开查看。
## 四、字段说明(JSONL 每行)
| 字段 | 含义 |
| --- | --- |
| barcode | 条码(GTIN/EAN-13) |
| name | 品名 |
| spec | 规格 |
| unit | 单位 |
| area | 产地/地区 |
| manufacturer | 生产企业(常为空) |
| license | 生产许可(常为空) |
| in_price | 建议进价 |
| sell_price | 建议零售价 |
| status | hit=命中 / miss=不存在 / invalid=非国标条码 / error=请求出错 |
| fetched_at | 采集时间 |
## 五、注意
- 这是用云店账号授权去查上游中心库,**批量自动**比页面里一条条查更"重",
上游厂商可能对账号做频控/限额。请低速、分批("一点点采"),发现大量报错就降速。
- 全量 69 段是个天文数字,不要无脑全跑;建议按你关心的品牌/品类前缀分批。
## 六、命令行参数(可选)
```
bypos-collector.exe -addr 127.0.0.1:8765 # 改监听端口
bypos-collector.exe -no-open # 不自动开浏览器
bypos-collector.exe -sdogid 137966 # 指定中心库账号 id
```