feat(content-distribution): editor plugin for distribution #167

miguelpeixe · 2024-12-11T20:27:16Z

Implements an editor plugin for distributing a post.

My original intention was to strictly leverage editPost() and savePost() dispatches to update the distribution post meta and let our short-circuit hook handle validation. This did not work well for error handling, as there was no straightforward way to pass the error message to the editor. Because of that, I switched to an API endpoint.

Selecting connections and distributing

Updating connections

Error message

Distributing an unsaved post

To prevent distributing an outdated version of the post, if the post has unsaved changes we'll enforce a post save before distributing:

A lot of nodes

Testing

This PR also inaugurates javascript assets to the plugin. Before anything, make sure to run npm ci && npm run build

Make sure you have a network setup with a hub and 2 nodes and define( 'NEWPACK_NETWORK_CONTENT_DISTRIBUTION', true ); on all instances config
Draft a new post in the hub and click the globe icon as referenced in the first image above
Confirm the nodes are available for distribution
Make changes to the post and confirm the button changes from "Distribute" to "Save & Distribute"
Save the post and confirm the button is back to "Distribute"
Select one node and click "Distribute"
Confirm you get the pending state as in the image above and the snackbar notice on success
Confirm the selected node is now checked and disabled
Click "Select all" and confirm the other node gets selected
Click Distribute and confirm you get the same successful result
Confirm on the nodes that the post is distributed
Edit the post in one of the nodes and confirm the editor plugin (globe icon) is not available

Multiple nodes

Replace line 57 of src/content-distribution/distribute/index.js with:

	const sites = [];
	for( let i = 0; i < 100; i++ ) {
		sites.push( `https://node${ i + 1}.local` );
	}

Edit a post and confirm the plugin sidebar renders with a scrollbar

Error handling

Add the following to line 78 of includes/content-distribution/class-outgoing-post.php:

return new WP_Error( 'test_error', 'This is my error message. Try distributing again.' );

Attempt to distribute a post via the editor and confirm you get the error notice.

* 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)

…tiple dispatches

…ibute-ui

miguelpeixe · 2024-12-18T16:35:36Z

We have talked about this before and concluded that we do want this! That removes some complexity on status handling... and also it's how Distributor does it

Sounds good! How about messaging? We just leave the button disabled or do we add something extra?

miguelpeixe · 2024-12-18T16:45:10Z

Added the non-publish post restriction in 0f7f73d

miguelpeixe · 2024-12-18T16:48:12Z

We have talked about this before and concluded that we do want this! That removes some complexity on status handling... and also it's how Distributor does it

Sounds good! How about messaging? We just leave the button disabled or do we add something extra?

Or maybe we do a "Publish & Distribute" in this case, instead of disabling it 🤔

thomasguillot · 2024-12-18T17:34:22Z

Or maybe we do a "Publish & Distribute" in this case, instead of disabling it

Too dangerous. A publisher might find useful the "pre-publish checks" sidebar and add tags etc...

thomasguillot · 2024-12-18T17:39:16Z

Sounds good! How about messaging? We just leave the button disabled or do we add something extra?

I'd change the description to something like: "This [post_type_singularname] has not been published yet. Please publish the [post_type_singularname] before distributing it to any connections."

leogermani · 2024-12-18T17:48:31Z

I'd change the description to something like: "This [post_type_singularname] has not been published yet. Please publish the [post_type_singularname] before distributing it to any connections."

Ah, I meant to comment on that. "Connections" is a Distributor plugin concept. Not sure if we need/want to use that here... they are "sites in the network"... or just "sites"

miguelpeixe · 2024-12-18T18:28:35Z

"Network site(s)" is a common occurrence. Maybe that?

miguelpeixe · 2024-12-18T19:11:24Z

Here's an example with the new paragraph using the proposed "network site" label:

Updated in 5f57b6a, let me know if I should tweak the "connection/network site" labeling.

cc @leogermani @thomasguillot

…e plugin

leogermani · 2024-12-18T21:25:18Z

For the yellow notice saying that the post is distributed to other sites, I think it will break the UI if the list has too many sites (not that many actually)... Maybe just display the number of sites? Is it possible to add a "Manage" link that opens the sidebar panel?

miguelpeixe · 2024-12-18T21:29:09Z

For the yellow notice saying that the post is distributed to other sites, I think it will break the UI if the list has too many sites (not that many actually)... Maybe just display the number of sites?

Good call! Updated in 649cf97

Is it possible to add a "Manage" link that opens the sidebar panel?

