Add Auto Update #16

emdashcodes · 2017-06-28T18:54:58Z

This PR makes it so that the wc-api-dev plugin can auto update itself as new (non prerelease) releases come out on GitHub.

This can be disabled by setting the constant WC_API_DEV_AUTO_UPDATE to false.

To Test:

This must be tested on install that does not use version control (including root WP). Optionally, you could comment out the is_vcs_checkout check from here.
Install this branch into wc-api-dev. Download and install from zip.
Use this helper gist. Save it as auto-update.php in your root WordPress folder. This is so you can force an auto update, and ignore the lock mechanism... otherwise you have to wait for transients to expire.
Open wc-api-dev.php and readme.txt and just set the version to something lower, like 0.4.0. This is to trick the system into thinking the plugin is out of date.
Go to the plugins page and click 'View Version 0.5.0' and you should see some basic plugin info.
Run php auto-update.php from the command line in your root WordPress folder.
WordPress should auto update. If it worked, you should see your wc-api-dev.php and readme.txt have the latest version tag, and the auto upgrade code will be gone too, since the current release doesn't have it.

jeffstieler · 2017-06-28T19:04:15Z

auto-update.php

+	 * Adds the wc-api-dev plugin to the list of allowed plugins for auto update.
+	 */
+	function auto_update( $update, $item ) {
+		if ( in_array( $item->slug, array( 'wc-api-dev' ) ) ) {


Why not use a simple string comparison here?

if ( 'wc-api-dev' === $item->slug ) {

jeffstieler · 2017-06-28T19:04:59Z

auto-update.php

+			$request_uri = 'https://api.github.com/repos/woocommerce/wc-api-dev/releases';
+			$response = json_decode( wp_remote_retrieve_body( wp_remote_get( $request_uri ) ), true );
+			if ( is_array( $response ) ) {
+				foreach( $response as $entry ) {


Missing space after foreach.

jeffstieler · 2017-06-28T19:06:48Z

auto-update.php

+	 * Add our plugin to the list of plugins to update, if we find the version is out of date.
+	 */
+	public function modify_transient( $transient ) {
+		if( property_exists( $transient, 'checked' ) && $transient->checked ) {


Missing space after if.

jeffstieler · 2017-06-28T19:10:08Z

auto-update.php

+		if( property_exists( $transient, 'checked' ) && $transient->checked ) {
+			$checked = $transient->checked;
+			$this->maybe_fetch_github_response();
+			$out_of_date = version_compare( $this->github_response['tag_name'], $checked[ $this->file ], 'gt' );


We should check github_response for 'tag_name' and $checked for $this->file to avoid warnings.

Nitpick: WP core uses '>' for version_compare() calls.

jeffstieler · 2017-06-28T19:10:32Z

auto-update.php

+			$checked = $transient->checked;
+			$this->maybe_fetch_github_response();
+			$out_of_date = version_compare( $this->github_response['tag_name'], $checked[ $this->file ], 'gt' );
+			if( $out_of_date ) {


Missing space after if.

jeffstieler · 2017-06-28T19:11:03Z

auto-update.php

+					'plugin'      => $this->file,
+					'slug'        => 'wc-api-dev',
+					'package'     => $this->github_response['zipball_url'],
+					'new_version' => $this->github_response['tag_name']


To avoid PHP warnings, we should check github_response for these array keys before accessing them.

Addressed. For this one, I am now bailing early and not modifying the transient, if we don't have the correct GitHub response.

jeffstieler · 2017-06-28T19:16:08Z

auto-update.php

+	 */
+	public function plugin_popup( $result, $action, $args ) {
+		if ( ! empty( $args->slug ) ) {
+			if ( $args->slug === current( explode( '/' , $this->file ) ) ) {


Why not hardcode a check for 'wc-api-dev' here?

jeffstieler · 2017-06-28T19:16:42Z

auto-update.php

+				$plugin = array(
+					'name'              => $plugin['Name'],
+					'slug'              => $this->file,
+					'version'           => $this->github_response['tag_name'],


Same comment about checking github_response before accessing.

jeffstieler · 2017-06-28T19:25:46Z

auto-update.php

+	}
+
+	/**
+	 * Move the updated plugin to the correct directory, and reactivate the plugin.


Please include a comment as to why this is necessary. I assume because the Github zip has a short hash in the filename?

jeffstieler · 2017-06-28T19:26:08Z

auto-update.php

+	/**
+	 * Move the updated plugin to the correct directory, and reactivate the plugin.
+	 */
+	public function after_install( $response, $hook_extra, $result ) {


Doesn't this need to be restricted to only the wc-api-dev plugin?

jeffstieler

One small nitpick, otherwise the changes look good.

jeffstieler · 2017-06-28T20:39:44Z

auto-update.php

+				$tag_name = ! empty( $this->github_response['tag_name'] ) ? $this->github_response['tag_name'] : '';
+				$published_at = ! empty( $this->github_response['published_at'] ) ? $this->github_response['published_at'] : '';
+				$body = ! empty( $this->github_response['body'] ) ? $this->github_response['body'] : '';
+				$zipball_url = ! empty( $this->github_response['zipball_url'] ) ? $this->github_response['zipball_url'] : '';


Nitpick - WP coding standard is to test the positive first. See: https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/#ternary-operator

@jeffstieler "An exception would be using ! empty(), as testing for false here is generally more intuitive.".

For shame. That'll learn me to read.

ryelle

Looks good, & test worked for me 👍

emdashcodes added Status: Needs Review Type: Enhancement labels Jun 28, 2017

emdashcodes self-assigned this Jun 28, 2017

emdashcodes requested review from allendav, belcherj, jeffstieler and ryelle June 28, 2017 18:54

Add auto update

da1e635

emdashcodes force-pushed the add/auto-updates branch from a90f90d to da1e635 Compare June 28, 2017 18:59

jeffstieler suggested changes Jun 28, 2017

View reviewed changes

jeffstieler added Status: Needs Author Reply / Changes and removed Status: Needs Review labels Jun 28, 2017

Handle PR feedback

286edc3

emdashcodes added Status: Needs Review and removed Status: Needs Author Reply / Changes labels Jun 28, 2017

jeffstieler suggested changes Jun 28, 2017

View reviewed changes

jeffstieler approved these changes Jun 28, 2017

View reviewed changes

emdashcodes changed the title ~~WooCommerce: Add Auto Update~~ Add Auto Update Jun 29, 2017

ryelle approved these changes Jun 29, 2017

View reviewed changes

emdashcodes merged commit f734013 into master Jun 29, 2017

emdashcodes deleted the add/auto-updates branch June 29, 2017 18:58

emdashcodes mentioned this pull request Aug 1, 2017

Fix plugin auto update logic #37

Merged

Add Auto Update #16

Add Auto Update #16

Uh oh!

Conversation

emdashcodes commented Jun 28, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeffstieler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ryelle left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants