Compare commits

...

52 Commits

Author SHA1 Message Date
Gitea Actions
b1fae270bb ci: Bump version to 0.8.0 for production release [skip ci] 2026-01-03 05:48:40 +05:00
Gitea Actions
c852483e18 ci: Bump version to 0.7.29 [skip ci] 2026-01-03 02:43:54 +05:00
2e01ad5bc9 more test fixin
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 13m50s
2026-01-02 13:43:20 -08:00
Gitea Actions
26763c7183 ci: Bump version to 0.7.28 [skip ci] 2026-01-03 02:04:26 +05:00
f0c5c2c45b more test fixin
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 12m40s
2026-01-02 13:03:25 -08:00
Gitea Actions
034bb60fd5 ci: Bump version to 0.7.27 [skip ci] 2026-01-03 01:31:54 +05:00
d4b389cb79 more test fixin
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 16m39s
2026-01-02 12:31:19 -08:00
Gitea Actions
a71fb81468 ci: Bump version to 0.7.26 [skip ci] 2026-01-03 00:58:34 +05:00
9bee0a013b unit test auto-provider refactor
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 17m8s
2026-01-02 11:58:03 -08:00
Gitea Actions
8bcb4311b3 ci: Bump version to 0.7.25 [skip ci] 2026-01-03 00:34:45 +05:00
9fd15f3a50 unit test auto-provider refactor
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 19m58s
2026-01-02 11:33:11 -08:00
Gitea Actions
e3c876c7be ci: Bump version to 0.7.24 [skip ci] 2026-01-02 23:23:21 +05:00
32dcf3b89e unit test auto-provider refactor
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 21m2s
2026-01-02 10:22:27 -08:00
7066b937f6 unit test auto-provider refactor 2026-01-02 10:17:01 -08:00
Gitea Actions
8553ea8811 ci: Bump version to 0.7.23 [skip ci] 2026-01-02 12:13:43 +05:00
19885a50f7 unit test auto-provider refactor
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 13m30s
2026-01-01 23:12:32 -08:00
Gitea Actions
ce82034b9d ci: Bump version to 0.7.22 [skip ci] 2026-01-02 07:30:53 +05:00
4528da2934 integration test fixes + added new ai models and recipeSuggestion
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 13m36s
2026-01-01 18:30:03 -08:00
Gitea Actions
146d4c1351 ci: Bump version to 0.7.21 [skip ci] 2026-01-02 03:37:22 +05:00
88625706f4 integration test fixes + added new ai models and recipeSuggestion
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 13m3s
2026-01-01 14:36:43 -08:00
Gitea Actions
e395faed30 ci: Bump version to 0.7.20 [skip ci] 2026-01-02 01:40:18 +05:00
e8f8399896 integration test fixes
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 12m11s
2026-01-01 12:30:03 -08:00
Gitea Actions
ac0115af2b ci: Bump version to 0.7.19 [skip ci] 2026-01-02 00:55:57 +05:00
f24b15f19b integration test fixes
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 14m22s
2026-01-01 11:55:26 -08:00
Gitea Actions
e64426bd84 ci: Bump version to 0.7.18 [skip ci] 2026-01-02 00:35:49 +05:00
0ec4cd68d2 integration test fixes
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 17m25s
2026-01-01 11:35:23 -08:00
Gitea Actions
840516d2a3 ci: Bump version to 0.7.17 [skip ci] 2026-01-02 00:29:45 +05:00
59355c3eef integration test fixes
Some checks failed
Deploy to Test Environment / deploy-to-test (push) Failing after 39s
2026-01-01 11:29:10 -08:00
d024935fe9 integration test fixes 2026-01-01 11:18:27 -08:00
Gitea Actions
5a5470634e ci: Bump version to 0.7.16 [skip ci] 2026-01-01 23:07:19 +05:00
392231ad63 more db
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 19m34s
2026-01-01 10:06:49 -08:00
Gitea Actions
4b1c896621 ci: Bump version to 0.7.15 [skip ci] 2026-01-01 22:33:18 +05:00
720920a51c more db
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 20m35s
2026-01-01 09:31:49 -08:00
Gitea Actions
460adb9506 ci: Bump version to 0.7.14 [skip ci] 2026-01-01 16:08:43 +05:00
7aa1f756a9 more db
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 10m26s
2026-01-01 03:08:02 -08:00
Gitea Actions
c484a8ca9b ci: Bump version to 0.7.13 [skip ci] 2026-01-01 15:58:33 +05:00
28d2c9f4ec more db
Some checks failed
Deploy to Test Environment / deploy-to-test (push) Has been cancelled
2026-01-01 02:58:02 -08:00
Gitea Actions
ee253e9449 ci: Bump version to 0.7.12 [skip ci] 2026-01-01 15:48:03 +05:00
b6c15e53d0 more db
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 10m24s
2026-01-01 02:47:31 -08:00
Gitea Actions
722162c2c3 ci: Bump version to 0.7.11 [skip ci] 2026-01-01 15:35:25 +05:00
02a76fe996 more db
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 10m20s
2026-01-01 02:35:00 -08:00
Gitea Actions
0ebb03a7ab ci: Bump version to 0.7.10 [skip ci] 2026-01-01 15:30:43 +05:00
748ac9e049 more db
Some checks failed
Deploy to Test Environment / deploy-to-test (push) Failing after 51s
2026-01-01 02:30:06 -08:00
Gitea Actions
495edd621c ci: Bump version to 0.7.9 [skip ci] 2026-01-01 14:59:38 +05:00
4ffca19db6 more db
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 10m28s
2026-01-01 01:58:18 -08:00
Gitea Actions
717427c5d7 ci: Bump version to 0.7.8 [skip ci] 2026-01-01 10:08:06 +05:00
cc438a0e36 more db
Some checks failed
Deploy to Test Environment / deploy-to-test (push) Failing after 38s
2025-12-31 21:07:40 -08:00
Gitea Actions
a32a0b62fc ci: Bump version to 0.7.7 [skip ci] 2026-01-01 09:44:49 +05:00
342f72b713 more db
Some checks failed
Deploy to Test Environment / deploy-to-test (push) Failing after 45s
2025-12-31 20:44:00 -08:00
Gitea Actions
91254d18f3 ci: Bump version to 0.7.6 [skip ci] 2026-01-01 06:02:31 +05:00
40580dbf15 database work !
Some checks failed
Deploy to Test Environment / deploy-to-test (push) Failing after 41s
2025-12-31 17:01:35 -08:00
7f1d74c047 flyer upload (anon) issues 2025-12-31 09:40:46 -08:00
111 changed files with 4342 additions and 1567 deletions

View File

