Compare commits

...

3 Commits

Author SHA1 Message Date
Gitea Actions
689320e7d2 ci: Bump version to 0.9.63 [skip ci] 2026-01-09 13:19:09 +05:00
e457bbf046 more req work
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 26m51s
2026-01-09 00:18:09 -08:00
68cdbb6066 progress enforcing adr-0005 2026-01-09 00:18:09 -08:00
18 changed files with 223 additions and 302 deletions

View File

@@ -45,7 +45,16 @@
"Bash(powershell.exe -Command \"echo ''List all podman containers'' | claude --print\")",
"Bash(powershell.exe -Command \"echo ''List my repositories on gitea.projectium.com using gitea-projectium MCP'' | claude --print\")",
"Bash(powershell.exe -Command \"echo ''List my repositories on gitea.projectium.com using gitea-projectium MCP'' | claude --print --allowedTools ''mcp__gitea-projectium__*''\")",
"Bash(powershell.exe -Command \"echo ''Fetch the homepage of https://gitea.projectium.com and summarize it'' | claude --print --allowedTools ''mcp__fetch__*''\")"
"Bash(powershell.exe -Command \"echo ''Fetch the homepage of https://gitea.projectium.com and summarize it'' | claude --print --allowedTools ''mcp__fetch__*''\")",
"Bash(dir \"C:\\\\Users\\\\games3\\\\.claude\")",
"Bash(dir:*)",
"Bash(D:nodejsnpx.cmd -y @modelcontextprotocol/server-fetch --help)",
"Bash(cmd /c \"dir /o-d C:\\\\Users\\\\games3\\\\.claude\\\\debug 2>nul | head -10\")",
"mcp__memory__read_graph",
"mcp__memory__create_entities",
"mcp__memory__search_nodes",
"mcp__memory__delete_entities",
"mcp__sequential-thinking__sequentialthinking"
]
}
}

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "flyer-crawler",
"version": "0.9.62",
"version": "0.9.63",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "flyer-crawler",
"version": "0.9.62",
"version": "0.9.63",
"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.9.62",
"version": "0.9.63",
"type": "module",
"scripts": {
"dev": "concurrently \"npm:start:dev\" \"vite\"",

View File

@@ -2,14 +2,13 @@
import { renderHook } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { useFlyerItems } from './useFlyerItems';
import { useApiOnMount } from './useApiOnMount';
import * as apiClient from '../services/apiClient';
import * as useFlyerItemsQueryModule from './queries/useFlyerItemsQuery';
import { createMockFlyer, createMockFlyerItem } from '../tests/utils/mockFactories';
// Mock the underlying useApiOnMount hook to isolate the useFlyerItems hook's logic.
vi.mock('./useApiOnMount');
// Mock the underlying query hook to isolate the useFlyerItems hook's logic.
vi.mock('./queries/useFlyerItemsQuery');
const mockedUseApiOnMount = vi.mocked(useApiOnMount);
const mockedUseFlyerItemsQuery = vi.mocked(useFlyerItemsQueryModule.useFlyerItemsQuery);
describe('useFlyerItems Hook', () => {
const mockFlyer = createMockFlyer({
@@ -39,19 +38,16 @@ describe('useFlyerItems Hook', () => {
];
beforeEach(() => {
// Clear mock history before each test
vi.clearAllMocks();
});
it('should return initial state and not call useApiOnMount when flyer is null', () => {
// Arrange: Mock the return value of the inner hook.
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: false,
it('should return initial state when flyer is null', () => {
// Arrange: Mock the return value of the query hook.
mockedUseFlyerItemsQuery.mockReturnValue({
data: undefined,
isLoading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
});
} as ReturnType<typeof useFlyerItemsQueryModule.useFlyerItemsQuery>);
// Act: Render the hook with a null flyer.
const { result } = renderHook(() => useFlyerItems(null));
@@ -60,57 +56,41 @@ 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
[null], // dependencies array
{ enabled: false }, // options object
undefined, // flyer_id
);
// Assert: Check that useFlyerItemsQuery was called with undefined flyerId.
expect(mockedUseFlyerItemsQuery).toHaveBeenCalledWith(undefined);
});
it('should call useApiOnMount with enabled: true when a flyer is provided', () => {
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: true,
it('should call useFlyerItemsQuery with flyerId when a flyer is provided', () => {
mockedUseFlyerItemsQuery.mockReturnValue({
data: undefined,
isLoading: true,
error: null,
isRefetching: false,
reset: vi.fn(),
});
} as ReturnType<typeof useFlyerItemsQueryModule.useFlyerItemsQuery>);
renderHook(() => useFlyerItems(mockFlyer));
// Assert: Check that useApiOnMount was called with the correct parameters.
expect(mockedUseApiOnMount).toHaveBeenCalledWith(
expect.any(Function),
[mockFlyer],
{ enabled: true },
mockFlyer.flyer_id,
);
// Assert: Check that useFlyerItemsQuery was called with the correct flyerId.
expect(mockedUseFlyerItemsQuery).toHaveBeenCalledWith(123);
});
it('should return isLoading: true when the inner hook is loading', () => {
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: true,
it('should return isLoading: true when the query is loading', () => {
mockedUseFlyerItemsQuery.mockReturnValue({
data: undefined,
isLoading: true,
error: null,
isRefetching: false,
reset: vi.fn(),
});
} as ReturnType<typeof useFlyerItemsQueryModule.useFlyerItemsQuery>);
const { result } = renderHook(() => useFlyerItems(mockFlyer));
expect(result.current.isLoading).toBe(true);
});
it('should return flyerItems when the inner hook provides data', () => {
mockedUseApiOnMount.mockReturnValue({
data: { items: mockFlyerItems },
loading: false,
it('should return flyerItems when the query provides data', () => {
mockedUseFlyerItemsQuery.mockReturnValue({
data: mockFlyerItems,
isLoading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
});
} as ReturnType<typeof useFlyerItemsQueryModule.useFlyerItemsQuery>);
const { result } = renderHook(() => useFlyerItems(mockFlyer));
@@ -119,15 +99,13 @@ describe('useFlyerItems Hook', () => {
expect(result.current.error).toBeNull();
});
it('should return an error when the inner hook returns an error', () => {
it('should return an error when the query returns an error', () => {
const mockError = new Error('Failed to fetch');
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: false,
mockedUseFlyerItemsQuery.mockReturnValue({
data: undefined,
isLoading: false,
error: mockError,
isRefetching: false,
reset: vi.fn(),
});
} as ReturnType<typeof useFlyerItemsQueryModule.useFlyerItemsQuery>);
const { result } = renderHook(() => useFlyerItems(mockFlyer));
@@ -135,46 +113,4 @@ describe('useFlyerItems Hook', () => {
expect(result.current.flyerItems).toEqual([]);
expect(result.current.error).toEqual(mockError);
});
describe('wrappedFetcher behavior', () => {
it('should reject if called with undefined flyerId', async () => {
// We need to trigger the hook to get access to the internal wrappedFetcher
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
});
renderHook(() => useFlyerItems(mockFlyer));
// The first argument passed to useApiOnMount is the wrappedFetcher function
const wrappedFetcher = mockedUseApiOnMount.mock.calls[0][0];
// Verify the fetcher rejects when no ID is passed (which shouldn't happen in normal flow due to 'enabled')
await expect(wrappedFetcher(undefined)).rejects.toThrow(
'Cannot fetch items for an undefined flyer ID.',
);
});
it('should call apiClient.fetchFlyerItems when called with a valid ID', async () => {
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
});
renderHook(() => useFlyerItems(mockFlyer));
const wrappedFetcher = mockedUseApiOnMount.mock.calls[0][0];
const mockResponse = new Response();
const mockedApiClient = vi.mocked(apiClient);
mockedApiClient.fetchFlyerItems.mockResolvedValue(mockResponse);
const response = await wrappedFetcher(123);
expect(mockedApiClient.fetchFlyerItems).toHaveBeenCalledWith(123);
expect(response).toBe(mockResponse);
});
});
});

View File

@@ -4,15 +4,15 @@ import { renderHook } from '@testing-library/react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { useMasterItems } from './useMasterItems';
import { MasterItemsProvider } from '../providers/MasterItemsProvider';
import { useApiOnMount } from './useApiOnMount';
import { useMasterItemsQuery } from './queries/useMasterItemsQuery';
import type { MasterGroceryItem } from '../types';
import { createMockMasterGroceryItem } from '../tests/utils/mockFactories';
// 1. Mock the useApiOnMount hook, which is the dependency of our provider.
vi.mock('./useApiOnMount');
// 1. Mock the useMasterItemsQuery hook, which is the dependency of our provider.
vi.mock('./queries/useMasterItemsQuery');
// 2. Create a typed mock for type safety and autocompletion.
const mockedUseApiOnMount = vi.mocked(useApiOnMount);
const mockedUseMasterItemsQuery = vi.mocked(useMasterItemsQuery);
// 3. A simple wrapper component that renders our provider.
// This is necessary because the useMasterItems hook needs to be a child of MasterItemsProvider.
@@ -42,13 +42,11 @@ describe('useMasterItems Hook and MasterItemsProvider', () => {
it('should return the initial loading state correctly', () => {
// Arrange: Configure the mocked hook to return a loading state.
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: true,
mockedUseMasterItemsQuery.mockReturnValue({
data: undefined,
isLoading: true,
error: null,
isRefetching: false,
reset: vi.fn(),
});
} as any);
// Act: Render the hook within the provider wrapper.
const { result } = renderHook(() => useMasterItems(), { wrapper });
@@ -75,13 +73,11 @@ describe('useMasterItems Hook and MasterItemsProvider', () => {
category_name: 'Bakery',
}),
];
mockedUseApiOnMount.mockReturnValue({
mockedUseMasterItemsQuery.mockReturnValue({
data: mockItems,
loading: false,
isLoading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
});
} as any);
// Act
const { result } = renderHook(() => useMasterItems(), { wrapper });
@@ -95,13 +91,11 @@ describe('useMasterItems Hook and MasterItemsProvider', () => {
it('should return an error state if the fetch fails', () => {
// Arrange: Mock a failed data fetch.
const mockError = new Error('Failed to fetch master items');
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: false,
mockedUseMasterItemsQuery.mockReturnValue({
data: undefined,
isLoading: false,
error: mockError,
isRefetching: false,
reset: vi.fn(),
});
} as any);
// Act
const { result } = renderHook(() => useMasterItems(), { wrapper });

View File

@@ -5,7 +5,8 @@ import { describe, it, expect, vi, beforeEach } from 'vitest';
import { useUserData } from './useUserData';
import { useAuth } from './useAuth';
import { UserDataProvider } from '../providers/UserDataProvider';
import { useApiOnMount } from './useApiOnMount';
import { useWatchedItemsQuery } from './queries/useWatchedItemsQuery';
import { useShoppingListsQuery } from './queries/useShoppingListsQuery';
import type { UserProfile } from '../types';
import {
createMockMasterGroceryItem,
@@ -15,11 +16,13 @@ import {
// 1. Mock the hook's dependencies
vi.mock('../hooks/useAuth');
vi.mock('./useApiOnMount');
vi.mock('./queries/useWatchedItemsQuery');
vi.mock('./queries/useShoppingListsQuery');
// 2. Create typed mocks for type safety and autocompletion
const mockedUseAuth = vi.mocked(useAuth);
const mockedUseApiOnMount = vi.mocked(useApiOnMount);
const mockedUseWatchedItemsQuery = vi.mocked(useWatchedItemsQuery);
const mockedUseShoppingListsQuery = vi.mocked(useShoppingListsQuery);
// 3. A simple wrapper component that renders our provider.
// This is necessary because the useUserData hook needs to be a child of UserDataProvider.
@@ -71,13 +74,16 @@ describe('useUserData Hook and UserDataProvider', () => {
updateProfile: vi.fn(),
});
// Arrange: Mock the return value of the inner hooks.
mockedUseApiOnMount.mockReturnValue({
data: null,
loading: false,
mockedUseWatchedItemsQuery.mockReturnValue({
data: [],
isLoading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
});
} as any);
mockedUseShoppingListsQuery.mockReturnValue({
data: [],
isLoading: false,
error: null,
} as any);
// Act: Render the hook within the provider wrapper.
const { result } = renderHook(() => useUserData(), { wrapper });
@@ -87,10 +93,9 @@ describe('useUserData Hook and UserDataProvider', () => {
expect(result.current.watchedItems).toEqual([]);
expect(result.current.shoppingLists).toEqual([]);
expect(result.current.error).toBeNull();
// Assert: Check that useApiOnMount was called with `enabled: false`.
expect(mockedUseApiOnMount).toHaveBeenCalledWith(expect.any(Function), [null], {
enabled: false,
});
// Assert: Check that queries were disabled (called with false)
expect(mockedUseWatchedItemsQuery).toHaveBeenCalledWith(false);
expect(mockedUseShoppingListsQuery).toHaveBeenCalledWith(false);
});
it('should return loading state when user is authenticated and data is fetching', () => {
@@ -104,21 +109,16 @@ describe('useUserData Hook and UserDataProvider', () => {
updateProfile: vi.fn(),
});
// Arrange: Mock one of the inner hooks to be in a loading state.
mockedUseApiOnMount
.mockReturnValueOnce({
data: null,
loading: true,
error: null,
isRefetching: false,
reset: vi.fn(),
}) // watched items
.mockReturnValueOnce({
data: null,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
}); // shopping lists
mockedUseWatchedItemsQuery.mockReturnValue({
data: undefined,
isLoading: true,
error: null,
} as any);
mockedUseShoppingListsQuery.mockReturnValue({
data: undefined,
isLoading: false,
error: null,
} as any);
// Act
const { result } = renderHook(() => useUserData(), { wrapper });
@@ -138,21 +138,16 @@ describe('useUserData Hook and UserDataProvider', () => {
updateProfile: vi.fn(),
});
// Arrange: Mock successful data fetches for both inner hooks.
mockedUseApiOnMount
.mockReturnValueOnce({
data: mockWatchedItems,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
})
.mockReturnValueOnce({
data: mockShoppingLists,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
});
mockedUseWatchedItemsQuery.mockReturnValue({
data: mockWatchedItems,
isLoading: false,
error: null,
} as any);
mockedUseShoppingListsQuery.mockReturnValue({
data: mockShoppingLists,
isLoading: false,
error: null,
} as any);
// Act
const { result } = renderHook(() => useUserData(), { wrapper });
@@ -178,55 +173,16 @@ describe('useUserData Hook and UserDataProvider', () => {
});
const mockError = new Error('Failed to fetch watched items');
// Arrange: Mock the behavior persistently to handle re-renders.
// We use mockImplementation to return based on call order in a loop or similar,
// OR just use mockReturnValueOnce enough times.
// Since we don't know exact render count, mockImplementation is safer if valid.
// But simplified: assuming 2 hooks called per render.
// reset mocks to be sure
mockedUseApiOnMount.mockReset();
// Define the sequence: 1st call (Watched) -> Error, 2nd call (Shopping) -> Success
// We want this to persist for multiple renders.
mockedUseApiOnMount.mockImplementation((_fn) => {
// We can't easily distinguish based on 'fn' arg without inspecting it,
// but we know the order is Watched then Shopping in the provider.
// A simple toggle approach works if strict order is maintained.
// However, stateless mocks are better.
// Let's fallback to setting up "many" return values.
return { data: null, loading: false, error: null, isRefetching: false, reset: vi.fn() };
});
mockedUseApiOnMount
.mockReturnValueOnce({
data: null,
loading: false,
error: mockError,
isRefetching: false,
reset: vi.fn(),
}) // 1st render: Watched
.mockReturnValueOnce({
data: mockShoppingLists,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
}) // 1st render: Shopping
.mockReturnValueOnce({
data: null,
loading: false,
error: mockError,
isRefetching: false,
reset: vi.fn(),
}) // 2nd render: Watched
.mockReturnValueOnce({
data: mockShoppingLists,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
}); // 2nd render: Shopping
mockedUseWatchedItemsQuery.mockReturnValue({
data: undefined,
isLoading: false,
error: mockError,
} as any);
mockedUseShoppingListsQuery.mockReturnValue({
data: mockShoppingLists,
isLoading: false,
error: null,
} as any);
// Act
const { result } = renderHook(() => useUserData(), { wrapper });
@@ -252,21 +208,16 @@ describe('useUserData Hook and UserDataProvider', () => {
logout: vi.fn(),
updateProfile: vi.fn(),
});
mockedUseApiOnMount
.mockReturnValueOnce({
data: mockWatchedItems,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
})
.mockReturnValueOnce({
data: mockShoppingLists,
loading: false,
error: null,
isRefetching: false,
reset: vi.fn(),
});
mockedUseWatchedItemsQuery.mockReturnValue({
data: mockWatchedItems,
isLoading: false,
error: null,
} as any);
mockedUseShoppingListsQuery.mockReturnValue({
data: mockShoppingLists,
isLoading: false,
error: null,
} as any);
const { result, rerender } = renderHook(() => useUserData(), { wrapper });
await waitFor(() => expect(result.current.watchedItems).not.toEqual([]));
@@ -279,6 +230,18 @@ describe('useUserData Hook and UserDataProvider', () => {
logout: vi.fn(),
updateProfile: vi.fn(),
});
// Update mocks to return empty data for the logged out state
mockedUseWatchedItemsQuery.mockReturnValue({
data: [],
isLoading: false,
error: null,
} as any);
mockedUseShoppingListsQuery.mockReturnValue({
data: [],
isLoading: false,
error: null,
} as any);
rerender();
// Assert: The data should now be cleared.

View File

@@ -10,6 +10,7 @@ import {
ValidationError,
NotFoundError,
} from '../services/db/errors.db';
import { createMockRequest } from '../tests/utils/createMockRequest';
import type { Logger } from 'pino';
// Create a mock logger that we can inject into requests and assert against.
@@ -271,7 +272,7 @@ describe('errorHandler Middleware', () => {
it('should call next(err) if headers have already been sent', () => {
// Supertest doesn't easily allow simulating res.headersSent = true mid-request
// We need to mock the express response object directly for this specific test.
const mockRequestDirect: Partial<Request> = { path: '/headers-sent-error', method: 'GET' };
const mockRequestDirect = createMockRequest({ path: '/headers-sent-error', method: 'GET' });
const mockResponseDirect: Partial<Response> = {
status: vi.fn().mockReturnThis(),
json: vi.fn(),

View File

@@ -3,6 +3,7 @@ import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest';
import { Request, Response, NextFunction } from 'express';
import { requireFileUpload } from './fileUpload.middleware';
import { ValidationError } from '../services/db/errors.db';
import { createMockRequest } from '../tests/utils/createMockRequest';
describe('requireFileUpload Middleware', () => {
let mockRequest: Partial<Request>;
@@ -11,7 +12,7 @@ describe('requireFileUpload Middleware', () => {
beforeEach(() => {
// Reset mocks before each test
mockRequest = {};
mockRequest = createMockRequest();
mockResponse = {
status: vi.fn().mockReturnThis(),
json: vi.fn(),

View File

@@ -5,6 +5,7 @@ import type { Request, Response, NextFunction } from 'express';
import { createUploadMiddleware, handleMulterError } from './multer.middleware';
import { createMockUserProfile } from '../tests/utils/mockFactories';
import { ValidationError } from '../services/db/errors.db';
import { createMockRequest } from '../tests/utils/createMockRequest';
// 1. Hoist the mocks so they can be referenced inside vi.mock factories.
const mocks = vi.hoisted(() => ({
@@ -125,7 +126,7 @@ describe('createUploadMiddleware', () => {
createUploadMiddleware({ storageType: 'avatar' });
const storageOptions = vi.mocked(multer.diskStorage).mock.calls[0][0];
const cb = vi.fn();
const mockReq = { user: mockUser } as unknown as Request;
const mockReq = createMockRequest({ user: mockUser });
storageOptions.filename!(mockReq, mockFile, cb);
@@ -138,7 +139,7 @@ describe('createUploadMiddleware', () => {
createUploadMiddleware({ storageType: 'avatar' });
const storageOptions = vi.mocked(multer.diskStorage).mock.calls[0][0];
const cb = vi.fn();
const mockReq = {} as Request; // No user on request
const mockReq = createMockRequest(); // No user on request
storageOptions.filename!(mockReq, mockFile, cb);
@@ -153,7 +154,7 @@ describe('createUploadMiddleware', () => {
createUploadMiddleware({ storageType: 'avatar' });
const storageOptions = vi.mocked(multer.diskStorage).mock.calls[0][0];
const cb = vi.fn();
const mockReq = { user: mockUser } as unknown as Request;
const mockReq = createMockRequest({ user: mockUser });
storageOptions.filename!(mockReq, mockFile, cb);
@@ -171,7 +172,7 @@ describe('createUploadMiddleware', () => {
createUploadMiddleware({ storageType: 'flyer' });
const storageOptions = vi.mocked(multer.diskStorage).mock.calls[0][0];
const cb = vi.fn();
const mockReq = {} as Request;
const mockReq = createMockRequest();
storageOptions.filename!(mockReq, mockFlyerFile, cb);
@@ -191,7 +192,7 @@ describe('createUploadMiddleware', () => {
createUploadMiddleware({ storageType: 'flyer' });
const storageOptions = vi.mocked(multer.diskStorage).mock.calls[0][0];
const cb = vi.fn();
const mockReq = {} as Request;
const mockReq = createMockRequest();
storageOptions.filename!(mockReq, mockFlyerFile, cb);
@@ -206,7 +207,7 @@ describe('createUploadMiddleware', () => {
const cb = vi.fn();
const mockImageFile = { mimetype: 'image/png' } as Express.Multer.File;
multerOptions!.fileFilter!({} as Request, mockImageFile, cb);
multerOptions!.fileFilter!(createMockRequest(), mockImageFile, cb);
expect(cb).toHaveBeenCalledWith(null, true);
});
@@ -217,7 +218,7 @@ describe('createUploadMiddleware', () => {
const cb = vi.fn();
const mockTextFile = { mimetype: 'text/plain' } as Express.Multer.File;
multerOptions!.fileFilter!({} as Request, { ...mockTextFile, fieldname: 'test' }, cb);
multerOptions!.fileFilter!(createMockRequest(), { ...mockTextFile, fieldname: 'test' }, cb);
const error = (cb as Mock).mock.calls[0][0];
expect(error).toBeInstanceOf(ValidationError);
@@ -232,7 +233,7 @@ describe('handleMulterError Middleware', () => {
let mockNext: NextFunction;
beforeEach(() => {
mockRequest = {};
mockRequest = createMockRequest();
mockResponse = {
status: vi.fn().mockReturnThis(),
json: vi.fn(),

View File

@@ -4,6 +4,7 @@ import { Request, Response, NextFunction } from 'express';
import { z } from 'zod';
import { validateRequest } from './validation.middleware';
import { ValidationError } from '../services/db/errors.db';
import { createMockRequest } from '../tests/utils/createMockRequest';
describe('validateRequest Middleware', () => {
let mockRequest: Partial<Request>;
@@ -16,11 +17,11 @@ describe('validateRequest Middleware', () => {
// This more accurately mimics the behavior of Express's request objects
// and prevents issues with inherited properties when the middleware
// attempts to delete keys before merging validated data.
mockRequest = {
mockRequest = createMockRequest({
params: Object.create(null),
query: Object.create(null),
body: {},
};
});
mockResponse = {
status: vi.fn().mockReturnThis(),
json: vi.fn(),

View File

@@ -94,33 +94,17 @@ vi.mock('../services/emailService.server', () => ({
import authRouter from './auth.routes';
import { UniqueConstraintError } from '../services/db/errors.db'; // Import actual class for instanceof checks
import { createTestApp } from '../tests/utils/createTestApp';
// --- 4. App Setup ---
// We need to inject cookie-parser BEFORE the router is mounted.
// Since createTestApp mounts the router immediately, we pass middleware to it if supported,
// or we construct the app manually here to ensure correct order.
// Assuming createTestApp doesn't support pre-middleware injection easily, we will
// create a standard express app here for full control, or modify createTestApp usage if possible.
// Looking at createTestApp.ts (inferred), it likely doesn't take middleware.
// Let's manually build the app for this test file to ensure cookieParser runs first.
import express from 'express';
import { errorHandler } from '../middleware/errorHandler'; // Assuming this exists
const { mockLogger } = await import('../tests/utils/mockLogger');
const app = express();
app.use(express.json());
app.use(cookieParser()); // Mount BEFORE router
// Middleware to inject the mock logger into req
app.use((req, res, next) => {
req.log = mockLogger;
next();
// --- 4. App Setup using createTestApp ---
const app = createTestApp({
router: authRouter,
basePath: '/api/auth',
// Inject cookieParser via the new middleware option
middleware: [cookieParser()],
});
app.use('/api/auth', authRouter);
app.use(errorHandler); // Mount AFTER router
const { mockLogger } = await import('../tests/utils/mockLogger');
// --- 5. Tests ---
describe('Auth Routes (/api/auth)', () => {

View File

@@ -56,6 +56,7 @@ import {
createMockUserProfile,
createMockUserWithPasswordHash,
} from '../tests/utils/mockFactories';
import { createMockRequest } from '../tests/utils/createMockRequest';
// Mock dependencies before importing the passport configuration
vi.mock('../services/db/index.db', () => ({
@@ -112,7 +113,7 @@ describe('Passport Configuration', () => {
describe('LocalStrategy (Isolated Callback Logic)', () => {
// FIX: mockReq needs a 'log' property because the implementation uses req.log
const mockReq = { ip: '127.0.0.1', log: logger } as unknown as Request;
const mockReq = createMockRequest({ ip: '127.0.0.1' });
const done = vi.fn();
it('should call done(null, user) on successful authentication', async () => {
@@ -454,12 +455,12 @@ describe('Passport Configuration', () => {
it('should call next() if user has "admin" role', () => {
// Arrange
const mockReq: Partial<Request> = {
const mockReq = createMockRequest({
user: createMockUserProfile({
role: 'admin',
user: { user_id: 'admin-id', email: 'admin@test.com' },
}),
};
});
// Act
isAdmin(mockReq as Request, mockRes as Response, mockNext);
@@ -471,12 +472,12 @@ describe('Passport Configuration', () => {
it('should call next with a ForbiddenError if user does not have "admin" role', () => {
// Arrange
const mockReq: Partial<Request> = {
const mockReq = createMockRequest({
user: createMockUserProfile({
role: 'user',
user: { user_id: 'user-id', email: 'user@test.com' },
}),
};
});
// Act
isAdmin(mockReq as Request, mockRes as Response, mockNext);
@@ -488,7 +489,7 @@ describe('Passport Configuration', () => {
it('should call next with a ForbiddenError if req.user is missing', () => {
// Arrange
const mockReq = {} as Request; // No req.user
const mockReq = createMockRequest(); // No req.user
// Act
isAdmin(mockReq, mockRes as Response, mockNext);
@@ -500,12 +501,12 @@ describe('Passport Configuration', () => {
it('should log a warning when a non-admin user tries to access an admin route', () => {
// Arrange
const mockReq: Partial<Request> = {
const mockReq = createMockRequest({
user: createMockUserProfile({
role: 'user',
user: { user_id: 'user-id-123', email: 'user@test.com' },
}),
};
});
// Act
isAdmin(mockReq as Request, mockRes as Response, mockNext);
@@ -516,7 +517,7 @@ describe('Passport Configuration', () => {
it('should log a warning with "unknown" user when req.user is missing', () => {
// Arrange
const mockReq = {} as Request; // No req.user
const mockReq = createMockRequest(); // No req.user
// Act
isAdmin(mockReq, mockRes as Response, mockNext);
@@ -533,37 +534,37 @@ describe('Passport Configuration', () => {
};
// Case 1: user is not an object (e.g., a string)
const req1 = { user: 'not-an-object' } as unknown as Request;
const req1 = createMockRequest({ user: 'not-an-object' } as any);
isAdmin(req1, mockRes as Response, mockNext);
expect(mockNext).toHaveBeenLastCalledWith(expect.any(ForbiddenError));
expect(mockRes.status).not.toHaveBeenCalled();
vi.clearAllMocks();
// Case 2: user is null
const req2 = { user: null } as unknown as Request;
const req2 = createMockRequest({ user: null } as any);
isAdmin(req2, mockRes as Response, mockNext);
expect(mockNext).toHaveBeenLastCalledWith(expect.any(ForbiddenError));
expect(mockRes.status).not.toHaveBeenCalled();
vi.clearAllMocks();
// Case 3: user object is missing 'user' property
const req3 = { user: { role: 'admin' } } as unknown as Request;
const req3 = createMockRequest({ user: { role: 'admin' } } as any);
isAdmin(req3, mockRes as Response, mockNext);
expect(mockNext).toHaveBeenLastCalledWith(expect.any(ForbiddenError));
expect(mockRes.status).not.toHaveBeenCalled();
vi.clearAllMocks();
// Case 4: user.user is not an object
const req4 = { user: { role: 'admin', user: 'not-an-object' } } as unknown as Request;
const req4 = createMockRequest({ user: { role: 'admin', user: 'not-an-object' } } as any);
isAdmin(req4, mockRes as Response, mockNext);
expect(mockNext).toHaveBeenLastCalledWith(expect.any(ForbiddenError));
expect(mockRes.status).not.toHaveBeenCalled();
vi.clearAllMocks();
// Case 5: user.user is missing 'user_id'
const req5 = {
user: { role: 'admin', user: { email: 'test@test.com' } },
} as unknown as Request;
const req5 = createMockRequest({
user: { role: 'admin', user: { email: 'test@test.com' } } as any,
});
isAdmin(req5, mockRes as Response, mockNext);
expect(mockNext).toHaveBeenLastCalledWith(expect.any(ForbiddenError));
expect(mockRes.status).not.toHaveBeenCalled();
@@ -575,12 +576,12 @@ describe('Passport Configuration', () => {
it('should call next with a ForbiddenError if req.user is not a valid UserProfile object', () => {
// Arrange
const mockReq: Partial<Request> = {
const mockReq = createMockRequest({
// An object that is not a valid UserProfile (e.g., missing 'role')
user: {
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
isAdmin(mockReq as Request, mockRes as Response, mockNext);
@@ -601,7 +602,7 @@ describe('Passport Configuration', () => {
it('should populate req.user and call next() if authentication succeeds', () => {
// Arrange
const mockReq = {} as Request;
const mockReq = createMockRequest();
const mockUser = createMockUserProfile({
role: 'admin',
user: { user_id: 'admin-id', email: 'admin@test.com' },
@@ -621,7 +622,7 @@ describe('Passport Configuration', () => {
it('should not populate req.user and still call next() if authentication fails', () => {
// Arrange
const mockReq = {} as Request;
const mockReq = createMockRequest();
vi.mocked(passport.authenticate).mockImplementation(
(_strategy, _options, callback) => () => callback?.(null, false, undefined),
);
@@ -634,7 +635,7 @@ describe('Passport Configuration', () => {
it('should log info and call next() if authentication provides an info message', () => {
// Arrange
const mockReq = {} as Request;
const mockReq = createMockRequest();
const mockInfo = { message: 'Token expired' };
// Mock passport.authenticate to call its callback with an info object
vi.mocked(passport.authenticate).mockImplementation(
@@ -652,7 +653,7 @@ describe('Passport Configuration', () => {
it('should log info and call next() if authentication provides an info Error object', () => {
// Arrange
const mockReq = {} as Request;
const mockReq = createMockRequest();
const mockInfoError = new Error('Token is malformed');
// Mock passport.authenticate to call its callback with an info object
vi.mocked(passport.authenticate).mockImplementation(
@@ -673,7 +674,7 @@ describe('Passport Configuration', () => {
it('should log info.toString() if info object has no message property', () => {
// Arrange
const mockReq = {} as Request;
const mockReq = createMockRequest();
const mockInfo = { custom: 'some info' };
// Mock passport.authenticate to call its callback with a custom info object
vi.mocked(passport.authenticate).mockImplementation(
@@ -693,7 +694,7 @@ describe('Passport Configuration', () => {
it('should call next() and not populate user if passport returns an error', () => {
// Arrange
const mockReq = {} as Request;
const mockReq = createMockRequest();
const authError = new Error('Malformed token');
// Mock passport.authenticate to call its callback with an error
vi.mocked(passport.authenticate).mockImplementation(
@@ -729,7 +730,7 @@ describe('Passport Configuration', () => {
it('should attach a mock admin user to req when NODE_ENV is "test"', () => {
// Arrange
vi.stubEnv('NODE_ENV', 'test');
const mockReq = {} as Request;
const mockReq = createMockRequest();
// Act
mockAuth(mockReq, mockRes as Response, mockNext);
@@ -743,7 +744,7 @@ describe('Passport Configuration', () => {
it('should do nothing and call next() when NODE_ENV is not "test"', () => {
// Arrange
vi.stubEnv('NODE_ENV', 'production');
const mockReq = {} as Request;
const mockReq = createMockRequest();
// Act
mockAuth(mockReq, mockRes as Response, mockNext);

View File

@@ -0,0 +1,8 @@
import { vi } from 'vitest';
import { mockLogger } from '../utils/mockLogger';
// Globally mock the logger service so individual test files don't have to.
// This ensures 'import { logger } from ...' always returns the mock.
vi.mock('../../services/logger.server', () => ({
logger: mockLogger,
}));

View File

@@ -0,0 +1,9 @@
import type { Request } from 'express';
import { mockLogger } from './mockLogger';
export const createMockRequest = (overrides: Partial<Request> = {}): Request => {
return {
log: mockLogger,
...overrides,
} as unknown as Request;
};

View File

@@ -1,5 +1,5 @@
// src/tests/utils/createTestApp.ts
import express, { type Router } from 'express';
import express, { type Router, type RequestHandler } from 'express';
import type { Logger } from 'pino';
import { errorHandler } from '../../middleware/errorHandler';
import { mockLogger } from './mockLogger';
@@ -17,6 +17,7 @@ interface CreateAppOptions {
router: Router;
basePath: string;
authenticatedUser?: UserProfile;
middleware?: RequestHandler[];
}
/**
@@ -24,10 +25,20 @@ interface CreateAppOptions {
* It includes JSON parsing, a mock logger, an optional authenticated user,
* the specified router, and the global error handler.
*/
export const createTestApp = ({ router, basePath, authenticatedUser }: CreateAppOptions) => {
export const createTestApp = ({
router,
basePath,
authenticatedUser,
middleware = [],
}: CreateAppOptions) => {
const app = express();
app.use(express.json({ strict: false }));
// Apply custom middleware (e.g. cookieParser)
if (middleware.length > 0) {
app.use(middleware);
}
// Inject the mock logger and authenticated user into every request.
app.use((req, res, next) => {
req.log = mockLogger;

View File

@@ -1,5 +1,5 @@
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import type { Request } from 'express';
import { createMockRequest } from '../tests/utils/createMockRequest';
describe('rateLimit utils', () => {
beforeEach(() => {
@@ -16,7 +16,7 @@ describe('rateLimit utils', () => {
vi.stubEnv('NODE_ENV', 'production');
const { shouldSkipRateLimit } = await import('./rateLimit');
const req = { headers: {} } as Request;
const req = createMockRequest({ headers: {} });
expect(shouldSkipRateLimit(req)).toBe(false);
});
@@ -24,7 +24,7 @@ describe('rateLimit utils', () => {
vi.stubEnv('NODE_ENV', 'development');
const { shouldSkipRateLimit } = await import('./rateLimit');
const req = { headers: {} } as Request;
const req = createMockRequest({ headers: {} });
expect(shouldSkipRateLimit(req)).toBe(false);
});
@@ -32,7 +32,7 @@ describe('rateLimit utils', () => {
vi.stubEnv('NODE_ENV', 'test');
const { shouldSkipRateLimit } = await import('./rateLimit');
const req = { headers: {} } as Request;
const req = createMockRequest({ headers: {} });
expect(shouldSkipRateLimit(req)).toBe(true);
});
@@ -40,9 +40,9 @@ describe('rateLimit utils', () => {
vi.stubEnv('NODE_ENV', 'test');
const { shouldSkipRateLimit } = await import('./rateLimit');
const req = {
const req = createMockRequest({
headers: { 'x-test-rate-limit-enable': 'true' },
} as unknown as Request;
});
expect(shouldSkipRateLimit(req)).toBe(false);
});
@@ -50,9 +50,9 @@ describe('rateLimit utils', () => {
vi.stubEnv('NODE_ENV', 'test');
const { shouldSkipRateLimit } = await import('./rateLimit');
const req = {
const req = createMockRequest({
headers: { 'x-test-rate-limit-enable': 'false' },
} as unknown as Request;
});
expect(shouldSkipRateLimit(req)).toBe(true);
});
});

View File

@@ -46,6 +46,7 @@ export default defineConfig({
globalSetup: './src/tests/setup/global-setup.ts',
// The globalApiMock MUST come first to ensure it's applied before other mocks that might depend on it.
setupFiles: [
'./src/tests/setup/global.ts',
'./src/tests/setup/globalApiMock.ts',
'./src/tests/setup/tests-setup-unit.ts',
],

View File

@@ -53,6 +53,7 @@ const finalConfig = mergeConfig(
},
// This setup script starts the backend server before tests run.
globalSetup: './src/tests/setup/integration-global-setup.ts',
setupFiles: ['./src/tests/setup/global.ts'],
// The default timeout is 5000ms (5 seconds)
testTimeout: 60000, // Increased timeout for server startup and API calls, especially AI services.
hookTimeout: 60000,