Compare commits

...

4 Commits

Author SHA1 Message Date
Gitea Actions
0db90dfaa6 ci: Bump version to 0.0.7 [skip ci] 2025-12-23 04:33:19 +05:00
b7a1294ae6 fix to versioning
Some checks are pending
Deploy to Test Environment / deploy-to-test (push) Has started running
2025-12-22 15:32:43 -08:00
Gitea Actions
be652f9790 ci: Bump version to 0.0.6 [skip ci] 2025-12-23 04:17:17 +05:00
1a3e6a9ab5 unit test fixes
Some checks failed
Deploy to Test Environment / deploy-to-test (push) Failing after 38s
2025-12-22 15:11:18 -08:00
8 changed files with 136 additions and 39 deletions

View File

@@ -51,7 +51,14 @@ jobs:
# Bump the patch version number. This creates a new commit and a new tag.
# The commit message includes [skip ci] to prevent this push from triggering another workflow run.
npm version patch -m "ci: Bump version to %s [skip ci]"
# If the tag already exists (e.g. re-running a failed job), we skip the conflicting version.
if ! npm version patch -m "ci: Bump version to %s [skip ci]"; then
echo "⚠️ Version bump failed (likely tag exists). Attempting to skip to next version..."
# Bump package.json to the conflicting version without git tagging
npm version patch --no-git-tag-version > /dev/null
# Bump again to the next version, forcing it because the directory is now dirty
npm version patch -m "ci: Bump version to %s [skip ci]" --force
fi
# Push the new commit and the new tag back to the main branch.
git push --follow-tags

4
package-lock.json generated
View File

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

View File

