fix: do not trigger site.changed when draft posts are deleted

[im-adithya]

Fixes #21699

Description

This adds a check to see if all of the posts being deleted are drafted, and only sets cacheInvalidate if not (since site.changed is triggered because of X-Cache-Invalidate header)

Checklist

• There's a clear use-case for this code change, explained below
• Commit message has a short title & references relevant issues
• The build will pass (run yarn test:all and yarn lint)

[coderabbitai]

Walkthrough

The update modifies the bulkDestroy and destroy methods in the posts endpoint. Both methods now ensure that the X-Cache-Invalidate header defaults to false. In the bulkDestroy method, an asynchronous query fetches posts matching a given filter with status 'all', and it checks whether all posts are drafts. If any post is not a draft, the header is set to "/". Similarly, in the destroy method, an asynchronous query retrieves a post by ID and, upon determining that the post is not a draft, sets the header to "/". Overall, the changes adjust cache invalidation behavior based on post status so that deleting drafts does not trigger unintended actions.

Assessment against linked issues

Objective	Addressed	Explanation
Deleting draft posts should not trigger the site.changed webhook (#21699)	✅

Suggested labels

browser-tests

---

📜 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 3740bc0 and 5233f32.

📒 Files selected for processing (1)

• ghost/core/test/e2e-webhooks/site.test.js (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• ghost/core/test/e2e-webhooks/site.test.js

---

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

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[im-adithya]

@ErisDS can you please have a look :)

[ErisDS]

Hey there @im-adithya, I see you've made quite a few PRs with bugfixes, really appreciate the effort 🙏

We have a working practice of always adding a unit test to demonstrate a bug fix, otherwise it's liable to either not be fixed properly, or regress again. How do you feel about adding tests to your changes?

Cheers!

[github-actions]

Note from our bot: Some changes have been requested on this pull request. Updating your code is great, but won't notify us, so please leave a comment so that we (and our bot) can see when you've made the changes. Thank you 🙏

[im-adithya]

Hey Hannah! Thanks for noticing, would be more than happy to have them reviewed :)

Absolutely, I added the test now. The test files (atleast the ones in e2e-webhooks) only had the checks for single addition/deletion, so I only checked deletion of a single draft post. Let me know if I should add for bulk deletion too!

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

ghost/core/test/e2e-webhooks/site.test.js (1)

157-157: Minor inconsistency in variable naming.

The variable name requestWasReceived uses a different spelling compared to requestWasRecieved on line 81. Consider standardizing the spelling across all tests for better code consistency.

-        const requestWasReceived = await Promise.race([
+        const requestWasRecieved = await Promise.race([

Though I personally recommend fixing the other occurrence to use the correct spelling "received" instead.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 21c0ef9 and 3740bc0.

📒 Files selected for processing (1)

• ghost/core/test/e2e-webhooks/site.test.js (1 hunks)

🔇 Additional comments (1)

ghost/core/test/e2e-webhooks/site.test.js (1)

127-165: Well-structured test case for verifying draft post deletion behavior.

This test case correctly verifies that the site.changed event is not triggered when draft posts are deleted, which aligns with the PR objective. The test follows the same pattern as other tests in the file and effectively validates the fix for issue #21699.

[alexgmathews]

Hi @im-adithya. Thank you for picking up my bug report!

Do you see a way to apply the bugfix to draft pages as well? I checked 5.115.0, and deleting draft pages is also triggering the site.changed webhook.