Feat/distribute authors #17

leogermani · 2023-11-28T22:45:35Z

Distributes authors upon post distribution via the Distributor plugin

When a post is distributed via Distributor, all the authors (and co-authors if CAP is enabled) information will be attached to the post.

In the site where the post was distributed to, the authorship information will be stored in a post meta, and later will be used to override the bylines of the posts.

Also in the target site, every author that is a WP user in the origin site, will be created as an author if an user with that email yet doesn't exist. Then the post authorship will be assigned to the distributed authors, in the same way they are in the origin site.

Guest Authors will not be created and the authorship will not be established. Information about Guest Authors will only exist in the post_meta, and will be used to filter the byline on the fly (in a future PR).

How to test

Establish a network with 2 or 3 sites. (newspack_docker is your friend here, since it automatically creates a bunch of sites and connect them both on Newspack Network plugin and on Distributor plugin, creating needed the keys and application passwords)
On one of the sites, create a post, and assign it multiple authors, having at least one wp user and one guest author
Distribute this post via push to another site
In the target site, observe the WP_User was created and the authorship was properly assigned
Observe the newspack_network_authors post_meta and see all authors are there, including the guest author
Repeat the process, now pulling a post from a site instead of pushing
Make sure to fill all fields of the authors and confirm all fields are propagated (name, bio, site, job, etc)

miguelpeixe

The newspack_network_authors meta is being populated correctly and I was able to see the multiple WP_User authors after disabling this setting from Distributor:

A few questions/suggestions inline:

miguelpeixe · 2023-12-12T18:46:24Z

includes/distributor-customizations/class-author-distribution.php

+			if ( is_a( $co_author, 'WP_User' ) ) {
+				$authors[] = self::get_wp_user_for_distribution( $co_author );
+			}
+			$authors[] = self::get_guest_author_for_distribution( $co_author );


Shouldn't line 99 be inside an else block? If $co_author is a user, it's being added twice (through the wp_user and guest methods).

Done in df7f3d8

miguelpeixe · 2023-12-12T18:50:50Z

includes/distributor-customizations/class-author-distribution.php

