Skip to content

docs: add Redis testing guide and update documentation references#249

Merged
mikewheeleer merged 2 commits into
Talenttrust:mainfrom
oyinade247:Add-developer-documentation-for-local-Redis-vs-mocked-Redis-behavior-in-tests
Apr 28, 2026
Merged

docs: add Redis testing guide and update documentation references#249
mikewheeleer merged 2 commits into
Talenttrust:mainfrom
oyinade247:Add-developer-documentation-for-local-Redis-vs-mocked-Redis-behavior-in-tests

Conversation

@oyinade247
Copy link
Copy Markdown
Contributor

closes #187

PR Description: Document Redis Testing Patterns

Description

This PR adds comprehensive documentation for Redis usage and testing patterns in the TalentTrust Backend. It clarifies the hybrid testing approach where Redis is mocked by default but utilized in CI and for specific integration tests.

Changes

  • New Guide: Created docs/backend/redis-testing-guide.md covering:
    • Global mocking strategy in src/test-setup.ts.
    • Scenarios where real Redis is required (Health probes, manual integration).
    • CI/CD service container configuration.
    • Local reproduction steps using Docker and the CI=true flag.
  • Queue System Docs: Updated docs/backend/queue-system.md to link to the new guide.
  • README: Added discoverability link for the Redis Testing Guide.

Motivation

Previously, the distinction between mocked Redis and real Redis requirements was not explicitly documented, making it difficult for new contributors to understand why certain tests were being ignored locally or how to debug queue-related issues.

Testing Steps

  1. Verify the new file docs/backend/redis-testing-guide.md exists and is correctly formatted.
  2. Verify links from README.md and docs/backend/queue-system.md are functional.
  3. (Optional) Run CI=true npx jest src/queue/queue-manager.test.ts with a local Redis instance to verify the local reproduction instructions.

Checklist

  • Documentation updated
  • Links verified
  • Local reproduction steps validated against jest.config.js logic

@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented Apr 27, 2026

@oyinade247 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@mikewheeleer mikewheeleer merged commit 341d76f into Talenttrust:main Apr 28, 2026
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Backend: Add developer documentation for local Redis vs mocked Redis behavior in tests

2 participants