Sync: CLI: First pass at adding sync CLI commands by ebinnion · Pull Request #5933 · Automattic/jetpack

ebinnion · 2016-12-16T19:32:09Z

For our ATAT work on WP.com, it is necessary that we have the ability to script a full sync. This PR introduces a handful of commands that should be useful to @seanosh for ATAT work.

Here are the commands to test:

wp jetpack sync status
- This command retrieves the current sync status. The best way to test this is:
  - Go to REST api console and make a request to POST /sites/$site/sync
  - Immediately run wp jetpack sync status on your site to make sure that the status updates
wp jetpack sync start
- Run this command on your host
- Go to the REST api console, and run GET /sites/$site/sync/status a few times and verify that the status changes
wp jetpack sync start --modules=functions
- Run this command on your host
- Go to the REST api console, and run GET /sites/$site/sync/status and verify that functions is the only thing in config property.
wp jetpack sync_queue incremental peek
- This command will likely return Nothing is in the sync queue
wp jetpack sync sync_queue full peek
- Go to REST API console and trigger a POST /sites/$site/sync
- Immediately run wp jetpack sync sync_queue full peek and you should see things in the queue
- Note: This command only shows the top 100 things. In the future we could perhaps add paging? But, I don't think that's necessary for this first pass

enejb · 2016-12-16T19:33:56Z

class.jetpack-cli.php

 	}
+
+	public function sync( $args, $assoc_args ) {
+		if ( ! Jetpack::is_active() ) {


I think it would be great to check if other conditions for sync are meet. See sync_allowed method in https://github.com/Automattic/jetpack/blob/master/sync/class.jetpack-sync-actions.php#L91

enejb · 2016-12-16T19:36:54Z

class.jetpack-cli.php

+
+		switch ( $action ) {
+			case 'status':
+				require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-modules.php';


Could we reuse some of the sync status endpoint code by calling from it directly. Since it almost looks identical?

For the status command, I think we could easily make that happen. We'd need to refactor a bit to handle the wp jetpack sync queue and wp jetpack sync start commands though.

enejb · 2016-12-16T19:38:26Z

I really like this and can see how sites would use this when they do batch operations to make sure things are in sync.

dereksmart · 2016-12-16T19:51:38Z

class.jetpack-cli.php

Let's add some documentation to this command, so that wp jetpack sync --help will be helpful :)

If you follow the syntax of one of the other commands, you should get a nice helpful message back

dereksmart · 2016-12-16T19:59:27Z

class.jetpack-cli.php

just ! empty() will suffice for checking the variable. Won't throw a notice if not defined.

…opsis

lezama · 2016-12-17T18:10:09Z

json-endpoints/jetpack/class.jetpack-json-api-sync-endpoint.php

-				'full_queue_next_sync'  => ( $sender->get_next_sync_time( 'full_sync' ) - microtime( true ) ),
-			)
-		);
+		return Jetpack_Sync_Actions::get_sync_status();


lezama · 2016-12-17T18:25:56Z

Great work @ebinnion

I think is ready to merge.

I am just not sure about the syntax for wp jetpack sync_queue incremental peek, maybe wp jetpack sync peek --queue=incremental --num=100 would make more sense?

ebinnion · 2016-12-19T06:03:39Z

Good point. The reason I created a separate command for the queue, sync_queue instead of sync, is that we could benefit from the robust validation of WP Cli thorough the @synopsis argument. When we put all of the sync related stuff under the sync method, the @synopsis argument felt awkward to me.

gravityrail · 2016-12-19T19:59:43Z

sync/class.jetpack-sync-actions.php

 	}