+		}
+
+		if ( ! $user ) {
+			return [];


Why not use WP_Error here for improved debugging?

Mainly because all this happens as side effects in the background and we don't have any opportunity to surface these errors to the user. How would you debug it?

But yes, I guess we could return a wp_error there... but then we need more lines in the method that call this to check what has been returned

Not really seeing a benefit of returning a WP_Error, but added some debugging on 2e26d03

miguelpeixe · 2023-12-12T18:55:32Z

includes/distributor-customizations/class-author-distribution.php

+	public static function get_guest_author_for_distribution( $guest_author ) {
+
+		if ( ! is_object( $guest_author ) || ! isset( $guest_author->type ) || 'guest-author' !== $guest_author->type ) {
+			return [];


Same for debugging, a WP_Error could be good here.

miguelpeixe · 2023-12-12T19:03:58Z

includes/distributor-customizations/class-author-ingestion.php

+
+			Debugger::log( 'Ingesting author: ' . $author['user_email'] );
+
+			$user = User_Utils::get_or_create_user_by_email( $author['user_email'], get_post_meta( $post_id, 'dt_original_site_url', true ), $author['id'] );


This is a bit confusing. Is the 3rd argument meant to be the author ID or the site ID?

The author id. Why confusing? When we create a user that has been propagated by another site we store their original ID

Because according to the code inline docs:

@param string $remote_site_id The ID of the remote site. Used only when a new user is created.

ah, I'll fix the docs. It should be The id ON the remote site... I'll make it clearer

Done in 92c6b32

includes/distributor-customizations/class-author-distribution.php

includes/distributor-customizations/class-author-ingestion.php

miguelpeixe · 2023-12-13T15:26:43Z

One other thing, the display name is set as the author's email. Can we use the same from the origin site?

Original	Distributed

John Doe in the example above is a guest author, so it's expected to be missing from the distributed post.

Co-authored-by: Miguel Peixe <miguel.peixe@automattic.com>

leogermani · 2023-12-13T18:54:47Z

One other thing, the display name is set as the author's email. Can we use the same from the origin site?

Good catch! Fixed in b529b36.

miguelpeixe

Thank you for the revisions!

includes/distributor-customizations/class-author-distribution.php

Co-authored-by: Miguel Peixe <miguel.peixe@automattic.com>

matticbot · 2023-12-22T16:22:27Z

🎉 This PR is included in version 1.0.0-alpha.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

matticbot · 2023-12-22T16:29:26Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

leogermani added 4 commits November 28, 2023 17:48

feat: distribute authors on push

80e2e36

feat: handle posts distributed via pull

6f87c64

Merge branch 'master' into feat/distribute-authors

f5790b6

feat: update code with user update watcher

37aa016

leogermani marked this pull request as ready for review December 1, 2023 21:58

leogermani self-assigned this Dec 1, 2023

leogermani added the [Status] Needs Review label Dec 1, 2023

leogermani mentioned this pull request Dec 4, 2023

feat: network donation events as reader data #8

Merged

Merge branch 'master' into feat/distribute-authors

5e70c99

leogermani requested a review from a team as a code owner December 6, 2023 19:28

leogermani added 2 commits December 7, 2023 09:21

Merge branch 'master' into feat/distribute-authors

2a69117

feat: use utils class

fe05bb1

leogermani mentioned this pull request Dec 12, 2023

feat: sync user avatar #21

Merged

Merge branch 'master' into feat/distribute-authors

42f7fac

miguelpeixe requested changes Dec 13, 2023

View reviewed changes

leogermani and others added 8 commits December 13, 2023 12:50

Update includes/distributor-customizations/class-author-distribution.php

bf84a87

Co-authored-by: Miguel Peixe <miguel.peixe@automattic.com>

Update includes/distributor-customizations/class-author-ingestion.php

c477fb1

Co-authored-by: Miguel Peixe <miguel.peixe@automattic.com>

Update includes/distributor-customizations/class-author-ingestion.php

b413ee1

Co-authored-by: Miguel Peixe <miguel.peixe@automattic.com>

Update includes/distributor-customizations/class-author-ingestion.php

7e8e827

Co-authored-by: Miguel Peixe <miguel.peixe@automattic.com>

fix: add users only once

df7f3d8

docs: fix docs explanation

92c6b32

feat: add debug messages in case of errors

2e26d03

fix: pass users props on user creation

b529b36

leogermani requested a review from miguelpeixe December 13, 2023 18:55

leogermani added 3 commits December 13, 2023 17:38

fix: improve param name

6636656

feat: add better debugging

2a908c4

docs: minor adjustment in a doc block

6bce598

miguelpeixe approved these changes Dec 14, 2023

View reviewed changes

includes/distributor-customizations/class-author-distribution.php Outdated Show resolved Hide resolved

leogermani and others added 3 commits December 14, 2023 12:02

Update includes/distributor-customizations/class-author-distribution.php

b25a1ec

Co-authored-by: Miguel Peixe <miguel.peixe@automattic.com>

fix: create users as authors

68f5fab

fix: do not trigger auto updates when ingesting

3160cd1

leogermani merged commit 62c69fe into master Dec 15, 2023
3 checks passed

leogermani mentioned this pull request Dec 19, 2023

feat: update authors on post update #29

Merged

matticbot added the released on @alpha label Dec 22, 2023

matticbot added the released label Dec 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/distribute authors #17

Feat/distribute authors #17

leogermani commented Nov 28, 2023 •

edited

Loading

miguelpeixe left a comment

miguelpeixe Dec 12, 2023

leogermani Dec 13, 2023

miguelpeixe Dec 12, 2023

leogermani Dec 13, 2023

leogermani Dec 13, 2023

miguelpeixe Dec 12, 2023

miguelpeixe Dec 12, 2023

leogermani Dec 13, 2023

miguelpeixe Dec 13, 2023

leogermani Dec 13, 2023

leogermani Dec 13, 2023

miguelpeixe commented Dec 13, 2023

leogermani commented Dec 13, 2023

miguelpeixe left a comment

matticbot commented Dec 22, 2023

matticbot commented Dec 22, 2023


		Debugger::log( 'Ingesting author: ' . $author['user_email'] );

		$user = User_Utils::get_or_create_user_by_email( $author['user_email'], get_post_meta( $post_id, 'dt_original_site_url', true ), $author['id'] );

Feat/distribute authors #17

Feat/distribute authors #17

Conversation

leogermani commented Nov 28, 2023 • edited Loading

Distributes authors upon post distribution via the Distributor plugin

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miguelpeixe commented Dec 13, 2023

leogermani commented Dec 13, 2023

miguelpeixe left a comment

Choose a reason for hiding this comment

matticbot commented Dec 22, 2023

matticbot commented Dec 22, 2023

leogermani commented Nov 28, 2023 •

edited

Loading