Unfortunately, the notice only supports a string. We also have to give up on the icon for the linked post notice...

naxoc

Tested again and it works great. I'm also much happier with wording and the before-published behaviour 👍

naxoc · 2024-12-18T13:06:57Z

includes/class-content-distribution.php

 use Newspack_Network\Content_Distribution\Incoming_Post;
 use Newspack_Network\Content_Distribution\Outgoing_Post;
 use WP_Post;
+use WP_Error;


This one is unused ;)

Whoops! Removed in 9a1516f

miguelpeixe · 2024-12-20T14:44:48Z

Thank you @naxoc, @thomasguillot, and @leogermani for your reviews here! 🙇

github-actions · 2024-12-20T14:45:11Z

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:29:55Z

🎉 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:07Z

🎉 This PR is included in version 2.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

miguelpeixe and others added 12 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

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)

feat(content-distribution): editor plugin for distribution

ff54819

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

miguelpeixe added 11 commits December 12, 2024 10:23

Merge branch 'trunk' into feat/distribute-ui

3405a39

feat: editor class and sidebar form

72590c5

refactor: schema

527592b

Merge branch 'trunk' into feat/distribute-ui

437514f

feat: more ui

25f4d85

feat: control meta and distribute on meta updates

4874286

Merge branch 'trunk' into feat/distribute-ui

30de590

fix: cli distribution method usage

f7720d1

feat: validate distribution

61f19c0

feat: control distributed meta and prevent multiple dispatches

d2bc1a9

feat(content-distribution): control distribution meta and prevent mul…

897bea8

…tiple dispatches

miguelpeixe changed the base branch from trunk to feat/content-distribution-control-meta December 13, 2024 19:21

miguelpeixe added 5 commits December 13, 2024 16:22

Merge branch 'feat/content-distribution-control-meta' into feat/distr…

e7e17b3

…ibute-ui

fix: incorrect prop

767a2cd

fix: optimize post meta update

58ed274

chore: simplify code

d19f657

Merge branch 'feat/content-distribution-control-meta' into feat/distr…

03fbf14

…ibute-ui

feat: prevent non-published posts from being distributed

0f7f73d

chore: lint

fba7129

miguelpeixe added 2 commits December 18, 2024 16:13

fix: better ui for non-publish post and use post type label across th…

5f57b6a

…e plugin

chore: simplify disabled check

af61ce1

fix: change notice text

649cf97

naxoc approved these changes Dec 20, 2024

View reviewed changes

miguelpeixe added 2 commits December 20, 2024 11:43

chore: remove unused import

9a1516f

Merge branch 'trunk' into feat/distribute-ui

40c67b2

miguelpeixe merged commit e10aef4 into trunk Dec 20, 2024
3 of 4 checks passed

miguelpeixe deleted the feat/distribute-ui branch December 20, 2024 14:45

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

miguelpeixe removed the needs-changelog label Dec 20, 2024

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

matticbot added the released label Jan 20, 2025

feat(content-distribution): editor plugin for distribution #167

feat(content-distribution): editor plugin for distribution #167

Uh oh!

Conversation

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

Uh oh!

Selecting connections and distributing

Updating connections

Error message

Distributing an unsaved post

A lot of nodes

Testing

Multiple nodes

Error handling

Uh oh!

miguelpeixe commented Dec 18, 2024

Uh oh!

miguelpeixe commented Dec 18, 2024

Uh oh!

miguelpeixe commented Dec 18, 2024

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

leogermani commented Dec 18, 2024

Uh oh!

miguelpeixe commented Dec 18, 2024

Uh oh!

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

Uh oh!

Uh oh!

leogermani commented Dec 18, 2024

Uh oh!

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

Uh oh!

Uh oh!

naxoc left a comment

Choose a reason for hiding this comment

Uh oh!

naxoc Dec 18, 2024

Choose a reason for hiding this comment

Uh oh!

miguelpeixe Dec 20, 2024

Choose a reason for hiding this comment

Uh oh!

miguelpeixe commented Dec 20, 2024

Uh oh!

Uh oh!

github-actions bot commented Dec 20, 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!

6 participants

miguelpeixe commented Dec 11, 2024 •

edited

Loading

thomasguillot commented Dec 18, 2024 •

edited

Loading

thomasguillot commented Dec 18, 2024 •

edited

Loading

miguelpeixe commented Dec 18, 2024 •

edited

Loading

miguelpeixe commented Dec 18, 2024 •

edited

Loading