+
+	static function get_sync_status() {
+		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-modules.php';


These first few lines could be written as:

self::initialize_sender(); $queue = self::$sender->get_sync_queue(); //...

dereksmart · 2016-12-20T14:07:53Z

4.5 0525012

Changelog: add #5867 Changelog: add #5874 Changelog: add #5905 Changelog: add #5906 Changelog: add #5931 Changelog: add #5933 Changelog: add #5934

@see

Changelog: add #5867 Changelog: add #5874 Changelog: add #5905 Changelog: add #5906 Changelog: add #5931 Changelog: add #5933 Changelog: add #5934 Bring over 4.4.2 changelog from branch-4.4 @see 18012a3 Changelog: add #5976, #5978, #5983 Changelog: add #5917 Changelog: add #5832 Changelog: add 4.4.2 release post link. CHangelog: add #5457 Changelog: add #5487 Changelog: add #5708 Changelog: add #5879 Changelog: add #5932 Changelog: add #5963 Changelog: add #5968 Changelog: add #5996 Changelog: add #5998 Changelog: add #5999 Changelog: add #6012 Changelog: add #6013 Changelog: add #6014 Changelog: add #6015 Changelog: add #6023 Changelog: add #6024 Changelog: add #6030 Changelog: add #5465 CHangelog: add #6063 Changelog: add #6025 Changelog: add #5974 Changelog: add #6059 Changelog: add #6046 Changelog: add #5418 Changelog: move things around and add missing information. Changelog: add #5565 Changelog: add #6087 Changelog: add #6095 Readme: add @tyxla to the list of contributors. Improved changelog for your readability and enjoyment updated the release date finalizing the changelog with a few more edits

akirk · 2017-01-30T12:31:16Z

class.jetpack-cli.php

+				$items = $queue->peek( 100 );
+
+				if ( empty( $items ) ) {
+					WP_CLI::log( sprintf( __( 'Nothing is in the %s queue', 'jetpack' ), $queue_name  ) );


Please don't create translatable strings like that. incremental and full can be integrated like that in English but this doesn't work for other languages, also translators need to know what the placeholder is (hint: translators: comment :) ). A string that works for a construct like you were using: Nothing is in the queue: %s

ebinnion added 3 commits December 16, 2016 12:25

Sync: CLI: First pass at adding sync status and full sync to WP CLI

301f46f

Sync: CLI: Add wp jetpack sync queue

c357e07

Sync: CLI: Reset sync settings if errored during initializing sync

d00ac46

ebinnion added [Feature] Jetpack CLI [Package] Sync [Pri] High [Status] In Progress labels Dec 16, 2016

ebinnion added this to the 4.5 milestone Dec 16, 2016

ebinnion self-assigned this Dec 16, 2016

ebinnion requested review from enejb, gravityrail and lezama December 16, 2016 19:32

enejb reviewed Dec 16, 2016

View reviewed changes

Sync: CLI: Add modules list to errored full sync start

1c78fc6

dereksmart reviewed Dec 16, 2016

View reviewed changes

Sync: CLI: Use more robust sync allowed method instead of is_active

f2912a4

dereksmart reviewed Dec 16, 2016

View reviewed changes

Sync: CLI: Factor out sync status from endpoint to Jetpack_Sync_Actions

c6a4e38

ebinnion force-pushed the update/wp-command-sync branch from 3b601fb to c6a4e38 Compare December 16, 2016 20:06

ebinnion added 5 commits December 16, 2016 14:33

Sync: CLI: Doc and various updates

bebfae4

Sync: CLI: Factor queue logic into a new sync_queue command

f12e750

Sync: CLI: Use friendlier queue names

1b7dd74

Sync: CLI: Remove unnecessary action validation, which is done by syn…

ce7740b

…opsis

Sync: CLI: Update sync_queue command doc

5c6f648

ebinnion added [Status] Needs Review This PR is ready for review. and removed [Status] In Progress labels Dec 16, 2016

lezama reviewed Dec 17, 2016

View reviewed changes

gravityrail reviewed Dec 19, 2016

View reviewed changes

Small cleanup of get_sync_status()

e0b701e

gravityrail merged commit b99224e into master Dec 19, 2016

gravityrail deleted the update/wp-command-sync branch December 19, 2016 20:18

gravityrail removed the [Status] Needs Review This PR is ready for review. label Dec 19, 2016

dereksmart restored the update/wp-command-sync branch December 20, 2016 14:03

jeherve added [Status] Needs Changelog and removed [Status] Needs Changelog labels Dec 21, 2016

jeherve added a commit that referenced this pull request Dec 21, 2016

Changelog: add #5933

2bcb49f

dereksmart pushed a commit that referenced this pull request Jan 17, 2017

Changelog: add #5866

d0a4697

Changelog: add #5867 Changelog: add #5874 Changelog: add #5905 Changelog: add #5906 Changelog: add #5931 Changelog: add #5933 Changelog: add #5934

akirk reviewed Jan 30, 2017

View reviewed changes

ebinnion mentioned this pull request Jan 30, 2017

CLI: Update translated string for sync queue #6233

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sync: CLI: First pass at adding sync CLI commands#5933

Sync: CLI: First pass at adding sync CLI commands#5933
gravityrail merged 12 commits intomasterfrom
update/wp-command-sync

ebinnion commented Dec 16, 2016 •

edited

Loading

Uh oh!

enejb Dec 16, 2016

Uh oh!

enejb Dec 16, 2016

Uh oh!

ebinnion Dec 16, 2016

Uh oh!

enejb commented Dec 16, 2016

Uh oh!

dereksmart Dec 16, 2016

Uh oh!

dereksmart Dec 16, 2016 •

edited

Loading

Uh oh!

lezama Dec 17, 2016

Uh oh!

lezama commented Dec 17, 2016

Uh oh!

ebinnion commented Dec 19, 2016 •

edited

Loading

Uh oh!

gravityrail Dec 19, 2016

Uh oh!

dereksmart commented Dec 20, 2016

Uh oh!

akirk Jan 30, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

ebinnion commented Dec 16, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

enejb Dec 16, 2016

Choose a reason for hiding this comment

Uh oh!

enejb Dec 16, 2016

Choose a reason for hiding this comment

Uh oh!

ebinnion Dec 16, 2016

Choose a reason for hiding this comment

Uh oh!

enejb commented Dec 16, 2016

Uh oh!

dereksmart Dec 16, 2016

Choose a reason for hiding this comment

Uh oh!

dereksmart Dec 16, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lezama Dec 17, 2016

Choose a reason for hiding this comment

Uh oh!

lezama commented Dec 17, 2016

Uh oh!

ebinnion commented Dec 19, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gravityrail Dec 19, 2016

Choose a reason for hiding this comment

Uh oh!

dereksmart commented Dec 20, 2016

Uh oh!

akirk Jan 30, 2017

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ebinnion commented Dec 16, 2016 •

edited

Loading

dereksmart Dec 16, 2016 •

edited

Loading

ebinnion commented Dec 19, 2016 •

edited

Loading