feat(content-distribution): Sync authors #194

naxoc · 2025-01-20T14:05:18Z

This copies most of the existing code for distributed post authors.

I tried to make the naming of classes make a bit more sense (using outgoing/incoming) naming-wise, but I think I might have lost my way somewhere in the process. It's still pretty unwieldy. Suggestions very welcome!

One thing I still lack: when a post is new and I click "publish" and then distribute it (without having touched authors), the cap authors are not added to the payload. I think the best way to fix that is to save the post from JS before distributing the first time. What do you think @miguelpeixe ?

How to test

Try distributing a post without having CAP enabled. Check that the author is transferred in a way that makes sense
Try with an author that is a guest contributor. Also try mixing "normal" users and guest contributors.
Try with Guest Authors enabled. Try mixing here too.

Still remains:

Write more tests, but I want to use feat(testing): Add co-authors-plus to unit testing #203 to that when this is is merged if that is OK.

includes/content-distribution/class-cap-authors.php

includes/content-distribution/class-outgoing-post.php

miguelpeixe

Thank you for refactoring the approach to fit the new partial payload implementation!

I'm able to get multiple authors synced, but with the standard guest author approach from CAP I'm unable to get the guest authors distributed.

I'm activating it via define( 'NEWSPACK_ENABLE_CAP_GUEST_AUTHORS', true ); on all sites. Should I be doing something different?

miguelpeixe · 2025-01-29T19:06:18Z

includes/class-content-distribution.php

@@ -47,7 +49,7 @@ public static function init() {
 		}

 		add_action( 'init', [ __CLASS__, 'register_data_event_actions' ] );
-		add_action( 'shutdown', [ __CLASS__, 'distribute_queued_posts' ] );
+		add_action( 'shutdown', [ __CLASS__, 'distribute_queued_posts' ], 20 );


Any reason for the change in priority?

No, I think that is a relic from when I was trying to game the timing of things. :) I removed it

includes/content-distribution/class-cap-authors.php

miguelpeixe · 2025-01-29T19:15:27Z

includes/content-distribution/class-incoming-post.php

-		 * @param int   $post_id   The post ID.
-		 * @param bool  $is_linked Whether the post is linked.
-		 * @param array $payload   The post payload.
+		 * @param int $post_id The post ID.
+		 * @param bool $is_linked Whether the post is linked.
+		 * @param array $payload The post payload.


Why this change in linting?

It was probably just my editor when it autoformats. There are too many spaces I think it picked up?

It follows the standard we use for functions and methods so the parameters info is aligned. It could be that your IDE doesn't interpret the do_action() as a thing that can precede that type of docblock.

You are right! I had the editor set to not WP for some reason and it felt like I had to keep tweaking it :)

miguelpeixe · 2025-01-29T19:17:43Z

