Support 'wporg_status' and 'wporg_last_updated' as optional `wp plugin list` fields #382

janw-me · 2023-11-10T17:15:12Z

Extends wp plugin list with the fields:

wp_org which will get the wp.org status (active, closed or empty)
wp_org_updated which will get the last svn commit date if it's a wp.org plugin.

These fields will take a look at the status of the plugin on wordpress.org and if it ever was a .org plugin it can display the last commit date.

Related wp-cli/wp-cli#5859

schlessera · 2023-11-10T17:22:35Z

@janw-me the API-specific stuff should be included in the WpOrgApi class found in wp-cli/wp-cli.

danielbachhuber

Great start!

I'd like to standardize on wporg_status and wporg_last_updated as the key names.

src/Plugin_Command.php

danielbachhuber · 2023-11-10T22:05:59Z

src/Plugin_Command.php

+	protected function get_wporg_data( $plugin_name ) {
+		$data = [
+			'status'       => 'no_wp_org',
+			'last_updated' => '-',


Suggested change

'last_updated' => '-',

'last_updated' => '',

We can leave this empty when it's not present.

danielbachhuber · 2023-11-10T22:06:15Z

src/Plugin_Command.php

+	 */
+	protected function get_wporg_data( $plugin_name ) {
+		$data = [
+			'status'       => 'no_wp_org',


Suggested change

'status' => 'no_wp_org',

'status' => '',

We can leave this empty when it's not present.

I was not happy about the label itself.
But personally I prefer when a check like this tells "something". Empty can feel like an unknown failure.

Are there other places where we leave fields empty?

Are there other places where we leave fields empty?

Yes:

danielbachhuber · 2023-11-10T22:07:05Z

src/Plugin_Command.php

+			// Just because the plugin is not in the api, does not mean it was never on .org.
+		}
+
+		$request       = wp_remote_get( "https://plugins.trac.wordpress.org/log/{$plugin_name}/?limit=1&mode=stop_on_copy&format=rss" );


Should we only make this request if we're checking for the date?

I made a better check in d7ec274
The answer is, not always,

When the call to api.wp is not succesfull, we need to check the SVN to distinguish between closed and never on .org.

janw-me · 2023-11-11T15:53:00Z

I'd like to standardize on wporg_status and wporg_last_updated as the key names.

Relabeling done in: fd9a235

janw-me · 2023-11-11T16:12:18Z

@janw-me the API-specific stuff should be included in the WpOrgApi class found in wp-cli/wp-cli.

Fixed in 71a1d23
Personally I don't think this is better, as this does the whole request instead of the HEAD.
But I also value consistency , so fine.

swissspidy · 2023-11-24T10:28:01Z

src/Plugin_Command.php

+				'auto_update'        => false,
+				'author'             => $item_data['Author'],
+				'wporg_status'       => 'no_wp_org',
+				'wporg_last_updated' => '-',


As per another comment, let's leave this empty per default instead

Suggested change

'wporg_last_updated' => '-',

'wporg_last_updated' => '',

schlessera · 2023-12-08T09:25:28Z

Personally I don't think this is better, as this does the whole request instead of the HEAD.

@janw-me Note: The WpOrgApi class can be adapted to make sure it fulfills all the requirements, of course. It is not considered feature-complete at this point and was meant to be extended/improved as needed.

I'll see how we can adapt it so it does not unnecessarily do the full request.

danielbachhuber · 2023-12-08T21:37:46Z

@janw-me Once your PR is ready, can you also update the PR description with details on how the new feature works? Thanks!

danielbachhuber

Great work on this, @janw-me !

I made a couple of tweaks (c927a46, 9d97c95) and regenerated the README (1dc730e).

Also, as a FYI for the future, please create a feature branch for pull requests as it makes things a bit easier to work with.

janw-me · 2023-12-13T10:03:05Z

I made a couple of tweaks (c927a46, 9d97c95) and regenerated the README (1dc730e).

Great additions.

Also, as a FYI for the future, please create a feature branch for pull requests as it makes things a bit easier to work with.

Will keep this in mind next time 👍

janw-me added 6 commits November 10, 2023 13:01

Plugins show their .org status.

0c695a5

Split the fields to check for wporg and date seperatatly.

342aaa1

Temp behat file to check

51b645b

Merge branch 'main' of github.com:wp-cli/extension-command

8d05f43

Added hints for behat that need to be implemented.

28f9a97

phpcs fixes.

bcbb215

janw-me requested a review from a team as a code owner November 10, 2023 17:15

janw-me added 4 commits November 10, 2023 19:46

Also add wp-org checks to mu-plugins.

37472a1

Added behat tests.

665a5eb

Allow to select the status on wporg as a single field.

1cec36e

Added Behat tests.

d12a9a6

danielbachhuber reviewed Nov 10, 2023

View reviewed changes

janw-me added 2 commits November 11, 2023 16:35

Better check for active plugins.

d7ec274

Renamed wporg keys

fd9a235

Replaced the api.wp call with the appropriate class.

71a1d23

janw-me added 3 commits November 19, 2023 20:35

replaced test plugin Akismet, because it's failing php version tests.

a171f4c

Fixed a missed rename.

a6e5b0b

Dropins need a hardcoded exception for wp.org status.

096ab96

swissspidy reviewed Nov 24, 2023

View reviewed changes

janw-me added 2 commits December 12, 2023 19:59

Removed all no_wp_org key words.

f5895b8

Merge remote-tracking branch 'origin/main'

09d1311

danielbachhuber added command:plugin command:plugin-list labels Dec 12, 2023

danielbachhuber added this to the 2.1.17 milestone Dec 12, 2023

danielbachhuber changed the title ~~Check if Installed Plugins Are No Longer in the Plugin Directory~~ Support 'wporg_status' and 'wporg_last_updated' as optional wp plugin list fields Dec 12, 2023

danielbachhuber added 3 commits December 12, 2023 13:51

Fix the feature name in Behat

c927a46

Add an example to the command doc

9d97c95

Regenerate README

1dc730e

danielbachhuber approved these changes Dec 12, 2023

View reviewed changes

danielbachhuber merged commit 12618c7 into wp-cli:main Dec 12, 2023
36 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support 'wporg_status' and 'wporg_last_updated' as optional `wp plugin list` fields #382

Support 'wporg_status' and 'wporg_last_updated' as optional `wp plugin list` fields #382

janw-me commented Nov 10, 2023 •

edited

schlessera commented Nov 10, 2023

danielbachhuber left a comment

danielbachhuber Nov 10, 2023

danielbachhuber Nov 10, 2023

janw-me Nov 11, 2023

danielbachhuber Dec 6, 2023

danielbachhuber Nov 10, 2023

janw-me Nov 11, 2023

janw-me commented Nov 11, 2023

janw-me commented Nov 11, 2023

swissspidy Nov 24, 2023

schlessera commented Dec 8, 2023

danielbachhuber commented Dec 8, 2023

danielbachhuber left a comment

janw-me commented Dec 13, 2023

Support 'wporg_status' and 'wporg_last_updated' as optional wp plugin list fields #382

Support 'wporg_status' and 'wporg_last_updated' as optional wp plugin list fields #382

Conversation

janw-me commented Nov 10, 2023 • edited

schlessera commented Nov 10, 2023

danielbachhuber left a comment

Choose a reason for hiding this comment

danielbachhuber Nov 10, 2023

Choose a reason for hiding this comment

danielbachhuber Nov 10, 2023

Choose a reason for hiding this comment

janw-me Nov 11, 2023

Choose a reason for hiding this comment

danielbachhuber Dec 6, 2023

Choose a reason for hiding this comment

danielbachhuber Nov 10, 2023

Choose a reason for hiding this comment

janw-me Nov 11, 2023

Choose a reason for hiding this comment

janw-me commented Nov 11, 2023

janw-me commented Nov 11, 2023

swissspidy Nov 24, 2023

Choose a reason for hiding this comment

schlessera commented Dec 8, 2023

danielbachhuber commented Dec 8, 2023

danielbachhuber left a comment

Choose a reason for hiding this comment

janw-me commented Dec 13, 2023

Support 'wporg_status' and 'wporg_last_updated' as optional `wp plugin list` fields #382

Support 'wporg_status' and 'wporg_last_updated' as optional `wp plugin list` fields #382

janw-me commented Nov 10, 2023 •

edited