bckelley/cgm-remote-monitor
1
0
Fork 0
mirror of https://github.com/bckelley/cgm-remote-monitor.git synced 2026-08-24 03:14:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: add test environment variables section to CONTRIBUTING.md

Browse Source 
Document MongoDB pool settings and AUTH_FAIL_DELAY for test tuning.
Useful for CI or resource-constrained environments.

Refs: DOC-ENV-002

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Ben West
2026-03-17 13:42:59 -07:00
co-authored by Copilot
parent f37f44e8c8
commit 551f6dfac6
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+18
View File
@@ -166,6 +166,24 @@ You can create a `my.test.env` file based on `ci.test.env` for local testing:
source my.test.env && npm test
```
### Test Environment Variables
These variables control test behavior and MongoDB connection pooling:
| Variable | Purpose | Default |
|----------|---------|---------|
| `NODE_ENV=test` | **Required** - Enables test mode, prevents production DB access | - |
| `MONGO_POOL_SIZE` | MongoDB connection pool size | 10 |
| `MONGO_MIN_POOL_SIZE` | Minimum pool connections to keep open | 1 |
| `MONGO_MAX_IDLE_TIME_MS` | Max idle time (ms) before closing connection | 10000 |
| `AUTH_FAIL_DELAY` | Delay (ms) after auth failure (test speedup) | 5000 |
For CI or resource-constrained environments, reduce pool size:
```bash
MONGO_POOL_SIZE=5 MONGO_MIN_POOL_SIZE=1 npm test
```
## Other Dev Tips
* Join the [Discord chat][discord-url].