Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
56f45c9301 | ||
| 83460abce4 | |||
|
|
1b084b2ba4 | ||
| 0ea034bdc8 | |||
|
|
fc9e27078a | ||
| fb8cbe8007 | |||
| f49f786c23 | |||
|
|
dd31141d4e | ||
| 8073094760 | |||
|
|
33a1e146ab | ||
| 4f8216db77 | |||
|
|
42d605d19f | ||
| 749350df7f | |||
|
|
ac085100fe | ||
| ce4ecd1268 | |||
|
|
a57cfc396b | ||
| 987badbf8d | |||
|
|
d38fcd21c1 | ||
| 6e36cc3b07 |
@@ -92,7 +92,13 @@
|
||||
"Bash(tee:*)",
|
||||
"Bash(timeout 1800 podman exec flyer-crawler-dev npm run test:unit:*)",
|
||||
"mcp__filesystem__edit_file",
|
||||
"Bash(timeout 300 tail:*)"
|
||||
"Bash(timeout 300 tail:*)",
|
||||
"mcp__filesystem__list_allowed_directories",
|
||||
"mcp__memory__add_observations",
|
||||
"Bash(ssh:*)",
|
||||
"mcp__redis__list",
|
||||
"Read(//d/gitea/bugsink-mcp/**)",
|
||||
"Bash(d:/nodejs/npm.cmd install)"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -37,3 +37,4 @@ test-output.txt
|
||||
Thumbs.db
|
||||
.claude
|
||||
nul
|
||||
tmpclaude*
|
||||
|
||||
378
CLAUDE-MCP.md
Normal file
378
CLAUDE-MCP.md
Normal file
@@ -0,0 +1,378 @@
|
||||
# Claude Code MCP Configuration Guide
|
||||
|
||||
This document explains how to configure MCP (Model Context Protocol) servers for Claude Code, covering both the CLI and VS Code extension.
|
||||
|
||||
## The Two Config Files
|
||||
|
||||
Claude Code uses **two separate configuration files** for MCP servers. They must be kept in sync manually.
|
||||
|
||||
| File | Used By | Notes |
|
||||
| ------------------------- | ----------------------------- | ------------------------------------------- |
|
||||
| `~/.claude.json` | Claude CLI (`claude` command) | Requires `"type": "stdio"` in each server |
|
||||
| `~/.claude/settings.json` | VS Code Extension | Simpler format, supports `"disabled": true` |
|
||||
|
||||
**Important:** Changes to one file do NOT automatically sync to the other!
|
||||
|
||||
## File Locations (Windows)
|
||||
|
||||
```text
|
||||
C:\Users\<username>\.claude.json # CLI config
|
||||
C:\Users\<username>\.claude\settings.json # VS Code extension config
|
||||
```
|
||||
|
||||
## Config Format Differences
|
||||
|
||||
### VS Code Extension Format (`~/.claude/settings.json`)
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"server-name": {
|
||||
"command": "path/to/executable",
|
||||
"args": ["arg1", "arg2"],
|
||||
"env": {
|
||||
"ENV_VAR": "value"
|
||||
},
|
||||
"disabled": true // Optional - disable without removing
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### CLI Format (`~/.claude.json`)
|
||||
|
||||
The CLI config is a larger file with many settings. The `mcpServers` section is nested within it:
|
||||
|
||||
```json
|
||||
{
|
||||
"numStartups": 14,
|
||||
"installMethod": "global",
|
||||
// ... other settings ...
|
||||
"mcpServers": {
|
||||
"server-name": {
|
||||
"type": "stdio", // REQUIRED for CLI
|
||||
"command": "path/to/executable",
|
||||
"args": ["arg1", "arg2"],
|
||||
"env": {
|
||||
"ENV_VAR": "value"
|
||||
}
|
||||
}
|
||||
}
|
||||
// ... more settings ...
|
||||
}
|
||||
```
|
||||
|
||||
**Key difference:** CLI format requires `"type": "stdio"` in each server definition.
|
||||
|
||||
## Common MCP Server Examples
|
||||
|
||||
### Memory (Knowledge Graph)
|
||||
|
||||
```json
|
||||
// VS Code format
|
||||
"memory": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@modelcontextprotocol/server-memory"]
|
||||
}
|
||||
|
||||
// CLI format
|
||||
"memory": {
|
||||
"type": "stdio",
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@modelcontextprotocol/server-memory"],
|
||||
"env": {}
|
||||
}
|
||||
```
|
||||
|
||||
### Filesystem
|
||||
|
||||
```json
|
||||
// VS Code format
|
||||
"filesystem": {
|
||||
"command": "d:\\nodejs\\node.exe",
|
||||
"args": [
|
||||
"c:\\Users\\<user>\\AppData\\Roaming\\npm\\node_modules\\@modelcontextprotocol\\server-filesystem\\dist\\index.js",
|
||||
"d:\\path\\to\\project"
|
||||
]
|
||||
}
|
||||
|
||||
// CLI format
|
||||
"filesystem": {
|
||||
"type": "stdio",
|
||||
"command": "d:\\nodejs\\node.exe",
|
||||
"args": [
|
||||
"c:\\Users\\<user>\\AppData\\Roaming\\npm\\node_modules\\@modelcontextprotocol\\server-filesystem\\dist\\index.js",
|
||||
"d:\\path\\to\\project"
|
||||
],
|
||||
"env": {}
|
||||
}
|
||||
```
|
||||
|
||||
### Podman/Docker
|
||||
|
||||
```json
|
||||
// VS Code format
|
||||
"podman": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "podman-mcp-server@latest"],
|
||||
"env": {
|
||||
"DOCKER_HOST": "npipe:////./pipe/podman-machine-default"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Gitea
|
||||
|
||||
```json
|
||||
// VS Code format
|
||||
"gitea-myserver": {
|
||||
"command": "d:\\gitea-mcp\\gitea-mcp.exe",
|
||||
"args": ["run", "-t", "stdio"],
|
||||
"env": {
|
||||
"GITEA_HOST": "https://gitea.example.com",
|
||||
"GITEA_ACCESS_TOKEN": "your-token-here"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Redis
|
||||
|
||||
```json
|
||||
// VS Code format
|
||||
"redis": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@modelcontextprotocol/server-redis", "redis://localhost:6379"]
|
||||
}
|
||||
```
|
||||
|
||||
### Bugsink (Error Tracking)
|
||||
|
||||
**Important:** Bugsink has a different API than Sentry. Use `bugsink-mcp`, NOT `sentry-selfhosted-mcp`.
|
||||
|
||||
**Note:** The `bugsink-mcp` npm package is NOT published. You must clone and build from source:
|
||||
|
||||
```bash
|
||||
# Clone and build bugsink-mcp
|
||||
git clone https://github.com/j-shelfwood/bugsink-mcp.git d:\gitea\bugsink-mcp
|
||||
cd d:\gitea\bugsink-mcp
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
```json
|
||||
// VS Code format (using locally built version)
|
||||
"bugsink": {
|
||||
"command": "d:\\nodejs\\node.exe",
|
||||
"args": ["d:\\gitea\\bugsink-mcp\\dist\\index.js"],
|
||||
"env": {
|
||||
"BUGSINK_URL": "https://bugsink.example.com",
|
||||
"BUGSINK_TOKEN": "your-api-token"
|
||||
}
|
||||
}
|
||||
|
||||
// CLI format
|
||||
"bugsink": {
|
||||
"type": "stdio",
|
||||
"command": "d:\\nodejs\\node.exe",
|
||||
"args": ["d:\\gitea\\bugsink-mcp\\dist\\index.js"],
|
||||
"env": {
|
||||
"BUGSINK_URL": "https://bugsink.example.com",
|
||||
"BUGSINK_TOKEN": "your-api-token"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- GitHub: <https://github.com/j-shelfwood/bugsink-mcp>
|
||||
- Get token from Bugsink UI: Settings > API Tokens
|
||||
- **Do NOT use npx** - the package is not on npm
|
||||
|
||||
### Sentry (Cloud or Self-hosted)
|
||||
|
||||
For actual Sentry instances (not Bugsink), use:
|
||||
|
||||
```json
|
||||
"sentry": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@sentry/mcp-server"],
|
||||
"env": {
|
||||
"SENTRY_AUTH_TOKEN": "your-sentry-token"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Server Not Loading
|
||||
|
||||
1. **Check both config files** - Make sure the server is defined in both `~/.claude.json` AND `~/.claude/settings.json`
|
||||
|
||||
2. **Verify server order** - Servers load sequentially. Broken/slow servers can block others. Put important servers first.
|
||||
|
||||
3. **Check for timeout** - Each server has 30 seconds to connect. Slow npx downloads can cause timeouts.
|
||||
|
||||
4. **Fully restart VS Code** - Window reload is not enough. Close all VS Code windows and reopen.
|
||||
|
||||
### Verifying Configuration
|
||||
|
||||
**For CLI:**
|
||||
|
||||
```bash
|
||||
claude mcp list
|
||||
```
|
||||
|
||||
**For VS Code:**
|
||||
|
||||
1. Open VS Code
|
||||
2. View → Output
|
||||
3. Select "Claude" from the dropdown
|
||||
4. Look for MCP server connection logs
|
||||
|
||||
### Common Errors
|
||||
|
||||
| Error | Cause | Solution |
|
||||
| ------------------------------------ | ----------------------------- | --------------------------------------------------------------------------- |
|
||||
| `Connection timed out after 30000ms` | Server took too long to start | Move server earlier in config, or use pre-installed packages instead of npx |
|
||||
| `npm error 404 Not Found` | Package doesn't exist | Check package name spelling |
|
||||
| `The system cannot find the path` | Wrong executable path | Verify the command path exists |
|
||||
| `Connection closed` | Server crashed on startup | Check server logs, verify environment variables |
|
||||
|
||||
### Disabling Problem Servers
|
||||
|
||||
In `~/.claude/settings.json`, add `"disabled": true`:
|
||||
|
||||
```json
|
||||
"problem-server": {
|
||||
"command": "...",
|
||||
"args": ["..."],
|
||||
"disabled": true
|
||||
}
|
||||
```
|
||||
|
||||
**Note:** The CLI config (`~/.claude.json`) does not support the `disabled` flag. You must remove the server entirely from that file.
|
||||
|
||||
## Adding a New MCP Server
|
||||
|
||||
1. **Install/clone the MCP server** (if not using npx)
|
||||
|
||||
2. **Add to VS Code config** (`~/.claude/settings.json`):
|
||||
|
||||
```json
|
||||
"new-server": {
|
||||
"command": "path/to/command",
|
||||
"args": ["arg1", "arg2"],
|
||||
"env": { "VAR": "value" }
|
||||
}
|
||||
```
|
||||
|
||||
3. **Add to CLI config** (`~/.claude.json`) - find the `mcpServers` section:
|
||||
|
||||
```json
|
||||
"new-server": {
|
||||
"type": "stdio",
|
||||
"command": "path/to/command",
|
||||
"args": ["arg1", "arg2"],
|
||||
"env": { "VAR": "value" }
|
||||
}
|
||||
```
|
||||
|
||||
4. **Fully restart VS Code**
|
||||
|
||||
5. **Verify with `claude mcp list`**
|
||||
|
||||
## Quick Reference: Available MCP Servers
|
||||
|
||||
| Server | Package/Repo | Purpose |
|
||||
| ------------------- | -------------------------------------------------- | --------------------------- |
|
||||
| memory | `@modelcontextprotocol/server-memory` | Knowledge graph persistence |
|
||||
| filesystem | `@modelcontextprotocol/server-filesystem` | File system access |
|
||||
| redis | `@modelcontextprotocol/server-redis` | Redis cache inspection |
|
||||
| postgres | `@modelcontextprotocol/server-postgres` | PostgreSQL queries |
|
||||
| sequential-thinking | `@modelcontextprotocol/server-sequential-thinking` | Step-by-step reasoning |
|
||||
| podman | `podman-mcp-server` | Container management |
|
||||
| gitea | `gitea-mcp` (binary) | Gitea API access |
|
||||
| bugsink | `j-shelfwood/bugsink-mcp` (build from source) | Error tracking for Bugsink |
|
||||
| sentry | `@sentry/mcp-server` | Error tracking for Sentry |
|
||||
| playwright | `@anthropics/mcp-server-playwright` | Browser automation |
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Keep configs in sync** - When you change one file, update the other
|
||||
|
||||
2. **Order servers by importance** - Put essential servers (memory, filesystem) first
|
||||
|
||||
3. **Disable instead of delete** - Use `"disabled": true` in settings.json to troubleshoot
|
||||
|
||||
4. **Use node.exe directly** - For faster startup, install packages globally and use `node.exe` instead of `npx`
|
||||
|
||||
5. **Store sensitive data in memory** - Use the memory MCP to store API tokens and config for future sessions
|
||||
|
||||
---
|
||||
|
||||
## Future: MCP Launchpad
|
||||
|
||||
**Project:** <https://github.com/kenneth-liao/mcp-launchpad>
|
||||
|
||||
MCP Launchpad is a CLI tool that wraps multiple MCP servers into a single interface. Worth revisiting when:
|
||||
|
||||
- [ ] Windows support is stable (currently experimental)
|
||||
- [ ] Available as an MCP server itself (currently Bash-based)
|
||||
|
||||
**Why it's interesting:**
|
||||
|
||||
| Benefit | Description |
|
||||
| ---------------------- | -------------------------------------------------------------- |
|
||||
| Single config file | No more syncing `~/.claude.json` and `~/.claude/settings.json` |
|
||||
| Project-level configs | Drop `mcp.json` in any project for instant MCP setup |
|
||||
| Context window savings | One MCP server in context instead of 10+, reducing token usage |
|
||||
| Persistent daemon | Keeps server connections alive for faster repeated calls |
|
||||
| Tool search | Find tools across all servers with `mcpl search` |
|
||||
|
||||
**Current limitations:**
|
||||
|
||||
- Experimental Windows support
|
||||
- Requires Python 3.13+ and uv
|
||||
- Claude calls tools via Bash instead of native MCP integration
|
||||
- Different mental model (runtime discovery vs startup loading)
|
||||
|
||||
---
|
||||
|
||||
## Future: Graphiti (Advanced Knowledge Graph)
|
||||
|
||||
**Project:** <https://github.com/getzep/graphiti>
|
||||
|
||||
Graphiti provides temporal-aware knowledge graphs - it tracks not just facts, but _when_ they became true/outdated. Much more powerful than simple memory MCP, but requires significant infrastructure.
|
||||
|
||||
**Ideal setup:** Run on a Linux server, connect via HTTP from Windows:
|
||||
|
||||
```json
|
||||
// Windows client config (settings.json)
|
||||
"graphiti": {
|
||||
"type": "sse",
|
||||
"url": "http://linux-server:8000/mcp/"
|
||||
}
|
||||
```
|
||||
|
||||
**Linux server setup:**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/getzep/graphiti.git
|
||||
cd graphiti/mcp_server
|
||||
docker compose up -d # Starts FalkorDB + MCP server on port 8000
|
||||
```
|
||||
|
||||
**Requirements:**
|
||||
|
||||
- Docker on Linux server
|
||||
- OpenAI API key (for embeddings)
|
||||
- Port 8000 open on LAN
|
||||
|
||||
**Benefits of remote deployment:**
|
||||
|
||||
- Heavy lifting (Neo4j/FalkorDB + embeddings) offloaded to Linux
|
||||
- Always-on server, Windows connects/disconnects freely
|
||||
- Multiple machines can share the same knowledge graph
|
||||
- Avoids Windows Docker/WSL2 complexity
|
||||
|
||||
---
|
||||
|
||||
\_Last updated: January 2026
|
||||
55
CLAUDE.md
55
CLAUDE.md
@@ -1,5 +1,35 @@
|
||||
# Claude Code Project Instructions
|
||||
|
||||
## Session Startup Checklist
|
||||
|
||||
**IMPORTANT**: At the start of every session, perform these steps:
|
||||
|
||||
1. **Check Memory First** - Use `mcp__memory__read_graph` or `mcp__memory__search_nodes` to recall:
|
||||
- Project-specific configurations and credentials
|
||||
- Previous work context and decisions
|
||||
- Infrastructure details (URLs, ports, access patterns)
|
||||
- Known issues and their solutions
|
||||
|
||||
2. **Review Recent Git History** - Check `git log --oneline -10` to understand recent changes
|
||||
|
||||
3. **Check Container Status** - Use `mcp__podman__container_list` to see what's running
|
||||
|
||||
---
|
||||
|
||||
## Project Instructions
|
||||
|
||||
### Things to Remember
|
||||
|
||||
Before writing any code:
|
||||
|
||||
1. State how you will verify this change works (test, bash command, browser check, etc.)
|
||||
|
||||
2. Write the test or verification step first
|
||||
|
||||
3. Then implement the code
|
||||
|
||||
4. Run verification and iterate until it passes
|
||||
|
||||
## Communication Style: Ask Before Assuming
|
||||
|
||||
**IMPORTANT**: When helping with tasks, **ask clarifying questions before making assumptions**. Do not assume:
|
||||
@@ -323,7 +353,7 @@ The following MCP servers are configured for this project:
|
||||
| redis | Redis cache inspection (localhost:6379) |
|
||||
| sentry-selfhosted-mcp | Error tracking via Bugsink (localhost:8000) |
|
||||
|
||||
**Note:** MCP servers are currently only available in **Claude CLI**. Due to a bug in Claude VS Code extension, MCP servers do not work there yet.
|
||||
**Note:** MCP servers work in both **Claude CLI** and **Claude Code VS Code extension** (as of January 2026).
|
||||
|
||||
### Sentry/Bugsink MCP Server Setup (ADR-015)
|
||||
|
||||
@@ -366,3 +396,26 @@ To enable Claude Code to query and analyze application errors from Bugsink:
|
||||
- Search by error message or stack trace
|
||||
- Update issue status (resolve, ignore)
|
||||
- Add comments to issues
|
||||
|
||||
### SSH Server Access
|
||||
|
||||
Claude Code can execute commands on the production server via SSH:
|
||||
|
||||
```bash
|
||||
# Basic command execution
|
||||
ssh root@projectium.com "command here"
|
||||
|
||||
# Examples:
|
||||
ssh root@projectium.com "systemctl status logstash"
|
||||
ssh root@projectium.com "pm2 list"
|
||||
ssh root@projectium.com "tail -50 /var/www/flyer-crawler.projectium.com/logs/app.log"
|
||||
```
|
||||
|
||||
**Use cases:**
|
||||
|
||||
- Managing Logstash, PM2, NGINX, Redis services
|
||||
- Viewing server logs
|
||||
- Deploying configuration changes
|
||||
- Checking service status
|
||||
|
||||
**Important:** SSH access requires the host machine to have SSH keys configured for `root@projectium.com`.
|
||||
|
||||
@@ -968,14 +968,11 @@ Create the pipeline configuration file:
|
||||
sudo nano /etc/logstash/conf.d/bugsink.conf
|
||||
```
|
||||
|
||||
Next,
|
||||
|
||||
Add the following content:
|
||||
|
||||
```conf
|
||||
input {
|
||||
# Production application logs (Pino JSON format)
|
||||
# The flyer-crawler app writes JSON logs directly to this file
|
||||
file {
|
||||
path => "/var/www/flyer-crawler.projectium.com/logs/app.log"
|
||||
codec => json_lines
|
||||
@@ -995,14 +992,51 @@ input {
|
||||
sincedb_path => "/var/lib/logstash/sincedb_pino_test"
|
||||
}
|
||||
|
||||
# Redis logs
|
||||
# Redis logs (shared by both environments)
|
||||
file {
|
||||
path => "/var/log/redis/redis-server.log"
|
||||
type => "redis"
|
||||
tags => ["redis"]
|
||||
tags => ["infra", "redis", "production"]
|
||||
start_position => "end"
|
||||
sincedb_path => "/var/lib/logstash/sincedb_redis"
|
||||
}
|
||||
|
||||
# NGINX error logs (production)
|
||||
file {
|
||||
path => "/var/log/nginx/error.log"
|
||||
type => "nginx"
|
||||
tags => ["infra", "nginx", "production"]
|
||||
start_position => "end"
|
||||
sincedb_path => "/var/lib/logstash/sincedb_nginx_error"
|
||||
}
|
||||
|
||||
# NGINX access logs - for detecting 5xx errors (production)
|
||||
file {
|
||||
path => "/var/log/nginx/access.log"
|
||||
type => "nginx_access"
|
||||
tags => ["infra", "nginx", "production"]
|
||||
start_position => "end"
|
||||
sincedb_path => "/var/lib/logstash/sincedb_nginx_access"
|
||||
}
|
||||
|
||||
# PM2 error logs - Production (plain text stack traces)
|
||||
file {
|
||||
path => "/home/gitea-runner/.pm2/logs/flyer-crawler-*-error.log"
|
||||
exclude => "*-test-error.log"
|
||||
type => "pm2"
|
||||
tags => ["infra", "pm2", "production"]
|
||||
start_position => "end"
|
||||
sincedb_path => "/var/lib/logstash/sincedb_pm2_prod"
|
||||
}
|
||||
|
||||
# PM2 error logs - Test
|
||||
file {
|
||||
path => "/home/gitea-runner/.pm2/logs/flyer-crawler-*-test-error.log"
|
||||
type => "pm2"
|
||||
tags => ["infra", "pm2", "test"]
|
||||
start_position => "end"
|
||||
sincedb_path => "/var/lib/logstash/sincedb_pm2_test"
|
||||
}
|
||||
}
|
||||
|
||||
filter {
|
||||
@@ -1025,59 +1059,142 @@ filter {
|
||||
mutate { add_tag => ["error"] }
|
||||
}
|
||||
}
|
||||
|
||||
# NGINX error log detection (all entries are errors)
|
||||
if [type] == "nginx" {
|
||||
mutate { add_tag => ["error"] }
|
||||
grok {
|
||||
match => { "message" => "%{TIMESTAMP_ISO8601:timestamp} \[%{WORD:severity}\] %{GREEDYDATA:nginx_message}" }
|
||||
}
|
||||
}
|
||||
|
||||
# NGINX access log - detect 5xx errors
|
||||
if [type] == "nginx_access" {
|
||||
grok {
|
||||
match => { "message" => "%{COMBINEDAPACHELOG}" }
|
||||
}
|
||||
if [response] =~ /^5\d{2}$/ {
|
||||
mutate { add_tag => ["error"] }
|
||||
}
|
||||
}
|
||||
|
||||
# PM2 error log detection - tag lines with actual error indicators
|
||||
if [type] == "pm2" {
|
||||
if [message] =~ /Error:|error:|ECONNREFUSED|ENOENT|TypeError|ReferenceError|SyntaxError/ {
|
||||
mutate { add_tag => ["error"] }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
output {
|
||||
# Only send errors to Bugsink
|
||||
if "error" in [tags] {
|
||||
# Production app errors -> flyer-crawler-backend (project 1)
|
||||
if "error" in [tags] and "app" in [tags] and "production" in [tags] {
|
||||
http {
|
||||
url => "http://localhost:8000/api/1/store/"
|
||||
http_method => "post"
|
||||
format => "json"
|
||||
headers => {
|
||||
"X-Sentry-Auth" => "Sentry sentry_version=7, sentry_client=logstash/1.0, sentry_key=YOUR_BACKEND_DSN_KEY"
|
||||
"X-Sentry-Auth" => "Sentry sentry_version=7, sentry_client=logstash/1.0, sentry_key=YOUR_PROD_BACKEND_DSN_KEY"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Debug output (remove in production after confirming it works)
|
||||
# Test app errors -> flyer-crawler-backend-test (project 3)
|
||||
if "error" in [tags] and "app" in [tags] and "test" in [tags] {
|
||||
http {
|
||||
url => "http://localhost:8000/api/3/store/"
|
||||
http_method => "post"
|
||||
format => "json"
|
||||
headers => {
|
||||
"X-Sentry-Auth" => "Sentry sentry_version=7, sentry_client=logstash/1.0, sentry_key=YOUR_TEST_BACKEND_DSN_KEY"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Production infrastructure errors (Redis, NGINX, PM2) -> flyer-crawler-infrastructure (project 5)
|
||||
if "error" in [tags] and "infra" in [tags] and "production" in [tags] {
|
||||
http {
|
||||
url => "http://localhost:8000/api/5/store/"
|
||||
http_method => "post"
|
||||
format => "json"
|
||||
headers => {
|
||||
"X-Sentry-Auth" => "Sentry sentry_version=7, sentry_client=logstash/1.0, sentry_key=b083076f94fb461b889d5dffcbef43bf"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Test infrastructure errors (PM2 test logs) -> flyer-crawler-test-infrastructure (project 6)
|
||||
if "error" in [tags] and "infra" in [tags] and "test" in [tags] {
|
||||
http {
|
||||
url => "http://localhost:8000/api/6/store/"
|
||||
http_method => "post"
|
||||
format => "json"
|
||||
headers => {
|
||||
"X-Sentry-Auth" => "Sentry sentry_version=7, sentry_client=logstash/1.0, sentry_key=25020dd6c2b74ad78463ec90e90fadab"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Debug output (uncomment to troubleshoot)
|
||||
# stdout { codec => rubydebug }
|
||||
}
|
||||
```
|
||||
|
||||
**Important:** Replace `YOUR_BACKEND_DSN_KEY` with the key from your Bugsink backend DSN. The key is the part before the `@` symbol in the DSN URL.
|
||||
**Bugsink Project DSNs:**
|
||||
|
||||
For example, if your DSN is:
|
||||
| Project | DSN Key | Project ID |
|
||||
| ----------------------------------- | ---------------------------------- | ---------- |
|
||||
| `flyer-crawler-backend` | `911aef02b9a548fa8fabb8a3c81abfe5` | 1 |
|
||||
| `flyer-crawler-frontend` | (used by app, not Logstash) | 2 |
|
||||
| `flyer-crawler-backend-test` | `cdb99c314589431e83d4cc38a809449b` | 3 |
|
||||
| `flyer-crawler-frontend-test` | (used by app, not Logstash) | 4 |
|
||||
| `flyer-crawler-infrastructure` | `b083076f94fb461b889d5dffcbef43bf` | 5 |
|
||||
| `flyer-crawler-test-infrastructure` | `25020dd6c2b74ad78463ec90e90fadab` | 6 |
|
||||
|
||||
```text
|
||||
https://abc123def456@bugsink.yourdomain.com/1
|
||||
```
|
||||
**Note:** The DSN key is the part before `@` in the full DSN URL (e.g., `https://KEY@bugsink.projectium.com/PROJECT_ID`).
|
||||
|
||||
Then `YOUR_BACKEND_DSN_KEY` is `abc123def456`.
|
||||
**Note on PM2 Logs:** PM2 error logs capture stack traces from stderr, which are valuable for debugging startup errors and uncaught exceptions. Production PM2 logs go to project 5 (infrastructure), test PM2 logs go to project 6 (test-infrastructure).
|
||||
|
||||
### Step 5: Create Logstash State Directory
|
||||
### Step 5: Create Logstash State Directory and Fix Config Path
|
||||
|
||||
Logstash needs a directory to track which log lines it has already processed:
|
||||
Logstash needs a directory to track which log lines it has already processed, and a symlink so it can find its config files:
|
||||
|
||||
```bash
|
||||
# Create state directory for sincedb files
|
||||
sudo mkdir -p /var/lib/logstash
|
||||
sudo chown logstash:logstash /var/lib/logstash
|
||||
|
||||
# Create symlink so Logstash finds its config (avoids "Could not find logstash.yml" warning)
|
||||
sudo ln -sf /etc/logstash /usr/share/logstash/config
|
||||
```
|
||||
|
||||
### Step 6: Grant Logstash Access to Application Logs
|
||||
|
||||
Logstash runs as the `logstash` user and needs permission to read the application log files:
|
||||
Logstash runs as the `logstash` user and needs permission to read log files:
|
||||
|
||||
```bash
|
||||
# Make application log files readable by logstash
|
||||
# The directories were already set to 755 in Step 1
|
||||
# Add logstash user to adm group (for nginx and redis logs)
|
||||
sudo usermod -aG adm logstash
|
||||
|
||||
# Ensure the log files themselves are readable (they should be created with 644 by default)
|
||||
# Make application log files readable (created automatically when app starts)
|
||||
sudo chmod 644 /var/www/flyer-crawler.projectium.com/logs/app.log 2>/dev/null || echo "Production log file not yet created"
|
||||
sudo chmod 644 /var/www/flyer-crawler-test.projectium.com/logs/app.log 2>/dev/null || echo "Test log file not yet created"
|
||||
|
||||
# For Redis logs
|
||||
# Make Redis logs and directory readable
|
||||
sudo chmod 755 /var/log/redis/
|
||||
sudo chmod 644 /var/log/redis/redis-server.log
|
||||
|
||||
# Make NGINX logs readable
|
||||
sudo chmod 644 /var/log/nginx/access.log /var/log/nginx/error.log
|
||||
|
||||
# Make PM2 logs and directories accessible
|
||||
sudo chmod 755 /home/gitea-runner/
|
||||
sudo chmod 755 /home/gitea-runner/.pm2/
|
||||
sudo chmod 755 /home/gitea-runner/.pm2/logs/
|
||||
sudo chmod 644 /home/gitea-runner/.pm2/logs/*.log
|
||||
|
||||
# Verify logstash group membership
|
||||
groups logstash
|
||||
```
|
||||
|
||||
**Note:** The application log files are created automatically when the application starts. Run the chmod commands after the first deployment.
|
||||
|
||||
@@ -7,10 +7,53 @@
|
||||
//
|
||||
// These apps:
|
||||
// - Run from /var/www/flyer-crawler-test.projectium.com
|
||||
// - Use NODE_ENV='test' (enables file logging in logger.server.ts)
|
||||
// - Use NODE_ENV='staging' (enables file logging in logger.server.ts)
|
||||
// - Use Redis database 1 (isolated from production which uses database 0)
|
||||
// - Have distinct PM2 process names to avoid conflicts with production
|
||||
|
||||
// --- Load Environment Variables from .env file ---
|
||||
// This allows PM2 to start without requiring the CI/CD pipeline to inject variables.
|
||||
// The .env file should be created on the server with the required secrets.
|
||||
// NOTE: We implement a simple .env parser since dotenv may not be installed.
|
||||
const path = require('path');
|
||||
const fs = require('fs');
|
||||
|
||||
const envPath = path.join('/var/www/flyer-crawler-test.projectium.com', '.env');
|
||||
if (fs.existsSync(envPath)) {
|
||||
console.log('[ecosystem-test.config.cjs] Loading environment from:', envPath);
|
||||
const envContent = fs.readFileSync(envPath, 'utf8');
|
||||
const lines = envContent.split('\n');
|
||||
for (const line of lines) {
|
||||
// Skip comments and empty lines
|
||||
const trimmed = line.trim();
|
||||
if (!trimmed || trimmed.startsWith('#')) continue;
|
||||
|
||||
// Parse KEY=value
|
||||
const eqIndex = trimmed.indexOf('=');
|
||||
if (eqIndex > 0) {
|
||||
const key = trimmed.substring(0, eqIndex);
|
||||
let value = trimmed.substring(eqIndex + 1);
|
||||
// Remove quotes if present
|
||||
if (
|
||||
(value.startsWith('"') && value.endsWith('"')) ||
|
||||
(value.startsWith("'") && value.endsWith("'"))
|
||||
) {
|
||||
value = value.slice(1, -1);
|
||||
}
|
||||
// Only set if not already in environment (don't override CI/CD vars)
|
||||
if (!process.env[key]) {
|
||||
process.env[key] = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
console.log('[ecosystem-test.config.cjs] Environment loaded successfully');
|
||||
} else {
|
||||
console.warn('[ecosystem-test.config.cjs] No .env file found at:', envPath);
|
||||
console.warn(
|
||||
'[ecosystem-test.config.cjs] Environment variables must be provided by the shell or CI/CD.'
|
||||
);
|
||||
}
|
||||
|
||||
// --- Environment Variable Validation ---
|
||||
// NOTE: We only WARN about missing secrets, not exit.
|
||||
// Calling process.exit(1) prevents PM2 from reading the apps array.
|
||||
@@ -71,7 +114,8 @@ module.exports = {
|
||||
exp_backoff_restart_delay: 100,
|
||||
min_uptime: '10s',
|
||||
env: {
|
||||
NODE_ENV: 'test',
|
||||
NODE_ENV: 'staging',
|
||||
PORT: 3002,
|
||||
WORKER_LOCK_DURATION: '120000',
|
||||
...sharedEnv,
|
||||
},
|
||||
@@ -89,7 +133,7 @@ module.exports = {
|
||||
exp_backoff_restart_delay: 100,
|
||||
min_uptime: '10s',
|
||||
env: {
|
||||
NODE_ENV: 'test',
|
||||
NODE_ENV: 'staging',
|
||||
...sharedEnv,
|
||||
},
|
||||
},
|
||||
@@ -106,7 +150,7 @@ module.exports = {
|
||||
exp_backoff_restart_delay: 100,
|
||||
min_uptime: '10s',
|
||||
env: {
|
||||
NODE_ENV: 'test',
|
||||
NODE_ENV: 'staging',
|
||||
...sharedEnv,
|
||||
},
|
||||
},
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
# HTTPS Server Block (main)
|
||||
server {
|
||||
listen 443 ssl;
|
||||
listen [::]:443 ssl;
|
||||
server_name flyer-crawler-test.projectium.com;
|
||||
|
||||
# SSL Configuration (managed by Certbot)
|
||||
ssl_certificate /etc/letsencrypt/live/flyer-crawler-test.projectium.com/fullchain.pem;
|
||||
ssl_certificate_key /etc/letsencrypt/live/flyer-crawler-test.projectium.com/privkey.pem;
|
||||
include /etc/letsencrypt/options-ssl-nginx.conf;
|
||||
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
|
||||
|
||||
# Allow large file uploads (e.g., for flyers)
|
||||
client_max_body_size 100M;
|
||||
|
||||
# Root directory for built application files
|
||||
root /var/www/flyer-crawler-test.projectium.com;
|
||||
index index.html;
|
||||
|
||||
# Deny access to all dotfiles
|
||||
location ~ /\. {
|
||||
deny all;
|
||||
return 404;
|
||||
}
|
||||
|
||||
# Coverage report (must come before generic location /)
|
||||
location /coverage/ {
|
||||
try_files $uri $uri/ =404;
|
||||
}
|
||||
|
||||
# SPA fallback for React Router
|
||||
location / {
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
|
||||
# Reverse proxy for backend API
|
||||
location /api/ {
|
||||
proxy_connect_timeout 300s;
|
||||
proxy_send_timeout 300s;
|
||||
proxy_read_timeout 300s;
|
||||
|
||||
proxy_pass http://localhost:3002;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection 'upgrade';
|
||||
proxy_set_header Host $host;
|
||||
proxy_cache_bypass $http_upgrade;
|
||||
}
|
||||
|
||||
# Correct MIME type for .mjs files
|
||||
location ~ \.mjs$ {
|
||||
include /etc/nginx/mime.types;
|
||||
default_type application/javascript;
|
||||
}
|
||||
|
||||
# Security headers
|
||||
add_header X-Frame-Options "SAMEORIGIN" always;
|
||||
add_header X-XSS-Protection "1; mode=block" always;
|
||||
add_header X-Content-Type-Options "nosniff" always;
|
||||
}
|
||||
|
||||
# HTTP to HTTPS Redirect
|
||||
server {
|
||||
listen 80;
|
||||
listen [::]:80;
|
||||
server_name flyer-crawler-test.projectium.com;
|
||||
|
||||
return 301 https://$host$request_uri;
|
||||
}
|
||||
196
notes-to-ai5.txt
Normal file
196
notes-to-ai5.txt
Normal file
@@ -0,0 +1,196 @@
|
||||
What is the correct named pipe address for Podman on Windows if it's not using the default docker_engine pipe?
|
||||
|
||||
How do I configure the chrome-devtools-mcp server to connect to an existing Chrome instance using the browser_url input?
|
||||
|
||||
|
||||
Unused Input: The browser_url input is defined but not used in any server arguments. If you intend to connect chrome-devtools-mcp to an existing Chrome instance, you would typically pass that URL in the arguments instead of launching a new headless instance.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Based on your current configuration and project setup (Gitea, Podman, PostgreSQL, Redis), here are several other valuable MCP servers available for VS Code.
|
||||
|
||||
Recommended for Your Stack
|
||||
Since you are running a PostgreSQL and Redis stack via Podman, these servers would be immediately useful:
|
||||
|
||||
PostgreSQL (@modelcontextprotocol/server-postgres)
|
||||
|
||||
Purpose: Allows the AI to query your database directly (inspect schemas, run SELECT queries) without needing to shell into the container.
|
||||
Config:
|
||||
json
|
||||
"postgres": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@modelcontextprotocol/server-postgres", "postgresql://postgres:postgres@localhost:5432/flyer_crawler_dev"]
|
||||
}
|
||||
|
||||
|
||||
|
||||
Redis (@modelcontextprotocol/server-redis)
|
||||
|
||||
Purpose: Inspect and modify keys in your Redis instance.
|
||||
Config:
|
||||
json
|
||||
"redis": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@modelcontextprotocol/server-redis", "redis://localhost:6379"]
|
||||
}
|
||||
General Utility Servers
|
||||
These servers enhance the AI's core capabilities regardless of the specific project:
|
||||
|
||||
|
||||
Memory (@modelcontextprotocol/server-memory)
|
||||
|
||||
Purpose: Gives the AI a persistent "knowledge graph" to remember context, user preferences, and project details across different chat sessions.
|
||||
Config:
|
||||
json
|
||||
"memory": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@modelcontextprotocol/server-memory"]
|
||||
}
|
||||
|
||||
|
||||
Brave Search (@modelcontextprotocol/server-brave-search)
|
||||
|
||||
Purpose: Performs actual web searches (finding current docs, libraries, or solutions) rather than just fetching specific URLs like the fetch server does.
|
||||
Config:
|
||||
json
|
||||
Show full code block
|
||||
"brave-search": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@modelcontextprotocol/server-brave-search"],
|
||||
"env": {
|
||||
"BRAVE_API_KEY": "YOUR_API_KEY_HERE"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Sequential Thinking (@modelcontextprotocol/server-sequential-thinking)
|
||||
|
||||
Purpose: A tool that helps the AI break down complex problems into step-by-step thought processes. It is particularly useful for debugging difficult logic or architectural planning.
|
||||
Config:
|
||||
json
|
||||
"sequential-thinking": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@modelcontextprotocol/server-sequential-thinking"]
|
||||
}
|
||||
|
||||
|
||||
Other Popular Servers
|
||||
|
||||
GitHub: (@modelcontextprotocol/server-github) - If you ever need to interact with GitHub.com in addition to Gitea.
|
||||
|
||||
Google Drive: (@modelcontextprotocol/server-google-drive) - Access files in Google Drive.
|
||||
|
||||
Slack: (@modelcontextprotocol/server-slack) - Read and send Slack messages.
|
||||
|
||||
Sentry: (@modelcontextprotocol/server-sentry) - Analyze error reports directly from Sentry.
|
||||
|
||||
How to Find More
|
||||
The community maintains a comprehensive list of servers in the Awesome MCP Servers repository. You can find servers for almost any major tool (AWS, Azure, Linear, Jira, etc.).
|
||||
|
||||
To add any of these, you simply add a new entry to the mcpServers object in your mcp.json file, similar to how you configured podman or fetch.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Create a new ADR for "Worker Health Checks" to monitor stalled background jobs.
|
||||
|
||||
Storybook ! for UI
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
{
|
||||
"mcpServers": {
|
||||
"gitea-projectium": {
|
||||
"command": "d:\\gitea-mcp\\gitea-mcp.exe",
|
||||
"args": ["run", "-t", "stdio"],
|
||||
"env": {
|
||||
"GITEA_HOST": "https://gitea.projectium.com",
|
||||
"GITEA_ACCESS_TOKEN": "b111259253aa3cadcb6a37618de03bf388f6235a"
|
||||
}
|
||||
},
|
||||
"gitea-torbonium": {
|
||||
"command": "d:\\gitea-mcp\\gitea-mcp.exe",
|
||||
"args": ["run", "-t", "stdio"],
|
||||
"env": {
|
||||
"GITEA_HOST": "https://gitea.torbonium.com",
|
||||
"GITEA_ACCESS_TOKEN": "563d01f9edc792b6dd09bf4cbd3a98bce45360a4"
|
||||
}
|
||||
},
|
||||
"gitea-lan": {
|
||||
"command": "d:\\gitea-mcp\\gitea-mcp.exe",
|
||||
"args": ["run", "-t", "stdio"],
|
||||
"env": {
|
||||
"GITEA_HOST": "https://gitea.torbolan.com",
|
||||
"GITEA_ACCESS_TOKEN": "YOUR_LAN_TOKEN_HERE"
|
||||
},
|
||||
"disabled": true
|
||||
},
|
||||
"podman": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "podman-mcp-server@latest"],
|
||||
"env": {
|
||||
"DOCKER_HOST": "npipe:////./pipe/podman-machine-default"
|
||||
}
|
||||
},
|
||||
"filesystem": {
|
||||
"command": "d:\\nodejs\\node.exe",
|
||||
"args": [
|
||||
"c:\\Users\\games3\\AppData\\Roaming\\npm\\node_modules\\@modelcontextprotocol\\server-filesystem\\dist\\index.js",
|
||||
"d:\\gitea\\flyer-crawler.projectium.com\\flyer-crawler.projectium.com"
|
||||
]
|
||||
},
|
||||
"fetch": {
|
||||
"command": "C:\\Users\\games3\\.local\\bin\\uvx.exe",
|
||||
"args": ["mcp-server-fetch"]
|
||||
},
|
||||
"chrome-devtools": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": [
|
||||
"chrome-devtools-mcp@latest",
|
||||
"--headless",
|
||||
"false",
|
||||
"--isolated",
|
||||
"false",
|
||||
"--channel",
|
||||
"stable"
|
||||
],
|
||||
"disabled": true
|
||||
},
|
||||
"markitdown": {
|
||||
"command": "C:\\Users\\games3\\.local\\bin\\uvx.exe",
|
||||
"args": ["markitdown-mcp"]
|
||||
},
|
||||
"sequential-thinking": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@modelcontextprotocol/server-sequential-thinking"]
|
||||
},
|
||||
"memory": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@modelcontextprotocol/server-memory"]
|
||||
},
|
||||
"postgres": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@modelcontextprotocol/server-postgres", "postgresql://postgres:postgres@localhost:5432/flyer_crawler_dev"]
|
||||
},
|
||||
"playwright": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@anthropics/mcp-server-playwright"]
|
||||
},
|
||||
"redis": {
|
||||
"command": "D:\\nodejs\\npx.cmd",
|
||||
"args": ["-y", "@modelcontextprotocol/server-redis", "redis://localhost:6379"]
|
||||
}
|
||||
}
|
||||
}
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "flyer-crawler",
|
||||
"version": "0.9.103",
|
||||
"version": "0.9.112",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "flyer-crawler",
|
||||
"version": "0.9.103",
|
||||
"version": "0.9.112",
|
||||
"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.103",
|
||||
"version": "0.9.112",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "concurrently \"npm:start:dev\" \"vite\"",
|
||||
|
||||
@@ -128,7 +128,7 @@ const workerSchema = z.object({
|
||||
* Server configuration schema.
|
||||
*/
|
||||
const serverSchema = z.object({
|
||||
nodeEnv: z.enum(['development', 'production', 'test']).default('development'),
|
||||
nodeEnv: z.enum(['development', 'production', 'test', 'staging']).default('development'),
|
||||
port: intWithDefault(3001),
|
||||
frontendUrl: z.string().url().optional(),
|
||||
baseUrl: z.string().optional(),
|
||||
@@ -262,8 +262,9 @@ function parseConfig(): EnvConfig {
|
||||
'',
|
||||
].join('\n');
|
||||
|
||||
// In test environment, throw instead of exiting to allow test frameworks to catch
|
||||
if (process.env.NODE_ENV === 'test') {
|
||||
// In test/staging environment, throw instead of exiting to allow test frameworks to catch
|
||||
// and to provide better visibility into config errors during staging deployments
|
||||
if (process.env.NODE_ENV === 'test' || process.env.NODE_ENV === 'staging') {
|
||||
throw new Error(errorMessage);
|
||||
}
|
||||
|
||||
@@ -318,6 +319,24 @@ export const isTest = config.server.nodeEnv === 'test';
|
||||
*/
|
||||
export const isDevelopment = config.server.nodeEnv === 'development';
|
||||
|
||||
/**
|
||||
* Returns true if running in staging environment.
|
||||
*/
|
||||
export const isStaging = config.server.nodeEnv === 'staging';
|
||||
|
||||
/**
|
||||
* Returns true if running in a test-like environment (test or staging).
|
||||
* Use this for behaviors that should be shared between unit/integration tests
|
||||
* and the staging deployment server, such as:
|
||||
* - Using mock AI services (no GEMINI_API_KEY required)
|
||||
* - Verbose error logging
|
||||
* - Fallback URL handling
|
||||
*
|
||||
* Do NOT use this for security bypasses (auth, rate limiting) - those should
|
||||
* only be active in NODE_ENV=test, not staging.
|
||||
*/
|
||||
export const isTestLikeEnvironment = isTest || isStaging;
|
||||
|
||||
/**
|
||||
* Returns true if SMTP is configured (all required fields present).
|
||||
*/
|
||||
|
||||
@@ -161,9 +161,12 @@ export const errorHandler = (err: Error, req: Request, res: Response, next: Next
|
||||
`Unhandled API Error (ID: ${errorId})`,
|
||||
);
|
||||
|
||||
// Also log to console in test environment for visibility in test runners
|
||||
if (process.env.NODE_ENV === 'test') {
|
||||
console.error(`--- [TEST] UNHANDLED ERROR (ID: ${errorId}) ---`, err);
|
||||
// Also log to console in test/staging environments for visibility in test runners
|
||||
if (process.env.NODE_ENV === 'test' || process.env.NODE_ENV === 'staging') {
|
||||
console.error(
|
||||
`--- [${process.env.NODE_ENV?.toUpperCase()}] UNHANDLED ERROR (ID: ${errorId}) ---`,
|
||||
err,
|
||||
);
|
||||
}
|
||||
|
||||
// In production, send a generic message to avoid leaking implementation details.
|
||||
|
||||
@@ -239,10 +239,13 @@ router.post(
|
||||
'Handling /upload-and-process',
|
||||
);
|
||||
|
||||
// Fix: Explicitly clear userProfile if no auth header is present in test env
|
||||
// Fix: Explicitly clear userProfile if no auth header is present in test/staging env
|
||||
// This prevents mockAuth from injecting a non-existent user ID for anonymous requests.
|
||||
let userProfile = req.user as UserProfile | undefined;
|
||||
if (process.env.NODE_ENV === 'test' && !req.headers['authorization']) {
|
||||
if (
|
||||
(process.env.NODE_ENV === 'test' || process.env.NODE_ENV === 'staging') &&
|
||||
!req.headers['authorization']
|
||||
) {
|
||||
userProfile = undefined;
|
||||
}
|
||||
|
||||
|
||||
@@ -160,7 +160,11 @@ export class AIService {
|
||||
this.logger = logger;
|
||||
this.logger.info('---------------- [AIService] Constructor Start ----------------');
|
||||
|
||||
const isTestEnvironment = process.env.NODE_ENV === 'test' || !!process.env.VITEST_POOL_ID;
|
||||
// Use mock AI in test and staging environments (no real API calls, no GEMINI_API_KEY needed)
|
||||
const isTestEnvironment =
|
||||
process.env.NODE_ENV === 'test' ||
|
||||
process.env.NODE_ENV === 'staging' ||
|
||||
!!process.env.VITEST_POOL_ID;
|
||||
|
||||
if (aiClient) {
|
||||
this.logger.info(
|
||||
|
||||
@@ -258,7 +258,13 @@ describe('Custom Database and Application Errors', () => {
|
||||
const dbError = new Error('invalid text');
|
||||
(dbError as any).code = '22P02';
|
||||
expect(() =>
|
||||
handleDbError(dbError, mockLogger, 'msg', {}, { invalidTextMessage: 'custom invalid text' }),
|
||||
handleDbError(
|
||||
dbError,
|
||||
mockLogger,
|
||||
'msg',
|
||||
{},
|
||||
{ invalidTextMessage: 'custom invalid text' },
|
||||
),
|
||||
).toThrow('custom invalid text');
|
||||
});
|
||||
|
||||
@@ -298,5 +304,35 @@ describe('Custom Database and Application Errors', () => {
|
||||
'Failed to perform operation on database.',
|
||||
);
|
||||
});
|
||||
|
||||
it('should fall through to generic error for unhandled Postgres error codes', () => {
|
||||
const dbError = new Error('some other db error');
|
||||
// Set an unhandled Postgres error code (e.g., 42P01 - undefined_table)
|
||||
(dbError as any).code = '42P01';
|
||||
(dbError as any).constraint = 'some_constraint';
|
||||
(dbError as any).detail = 'Table does not exist';
|
||||
|
||||
expect(() =>
|
||||
handleDbError(
|
||||
dbError,
|
||||
mockLogger,
|
||||
'Unknown DB error',
|
||||
{ table: 'users' },
|
||||
{ defaultMessage: 'Operation failed' },
|
||||
),
|
||||
).toThrow('Operation failed');
|
||||
|
||||
// Verify logger.error was called with enhanced context including Postgres-specific fields
|
||||
expect(mockLogger.error).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
err: dbError,
|
||||
code: '42P01',
|
||||
constraint: 'some_constraint',
|
||||
detail: 'Table does not exist',
|
||||
table: 'users',
|
||||
}),
|
||||
'Unknown DB error',
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -182,6 +182,174 @@ describe('ExpiryRepository', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('should update unit field', async () => {
|
||||
const updatedRow = {
|
||||
pantry_item_id: 1,
|
||||
user_id: 'user-1',
|
||||
master_item_id: 100,
|
||||
quantity: 2,
|
||||
unit: 'gallons',
|
||||
best_before_date: '2024-02-15',
|
||||
pantry_location_id: 1,
|
||||
notification_sent_at: null,
|
||||
updated_at: new Date().toISOString(),
|
||||
purchase_date: '2024-01-10',
|
||||
source: 'manual' as InventorySource,
|
||||
receipt_item_id: null,
|
||||
product_id: null,
|
||||
expiry_source: 'manual' as ExpirySource,
|
||||
is_consumed: false,
|
||||
consumed_at: null,
|
||||
item_name: 'Milk',
|
||||
category_name: 'Dairy',
|
||||
location_name: 'fridge',
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rowCount: 1,
|
||||
rows: [updatedRow],
|
||||
});
|
||||
|
||||
const result = await repo.updateInventoryItem(1, 'user-1', { unit: 'gallons' }, mockLogger);
|
||||
|
||||
expect(result.unit).toBe('gallons');
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('unit = $'),
|
||||
expect.arrayContaining(['gallons']),
|
||||
);
|
||||
});
|
||||
|
||||
it('should mark item as consumed and set consumed_at', async () => {
|
||||
const updatedRow = {
|
||||
pantry_item_id: 1,
|
||||
user_id: 'user-1',
|
||||
master_item_id: 100,
|
||||
quantity: 1,
|
||||
unit: null,
|
||||
best_before_date: '2024-02-15',
|
||||
pantry_location_id: 1,
|
||||
notification_sent_at: null,
|
||||
updated_at: new Date().toISOString(),
|
||||
purchase_date: '2024-01-10',
|
||||
source: 'manual' as InventorySource,
|
||||
receipt_item_id: null,
|
||||
product_id: null,
|
||||
expiry_source: 'manual' as ExpirySource,
|
||||
is_consumed: true,
|
||||
consumed_at: new Date().toISOString(),
|
||||
item_name: 'Milk',
|
||||
category_name: 'Dairy',
|
||||
location_name: 'fridge',
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rowCount: 1,
|
||||
rows: [updatedRow],
|
||||
});
|
||||
|
||||
const result = await repo.updateInventoryItem(1, 'user-1', { is_consumed: true }, mockLogger);
|
||||
|
||||
expect(result.is_consumed).toBe(true);
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('consumed_at = NOW()'),
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should unmark item as consumed and set consumed_at to NULL', async () => {
|
||||
const updatedRow = {
|
||||
pantry_item_id: 1,
|
||||
user_id: 'user-1',
|
||||
master_item_id: 100,
|
||||
quantity: 1,
|
||||
unit: null,
|
||||
best_before_date: '2024-02-15',
|
||||
pantry_location_id: 1,
|
||||
notification_sent_at: null,
|
||||
updated_at: new Date().toISOString(),
|
||||
purchase_date: '2024-01-10',
|
||||
source: 'manual' as InventorySource,
|
||||
receipt_item_id: null,
|
||||
product_id: null,
|
||||
expiry_source: 'manual' as ExpirySource,
|
||||
is_consumed: false,
|
||||
consumed_at: null,
|
||||
item_name: 'Milk',
|
||||
category_name: 'Dairy',
|
||||
location_name: 'fridge',
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rowCount: 1,
|
||||
rows: [updatedRow],
|
||||
});
|
||||
|
||||
const result = await repo.updateInventoryItem(
|
||||
1,
|
||||
'user-1',
|
||||
{ is_consumed: false },
|
||||
mockLogger,
|
||||
);
|
||||
|
||||
expect(result.is_consumed).toBe(false);
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('consumed_at = NULL'),
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle notes update (skipped since column does not exist)', async () => {
|
||||
const updatedRow = {
|
||||
pantry_item_id: 1,
|
||||
user_id: 'user-1',
|
||||
master_item_id: 100,
|
||||
quantity: 1,
|
||||
unit: null,
|
||||
best_before_date: null,
|
||||
pantry_location_id: null,
|
||||
notification_sent_at: null,
|
||||
updated_at: new Date().toISOString(),
|
||||
purchase_date: null,
|
||||
source: 'manual' as InventorySource,
|
||||
receipt_item_id: null,
|
||||
product_id: null,
|
||||
expiry_source: null,
|
||||
is_consumed: false,
|
||||
consumed_at: null,
|
||||
item_name: 'Milk',
|
||||
category_name: 'Dairy',
|
||||
location_name: null,
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rowCount: 1,
|
||||
rows: [updatedRow],
|
||||
});
|
||||
|
||||
// notes field is ignored as pantry_items doesn't have notes column
|
||||
const result = await repo.updateInventoryItem(
|
||||
1,
|
||||
'user-1',
|
||||
{ notes: 'Some notes' },
|
||||
mockLogger,
|
||||
);
|
||||
|
||||
expect(result).toBeDefined();
|
||||
// Query should not include notes
|
||||
expect(mockQuery).not.toHaveBeenCalledWith(
|
||||
expect.stringContaining('notes ='),
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.updateInventoryItem(1, 'user-1', { quantity: 1 }, mockLogger),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
|
||||
it('should update with location change', async () => {
|
||||
// Location upsert query
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
@@ -423,6 +591,52 @@ describe('ExpiryRepository', () => {
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should sort by purchase_date', async () => {
|
||||
mockQuery.mockResolvedValueOnce({ rows: [{ count: '5' }] });
|
||||
mockQuery.mockResolvedValueOnce({ rows: [] });
|
||||
|
||||
await repo.getInventory({ user_id: 'user-1', sort_by: 'purchase_date' }, mockLogger);
|
||||
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('ORDER BY pi.purchase_date'),
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should sort by item_name', async () => {
|
||||
mockQuery.mockResolvedValueOnce({ rows: [{ count: '5' }] });
|
||||
mockQuery.mockResolvedValueOnce({ rows: [] });
|
||||
|
||||
await repo.getInventory({ user_id: 'user-1', sort_by: 'item_name' }, mockLogger);
|
||||
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('ORDER BY mgi.name'),
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should sort by updated_at when unknown sort_by is provided', async () => {
|
||||
mockQuery.mockResolvedValueOnce({ rows: [{ count: '5' }] });
|
||||
mockQuery.mockResolvedValueOnce({ rows: [] });
|
||||
|
||||
// Type cast to bypass type checking for testing default case
|
||||
await repo.getInventory(
|
||||
{ user_id: 'user-1', sort_by: 'unknown_field' as 'expiry_date' },
|
||||
mockLogger,
|
||||
);
|
||||
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('ORDER BY pi.updated_at'),
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getInventory({ user_id: 'user-1' }, mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getExpiringItems', () => {
|
||||
@@ -463,6 +677,12 @@ describe('ExpiryRepository', () => {
|
||||
['user-1', 7],
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getExpiringItems('user-1', 7, mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getExpiredItems', () => {
|
||||
@@ -503,6 +723,12 @@ describe('ExpiryRepository', () => {
|
||||
['user-1'],
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getExpiredItems('user-1', mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
// ============================================================================
|
||||
@@ -604,6 +830,14 @@ describe('ExpiryRepository', () => {
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.getExpiryRangeForItem('fridge', mockLogger, { masterItemId: 100 }),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('addExpiryRange', () => {
|
||||
@@ -644,6 +878,22 @@ describe('ExpiryRepository', () => {
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.addExpiryRange(
|
||||
{
|
||||
storage_location: 'fridge',
|
||||
min_days: 5,
|
||||
max_days: 10,
|
||||
typical_days: 7,
|
||||
},
|
||||
mockLogger,
|
||||
),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getExpiryRanges', () => {
|
||||
@@ -684,10 +934,52 @@ describe('ExpiryRepository', () => {
|
||||
await repo.getExpiryRanges({ storage_location: 'freezer' }, mockLogger);
|
||||
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('storage_location = $1'),
|
||||
expect.stringContaining('storage_location = $'),
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should filter by master_item_id', async () => {
|
||||
mockQuery.mockResolvedValueOnce({ rows: [{ count: '5' }] });
|
||||
mockQuery.mockResolvedValueOnce({ rows: [] });
|
||||
|
||||
await repo.getExpiryRanges({ master_item_id: 100 }, mockLogger);
|
||||
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('master_item_id = $'),
|
||||
expect.arrayContaining([100]),
|
||||
);
|
||||
});
|
||||
|
||||
it('should filter by category_id', async () => {
|
||||
mockQuery.mockResolvedValueOnce({ rows: [{ count: '8' }] });
|
||||
mockQuery.mockResolvedValueOnce({ rows: [] });
|
||||
|
||||
await repo.getExpiryRanges({ category_id: 5 }, mockLogger);
|
||||
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('category_id = $'),
|
||||
expect.arrayContaining([5]),
|
||||
);
|
||||
});
|
||||
|
||||
it('should filter by source', async () => {
|
||||
mockQuery.mockResolvedValueOnce({ rows: [{ count: '12' }] });
|
||||
mockQuery.mockResolvedValueOnce({ rows: [] });
|
||||
|
||||
await repo.getExpiryRanges({ source: 'usda' }, mockLogger);
|
||||
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('source = $'),
|
||||
expect.arrayContaining(['usda']),
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getExpiryRanges({}, mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
// ============================================================================
|
||||
@@ -728,6 +1020,12 @@ describe('ExpiryRepository', () => {
|
||||
expect(result).toHaveLength(2);
|
||||
expect(result[0].alert_method).toBe('email');
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getUserAlertSettings('user-1', mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('upsertAlertSettings', () => {
|
||||
@@ -784,6 +1082,39 @@ describe('ExpiryRepository', () => {
|
||||
expect(result.days_before_expiry).toBe(5);
|
||||
expect(result.is_enabled).toBe(false);
|
||||
});
|
||||
|
||||
it('should use default values when not provided', async () => {
|
||||
const settings = {
|
||||
alert_id: 1,
|
||||
user_id: 'user-1',
|
||||
alert_method: 'email',
|
||||
days_before_expiry: 3,
|
||||
is_enabled: true,
|
||||
last_alert_sent_at: null,
|
||||
created_at: new Date().toISOString(),
|
||||
updated_at: new Date().toISOString(),
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rows: [settings],
|
||||
});
|
||||
|
||||
// Call without providing days_before_expiry or is_enabled
|
||||
const result = await repo.upsertAlertSettings('user-1', 'email', {}, mockLogger);
|
||||
|
||||
expect(result.days_before_expiry).toBe(3); // Default value
|
||||
expect(result.is_enabled).toBe(true); // Default value
|
||||
// Verify defaults were passed to query
|
||||
expect(mockQuery).toHaveBeenCalledWith(expect.any(String), ['user-1', 'email', 3, true]);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.upsertAlertSettings('user-1', 'email', { days_before_expiry: 3 }, mockLogger),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('logAlert', () => {
|
||||
@@ -813,6 +1144,14 @@ describe('ExpiryRepository', () => {
|
||||
expect(result.alert_type).toBe('expiring_soon');
|
||||
expect(result.item_name).toBe('Milk');
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.logAlert('user-1', 'expiring_soon', 'email', 'Milk', mockLogger),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getUsersWithExpiringItems', () => {
|
||||
@@ -841,6 +1180,12 @@ describe('ExpiryRepository', () => {
|
||||
expect(result).toHaveLength(2);
|
||||
expect(mockQuery).toHaveBeenCalledWith(expect.stringContaining('ea.is_enabled = true'));
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getUsersWithExpiringItems(mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('markAlertSent', () => {
|
||||
@@ -856,6 +1201,12 @@ describe('ExpiryRepository', () => {
|
||||
['user-1', 'email'],
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.markAlertSent('user-1', 'email', mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
// ============================================================================
|
||||
@@ -920,6 +1271,14 @@ describe('ExpiryRepository', () => {
|
||||
expect(result.total).toBe(0);
|
||||
expect(result.recipes).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.getRecipesForExpiringItems('user-1', 7, 10, 0, mockLogger),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
// ============================================================================
|
||||
|
||||
@@ -261,6 +261,62 @@ describe('Flyer DB Service', () => {
|
||||
/\[URL_CHECK_FAIL\] Invalid URL format\. Image: 'https?:\/\/[^']+\/not-a-url', Icon: 'null'/,
|
||||
);
|
||||
});
|
||||
|
||||
it('should transform relative icon_url to absolute URL with leading slash', async () => {
|
||||
const flyerData: FlyerDbInsert = {
|
||||
file_name: 'test.jpg',
|
||||
image_url: 'https://example.com/images/test.jpg',
|
||||
icon_url: '/uploads/icons/test-icon.jpg', // relative path with leading slash
|
||||
checksum: 'checksum-with-relative-icon',
|
||||
store_id: 1,
|
||||
valid_from: '2024-01-01',
|
||||
valid_to: '2024-01-07',
|
||||
store_address: '123 Test St',
|
||||
status: 'processed',
|
||||
item_count: 10,
|
||||
uploaded_by: null,
|
||||
};
|
||||
const mockFlyer = createMockFlyer({ ...flyerData, flyer_id: 1 });
|
||||
mockPoolInstance.query.mockResolvedValue({ rows: [mockFlyer] });
|
||||
|
||||
await flyerRepo.insertFlyer(flyerData, mockLogger);
|
||||
|
||||
// The icon_url should have been transformed to an absolute URL
|
||||
expect(mockPoolInstance.query).toHaveBeenCalledWith(
|
||||
expect.stringContaining('INSERT INTO flyers'),
|
||||
expect.arrayContaining([
|
||||
expect.stringMatching(/^https?:\/\/.*\/uploads\/icons\/test-icon\.jpg$/),
|
||||
]),
|
||||
);
|
||||
});
|
||||
|
||||
it('should transform relative icon_url to absolute URL without leading slash', async () => {
|
||||
const flyerData: FlyerDbInsert = {
|
||||
file_name: 'test.jpg',
|
||||
image_url: 'https://example.com/images/test.jpg',
|
||||
icon_url: 'uploads/icons/test-icon.jpg', // relative path without leading slash
|
||||
checksum: 'checksum-with-relative-icon2',
|
||||
store_id: 1,
|
||||
valid_from: '2024-01-01',
|
||||
valid_to: '2024-01-07',
|
||||
store_address: '123 Test St',
|
||||
status: 'processed',
|
||||
item_count: 10,
|
||||
uploaded_by: null,
|
||||
};
|
||||
const mockFlyer = createMockFlyer({ ...flyerData, flyer_id: 1 });
|
||||
mockPoolInstance.query.mockResolvedValue({ rows: [mockFlyer] });
|
||||
|
||||
await flyerRepo.insertFlyer(flyerData, mockLogger);
|
||||
|
||||
// The icon_url should have been transformed to an absolute URL
|
||||
expect(mockPoolInstance.query).toHaveBeenCalledWith(
|
||||
expect.stringContaining('INSERT INTO flyers'),
|
||||
expect.arrayContaining([
|
||||
expect.stringMatching(/^https?:\/\/.*\/uploads\/icons\/test-icon\.jpg$/),
|
||||
]),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('insertFlyerItems', () => {
|
||||
|
||||
@@ -172,6 +172,12 @@ describe('ReceiptRepository', () => {
|
||||
|
||||
await expect(repo.getReceiptById(999, 'user-1', mockLogger)).rejects.toThrow(NotFoundError);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getReceiptById(1, 'user-1', mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getReceipts', () => {
|
||||
@@ -257,6 +263,12 @@ describe('ReceiptRepository', () => {
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getReceipts({ user_id: 'user-1' }, mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('updateReceipt', () => {
|
||||
@@ -316,6 +328,158 @@ describe('ReceiptRepository', () => {
|
||||
NotFoundError,
|
||||
);
|
||||
});
|
||||
|
||||
it('should update store_confidence field', async () => {
|
||||
const updatedRow = {
|
||||
receipt_id: 1,
|
||||
user_id: 'user-1',
|
||||
store_id: 5,
|
||||
receipt_image_url: '/uploads/receipts/receipt-1.jpg',
|
||||
transaction_date: null,
|
||||
total_amount_cents: null,
|
||||
status: 'processing',
|
||||
raw_text: null,
|
||||
store_confidence: 0.85,
|
||||
ocr_provider: null,
|
||||
error_details: null,
|
||||
retry_count: 0,
|
||||
ocr_confidence: null,
|
||||
currency: 'CAD',
|
||||
created_at: new Date().toISOString(),
|
||||
processed_at: null,
|
||||
updated_at: new Date().toISOString(),
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rowCount: 1,
|
||||
rows: [updatedRow],
|
||||
});
|
||||
|
||||
const result = await repo.updateReceipt(1, { store_confidence: 0.85 }, mockLogger);
|
||||
|
||||
expect(result.store_confidence).toBe(0.85);
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('store_confidence = $'),
|
||||
expect.arrayContaining([0.85]),
|
||||
);
|
||||
});
|
||||
|
||||
it('should update transaction_date field', async () => {
|
||||
const updatedRow = {
|
||||
receipt_id: 1,
|
||||
user_id: 'user-1',
|
||||
store_id: null,
|
||||
receipt_image_url: '/uploads/receipts/receipt-1.jpg',
|
||||
transaction_date: '2024-02-15',
|
||||
total_amount_cents: null,
|
||||
status: 'processing',
|
||||
raw_text: null,
|
||||
store_confidence: null,
|
||||
ocr_provider: null,
|
||||
error_details: null,
|
||||
retry_count: 0,
|
||||
ocr_confidence: null,
|
||||
currency: 'CAD',
|
||||
created_at: new Date().toISOString(),
|
||||
processed_at: null,
|
||||
updated_at: new Date().toISOString(),
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rowCount: 1,
|
||||
rows: [updatedRow],
|
||||
});
|
||||
|
||||
const result = await repo.updateReceipt(1, { transaction_date: '2024-02-15' }, mockLogger);
|
||||
|
||||
expect(result.transaction_date).toBe('2024-02-15');
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('transaction_date = $'),
|
||||
expect.arrayContaining(['2024-02-15']),
|
||||
);
|
||||
});
|
||||
|
||||
it('should update error_details field', async () => {
|
||||
const errorDetails = { code: 'OCR_FAILED', message: 'Image too blurry' };
|
||||
const updatedRow = {
|
||||
receipt_id: 1,
|
||||
user_id: 'user-1',
|
||||
store_id: null,
|
||||
receipt_image_url: '/uploads/receipts/receipt-1.jpg',
|
||||
transaction_date: null,
|
||||
total_amount_cents: null,
|
||||
status: 'failed',
|
||||
raw_text: null,
|
||||
store_confidence: null,
|
||||
ocr_provider: null,
|
||||
error_details: errorDetails,
|
||||
retry_count: 1,
|
||||
ocr_confidence: null,
|
||||
currency: 'CAD',
|
||||
created_at: new Date().toISOString(),
|
||||
processed_at: null,
|
||||
updated_at: new Date().toISOString(),
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rowCount: 1,
|
||||
rows: [updatedRow],
|
||||
});
|
||||
|
||||
const result = await repo.updateReceipt(
|
||||
1,
|
||||
{ status: 'failed', error_details: errorDetails },
|
||||
mockLogger,
|
||||
);
|
||||
|
||||
expect(result.error_details).toEqual(errorDetails);
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('error_details = $'),
|
||||
expect.arrayContaining([JSON.stringify(errorDetails)]),
|
||||
);
|
||||
});
|
||||
|
||||
it('should update processed_at field', async () => {
|
||||
const processedAt = '2024-01-15T12:00:00Z';
|
||||
const updatedRow = {
|
||||
receipt_id: 1,
|
||||
user_id: 'user-1',
|
||||
store_id: 5,
|
||||
receipt_image_url: '/uploads/receipts/receipt-1.jpg',
|
||||
transaction_date: '2024-01-15',
|
||||
total_amount_cents: 5499,
|
||||
status: 'completed',
|
||||
raw_text: 'Some text',
|
||||
store_confidence: 0.9,
|
||||
ocr_provider: 'gemini',
|
||||
error_details: null,
|
||||
retry_count: 0,
|
||||
ocr_confidence: 0.9,
|
||||
currency: 'CAD',
|
||||
created_at: new Date().toISOString(),
|
||||
processed_at: processedAt,
|
||||
updated_at: new Date().toISOString(),
|
||||
};
|
||||
|
||||
mockQuery.mockResolvedValueOnce({
|
||||
rowCount: 1,
|
||||
rows: [updatedRow],
|
||||
});
|
||||
|
||||
const result = await repo.updateReceipt(1, { processed_at: processedAt }, mockLogger);
|
||||
|
||||
expect(result.processed_at).toBe(processedAt);
|
||||
expect(mockQuery).toHaveBeenCalledWith(
|
||||
expect.stringContaining('processed_at = $'),
|
||||
expect.arrayContaining([processedAt]),
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.updateReceipt(1, { status: 'completed' }, mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('incrementRetryCount', () => {
|
||||
|
||||
@@ -113,6 +113,12 @@ describe('UpcRepository', () => {
|
||||
NotFoundError,
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.linkUpcToProduct(1, '012345678905', mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('recordScan', () => {
|
||||
@@ -168,6 +174,14 @@ describe('UpcRepository', () => {
|
||||
expect(result.product_id).toBeNull();
|
||||
expect(result.lookup_successful).toBe(false);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.recordScan('user-1', '012345678905', 'manual_entry', mockLogger),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getScanHistory', () => {
|
||||
@@ -246,6 +260,12 @@ describe('UpcRepository', () => {
|
||||
expect.any(Array),
|
||||
);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getScanHistory({ user_id: 'user-1' }, mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getScanById', () => {
|
||||
@@ -282,6 +302,12 @@ describe('UpcRepository', () => {
|
||||
|
||||
await expect(repo.getScanById(999, 'user-1', mockLogger)).rejects.toThrow(NotFoundError);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getScanById(1, 'user-1', mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('findExternalLookup', () => {
|
||||
@@ -322,6 +348,12 @@ describe('UpcRepository', () => {
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.findExternalLookup('012345678905', 168, mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('upsertExternalLookup', () => {
|
||||
@@ -400,6 +432,14 @@ describe('UpcRepository', () => {
|
||||
expect(result.product_name).toBe('Updated Product');
|
||||
expect(result.external_source).toBe('upcitemdb');
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.upsertExternalLookup('012345678905', 'openfoodfacts', true, mockLogger),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getExternalLookupByUpc', () => {
|
||||
@@ -442,6 +482,12 @@ describe('UpcRepository', () => {
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getExternalLookupByUpc('012345678905', mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('deleteOldExternalLookups', () => {
|
||||
@@ -465,6 +511,12 @@ describe('UpcRepository', () => {
|
||||
|
||||
expect(deleted).toBe(0);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.deleteOldExternalLookups(30, mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getUserScanStats', () => {
|
||||
@@ -489,6 +541,12 @@ describe('UpcRepository', () => {
|
||||
expect(stats.scans_today).toBe(5);
|
||||
expect(stats.scans_this_week).toBe(25);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(repo.getUserScanStats('user-1', mockLogger)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('updateScanWithDetectedCode', () => {
|
||||
@@ -514,5 +572,13 @@ describe('UpcRepository', () => {
|
||||
repo.updateScanWithDetectedCode(999, '012345678905', 0.95, mockLogger),
|
||||
).rejects.toThrow(NotFoundError);
|
||||
});
|
||||
|
||||
it('should throw on database error', async () => {
|
||||
mockQuery.mockRejectedValueOnce(new Error('DB connection failed'));
|
||||
|
||||
await expect(
|
||||
repo.updateScanWithDetectedCode(1, '012345678905', 0.95, mockLogger),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -19,7 +19,8 @@ import path from 'path';
|
||||
|
||||
const isProduction = process.env.NODE_ENV === 'production';
|
||||
const isTest = process.env.NODE_ENV === 'test';
|
||||
const isDevelopment = !isProduction && !isTest;
|
||||
const isStaging = process.env.NODE_ENV === 'staging';
|
||||
const isDevelopment = !isProduction && !isTest && !isStaging;
|
||||
|
||||
// Determine log directory based on environment
|
||||
// In production/test, use the application directory's logs folder
|
||||
|
||||
@@ -671,4 +671,531 @@ describe('upcService.server', () => {
|
||||
expect(upcRepo.getScanById).toHaveBeenCalledWith(1, 'user-1', mockLogger);
|
||||
});
|
||||
});
|
||||
|
||||
describe('lookupExternalUpc - additional coverage', () => {
|
||||
it('should use image_front_url as fallback when image_url is missing', async () => {
|
||||
mockFetch.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({
|
||||
status: 1,
|
||||
product: {
|
||||
product_name: 'Test Product',
|
||||
brands: 'Test Brand',
|
||||
image_url: null,
|
||||
image_front_url: 'https://example.com/front.jpg',
|
||||
},
|
||||
}),
|
||||
});
|
||||
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result?.image_url).toBe('https://example.com/front.jpg');
|
||||
});
|
||||
|
||||
it('should return Unknown Product when both product_name and generic_name are missing', async () => {
|
||||
mockFetch.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({
|
||||
status: 1,
|
||||
product: {
|
||||
brands: 'Test Brand',
|
||||
// No product_name or generic_name
|
||||
},
|
||||
}),
|
||||
});
|
||||
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result?.name).toBe('Unknown Product');
|
||||
});
|
||||
|
||||
it('should handle category without en: prefix', async () => {
|
||||
mockFetch.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({
|
||||
status: 1,
|
||||
product: {
|
||||
product_name: 'Test Product',
|
||||
categories_tags: ['snacks'], // No en: prefix
|
||||
},
|
||||
}),
|
||||
});
|
||||
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result?.category).toBe('snacks');
|
||||
});
|
||||
|
||||
it('should handle non-Error thrown in catch block', async () => {
|
||||
mockFetch.mockRejectedValueOnce('String error');
|
||||
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('scanUpc - additional coverage', () => {
|
||||
it('should not set external_lookup when cached lookup was unsuccessful', async () => {
|
||||
vi.mocked(upcRepo.findProductByUpc).mockResolvedValueOnce(null);
|
||||
vi.mocked(upcRepo.findExternalLookup).mockResolvedValueOnce({
|
||||
lookup_id: 1,
|
||||
upc_code: '012345678905',
|
||||
product_name: null,
|
||||
brand_name: null,
|
||||
category: null,
|
||||
description: null,
|
||||
image_url: null,
|
||||
external_source: 'unknown',
|
||||
lookup_data: null,
|
||||
lookup_successful: false,
|
||||
created_at: new Date().toISOString(),
|
||||
updated_at: new Date().toISOString(),
|
||||
});
|
||||
vi.mocked(upcRepo.recordScan).mockResolvedValueOnce({
|
||||
scan_id: 5,
|
||||
user_id: 'user-1',
|
||||
upc_code: '012345678905',
|
||||
product_id: null,
|
||||
scan_source: 'manual_entry',
|
||||
scan_confidence: 1.0,
|
||||
raw_image_path: null,
|
||||
lookup_successful: false,
|
||||
created_at: new Date().toISOString(),
|
||||
updated_at: new Date().toISOString(),
|
||||
});
|
||||
|
||||
const result = await scanUpc(
|
||||
'user-1',
|
||||
{ upc_code: '012345678905', scan_source: 'manual_entry' },
|
||||
mockLogger,
|
||||
);
|
||||
|
||||
expect(result.external_lookup).toBeNull();
|
||||
expect(result.lookup_successful).toBe(false);
|
||||
expect(mockFetch).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should cache unsuccessful external lookup result', async () => {
|
||||
vi.mocked(upcRepo.findProductByUpc).mockResolvedValueOnce(null);
|
||||
vi.mocked(upcRepo.findExternalLookup).mockResolvedValueOnce(null);
|
||||
vi.mocked(upcRepo.upsertExternalLookup).mockResolvedValueOnce(
|
||||
createMockExternalLookupRecord(),
|
||||
);
|
||||
vi.mocked(upcRepo.recordScan).mockResolvedValueOnce({
|
||||
scan_id: 6,
|
||||
user_id: 'user-1',
|
||||
upc_code: '012345678905',
|
||||
product_id: null,
|
||||
scan_source: 'manual_entry',
|
||||
scan_confidence: 1.0,
|
||||
raw_image_path: null,
|
||||
lookup_successful: false,
|
||||
created_at: new Date().toISOString(),
|
||||
updated_at: new Date().toISOString(),
|
||||
});
|
||||
|
||||
// External lookup returns nothing
|
||||
mockFetch.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
});
|
||||
|
||||
const result = await scanUpc(
|
||||
'user-1',
|
||||
{ upc_code: '012345678905', scan_source: 'manual_entry' },
|
||||
mockLogger,
|
||||
);
|
||||
|
||||
expect(result.external_lookup).toBeNull();
|
||||
expect(upcRepo.upsertExternalLookup).toHaveBeenCalledWith(
|
||||
'012345678905',
|
||||
'unknown',
|
||||
false,
|
||||
expect.anything(),
|
||||
{},
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('lookupUpc - additional coverage', () => {
|
||||
it('should cache unsuccessful external lookup and return found=false', async () => {
|
||||
vi.mocked(upcRepo.findProductByUpc).mockResolvedValueOnce(null);
|
||||
vi.mocked(upcRepo.findExternalLookup).mockResolvedValueOnce(null);
|
||||
vi.mocked(upcRepo.upsertExternalLookup).mockResolvedValueOnce(
|
||||
createMockExternalLookupRecord(),
|
||||
);
|
||||
|
||||
// External lookup returns nothing
|
||||
mockFetch.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
});
|
||||
|
||||
const result = await lookupUpc({ upc_code: '012345678905' }, mockLogger);
|
||||
|
||||
expect(result.found).toBe(false);
|
||||
expect(result.from_cache).toBe(false);
|
||||
expect(result.external_lookup).toBeNull();
|
||||
});
|
||||
|
||||
it('should use custom max_cache_age_hours', async () => {
|
||||
vi.mocked(upcRepo.findProductByUpc).mockResolvedValueOnce(null);
|
||||
vi.mocked(upcRepo.findExternalLookup).mockResolvedValueOnce(null);
|
||||
vi.mocked(upcRepo.upsertExternalLookup).mockResolvedValueOnce(
|
||||
createMockExternalLookupRecord(),
|
||||
);
|
||||
|
||||
mockFetch.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
});
|
||||
|
||||
await lookupUpc({ upc_code: '012345678905', max_cache_age_hours: 24 }, mockLogger);
|
||||
|
||||
expect(upcRepo.findExternalLookup).toHaveBeenCalledWith(
|
||||
'012345678905',
|
||||
24,
|
||||
expect.anything(),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* Tests for UPC Item DB and Barcode Lookup APIs when configured.
|
||||
* These require separate describe blocks to re-mock the config module.
|
||||
*/
|
||||
describe('upcService.server - with API keys configured', () => {
|
||||
let mockLogger: Logger;
|
||||
const mockFetch = vi.fn();
|
||||
|
||||
beforeEach(async () => {
|
||||
vi.clearAllMocks();
|
||||
vi.resetModules();
|
||||
global.fetch = mockFetch;
|
||||
mockFetch.mockReset();
|
||||
|
||||
// Re-mock with API keys configured
|
||||
vi.doMock('../config/env', () => ({
|
||||
config: {
|
||||
upc: {
|
||||
upcItemDbApiKey: 'test-upcitemdb-key',
|
||||
barcodeLookupApiKey: 'test-barcodelookup-key',
|
||||
},
|
||||
},
|
||||
isUpcItemDbConfigured: true,
|
||||
isBarcodeLookupConfigured: true,
|
||||
}));
|
||||
|
||||
vi.doMock('./db/index.db', () => ({
|
||||
upcRepo: {
|
||||
recordScan: vi.fn(),
|
||||
findProductByUpc: vi.fn(),
|
||||
findExternalLookup: vi.fn(),
|
||||
upsertExternalLookup: vi.fn(),
|
||||
linkUpcToProduct: vi.fn(),
|
||||
getScanHistory: vi.fn(),
|
||||
getUserScanStats: vi.fn(),
|
||||
getScanById: vi.fn(),
|
||||
},
|
||||
}));
|
||||
|
||||
mockLogger = createMockLogger();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.resetAllMocks();
|
||||
});
|
||||
|
||||
describe('lookupExternalUpc with UPC Item DB', () => {
|
||||
it('should return product from UPC Item DB when Open Food Facts has no result', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns product
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({
|
||||
code: 'OK',
|
||||
items: [
|
||||
{
|
||||
title: 'UPC Item DB Product',
|
||||
brand: 'UPC Brand',
|
||||
category: 'Electronics',
|
||||
description: 'A test product',
|
||||
images: ['https://example.com/upcitemdb.jpg'],
|
||||
},
|
||||
],
|
||||
}),
|
||||
});
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).not.toBeNull();
|
||||
expect(result?.name).toBe('UPC Item DB Product');
|
||||
expect(result?.brand).toBe('UPC Brand');
|
||||
expect(result?.source).toBe('upcitemdb');
|
||||
});
|
||||
|
||||
it('should handle UPC Item DB rate limit (429)', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB rate limit
|
||||
.mockResolvedValueOnce({
|
||||
ok: false,
|
||||
status: 429,
|
||||
})
|
||||
// Barcode Lookup also returns nothing
|
||||
.mockResolvedValueOnce({
|
||||
ok: false,
|
||||
status: 404,
|
||||
});
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).toBeNull();
|
||||
expect(mockLogger.warn).toHaveBeenCalledWith(
|
||||
{ upcCode: '012345678905' },
|
||||
'UPC Item DB rate limit exceeded',
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle UPC Item DB network error', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB network error
|
||||
.mockRejectedValueOnce(new Error('Network error'))
|
||||
// Barcode Lookup also errors
|
||||
.mockRejectedValueOnce(new Error('Network error'));
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle UPC Item DB empty items array', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns empty items
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ code: 'OK', items: [] }),
|
||||
})
|
||||
// Barcode Lookup also returns nothing
|
||||
.mockResolvedValueOnce({
|
||||
ok: false,
|
||||
status: 404,
|
||||
});
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should return Unknown Product when UPC Item DB item has no title', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns item without title
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({
|
||||
code: 'OK',
|
||||
items: [{ brand: 'Some Brand' }],
|
||||
}),
|
||||
});
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result?.name).toBe('Unknown Product');
|
||||
expect(result?.source).toBe('upcitemdb');
|
||||
});
|
||||
});
|
||||
|
||||
describe('lookupExternalUpc with Barcode Lookup', () => {
|
||||
it('should return product from Barcode Lookup when other APIs have no result', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns nothing
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ code: 'OK', items: [] }),
|
||||
})
|
||||
// Barcode Lookup returns product
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({
|
||||
products: [
|
||||
{
|
||||
title: 'Barcode Lookup Product',
|
||||
brand: 'BL Brand',
|
||||
category: 'Food',
|
||||
description: 'A barcode lookup product',
|
||||
images: ['https://example.com/barcodelookup.jpg'],
|
||||
},
|
||||
],
|
||||
}),
|
||||
});
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).not.toBeNull();
|
||||
expect(result?.name).toBe('Barcode Lookup Product');
|
||||
expect(result?.source).toBe('barcodelookup');
|
||||
});
|
||||
|
||||
it('should handle Barcode Lookup rate limit (429)', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns nothing
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ code: 'OK', items: [] }),
|
||||
})
|
||||
// Barcode Lookup rate limit
|
||||
.mockResolvedValueOnce({
|
||||
ok: false,
|
||||
status: 429,
|
||||
});
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).toBeNull();
|
||||
expect(mockLogger.warn).toHaveBeenCalledWith(
|
||||
{ upcCode: '012345678905' },
|
||||
'Barcode Lookup rate limit exceeded',
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle Barcode Lookup 404 response', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns nothing
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ code: 'OK', items: [] }),
|
||||
})
|
||||
// Barcode Lookup 404
|
||||
.mockResolvedValueOnce({
|
||||
ok: false,
|
||||
status: 404,
|
||||
});
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should use product_name fallback when title is missing in Barcode Lookup', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns nothing
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ code: 'OK', items: [] }),
|
||||
})
|
||||
// Barcode Lookup with product_name instead of title
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({
|
||||
products: [
|
||||
{
|
||||
product_name: 'Product Name Fallback',
|
||||
brand: 'BL Brand',
|
||||
},
|
||||
],
|
||||
}),
|
||||
});
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result?.name).toBe('Product Name Fallback');
|
||||
});
|
||||
|
||||
it('should handle Barcode Lookup network error', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns nothing
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ code: 'OK', items: [] }),
|
||||
})
|
||||
// Barcode Lookup network error
|
||||
.mockRejectedValueOnce(new Error('Network error'));
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle non-Error thrown in Barcode Lookup', async () => {
|
||||
// Open Food Facts returns nothing
|
||||
mockFetch
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ status: 0, product: null }),
|
||||
})
|
||||
// UPC Item DB returns nothing
|
||||
.mockResolvedValueOnce({
|
||||
ok: true,
|
||||
json: async () => ({ code: 'OK', items: [] }),
|
||||
})
|
||||
// Barcode Lookup throws non-Error
|
||||
.mockRejectedValueOnce('String error thrown');
|
||||
|
||||
const { lookupExternalUpc } = await import('./upcService.server');
|
||||
const result = await lookupExternalUpc('012345678905', mockLogger);
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -276,8 +276,8 @@ describe('E2E Inventory/Expiry Management Journey', () => {
|
||||
|
||||
expect(detailResponse.status).toBe(200);
|
||||
const detailData = await detailResponse.json();
|
||||
expect(detailData.data.item.item_name).toBe('Milk');
|
||||
expect(detailData.data.item.quantity).toBe(2);
|
||||
expect(detailData.data.item_name).toBe('E2E Milk');
|
||||
expect(detailData.data.quantity).toBe(2);
|
||||
|
||||
// Step 9: Update item quantity and location
|
||||
const updateResponse = await authedFetch(`/inventory/${milkId}`, {
|
||||
@@ -344,7 +344,7 @@ describe('E2E Inventory/Expiry Management Journey', () => {
|
||||
|
||||
expect(suggestionsResponse.status).toBe(200);
|
||||
const suggestionsData = await suggestionsResponse.json();
|
||||
expect(Array.isArray(suggestionsData.data.suggestions)).toBe(true);
|
||||
expect(Array.isArray(suggestionsData.data.recipes)).toBe(true);
|
||||
|
||||
// Step 14: Fully consume an item (marks as consumed, returns 204)
|
||||
const breadId = createdInventoryIds[2];
|
||||
@@ -362,7 +362,7 @@ describe('E2E Inventory/Expiry Management Journey', () => {
|
||||
});
|
||||
expect(consumedItemResponse.status).toBe(200);
|
||||
const consumedItemData = await consumedItemResponse.json();
|
||||
expect(consumedItemData.data.item.is_consumed).toBe(true);
|
||||
expect(consumedItemData.data.is_consumed).toBe(true);
|
||||
|
||||
// Step 15: Delete an item
|
||||
const riceId = createdInventoryIds[4];
|
||||
|
||||
@@ -258,25 +258,9 @@ describe('E2E Receipt Processing Journey', () => {
|
||||
// Should have at least the items we added
|
||||
expect(inventoryData.data.items.length).toBeGreaterThanOrEqual(0);
|
||||
|
||||
// Step 11: Add processing logs (simulating backend activity)
|
||||
await pool.query(
|
||||
`INSERT INTO public.receipt_processing_logs (receipt_id, step, status, message)
|
||||
VALUES
|
||||
($1, 'ocr', 'completed', 'OCR completed successfully'),
|
||||
($1, 'item_extraction', 'completed', 'Extracted 3 items'),
|
||||
($1, 'matching', 'completed', 'Matched 2 items')`,
|
||||
[receiptId],
|
||||
);
|
||||
|
||||
// Step 12: View processing logs
|
||||
const logsResponse = await authedFetch(`/receipts/${receiptId}/logs`, {
|
||||
method: 'GET',
|
||||
token: authToken,
|
||||
});
|
||||
|
||||
expect(logsResponse.status).toBe(200);
|
||||
const logsData = await logsResponse.json();
|
||||
expect(logsData.data.logs.length).toBe(3);
|
||||
// Step 11-12: Processing logs tests skipped - receipt_processing_logs table not implemented
|
||||
// TODO: Add these steps back when the receipt_processing_logs table is added to the schema
|
||||
// See: The route /receipts/:receiptId/logs exists but the backing table does not
|
||||
|
||||
// Step 13: Verify another user cannot access our receipt
|
||||
const otherUserEmail = `other-receipt-e2e-${uniqueId}@example.com`;
|
||||
|
||||
@@ -126,8 +126,8 @@ describe('E2E UPC Scanning Journey', () => {
|
||||
expect(scanResponse.status).toBe(200);
|
||||
const scanData = await scanResponse.json();
|
||||
expect(scanData.success).toBe(true);
|
||||
expect(scanData.data.scan.upc_code).toBe(testUpc);
|
||||
const scanId = scanData.data.scan.scan_id;
|
||||
expect(scanData.data.upc_code).toBe(testUpc);
|
||||
const scanId = scanData.data.scan_id;
|
||||
createdScanIds.push(scanId);
|
||||
|
||||
// Step 5: Lookup the product by UPC
|
||||
@@ -155,8 +155,8 @@ describe('E2E UPC Scanning Journey', () => {
|
||||
|
||||
if (additionalScan.ok) {
|
||||
const additionalData = await additionalScan.json();
|
||||
if (additionalData.data?.scan?.scan_id) {
|
||||
createdScanIds.push(additionalData.data.scan.scan_id);
|
||||
if (additionalData.data?.scan_id) {
|
||||
createdScanIds.push(additionalData.data.scan_id);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -181,8 +181,8 @@ describe('E2E UPC Scanning Journey', () => {
|
||||
|
||||
expect(scanDetailResponse.status).toBe(200);
|
||||
const scanDetailData = await scanDetailResponse.json();
|
||||
expect(scanDetailData.data.scan.scan_id).toBe(scanId);
|
||||
expect(scanDetailData.data.scan.upc_code).toBe(testUpc);
|
||||
expect(scanDetailData.data.scan_id).toBe(scanId);
|
||||
expect(scanDetailData.data.upc_code).toBe(testUpc);
|
||||
|
||||
// Step 9: Check user scan statistics
|
||||
const statsResponse = await authedFetch('/upc/stats', {
|
||||
@@ -193,7 +193,7 @@ describe('E2E UPC Scanning Journey', () => {
|
||||
expect(statsResponse.status).toBe(200);
|
||||
const statsData = await statsResponse.json();
|
||||
expect(statsData.success).toBe(true);
|
||||
expect(statsData.data.stats.total_scans).toBeGreaterThanOrEqual(4);
|
||||
expect(statsData.data.total_scans).toBeGreaterThanOrEqual(4);
|
||||
|
||||
// Step 10: Test history filtering by scan_source
|
||||
const filteredHistoryResponse = await authedFetch('/upc/history?scan_source=manual_entry', {
|
||||
|
||||
469
src/utils/apiResponse.test.ts
Normal file
469
src/utils/apiResponse.test.ts
Normal file
@@ -0,0 +1,469 @@
|
||||
// src/utils/apiResponse.test.ts
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
||||
import type { Response } from 'express';
|
||||
import {
|
||||
sendSuccess,
|
||||
sendNoContent,
|
||||
calculatePagination,
|
||||
sendPaginated,
|
||||
sendError,
|
||||
sendMessage,
|
||||
ErrorCode,
|
||||
} from './apiResponse';
|
||||
|
||||
// Create a mock Express response
|
||||
function createMockResponse(): Response {
|
||||
const res = {
|
||||
status: vi.fn().mockReturnThis(),
|
||||
json: vi.fn().mockReturnThis(),
|
||||
send: vi.fn().mockReturnThis(),
|
||||
} as unknown as Response;
|
||||
return res;
|
||||
}
|
||||
|
||||
describe('apiResponse utilities', () => {
|
||||
let mockRes: Response;
|
||||
|
||||
beforeEach(() => {
|
||||
mockRes = createMockResponse();
|
||||
});
|
||||
|
||||
describe('sendSuccess', () => {
|
||||
it('should send success response with data and default status 200', () => {
|
||||
const data = { id: 1, name: 'Test' };
|
||||
|
||||
sendSuccess(mockRes, data);
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(200);
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data,
|
||||
});
|
||||
});
|
||||
|
||||
it('should send success response with custom status code', () => {
|
||||
const data = { id: 1 };
|
||||
|
||||
sendSuccess(mockRes, data, 201);
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(201);
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data,
|
||||
});
|
||||
});
|
||||
|
||||
it('should include meta when provided', () => {
|
||||
const data = { id: 1 };
|
||||
const meta = { requestId: 'req-123', timestamp: '2024-01-15T12:00:00Z' };
|
||||
|
||||
sendSuccess(mockRes, data, 200, meta);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data,
|
||||
meta,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle null data', () => {
|
||||
sendSuccess(mockRes, null);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data: null,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle array data', () => {
|
||||
const data = [{ id: 1 }, { id: 2 }];
|
||||
|
||||
sendSuccess(mockRes, data);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle empty object data', () => {
|
||||
sendSuccess(mockRes, {});
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data: {},
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('sendNoContent', () => {
|
||||
it('should send 204 status with no body', () => {
|
||||
sendNoContent(mockRes);
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(204);
|
||||
expect(mockRes.send).toHaveBeenCalledWith();
|
||||
});
|
||||
});
|
||||
|
||||
describe('calculatePagination', () => {
|
||||
it('should calculate pagination for first page', () => {
|
||||
const result = calculatePagination({ page: 1, limit: 10, total: 100 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 1,
|
||||
limit: 10,
|
||||
total: 100,
|
||||
totalPages: 10,
|
||||
hasNextPage: true,
|
||||
hasPrevPage: false,
|
||||
});
|
||||
});
|
||||
|
||||
it('should calculate pagination for middle page', () => {
|
||||
const result = calculatePagination({ page: 5, limit: 10, total: 100 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 5,
|
||||
limit: 10,
|
||||
total: 100,
|
||||
totalPages: 10,
|
||||
hasNextPage: true,
|
||||
hasPrevPage: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('should calculate pagination for last page', () => {
|
||||
const result = calculatePagination({ page: 10, limit: 10, total: 100 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 10,
|
||||
limit: 10,
|
||||
total: 100,
|
||||
totalPages: 10,
|
||||
hasNextPage: false,
|
||||
hasPrevPage: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle single page result', () => {
|
||||
const result = calculatePagination({ page: 1, limit: 10, total: 5 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 1,
|
||||
limit: 10,
|
||||
total: 5,
|
||||
totalPages: 1,
|
||||
hasNextPage: false,
|
||||
hasPrevPage: false,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle empty results', () => {
|
||||
const result = calculatePagination({ page: 1, limit: 10, total: 0 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 1,
|
||||
limit: 10,
|
||||
total: 0,
|
||||
totalPages: 0,
|
||||
hasNextPage: false,
|
||||
hasPrevPage: false,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle non-even page boundaries', () => {
|
||||
const result = calculatePagination({ page: 1, limit: 10, total: 25 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 1,
|
||||
limit: 10,
|
||||
total: 25,
|
||||
totalPages: 3, // ceil(25/10) = 3
|
||||
hasNextPage: true,
|
||||
hasPrevPage: false,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle page 2 of 3 with non-even total', () => {
|
||||
const result = calculatePagination({ page: 2, limit: 10, total: 25 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 2,
|
||||
limit: 10,
|
||||
total: 25,
|
||||
totalPages: 3,
|
||||
hasNextPage: true,
|
||||
hasPrevPage: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle last page with non-even total', () => {
|
||||
const result = calculatePagination({ page: 3, limit: 10, total: 25 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 3,
|
||||
limit: 10,
|
||||
total: 25,
|
||||
totalPages: 3,
|
||||
hasNextPage: false,
|
||||
hasPrevPage: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle limit of 1', () => {
|
||||
const result = calculatePagination({ page: 5, limit: 1, total: 10 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 5,
|
||||
limit: 1,
|
||||
total: 10,
|
||||
totalPages: 10,
|
||||
hasNextPage: true,
|
||||
hasPrevPage: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle large limit with small total', () => {
|
||||
const result = calculatePagination({ page: 1, limit: 100, total: 5 });
|
||||
|
||||
expect(result).toEqual({
|
||||
page: 1,
|
||||
limit: 100,
|
||||
total: 5,
|
||||
totalPages: 1,
|
||||
hasNextPage: false,
|
||||
hasPrevPage: false,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('sendPaginated', () => {
|
||||
it('should send paginated response with data and pagination meta', () => {
|
||||
const data = [{ id: 1 }, { id: 2 }];
|
||||
const pagination = { page: 1, limit: 10, total: 100 };
|
||||
|
||||
sendPaginated(mockRes, data, pagination);
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(200);
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data,
|
||||
meta: {
|
||||
pagination: {
|
||||
page: 1,
|
||||
limit: 10,
|
||||
total: 100,
|
||||
totalPages: 10,
|
||||
hasNextPage: true,
|
||||
hasPrevPage: false,
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('should include additional meta when provided', () => {
|
||||
const data = [{ id: 1 }];
|
||||
const pagination = { page: 1, limit: 10, total: 1 };
|
||||
const meta = { requestId: 'req-456' };
|
||||
|
||||
sendPaginated(mockRes, data, pagination, meta);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data,
|
||||
meta: {
|
||||
requestId: 'req-456',
|
||||
pagination: {
|
||||
page: 1,
|
||||
limit: 10,
|
||||
total: 1,
|
||||
totalPages: 1,
|
||||
hasNextPage: false,
|
||||
hasPrevPage: false,
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle empty array data', () => {
|
||||
const data: unknown[] = [];
|
||||
const pagination = { page: 1, limit: 10, total: 0 };
|
||||
|
||||
sendPaginated(mockRes, data, pagination);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data: [],
|
||||
meta: {
|
||||
pagination: {
|
||||
page: 1,
|
||||
limit: 10,
|
||||
total: 0,
|
||||
totalPages: 0,
|
||||
hasNextPage: false,
|
||||
hasPrevPage: false,
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('should always return status 200', () => {
|
||||
const data = [{ id: 1 }];
|
||||
const pagination = { page: 1, limit: 10, total: 1 };
|
||||
|
||||
sendPaginated(mockRes, data, pagination);
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(200);
|
||||
});
|
||||
});
|
||||
|
||||
describe('sendError', () => {
|
||||
it('should send error response with code and message', () => {
|
||||
sendError(mockRes, ErrorCode.VALIDATION_ERROR, 'Invalid input');
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(400);
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: false,
|
||||
error: {
|
||||
code: ErrorCode.VALIDATION_ERROR,
|
||||
message: 'Invalid input',
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('should send error with custom status code', () => {
|
||||
sendError(mockRes, ErrorCode.NOT_FOUND, 'Resource not found', 404);
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(404);
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: false,
|
||||
error: {
|
||||
code: ErrorCode.NOT_FOUND,
|
||||
message: 'Resource not found',
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('should include details when provided', () => {
|
||||
const details = [
|
||||
{ field: 'email', message: 'Invalid email format' },
|
||||
{ field: 'password', message: 'Password too short' },
|
||||
];
|
||||
|
||||
sendError(mockRes, ErrorCode.VALIDATION_ERROR, 'Validation failed', 400, details);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: false,
|
||||
error: {
|
||||
code: ErrorCode.VALIDATION_ERROR,
|
||||
message: 'Validation failed',
|
||||
details,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('should include meta when provided', () => {
|
||||
const meta = { requestId: 'req-789', timestamp: '2024-01-15T12:00:00Z' };
|
||||
|
||||
sendError(mockRes, ErrorCode.INTERNAL_ERROR, 'Server error', 500, undefined, meta);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: false,
|
||||
error: {
|
||||
code: ErrorCode.INTERNAL_ERROR,
|
||||
message: 'Server error',
|
||||
},
|
||||
meta,
|
||||
});
|
||||
});
|
||||
|
||||
it('should include both details and meta when provided', () => {
|
||||
const details = { originalError: 'Database connection failed' };
|
||||
const meta = { requestId: 'req-000' };
|
||||
|
||||
sendError(mockRes, ErrorCode.INTERNAL_ERROR, 'Database error', 500, details, meta);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: false,
|
||||
error: {
|
||||
code: ErrorCode.INTERNAL_ERROR,
|
||||
message: 'Database error',
|
||||
details,
|
||||
},
|
||||
meta,
|
||||
});
|
||||
});
|
||||
|
||||
it('should accept string error codes', () => {
|
||||
sendError(mockRes, 'CUSTOM_ERROR', 'Custom error message', 400);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: false,
|
||||
error: {
|
||||
code: 'CUSTOM_ERROR',
|
||||
message: 'Custom error message',
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('should use default status 400 when not specified', () => {
|
||||
sendError(mockRes, ErrorCode.VALIDATION_ERROR, 'Error');
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(400);
|
||||
});
|
||||
|
||||
it('should handle null details (not undefined)', () => {
|
||||
// null should be included as details, unlike undefined
|
||||
sendError(mockRes, ErrorCode.VALIDATION_ERROR, 'Error', 400, null);
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: false,
|
||||
error: {
|
||||
code: ErrorCode.VALIDATION_ERROR,
|
||||
message: 'Error',
|
||||
details: null,
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('sendMessage', () => {
|
||||
it('should send success response with message', () => {
|
||||
sendMessage(mockRes, 'Operation completed successfully');
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(200);
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data: { message: 'Operation completed successfully' },
|
||||
});
|
||||
});
|
||||
|
||||
it('should send message with custom status code', () => {
|
||||
sendMessage(mockRes, 'Resource created', 201);
|
||||
|
||||
expect(mockRes.status).toHaveBeenCalledWith(201);
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data: { message: 'Resource created' },
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle empty message', () => {
|
||||
sendMessage(mockRes, '');
|
||||
|
||||
expect(mockRes.json).toHaveBeenCalledWith({
|
||||
success: true,
|
||||
data: { message: '' },
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('ErrorCode re-export', () => {
|
||||
it('should export ErrorCode enum', () => {
|
||||
expect(ErrorCode).toBeDefined();
|
||||
expect(ErrorCode.VALIDATION_ERROR).toBeDefined();
|
||||
expect(ErrorCode.NOT_FOUND).toBeDefined();
|
||||
expect(ErrorCode.INTERNAL_ERROR).toBeDefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -15,9 +15,9 @@ export function getBaseUrl(logger: Logger): string {
|
||||
let baseUrl = (process.env.FRONTEND_URL || process.env.BASE_URL || '').trim();
|
||||
if (!baseUrl || !baseUrl.startsWith('http')) {
|
||||
const port = process.env.PORT || 3000;
|
||||
// In test/development, use http://localhost. In production, this should never be reached.
|
||||
// In test/staging/development, use http://localhost. In production, this should never be reached.
|
||||
const fallbackUrl =
|
||||
process.env.NODE_ENV === 'test'
|
||||
process.env.NODE_ENV === 'test' || process.env.NODE_ENV === 'staging'
|
||||
? `http://localhost:${port}`
|
||||
: `http://example.com:${port}`;
|
||||
if (baseUrl) {
|
||||
@@ -39,4 +39,4 @@ export function getBaseUrl(logger: Logger): string {
|
||||
}
|
||||
|
||||
return finalUrl;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user