@@ -13,6 +13,12 @@ RULES:
latest refacter
Refactor `RecipeSuggester.test.tsx` to use `renderWithProviders`.
Create a new test file for `StatCard.tsx` to verify its props and rendering.
UPC SCANNING !

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "flyer-crawler",
"version": "0.7.5",
"version": "0.8.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "flyer-crawler",
"version": "0.7.5",
"version": "0.8.0",
"dependencies": {
"@bull-board/api": "^6.14.2",
"@bull-board/express": "^6.14.2",

View File

@@ -1,7 +1,7 @@
{
"name": "flyer-crawler",
"private": true,
"version": "0.7.5",
"version": "0.8.0",
"type": "module",
"scripts": {
"dev": "concurrently \"npm:start:dev\" \"vite\"",

View File

@@ -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);

View File

@@ -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.';
@@ -1176,7 +1248,8 @@ INSERT INTO public.achievements (name, description, icon, points_value) VALUES
('List Sharer', 'Share a shopping list with another user for the first time.', 'list', 20),
('First Favorite', 'Mark a recipe as one of your favorites.', 'heart', 5),
('First Fork', 'Make a personal copy of a public recipe.', 'git-fork', 10),
('First Budget Created', 'Create your first budget to track spending.', 'piggy-bank', 15)
('First Budget Created', 'Create your first budget to track spending.', 'piggy-bank', 15),
('First-Upload', 'Upload your first flyer.', 'upload-cloud', 25)
ON CONFLICT (name) DO NOTHING;
-- ============================================================================
@@ -2042,6 +2115,61 @@ AS $$
ORDER BY potential_savings_cents DESC;
$$;
-- Function to get a user's spending breakdown by category for a given date range.
DROP FUNCTION IF EXISTS public.get_spending_by_category(UUID, DATE, DATE);
CREATE OR REPLACE FUNCTION public.get_spending_by_category(p_user_id UUID, p_start_date DATE, p_end_date DATE)
RETURNS TABLE (
category_id BIGINT,
category_name TEXT,
total_spent_cents BIGINT
)
LANGUAGE sql
STABLE
SECURITY INVOKER
AS $$
WITH all_purchases AS (
-- CTE 1: Combine purchases from completed shopping trips.
-- We only consider items that have a price paid.
SELECT
sti.master_item_id,
sti.price_paid_cents
FROM public.shopping_trip_items sti
JOIN public.shopping_trips st ON sti.shopping_trip_id = st.shopping_trip_id
WHERE st.user_id = p_user_id
AND st.completed_at::date BETWEEN p_start_date AND p_end_date
AND sti.price_paid_cents IS NOT NULL
UNION ALL
-- CTE 2: Combine purchases from processed receipts.
SELECT
ri.master_item_id,
ri.price_paid_cents
FROM public.receipt_items ri
JOIN public.receipts r ON ri.receipt_id = r.receipt_id
WHERE r.user_id = p_user_id
AND r.transaction_date::date BETWEEN p_start_date AND p_end_date
AND ri.master_item_id IS NOT NULL -- Only include items matched to a master item
)
-- Final Aggregation: Group all combined purchases by category and sum the spending.
SELECT
c.category_id,
c.name AS category_name,
SUM(ap.price_paid_cents)::BIGINT AS total_spent_cents
FROM all_purchases ap
-- Join with master_grocery_items to get the category_id for each purchase.
JOIN public.master_grocery_items mgi ON ap.master_item_id = mgi.master_grocery_item_id
-- Join with categories to get the category name for display.
JOIN public.categories c ON mgi.category_id = c.category_id
GROUP BY
c.category_id, c.name
HAVING
SUM(ap.price_paid_cents) > 0
ORDER BY
total_spent_cents DESC;
$$;
-- Function to approve a suggested correction and apply it.
DROP FUNCTION IF EXISTS public.approve_correction(BIGINT);
@@ -2485,16 +2613,21 @@ DROP FUNCTION IF EXISTS public.log_new_flyer();
CREATE OR REPLACE FUNCTION public.log_new_flyer()
RETURNS TRIGGER AS $$
BEGIN
INSERT INTO public.activity_log (action, display_text, icon, details)
-- If the flyer was uploaded by a registered user, award the 'First-Upload' achievement.
-- The award_achievement function handles checking if the user already has it.
IF NEW.uploaded_by IS NOT NULL THEN
PERFORM public.award_achievement(NEW.uploaded_by, 'First-Upload');
END IF;
INSERT INTO public.activity_log (user_id, action, display_text, icon, details)
VALUES (
NEW.uploaded_by, -- Log the user who uploaded it
'flyer_uploaded',
'A new flyer for ' || (SELECT name FROM public.stores WHERE store_id = NEW.store_id) || ' has been uploaded.',
'file-text',
jsonb_build_object(
'flyer_id', NEW.flyer_id,
'store_name', (SELECT name FROM public.stores WHERE store_id = NEW.store_id),
'valid_from', to_char(NEW.valid_from, 'YYYY-MM-DD'),
'valid_to', to_char(NEW.valid_to, 'YYYY-MM-DD')
'store_name', (SELECT name FROM public.stores WHERE store_id = NEW.store_id)
)
);
RETURN NEW;
@@ -2591,6 +2724,58 @@ CREATE TRIGGER on_new_recipe_collection_share
AFTER INSERT ON public.shared_recipe_collections
FOR EACH ROW EXECUTE FUNCTION public.log_new_recipe_collection_share();
-- 10. Trigger function to geocode a store location's address.
-- This function is designed to be extensible for external geocoding services.
DROP FUNCTION IF EXISTS public.geocode_store_location();
CREATE OR REPLACE FUNCTION public.geocode_store_location()
RETURNS TRIGGER AS $$
DECLARE
full_address TEXT;
BEGIN
-- Only proceed if the address has actually changed.
-- Note: We check against the linked address fields via the NEW.address_id in a real scenario,
-- but for this trigger to work effectively, it usually requires a direct update on the address table
-- or this trigger should be moved to the 'addresses' table.
-- However, based on the provided logic, we are keeping the placeholder structure.
-- Placeholder logic:
IF TG_OP = 'INSERT' THEN
-- Logic to fetch address string based on NEW.address_id and geocode
NULL;
END IF;
RETURN NEW;
END;
$$ LANGUAGE plpgsql;
-- Trigger to call the geocoding function.
DROP TRIGGER IF EXISTS on_store_location_address_change ON public.store_locations;
CREATE TRIGGER on_store_location_address_change
BEFORE INSERT OR UPDATE ON public.store_locations
FOR EACH ROW EXECUTE FUNCTION public.geocode_store_location();
-- 11. Trigger function to increment the fork_count on the original recipe.
DROP FUNCTION IF EXISTS public.increment_recipe_fork_count();
CREATE OR REPLACE FUNCTION public.increment_recipe_fork_count()
RETURNS TRIGGER AS $$
BEGIN
-- Only run if the recipe is a fork (original_recipe_id is not null).
IF NEW.original_recipe_id IS NOT NULL THEN
UPDATE public.recipes SET fork_count = fork_count + 1 WHERE recipe_id = NEW.original_recipe_id;
-- Award 'First Fork' achievement.
PERFORM public.award_achievement(NEW.user_id, 'First Fork');
END IF;
RETURN NEW;
END;
$$ LANGUAGE plpgsql;
DROP TRIGGER IF EXISTS on_recipe_fork ON public.recipes;
CREATE TRIGGER on_recipe_fork
AFTER INSERT ON public.recipes
FOR EACH ROW EXECUTE FUNCTION public.increment_recipe_fork_count();
-- =================================================================
-- Function: get_best_sale_prices_for_all_users()
-- Description: Retrieves the best sale price for every item on every user's watchlist.
@@ -2601,6 +2786,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 +2801,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 +2810,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 +2834,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 +2854,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;

View File

@@ -1,9 +1,10 @@
// src/components/AchievementsList.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import { screen } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import { AchievementsList } from './AchievementsList';
import { createMockUserAchievement } from '../tests/utils/mockFactories';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
describe('AchievementsList', () => {
it('should render the list of achievements with correct details', () => {
@@ -24,7 +25,7 @@ describe('AchievementsList', () => {
createMockUserAchievement({ achievement_id: 3, name: 'Unknown Achievement', icon: 'star' }), // This icon is not in the component's map
];
render(<AchievementsList achievements={mockAchievements} />);
renderWithProviders(<AchievementsList achievements={mockAchievements} />);
expect(screen.getByRole('heading', { name: /achievements/i })).toBeInTheDocument();
@@ -44,7 +45,7 @@ describe('AchievementsList', () => {
});
it('should render a message when there are no achievements', () => {
render(<AchievementsList achievements={[]} />);
renderWithProviders(<AchievementsList achievements={[]} />);
expect(
screen.getByText('No achievements earned yet. Keep exploring to unlock them!'),
).toBeInTheDocument();

View File

@@ -1,11 +1,12 @@
// src/components/AdminRoute.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import { MemoryRouter, Routes, Route } from 'react-router-dom';
import { screen } from '@testing-library/react';
import { describe, it, expect, vi } from 'vitest';
import { Routes, Route } from 'react-router-dom';
import { AdminRoute } from './AdminRoute';
import type { Profile } from '../types';
import { createMockProfile } from '../tests/utils/mockFactories';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Unmock the component to test the real implementation
vi.unmock('./AdminRoute');
@@ -14,15 +15,14 @@ const AdminContent = () => <div>Admin Page Content</div>;
const HomePage = () => <div>Home Page</div>;
const renderWithRouter = (profile: Profile | null, initialPath: string) => {
render(
<MemoryRouter initialEntries={[initialPath]}>
<Routes>
<Route path="/" element={<HomePage />} />
<Route path="/admin" element={<AdminRoute profile={profile} />}>
<Route index element={<AdminContent />} />
</Route>
</Routes>
</MemoryRouter>,
renderWithProviders(
<Routes>
<Route path="/" element={<HomePage />} />
<Route path="/admin" element={<AdminRoute profile={profile} />}>
<Route index element={<AdminContent />} />
</Route>
</Routes>,
{ initialEntries: [initialPath] },
);
};

View File

@@ -1,8 +1,9 @@
// src/components/AnonymousUserBanner.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { screen, fireEvent } from '@testing-library/react';
import { describe, it, expect, vi } from 'vitest';
import { AnonymousUserBanner } from './AnonymousUserBanner';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Mock the icon to ensure it is rendered correctly
vi.mock('./icons/InformationCircleIcon', () => ({
@@ -14,7 +15,7 @@ vi.mock('./icons/InformationCircleIcon', () => ({
describe('AnonymousUserBanner', () => {
it('should render the banner with the correct text content and accessibility role', () => {
const mockOnOpenProfile = vi.fn();
render(<AnonymousUserBanner onOpenProfile={mockOnOpenProfile} />);
renderWithProviders(<AnonymousUserBanner onOpenProfile={mockOnOpenProfile} />);
// Check for accessibility role
expect(screen.getByRole('alert')).toBeInTheDocument();
@@ -30,7 +31,7 @@ describe('AnonymousUserBanner', () => {
it('should call onOpenProfile when the "sign up or log in" button is clicked', () => {
const mockOnOpenProfile = vi.fn();
render(<AnonymousUserBanner onOpenProfile={mockOnOpenProfile} />);
renderWithProviders(<AnonymousUserBanner onOpenProfile={mockOnOpenProfile} />);
const loginButton = screen.getByRole('button', { name: /sign up or log in/i });
fireEvent.click(loginButton);

View File

@@ -1,12 +1,15 @@
// src/components/AppGuard.test.tsx
import React from 'react';
import { render, screen, waitFor } from '@testing-library/react';
import { screen, waitFor } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { AppGuard } from './AppGuard';
import { useAppInitialization } from '../hooks/useAppInitialization';
import * as apiClient from '../services/apiClient';
import { useModal } from '../hooks/useModal';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Mock dependencies
// The apiClient is mocked globally in `src/tests/setup/globalApiMock.ts`.
vi.mock('../hooks/useAppInitialization');
vi.mock('../hooks/useModal');
vi.mock('./WhatsNewModal', () => ({
@@ -19,6 +22,7 @@ vi.mock('../config', () => ({
},
}));
const mockedApiClient = vi.mocked(apiClient);
const mockedUseAppInitialization = vi.mocked(useAppInitialization);
const mockedUseModal = vi.mocked(useModal);
@@ -38,7 +42,7 @@ describe('AppGuard', () => {
});
it('should render children', () => {
render(
renderWithProviders(
<AppGuard>
<div>Child Content</div>
</AppGuard>,
@@ -51,7 +55,7 @@ describe('AppGuard', () => {
...mockedUseModal(),
isModalOpen: (modalId) => modalId === 'whatsNew',
});
render(
renderWithProviders(
<AppGuard>
<div>Child</div>
</AppGuard>,
@@ -64,7 +68,7 @@ describe('AppGuard', () => {
isDarkMode: true,
unitSystem: 'imperial',
});
render(
renderWithProviders(
<AppGuard>
<div>Child</div>
</AppGuard>,
@@ -78,7 +82,7 @@ describe('AppGuard', () => {
});
it('should set light mode styles for toaster', async () => {
render(
renderWithProviders(
<AppGuard>
<div>Child</div>
</AppGuard>,

View File

@@ -1,8 +1,9 @@
// src/components/ConfirmationModal.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { screen, fireEvent } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { ConfirmationModal } from './ConfirmationModal';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
describe('ConfirmationModal (in components)', () => {
const mockOnClose = vi.fn();
@@ -21,12 +22,12 @@ describe('ConfirmationModal (in components)', () => {
});
it('should not render when isOpen is false', () => {
const { container } = render(<ConfirmationModal {...defaultProps} isOpen={false} />);
const { container } = renderWithProviders(<ConfirmationModal {...defaultProps} isOpen={false} />);
expect(container.firstChild).toBeNull();
});
it('should render correctly when isOpen is true', () => {
render(<ConfirmationModal {...defaultProps} />);
renderWithProviders(<ConfirmationModal {...defaultProps} />);
expect(screen.getByRole('heading', { name: 'Confirm Action' })).toBeInTheDocument();
expect(screen.getByText('Are you sure you want to do this?')).toBeInTheDocument();
expect(screen.getByRole('button', { name: 'Confirm' })).toBeInTheDocument();
@@ -34,38 +35,38 @@ describe('ConfirmationModal (in components)', () => {
});
it('should call onConfirm when the confirm button is clicked', () => {
render(<ConfirmationModal {...defaultProps} />);
renderWithProviders(<ConfirmationModal {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: 'Confirm' }));
expect(mockOnConfirm).toHaveBeenCalledTimes(1);
});
it('should call onClose when the cancel button is clicked', () => {
render(<ConfirmationModal {...defaultProps} />);
renderWithProviders(<ConfirmationModal {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: 'Cancel' }));
expect(mockOnClose).toHaveBeenCalledTimes(1);
});
it('should call onClose when the close icon is clicked', () => {
render(<ConfirmationModal {...defaultProps} />);
renderWithProviders(<ConfirmationModal {...defaultProps} />);
fireEvent.click(screen.getByLabelText('Close confirmation modal'));
expect(mockOnClose).toHaveBeenCalledTimes(1);
});
it('should call onClose when the overlay is clicked', () => {
render(<ConfirmationModal {...defaultProps} />);
renderWithProviders(<ConfirmationModal {...defaultProps} />);
// The overlay is the parent of the modal content div
fireEvent.click(screen.getByRole('dialog'));
expect(mockOnClose).toHaveBeenCalledTimes(1);
});
it('should not call onClose when clicking inside the modal content', () => {
render(<ConfirmationModal {...defaultProps} />);
renderWithProviders(<ConfirmationModal {...defaultProps} />);
fireEvent.click(screen.getByText('Are you sure you want to do this?'));
expect(mockOnClose).not.toHaveBeenCalled();
});
it('should render custom button text and classes', () => {
render(
renderWithProviders(
<ConfirmationModal
{...defaultProps}
confirmButtonText="Yes, Delete"

View File

@@ -1,8 +1,9 @@
// src/components/DarkModeToggle.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { screen, fireEvent } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { DarkModeToggle } from './DarkModeToggle';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Mock the icon components to isolate the toggle's logic
vi.mock('./icons/SunIcon', () => ({
@@ -20,7 +21,7 @@ describe('DarkModeToggle', () => {
});
it('should render in light mode state', () => {
render(<DarkModeToggle isDarkMode={false} onToggle={mockOnToggle} />);
renderWithProviders(<DarkModeToggle isDarkMode={false} onToggle={mockOnToggle} />);
const checkbox = screen.getByRole('checkbox');
expect(checkbox).not.toBeChecked();
@@ -29,7 +30,7 @@ describe('DarkModeToggle', () => {
});
it('should render in dark mode state', () => {
render(<DarkModeToggle isDarkMode={true} onToggle={mockOnToggle} />);
renderWithProviders(<DarkModeToggle isDarkMode={true} onToggle={mockOnToggle} />);
const checkbox = screen.getByRole('checkbox');
expect(checkbox).toBeChecked();
@@ -38,7 +39,7 @@ describe('DarkModeToggle', () => {
});
it('should call onToggle when the label is clicked', () => {
render(<DarkModeToggle isDarkMode={false} onToggle={mockOnToggle} />);
renderWithProviders(<DarkModeToggle isDarkMode={false} onToggle={mockOnToggle} />);
// Clicking the label triggers the checkbox change
const label = screen.getByTitle('Switch to Dark Mode');

View File

@@ -0,0 +1,67 @@
// src/components/Dashboard.test.tsx
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { screen } from '@testing-library/react';
import { Dashboard } from './Dashboard';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Mock child components to isolate Dashboard logic
// Note: The Dashboard component imports these using '../components/RecipeSuggester'
// which resolves to the same file as './RecipeSuggester' when inside src/components.
vi.mock('./RecipeSuggester', () => ({
RecipeSuggester: () => <div data-testid="recipe-suggester-mock">Recipe Suggester</div>,
}));
vi.mock('./FlyerCountDisplay', () => ({
FlyerCountDisplay: () => <div data-testid="flyer-count-display-mock">Flyer Count Display</div>,
}));
vi.mock('./Leaderboard', () => ({
Leaderboard: () => <div data-testid="leaderboard-mock">Leaderboard</div>,
}));
describe('Dashboard Component', () => {
beforeEach(() => {
vi.clearAllMocks();
});
it('renders the dashboard title', () => {
console.log('TEST: Verifying dashboard title render');
renderWithProviders(<Dashboard />);
expect(screen.getByRole('heading', { name: /dashboard/i, level: 1 })).toBeInTheDocument();
});
it('renders the RecipeSuggester widget', () => {
console.log('TEST: Verifying RecipeSuggester presence');
renderWithProviders(<Dashboard />);
expect(screen.getByTestId('recipe-suggester-mock')).toBeInTheDocument();
});
it('renders the FlyerCountDisplay widget within the "Your Flyers" section', () => {
console.log('TEST: Verifying FlyerCountDisplay presence and section title');
renderWithProviders(<Dashboard />);
// Check for the section heading
expect(screen.getByRole('heading', { name: /your flyers/i, level: 2 })).toBeInTheDocument();
// Check for the component
expect(screen.getByTestId('flyer-count-display-mock')).toBeInTheDocument();
});
it('renders the Leaderboard widget in the sidebar area', () => {
console.log('TEST: Verifying Leaderboard presence');
renderWithProviders(<Dashboard />);
expect(screen.getByTestId('leaderboard-mock')).toBeInTheDocument();
});
it('renders with the correct grid layout classes', () => {
console.log('TEST: Verifying layout classes');
const { container } = renderWithProviders(<Dashboard />);
// The main grid container
const gridContainer = container.querySelector('.grid');
expect(gridContainer).toBeInTheDocument();
expect(gridContainer).toHaveClass('grid-cols-1');
expect(gridContainer).toHaveClass('lg:grid-cols-3');
expect(gridContainer).toHaveClass('gap-6');
});
});

View File

@@ -0,0 +1,33 @@
import React from 'react';
import { RecipeSuggester } from '../components/RecipeSuggester';
import { FlyerCountDisplay } from '../components/FlyerCountDisplay';
import { Leaderboard } from '../components/Leaderboard';
export const Dashboard: React.FC = () => {
return (
<div className="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-8">
<h1 className="text-2xl font-bold text-gray-900 dark:text-white mb-6">Dashboard</h1>
<div className="grid grid-cols-1 lg:grid-cols-3 gap-6">
{/* Main Content Area */}
<div className="lg:col-span-2 space-y-6">
{/* Recipe Suggester Section */}
<RecipeSuggester />
{/* Other Dashboard Widgets */}
<div className="bg-white dark:bg-gray-800 shadow rounded-lg p-6">
<h2 className="text-lg font-medium text-gray-900 dark:text-white mb-4">Your Flyers</h2>
<FlyerCountDisplay />
</div>
</div>
{/* Sidebar Area */}
<div className="space-y-6">
<Leaderboard />
</div>
</div>
</div>
);
};
export default Dashboard;

View File

@@ -1,24 +1,25 @@
// src/components/ErrorDisplay.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import { screen } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import { ErrorDisplay } from './ErrorDisplay';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
describe('ErrorDisplay (in components)', () => {
it('should not render when the message is empty', () => {
const { container } = render(<ErrorDisplay message="" />);
const { container } = renderWithProviders(<ErrorDisplay message="" />);
expect(container.firstChild).toBeNull();
});
it('should not render when the message is null', () => {
// The component expects a string, but we test for nullish values as a safeguard.
const { container } = render(<ErrorDisplay message={null as unknown as string} />);
const { container } = renderWithProviders(<ErrorDisplay message={null as unknown as string} />);
expect(container.firstChild).toBeNull();
});
it('should render the error message when provided', () => {
const errorMessage = 'Something went terribly wrong.';
render(<ErrorDisplay message={errorMessage} />);
renderWithProviders(<ErrorDisplay message={errorMessage} />);
const alert = screen.getByRole('alert');
expect(alert).toBeInTheDocument();

View File

@@ -1,24 +1,18 @@
// src/components/FlyerCorrectionTool.test.tsx
import React from 'react';
import { render, screen, fireEvent, waitFor, act } from '@testing-library/react';
import { screen, fireEvent, waitFor, act } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, type Mocked } from 'vitest';
import { FlyerCorrectionTool } from './FlyerCorrectionTool';
import * as aiApiClient from '../services/aiApiClient';
import { notifyError, notifySuccess } from '../services/notificationService';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Unmock the component to test the real implementation
vi.unmock('./FlyerCorrectionTool');
// Mock dependencies
vi.mock('../services/aiApiClient');
vi.mock('../services/notificationService');
vi.mock('../services/logger', () => ({
logger: {
error: vi.fn(),
},
}));
const mockedAiApiClient = aiApiClient as Mocked<typeof aiApiClient>;
// The aiApiClient, notificationService, and logger are mocked globally.
// We can get a typed reference to the aiApiClient for individual test overrides.
const mockedAiApiClient = vi.mocked(aiApiClient);
const mockedNotifySuccess = notifySuccess as Mocked<typeof notifySuccess>;
const mockedNotifyError = notifyError as Mocked<typeof notifyError>;
@@ -54,12 +48,12 @@ describe('FlyerCorrectionTool', () => {
});
it('should not render when isOpen is false', () => {
const { container } = render(<FlyerCorrectionTool {...defaultProps} isOpen={false} />);
const { container } = renderWithProviders(<FlyerCorrectionTool {...defaultProps} isOpen={false} />);
expect(container.firstChild).toBeNull();
});
it('should render correctly when isOpen is true', () => {
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
expect(screen.getByRole('heading', { name: /flyer correction tool/i })).toBeInTheDocument();
expect(screen.getByAltText('Flyer for correction')).toBeInTheDocument();
expect(screen.getByRole('button', { name: /extract store name/i })).toBeInTheDocument();
@@ -67,7 +61,7 @@ describe('FlyerCorrectionTool', () => {
});
it('should call onClose when the close button is clicked', () => {
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
// Use the specific aria-label defined in the component to find the close button
const closeButton = screen.getByLabelText(/close correction tool/i);
fireEvent.click(closeButton);
@@ -75,13 +69,13 @@ describe('FlyerCorrectionTool', () => {
});
it('should have disabled extraction buttons initially', () => {
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
expect(screen.getByRole('button', { name: /extract store name/i })).toBeDisabled();
expect(screen.getByRole('button', { name: /extract sale dates/i })).toBeDisabled();
});
it('should enable extraction buttons after a selection is made', () => {
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
const canvas = screen.getByRole('dialog').querySelector('canvas')!;
// Simulate drawing a rectangle
@@ -94,7 +88,7 @@ describe('FlyerCorrectionTool', () => {
});
it('should stop drawing when the mouse leaves the canvas', () => {
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
const canvas = screen.getByRole('dialog').querySelector('canvas')!;
fireEvent.mouseDown(canvas, { clientX: 10, clientY: 10 });
@@ -114,7 +108,7 @@ describe('FlyerCorrectionTool', () => {
});
mockedAiApiClient.rescanImageArea.mockReturnValue(rescanPromise);
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
// Wait for the image fetch to complete to ensure 'imageFile' state is populated
console.log('--- [TEST LOG] ---: Awaiting image fetch inside component...');
@@ -192,7 +186,7 @@ describe('FlyerCorrectionTool', () => {
// Mock fetch to reject
global.fetch = vi.fn(() => Promise.reject(new Error('Network error'))) as Mocked<typeof fetch>;
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
await waitFor(() => {
expect(mockedNotifyError).toHaveBeenCalledWith('Could not load the image for correction.');
@@ -211,7 +205,7 @@ describe('FlyerCorrectionTool', () => {
return new Promise(() => {});
}) as Mocked<typeof fetch>;
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
const canvas = screen.getByRole('dialog').querySelector('canvas')!;
@@ -238,7 +232,7 @@ describe('FlyerCorrectionTool', () => {
it('should handle non-standard API errors during rescan', async () => {
console.log('TEST: Starting "should handle non-standard API errors during rescan"');
mockedAiApiClient.rescanImageArea.mockRejectedValue('A plain string error');
render(<FlyerCorrectionTool {...defaultProps} />);
renderWithProviders(<FlyerCorrectionTool {...defaultProps} />);
// Wait for image fetch to ensure imageFile is set before we interact
await waitFor(() => expect(global.fetch).toHaveBeenCalled());

View File

@@ -1,11 +1,12 @@
// src/components/FlyerCountDisplay.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import { screen } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { FlyerCountDisplay } from './FlyerCountDisplay';
import { useFlyers } from '../hooks/useFlyers';
import type { Flyer } from '../types';
import { createMockFlyer } from '../tests/utils/mockFactories';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Mock the dependencies
vi.mock('../hooks/useFlyers');
@@ -32,7 +33,7 @@ describe('FlyerCountDisplay', () => {
});
// Act: Render the component.
render(<FlyerCountDisplay />);
renderWithProviders(<FlyerCountDisplay />);
// Assert: Check that the loading spinner is visible.
expect(screen.getByTestId('loading-spinner')).toBeInTheDocument();
@@ -53,7 +54,7 @@ describe('FlyerCountDisplay', () => {
});
// Act
render(<FlyerCountDisplay />);
renderWithProviders(<FlyerCountDisplay />);
// Assert: Check that the error message is displayed.
expect(screen.getByRole('alert')).toHaveTextContent(errorMessage);
@@ -73,7 +74,7 @@ describe('FlyerCountDisplay', () => {
});
// Act
render(<FlyerCountDisplay />);
renderWithProviders(<FlyerCountDisplay />);
// Assert: Check that the correct count is displayed.
const countDisplay = screen.getByTestId('flyer-count');

View File

@@ -1,8 +1,9 @@
// src/components/Footer.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import { screen } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { Footer } from './Footer';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
describe('Footer', () => {
beforeEach(() => {
@@ -21,7 +22,7 @@ describe('Footer', () => {
vi.setSystemTime(mockDate);
// Act: Render the component
render(<Footer />);
renderWithProviders(<Footer />);
// Assert: Check that the rendered text includes the mocked year
expect(screen.getByText('Copyright 2025-2025')).toBeInTheDocument();
@@ -29,7 +30,7 @@ describe('Footer', () => {
it('should display the correct year when it changes', () => {
vi.setSystemTime(new Date('2030-01-01T00:00:00Z'));
render(<Footer />);
renderWithProviders(<Footer />);
expect(screen.getByText('Copyright 2025-2030')).toBeInTheDocument();
});
});

View File

@@ -1,11 +1,11 @@
// src/components/Header.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { screen, fireEvent } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { MemoryRouter } from 'react-router-dom';
import { Header } from './Header';
import type { UserProfile } from '../types';
import { createMockUserProfile } from '../tests/utils/mockFactories';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Unmock the component to test the real implementation
vi.unmock('./Header');
@@ -34,12 +34,8 @@ const defaultProps = {
};
// Helper to render with router context
const renderWithRouter = (props: Partial<React.ComponentProps<typeof Header>>) => {
return render(
<MemoryRouter>
<Header {...defaultProps} {...props} />
</MemoryRouter>,
);
const renderHeader = (props: Partial<React.ComponentProps<typeof Header>>) => {
return renderWithProviders(<Header {...defaultProps} {...props} />);
};
describe('Header', () => {
@@ -48,30 +44,30 @@ describe('Header', () => {
});
it('should render the application title', () => {
renderWithRouter({});
renderHeader({});
expect(screen.getByRole('heading', { name: /flyer crawler/i })).toBeInTheDocument();
});
it('should display unit system and theme mode', () => {
renderWithRouter({ isDarkMode: true, unitSystem: 'metric' });
renderHeader({ isDarkMode: true, unitSystem: 'metric' });
expect(screen.getByText(/metric/i)).toBeInTheDocument();
expect(screen.getByText(/dark mode/i)).toBeInTheDocument();
});
describe('When user is logged out', () => {
it('should show a Login button', () => {
renderWithRouter({ userProfile: null, authStatus: 'SIGNED_OUT' });
renderHeader({ userProfile: null, authStatus: 'SIGNED_OUT' });
expect(screen.getByRole('button', { name: /login/i })).toBeInTheDocument();
});
it('should call onOpenProfile when Login button is clicked', () => {
renderWithRouter({ userProfile: null, authStatus: 'SIGNED_OUT' });
renderHeader({ userProfile: null, authStatus: 'SIGNED_OUT' });
fireEvent.click(screen.getByRole('button', { name: /login/i }));
expect(mockOnOpenProfile).toHaveBeenCalledTimes(1);
});
it('should not show user-specific buttons', () => {
renderWithRouter({ userProfile: null, authStatus: 'SIGNED_OUT' });
renderHeader({ userProfile: null, authStatus: 'SIGNED_OUT' });
expect(screen.queryByLabelText(/open voice assistant/i)).not.toBeInTheDocument();
expect(screen.queryByLabelText(/open my account settings/i)).not.toBeInTheDocument();
expect(screen.queryByRole('button', { name: /logout/i })).not.toBeInTheDocument();
@@ -80,29 +76,29 @@ describe('Header', () => {
describe('When user is authenticated', () => {
it('should display the user email', () => {
renderWithRouter({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
renderHeader({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
expect(screen.getByText(mockUserProfile.user.email)).toBeInTheDocument();
});
it('should display "Guest" for anonymous users', () => {
renderWithRouter({ userProfile: mockUserProfile, authStatus: 'SIGNED_OUT' });
renderHeader({ userProfile: mockUserProfile, authStatus: 'SIGNED_OUT' });
expect(screen.getByText(/guest/i)).toBeInTheDocument();
});
it('should call onOpenVoiceAssistant when microphone icon is clicked', () => {
renderWithRouter({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
renderHeader({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
fireEvent.click(screen.getByLabelText(/open voice assistant/i));
expect(mockOnOpenVoiceAssistant).toHaveBeenCalledTimes(1);
});
it('should call onOpenProfile when cog icon is clicked', () => {
renderWithRouter({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
renderHeader({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
fireEvent.click(screen.getByLabelText(/open my account settings/i));
expect(mockOnOpenProfile).toHaveBeenCalledTimes(1);
});
it('should call onSignOut when Logout button is clicked', () => {
renderWithRouter({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
renderHeader({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
fireEvent.click(screen.getByRole('button', { name: /logout/i }));
expect(mockOnSignOut).toHaveBeenCalledTimes(1);
});
@@ -110,14 +106,14 @@ describe('Header', () => {
describe('Admin user', () => {
it('should show the Admin Area link for admin users', () => {
renderWithRouter({ userProfile: mockAdminProfile, authStatus: 'AUTHENTICATED' });
renderHeader({ userProfile: mockAdminProfile, authStatus: 'AUTHENTICATED' });
const adminLink = screen.getByTitle(/admin area/i);
expect(adminLink).toBeInTheDocument();
expect(adminLink.closest('a')).toHaveAttribute('href', '/admin');
});
it('should not show the Admin Area link for non-admin users', () => {
renderWithRouter({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
renderHeader({ userProfile: mockUserProfile, authStatus: 'AUTHENTICATED' });
expect(screen.queryByTitle(/admin area/i)).not.toBeInTheDocument();
});
});

View File

@@ -1,21 +1,17 @@
// src/components/Leaderboard.test.tsx
import React from 'react';
import { render, screen, waitFor } from '@testing-library/react';
import { screen, waitFor } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, type Mocked } from 'vitest';
import Leaderboard from './Leaderboard';
import * as apiClient from '../services/apiClient';
import { LeaderboardUser } from '../types';
import { createMockLeaderboardUser } from '../tests/utils/mockFactories';
import { createMockLogger } from '../tests/utils/mockLogger';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Mock the apiClient
vi.mock('../services/apiClient'); // This was correct
const mockedApiClient = apiClient as Mocked<typeof apiClient>;
// Mock the logger
vi.mock('../services/logger', () => ({
logger: createMockLogger(),
}));
// The apiClient and logger are mocked globally.
// We can get a typed reference to the apiClient for individual test overrides.
const mockedApiClient = vi.mocked(apiClient);
// Mock lucide-react icons to prevent rendering errors in the test environment
vi.mock('lucide-react', () => ({
@@ -45,13 +41,13 @@ describe('Leaderboard', () => {
it('should display a loading message initially', () => {
// Mock a pending promise that never resolves to keep it in the loading state
mockedApiClient.fetchLeaderboard.mockReturnValue(new Promise(() => {}));
render(<Leaderboard />);
renderWithProviders(<Leaderboard />);
expect(screen.getByText('Loading Leaderboard...')).toBeInTheDocument();
});
it('should display an error message if the API call fails', async () => {
mockedApiClient.fetchLeaderboard.mockResolvedValue(new Response(null, { status: 500 }));
render(<Leaderboard />);
renderWithProviders(<Leaderboard />);
await waitFor(() => {
expect(screen.getByRole('alert')).toBeInTheDocument();
@@ -62,7 +58,7 @@ describe('Leaderboard', () => {
it('should display a generic error for unknown error types', async () => {
const unknownError = 'A string error';
mockedApiClient.fetchLeaderboard.mockRejectedValue(unknownError);
render(<Leaderboard />);
renderWithProviders(<Leaderboard />);
await waitFor(() => {
expect(screen.getByRole('alert')).toBeInTheDocument();
@@ -72,7 +68,7 @@ describe('Leaderboard', () => {
it('should display a message when the leaderboard is empty', async () => {
mockedApiClient.fetchLeaderboard.mockResolvedValue(new Response(JSON.stringify([])));
render(<Leaderboard />);
renderWithProviders(<Leaderboard />);
await waitFor(() => {
expect(
@@ -85,7 +81,7 @@ describe('Leaderboard', () => {
mockedApiClient.fetchLeaderboard.mockResolvedValue(
new Response(JSON.stringify(mockLeaderboardData)),
);
render(<Leaderboard />);
renderWithProviders(<Leaderboard />);
await waitFor(() => {
expect(screen.getByRole('heading', { name: 'Top Users' })).toBeInTheDocument();
@@ -110,7 +106,7 @@ describe('Leaderboard', () => {
mockedApiClient.fetchLeaderboard.mockResolvedValue(
new Response(JSON.stringify(mockLeaderboardData)),
);
render(<Leaderboard />);
renderWithProviders(<Leaderboard />);
await waitFor(() => {
// Rank 1, 2, and 3 should have a crown icon
@@ -129,7 +125,7 @@ describe('Leaderboard', () => {
mockedApiClient.fetchLeaderboard.mockResolvedValue(
new Response(JSON.stringify(dataWithMissingNames)),
);
render(<Leaderboard />);
renderWithProviders(<Leaderboard />);
await waitFor(() => {
// Check for fallback name

View File

@@ -1,19 +1,19 @@
// src/components/LoadingSpinner.test.tsx
import React from 'react';
import { render } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import { LoadingSpinner } from './LoadingSpinner';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
describe('LoadingSpinner (in components)', () => {
it('should render the SVG with animation classes', () => {
const { container } = render(<LoadingSpinner />);
const { container } = renderWithProviders(<LoadingSpinner />);
const svgElement = container.querySelector('svg');
expect(svgElement).toBeInTheDocument();
expect(svgElement).toHaveClass('animate-spin');
});
it('should contain the correct SVG paths for the spinner graphic', () => {
const { container } = render(<LoadingSpinner />);
const { container } = renderWithProviders(<LoadingSpinner />);
const circle = container.querySelector('circle');
const path = container.querySelector('path');
expect(circle).toBeInTheDocument();

View File

@@ -1,9 +1,10 @@
// src/components/MapView.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import { screen } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { MapView } from './MapView';
import config from '../config';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Create a type-safe mocked version of the config for easier manipulation
const mockedConfig = vi.mocked(config);
@@ -40,14 +41,14 @@ describe('MapView', () => {
describe('when API key is not configured', () => {
it('should render a disabled message', () => {
render(<MapView {...defaultProps} />);
renderWithProviders(<MapView {...defaultProps} />);
expect(
screen.getByText('Map view is disabled: API key is not configured.'),
).toBeInTheDocument();
});
it('should not render the iframe', () => {
render(<MapView {...defaultProps} />);
renderWithProviders(<MapView {...defaultProps} />);
// Use queryByTitle because iframes don't have a default "iframe" role
expect(screen.queryByTitle('Map view')).not.toBeInTheDocument();
});
@@ -62,7 +63,7 @@ describe('MapView', () => {
});
it('should render the iframe with the correct src URL', () => {
render(<MapView {...defaultProps} />);
renderWithProviders(<MapView {...defaultProps} />);
// Use getByTitle to access the iframe
const iframe = screen.getByTitle('Map view');

View File

@@ -1,8 +1,9 @@
// src/components/PasswordInput.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { screen, fireEvent } from '@testing-library/react';
import { describe, it, expect, vi } from 'vitest';
import { PasswordInput } from './PasswordInput';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Mock the child PasswordStrengthIndicator component to isolate the test (relative to new location)
vi.mock('./PasswordStrengthIndicator', () => ({
PasswordStrengthIndicator: ({ password }: { password?: string }) => (
@@ -12,13 +13,13 @@ vi.mock('./PasswordStrengthIndicator', () => ({
describe('PasswordInput (in auth feature)', () => {
it('should render as a password input by default', () => {
render(<PasswordInput placeholder="Enter password" />);
renderWithProviders(<PasswordInput placeholder="Enter password" />);
const input = screen.getByPlaceholderText('Enter password');
expect(input).toHaveAttribute('type', 'password');
});
it('should toggle input type between password and text when the eye icon is clicked', () => {
render(<PasswordInput placeholder="Enter password" />);
renderWithProviders(<PasswordInput placeholder="Enter password" />);
const input = screen.getByPlaceholderText('Enter password');
const toggleButton = screen.getByRole('button', { name: /show password/i });
@@ -38,7 +39,7 @@ describe('PasswordInput (in auth feature)', () => {
it('should pass through standard input attributes', () => {
const handleChange = vi.fn();
render(
renderWithProviders(
<PasswordInput
value="test"
onChange={handleChange}
@@ -56,38 +57,38 @@ describe('PasswordInput (in auth feature)', () => {
});
it('should not show strength indicator by default', () => {
render(<PasswordInput value="some-password" onChange={() => {}} />);
renderWithProviders(<PasswordInput value="some-password" onChange={() => {}} />);
expect(screen.queryByTestId('strength-indicator')).not.toBeInTheDocument();
});
it('should show strength indicator when showStrength is true and there is a value', () => {
render(<PasswordInput value="some-password" showStrength onChange={() => {}} />);
renderWithProviders(<PasswordInput value="some-password" showStrength onChange={() => {}} />);
const indicator = screen.getByTestId('strength-indicator');
expect(indicator).toBeInTheDocument();
expect(indicator).toHaveTextContent('Strength for: some-password');
});
it('should not show strength indicator when showStrength is true but value is empty', () => {
render(<PasswordInput value="" showStrength onChange={() => {}} />);
renderWithProviders(<PasswordInput value="" showStrength onChange={() => {}} />);
expect(screen.queryByTestId('strength-indicator')).not.toBeInTheDocument();
});
it('should handle undefined className gracefully', () => {
render(<PasswordInput placeholder="No class" />);
renderWithProviders(<PasswordInput placeholder="No class" />);
const input = screen.getByPlaceholderText('No class');
expect(input.className).not.toContain('undefined');
expect(input.className).toContain('block w-full');
});
it('should not show strength indicator if value is undefined', () => {
render(<PasswordInput showStrength onChange={() => {}} />);
renderWithProviders(<PasswordInput showStrength onChange={() => {}} />);
expect(screen.queryByTestId('strength-indicator')).not.toBeInTheDocument();
});
it('should not show strength indicator if value is not a string', () => {
// Force a non-string value to test the typeof check
const props = { value: 12345, showStrength: true, onChange: () => {} } as any;
render(<PasswordInput {...props} />);
renderWithProviders(<PasswordInput {...props} />);
expect(screen.queryByTestId('strength-indicator')).not.toBeInTheDocument();
});
});

View File

@@ -1,8 +1,9 @@
// src/pages/admin/components/PasswordStrengthIndicator.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import { screen } from '@testing-library/react';
import { describe, it, expect, vi, type Mock } from 'vitest';
import { PasswordStrengthIndicator } from './PasswordStrengthIndicator';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
import zxcvbn from 'zxcvbn';
// Mock the zxcvbn library to control its output for testing
@@ -11,7 +12,7 @@ vi.mock('zxcvbn');
describe('PasswordStrengthIndicator', () => {
it('should render 5 gray bars when no password is provided', () => {
(zxcvbn as Mock).mockReturnValue({ score: -1, feedback: { warning: '', suggestions: [] } });
const { container } = render(<PasswordStrengthIndicator password="" />);
const { container } = renderWithProviders(<PasswordStrengthIndicator password="" />);
const bars = container.querySelectorAll('.h-1\\.5');
expect(bars).toHaveLength(5);
bars.forEach((bar) => {
@@ -28,7 +29,7 @@ describe('PasswordStrengthIndicator', () => {
{ score: 4, label: 'Strong', color: 'bg-green-500', bars: 5 },
])('should render correctly for score $score ($label)', ({ score, label, color, bars }) => {
(zxcvbn as Mock).mockReturnValue({ score, feedback: { warning: '', suggestions: [] } });
const { container } = render(<PasswordStrengthIndicator password="some-password" />);
const { container } = renderWithProviders(<PasswordStrengthIndicator password="some-password" />);
// Check the label
expect(screen.getByText(label)).toBeInTheDocument();
@@ -54,7 +55,7 @@ describe('PasswordStrengthIndicator', () => {
suggestions: [],
},
});
render(<PasswordStrengthIndicator password="password" />);
renderWithProviders(<PasswordStrengthIndicator password="password" />);
expect(screen.getByText(/this is a very common password/i)).toBeInTheDocument();
});
@@ -66,7 +67,7 @@ describe('PasswordStrengthIndicator', () => {
suggestions: ['Add another word or two'],
},
});
render(<PasswordStrengthIndicator password="pass" />);
renderWithProviders(<PasswordStrengthIndicator password="pass" />);
expect(screen.getByText(/add another word or two/i)).toBeInTheDocument();
});
@@ -75,14 +76,14 @@ describe('PasswordStrengthIndicator', () => {
score: 1,
feedback: { warning: 'A warning here', suggestions: ['A suggestion here'] },
});
render(<PasswordStrengthIndicator password="password" />);
renderWithProviders(<PasswordStrengthIndicator password="password" />);
expect(screen.getByText(/a warning here/i)).toBeInTheDocument();
expect(screen.queryByText(/a suggestion here/i)).not.toBeInTheDocument();
});
it('should use default empty string if password prop is undefined', () => {
(zxcvbn as Mock).mockReturnValue({ score: 0, feedback: { warning: '', suggestions: [] } });
const { container } = render(<PasswordStrengthIndicator />);
const { container } = renderWithProviders(<PasswordStrengthIndicator />);
const bars = container.querySelectorAll('.h-1\\.5');
expect(bars).toHaveLength(5);
bars.forEach((bar) => {
@@ -94,7 +95,7 @@ describe('PasswordStrengthIndicator', () => {
it('should handle out-of-range scores gracefully (defensive)', () => {
// Mock a score that isn't 0-4 to hit default switch cases
(zxcvbn as Mock).mockReturnValue({ score: 99, feedback: { warning: '', suggestions: [] } });
const { container } = render(<PasswordStrengthIndicator password="test" />);
const { container } = renderWithProviders(<PasswordStrengthIndicator password="test" />);
// Check bars - should hit default case in getBarColor which returns gray
const bars = container.querySelectorAll('.h-1\\.5');

View File

@@ -0,0 +1,156 @@
// src/components/RecipeSuggester.test.tsx
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { screen, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { RecipeSuggester } from './RecipeSuggester'; // This should be after mocks
import * as apiClient from '../services/apiClient';
import { logger } from '../services/logger.client';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
import '@testing-library/jest-dom';
// The apiClient is mocked globally in `src/tests/setup/globalApiMock.ts`.
// We can get a typed reference to it for individual test overrides.
const mockedApiClient = vi.mocked(apiClient);
describe('RecipeSuggester Component', () => {
beforeEach(() => {
vi.clearAllMocks();
// Reset console logs if needed, or just keep them for debug visibility
});
it('renders correctly with initial state', () => {
console.log('TEST: Verifying initial render state');
renderWithProviders(<RecipeSuggester />);
expect(screen.getByText('Get a Recipe Suggestion')).toBeInTheDocument();
expect(screen.getByLabelText(/Ingredients:/i)).toBeInTheDocument();
expect(screen.getByRole('button', { name: /Suggest a Recipe/i })).toBeInTheDocument();
expect(screen.queryByText('Getting suggestion...')).not.toBeInTheDocument();
});
it('shows validation error if no ingredients are entered', async () => {
console.log('TEST: Verifying validation for empty input');
const user = userEvent.setup();
renderWithProviders(<RecipeSuggester />);
const button = screen.getByRole('button', { name: /Suggest a Recipe/i });
await user.click(button);
expect(await screen.findByText('Please enter at least one ingredient.')).toBeInTheDocument();
expect(mockedApiClient.suggestRecipe).not.toHaveBeenCalled();
console.log('TEST: Validation error displayed correctly');
});
it('calls suggestRecipe and displays suggestion on success', async () => {
console.log('TEST: Verifying successful recipe suggestion flow');
const user = userEvent.setup();
renderWithProviders(<RecipeSuggester />);
const input = screen.getByLabelText(/Ingredients:/i);
await user.type(input, 'chicken, rice');
// Mock successful API response
const mockSuggestion = 'Here is a nice Chicken and Rice recipe...';
// Add a delay to ensure the loading state is visible during the test
mockedApiClient.suggestRecipe.mockImplementation(async () => {
await new Promise((resolve) => setTimeout(resolve, 50));
return { ok: true, json: async () => ({ suggestion: mockSuggestion }) } as Response;
});
const button = screen.getByRole('button', { name: /Suggest a Recipe/i });
await user.click(button);
// Check loading state
expect(screen.getByRole('button')).toBeDisabled();
expect(screen.getByText('Getting suggestion...')).toBeInTheDocument();
await waitFor(() => {
expect(screen.getByText(mockSuggestion)).toBeInTheDocument();
});
expect(mockedApiClient.suggestRecipe).toHaveBeenCalledWith(['chicken', 'rice']);
console.log('TEST: Suggestion displayed and API called with correct args');
});
it('handles API errors (non-200 response) gracefully', async () => {
console.log('TEST: Verifying API error handling (400/500 responses)');
const user = userEvent.setup();
renderWithProviders(<RecipeSuggester />);
const input = screen.getByLabelText(/Ingredients:/i);
await user.type(input, 'rocks');
// Mock API failure response
const errorMessage = 'Invalid ingredients provided.';
mockedApiClient.suggestRecipe.mockResolvedValue({
ok: false,
json: async () => ({ message: errorMessage }),
} as Response);
const button = screen.getByRole('button', { name: /Suggest a Recipe/i });
await user.click(button);
await waitFor(() => {
expect(screen.getByText(errorMessage)).toBeInTheDocument();
});
// Ensure loading state is reset
expect(screen.getByRole('button', { name: /Suggest a Recipe/i })).toBeEnabled();
console.log('TEST: API error message displayed to user');
});
it('handles network exceptions and logs them', async () => {
console.log('TEST: Verifying network exception handling');
const user = userEvent.setup();
renderWithProviders(<RecipeSuggester />);
const input = screen.getByLabelText(/Ingredients:/i);
await user.type(input, 'beef');
// Mock network error
const networkError = new Error('Network Error');
mockedApiClient.suggestRecipe.mockRejectedValue(networkError);
const button = screen.getByRole('button', { name: /Suggest a Recipe/i });
await user.click(button);
await waitFor(() => {
expect(screen.getByText('Network Error')).toBeInTheDocument();
});
expect(logger.error).toHaveBeenCalledWith(
{ error: networkError },
'Failed to fetch recipe suggestion.'
);
console.log('TEST: Network error caught and logged');
});
it('clears previous errors when submitting again', async () => {
console.log('TEST: Verifying error clearing on re-submit');
const user = userEvent.setup();
renderWithProviders(<RecipeSuggester />);
// Trigger validation error first
const button = screen.getByRole('button', { name: /Suggest a Recipe/i });
await user.click(button);
expect(screen.getByText('Please enter at least one ingredient.')).toBeInTheDocument();
// Now type something to clear it (state change doesn't clear it, submit does)
const input = screen.getByLabelText(/Ingredients:/i);
await user.type(input, 'tofu');
// Mock success for the second click
mockedApiClient.suggestRecipe.mockResolvedValue({
ok: true,
json: async () => ({ suggestion: 'Tofu Stir Fry' }),
} as Response);
await user.click(button);
await waitFor(() => {
expect(screen.queryByText('Please enter at least one ingredient.')).not.toBeInTheDocument();
expect(screen.getByText('Tofu Stir Fry')).toBeInTheDocument();
});
console.log('TEST: Previous error cleared successfully');
});
});

View File

@@ -0,0 +1,80 @@
// src/components/RecipeSuggester.tsx
import React, { useState, useCallback } from 'react';
import { suggestRecipe } from '../services/apiClient';
import { logger } from '../services/logger.client';
export const RecipeSuggester: React.FC = () => {
const [ingredients, setIngredients] = useState<string>('');
const [suggestion, setSuggestion] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState<boolean>(false);
const [error, setError] = useState<string | null>(null);
const handleSubmit = useCallback(async (event: React.FormEvent<HTMLFormElement>) => {
event.preventDefault();
setIsLoading(true);
setError(null);
setSuggestion(null);
const ingredientList = ingredients.split(',').map(item => item.trim()).filter(Boolean);
if (ingredientList.length === 0) {
setError('Please enter at least one ingredient.');
setIsLoading(false);
return;
}
try {
const response = await suggestRecipe(ingredientList);
const data = await response.json();
if (!response.ok) {
throw new Error(data.message || 'Failed to get suggestion.');
}
setSuggestion(data.suggestion);
} catch (err) {
const errorMessage = err instanceof Error ? err.message : 'An unknown error occurred.';
logger.error({ error: err }, 'Failed to fetch recipe suggestion.');
setError(errorMessage);
} finally {
setIsLoading(false);
}
}, [ingredients]);
return (
<div className="bg-white dark:bg-gray-800 shadow rounded-lg p-6">
<h2 className="text-xl font-semibold text-gray-900 dark:text-white mb-2">Get a Recipe Suggestion</h2>
<p className="text-gray-600 dark:text-gray-400 mb-4">Enter some ingredients you have, separated by commas.</p>
<form onSubmit={handleSubmit}>
<div className="mb-4">
<label htmlFor="ingredients-input" className="block text-sm font-medium text-gray-700 dark:text-gray-300 mb-1">Ingredients:</label>
<input
id="ingredients-input"
type="text"
value={ingredients}
onChange={(e) => setIngredients(e.target.value)}
placeholder="e.g., chicken, rice, broccoli"
disabled={isLoading}
className="block w-full rounded-md border-gray-300 shadow-sm focus:border-blue-500 focus:ring-blue-500 dark:bg-gray-700 dark:border-gray-600 dark:text-white sm:text-sm p-2 border"
/>
</div>
<button type="submit" disabled={isLoading} className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50 transition-colors">
{isLoading ? 'Getting suggestion...' : 'Suggest a Recipe'}
</button>
</form>
{error && (
<div className="mt-4 p-4 bg-red-50 dark:bg-red-900/50 text-red-700 dark:text-red-200 rounded-md text-sm">{error}</div>
)}
{suggestion && (
<div className="mt-6 bg-gray-50 dark:bg-gray-700/50 rounded-lg p-4 border border-gray-200 dark:border-gray-600">
<div className="prose dark:prose-invert max-w-none">
<h5 className="text-lg font-medium text-gray-900 dark:text-white mb-2">Recipe Suggestion</h5>
<p className="text-gray-700 dark:text-gray-300 whitespace-pre-wrap">{suggestion}</p>
</div>
</div>
)}
</div>
);
};

View File

@@ -0,0 +1,34 @@
// src/components/StatCard.test.tsx
import React from 'react';
import { screen } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import { StatCard } from './StatCard';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
import '@testing-library/jest-dom';
describe('StatCard', () => {
it('renders title and value correctly', () => {
renderWithProviders(
<StatCard
title="Total Users"
value="1,234"
icon={<div data-testid="mock-icon">Icon</div>}
/>,
);
expect(screen.getByText('Total Users')).toBeInTheDocument();
expect(screen.getByText('1,234')).toBeInTheDocument();
});
it('renders the icon', () => {
renderWithProviders(
<StatCard
title="Total Users"
value="1,234"
icon={<div data-testid="mock-icon">Icon</div>}
/>,
);
expect(screen.getByTestId('mock-icon')).toBeInTheDocument();
});
});

View File

@@ -0,0 +1,32 @@
// src/components/StatCard.tsx
import React, { ReactNode } from 'react';
interface StatCardProps {
title: string;
value: string;
icon: ReactNode;
}
export const StatCard: React.FC<StatCardProps> = ({ title, value, icon }) => {
return (
<div className="bg-white dark:bg-gray-800 overflow-hidden shadow rounded-lg">
<div className="p-5">
<div className="flex items-center">
<div className="flex-shrink-0">
<div className="flex items-center justify-center h-12 w-12 rounded-md bg-blue-500 text-white">
{icon}
</div>
</div>
<div className="ml-5 w-0 flex-1">
<dl>
<dt className="text-sm font-medium text-gray-500 dark:text-gray-400 truncate">{title}</dt>
<dd>
<div className="text-lg font-medium text-gray-900 dark:text-white">{value}</div>
</dd>
</dl>
</div>
</div>
</div>
</div>
);
};

View File

@@ -1,8 +1,9 @@
// src/components/UnitSystemToggle.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { screen, fireEvent } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { UnitSystemToggle } from './UnitSystemToggle';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
describe('UnitSystemToggle', () => {
const mockOnToggle = vi.fn();
@@ -12,7 +13,7 @@ describe('UnitSystemToggle', () => {
});
it('should render correctly for imperial system', () => {
render(<UnitSystemToggle currentSystem="imperial" onToggle={mockOnToggle} />);
renderWithProviders(<UnitSystemToggle currentSystem="imperial" onToggle={mockOnToggle} />);
const checkbox = screen.getByRole('checkbox');
expect(checkbox).toBeChecked();
@@ -23,7 +24,7 @@ describe('UnitSystemToggle', () => {
});
it('should render correctly for metric system', () => {
render(<UnitSystemToggle currentSystem="metric" onToggle={mockOnToggle} />);
renderWithProviders(<UnitSystemToggle currentSystem="metric" onToggle={mockOnToggle} />);
const checkbox = screen.getByRole('checkbox');
expect(checkbox).not.toBeChecked();
@@ -34,7 +35,7 @@ describe('UnitSystemToggle', () => {
});
it('should call onToggle when the toggle is clicked', () => {
render(<UnitSystemToggle currentSystem="metric" onToggle={mockOnToggle} />);
renderWithProviders(<UnitSystemToggle currentSystem="metric" onToggle={mockOnToggle} />);
fireEvent.click(screen.getByRole('checkbox'));
expect(mockOnToggle).toHaveBeenCalledTimes(1);
});

View File

@@ -1,34 +1,34 @@
// src/components/UserMenuSkeleton.test.tsx
import React from 'react';
import { render } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import { UserMenuSkeleton } from './UserMenuSkeleton';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
describe('UserMenuSkeleton', () => {
it('should render without crashing', () => {
const { container } = render(<UserMenuSkeleton />);
const { container } = renderWithProviders(<UserMenuSkeleton />);
expect(container.firstChild).toBeInTheDocument();
});
it('should have the main container with pulse animation', () => {
const { container } = render(<UserMenuSkeleton />);
const { container } = renderWithProviders(<UserMenuSkeleton />);
expect(container.firstChild).toHaveClass('animate-pulse');
});
it('should render two child placeholder elements', () => {
const { container } = render(<UserMenuSkeleton />);
const { container } = renderWithProviders(<UserMenuSkeleton />);
expect(container.firstChild?.childNodes.length).toBe(2);
});
it('should render a rectangular placeholder with correct styles', () => {
const { container } = render(<UserMenuSkeleton />);
const { container } = renderWithProviders(<UserMenuSkeleton />);
expect(container.querySelector('.rounded-md')).toHaveClass(
'h-8 w-24 bg-gray-200 dark:bg-gray-700',
);
});
it('should render a circular placeholder with correct styles', () => {
const { container } = render(<UserMenuSkeleton />);
const { container } = renderWithProviders(<UserMenuSkeleton />);
expect(container.querySelector('.rounded-full')).toHaveClass(
'h-10 w-10 bg-gray-200 dark:bg-gray-700',
);

View File

@@ -1,8 +1,9 @@
// src/components/WhatsNewModal.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { screen, fireEvent } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { WhatsNewModal } from './WhatsNewModal';
import { renderWithProviders } from '../tests/utils/renderWithProviders';
// Unmock the component to test the real implementation
vi.unmock('./WhatsNewModal');
@@ -21,13 +22,13 @@ describe('WhatsNewModal', () => {
});
it('should not render when isOpen is false', () => {
const { container } = render(<WhatsNewModal {...defaultProps} isOpen={false} />);
const { container } = renderWithProviders(<WhatsNewModal {...defaultProps} isOpen={false} />);
// The component returns null, so the container should be empty.
expect(container.firstChild).toBeNull();
});
it('should render correctly when isOpen is true', () => {
render(<WhatsNewModal {...defaultProps} />);
renderWithProviders(<WhatsNewModal {...defaultProps} />);
expect(screen.getByRole('heading', { name: /what's new/i })).toBeInTheDocument();
expect(screen.getByText(`Version: ${defaultProps.version}`)).toBeInTheDocument();
@@ -36,13 +37,13 @@ describe('WhatsNewModal', () => {
});
it('should call onClose when the "Got it!" button is clicked', () => {
render(<WhatsNewModal {...defaultProps} />);
renderWithProviders(<WhatsNewModal {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /got it/i }));
expect(mockOnClose).toHaveBeenCalledTimes(1);
});
it('should call onClose when the close icon button is clicked', () => {
render(<WhatsNewModal {...defaultProps} />);
renderWithProviders(<WhatsNewModal {...defaultProps} />);
// The close button is an SVG icon inside a button, best queried by its aria-label.
const closeButton = screen.getByRole('button', { name: /close/i });
fireEvent.click(closeButton);
@@ -50,7 +51,7 @@ describe('WhatsNewModal', () => {
});
it('should call onClose when clicking on the overlay', () => {
render(<WhatsNewModal {...defaultProps} />);
renderWithProviders(<WhatsNewModal {...defaultProps} />);
// The overlay is the root div with the background color.
const overlay = screen.getByRole('dialog').parentElement;
fireEvent.click(overlay!);
@@ -58,7 +59,7 @@ describe('WhatsNewModal', () => {
});
it('should not call onClose when clicking inside the modal content', () => {
render(<WhatsNewModal {...defaultProps} />);
renderWithProviders(<WhatsNewModal {...defaultProps} />);
fireEvent.click(screen.getByText(defaultProps.commitMessage));
expect(mockOnClose).not.toHaveBeenCalled();
});

View File

@@ -111,7 +111,7 @@ async function main() {
const flyerQuery = `
INSERT INTO public.flyers (file_name, image_url, checksum, store_id, valid_from, valid_to)
VALUES ('safeway-flyer.jpg', '/sample-assets/safeway-flyer.jpg', 'sample-checksum-123', ${storeMap.get('Safeway')}, $1, $2)
VALUES ('safeway-flyer.jpg', 'https://example.com/flyer-images/safeway-flyer.jpg', 'a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0', ${storeMap.get('Safeway')}, $1, $2)
RETURNING flyer_id;
`;
const flyerRes = await client.query<{ flyer_id: number }>(flyerQuery, [

View File

@@ -12,12 +12,7 @@ import {
} from '../tests/utils/mockFactories';
import { mockUseFlyers, mockUseUserData } from '../tests/setup/mockHooks';
// Explicitly mock apiClient to ensure stable spies are used
vi.mock('../services/apiClient', () => ({
countFlyerItemsForFlyers: vi.fn(),
fetchFlyerItemsForFlyers: vi.fn(),
}));
// The apiClient is mocked globally in `src/tests/setup/globalApiMock.ts`.
// Mock the hooks to avoid Missing Context errors
vi.mock('./useFlyers', () => ({
useFlyers: () => mockUseFlyers(),
@@ -30,14 +25,6 @@ vi.mock('../hooks/useUserData', () => ({
// The apiClient is globally mocked in our test setup, so we just need to cast it
const mockedApiClient = vi.mocked(apiClient);
// Mock the logger to prevent console noise
vi.mock('../services/logger.client', () => ({
logger: {
error: vi.fn(),
info: vi.fn(), // Added to prevent crashes on abort logging
},
}));
// Set a consistent "today" for testing flyer validity to make tests deterministic
const TODAY = new Date('2024-01-15T12:00:00.000Z');

View File

@@ -11,21 +11,9 @@ import { createMockUserProfile } from '../tests/utils/mockFactories';
import { logger } from '../services/logger.client';
// Mock the dependencies
vi.mock('../services/apiClient', () => ({
// Mock other functions if needed
getAuthenticatedUserProfile: vi.fn(),
}));
// The apiClient is mocked globally in `src/tests/setup/globalApiMock.ts`.
vi.mock('../services/tokenStorage');
// Mock the logger to spy on its methods
vi.mock('../services/logger.client', () => ({
logger: {
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
},
}));
const mockedApiClient = vi.mocked(apiClient);
const mockedTokenStorage = vi.mocked(tokenStorage);

View File

@@ -3,12 +3,11 @@ import { renderHook } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { useFlyerItems } from './useFlyerItems';
import { useApiOnMount } from './useApiOnMount';
import { createMockFlyer, createMockFlyerItem } from '../tests/utils/mockFactories';
import * as apiClient from '../services/apiClient';
import { createMockFlyer, createMockFlyerItem } from '../tests/utils/mockFactories';
// Mock the underlying useApiOnMount hook to isolate the useFlyerItems hook's logic.
vi.mock('./useApiOnMount');
vi.mock('../services/apiClient');
const mockedUseApiOnMount = vi.mocked(useApiOnMount);
@@ -61,7 +60,6 @@ describe('useFlyerItems Hook', () => {
expect(result.current.flyerItems).toEqual([]);
expect(result.current.isLoading).toBe(false);
expect(result.current.error).toBeNull();
// Assert: Check that useApiOnMount was called with `enabled: false`.
expect(mockedUseApiOnMount).toHaveBeenCalledWith(
expect.any(Function), // the wrapped fetcher function
@@ -171,11 +169,11 @@ describe('useFlyerItems Hook', () => {
const wrappedFetcher = mockedUseApiOnMount.mock.calls[0][0];
const mockResponse = new Response();
vi.mocked(apiClient.fetchFlyerItems).mockResolvedValue(mockResponse);
const mockedApiClient = vi.mocked(apiClient);
mockedApiClient.fetchFlyerItems.mockResolvedValue(mockResponse);
const response = await wrappedFetcher(123);
expect(apiClient.fetchFlyerItems).toHaveBeenCalledWith(123);
expect(mockedApiClient.fetchFlyerItems).toHaveBeenCalledWith(123);
expect(response).toBe(mockResponse);
});
});

View File

@@ -29,7 +29,6 @@ type MockApiResult = {
vi.mock('./useApi');
vi.mock('../hooks/useAuth');
vi.mock('../hooks/useUserData');
vi.mock('../services/apiClient');
// The apiClient is globally mocked in our test setup, so we just need to cast it
const mockedUseApi = vi.mocked(useApi);

View File

@@ -17,7 +17,6 @@ import {
vi.mock('./useApi');
vi.mock('../hooks/useAuth');
vi.mock('../hooks/useUserData');
vi.mock('../services/apiClient');
// The apiClient is globally mocked in our test setup, so we just need to cast it
const mockedUseApi = vi.mocked(useApi);

View File

@@ -1,25 +1,15 @@
// src/components/MyDealsPage.test.tsx
// src/pages/MyDealsPage.test.tsx
import React from 'react';
import { render, screen, waitFor } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, type Mocked } from 'vitest';
import MyDealsPage from './MyDealsPage';
import * as apiClient from '../services/apiClient';
import { WatchedItemDeal } from '../types';
import type { WatchedItemDeal } from '../types';
import { logger } from '../services/logger.client';
import { createMockWatchedItemDeal } from '../tests/utils/mockFactories';
// Mock the apiClient. The component now directly uses `fetchBestSalePrices`.
// By mocking the entire module, we can control the behavior of `fetchBestSalePrices`
// for our tests.
vi.mock('../services/apiClient');
const mockedApiClient = apiClient as Mocked<typeof apiClient>;
// Mock the logger
vi.mock('../services/logger.client', () => ({
logger: {
error: vi.fn(),
},
}));
// The apiClient is mocked globally in `src/tests/setup/globalApiMock.ts`.
const mockedApiClient = vi.mocked(apiClient);
// Mock lucide-react icons to prevent rendering errors in the test environment
vi.mock('lucide-react', () => ({

View File

@@ -10,13 +10,7 @@ import { logger } from '../services/logger.client';
// The apiClient and logger are now mocked globally.
const mockedApiClient = vi.mocked(apiClient);
vi.mock('../services/logger.client', () => ({
logger: {
info: vi.fn(),
error: vi.fn(),
},
}));
// The logger is mocked globally.
// Helper function to render the component within a router context
const renderWithRouter = (token: string) => {
return render(

View File

@@ -11,16 +11,8 @@ import {
createMockUser,
} from '../tests/utils/mockFactories';
// Mock dependencies
vi.mock('../services/apiClient'); // This was correct
vi.mock('../services/logger.client', () => ({
logger: {
info: vi.fn(),
error: vi.fn(),
},
}));
vi.mock('../services/notificationService');
vi.mock('../services/aiApiClient'); // Mock aiApiClient as it's used in the component
// The apiClient, logger, notificationService, and aiApiClient are all mocked globally.
// We can get a typed reference to the notificationService for individual test overrides.
const mockedNotificationService = vi.mocked(await import('../services/notificationService'));
vi.mock('../components/AchievementsList', () => ({
AchievementsList: ({ achievements }: { achievements: (UserAchievement & Achievement)[] }) => (
@@ -28,7 +20,7 @@ vi.mock('../components/AchievementsList', () => ({
),
}));
const mockedApiClient = apiClient as Mocked<typeof apiClient>;
const mockedApiClient = vi.mocked(apiClient);
// --- Mock Data ---
const mockProfile: UserProfile = createMockUserProfile({

View File

@@ -10,21 +10,10 @@ import { logger } from '../services/logger.client';
// Extensive logging for debugging
const LOG_PREFIX = '[TEST DEBUG]';
vi.mock('../services/notificationService');
// 1. Mock the module to replace its exports with mock functions.
vi.mock('../services/aiApiClient');
// 2. Get a typed reference to the mocked module to control its functions in tests.
// The aiApiClient, notificationService, and logger are mocked globally.
// We can get a typed reference to the aiApiClient for individual test overrides.
const mockedAiApiClient = vi.mocked(aiApiClient);
// Mock the logger
vi.mock('../services/logger.client', () => ({
logger: {
info: vi.fn(),
error: vi.fn(),
},
}));
// Define mock at module level so it can be referenced in the implementation
const mockAudioPlay = vi.fn(() => {
console.log(`${LOG_PREFIX} mockAudioPlay executed`);

View File

@@ -7,13 +7,13 @@ import { AdminStatsPage } from './AdminStatsPage';
import * as apiClient from '../../services/apiClient';
import type { AppStats } from '../../services/apiClient';
import { createMockAppStats } from '../../tests/utils/mockFactories';
import { StatCard } from './components/StatCard';
import { StatCard } from '../../components/StatCard';
// The apiClient and logger are now mocked globally via src/tests/setup/tests-setup-unit.ts.
const mockedApiClient = vi.mocked(apiClient);
// Mock the child StatCard component to use the shared mock and allow spying
vi.mock('./components/StatCard', async () => {
vi.mock('../../components/StatCard', async () => {
const { MockStatCard } = await import('../../tests/utils/componentMocks');
return { StatCard: vi.fn(MockStatCard) };
});

View File

@@ -10,7 +10,7 @@ import { DocumentDuplicateIcon } from '../../components/icons/DocumentDuplicateI
import { BuildingStorefrontIcon } from '../../components/icons/BuildingStorefrontIcon';
import { BellAlertIcon } from '../../components/icons/BellAlertIcon';
import { BookOpenIcon } from '../../components/icons/BookOpenIcon';
import { StatCard } from './components/StatCard';
import { StatCard } from '../../components/StatCard';
export const AdminStatsPage: React.FC = () => {
const [stats, setStats] = useState<AppStats | null>(null);

View File

@@ -6,16 +6,9 @@ import { MemoryRouter } from 'react-router-dom';
import * as apiClient from '../../services/apiClient';
import { logger } from '../../services/logger.client';
// Mock dependencies
vi.mock('../../services/apiClient', () => ({
getFlyersForReview: vi.fn(),
}));
vi.mock('../../services/logger.client', () => ({
logger: {
error: vi.fn(),
},
}));
// The apiClient and logger are mocked globally.
// We can get a typed reference to the apiClient for individual test overrides.
const mockedApiClient = vi.mocked(apiClient);
// Mock LoadingSpinner to simplify DOM and avoid potential issues
vi.mock('../../components/LoadingSpinner', () => ({
@@ -29,7 +22,7 @@ describe('FlyerReviewPage', () => {
it('renders loading spinner initially', () => {
// Mock a promise that doesn't resolve immediately to check loading state
vi.mocked(apiClient.getFlyersForReview).mockReturnValue(new Promise(() => {}));
mockedApiClient.getFlyersForReview.mockReturnValue(new Promise(() => {}));
render(
<MemoryRouter>
@@ -41,7 +34,7 @@ describe('FlyerReviewPage', () => {
});
it('renders empty state when no flyers are returned', async () => {
vi.mocked(apiClient.getFlyersForReview).mockResolvedValue({
mockedApiClient.getFlyersForReview.mockResolvedValue({
ok: true,
json: async () => [],
} as Response);
@@ -84,7 +77,7 @@ describe('FlyerReviewPage', () => {
},
];
vi.mocked(apiClient.getFlyersForReview).mockResolvedValue({
mockedApiClient.getFlyersForReview.mockResolvedValue({
ok: true,
json: async () => mockFlyers,
} as Response);
@@ -114,7 +107,7 @@ describe('FlyerReviewPage', () => {
});
it('renders error message when API response is not ok', async () => {
vi.mocked(apiClient.getFlyersForReview).mockResolvedValue({
mockedApiClient.getFlyersForReview.mockResolvedValue({
ok: false,
json: async () => ({ message: 'Server error' }),
} as Response);
@@ -138,7 +131,7 @@ describe('FlyerReviewPage', () => {
it('renders error message when API throws an error', async () => {
const networkError = new Error('Network error');
vi.mocked(apiClient.getFlyersForReview).mockRejectedValue(networkError);
mockedApiClient.getFlyersForReview.mockRejectedValue(networkError);
render(
<MemoryRouter>
@@ -159,7 +152,7 @@ describe('FlyerReviewPage', () => {
it('renders a generic error for non-Error rejections', async () => {
const nonErrorRejection = { message: 'This is not an Error object' };
vi.mocked(apiClient.getFlyersForReview).mockRejectedValue(nonErrorRejection);
mockedApiClient.getFlyersForReview.mockRejectedValue(nonErrorRejection);
render(
<MemoryRouter>

View File

@@ -1,9 +1,10 @@
// src/pages/admin/components/AddressForm.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import { screen, fireEvent } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { AddressForm } from './AddressForm';
import { createMockAddress } from '../../../tests/utils/mockFactories';
import { renderWithProviders } from '../../../tests/utils/renderWithProviders';
// Mock child components and icons to isolate the form's logic
vi.mock('lucide-react', () => ({
@@ -30,7 +31,7 @@ describe('AddressForm', () => {
});
it('should render all address fields correctly', () => {
render(<AddressForm {...defaultProps} />);
renderWithProviders(<AddressForm {...defaultProps} />);
expect(screen.getByRole('heading', { name: /home address/i })).toBeInTheDocument();
expect(screen.getByLabelText(/address line 1/i)).toBeInTheDocument();
@@ -48,7 +49,7 @@ describe('AddressForm', () => {
city: 'Anytown',
country: 'Canada',
});
render(<AddressForm {...defaultProps} address={fullAddress} />);
renderWithProviders(<AddressForm {...defaultProps} address={fullAddress} />);
expect(screen.getByLabelText(/address line 1/i)).toHaveValue('123 Main St');
expect(screen.getByLabelText(/city/i)).toHaveValue('Anytown');
@@ -56,7 +57,7 @@ describe('AddressForm', () => {
});
it('should call onAddressChange with the correct field and value for all inputs', () => {
render(<AddressForm {...defaultProps} />);
renderWithProviders(<AddressForm {...defaultProps} />);
const inputs = [
{ label: /address line 1/i, name: 'address_line_1', value: '123 St' },
@@ -75,7 +76,7 @@ describe('AddressForm', () => {
});
it('should call onGeocode when the "Re-Geocode" button is clicked', () => {
render(<AddressForm {...defaultProps} />);
renderWithProviders(<AddressForm {...defaultProps} />);
const geocodeButton = screen.getByRole('button', { name: /re-geocode/i });
fireEvent.click(geocodeButton);
@@ -84,14 +85,14 @@ describe('AddressForm', () => {
});
it('should show MapPinIcon when not geocoding', () => {
render(<AddressForm {...defaultProps} isGeocoding={false} />);
renderWithProviders(<AddressForm {...defaultProps} isGeocoding={false} />);
expect(screen.getByTestId('map-pin-icon')).toBeInTheDocument();
expect(screen.queryByTestId('loading-spinner')).not.toBeInTheDocument();
});
describe('when isGeocoding is true', () => {
it('should disable the button and show a loading spinner', () => {
render(<AddressForm {...defaultProps} isGeocoding={true} />);
renderWithProviders(<AddressForm {...defaultProps} isGeocoding={true} />);
const geocodeButton = screen.getByRole('button', { name: /re-geocode/i });
expect(geocodeButton).toBeDisabled();

View File

@@ -1,11 +1,12 @@
// src/pages/admin/components/AdminBrandManager.test.tsx
import React from 'react';
import { render, screen, fireEvent, waitFor } from '@testing-library/react';
import { screen, fireEvent, waitFor } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import toast from 'react-hot-toast';
import { AdminBrandManager } from './AdminBrandManager';
import * as apiClient from '../../../services/apiClient';
import { createMockBrand } from '../../../tests/utils/mockFactories';
import { renderWithProviders } from '../../../tests/utils/renderWithProviders';
// After mocking, we can get a type-safe mocked version of the module.
// This allows us to use .mockResolvedValue, .mockRejectedValue, etc. on the functions.
@@ -34,7 +35,7 @@ describe('AdminBrandManager', () => {
mockedApiClient.fetchAllBrands.mockReturnValue(new Promise(() => {}));
console.log('TEST ACTION: Rendering AdminBrandManager component.');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
console.log('TEST ASSERTION: Checking for the loading text.');
expect(screen.getByText('Loading brands...')).toBeInTheDocument();
@@ -49,7 +50,7 @@ describe('AdminBrandManager', () => {
mockedApiClient.fetchAllBrands.mockRejectedValue(new Error('Network Error'));
console.log('TEST ACTION: Rendering AdminBrandManager component.');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
console.log('TEST ASSERTION: Waiting for error message to be displayed.');
await waitFor(() => {
@@ -69,7 +70,7 @@ describe('AdminBrandManager', () => {
);
console.log('TEST ACTION: Rendering AdminBrandManager component.');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
console.log('TEST ASSERTION: Waiting for brand list to render.');
await waitFor(() => {
@@ -98,7 +99,7 @@ describe('AdminBrandManager', () => {
mockedToast.loading.mockReturnValue('toast-1');
console.log('TEST ACTION: Rendering AdminBrandManager component.');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
console.log('TEST ACTION: Waiting for initial brands to render.');
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
@@ -135,7 +136,7 @@ describe('AdminBrandManager', () => {
mockedApiClient.uploadBrandLogo.mockRejectedValue('A string error');
mockedToast.loading.mockReturnValue('toast-non-error');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
const file = new File(['logo'], 'logo.png', { type: 'image/png' });
@@ -162,7 +163,7 @@ describe('AdminBrandManager', () => {
mockedToast.loading.mockReturnValue('toast-2');
console.log('TEST ACTION: Rendering AdminBrandManager component.');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
console.log('TEST ACTION: Waiting for initial brands to render.');
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
@@ -189,7 +190,7 @@ describe('AdminBrandManager', () => {
async () => new Response(JSON.stringify(mockBrands), { status: 200 }),
);
console.log('TEST ACTION: Rendering AdminBrandManager component.');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
console.log('TEST ACTION: Waiting for initial brands to render.');
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
@@ -217,7 +218,7 @@ describe('AdminBrandManager', () => {
async () => new Response(JSON.stringify(mockBrands), { status: 200 }),
);
console.log('TEST ACTION: Rendering AdminBrandManager component.');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
console.log('TEST ACTION: Waiting for initial brands to render.');
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
@@ -247,7 +248,7 @@ describe('AdminBrandManager', () => {
);
mockedToast.loading.mockReturnValue('toast-3');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
const file = new File(['logo'], 'logo.png', { type: 'image/png' });
@@ -270,7 +271,7 @@ describe('AdminBrandManager', () => {
mockedApiClient.fetchAllBrands.mockImplementation(
async () => new Response(JSON.stringify(mockBrands), { status: 200 }),
);
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
console.log('TEST ACTION: Waiting for initial brands to render.');
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
@@ -291,7 +292,7 @@ describe('AdminBrandManager', () => {
mockedApiClient.fetchAllBrands.mockImplementation(
async () => new Response(JSON.stringify([]), { status: 200 }),
);
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
await waitFor(() => {
expect(screen.getByRole('heading', { name: /brand management/i })).toBeInTheDocument();
@@ -309,7 +310,7 @@ describe('AdminBrandManager', () => {
);
mockedToast.loading.mockReturnValue('toast-fallback');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
const file = new File(['logo'], 'logo.png', { type: 'image/png' });
@@ -333,7 +334,7 @@ describe('AdminBrandManager', () => {
);
mockedToast.loading.mockReturnValue('toast-opt');
render(<AdminBrandManager />);
renderWithProviders(<AdminBrandManager />);
await waitFor(() => expect(screen.getByText('No Frills')).toBeInTheDocument());
// Brand 1: No Frills (initially null logo)

View File

@@ -1,11 +1,12 @@
// src/pages/admin/components/AuthView.test.tsx
import React from 'react';
import { render, screen, fireEvent, waitFor, act } from '@testing-library/react';
import { screen, fireEvent, waitFor } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest';
import { AuthView } from './AuthView';
import * as apiClient from '../../../services/apiClient';
import { notifySuccess, notifyError } from '../../../services/notificationService';
import { createMockUserProfile } from '../../../tests/utils/mockFactories';
import { renderWithProviders } from '../../../tests/utils/renderWithProviders';
const mockedApiClient = vi.mocked(apiClient, true);
@@ -46,7 +47,7 @@ describe('AuthView', () => {
describe('Initial Render and Login', () => {
it('should render the Sign In form by default', () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
expect(screen.getByRole('heading', { name: /sign in/i })).toBeInTheDocument();
expect(screen.getByLabelText(/email address/i)).toBeInTheDocument();
expect(screen.getByLabelText(/^password$/i)).toBeInTheDocument();
@@ -54,7 +55,7 @@ describe('AuthView', () => {
});
it('should allow typing in email and password fields', () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
const emailInput = screen.getByLabelText(/email address/i);
const passwordInput = screen.getByLabelText(/^password$/i);
@@ -66,7 +67,7 @@ describe('AuthView', () => {
});
it('should call loginUser and onLoginSuccess on successful login', async () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.change(screen.getByLabelText(/email address/i), {
target: { value: 'test@example.com' },
});
@@ -94,7 +95,7 @@ describe('AuthView', () => {
it('should display an error on failed login', async () => {
(mockedApiClient.loginUser as Mock).mockRejectedValueOnce(new Error('Invalid credentials'));
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.submit(screen.getByTestId('auth-form'));
await waitFor(() => {
@@ -107,7 +108,7 @@ describe('AuthView', () => {
(mockedApiClient.loginUser as Mock).mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'Unauthorized' }), { status: 401 }),
);
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.submit(screen.getByTestId('auth-form'));
await waitFor(() => {
@@ -120,7 +121,7 @@ describe('AuthView', () => {
describe('Registration', () => {
it('should switch to the registration form', () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /don't have an account\? register/i }));
expect(screen.getByRole('heading', { name: /create an account/i })).toBeInTheDocument();
@@ -129,7 +130,7 @@ describe('AuthView', () => {
});
it('should call registerUser on successful registration', async () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /don't have an account\? register/i }));
fireEvent.change(screen.getByLabelText(/full name/i), { target: { value: 'Test User' } });
@@ -157,7 +158,7 @@ describe('AuthView', () => {
});
it('should allow registration without providing a full name', async () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /don't have an account\? register/i }));
// Do not fill in the full name, which is marked as optional
@@ -184,7 +185,7 @@ describe('AuthView', () => {
(mockedApiClient.registerUser as Mock).mockRejectedValueOnce(
new Error('Email already exists'),
);
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /don't have an account\? register/i }));
fireEvent.submit(screen.getByTestId('auth-form'));
@@ -197,7 +198,7 @@ describe('AuthView', () => {
(mockedApiClient.registerUser as Mock).mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'User exists' }), { status: 409 }),
);
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /don't have an account\? register/i }));
fireEvent.submit(screen.getByTestId('auth-form'));
@@ -209,7 +210,7 @@ describe('AuthView', () => {
describe('Forgot Password', () => {
it('should switch to the reset password form', () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /forgot password\?/i }));
expect(screen.getByRole('heading', { name: /reset password/i })).toBeInTheDocument();
@@ -217,7 +218,7 @@ describe('AuthView', () => {
});
it('should call requestPasswordReset and show success message', async () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /forgot password\?/i }));
fireEvent.change(screen.getByLabelText(/email address/i), {
@@ -238,7 +239,7 @@ describe('AuthView', () => {
(mockedApiClient.requestPasswordReset as Mock).mockRejectedValueOnce(
new Error('User not found'),
);
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /forgot password\?/i }));
fireEvent.submit(screen.getByTestId('reset-password-form'));
@@ -251,7 +252,7 @@ describe('AuthView', () => {
(mockedApiClient.requestPasswordReset as Mock).mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'Rate limit exceeded' }), { status: 429 }),
);
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /forgot password\?/i }));
fireEvent.submit(screen.getByTestId('reset-password-form'));
@@ -261,7 +262,7 @@ describe('AuthView', () => {
});
it('should switch back to sign in from forgot password', () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /forgot password\?/i }));
fireEvent.click(screen.getByRole('button', { name: /back to sign in/i }));
@@ -287,13 +288,13 @@ describe('AuthView', () => {
});
it('should set window.location.href for Google OAuth', () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /sign in with google/i }));
expect(window.location.href).toBe('/api/auth/google');
});
it('should set window.location.href for GitHub OAuth', () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /sign in with github/i }));
expect(window.location.href).toBe('/api/auth/github');
});
@@ -301,7 +302,7 @@ describe('AuthView', () => {
describe('UI Logic and Loading States', () => {
it('should toggle "Remember me" checkbox', () => {
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
const rememberMeCheckbox = screen.getByRole('checkbox', { name: /remember me/i });
expect(rememberMeCheckbox).not.toBeChecked();
@@ -316,7 +317,7 @@ describe('AuthView', () => {
it('should show loading state during login submission', async () => {
// Mock a promise that doesn't resolve immediately
(mockedApiClient.loginUser as Mock).mockReturnValue(new Promise(() => {}));
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.change(screen.getByLabelText(/email address/i), {
target: { value: 'test@example.com' },
@@ -341,7 +342,7 @@ describe('AuthView', () => {
it('should show loading state during password reset submission', async () => {
(mockedApiClient.requestPasswordReset as Mock).mockReturnValue(new Promise(() => {}));
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
fireEvent.click(screen.getByRole('button', { name: /forgot password\?/i }));
@@ -362,7 +363,7 @@ describe('AuthView', () => {
it('should show loading state during registration submission', async () => {
// Mock a promise that doesn't resolve immediately
(mockedApiClient.registerUser as Mock).mockReturnValue(new Promise(() => {}));
render(<AuthView {...defaultProps} />);
renderWithProviders(<AuthView {...defaultProps} />);
// Switch to registration view
fireEvent.click(screen.getByRole('button', { name: /don't have an account\? register/i }));

View File

@@ -1,7 +1,7 @@
// src/pages/admin/components/CorrectionRow.test.tsx
import React from 'react';
import ReactDOM from 'react-dom';
import { render, screen, fireEvent, waitFor } from '@testing-library/react';
import { screen, fireEvent, waitFor } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, type Mocked } from 'vitest';
import { CorrectionRow } from './CorrectionRow';
import * as apiClient from '../../../services/apiClient';
@@ -10,15 +10,11 @@ import {
createMockMasterGroceryItem,
createMockCategory,
} from '../../../tests/utils/mockFactories';
import { renderWithProviders } from '../../../tests/utils/renderWithProviders';
// Cast the mocked module to its mocked type to retain type safety and autocompletion.
// The apiClient is now mocked globally via src/tests/setup/tests-setup-unit.ts.
const mockedApiClient = apiClient as Mocked<typeof apiClient>;
// Mock the logger
vi.mock('../../../services/logger', () => ({
logger: { info: vi.fn(), error: vi.fn() },
}));
// The apiClient and logger are mocked globally.
// We can get a typed reference to the apiClient for individual test overrides.
const mockedApiClient = vi.mocked(apiClient);
// Mock the ConfirmationModal to test its props and interactions
// The ConfirmationModal is now in a different directory.
@@ -80,7 +76,7 @@ const defaultProps = {
// Helper to render the component inside a table structure
const renderInTable = (props = defaultProps) => {
return render(
return renderWithProviders(
<table>
<tbody>
<CorrectionRow {...props} />

View File

@@ -21,25 +21,10 @@ vi.mock('../../../components/PasswordInput', () => ({
PasswordInput: (props: any) => <input {...props} data-testid="password-input" />,
}));
// The apiClient, notificationService, react-hot-toast, and logger are all mocked globally.
// We can get a typed reference to the apiClient for individual test overrides.
const mockedApiClient = vi.mocked(apiClient, true);
vi.mock('../../../services/notificationService');
vi.mock('react-hot-toast', () => ({
__esModule: true,
default: {
success: vi.fn(),
error: vi.fn(),
},
}));
vi.mock('../../../services/logger.client', () => ({
logger: {
debug: vi.fn(),
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
},
}));
const mockOnClose = vi.fn();
const mockOnLoginSuccess = vi.fn();
const mockOnSignOut = vi.fn();
@@ -883,6 +868,12 @@ describe('ProfileManager', () => {
});
});
it('should not render auth views when the user is already authenticated', () => {
render(<ProfileManager {...defaultAuthenticatedProps} />);
expect(screen.queryByText('Sign In')).not.toBeInTheDocument();
expect(screen.queryByText('Create an Account')).not.toBeInTheDocument();
});
it('should log warning if address fetch returns null', async () => {
console.log('[TEST DEBUG] Running: should log warning if address fetch returns null');
const loggerSpy = vi.spyOn(logger.logger, 'warn');
@@ -905,5 +896,113 @@ describe('ProfileManager', () => {
);
});
});
it('should handle updating the user profile and address with empty strings', async () => {
mockedApiClient.updateUserProfile.mockImplementation(async (data) =>
new Response(JSON.stringify({ ...authenticatedProfile, ...data })),
);
mockedApiClient.updateUserAddress.mockImplementation(async (data) =>
new Response(JSON.stringify({ ...mockAddress, ...data })),
);
render(<ProfileManager {...defaultAuthenticatedProps} />);
await waitFor(() => {
expect(screen.getByLabelText(/full name/i)).toHaveValue(authenticatedProfile.full_name);
});
await waitFor(() => expect(screen.getByLabelText(/city/i)).toHaveValue(mockAddress.city));
fireEvent.change(screen.getByLabelText(/full name/i), { target: { value: '' } });
fireEvent.change(screen.getByLabelText(/city/i), { target: { value: '' } });
const saveButton = screen.getByRole('button', { name: /save profile/i });
fireEvent.click(saveButton);
await waitFor(() => {
expect(mockedApiClient.updateUserProfile).toHaveBeenCalledWith(
{ full_name: '', avatar_url: authenticatedProfile.avatar_url },
expect.objectContaining({ signal: expect.anything() }),
);
expect(mockedApiClient.updateUserAddress).toHaveBeenCalledWith(
expect.objectContaining({ city: '' }),
expect.objectContaining({ signal: expect.anything() }),
);
expect(mockOnProfileUpdate).toHaveBeenCalledWith(
expect.objectContaining({ full_name: '' })
);
expect(notifySuccess).toHaveBeenCalledWith('Profile updated successfully!');
});
});
it('should correctly clear the form when userProfile.address_id is null', async () => {
const profileNoAddress = { ...authenticatedProfile, address_id: null };
render(
<ProfileManager
{...defaultAuthenticatedProps}
userProfile={profileNoAddress as any} // Forcefully override the type to simulate address_id: null
/>,
);
await waitFor(() => {
expect(screen.getByLabelText(/address line 1/i)).toHaveValue('');
expect(screen.getByLabelText(/city/i)).toHaveValue('');
expect(screen.getByLabelText(/province \/ state/i)).toHaveValue('');
expect(screen.getByLabelText(/postal \/ zip code/i)).toHaveValue('');
expect(screen.getByLabelText(/country/i)).toHaveValue('');
});
});
it('should show error notification when manual geocoding fails', async () => {
render(<ProfileManager {...defaultAuthenticatedProps} />);
await waitFor(() => expect(screen.getByLabelText(/city/i)).toHaveValue(mockAddress.city));
(mockedApiClient.geocodeAddress as Mock).mockRejectedValue(new Error('Geocoding failed'));
fireEvent.click(screen.getByRole('button', { name: /re-geocode/i }));
await waitFor(() => {
expect(notifyError).toHaveBeenCalledWith('Geocoding failed');
});
});
it('should show error notification when auto-geocoding fails', async () => {
vi.useFakeTimers();
// FIX: Mock getUserAddress to return an address *without* coordinates.
// This is the condition required to trigger the auto-geocoding logic.
const addressWithoutCoords = { ...mockAddress, latitude: undefined, longitude: undefined };
mockedApiClient.getUserAddress.mockResolvedValue(
new Response(JSON.stringify(addressWithoutCoords)),
);
render(<ProfileManager {...defaultAuthenticatedProps} />);
// Wait for initial load
await act(async () => {
await vi.runAllTimersAsync();
});
(mockedApiClient.geocodeAddress as Mock).mockRejectedValue(new Error('Auto-geocode error'));
fireEvent.change(screen.getByLabelText(/city/i), { target: { value: 'ErrorCity' } });
await act(async () => {
await vi.runAllTimersAsync();
});
expect(notifyError).toHaveBeenCalledWith('Auto-geocode error');
});
it('should handle permission denied error during geocoding', async () => {
render(<ProfileManager {...defaultAuthenticatedProps} />);
await waitFor(() => expect(screen.getByLabelText(/city/i)).toHaveValue(mockAddress.city));
(mockedApiClient.geocodeAddress as Mock).mockRejectedValue(new Error('Permission denied'));
fireEvent.click(screen.getByRole('button', { name: /re-geocode/i }));
await waitFor(() => {
expect(notifyError).toHaveBeenCalledWith('Permission denied');
});
});
});
});

View File

@@ -1,18 +1,19 @@
import React from 'react';
import { render, screen } from '@testing-library/react';
import { screen } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import { StatCard } from './StatCard';
import { renderWithProviders } from '../../../tests/utils/renderWithProviders';
describe('StatCard', () => {
it('should render the title and value correctly', () => {
render(<StatCard title="Test Stat" value="1,234" icon={<div data-testid="icon" />} />);
renderWithProviders(<StatCard title="Test Stat" value="1,234" icon={<div data-testid="icon" />} />);
expect(screen.getByText('Test Stat')).toBeInTheDocument();
expect(screen.getByText('1,234')).toBeInTheDocument();
});
it('should render the icon', () => {
render(
renderWithProviders(
<StatCard title="Test Stat" value={100} icon={<div data-testid="test-icon">Icon</div>} />,
);

View File

@@ -1,47 +1,18 @@
// src/pages/admin/components/SystemCheck.test.tsx
import React from 'react';
import { render, screen, waitFor, cleanup, fireEvent, act } from '@testing-library/react';
import { screen, waitFor, cleanup, fireEvent, act } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, afterEach, type Mock } from 'vitest';
import { SystemCheck } from './SystemCheck';
import * as apiClient from '../../../services/apiClient';
import toast from 'react-hot-toast';
import { createMockUser } from '../../../tests/utils/mockFactories';
import { renderWithProviders } from '../../../tests/utils/renderWithProviders';
// Mock the entire apiClient module to ensure all exports are defined.
// This is the primary fix for the error: [vitest] No "..." export is defined on the mock.
vi.mock('../../../services/apiClient', () => ({
pingBackend: vi.fn(),
checkStorage: vi.fn(),
checkDbPoolHealth: vi.fn(),
checkPm2Status: vi.fn(),
checkRedisHealth: vi.fn(),
checkDbSchema: vi.fn(),
loginUser: vi.fn(),
triggerFailingJob: vi.fn(),
clearGeocodeCache: vi.fn(),
}));
// Get a type-safe mocked version of the apiClient module.
// The apiClient is mocked globally in `src/tests/setup/globalApiMock.ts`.
// We can get a type-safe mocked version of the module to override functions for specific tests.
const mockedApiClient = vi.mocked(apiClient);
// Correct the relative path to the logger module.
vi.mock('../../../services/logger', () => ({
logger: {
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
debug: vi.fn(),
},
}));
// Mock toast to check for notifications
vi.mock('react-hot-toast', () => ({
__esModule: true,
default: {
success: vi.fn(),
error: vi.fn(),
},
}));
// The logger and react-hot-toast are mocked globally.
describe('SystemCheck', () => {
// Store original env variable
@@ -100,7 +71,7 @@ describe('SystemCheck', () => {
it('should render initial idle state and then run checks automatically on mount', async () => {
setGeminiApiKey('mock-api-key');
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
// Initially, all checks should be in 'running' state due to auto-run
// However, the API key check is synchronous and resolves immediately.
@@ -126,7 +97,7 @@ describe('SystemCheck', () => {
it('should show API key as failed if GEMINI_API_KEY is not set', async () => {
setGeminiApiKey(undefined);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
// Wait for the specific error message to appear.
expect(
@@ -139,7 +110,7 @@ describe('SystemCheck', () => {
it('should show backend connection as failed if pingBackend fails', async () => {
setGeminiApiKey('mock-api-key');
(mockedApiClient.pingBackend as Mock).mockRejectedValueOnce(new Error('Network error'));
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Network error')).toBeInTheDocument();
@@ -164,7 +135,7 @@ describe('SystemCheck', () => {
new Response(JSON.stringify({ success: false, message: 'PM2 process not found' })),
),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('PM2 process not found')).toBeInTheDocument();
@@ -174,7 +145,7 @@ describe('SystemCheck', () => {
it('should show database pool check as failed if checkDbPoolHealth fails', async () => {
setGeminiApiKey('mock-api-key'); // This was missing
mockedApiClient.checkDbPoolHealth.mockRejectedValueOnce(new Error('DB connection refused'));
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('DB connection refused')).toBeInTheDocument();
@@ -184,7 +155,7 @@ describe('SystemCheck', () => {
it('should show Redis check as failed if checkRedisHealth fails', async () => {
setGeminiApiKey('mock-api-key');
mockedApiClient.checkRedisHealth.mockRejectedValueOnce(new Error('Redis connection refused'));
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Redis connection refused')).toBeInTheDocument();
@@ -197,7 +168,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkDbPoolHealth.mockImplementationOnce(() =>
Promise.reject(new Error('DB connection refused')),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
// Verify the specific "skipped" messages for DB-dependent checks
@@ -214,7 +185,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkDbSchema.mockImplementationOnce(() =>
Promise.resolve(new Response(JSON.stringify({ success: false, message: 'Schema mismatch' }))),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Schema mismatch')).toBeInTheDocument();
@@ -224,7 +195,7 @@ describe('SystemCheck', () => {
it('should show seeded user check as failed if loginUser fails', async () => {
setGeminiApiKey('mock-api-key');
mockedApiClient.loginUser.mockRejectedValueOnce(new Error('Incorrect email or password'));
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(
@@ -236,7 +207,7 @@ describe('SystemCheck', () => {
it('should show a generic failure message for other login errors', async () => {
setGeminiApiKey('mock-api-key');
mockedApiClient.loginUser.mockRejectedValueOnce(new Error('Server is on fire'));
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Failed: Server is on fire')).toBeInTheDocument();
@@ -246,7 +217,7 @@ describe('SystemCheck', () => {
it('should show storage directory check as failed if checkStorage fails', async () => {
setGeminiApiKey('mock-api-key');
mockedApiClient.checkStorage.mockRejectedValueOnce(new Error('Storage not writable'));
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Storage not writable')).toBeInTheDocument();
@@ -262,7 +233,7 @@ describe('SystemCheck', () => {
});
mockedApiClient.pingBackend.mockImplementation(() => mockPromise);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
// The button text changes to "Running Checks..."
const runningButton = screen.getByRole('button', { name: /running checks/i });
@@ -283,7 +254,7 @@ describe('SystemCheck', () => {
it('should re-run checks when the "Re-run Checks" button is clicked', async () => {
setGeminiApiKey('mock-api-key');
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
// Wait for initial auto-run to complete
await waitFor(() => expect(screen.getByText(/finished in/i)).toBeInTheDocument());
@@ -328,7 +299,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkDbSchema.mockImplementationOnce(() =>
Promise.resolve(new Response(JSON.stringify({ success: false, message: 'Schema mismatch' }))),
);
const { container } = render(<SystemCheck />);
const { container } = renderWithProviders(<SystemCheck />);
await waitFor(() => {
// Instead of test-ids, we check for the result: the icon's color class.
@@ -344,7 +315,7 @@ describe('SystemCheck', () => {
it('should display elapsed time after checks complete', async () => {
setGeminiApiKey('mock-api-key');
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
const elapsedTimeText = screen.getByText(/finished in \d+\.\d{2} seconds\./i);
@@ -357,7 +328,7 @@ describe('SystemCheck', () => {
describe('Integration: Job Queue Retries', () => {
it('should call triggerFailingJob and show a success toast', async () => {
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
const triggerButton = screen.getByRole('button', { name: /trigger failing job/i });
fireEvent.click(triggerButton);
@@ -374,7 +345,7 @@ describe('SystemCheck', () => {
});
mockedApiClient.triggerFailingJob.mockImplementation(() => mockPromise);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
const triggerButton = screen.getByRole('button', { name: /trigger failing job/i });
fireEvent.click(triggerButton);
@@ -390,7 +361,7 @@ describe('SystemCheck', () => {
it('should show an error toast if triggering the job fails', async () => {
mockedApiClient.triggerFailingJob.mockRejectedValueOnce(new Error('Queue is down'));
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
const triggerButton = screen.getByRole('button', { name: /trigger failing job/i });
fireEvent.click(triggerButton);
@@ -403,7 +374,7 @@ describe('SystemCheck', () => {
mockedApiClient.triggerFailingJob.mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'Server error' }), { status: 500 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
const triggerButton = screen.getByRole('button', { name: /trigger failing job/i });
fireEvent.click(triggerButton);
@@ -420,7 +391,7 @@ describe('SystemCheck', () => {
});
it('should call clearGeocodeCache and show a success toast', async () => {
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
// Wait for checks to run and Redis to be OK
await waitFor(() => expect(screen.getByText('Redis OK')).toBeInTheDocument());
@@ -435,7 +406,7 @@ describe('SystemCheck', () => {
it('should show an error toast if clearing the cache fails', async () => {
mockedApiClient.clearGeocodeCache.mockRejectedValueOnce(new Error('Redis is busy'));
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => expect(screen.getByText('Redis OK')).toBeInTheDocument());
fireEvent.click(screen.getByRole('button', { name: /clear geocode cache/i }));
await waitFor(() => expect(vi.mocked(toast).error).toHaveBeenCalledWith('Redis is busy'));
@@ -443,7 +414,7 @@ describe('SystemCheck', () => {
it('should not call clearGeocodeCache if user cancels confirmation', async () => {
vi.spyOn(window, 'confirm').mockReturnValue(false);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => expect(screen.getByText('Redis OK')).toBeInTheDocument());
const clearButton = screen.getByRole('button', { name: /clear geocode cache/i });
@@ -456,7 +427,7 @@ describe('SystemCheck', () => {
mockedApiClient.clearGeocodeCache.mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'Cache clear failed' }), { status: 500 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => expect(screen.getByText('Redis OK')).toBeInTheDocument());
fireEvent.click(screen.getByRole('button', { name: /clear geocode cache/i }));
@@ -470,7 +441,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkRedisHealth.mockResolvedValueOnce(
new Response(JSON.stringify({ success: false, message: 'Redis down' })),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => expect(screen.getByText('Redis down')).toBeInTheDocument());
@@ -486,7 +457,7 @@ describe('SystemCheck', () => {
mockedApiClient.pingBackend.mockResolvedValueOnce(
new Response('unexpected response', { status: 200 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(
@@ -499,7 +470,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkStorage.mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'Permission denied' }), { status: 403 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Permission denied')).toBeInTheDocument();
@@ -511,7 +482,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkDbSchema.mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'Schema check failed 500' }), { status: 500 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Schema check failed 500')).toBeInTheDocument();
@@ -523,7 +494,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkDbPoolHealth.mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'DB Pool check failed 500' }), { status: 500 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('DB Pool check failed 500')).toBeInTheDocument();
@@ -535,7 +506,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkPm2Status.mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'PM2 check failed 500' }), { status: 500 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('PM2 check failed 500')).toBeInTheDocument();
@@ -547,7 +518,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkRedisHealth.mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'Redis check failed 500' }), { status: 500 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Redis check failed 500')).toBeInTheDocument();
@@ -559,7 +530,7 @@ describe('SystemCheck', () => {
mockedApiClient.checkRedisHealth.mockResolvedValueOnce(
new Response(JSON.stringify({ success: false, message: 'Redis is down' })),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Redis is down')).toBeInTheDocument();
@@ -571,7 +542,7 @@ describe('SystemCheck', () => {
mockedApiClient.loginUser.mockResolvedValueOnce(
new Response(JSON.stringify({ message: 'Invalid credentials' }), { status: 401 }),
);
render(<SystemCheck />);
renderWithProviders(<SystemCheck />);
await waitFor(() => {
expect(screen.getByText('Failed: Invalid credentials')).toBeInTheDocument();

View File

@@ -6,14 +6,8 @@ import { ApiProvider } from './ApiProvider';
import { ApiContext } from '../contexts/ApiContext';
import * as apiClient from '../services/apiClient';
// Mock the apiClient module.
// Since ApiProvider and ApiContext import * as apiClient, mocking it ensures
// we control the reference identity and can verify it's being passed correctly.
vi.mock('../services/apiClient', () => ({
fetchFlyers: vi.fn(),
fetchMasterItems: vi.fn(),
// Add other mocked methods as needed for the shape to be valid-ish
}));
// The apiClient is mocked globally in `src/tests/setup/globalApiMock.ts`.
// This test verifies that the ApiProvider correctly provides this mocked module.
describe('ApiProvider & ApiContext', () => {
const TestConsumer = () => {

View File

@@ -0,0 +1,72 @@
// src/providers/AppProviders.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import { describe, it, expect, vi } from 'vitest';
import { AppProviders } from './AppProviders';
// Mock all the providers to avoid their side effects and isolate AppProviders logic.
// We render a simple div with a data-testid for each to verify nesting.
vi.mock('./ModalProvider', () => ({
ModalProvider: ({ children }: { children: React.ReactNode }) => (
<div data-testid="modal-provider">{children}</div>
),
}));
vi.mock('./AuthProvider', () => ({
AuthProvider: ({ children }: { children: React.ReactNode }) => (
<div data-testid="auth-provider">{children}</div>
),
}));
vi.mock('./FlyersProvider', () => ({
FlyersProvider: ({ children }: { children: React.ReactNode }) => (
<div data-testid="flyers-provider">{children}</div>
),
}));
vi.mock('./MasterItemsProvider', () => ({
MasterItemsProvider: ({ children }: { children: React.ReactNode }) => (
<div data-testid="master-items-provider">{children}</div>
),
}));
vi.mock('./UserDataProvider', () => ({
UserDataProvider: ({ children }: { children: React.ReactNode }) => (
<div data-testid="user-data-provider">{children}</div>
),
}));
describe('AppProviders', () => {
it('renders children correctly', () => {
render(
<AppProviders>
<div data-testid="test-child">Test Child</div>
</AppProviders>,
);
expect(screen.getByTestId('test-child')).toBeInTheDocument();
expect(screen.getByText('Test Child')).toBeInTheDocument();
});
it('renders providers in the correct nesting order', () => {
render(
<AppProviders>
<div data-testid="test-child">Test Child</div>
</AppProviders>,
);
const modalProvider = screen.getByTestId('modal-provider');
const authProvider = screen.getByTestId('auth-provider');
const flyersProvider = screen.getByTestId('flyers-provider');
const masterItemsProvider = screen.getByTestId('master-items-provider');
const userDataProvider = screen.getByTestId('user-data-provider');
const child = screen.getByTestId('test-child');
// Verify nesting structure: Modal -> Auth -> Flyers -> MasterItems -> UserData -> Child
expect(modalProvider).toContainElement(authProvider);
expect(authProvider).toContainElement(flyersProvider);
expect(flyersProvider).toContainElement(masterItemsProvider);
expect(masterItemsProvider).toContainElement(userDataProvider);
expect(userDataProvider).toContainElement(child);
});
});

View File

@@ -0,0 +1,245 @@
// src/providers/AuthProvider.test.tsx
import React, { useContext, useState } from 'react';
import { render, screen, waitFor, fireEvent, act } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, type Mocked } from 'vitest';
import { AuthProvider } from './AuthProvider';
import { AuthContext } from '../contexts/AuthContext';
import * as tokenStorage from '../services/tokenStorage';
import { createMockUserProfile } from '../tests/utils/mockFactories';
import * as apiClient from '../services/apiClient';
// Mocks
// The apiClient is mocked globally in `src/tests/setup/globalApiMock.ts`.
vi.mock('../services/tokenStorage');
vi.mock('../services/logger.client', () => ({
logger: {
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
debug: vi.fn(),
},
}));
const mockedApiClient = vi.mocked(apiClient);
const mockedTokenStorage = tokenStorage as Mocked<typeof tokenStorage>;
const mockProfile = createMockUserProfile({
user: { user_id: 'user-123', email: 'test@example.com' },
});
// A simple consumer component to access and display context values
const TestConsumer = () => {
const context = useContext(AuthContext);
const [error, setError] = useState<string | null>(null);
if (!context) {
return <div>No Context</div>;
}
const handleLoginWithoutProfile = async () => {
try {
await context.login('test-token-no-profile');
} catch (e) {
setError(e instanceof Error ? e.message : String(e));
}
};
return (
<div>
<div data-testid="auth-status">{context.authStatus}</div>
<div data-testid="user-email">{context.userProfile?.user.email ?? 'No User'}</div>
<div data-testid="is-loading">{context.isLoading.toString()}</div>
{error && <div data-testid="error-display">{error}</div>}
<button onClick={() => context.login('test-token', mockProfile)}>Login with Profile</button>
<button onClick={handleLoginWithoutProfile}>Login without Profile</button>
<button onClick={context.logout}>Logout</button>
<button onClick={() => context.updateProfile({ full_name: 'Updated Name' })}>
Update Profile
</button>
</div>
);
};
const renderWithProvider = () => {
return render(
<AuthProvider>
<TestConsumer />
</AuthProvider>,
);
};
describe('AuthProvider', () => {
beforeEach(() => {
vi.clearAllMocks();
});
it('should start in "Determining..." state and transition to "SIGNED_OUT" if no token exists', async () => {
mockedTokenStorage.getToken.mockReturnValue(null);
renderWithProvider();
// The transition happens synchronously in the effect when no token is present,
// so 'Determining...' might be skipped or flashed too quickly for the test runner.
// We check that it settles correctly.
await waitFor(() => {
expect(screen.getByTestId('auth-status')).toHaveTextContent('SIGNED_OUT');
expect(screen.getByTestId('is-loading')).toHaveTextContent('false');
});
expect(mockedApiClient.getAuthenticatedUserProfile).not.toHaveBeenCalled();
});
it('should transition to "AUTHENTICATED" if a valid token exists', async () => {
mockedTokenStorage.getToken.mockReturnValue('valid-token');
mockedApiClient.getAuthenticatedUserProfile.mockResolvedValue(
new Response(JSON.stringify(mockProfile)),
);
renderWithProvider();
await waitFor(() => {
expect(screen.getByTestId('auth-status')).toHaveTextContent('AUTHENTICATED');
expect(screen.getByTestId('user-email')).toHaveTextContent('test@example.com');
expect(screen.getByTestId('is-loading')).toHaveTextContent('false');
});
expect(mockedApiClient.getAuthenticatedUserProfile).toHaveBeenCalledTimes(1);
});
it('should handle token validation failure by signing out', async () => {
mockedTokenStorage.getToken.mockReturnValue('invalid-token');
mockedApiClient.getAuthenticatedUserProfile.mockRejectedValue(new Error('Invalid Token'));
renderWithProvider();
await waitFor(() => {
expect(screen.getByTestId('auth-status')).toHaveTextContent('SIGNED_OUT');
});
expect(mockedTokenStorage.removeToken).toHaveBeenCalled();
});
it('should handle a valid token that returns no profile by signing out', async () => {
// This test covers lines 51-55
mockedTokenStorage.getToken.mockReturnValue('valid-token-no-profile');
mockedApiClient.getAuthenticatedUserProfile.mockResolvedValue(
new Response(JSON.stringify(null)),
);
renderWithProvider();
expect(screen.getByTestId('auth-status')).toHaveTextContent('Determining...');
await waitFor(() => {
expect(screen.getByTestId('auth-status')).toHaveTextContent('SIGNED_OUT');
});
expect(mockedTokenStorage.removeToken).toHaveBeenCalled();
expect(screen.getByTestId('user-email')).toHaveTextContent('No User');
expect(screen.getByTestId('is-loading')).toHaveTextContent('false');
});
it('should log in a user with provided profile data', async () => {
mockedTokenStorage.getToken.mockReturnValue(null);
renderWithProvider();
await waitFor(() => expect(screen.getByTestId('auth-status')).toHaveTextContent('SIGNED_OUT'));
const loginButton = screen.getByRole('button', { name: 'Login with Profile' });
await act(async () => {
fireEvent.click(loginButton);
});
expect(mockedTokenStorage.setToken).toHaveBeenCalledWith('test-token');
expect(screen.getByTestId('auth-status')).toHaveTextContent('AUTHENTICATED');
expect(screen.getByTestId('user-email')).toHaveTextContent('test@example.com');
// API should not be called if profile is provided
expect(mockedApiClient.getAuthenticatedUserProfile).not.toHaveBeenCalled();
});
it('should log in a user and fetch profile if not provided', async () => {
mockedTokenStorage.getToken.mockReturnValue(null);
mockedApiClient.getAuthenticatedUserProfile.mockResolvedValue(
new Response(JSON.stringify(mockProfile)),
);
renderWithProvider();
await waitFor(() => expect(screen.getByTestId('auth-status')).toHaveTextContent('SIGNED_OUT'));
const loginButton = screen.getByRole('button', { name: 'Login without Profile' });
await act(async () => {
fireEvent.click(loginButton);
});
await waitFor(() => {
expect(screen.getByTestId('auth-status')).toHaveTextContent('AUTHENTICATED');
expect(screen.getByTestId('user-email')).toHaveTextContent('test@example.com');
});
expect(mockedTokenStorage.setToken).toHaveBeenCalledWith('test-token-no-profile');
expect(mockedApiClient.getAuthenticatedUserProfile).toHaveBeenCalledTimes(1);
});
it('should throw an error and log out if profile fetch fails after login', async () => {
// This test covers lines 109-111
mockedTokenStorage.getToken.mockReturnValue(null);
const fetchError = new Error('API is down');
mockedApiClient.getAuthenticatedUserProfile.mockRejectedValue(fetchError);
renderWithProvider();
await waitFor(() => {
expect(screen.getByTestId('auth-status')).toHaveTextContent('SIGNED_OUT');
});
const loginButton = screen.getByRole('button', { name: 'Login without Profile' });
// Click the button that triggers the failing login
fireEvent.click(loginButton);
// After the error is thrown, the state should be rolled back
await waitFor(() => {
// The error is now caught and displayed by the TestConsumer
expect(screen.getByTestId('error-display')).toHaveTextContent(
'Login succeeded, but failed to fetch your data: Received null or undefined profile from API.',
);
expect(mockedTokenStorage.setToken).toHaveBeenCalledWith('test-token-no-profile');
expect(mockedTokenStorage.removeToken).toHaveBeenCalled();
expect(screen.getByTestId('auth-status')).toHaveTextContent('SIGNED_OUT');
});
});
it('should log out the user', async () => {
mockedTokenStorage.getToken.mockReturnValue('valid-token');
mockedApiClient.getAuthenticatedUserProfile.mockResolvedValue(
new Response(JSON.stringify(mockProfile)),
);
renderWithProvider();
await waitFor(() => expect(screen.getByTestId('auth-status')).toHaveTextContent('AUTHENTICATED'));
const logoutButton = screen.getByRole('button', { name: 'Logout' });
fireEvent.click(logoutButton);
expect(screen.getByTestId('auth-status')).toHaveTextContent('SIGNED_OUT');
expect(screen.getByTestId('user-email')).toHaveTextContent('No User');
expect(mockedTokenStorage.removeToken).toHaveBeenCalled();
});
it('should update the user profile', async () => {
mockedTokenStorage.getToken.mockReturnValue('valid-token');
mockedApiClient.getAuthenticatedUserProfile.mockResolvedValue(
new Response(JSON.stringify(mockProfile)),
);
renderWithProvider();
await waitFor(() => expect(screen.getByTestId('auth-status')).toHaveTextContent('AUTHENTICATED'));
const updateButton = screen.getByRole('button', { name: 'Update Profile' });
fireEvent.click(updateButton);
await waitFor(() => {
// The profile object is internal, so we can't directly check it.
// A good proxy is to see if a component that uses it would re-render.
// Since our consumer doesn't display the name, we just confirm the function was called.
// In a real app, we'd check the updated UI element.
expect(screen.getByTestId('auth-status')).toHaveTextContent('AUTHENTICATED');
});
});
});

View File

@@ -482,8 +482,8 @@ describe('Passport Configuration', () => {
const mockReq: Partial<Request> = {
// An object that is not a valid UserProfile (e.g., missing 'role')
user: {
user_id: 'invalid-user-id',
} as any,
user: { user_id: 'invalid-user-id' }, // Missing 'role' property
} as unknown as UserProfile, // Cast to UserProfile to satisfy req.user type, but it's intentionally malformed
};
// Act

View 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;

View File

@@ -2,6 +2,8 @@
import { Router } from 'express';
import { z } from 'zod';
import * as db from '../services/db/index.db';
import { aiService } from '../services/aiService.server';
import passport from './passport.routes';
import { validateRequest } from '../middleware/validation.middleware';
import { requiredString, numericIdParam, optionalNumeric } from '../utils/zodUtils';
@@ -28,6 +30,12 @@ const byIngredientAndTagSchema = z.object({
const recipeIdParamsSchema = numericIdParam('recipeId');
const suggestRecipeSchema = z.object({
body: z.object({
ingredients: z.array(z.string().min(1)).nonempty('At least one ingredient is required.'),
}),
});
/**
* GET /api/recipes/by-sale-percentage - Get recipes based on the percentage of their ingredients on sale.
*/
@@ -121,4 +129,31 @@ router.get('/:recipeId', validateRequest(recipeIdParamsSchema), async (req, res,
}
});
/**
* POST /api/recipes/suggest - Generates a simple recipe suggestion from a list of ingredients.
* This is a protected endpoint.
*/
router.post(
'/suggest',
passport.authenticate('jwt', { session: false }),
validateRequest(suggestRecipeSchema),
async (req, res, next) => {
try {
const { body } = req as unknown as z.infer<typeof suggestRecipeSchema>;
const suggestion = await aiService.generateRecipeSuggestion(body.ingredients, req.log);
if (!suggestion) {
return res
.status(503)
.json({ message: 'AI service is currently unavailable or failed to generate a suggestion.' });
}
res.json({ suggestion });
} catch (error) {
req.log.error({ error }, 'Error generating recipe suggestion');
next(error);
}
},
);
export default router;

View File

@@ -482,6 +482,12 @@ describe('User Routes (/api/users)', () => {
expect(response.status).toBe(201);
expect(response.body).toEqual(mockAddedItem);
expect(db.shoppingRepo.addShoppingListItem).toHaveBeenCalledWith(
listId,
mockUserProfile.user.user_id,
itemData,
expectLogger,
);
});
it('should return 400 on foreign key error when adding an item', async () => {
@@ -519,6 +525,12 @@ describe('User Routes (/api/users)', () => {
expect(response.status).toBe(200);
expect(response.body).toEqual(mockUpdatedItem);
expect(db.shoppingRepo.updateShoppingListItem).toHaveBeenCalledWith(
itemId,
mockUserProfile.user.user_id,
updates,
expectLogger,
);
});
it('should return 404 if item to update is not found', async () => {
@@ -554,6 +566,11 @@ describe('User Routes (/api/users)', () => {
vi.mocked(db.shoppingRepo.removeShoppingListItem).mockResolvedValue(undefined);
const response = await supertest(app).delete('/api/users/shopping-lists/items/101');
expect(response.status).toBe(204);
expect(db.shoppingRepo.removeShoppingListItem).toHaveBeenCalledWith(
101,
mockUserProfile.user.user_id,
expectLogger,
);
});
it('should return 404 if item to delete is not found', async () => {

View File

@@ -478,10 +478,16 @@ router.post(
validateRequest(addShoppingListItemSchema),
async (req, res, next: NextFunction) => {
logger.debug(`[ROUTE] POST /api/users/shopping-lists/:listId/items - ENTER`);
const userProfile = req.user as UserProfile;
// Apply ADR-003 pattern for type safety
const { params, body } = req as unknown as AddShoppingListItemRequest;
try {
const newItem = await db.shoppingRepo.addShoppingListItem(params.listId, body, req.log);
const newItem = await db.shoppingRepo.addShoppingListItem(
params.listId,
userProfile.user.user_id,
body,
req.log,
);
res.status(201).json(newItem);
} catch (error) {
if (error instanceof ForeignKeyConstraintError) {
@@ -512,11 +518,13 @@ router.put(
validateRequest(updateShoppingListItemSchema),
async (req, res, next: NextFunction) => {
logger.debug(`[ROUTE] PUT /api/users/shopping-lists/items/:itemId - ENTER`);
const userProfile = req.user as UserProfile;
// Apply ADR-003 pattern for type safety
const { params, body } = req as unknown as UpdateShoppingListItemRequest;
try {
const updatedItem = await db.shoppingRepo.updateShoppingListItem(
params.itemId,
userProfile.user.user_id,
body,
req.log,
);
@@ -541,10 +549,11 @@ router.delete(
validateRequest(shoppingListItemIdSchema),
async (req, res, next: NextFunction) => {
logger.debug(`[ROUTE] DELETE /api/users/shopping-lists/items/:itemId - ENTER`);
const userProfile = req.user as UserProfile;
// Apply ADR-003 pattern for type safety
const { params } = req as unknown as DeleteShoppingListItemRequest;
try {
await db.shoppingRepo.removeShoppingListItem(params.itemId, req.log);
await db.shoppingRepo.removeShoppingListItem(params.itemId, userProfile.user.user_id, req.log);
res.status(204).send();
} catch (error: unknown) {
logger.error(

View File

@@ -1,5 +1,6 @@
// src/services/aiService.server.test.ts
import { describe, it, expect, vi, beforeEach, afterEach, type Mock } from 'vitest';
import type { Job } from 'bullmq';
import { createMockLogger } from '../tests/utils/mockLogger';
import type { Logger } from 'pino';
import type { FlyerStatus, MasterGroceryItem, UserProfile } from '../types';
@@ -10,7 +11,7 @@ import {
DuplicateFlyerError,
type RawFlyerItem,
} from './aiService.server';
import { createMockMasterGroceryItem } from '../tests/utils/mockFactories';
import { createMockMasterGroceryItem, createMockFlyer } from '../tests/utils/mockFactories';
import { ValidationError } from './db/errors.db';
import { AiFlyerDataSchema } from '../types/ai';
@@ -113,6 +114,7 @@ describe('AI Service (Server)', () => {
// Restore all environment variables and clear all mocks before each test
vi.restoreAllMocks();
vi.clearAllMocks();
mockGenerateContent.mockReset();
// Reset modules to ensure the service re-initializes with the mocks
mockAiClient.generateContent.mockResolvedValue({
@@ -129,14 +131,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.
});
});
@@ -248,6 +243,7 @@ describe('AI Service (Server)', () => {
vi.unstubAllEnvs();
process.env = { ...originalEnv, GEMINI_API_KEY: 'test-key' };
vi.resetModules(); // Re-import to use the new env var and re-instantiate the service
mockGenerateContent.mockReset();
});
afterEach(() => {
@@ -326,41 +322,174 @@ describe('AI Service (Server)', () => {
const { logger } = await import('./logger.server');
const serviceWithFallback = new AIService(logger);
const quotaError1 = new Error('Quota exhausted for model 1');
const quotaError2 = new Error('429 Too Many Requests for model 2');
const quotaError3 = new Error('RESOURCE_EXHAUSTED for model 3');
// Access private property for testing purposes to ensure test stays in sync with implementation
const models = (serviceWithFallback as any).models as string[];
// Use a quota error to trigger the fallback logic for each model
const errors = models.map((model, i) => new Error(`Quota error for model ${model} (${i})`));
const lastError = errors[errors.length - 1];
mockGenerateContent
.mockRejectedValueOnce(quotaError1)
.mockRejectedValueOnce(quotaError2)
.mockRejectedValueOnce(quotaError3);
// Dynamically setup mocks
errors.forEach((err) => {
mockGenerateContent.mockRejectedValueOnce(err);
});
const request = { contents: [{ parts: [{ text: 'test prompt' }] }] };
// Act & Assert
await expect((serviceWithFallback as any).aiClient.generateContent(request)).rejects.toThrow(
quotaError3,
lastError,
);
expect(mockGenerateContent).toHaveBeenCalledTimes(3);
expect(mockGenerateContent).toHaveBeenNthCalledWith(1, { // The first model in the list is now 'gemini-3-flash-preview'
model: 'gemini-3-flash-preview',
...request,
});
expect(mockGenerateContent).toHaveBeenNthCalledWith(2, { // The second model in the list is 'gemini-2.5-flash'
model: 'gemini-2.5-flash',
...request,
});
expect(mockGenerateContent).toHaveBeenNthCalledWith(3, { // The third model in the list is 'gemini-2.5-flash-lite'
model: 'gemini-2.5-flash-lite',
...request,
expect(mockGenerateContent).toHaveBeenCalledTimes(models.length);
models.forEach((model, index) => {
expect(mockGenerateContent).toHaveBeenNthCalledWith(index + 1, {
model: model,
...request,
});
});
expect(logger.error).toHaveBeenCalledWith(
{ lastError: quotaError3 },
{ lastError },
'[AIService Adapter] All AI models failed. Throwing last known error.',
);
});
it('should use lite models and throw the last error if all lite models fail', async () => {
// Arrange
const { AIService } = await import('./aiService.server');
const { logger } = await import('./logger.server');
// We instantiate with the real logger to test the production fallback logic
const serviceWithFallback = new AIService(logger);
// Access private property for testing purposes
const modelsLite = (serviceWithFallback as any).models_lite as string[];
// Use a quota error to trigger the fallback logic for each model
const errors = modelsLite.map((model, i) => new Error(`Quota error for lite model ${model} (${i})`));
const lastError = errors[errors.length - 1];
// Dynamically setup mocks
errors.forEach((err) => {
mockGenerateContent.mockRejectedValueOnce(err);
});
const request = {
contents: [{ parts: [{ text: 'test prompt' }] }],
useLiteModels: true, // This is the key to trigger the lite model list
};
// The adapter strips `useLiteModels` before calling the underlying client,
// so we prepare the expected request shape for our assertions.
const { useLiteModels, ...apiReq } = request;
// Act & Assert
// Expect the entire operation to reject with the error from the very last model attempt.
await expect((serviceWithFallback as any).aiClient.generateContent(request)).rejects.toThrow(
lastError,
);
// Verify that all lite models were attempted in the correct order.
expect(mockGenerateContent).toHaveBeenCalledTimes(modelsLite.length);
modelsLite.forEach((model, index) => {
expect(mockGenerateContent).toHaveBeenNthCalledWith(index + 1, {
model: model,
...apiReq,
});
});
});
it('should dynamically try the next model if the first one fails and succeed if the second one works', async () => {
// Arrange
const { AIService } = await import('./aiService.server');
const { logger } = await import('./logger.server');
const serviceWithFallback = new AIService(logger);
// Access private property for testing purposes
const models = (serviceWithFallback as any).models as string[];
// Ensure we have enough models to test fallback
expect(models.length).toBeGreaterThanOrEqual(2);
const error1 = new Error('Quota exceeded for model 1');
const successResponse = { text: 'Success', candidates: [] };
mockGenerateContent
.mockRejectedValueOnce(error1)
.mockResolvedValueOnce(successResponse);
const request = { contents: [{ parts: [{ text: 'test prompt' }] }] };
// Act
const result = await (serviceWithFallback as any).aiClient.generateContent(request);
// Assert
expect(result).toEqual(successResponse);
expect(mockGenerateContent).toHaveBeenCalledTimes(2);
expect(mockGenerateContent).toHaveBeenNthCalledWith(1, {
model: models[0],
...request,
});
expect(mockGenerateContent).toHaveBeenNthCalledWith(2, {
model: models[1],
...request,
});
expect(logger.warn).toHaveBeenCalledWith(
expect.stringContaining(`Model '${models[0]}' failed`),
);
});
it('should retry on a 429 error and succeed on the next model', async () => {
// Arrange
const { AIService } = await import('./aiService.server');
const { logger } = await import('./logger.server');
const serviceWithFallback = new AIService(logger);
const models = (serviceWithFallback as any).models as string[];
const retriableError = new Error('429 Too Many Requests');
const successResponse = { text: 'Success from second model', candidates: [] };
mockGenerateContent
.mockRejectedValueOnce(retriableError)
.mockResolvedValueOnce(successResponse);
const request = { contents: [{ parts: [{ text: 'test prompt' }] }] };
// Act
const result = await (serviceWithFallback as any).aiClient.generateContent(request);
// Assert
expect(result).toEqual(successResponse);
expect(mockGenerateContent).toHaveBeenCalledTimes(2);
expect(mockGenerateContent).toHaveBeenNthCalledWith(1, { model: models[0], ...request });
expect(mockGenerateContent).toHaveBeenNthCalledWith(2, { model: models[1], ...request });
expect(logger.warn).toHaveBeenCalledWith(expect.stringContaining(`Model '${models[0]}' failed due to quota/rate limit.`));
});
it('should fail immediately on a 400 Bad Request error without retrying', async () => {
// Arrange
const { AIService } = await import('./aiService.server');
const { logger } = await import('./logger.server');
const serviceWithFallback = new AIService(logger);
const models = (serviceWithFallback as any).models as string[];
const nonRetriableError = new Error('400 Bad Request: Invalid input');
mockGenerateContent.mockRejectedValueOnce(nonRetriableError);
const request = { contents: [{ parts: [{ text: 'test prompt' }] }] };
// Act & Assert
await expect((serviceWithFallback as any).aiClient.generateContent(request)).rejects.toThrow(nonRetriableError);
expect(mockGenerateContent).toHaveBeenCalledTimes(1);
expect(mockGenerateContent).toHaveBeenCalledWith({ model: models[0], ...request });
expect(logger.error).toHaveBeenCalledWith(
{ error: nonRetriableError },
`[AIService Adapter] Model '${models[0]}' failed with a non-retriable error.`,
);
// Ensure it didn't log a warning about trying the next model
expect(logger.warn).not.toHaveBeenCalledWith(expect.stringContaining('Trying next model'));
});
});
describe('extractItemsFromReceiptImage', () => {
@@ -790,7 +919,7 @@ describe('AI Service (Server)', () => {
} as UserProfile;
it('should throw DuplicateFlyerError if flyer already exists', async () => {
vi.mocked(dbModule.flyerRepo.findFlyerByChecksum).mockResolvedValue({ flyer_id: 99 } as any);
vi.mocked(dbModule.flyerRepo.findFlyerByChecksum).mockResolvedValue({ flyer_id: 99, checksum: 'checksum123', file_name: 'test.pdf', image_url: '/flyer-images/test.pdf', icon_url: '/flyer-images/icons/test.webp', store_id: 1, status: 'processed', item_count: 0, created_at: new Date().toISOString(), updated_at: new Date().toISOString() });
await expect(
aiServiceInstance.enqueueFlyerProcessing(
@@ -805,7 +934,7 @@ describe('AI Service (Server)', () => {
it('should enqueue job with user address if profile exists', async () => {
vi.mocked(dbModule.flyerRepo.findFlyerByChecksum).mockResolvedValue(undefined);
vi.mocked(flyerQueue.add).mockResolvedValue({ id: 'job123' } as any);
vi.mocked(flyerQueue.add).mockResolvedValue({ id: 'job123' } as unknown as Job);
const result = await aiServiceInstance.enqueueFlyerProcessing(
mockFile,
@@ -828,7 +957,7 @@ describe('AI Service (Server)', () => {
it('should enqueue job without address if profile is missing', async () => {
vi.mocked(dbModule.flyerRepo.findFlyerByChecksum).mockResolvedValue(undefined);
vi.mocked(flyerQueue.add).mockResolvedValue({ id: 'job456' } as any);
vi.mocked(flyerQueue.add).mockResolvedValue({ id: 'job456' } as unknown as Job);
await aiServiceInstance.enqueueFlyerProcessing(
mockFile,
@@ -857,7 +986,7 @@ describe('AI Service (Server)', () => {
const mockProfile = { user: { user_id: 'u1' } } as UserProfile;
beforeEach(() => {
// Default success mocks
// Default success mocks. Use createMockFlyer for a more complete mock.
vi.mocked(dbModule.flyerRepo.findFlyerByChecksum).mockResolvedValue(undefined);
vi.mocked(generateFlyerIcon).mockResolvedValue('icon.jpg');
vi.mocked(createFlyerAndItems).mockResolvedValue({
@@ -894,7 +1023,7 @@ describe('AI Service (Server)', () => {
});
it('should throw DuplicateFlyerError if checksum exists', async () => {
vi.mocked(dbModule.flyerRepo.findFlyerByChecksum).mockResolvedValue({ flyer_id: 55 } as any);
vi.mocked(dbModule.flyerRepo.findFlyerByChecksum).mockResolvedValue(createMockFlyer({ flyer_id: 55 }));
const body = { checksum: 'dup-sum' };
await expect(

View File

@@ -62,6 +62,7 @@ interface IAiClient {
generateContent(request: {
contents: Content[];
tools?: Tool[];
useLiteModels?: boolean;
}): Promise<GenerateContentResponse>;
}
@@ -93,7 +94,8 @@ export class AIService {
// The fallback list is ordered by preference (speed/cost vs. power).
// We try the fastest models first, then the more powerful 'pro' model as a high-quality fallback,
// and finally the 'lite' model as a last resort.
private readonly models = [ 'gemini-3-flash-preview', 'gemini-2.5-flash', 'gemini-2.5-flash-lite'];
private readonly models = [ 'gemini-3-flash-preview','gemini-2.5-pro', 'gemini-2.5-flash', 'gemini-2.5-flash-lite','gemini-2.0-flash-001','gemini-2.0-flash','gemini-2.0-flash-exp','gemini-2.0-flash-lite-001','gemini-2.0-flash-lite', 'gemma-3-27b-it', 'gemma-3-12b-it'];
private readonly models_lite = ["gemma-3-4b-it", "gemma-3-2b-it", "gemma-3-1b-it"];
constructor(logger: Logger, aiClient?: IAiClient, fs?: IFileSystem) {
this.logger = logger;
@@ -156,7 +158,9 @@ export class AIService {
throw new Error('AIService.generateContent requires at least one content element.');
}
return this._generateWithFallback(genAI, request);
const { useLiteModels, ...apiReq } = request;
const models = useLiteModels ? this.models_lite : this.models;
return this._generateWithFallback(genAI, apiReq, models);
},
}
: {
@@ -194,10 +198,11 @@ export class AIService {
private async _generateWithFallback(
genAI: GoogleGenAI,
request: { contents: Content[]; tools?: Tool[] },
models: string[] = this.models,
): Promise<GenerateContentResponse> {
let lastError: Error | null = null;
for (const modelName of this.models) {
for (const modelName of models) {
try {
this.logger.info(
`[AIService Adapter] Attempting to generate content with model: ${modelName}`,
@@ -668,6 +673,33 @@ export class AIService {
}
}
/**
* Generates a simple recipe suggestion based on a list of ingredients.
* Uses the 'lite' models for faster/cheaper generation.
* @param ingredients List of available ingredients.
* @param logger Logger instance.
* @returns The recipe suggestion text.
*/
async generateRecipeSuggestion(
ingredients: string[],
logger: Logger = this.logger,
): Promise<string | null> {
const prompt = `Suggest a simple recipe using these ingredients: ${ingredients.join(', ')}. Keep it brief.`;
try {
const result = await this.rateLimiter(() =>
this.aiClient.generateContent({
contents: [{ parts: [{ text: prompt }] }],
useLiteModels: true,
}),
);
return result.text || null;
} catch (error) {
logger.error({ err: error }, 'Failed to generate recipe suggestion');
return null;
}
}
/**
* SERVER-SIDE FUNCTION
* Uses Google Maps grounding to find nearby stores and plan a shopping trip.

View File

@@ -543,6 +543,13 @@ describe('API Client', () => {
await apiClient.deleteRecipe(recipeId);
expect(capturedUrl?.pathname).toBe(`/api/recipes/${recipeId}`);
});
it('suggestRecipe should send a POST request with ingredients', async () => {
const ingredients = ['chicken', 'rice'];
await apiClient.suggestRecipe(ingredients);
expect(capturedUrl?.pathname).toBe('/api/recipes/suggest');
expect(capturedBody).toEqual({ ingredients });
});
});
describe('User Profile and Settings API Functions', () => {
@@ -933,7 +940,7 @@ describe('API Client', () => {
it('logSearchQuery should send a POST request with query data', async () => {
const queryData = createMockSearchQueryPayload({ query_text: 'apples', result_count: 10, was_successful: true });
await apiClient.logSearchQuery(queryData);
await apiClient.logSearchQuery(queryData as any);
expect(capturedUrl?.pathname).toBe('/api/search/log');
expect(capturedBody).toEqual(queryData);
});
@@ -960,7 +967,7 @@ describe('API Client', () => {
result_count: 0,
was_successful: false,
});
await apiClient.logSearchQuery(queryData);
await apiClient.logSearchQuery(queryData as any);
expect(logger.warn).toHaveBeenCalledWith('Failed to log search query', { error: apiError });
});
});

View File

@@ -636,6 +636,20 @@ export const addRecipeComment = (
): Promise<Response> =>
authedPost(`/recipes/${recipeId}/comments`, { content, parentCommentId }, { tokenOverride });
/**
* Requests a simple recipe suggestion from the AI based on a list of ingredients.
* @param ingredients An array of ingredient strings.
* @param tokenOverride Optional token for testing.
* @returns A promise that resolves to the API response containing the suggestion.
*/
export const suggestRecipe = (
ingredients: string[],
tokenOverride?: string,
): Promise<Response> => {
// This is a protected endpoint, so we use authedPost.
return authedPost('/recipes/suggest', { ingredients }, { tokenOverride });
};
/**
* Deletes a recipe.
* @param recipeId The ID of the recipe to delete.

View File

@@ -17,6 +17,11 @@ describe('AuthService', () => {
user_id: 'user-123',
email: 'test@example.com',
password_hash: 'hashed-password',
failed_login_attempts: 0,
last_failed_login: null,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
refresh_token: null,
};
const mockUserProfile: UserProfile = {
user: mockUser,
@@ -205,7 +210,7 @@ describe('AuthService', () => {
describe('resetPassword', () => {
it('should process password reset for existing user', async () => {
vi.mocked(userRepo.findUserByEmail).mockResolvedValue(mockUser as any);
vi.mocked(userRepo.findUserByEmail).mockResolvedValue(mockUser);
vi.mocked(bcrypt.hash).mockImplementation(async () => 'hashed-token');
const result = await authService.resetPassword('test@example.com', reqLog);
@@ -284,7 +289,7 @@ describe('AuthService', () => {
describe('getUserByRefreshToken', () => {
it('should return user profile if token exists', async () => {
vi.mocked(userRepo.findUserByRefreshToken).mockResolvedValue({ user_id: 'user-123' } as any);
vi.mocked(userRepo.findUserByRefreshToken).mockResolvedValue({ user_id: 'user-123', email: 'test@example.com', created_at: new Date().toISOString(), updated_at: new Date().toISOString() });
vi.mocked(userRepo.findUserProfileById).mockResolvedValue(mockUserProfile);
const result = await authService.getUserByRefreshToken('valid-token', reqLog);
@@ -318,7 +323,7 @@ describe('AuthService', () => {
describe('refreshAccessToken', () => {
it('should return new access token if user found', async () => {
vi.mocked(userRepo.findUserByRefreshToken).mockResolvedValue({ user_id: 'user-123' } as any);
vi.mocked(userRepo.findUserByRefreshToken).mockResolvedValue({ user_id: 'user-123', email: 'test@example.com', created_at: new Date().toISOString(), updated_at: new Date().toISOString() });
vi.mocked(userRepo.findUserProfileById).mockResolvedValue(mockUserProfile);
// FIX: The global mock for jsonwebtoken provides a `default` export.
// The code under test (`authService`) uses `import jwt from 'jsonwebtoken'`, so it gets the default export.

View File

@@ -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.',
});
}
}
}

View File

@@ -203,7 +203,11 @@ describe('Admin DB Service', () => {
.mockRejectedValueOnce(new Error('DB Read Error'));
// The Promise.all should reject, and the function should re-throw the error
await expect(adminRepo.getApplicationStats(mockLogger)).rejects.toThrow('DB Read Error');
// The handleDbError function wraps the original error in a new one with a default message,
// so we should test for that specific message.
await expect(adminRepo.getApplicationStats(mockLogger)).rejects.toThrow(
'Failed to retrieve application statistics.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: expect.any(Error) },
'Database error in getApplicationStats',
@@ -277,7 +281,7 @@ describe('Admin DB Service', () => {
'Failed to get most frequent sale items.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError },
{ err: dbError, days: 30, limit: 10 },
'Database error in getMostFrequentSaleItems',
);
});
@@ -688,7 +692,9 @@ describe('Admin DB Service', () => {
it('should re-throw a generic error if the database query fails for other reasons', async () => {
const dbError = new Error('DB Error');
mockDb.query.mockRejectedValue(dbError);
await expect(adminRepo.updateUserRole('1', 'admin', mockLogger)).rejects.toThrow('DB Error');
await expect(adminRepo.updateUserRole('1', 'admin', mockLogger)).rejects.toThrow(
'Failed to update user role.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, userId: '1', role: 'admin' },
'Database error in updateUserRole',

View File

@@ -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,
@@ -41,6 +41,7 @@ export class AdminRepository {
sc.correction_type,
sc.suggested_value,
sc.status,
sc.updated_at,
sc.created_at,
fi.item as flyer_item_name,
fi.price_display as flyer_item_price_display,
@@ -54,8 +55,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 +75,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 +99,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 +126,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 +174,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 +219,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 +262,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 +292,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.',
});
}
}
@@ -301,6 +309,7 @@ export class AdminRepository {
SELECT
ufi.unmatched_flyer_item_id,
ufi.status,
ufi.updated_at,
ufi.created_at,
fi.flyer_item_id as flyer_item_id,
fi.item as flyer_item_name,
@@ -317,8 +326,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 +354,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 +409,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 +436,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 +458,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 +561,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 +587,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 +603,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 +626,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 +660,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.',
});
}
}
}

View File

@@ -249,6 +249,17 @@ describe('Budget DB Service', () => {
expect(result).toEqual(mockUpdatedBudget);
});
it('should prevent a user from updating a budget they do not own', async () => {
// Arrange: Mock the query to return 0 rows affected
mockDb.query.mockResolvedValue({ rows: [], rowCount: 0 });
// Act & Assert: Attempt to update with a different user ID should throw an error.
await expect(
budgetRepo.updateBudget(1, 'another-user', { name: 'Updated Groceries' }, mockLogger),
).rejects.toThrow('Budget not found or user does not have permission to update.');
});
it('should throw an error if no rows are updated', async () => {
// Arrange: Mock the query to return 0 rows affected
mockDb.query.mockResolvedValue({ rows: [], rowCount: 0 });

View File

@@ -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.');
}
}
}

View File

@@ -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.',
});
}
}

View File

@@ -0,0 +1,160 @@
// src/services/db/conversion.db.test.ts
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { mockPoolInstance } from '../../tests/setup/tests-setup-unit';
import { getPool } from './connection.db';
import { conversionRepo } from './conversion.db';
import { NotFoundError } from './errors.db';
import type { UnitConversion } from '../../types';
// Un-mock the module we are testing
vi.unmock('./conversion.db');
// Mock dependencies
vi.mock('./connection.db', () => ({
getPool: vi.fn(),
}));
vi.mock('../logger.server', () => ({
logger: {
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
debug: vi.fn(),
},
}));
import { logger as mockLogger } from '../logger.server';
describe('Conversion DB Service', () => {
beforeEach(() => {
vi.clearAllMocks();
// Make getPool return our mock instance for each test
vi.mocked(getPool).mockReturnValue(mockPoolInstance as any);
});
describe('getConversions', () => {
it('should return all conversions if no filters are provided', async () => {
const mockConversions: UnitConversion[] = [
{
unit_conversion_id: 1,
master_item_id: 1,
from_unit: 'g',
to_unit: 'kg',
factor: 0.001,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
},
];
mockPoolInstance.query.mockResolvedValue({ rows: mockConversions });
const result = await conversionRepo.getConversions({}, mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('SELECT * FROM public.unit_conversions'),
expect.any(Array),
);
// Check that WHERE clause is not present for master_item_id
expect(mockPoolInstance.query.mock.calls[0][0]).not.toContain('WHERE master_item_id');
expect(result).toEqual(mockConversions);
});
it('should filter by masterItemId', async () => {
mockPoolInstance.query.mockResolvedValue({ rows: [] });
await conversionRepo.getConversions({ masterItemId: 123 }, mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('WHERE master_item_id = $1'),
[123],
);
});
it('should throw an error if the database query fails', async () => {
const dbError = new Error('DB Error');
mockPoolInstance.query.mockRejectedValue(dbError);
await expect(conversionRepo.getConversions({}, mockLogger)).rejects.toThrow(
'Failed to retrieve unit conversions.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, filters: {} },
'Database error in getConversions',
);
});
});
describe('createConversion', () => {
const newConversion = {
master_item_id: 1,
from_unit: 'cup',
to_unit: 'ml',
factor: 236.588,
};
it('should insert a new conversion and return it', async () => {
const mockCreatedConversion: UnitConversion = {
unit_conversion_id: 1,
...newConversion,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
};
mockPoolInstance.query.mockResolvedValue({ rows: [mockCreatedConversion] });
const result = await conversionRepo.createConversion(newConversion, mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('INSERT INTO public.unit_conversions'),
[1, 'cup', 'ml', 236.588],
);
expect(result).toEqual(mockCreatedConversion);
});
it('should throw an error if the database query fails', async () => {
const dbError = new Error('DB Error');
mockPoolInstance.query.mockRejectedValue(dbError);
await expect(conversionRepo.createConversion(newConversion, mockLogger)).rejects.toThrow(
'Failed to create unit conversion.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, conversionData: newConversion },
'Database error in createConversion',
);
});
});
describe('deleteConversion', () => {
it('should delete a conversion if found', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 1 });
await conversionRepo.deleteConversion(1, mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
'DELETE FROM public.unit_conversions WHERE unit_conversion_id = $1',
[1],
);
});
it('should throw NotFoundError if conversion is not found', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 0 });
await expect(conversionRepo.deleteConversion(999, mockLogger)).rejects.toThrow(NotFoundError);
await expect(conversionRepo.deleteConversion(999, mockLogger)).rejects.toThrow(
'Unit conversion with ID 999 not found.',
);
});
it('should throw an error if the database query fails', async () => {
const dbError = new Error('DB Error');
mockPoolInstance.query.mockRejectedValue(dbError);
await expect(conversionRepo.deleteConversion(1, mockLogger)).rejects.toThrow(
'Failed to delete unit conversion.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, conversionId: 1 },
'Database error in deleteConversion',
);
});
});
});

View 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.',
});
}
},
};

View File

@@ -82,15 +82,15 @@ describe('Deals DB Service', () => {
expect(result).toEqual([]);
});
it('should re-throw the error if the database query fails', async () => {
it('should throw a generic error if the database query fails', async () => {
const dbError = new Error('DB Connection Error');
mockDb.query.mockRejectedValue(dbError);
await expect(dealsRepo.findBestPricesForWatchedItems('user-1', mockLogger)).rejects.toThrow(
dbError,
'Failed to find best prices for watched items.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError },
{ err: dbError, userId: 'user-1' },
'Database error in findBestPricesForWatchedItems',
);
});

View File

@@ -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.',
});
}
}
}

View File

@@ -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'}.`,
);
}

View File

@@ -274,7 +274,7 @@ describe('Flyer DB Service', () => {
ForeignKeyConstraintError,
);
await expect(flyerRepo.insertFlyerItems(999, itemsData, mockLogger)).rejects.toThrow(
'The specified flyer does not exist.',
'The specified flyer, category, master item, or product does not exist.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, flyerId: 999 },
@@ -285,10 +285,10 @@ describe('Flyer DB Service', () => {
it('should throw a generic error if the database query fails', async () => {
const dbError = new Error('DB Connection Error');
mockPoolInstance.query.mockRejectedValue(dbError);
// The implementation now re-throws the original error, so we should expect that.
// The implementation wraps the error using handleDbError
await expect(
flyerRepo.insertFlyerItems(1, [{ item: 'Test' } as FlyerItemInsert], mockLogger),
).rejects.toThrow(dbError);
).rejects.toThrow('An unknown error occurred while inserting flyer items.');
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, flyerId: 1 },
'Database error in insertFlyerItems',
@@ -691,11 +691,7 @@ describe('Flyer DB Service', () => {
);
await expect(flyerRepo.deleteFlyer(999, mockLogger)).rejects.toThrow(
'Failed to delete flyer.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: expect.any(NotFoundError), flyerId: 999 },
'Database transaction error in deleteFlyer',
'Flyer with ID 999 not found.',
);
});

View File

@@ -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,
@@ -97,18 +97,30 @@ export class FlyerRepository {
flyerData.store_address, // $8
flyerData.status, // $9
flyerData.item_count, // $10
flyerData.uploaded_by, // $11
flyerData.uploaded_by ?? null, // $11
];
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.');
const errorMessage = error instanceof Error ? error.message : '';
let checkMsg = 'A database check constraint failed.';
if (errorMessage.includes('flyers_checksum_check')) {
checkMsg =
'The provided checksum is invalid or does not meet format requirements (e.g., must be a 64-character SHA-256 hash).';
} else if (errorMessage.includes('flyers_status_check')) {
checkMsg = 'Invalid status provided for flyer.';
} else if (errorMessage.includes('url_check')) {
checkMsg = 'Invalid URL format provided for image or icon.';
}
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: checkMsg,
defaultMessage: 'Failed to insert flyer into database.',
});
}
}
@@ -159,16 +171,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.',
});
}
}
@@ -179,15 +185,16 @@ export class FlyerRepository {
async getAllBrands(logger: Logger): Promise<Brand[]> {
try {
const query = `
SELECT s.store_id as brand_id, s.name, s.logo_url
SELECT s.store_id as brand_id, s.name, s.logo_url, s.created_at, s.updated_at
FROM public.stores s
ORDER BY s.name;
`;
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 +233,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 +252,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 +271,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 +293,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 +311,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 +365,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.',
});
}
}
}

View File

@@ -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.',
});
}
}
@@ -49,7 +50,8 @@ export class GamificationRepository {
a.name,
a.description,
a.icon,
a.points_value
a.points_value,
a.created_at
FROM public.user_achievements ua
JOIN public.achievements a ON ua.achievement_id = a.achievement_id
WHERE ua.user_id = $1
@@ -58,8 +60,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 +78,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 +106,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.',
});
}
}
}

View File

@@ -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,
};

View File

@@ -195,7 +195,7 @@ describe('Notification DB Service', () => {
notificationRepo.createBulkNotifications(notificationsToCreate, mockLogger),
).rejects.toThrow(ForeignKeyConstraintError);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError },
{ err: dbError, notifications: notificationsToCreate },
'Database error in createBulkNotifications',
);
});
@@ -208,7 +208,7 @@ describe('Notification DB Service', () => {
notificationRepo.createBulkNotifications(notificationsToCreate, mockLogger),
).rejects.toThrow('Failed to create bulk notifications.');
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError },
{ err: dbError, notifications: notificationsToCreate },
'Database error in createBulkNotifications',
);
});
@@ -264,6 +264,16 @@ describe('Notification DB Service', () => {
});
});
describe('markNotificationAsRead - Ownership Check', () => {
it('should not mark a notification as read if the user does not own it', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 0 });
await expect(notificationRepo.markNotificationAsRead(1, 'wrong-user', mockLogger)).rejects.toThrow(
'Notification not found or user does not have permission.',
);
});
});
describe('markAllNotificationsAsRead', () => {
it('should execute an UPDATE query to mark all notifications as read for a user', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 3 });

View File

@@ -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.',
});
}
}
}

View File

@@ -5,7 +5,7 @@ import type { Pool, PoolClient } from 'pg';
import { withTransaction } from './connection.db';
import { PersonalizationRepository } from './personalization.db';
import type { MasterGroceryItem, UserAppliance, DietaryRestriction, Appliance } from '../../types';
import { createMockMasterGroceryItem } from '../../tests/utils/mockFactories';
import { createMockMasterGroceryItem, createMockUserAppliance } from '../../tests/utils/mockFactories';
// Un-mock the module we are testing to ensure we use the real implementation.
vi.unmock('./personalization.db');
@@ -46,9 +46,6 @@ describe('Personalization DB Service', () => {
describe('getAllMasterItems', () => {
it('should execute the correct query and return master items', async () => {
console.log(
'[TEST DEBUG] Running test: getAllMasterItems > should execute the correct query',
);
const mockItems: MasterGroceryItem[] = [
createMockMasterGroceryItem({ master_grocery_item_id: 1, name: 'Apples' }),
];
@@ -64,8 +61,6 @@ describe('Personalization DB Service', () => {
LEFT JOIN public.categories c ON mgi.category_id = c.category_id
ORDER BY mgi.name ASC`;
console.log('[TEST DEBUG] mockQuery calls:', JSON.stringify(mockQuery.mock.calls, null, 2));
// The query string in the implementation has a lot of whitespace from the template literal.
// This updated expectation matches the new query exactly.
expect(mockQuery).toHaveBeenCalledWith(expectedQuery);
@@ -649,8 +644,8 @@ describe('Personalization DB Service', () => {
describe('setUserAppliances', () => {
it('should execute a transaction to set appliances', async () => {
const mockNewAppliances: UserAppliance[] = [
{ user_id: 'user-123', appliance_id: 1 },
{ user_id: 'user-123', appliance_id: 2 },
createMockUserAppliance({ user_id: 'user-123', appliance_id: 1 }),
createMockUserAppliance({ user_id: 'user-123', appliance_id: 2 }),
];
const mockClientQuery = vi.fn();
vi.mocked(withTransaction).mockImplementation(async (callback) => {

View File

@@ -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.',
});
}
}
}

View File

@@ -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.');
}
},
};

View File

@@ -0,0 +1,225 @@
// src/services/db/reaction.db.test.ts
import { describe, it, expect, vi, beforeEach, Mock } from 'vitest';
import type { Pool, PoolClient } from 'pg';
import { ReactionRepository } from './reaction.db';
import { mockPoolInstance } from '../../tests/setup/tests-setup-unit';
import { withTransaction } from './connection.db';
import { ForeignKeyConstraintError } from './errors.db';
import type { UserReaction } from '../../types';
// Un-mock the module we are testing
vi.unmock('./reaction.db');
// Mock dependencies
vi.mock('../logger.server', () => ({
logger: {
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
debug: vi.fn(),
},
}));
import { logger as mockLogger } from '../logger.server';
vi.mock('./connection.db', async (importOriginal) => {
const actual = await importOriginal<typeof import('./connection.db')>();
return { ...actual, withTransaction: vi.fn() };
});
describe('Reaction DB Service', () => {
let reactionRepo: ReactionRepository;
const mockDb = {
query: vi.fn(),
};
beforeEach(() => {
vi.clearAllMocks();
reactionRepo = new ReactionRepository(mockDb);
});
describe('getReactions', () => {
it('should build a query with no filters', async () => {
mockDb.query.mockResolvedValue({ rows: [] });
await reactionRepo.getReactions({}, mockLogger);
expect(mockDb.query).toHaveBeenCalledWith(
'SELECT * FROM public.user_reactions WHERE 1=1 ORDER BY created_at DESC',
[],
);
});
it('should build a query with a userId filter', async () => {
mockDb.query.mockResolvedValue({ rows: [] });
await reactionRepo.getReactions({ userId: 'user-1' }, mockLogger);
expect(mockDb.query).toHaveBeenCalledWith(
'SELECT * FROM public.user_reactions WHERE 1=1 AND user_id = $1 ORDER BY created_at DESC',
['user-1'],
);
});
it('should build a query with all filters', async () => {
mockDb.query.mockResolvedValue({ rows: [] });
await reactionRepo.getReactions(
{ userId: 'user-1', entityType: 'recipe', entityId: '123' },
mockLogger,
);
expect(mockDb.query).toHaveBeenCalledWith(
'SELECT * FROM public.user_reactions WHERE 1=1 AND user_id = $1 AND entity_type = $2 AND entity_id = $3 ORDER BY created_at DESC',
['user-1', 'recipe', '123'],
);
});
it('should return an array of reactions on success', async () => {
const mockReactions: UserReaction[] = [
{
reaction_id: 1,
user_id: 'user-1',
entity_type: 'recipe',
entity_id: '123',
reaction_type: 'like',
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
},
];
mockDb.query.mockResolvedValue({ rows: mockReactions });
const result = await reactionRepo.getReactions({}, mockLogger);
expect(result).toEqual(mockReactions);
});
it('should throw an error if the database query fails', async () => {
const dbError = new Error('DB Error');
mockDb.query.mockRejectedValue(dbError);
await expect(reactionRepo.getReactions({}, mockLogger)).rejects.toThrow(
'Failed to retrieve user reactions.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, filters: {} },
'Database error in getReactions',
);
});
});
describe('toggleReaction', () => {
const reactionData = {
user_id: 'user-1',
entity_type: 'recipe',
entity_id: '123',
reaction_type: 'like',
};
it('should remove an existing reaction and return null', async () => {
const mockClient = { query: vi.fn() };
// Mock DELETE returning 1 row, indicating a reaction was deleted
(mockClient.query as Mock).mockResolvedValueOnce({ rowCount: 1 });
vi.mocked(withTransaction).mockImplementation(async (callback) => {
return callback(mockClient as unknown as PoolClient);
});
const result = await reactionRepo.toggleReaction(reactionData, mockLogger);
expect(result).toBeNull();
expect(mockClient.query).toHaveBeenCalledWith(
'DELETE FROM public.user_reactions WHERE user_id = $1 AND entity_type = $2 AND entity_id = $3 AND reaction_type = $4',
['user-1', 'recipe', '123', 'like'],
);
// Ensure INSERT was not called
expect(mockClient.query).toHaveBeenCalledTimes(1);
});
it('should add a new reaction and return it if it does not exist', async () => {
const mockClient = { query: vi.fn() };
const mockCreatedReaction: UserReaction = {
reaction_id: 1,
...reactionData,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
};
// Mock DELETE returning 0 rows, then mock INSERT returning the new reaction
(mockClient.query as Mock)
.mockResolvedValueOnce({ rowCount: 0 }) // DELETE
.mockResolvedValueOnce({ rows: [mockCreatedReaction] }); // INSERT
vi.mocked(withTransaction).mockImplementation(async (callback) => {
return callback(mockClient as unknown as PoolClient);
});
const result = await reactionRepo.toggleReaction(reactionData, mockLogger);
expect(result).toEqual(mockCreatedReaction);
expect(mockClient.query).toHaveBeenCalledTimes(2);
expect(mockClient.query).toHaveBeenCalledWith(
'INSERT INTO public.user_reactions (user_id, entity_type, entity_id, reaction_type) VALUES ($1, $2, $3, $4) RETURNING *',
['user-1', 'recipe', '123', 'like'],
);
});
it('should throw ForeignKeyConstraintError if user or entity does not exist', async () => {
const dbError = new Error('violates foreign key constraint');
(dbError as Error & { code: string }).code = '23503';
vi.mocked(withTransaction).mockImplementation(async (callback) => {
const mockClient = { query: vi.fn().mockRejectedValue(dbError) };
await expect(callback(mockClient as unknown as PoolClient)).rejects.toThrow(dbError);
throw dbError;
});
await expect(reactionRepo.toggleReaction(reactionData, mockLogger)).rejects.toThrow(
ForeignKeyConstraintError,
);
await expect(reactionRepo.toggleReaction(reactionData, mockLogger)).rejects.toThrow(
'The specified user or entity does not exist.',
);
});
it('should throw a generic error if the transaction fails', async () => {
const dbError = new Error('Transaction failed');
vi.mocked(withTransaction).mockRejectedValue(dbError);
await expect(reactionRepo.toggleReaction(reactionData, mockLogger)).rejects.toThrow(
'Failed to toggle user reaction.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, reactionData },
'Database error in toggleReaction',
);
});
});
describe('getReactionSummary', () => {
it('should return a summary of reactions for an entity', async () => {
const mockSummary = [
{ reaction_type: 'like', count: 5 },
{ reaction_type: 'heart', count: 2 },
];
// This method uses getPool() directly, so we mock the main instance
mockPoolInstance.query.mockResolvedValue({ rows: mockSummary });
const result = await reactionRepo.getReactionSummary('recipe', '123', mockLogger);
expect(result).toEqual(mockSummary);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('GROUP BY reaction_type'),
['recipe', '123'],
);
});
it('should return an empty array if there are no reactions', async () => {
mockPoolInstance.query.mockResolvedValue({ rows: [] });
const result = await reactionRepo.getReactionSummary('recipe', '456', mockLogger);
expect(result).toEqual([]);
});
it('should throw an error if the database query fails', async () => {
const dbError = new Error('DB Error');
mockPoolInstance.query.mockRejectedValue(dbError);
await expect(
reactionRepo.getReactionSummary('recipe', '123', mockLogger),
).rejects.toThrow('Failed to retrieve reaction summary.');
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, entityType: 'recipe', entityId: '123' },
'Database error in getReactionSummary',
);
});
});
});

View 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();

View File

@@ -268,6 +268,17 @@ describe('Recipe DB Service', () => {
);
});
});
describe('deleteRecipe - Ownership Check', () => {
it('should not delete recipe if the user does not own it and is not an admin', async () => {
mockQuery.mockResolvedValue({ rowCount: 0 });
await expect(recipeRepo.deleteRecipe(1, 'wrong-user', false, mockLogger)).rejects.toThrow(
'Recipe not found or user does not have permission to delete.',
);
});
});
describe('updateRecipe', () => {
it('should execute an UPDATE query with the correct fields', async () => {
@@ -382,6 +393,7 @@ describe('Recipe DB Service', () => {
content: 'Great!',
status: 'visible',
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
};
mockQuery.mockResolvedValue({ rows: [mockComment] });
@@ -441,10 +453,6 @@ describe('Recipe DB Service', () => {
await expect(recipeRepo.forkRecipe('user-123', 1, mockLogger)).rejects.toThrow(
'Recipe is not public and cannot be forked.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, userId: 'user-123', originalRecipeId: 1 },
'Database error in forkRecipe',
);
});
it('should throw a generic error if the database query fails', async () => {

View File

@@ -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,13 @@ 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'))
) {
// Explicitly re-throw the "No fields" error before it gets caught by the generic handler.
if (error instanceof Error && error.message === 'No fields provided to update.') {
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.',
});
}
}
@@ -261,8 +259,20 @@ export class RecipeRepository {
const query = `
SELECT
r.*,
COALESCE(json_agg(DISTINCT jsonb_build_object('recipe_ingredient_id', ri.recipe_ingredient_id, 'master_item_name', mgi.name, 'quantity', ri.quantity, 'unit', ri.unit)) FILTER (WHERE ri.recipe_ingredient_id IS NOT NULL), '[]') AS ingredients,
COALESCE(json_agg(DISTINCT jsonb_build_object('tag_id', t.tag_id, 'name', t.name)) FILTER (WHERE t.tag_id IS NOT NULL), '[]') AS tags
COALESCE(json_agg(DISTINCT jsonb_build_object(
'recipe_ingredient_id', ri.recipe_ingredient_id,
'master_item_name', mgi.name,
'quantity', ri.quantity,
'unit', ri.unit,
'created_at', ri.created_at,
'updated_at', ri.updated_at
)) FILTER (WHERE ri.recipe_ingredient_id IS NOT NULL), '[]') AS ingredients,
COALESCE(json_agg(DISTINCT jsonb_build_object(
'tag_id', t.tag_id,
'name', t.name,
'created_at', t.created_at,
'updated_at', t.updated_at
)) FILTER (WHERE t.tag_id IS NOT NULL), '[]') AS tags
FROM public.recipes r
LEFT JOIN public.recipe_ingredients ri ON r.recipe_id = ri.recipe_id
LEFT JOIN public.master_grocery_items mgi ON ri.master_item_id = mgi.master_grocery_item_id
@@ -277,11 +287,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 +313,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 +341,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 +365,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.',
});
}
}
}

View File

@@ -166,7 +166,7 @@ describe('Shopping DB Service', () => {
it('should throw an error if no rows are deleted (list not found or wrong user)', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 0, rows: [], command: 'DELETE' });
await expect(shoppingRepo.deleteShoppingList(999, 'user-1', mockLogger)).rejects.toThrow(
'Failed to delete shopping list.',
'Shopping list not found or user does not have permission to delete.',
);
});
@@ -190,13 +190,14 @@ describe('Shopping DB Service', () => {
const result = await shoppingRepo.addShoppingListItem(
1,
'user-1',
{ customItemName: 'Custom Item' },
mockLogger,
);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('INSERT INTO public.shopping_list_items'),
[1, null, 'Custom Item'],
[1, null, 'Custom Item', 'user-1'],
);
expect(result).toEqual(mockItem);
});
@@ -205,11 +206,11 @@ describe('Shopping DB Service', () => {
const mockItem = createMockShoppingListItem({ master_item_id: 123 });
mockPoolInstance.query.mockResolvedValue({ rows: [mockItem] });
const result = await shoppingRepo.addShoppingListItem(1, { masterItemId: 123 }, mockLogger);
const result = await shoppingRepo.addShoppingListItem(1, 'user-1', { masterItemId: 123 }, mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('INSERT INTO public.shopping_list_items'),
[1, 123, null],
[1, 123, null, 'user-1'],
);
expect(result).toEqual(mockItem);
});
@@ -223,19 +224,20 @@ describe('Shopping DB Service', () => {
const result = await shoppingRepo.addShoppingListItem(
1,
'user-1',
{ masterItemId: 123, customItemName: 'Organic Apples' },
mockLogger,
);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('INSERT INTO public.shopping_list_items'),
[1, 123, 'Organic Apples'],
[1, 123, 'Organic Apples', 'user-1'],
);
expect(result).toEqual(mockItem);
});
it('should throw an error if both masterItemId and customItemName are missing', async () => {
await expect(shoppingRepo.addShoppingListItem(1, {}, mockLogger)).rejects.toThrow(
await expect(shoppingRepo.addShoppingListItem(1, 'user-1', {}, mockLogger)).rejects.toThrow(
'Either masterItemId or customItemName must be provided.',
);
});
@@ -244,19 +246,19 @@ describe('Shopping DB Service', () => {
const dbError = new Error('violates foreign key constraint');
(dbError as Error & { code: string }).code = '23503';
mockPoolInstance.query.mockRejectedValue(dbError);
await expect(
shoppingRepo.addShoppingListItem(999, { masterItemId: 999 }, mockLogger),
).rejects.toThrow('Referenced list or item does not exist.');
await expect(shoppingRepo.addShoppingListItem(999, 'user-1', { masterItemId: 999 }, mockLogger)).rejects.toThrow(
'Referenced list or item does not exist.',
);
});
it('should throw a generic error if the database query fails', async () => {
const dbError = new Error('DB Connection Error');
mockPoolInstance.query.mockRejectedValue(dbError);
await expect(
shoppingRepo.addShoppingListItem(1, { customItemName: 'Test' }, mockLogger),
shoppingRepo.addShoppingListItem(1, 'user-1', { customItemName: 'Test' }, mockLogger),
).rejects.toThrow('Failed to add item to shopping list.');
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, listId: 1, item: { customItemName: 'Test' } },
{ err: dbError, listId: 1, userId: 'user-1', item: { customItemName: 'Test' } },
'Database error in addShoppingListItem',
);
});
@@ -269,13 +271,14 @@ describe('Shopping DB Service', () => {
const result = await shoppingRepo.updateShoppingListItem(
1,
'user-1',
{ is_purchased: true },
mockLogger,
);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
'UPDATE public.shopping_list_items SET is_purchased = $1 WHERE shopping_list_item_id = $2 RETURNING *',
[true, 1],
expect.stringContaining('UPDATE public.shopping_list_items sli'),
[true, 1, 'user-1'],
);
expect(result).toEqual(mockItem);
});
@@ -285,11 +288,11 @@ describe('Shopping DB Service', () => {
const mockItem = createMockShoppingListItem({ shopping_list_item_id: 1, ...updates });
mockPoolInstance.query.mockResolvedValue({ rows: [mockItem], rowCount: 1 });
const result = await shoppingRepo.updateShoppingListItem(1, updates, mockLogger);
const result = await shoppingRepo.updateShoppingListItem(1, 'user-1', updates, mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
'UPDATE public.shopping_list_items SET quantity = $1, is_purchased = $2, notes = $3 WHERE shopping_list_item_id = $4 RETURNING *',
[updates.quantity, updates.is_purchased, updates.notes, 1],
expect.stringContaining('UPDATE public.shopping_list_items sli'),
[updates.quantity, updates.is_purchased, updates.notes, 1, 'user-1'],
);
expect(result).toEqual(mockItem);
});
@@ -297,13 +300,13 @@ describe('Shopping DB Service', () => {
it('should throw an error if the item to update is not found', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 0, rows: [], command: 'UPDATE' });
await expect(
shoppingRepo.updateShoppingListItem(999, { quantity: 5 }, mockLogger),
shoppingRepo.updateShoppingListItem(999, 'user-1', { quantity: 5 }, mockLogger),
).rejects.toThrow('Shopping list item not found.');
});
it('should throw an error if no valid fields are provided to update', async () => {
// The function should throw before even querying the database.
await expect(shoppingRepo.updateShoppingListItem(1, {}, mockLogger)).rejects.toThrow(
await expect(shoppingRepo.updateShoppingListItem(1, 'user-1', {}, mockLogger)).rejects.toThrow(
'No valid fields to update.',
);
});
@@ -312,44 +315,65 @@ describe('Shopping DB Service', () => {
const dbError = new Error('DB Connection Error');
mockPoolInstance.query.mockRejectedValue(dbError);
await expect(
shoppingRepo.updateShoppingListItem(1, { is_purchased: true }, mockLogger),
shoppingRepo.updateShoppingListItem(1, 'user-1', { is_purchased: true }, mockLogger),
).rejects.toThrow('Failed to update shopping list item.');
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, itemId: 1, updates: { is_purchased: true } },
{ err: dbError, itemId: 1, userId: 'user-1', updates: { is_purchased: true } },
'Database error in updateShoppingListItem',
);
});
});
describe('updateShoppingListItem - Ownership Check', () => {
it('should not update an item if the user does not own the shopping list', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 0 });
await expect(
shoppingRepo.updateShoppingListItem(1, 'wrong-user', { is_purchased: true }, mockLogger),
).rejects.toThrow('Shopping list item not found.');
});
});
describe('removeShoppingListItem', () => {
it('should delete an item if rowCount is 1', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 1, rows: [], command: 'DELETE' });
await expect(shoppingRepo.removeShoppingListItem(1, mockLogger)).resolves.toBeUndefined();
await expect(shoppingRepo.removeShoppingListItem(1, 'user-1', mockLogger)).resolves.toBeUndefined();
expect(mockPoolInstance.query).toHaveBeenCalledWith(
'DELETE FROM public.shopping_list_items WHERE shopping_list_item_id = $1',
[1],
expect.stringContaining('DELETE FROM public.shopping_list_items sli'),
[1, 'user-1'],
);
});
it('should throw an error if no rows are deleted (item not found)', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 0, rows: [], command: 'DELETE' });
await expect(shoppingRepo.removeShoppingListItem(999, mockLogger)).rejects.toThrow(
'Shopping list item not found.',
await expect(shoppingRepo.removeShoppingListItem(999, 'user-1', mockLogger)).rejects.toThrow(
'Shopping list item not found or user does not have permission.',
);
});
it('should throw a generic error if the database query fails', async () => {
const dbError = new Error('DB Connection Error');
mockPoolInstance.query.mockRejectedValue(dbError);
await expect(shoppingRepo.removeShoppingListItem(1, mockLogger)).rejects.toThrow(
await expect(shoppingRepo.removeShoppingListItem(1, 'user-1', mockLogger)).rejects.toThrow(
'Failed to remove item from shopping list.',
);
expect(mockLogger.error).toHaveBeenCalledWith(
{ err: dbError, itemId: 1 },
{ err: dbError, itemId: 1, userId: 'user-1' },
'Database error in removeShoppingListItem',
);
});
});
describe('removeShoppingListItem - Ownership Check', () => {
it('should not remove an item if the user does not own the shopping list', async () => {
mockPoolInstance.query.mockResolvedValue({ rowCount: 0 });
await expect(shoppingRepo.removeShoppingListItem(1, 'wrong-user', mockLogger)).rejects.toThrow(
'Shopping list item not found or user does not have permission.',
);
});
});
describe('completeShoppingList', () => {
it('should call the complete_shopping_list database function', async () => {

View File

@@ -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,
@@ -29,8 +29,7 @@ export class ShoppingRepository {
async getShoppingLists(userId: string, logger: Logger): Promise<ShoppingList[]> {
try {
const query = `
SELECT
sl.shopping_list_id, sl.name, sl.created_at,
SELECT sl.shopping_list_id, sl.name, sl.created_at, sl.updated_at,
COALESCE(json_agg(
json_build_object(
'shopping_list_item_id', sli.shopping_list_item_id,
@@ -40,6 +39,7 @@ export class ShoppingRepository {
'quantity', sli.quantity,
'is_purchased', sli.is_purchased,
'added_at', sli.added_at,
'updated_at', sli.updated_at,
'master_item', json_build_object('name', mgi.name)
)
) FILTER (WHERE sli.shopping_list_item_id IS NOT NULL), '[]'::json) as items
@@ -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.',
});
}
}
@@ -67,18 +68,15 @@ export class ShoppingRepository {
async createShoppingList(userId: string, name: string, logger: Logger): Promise<ShoppingList> {
try {
const res = await this.db.query<ShoppingList>(
'INSERT INTO public.shopping_lists (user_id, name) VALUES ($1, $2) RETURNING shopping_list_id, user_id, name, created_at',
'INSERT INTO public.shopping_lists (user_id, name) VALUES ($1, $2) RETURNING shopping_list_id, user_id, name, created_at, updated_at',
[userId, name],
);
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.',
});
}
}
@@ -91,8 +89,7 @@ export class ShoppingRepository {
async getShoppingListById(listId: number, userId: string, logger: Logger): Promise<ShoppingList> {
try {
const query = `
SELECT
sl.shopping_list_id, sl.name, sl.created_at,
SELECT sl.shopping_list_id, sl.name, sl.created_at, sl.updated_at,
COALESCE(json_agg(
json_build_object(
'shopping_list_item_id', sli.shopping_list_item_id,
@@ -102,6 +99,7 @@ export class ShoppingRepository {
'quantity', sli.quantity,
'is_purchased', sli.is_purchased,
'added_at', sli.added_at,
'updated_at', sli.updated_at,
'master_item', json_build_object('name', mgi.name)
)
) FILTER (WHERE sli.shopping_list_item_id IS NOT NULL), '[]'::json) as items
@@ -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.',
});
}
}
@@ -156,6 +156,7 @@ export class ShoppingRepository {
*/
async addShoppingListItem(
listId: number,
userId: string,
item: { masterItemId?: number; customItemName?: string },
logger: Logger,
): Promise<ShoppingListItem> {
@@ -165,18 +166,33 @@ export class ShoppingRepository {
}
try {
const res = await this.db.query<ShoppingListItem>(
'INSERT INTO public.shopping_list_items (shopping_list_id, master_item_id, custom_item_name) VALUES ($1, $2, $3) RETURNING *',
[listId, item.masterItemId ?? null, item.customItemName ?? null],
);
const query = `
INSERT INTO public.shopping_list_items (shopping_list_id, master_item_id, custom_item_name)
SELECT $1, $2, $3
WHERE EXISTS (
SELECT 1 FROM public.shopping_lists WHERE shopping_list_id = $1 AND user_id = $4
)
RETURNING *;
`;
const res = await this.db.query<ShoppingListItem>(query, [
listId,
item.masterItemId ?? null,
item.customItemName ?? null,
userId,
]);
if (res.rowCount === 0) {
throw new NotFoundError('Shopping list not found or user does not have permission.');
}
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.');
if (error instanceof NotFoundError) throw error;
handleDbError(error, logger, 'Database error in addShoppingListItem', { listId, userId, 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.',
});
}
}
@@ -184,20 +200,25 @@ export class ShoppingRepository {
* Removes an item from a shopping list.
* @param itemId The ID of the shopping list item to remove.
*/
async removeShoppingListItem(itemId: number, logger: Logger): Promise<void> {
async removeShoppingListItem(itemId: number, userId: string, logger: Logger): Promise<void> {
try {
const res = await this.db.query(
'DELETE FROM public.shopping_list_items WHERE shopping_list_item_id = $1',
[itemId],
);
// The patch requested this specific error handling.
const query = `
DELETE FROM public.shopping_list_items sli
WHERE sli.shopping_list_item_id = $1
AND EXISTS (
SELECT 1 FROM public.shopping_lists sl
WHERE sl.shopping_list_id = sli.shopping_list_id AND sl.user_id = $2
);
`;
const res = await this.db.query(query, [itemId, userId]);
if (res.rowCount === 0) {
throw new NotFoundError('Shopping list item not found.');
throw new NotFoundError('Shopping list item not found or user does not have permission.');
}
} 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, userId }, {
defaultMessage: 'Failed to remove item from shopping list.',
});
}
}
/**
@@ -218,11 +239,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 +269,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 +292,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 +316,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.',
});
}
}
@@ -308,6 +333,7 @@ export class ShoppingRepository {
*/
async updateShoppingListItem(
itemId: number,
userId: string,
updates: Partial<ShoppingListItem>,
logger: Logger,
): Promise<ShoppingListItem> {
@@ -337,10 +363,19 @@ export class ShoppingRepository {
}
values.push(itemId);
const query = `UPDATE public.shopping_list_items SET ${setClauses.join(', ')} WHERE shopping_list_item_id = $${valueIndex} RETURNING *`;
values.push(userId);
const query = `
UPDATE public.shopping_list_items sli
SET ${setClauses.join(', ')}
FROM public.shopping_lists sl
WHERE sli.shopping_list_item_id = $${valueIndex}
AND sli.shopping_list_id = sl.shopping_list_id
AND sl.user_id = $${valueIndex + 1}
RETURNING sli.*;
`;
const res = await this.db.query<ShoppingListItem>(query, values);
// The patch requested this specific error handling.
if (res.rowCount === 0) {
throw new NotFoundError('Shopping list item not found.');
}
@@ -353,8 +388,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, userId, updates }, {
defaultMessage: 'Failed to update shopping list item.',
});
}
}
@@ -378,15 +414,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.',
});
}
}
@@ -399,13 +430,15 @@ export class ShoppingRepository {
try {
const query = `
SELECT
st.shopping_trip_id, st.user_id, st.shopping_list_id, st.completed_at, st.total_spent_cents,
st.shopping_trip_id, st.user_id, st.shopping_list_id, st.completed_at, st.total_spent_cents, st.updated_at,
COALESCE(
json_agg(
json_build_object(
'shopping_trip_item_id', sti.shopping_trip_item_id,
'master_item_id', sti.master_item_id,
'custom_item_name', sti.custom_item_name,
'created_at', sti.created_at,
'updated_at', sti.updated_at,
'quantity', sti.quantity,
'price_paid_cents', sti.price_paid_cents,
'master_item_name', mgi.name
@@ -423,8 +456,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 +478,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.',
});
}
}
@@ -463,7 +495,14 @@ export class ShoppingRepository {
receiptId: number,
items: Omit<
ReceiptItem,
'receipt_item_id' | 'receipt_id' | 'status' | 'master_item_id' | 'product_id' | 'quantity'
| 'receipt_item_id'
| 'receipt_id'
| 'status'
| 'master_item_id'
| 'product_id'
| 'quantity'
| 'created_at'
| 'updated_at'
>[],
logger: Logger,
): Promise<void> {
@@ -479,7 +518,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 +530,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 +550,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 +572,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.',
});
}
}
}

View File

@@ -25,9 +25,9 @@ import { withTransaction } from './connection.db';
import { UserRepository, exportUserData } from './user.db';
import { mockPoolInstance } from '../../tests/setup/tests-setup-unit';
import { createMockUserProfile } from '../../tests/utils/mockFactories';
import { createMockUserProfile, createMockUser } from '../../tests/utils/mockFactories';
import { UniqueConstraintError, ForeignKeyConstraintError, NotFoundError } from './errors.db';
import type { Profile, ActivityLogItem, SearchQuery, UserProfile } from '../../types';
import type { Profile, ActivityLogItem, SearchQuery, UserProfile, User } from '../../types';
// Mock other db services that are used by functions in user.db.ts
// Update mocks to put methods on prototype so spyOn works in exportUserData tests
@@ -70,7 +70,16 @@ describe('User DB Service', () => {
describe('findUserByEmail', () => {
it('should execute the correct query and return a user', async () => {
const mockUser = { user_id: '123', email: 'test@example.com' };
const mockUser = {
user_id: '123',
email: 'test@example.com',
password_hash: 'some-hash',
failed_login_attempts: 0,
last_failed_login: null,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
refresh_token: null,
};
mockPoolInstance.query.mockResolvedValue({ rows: [mockUser] });
const result = await userRepo.findUserByEmail('test@example.com', mockLogger);
@@ -107,8 +116,12 @@ describe('User DB Service', () => {
describe('createUser', () => {
it('should execute a transaction to create a user and profile', async () => {
const mockUser = { user_id: 'new-user-id', email: 'new@example.com' };
const now = new Date().toISOString();
const mockUser = {
user_id: 'new-user-id',
email: 'new@example.com',
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
};
// This is the flat structure returned by the DB query inside createUser
const mockDbProfile = {
user_id: 'new-user-id',
@@ -118,24 +131,31 @@ describe('User DB Service', () => {
avatar_url: null,
points: 0,
preferences: null,
created_at: now,
updated_at: now,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
user_created_at: new Date().toISOString(),
user_updated_at: new Date().toISOString(),
};
// This is the nested structure the function is expected to return
const expectedProfile: UserProfile = {
user: { user_id: 'new-user-id', email: 'new@example.com' },
user: {
user_id: mockDbProfile.user_id,
email: mockDbProfile.email,
created_at: mockDbProfile.user_created_at,
updated_at: mockDbProfile.user_updated_at,
},
full_name: 'New User',
avatar_url: null,
role: 'user',
points: 0,
preferences: null,
created_at: now,
updated_at: now,
created_at: mockDbProfile.created_at,
updated_at: mockDbProfile.updated_at,
};
vi.mocked(withTransaction).mockImplementation(async (callback) => {
const mockClient = { query: vi.fn() };
mockClient.query
vi.mocked(withTransaction).mockImplementation(async (callback: any) => {
const mockClient = { query: vi.fn(), release: vi.fn() };
(mockClient.query as Mock)
.mockResolvedValueOnce({ rows: [] }) // set_config
.mockResolvedValueOnce({ rows: [mockUser] }) // INSERT user
.mockResolvedValueOnce({ rows: [mockDbProfile] }); // SELECT profile
@@ -149,16 +169,11 @@ describe('User DB Service', () => {
mockLogger,
);
console.log(
'[TEST DEBUG] createUser - Result from function:',
JSON.stringify(result, null, 2),
);
console.log(
'[TEST DEBUG] createUser - Expected result:',
JSON.stringify(expectedProfile, null, 2),
);
// Use objectContaining because the real implementation might have other DB-generated fields.
// We can't do a deep equality check on the user object because the mock factory will generate different timestamps.
expect(result.user.user_id).toEqual(expectedProfile.user.user_id);
expect(result.full_name).toEqual(expectedProfile.full_name);
// eslint-disable-next-line @typescript-eslint/no-unused-vars
expect(result).toEqual(expect.objectContaining(expectedProfile));
expect(withTransaction).toHaveBeenCalledTimes(1);
});
@@ -222,9 +237,7 @@ describe('User DB Service', () => {
}
expect(withTransaction).toHaveBeenCalledTimes(1);
expect(mockLogger.warn).toHaveBeenCalledWith(
`Attempted to create a user with an existing email: exists@example.com`,
);
expect(mockLogger.warn).toHaveBeenCalledWith(`Attempted to create a user with an existing email: exists@example.com`);
});
it('should throw an error if profile is not found after user creation', async () => {
@@ -255,8 +268,7 @@ describe('User DB Service', () => {
describe('findUserWithProfileByEmail', () => {
it('should query for a user and their profile by email', async () => {
const now = new Date().toISOString();
const mockDbResult = {
const mockDbResult: any = {
user_id: '123',
email: 'test@example.com',
password_hash: 'hash',
@@ -268,9 +280,11 @@ describe('User DB Service', () => {
role: 'user' as const,
points: 0,
preferences: null,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
user_created_at: new Date().toISOString(),
user_updated_at: new Date().toISOString(),
address_id: null,
created_at: now,
updated_at: now,
};
mockPoolInstance.query.mockResolvedValue({ rows: [mockDbResult] });
@@ -281,9 +295,12 @@ describe('User DB Service', () => {
points: 0,
preferences: null,
address_id: null,
created_at: now,
updated_at: now,
user: { user_id: '123', email: 'test@example.com' },
user: {
user_id: '123',
email: 'test@example.com',
created_at: expect.any(String),
updated_at: expect.any(String),
},
password_hash: 'hash',
failed_login_attempts: 0,
last_failed_login: null,
@@ -292,15 +309,6 @@ describe('User DB Service', () => {
const result = await userRepo.findUserWithProfileByEmail('test@example.com', mockLogger);
console.log(
'[TEST DEBUG] findUserWithProfileByEmail - Result from function:',
JSON.stringify(result, null, 2),
);
console.log(
'[TEST DEBUG] findUserWithProfileByEmail - Expected result:',
JSON.stringify(expectedResult, null, 2),
);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('JOIN public.profiles'),
['test@example.com'],
@@ -329,7 +337,11 @@ describe('User DB Service', () => {
describe('findUserById', () => {
it('should query for a user by their ID', async () => {
mockPoolInstance.query.mockResolvedValue({ rows: [{ user_id: '123' }], rowCount: 1 });
const mockUser = createMockUser({ user_id: '123' });
mockPoolInstance.query.mockResolvedValue({
rows: [mockUser],
rowCount: 1,
});
await userRepo.findUserById('123', mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('FROM public.users WHERE user_id = $1'),
@@ -359,13 +371,16 @@ describe('User DB Service', () => {
describe('findUserWithPasswordHashById', () => {
it('should query for a user and their password hash by ID', async () => {
const mockUser = createMockUser({ user_id: '123' });
const mockUserWithHash = { ...mockUser, password_hash: 'hash' };
mockPoolInstance.query.mockResolvedValue({
rows: [{ user_id: '123', password_hash: 'hash' }],
rows: [mockUserWithHash],
rowCount: 1,
});
await userRepo.findUserWithPasswordHashById('123', mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('SELECT user_id, email, password_hash'),
expect.stringContaining('SELECT user_id, email, password_hash, created_at, updated_at'),
['123'],
);
});
@@ -395,7 +410,11 @@ describe('User DB Service', () => {
describe('findUserProfileById', () => {
it('should query for a user profile by user ID', async () => {
mockPoolInstance.query.mockResolvedValue({ rows: [{ user_id: '123' }] });
const mockProfile = createMockUserProfile({
user: createMockUser({ user_id: '123' }),
});
// The query returns a user object inside, so we need to mock that structure.
mockPoolInstance.query.mockResolvedValue({ rows: [mockProfile] });
await userRepo.findUserProfileById('123', mockLogger);
// The actual query uses 'p.user_id' due to the join alias
expect(mockPoolInstance.query).toHaveBeenCalledWith(
@@ -426,7 +445,7 @@ describe('User DB Service', () => {
describe('updateUserProfile', () => {
it('should execute an UPDATE query for the user profile', async () => {
const mockProfile: Profile = {
const mockProfile: any = {
full_name: 'Updated Name',
role: 'user',
points: 0,
@@ -444,7 +463,7 @@ describe('User DB Service', () => {
});
it('should execute an UPDATE query for avatar_url', async () => {
const mockProfile: Profile = {
const mockProfile: any = {
avatar_url: 'new-avatar.png',
role: 'user',
points: 0,
@@ -462,7 +481,7 @@ describe('User DB Service', () => {
});
it('should execute an UPDATE query for address_id', async () => {
const mockProfile: Profile = {
const mockProfile: any = {
address_id: 99,
role: 'user',
points: 0,
@@ -480,8 +499,8 @@ describe('User DB Service', () => {
});
it('should fetch the current profile if no update fields are provided', async () => {
const mockProfile: Profile = createMockUserProfile({
user: { user_id: '123', email: '123@example.com' },
const mockProfile: UserProfile = createMockUserProfile({
user: createMockUser({ user_id: '123', email: '123@example.com' }),
full_name: 'Current Name',
});
// FIX: Instead of mocking `mockResolvedValue` on the instance method which might fail if not spied correctly,
@@ -520,7 +539,7 @@ describe('User DB Service', () => {
describe('updateUserPreferences', () => {
it('should execute an UPDATE query for user preferences', async () => {
mockPoolInstance.query.mockResolvedValue({ rows: [{}] });
mockPoolInstance.query.mockResolvedValue({ rows: [createMockUserProfile()] });
await userRepo.updateUserPreferences('123', { darkMode: true }, mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining("SET preferences = COALESCE(preferences, '{}'::jsonb) || $1"),
@@ -616,7 +635,11 @@ describe('User DB Service', () => {
describe('findUserByRefreshToken', () => {
it('should query for a user by their refresh token', async () => {
mockPoolInstance.query.mockResolvedValue({ rows: [{ user_id: '123' }], rowCount: 1 });
const mockUser = createMockUser({ user_id: '123' });
mockPoolInstance.query.mockResolvedValue({
rows: [mockUser],
rowCount: 1,
});
await userRepo.findUserByRefreshToken('a-token', mockLogger);
expect(mockPoolInstance.query).toHaveBeenCalledWith(
expect.stringContaining('WHERE refresh_token = $1'),
@@ -788,7 +811,7 @@ describe('User DB Service', () => {
const findProfileSpy = vi.spyOn(UserRepository.prototype, 'findUserProfileById');
findProfileSpy.mockResolvedValue(
createMockUserProfile({ user: { user_id: '123', email: '123@example.com' } }),
createMockUserProfile({ user: createMockUser({ user_id: '123', email: '123@example.com' }) }),
);
const getWatchedItemsSpy = vi.spyOn(PersonalizationRepository.prototype, 'getWatchedItems');
getWatchedItemsSpy.mockResolvedValue([]);
@@ -815,9 +838,7 @@ describe('User DB Service', () => {
);
// Act & Assert: The outer function catches the NotFoundError and re-throws it.
await expect(exportUserData('123', mockLogger)).rejects.toThrow(
'Failed to export user data.',
);
await expect(exportUserData('123', mockLogger)).rejects.toThrow('Profile not found');
expect(withTransaction).toHaveBeenCalledTimes(1);
});
@@ -898,8 +919,8 @@ describe('User DB Service', () => {
user_id: 'following-1',
action: 'recipe_created',
display_text: 'Created a new recipe',
created_at: new Date().toISOString(),
details: { recipe_id: 1, recipe_name: 'Test Recipe' },
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
},
];
@@ -935,16 +956,17 @@ describe('User DB Service', () => {
describe('logSearchQuery', () => {
it('should execute an INSERT query and return the new search query log', async () => {
const queryData: Omit<SearchQuery, 'search_query_id' | 'created_at'> = {
const queryData: Omit<SearchQuery, 'search_query_id' | 'created_at' | 'updated_at'> = {
user_id: 'user-123',
query_text: 'best chicken recipes',
result_count: 5,
was_successful: true,
};
const mockLoggedQuery: SearchQuery = {
const mockLoggedQuery: any = {
search_query_id: 1,
created_at: new Date().toISOString(),
...queryData,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
};
mockPoolInstance.query.mockResolvedValue({ rows: [mockLoggedQuery] });
@@ -966,8 +988,9 @@ describe('User DB Service', () => {
};
const mockLoggedQuery: SearchQuery = {
search_query_id: 2,
created_at: new Date().toISOString(),
...queryData,
created_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
};
mockPoolInstance.query.mockResolvedValue({ rows: [mockLoggedQuery] });

View File

@@ -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, UniqueConstraintError } from './errors.db';
import {
Profile,
MasterGroceryItem,
@@ -10,6 +10,7 @@ import {
ActivityLogItem,
UserProfile,
SearchQuery,
User,
} from '../../types';
import { ShoppingRepository } from './shopping.db';
import { PersonalizationRepository } from './personalization.db';
@@ -26,6 +27,8 @@ interface DbUser {
refresh_token?: string | null;
failed_login_attempts: number;
last_failed_login: string | null; // This will be a date string from the DB
created_at: string;
updated_at: string;
}
export class UserRepository {
@@ -43,7 +46,7 @@ export class UserRepository {
logger.debug({ email }, `[DB findUserByEmail] Searching for user.`);
try {
const res = await this.db.query<DbUser>(
'SELECT user_id, email, password_hash, refresh_token, failed_login_attempts, last_failed_login FROM public.users WHERE email = $1',
'SELECT user_id, email, password_hash, refresh_token, failed_login_attempts, last_failed_login, created_at, updated_at FROM public.users WHERE email = $1',
[email],
);
const userFound = res.rows[0];
@@ -52,8 +55,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.',
});
}
}
@@ -90,7 +94,7 @@ export class UserRepository {
// After the trigger has run, fetch the complete profile data.
const profileQuery = `
SELECT u.user_id, u.email, p.full_name, p.avatar_url, p.role, p.points, p.preferences, p.created_at, p.updated_at
SELECT u.user_id, u.email, u.created_at as user_created_at, u.updated_at as user_updated_at, p.full_name, p.avatar_url, p.role, p.points, p.preferences, p.created_at, p.updated_at
FROM public.users u
JOIN public.profiles p ON u.user_id = p.user_id
WHERE u.user_id = $1;
@@ -108,6 +112,8 @@ export class UserRepository {
user: {
user_id: flatProfile.user_id,
email: flatProfile.email,
created_at: flatProfile.user_created_at,
updated_at: flatProfile.user_updated_at,
},
full_name: flatProfile.full_name,
avatar_url: flatProfile.avatar_url,
@@ -121,14 +127,16 @@ 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') {
// Specific handling for unique constraint violation on user creation
if (error instanceof Error && 'code' in error && (error as any).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.');
// Fallback to generic handler for all other errors
handleDbError(error, logger, 'Error during createUser transaction', { email }, {
uniqueMessage: 'A user with this email address already exists.',
defaultMessage: 'Failed to create user in database.',
});
});
}
@@ -145,15 +153,17 @@ export class UserRepository {
logger.debug({ email }, `[DB findUserWithProfileByEmail] Searching for user.`);
try {
const query = `
SELECT
u.user_id, u.email, u.password_hash, u.refresh_token, u.failed_login_attempts, u.last_failed_login,
SELECT
u.user_id, u.email, u.created_at as user_created_at, u.updated_at as user_updated_at, u.password_hash, u.refresh_token, u.failed_login_attempts, u.last_failed_login,
p.full_name, p.avatar_url, p.role, p.points, p.preferences, p.address_id,
p.created_at, p.updated_at
FROM public.users u
JOIN public.profiles p ON u.user_id = p.user_id
WHERE u.email = $1;
`;
const res = await this.db.query<DbUser & Profile>(query, [email]);
const res = await this.db.query<
DbUser & Profile & { user_created_at: string; user_updated_at: string }
>(query, [email]);
const flatUser = res.rows[0];
if (!flatUser) {
@@ -173,6 +183,8 @@ export class UserRepository {
user: {
user_id: flatUser.user_id,
email: flatUser.email,
created_at: flatUser.user_created_at,
updated_at: flatUser.user_updated_at,
},
password_hash: flatUser.password_hash,
failed_login_attempts: flatUser.failed_login_attempts,
@@ -182,8 +194,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.',
});
}
}
@@ -193,10 +206,10 @@ export class UserRepository {
* @returns A promise that resolves to the user object (id, email) or undefined if not found.
*/
// prettier-ignore
async findUserById(userId: string, logger: Logger): Promise<{ user_id: string; email: string; }> {
async findUserById(userId: string, logger: Logger): Promise<User> {
try {
const res = await this.db.query<{ user_id: string; email: string }>(
'SELECT user_id, email FROM public.users WHERE user_id = $1',
const res = await this.db.query<User>(
'SELECT user_id, email, created_at, updated_at FROM public.users WHERE user_id = $1',
[userId]
);
if (res.rowCount === 0) {
@@ -205,11 +218,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.',
});
}
}
@@ -220,10 +231,10 @@ export class UserRepository {
* @returns A promise that resolves to the user object (id, email, password_hash) or undefined if not found.
*/
// prettier-ignore
async findUserWithPasswordHashById(userId: string, logger: Logger): Promise<{ user_id: string; email: string; password_hash: string | null }> {
async findUserWithPasswordHashById(userId: string, logger: Logger): Promise<User & { password_hash: string | null }> {
try {
const res = await this.db.query<{ user_id: string; email: string; password_hash: string | null }>(
'SELECT user_id, email, password_hash FROM public.users WHERE user_id = $1',
const res = await this.db.query<User & { password_hash: string | null }>(
'SELECT user_id, email, password_hash, created_at, updated_at FROM public.users WHERE user_id = $1',
[userId]
);
if ((res.rowCount ?? 0) === 0) {
@@ -232,11 +243,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.',
});
}
}
@@ -253,7 +262,9 @@ export class UserRepository {
p.created_at, p.updated_at,
json_build_object(
'user_id', u.user_id,
'email', u.email
'email', u.email,
'created_at', u.created_at,
'updated_at', u.updated_at
) as user,
CASE
WHEN a.address_id IS NOT NULL THEN json_build_object(
@@ -281,11 +292,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 +339,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 +370,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 +389,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 +404,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 +423,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.',
});
}
}
@@ -437,10 +437,10 @@ export class UserRepository {
async findUserByRefreshToken(
refreshToken: string,
logger: Logger,
): Promise<{ user_id: string; email: string } | undefined> {
): Promise<User | undefined> {
try {
const res = await this.db.query<{ user_id: string; email: string }>(
'SELECT user_id, email FROM public.users WHERE refresh_token = $1',
const res = await this.db.query<User>(
'SELECT user_id, email, created_at, updated_at FROM public.users WHERE refresh_token = $1',
[refreshToken],
);
if ((res.rowCount ?? 0) === 0) {
@@ -448,8 +448,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 +484,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 +504,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 +541,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 +558,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 +578,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 +610,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.',
});
}
}
@@ -623,7 +622,7 @@ export class UserRepository {
* @returns A promise that resolves to the created SearchQuery object.
*/
async logSearchQuery(
queryData: Omit<SearchQuery, 'search_query_id' | 'created_at'>,
queryData: Omit<SearchQuery, 'search_query_id' | 'created_at' | 'updated_at'>,
logger: Logger,
): Promise<SearchQuery> {
const { user_id, query_text, result_count, was_successful } = queryData;
@@ -634,8 +633,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 +669,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.',
});
}
}

View File

@@ -100,7 +100,7 @@ describe('FlyerAiProcessor', () => {
valid_to: null,
store_address: null,
};
vi.mocked(mockAiService.extractCoreDataFromFlyerImage).mockResolvedValue(mockAiResponse as any);
vi.mocked(mockAiService.extractCoreDataFromFlyerImage).mockResolvedValue(mockAiResponse);
const { logger } = await import('./logger.server');
const imagePaths = [{ path: 'page1.jpg', mimetype: 'image/jpeg' }];

View File

@@ -83,8 +83,8 @@ describe('FlyerDataTransformer', () => {
// 1. Check flyer data
expect(flyerData).toEqual({
file_name: originalFileName,
image_url: '/flyer-images/flyer-page-1.jpg',
icon_url: '/flyer-images/icons/icon-flyer-page-1.webp',
image_url: `http://localhost:3000/flyer-images/flyer-page-1.jpg`,
icon_url: `http://localhost:3000/flyer-images/icons/icon-flyer-page-1.webp`,
checksum,
store_name: 'Test Store',
valid_from: '2024-01-01',
@@ -167,8 +167,8 @@ describe('FlyerDataTransformer', () => {
expect(itemsForDb).toHaveLength(0);
expect(flyerData).toEqual({
file_name: originalFileName,
image_url: '/flyer-images/another.png',
icon_url: '/flyer-images/icons/icon-another.webp',
image_url: `http://localhost:3000/flyer-images/another.png`,
icon_url: `http://localhost:3000/flyer-images/icons/icon-another.webp`,
checksum,
store_name: 'Unknown Store (auto)', // Should use fallback
valid_from: null,

View File

@@ -23,14 +23,14 @@ export class FlyerDataTransformer {
): FlyerItemInsert {
return {
...item,
// Use logical OR to default falsy values (null, undefined, '') to a fallback.
// The trim is important for cases where the AI returns only whitespace.
item: String(item.item || '').trim() || 'Unknown Item',
// Use nullish coalescing to default only null/undefined to an empty string.
price_display: String(item.price_display ?? ''),
quantity: String(item.quantity ?? ''),
// Use logical OR to default falsy category names (null, undefined, '') to a fallback.
category_name: String(item.category_name || 'Other/Miscellaneous'),
// Use nullish coalescing and trim for robustness.
// An empty or whitespace-only name falls back to 'Unknown Item'.
item: (item.item ?? '').trim() || 'Unknown Item',
// Default null/undefined to an empty string and trim.
price_display: (item.price_display ?? '').trim(),
quantity: (item.quantity ?? '').trim(),
// An empty or whitespace-only category falls back to 'Other/Miscellaneous'.
category_name: (item.category_name ?? '').trim() || 'Other/Miscellaneous',
// Use nullish coalescing to convert null to undefined for the database.
master_item_id: item.master_item_id ?? undefined,
view_count: 0,
@@ -75,10 +75,13 @@ export class FlyerDataTransformer {
logger.warn('AI did not return a store name. Using fallback "Unknown Store (auto)".');
}
// Construct proper URLs including protocol and host to satisfy DB constraints
const baseUrl = process.env.BASE_URL || `http://localhost:${process.env.PORT || 3000}`;
const flyerData: FlyerInsert = {
file_name: originalFileName,
image_url: `/flyer-images/${path.basename(firstImage)}`,
icon_url: `/flyer-images/icons/${iconFileName}`,
image_url: new URL(`/flyer-images/${path.basename(firstImage)}`, baseUrl).href,
icon_url: new URL(`/flyer-images/icons/${iconFileName}`, baseUrl).href,
checksum,
store_name: storeName,
valid_from: extractedData.valid_from,

View File

@@ -112,6 +112,57 @@ describe('Authentication E2E Flow', () => {
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', () => {

View File

@@ -164,8 +164,10 @@ describe('Admin API Routes Integration Tests', () => {
beforeEach(async () => {
const flyerRes = await getPool().query(
`INSERT INTO public.flyers (store_id, file_name, image_url, item_count, checksum)
VALUES ($1, 'admin-test.jpg', 'http://test.com/img.jpg', 1, $2) RETURNING flyer_id`,
[testStoreId, `checksum-${Date.now()}-${Math.random()}`],
VALUES ($1, 'admin-test.jpg', 'https://example.com/flyer-images/asdmin-test.jpg', 1, $2) RETURNING flyer_id`,
// The checksum must be a unique 64-character string to satisfy the DB constraint.
// We generate a dynamic string and pad it to 64 characters.
[testStoreId, `checksum-${Date.now()}-${Math.random()}`.padEnd(64, '0')],
);
const flyerId = flyerRes.rows[0].flyer_id;

View File

@@ -1,5 +1,5 @@
// src/tests/integration/flyer-processing.integration.test.ts
import { describe, it, expect, beforeAll, afterAll } from 'vitest';
import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest';
import supertest from 'supertest';
import app from '../../../server';
import fs from 'node:fs/promises';
@@ -8,7 +8,7 @@ import * as db from '../../services/db/index.db';
import { getPool } from '../../services/db/connection.db';
import { generateFileChecksum } from '../../utils/checksum';
import { logger } from '../../services/logger.server';
import type { UserProfile } from '../../types';
import type { UserProfile, ExtractedFlyerItem } from '../../types';
import { createAndLoginUser } from '../utils/testHelpers';
import { cleanupDb } from '../utils/cleanup';
import { cleanupFiles } from '../utils/cleanupFiles';
@@ -16,12 +16,16 @@ import piexif from 'piexifjs';
import exifParser from 'exif-parser';
import sharp from 'sharp';
/**
* @vitest-environment node
*/
const request = supertest(app);
// Import the mocked service to control its behavior in tests.
import { aiService } from '../../services/aiService.server';
describe('Flyer Processing Background Job Integration Test', () => {
const createdUserIds: string[] = [];
const createdFlyerIds: number[] = [];
@@ -29,6 +33,23 @@ describe('Flyer Processing Background Job Integration Test', () => {
beforeAll(async () => {
// This setup is now simpler as the worker handles fetching master items.
// Setup default mock response for AI service
const mockItems: ExtractedFlyerItem[] = [
{
item: 'Mocked Integration Item',
price_display: '$1.99',
price_in_cents: 199,
quantity: 'each',
category_name: 'Mock Category',
},
];
vi.spyOn(aiService, 'extractCoreDataFromFlyerImage').mockResolvedValue({
store_name: 'Mock Store',
valid_from: null,
valid_to: null,
store_address: null,
items: mockItems,
});
});
afterAll(async () => {
@@ -80,7 +101,7 @@ describe('Flyer Processing Background Job Integration Test', () => {
// Act 2: Poll for the job status until it completes.
let jobStatus;
const maxRetries = 30; // Poll for up to 90 seconds (30 * 3s)
const maxRetries = 60; // Poll for up to 180 seconds (60 * 3s)
for (let i = 0; i < maxRetries; i++) {
console.log(`Polling attempt ${i + 1}...`);
await new Promise((resolve) => setTimeout(resolve, 3000)); // Wait 3 seconds between polls
@@ -149,12 +170,12 @@ describe('Flyer Processing Background Job Integration Test', () => {
// Act & Assert
await runBackgroundProcessingTest(authUser, token);
}, 120000); // Increase timeout to 120 seconds for this long-running test
}, 240000); // Increase timeout to 240 seconds for this long-running test
it('should successfully process a flyer for an ANONYMOUS user via the background queue', async () => {
// Act & Assert: Call the test helper without a user or token.
await runBackgroundProcessingTest();
}, 120000); // Increase timeout to 120 seconds for this long-running test
}, 240000); // Increase timeout to 240 seconds for this long-running test
it(
'should strip EXIF data from uploaded JPEG images during processing',
@@ -238,7 +259,7 @@ describe('Flyer Processing Background Job Integration Test', () => {
expect(exifResult.tags).toEqual({});
expect(exifResult.tags.Software).toBeUndefined();
},
120000,
240000,
);
it(
@@ -322,6 +343,6 @@ describe('Flyer Processing Background Job Integration Test', () => {
// The `exif` property should be undefined after the fix.
expect(savedImageMetadata.exif).toBeUndefined();
},
120000,
240000,
);
});

View File

@@ -25,8 +25,8 @@ describe('Public Flyer API Routes Integration Tests', () => {
const flyerRes = await getPool().query(
`INSERT INTO public.flyers (store_id, file_name, image_url, item_count, checksum)
VALUES ($1, 'integration-test.jpg', 'http://test.com/img.jpg', 1, $2) RETURNING flyer_id`,
[storeId, `checksum-${Date.now()}`],
VALUES ($1, 'integration-test.jpg', 'https://example.com/flyer-images/integration-test.jpg', 1, $2) RETURNING flyer_id`,
[storeId, `${Date.now().toString(16)}`.padEnd(64, '0')],
);
createdFlyerId = flyerRes.rows[0].flyer_id;

View File

@@ -1,5 +1,5 @@
// src/tests/integration/gamification.integration.test.ts
import { describe, it, expect, beforeAll, afterAll } from 'vitest';
import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest';
import supertest from 'supertest';
import app from '../../../server';
import path from 'path';
@@ -9,7 +9,13 @@ import { generateFileChecksum } from '../../utils/checksum';
import * as db from '../../services/db/index.db';
import { cleanupDb } from '../utils/cleanup';
import { logger } from '../../services/logger.server';
import type { UserProfile, UserAchievement, LeaderboardUser, Achievement } from '../../types';
import type {
UserProfile,
UserAchievement,
LeaderboardUser,
Achievement,
ExtractedFlyerItem,
} from '../../types';
import { cleanupFiles } from '../utils/cleanupFiles';
/**
@@ -18,6 +24,9 @@ import { cleanupFiles } from '../utils/cleanupFiles';
const request = supertest(app);
// Import the mocked service to control its behavior in tests.
import { aiService } from '../../services/aiService.server';
describe('Gamification Flow Integration Test', () => {
let testUser: UserProfile;
let authToken: string;
@@ -31,6 +40,28 @@ describe('Gamification Flow Integration Test', () => {
fullName: 'Gamification Tester',
request,
}));
// Mock the AI service's method to prevent actual API calls during integration tests.
// This is crucial for making the integration test reliable. We don't want to
// depend on the external Gemini API, which has quotas and can be slow.
// By mocking this, we test our application's internal flow:
// API -> Queue -> Worker -> DB -> Gamification Logic
const mockExtractedItems: ExtractedFlyerItem[] = [
{
item: 'Integration Test Milk',
price_display: '$4.99',
price_in_cents: 499,
quantity: '2L',
category_name: 'Dairy',
},
];
vi.spyOn(aiService, 'extractCoreDataFromFlyerImage').mockResolvedValue({
store_name: 'Gamification Test Store',
valid_from: null,
valid_to: null,
store_address: null,
items: mockExtractedItems,
});
});
afterAll(async () => {
@@ -81,12 +112,17 @@ describe('Gamification Flow Integration Test', () => {
break;
}
}
if (!jobStatus) {
console.error('[DEBUG] Gamification test job timed out: No job status received.');
throw new Error('Gamification test job timed out: No job status received.');
}
// --- Assert 1: Verify the job completed successfully ---
if (jobStatus?.state === 'failed') {
console.error('[DEBUG] Gamification test job failed:', jobStatus.failedReason);
}
expect(jobStatus?.state).toBe('completed');
const flyerId = jobStatus?.returnValue?.flyerId;
expect(flyerId).toBeTypeOf('number');
createdFlyerIds.push(flyerId); // Track for cleanup

View File

@@ -35,22 +35,22 @@ describe('Price History API Integration Test (/api/price-history)', () => {
// 3. Create two flyers with different dates
const flyerRes1 = await pool.query(
`INSERT INTO public.flyers (store_id, file_name, image_url, item_count, checksum, valid_from)
VALUES ($1, 'price-test-1.jpg', 'http://test.com/price-1.jpg', 1, $2, '2025-01-01') RETURNING flyer_id`,
[storeId, `checksum-price-1-${Date.now()}`],
VALUES ($1, 'price-test-1.jpg', 'https://example.com/flyer-images/price-test-1.jpg', 1, $2, '2025-01-01') RETURNING flyer_id`,
[storeId, `${Date.now().toString(16)}1`.padEnd(64, '0')],
);
flyerId1 = flyerRes1.rows[0].flyer_id;
const flyerRes2 = await pool.query(
`INSERT INTO public.flyers (store_id, file_name, image_url, item_count, checksum, valid_from)
VALUES ($1, 'price-test-2.jpg', 'http://test.com/price-2.jpg', 1, $2, '2025-01-08') RETURNING flyer_id`,
[storeId, `checksum-price-2-${Date.now()}`],
VALUES ($1, 'price-test-2.jpg', 'https://example.com/flyer-images/price-test-2.jpg', 1, $2, '2025-01-08') RETURNING flyer_id`,
[storeId, `${Date.now().toString(16)}2`.padEnd(64, '0')],
);
flyerId2 = flyerRes2.rows[0].flyer_id; // This was a duplicate, fixed.
const flyerRes3 = await pool.query(
`INSERT INTO public.flyers (store_id, file_name, image_url, item_count, checksum, valid_from)
VALUES ($1, 'price-test-3.jpg', 'http://test.com/price-3.jpg', 1, $2, '2025-01-15') RETURNING flyer_id`,
[storeId, `checksum-price-3-${Date.now()}`],
VALUES ($1, 'price-test-3.jpg', 'https://example.com/flyer-images/price-test-3.jpg', 1, $2, '2025-01-15') RETURNING flyer_id`,
[storeId, `${Date.now().toString(16)}3`.padEnd(64, '0')],
);
flyerId3 = flyerRes3.rows[0].flyer_id;

Some files were not shown because too many files have changed in this diff Show More