Fix: Announces (#1500)

* Fix: Announces

With the re-write of how we store Activities in the Outbox, the Announces do no longer work. This PR fixes that.

* Update includes/class-scheduler.php

Co-authored-by: Konstantin Obenland <obenland@gmx.de>

* simplify namings

* Add unittests

* Add changelog

---------

Co-authored-by: Konstantin Obenland <obenland@gmx.de>
Co-authored-by: Automattic Bot <sysops+ghmatticbot@automattic.com>

Author: 3 people

.github/changelog/1500-from-description

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fixed
+
+`Scheduler::schedule_announce_activity` to handle Activities instead of Activity-Objects.

includes/class-scheduler.php

@@ -7,6 +7,7 @@
 
 namespace Activitypub;
 
+use Activitypub\Activity\Activity;
 use Activitypub\Scheduler\Post;
 use Activitypub\Scheduler\Actor;
 use Activitypub\Scheduler\Comment;
@@ -391,11 +392,11 @@ private static function next_scheduled_hook( $hook ) {
 	 * Send announces.
 	 *
 	 * @param int                            $outbox_activity_id The outbox activity ID.
-	 * @param \Activitypub\Activity\Activity $activity_object    The activity object.
+	 * @param \Activitypub\Activity\Activity $activity           The activity object.
 	 * @param int                            $actor_id           The actor ID.
 	 * @param int                            $content_visibility The content visibility.
 	 */
-	public static function schedule_announce_activity( $outbox_activity_id, $activity_object, $actor_id, $content_visibility ) {
+	public static function schedule_announce_activity( $outbox_activity_id, $activity, $actor_id, $content_visibility ) {
 		// Only if we're in both Blog and User modes.
 		if ( ACTIVITYPUB_ACTOR_AND_BLOG_MODE !== \get_option( 'activitypub_actor_mode', ACTIVITYPUB_ACTOR_MODE ) ) {
 			return;
@@ -411,28 +412,26 @@ public static function schedule_announce_activity( $outbox_activity_id, $activit
 			return;
 		}
 
-		$activity_type = \get_post_meta( $outbox_activity_id, '_activitypub_activity_type', true );
-
 		// Only if the activity is a Create, Update or Delete.
-		if ( ! in_array( $activity_type, array( 'Create', 'Update', 'Delete' ), true ) ) {
+		if ( ! in_array( $activity->get_type(), array( 'Create', 'Update', 'Delete' ), true ) ) {
 			return;
 		}
 
-		// Check if the object is an article, image, audio, video, event or document and ignore profile updates and other activities.
-		if ( ! in_array( $activity_object->get_type(), array( 'Note', 'Article', 'Image', 'Audio', 'Video', 'Event', 'Document' ), true ) ) {
+		if ( ! is_object( $activity->get_object() ) ) {
 			return;
 		}
 
-		$transformer = Factory::get_transformer( $activity_object );
-		if ( ! $transformer || \is_wp_error( $transformer ) ) {
+		// Check if the object is an article, image, audio, video, event, or document and ignore profile updates and other activities.
+		if ( ! in_array( $activity->get_object()->get_type(), array( 'Note', 'Article', 'Image', 'Audio', 'Video', 'Event', 'Document' ), true ) ) {
 			return;
 		}
 
-		$post     = get_post( $outbox_activity_id );
-		$activity = $transformer->to_activity( $activity_type );
-		$activity->set_id( $post->guid );
+		$announce = new Activity();
+		$announce->set_type( 'Announce' );
+		$announce->set_actor( Actors::get_by_id( Actors::BLOG_USER_ID )->get_id() );
+		$announce->set_object( $activity );
 
-		$outbox_activity_id = Outbox::add( $activity, 'Announce', Actors::BLOG_USER_ID );
+		$outbox_activity_id = Outbox::add( $announce, Actors::BLOG_USER_ID );
 
 		if ( ! $outbox_activity_id ) {
 			return;

tests/includes/class-test-scheduler.php

@@ -7,19 +7,20 @@
 
 namespace Activitypub\Tests;
 
-use Activitypub\Activity\Activity;
 use Activitypub\Scheduler;
-use Activitypub\Collection\Outbox;
+use Activitypub\Activity\Activity;
 use Activitypub\Activity\Base_Object;
-use WP_UnitTestCase;
+use Activitypub\Collection\Outbox;
+use Activitypub\Collection\Actors;
+
 use function Activitypub\add_to_outbox;
 
 /**
  * Test class for Scheduler.
  *
  * @coversDefaultClass \Activitypub\Scheduler
  */
-class Test_Scheduler extends WP_UnitTestCase {
+class Test_Scheduler extends \WP_UnitTestCase {
 	/**
 	 * Test user ID.
 	 *
@@ -285,4 +286,68 @@ public function test_async_batch_with_invalid_callback() {
 		// Run async_batch with invalid callback.
 		Scheduler::async_batch( array( $mock_class, 'callback' ) );
 	}
+
+	/**
+	 * Test schedule_announce_activity method.
+	 *
+	 * @covers ::schedule_announce_activity
+	 */
+	public function test_schedule_announce_activity() {
+		// Set the actor mode to both blog and user mode.
+		\update_option( 'activitypub_actor_mode', ACTIVITYPUB_ACTOR_AND_BLOG_MODE );
+
+		$activity = new Activity();
+		$activity->set_type( 'Create' );
+		$activity->set_id( 'https://example.com/test-id' );
+
+		// Create a Note object for the activity.
+		$note = new Base_Object();
+		$note->set_type( 'Note' );
+		$note->set_content( 'Test content' );
+		$note->set_id( 'https://example.com/note/1' );
+		$activity->set_object( $note );
+
+		$outbox_activity_id = Outbox::add( $activity, self::$user_id );
+
+		$scheduled_events = array();
+		add_filter(
+			'schedule_event',
+			function ( $event ) use ( &$scheduled_events ) {
+				if ( 'activitypub_process_outbox' === $event->hook ) {
+					$scheduled_events[] = $event->args[0];
+				}
+				return $event;
+			}
+		);
+
+		Scheduler::schedule_announce_activity( $outbox_activity_id, $activity, self::$user_id, ACTIVITYPUB_CONTENT_VISIBILITY_PUBLIC );
+
+		// Get the most recent outbox item for the blog actor.
+		$announce_outbox_items = get_posts(
+			array(
+				'post_type'      => Outbox::POST_TYPE,
+				'post_author'    => Actors::BLOG_USER_ID,
+				'post_status'    => 'pending',
+				'orderby'        => 'ID',
+				'order'          => 'DESC',
+				'posts_per_page' => 1,
+			)
+		);
+
+		$this->assertNotEmpty( $announce_outbox_items, 'No announce outbox items found' );
+		$announce_outbox_id = $announce_outbox_items[0]->ID;
+
+		$this->assertCount( 1, $scheduled_events, 'Should schedule 1 event' );
+		$this->assertContains( $announce_outbox_id, $scheduled_events, 'Should schedule the announce outbox activity' );
+
+		// Check for Announce activity in the outbox.
+		$announce_post     = get_post( $announce_outbox_id );
+		$announce_activity = json_decode( $announce_post->post_content, true );
+		$this->assertEquals( 'Announce', $announce_activity['type'] );
+
+		// Clean up.
+		wp_delete_post( $outbox_activity_id, true );
+		wp_delete_post( $announce_outbox_id, true );
+		remove_all_filters( 'schedule_event' );
+	}
 }