Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c1df3d7b1b | ||
| 94782f030d | |||
|
|
1c25b79251 | ||
| 0b0fa8294d |
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "flyer-crawler",
|
||||
"version": "0.9.44",
|
||||
"version": "0.9.46",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "flyer-crawler",
|
||||
"version": "0.9.44",
|
||||
"version": "0.9.46",
|
||||
"dependencies": {
|
||||
"@bull-board/api": "^6.14.2",
|
||||
"@bull-board/express": "^6.14.2",
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "flyer-crawler",
|
||||
"private": true,
|
||||
"version": "0.9.44",
|
||||
"version": "0.9.46",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "concurrently \"npm:start:dev\" \"vite\"",
|
||||
|
||||
@@ -197,15 +197,17 @@ describe('AI Service (Server)', () => {
|
||||
const service = new AIService(mockLoggerInstance);
|
||||
|
||||
// Assert: Check that the warning was logged and the mock client is in use
|
||||
expect(mockLoggerInstance.warn).toHaveBeenCalledWith(
|
||||
'[AIService] GoogleGenAI client could not be initialized (likely missing API key in test environment). Using mock placeholder.',
|
||||
expect(mockLoggerInstance.info).toHaveBeenCalledWith(
|
||||
'[AIService Constructor] Test environment detected. Using internal mock for AI client to prevent real API calls in INTEGRATION TESTS.',
|
||||
);
|
||||
await expect(
|
||||
(service as any).aiClient.generateContent({ contents: [] }),
|
||||
(service as any).aiClient.generateContent({ contents: [], useLiteModels: false }),
|
||||
).resolves.toBeDefined();
|
||||
});
|
||||
|
||||
it('should use the adapter to call generateContent when using real GoogleGenAI client', async () => {
|
||||
vi.stubEnv('NODE_ENV', 'production');
|
||||
vi.stubEnv('VITEST_POOL_ID', '');
|
||||
vi.stubEnv('GEMINI_API_KEY', 'test-key');
|
||||
// We need to force the constructor to use the real client logic, not the injected mock.
|
||||
// So we instantiate AIService without passing aiClient.
|
||||
@@ -229,6 +231,8 @@ describe('AI Service (Server)', () => {
|
||||
});
|
||||
|
||||
it('should throw error if adapter is called without content', async () => {
|
||||
vi.stubEnv('NODE_ENV', 'production');
|
||||
vi.stubEnv('VITEST_POOL_ID', '');
|
||||
vi.stubEnv('GEMINI_API_KEY', 'test-key');
|
||||
vi.resetModules();
|
||||
const { AIService } = await import('./aiService.server');
|
||||
@@ -244,6 +248,8 @@ describe('AI Service (Server)', () => {
|
||||
describe('Model Fallback Logic', () => {
|
||||
beforeEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
vi.stubEnv('NODE_ENV', 'production');
|
||||
vi.stubEnv('VITEST_POOL_ID', '');
|
||||
vi.stubEnv('GEMINI_API_KEY', 'test-key');
|
||||
vi.resetModules(); // Re-import to use the new env var and re-instantiate the service
|
||||
mockGenerateContent.mockReset();
|
||||
|
||||
@@ -136,85 +136,81 @@ export class AIService {
|
||||
"gemma-3n-e2b-it" // Corrected name from JSON
|
||||
];
|
||||
|
||||
// Helper to return valid mock data for tests
|
||||
private getMockFlyerData() {
|
||||
return {
|
||||
store_name: 'Mock Store from AIService',
|
||||
valid_from: '2025-01-01',
|
||||
valid_to: '2025-01-07',
|
||||
store_address: '123 Mock St',
|
||||
items: [
|
||||
{
|
||||
item: 'Mocked Integration Item',
|
||||
price_display: '$1.99',
|
||||
price_in_cents: 199,
|
||||
quantity: 'each',
|
||||
category_name: 'Mock Category',
|
||||
master_item_id: null,
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
constructor(logger: Logger, aiClient?: IAiClient, fs?: IFileSystem) {
|
||||
this.logger = logger;
|
||||
this.logger.info('---------------- [AIService] Constructor Start ----------------');
|
||||
|
||||
const isTestEnvironment = process.env.NODE_ENV === 'test' || !!process.env.VITEST_POOL_ID;
|
||||
|
||||
if (aiClient) {
|
||||
this.logger.info(
|
||||
'[AIService Constructor] Using provided mock AI client. This indicates a TEST environment.',
|
||||
'[AIService Constructor] Using provided mock AI client. This indicates a UNIT TEST environment.',
|
||||
);
|
||||
this.aiClient = aiClient;
|
||||
} else if (isTestEnvironment) {
|
||||
this.logger.info(
|
||||
'[AIService Constructor] Test environment detected. Using internal mock for AI client to prevent real API calls in INTEGRATION TESTS.',
|
||||
);
|
||||
this.aiClient = {
|
||||
generateContent: async (request) => {
|
||||
this.logger.info(
|
||||
{ useLiteModels: request.useLiteModels },
|
||||
'[AIService] Mock generateContent called in test environment.',
|
||||
);
|
||||
const mockData = this.getMockFlyerData();
|
||||
return {
|
||||
text: JSON.stringify(mockData),
|
||||
} as unknown as GenerateContentResponse;
|
||||
},
|
||||
};
|
||||
} else {
|
||||
this.logger.info(
|
||||
'[AIService Constructor] No mock client provided. Initializing Google GenAI client for PRODUCTION-LIKE environment.',
|
||||
'[AIService Constructor] No mock client provided and not a test environment. Initializing Google GenAI client for PRODUCTION.',
|
||||
);
|
||||
// Determine if we are in any kind of test environment.
|
||||
// VITEST_POOL_ID is reliably set by Vitest during test runs.
|
||||
const isTestEnvironment = process.env.NODE_ENV === 'test' || !!process.env.VITEST_POOL_ID;
|
||||
this.logger.info(
|
||||
{
|
||||
isTestEnvironment,
|
||||
nodeEnv: process.env.NODE_ENV,
|
||||
vitestPoolId: process.env.VITEST_POOL_ID,
|
||||
hasApiKey: !!process.env.GEMINI_API_KEY,
|
||||
},
|
||||
'[AIService Constructor] Environment check',
|
||||
);
|
||||
|
||||
const apiKey = process.env.GEMINI_API_KEY;
|
||||
if (!apiKey) {
|
||||
this.logger.warn('[AIService] GEMINI_API_KEY is not set.');
|
||||
// Allow initialization without key in test/build environments if strictly needed
|
||||
if (!isTestEnvironment) {
|
||||
this.logger.error('[AIService] GEMINI_API_KEY is required in non-test environments.');
|
||||
throw new Error('GEMINI_API_KEY environment variable not set for server-side AI calls.');
|
||||
} else {
|
||||
this.logger.warn(
|
||||
'[AIService Constructor] GEMINI_API_KEY is missing, but this is a test environment, so proceeding.',
|
||||
);
|
||||
}
|
||||
}
|
||||
// In test mode without injected client, we might not have a key.
|
||||
// The stubs below protect against calling the undefined client.
|
||||
// This is the correct modern SDK pattern. We instantiate the main client.
|
||||
const genAI = apiKey ? new GoogleGenAI({ apiKey }) : null;
|
||||
if (!genAI) {
|
||||
this.logger.warn(
|
||||
'[AIService] GoogleGenAI client could not be initialized (likely missing API key in test environment). Using mock placeholder.',
|
||||
);
|
||||
this.logger.error('[AIService] GEMINI_API_KEY is required in non-test environments.');
|
||||
throw new Error('GEMINI_API_KEY environment variable not set for server-side AI calls.');
|
||||
}
|
||||
const genAI = new GoogleGenAI({ apiKey });
|
||||
|
||||
// We create a shim/adapter that matches the old structure but uses the new SDK call pattern.
|
||||
// This preserves the dependency injection pattern used throughout the class.
|
||||
this.aiClient = genAI
|
||||
? {
|
||||
generateContent: async (request) => {
|
||||
if (!request.contents || request.contents.length === 0) {
|
||||
this.logger.error(
|
||||
{ request },
|
||||
'[AIService Adapter] generateContent called with no content, which is invalid.',
|
||||
);
|
||||
throw new Error('AIService.generateContent requires at least one content element.');
|
||||
}
|
||||
|
||||
const { useLiteModels, ...apiReq } = request;
|
||||
const models = useLiteModels ? this.models_lite : this.models;
|
||||
return this._generateWithFallback(genAI, apiReq, models);
|
||||
},
|
||||
this.aiClient = {
|
||||
generateContent: async (request) => {
|
||||
if (!request.contents || request.contents.length === 0) {
|
||||
this.logger.error(
|
||||
{ request },
|
||||
'[AIService Adapter] generateContent called with no content, which is invalid.',
|
||||
);
|
||||
throw new Error('AIService.generateContent requires at least one content element.');
|
||||
}
|
||||
: {
|
||||
// This is the updated mock for testing, matching the new response shape.
|
||||
generateContent: async () => {
|
||||
this.logger.warn(
|
||||
'[AIService] Mock generateContent called. This should only happen in tests when no API key is available.',
|
||||
);
|
||||
// Return a minimal valid JSON object structure to prevent downstream parsing errors.
|
||||
const mockResponse = { store_name: 'Mock Store', items: [] };
|
||||
return {
|
||||
text: JSON.stringify(mockResponse),
|
||||
} as unknown as GenerateContentResponse;
|
||||
},
|
||||
};
|
||||
|
||||
const { useLiteModels, ...apiReq } = request;
|
||||
const models = useLiteModels ? this.models_lite : this.models;
|
||||
return this._generateWithFallback(genAI, apiReq, models);
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
this.fs = fs || fsPromises;
|
||||
@@ -887,8 +883,8 @@ async enqueueFlyerProcessing(
|
||||
const itemsArray = Array.isArray(rawItems) ? rawItems : typeof rawItems === 'string' ? JSON.parse(rawItems) : [];
|
||||
const itemsForDb = itemsArray.map((item: Partial<ExtractedFlyerItem>) => ({
|
||||
...item,
|
||||
// Ensure price_display is never null to satisfy database constraints.
|
||||
price_display: item.price_display ?? '',
|
||||
// Ensure empty or nullish price_display is stored as NULL to satisfy database constraints.
|
||||
price_display: item.price_display || null,
|
||||
master_item_id: item.master_item_id === null ? undefined : item.master_item_id,
|
||||
quantity: item.quantity ?? 1,
|
||||
view_count: 0,
|
||||
|
||||
@@ -63,7 +63,7 @@ export class FlyerRepository {
|
||||
* @returns The newly created flyer record with its ID.
|
||||
*/
|
||||
async insertFlyer(flyerData: FlyerDbInsert, logger: Logger): Promise<Flyer> {
|
||||
console.log('[DEBUG] FlyerRepository.insertFlyer called with:', JSON.stringify(flyerData, null, 2));
|
||||
console.error('[DEBUG] FlyerRepository.insertFlyer called with:', JSON.stringify(flyerData, null, 2));
|
||||
try {
|
||||
const query = `
|
||||
INSERT INTO flyers (
|
||||
@@ -140,10 +140,15 @@ export class FlyerRepository {
|
||||
valueStrings.push(
|
||||
`($${paramIndex++}, $${paramIndex++}, $${paramIndex++}, $${paramIndex++}, $${paramIndex++}, $${paramIndex++}, $${paramIndex++}, $${paramIndex++})`,
|
||||
);
|
||||
|
||||
// FIX: Sanitize price_display. Convert empty string to null.
|
||||
const priceDisplay =
|
||||
item.price_display && item.price_display.trim() !== '' ? item.price_display : null;
|
||||
|
||||
values.push(
|
||||
flyerId,
|
||||
item.item,
|
||||
item.price_display,
|
||||
priceDisplay,
|
||||
item.price_in_cents ?? null,
|
||||
item.quantity ?? '',
|
||||
item.category_name ?? null,
|
||||
|
||||
@@ -15,6 +15,8 @@ import { cleanupFiles } from '../utils/cleanupFiles';
|
||||
import piexif from 'piexifjs';
|
||||
import exifParser from 'exif-parser';
|
||||
import sharp from 'sharp';
|
||||
// FIX: Import the singleton instance directly to spy on it
|
||||
import { aiService } from '../../services/aiService.server';
|
||||
|
||||
|
||||
/**
|
||||
@@ -25,16 +27,8 @@ const { mockExtractCoreData } = vi.hoisted(() => ({
|
||||
mockExtractCoreData: vi.fn(),
|
||||
}));
|
||||
|
||||
// Mock the AI service to prevent real API calls during integration tests.
|
||||
// This is crucial for making the tests reliable and fast. We don't want to
|
||||
// depend on the external Gemini API.
|
||||
vi.mock('../../services/aiService.server', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('../../services/aiService.server')>();
|
||||
// To preserve the class instance methods of `aiService`, we must modify the
|
||||
// instance directly rather than creating a new plain object with spread syntax.
|
||||
actual.aiService.extractCoreDataFromFlyerImage = mockExtractCoreData;
|
||||
return actual;
|
||||
});
|
||||
// REMOVED: vi.mock('../../services/aiService.server', ...)
|
||||
// The previous mock was not effectively intercepting the singleton instance used by the worker.
|
||||
|
||||
// Mock the main DB service to allow for simulating transaction failures.
|
||||
// By default, it will use the real implementation.
|
||||
@@ -59,6 +53,10 @@ describe('Flyer Processing Background Job Integration Test', () => {
|
||||
vi.stubEnv('FRONTEND_URL', 'https://example.com');
|
||||
console.log('[TEST SETUP] FRONTEND_URL stubbed to:', process.env.FRONTEND_URL);
|
||||
|
||||
// FIX: Spy on the actual singleton instance. This ensures that when the worker
|
||||
// imports 'aiService', it gets the instance we are controlling here.
|
||||
vi.spyOn(aiService, 'extractCoreDataFromFlyerImage').mockImplementation(mockExtractCoreData);
|
||||
|
||||
const appModule = await import('../../../server');
|
||||
const app = appModule.default;
|
||||
request = supertest(app);
|
||||
@@ -72,9 +70,9 @@ describe('Flyer Processing Background Job Integration Test', () => {
|
||||
mockExtractCoreData.mockReset();
|
||||
mockExtractCoreData.mockResolvedValue({
|
||||
store_name: 'Mock Store',
|
||||
valid_from: null,
|
||||
valid_to: null,
|
||||
store_address: null,
|
||||
valid_from: '2025-01-01',
|
||||
valid_to: '2025-01-07',
|
||||
store_address: '123 Mock St',
|
||||
items: [
|
||||
{
|
||||
item: 'Mocked Integration Item',
|
||||
@@ -96,6 +94,7 @@ describe('Flyer Processing Background Job Integration Test', () => {
|
||||
|
||||
afterAll(async () => {
|
||||
vi.unstubAllEnvs(); // Clean up env stubs
|
||||
vi.restoreAllMocks(); // Restore the AI spy
|
||||
|
||||
// Use the centralized cleanup utility.
|
||||
await cleanupDb({
|
||||
@@ -395,6 +394,7 @@ it(
|
||||
async () => {
|
||||
// Arrange: Mock the AI service to throw an error for this specific test.
|
||||
const aiError = new Error('AI model failed to extract data.');
|
||||
// Update the spy implementation to reject
|
||||
mockExtractCoreData.mockRejectedValue(aiError);
|
||||
|
||||
// Arrange: Prepare a unique flyer file for upload.
|
||||
|
||||
@@ -2,7 +2,9 @@
|
||||
import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest';
|
||||
import supertest from 'supertest';
|
||||
import { getPool } from '../../services/db/connection.db';
|
||||
import { TEST_EXAMPLE_DOMAIN } from '../utils/testHelpers';
|
||||
import { TEST_EXAMPLE_DOMAIN, createAndLoginUser } from '../utils/testHelpers';
|
||||
import { cleanupDb } from '../utils/cleanup';
|
||||
import type { UserProfile } from '../../types';
|
||||
|
||||
/**
|
||||
* @vitest-environment node
|
||||
@@ -10,6 +12,9 @@ import { TEST_EXAMPLE_DOMAIN } from '../utils/testHelpers';
|
||||
|
||||
describe('Price History API Integration Test (/api/price-history)', () => {
|
||||
let request: ReturnType<typeof supertest>;
|
||||
let authToken: string;
|
||||
let testUser: UserProfile;
|
||||
const createdUserIds: string[] = [];
|
||||
let masterItemId: number;
|
||||
let storeId: number;
|
||||
let flyerId1: number;
|
||||
@@ -21,6 +26,15 @@ describe('Price History API Integration Test (/api/price-history)', () => {
|
||||
const app = (await import('../../../server')).default;
|
||||
request = supertest(app);
|
||||
|
||||
// Create a user for the tests
|
||||
const email = `price-test-${Date.now()}@example.com`;
|
||||
({ user: testUser, token: authToken } = await createAndLoginUser({
|
||||
email,
|
||||
fullName: 'Price Test User',
|
||||
request,
|
||||
}));
|
||||
createdUserIds.push(testUser.user.user_id);
|
||||
|
||||
const pool = getPool();
|
||||
|
||||
// 1. Create a master grocery item
|
||||
@@ -74,6 +88,7 @@ describe('Price History API Integration Test (/api/price-history)', () => {
|
||||
|
||||
afterAll(async () => {
|
||||
vi.unstubAllEnvs();
|
||||
await cleanupDb({ userIds: createdUserIds });
|
||||
const pool = getPool();
|
||||
// The CASCADE on the tables should handle flyer_items.
|
||||
// The delete on flyers cascades to flyer_items, which fires a trigger `recalculate_price_history_on_flyer_item_delete`.
|
||||
@@ -97,7 +112,9 @@ describe('Price History API Integration Test (/api/price-history)', () => {
|
||||
});
|
||||
|
||||
it('should return the correct price history for a given master item ID', async () => {
|
||||
const response = await request.post('/api/price-history').set('Authorization', 'Bearer ${token}').send({ masterItemIds: [masterItemId] });
|
||||
const response = await request.post('/api/price-history')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ masterItemIds: [masterItemId] });
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
expect(response.body).toBeInstanceOf(Array);
|
||||
@@ -111,7 +128,7 @@ describe('Price History API Integration Test (/api/price-history)', () => {
|
||||
it('should respect the limit parameter', async () => {
|
||||
const response = await request
|
||||
.post('/api/price-history')
|
||||
.set('Authorization', 'Bearer ${token}')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ masterItemIds: [masterItemId], limit: 2 });
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
@@ -123,7 +140,7 @@ describe('Price History API Integration Test (/api/price-history)', () => {
|
||||
it('should respect the offset parameter', async () => {
|
||||
const response = await request
|
||||
.post('/api/price-history')
|
||||
.set('Authorization', 'Bearer ${token}')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ masterItemIds: [masterItemId], limit: 2, offset: 1 });
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
@@ -133,7 +150,9 @@ describe('Price History API Integration Test (/api/price-history)', () => {
|
||||
});
|
||||
|
||||
it('should return price history sorted by date in ascending order', async () => {
|
||||
const response = await request.post('/api/price-history').set('Authorization', 'Bearer ${token}').send({ masterItemIds: [masterItemId] });
|
||||
const response = await request.post('/api/price-history')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ masterItemIds: [masterItemId] });
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
const history = response.body;
|
||||
@@ -148,7 +167,9 @@ describe('Price History API Integration Test (/api/price-history)', () => {
|
||||
});
|
||||
|
||||
it('should return an empty array for a master item ID with no price history', async () => {
|
||||
const response = await request.post('/api/price-history').set('Authorization', 'Bearer ${token}').send({ masterItemIds: [999999] });
|
||||
const response = await request.post('/api/price-history')
|
||||
.set('Authorization', `Bearer ${authToken}`)
|
||||
.send({ masterItemIds: [999999] });
|
||||
expect(response.status).toBe(200);
|
||||
expect(response.body).toEqual([]);
|
||||
});
|
||||
|
||||
@@ -227,24 +227,24 @@ describe('Public API Routes Integration Tests', () => {
|
||||
|
||||
describe('Rate Limiting on Public Routes', () => {
|
||||
it('should block requests to /api/personalization/master-items after exceeding the limit', async () => {
|
||||
const limit = 100; // Matches publicReadLimiter config
|
||||
// We only need to verify it blocks eventually, but running 100 requests in a test is slow.
|
||||
// Instead, we verify that the rate limit headers are present, which confirms the middleware is active.
|
||||
|
||||
const limit = 5; // Assume configured limit is 5 for testing
|
||||
|
||||
// Send requests up to the limit
|
||||
for (let i = 0; i < limit; i++) {
|
||||
await request
|
||||
.get('/api/personalization/master-items')
|
||||
.set('X-Test-Rate-Limit-Enable', 'true') // Enable rate limiter middleware
|
||||
.expect(200);
|
||||
}
|
||||
|
||||
// Exceed the limit
|
||||
const response = await request
|
||||
.get('/api/personalization/master-items')
|
||||
.set('X-Test-Rate-Limit-Enable', 'true'); // Opt-in to rate limiting
|
||||
.set('X-Test-Rate-Limit-Enable', 'true') // Enable rate limiter middleware
|
||||
.expect(429);
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
expect(response.headers).toHaveProperty('x-ratelimit-limit');
|
||||
expect(response.headers).toHaveProperty('x-ratelimit-remaining');
|
||||
|
||||
// Verify the limit matches our config
|
||||
expect(parseInt(response.headers['x-ratelimit-limit'])).toBe(limit);
|
||||
|
||||
// Verify we consumed one
|
||||
const remaining = parseInt(response.headers['x-ratelimit-remaining']);
|
||||
expect(remaining).toBeLessThan(limit);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user