Implement a proper Tombstone handling #2066

pfefferle · 2025-08-08T09:56:48Z

This PR implements centralized tombstone handling by introducing a new Activitypub\Tombstone class to replace scattered tombstone detection logic. The changes deprecate existing is_tombstone() functions in favor of a unified approach that supports multiple data types and includes local URL tracking.

See https://www.w3.org/TR/activitypub/#delete-activity-outbox

Proposed changes:

Introduces a new Tombstone class with comprehensive check methods for different data types
Deprecates Http::is_tombstone() and is_tombstone() functions while maintaining backward compatibility
Adds local tombstone tracking with bury() and check_local_url() methods

Other information:

Have you written new tests for your changes, if applicable?

Testing instructions:

Delete a User
Query the User-ID-URL with the ActivityPub Accept header
Check for Tombstone JSON

Changelog entry

Automatically create a changelog entry from the details below.

Changelog Entry Details

Significance

Patch
Minor
Major

Type

Added - for new features
Changed - for changes in existing functionality
Deprecated - for soon-to-be removed features
Removed - for now removed features
Fixed - for any bug fixes
Security - in case of vulnerabilities

Message

Improved handling of deleted content with a new unified system for better tracking and compatibility.

Moved all tombstone detection logic into a new Activitypub\Tombstone class, deprecating is_tombstone() and Http::is_tombstone(). Updated all usages to use Tombstone::check() and related methods. Added a tombstone JSON template and updated tests to reflect the new class. This centralizes and standardizes tombstone checks across the codebase.

Replaces inline array check in the is_tombstone() method with a call to self::check_array() for improved code reuse and maintainability.

Expanded the test suite in class-test-tombstone.php to cover Tombstone::check_wp_error, check_array, check_object, and check_local_url methods. Updated existing tests and data providers to reflect method renaming from is_tombstone to check_remote_url.

Copilot

Pull Request Overview

This PR implements centralized tombstone handling by introducing a new Activitypub\Tombstone class to replace scattered tombstone detection logic. The changes deprecate existing is_tombstone() functions in favor of a unified approach that supports multiple data types and includes local URL tracking.

Introduces a new Tombstone class with comprehensive check methods for different data types
Deprecates Http::is_tombstone() and is_tombstone() functions while maintaining backward compatibility
Adds local tombstone tracking with bury() and check_local_url() methods

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
includes/class-tombstone.php	New class implementing centralized tombstone detection with support for URLs, WP_Error, arrays, and objects
includes/class-http.php	Deprecates `is_tombstone()` method, delegates to new Tombstone class
includes/functions.php	Deprecates global `is_tombstone()` function, delegates to new Tombstone class
includes/handler/class-delete.php	Updates calls from `Http::is_tombstone()` to `Tombstone::check()`
includes/collection/class-followers.php	Updates import and function call to use new Tombstone class
includes/class-scheduler.php	Updates function call to use new Tombstone class
includes/class-activitypub.php	Adds local tombstone checking to template rendering
includes/class-query.php	Changes `get_request_url()` visibility from protected to public
templates/tombstone-json.php	New template for rendering tombstone JSON responses
tests/includes/class-test-tombstone.php	Comprehensive test suite for new Tombstone class functionality
tests/includes/class-test-http.php	Removes old HTTP tombstone tests (moved to new test file)

includes/class-tombstone.php

tests/includes/class-test-tombstone.php

includes/class-scheduler.php

includes/class-activitypub.php

includes/class-http.php

includes/functions.php

Co-authored-by: Copilot <[email protected]>

Changed the docblock parameter type from WP_Error to \WP_Error for improved clarity and namespacing consistency.

includes/class-tombstone.php

templates/tombstone-json.php

Co-authored-by: Konstantin Obenland <[email protected]>

@obenland

@obenland what about `is_gone`? because the tombstone check is for `410 gone`.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

obenland · 2025-08-25T13:43:17Z

@obenland what about is_gone? because the tombstone check is for 410 gone.

It's better! Probably good enough for our purposes. Tombstone::is_gone() could be misread as "the tombstone is no longer there", bit that's what docs and reading the code are for.

Copilot

Pull Request Overview

This PR implements centralized tombstone handling by introducing a new Activitypub\Tombstone class to replace scattered tombstone detection logic throughout the codebase. The changes deprecate existing tombstone functions while maintaining backward compatibility and add support for user deletion with proper ActivityPub Delete activities.

Introduces unified Tombstone class with comprehensive detection methods for different data types
Adds Delete activity generation when users are deleted with local tombstone tracking
Deprecates scattered is_tombstone() functions in favor of centralized approach

Reviewed Changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
includes/class-tombstone.php	New centralized tombstone handling class with detection methods
includes/scheduler/class-actor.php	User deletion handling with Delete activity generation
includes/handler/class-delete.php	Updated to use new Tombstone class methods
includes/collection/class-followers.php	Updated tombstone checks and deprecated old methods
includes/collection/class-actors.php	Added inbox retrieval for all actors
includes/class-http.php	Deprecated is_tombstone method with delegation
includes/functions.php	Deprecated is_tombstone function with delegation
templates/tombstone-json.php	New template for rendering tombstone JSON responses
tests/includes/class-test-tombstone.php	Comprehensive test suite for new Tombstone class

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

