Fully test getPageIdFromPersistentId

[JeroenDeDauw]

Follow up to #64

@alistair3149 Writing good tests after the fact is more difficult than if you follow the red-green-refactor cycle. You never had the red step for this test, because I could remove the WHERE clause from the query, and it would still pass. To know a test actually does what you want, you need to see it fail first. It's easy to miss testing parts of the production code or to fail to test it altogether due to a mistake in the test.

Summary by CodeRabbit

• Tests
  • Improved test coverage by saving multiple persistent IDs before querying.
  • Enhanced test clarity with more descriptive test names.
  • Updated assertions to better verify correct behavior for known and unknown persistent IDs.

[coderabbitai]

📝 Walkthrough

Walkthrough

Two test methods in the DatabasePersistentPageIdentifiersRepoTest class were renamed for clarity, and their implementations were updated. The revised tests now set up multiple persistent IDs for specific page IDs, and assertions explicitly check for correct matches and null returns when querying known and unknown persistent IDs, respectively.

Changes

Files	Change Summary
tests/Adapters/DatabasePersistentPageIdentifiersRepoTest.php	Renamed two test methods for clarity; updated test setups to save multiple persistent IDs and improved assertions.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb06ee0 and 3c709b4.

📒 Files selected for processing (1)

• tests/Adapters/DatabasePersistentPageIdentifiersRepoTest.php (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

tests/Adapters/DatabasePersistentPageIdentifiersRepoTest.php (3)

src/Application/PersistentPageIdentifiersRepo.php (2)

• savePersistentIds (12-12)
• getPageIdFromPersistentId (22-22)

src/Adapters/DatabasePersistentPageIdentifiersRepo.php (2)

• savePersistentIds (18-26)
• getPageIdFromPersistentId (62-70)

tests/TestDoubles/InMemoryPersistentPageIdentifiersRepo.php (2)

• savePersistentIds (13-15)
• getPageIdFromPersistentId (25-28)

🔇 Additional comments (2)

tests/Adapters/DatabasePersistentPageIdentifiersRepoTest.php (2)

105-116: Excellent improvement to the test methodology

The renamed test is much clearer about its intent (testing that the correct page ID is returned when querying by persistent ID). By setting up multiple persistent IDs and explicitly asserting that the correct page ID is retrieved, this test properly validates the WHERE clause functionality in the database query. This addresses the issue mentioned in the PR description where removing the WHERE clause wouldn't have been caught by the previous test implementation.

---

118-124: Good enhancement to the null case testing

This revised test is more robust than its predecessor. By first ensuring there is data in the database (the persistent ID for page 42) and then testing for a different, unknown persistent ID, the test properly validates that the database query's WHERE clause is correctly filtering results. The new name is also more descriptive of the test's purpose.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.