@@ -192,7 +192,7 @@ describe('Auth Routes (/api/auth)', () => {
// Assert
expect(response.status).toBe(201);
expect(response.body.message).toBe('User registered successfully!');
expect(response.body.user.email).toBe(newUserEmail);
expect(response.body.userprofile.user.email).toBe(newUserEmail);
expect(response.body.token).toBeTypeOf('string'); // This was a duplicate, fixed.
expect(db.userRepo.createUser).toHaveBeenCalled();
});
@@ -295,7 +295,7 @@ describe('Auth Routes (/api/auth)', () => {
// Assert
expect(response.status).toBe(200);
// The API now returns a nested UserProfile object
expect(response.body.user).toEqual(
expect(response.body.userprofile).toEqual(
expect.objectContaining({
user_id: 'user-123',
user: expect.objectContaining({

View File

@@ -1,23 +1,38 @@
// src/routes/system.routes.test.ts
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { describe, it, expect, vi, beforeEach, afterAll } from 'vitest';
import supertest from 'supertest';
import { exec, type ExecException, type ExecOptions } from 'child_process'; // Keep this for mocking
import { geocodingService } from '../services/geocodingService.server';
import { createTestApp } from '../tests/utils/createTestApp';
import { mockLogger } from '../tests/utils/mockLogger';
// FIX: Use the simple factory pattern for child_process to avoid default export issues
// =============================================================================
// MOCKS CONFIGURATION
// =============================================================================
// 1. Mock child_process
// FIX: Use the simple factory pattern for child_process to avoid default export issues.
// We also add logging here to catch any un-mocked usages immediately.
vi.mock('child_process', () => {
const mockExec = vi.fn((command, callback) => {
if (typeof callback === 'function') {
callback(null, 'PM2 OK', '');
const defaultMockExec = (command: string, ...args: any[]) => {
console.log(`[MOCK:child_process] Global exec hit for command: "${command}"`);
const callback = args.find((arg) => typeof arg === 'function');
if (callback) {
// Defensive: Run callback async to prevent Zalgo and stack overflows
process.nextTick(() => {
callback(null, 'PM2 OK', '');
});
}
return { unref: () => {} };
});
return {
unref: () => {
/* no-op */
},
};
};
return {
default: { exec: mockExec },
exec: mockExec,
default: { exec: defaultMockExec },
exec: defaultMockExec,
};
});
@@ -36,39 +51,83 @@ vi.mock('../services/logger.server', () => ({
// Import the router AFTER all mocks are defined.
import systemRouter from './system.routes';
// =============================================================================
// TEST SUITE
// =============================================================================
describe('System Routes (/api/system)', () => {
console.log('[TEST SUITE] initializing System Routes tests...');
const app = createTestApp({ router: systemRouter, basePath: '/api/system' });
// Add a basic error handler to capture errors passed to next(err) and return JSON.
app.use((err: any, req: any, res: any, next: any) => {
console.error('[TEST SUITE] Error caught in test app error handler:', err.message);
res.status(err.status || 500).json({ message: err.message, errors: err.errors });
});
beforeEach(() => {
// We cast here to get type-safe access to mock functions like .mockImplementation
vi.clearAllMocks();
console.log('[TEST SUITE] Mocks cleared.');
});
afterAll(() => {
vi.restoreAllMocks();
console.log('[TEST SUITE] Mocks restored. Suite finished.');
});
describe('GET /pm2-status', () => {
// Helper function to set up the mock for `child_process.exec` for each test case.
// This avoids repeating the complex mock implementation in every test.
const setupExecMock = (error: ExecException | null, stdout: string, stderr: string) => {
console.log('[TEST SETUP] Configuring exec mock implementation');
vi.mocked(exec).mockImplementation(
(
command: string,
options?:
optionsOrCb?:
| ExecOptions
| ((error: ExecException | null, stdout: string, stderr: string) => void)
| null,
callback?: ((error: ExecException | null, stdout: string, stderr: string) => void) | null,
cb?: ((error: ExecException | null, stdout: string, stderr: string) => void) | null,
) => {
const actualCallback = (typeof options === 'function' ? options : callback) as (
error: ExecException | null,
stdout: string,
stderr: string,
) => void;
if (actualCallback) actualCallback(error, stdout, stderr);
return { unref: () => {} } as ReturnType<typeof exec>;
console.log(`[MOCK EXEC] Command received: "${command}"`);
// Normalize arguments: options is optional
let callback:
| ((error: ExecException | null, stdout: string, stderr: string) => void)
| undefined;
if (typeof optionsOrCb === 'function') {
callback = optionsOrCb;
} else if (typeof cb === 'function') {
callback = cb;
}
if (callback) {
const safeCallback = callback;
// Defensive: Execute callback asynchronously (nextTick) to simulate real I/O
// This prevents the "synchronous callback" issue which can confuse test runners and async/await
process.nextTick(() => {
console.log(
`[MOCK EXEC] Invoking callback for "${command}" | Error: ${!!error} | Stdout len: ${stdout.length}`,
);
try {
safeCallback(error, stdout, stderr);
} catch (err) {
console.error('[MOCK EXEC] CRITICAL: Error inside exec callback:', err);
}
});
} else {
console.warn(`[MOCK EXEC] No callback provided for "${command}"`);
}
return {
unref: () => {
/* no-op */
},
} as ReturnType<typeof exec>;
},
);
};
@@ -118,21 +177,30 @@ describe('System Routes (/api/system)', () => {
},
];
it.each(testCases)('$description', async ({ mock, expectedStatus, expectedBody }) => {
// Arrange
setupExecMock(mock.error as ExecException | null, mock.stdout, mock.stderr);
it.each(testCases)(
'$description',
async ({ mock, expectedStatus, expectedBody, description }) => {
console.log(`[TEST CASE] Starting: ${description}`);
// Act
const response = await supertest(app).get('/api/system/pm2-status');
// Arrange
setupExecMock(mock.error as ExecException | null, mock.stdout, mock.stderr);
// Assert
expect(response.status).toBe(expectedStatus);
expect(response.body).toEqual(expectedBody);
});
// Act
console.log('[TEST CASE] Sending request...');
const response = await supertest(app).get('/api/system/pm2-status');
console.log(`[TEST CASE] Response received: status=${response.status}`);
// Assert
expect(response.status).toBe(expectedStatus);
expect(response.body).toEqual(expectedBody);
console.log(`[TEST CASE] Completed: ${description}`);
},
);
});
describe('POST /geocode', () => {
it('should return geocoded coordinates for a valid address', async () => {
console.log('[TEST CASE] POST /geocode - valid address');
// Arrange
const mockCoordinates = { lat: 48.4284, lng: -123.3656 };
vi.mocked(geocodingService.geocodeAddress).mockResolvedValue(mockCoordinates);
@@ -148,6 +216,7 @@ describe('System Routes (/api/system)', () => {
});
it('should return 404 if the address cannot be geocoded', async () => {
console.log('[TEST CASE] POST /geocode - address not found');
vi.mocked(geocodingService.geocodeAddress).mockResolvedValue(null);
const response = await supertest(app)
.post('/api/system/geocode')
@@ -157,6 +226,7 @@ describe('System Routes (/api/system)', () => {
});
it('should return 500 if the geocoding service throws an error', async () => {
console.log('[TEST CASE] POST /geocode - service error');
const geocodeError = new Error('Geocoding service unavailable');
vi.mocked(geocodingService.geocodeAddress).mockRejectedValue(geocodeError);
const response = await supertest(app)
@@ -166,6 +236,7 @@ describe('System Routes (/api/system)', () => {
});
it('should return 400 if the address is missing from the body', async () => {
console.log('[TEST CASE] POST /geocode - validation error');
const response = await supertest(app)
.post('/api/system/geocode')
.send({ not_address: 'Victoria, BC' });

View File

@@ -29,8 +29,16 @@ router.get(
'/pm2-status',
validateRequest(emptySchema),
(req: Request, res: Response, next: NextFunction) => {
// DEBUG: Add logging to trace entry into the route
console.log(`[API /pm2-status] Received request. Executing PM2 check...`);
// The name 'flyer-crawler-api' comes from your ecosystem.config.cjs file.
exec('pm2 describe flyer-crawler-api', (error, stdout, stderr) => {
// DEBUG: Log callback entry
console.log(
`[API /pm2-status] PM2 check complete. Error: ${!!error}, Stderr Len: ${stderr?.length}`,
);
// The "doesn't exist" message can appear in stdout or stderr depending on PM2 version and context.
const processNotFound =
stdout?.includes("doesn't exist") || stderr?.includes("doesn't exist");
@@ -49,6 +57,8 @@ router.get(
{ error: stderr || error.message },
'[API /pm2-status] Error executing pm2 describe:',
);
// DEBUG: Explicit log for test debugging
console.error('[API /pm2-status] Exec failed:', error);
return next(error);
}
@@ -56,6 +66,7 @@ router.get(
// This handles warnings or non-fatal errors that should arguably be treated as failures in this context.
if (stderr && stderr.trim().length > 0) {
logger.error({ stderr }, '[API /pm2-status] PM2 executed but produced stderr:');
console.error('[API /pm2-status] STDERR present:', stderr);
return next(new Error(`PM2 command produced an error: ${stderr}`));
}
@@ -64,6 +75,8 @@ router.get(
const message = isOnline
? 'Application is online and running under PM2.'
: 'Application process exists but is not online.';
console.log(`[API /pm2-status] Success. Online: ${isOnline}`);
res.json({ success: isOnline, message });
});
},
@@ -83,16 +96,22 @@ router.post(
body: { address },
} = req as unknown as GeocodeRequest;
// DEBUG
console.log(`[API /geocode] Request for address: "${address}"`);
try {
const coordinates = await geocodingService.geocodeAddress(address, req.log);
if (!coordinates) {
console.log('[API /geocode] Address not found.');
// This check remains, but now it only fails if BOTH services fail.
return res.status(404).json({ message: 'Could not geocode the provided address.' });
}
console.log('[API /geocode] Success:', coordinates);
res.json(coordinates);
} catch (error) {
console.error('[API /geocode] Error:', error);
next(error);
}
},

View File

@@ -128,7 +128,7 @@ export class AIService {
// This preserves the dependency injection pattern used throughout the class.
this.aiClient = genAI
? {
generateContent: (request) => {
generateContent: async (request) => {
// The model name is now injected here, into every call, as the new SDK requires.
// Architectural guard clause: All requests from this service must have content.
// This prevents sending invalid requests to the API and satisfies TypeScript's strictness.

View File

@@ -87,7 +87,7 @@ describe('Geocoding Service', () => {
// Assert
expect(result).toEqual(coordinates);
expect(logger.error).toHaveBeenCalledWith(
{ err: expect.any(Error), cacheKey: expect.any(String) },
{ err: 'Redis down', cacheKey: expect.any(String) },
'Redis GET or JSON.parse command failed. Proceeding without cache.',
);
expect(mockGoogleService.geocode).toHaveBeenCalled(); // Should still proceed to fetch
@@ -107,7 +107,7 @@ describe('Geocoding Service', () => {
expect(mocks.mockRedis.get).toHaveBeenCalledWith(cacheKey);
// The service should log the JSON parsing error and continue
expect(logger.error).toHaveBeenCalledWith(
{ err: expect.any(SyntaxError), cacheKey: expect.any(String) },
{ err: expect.any(String), cacheKey: expect.any(String) },
'Redis GET or JSON.parse command failed. Proceeding without cache.',
);
expect(mockGoogleService.geocode).toHaveBeenCalledTimes(1);
@@ -185,7 +185,7 @@ describe('Geocoding Service', () => {
// Assert
expect(result).toEqual(coordinates);
expect(logger.error).toHaveBeenCalledWith(
{ err: expect.any(Error) },
{ err: 'Network Error' },
expect.stringContaining('An error occurred while calling the Google Maps Geocoding API'),
);
expect(mockNominatimService.geocode).toHaveBeenCalledWith(address, logger);
@@ -223,7 +223,7 @@ describe('Geocoding Service', () => {
expect(mockGoogleService.geocode).toHaveBeenCalledTimes(1);
expect(mocks.mockRedis.set).toHaveBeenCalledTimes(1);
expect(logger.error).toHaveBeenCalledWith(
{ err: expect.any(Error), cacheKey: expect.any(String) },
{ err: 'Redis SET failed', cacheKey: expect.any(String) },
'Redis SET command failed. Result will not be cached.',
);
});
@@ -271,7 +271,7 @@ describe('Geocoding Service', () => {
// Act & Assert
await expect(geocodingService.clearGeocodeCache(logger)).rejects.toThrow(redisError);
expect(logger.error).toHaveBeenCalledWith(
{ err: redisError },
{ err: redisError.message },
'Failed to clear geocode cache from Redis.',
);
expect(mocks.mockRedis.del).not.toHaveBeenCalled();