feat(content-distribution): sync post meta #163

miguelpeixe · 2024-12-10T19:02:43Z

Implements support for syncing post meta when distributing content. The new Newspack_Network\Content_Distribution::get_reserved_post_meta_keys() should determine which keys to ignore on distribution, to be used by both Outgoing_Post when generating the payload and Incoming_Post when clearing the post meta before an update.

This approach supports unique and not unique post meta.

Testing

Make sure you have a network setup with at least one hub and one node
Setup content distribution by creating a new post and running in wp shell:

$post_id = 0; // Change to your post ID.
$outgoing_post = new Newspack_Network\Content_Distribution\Outgoing_Post( $post_id );
$outgoing_post->set_config( [ 'http://node1.local' ] ); // Change to match your node URL.
Newspack_Network\Content_Distribution::distribute_post( $outgoing_post );

Still in wp shell, update the post meta and distribute again:

$post = $outgoing_post->get_post();
update_post_meta( $post->ID, 'single', 'value' ); // Single string
update_post_meta( $post->ID, 'array', [ 1, 2, 3 ] ); // Single array
add_post_meta( $post->ID, 'multiple', 'a' ); // Not unique meta
add_post_meta( $post->ID, 'multiple', 'b' ); // Not unique meta
Newspack_Network\Content_Distribution::distribute_post( $outgoing_post );

Once the events are processed, confirm the meta is updated correctly in the node:

get_post_meta( $post_id );
// = [
//      "single" => [ "value" ],
//      "array" => [ "a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}" ],
//      "multiple" => [ "a", "b", "c" ]
// ]

* feat: content distribution class * feat: insert linked post * refactor: use site url instead of ID * chore: lint * feat: return errors on post insert * chore: lint * feat: support webhooks request priority * feat: unlink functionality and unit tests * chore: lint * feat: introduce 'linked_post_inserted' hook and listener * chore: lint * fix: listener hook name * fix: typo * chore: better docblocks * chore: remove redundant code * test: persist post hash * test: remove unnecessary assertion * refactor: distribute_post() to use handle_post_updated() method * refactor: post hash is now network post id * chore: update comment

