Clarify join requirement

[malberts]

Follow-up to #64 (comment)

The join is necessary to avoid returning persistent IDs for deleted pages (e.g. via REST API).

For reference, the corresponding test:

PersistentPageIdentifiers/tests/Adapters/DatabasePersistentPageIdentifiersRepoTest.php

Lines 65 to 75 in 0053bb0

	public function testGetPersistentIdsReturnsNothingForDeletedPage(): void {
	$page = $this->createPageWithText();
	$this->repo->savePersistentIds( [
	$page->getId() => '00000000-0000-0000-0000-000000000042'
	] );
	$this->deletePage( $page );
	$this->assertSame( [], $this->repo->getPersistentIds( [ $page->getId() ] ) );
	}

Summary by CodeRabbit

• Documentation
  • Added a clarifying comment to explain the purpose of a database join, improving code readability for future maintenance.

[coderabbitai]

📝 Walkthrough

Walkthrough

A clarifying comment was added above a left join statement in the getPersistentIds method of the database repository class. The comment explains the purpose of the join, specifically regarding the exclusion of deleted pages. No functional or structural code changes were made.

Changes

File(s)	Change Summary
src/Adapters/DatabasePersistentPageIdentifiersRepo.php	Added a comment above a left join in getPersistentIds to clarify its intent regarding deleted pages.

Suggested reviewers

• alistair3149

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 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 0053bb0 and 39aab32.

📒 Files selected for processing (1)

• src/Adapters/DatabasePersistentPageIdentifiersRepo.php (1 hunks)

🔇 Additional comments (1)

src/Adapters/DatabasePersistentPageIdentifiersRepo.php (1)

40-40: Good clarification: comment improves join intent visibility.
The added comment succinctly explains why a LEFT JOIN is used here—to omit rows in persistent_page_ids for pages that no longer exist—enhancing code readability and maintainability.

✨ 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.

[JeroenDeDauw]

Is this the better behavior? And if it is, what about the newly added method? Should we re-add the join there?

[malberts]

There is one use case I can think of where returning deleted IDs might be useful: if you only know the persistent ID and you want to undelete the page. Not sure if there's anything else somebody might want to do with a deleted page ID.

The join is not strictly necessary in the new code, because it does an implicit page existence check (via Title::newFromID()) before redirecting.

However, if we decide that the "get deleted ID to undelete" use case is necessary, then the new special page should probably also redirect to the deleted page.