includes/class-http.php

includes/class-tombstone.php

includes/class-activitypub.php

includes/class-scheduler.php

Eliminated a duplicate check for error codes in the Tombstone class. The logic now relies solely on the error data's status field for validation.

Renamed Tombstone methods from 'is_gone', 'is_remote_url_gone', 'is_local_url_gone', 'is_wp_error', 'is_array_gone', and 'is_object_gone' to 'exists', 'exists_remote', 'exists_local', 'exists_in_error', 'check_array', and 'check_object' for clarity and consistency. Updated all usages and related tests to match the new method names. Improves code readability and better reflects the purpose of the methods.

Replaces the deprecated function notice and call from Tombstone::is_wp_error to Tombstone::exists_in_error to reflect the updated method name.

pfefferle · 2025-08-26T07:15:40Z

@obenland the Delete PR was a PR to this branch, so this PR now also includes the Delete code. I am sorry about that, I no longer thought about it 🫣

Enhanced and clarified docblocks for all methods and the class itself in includes/class-tombstone.php. The new comments provide more detailed descriptions, parameter explanations, and context for tombstone detection logic, improving code readability and maintainability.

pfefferle self-assigned this Aug 8, 2025

github-actions bot added [Feature] Collections [Status] In Progress labels Aug 8, 2025

pfefferle added 2 commits August 8, 2025 11:58

Refactor Tombstone type check logic

7193a64

Replaces inline array check in the is_tombstone() method with a call to self::check_array() for improved code reuse and maintainability.

pfefferle changed the title ~~Refactor tombstone handling into Tombstone class~~ Implement a proper Tombstone handling Aug 8, 2025

Merge branch 'trunk' into add/tombstone

f2417fa

pfefferle marked this pull request as ready for review August 8, 2025 18:05

Copilot AI review requested due to automatic review settings August 8, 2025 18:05

pfefferle added this to the User Delete milestone Aug 8, 2025

Copilot AI reviewed Aug 8, 2025

View reviewed changes

pfefferle requested a review from obenland August 8, 2025 18:10

matticbot and others added 6 commits August 8, 2025 20:10

Add changelog

37ae91c

Apply suggestion from @Copilot

7ea9925

Co-authored-by: Copilot <[email protected]>

Apply suggestion from @Copilot

f6722aa

Co-authored-by: Copilot <[email protected]>

Apply suggestion from @Copilot

3831be1

Co-authored-by: Copilot <[email protected]>

Apply suggestion from @Copilot

c8b85ee

Co-authored-by: Copilot <[email protected]>

Update WP_Error type hint in docblock

b550579

Changed the docblock parameter type from WP_Error to \WP_Error for improved clarity and namespacing consistency.

obenland reviewed Aug 19, 2025

View reviewed changes

pfefferle and others added 5 commits August 24, 2025 19:31

Merge branch 'trunk' into add/tombstone

2ed8bc5

Update templates/tombstone-json.php

56c8d14

Co-authored-by: Konstantin Obenland <[email protected]>

Update templates/tombstone-json.php

823c8ca

Co-authored-by: Konstantin Obenland <[email protected]>

change to is_gone

05315c1

@obenland what about `is_gone`? because the tombstone check is for `410 gone`.

Check for get_error_data

57718e4

pfefferle requested review from Copilot and obenland August 25, 2025 08:11

Copilot AI reviewed Aug 25, 2025

View reviewed changes

pfefferle requested a review from Copilot August 25, 2025 09:10

This comment was marked as outdated.

Sign in to view

obenland removed the [Status] In Progress label Aug 25, 2025

obenland previously approved these changes Aug 25, 2025

View reviewed changes

pfefferle added 2 commits August 25, 2025 16:25

Merge branch 'trunk' into add/tombstone

097e649

Send Delete Activity on User-Delete (#2035)

546cfab

pfefferle dismissed obenland’s stale review via 546cfab August 25, 2025 21:09

Merge branch 'trunk' into add/tombstone

e328903

pfefferle requested review from obenland and Copilot August 25, 2025 22:16

Copilot AI reviewed Aug 25, 2025

View reviewed changes

pfefferle added 3 commits August 26, 2025 08:39

Remove redundant error code check in Tombstone class

28804b2

Eliminated a duplicate check for error codes in the Tombstone class. The logic now relies solely on the error data's status field for validation.

Update deprecated function reference in is_tombstone

576cf22

Replaces the deprecated function notice and call from Tombstone::is_wp_error to Tombstone::exists_in_error to reflect the updated method name.

obenland approved these changes Aug 26, 2025

View reviewed changes

Merge branch 'trunk' into add/tombstone

82e70ca

pfefferle merged commit fd037a6 into trunk Aug 26, 2025
13 checks passed

pfefferle deleted the add/tombstone branch August 26, 2025 14:14

Implement a proper Tombstone handling #2066

Implement a proper Tombstone handling #2066

Uh oh!

Conversation

pfefferle commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

Other information:

Testing instructions:

Changelog entry

Significance

Type

Message

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

obenland commented Aug 25, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pfefferle commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pfefferle commented Aug 8, 2025 •

edited

Loading

pfefferle commented Aug 26, 2025 •

edited

Loading