…ts (#156)

feat: Add network util class

The old classname "Linked_Post" was still used instead of "Incoming_Post" causing sync to fail. ## How to test Probably eyeballing is enough

…sname fix: Include correct classname

…nfig (#165)

…on-post-meta

naxoc

👍 Looks good and tests well. I added some nits – feel free to ignore them : )

naxoc · 2024-12-12T16:18:51Z

includes/class-content-distribution.php

+		$reserved_keys = apply_filters( 'newspack_network_content_distribution_reserved_post_meta_keys', $reserved_keys );
+
+		// Always preserve content distribution post meta.
+		$reserved_keys = array_merge(


Nit: we could also just return the array_merge here. No need for the $reserved_key var.

Good call! Updated in 53de4f3

naxoc · 2024-12-12T16:26:04Z

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

+		 * @param array   $meta The post meta data.
+		 * @param WP_Post $post The post object.
+		 */
+		$meta = apply_filters( 'newspack_network_distributed_post_meta', $meta, $this->post );


Same with an un-needed var here

Same in 53de4f3

miguelpeixe · 2024-12-12T18:07:19Z

Thanks for the review!

github-actions · 2024-12-12T18:36:12Z

Hey @miguelpeixe, 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.4.0-alpha.1](v2.3.4...v2.4.0-alpha.1) (2025-01-10) ### Bug Fixes * **content-distribution:** post insertion hook and additional meta for incoming post event ([#173](#173)) ([48df13c](48df13c)) * load text domain on init hook ([#171](#171)) ([01fb89c](01fb89c)) ### Features * content distribution - experimental ([#168](#168)) ([dc837d8](dc837d8)) * **content-distribution:** add CLI command for distribute post ([#159](#159)) ([7a43b86](7a43b86)), closes [#155](#155) [#156](#156) [#157](#157) [#160](#160) [#165](#165) * **content-distribution:** canonical url ([#177](#177)) ([5ca60ce](5ca60ce)) * **content-distribution:** capability and admin page ([#176](#176)) ([5285285](5285285)) * **content-distribution:** control distribution meta and prevent multiple dispatches ([#170](#170)) ([e76a2dc](e76a2dc)) * **content-distribution:** editor plugin for distribution ([#167](#167)) ([e10aef4](e10aef4)) * **content-distribution:** handle status changes ([#166](#166)) ([4af5da1](4af5da1)) * **content-distribution:** log incoming post errors ([#182](#182)) ([74c9119](74c9119)) * **content-distribution:** posts column ([#178](#178)) ([8e07640](8e07640)) * **content-distribution:** reserved taxonomies ([#174](#174)) ([a2c54d2](a2c54d2)) * **content-distribution:** sync comment and ping statuses ([#179](#179)) ([90c5425](90c5425)) * **content-distribution:** sync post meta ([#163](#163)) ([353a3d8](353a3d8)) * **event-log:** collapse data ([#180](#180)) ([956219d](956219d)) * limit purchase of a network membership ([#169](#169)) ([deb2683](deb2683))

matticbot · 2025-01-10T22:30:22Z

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

The release is available on GitHub release

Your semantic-release bot 📦🚀

# [2.4.0](v2.3.4...v2.4.0) (2025-01-20) ### Bug Fixes * **content-distribution:** post insertion hook and additional meta for incoming post event ([#173](#173)) ([48df13c](48df13c)) * load text domain on init hook ([#171](#171)) ([01fb89c](01fb89c)) ### Features * content distribution - experimental ([#168](#168)) ([dc837d8](dc837d8)) * **content-distribution:** add CLI command for distribute post ([#159](#159)) ([7a43b86](7a43b86)), closes [#155](#155) [#156](#156) [#157](#157) [#160](#160) [#165](#165) * **content-distribution:** canonical url ([#177](#177)) ([5ca60ce](5ca60ce)) * **content-distribution:** capability and admin page ([#176](#176)) ([5285285](5285285)) * **content-distribution:** control distribution meta and prevent multiple dispatches ([#170](#170)) ([e76a2dc](e76a2dc)) * **content-distribution:** editor plugin for distribution ([#167](#167)) ([e10aef4](e10aef4)) * **content-distribution:** handle status changes ([#166](#166)) ([4af5da1](4af5da1)) * **content-distribution:** log incoming post errors ([#182](#182)) ([74c9119](74c9119)) * **content-distribution:** posts column ([#178](#178)) ([8e07640](8e07640)) * **content-distribution:** reserved taxonomies ([#174](#174)) ([a2c54d2](a2c54d2)) * **content-distribution:** sync comment and ping statuses ([#179](#179)) ([90c5425](90c5425)) * **content-distribution:** sync post meta ([#163](#163)) ([353a3d8](353a3d8)) * **event-log:** collapse data ([#180](#180)) ([956219d](956219d)) * limit purchase of a network membership ([#169](#169)) ([deb2683](deb2683))

matticbot · 2025-01-20T18:04:28Z

🎉 This PR is included in version 2.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

miguelpeixe and others added 13 commits December 9, 2024 08:52

feat(content-distribution): prevent older content updating linked pos…

cd4339d

…ts (#156)

feat(content-distribution): handle post thumbnail (#157)

f2de08c

Add network util class

db14c66

refactor: OOP for distributed and linked posts (#160)

31d6744

Merge branch 'epic/content-distribution' into feat/network-validate-urls

cf2a369

chore: Require php 8.1

8e222e5

Merge pull request #161 from Automattic/feat/network-validate-urls

36a8807

feat: Add network util class

feat(content-distribution): sync post meta

d357a60

fix: tweak post meta schema

6abc714

test: post meta

8e258d3

chore: lint

6939bac

chore: move var

8ce75ff

miguelpeixe marked this pull request as ready for review December 10, 2024 19:43

miguelpeixe requested a review from a team as a code owner December 10, 2024 19:43

miguelpeixe self-assigned this Dec 10, 2024

miguelpeixe added the [Status] Needs Review label Dec 10, 2024

miguelpeixe requested a review from naxoc December 10, 2024 19:43

naxoc and others added 5 commits December 11, 2024 13:15

fix: Include correct classname

00be82b

The old classname "Linked_Post" was still used instead of "Incoming_Post" causing sync to fail. ## How to test Probably eyeballing is enough

Merge pull request #164 from Automattic/fix/content-distribution-clas…

0e3bec4

…sname fix: Include correct classname

fix(content-distribution): debug post update and remove deprecated co…

47bd6b6

…nfig (#165)

Merge branch 'epic/content-distribution' into feat/content-distributi…

5e2cd05

…on-post-meta

test: post meta sync

879e321

Base automatically changed from epic/content-distribution to trunk December 12, 2024 13:00

Merge branch 'trunk' into feat/content-distribution-post-meta

9eb2e82

naxoc approved these changes Dec 12, 2024

View reviewed changes

chore: remove unnecessary vars

53de4f3

miguelpeixe merged commit 353a3d8 into trunk Dec 12, 2024

miguelpeixe deleted the feat/content-distribution-post-meta branch December 12, 2024 18:36

github-actions bot added the needs-changelog label Dec 12, 2024

miguelpeixe removed the needs-changelog label Dec 12, 2024

matticbot added the released on @alpha label Jan 10, 2025

matticbot added the released label Jan 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(content-distribution): sync post meta #163

feat(content-distribution): sync post meta #163

Uh oh!

miguelpeixe commented Dec 10, 2024 •

edited

Loading

Uh oh!

naxoc left a comment

Uh oh!

naxoc Dec 12, 2024

Uh oh!

miguelpeixe Dec 12, 2024

Uh oh!

naxoc Dec 12, 2024

Uh oh!

miguelpeixe Dec 12, 2024

Uh oh!

miguelpeixe commented Dec 12, 2024

Uh oh!

github-actions bot commented Dec 12, 2024

Uh oh!

matticbot commented Jan 10, 2025

Uh oh!

matticbot commented Jan 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat(content-distribution): sync post meta #163

feat(content-distribution): sync post meta #163

Uh oh!

Conversation

miguelpeixe commented Dec 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing

Uh oh!

naxoc left a comment

Choose a reason for hiding this comment

Uh oh!

naxoc Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

miguelpeixe Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

naxoc Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

miguelpeixe Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

miguelpeixe commented Dec 12, 2024

Uh oh!

github-actions bot commented Dec 12, 2024

Uh oh!

matticbot commented Jan 10, 2025

Uh oh!

matticbot commented Jan 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

miguelpeixe commented Dec 10, 2024 •

edited

Loading