includes/content-distribution/class-outgoing-post.php

 		return [
 			'site_url'         => get_bloginfo( 'url' ),
 			'post_id'          => $this->post->ID,
 			'post_url'         => get_permalink( $this->post->ID ),
 			'network_post_id'  => $this->get_network_post_id(),
 			'sites'            => $this->get_distribution(),
 			'status_on_create' => $status_on_create,
+			'multiple_authors' => is_wp_error( $multiple_authors ) ? [] : $multiple_authors,


Partial payload filters through the contents of post_data. This should move there in order to work as designed.

As it is now, at the root-level, it'll be always part of the payload. It works, but not how we expect it to.

👍 Moved it to post_data

miguelpeixe · 2025-01-29T19:22:06Z

includes/content-distribution/class-outgoing-author.php

+	 *
+	 * @return WP_Error|array
+	 */
+	public static function get_wp_user_for_distribution( $user ) {


I don't think we need a whole class for this. WDYT of moving this to the Outgoing_Post class?

It's similar to other methods we have there that are meant to build the payload, like get_processed_post_content(), get_post_taxonomy_terms(), and get_post_meta().

miguelpeixe · 2025-01-29T19:24:41Z

includes/content-distribution/class-incoming-author.php

+/**
+ * Class to handle author ingestion for content distribution.
+ */
+class Incoming_Author {


I also think this class could become methods inside Incoming_Post.

miguelpeixe · 2025-01-29T19:32:32Z

includes/content-distribution/class-incoming-post.php

 				return new WP_Error( 'insert_error', __( 'Error inserting post.', 'newspack-network' ) );
 			}

 			// Update the object.
 			$this->ID   = $post_id;
 			$this->post = get_post( $this->ID );

+			Incoming_Author::ingest_author_for_post( $this->ID, $this->get_original_site_url(), $post_data['author'] );


This method makes a second post update to the db. Can we dissolve it and move its logic upper in this method's $postarr arguments?

Regular WP author is a core aspect of the post and should fit well in the composition of our insert() logic.

Makes sense! thanks :)

miguelpeixe · 2025-01-29T19:36:34Z

includes/content-distribution/class-outgoing-post.php

@@ -202,15 +202,20 @@ public function get_payload_hash( $payload = null ) {
 	 * @return array|WP_Error The post payload or WP_Error if the post is invalid.
 	 */
 	public function get_payload( $status_on_create = 'draft' ) {
+		$post_author = $this->post->post_author ? Outgoing_Author::get_wp_user_for_distribution( $this->post->post_author ) : [];
+		$multiple_authors = apply_filters( 'newspack_network_multiple_authors_for_post', [], $this->post );


Can you share more about the use case for this filter? It's missing a docblock.

It was an attempt to make it so other implementations of multiple authors (like other than the CAP plugin) could chime in. I'm missing an equivalent on incoming – I'll add that and add those in-function docblocks

I also added a filter for incoming "mulitple_authors", so any implementation could hook in in both directions.

Ah, I see. I didn't realize that's how the CAP data is being added to the payload.

Non-blocking suggestion: maybe instead of filtering this specific property we can go with a more generic approach and filter the payload post_data to let additional features determine their properties. That'll also generate a cleaner payload for sites that don't have CAP at all - no permanent empty array.

Co-authored-by: Miguel Peixe <[email protected]>

naxoc · 2025-01-30T14:23:21Z

Thanks for the review @miguelpeixe

I implemented your suggestions. If you think the whole hooks thing for multiple authors is over engineering things, let me know and I can change them to function calls.

miguelpeixe

Thank you for the revisions, @naxoc! It's looking great.

Maybe you missed this bit from my previous review:

I'm able to get multiple authors synced, but with the standard guest author approach from CAP I'm unable to get the guest authors distributed.

I'm activating it via define( 'NEWSPACK_ENABLE_CAP_GUEST_AUTHORS', true ); on all sites. Should I be doing something different?

I'm still unable to get it to work. The payload does include the data, though:

{
    "site_url": "http:\/\/localhost",
    "post_id": 827,
    "post_url": "http:\/\/localhost\/2025\/01\/my-new-cap-post\/",
    "network_post_id": "6dc7943077f7903f656015af0ebb029e",
    "sites": [
        "http:\/\/node1.test"
    ],
    "status_on_create": "draft",
    "post_data": {
        "multiple_authors": [
            {
                "type": "wp_user",
                "ID": 1,
                "display_name": "wordpress",
                "user_email": "[email protected]",
                "user_url": "http:\/\/localhost"
            },
            {
                "ID": "825",
                "display_name": "My CAP Guest Author",
                "first_name": "",
                "last_name": "",
                "user_login": "my-cap-guest-author",
                "user_email": "[email protected]",
                "linked_account": "",
                "website": "",
                "description": "",
                "newspack_job_title": "",
                "newspack_role": "",
                "newspack_employer": "",
                "newspack_phone_number": "",
                "user_nicename": "my-cap-guest-author",
                "type": "guest_author",
                "nickname": ""
            },
            {
                "type": "wp_user",
                "ID": 2,
                "display_name": "Contributor",
                "user_email": "[email protected]",
                "first_name": "Contributor",
                "last_name": "Contributor"
            }
        ],
        "date_gmt": "2025-01-30 17:37:01",
        "modified_gmt": "2025-01-30 17:39:22"
    },
    "partial": true
}

miguelpeixe · 2025-01-30T17:27:51Z

includes/content-distribution/class-cap-authors.php

+	 * Action callback.
+	 *
+	 * Add a postmeta entry with the Co-Authors Plus authors for outgoing posts.


This docblock needs an update.

miguelpeixe · 2025-01-30T17:34:40Z

includes/content-distribution/class-outgoing-post.php

@@ -202,15 +202,20 @@ public function get_payload_hash( $payload = null ) {
 	 * @return array|WP_Error The post payload or WP_Error if the post is invalid.
 	 */
 	public function get_payload( $status_on_create = 'draft' ) {
+		$post_author = $this->post->post_author ? Outgoing_Author::get_wp_user_for_distribution( $this->post->post_author ) : [];
+		$multiple_authors = apply_filters( 'newspack_network_multiple_authors_for_post', [], $this->post );


Ah, I see. I didn't realize that's how the CAP data is being added to the payload.

Non-blocking suggestion: maybe instead of filtering this specific property we can go with a more generic approach and filter the payload post_data to let additional features determine their properties. That'll also generate a cleaner payload for sites that don't have CAP at all - no permanent empty array.

naxoc · 2025-01-30T18:35:22Z

Woops. I didn't click comment on this one:

I'm able to get multiple authors synced, but with the standard guest author approach from CAP I'm unable to get the guest authors distributed.

I copied the behavior from the existing code that handles guest authors It would be great to also have it work in admin – at least in the posts listing 🤔 It works for me. They only show on the front end, so might that have been it? Let me know if the front end is not showing them for you.

miguelpeixe · 2025-01-30T18:45:18Z

They only show on the front end, so might that have been it? Let me know if the front end is not showing them for you.

Ah! My apologies, that's indeed the case. I was expecting it to sync them exactly. Confirmed it's working as intended:

naxoc · 2025-01-30T19:06:28Z

Thank you Miguel – I love the idea of filtering the whole post_data part instead. I'll add that tomorrow 👍

naxoc · 2025-01-31T12:24:51Z

OK, @miguelpeixe I added the payload filtering. That is a great idea – it makes everything much more readable and extendable. Ready for re-review :)

miguelpeixe

Thanks, @naxoc! Looks good and tests well 💯

One small ✂️ and we're good to go!

tests/unit-tests/content-distribution/util.php

Co-authored-by: Miguel Peixe <[email protected]>

github-actions · 2025-01-31T13:28:15Z

Hey @naxoc, good job getting this PR merged! 🎉

Now, the needs-changelog label has been added to it.

Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label.

If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label.

Thank you! ❤️

# [2.6.0-alpha.1](v2.5.0...v2.6.0-alpha.1) (2025-02-07) ### Bug Fixes * **content-distribution:** use payload hash on partial updates ([#207](#207)) ([31b342d](31b342d)) * **event-log:** data css overflow ([#206](#206)) ([f81adfe](f81adfe)) ### Features * **content-distribution:** migration tweaks ([#201](#201)) ([9c61fa8](9c61fa8)) * **content-distribution:** partial payload ([#205](#205)) ([b844d06](b844d06)) * **content-distribution:** remove "Quick Edit" from linked posts ([#200](#200)) ([6ad3a4a](6ad3a4a)) * **content-distribution:** Sync authors ([#194](#194)) ([3156d35](3156d35)) * increase pull frequency and amount ([#209](#209)) ([6791da1](6791da1))

matticbot · 2025-02-07T17:15:15Z

🎉 This PR is included in version 2.6.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

naxoc added 5 commits December 18, 2024 11:55

work in progress

18cb10c

Merge branch 'trunk' into feat/content-distribution-authors

06d1397

Merge branch 'trunk' into feat/content-distribution-authors

0227d6c

Merge branch 'trunk' into feat/content-distribution-authors

d323ebb

Add to outgoing

25511b4

naxoc self-assigned this Jan 20, 2025

naxoc added 14 commits January 20, 2025 15:38

Clean up

2a7185f

Merge branch 'trunk' into feat/content-distribution-authors

36b30ed

Liniting

6e13d27

Remane to avoid confusion

c4581cd

Merge branch 'trunk' into feat/content-distribution-authors

b08b048

Merge branch 'trunk' into feat/content-distribution-authors

077d5ce

Add some comments on a way forward

cd2276c

Move stuff around

caa506d

Merge branch 'trunk' into feat/content-distribution-authors

ea7bb12

most things work now

beed21f

Fix tests

8e770bb

Work in progress

4150ad0

Merge branch 'trunk' into feat/content-distribution-authors

c718269

PHPCS

9b66863

naxoc commented Jan 28, 2025

View reviewed changes

includes/content-distribution/class-cap-authors.php Outdated Show resolved Hide resolved

naxoc added 2 commits January 28, 2025 18:10

Cleanup

ffd0116

Check for warning

f0e4459

miguelpeixe reviewed Jan 28, 2025

View reviewed changes

includes/content-distribution/class-outgoing-post.php Outdated Show resolved Hide resolved

naxoc added 4 commits January 29, 2025 15:25

Work in progress

1700eb7

Merge branch 'trunk' into feat/content-distribution-authors

7f20d29

Use partial payloads and simplify

32a5d18

phpcs

71ac748

naxoc marked this pull request as ready for review January 29, 2025 18:56

naxoc requested a review from a team as a code owner January 29, 2025 18:56

More phpcs

113d019

miguelpeixe requested changes Jan 29, 2025

View reviewed changes

naxoc and others added 7 commits January 30, 2025 12:01

Suggestion from review

37c2c9b

Co-authored-by: Miguel Peixe <[email protected]>

Review feedback

33daeb0

Move 'multiple_authors' to post data

12547b6

Use filter for both incoming and outgoing multiple_authors

0736b2b

Don't hit the db more than necessary

7ae0574

Move outoging authors to outgoing post

1c69f02

Move incoming authors to incoming post

af741a4

naxoc requested a review from miguelpeixe January 30, 2025 14:23

miguelpeixe requested changes Jan 30, 2025

View reviewed changes

Fix docblock

17e4b8c

naxoc added 2 commits January 31, 2025 13:12

Add filters for the payload

397275f

Remove unused method

3c2cad4

naxoc requested a review from miguelpeixe January 31, 2025 12:24

miguelpeixe approved these changes Jan 31, 2025

View reviewed changes

tests/unit-tests/content-distribution/util.php Outdated Show resolved Hide resolved

Remove unused post_data field

fa05a21

Co-authored-by: Miguel Peixe <[email protected]>

naxoc merged commit 3156d35 into trunk Jan 31, 2025
4 checks passed

github-actions bot added the needs-changelog label Jan 31, 2025

naxoc deleted the feat/content-distribution-authors branch January 31, 2025 13:35

matticbot added the released on @alpha label Feb 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(content-distribution): Sync authors #194

feat(content-distribution): Sync authors #194

naxoc commented Jan 20, 2025 •

edited

Loading

miguelpeixe left a comment

miguelpeixe Jan 29, 2025

naxoc Jan 30, 2025

miguelpeixe Jan 29, 2025

naxoc Jan 30, 2025

miguelpeixe Jan 30, 2025

naxoc Jan 30, 2025

miguelpeixe Jan 29, 2025

naxoc Jan 30, 2025

miguelpeixe Jan 29, 2025 •

edited

Loading

miguelpeixe Jan 29, 2025

miguelpeixe Jan 29, 2025

naxoc Jan 30, 2025

miguelpeixe Jan 29, 2025

naxoc Jan 30, 2025

naxoc Jan 30, 2025

miguelpeixe Jan 30, 2025 •

edited

Loading

naxoc commented Jan 30, 2025

miguelpeixe left a comment

miguelpeixe Jan 30, 2025

miguelpeixe Jan 30, 2025 •

edited

Loading

naxoc commented Jan 30, 2025

miguelpeixe commented Jan 30, 2025

naxoc commented Jan 30, 2025

naxoc commented Jan 31, 2025

miguelpeixe left a comment

github-actions bot commented Jan 31, 2025

matticbot commented Feb 7, 2025

feat(content-distribution): Sync authors #194

feat(content-distribution): Sync authors #194

Conversation

naxoc commented Jan 20, 2025 • edited Loading

How to test

miguelpeixe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miguelpeixe Jan 29, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miguelpeixe Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

naxoc commented Jan 30, 2025

miguelpeixe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miguelpeixe Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

naxoc commented Jan 30, 2025

miguelpeixe commented Jan 30, 2025

naxoc commented Jan 30, 2025

naxoc commented Jan 31, 2025

miguelpeixe left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 31, 2025

matticbot commented Feb 7, 2025

naxoc commented Jan 20, 2025 •

edited

Loading

miguelpeixe Jan 29, 2025 •

edited

Loading

miguelpeixe Jan 30, 2025 •

edited

Loading

miguelpeixe Jan 30, 2025 •

edited

Loading