docs: add Redis testing guide and update documentation references#249
Merged
Conversation
|
@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! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
docs/backend/redis-testing-guide.mdcovering:src/test-setup.ts.CI=trueflag.docs/backend/queue-system.mdto link to the new 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
docs/backend/redis-testing-guide.mdexists and is correctly formatted.README.mdanddocs/backend/queue-system.mdare functional.CI=true npx jest src/queue/queue-manager.test.tswith a local Redis instance to verify the local reproduction instructions.Checklist
jest.config.jslogic