Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
91254d18f3 | ||
| 40580dbf15 | |||
| 7f1d74c047 | |||
|
|
ecec686347 | ||
| 86de680080 | |||
|
|
0371947065 | ||
| 296698758c | |||
|
|
18c1161587 | ||
| 0010396780 |
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "flyer-crawler",
|
||||
"version": "0.7.2",
|
||||
"version": "0.7.6",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "flyer-crawler",
|
||||
"version": "0.7.2",
|
||||
"version": "0.7.6",
|
||||
"dependencies": {
|
||||
"@bull-board/api": "^6.14.2",
|
||||
"@bull-board/express": "^6.14.2",
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "flyer-crawler",
|
||||
"private": true,
|
||||
"version": "0.7.2",
|
||||
"version": "0.7.6",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "concurrently \"npm:start:dev\" \"vite\"",
|
||||
|
||||
@@ -8,16 +8,23 @@
|
||||
CREATE TABLE IF NOT EXISTS public.addresses (
|
||||
address_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
address_line_1 TEXT NOT NULL UNIQUE,
|
||||
address_line_2 TEXT,
|
||||
city TEXT NOT NULL,
|
||||
province_state TEXT NOT NULL,
|
||||
postal_code TEXT NOT NULL,
|
||||
country TEXT NOT NULL,
|
||||
address_line_2 TEXT,
|
||||
latitude NUMERIC(9, 6),
|
||||
longitude NUMERIC(9, 6),
|
||||
location GEOGRAPHY(Point, 4326),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT addresses_address_line_1_check CHECK (TRIM(address_line_1) <> ''),
|
||||
CONSTRAINT addresses_city_check CHECK (TRIM(city) <> ''),
|
||||
CONSTRAINT addresses_province_state_check CHECK (TRIM(province_state) <> ''),
|
||||
CONSTRAINT addresses_postal_code_check CHECK (TRIM(postal_code) <> ''),
|
||||
CONSTRAINT addresses_country_check CHECK (TRIM(country) <> ''),
|
||||
CONSTRAINT addresses_latitude_check CHECK (latitude >= -90 AND latitude <= 90),
|
||||
CONSTRAINT addresses_longitude_check CHECK (longitude >= -180 AND longitude <= 180)
|
||||
);
|
||||
COMMENT ON TABLE public.addresses IS 'A centralized table for storing all physical addresses for users and stores.';
|
||||
COMMENT ON COLUMN public.addresses.latitude IS 'The geographic latitude.';
|
||||
@@ -31,12 +38,14 @@ CREATE TABLE IF NOT EXISTS public.users (
|
||||
email TEXT NOT NULL UNIQUE,
|
||||
password_hash TEXT,
|
||||
refresh_token TEXT,
|
||||
failed_login_attempts INTEGER DEFAULT 0,
|
||||
failed_login_attempts INTEGER DEFAULT 0 CHECK (failed_login_attempts >= 0),
|
||||
last_failed_login TIMESTAMPTZ,
|
||||
last_login_at TIMESTAMPTZ,
|
||||
last_login_ip TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT users_email_check CHECK (email ~* '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$'),
|
||||
CONSTRAINT users_password_hash_check CHECK (password_hash IS NULL OR TRIM(password_hash) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.users IS 'Stores user authentication information.';
|
||||
COMMENT ON COLUMN public.users.refresh_token IS 'Stores the long-lived refresh token for re-authentication.';
|
||||
@@ -59,10 +68,13 @@ CREATE TABLE IF NOT EXISTS public.activity_log (
|
||||
icon TEXT,
|
||||
details JSONB,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT activity_log_action_check CHECK (TRIM(action) <> ''),
|
||||
CONSTRAINT activity_log_display_text_check CHECK (TRIM(display_text) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.activity_log IS 'Logs key user and system actions for auditing and display in an activity feed.';
|
||||
CREATE INDEX IF NOT EXISTS idx_activity_log_user_id ON public.activity_log(user_id);
|
||||
-- This composite index is more efficient for user-specific activity feeds ordered by date.
|
||||
CREATE INDEX IF NOT EXISTS idx_activity_log_user_id_created_at ON public.activity_log(user_id, created_at DESC);
|
||||
|
||||
-- 3. for public user profiles.
|
||||
-- This table is linked to the users table and stores non-sensitive user data.
|
||||
@@ -72,16 +84,20 @@ CREATE TABLE IF NOT EXISTS public.profiles (
|
||||
full_name TEXT,
|
||||
avatar_url TEXT,
|
||||
address_id BIGINT REFERENCES public.addresses(address_id) ON DELETE SET NULL,
|
||||
points INTEGER DEFAULT 0 NOT NULL CHECK (points >= 0),
|
||||
preferences JSONB,
|
||||
role TEXT CHECK (role IN ('admin', 'user')),
|
||||
points INTEGER DEFAULT 0 NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT profiles_full_name_check CHECK (full_name IS NULL OR TRIM(full_name) <> ''),
|
||||
CONSTRAINT profiles_avatar_url_check CHECK (avatar_url IS NULL OR avatar_url ~* '^https://?.*'),
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL,
|
||||
updated_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL
|
||||
);
|
||||
COMMENT ON TABLE public.profiles IS 'Stores public-facing user data, linked to the public.users table.';
|
||||
COMMENT ON COLUMN public.profiles.address_id IS 'A foreign key to the user''s primary address in the `addresses` table.';
|
||||
-- This index is crucial for the gamification leaderboard feature.
|
||||
CREATE INDEX IF NOT EXISTS idx_profiles_points_leaderboard ON public.profiles (points DESC, full_name ASC);
|
||||
COMMENT ON COLUMN public.profiles.points IS 'A simple integer column to store a user''s total accumulated points from achievements.';
|
||||
|
||||
-- 4. The 'stores' table for normalized store data.
|
||||
@@ -91,6 +107,8 @@ CREATE TABLE IF NOT EXISTS public.stores (
|
||||
logo_url TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT stores_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT stores_logo_url_check CHECK (logo_url IS NULL OR logo_url ~* '^https://?.*'),
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL
|
||||
);
|
||||
COMMENT ON TABLE public.stores IS 'Stores metadata for grocery store chains (e.g., Safeway, Kroger).';
|
||||
@@ -100,7 +118,8 @@ CREATE TABLE IF NOT EXISTS public.categories (
|
||||
category_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT categories_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.categories IS 'Stores a predefined list of grocery item categories (e.g., ''Fruits & Vegetables'', ''Dairy & Eggs'').';
|
||||
|
||||
@@ -116,10 +135,15 @@ CREATE TABLE IF NOT EXISTS public.flyers (
|
||||
valid_to DATE,
|
||||
store_address TEXT,
|
||||
status TEXT DEFAULT 'processed' NOT NULL CHECK (status IN ('processed', 'needs_review', 'archived')),
|
||||
item_count INTEGER DEFAULT 0 NOT NULL,
|
||||
item_count INTEGER DEFAULT 0 NOT NULL CHECK (item_count >= 0),
|
||||
uploaded_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT flyers_valid_dates_check CHECK (valid_to >= valid_from),
|
||||
CONSTRAINT flyers_file_name_check CHECK (TRIM(file_name) <> ''),
|
||||
CONSTRAINT flyers_image_url_check CHECK (image_url ~* '^https://?.*'),
|
||||
CONSTRAINT flyers_icon_url_check CHECK (icon_url IS NULL OR icon_url ~* '^https://?.*'),
|
||||
CONSTRAINT flyers_checksum_check CHECK (checksum IS NULL OR length(checksum) = 64)
|
||||
);
|
||||
COMMENT ON TABLE public.flyers IS 'Stores metadata for each processed flyer, linking it to a store and its validity period.';
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_store_id ON public.flyers(store_id);
|
||||
@@ -135,6 +159,7 @@ COMMENT ON COLUMN public.flyers.status IS 'The processing status of the flyer, e
|
||||
COMMENT ON COLUMN public.flyers.item_count IS 'A cached count of the number of items in this flyer, maintained by a trigger.';
|
||||
COMMENT ON COLUMN public.flyers.uploaded_by IS 'The user who uploaded the flyer. Can be null for anonymous or system uploads.';
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_status ON public.flyers(status);
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_created_at ON public.flyers (created_at DESC);
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_valid_to_file_name ON public.flyers (valid_to DESC, file_name ASC);
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_status ON public.flyers(status);
|
||||
@@ -147,7 +172,8 @@ CREATE TABLE IF NOT EXISTS public.master_grocery_items (
|
||||
allergy_info JSONB,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL,
|
||||
CONSTRAINT master_grocery_items_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.master_grocery_items IS 'The master dictionary of canonical grocery items. Each item has a unique name and is linked to a category.';
|
||||
CREATE INDEX IF NOT EXISTS idx_master_grocery_items_category_id ON public.master_grocery_items(category_id);
|
||||
@@ -172,7 +198,9 @@ CREATE TABLE IF NOT EXISTS public.brands (
|
||||
logo_url TEXT,
|
||||
store_id BIGINT REFERENCES public.stores(store_id) ON DELETE SET NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT brands_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT brands_logo_url_check CHECK (logo_url IS NULL OR logo_url ~* '^https://?.*')
|
||||
);
|
||||
COMMENT ON TABLE public.brands IS 'Stores brand names like "Coca-Cola", "Maple Leaf", or "Kraft".';
|
||||
COMMENT ON COLUMN public.brands.store_id IS 'If this is a store-specific brand (e.g., President''s Choice), this links to the parent store.';
|
||||
@@ -187,7 +215,9 @@ CREATE TABLE IF NOT EXISTS public.products (
|
||||
size TEXT,
|
||||
upc_code TEXT UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT products_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT products_upc_code_check CHECK (upc_code IS NULL OR upc_code ~ '^[0-9]{8,14}$')
|
||||
);
|
||||
COMMENT ON TABLE public.products IS 'Represents a specific, sellable product, combining a generic item with a brand and size.';
|
||||
COMMENT ON COLUMN public.products.upc_code IS 'Universal Product Code, if available, for exact product matching.';
|
||||
@@ -203,18 +233,22 @@ CREATE TABLE IF NOT EXISTS public.flyer_items (
|
||||
flyer_id BIGINT REFERENCES public.flyers(flyer_id) ON DELETE CASCADE,
|
||||
item TEXT NOT NULL,
|
||||
price_display TEXT NOT NULL,
|
||||
price_in_cents INTEGER,
|
||||
price_in_cents INTEGER CHECK (price_in_cents IS NULL OR price_in_cents >= 0),
|
||||
quantity_num NUMERIC,
|
||||
quantity TEXT NOT NULL,
|
||||
category_id BIGINT REFERENCES public.categories(category_id) ON DELETE SET NULL,
|
||||
category_name TEXT,
|
||||
unit_price JSONB,
|
||||
view_count INTEGER DEFAULT 0 NOT NULL,
|
||||
click_count INTEGER DEFAULT 0 NOT NULL,
|
||||
view_count INTEGER DEFAULT 0 NOT NULL CHECK (view_count >= 0),
|
||||
click_count INTEGER DEFAULT 0 NOT NULL CHECK (click_count >= 0),
|
||||
master_item_id BIGINT REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE SET NULL,
|
||||
product_id BIGINT REFERENCES public.products(product_id) ON DELETE SET NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT flyer_items_item_check CHECK (TRIM(item) <> ''),
|
||||
CONSTRAINT flyer_items_price_display_check CHECK (TRIM(price_display) <> ''),
|
||||
CONSTRAINT flyer_items_quantity_check CHECK (TRIM(quantity) <> ''),
|
||||
CONSTRAINT flyer_items_category_name_check CHECK (category_name IS NULL OR TRIM(category_name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.flyer_items IS 'Stores individual items extracted from a specific flyer.';
|
||||
COMMENT ON COLUMN public.flyer_items.flyer_id IS 'Foreign key linking this item to its parent flyer in the `flyers` table.';
|
||||
@@ -233,6 +267,8 @@ CREATE INDEX IF NOT EXISTS idx_flyer_items_master_item_id ON public.flyer_items(
|
||||
CREATE INDEX IF NOT EXISTS idx_flyer_items_category_id ON public.flyer_items(category_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_flyer_items_product_id ON public.flyer_items(product_id);
|
||||
-- Add a GIN index to the 'item' column for fast fuzzy text searching.
|
||||
-- This partial index is optimized for queries that find the best price for an item.
|
||||
CREATE INDEX IF NOT EXISTS idx_flyer_items_master_item_price ON public.flyer_items (master_item_id, price_in_cents ASC) WHERE price_in_cents IS NOT NULL;
|
||||
-- This requires the pg_trgm extension.
|
||||
CREATE INDEX IF NOT EXISTS flyer_items_item_trgm_idx ON public.flyer_items USING GIN (item gin_trgm_ops);
|
||||
|
||||
@@ -241,7 +277,7 @@ CREATE TABLE IF NOT EXISTS public.user_alerts (
|
||||
user_alert_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
user_watched_item_id BIGINT NOT NULL REFERENCES public.user_watched_items(user_watched_item_id) ON DELETE CASCADE,
|
||||
alert_type TEXT NOT NULL CHECK (alert_type IN ('PRICE_BELOW', 'PERCENT_OFF_AVERAGE')),
|
||||
threshold_value NUMERIC NOT NULL,
|
||||
threshold_value NUMERIC NOT NULL CHECK (threshold_value > 0),
|
||||
is_active BOOLEAN DEFAULT true NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
@@ -259,7 +295,8 @@ CREATE TABLE IF NOT EXISTS public.notifications (
|
||||
link_url TEXT,
|
||||
is_read BOOLEAN DEFAULT false NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT notifications_content_check CHECK (TRIM(content) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.notifications IS 'A central log of notifications generated for users, such as price alerts.';
|
||||
COMMENT ON COLUMN public.notifications.content IS 'The notification message displayed to the user.';
|
||||
@@ -272,8 +309,8 @@ CREATE TABLE IF NOT EXISTS public.store_locations (
|
||||
store_location_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
store_id BIGINT REFERENCES public.stores(store_id) ON DELETE CASCADE,
|
||||
address_id BIGINT NOT NULL REFERENCES public.addresses(address_id) ON DELETE CASCADE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
UNIQUE(store_id, address_id),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
);
|
||||
COMMENT ON TABLE public.store_locations IS 'Stores physical locations of stores with geographic data for proximity searches.';
|
||||
@@ -285,13 +322,14 @@ CREATE TABLE IF NOT EXISTS public.item_price_history (
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
summary_date DATE NOT NULL,
|
||||
store_location_id BIGINT REFERENCES public.store_locations(store_location_id) ON DELETE CASCADE,
|
||||
min_price_in_cents INTEGER,
|
||||
max_price_in_cents INTEGER,
|
||||
avg_price_in_cents INTEGER,
|
||||
data_points_count INTEGER DEFAULT 0 NOT NULL,
|
||||
min_price_in_cents INTEGER CHECK (min_price_in_cents IS NULL OR min_price_in_cents >= 0),
|
||||
max_price_in_cents INTEGER CHECK (max_price_in_cents IS NULL OR max_price_in_cents >= 0),
|
||||
avg_price_in_cents INTEGER CHECK (avg_price_in_cents IS NULL OR avg_price_in_cents >= 0),
|
||||
data_points_count INTEGER DEFAULT 0 NOT NULL CHECK (data_points_count >= 0),
|
||||
UNIQUE(master_item_id, summary_date, store_location_id),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT item_price_history_price_order_check CHECK (min_price_in_cents <= max_price_in_cents)
|
||||
);
|
||||
COMMENT ON TABLE public.item_price_history IS 'Serves as a summary table to speed up charting and analytics.';
|
||||
COMMENT ON COLUMN public.item_price_history.summary_date IS 'The date for which the price data is summarized.';
|
||||
@@ -308,7 +346,8 @@ CREATE TABLE IF NOT EXISTS public.master_item_aliases (
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
alias TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT master_item_aliases_alias_check CHECK (TRIM(alias) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.master_item_aliases IS 'Stores synonyms or alternative names for master items to improve matching.';
|
||||
COMMENT ON COLUMN public.master_item_aliases.alias IS 'An alternative name, e.g., "Ground Chuck" for the master item "Ground Beef".';
|
||||
@@ -320,7 +359,8 @@ CREATE TABLE IF NOT EXISTS public.shopping_lists (
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
name TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT shopping_lists_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.shopping_lists IS 'Stores user-created shopping lists, e.g., "Weekly Groceries".';
|
||||
CREATE INDEX IF NOT EXISTS idx_shopping_lists_user_id ON public.shopping_lists(user_id);
|
||||
@@ -331,12 +371,13 @@ CREATE TABLE IF NOT EXISTS public.shopping_list_items (
|
||||
shopping_list_id BIGINT NOT NULL REFERENCES public.shopping_lists(shopping_list_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
custom_item_name TEXT,
|
||||
quantity NUMERIC DEFAULT 1 NOT NULL,
|
||||
quantity NUMERIC DEFAULT 1 NOT NULL CHECK (quantity > 0),
|
||||
is_purchased BOOLEAN DEFAULT false NOT NULL,
|
||||
notes TEXT,
|
||||
added_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT must_have_item_identifier CHECK (master_item_id IS NOT NULL OR custom_item_name IS NOT NULL)
|
||||
CONSTRAINT must_have_item_identifier CHECK (master_item_id IS NOT NULL OR custom_item_name IS NOT NULL),
|
||||
CONSTRAINT shopping_list_items_custom_item_name_check CHECK (custom_item_name IS NULL OR TRIM(custom_item_name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.shopping_list_items IS 'Contains individual items for a specific shopping list.';
|
||||
COMMENT ON COLUMN public.shopping_list_items.custom_item_name IS 'For items not in the master list, e.g., "Grandma''s special spice mix".';
|
||||
@@ -344,7 +385,6 @@ COMMENT ON COLUMN public.shopping_list_items.is_purchased IS 'Lets users check i
|
||||
CREATE INDEX IF NOT EXISTS idx_shopping_list_items_shopping_list_id ON public.shopping_list_items(shopping_list_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_shopping_list_items_master_item_id ON public.shopping_list_items(master_item_id);
|
||||
|
||||
-- 17. Manage shared access to shopping lists.
|
||||
CREATE TABLE IF NOT EXISTS public.shared_shopping_lists (
|
||||
shared_shopping_list_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
shopping_list_id BIGINT NOT NULL REFERENCES public.shopping_lists(shopping_list_id) ON DELETE CASCADE,
|
||||
@@ -369,6 +409,7 @@ CREATE TABLE IF NOT EXISTS public.menu_plans (
|
||||
end_date DATE NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT menu_plans_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT date_range_check CHECK (end_date >= start_date)
|
||||
);
|
||||
COMMENT ON TABLE public.menu_plans IS 'Represents a user''s meal plan for a specific period, e.g., "Week of Oct 23".';
|
||||
@@ -397,11 +438,13 @@ CREATE TABLE IF NOT EXISTS public.suggested_corrections (
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
correction_type TEXT NOT NULL,
|
||||
suggested_value TEXT NOT NULL,
|
||||
status TEXT DEFAULT 'pending' NOT NULL,
|
||||
status TEXT DEFAULT 'pending' NOT NULL CHECK (status IN ('pending', 'approved', 'rejected')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
reviewed_notes TEXT,
|
||||
reviewed_at TIMESTAMPTZ,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT suggested_corrections_correction_type_check CHECK (TRIM(correction_type) <> ''),
|
||||
CONSTRAINT suggested_corrections_suggested_value_check CHECK (TRIM(suggested_value) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.suggested_corrections IS 'A queue for user-submitted data corrections, enabling crowdsourced data quality improvements.';
|
||||
COMMENT ON COLUMN public.suggested_corrections.correction_type IS 'The type of error the user is reporting.';
|
||||
@@ -417,12 +460,13 @@ CREATE TABLE IF NOT EXISTS public.user_submitted_prices (
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
store_id BIGINT NOT NULL REFERENCES public.stores(store_id) ON DELETE CASCADE,
|
||||
price_in_cents INTEGER NOT NULL,
|
||||
price_in_cents INTEGER NOT NULL CHECK (price_in_cents > 0),
|
||||
photo_url TEXT,
|
||||
upvotes INTEGER DEFAULT 0 NOT NULL,
|
||||
downvotes INTEGER DEFAULT 0 NOT NULL,
|
||||
upvotes INTEGER DEFAULT 0 NOT NULL CHECK (upvotes >= 0),
|
||||
downvotes INTEGER DEFAULT 0 NOT NULL CHECK (downvotes >= 0),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT user_submitted_prices_photo_url_check CHECK (photo_url IS NULL OR photo_url ~* '^https://?.*')
|
||||
);
|
||||
COMMENT ON TABLE public.user_submitted_prices IS 'Stores item prices submitted by users directly from physical stores.';
|
||||
COMMENT ON COLUMN public.user_submitted_prices.photo_url IS 'URL to user-submitted photo evidence of the price.';
|
||||
@@ -464,20 +508,22 @@ CREATE TABLE IF NOT EXISTS public.recipes (
|
||||
name TEXT NOT NULL,
|
||||
description TEXT,
|
||||
instructions TEXT,
|
||||
prep_time_minutes INTEGER,
|
||||
cook_time_minutes INTEGER,
|
||||
servings INTEGER,
|
||||
prep_time_minutes INTEGER CHECK (prep_time_minutes IS NULL OR prep_time_minutes >= 0),
|
||||
cook_time_minutes INTEGER CHECK (cook_time_minutes IS NULL OR cook_time_minutes >= 0),
|
||||
servings INTEGER CHECK (servings IS NULL OR servings > 0),
|
||||
photo_url TEXT,
|
||||
calories_per_serving INTEGER,
|
||||
protein_grams NUMERIC,
|
||||
fat_grams NUMERIC,
|
||||
carb_grams NUMERIC,
|
||||
avg_rating NUMERIC(2,1) DEFAULT 0.0 NOT NULL,
|
||||
status TEXT DEFAULT 'private' NOT NULL CHECK (status IN ('private', 'pending_review', 'public', 'rejected')),
|
||||
rating_count INTEGER DEFAULT 0 NOT NULL,
|
||||
fork_count INTEGER DEFAULT 0 NOT NULL,
|
||||
avg_rating NUMERIC(2,1) DEFAULT 0.0 NOT NULL CHECK (avg_rating >= 0.0 AND avg_rating <= 5.0),
|
||||
status TEXT DEFAULT 'private' NOT NULL CHECK (status IN ('private', 'pending_review', 'public', 'rejected')),
|
||||
rating_count INTEGER DEFAULT 0 NOT NULL CHECK (rating_count >= 0),
|
||||
fork_count INTEGER DEFAULT 0 NOT NULL CHECK (fork_count >= 0),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT recipes_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT recipes_photo_url_check CHECK (photo_url IS NULL OR photo_url ~* '^https://?.*')
|
||||
);
|
||||
COMMENT ON TABLE public.recipes IS 'Stores recipes that can be used to generate shopping lists.';
|
||||
COMMENT ON COLUMN public.recipes.servings IS 'The number of servings this recipe yields.';
|
||||
@@ -488,11 +534,11 @@ COMMENT ON COLUMN public.recipes.calories_per_serving IS 'Optional nutritional i
|
||||
COMMENT ON COLUMN public.recipes.protein_grams IS 'Optional nutritional information.';
|
||||
COMMENT ON COLUMN public.recipes.fat_grams IS 'Optional nutritional information.';
|
||||
COMMENT ON COLUMN public.recipes.carb_grams IS 'Optional nutritional information.';
|
||||
COMMENT ON COLUMN public.recipes.fork_count IS 'To track how many times a public recipe has been "forked" or copied by other users.';
|
||||
CREATE INDEX IF NOT EXISTS idx_recipes_user_id ON public.recipes(user_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_recipes_original_recipe_id ON public.recipes(original_recipe_id);
|
||||
-- Add a partial unique index to ensure system-wide recipes (user_id IS NULL) have unique names.
|
||||
-- This allows different users to have recipes with the same name.
|
||||
-- This index helps speed up sorting for recipe recommendations.
|
||||
CREATE INDEX IF NOT EXISTS idx_recipes_rating_sort ON public.recipes (avg_rating DESC, rating_count DESC);
|
||||
CREATE UNIQUE INDEX IF NOT EXISTS idx_recipes_unique_system_recipe_name ON public.recipes(name) WHERE user_id IS NULL;
|
||||
|
||||
-- 27. For ingredients required for each recipe.
|
||||
@@ -500,10 +546,11 @@ CREATE TABLE IF NOT EXISTS public.recipe_ingredients (
|
||||
recipe_ingredient_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
recipe_id BIGINT NOT NULL REFERENCES public.recipes(recipe_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
quantity NUMERIC NOT NULL,
|
||||
quantity NUMERIC NOT NULL CHECK (quantity > 0),
|
||||
unit TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT recipe_ingredients_unit_check CHECK (TRIM(unit) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.recipe_ingredients IS 'Defines the ingredients and quantities needed for a recipe.';
|
||||
COMMENT ON COLUMN public.recipe_ingredients.unit IS 'e.g., "cups", "tbsp", "g", "each".';
|
||||
@@ -529,7 +576,8 @@ CREATE TABLE IF NOT EXISTS public.tags (
|
||||
tag_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT tags_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.tags IS 'Stores tags for categorizing recipes, e.g., "Vegetarian", "Quick & Easy".';
|
||||
|
||||
@@ -543,6 +591,7 @@ CREATE TABLE IF NOT EXISTS public.recipe_tags (
|
||||
);
|
||||
COMMENT ON TABLE public.recipe_tags IS 'A linking table to associate multiple tags with a single recipe.';
|
||||
CREATE INDEX IF NOT EXISTS idx_recipe_tags_recipe_id ON public.recipe_tags(recipe_id);
|
||||
-- This index is crucial for functions that find recipes based on tags.
|
||||
CREATE INDEX IF NOT EXISTS idx_recipe_tags_tag_id ON public.recipe_tags(tag_id);
|
||||
|
||||
-- 31. Store a predefined list of kitchen appliances.
|
||||
@@ -550,7 +599,8 @@ CREATE TABLE IF NOT EXISTS public.appliances (
|
||||
appliance_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT appliances_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.appliances IS 'A predefined list of kitchen appliances (e.g., Air Fryer, Instant Pot).';
|
||||
|
||||
@@ -590,7 +640,8 @@ CREATE TABLE IF NOT EXISTS public.recipe_comments (
|
||||
content TEXT NOT NULL,
|
||||
status TEXT DEFAULT 'visible' NOT NULL CHECK (status IN ('visible', 'hidden', 'reported')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT recipe_comments_content_check CHECK (TRIM(content) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.recipe_comments IS 'Allows for threaded discussions and comments on recipes.';
|
||||
COMMENT ON COLUMN public.recipe_comments.parent_comment_id IS 'For threaded comments.';
|
||||
@@ -605,6 +656,7 @@ CREATE TABLE IF NOT EXISTS public.pantry_locations (
|
||||
name TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT pantry_locations_name_check CHECK (TRIM(name) <> ''),
|
||||
UNIQUE(user_id, name)
|
||||
);
|
||||
COMMENT ON TABLE public.pantry_locations IS 'User-defined locations for organizing pantry items (e.g., "Fridge", "Freezer", "Spice Rack").';
|
||||
@@ -618,8 +670,9 @@ CREATE TABLE IF NOT EXISTS public.planned_meals (
|
||||
plan_date DATE NOT NULL,
|
||||
meal_type TEXT NOT NULL,
|
||||
servings_to_cook INTEGER,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT planned_meals_meal_type_check CHECK (TRIM(meal_type) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.planned_meals IS 'Assigns a recipe to a specific day and meal type within a user''s menu plan.';
|
||||
COMMENT ON COLUMN public.planned_meals.meal_type IS 'The designated meal for the recipe, e.g., ''Breakfast'', ''Lunch'', ''Dinner''.';
|
||||
@@ -631,7 +684,7 @@ CREATE TABLE IF NOT EXISTS public.pantry_items (
|
||||
pantry_item_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
quantity NUMERIC NOT NULL,
|
||||
quantity NUMERIC NOT NULL CHECK (quantity >= 0),
|
||||
unit TEXT,
|
||||
best_before_date DATE,
|
||||
pantry_location_id BIGINT REFERENCES public.pantry_locations(pantry_location_id) ON DELETE SET NULL,
|
||||
@@ -640,7 +693,6 @@ CREATE TABLE IF NOT EXISTS public.pantry_items (
|
||||
UNIQUE(user_id, master_item_id, unit)
|
||||
);
|
||||
COMMENT ON TABLE public.pantry_items IS 'Tracks a user''s personal inventory of grocery items to enable smart shopping lists.';
|
||||
COMMENT ON COLUMN public.pantry_items.quantity IS 'The current amount of the item. Convention: use grams for weight, mL for volume where applicable.';
|
||||
COMMENT ON COLUMN public.pantry_items.pantry_location_id IS 'Links the item to a user-defined location like "Fridge" or "Freezer".';
|
||||
COMMENT ON COLUMN public.pantry_items.unit IS 'e.g., ''g'', ''ml'', ''items''. Should align with recipe_ingredients.unit and quantity convention.';
|
||||
CREATE INDEX IF NOT EXISTS idx_pantry_items_user_id ON public.pantry_items(user_id);
|
||||
@@ -654,7 +706,8 @@ CREATE TABLE IF NOT EXISTS public.password_reset_tokens (
|
||||
token_hash TEXT NOT NULL UNIQUE,
|
||||
expires_at TIMESTAMPTZ NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT password_reset_tokens_token_hash_check CHECK (TRIM(token_hash) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.password_reset_tokens IS 'Stores secure, single-use tokens for password reset requests.';
|
||||
COMMENT ON COLUMN public.password_reset_tokens.token_hash IS 'A bcrypt hash of the reset token sent to the user.';
|
||||
@@ -669,10 +722,13 @@ CREATE TABLE IF NOT EXISTS public.unit_conversions (
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
from_unit TEXT NOT NULL,
|
||||
to_unit TEXT NOT NULL,
|
||||
factor NUMERIC NOT NULL,
|
||||
factor NUMERIC NOT NULL CHECK (factor > 0),
|
||||
UNIQUE(master_item_id, from_unit, to_unit),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT unit_conversions_from_unit_check CHECK (TRIM(from_unit) <> ''),
|
||||
CONSTRAINT unit_conversions_to_unit_check CHECK (TRIM(to_unit) <> ''),
|
||||
CONSTRAINT unit_conversions_units_check CHECK (from_unit <> to_unit)
|
||||
);
|
||||
COMMENT ON TABLE public.unit_conversions IS 'Stores item-specific unit conversion factors (e.g., grams of flour to cups).';
|
||||
COMMENT ON COLUMN public.unit_conversions.factor IS 'The multiplication factor to convert from_unit to to_unit.';
|
||||
@@ -686,7 +742,8 @@ CREATE TABLE IF NOT EXISTS public.user_item_aliases (
|
||||
alias TEXT NOT NULL,
|
||||
UNIQUE(user_id, alias),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT user_item_aliases_alias_check CHECK (TRIM(alias) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.user_item_aliases IS 'Allows users to create personal aliases for grocery items (e.g., "Dad''s Cereal").';
|
||||
CREATE INDEX IF NOT EXISTS idx_user_item_aliases_user_id ON public.user_item_aliases(user_id);
|
||||
@@ -723,7 +780,8 @@ CREATE TABLE IF NOT EXISTS public.recipe_collections (
|
||||
name TEXT NOT NULL,
|
||||
description TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT recipe_collections_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.recipe_collections IS 'Allows users to create personal collections of recipes (e.g., "Holiday Baking").';
|
||||
CREATE INDEX IF NOT EXISTS idx_recipe_collections_user_id ON public.recipe_collections(user_id);
|
||||
@@ -748,8 +806,11 @@ CREATE TABLE IF NOT EXISTS public.shared_recipe_collections (
|
||||
shared_with_user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
permission_level TEXT NOT NULL CHECK (permission_level IN ('view', 'edit')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
UNIQUE(recipe_collection_id, shared_with_user_id)
|
||||
);
|
||||
-- This index is crucial for efficiently finding all collections shared with a specific user.
|
||||
CREATE INDEX IF NOT EXISTS idx_shared_recipe_collections_shared_with ON public.shared_recipe_collections(shared_with_user_id);
|
||||
|
||||
-- 45. Log user search queries for analysis.
|
||||
CREATE TABLE IF NOT EXISTS public.search_queries (
|
||||
@@ -759,7 +820,8 @@ CREATE TABLE IF NOT EXISTS public.search_queries (
|
||||
result_count INTEGER,
|
||||
was_successful BOOLEAN,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT search_queries_query_text_check CHECK (TRIM(query_text) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.search_queries IS 'Logs user search queries to analyze search effectiveness and identify gaps in data.';
|
||||
COMMENT ON COLUMN public.search_queries.was_successful IS 'Indicates if the user interacted with a search result.';
|
||||
@@ -785,10 +847,11 @@ CREATE TABLE IF NOT EXISTS public.shopping_trip_items (
|
||||
shopping_trip_id BIGINT NOT NULL REFERENCES public.shopping_trips(shopping_trip_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE SET NULL,
|
||||
custom_item_name TEXT,
|
||||
quantity NUMERIC NOT NULL,
|
||||
quantity NUMERIC NOT NULL CHECK (quantity > 0),
|
||||
price_paid_cents INTEGER,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT shopping_trip_items_custom_item_name_check CHECK (custom_item_name IS NULL OR TRIM(custom_item_name) <> ''),
|
||||
CONSTRAINT trip_must_have_item_identifier CHECK (master_item_id IS NOT NULL OR custom_item_name IS NOT NULL)
|
||||
);
|
||||
COMMENT ON TABLE public.shopping_trip_items IS 'A historical log of items purchased during a shopping trip.';
|
||||
@@ -802,7 +865,8 @@ CREATE TABLE IF NOT EXISTS public.dietary_restrictions (
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
type TEXT NOT NULL CHECK (type IN ('diet', 'allergy')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT dietary_restrictions_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.dietary_restrictions IS 'A predefined list of common diets (e.g., Vegan) and allergies (e.g., Nut Allergy).';
|
||||
|
||||
@@ -815,6 +879,7 @@ CREATE TABLE IF NOT EXISTS public.user_dietary_restrictions (
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
);
|
||||
COMMENT ON TABLE public.user_dietary_restrictions IS 'Connects users to their selected dietary needs and allergies.';
|
||||
-- This index is crucial for functions that filter recipes based on user diets/allergies.
|
||||
CREATE INDEX IF NOT EXISTS idx_user_dietary_restrictions_user_id ON public.user_dietary_restrictions(user_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_user_dietary_restrictions_restriction_id ON public.user_dietary_restrictions(restriction_id);
|
||||
|
||||
@@ -840,6 +905,7 @@ CREATE TABLE IF NOT EXISTS public.user_follows (
|
||||
CONSTRAINT cant_follow_self CHECK (follower_id <> following_id)
|
||||
);
|
||||
COMMENT ON TABLE public.user_follows IS 'Stores user following relationships to build a social graph.';
|
||||
-- This index is crucial for efficiently generating a user's activity feed.
|
||||
CREATE INDEX IF NOT EXISTS idx_user_follows_follower_id ON public.user_follows(follower_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_user_follows_following_id ON public.user_follows(following_id);
|
||||
|
||||
@@ -850,12 +916,13 @@ CREATE TABLE IF NOT EXISTS public.receipts (
|
||||
store_id BIGINT REFERENCES public.stores(store_id) ON DELETE CASCADE,
|
||||
receipt_image_url TEXT NOT NULL,
|
||||
transaction_date TIMESTAMPTZ,
|
||||
total_amount_cents INTEGER,
|
||||
total_amount_cents INTEGER CHECK (total_amount_cents IS NULL OR total_amount_cents >= 0),
|
||||
status TEXT DEFAULT 'pending' NOT NULL CHECK (status IN ('pending', 'processing', 'completed', 'failed')),
|
||||
raw_text TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
processed_at TIMESTAMPTZ,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
processed_at TIMESTAMPTZ,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT receipts_receipt_image_url_check CHECK (receipt_image_url ~* '^https://?.*')
|
||||
);
|
||||
COMMENT ON TABLE public.receipts IS 'Stores uploaded user receipts for purchase tracking and analysis.';
|
||||
CREATE INDEX IF NOT EXISTS idx_receipts_user_id ON public.receipts(user_id);
|
||||
@@ -866,13 +933,14 @@ CREATE TABLE IF NOT EXISTS public.receipt_items (
|
||||
receipt_item_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
receipt_id BIGINT NOT NULL REFERENCES public.receipts(receipt_id) ON DELETE CASCADE,
|
||||
raw_item_description TEXT NOT NULL,
|
||||
quantity NUMERIC DEFAULT 1 NOT NULL,
|
||||
price_paid_cents INTEGER NOT NULL,
|
||||
quantity NUMERIC DEFAULT 1 NOT NULL CHECK (quantity > 0),
|
||||
price_paid_cents INTEGER NOT NULL CHECK (price_paid_cents >= 0),
|
||||
master_item_id BIGINT REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE SET NULL,
|
||||
product_id BIGINT REFERENCES public.products(product_id) ON DELETE SET NULL,
|
||||
status TEXT DEFAULT 'unmatched' NOT NULL CHECK (status IN ('unmatched', 'matched', 'needs_review', 'ignored')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT receipt_items_raw_item_description_check CHECK (TRIM(raw_item_description) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.receipt_items IS 'Stores individual line items extracted from a user receipt.';
|
||||
CREATE INDEX IF NOT EXISTS idx_receipt_items_receipt_id ON public.receipt_items(receipt_id);
|
||||
@@ -885,7 +953,6 @@ CREATE TABLE IF NOT EXISTS public.schema_info (
|
||||
deployed_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
);
|
||||
COMMENT ON TABLE public.schema_info IS 'Stores metadata about the deployed schema, such as a hash of the schema file, to detect changes.';
|
||||
COMMENT ON COLUMN public.schema_info.environment IS 'The deployment environment (e.g., ''development'', ''test'', ''production'').';
|
||||
COMMENT ON COLUMN public.schema_info.schema_hash IS 'A SHA-256 hash of the master_schema_rollup.sql file at the time of deployment.';
|
||||
|
||||
-- 55. Store user reactions to various entities (e.g., recipes, comments).
|
||||
@@ -912,8 +979,10 @@ CREATE TABLE IF NOT EXISTS public.achievements (
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
description TEXT NOT NULL,
|
||||
icon TEXT,
|
||||
points_value INTEGER NOT NULL DEFAULT 0,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
points_value INTEGER NOT NULL DEFAULT 0 CHECK (points_value >= 0),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT achievements_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT achievements_description_check CHECK (TRIM(description) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.achievements IS 'A static table defining the available achievements users can earn.';
|
||||
|
||||
@@ -934,11 +1003,12 @@ CREATE TABLE IF NOT EXISTS public.budgets (
|
||||
budget_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
name TEXT NOT NULL,
|
||||
amount_cents INTEGER NOT NULL,
|
||||
amount_cents INTEGER NOT NULL CHECK (amount_cents > 0),
|
||||
period TEXT NOT NULL CHECK (period IN ('weekly', 'monthly')),
|
||||
start_date DATE NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT budgets_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.budgets IS 'Allows users to set weekly or monthly grocery budgets for spending tracking.';
|
||||
CREATE INDEX IF NOT EXISTS idx_budgets_user_id ON public.budgets(user_id);
|
||||
|
||||
@@ -23,16 +23,23 @@
|
||||
CREATE TABLE IF NOT EXISTS public.addresses (
|
||||
address_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
address_line_1 TEXT NOT NULL UNIQUE,
|
||||
address_line_2 TEXT,
|
||||
city TEXT NOT NULL,
|
||||
province_state TEXT NOT NULL,
|
||||
postal_code TEXT NOT NULL,
|
||||
country TEXT NOT NULL,
|
||||
address_line_2 TEXT,
|
||||
latitude NUMERIC(9, 6),
|
||||
longitude NUMERIC(9, 6),
|
||||
location GEOGRAPHY(Point, 4326),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT addresses_address_line_1_check CHECK (TRIM(address_line_1) <> ''),
|
||||
CONSTRAINT addresses_city_check CHECK (TRIM(city) <> ''),
|
||||
CONSTRAINT addresses_province_state_check CHECK (TRIM(province_state) <> ''),
|
||||
CONSTRAINT addresses_postal_code_check CHECK (TRIM(postal_code) <> ''),
|
||||
CONSTRAINT addresses_country_check CHECK (TRIM(country) <> ''),
|
||||
CONSTRAINT addresses_latitude_check CHECK (latitude >= -90 AND latitude <= 90),
|
||||
CONSTRAINT addresses_longitude_check CHECK (longitude >= -180 AND longitude <= 180)
|
||||
);
|
||||
COMMENT ON TABLE public.addresses IS 'A centralized table for storing all physical addresses for users and stores.';
|
||||
COMMENT ON COLUMN public.addresses.latitude IS 'The geographic latitude.';
|
||||
@@ -45,14 +52,16 @@ CREATE INDEX IF NOT EXISTS addresses_location_idx ON public.addresses USING GIST
|
||||
CREATE TABLE IF NOT EXISTS public.users (
|
||||
user_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
|
||||
email TEXT NOT NULL UNIQUE,
|
||||
password_hash TEXT,
|
||||
password_hash TEXT,
|
||||
refresh_token TEXT,
|
||||
failed_login_attempts INTEGER DEFAULT 0,
|
||||
failed_login_attempts INTEGER DEFAULT 0 CHECK (failed_login_attempts >= 0),
|
||||
last_failed_login TIMESTAMPTZ,
|
||||
last_login_at TIMESTAMPTZ,
|
||||
last_login_ip TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT users_email_check CHECK (email ~* '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$'),
|
||||
CONSTRAINT users_password_hash_check CHECK (password_hash IS NULL OR TRIM(password_hash) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.users IS 'Stores user authentication information.';
|
||||
COMMENT ON COLUMN public.users.refresh_token IS 'Stores the long-lived refresh token for re-authentication.';
|
||||
@@ -74,11 +83,14 @@ CREATE TABLE IF NOT EXISTS public.activity_log (
|
||||
display_text TEXT NOT NULL,
|
||||
icon TEXT,
|
||||
details JSONB,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT activity_log_action_check CHECK (TRIM(action) <> ''),
|
||||
CONSTRAINT activity_log_display_text_check CHECK (TRIM(display_text) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.activity_log IS 'Logs key user and system actions for auditing and display in an activity feed.';
|
||||
CREATE INDEX IF NOT EXISTS idx_activity_log_user_id ON public.activity_log(user_id);
|
||||
-- This composite index is more efficient for user-specific activity feeds ordered by date.
|
||||
CREATE INDEX IF NOT EXISTS idx_activity_log_user_id_created_at ON public.activity_log(user_id, created_at DESC);
|
||||
|
||||
-- 3. for public user profiles.
|
||||
-- This table is linked to the users table and stores non-sensitive user data.
|
||||
@@ -88,16 +100,20 @@ CREATE TABLE IF NOT EXISTS public.profiles (
|
||||
full_name TEXT,
|
||||
avatar_url TEXT,
|
||||
address_id BIGINT REFERENCES public.addresses(address_id) ON DELETE SET NULL,
|
||||
points INTEGER DEFAULT 0 NOT NULL,
|
||||
points INTEGER DEFAULT 0 NOT NULL CHECK (points >= 0),
|
||||
preferences JSONB,
|
||||
role TEXT CHECK (role IN ('admin', 'user')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL,
|
||||
CONSTRAINT profiles_full_name_check CHECK (full_name IS NULL OR TRIM(full_name) <> ''),
|
||||
CONSTRAINT profiles_avatar_url_check CHECK (avatar_url IS NULL OR avatar_url ~* '^https://?.*'),
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL,
|
||||
updated_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL
|
||||
);
|
||||
COMMENT ON TABLE public.profiles IS 'Stores public-facing user data, linked to the public.users table.';
|
||||
COMMENT ON COLUMN public.profiles.address_id IS 'A foreign key to the user''s primary address in the `addresses` table.';
|
||||
-- This index is crucial for the gamification leaderboard feature.
|
||||
CREATE INDEX IF NOT EXISTS idx_profiles_points_leaderboard ON public.profiles (points DESC, full_name ASC);
|
||||
COMMENT ON COLUMN public.profiles.points IS 'A simple integer column to store a user''s total accumulated points from achievements.';
|
||||
|
||||
-- 4. The 'stores' table for normalized store data.
|
||||
@@ -107,7 +123,9 @@ CREATE TABLE IF NOT EXISTS public.stores (
|
||||
logo_url TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL
|
||||
CONSTRAINT stores_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT stores_logo_url_check CHECK (logo_url IS NULL OR logo_url ~* '^https://?.*'),
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL
|
||||
);
|
||||
COMMENT ON TABLE public.stores IS 'Stores metadata for grocery store chains (e.g., Safeway, Kroger).';
|
||||
|
||||
@@ -116,7 +134,8 @@ CREATE TABLE IF NOT EXISTS public.categories (
|
||||
category_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT categories_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.categories IS 'Stores a predefined list of grocery item categories (e.g., ''Fruits & Vegetables'', ''Dairy & Eggs'').';
|
||||
|
||||
@@ -126,16 +145,21 @@ CREATE TABLE IF NOT EXISTS public.flyers (
|
||||
file_name TEXT NOT NULL,
|
||||
image_url TEXT NOT NULL,
|
||||
icon_url TEXT,
|
||||
checksum TEXT UNIQUE,
|
||||
store_id BIGINT REFERENCES public.stores(store_id) ON DELETE CASCADE,
|
||||
checksum TEXT UNIQUE,
|
||||
store_id BIGINT REFERENCES public.stores(store_id) ON DELETE CASCADE,
|
||||
valid_from DATE,
|
||||
valid_to DATE,
|
||||
store_address TEXT,
|
||||
status TEXT DEFAULT 'processed' NOT NULL CHECK (status IN ('processed', 'needs_review', 'archived')),
|
||||
item_count INTEGER DEFAULT 0 NOT NULL,
|
||||
status TEXT DEFAULT 'processed' NOT NULL CHECK (status IN ('processed', 'needs_review', 'archived')),
|
||||
item_count INTEGER DEFAULT 0 NOT NULL CHECK (item_count >= 0),
|
||||
uploaded_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT flyers_valid_dates_check CHECK (valid_to >= valid_from),
|
||||
CONSTRAINT flyers_file_name_check CHECK (TRIM(file_name) <> ''),
|
||||
CONSTRAINT flyers_image_url_check CHECK (image_url ~* '^https://?.*'),
|
||||
CONSTRAINT flyers_icon_url_check CHECK (icon_url IS NULL OR icon_url ~* '^https://?.*'),
|
||||
CONSTRAINT flyers_checksum_check CHECK (checksum IS NULL OR length(checksum) = 64)
|
||||
);
|
||||
COMMENT ON TABLE public.flyers IS 'Stores metadata for each processed flyer, linking it to a store and its validity period.';
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_store_id ON public.flyers(store_id);
|
||||
@@ -151,9 +175,9 @@ COMMENT ON COLUMN public.flyers.status IS 'The processing status of the flyer, e
|
||||
COMMENT ON COLUMN public.flyers.item_count IS 'A cached count of the number of items in this flyer, maintained by a trigger.';
|
||||
COMMENT ON COLUMN public.flyers.uploaded_by IS 'The user who uploaded the flyer. Can be null for anonymous or system uploads.';
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_status ON public.flyers(status);
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_created_at ON public.flyers (created_at DESC);
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_valid_to_file_name ON public.flyers (valid_to DESC, file_name ASC);
|
||||
CREATE INDEX IF NOT EXISTS idx_flyers_status ON public.flyers(status);
|
||||
-- 7. The 'master_grocery_items' table. This is the master dictionary.
|
||||
CREATE TABLE IF NOT EXISTS public.master_grocery_items (
|
||||
master_grocery_item_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
@@ -163,7 +187,8 @@ CREATE TABLE IF NOT EXISTS public.master_grocery_items (
|
||||
allergy_info JSONB,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL
|
||||
created_by UUID REFERENCES public.users(user_id) ON DELETE SET NULL,
|
||||
CONSTRAINT master_grocery_items_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.master_grocery_items IS 'The master dictionary of canonical grocery items. Each item has a unique name and is linked to a category.';
|
||||
CREATE INDEX IF NOT EXISTS idx_master_grocery_items_category_id ON public.master_grocery_items(category_id);
|
||||
@@ -188,7 +213,9 @@ CREATE TABLE IF NOT EXISTS public.brands (
|
||||
logo_url TEXT,
|
||||
store_id BIGINT REFERENCES public.stores(store_id) ON DELETE SET NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT brands_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT brands_logo_url_check CHECK (logo_url IS NULL OR logo_url ~* '^https://?.*')
|
||||
);
|
||||
COMMENT ON TABLE public.brands IS 'Stores brand names like "Coca-Cola", "Maple Leaf", or "Kraft".';
|
||||
COMMENT ON COLUMN public.brands.store_id IS 'If this is a store-specific brand (e.g., President''s Choice), this links to the parent store.';
|
||||
@@ -203,7 +230,9 @@ CREATE TABLE IF NOT EXISTS public.products (
|
||||
size TEXT,
|
||||
upc_code TEXT UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT products_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT products_upc_code_check CHECK (upc_code IS NULL OR upc_code ~ '^[0-9]{8,14}$')
|
||||
);
|
||||
COMMENT ON TABLE public.products IS 'Represents a specific, sellable product, combining a generic item with a brand and size.';
|
||||
COMMENT ON COLUMN public.products.upc_code IS 'Universal Product Code, if available, for exact product matching.';
|
||||
@@ -219,18 +248,22 @@ CREATE TABLE IF NOT EXISTS public.flyer_items (
|
||||
flyer_id BIGINT REFERENCES public.flyers(flyer_id) ON DELETE CASCADE,
|
||||
item TEXT NOT NULL,
|
||||
price_display TEXT NOT NULL,
|
||||
price_in_cents INTEGER,
|
||||
price_in_cents INTEGER CHECK (price_in_cents IS NULL OR price_in_cents >= 0),
|
||||
quantity_num NUMERIC,
|
||||
quantity TEXT NOT NULL,
|
||||
category_id BIGINT REFERENCES public.categories(category_id) ON DELETE SET NULL,
|
||||
category_name TEXT,
|
||||
unit_price JSONB,
|
||||
view_count INTEGER DEFAULT 0 NOT NULL,
|
||||
click_count INTEGER DEFAULT 0 NOT NULL,
|
||||
view_count INTEGER DEFAULT 0 NOT NULL CHECK (view_count >= 0),
|
||||
click_count INTEGER DEFAULT 0 NOT NULL CHECK (click_count >= 0),
|
||||
master_item_id BIGINT REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE SET NULL,
|
||||
product_id BIGINT REFERENCES public.products(product_id) ON DELETE SET NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT flyer_items_item_check CHECK (TRIM(item) <> ''),
|
||||
CONSTRAINT flyer_items_price_display_check CHECK (TRIM(price_display) <> ''),
|
||||
CONSTRAINT flyer_items_quantity_check CHECK (TRIM(quantity) <> ''),
|
||||
CONSTRAINT flyer_items_category_name_check CHECK (category_name IS NULL OR TRIM(category_name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.flyer_items IS 'Stores individual items extracted from a specific flyer.';
|
||||
COMMENT ON COLUMN public.flyer_items.flyer_id IS 'Foreign key linking this item to its parent flyer in the `flyers` table.';
|
||||
@@ -249,6 +282,8 @@ CREATE INDEX IF NOT EXISTS idx_flyer_items_master_item_id ON public.flyer_items(
|
||||
CREATE INDEX IF NOT EXISTS idx_flyer_items_category_id ON public.flyer_items(category_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_flyer_items_product_id ON public.flyer_items(product_id);
|
||||
-- Add a GIN index to the 'item' column for fast fuzzy text searching.
|
||||
-- This partial index is optimized for queries that find the best price for an item.
|
||||
CREATE INDEX IF NOT EXISTS idx_flyer_items_master_item_price ON public.flyer_items (master_item_id, price_in_cents ASC) WHERE price_in_cents IS NOT NULL;
|
||||
-- This requires the pg_trgm extension.
|
||||
CREATE INDEX IF NOT EXISTS flyer_items_item_trgm_idx ON public.flyer_items USING GIN (item gin_trgm_ops);
|
||||
|
||||
@@ -257,7 +292,7 @@ CREATE TABLE IF NOT EXISTS public.user_alerts (
|
||||
user_alert_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
user_watched_item_id BIGINT NOT NULL REFERENCES public.user_watched_items(user_watched_item_id) ON DELETE CASCADE,
|
||||
alert_type TEXT NOT NULL CHECK (alert_type IN ('PRICE_BELOW', 'PERCENT_OFF_AVERAGE')),
|
||||
threshold_value NUMERIC NOT NULL,
|
||||
threshold_value NUMERIC NOT NULL CHECK (threshold_value > 0),
|
||||
is_active BOOLEAN DEFAULT true NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
@@ -275,7 +310,8 @@ CREATE TABLE IF NOT EXISTS public.notifications (
|
||||
link_url TEXT,
|
||||
is_read BOOLEAN DEFAULT false NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT notifications_content_check CHECK (TRIM(content) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.notifications IS 'A central log of notifications generated for users, such as price alerts.';
|
||||
COMMENT ON COLUMN public.notifications.content IS 'The notification message displayed to the user.';
|
||||
@@ -301,13 +337,14 @@ CREATE TABLE IF NOT EXISTS public.item_price_history (
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
summary_date DATE NOT NULL,
|
||||
store_location_id BIGINT REFERENCES public.store_locations(store_location_id) ON DELETE CASCADE,
|
||||
min_price_in_cents INTEGER,
|
||||
max_price_in_cents INTEGER,
|
||||
avg_price_in_cents INTEGER,
|
||||
data_points_count INTEGER DEFAULT 0 NOT NULL,
|
||||
min_price_in_cents INTEGER CHECK (min_price_in_cents IS NULL OR min_price_in_cents >= 0),
|
||||
max_price_in_cents INTEGER CHECK (max_price_in_cents IS NULL OR max_price_in_cents >= 0),
|
||||
avg_price_in_cents INTEGER CHECK (avg_price_in_cents IS NULL OR avg_price_in_cents >= 0),
|
||||
data_points_count INTEGER DEFAULT 0 NOT NULL CHECK (data_points_count >= 0),
|
||||
UNIQUE(master_item_id, summary_date, store_location_id),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT item_price_history_price_order_check CHECK (min_price_in_cents <= max_price_in_cents)
|
||||
);
|
||||
COMMENT ON TABLE public.item_price_history IS 'Serves as a summary table to speed up charting and analytics.';
|
||||
COMMENT ON COLUMN public.item_price_history.summary_date IS 'The date for which the price data is summarized.';
|
||||
@@ -324,7 +361,8 @@ CREATE TABLE IF NOT EXISTS public.master_item_aliases (
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
alias TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT master_item_aliases_alias_check CHECK (TRIM(alias) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.master_item_aliases IS 'Stores synonyms or alternative names for master items to improve matching.';
|
||||
COMMENT ON COLUMN public.master_item_aliases.alias IS 'An alternative name, e.g., "Ground Chuck" for the master item "Ground Beef".';
|
||||
@@ -336,7 +374,8 @@ CREATE TABLE IF NOT EXISTS public.shopping_lists (
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
name TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT shopping_lists_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.shopping_lists IS 'Stores user-created shopping lists, e.g., "Weekly Groceries".';
|
||||
CREATE INDEX IF NOT EXISTS idx_shopping_lists_user_id ON public.shopping_lists(user_id);
|
||||
@@ -347,12 +386,13 @@ CREATE TABLE IF NOT EXISTS public.shopping_list_items (
|
||||
shopping_list_id BIGINT NOT NULL REFERENCES public.shopping_lists(shopping_list_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
custom_item_name TEXT,
|
||||
quantity NUMERIC DEFAULT 1 NOT NULL,
|
||||
quantity NUMERIC DEFAULT 1 NOT NULL CHECK (quantity > 0),
|
||||
is_purchased BOOLEAN DEFAULT false NOT NULL,
|
||||
notes TEXT,
|
||||
added_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT must_have_item_identifier CHECK (master_item_id IS NOT NULL OR custom_item_name IS NOT NULL)
|
||||
CONSTRAINT must_have_item_identifier CHECK (master_item_id IS NOT NULL OR custom_item_name IS NOT NULL),
|
||||
CONSTRAINT shopping_list_items_custom_item_name_check CHECK (custom_item_name IS NULL OR TRIM(custom_item_name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.shopping_list_items IS 'Contains individual items for a specific shopping list.';
|
||||
COMMENT ON COLUMN public.shopping_list_items.custom_item_name IS 'For items not in the master list, e.g., "Grandma''s special spice mix".';
|
||||
@@ -384,7 +424,8 @@ CREATE TABLE IF NOT EXISTS public.menu_plans (
|
||||
start_date DATE NOT NULL,
|
||||
end_date DATE NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT menu_plans_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT date_range_check CHECK (end_date >= start_date)
|
||||
);
|
||||
COMMENT ON TABLE public.menu_plans IS 'Represents a user''s meal plan for a specific period, e.g., "Week of Oct 23".';
|
||||
@@ -413,11 +454,13 @@ CREATE TABLE IF NOT EXISTS public.suggested_corrections (
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
correction_type TEXT NOT NULL,
|
||||
suggested_value TEXT NOT NULL,
|
||||
status TEXT DEFAULT 'pending' NOT NULL,
|
||||
status TEXT DEFAULT 'pending' NOT NULL CHECK (status IN ('pending', 'approved', 'rejected')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
reviewed_notes TEXT,
|
||||
reviewed_at TIMESTAMPTZ,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT suggested_corrections_correction_type_check CHECK (TRIM(correction_type) <> ''),
|
||||
CONSTRAINT suggested_corrections_suggested_value_check CHECK (TRIM(suggested_value) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.suggested_corrections IS 'A queue for user-submitted data corrections, enabling crowdsourced data quality improvements.';
|
||||
COMMENT ON COLUMN public.suggested_corrections.correction_type IS 'The type of error the user is reporting.';
|
||||
@@ -433,12 +476,13 @@ CREATE TABLE IF NOT EXISTS public.user_submitted_prices (
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
store_id BIGINT NOT NULL REFERENCES public.stores(store_id) ON DELETE CASCADE,
|
||||
price_in_cents INTEGER NOT NULL,
|
||||
price_in_cents INTEGER NOT NULL CHECK (price_in_cents > 0),
|
||||
photo_url TEXT,
|
||||
upvotes INTEGER DEFAULT 0 NOT NULL,
|
||||
downvotes INTEGER DEFAULT 0 NOT NULL,
|
||||
upvotes INTEGER DEFAULT 0 NOT NULL CHECK (upvotes >= 0),
|
||||
downvotes INTEGER DEFAULT 0 NOT NULL CHECK (downvotes >= 0),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT user_submitted_prices_photo_url_check CHECK (photo_url IS NULL OR photo_url ~* '^https://?.*')
|
||||
);
|
||||
COMMENT ON TABLE public.user_submitted_prices IS 'Stores item prices submitted by users directly from physical stores.';
|
||||
COMMENT ON COLUMN public.user_submitted_prices.photo_url IS 'URL to user-submitted photo evidence of the price.';
|
||||
@@ -449,7 +493,8 @@ CREATE INDEX IF NOT EXISTS idx_user_submitted_prices_master_item_id ON public.us
|
||||
-- 22. Log flyer items that could not be automatically matched to a master item.
|
||||
CREATE TABLE IF NOT EXISTS public.unmatched_flyer_items (
|
||||
unmatched_flyer_item_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
flyer_item_id BIGINT NOT NULL REFERENCES public.flyer_items(flyer_item_id) ON DELETE CASCADE, status TEXT DEFAULT 'pending' NOT NULL CHECK (status IN ('pending', 'resolved', 'ignored')),
|
||||
flyer_item_id BIGINT NOT NULL REFERENCES public.flyer_items(flyer_item_id) ON DELETE CASCADE,
|
||||
status TEXT DEFAULT 'pending' NOT NULL CHECK (status IN ('pending', 'resolved', 'ignored')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
reviewed_at TIMESTAMPTZ,
|
||||
UNIQUE(flyer_item_id),
|
||||
@@ -479,20 +524,22 @@ CREATE TABLE IF NOT EXISTS public.recipes (
|
||||
name TEXT NOT NULL,
|
||||
description TEXT,
|
||||
instructions TEXT,
|
||||
prep_time_minutes INTEGER,
|
||||
cook_time_minutes INTEGER,
|
||||
servings INTEGER,
|
||||
prep_time_minutes INTEGER CHECK (prep_time_minutes IS NULL OR prep_time_minutes >= 0),
|
||||
cook_time_minutes INTEGER CHECK (cook_time_minutes IS NULL OR cook_time_minutes >= 0),
|
||||
servings INTEGER CHECK (servings IS NULL OR servings > 0),
|
||||
photo_url TEXT,
|
||||
calories_per_serving INTEGER,
|
||||
protein_grams NUMERIC,
|
||||
fat_grams NUMERIC,
|
||||
carb_grams NUMERIC,
|
||||
avg_rating NUMERIC(2,1) DEFAULT 0.0 NOT NULL,
|
||||
avg_rating NUMERIC(2,1) DEFAULT 0.0 NOT NULL CHECK (avg_rating >= 0.0 AND avg_rating <= 5.0),
|
||||
status TEXT DEFAULT 'private' NOT NULL CHECK (status IN ('private', 'pending_review', 'public', 'rejected')),
|
||||
rating_count INTEGER DEFAULT 0 NOT NULL,
|
||||
fork_count INTEGER DEFAULT 0 NOT NULL,
|
||||
rating_count INTEGER DEFAULT 0 NOT NULL CHECK (rating_count >= 0),
|
||||
fork_count INTEGER DEFAULT 0 NOT NULL CHECK (fork_count >= 0),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT recipes_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT recipes_photo_url_check CHECK (photo_url IS NULL OR photo_url ~* '^https://?.*')
|
||||
);
|
||||
COMMENT ON TABLE public.recipes IS 'Stores recipes that can be used to generate shopping lists.';
|
||||
COMMENT ON COLUMN public.recipes.servings IS 'The number of servings this recipe yields.';
|
||||
@@ -507,6 +554,8 @@ CREATE INDEX IF NOT EXISTS idx_recipes_user_id ON public.recipes(user_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_recipes_original_recipe_id ON public.recipes(original_recipe_id);
|
||||
-- Add a partial unique index to ensure system-wide recipes (user_id IS NULL) have unique names.
|
||||
-- This allows different users to have recipes with the same name.
|
||||
-- This index helps speed up sorting for recipe recommendations.
|
||||
CREATE INDEX IF NOT EXISTS idx_recipes_rating_sort ON public.recipes (avg_rating DESC, rating_count DESC);
|
||||
CREATE UNIQUE INDEX IF NOT EXISTS idx_recipes_unique_system_recipe_name ON public.recipes(name) WHERE user_id IS NULL;
|
||||
|
||||
-- 27. For ingredients required for each recipe.
|
||||
@@ -514,10 +563,11 @@ CREATE TABLE IF NOT EXISTS public.recipe_ingredients (
|
||||
recipe_ingredient_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
recipe_id BIGINT NOT NULL REFERENCES public.recipes(recipe_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
quantity NUMERIC NOT NULL,
|
||||
quantity NUMERIC NOT NULL CHECK (quantity > 0),
|
||||
unit TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT recipe_ingredients_unit_check CHECK (TRIM(unit) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.recipe_ingredients IS 'Defines the ingredients and quantities needed for a recipe.';
|
||||
COMMENT ON COLUMN public.recipe_ingredients.unit IS 'e.g., "cups", "tbsp", "g", "each".';
|
||||
@@ -544,7 +594,8 @@ CREATE TABLE IF NOT EXISTS public.tags (
|
||||
tag_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT tags_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.tags IS 'Stores tags for categorizing recipes, e.g., "Vegetarian", "Quick & Easy".';
|
||||
|
||||
@@ -566,7 +617,8 @@ CREATE TABLE IF NOT EXISTS public.appliances (
|
||||
appliance_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT appliances_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.appliances IS 'A predefined list of kitchen appliances (e.g., Air Fryer, Instant Pot).';
|
||||
|
||||
@@ -606,7 +658,8 @@ CREATE TABLE IF NOT EXISTS public.recipe_comments (
|
||||
content TEXT NOT NULL,
|
||||
status TEXT DEFAULT 'visible' NOT NULL CHECK (status IN ('visible', 'hidden', 'reported')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT recipe_comments_content_check CHECK (TRIM(content) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.recipe_comments IS 'Allows for threaded discussions and comments on recipes.';
|
||||
COMMENT ON COLUMN public.recipe_comments.parent_comment_id IS 'For threaded comments.';
|
||||
@@ -620,7 +673,8 @@ CREATE TABLE IF NOT EXISTS public.pantry_locations (
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
name TEXT NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT pantry_locations_name_check CHECK (TRIM(name) <> ''),
|
||||
UNIQUE(user_id, name)
|
||||
);
|
||||
COMMENT ON TABLE public.pantry_locations IS 'User-defined locations for organizing pantry items (e.g., "Fridge", "Freezer", "Spice Rack").';
|
||||
@@ -634,7 +688,8 @@ CREATE TABLE IF NOT EXISTS public.planned_meals (
|
||||
plan_date DATE NOT NULL,
|
||||
meal_type TEXT NOT NULL,
|
||||
servings_to_cook INTEGER,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT planned_meals_meal_type_check CHECK (TRIM(meal_type) <> ''),
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
);
|
||||
COMMENT ON TABLE public.planned_meals IS 'Assigns a recipe to a specific day and meal type within a user''s menu plan.';
|
||||
@@ -647,7 +702,7 @@ CREATE TABLE IF NOT EXISTS public.pantry_items (
|
||||
pantry_item_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
quantity NUMERIC NOT NULL,
|
||||
quantity NUMERIC NOT NULL CHECK (quantity >= 0),
|
||||
unit TEXT,
|
||||
best_before_date DATE,
|
||||
pantry_location_id BIGINT REFERENCES public.pantry_locations(pantry_location_id) ON DELETE SET NULL,
|
||||
@@ -670,7 +725,8 @@ CREATE TABLE IF NOT EXISTS public.password_reset_tokens (
|
||||
token_hash TEXT NOT NULL UNIQUE,
|
||||
expires_at TIMESTAMPTZ NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT password_reset_tokens_token_hash_check CHECK (TRIM(token_hash) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.password_reset_tokens IS 'Stores secure, single-use tokens for password reset requests.';
|
||||
COMMENT ON COLUMN public.password_reset_tokens.token_hash IS 'A bcrypt hash of the reset token sent to the user.';
|
||||
@@ -685,10 +741,13 @@ CREATE TABLE IF NOT EXISTS public.unit_conversions (
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
from_unit TEXT NOT NULL,
|
||||
to_unit TEXT NOT NULL,
|
||||
factor NUMERIC NOT NULL,
|
||||
UNIQUE(master_item_id, from_unit, to_unit),
|
||||
factor NUMERIC NOT NULL CHECK (factor > 0),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
UNIQUE(master_item_id, from_unit, to_unit),
|
||||
CONSTRAINT unit_conversions_from_unit_check CHECK (TRIM(from_unit) <> ''),
|
||||
CONSTRAINT unit_conversions_to_unit_check CHECK (TRIM(to_unit) <> ''),
|
||||
CONSTRAINT unit_conversions_units_check CHECK (from_unit <> to_unit)
|
||||
);
|
||||
COMMENT ON TABLE public.unit_conversions IS 'Stores item-specific unit conversion factors (e.g., grams of flour to cups).';
|
||||
COMMENT ON COLUMN public.unit_conversions.factor IS 'The multiplication factor to convert from_unit to to_unit.';
|
||||
@@ -700,9 +759,10 @@ CREATE TABLE IF NOT EXISTS public.user_item_aliases (
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT NOT NULL REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE CASCADE,
|
||||
alias TEXT NOT NULL,
|
||||
UNIQUE(user_id, alias),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
UNIQUE(user_id, alias),
|
||||
CONSTRAINT user_item_aliases_alias_check CHECK (TRIM(alias) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.user_item_aliases IS 'Allows users to create personal aliases for grocery items (e.g., "Dad''s Cereal").';
|
||||
CREATE INDEX IF NOT EXISTS idx_user_item_aliases_user_id ON public.user_item_aliases(user_id);
|
||||
@@ -739,7 +799,8 @@ CREATE TABLE IF NOT EXISTS public.recipe_collections (
|
||||
name TEXT NOT NULL,
|
||||
description TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT recipe_collections_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.recipe_collections IS 'Allows users to create personal collections of recipes (e.g., "Holiday Baking").';
|
||||
CREATE INDEX IF NOT EXISTS idx_recipe_collections_user_id ON public.recipe_collections(user_id);
|
||||
@@ -764,8 +825,11 @@ CREATE TABLE IF NOT EXISTS public.shared_recipe_collections (
|
||||
shared_with_user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
permission_level TEXT NOT NULL CHECK (permission_level IN ('view', 'edit')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
UNIQUE(recipe_collection_id, shared_with_user_id)
|
||||
);
|
||||
-- This index is crucial for efficiently finding all collections shared with a specific user.
|
||||
CREATE INDEX IF NOT EXISTS idx_shared_recipe_collections_shared_with ON public.shared_recipe_collections(shared_with_user_id);
|
||||
|
||||
-- 45. Log user search queries for analysis.
|
||||
CREATE TABLE IF NOT EXISTS public.search_queries (
|
||||
@@ -775,7 +839,8 @@ CREATE TABLE IF NOT EXISTS public.search_queries (
|
||||
result_count INTEGER,
|
||||
was_successful BOOLEAN,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT search_queries_query_text_check CHECK (TRIM(query_text) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.search_queries IS 'Logs user search queries to analyze search effectiveness and identify gaps in data.';
|
||||
COMMENT ON COLUMN public.search_queries.was_successful IS 'Indicates if the user interacted with a search result.';
|
||||
@@ -801,10 +866,11 @@ CREATE TABLE IF NOT EXISTS public.shopping_trip_items (
|
||||
shopping_trip_id BIGINT NOT NULL REFERENCES public.shopping_trips(shopping_trip_id) ON DELETE CASCADE,
|
||||
master_item_id BIGINT REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE SET NULL,
|
||||
custom_item_name TEXT,
|
||||
quantity NUMERIC NOT NULL,
|
||||
quantity NUMERIC NOT NULL CHECK (quantity > 0),
|
||||
price_paid_cents INTEGER,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT shopping_trip_items_custom_item_name_check CHECK (custom_item_name IS NULL OR TRIM(custom_item_name) <> ''),
|
||||
CONSTRAINT trip_must_have_item_identifier CHECK (master_item_id IS NOT NULL OR custom_item_name IS NOT NULL)
|
||||
);
|
||||
COMMENT ON TABLE public.shopping_trip_items IS 'A historical log of items purchased during a shopping trip.';
|
||||
@@ -818,7 +884,8 @@ CREATE TABLE IF NOT EXISTS public.dietary_restrictions (
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
type TEXT NOT NULL CHECK (type IN ('diet', 'allergy')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT dietary_restrictions_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.dietary_restrictions IS 'A predefined list of common diets (e.g., Vegan) and allergies (e.g., Nut Allergy).';
|
||||
|
||||
@@ -868,11 +935,12 @@ CREATE TABLE IF NOT EXISTS public.receipts (
|
||||
store_id BIGINT REFERENCES public.stores(store_id) ON DELETE CASCADE,
|
||||
receipt_image_url TEXT NOT NULL,
|
||||
transaction_date TIMESTAMPTZ,
|
||||
total_amount_cents INTEGER,
|
||||
total_amount_cents INTEGER CHECK (total_amount_cents IS NULL OR total_amount_cents >= 0),
|
||||
status TEXT DEFAULT 'pending' NOT NULL CHECK (status IN ('pending', 'processing', 'completed', 'failed')),
|
||||
raw_text TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
processed_at TIMESTAMPTZ,
|
||||
processed_at TIMESTAMPTZ,
|
||||
CONSTRAINT receipts_receipt_image_url_check CHECK (receipt_image_url ~* '^https://?.*'),
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
);
|
||||
COMMENT ON TABLE public.receipts IS 'Stores uploaded user receipts for purchase tracking and analysis.';
|
||||
@@ -884,13 +952,14 @@ CREATE TABLE IF NOT EXISTS public.receipt_items (
|
||||
receipt_item_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
receipt_id BIGINT NOT NULL REFERENCES public.receipts(receipt_id) ON DELETE CASCADE,
|
||||
raw_item_description TEXT NOT NULL,
|
||||
quantity NUMERIC DEFAULT 1 NOT NULL,
|
||||
price_paid_cents INTEGER NOT NULL,
|
||||
quantity NUMERIC DEFAULT 1 NOT NULL CHECK (quantity > 0),
|
||||
price_paid_cents INTEGER NOT NULL CHECK (price_paid_cents >= 0),
|
||||
master_item_id BIGINT REFERENCES public.master_grocery_items(master_grocery_item_id) ON DELETE SET NULL,
|
||||
product_id BIGINT REFERENCES public.products(product_id) ON DELETE SET NULL,
|
||||
status TEXT DEFAULT 'unmatched' NOT NULL CHECK (status IN ('unmatched', 'matched', 'needs_review', 'ignored')),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT receipt_items_raw_item_description_check CHECK (TRIM(raw_item_description) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.receipt_items IS 'Stores individual line items extracted from a user receipt.';
|
||||
CREATE INDEX IF NOT EXISTS idx_receipt_items_receipt_id ON public.receipt_items(receipt_id);
|
||||
@@ -929,11 +998,12 @@ CREATE TABLE IF NOT EXISTS public.budgets (
|
||||
budget_id BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
|
||||
user_id UUID NOT NULL REFERENCES public.users(user_id) ON DELETE CASCADE,
|
||||
name TEXT NOT NULL,
|
||||
amount_cents INTEGER NOT NULL,
|
||||
amount_cents INTEGER NOT NULL CHECK (amount_cents > 0),
|
||||
period TEXT NOT NULL CHECK (period IN ('weekly', 'monthly')),
|
||||
start_date DATE NOT NULL,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
updated_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT budgets_name_check CHECK (TRIM(name) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.budgets IS 'Allows users to set weekly or monthly grocery budgets for spending tracking.';
|
||||
CREATE INDEX IF NOT EXISTS idx_budgets_user_id ON public.budgets(user_id);
|
||||
@@ -944,8 +1014,10 @@ CREATE TABLE IF NOT EXISTS public.achievements (
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
description TEXT NOT NULL,
|
||||
icon TEXT,
|
||||
points_value INTEGER NOT NULL DEFAULT 0,
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL
|
||||
points_value INTEGER NOT NULL DEFAULT 0 CHECK (points_value >= 0),
|
||||
created_at TIMESTAMPTZ DEFAULT now() NOT NULL,
|
||||
CONSTRAINT achievements_name_check CHECK (TRIM(name) <> ''),
|
||||
CONSTRAINT achievements_description_check CHECK (TRIM(description) <> '')
|
||||
);
|
||||
COMMENT ON TABLE public.achievements IS 'A static table defining the available achievements users can earn.';
|
||||
|
||||
@@ -2601,6 +2673,7 @@ CREATE TRIGGER on_new_recipe_collection_share
|
||||
CREATE OR REPLACE FUNCTION public.get_best_sale_prices_for_all_users()
|
||||
RETURNS TABLE(
|
||||
user_id uuid,
|
||||
|
||||
email text,
|
||||
full_name text,
|
||||
master_item_id integer,
|
||||
@@ -2615,6 +2688,7 @@ BEGIN
|
||||
WITH
|
||||
-- Step 1: Find all flyer items that are currently on sale and have a valid price.
|
||||
current_sales AS (
|
||||
|
||||
SELECT
|
||||
fi.master_item_id,
|
||||
fi.price_in_cents,
|
||||
@@ -2623,14 +2697,18 @@ BEGIN
|
||||
f.valid_to
|
||||
FROM public.flyer_items fi
|
||||
JOIN public.flyers f ON fi.flyer_id = f.flyer_id
|
||||
JOIN public.stores s ON f.store_id = s.store_id
|
||||
WHERE
|
||||
|
||||
fi.master_item_id IS NOT NULL
|
||||
AND fi.price_in_cents IS NOT NULL
|
||||
AND f.valid_to >= CURRENT_DATE
|
||||
),
|
||||
-- Step 2: For each master item, find its absolute best (lowest) price across all current sales.
|
||||
-- We use a window function to rank the sales for each item by price.
|
||||
|
||||
best_prices AS (
|
||||
|
||||
SELECT
|
||||
cs.master_item_id,
|
||||
cs.price_in_cents AS best_price_in_cents,
|
||||
@@ -2643,6 +2721,7 @@ BEGIN
|
||||
)
|
||||
-- Step 3: Join the best-priced items with the user watchlist and user details.
|
||||
SELECT
|
||||
|
||||
u.user_id,
|
||||
u.email,
|
||||
p.full_name,
|
||||
@@ -2662,6 +2741,7 @@ BEGIN
|
||||
JOIN public.master_grocery_items mgi ON bp.master_item_id = mgi.master_grocery_item_id
|
||||
WHERE
|
||||
-- Only include the items that are at their absolute best price (rank = 1).
|
||||
|
||||
bp.price_rank = 1;
|
||||
END;
|
||||
$$ LANGUAGE plpgsql;
|
||||
|
||||
@@ -165,6 +165,38 @@ describe('Auth Routes (/api/auth)', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('should allow registration with an empty string for avatar_url', async () => {
|
||||
// Arrange
|
||||
const email = 'avatar-user@test.com';
|
||||
const mockNewUser = createMockUserProfile({
|
||||
user: { user_id: 'avatar-user-id', email },
|
||||
});
|
||||
mockedAuthService.registerAndLoginUser.mockResolvedValue({
|
||||
newUserProfile: mockNewUser,
|
||||
accessToken: 'avatar-access-token',
|
||||
refreshToken: 'avatar-refresh-token',
|
||||
});
|
||||
|
||||
// Act
|
||||
const response = await supertest(app).post('/api/auth/register').send({
|
||||
email,
|
||||
password: strongPassword,
|
||||
full_name: 'Avatar User',
|
||||
avatar_url: '', // Send an empty string
|
||||
});
|
||||
|
||||
// Assert
|
||||
expect(response.status).toBe(201);
|
||||
expect(response.body.message).toBe('User registered successfully!');
|
||||
expect(mockedAuthService.registerAndLoginUser).toHaveBeenCalledWith(
|
||||
email,
|
||||
strongPassword,
|
||||
'Avatar User',
|
||||
undefined, // The preprocess step in the Zod schema should convert '' to undefined
|
||||
mockLogger,
|
||||
);
|
||||
});
|
||||
|
||||
it('should set a refresh token cookie on successful registration', async () => {
|
||||
const mockNewUser = createMockUserProfile({
|
||||
user: { user_id: 'new-user-id', email: 'cookie@test.com' },
|
||||
|
||||
@@ -51,7 +51,11 @@ const registerSchema = z.object({
|
||||
}),
|
||||
// Sanitize optional string inputs.
|
||||
full_name: z.string().trim().optional(),
|
||||
avatar_url: z.string().trim().url().optional(),
|
||||
// Allow empty string or valid URL. If empty string is received, convert to undefined.
|
||||
avatar_url: z.preprocess(
|
||||
(val) => (val === '' ? undefined : val),
|
||||
z.string().trim().url().optional(),
|
||||
),
|
||||
}),
|
||||
});
|
||||
|
||||
|
||||
109
src/routes/reactions.routes.ts
Normal file
109
src/routes/reactions.routes.ts
Normal file
@@ -0,0 +1,109 @@
|
||||
import { Router, Request, Response, NextFunction } from 'express';
|
||||
import { z } from 'zod';
|
||||
import { reactionRepo } from '../services/db/index.db';
|
||||
import { validateRequest } from '../middleware/validation.middleware';
|
||||
import passport from './passport.routes';
|
||||
import { requiredString } from '../utils/zodUtils';
|
||||
import { UserProfile } from '../types';
|
||||
|
||||
const router = Router();
|
||||
|
||||
// --- Zod Schemas for Reaction Routes ---
|
||||
|
||||
const getReactionsSchema = z.object({
|
||||
query: z.object({
|
||||
userId: z.string().uuid().optional(),
|
||||
entityType: z.string().optional(),
|
||||
entityId: z.string().optional(),
|
||||
}),
|
||||
});
|
||||
|
||||
const toggleReactionSchema = z.object({
|
||||
body: z.object({
|
||||
entity_type: requiredString('entity_type is required.'),
|
||||
entity_id: requiredString('entity_id is required.'),
|
||||
reaction_type: requiredString('reaction_type is required.'),
|
||||
}),
|
||||
});
|
||||
|
||||
const getReactionSummarySchema = z.object({
|
||||
query: z.object({
|
||||
entityType: requiredString('entityType is required.'),
|
||||
entityId: requiredString('entityId is required.'),
|
||||
}),
|
||||
});
|
||||
|
||||
// --- Routes ---
|
||||
|
||||
/**
|
||||
* GET /api/reactions - Fetches user reactions based on query filters.
|
||||
* Supports filtering by userId, entityType, and entityId.
|
||||
* This is a public endpoint.
|
||||
*/
|
||||
router.get(
|
||||
'/',
|
||||
validateRequest(getReactionsSchema),
|
||||
async (req: Request, res: Response, next: NextFunction) => {
|
||||
try {
|
||||
const { query } = getReactionsSchema.parse({ query: req.query });
|
||||
const reactions = await reactionRepo.getReactions(query, req.log);
|
||||
res.json(reactions);
|
||||
} catch (error) {
|
||||
req.log.error({ error }, 'Error fetching user reactions');
|
||||
next(error);
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /api/reactions/summary - Fetches a summary of reactions for a specific entity.
|
||||
* Example: /api/reactions/summary?entityType=recipe&entityId=123
|
||||
* This is a public endpoint.
|
||||
*/
|
||||
router.get(
|
||||
'/summary',
|
||||
validateRequest(getReactionSummarySchema),
|
||||
async (req: Request, res: Response, next: NextFunction) => {
|
||||
try {
|
||||
const { query } = getReactionSummarySchema.parse({ query: req.query });
|
||||
const summary = await reactionRepo.getReactionSummary(query.entityType, query.entityId, req.log);
|
||||
res.json(summary);
|
||||
} catch (error) {
|
||||
req.log.error({ error }, 'Error fetching reaction summary');
|
||||
next(error);
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /api/reactions/toggle - Toggles a user's reaction to an entity.
|
||||
* This is a protected endpoint.
|
||||
*/
|
||||
router.post(
|
||||
'/toggle',
|
||||
passport.authenticate('jwt', { session: false }),
|
||||
validateRequest(toggleReactionSchema),
|
||||
async (req: Request, res: Response, next: NextFunction) => {
|
||||
const userProfile = req.user as UserProfile;
|
||||
type ToggleReactionRequest = z.infer<typeof toggleReactionSchema>;
|
||||
const { body } = req as unknown as ToggleReactionRequest;
|
||||
|
||||
try {
|
||||
const reactionData = {
|
||||
user_id: userProfile.user.user_id,
|
||||
...body,
|
||||
};
|
||||
const result = await reactionRepo.toggleReaction(reactionData, req.log);
|
||||
if (result) {
|
||||
res.status(201).json({ message: 'Reaction added.', reaction: result });
|
||||
} else {
|
||||
res.status(200).json({ message: 'Reaction removed.' });
|
||||
}
|
||||
} catch (error) {
|
||||
req.log.error({ error, body }, 'Error toggling user reaction');
|
||||
next(error);
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
export default router;
|
||||
@@ -585,6 +585,27 @@ describe('User Routes (/api/users)', () => {
|
||||
expect(response.body).toEqual(updatedProfile);
|
||||
});
|
||||
|
||||
it('should allow updating the profile with an empty string for avatar_url', async () => {
|
||||
// Arrange
|
||||
const profileUpdates = { avatar_url: '' };
|
||||
// The service should receive `undefined` after Zod preprocessing
|
||||
const updatedProfile = createMockUserProfile({ ...mockUserProfile, avatar_url: undefined });
|
||||
vi.mocked(db.userRepo.updateUserProfile).mockResolvedValue(updatedProfile);
|
||||
|
||||
// Act
|
||||
const response = await supertest(app).put('/api/users/profile').send(profileUpdates);
|
||||
|
||||
// Assert
|
||||
expect(response.status).toBe(200);
|
||||
expect(response.body).toEqual(updatedProfile);
|
||||
// Verify that the Zod schema preprocessed the empty string to undefined
|
||||
expect(db.userRepo.updateUserProfile).toHaveBeenCalledWith(
|
||||
mockUserProfile.user.user_id,
|
||||
{ avatar_url: undefined },
|
||||
expectLogger,
|
||||
);
|
||||
});
|
||||
|
||||
it('should return 500 on a generic database error', async () => {
|
||||
const dbError = new Error('DB Connection Failed');
|
||||
vi.mocked(db.userRepo.updateUserProfile).mockRejectedValue(dbError);
|
||||
|
||||
@@ -26,7 +26,13 @@ const router = express.Router();
|
||||
|
||||
const updateProfileSchema = z.object({
|
||||
body: z
|
||||
.object({ full_name: z.string().optional(), avatar_url: z.string().url().optional() })
|
||||
.object({
|
||||
full_name: z.string().optional(),
|
||||
avatar_url: z.preprocess(
|
||||
(val) => (val === '' ? undefined : val),
|
||||
z.string().trim().url().optional(),
|
||||
),
|
||||
})
|
||||
.refine((data) => Object.keys(data).length > 0, {
|
||||
message: 'At least one field to update must be provided.',
|
||||
}),
|
||||
|
||||
@@ -6,12 +6,13 @@ import type { FlyerStatus, MasterGroceryItem, UserProfile } from '../types';
|
||||
// Import the class, not the singleton instance, so we can instantiate it with mocks.
|
||||
import {
|
||||
AIService,
|
||||
AiFlyerDataSchema,
|
||||
aiService as aiServiceSingleton,
|
||||
DuplicateFlyerError,
|
||||
type RawFlyerItem,
|
||||
} from './aiService.server';
|
||||
import { createMockMasterGroceryItem } from '../tests/utils/mockFactories';
|
||||
import { ValidationError } from './db/errors.db';
|
||||
import { AiFlyerDataSchema } from '../types/ai';
|
||||
|
||||
// Mock the logger to prevent the real pino instance from being created, which causes issues with 'pino-pretty' in tests.
|
||||
vi.mock('./logger.server', () => ({
|
||||
@@ -128,14 +129,7 @@ describe('AI Service (Server)', () => {
|
||||
const resultEmpty = AiFlyerDataSchema.safeParse(dataWithEmpty);
|
||||
|
||||
expect(resultNull.success).toBe(false);
|
||||
if (!resultNull.success) {
|
||||
expect(resultNull.error.issues[0].message).toBe('Store name cannot be empty');
|
||||
}
|
||||
|
||||
expect(resultEmpty.success).toBe(false);
|
||||
if (!resultEmpty.success) {
|
||||
expect(resultEmpty.error.issues[0].message).toBe('Store name cannot be empty');
|
||||
}
|
||||
// Null checks fail with a generic type error, which is acceptable.
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1058,4 +1052,56 @@ describe('AI Service (Server)', () => {
|
||||
expect(aiServiceSingleton).toBeInstanceOf(AIService);
|
||||
});
|
||||
});
|
||||
|
||||
describe('_normalizeExtractedItems (private method)', () => {
|
||||
it('should correctly normalize items with null or undefined price_in_cents', () => {
|
||||
const rawItems: RawFlyerItem[] = [
|
||||
{
|
||||
item: 'Valid Item',
|
||||
price_display: '$1.99',
|
||||
price_in_cents: 199,
|
||||
quantity: '1',
|
||||
category_name: 'Category A',
|
||||
master_item_id: 1,
|
||||
},
|
||||
{
|
||||
item: 'Item with Null Price',
|
||||
price_display: null,
|
||||
price_in_cents: null, // Test case for null
|
||||
quantity: '1',
|
||||
category_name: 'Category B',
|
||||
master_item_id: 2,
|
||||
},
|
||||
{
|
||||
item: 'Item with Undefined Price',
|
||||
price_display: '$2.99',
|
||||
price_in_cents: undefined, // Test case for undefined
|
||||
quantity: '1',
|
||||
category_name: 'Category C',
|
||||
master_item_id: 3,
|
||||
},
|
||||
{
|
||||
item: null, // Test null item name
|
||||
price_display: undefined, // Test undefined display price
|
||||
price_in_cents: 50,
|
||||
quantity: null, // Test null quantity
|
||||
category_name: undefined, // Test undefined category
|
||||
master_item_id: null, // Test null master_item_id
|
||||
},
|
||||
];
|
||||
|
||||
// Access the private method for testing
|
||||
const normalized = (aiServiceInstance as any)._normalizeExtractedItems(rawItems);
|
||||
|
||||
expect(normalized).toHaveLength(4);
|
||||
expect(normalized[0].price_in_cents).toBe(199);
|
||||
expect(normalized[1].price_in_cents).toBe(null); // null should remain null
|
||||
expect(normalized[2].price_in_cents).toBe(null); // undefined should become null
|
||||
expect(normalized[3].item).toBe('Unknown Item');
|
||||
expect(normalized[3].quantity).toBe('');
|
||||
expect(normalized[3].category_name).toBe('Other/Miscellaneous');
|
||||
expect(normalized[3].master_item_id).toBeUndefined(); // nullish coalescing to undefined
|
||||
});
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
* It is intended to be used only by the backend (e.g., server.ts) and should never be imported into client-side code.
|
||||
* The `.server.ts` naming convention helps enforce this separation.
|
||||
*/
|
||||
|
||||
import { GoogleGenAI, type GenerateContentResponse, type Content, type Tool } from '@google/genai';
|
||||
import fsPromises from 'node:fs/promises';
|
||||
import type { Logger } from 'pino';
|
||||
@@ -26,29 +25,11 @@ import type { Job } from 'bullmq';
|
||||
import { createFlyerAndItems } from './db/flyer.db';
|
||||
import { generateFlyerIcon } from '../utils/imageProcessor';
|
||||
import path from 'path';
|
||||
import { ValidationError } from './db/errors.db';
|
||||
|
||||
// Helper for consistent required string validation (handles missing/null/empty)
|
||||
const requiredString = (message: string) =>
|
||||
z.preprocess((val) => val ?? '', z.string().min(1, message));
|
||||
|
||||
// --- Zod Schemas for AI Response Validation (exported for the transformer) ---
|
||||
const ExtractedFlyerItemSchema = z.object({
|
||||
item: z.string(),
|
||||
price_display: z.string(),
|
||||
price_in_cents: z.number().nullable(),
|
||||
quantity: z.string(),
|
||||
category_name: z.string(),
|
||||
master_item_id: z.number().nullish(), // .nullish() allows null or undefined
|
||||
});
|
||||
|
||||
export const AiFlyerDataSchema = z.object({
|
||||
store_name: z.string().nullable(),
|
||||
valid_from: z.string().nullable(),
|
||||
valid_to: z.string().nullable(),
|
||||
store_address: z.string().nullable(),
|
||||
items: z.array(ExtractedFlyerItemSchema),
|
||||
});
|
||||
import { ValidationError } from './db/errors.db'; // Keep this import for ValidationError
|
||||
import {
|
||||
AiFlyerDataSchema,
|
||||
ExtractedFlyerItemSchema,
|
||||
} from '../types/ai'; // Import consolidated schemas
|
||||
|
||||
interface FlyerProcessPayload extends Partial<ExtractedCoreData> {
|
||||
checksum?: string;
|
||||
@@ -89,10 +70,10 @@ interface IAiClient {
|
||||
* This type is intentionally loose to accommodate potential null/undefined values
|
||||
* from the AI before they are cleaned and normalized.
|
||||
*/
|
||||
type RawFlyerItem = {
|
||||
item: string;
|
||||
export type RawFlyerItem = {
|
||||
item: string | null;
|
||||
price_display: string | null | undefined;
|
||||
price_in_cents: number | null;
|
||||
price_in_cents: number | null | undefined;
|
||||
quantity: string | null | undefined;
|
||||
category_name: string | null | undefined;
|
||||
master_item_id?: number | null | undefined;
|
||||
@@ -606,6 +587,8 @@ export class AIService {
|
||||
item.category_name === null || item.category_name === undefined
|
||||
? 'Other/Miscellaneous'
|
||||
: String(item.category_name),
|
||||
// Ensure undefined is converted to null to match the Zod schema.
|
||||
price_in_cents: item.price_in_cents ?? null,
|
||||
master_item_id: item.master_item_id ?? undefined,
|
||||
}));
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool } from './connection.db';
|
||||
import type { Logger } from 'pino';
|
||||
import { UniqueConstraintError, NotFoundError } from './errors.db';
|
||||
import { UniqueConstraintError, NotFoundError, handleDbError } from './errors.db';
|
||||
import { Address } from '../../types';
|
||||
|
||||
export class AddressRepository {
|
||||
@@ -30,11 +30,9 @@ export class AddressRepository {
|
||||
}
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error({ err: error, addressId }, 'Database error in getAddressById');
|
||||
throw new Error('Failed to retrieve address.');
|
||||
handleDbError(error, logger, 'Database error in getAddressById', { addressId }, {
|
||||
defaultMessage: 'Failed to retrieve address.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -78,10 +76,10 @@ export class AddressRepository {
|
||||
const res = await this.db.query<{ address_id: number }>(query, values);
|
||||
return res.rows[0].address_id;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, address }, 'Database error in upsertAddress');
|
||||
if (error instanceof Error && 'code' in error && error.code === '23505')
|
||||
throw new UniqueConstraintError('An identical address already exists.');
|
||||
throw new Error('Failed to upsert address.');
|
||||
handleDbError(error, logger, 'Database error in upsertAddress', { address }, {
|
||||
uniqueMessage: 'An identical address already exists.',
|
||||
defaultMessage: 'Failed to upsert address.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// src/services/db/admin.db.ts
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool, withTransaction } from './connection.db';
|
||||
import { ForeignKeyConstraintError, NotFoundError } from './errors.db';
|
||||
import { ForeignKeyConstraintError, NotFoundError, CheckConstraintError, handleDbError } from './errors.db';
|
||||
import type { Logger } from 'pino';
|
||||
import {
|
||||
SuggestedCorrection,
|
||||
@@ -54,8 +54,9 @@ export class AdminRepository {
|
||||
const res = await this.db.query<SuggestedCorrection>(query);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getSuggestedCorrections');
|
||||
throw new Error('Failed to retrieve suggested corrections.');
|
||||
handleDbError(error, logger, 'Database error in getSuggestedCorrections', {}, {
|
||||
defaultMessage: 'Failed to retrieve suggested corrections.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -73,8 +74,10 @@ export class AdminRepository {
|
||||
await this.db.query('SELECT public.approve_correction($1)', [correctionId]);
|
||||
logger.info(`Successfully approved and applied correction ID: ${correctionId}`);
|
||||
} catch (error) {
|
||||
logger.error({ err: error, correctionId }, 'Database transaction error in approveCorrection');
|
||||
throw new Error('Failed to approve correction.');
|
||||
handleDbError(error, logger, 'Database transaction error in approveCorrection', { correctionId }, {
|
||||
fkMessage: 'The suggested master item ID does not exist.',
|
||||
defaultMessage: 'Failed to approve correction.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -95,8 +98,9 @@ export class AdminRepository {
|
||||
logger.info(`Successfully rejected correction ID: ${correctionId}`);
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error({ err: error, correctionId }, 'Database error in rejectCorrection');
|
||||
throw new Error('Failed to reject correction.');
|
||||
handleDbError(error, logger, 'Database error in rejectCorrection', { correctionId }, {
|
||||
defaultMessage: 'Failed to reject correction.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -121,8 +125,9 @@ export class AdminRepository {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error({ err: error, correctionId }, 'Database error in updateSuggestedCorrection');
|
||||
throw new Error('Failed to update suggested correction.');
|
||||
handleDbError(error, logger, 'Database error in updateSuggestedCorrection', { correctionId }, {
|
||||
defaultMessage: 'Failed to update suggested correction.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -168,8 +173,9 @@ export class AdminRepository {
|
||||
recipeCount: parseInt(recipeCountRes.rows[0].count, 10),
|
||||
};
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getApplicationStats');
|
||||
throw error; // Re-throw the original error to be handled by the caller
|
||||
handleDbError(error, logger, 'Database error in getApplicationStats', {}, {
|
||||
defaultMessage: 'Failed to retrieve application statistics.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -212,8 +218,9 @@ export class AdminRepository {
|
||||
const res = await this.db.query(query);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getDailyStatsForLast30Days');
|
||||
throw new Error('Failed to retrieve daily statistics.');
|
||||
handleDbError(error, logger, 'Database error in getDailyStatsForLast30Days', {}, {
|
||||
defaultMessage: 'Failed to retrieve daily statistics.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -254,8 +261,9 @@ export class AdminRepository {
|
||||
const res = await this.db.query<MostFrequentSaleItem>(query, [days, limit]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getMostFrequentSaleItems');
|
||||
throw new Error('Failed to get most frequent sale items.');
|
||||
handleDbError(error, logger, 'Database error in getMostFrequentSaleItems', { days, limit }, {
|
||||
defaultMessage: 'Failed to get most frequent sale items.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -283,11 +291,10 @@ export class AdminRepository {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, commentId, status },
|
||||
'Database error in updateRecipeCommentStatus',
|
||||
);
|
||||
throw new Error('Failed to update recipe comment status.');
|
||||
handleDbError(error, logger, 'Database error in updateRecipeCommentStatus', { commentId, status }, {
|
||||
checkMessage: 'Invalid status provided for recipe comment.',
|
||||
defaultMessage: 'Failed to update recipe comment status.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -317,8 +324,9 @@ export class AdminRepository {
|
||||
const res = await this.db.query<UnmatchedFlyerItem>(query);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getUnmatchedFlyerItems');
|
||||
throw new Error('Failed to retrieve unmatched flyer items.');
|
||||
handleDbError(error, logger, 'Database error in getUnmatchedFlyerItems', {}, {
|
||||
defaultMessage: 'Failed to retrieve unmatched flyer items.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -344,8 +352,10 @@ export class AdminRepository {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error({ err: error, recipeId, status }, 'Database error in updateRecipeStatus');
|
||||
throw new Error('Failed to update recipe status.'); // Keep generic for other DB errors
|
||||
handleDbError(error, logger, 'Database error in updateRecipeStatus', { recipeId, status }, {
|
||||
checkMessage: 'Invalid status provided for recipe.',
|
||||
defaultMessage: 'Failed to update recipe status.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -397,11 +407,13 @@ export class AdminRepository {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, unmatchedFlyerItemId, masterItemId },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database transaction error in resolveUnmatchedFlyerItem',
|
||||
{ unmatchedFlyerItemId, masterItemId },
|
||||
{ fkMessage: 'The specified master item ID does not exist.', defaultMessage: 'Failed to resolve unmatched flyer item.' },
|
||||
);
|
||||
throw new Error('Failed to resolve unmatched flyer item.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -422,11 +434,13 @@ export class AdminRepository {
|
||||
}
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error(
|
||||
{ err: error, unmatchedFlyerItemId },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in ignoreUnmatchedFlyerItem',
|
||||
{ unmatchedFlyerItemId },
|
||||
{ defaultMessage: 'Failed to ignore unmatched flyer item.' },
|
||||
);
|
||||
throw new Error('Failed to ignore unmatched flyer item.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -442,8 +456,9 @@ export class AdminRepository {
|
||||
const res = await this.db.query<ActivityLogItem>('SELECT * FROM public.get_activity_log($1, $2)', [limit, offset]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, limit, offset }, 'Database error in getActivityLog');
|
||||
throw new Error('Failed to retrieve activity log.');
|
||||
handleDbError(error, logger, 'Database error in getActivityLog', { limit, offset }, {
|
||||
defaultMessage: 'Failed to retrieve activity log.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -544,8 +559,9 @@ export class AdminRepository {
|
||||
}
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error({ err: error, brandId }, 'Database error in updateBrandLogo');
|
||||
throw new Error('Failed to update brand logo in database.');
|
||||
handleDbError(error, logger, 'Database error in updateBrandLogo', { brandId }, {
|
||||
defaultMessage: 'Failed to update brand logo in database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -569,8 +585,10 @@ export class AdminRepository {
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error({ err: error, receiptId, status }, 'Database error in updateReceiptStatus');
|
||||
throw new Error('Failed to update receipt status.');
|
||||
handleDbError(error, logger, 'Database error in updateReceiptStatus', { receiptId, status }, {
|
||||
checkMessage: 'Invalid status provided for receipt.',
|
||||
defaultMessage: 'Failed to update receipt status.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -583,8 +601,9 @@ export class AdminRepository {
|
||||
const res = await this.db.query<AdminUserView>(query);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getAllUsers');
|
||||
throw new Error('Failed to retrieve all users.');
|
||||
handleDbError(error, logger, 'Database error in getAllUsers', {}, {
|
||||
defaultMessage: 'Failed to retrieve all users.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -605,14 +624,14 @@ export class AdminRepository {
|
||||
}
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId, role }, 'Database error in updateUserRole');
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified user does not exist.');
|
||||
}
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
throw error; // Re-throw to be handled by the route
|
||||
handleDbError(error, logger, 'Database error in updateUserRole', { userId, role }, {
|
||||
fkMessage: 'The specified user does not exist.',
|
||||
checkMessage: 'Invalid role provided for user.',
|
||||
defaultMessage: 'Failed to update user role.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -639,8 +658,9 @@ export class AdminRepository {
|
||||
const res = await this.db.query<Flyer>(query);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getFlyersForReview');
|
||||
throw new Error('Failed to retrieve flyers for review.');
|
||||
handleDbError(error, logger, 'Database error in getFlyersForReview', {}, {
|
||||
defaultMessage: 'Failed to retrieve flyers for review.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// src/services/db/budget.db.ts
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool, withTransaction } from './connection.db';
|
||||
import { ForeignKeyConstraintError, NotFoundError } from './errors.db';
|
||||
import { NotFoundError, handleDbError } from './errors.db';
|
||||
import type { Logger } from 'pino';
|
||||
import type { Budget, SpendingByCategory } from '../../types';
|
||||
import { GamificationRepository } from './gamification.db';
|
||||
@@ -28,8 +28,9 @@ export class BudgetRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getBudgetsForUser');
|
||||
throw new Error('Failed to retrieve budgets.');
|
||||
handleDbError(error, logger, 'Database error in getBudgetsForUser', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve budgets.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -59,14 +60,12 @@ export class BudgetRepository {
|
||||
return res.rows[0];
|
||||
});
|
||||
} catch (error) {
|
||||
// The patch requested this specific error handling.
|
||||
// Type-safe check for a PostgreSQL error code.
|
||||
// This ensures 'error' is an object with a 'code' property before we access it.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified user does not exist.');
|
||||
}
|
||||
logger.error({ err: error, budgetData, userId }, 'Database error in createBudget');
|
||||
throw new Error('Failed to create budget.');
|
||||
handleDbError(error, logger, 'Database error in createBudget', { budgetData, userId }, {
|
||||
fkMessage: 'The specified user does not exist.',
|
||||
notNullMessage: 'One or more required budget fields are missing.',
|
||||
checkMessage: 'Invalid value provided for budget period.',
|
||||
defaultMessage: 'Failed to create budget.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -99,8 +98,9 @@ export class BudgetRepository {
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error({ err: error, budgetId, userId }, 'Database error in updateBudget');
|
||||
throw new Error('Failed to update budget.');
|
||||
handleDbError(error, logger, 'Database error in updateBudget', { budgetId, userId }, {
|
||||
defaultMessage: 'Failed to update budget.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -120,8 +120,9 @@ export class BudgetRepository {
|
||||
}
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error({ err: error, budgetId, userId }, 'Database error in deleteBudget');
|
||||
throw new Error('Failed to delete budget.');
|
||||
handleDbError(error, logger, 'Database error in deleteBudget', { budgetId, userId }, {
|
||||
defaultMessage: 'Failed to delete budget.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -145,11 +146,13 @@ export class BudgetRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, userId, startDate, endDate },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in getSpendingByCategory',
|
||||
{ userId, startDate, endDate },
|
||||
{ defaultMessage: 'Failed to get spending analysis.' },
|
||||
);
|
||||
throw new Error('Failed to get spending analysis.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
// src/services/db/connection.db.ts
|
||||
import { Pool, PoolConfig, PoolClient, types } from 'pg';
|
||||
import { logger } from '../logger.server';
|
||||
import { handleDbError } from './errors.db';
|
||||
|
||||
// --- Singleton Pool Instance ---
|
||||
// This variable will hold the single, shared connection pool for the entire application.
|
||||
@@ -105,8 +106,9 @@ export async function checkTablesExist(tableNames: string[]): Promise<string[]>
|
||||
|
||||
return missingTables;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in checkTablesExist');
|
||||
throw new Error('Failed to check for tables in database.');
|
||||
handleDbError(error, logger, 'Database error in checkTablesExist', {}, {
|
||||
defaultMessage: 'Failed to check for tables in database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
78
src/services/db/conversion.db.ts
Normal file
78
src/services/db/conversion.db.ts
Normal file
@@ -0,0 +1,78 @@
|
||||
// src/services/db/conversion.db.ts
|
||||
import type { Logger } from 'pino';
|
||||
import { getPool } from './connection.db';
|
||||
import { handleDbError, NotFoundError } from './errors.db';
|
||||
import type { UnitConversion } from '../../types';
|
||||
|
||||
export const conversionRepo = {
|
||||
/**
|
||||
* Fetches unit conversions, optionally filtered by master_item_id.
|
||||
*/
|
||||
async getConversions(
|
||||
filters: { masterItemId?: number },
|
||||
logger: Logger,
|
||||
): Promise<UnitConversion[]> {
|
||||
const { masterItemId } = filters;
|
||||
try {
|
||||
let query = 'SELECT * FROM public.unit_conversions';
|
||||
const params: any[] = [];
|
||||
|
||||
if (masterItemId) {
|
||||
query += ' WHERE master_item_id = $1';
|
||||
params.push(masterItemId);
|
||||
}
|
||||
|
||||
query += ' ORDER BY master_item_id, from_unit, to_unit';
|
||||
|
||||
const result = await getPool().query<UnitConversion>(query, params);
|
||||
return result.rows;
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in getConversions', { filters }, {
|
||||
defaultMessage: 'Failed to retrieve unit conversions.',
|
||||
});
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Creates a new unit conversion rule.
|
||||
*/
|
||||
async createConversion(
|
||||
conversionData: Omit<UnitConversion, 'unit_conversion_id' | 'created_at' | 'updated_at'>,
|
||||
logger: Logger,
|
||||
): Promise<UnitConversion> {
|
||||
const { master_item_id, from_unit, to_unit, factor } = conversionData;
|
||||
try {
|
||||
const res = await getPool().query<UnitConversion>(
|
||||
'INSERT INTO public.unit_conversions (master_item_id, from_unit, to_unit, factor) VALUES ($1, $2, $3, $4) RETURNING *',
|
||||
[master_item_id, from_unit, to_unit, factor],
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in createConversion', { conversionData }, {
|
||||
fkMessage: 'The specified master item does not exist.',
|
||||
uniqueMessage: 'This conversion rule already exists for this item.',
|
||||
checkMessage: 'Invalid unit conversion data provided (e.g., factor must be > 0, units cannot be the same).',
|
||||
defaultMessage: 'Failed to create unit conversion.',
|
||||
});
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Deletes a unit conversion rule.
|
||||
*/
|
||||
async deleteConversion(conversionId: number, logger: Logger): Promise<void> {
|
||||
try {
|
||||
const res = await getPool().query(
|
||||
'DELETE FROM public.unit_conversions WHERE unit_conversion_id = $1',
|
||||
[conversionId],
|
||||
);
|
||||
if (res.rowCount === 0) {
|
||||
throw new NotFoundError(`Unit conversion with ID ${conversionId} not found.`);
|
||||
}
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in deleteConversion', { conversionId }, {
|
||||
defaultMessage: 'Failed to delete unit conversion.',
|
||||
});
|
||||
}
|
||||
},
|
||||
};
|
||||
@@ -4,6 +4,7 @@ import { WatchedItemDeal } from '../../types';
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import type { Logger } from 'pino';
|
||||
import { logger as globalLogger } from '../logger.server';
|
||||
import { handleDbError } from './errors.db';
|
||||
|
||||
export class DealsRepository {
|
||||
// The repository only needs an object with a `query` method, matching the Pool/PoolClient interface.
|
||||
@@ -69,8 +70,9 @@ export class DealsRepository {
|
||||
const { rows } = await this.db.query<WatchedItemDeal>(query, [userId]);
|
||||
return rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in findBestPricesForWatchedItems');
|
||||
throw error; // Re-throw the original error to be handled by the global error handler
|
||||
handleDbError(error, logger, 'Database error in findBestPricesForWatchedItems', { userId }, {
|
||||
defaultMessage: 'Failed to find best prices for watched items.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
// src/services/db/errors.db.ts
|
||||
import type { Logger } from 'pino';
|
||||
|
||||
/**
|
||||
* Base class for custom database errors to ensure they have a status property.
|
||||
@@ -35,6 +36,46 @@ export class ForeignKeyConstraintError extends DatabaseError {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when a 'not null' constraint is violated.
|
||||
* Corresponds to PostgreSQL error code '23502'.
|
||||
*/
|
||||
export class NotNullConstraintError extends DatabaseError {
|
||||
constructor(message = 'A required field was left null.') {
|
||||
super(message, 400); // 400 Bad Request
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when a 'check' constraint is violated.
|
||||
* Corresponds to PostgreSQL error code '23514'.
|
||||
*/
|
||||
export class CheckConstraintError extends DatabaseError {
|
||||
constructor(message = 'A check constraint was violated.') {
|
||||
super(message, 400); // 400 Bad Request
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when a value has an invalid text representation for its data type (e.g., 'abc' for an integer).
|
||||
* Corresponds to PostgreSQL error code '22P02'.
|
||||
*/
|
||||
export class InvalidTextRepresentationError extends DatabaseError {
|
||||
constructor(message = 'A value has an invalid format for its data type.') {
|
||||
super(message, 400); // 400 Bad Request
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when a numeric value is out of range for its data type (e.g., too large for an integer).
|
||||
* Corresponds to PostgreSQL error code '22003'.
|
||||
*/
|
||||
export class NumericValueOutOfRangeError extends DatabaseError {
|
||||
constructor(message = 'A numeric value is out of the allowed range.') {
|
||||
super(message, 400); // 400 Bad Request
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown when a specific record is not found in the database.
|
||||
*/
|
||||
@@ -73,3 +114,50 @@ export class FileUploadError extends Error {
|
||||
this.name = 'FileUploadError';
|
||||
}
|
||||
}
|
||||
|
||||
export interface HandleDbErrorOptions {
|
||||
entityName?: string;
|
||||
uniqueMessage?: string;
|
||||
fkMessage?: string;
|
||||
notNullMessage?: string;
|
||||
checkMessage?: string;
|
||||
invalidTextMessage?: string;
|
||||
numericOutOfRangeMessage?: string;
|
||||
defaultMessage?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Centralized error handler for database repositories.
|
||||
* Logs the error and throws appropriate custom errors based on PostgreSQL error codes.
|
||||
*/
|
||||
export function handleDbError(
|
||||
error: unknown,
|
||||
logger: Logger,
|
||||
logMessage: string,
|
||||
logContext: Record<string, unknown>,
|
||||
options: HandleDbErrorOptions = {},
|
||||
): never {
|
||||
// If it's already a known domain error (like NotFoundError thrown manually), rethrow it.
|
||||
if (error instanceof DatabaseError) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
// Log the raw error
|
||||
logger.error({ err: error, ...logContext }, logMessage);
|
||||
|
||||
if (error instanceof Error && 'code' in error) {
|
||||
const code = (error as any).code;
|
||||
|
||||
if (code === '23505') throw new UniqueConstraintError(options.uniqueMessage);
|
||||
if (code === '23503') throw new ForeignKeyConstraintError(options.fkMessage);
|
||||
if (code === '23502') throw new NotNullConstraintError(options.notNullMessage);
|
||||
if (code === '23514') throw new CheckConstraintError(options.checkMessage);
|
||||
if (code === '22P02') throw new InvalidTextRepresentationError(options.invalidTextMessage);
|
||||
if (code === '22003') throw new NumericValueOutOfRangeError(options.numericOutOfRangeMessage);
|
||||
}
|
||||
|
||||
// Fallback generic error
|
||||
throw new Error(
|
||||
options.defaultMessage || `Failed to perform operation on ${options.entityName || 'database'}.`,
|
||||
);
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool, withTransaction } from './connection.db';
|
||||
import type { Logger } from 'pino';
|
||||
import { UniqueConstraintError, ForeignKeyConstraintError, NotFoundError } from './errors.db';
|
||||
import { UniqueConstraintError, NotFoundError, handleDbError } from './errors.db';
|
||||
import type {
|
||||
Flyer,
|
||||
FlyerItem,
|
||||
@@ -103,12 +103,12 @@ export class FlyerRepository {
|
||||
const result = await this.db.query<Flyer>(query, values);
|
||||
return result.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error, flyerData }, 'Database error in insertFlyer');
|
||||
// Check for a unique constraint violation on the 'checksum' column.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23505') {
|
||||
throw new UniqueConstraintError('A flyer with this checksum already exists.');
|
||||
}
|
||||
throw new Error('Failed to insert flyer into database.');
|
||||
handleDbError(error, logger, 'Database error in insertFlyer', { flyerData }, {
|
||||
uniqueMessage: 'A flyer with this checksum already exists.',
|
||||
fkMessage: 'The specified user or store for this flyer does not exist.',
|
||||
checkMessage: 'Invalid status provided for flyer.',
|
||||
defaultMessage: 'Failed to insert flyer into database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -159,16 +159,10 @@ export class FlyerRepository {
|
||||
const result = await this.db.query<FlyerItem>(query, values);
|
||||
return result.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, flyerId }, 'Database error in insertFlyerItems');
|
||||
// Check for a foreign key violation, which would mean the flyerId is invalid.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified flyer does not exist.');
|
||||
}
|
||||
// Preserve the original error if it's not a foreign key violation,
|
||||
// allowing transactional functions to catch and identify the specific failure.
|
||||
// This is a higher-level fix for the test failure in `createFlyerAndItems`.
|
||||
if (error instanceof Error) throw error;
|
||||
throw new Error('An unknown error occurred while inserting flyer items.');
|
||||
handleDbError(error, logger, 'Database error in insertFlyerItems', { flyerId }, {
|
||||
fkMessage: 'The specified flyer, category, master item, or product does not exist.',
|
||||
defaultMessage: 'An unknown error occurred while inserting flyer items.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -186,8 +180,9 @@ export class FlyerRepository {
|
||||
const res = await this.db.query<Brand>(query);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getAllBrands');
|
||||
throw new Error('Failed to retrieve brands from database.');
|
||||
handleDbError(error, logger, 'Database error in getAllBrands', {}, {
|
||||
defaultMessage: 'Failed to retrieve brands from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -226,8 +221,9 @@ export class FlyerRepository {
|
||||
const res = await this.db.query<Flyer>(query, [limit, offset]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, limit, offset }, 'Database error in getFlyers');
|
||||
throw new Error('Failed to retrieve flyers from database.');
|
||||
handleDbError(error, logger, 'Database error in getFlyers', { limit, offset }, {
|
||||
defaultMessage: 'Failed to retrieve flyers from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -244,8 +240,9 @@ export class FlyerRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, flyerId }, 'Database error in getFlyerItems');
|
||||
throw new Error('Failed to retrieve flyer items from database.');
|
||||
handleDbError(error, logger, 'Database error in getFlyerItems', { flyerId }, {
|
||||
defaultMessage: 'Failed to retrieve flyer items from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -262,8 +259,9 @@ export class FlyerRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, flyerIds }, 'Database error in getFlyerItemsForFlyers');
|
||||
throw new Error('Failed to retrieve flyer items in batch from database.');
|
||||
handleDbError(error, logger, 'Database error in getFlyerItemsForFlyers', { flyerIds }, {
|
||||
defaultMessage: 'Failed to retrieve flyer items in batch from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -283,8 +281,9 @@ export class FlyerRepository {
|
||||
);
|
||||
return parseInt(res.rows[0].count, 10);
|
||||
} catch (error) {
|
||||
logger.error({ err: error, flyerIds }, 'Database error in countFlyerItemsForFlyers');
|
||||
throw new Error('Failed to count flyer items in batch from database.');
|
||||
handleDbError(error, logger, 'Database error in countFlyerItemsForFlyers', { flyerIds }, {
|
||||
defaultMessage: 'Failed to count flyer items in batch from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -300,8 +299,9 @@ export class FlyerRepository {
|
||||
]);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error, checksum }, 'Database error in findFlyerByChecksum');
|
||||
throw new Error('Failed to find flyer by checksum in database.');
|
||||
handleDbError(error, logger, 'Database error in findFlyerByChecksum', { checksum }, {
|
||||
defaultMessage: 'Failed to find flyer by checksum in database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -353,8 +353,9 @@ export class FlyerRepository {
|
||||
logger.info(`Successfully deleted flyer with ID: ${flyerId}`);
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error({ err: error, flyerId }, 'Database transaction error in deleteFlyer');
|
||||
throw new Error('Failed to delete flyer.');
|
||||
handleDbError(error, logger, 'Database transaction error in deleteFlyer', { flyerId }, {
|
||||
defaultMessage: 'Failed to delete flyer.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// src/services/db/gamification.db.ts
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool } from './connection.db';
|
||||
import { ForeignKeyConstraintError } from './errors.db';
|
||||
import { handleDbError } from './errors.db';
|
||||
import type { Logger } from 'pino';
|
||||
import { Achievement, UserAchievement, LeaderboardUser } from '../../types';
|
||||
|
||||
@@ -25,8 +25,9 @@ export class GamificationRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getAllAchievements');
|
||||
throw new Error('Failed to retrieve achievements.');
|
||||
handleDbError(error, logger, 'Database error in getAllAchievements', {}, {
|
||||
defaultMessage: 'Failed to retrieve achievements.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -58,8 +59,9 @@ export class GamificationRepository {
|
||||
const res = await this.db.query<UserAchievement & Achievement>(query, [userId]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getUserAchievements');
|
||||
throw new Error('Failed to retrieve user achievements.');
|
||||
handleDbError(error, logger, 'Database error in getUserAchievements', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve user achievements.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -75,12 +77,10 @@ export class GamificationRepository {
|
||||
try {
|
||||
await this.db.query('SELECT public.award_achievement($1, $2)', [userId, achievementName]); // This was a duplicate, fixed.
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId, achievementName }, 'Database error in awardAchievement');
|
||||
// Check for a foreign key violation, which would mean the user or achievement name is invalid.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified user or achievement does not exist.');
|
||||
}
|
||||
throw new Error('Failed to award achievement.');
|
||||
handleDbError(error, logger, 'Database error in awardAchievement', { userId, achievementName }, {
|
||||
fkMessage: 'The specified user or achievement does not exist.',
|
||||
defaultMessage: 'Failed to award achievement.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -105,8 +105,9 @@ export class GamificationRepository {
|
||||
const res = await this.db.query<LeaderboardUser>(query, [limit]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, limit }, 'Database error in getLeaderboard');
|
||||
throw new Error('Failed to retrieve leaderboard.');
|
||||
handleDbError(error, logger, 'Database error in getLeaderboard', { limit }, {
|
||||
defaultMessage: 'Failed to retrieve leaderboard.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,6 +10,8 @@ import { NotificationRepository } from './notification.db';
|
||||
import { BudgetRepository } from './budget.db';
|
||||
import { GamificationRepository } from './gamification.db';
|
||||
import { AdminRepository } from './admin.db';
|
||||
import { reactionRepo } from './reaction.db';
|
||||
import { conversionRepo } from './conversion.db';
|
||||
|
||||
const userRepo = new UserRepository();
|
||||
const flyerRepo = new FlyerRepository();
|
||||
@@ -33,5 +35,7 @@ export {
|
||||
budgetRepo,
|
||||
gamificationRepo,
|
||||
adminRepo,
|
||||
reactionRepo,
|
||||
conversionRepo,
|
||||
withTransaction,
|
||||
};
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// src/services/db/notification.db.ts
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool } from './connection.db';
|
||||
import { ForeignKeyConstraintError, NotFoundError } from './errors.db';
|
||||
import { NotFoundError, handleDbError } from './errors.db';
|
||||
import type { Logger } from 'pino';
|
||||
import type { Notification } from '../../types';
|
||||
|
||||
@@ -34,14 +34,10 @@ export class NotificationRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, userId, content, linkUrl },
|
||||
'Database error in createNotification',
|
||||
);
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified user does not exist.');
|
||||
}
|
||||
throw new Error('Failed to create notification.');
|
||||
handleDbError(error, logger, 'Database error in createNotification', { userId, content, linkUrl }, {
|
||||
fkMessage: 'The specified user does not exist.',
|
||||
defaultMessage: 'Failed to create notification.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -78,11 +74,10 @@ export class NotificationRepository {
|
||||
|
||||
await this.db.query(query, [userIds, contents, linkUrls]);
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in createBulkNotifications');
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('One or more of the specified users do not exist.');
|
||||
}
|
||||
throw new Error('Failed to create bulk notifications.');
|
||||
handleDbError(error, logger, 'Database error in createBulkNotifications', { notifications }, {
|
||||
fkMessage: 'One or more of the specified users do not exist.',
|
||||
defaultMessage: 'Failed to create bulk notifications.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -113,11 +108,13 @@ export class NotificationRepository {
|
||||
const res = await this.db.query<Notification>(query, params);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, userId, limit, offset, includeRead },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in getNotificationsForUser',
|
||||
{ userId, limit, offset, includeRead },
|
||||
{ defaultMessage: 'Failed to retrieve notifications.' },
|
||||
);
|
||||
throw new Error('Failed to retrieve notifications.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -133,8 +130,9 @@ export class NotificationRepository {
|
||||
[userId],
|
||||
);
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in markAllNotificationsAsRead');
|
||||
throw new Error('Failed to mark notifications as read.');
|
||||
handleDbError(error, logger, 'Database error in markAllNotificationsAsRead', { userId }, {
|
||||
defaultMessage: 'Failed to mark notifications as read.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -161,12 +159,13 @@ export class NotificationRepository {
|
||||
}
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error(
|
||||
{ err: error, notificationId, userId },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in markNotificationAsRead',
|
||||
{ notificationId, userId },
|
||||
{ defaultMessage: 'Failed to mark notification as read.' },
|
||||
);
|
||||
throw new Error('Failed to mark notification as read.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -184,8 +183,9 @@ export class NotificationRepository {
|
||||
);
|
||||
return res.rowCount ?? 0;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, daysOld }, 'Database error in deleteOldNotifications');
|
||||
throw new Error('Failed to delete old notifications.');
|
||||
handleDbError(error, logger, 'Database error in deleteOldNotifications', { daysOld }, {
|
||||
defaultMessage: 'Failed to delete old notifications.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// src/services/db/personalization.db.ts
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool, withTransaction } from './connection.db';
|
||||
import { ForeignKeyConstraintError } from './errors.db';
|
||||
import { handleDbError } from './errors.db';
|
||||
import type { Logger } from 'pino';
|
||||
import {
|
||||
MasterGroceryItem,
|
||||
@@ -40,8 +40,9 @@ export class PersonalizationRepository {
|
||||
const res = await this.db.query<MasterGroceryItem>(query);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getAllMasterItems');
|
||||
throw new Error('Failed to retrieve master grocery items.');
|
||||
handleDbError(error, logger, 'Database error in getAllMasterItems', {}, {
|
||||
defaultMessage: 'Failed to retrieve master grocery items.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -62,8 +63,9 @@ export class PersonalizationRepository {
|
||||
const res = await this.db.query<MasterGroceryItem>(query, [userId]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getWatchedItems');
|
||||
throw new Error('Failed to retrieve watched items.');
|
||||
handleDbError(error, logger, 'Database error in getWatchedItems', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve watched items.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -79,8 +81,9 @@ export class PersonalizationRepository {
|
||||
[userId, masterItemId],
|
||||
);
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId, masterItemId }, 'Database error in removeWatchedItem');
|
||||
throw new Error('Failed to remove item from watchlist.');
|
||||
handleDbError(error, logger, 'Database error in removeWatchedItem', { userId, masterItemId }, {
|
||||
defaultMessage: 'Failed to remove item from watchlist.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -100,8 +103,9 @@ export class PersonalizationRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error, pantryItemId }, 'Database error in findPantryItemOwner');
|
||||
throw new Error('Failed to retrieve pantry item owner from database.');
|
||||
handleDbError(error, logger, 'Database error in findPantryItemOwner', { pantryItemId }, {
|
||||
defaultMessage: 'Failed to retrieve pantry item owner from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -156,18 +160,17 @@ export class PersonalizationRepository {
|
||||
return masterItem;
|
||||
});
|
||||
} catch (error) {
|
||||
// The withTransaction helper will handle rollback. We just need to handle specific errors.
|
||||
if (error instanceof Error && 'code' in error) {
|
||||
if (error.code === '23503') {
|
||||
// foreign_key_violation
|
||||
throw new ForeignKeyConstraintError('The specified user or category does not exist.');
|
||||
}
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, userId, itemName, categoryName },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Transaction error in addWatchedItem',
|
||||
{ userId, itemName, categoryName },
|
||||
{
|
||||
fkMessage: 'The specified user or category does not exist.',
|
||||
uniqueMessage: 'A master grocery item with this name was created by another process.',
|
||||
defaultMessage: 'Failed to add item to watchlist.',
|
||||
},
|
||||
);
|
||||
throw new Error('Failed to add item to watchlist.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -186,8 +189,9 @@ export class PersonalizationRepository {
|
||||
>('SELECT * FROM public.get_best_sale_prices_for_all_users()');
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getBestSalePricesForAllUsers');
|
||||
throw new Error('Failed to get best sale prices for all users.');
|
||||
handleDbError(error, logger, 'Database error in getBestSalePricesForAllUsers', {}, {
|
||||
defaultMessage: 'Failed to get best sale prices for all users.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -200,8 +204,9 @@ export class PersonalizationRepository {
|
||||
const res = await this.db.query<Appliance>('SELECT * FROM public.appliances ORDER BY name');
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getAppliances');
|
||||
throw new Error('Failed to get appliances.');
|
||||
handleDbError(error, logger, 'Database error in getAppliances', {}, {
|
||||
defaultMessage: 'Failed to get appliances.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -216,8 +221,9 @@ export class PersonalizationRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in getDietaryRestrictions');
|
||||
throw new Error('Failed to get dietary restrictions.');
|
||||
handleDbError(error, logger, 'Database error in getDietaryRestrictions', {}, {
|
||||
defaultMessage: 'Failed to get dietary restrictions.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -236,8 +242,9 @@ export class PersonalizationRepository {
|
||||
const res = await this.db.query<DietaryRestriction>(query, [userId]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getUserDietaryRestrictions');
|
||||
throw new Error('Failed to get user dietary restrictions.');
|
||||
handleDbError(error, logger, 'Database error in getUserDietaryRestrictions', { userId }, {
|
||||
defaultMessage: 'Failed to get user dietary restrictions.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -266,17 +273,13 @@ export class PersonalizationRepository {
|
||||
}
|
||||
});
|
||||
} catch (error) {
|
||||
// Check for a foreign key violation, which would mean an invalid ID was provided.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError(
|
||||
'One or more of the specified restriction IDs are invalid.',
|
||||
);
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, userId, restrictionIds },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in setUserDietaryRestrictions',
|
||||
{ userId, restrictionIds },
|
||||
{ fkMessage: 'One or more of the specified restriction IDs are invalid.', defaultMessage: 'Failed to set user dietary restrictions.' },
|
||||
);
|
||||
throw new Error('Failed to set user dietary restrictions.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -306,12 +309,10 @@ export class PersonalizationRepository {
|
||||
return newAppliances;
|
||||
});
|
||||
} catch (error) {
|
||||
// Check for a foreign key violation, which would mean an invalid ID was provided.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('Invalid appliance ID');
|
||||
}
|
||||
logger.error({ err: error, userId, applianceIds }, 'Database error in setUserAppliances');
|
||||
throw new Error('Failed to set user appliances.');
|
||||
handleDbError(error, logger, 'Database error in setUserAppliances', { userId, applianceIds }, {
|
||||
fkMessage: 'Invalid appliance ID',
|
||||
defaultMessage: 'Failed to set user appliances.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -330,8 +331,9 @@ export class PersonalizationRepository {
|
||||
const res = await this.db.query<Appliance>(query, [userId]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getUserAppliances');
|
||||
throw new Error('Failed to get user appliances.');
|
||||
handleDbError(error, logger, 'Database error in getUserAppliances', { userId }, {
|
||||
defaultMessage: 'Failed to get user appliances.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -348,8 +350,9 @@ export class PersonalizationRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in findRecipesFromPantry');
|
||||
throw new Error('Failed to find recipes from pantry.');
|
||||
handleDbError(error, logger, 'Database error in findRecipesFromPantry', { userId }, {
|
||||
defaultMessage: 'Failed to find recipes from pantry.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -371,8 +374,9 @@ export class PersonalizationRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId, limit }, 'Database error in recommendRecipesForUser');
|
||||
throw new Error('Failed to recommend recipes.');
|
||||
handleDbError(error, logger, 'Database error in recommendRecipesForUser', { userId, limit }, {
|
||||
defaultMessage: 'Failed to recommend recipes.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -389,8 +393,9 @@ export class PersonalizationRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getBestSalePricesForUser');
|
||||
throw new Error('Failed to get best sale prices.');
|
||||
handleDbError(error, logger, 'Database error in getBestSalePricesForUser', { userId }, {
|
||||
defaultMessage: 'Failed to get best sale prices.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -410,8 +415,9 @@ export class PersonalizationRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, pantryItemId }, 'Database error in suggestPantryItemConversions');
|
||||
throw new Error('Failed to suggest pantry item conversions.');
|
||||
handleDbError(error, logger, 'Database error in suggestPantryItemConversions', { pantryItemId }, {
|
||||
defaultMessage: 'Failed to suggest pantry item conversions.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -428,8 +434,9 @@ export class PersonalizationRepository {
|
||||
); // This is a standalone function, no change needed here.
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getRecipesForUserDiets');
|
||||
throw new Error('Failed to get recipes compatible with user diet.');
|
||||
handleDbError(error, logger, 'Database error in getRecipesForUserDiets', { userId }, {
|
||||
defaultMessage: 'Failed to get recipes compatible with user diet.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
import type { Logger } from 'pino';
|
||||
import type { PriceHistoryData } from '../../types';
|
||||
import { getPool } from './connection.db';
|
||||
import { handleDbError } from './errors.db';
|
||||
|
||||
/**
|
||||
* Repository for fetching price-related data.
|
||||
@@ -51,11 +52,13 @@ export const priceRepo = {
|
||||
);
|
||||
return result.rows;
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, masterItemIds, limit, offset },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in getPriceHistory',
|
||||
{ masterItemIds, limit, offset },
|
||||
{ defaultMessage: 'Failed to retrieve price history.' },
|
||||
);
|
||||
throw new Error('Failed to retrieve price history.');
|
||||
}
|
||||
},
|
||||
};
|
||||
131
src/services/db/reaction.db.ts
Normal file
131
src/services/db/reaction.db.ts
Normal file
@@ -0,0 +1,131 @@
|
||||
// src/services/db/reaction.db.ts
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import type { Logger } from 'pino';
|
||||
import { getPool, withTransaction } from './connection.db';
|
||||
import { handleDbError } from './errors.db';
|
||||
import type { UserReaction } from '../../types';
|
||||
|
||||
export class ReactionRepository {
|
||||
private db: Pick<Pool | PoolClient, 'query'>;
|
||||
|
||||
constructor(db: Pick<Pool | PoolClient, 'query'> = getPool()) {
|
||||
this.db = db;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches user reactions based on query filters.
|
||||
* Supports filtering by user_id, entity_type, and entity_id.
|
||||
*/
|
||||
async getReactions(
|
||||
filters: {
|
||||
userId?: string;
|
||||
entityType?: string;
|
||||
entityId?: string;
|
||||
},
|
||||
logger: Logger,
|
||||
): Promise<UserReaction[]> {
|
||||
const { userId, entityType, entityId } = filters;
|
||||
try {
|
||||
let query = 'SELECT * FROM public.user_reactions WHERE 1=1';
|
||||
const params: any[] = [];
|
||||
let paramCount = 1;
|
||||
|
||||
if (userId) {
|
||||
query += ` AND user_id = $${paramCount++}`;
|
||||
params.push(userId);
|
||||
}
|
||||
|
||||
if (entityType) {
|
||||
query += ` AND entity_type = $${paramCount++}`;
|
||||
params.push(entityType);
|
||||
}
|
||||
|
||||
if (entityId) {
|
||||
query += ` AND entity_id = $${paramCount++}`;
|
||||
params.push(entityId);
|
||||
}
|
||||
|
||||
query += ' ORDER BY created_at DESC';
|
||||
|
||||
const result = await this.db.query<UserReaction>(query, params);
|
||||
return result.rows;
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in getReactions', { filters }, {
|
||||
defaultMessage: 'Failed to retrieve user reactions.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Toggles a user's reaction to an entity.
|
||||
* If the reaction exists, it's deleted. If it doesn't, it's created.
|
||||
* @returns The created UserReaction if a reaction was added, or null if it was removed.
|
||||
*/
|
||||
async toggleReaction(
|
||||
reactionData: Omit<UserReaction, 'reaction_id' | 'created_at' | 'updated_at'>,
|
||||
logger: Logger,
|
||||
): Promise<UserReaction | null> {
|
||||
const { user_id, entity_type, entity_id, reaction_type } = reactionData;
|
||||
|
||||
try {
|
||||
return await withTransaction(async (client) => {
|
||||
const deleteRes = await client.query(
|
||||
'DELETE FROM public.user_reactions WHERE user_id = $1 AND entity_type = $2 AND entity_id = $3 AND reaction_type = $4',
|
||||
[user_id, entity_type, entity_id, reaction_type],
|
||||
);
|
||||
|
||||
if ((deleteRes.rowCount ?? 0) > 0) {
|
||||
logger.debug({ reactionData }, 'Reaction removed.');
|
||||
return null;
|
||||
}
|
||||
|
||||
const insertRes = await client.query<UserReaction>(
|
||||
'INSERT INTO public.user_reactions (user_id, entity_type, entity_id, reaction_type) VALUES ($1, $2, $3, $4) RETURNING *',
|
||||
[user_id, entity_type, entity_id, reaction_type],
|
||||
);
|
||||
|
||||
logger.debug({ reaction: insertRes.rows[0] }, 'Reaction added.');
|
||||
return insertRes.rows[0];
|
||||
});
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in toggleReaction', { reactionData }, {
|
||||
fkMessage: 'The specified user or entity does not exist.',
|
||||
defaultMessage: 'Failed to toggle user reaction.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a summary of reactions for a specific entity.
|
||||
* Counts the number of each reaction_type.
|
||||
* @param entityType The type of the entity (e.g., 'recipe').
|
||||
* @param entityId The ID of the entity.
|
||||
* @param logger The pino logger instance.
|
||||
* @returns A promise that resolves to an array of reaction summaries.
|
||||
*/
|
||||
async getReactionSummary(
|
||||
entityType: string,
|
||||
entityId: string,
|
||||
logger: Logger,
|
||||
): Promise<{ reaction_type: string; count: number }[]> {
|
||||
try {
|
||||
const query = `
|
||||
SELECT
|
||||
reaction_type,
|
||||
COUNT(*)::int as count
|
||||
FROM public.user_reactions
|
||||
WHERE entity_type = $1 AND entity_id = $2
|
||||
GROUP BY reaction_type
|
||||
ORDER BY count DESC;
|
||||
`;
|
||||
const result = await getPool().query<{ reaction_type: string; count: number }>(query, [entityType, entityId]);
|
||||
return result.rows;
|
||||
} catch (error) {
|
||||
handleDbError(error, logger, 'Database error in getReactionSummary', { entityType, entityId }, {
|
||||
defaultMessage: 'Failed to retrieve reaction summary.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const reactionRepo = new ReactionRepository();
|
||||
@@ -1,7 +1,7 @@
|
||||
// src/services/db/recipe.db.ts
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool } from './connection.db';
|
||||
import { ForeignKeyConstraintError, NotFoundError, UniqueConstraintError } from './errors.db';
|
||||
import { NotFoundError, UniqueConstraintError, handleDbError } from './errors.db';
|
||||
import type { Logger } from 'pino';
|
||||
import type { Recipe, FavoriteRecipe, RecipeComment } from '../../types';
|
||||
|
||||
@@ -25,8 +25,9 @@ export class RecipeRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, minPercentage }, 'Database error in getRecipesBySalePercentage');
|
||||
throw new Error('Failed to get recipes by sale percentage.');
|
||||
handleDbError(error, logger, 'Database error in getRecipesBySalePercentage', { minPercentage }, {
|
||||
defaultMessage: 'Failed to get recipes by sale percentage.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -43,11 +44,13 @@ export class RecipeRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, minIngredients },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in getRecipesByMinSaleIngredients',
|
||||
{ minIngredients },
|
||||
{ defaultMessage: 'Failed to get recipes by minimum sale ingredients.' },
|
||||
);
|
||||
throw new Error('Failed to get recipes by minimum sale ingredients.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -69,11 +72,13 @@ export class RecipeRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, ingredient, tag },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in findRecipesByIngredientAndTag',
|
||||
{ ingredient, tag },
|
||||
{ defaultMessage: 'Failed to find recipes by ingredient and tag.' },
|
||||
);
|
||||
throw new Error('Failed to find recipes by ingredient and tag.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -90,8 +95,9 @@ export class RecipeRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getUserFavoriteRecipes');
|
||||
throw new Error('Failed to get favorite recipes.');
|
||||
handleDbError(error, logger, 'Database error in getUserFavoriteRecipes', { userId }, {
|
||||
defaultMessage: 'Failed to get favorite recipes.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -118,14 +124,10 @@ export class RecipeRepository {
|
||||
}
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof UniqueConstraintError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error({ err: error, userId, recipeId }, 'Database error in addFavoriteRecipe');
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified user or recipe does not exist.');
|
||||
}
|
||||
throw new Error('Failed to add favorite recipe.');
|
||||
handleDbError(error, logger, 'Database error in addFavoriteRecipe', { userId, recipeId }, {
|
||||
fkMessage: 'The specified user or recipe does not exist.',
|
||||
defaultMessage: 'Failed to add favorite recipe.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -144,11 +146,9 @@ export class RecipeRepository {
|
||||
throw new NotFoundError('Favorite recipe not found for this user.');
|
||||
}
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error({ err: error, userId, recipeId }, 'Database error in removeFavoriteRecipe');
|
||||
throw new Error('Failed to remove favorite recipe.');
|
||||
handleDbError(error, logger, 'Database error in removeFavoriteRecipe', { userId, recipeId }, {
|
||||
defaultMessage: 'Failed to remove favorite recipe.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -178,9 +178,9 @@ export class RecipeRepository {
|
||||
throw new NotFoundError('Recipe not found or user does not have permission to delete.');
|
||||
}
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error({ err: error, recipeId, userId, isAdmin }, 'Database error in deleteRecipe');
|
||||
throw new Error('Failed to delete recipe.');
|
||||
handleDbError(error, logger, 'Database error in deleteRecipe', { recipeId, userId, isAdmin }, {
|
||||
defaultMessage: 'Failed to delete recipe.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -239,15 +239,9 @@ export class RecipeRepository {
|
||||
}
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
// Re-throw specific, known errors to allow for more precise error handling in the calling code.
|
||||
if (
|
||||
error instanceof NotFoundError ||
|
||||
(error instanceof Error && error.message.includes('No fields provided'))
|
||||
) {
|
||||
throw error;
|
||||
}
|
||||
logger.error({ err: error, recipeId, userId, updates }, 'Database error in updateRecipe');
|
||||
throw new Error('Failed to update recipe.');
|
||||
handleDbError(error, logger, 'Database error in updateRecipe', { recipeId, userId, updates }, {
|
||||
defaultMessage: 'Failed to update recipe.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -277,11 +271,9 @@ export class RecipeRepository {
|
||||
}
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error({ err: error, recipeId }, 'Database error in getRecipeById');
|
||||
throw new Error('Failed to retrieve recipe.');
|
||||
handleDbError(error, logger, 'Database error in getRecipeById', { recipeId }, {
|
||||
defaultMessage: 'Failed to retrieve recipe.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -305,8 +297,9 @@ export class RecipeRepository {
|
||||
const res = await this.db.query<RecipeComment>(query, [recipeId]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, recipeId }, 'Database error in getRecipeComments');
|
||||
throw new Error('Failed to get recipe comments.');
|
||||
handleDbError(error, logger, 'Database error in getRecipeComments', { recipeId }, {
|
||||
defaultMessage: 'Failed to get recipe comments.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -332,18 +325,13 @@ export class RecipeRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, recipeId, userId, parentCommentId },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in addRecipeComment',
|
||||
{ recipeId, userId, parentCommentId },
|
||||
{ fkMessage: 'The specified recipe, user, or parent comment does not exist.', defaultMessage: 'Failed to add recipe comment.' },
|
||||
);
|
||||
// Check for specific PostgreSQL error codes
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
// foreign_key_violation
|
||||
throw new ForeignKeyConstraintError(
|
||||
'The specified recipe, user, or parent comment does not exist.',
|
||||
);
|
||||
}
|
||||
throw new Error('Failed to add recipe comment.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -361,13 +349,15 @@ export class RecipeRepository {
|
||||
]);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId, originalRecipeId }, 'Database error in forkRecipe');
|
||||
// The fork_recipe function could fail if the original recipe doesn't exist or isn't public.
|
||||
if (error instanceof Error && 'code' in error && error.code === 'P0001') {
|
||||
// raise_exception
|
||||
throw new Error(error.message); // Re-throw the user-friendly message from the DB function.
|
||||
}
|
||||
throw new Error('Failed to fork recipe.');
|
||||
handleDbError(error, logger, 'Database error in forkRecipe', { userId, originalRecipeId }, {
|
||||
fkMessage: 'The specified user or original recipe does not exist.',
|
||||
defaultMessage: 'Failed to fork recipe.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// src/services/db/shopping.db.ts
|
||||
import type { Pool, PoolClient } from 'pg';
|
||||
import { getPool, withTransaction } from './connection.db';
|
||||
import { ForeignKeyConstraintError, UniqueConstraintError, NotFoundError } from './errors.db';
|
||||
import { NotFoundError, handleDbError } from './errors.db';
|
||||
import type { Logger } from 'pino';
|
||||
import {
|
||||
ShoppingList,
|
||||
@@ -53,8 +53,9 @@ export class ShoppingRepository {
|
||||
const res = await this.db.query<ShoppingList>(query, [userId]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getShoppingLists');
|
||||
throw new Error('Failed to retrieve shopping lists.');
|
||||
handleDbError(error, logger, 'Database error in getShoppingLists', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve shopping lists.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -72,13 +73,10 @@ export class ShoppingRepository {
|
||||
);
|
||||
return { ...res.rows[0], items: [] };
|
||||
} catch (error) {
|
||||
// The patch requested this specific error handling.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified user does not exist.');
|
||||
}
|
||||
logger.error({ err: error, userId, name }, 'Database error in createShoppingList');
|
||||
// The patch requested this specific error handling.
|
||||
throw new Error('Failed to create shopping list.');
|
||||
handleDbError(error, logger, 'Database error in createShoppingList', { userId, name }, {
|
||||
fkMessage: 'The specified user does not exist.',
|
||||
defaultMessage: 'Failed to create shopping list.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -120,8 +118,9 @@ export class ShoppingRepository {
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error({ err: error, listId, userId }, 'Database error in getShoppingListById');
|
||||
throw new Error('Failed to retrieve shopping list.');
|
||||
handleDbError(error, logger, 'Database error in getShoppingListById', { listId, userId }, {
|
||||
defaultMessage: 'Failed to retrieve shopping list.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -143,8 +142,9 @@ export class ShoppingRepository {
|
||||
);
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error({ err: error, listId, userId }, 'Database error in deleteShoppingList');
|
||||
throw new Error('Failed to delete shopping list.');
|
||||
handleDbError(error, logger, 'Database error in deleteShoppingList', { listId, userId }, {
|
||||
defaultMessage: 'Failed to delete shopping list.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -171,12 +171,11 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
// The patch requested this specific error handling.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('Referenced list or item does not exist.');
|
||||
}
|
||||
logger.error({ err: error, listId, item }, 'Database error in addShoppingListItem');
|
||||
throw new Error('Failed to add item to shopping list.');
|
||||
handleDbError(error, logger, 'Database error in addShoppingListItem', { listId, item }, {
|
||||
fkMessage: 'Referenced list or item does not exist.',
|
||||
checkMessage: 'Shopping list item must have a master item or a custom name.',
|
||||
defaultMessage: 'Failed to add item to shopping list.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -196,8 +195,9 @@ export class ShoppingRepository {
|
||||
}
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error({ err: error, itemId }, 'Database error in removeShoppingListItem');
|
||||
throw new Error('Failed to remove item from shopping list.');
|
||||
handleDbError(error, logger, 'Database error in removeShoppingListItem', { itemId }, {
|
||||
defaultMessage: 'Failed to remove item from shopping list.',
|
||||
});
|
||||
}
|
||||
}
|
||||
/**
|
||||
@@ -218,11 +218,13 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, menuPlanId, userId },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in generateShoppingListForMenuPlan',
|
||||
{ menuPlanId, userId },
|
||||
{ defaultMessage: 'Failed to generate shopping list for menu plan.' },
|
||||
);
|
||||
throw new Error('Failed to generate shopping list for menu plan.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -246,11 +248,13 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, menuPlanId, shoppingListId, userId },
|
||||
handleDbError(
|
||||
error,
|
||||
logger,
|
||||
'Database error in addMenuPlanToShoppingList',
|
||||
{ menuPlanId, shoppingListId, userId },
|
||||
{ fkMessage: 'The specified menu plan, shopping list, or an item within the plan does not exist.', defaultMessage: 'Failed to add menu plan to shopping list.' },
|
||||
);
|
||||
throw new Error('Failed to add menu plan to shopping list.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -267,8 +271,9 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getPantryLocations');
|
||||
throw new Error('Failed to get pantry locations.');
|
||||
handleDbError(error, logger, 'Database error in getPantryLocations', { userId }, {
|
||||
defaultMessage: 'Failed to get pantry locations.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -290,13 +295,12 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof Error && 'code' in error && error.code === '23505') {
|
||||
throw new UniqueConstraintError('A pantry location with this name already exists.');
|
||||
} else if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('User not found');
|
||||
}
|
||||
logger.error({ err: error, userId, name }, 'Database error in createPantryLocation');
|
||||
throw new Error('Failed to create pantry location.');
|
||||
handleDbError(error, logger, 'Database error in createPantryLocation', { userId, name }, {
|
||||
uniqueMessage: 'A pantry location with this name already exists.',
|
||||
fkMessage: 'User not found',
|
||||
notNullMessage: 'Pantry location name cannot be null.',
|
||||
defaultMessage: 'Failed to create pantry location.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -353,8 +357,9 @@ export class ShoppingRepository {
|
||||
) {
|
||||
throw error;
|
||||
}
|
||||
logger.error({ err: error, itemId, updates }, 'Database error in updateShoppingListItem');
|
||||
throw new Error('Failed to update shopping list item.');
|
||||
handleDbError(error, logger, 'Database error in updateShoppingListItem', { itemId, updates }, {
|
||||
defaultMessage: 'Failed to update shopping list item.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -378,15 +383,10 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows[0].complete_shopping_list;
|
||||
} catch (error) {
|
||||
// The patch requested this specific error handling.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified shopping list does not exist.');
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, shoppingListId, userId },
|
||||
'Database error in completeShoppingList',
|
||||
);
|
||||
throw new Error('Failed to complete shopping list.');
|
||||
handleDbError(error, logger, 'Database error in completeShoppingList', { shoppingListId, userId }, {
|
||||
fkMessage: 'The specified shopping list does not exist.',
|
||||
defaultMessage: 'Failed to complete shopping list.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -423,8 +423,9 @@ export class ShoppingRepository {
|
||||
const res = await this.db.query<ShoppingTrip>(query, [userId]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId }, 'Database error in getShoppingTripHistory');
|
||||
throw new Error('Failed to retrieve shopping trip history.');
|
||||
handleDbError(error, logger, 'Database error in getShoppingTripHistory', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve shopping trip history.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -444,12 +445,10 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
// The patch requested this specific error handling.
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('User not found');
|
||||
}
|
||||
logger.error({ err: error, userId, receiptImageUrl }, 'Database error in createReceipt');
|
||||
throw new Error('Failed to create receipt record.');
|
||||
handleDbError(error, logger, 'Database error in createReceipt', { userId, receiptImageUrl }, {
|
||||
fkMessage: 'User not found',
|
||||
defaultMessage: 'Failed to create receipt record.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -479,7 +478,6 @@ export class ShoppingRepository {
|
||||
logger.info(`Successfully processed items for receipt ID: ${receiptId}`);
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error({ err: error, receiptId }, 'Database transaction error in processReceiptItems');
|
||||
// After the transaction fails and is rolled back by withTransaction,
|
||||
// update the receipt status in a separate, non-transactional query.
|
||||
try {
|
||||
@@ -492,7 +490,10 @@ export class ShoppingRepository {
|
||||
'Failed to update receipt status to "failed" after transaction rollback.',
|
||||
);
|
||||
}
|
||||
throw new Error('Failed to process and save receipt items.');
|
||||
handleDbError(error, logger, 'Database transaction error in processReceiptItems', { receiptId }, {
|
||||
fkMessage: 'The specified receipt or an item within it does not exist.',
|
||||
defaultMessage: 'Failed to process and save receipt items.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -509,8 +510,9 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, receiptId }, 'Database error in findDealsForReceipt');
|
||||
throw new Error('Failed to find deals for receipt.');
|
||||
handleDbError(error, logger, 'Database error in findDealsForReceipt', { receiptId }, {
|
||||
defaultMessage: 'Failed to find deals for receipt.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -530,8 +532,9 @@ export class ShoppingRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error, receiptId }, 'Database error in findReceiptOwner');
|
||||
throw new Error('Failed to retrieve receipt owner from database.');
|
||||
handleDbError(error, logger, 'Database error in findReceiptOwner', { receiptId }, {
|
||||
defaultMessage: 'Failed to retrieve receipt owner from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
import { Pool, PoolClient } from 'pg';
|
||||
import { getPool } from './connection.db';
|
||||
import type { Logger } from 'pino';
|
||||
import { UniqueConstraintError, ForeignKeyConstraintError, NotFoundError } from './errors.db';
|
||||
import { NotFoundError, handleDbError } from './errors.db';
|
||||
import {
|
||||
Profile,
|
||||
MasterGroceryItem,
|
||||
@@ -52,8 +52,9 @@ export class UserRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error, email }, 'Database error in findUserByEmail');
|
||||
throw new Error('Failed to retrieve user from database.');
|
||||
handleDbError(error, logger, 'Database error in findUserByEmail', { email }, {
|
||||
defaultMessage: 'Failed to retrieve user from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -121,14 +122,10 @@ export class UserRepository {
|
||||
logger.debug({ user: fullUserProfile }, `[DB createUser] Fetched full profile for new user:`);
|
||||
return fullUserProfile;
|
||||
}).catch((error) => {
|
||||
// Check for specific PostgreSQL error codes
|
||||
if (error instanceof Error && 'code' in error && error.code === '23505') {
|
||||
logger.warn(`Attempted to create a user with an existing email: ${email}`);
|
||||
throw new UniqueConstraintError('A user with this email address already exists.');
|
||||
}
|
||||
// The withTransaction helper logs the rollback, so we just log the context here.
|
||||
logger.error({ err: error, email }, 'Error during createUser transaction');
|
||||
throw new Error('Failed to create user in database.');
|
||||
handleDbError(error, logger, 'Error during createUser transaction', { email }, {
|
||||
uniqueMessage: 'A user with this email address already exists.',
|
||||
defaultMessage: 'Failed to create user in database.',
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
@@ -182,8 +179,9 @@ export class UserRepository {
|
||||
|
||||
return authableProfile;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, email }, 'Database error in findUserWithProfileByEmail');
|
||||
throw new Error('Failed to retrieve user with profile from database.');
|
||||
handleDbError(error, logger, 'Database error in findUserWithProfileByEmail', { email }, {
|
||||
defaultMessage: 'Failed to retrieve user with profile from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -205,11 +203,9 @@ export class UserRepository {
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error(
|
||||
{ err: error, userId },
|
||||
'Database error in findUserById',
|
||||
);
|
||||
throw new Error('Failed to retrieve user by ID from database.');
|
||||
handleDbError(error, logger, 'Database error in findUserById', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve user by ID from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -232,11 +228,9 @@ export class UserRepository {
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
if (error instanceof NotFoundError) throw error;
|
||||
logger.error(
|
||||
{ err: error, userId },
|
||||
'Database error in findUserWithPasswordHashById',
|
||||
);
|
||||
throw new Error('Failed to retrieve user with sensitive data by ID from database.');
|
||||
handleDbError(error, logger, 'Database error in findUserWithPasswordHashById', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve user with sensitive data by ID from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -281,11 +275,9 @@ export class UserRepository {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, userId },
|
||||
'Database error in findUserProfileById',
|
||||
);
|
||||
throw new Error('Failed to retrieve user profile from database.');
|
||||
handleDbError(error, logger, 'Database error in findUserProfileById', { userId }, {
|
||||
defaultMessage: 'Failed to retrieve user profile from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -330,11 +322,10 @@ export class UserRepository {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, userId, profileData },
|
||||
'Database error in updateUserProfile',
|
||||
);
|
||||
throw new Error('Failed to update user profile in database.');
|
||||
handleDbError(error, logger, 'Database error in updateUserProfile', { userId, profileData }, {
|
||||
fkMessage: 'The specified address does not exist.',
|
||||
defaultMessage: 'Failed to update user profile in database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -362,11 +353,9 @@ export class UserRepository {
|
||||
if (error instanceof NotFoundError) {
|
||||
throw error;
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, userId, preferences },
|
||||
'Database error in updateUserPreferences',
|
||||
);
|
||||
throw new Error('Failed to update user preferences in database.');
|
||||
handleDbError(error, logger, 'Database error in updateUserPreferences', { userId, preferences }, {
|
||||
defaultMessage: 'Failed to update user preferences in database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -383,11 +372,9 @@ export class UserRepository {
|
||||
[passwordHash, userId]
|
||||
);
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, userId },
|
||||
'Database error in updateUserPassword',
|
||||
);
|
||||
throw new Error('Failed to update user password in database.');
|
||||
handleDbError(error, logger, 'Database error in updateUserPassword', { userId }, {
|
||||
defaultMessage: 'Failed to update user password in database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -400,11 +387,9 @@ export class UserRepository {
|
||||
try {
|
||||
await this.db.query('DELETE FROM public.users WHERE user_id = $1', [userId]);
|
||||
} catch (error) { // This was a duplicate, fixed.
|
||||
logger.error(
|
||||
{ err: error, userId },
|
||||
'Database error in deleteUserById',
|
||||
);
|
||||
throw new Error('Failed to delete user from database.');
|
||||
handleDbError(error, logger, 'Database error in deleteUserById', { userId }, {
|
||||
defaultMessage: 'Failed to delete user from database.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -421,11 +406,9 @@ export class UserRepository {
|
||||
[refreshToken, userId]
|
||||
);
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, userId },
|
||||
'Database error in saveRefreshToken',
|
||||
);
|
||||
throw new Error('Failed to save refresh token.');
|
||||
handleDbError(error, logger, 'Database error in saveRefreshToken', { userId }, {
|
||||
defaultMessage: 'Failed to save refresh token.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -448,8 +431,9 @@ export class UserRepository {
|
||||
}
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in findUserByRefreshToken');
|
||||
throw new Error('Failed to find user by refresh token.'); // Generic error for other failures
|
||||
handleDbError(error, logger, 'Database error in findUserByRefreshToken', {}, {
|
||||
defaultMessage: 'Failed to find user by refresh token.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -483,14 +467,11 @@ export class UserRepository {
|
||||
[userId, tokenHash, expiresAt]
|
||||
);
|
||||
} catch (error) {
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('The specified user does not exist.');
|
||||
}
|
||||
logger.error(
|
||||
{ err: error, userId },
|
||||
'Database error in createPasswordResetToken',
|
||||
);
|
||||
throw new Error('Failed to create password reset token.');
|
||||
handleDbError(error, logger, 'Database error in createPasswordResetToken', { userId }, {
|
||||
fkMessage: 'The specified user does not exist.',
|
||||
uniqueMessage: 'A password reset token with this hash already exists.',
|
||||
defaultMessage: 'Failed to create password reset token.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -506,11 +487,9 @@ export class UserRepository {
|
||||
);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error },
|
||||
'Database error in getValidResetTokens',
|
||||
);
|
||||
throw new Error('Failed to retrieve valid reset tokens.');
|
||||
handleDbError(error, logger, 'Database error in getValidResetTokens', {}, {
|
||||
defaultMessage: 'Failed to retrieve valid reset tokens.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -545,8 +524,9 @@ export class UserRepository {
|
||||
);
|
||||
return res.rowCount ?? 0;
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Database error in deleteExpiredResetTokens');
|
||||
throw new Error('Failed to delete expired password reset tokens.');
|
||||
handleDbError(error, logger, 'Database error in deleteExpiredResetTokens', {}, {
|
||||
defaultMessage: 'Failed to delete expired password reset tokens.',
|
||||
});
|
||||
}
|
||||
}
|
||||
/**
|
||||
@@ -561,11 +541,11 @@ export class UserRepository {
|
||||
[followerId, followingId],
|
||||
);
|
||||
} catch (error) {
|
||||
if (error instanceof Error && 'code' in error && error.code === '23503') {
|
||||
throw new ForeignKeyConstraintError('One or both users do not exist.');
|
||||
}
|
||||
logger.error({ err: error, followerId, followingId }, 'Database error in followUser');
|
||||
throw new Error('Failed to follow user.');
|
||||
handleDbError(error, logger, 'Database error in followUser', { followerId, followingId }, {
|
||||
fkMessage: 'One or both users do not exist.',
|
||||
checkMessage: 'A user cannot follow themselves.',
|
||||
defaultMessage: 'Failed to follow user.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -581,8 +561,9 @@ export class UserRepository {
|
||||
[followerId, followingId],
|
||||
);
|
||||
} catch (error) {
|
||||
logger.error({ err: error, followerId, followingId }, 'Database error in unfollowUser');
|
||||
throw new Error('Failed to unfollow user.');
|
||||
handleDbError(error, logger, 'Database error in unfollowUser', { followerId, followingId }, {
|
||||
defaultMessage: 'Failed to unfollow user.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -612,8 +593,9 @@ export class UserRepository {
|
||||
const res = await this.db.query<ActivityLogItem>(query, [userId, limit, offset]);
|
||||
return res.rows;
|
||||
} catch (error) {
|
||||
logger.error({ err: error, userId, limit, offset }, 'Database error in getUserFeed');
|
||||
throw new Error('Failed to retrieve user feed.');
|
||||
handleDbError(error, logger, 'Database error in getUserFeed', { userId, limit, offset }, {
|
||||
defaultMessage: 'Failed to retrieve user feed.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -634,8 +616,10 @@ export class UserRepository {
|
||||
);
|
||||
return res.rows[0];
|
||||
} catch (error) {
|
||||
logger.error({ err: error, queryData }, 'Database error in logSearchQuery');
|
||||
throw new Error('Failed to log search query.');
|
||||
handleDbError(error, logger, 'Database error in logSearchQuery', { queryData }, {
|
||||
fkMessage: 'The specified user does not exist.',
|
||||
defaultMessage: 'Failed to log search query.',
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -668,10 +652,8 @@ export async function exportUserData(userId: string, logger: Logger): Promise<{
|
||||
return { profile, watchedItems, shoppingLists };
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error(
|
||||
{ err: error, userId },
|
||||
'Database error in exportUserData',
|
||||
);
|
||||
throw new Error('Failed to export user data.');
|
||||
handleDbError(error, logger, 'Database error in exportUserData', { userId }, {
|
||||
defaultMessage: 'Failed to export user data.',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
||||
import { FlyerAiProcessor } from './flyerAiProcessor.server';
|
||||
import { AiDataValidationError } from './processingErrors';
|
||||
import { logger } from './logger.server';
|
||||
import { logger } from './logger.server'; // Keep this import for the logger instance
|
||||
import type { AIService } from './aiService.server';
|
||||
import type { PersonalizationRepository } from './db/personalization.db';
|
||||
import type { FlyerJobData } from '../types/job-data';
|
||||
@@ -63,7 +63,8 @@ describe('FlyerAiProcessor', () => {
|
||||
};
|
||||
vi.mocked(mockAiService.extractCoreDataFromFlyerImage).mockResolvedValue(mockAiResponse);
|
||||
|
||||
const result = await service.extractAndValidateData([], jobData, logger);
|
||||
const imagePaths = [{ path: 'page1.jpg', mimetype: 'image/jpeg' }];
|
||||
const result = await service.extractAndValidateData(imagePaths, jobData, logger);
|
||||
|
||||
expect(mockAiService.extractCoreDataFromFlyerImage).toHaveBeenCalledTimes(1);
|
||||
expect(mockPersonalizationRepo.getAllMasterItems).toHaveBeenCalledTimes(1);
|
||||
@@ -83,7 +84,8 @@ describe('FlyerAiProcessor', () => {
|
||||
};
|
||||
vi.mocked(mockAiService.extractCoreDataFromFlyerImage).mockResolvedValue(invalidResponse as any);
|
||||
|
||||
await expect(service.extractAndValidateData([], jobData, logger)).rejects.toThrow(
|
||||
const imagePaths = [{ path: 'page1.jpg', mimetype: 'image/jpeg' }];
|
||||
await expect(service.extractAndValidateData(imagePaths, jobData, logger)).rejects.toThrow(
|
||||
AiDataValidationError,
|
||||
);
|
||||
});
|
||||
@@ -101,7 +103,8 @@ describe('FlyerAiProcessor', () => {
|
||||
vi.mocked(mockAiService.extractCoreDataFromFlyerImage).mockResolvedValue(mockAiResponse as any);
|
||||
const { logger } = await import('./logger.server');
|
||||
|
||||
const result = await service.extractAndValidateData([], jobData, logger);
|
||||
const imagePaths = [{ path: 'page1.jpg', mimetype: 'image/jpeg' }];
|
||||
const result = await service.extractAndValidateData(imagePaths, jobData, logger);
|
||||
|
||||
// It should not throw, but return the data and log a warning.
|
||||
expect(result.data).toEqual(mockAiResponse);
|
||||
@@ -122,7 +125,8 @@ describe('FlyerAiProcessor', () => {
|
||||
vi.mocked(mockAiService.extractCoreDataFromFlyerImage).mockResolvedValue(mockAiResponse);
|
||||
const { logger } = await import('./logger.server');
|
||||
|
||||
const result = await service.extractAndValidateData([], jobData, logger);
|
||||
const imagePaths = [{ path: 'page1.jpg', mimetype: 'image/jpeg' }];
|
||||
const result = await service.extractAndValidateData(imagePaths, jobData, logger);
|
||||
expect(result.data).toEqual(mockAiResponse);
|
||||
expect(result.needsReview).toBe(true);
|
||||
expect(logger.warn).toHaveBeenCalledWith(expect.any(Object), expect.stringContaining('contains no items. The flyer will be saved with an item_count of 0. Flagging for review.'));
|
||||
|
||||
@@ -5,28 +5,11 @@ import type { AIService } from './aiService.server';
|
||||
import type { PersonalizationRepository } from './db/personalization.db';
|
||||
import { AiDataValidationError } from './processingErrors';
|
||||
import type { FlyerJobData } from '../types/job-data';
|
||||
|
||||
// Helper for consistent required string validation (handles missing/null/empty)
|
||||
const requiredString = (message: string) =>
|
||||
z.preprocess((val) => val ?? '', z.string().min(1, message));
|
||||
|
||||
// --- Zod Schemas for AI Response Validation ---
|
||||
const ExtractedFlyerItemSchema = z.object({
|
||||
item: z.string().nullable(),
|
||||
price_display: z.string().nullable(),
|
||||
price_in_cents: z.number().nullable(),
|
||||
quantity: z.string().nullable(),
|
||||
category_name: z.string().nullable(),
|
||||
master_item_id: z.number().nullish(),
|
||||
});
|
||||
|
||||
export const AiFlyerDataSchema = z.object({
|
||||
store_name: z.string().nullable(),
|
||||
valid_from: z.string().nullable(),
|
||||
valid_to: z.string().nullable(),
|
||||
store_address: z.string().nullable(),
|
||||
items: z.array(ExtractedFlyerItemSchema),
|
||||
});
|
||||
import {
|
||||
AiFlyerDataSchema,
|
||||
ExtractedFlyerItemSchema,
|
||||
requiredString,
|
||||
} from '../types/ai'; // Import consolidated schemas and helper
|
||||
|
||||
export type ValidatedAiDataType = z.infer<typeof AiFlyerDataSchema>;
|
||||
|
||||
|
||||
@@ -2,9 +2,11 @@
|
||||
import path from 'path';
|
||||
import type { z } from 'zod';
|
||||
import type { Logger } from 'pino';
|
||||
import type { FlyerInsert, FlyerItemInsert, FlyerStatus } from '../types';
|
||||
import type { AiFlyerDataSchema, AiProcessorResult } from './flyerAiProcessor.server';
|
||||
import type { FlyerInsert, FlyerItemInsert } from '../types';
|
||||
import type { AiProcessorResult } from './flyerAiProcessor.server'; // Keep this import for AiProcessorResult
|
||||
import { AiFlyerDataSchema } from '../types/ai'; // Import consolidated schema
|
||||
import { generateFlyerIcon } from '../utils/imageProcessor';
|
||||
import { TransformationError } from './processingErrors';
|
||||
|
||||
/**
|
||||
* This class is responsible for transforming the validated data from the AI service
|
||||
@@ -56,41 +58,47 @@ export class FlyerDataTransformer {
|
||||
): Promise<{ flyerData: FlyerInsert; itemsForDb: FlyerItemInsert[] }> {
|
||||
logger.info('Starting data transformation from AI output to database format.');
|
||||
|
||||
const { data: extractedData, needsReview } = aiResult;
|
||||
try {
|
||||
const { data: extractedData, needsReview } = aiResult;
|
||||
|
||||
const firstImage = imagePaths[0].path;
|
||||
const iconFileName = await generateFlyerIcon(
|
||||
firstImage,
|
||||
path.join(path.dirname(firstImage), 'icons'),
|
||||
logger,
|
||||
);
|
||||
const firstImage = imagePaths[0].path;
|
||||
const iconFileName = await generateFlyerIcon(
|
||||
firstImage,
|
||||
path.join(path.dirname(firstImage), 'icons'),
|
||||
logger,
|
||||
);
|
||||
|
||||
const itemsForDb: FlyerItemInsert[] = extractedData.items.map((item) => this._normalizeItem(item));
|
||||
const itemsForDb: FlyerItemInsert[] = extractedData.items.map((item) => this._normalizeItem(item));
|
||||
|
||||
const storeName = extractedData.store_name || 'Unknown Store (auto)';
|
||||
if (!extractedData.store_name) {
|
||||
logger.warn('AI did not return a store name. Using fallback "Unknown Store (auto)".');
|
||||
const storeName = extractedData.store_name || 'Unknown Store (auto)';
|
||||
if (!extractedData.store_name) {
|
||||
logger.warn('AI did not return a store name. Using fallback "Unknown Store (auto)".');
|
||||
}
|
||||
|
||||
const flyerData: FlyerInsert = {
|
||||
file_name: originalFileName,
|
||||
image_url: `/flyer-images/${path.basename(firstImage)}`,
|
||||
icon_url: `/flyer-images/icons/${iconFileName}`,
|
||||
checksum,
|
||||
store_name: storeName,
|
||||
valid_from: extractedData.valid_from,
|
||||
valid_to: extractedData.valid_to,
|
||||
store_address: extractedData.store_address, // The number of items is now calculated directly from the transformed data.
|
||||
item_count: itemsForDb.length,
|
||||
uploaded_by: userId,
|
||||
status: needsReview ? 'needs_review' : 'processed',
|
||||
};
|
||||
|
||||
logger.info(
|
||||
{ itemCount: itemsForDb.length, storeName: flyerData.store_name },
|
||||
'Data transformation complete.',
|
||||
);
|
||||
|
||||
return { flyerData, itemsForDb };
|
||||
} catch (err) {
|
||||
logger.error({ err }, 'Transformation process failed');
|
||||
// Wrap and rethrow with the new error class
|
||||
throw new TransformationError('Flyer Data Transformation Failed');
|
||||
}
|
||||
|
||||
const flyerData: FlyerInsert = {
|
||||
file_name: originalFileName,
|
||||
image_url: `/flyer-images/${path.basename(firstImage)}`,
|
||||
icon_url: `/flyer-images/icons/${iconFileName}`,
|
||||
checksum,
|
||||
store_name: storeName,
|
||||
valid_from: extractedData.valid_from,
|
||||
valid_to: extractedData.valid_to,
|
||||
store_address: extractedData.store_address, // The number of items is now calculated directly from the transformed data.
|
||||
item_count: itemsForDb.length,
|
||||
uploaded_by: userId,
|
||||
status: needsReview ? 'needs_review' : 'processed',
|
||||
};
|
||||
|
||||
logger.info(
|
||||
{ itemCount: itemsForDb.length, storeName: flyerData.store_name },
|
||||
'Data transformation complete.',
|
||||
);
|
||||
|
||||
return { flyerData, itemsForDb };
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,12 +1,8 @@
|
||||
// src/services/flyerProcessingService.server.test.ts
|
||||
import { describe, it, expect, vi, beforeEach, type Mocked } from 'vitest';
|
||||
import sharp from 'sharp';
|
||||
import { Job, UnrecoverableError } from 'bullmq';
|
||||
import type { Dirent } from 'node:fs';
|
||||
import type { Logger } from 'pino';
|
||||
import { z } from 'zod';
|
||||
import { AiFlyerDataSchema } from './flyerAiProcessor.server';
|
||||
import type { Flyer, FlyerInsert, FlyerItemInsert } from '../types';
|
||||
import { AiFlyerDataSchema } from '../types/ai';
|
||||
import type { FlyerInsert } from '../types';
|
||||
import type { CleanupJobData, FlyerJobData } from '../types/job-data';
|
||||
|
||||
// 1. Create hoisted mocks FIRST
|
||||
|
||||
@@ -203,6 +203,14 @@ export class FlyerProcessingService {
|
||||
logger: Logger,
|
||||
initialStages: ProcessingStage[],
|
||||
): Promise<never> {
|
||||
// Map specific error codes to their corresponding processing stage names.
|
||||
// This is more maintainable than a long if/else if chain.
|
||||
const errorCodeToStageMap = new Map<string, string>([
|
||||
['PDF_CONVERSION_FAILED', 'Preparing Inputs'],
|
||||
['UNSUPPORTED_FILE_TYPE', 'Preparing Inputs'],
|
||||
['AI_VALIDATION_FAILED', 'Extracting Data with AI'],
|
||||
['TRANSFORMATION_FAILED', 'Transforming AI Data'], // Add new mapping
|
||||
]);
|
||||
const normalizedError = error instanceof Error ? error : new Error(String(error));
|
||||
let errorPayload: { errorCode: string; message: string; [key: string]: any };
|
||||
let stagesToReport: ProcessingStage[] = [...initialStages]; // Create a mutable copy
|
||||
@@ -215,16 +223,15 @@ export class FlyerProcessingService {
|
||||
}
|
||||
|
||||
// Determine which stage failed
|
||||
let errorStageIndex = -1;
|
||||
const failedStageName = errorCodeToStageMap.get(errorPayload.errorCode);
|
||||
let errorStageIndex = failedStageName ? stagesToReport.findIndex(s => s.name === failedStageName) : -1;
|
||||
|
||||
// 1. Try to map specific error codes/messages to stages
|
||||
if (errorPayload.errorCode === 'PDF_CONVERSION_FAILED' || errorPayload.errorCode === 'UNSUPPORTED_FILE_TYPE') {
|
||||
errorStageIndex = stagesToReport.findIndex(s => s.name === 'Preparing Inputs');
|
||||
} else if (errorPayload.errorCode === 'AI_VALIDATION_FAILED') {
|
||||
errorStageIndex = stagesToReport.findIndex(s => s.name === 'Extracting Data with AI');
|
||||
} else if (errorPayload.message.includes('Icon generation failed')) {
|
||||
// Fallback for generic errors not in the map. This is less robust and relies on string matching.
|
||||
// A future improvement would be to wrap these in specific FlyerProcessingError subclasses.
|
||||
if (errorStageIndex === -1 && errorPayload.message.includes('Icon generation failed')) {
|
||||
errorStageIndex = stagesToReport.findIndex(s => s.name === 'Transforming AI Data');
|
||||
} else if (errorPayload.message.includes('Database transaction failed')) {
|
||||
}
|
||||
if (errorStageIndex === -1 && errorPayload.message.includes('Database transaction failed')) {
|
||||
errorStageIndex = stagesToReport.findIndex(s => s.name === 'Saving to Database');
|
||||
}
|
||||
|
||||
@@ -260,24 +267,16 @@ export class FlyerProcessingService {
|
||||
|
||||
// Logging logic
|
||||
if (normalizedError instanceof FlyerProcessingError) {
|
||||
const logDetails: Record<string, any> = { err: normalizedError };
|
||||
// Simplify log object creation
|
||||
const logDetails: Record<string, any> = { ...errorPayload, err: normalizedError };
|
||||
|
||||
if (normalizedError instanceof AiDataValidationError) {
|
||||
logDetails.validationErrors = normalizedError.validationErrors;
|
||||
logDetails.rawData = normalizedError.rawData;
|
||||
}
|
||||
// Also include stderr for PdfConversionError in logs
|
||||
if (normalizedError instanceof PdfConversionError) {
|
||||
logDetails.stderr = normalizedError.stderr;
|
||||
}
|
||||
// Include the errorPayload details in the log, but avoid duplicating err, validationErrors, rawData
|
||||
Object.assign(logDetails, errorPayload);
|
||||
// Remove the duplicated err property if it was assigned by Object.assign
|
||||
if ('err' in logDetails && logDetails.err === normalizedError) {
|
||||
// This check prevents accidental deletion if 'err' was a legitimate property of errorPayload
|
||||
delete logDetails.err;
|
||||
}
|
||||
// Ensure the original error object is always passed as 'err' for consistency in logging
|
||||
logDetails.err = normalizedError;
|
||||
|
||||
logger.error(logDetails, `A known processing error occurred: ${normalizedError.name}`);
|
||||
} else {
|
||||
|
||||
@@ -62,6 +62,18 @@ export class AiDataValidationError extends FlyerProcessingError {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Error thrown when a transformation step fails.
|
||||
*/
|
||||
export class TransformationError extends FlyerProcessingError {
|
||||
constructor(message: string) {
|
||||
super(
|
||||
message,
|
||||
'TRANSFORMATION_FAILED',
|
||||
'There was a problem transforming the flyer data. Please check the input.',
|
||||
);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Error thrown when an image conversion fails (e.g., using sharp).
|
||||
*/
|
||||
|
||||
215
src/tests/e2e/auth.e2e.test.ts
Normal file
215
src/tests/e2e/auth.e2e.test.ts
Normal file
@@ -0,0 +1,215 @@
|
||||
// src/tests/e2e/auth.e2e.test.ts
|
||||
import { describe, it, expect, afterAll, beforeAll } from 'vitest';
|
||||
import * as apiClient from '../../services/apiClient';
|
||||
import { cleanupDb } from '../utils/cleanup';
|
||||
import { createAndLoginUser, TEST_PASSWORD } from '../utils/testHelpers';
|
||||
import type { UserProfile } from '../../types';
|
||||
|
||||
/**
|
||||
* @vitest-environment node
|
||||
*/
|
||||
|
||||
describe('Authentication E2E Flow', () => {
|
||||
let testUser: UserProfile;
|
||||
const createdUserIds: string[] = [];
|
||||
|
||||
beforeAll(async () => {
|
||||
// Create a user that can be used for login-related tests in this suite.
|
||||
const { user } = await createAndLoginUser({
|
||||
email: `e2e-login-user-${Date.now()}@example.com`,
|
||||
fullName: 'E2E Login User',
|
||||
// E2E tests use apiClient which doesn't need the `request` object.
|
||||
});
|
||||
testUser = user;
|
||||
createdUserIds.push(user.user.user_id);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
if (createdUserIds.length > 0) {
|
||||
await cleanupDb({ userIds: createdUserIds });
|
||||
}
|
||||
});
|
||||
|
||||
describe('Registration Flow', () => {
|
||||
it('should successfully register a new user', async () => {
|
||||
const email = `e2e-register-success-${Date.now()}@example.com`;
|
||||
const fullName = 'E2E Register User';
|
||||
|
||||
// Act
|
||||
const response = await apiClient.registerUser(email, TEST_PASSWORD, fullName);
|
||||
const data = await response.json();
|
||||
|
||||
// Assert
|
||||
expect(response.status).toBe(201);
|
||||
expect(data.message).toBe('User registered successfully!');
|
||||
expect(data.userprofile).toBeDefined();
|
||||
expect(data.userprofile.user.email).toBe(email);
|
||||
expect(data.token).toBeTypeOf('string');
|
||||
|
||||
// Add to cleanup
|
||||
createdUserIds.push(data.userprofile.user.user_id);
|
||||
});
|
||||
|
||||
it('should fail to register a user with a weak password', async () => {
|
||||
const email = `e2e-register-weakpass-${Date.now()}@example.com`;
|
||||
const weakPassword = '123';
|
||||
|
||||
// Act
|
||||
const response = await apiClient.registerUser(email, weakPassword, 'Weak Pass User');
|
||||
const errorData = await response.json();
|
||||
|
||||
// Assert
|
||||
expect(response.status).toBe(400);
|
||||
expect(errorData.errors[0].message).toContain('Password must be at least 8 characters long.');
|
||||
});
|
||||
|
||||
it('should fail to register a user with a duplicate email', async () => {
|
||||
const email = `e2e-register-duplicate-${Date.now()}@example.com`;
|
||||
|
||||
// Act 1: Register the user successfully
|
||||
const firstResponse = await apiClient.registerUser(email, TEST_PASSWORD, 'Duplicate User');
|
||||
const firstData = await firstResponse.json();
|
||||
expect(firstResponse.status).toBe(201);
|
||||
createdUserIds.push(firstData.userprofile.user.user_id); // Add for cleanup
|
||||
|
||||
// Act 2: Attempt to register the same user again
|
||||
const secondResponse = await apiClient.registerUser(email, TEST_PASSWORD, 'Duplicate User');
|
||||
const errorData = await secondResponse.json();
|
||||
|
||||
// Assert
|
||||
expect(secondResponse.status).toBe(409); // Conflict
|
||||
expect(errorData.message).toContain('A user with this email address already exists.');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Login Flow', () => {
|
||||
it('should successfully log in a registered user', async () => {
|
||||
// Act: Attempt to log in with the user created in beforeAll
|
||||
const response = await apiClient.loginUser(testUser.user.email, TEST_PASSWORD, false);
|
||||
const data = await response.json();
|
||||
|
||||
// Assert
|
||||
expect(response.status).toBe(200);
|
||||
expect(data.userprofile).toBeDefined();
|
||||
expect(data.userprofile.user.email).toBe(testUser.user.email);
|
||||
expect(data.token).toBeTypeOf('string');
|
||||
});
|
||||
|
||||
it('should fail to log in with an incorrect password', async () => {
|
||||
// Act: Attempt to log in with the wrong password
|
||||
const response = await apiClient.loginUser(testUser.user.email, 'wrong-password', false);
|
||||
const errorData = await response.json();
|
||||
|
||||
// Assert
|
||||
expect(response.status).toBe(401);
|
||||
expect(errorData.message).toBe('Incorrect email or password.');
|
||||
});
|
||||
|
||||
it('should fail to log in with a non-existent email', async () => {
|
||||
const response = await apiClient.loginUser('no-one-here@example.com', TEST_PASSWORD, false);
|
||||
const errorData = await response.json();
|
||||
|
||||
expect(response.status).toBe(401);
|
||||
expect(errorData.message).toBe('Incorrect email or password.');
|
||||
});
|
||||
|
||||
it('should be able to access a protected route after logging in', async () => {
|
||||
// Arrange: Log in to get a token
|
||||
const loginResponse = await apiClient.loginUser(testUser.user.email, TEST_PASSWORD, false);
|
||||
const loginData = await loginResponse.json();
|
||||
const token = loginData.token;
|
||||
|
||||
expect(loginResponse.status).toBe(200);
|
||||
expect(token).toBeDefined();
|
||||
|
||||
// Act: Use the token to access a protected route
|
||||
const profileResponse = await apiClient.getAuthenticatedUserProfile({ tokenOverride: token });
|
||||
const profileData = await profileResponse.json();
|
||||
|
||||
// Assert
|
||||
expect(profileResponse.status).toBe(200);
|
||||
expect(profileData).toBeDefined();
|
||||
expect(profileData.user.user_id).toBe(testUser.user.user_id);
|
||||
expect(profileData.user.email).toBe(testUser.user.email);
|
||||
expect(profileData.role).toBe('user');
|
||||
});
|
||||
|
||||
it('should allow an authenticated user to update their profile', async () => {
|
||||
// Arrange: Log in to get a token
|
||||
const loginResponse = await apiClient.loginUser(testUser.user.email, TEST_PASSWORD, false);
|
||||
const loginData = await loginResponse.json();
|
||||
const token = loginData.token;
|
||||
expect(loginResponse.status).toBe(200);
|
||||
|
||||
const profileUpdates = {
|
||||
full_name: 'E2E Updated Name',
|
||||
avatar_url: 'https://www.projectium.com/updated-avatar.png',
|
||||
};
|
||||
|
||||
// Act: Call the update endpoint
|
||||
const updateResponse = await apiClient.updateUserProfile(profileUpdates, { tokenOverride: token });
|
||||
const updatedProfileData = await updateResponse.json();
|
||||
|
||||
// Assert: Check the response from the update call
|
||||
expect(updateResponse.status).toBe(200);
|
||||
expect(updatedProfileData.full_name).toBe(profileUpdates.full_name);
|
||||
expect(updatedProfileData.avatar_url).toBe(profileUpdates.avatar_url);
|
||||
|
||||
// Act 2: Fetch the profile again to verify persistence
|
||||
const verifyResponse = await apiClient.getAuthenticatedUserProfile({ tokenOverride: token });
|
||||
const verifiedProfileData = await verifyResponse.json();
|
||||
|
||||
// Assert 2: Check the fetched data
|
||||
expect(verifiedProfileData.full_name).toBe(profileUpdates.full_name);
|
||||
expect(verifiedProfileData.avatar_url).toBe(profileUpdates.avatar_url);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Forgot/Reset Password Flow', () => {
|
||||
it('should allow a user to reset their password and log in with the new one', async () => {
|
||||
// Arrange: Create a user to reset the password for
|
||||
const email = `e2e-reset-pass-${Date.now()}@example.com`;
|
||||
const registerResponse = await apiClient.registerUser(email, TEST_PASSWORD, 'Reset Pass User');
|
||||
const registerData = await registerResponse.json();
|
||||
expect(registerResponse.status).toBe(201);
|
||||
createdUserIds.push(registerData.userprofile.user.user_id);
|
||||
|
||||
// Act 1: Request a password reset.
|
||||
// The test environment returns the token directly in the response for E2E testing.
|
||||
const forgotResponse = await apiClient.requestPasswordReset(email);
|
||||
const forgotData = await forgotResponse.json();
|
||||
const resetToken = forgotData.token;
|
||||
|
||||
// Assert 1: Check that we received a token.
|
||||
expect(forgotResponse.status).toBe(200);
|
||||
expect(resetToken).toBeDefined();
|
||||
expect(resetToken).toBeTypeOf('string');
|
||||
|
||||
// Act 2: Use the token to set a new password.
|
||||
const newPassword = 'my-new-e2e-password-!@#$';
|
||||
const resetResponse = await apiClient.resetPassword(resetToken, newPassword);
|
||||
const resetData = await resetResponse.json();
|
||||
|
||||
// Assert 2: Check for a successful password reset message.
|
||||
expect(resetResponse.status).toBe(200);
|
||||
expect(resetData.message).toBe('Password has been reset successfully.');
|
||||
|
||||
// Act 3 & Assert 3 (Verification): Log in with the NEW password to confirm the change.
|
||||
const loginResponse = await apiClient.loginUser(email, newPassword, false);
|
||||
const loginData = await loginResponse.json();
|
||||
|
||||
expect(loginResponse.status).toBe(200);
|
||||
expect(loginData.userprofile).toBeDefined();
|
||||
expect(loginData.userprofile.user.email).toBe(email);
|
||||
});
|
||||
|
||||
it('should return a generic success message for a non-existent email to prevent enumeration', async () => {
|
||||
const nonExistentEmail = `non-existent-e2e-${Date.now()}@example.com`;
|
||||
const response = await apiClient.requestPasswordReset(nonExistentEmail);
|
||||
const data = await response.json();
|
||||
expect(response.status).toBe(200);
|
||||
expect(data.message).toBe('If an account with that email exists, a password reset link has been sent.');
|
||||
expect(data.token).toBeUndefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -21,16 +21,18 @@ const request = supertest(app);
|
||||
describe('Authentication API Integration', () => {
|
||||
let testUserEmail: string;
|
||||
let testUser: UserProfile;
|
||||
const createdUserIds: string[] = [];
|
||||
|
||||
beforeAll(async () => {
|
||||
// Use a unique email for this test suite to prevent collisions with other tests.
|
||||
const email = `auth-integration-test-${Date.now()}@example.com`;
|
||||
({ user: testUser } = await createAndLoginUser({ email, fullName: 'Auth Test User', request }));
|
||||
testUserEmail = testUser.user.email;
|
||||
createdUserIds.push(testUser.user.user_id);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await cleanupDb({ userIds: testUser ? [testUser.user.user_id] : [] });
|
||||
await cleanupDb({ userIds: createdUserIds });
|
||||
});
|
||||
|
||||
// This test migrates the logic from the old DevTestRunner.tsx component.
|
||||
@@ -83,6 +85,38 @@ describe('Authentication API Integration', () => {
|
||||
expect(errorData.message).toBe('Incorrect email or password.');
|
||||
});
|
||||
|
||||
it('should allow registration with an empty string for avatar_url and save it as null', async () => {
|
||||
// Arrange: Define user data with an empty avatar_url.
|
||||
const email = `empty-avatar-user-${Date.now()}@example.com`;
|
||||
const userData = {
|
||||
email,
|
||||
password: TEST_PASSWORD,
|
||||
full_name: 'Empty Avatar',
|
||||
avatar_url: '',
|
||||
};
|
||||
|
||||
// Act: Register the new user.
|
||||
const registerResponse = await request.post('/api/auth/register').send(userData);
|
||||
|
||||
// Assert 1: Check that the registration was successful and the returned profile is correct.
|
||||
expect(registerResponse.status).toBe(201);
|
||||
const registeredProfile = registerResponse.body.userprofile;
|
||||
const registeredToken = registerResponse.body.token;
|
||||
expect(registeredProfile.user.email).toBe(email);
|
||||
expect(registeredProfile.avatar_url).toBeNull(); // The API should return null for the avatar_url.
|
||||
|
||||
// Add the newly created user's ID to the array for cleanup in afterAll.
|
||||
createdUserIds.push(registeredProfile.user.user_id);
|
||||
|
||||
// Assert 2 (Verification): Fetch the profile using the new token to confirm the value in the DB is null.
|
||||
const profileResponse = await request
|
||||
.get('/api/users/profile')
|
||||
.set('Authorization', `Bearer ${registeredToken}`);
|
||||
|
||||
expect(profileResponse.status).toBe(200);
|
||||
expect(profileResponse.body.avatar_url).toBeNull();
|
||||
});
|
||||
|
||||
it('should successfully refresh an access token using a refresh token cookie', async () => {
|
||||
// Arrange: Log in to get a fresh, valid refresh token cookie for this specific test.
|
||||
// This ensures the test is self-contained and not affected by other tests.
|
||||
|
||||
@@ -75,6 +75,32 @@ describe('User API Routes Integration Tests', () => {
|
||||
expect(refetchedProfile.full_name).toBe('Updated Test User');
|
||||
});
|
||||
|
||||
it('should allow updating the profile with an empty string for avatar_url', async () => {
|
||||
// Arrange: Define the profile updates.
|
||||
const profileUpdates = {
|
||||
full_name: 'Empty Avatar User',
|
||||
avatar_url: '',
|
||||
};
|
||||
|
||||
// Act: Call the update endpoint with the new data and the auth token.
|
||||
const response = await request
|
||||
.put('/api/users/profile')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send(profileUpdates);
|
||||
const updatedProfile = response.body;
|
||||
|
||||
// Assert: Check that the returned profile reflects the changes.
|
||||
expect(response.status).toBe(200);
|
||||
expect(updatedProfile.full_name).toBe('Empty Avatar User');
|
||||
expect(updatedProfile.avatar_url).toBeNull();
|
||||
|
||||
// Also, fetch the profile again to ensure the change was persisted in the database as NULL.
|
||||
const refetchResponse = await request
|
||||
.get('/api/users/profile')
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
expect(refetchResponse.body.avatar_url).toBeNull();
|
||||
});
|
||||
|
||||
it('should update user preferences via PUT /api/users/profile/preferences', async () => {
|
||||
// Arrange: Define the preference updates.
|
||||
const preferenceUpdates = {
|
||||
|
||||
@@ -12,11 +12,11 @@ import { cleanupDb } from '../utils/cleanup';
|
||||
|
||||
const request = supertest(app);
|
||||
|
||||
let authToken = '';
|
||||
let createdListId: number;
|
||||
let testUser: UserProfile;
|
||||
|
||||
describe('User Routes Integration Tests (/api/users)', () => {
|
||||
let authToken = '';
|
||||
let testUser: UserProfile;
|
||||
const createdUserIds: string[] = [];
|
||||
|
||||
// Authenticate once before all tests in this suite to get a JWT.
|
||||
beforeAll(async () => {
|
||||
// Use the helper to create and log in a user in one step.
|
||||
@@ -26,10 +26,11 @@ describe('User Routes Integration Tests (/api/users)', () => {
|
||||
});
|
||||
testUser = user;
|
||||
authToken = token;
|
||||
createdUserIds.push(user.user.user_id);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await cleanupDb({ userIds: testUser ? [testUser.user.user_id] : [] });
|
||||
await cleanupDb({ userIds: createdUserIds });
|
||||
});
|
||||
|
||||
describe('GET /api/users/profile', () => {
|
||||
@@ -70,54 +71,6 @@ describe('User Routes Integration Tests (/api/users)', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('Shopping List CRUD', () => {
|
||||
it('POST /api/users/shopping-lists should create a new shopping list', async () => {
|
||||
const listName = `My Integration Test List ${Date.now()}`;
|
||||
const response = await request
|
||||
.post('/api/users/shopping-lists')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ name: listName });
|
||||
|
||||
expect(response.status).toBe(201);
|
||||
expect(response.body.name).toBe(listName);
|
||||
expect(response.body.shopping_list_id).toBeDefined();
|
||||
createdListId = response.body.shopping_list_id; // Save for the next test
|
||||
});
|
||||
|
||||
it('GET /api/users/shopping-lists should retrieve the created shopping list', async () => {
|
||||
const response = await request
|
||||
.get('/api/users/shopping-lists')
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
expect(Array.isArray(response.body)).toBe(true);
|
||||
const foundList = response.body.find(
|
||||
(list: { shopping_list_id: number }) => list.shopping_list_id === createdListId,
|
||||
);
|
||||
expect(foundList).toBeDefined();
|
||||
});
|
||||
|
||||
it('DELETE /api/users/shopping-lists/:listId should delete the shopping list', async () => {
|
||||
expect(createdListId).toBeDefined(); // Ensure the previous test ran and set the ID
|
||||
|
||||
const response = await request
|
||||
.delete(`/api/users/shopping-lists/${createdListId}`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(response.status).toBe(204);
|
||||
|
||||
// Verify deletion
|
||||
const verifyResponse = await request
|
||||
.get('/api/users/shopping-lists')
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
const foundList = verifyResponse.body.find(
|
||||
(list: { shopping_list_id: number }) => list.shopping_list_id === createdListId,
|
||||
);
|
||||
expect(foundList).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('PUT /api/users/profile/preferences', () => {
|
||||
it('should update user preferences', async () => {
|
||||
const preferences = { darkMode: true, unitSystem: 'metric' };
|
||||
@@ -138,4 +91,164 @@ describe('User Routes Integration Tests (/api/users)', () => {
|
||||
expect(verifyResponse.body.preferences?.unitSystem).toBe('metric');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Shopping Lists and Items', () => {
|
||||
it('should create, retrieve, and delete a shopping list', async () => {
|
||||
// 1. Create
|
||||
const listName = `My Test List - ${Date.now()}`;
|
||||
const createResponse = await request
|
||||
.post('/api/users/shopping-lists')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ name: listName });
|
||||
|
||||
expect(createResponse.status).toBe(201);
|
||||
expect(createResponse.body.name).toBe(listName);
|
||||
const listId = createResponse.body.shopping_list_id;
|
||||
expect(listId).toBeDefined();
|
||||
|
||||
// 2. Retrieve
|
||||
const getResponse = await request
|
||||
.get('/api/users/shopping-lists')
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(getResponse.status).toBe(200);
|
||||
const foundList = getResponse.body.find(
|
||||
(l: { shopping_list_id: number }) => l.shopping_list_id === listId,
|
||||
);
|
||||
expect(foundList).toBeDefined();
|
||||
|
||||
// 3. Delete
|
||||
const deleteResponse = await request
|
||||
.delete(`/api/users/shopping-lists/${listId}`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
expect(deleteResponse.status).toBe(204);
|
||||
|
||||
// 4. Verify Deletion
|
||||
const verifyResponse = await request
|
||||
.get('/api/users/shopping-lists')
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
const notFoundList = verifyResponse.body.find(
|
||||
(l: { shopping_list_id: number }) => l.shopping_list_id === listId,
|
||||
);
|
||||
expect(notFoundList).toBeUndefined();
|
||||
});
|
||||
|
||||
it("should prevent a user from modifying another user's shopping list", async () => {
|
||||
// Arrange: Create a shopping list owned by the primary testUser.
|
||||
const listName = `Owner's List - ${Date.now()}`;
|
||||
const createListResponse = await request
|
||||
.post('/api/users/shopping-lists')
|
||||
.set('Authorization', `Bearer ${authToken}`) // Use owner's token
|
||||
.send({ name: listName });
|
||||
expect(createListResponse.status).toBe(201);
|
||||
const listId = createListResponse.body.shopping_list_id;
|
||||
|
||||
// Arrange: Create a second, "malicious" user.
|
||||
const maliciousEmail = `malicious-user-${Date.now()}@example.com`;
|
||||
const { token: maliciousToken, user: maliciousUser } = await createAndLoginUser({
|
||||
email: maliciousEmail,
|
||||
fullName: 'Malicious User',
|
||||
request,
|
||||
});
|
||||
createdUserIds.push(maliciousUser.user.user_id); // Ensure cleanup
|
||||
|
||||
// Act 1: Malicious user attempts to add an item to the owner's list.
|
||||
const addItemResponse = await request
|
||||
.post(`/api/users/shopping-lists/${listId}/items`)
|
||||
.set('Authorization', `Bearer ${maliciousToken}`) // Use malicious user's token
|
||||
.send({ customItemName: 'Malicious Item' });
|
||||
|
||||
// Assert 1: The request should fail. A 404 is expected because the list is not found for this user.
|
||||
expect(addItemResponse.status).toBe(404);
|
||||
expect(addItemResponse.body.message).toContain('Shopping list not found');
|
||||
|
||||
// Act 2: Malicious user attempts to delete the owner's list.
|
||||
const deleteResponse = await request
|
||||
.delete(`/api/users/shopping-lists/${listId}`)
|
||||
.set('Authorization', `Bearer ${maliciousToken}`); // Use malicious user's token
|
||||
|
||||
// Assert 2: This should also fail with a 404.
|
||||
expect(deleteResponse.status).toBe(404);
|
||||
expect(deleteResponse.body.message).toContain('Shopping list not found');
|
||||
|
||||
// Act 3: Malicious user attempts to update an item on the owner's list.
|
||||
// First, the owner adds an item.
|
||||
const ownerAddItemResponse = await request
|
||||
.post(`/api/users/shopping-lists/${listId}/items`)
|
||||
.set('Authorization', `Bearer ${authToken}`) // Owner's token
|
||||
.send({ customItemName: 'Legitimate Item' });
|
||||
expect(ownerAddItemResponse.status).toBe(201);
|
||||
const itemId = ownerAddItemResponse.body.shopping_list_item_id;
|
||||
|
||||
// Now, the malicious user tries to update it.
|
||||
const updateItemResponse = await request
|
||||
.put(`/api/users/shopping-lists/items/${itemId}`)
|
||||
.set('Authorization', `Bearer ${maliciousToken}`) // Malicious token
|
||||
.send({ is_purchased: true });
|
||||
|
||||
// Assert 3: This should also fail with a 404.
|
||||
expect(updateItemResponse.status).toBe(404);
|
||||
expect(updateItemResponse.body.message).toContain('Shopping list item not found');
|
||||
|
||||
// Cleanup the list created in this test
|
||||
await request
|
||||
.delete(`/api/users/shopping-lists/${listId}`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Shopping List Item Management', () => {
|
||||
let listId: number;
|
||||
let itemId: number;
|
||||
|
||||
// Create a dedicated list for these item tests
|
||||
beforeAll(async () => {
|
||||
const response = await request
|
||||
.post('/api/users/shopping-lists')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ name: 'Item Test List' });
|
||||
listId = response.body.shopping_list_id;
|
||||
});
|
||||
|
||||
// Clean up the list after the item tests are done
|
||||
afterAll(async () => {
|
||||
if (listId) {
|
||||
await request
|
||||
.delete(`/api/users/shopping-lists/${listId}`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
}
|
||||
});
|
||||
|
||||
it('should add an item to a shopping list', async () => {
|
||||
const response = await request
|
||||
.post(`/api/users/shopping-lists/${listId}/items`)
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ customItemName: 'Test Item' });
|
||||
|
||||
expect(response.status).toBe(201);
|
||||
expect(response.body.custom_item_name).toBe('Test Item');
|
||||
expect(response.body.shopping_list_item_id).toBeDefined();
|
||||
itemId = response.body.shopping_list_item_id; // Save for next tests
|
||||
});
|
||||
|
||||
it('should update an item in a shopping list', async () => {
|
||||
const updates = { is_purchased: true, quantity: 5 };
|
||||
const response = await request
|
||||
.put(`/api/users/shopping-lists/items/${itemId}`)
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send(updates);
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
expect(response.body.is_purchased).toBe(true);
|
||||
expect(response.body.quantity).toBe(5);
|
||||
});
|
||||
|
||||
it('should delete an item from a shopping list', async () => {
|
||||
const response = await request
|
||||
.delete(`/api/users/shopping-lists/items/${itemId}`)
|
||||
.set('Authorization', `Bearer ${authToken}`);
|
||||
|
||||
expect(response.status).toBe(204);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
75
src/types.ts
75
src/types.ts
@@ -101,6 +101,8 @@ export interface MasterGroceryItem {
|
||||
export interface Category {
|
||||
category_id: number;
|
||||
name: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface Brand {
|
||||
@@ -216,6 +218,7 @@ export interface UserAlert {
|
||||
threshold_value: number;
|
||||
is_active: boolean;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface Notification {
|
||||
@@ -263,16 +266,20 @@ export interface UserSubmittedPrice {
|
||||
upvotes: number;
|
||||
downvotes: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface ItemPriceHistory {
|
||||
item_price_history_id: number;
|
||||
master_item_id: number;
|
||||
summary_date: string; // DATE
|
||||
store_location_id?: number | null;
|
||||
min_price_in_cents?: number | null;
|
||||
max_price_in_cents?: number | null;
|
||||
avg_price_in_cents?: number | null;
|
||||
data_points_count: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -289,6 +296,8 @@ export interface MasterItemAlias {
|
||||
master_item_alias_id: number;
|
||||
master_item_id: number;
|
||||
alias: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface Recipe {
|
||||
@@ -322,6 +331,8 @@ export interface RecipeIngredient {
|
||||
master_item_id: number;
|
||||
quantity: number;
|
||||
unit: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface RecipeIngredientSubstitution {
|
||||
@@ -329,16 +340,22 @@ export interface RecipeIngredientSubstitution {
|
||||
recipe_ingredient_id: number;
|
||||
substitute_master_item_id: number;
|
||||
notes?: string | null;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface Tag {
|
||||
tag_id: number;
|
||||
name: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface RecipeTag {
|
||||
recipe_id: number;
|
||||
tag_id: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface RecipeRating {
|
||||
@@ -348,6 +365,7 @@ export interface RecipeRating {
|
||||
rating: number;
|
||||
comment?: string | null;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface RecipeComment {
|
||||
@@ -370,6 +388,7 @@ export interface MenuPlan {
|
||||
start_date: string; // DATE
|
||||
end_date: string; // DATE
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
planned_meals?: PlannedMeal[];
|
||||
}
|
||||
|
||||
@@ -380,6 +399,7 @@ export interface SharedMenuPlan {
|
||||
shared_with_user_id: string; // UUID
|
||||
permission_level: 'view' | 'edit';
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface PlannedMeal {
|
||||
@@ -389,6 +409,8 @@ export interface PlannedMeal {
|
||||
plan_date: string; // DATE
|
||||
meal_type: string;
|
||||
servings_to_cook?: number | null;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface PantryItem {
|
||||
@@ -408,18 +430,22 @@ export interface UserItemAlias {
|
||||
user_id: string; // UUID
|
||||
master_item_id: number;
|
||||
alias: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface FavoriteRecipe {
|
||||
user_id: string; // UUID
|
||||
recipe_id: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface FavoriteStore {
|
||||
user_id: string; // UUID
|
||||
store_id: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface RecipeCollection {
|
||||
@@ -428,12 +454,14 @@ export interface RecipeCollection {
|
||||
name: string;
|
||||
description?: string | null;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface RecipeCollectionItem {
|
||||
collection_id: number;
|
||||
recipe_id: number;
|
||||
added_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface SharedShoppingList {
|
||||
@@ -443,6 +471,7 @@ export interface SharedShoppingList {
|
||||
shared_with_user_id: string; // UUID
|
||||
permission_level: 'view' | 'edit';
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface SharedRecipeCollection {
|
||||
@@ -451,38 +480,51 @@ export interface SharedRecipeCollection {
|
||||
shared_by_user_id: string; // UUID
|
||||
shared_with_user_id: string; // UUID
|
||||
permission_level: 'view' | 'edit';
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface DietaryRestriction {
|
||||
dietary_restriction_id: number;
|
||||
name: string;
|
||||
type: 'diet' | 'allergy';
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface UserDietaryRestriction {
|
||||
user_id: string; // UUID
|
||||
restriction_id: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface Appliance {
|
||||
appliance_id: number;
|
||||
name: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface UserAppliance {
|
||||
user_id: string; // UUID
|
||||
appliance_id: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface RecipeAppliance {
|
||||
recipe_id: number;
|
||||
appliance_id: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface UserFollow {
|
||||
follower_id: string; // UUID
|
||||
following_id: string; // UUID
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
/**
|
||||
* The list of possible actions for an activity log.
|
||||
@@ -569,6 +611,8 @@ export interface PantryLocation {
|
||||
pantry_location_id: number;
|
||||
user_id: string; // UUID
|
||||
name: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface SearchQuery {
|
||||
@@ -578,6 +622,7 @@ export interface SearchQuery {
|
||||
result_count?: number | null;
|
||||
was_successful?: boolean | null;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface ShoppingTripItem {
|
||||
@@ -587,6 +632,8 @@ export interface ShoppingTripItem {
|
||||
custom_item_name?: string | null;
|
||||
quantity: number;
|
||||
price_paid_cents?: number | null;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
// Joined data for display
|
||||
master_item_name?: string | null;
|
||||
}
|
||||
@@ -597,6 +644,7 @@ export interface ShoppingTrip {
|
||||
shopping_list_id?: number | null;
|
||||
completed_at: string;
|
||||
total_spent_cents?: number | null;
|
||||
updated_at: string;
|
||||
items: ShoppingTripItem[]; // Nested items
|
||||
}
|
||||
|
||||
@@ -611,6 +659,7 @@ export interface Receipt {
|
||||
raw_text?: string | null;
|
||||
created_at: string;
|
||||
processed_at?: string | null;
|
||||
updated_at: string;
|
||||
items?: ReceiptItem[];
|
||||
}
|
||||
|
||||
@@ -623,6 +672,8 @@ export interface ReceiptItem {
|
||||
master_item_id?: number | null;
|
||||
product_id?: number | null;
|
||||
status: 'unmatched' | 'matched' | 'needs_review' | 'ignored';
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface ReceiptDeal {
|
||||
@@ -649,6 +700,8 @@ export interface StoreLocation {
|
||||
store_location_id: number;
|
||||
store_id?: number | null;
|
||||
address_id: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface Address {
|
||||
@@ -669,6 +722,8 @@ export interface Address {
|
||||
export interface FlyerLocation {
|
||||
flyer_id: number;
|
||||
store_location_id: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export enum AnalysisType {
|
||||
@@ -965,3 +1020,23 @@ export interface PriceHistoryData {
|
||||
price_in_cents: number;
|
||||
date: string; // ISO date string
|
||||
}
|
||||
|
||||
export interface UserReaction {
|
||||
reaction_id: number;
|
||||
user_id: string; // UUID
|
||||
entity_type: string;
|
||||
entity_id: string;
|
||||
reaction_type: string;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
export interface UnitConversion {
|
||||
unit_conversion_id: number;
|
||||
master_item_id: number;
|
||||
from_unit: string;
|
||||
to_unit: string;
|
||||
factor: number;
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
|
||||
29
src/types/ai.ts
Normal file
29
src/types/ai.ts
Normal file
@@ -0,0 +1,29 @@
|
||||
// src/types/ai.ts
|
||||
|
||||
import { z } from 'zod';
|
||||
|
||||
// Helper for consistent required string validation (handles missing/null/empty)
|
||||
// This is moved here as it's directly related to the schemas.
|
||||
export const requiredString = (message: string) =>
|
||||
z.preprocess((val) => val ?? '', z.string().min(1, message));
|
||||
|
||||
// --- Zod Schemas for AI Response Validation ---
|
||||
// These schemas define the expected structure of data returned by the AI.
|
||||
// They are used for validation and type inference across multiple services.
|
||||
|
||||
export const ExtractedFlyerItemSchema = z.object({
|
||||
item: z.string().nullable(),
|
||||
price_display: z.string().nullable(),
|
||||
price_in_cents: z.number().nullable(),
|
||||
quantity: z.string().nullable(),
|
||||
category_name: z.string().nullable(),
|
||||
master_item_id: z.number().nullish(), // .nullish() allows null or undefined
|
||||
});
|
||||
|
||||
export const AiFlyerDataSchema = z.object({
|
||||
store_name: z.string().nullable(),
|
||||
valid_from: z.string().nullable(),
|
||||
valid_to: z.string().nullable(),
|
||||
store_address: z.string().nullable(),
|
||||
items: z.array(ExtractedFlyerItemSchema),
|
||||
});
|
||||
Reference in New Issue
Block a user