P5a of docs/plans/paid-model-price-tracking.md: one surface that answers "what got cheaper / became free", without a permanent button (the grid filter was dropped by owner decision, so the panel carries the actions itself). - price_alert_since records when an alert started, so the panel can say "dropped 3 d ago" and count what is new since the user last looked; it is set on the first sight of an already-cheap version, preserved while the alert stands, and cleared when the price rises back above the threshold - get_price_alerts() compares the threshold at read time (editing it takes effect immediately, no refresh needed) and returns both kinds in one list; model_type=None covers every type, which the shared update DB makes a single query. "became free" needs no price data, so it is reported even while price tracking is off - GET /api/lm/price-alerts, registered once in MiscRoutes rather than per model type, decorating rows best-effort with the local model name and file path from the scanner indexes (a cold cache just omits them) - a third tab in the notification bell: segments for under-threshold and became-free, the three states (tracking off / nothing matching / stale), and per-row actions (CivitAI always, Open when the model is local) - two non-permanent entry points share one helper: the controls-bar updates dropdown and the global context menu, whose label carries the unread count - unread state stays client-side (localStorage watermark); the count is fetched once on init and only when price tracking is enabled - the per-type frontend client method is removed as dead code; the per-type backend route stays for the companion extension
41 KiB
Plan: Buzz Price Tracking and Threshold Alerts for Paid / Early Access Versions
Origin: FR "Price tracker for models/loras" (Geekier, Discord) — track the buzz price of paid
model versions and flag when it drops below a threshold or becomes free.
Related: #1060 — Some "Early Access" models are not identified correctly
(closed) established is_paid, the Paid badge and hide_paid_updates; this FR is the next step
after gate state — gate price.
Status: v3 — P0–P3 implemented (§10 records what shipped and the deviations); P5 (alerts
panel) planned in §11, not implemented. The grid-level "price alert only" filter was dropped by
owner decision, so §11 defines the panel as the only new browsing surface.
Feasibility was verified against this repo and upstream CivitAI main (6d29ed1368), including live
probes against civitai.com / civitai.red.
Scope: every model type that goes through ModelUpdateService (lora / checkpoint / embedding /
other). Out of scope: purchasing, downloading gated content, and any change that depends on a future
CivitAI API addition.
1. Problem statement
Creators increasingly gate model versions behind buzz. LoRA Manager already knows whether a
version is gated (is_paid, is_early_access, paid_access) but not how much it costs, so it
cannot answer the two questions the FR asks:
- "Tell me when this model's price drops below X buzz."
- "Tell me when it becomes free."
Additionally, the current code only compares version ids when deciding has_update, so a version
that a user already tracks can go from paid to free (or gain a gate) without producing any signal at
all.
2. Verified current state
2.1 LoRA Manager (all references confirmed in this checkout)
| Fact | Reference |
|---|---|
Gate fields persisted per version: is_paid, is_early_access, paid_access (raw DTO JSON), early_access_ends_at |
py/services/model_update_service.py:65-84 |
Gate data comes from the bulk GET /api/v1/models?ids=… response (availability, paidAccess, earlyAccessEndsAt) |
py/services/civitai_client.py:329-380, parsed at py/services/model_update_service.py:1756-1793 |
No numeric price anywhere in py/ |
grep -rn "price" py/ → only license/allowCommercialUse hits |
| Update refresh is user-triggered, not scheduled; TTL 24 h | route py/routes/handlers/model_handlers.py:2899; ModelUpdateService.__init__ default ttl_seconds=24*60*60 at py/services/model_update_service.py:338 |
has_update compares version ids + gate filters only; no state-transition detection |
py/services/model_update_service.py:117-160 |
{permanent:false, endsAt:null} is deliberately treated as not a gate on the download path |
py/services/download_manager.py:2000-2003 |
Version payload sent to the frontend already carries isPaid / paidAccess |
py/routes/handlers/model_handlers.py:3444-3455 |
UI: Paid / Early Access badges, hide_paid_updates filter |
static/js/components/shared/ModelVersionsTab.js:169-196, 474-545; static/js/state/index.js:58-59; templates/components/modals/settings/library.html:191-192 |
2.2 Upstream CivitAI — what is and is not public
| Fact | Evidence |
|---|---|
Public v1 API intentionally strips pricing: paidAccess is reduced to {permanent, endsAt}. Source comment: "Omits terms (pricing belongs to the purchase flow)" |
~/code/civitai/src/server/services/paid-access.service.ts:640-652; verified live: /api/v1/models and /api/v1/model-versions/{id} return exactly that shape |
The internal tRPC route is not usable anonymously. isAcceptableOrigin rejects non-site origins with 401 "Please use the public API instead" |
~/code/civitai/src/server/trpc.ts:120-128; acceptableOrigin = !isProd || isBearerAuth || isAllowedOriginRequest(req) (createContext.ts:43), and the origin check is header-based (src/server/utils/origin-helpers.ts:27-32). Live probe warning: an anonymous tRPC GET can return 200 when Cloudflare serves a cached copy (cf-cache-status: HIT); uncached it is 401. Do not build on this path. |
The price is publicly reachable inside the public model page. The SSR payload embeds the site's own model.getById result, including full terms |
https://civitai.com/models/<id> and https://civitai.red/models/<id> → <script id="__NEXT_DATA__" type="application/json"> → props.pageProps.trpcState.json.queries[*] where queryKey[0] == ["model","getById"] → state.data.modelVersions[*].paidAccess |
| Observed payloads (anonymous, no cookies) | version 3379626 → {terms:{download:{price:5000},generation:{price:100,trialLimit:5}}, endsAt:null, sale:null}; version 3380114 → download.price 125 acceptsBlueBuzz:true endsAt:2026-10-10; another → 200 |
| Per-generation licensing fees are already public and official | GET /api/v1/model-versions/mini/{id} (MixedAuthEndpoint, anonymous 200) exposes fees / freeTrialLimit — ~/code/civitai/src/pages/api/v1/model-versions/mini/[id].ts:455 |
| Webhooks cannot carry price changes | updated-model is driven by Model.lastVersionAt (fires only on new versions) and its select has no paidAccess: ~/code/civitai/src/server/webhooks/model.webooks.ts:88-96, ~/code/civitai/src/server/selectors/model.selector.ts:15-36 |
| Prevalence (sampled newest 600 models / 4634 versions via public API cursor): 90 gated (1.9%), 87 permanent vs 3 timed | live scan, 2026-xx; dominated by permanent gates, so "EA expiry" alone covers ~3% of gated versions |
2.3 Consequences for the design
- Threshold alerts on download price require one new data source: the model page payload. It is public, but it is page data — so it must be isolated, opt-in, cheap, and fail-open.
- Request budget is small because only gated models need it: ~2% of models, one extra ~200 KB request per gated model per price TTL.
- "Becomes free" and "gained a gate" need no new data source at all and should ship first.
- One page fetch returns all versions of a model, so prices cost one request per model, not per version.
3. Data source decision
Chosen: __NEXT_DATA__ of the public model page, fetched with the existing HTTP stack.
Rejected alternatives:
- Internal tRPC — origin-gated; passing it means forging
Originor relying on bearer auth against an undocumented endpoint whose own error message says to use the public API. Not worth the stability/compliance risk for a convenience feature. - Official v1 API as-is — no price field, by design. Track it as an upstream request (§8), not as a dependency.
mini/{id}fees— useful extra signal for per-generation fees, but it is not the download price and does not cover the gate.
4. Design
4.1 Schema (all additive, in the existing update DB)
model_update_versions gains:
ALTER TABLE model_update_versions ADD COLUMN price_buzz INTEGER; -- effective (sale-adjusted) download price
ALTER TABLE model_update_versions ADD COLUMN list_price_buzz INTEGER; -- undiscounted download price
ALTER TABLE model_update_versions ADD COLUMN generation_price_buzz INTEGER;
ALTER TABLE model_update_versions ADD COLUMN accepts_blue_buzz INTEGER NOT NULL DEFAULT 0;
ALTER TABLE model_update_versions ADD COLUMN price_sale_ends_at TEXT;
ALTER TABLE model_update_versions ADD COLUMN price_checked_at REAL; -- last *successful* price fetch
ALTER TABLE model_update_versions ADD COLUMN price_alert_state INTEGER NOT NULL DEFAULT 0; -- last computed alert hit, for edge detection
Adding a column to this table requires touching all eight enumerations (missing one silently drops data or breaks reads):
- dataclass
ModelVersionRecord—py/services/model_update_service.py:65-84 _SCHEMACREATE TABLE—:300-330_apply_migrationscolumn dict —:554-580_migrate_model_update_versions_primary_keytarget_columns+defaults—:680-745(easy to miss; omitting it loses the new columns whenever the PK migration runs)_build_record_from_remote—:1630-1665_extract_single_version—:1740-1795_get_records_bulkSELECT + row→record mapping —:1945-1990_upsert_recordINSERT —:2028-2066
price_checked_at lives on the version row (not the model status row) so a stale price on one
version does not force a re-fetch for its siblings; the fetch itself is per model.
4.2 Parser contract
New pure function, unit-testable without network:
parse_model_page_prices(html: str) -> dict[int, dict] | None
- Locate
<script id="__NEXT_DATA__" type="application/json">…</script>;json.loadsit. - Walk
props.pageProps.trpcState.json.queries[*]; pick the entry whosequeryKey[0] == ["model","getById"](the query order is not stable — 7 queries were observed,getByIdfirst only incidentally). - From
state.data.modelVersions[*], per version emit:price_buzz=paidAccess.sale.buyerTerms.download.priceifsalepresent, elsepaidAccess.terms.download.pricelist_price_buzz=paidAccess.terms.download.pricegeneration_price_buzz=terms.generation.price(undefined for{free:true}/ bundled)accepts_blue_buzz,price_sale_ends_at- no
paidAccess→ the version is ungated: emit an explicit "no price" marker so the caller can clear stale prices and raise a became free event.
- Return
None(never raise) for: missing script tag, JSON error, shape mismatch, emptymodelVersions, or a Cloudflare/challenge page.
4.3 Refresh flow and request budget
Hook: _refresh_single_model (py/services/model_update_service.py:1099-1215), inside the existing
"lock released during network I/O" window, after fetched_versions is built:
prices_needed = feature_enabled and (any gated version or any version with a stored price)
if prices_needed:
prices = await provider.get_model_prices(model_id) # never raises; None on failure
if prices is not None:
fetched_versions = [apply_price(v, prices.get(v.version_id)) for v in fetched_versions]
# price_checked_at advances only for versions actually present in the payload
- Candidate selection uses the gate data already in hand from the bulk API, so no extra call is made for the ~98% of models with no gate (except models that previously had a price and must confirm "now free").
- TTL:
price_check_ttl_hours(default 24 h), independent of the update TTL — a price refresh can be skipped while the version list is fresh, and vice versa. Force refresh (force_refresh=True) also forces prices. - Failure behaviour: keep the previous price, do not advance
price_checked_at(so the next refresh retries), log at debug/info. ARateLimitErrorfrom the shared gate must remain a skip, not a hard failure of the update check. After N consecutive parse failures within one refresh, stop attempting price fetches for the remainder of that run. - Offline/cooldown: reuse the existing
ConnectivityGuardpath indownloader.make_request— no new connectivity handling.
Client/provider seam:
ModelMetadataProvider.get_model_prices(model_id)— default returnsNone(not abstract, so CivArchive / SQLite providers are untouched).CivitaiModelMetadataProvider→CivitaiClient.get_model_prices(model_id).- Add the pass-through to the composite provider wrapper
(
py/services/model_metadata_provider.py:855-955) so the rate-limit helper applies. CivitaiClient.get_model_prices: build the URL with the existing helperbuild_civitai_model_page_url(model_id, host=self._settings.get("civitai_host"))(py/utils/civitai_utils.py:44-66;civitai.redis already a supported page host,:10), fetch withdownloader.make_request("GET", url, use_auth=False, custom_headers={"Accept": "text/html"})(returnsstrbecause the body is not JSON), then call the parser. Cap the body size before parsing.
4.4 Alert semantics
- Threshold hit:
price_buzz is not None and price_buzz <= threshold_buzz.threshold_buzz = 0means "free only, plus any gate removal". - Became free: a version with a stored gate/price now has no
paidAccess(from the bulk API and/or the page payload). - Newly gated: a version that had none now has
paidAccess. - Edge detection uses
price_alert_stateplus the previouspaid_accessJSON, compared in_build_record_from_remotewhereexisting_mapis already built (py/services/model_update_service.py:1636-1665). Do not put this inhas_update: it is a different question, andhas_updateis filtered by the hide-* settings. ModelUpdateRecordgains a non-persisted field (e.g.events: list | None = None) carrying{version_id, kind: "price_drop"|"became_free"|"new_gate", price_buzz, previous_price_buzz}._upsert_recordignores it;_get_recordleaves itNone.
4.5 Settings and routes
New settings (defaults in DEFAULT_SETTINGS, py/services/settings_manager.py:68;
settings.json.example stays minimal per repo policy; frontend defaults in
static/js/state/index.js:58):
| Key | Default | Meaning |
|---|---|---|
price_tracking_enabled |
False |
master switch; off means no model-page fetches at all |
price_alert_threshold_buzz |
0 |
alert when effective price ≤ this; 0 = free only |
price_check_ttl_hours |
24 |
price freshness window |
Routes (all under the existing model route registrars, POST + GET because the companion
extension is GET-only per AGENTS.md):
GET /api/lm/models/price-alerts— aggregate over the update DB:{modelId, modelType, versionId, versionName, priceBuzz, listPriceBuzz, thresholdBuzz, isFree}.- Prices themselves need no new read route: they ride along in the existing version payload
(
py/routes/handlers/model_handlers.py:3438-3455gainspriceBuzz,listPriceBuzz,generationPriceBuzz,acceptsBlueBuzz,priceCheckedAt,priceAlert). - The existing update-refresh response gains
events(from §4.4) so the frontend can toast.
4.6 UI
static/js/components/shared/ModelVersionsTab.js- Extend the existing Paid / Early Access badge tooltips with the price when known
("Paid · 5,000 Buzz") — helpers at
:169-196, badges at:474-545. - New badges: price chip (
paid/infostyling) and "Free now" for a became-free transition. - Filter toggle reusing the
hide_paid_updatespattern (:349-400, plus the settings modal andSettingsManager.js:1157-1163) — e.g. "Show price drops only".
- Extend the existing Paid / Early Access badge tooltips with the price when known
("Paid · 5,000 Buzz") — helpers at
- Optional, cheap win: include the price in the paid-download error text
(
py/services/download_manager.py:1987-2031,py/services/use_cases/download_model_use_case.py:35). - Strings: add to
locales/en.json, thenpython scripts/sync_translation_keys.py, then stop — do not translate the other locales (seedocs/i18n-translation-guidelines.md§7).
5. Phased tasks
P0 — settle gate semantics (prerequisite, small)
- Decide the meaning of
{permanent:false, endsAt:null}. The repo currently treats it as no gate (py/services/download_manager.py:2000-2003), while upstreamisPaidAccessActive(endsAt == null || endsAt > now) treats it as active. Live sample: version 3372655 currently returns exactly this DTO from/api/v1/models. - Introduce one shared helper (e.g.
_has_active_gate(paid_access, early_access_ends_at)inpy/services/model_update_service.py) and use it from both the update service and the download gate, so alerts and download blocking cannot disagree. - Unit test for the chosen rule.
- Why first: every alert kind inherits the gate-state decision; getting it wrong produces false "free" alerts.
P1 — gate-state change detection (no new data source)
- Emit
new_gate/became_freeevents from_build_record_from_remote; add the non-persistedeventsfield; surface in the refresh response. - Keep
has_updatesemantics unchanged (regression risk tohide_paid_updates,hide_early_access_updates). - UI: "Free now" badge + one batched toast per refresh; extend paid/EA tooltips.
- Tests in
tests/services/test_model_update_service.pyfor each transition and for the no-change case. - Acceptance: a version whose gate lapses is visibly marked free after a refresh, with no new network calls; existing hide-* filters behave identically.
P2 — price capture (opt-in)
- Schema + all eight column touchpoints from §4.1, with a migration test.
parse_model_page_prices+ fixture-based tests (tests/services/fixtures/…, one trimmed page with a timed gate, one with a permanent gate, one malformed/missing payload).CivitaiClient.get_model_prices+ provider methods + composite pass-through; assert redirect following and that a non-JSON body is returned as text.- Wire into
_refresh_single_modelbehindprice_tracking_enabled, with the failure matrix from §4.3. - Tests: feature off ⇒ zero extra calls; fetch failure ⇒ previous price retained and
price_checked_atunchanged; gated-only candidate selection. - Acceptance: with tracking enabled, a refresh on a gated model stores
price_buzzfor all of its versions from one request; with tracking disabled or offline, refresh behaves exactly as today.
P3 — threshold alerts and surface
- Settings + defaults (§4.5) and the settings-modal toggles/inputs.
- Threshold evaluation +
price_alert_stateedges →price_dropevents. GET /api/lm/models/price-alertsaggregate endpoint.- Version payload gains the price fields; UI price chip, "Free now" badge, "price drops only" filter; optional price in the paid-download error.
- Locale keys +
scripts/sync_translation_keys.py. - Tests: threshold boundary (
<=vs<), Blue Buzz labelling, sale-adjusted vs list price, alerts for a version already in the library. - Acceptance: a user can set "alert me under 500 buzz", refresh, and see the models that qualify; nothing alerts when the price rises above the threshold again (state resets).
P4 — docs and upstream
- Short feature note in the repo docs; keep this plan's data-source rationale in a code comment (public page read, no auth or origin spoofing, no internal API).
- Draft the upstream request: add a price field to the public
paidAccessDTO. Point out the asymmetry — writes already go through the official v1 endpoint (~/code/civitai/src/pages/api/v1/model-versions/early-access.ts, sharingupdateModelVersionPaidAccessSchema) while reads withhold it deliberately. If it lands, the page scraper becomes an optional fallback rather than the only path.
6. Test plan summary
pytest tests/services/test_model_update_service.py— migrations, extraction, transitions, threshold logic, fetch-failure matrix, feature-off path.- New parser tests with HTML fixtures (no network in tests).
npm run test:jsfor badge/helper changes inModelVersionsTab.- Manual UI verification by the user (per repo policy — no browser automation for layout).
- No live CivitAI calls in the test suite.
7. Risks and mitigations
| Risk | Mitigation |
|---|---|
Page payload format changes (Next.js is migrating away from __NEXT_DATA__ to the flight payload) |
Parser is a single pure function behind a provider method; fixture test fails loudly at build time; parse failure is non-fatal and keeps the last known price |
Cloudflare / UA sensitivity (verified: civitai.com, civitai.red and even no-UA all returned the payload for the sampled pages) |
Reuse downloader (proxy, rate-limit coordinator, connectivity guard); detect challenge/absence and back off; never retry in a tight loop |
| Traffic/size (~200-270 KB per model) | Gated models only (~2%), one request per model, price_check_ttl_hours, force-refresh only on user action |
| False "free" alerts from gate-semantics ambiguity | P0 helper + explicit tests before any alert ships |
| Misleading price (list vs sale-adjusted; Blue Buzz is the same number but non-withdrawable) | Store both list and effective price; tooltip states the unit and Blue Buzz acceptance |
| Alerts are pull-only (no scheduler, no push channel today) | State it in the UI copy; treat background push as a separate follow-up, not a silent gap |
8. Out of scope / follow-ups
- Purchasing or downloading gated content.
- Generation-fee tracking beyond displaying
generation_price_buzz(the publicmini/{id}feesfield could feed a richer view later). - A background/notification channel; today alerts appear when the user refreshes or opens the panel.
- Waiting on CivitAI to expose prices; P1–P3 stand alone.
9. Open questions
{permanent:false, endsAt:null}— gate or not? (P0; affects download blocking too.)- Should the threshold apply to versions already in the library (watching for a future re-buy) or only to versions the user does not own?
- Is a per-model threshold override needed in v1, or is one global threshold enough?
10. What shipped (P0–P3)
10.1 Answers to the open questions
{permanent:false, endsAt:null}is a gate. Decided by evidence, not preference: the public v1 API returnsnullfor lapsed gates (toPublicPaidAccessDtofilters onisPaidAccessActive), so a non-null DTO is always an active gate; on the live model 1802980 that version reportscanDownload: falsewhile its lapsed-tombstone siblings reporttrue. The previous rule dropped it, which is exactly the #1060 class of bug.- The global threshold applies to every gated version the update service tracks, in library or not — the user may be watching a version they intend to buy later.
- One global threshold in v1; a per-model override is still open.
10.2 Files and seams
| Area | Where |
|---|---|
Shared gate semantics (normalize_paid_access, is_gate_active, is_early_access_deadline_active) |
py/utils/paid_access.py (new) |
Model page price parser (parse_model_page_prices) |
py/utils/civitai_page_prices.py (new) |
| Price fetch | CivitaiClient.get_model_prices (py/services/civitai_client.py) |
| Provider seam | ModelMetadataProvider.get_model_prices default None; CivitAI impl; fallback + rate-limit wrappers (py/services/model_metadata_provider.py) |
| Columns, migration, transition + threshold logic, alerts query | py/services/model_update_service.py |
Version payload, refresh events, GET /api/lm/{type}/updates/price-alerts |
py/routes/handlers/model_handlers.py, py/routes/model_route_registrar.py |
| Badges, price chip, gate/price toast | static/js/components/shared/ModelVersionsTab.js, static/js/utils/updateCheckHelpers.js, static/css/components/lora-modal/versions.css |
| Settings | defaults in py/services/settings_manager.py; UI in templates/components/modals/settings/library.html + static/js/managers/SettingsManager.js; client defaults in static/js/state/index.js |
| API client | getPriceAlerts in static/js/api/baseModelApi.js + priceAlerts endpoint in static/js/api/apiConfig.js |
10.3 Deviations from the plan
gate_lapsed_atcolumn added (8th column): a transient event would leave a "became free" marker invisible minutes later, so the lapse timestamp is persisted and the UI shows aFree Nowbadge with it.- Alerts are edge-triggered, and first sight is silent. When a price first appears under the
threshold,
price_alert_stateis stored and the version shows up inprice-alertsimmediately, but no toast fires — otherwise switching the feature on would announce every cheap version in the library at once. The toast fires when a price crosses down through the threshold. - No dedicated alerts panel. The surfaces are: price chip +
Free Nowbadge in the versions tab, one combined toast per update check, and theprice-alertsendpoint (GET, so the companion extension can use it). A browse surface over the endpoint is a follow-up. - Prices are only fetched for models with a gate (~2% of a typical library), one page request per
model, on
price_check_ttl_hours, and immediately when the gate DTO changes. - The paid-download warning message does not include the price: that path reads the model's CivitAI metadata, which has no price, and looking one up would add a request to a failure path. Left as a follow-up.
10.4 Test coverage added
tests/utils/test_paid_access.py— gate shapes, activity, timestamps.tests/utils/test_civitai_page_prices.py+tests/utils/fixtures/civitai_model_page_paid.html— parser, including sale-adjusted vs list price and lapsed tombstones.tests/services/test_model_update_service.py— migration from a pre-feature DB, column round-trip, transitions, price capture on/off, failure retention, TTL, threshold edges, alerts query.tests/services/test_civitai_client.py— page fetch happy path, unusable payloads, rate limits.tests/routes/test_model_update_handler.py— alerts endpoint, gate events for non-updating records.
11. P5 — Price alerts panel
Goal: a single surface that answers "what got cheaper / became free, and can I act on it".
Status: P5a implemented (see §11.9); P5b (inline threshold editing, Refresh prices, type chips, ignore action) and P5c (polish) are not.
Naming: called P4a–c in earlier discussion; renumbered to P5 because §5 already uses P4 for "docs and upstream".
Owner decision: the grid-level "price alert only" filter is out of scope. The panel is the only new browsing surface; the existing per-version badges and the update-check toast stay as they are. Consequence: the panel carries the "act on it" affordances itself (§11.2), and discoverability rests on the bell badge plus the controls-dropdown entry (§11.1 D8).
11.1 Locked decisions
| # | Decision | Why / evidence |
|---|---|---|
| D1 | Host it as a third tab in the existing notification bell modal, driven by UpdateService |
templates/components/modals.html is included by templates/base.html:75, so the bell exists on every page; UpdateService already has toggleUpdateModal(), switchNotificationTab(), tab badges, arrow-key tab navigation and a list/empty-state pattern (renderRecentBanners) |
| D2 | One global endpoint GET /api/lm/price-alerts, registered once in MiscRoutes |
The update DB is one file per library shared by all model types (cache/model_update/<library>.sqlite), and ServiceRegistry.get_model_update_service() returns one shared instance (py/services/service_registry.py:153). get_price_alerts only filters on s.model_type, so model_type=None is all types in one query. Adding it to COMMON_ROUTE_DEFINITIONS would bind the same path once per model type (4×) |
| D3 | Compare the threshold at read time (WHERE v.price_buzz <= ?); keep price_alert_state for the toast edge only |
As shipped, panel membership only changes after a refresh, so editing the threshold in the panel would look broken |
| D4 | New column price_alert_since REAL |
price_alert_state is a boolean; "dropped 3 days ago" and an unread count both need the moment the state flipped, which the existing edge detection already knows |
| D5 | Unread state is client-side (localStorage watermark compared against price_alert_since) |
No per-user read-state table and no sync logic; the worst case is a conservative badge on a second browser |
| D6 | Row actions: CivitAI always; Open only when the payload resolved a local file path | showModelModal(model, modelType) needs a local metadata object and re-fetches by file_path (static/js/components/shared/ModelModal.js:343-361); a gated version the user does not own has no local file |
| D7 | Refresh prices must bypass the price TTL | Prices stay fresh for price_check_ttl_hours (24 h by default), so without a force flag the button would appear to do nothing |
| D8 | Two non-permanent entry points, both opening the bell on the Price alerts tab: the updates dropdown in the controls bar, and the global context menu (right-click on empty space) | The controls dropdown already hosts checkUpdatesMenuItem (templates/components/controls.html:114-126) and costs no layout space. The global menu is the established home for library-wide occasional actions and already holds the sibling check-model-updates (templates/components/context_menu.html:185); it has only 7 items and existing hide/separator machinery (GlobalContextMenu.showMenu / _updateSeparatorVisibility). The model-card menu is deliberately left alone — it already has 20 items, and P5b's Refresh prices covers the per-model case |
| D9 | Bell badge shows the unread alert count; when there are none it keeps today's behaviour (dot for app updates). The same cached count is appended to the global context menu item (Price alerts (3)) |
Otherwise a price drop is invisible until the user opens the bell. The count is fetched once on init only when price_tracking_enabled, so users who never enable the feature pay nothing |
| D10 | The global context menu item is always visible on model pages (hidden on recipes, like its siblings) | The panel's disabled state is the explanation plus a deep link into Settings; hiding the entry would make the feature undiscoverable for exactly the users who have not enabled it yet |
11.2 Information architecture
┌ Price alerts [Refresh prices] ┐
│ Threshold: 500 Buzz (click to edit) │
│ [ Under threshold ] [ Became free ] Type: All · LoRA · … │
├──────────────────────────────────────────────────────────────────────┤
│ ▸ Glorious Art · Checkpoint · 2 versions │
│ Alpha · 250 Buzz (was 500) · Blue Buzz OK │
│ EA until Oct 10 · Not in library · dropped 3 days ago │
│ [CivitAI] [Open] [Ignore] │
│ ▸ Eira Kishida · LoRA · 1 version │
│ 125 Buzz · In library · dropped today [CivitAI] [Open] │
└──────────────────────────────────────────────────────────────────────┘
- Segments cover both halves of the FR:
Under threshold(price at or below the threshold) andBecame free(versions withgate_lapsed_at, no price). - Grouped by model (a model often has several versions at the same price), sorted cheapest first then most recently crossed; the type chips filter client-side over the loaded list.
- Row: effective price with the list price struck through when on sale, Blue Buzz note, EA end date,
in-library marker, and "dropped X ago" from
price_alert_since. - Actions: open on CivitAI, open the local model modal (only when a file path was resolved), ignore
this version (reuses
setVersionUpdateIgnore).
11.3 Data contract
GET /api/lm/price-alerts?limit=200
{
"success": true,
"enabled": true, // price_tracking_enabled
"thresholdBuzz": 500,
"newestCheckedAt": 1791039694.5, // staleness copy ("prices last checked X ago")
"alerts": [
{
"modelId": 2981320, "modelType": "checkpoint",
"modelName": "Glorious Art", // best-effort, from the scanner cache
"versionId": 3379626, "versionName": "Alpha",
"kind": "below_threshold", // or "became_free"
"priceBuzz": 250, "listPriceBuzz": 500,
"acceptsBlueBuzz": true, "priceSaleEndsAt": null,
"priceAlertSince": 1791000000.0,
"gateLapsedAt": null,
"earlyAccessEndsAt": null, "isPaid": true, "isEarlyAccess": false,
"isInLibrary": false,
"filePath": null, // set only when resolvable
"civitaiUrl": "https://civitai.com/models/2981320?modelVersionId=3379626"
}
]
}
One list with a kind discriminator (not two lists) so "All" needs no second request. civitaiUrl
is built server-side with the existing build_civitai_model_page_url so civitai_host stays the
single source of truth.
11.4 States (all three must be designed, not just the happy path)
- Tracking off — explain that CivitAI publishes no price in its public API and that the feature reads the model page, plus a button that opens Settings → Library.
- On, nothing matching — "nothing under N Buzz right now", with the threshold editable inline.
- Stale / offline / rate-limited — keep the last known list, add a "prices last checked X ago" line and a retry; never blank the panel.
11.5 Tasks
P5a — panel usable end to end
py/services/model_update_service.pyget_price_alerts(model_type=None, *, threshold_buzz, limit=200)— optional type filter, live threshold comparison,kind,price_alert_since; keep the shipped per-type call site working.price_alert_sincecolumn through all eight enumerations (§4.1), set on the0 → 1edge and cleared on1 → 0inside_build_record_from_remote.
py/routes/misc_route_registrar.py+py/routes/handlers/misc_handlers.py— registerGET /api/lm/price-alertsonce, usingServiceRegistry.get_model_update_service()and the settings service; resolvemodelName/filePathbest-effort per model type from the scanner caches (version_index[version_id]→file_path,file_name; itemmodel_namewith afile_namefallback), and omit them when resolution fails.templates/components/modals/update_modal.html— third tab + panel skeleton (segments, threshold row, list container, empty/disabled blocks), reusingdata-notification-tab/data-notification-panel.static/js/managers/UpdateService.js—renderPriceAlerts(), panel fetch on open, tab badge count, threshold display, row rendering and actions,localStoragewatermark; extendupdateTabBadges()andswitchNotificationTab().static/js/api/apiConfig.js+ a small fetch helper — the endpoint is global, so it does not belong in the per-model-typeendpointsmap.templates/components/controls.html+static/js/components/controls/PageControls.js— the controls-dropdown item (D8).templates/components/context_menu.html+static/js/components/ContextMenu/GlobalContextMenu.js— the global-context-menu item (D8): one template entry, the recipes-page hide list inshowMenu(), onecaseinhandleMenuAction, and the optional(N)count from the cached alert count. Both entries call one sharedopenPriceAlertsPanel()helper.locales/en.json+python scripts/sync_translation_keys.py.
Acceptance: with tracking on and one refresh done, the bell shows a count, the tab lists the versions with prices, CivitAI opens the right page, Open appears only for in-library models and opens the modal, all three states render, and it works from every page type.
P5b — actions and polish
- Inline threshold editing (read-time comparison makes it instant) and Refresh prices with a
force_price_refreshflag on the existing refresh endpoint (or a dedicatedPOST /api/lm/price-alerts/refresh). - Type chips and a "only versions I do not own" toggle (this is open question 2 from §9).
- Ignore-this-version action.
P5c — optional
- Thumbnails from the scanner cache, "unread only", focus-management pass on the new tab, and a deep link from the panel into the settings section.
11.6 Tests
tests/services/test_model_update_service.py—model_type=Nonespans types; live threshold parameter;price_alert_sinceset/cleared on the edge.tests/routes/— the global route is registered exactly once and returns the documented shape;filePathresolution is best-effort (mock scanner; omit on failure).tests/frontend/— vitest forrenderPriceAlertscovering rows, both segments, the three states and the badge count with a mocked fetch.- Manual eyeball for layout, per the repo's UI verification policy.
11.7 Risks
| Risk | Mitigation |
|---|---|
| The bell modal is nominally about app updates; a third tab changes its character | Clear labelling, and only count/badge when the feature is on; the app-update dot behaviour is unchanged when there are no alerts |
| Resolving local file paths pulls scanner caches into an app-wide route | Best-effort with try/except, one get_cached_data() per type (in-memory), omit the field and hide the Open button when it fails |
price_alert_since is another migration |
Same eight-touchpoint discipline as §4.1, covered by the existing migration test |
A global route in COMMON_ROUTE_DEFINITIONS would bind 4× |
Register it in MiscRoutes instead (D2) |
| Menu bloat / entry sprawl | Two entries maximum (D8), both calling one helper; the 20-item model-card menu is explicitly untouched |
| Panel data goes stale between refreshes | Show newestCheckedAt; the refresh action (P5b) makes it explicit rather than silent |
11.8 Open questions for the owner
- Badge policy — count unread alerts on the bell (recommended, D9), or leave the bell alone and put the number only on the tab?
- Unread at all — the
localStoragewatermark (recommended, D5), or simply "current matches" with no read state? - Threshold editing inside the panel — convenient, but it silently changes a global setting from a surface the user opened just to look.
- "Open in library" — worth the scanner-cache coupling (D6), or should the row offer only "CivitAI" plus a copy-link action?
- Thumbnails — skip for weight (recommended) or show them?
- Entry visibility when tracking is off — always show the global-context-menu item (recommended, D10: the panel's disabled state educates and deep-links to Settings), or hide it until the feature is enabled for a cleaner menu?
- Count in the menu label —
Price alerts (3)using the cached count (recommended, D9), or a plain label with the number only on the bell/tab?
11.9 What shipped (P5a)
Answers to §11.8: badge counts unread alerts (D9), unread uses the localStorage watermark (D5),
threshold editing is display-only in P5a (editing is P5b), "Open in library" ships with the
best-effort path resolution (D6), no thumbnails, the context-menu item is always visible (D10), and
the menu label carries the count (D9).
| Area | Where |
|---|---|
price_alert_since column through all eight enumerations, set on the 0 → 1 edge, preserved while the alert stands, cleared when the price rises |
py/services/model_update_service.py |
get_price_alerts(model_type=None, *, threshold_buzz, limit) — read-time threshold, kind, one list across types; newest_price_checked_at() |
py/services/model_update_service.py |
Global endpoint GET /api/lm/price-alerts, registered once |
py/routes/misc_route_registrar.py, py/routes/misc_routes.py, PriceAlertsHandler in py/routes/handlers/misc_handlers.py |
| Third bell tab, panel skeleton, segments, three states | templates/components/modals/update_modal.html, static/css/components/modal/update-modal.css |
Loader, renderer, unread watermark, badge, openPriceAlertsPanel() |
static/js/managers/UpdateService.js |
| Entry points (controls dropdown + global context menu, count in the label) | templates/components/controls.html, static/js/components/controls/PageControls.js, templates/components/context_menu.html, static/js/components/ContextMenu/GlobalContextMenu.js |
Deviations and decisions made while implementing:
became_freeis reported even while price tracking is off. It needs no price data, so the panel shows the "tracking is off" explanation and whatever became free instead of hiding the half of the feature that already works.price_alert_sinceis also set on first sight of an already-cheap version. The toast stays silent (edge-triggered, §10.3), but the count is non-zero, which is what invites the user into the panel after enabling the feature.- The per-type frontend client method was removed (
baseModelApi.getPriceAlertsand thepriceAlertsentry inapiConfig.js): with the global endpoint it was dead code. The per-type backend route stays for the companion extension and a possible future grid filter. openPriceAlertsTab()exists becausetoggleUpdateModal()closes an open bell — an entry point calling it unconditionally would dismiss the modal instead of switching tabs.- Local context uses the existing indexes (
cache.model_id_indexformodel_name,cache.version_indexforfile_path/file_name), so it is O(1) per row; every failure just omits the fields and the row loses its "Open" button.
Verification: pytest 3652 passed / 7 skipped, npm run test:js 1444 passed, plus a sandboxed
standalone server run that seeded the update DB and confirmed the payload shape, the kind
split, the civitaiUrl, and that changing price_alert_threshold_buzz through POST /api/lm/settings
changes panel membership immediately with no refresh.