Feature request: add sync-missing command to wp client. #7

juliquiron · 2019-04-05T09:16:27Z

The problem
Some generated images can be removed or deleted for multiple reasons. When this happen the bulk optimizer can not re-optimize it again as long are already registered as optimized and no missing images to be optimized are detected.

Proposed solution
Implement a method to check if all expected images to be in the file system are really there. If not present then update the DB registry to let the bulk optimizer to be able to process it.

This PR implements a new wp command optimus sync-missing that performs this operation. The feature can be exposed also to the management pages, but is not done in this PR.

sun

👍 Most of the changes are just moving existing code to be able to re-use it in the new command.

I'd recommend to rename the title of this PR to: "Add WP-CLI command to synchronize WebP image attachment optimization status with filesystem."

sun · 2019-04-12T10:56:22Z

inc/optimus_cli.class.php

@@ -99,6 +129,11 @@ public static function add_commands() {
                ),
            ),
        ));
+
+        $cmd_syncmissing = function() { self::syncMissing(); };
+        WP_CLI::add_command( 'optimus sync-missing', $cmd_syncmissing, array(


Suggested change

WP_CLI::add_command( 'optimus sync-missing', $cmd_syncmissing, array(

WP_CLI::add_command( 'optimus webp sync', $cmd_syncmissing, array(

I would recommend to rename the (sub)command to wp optimus webp sync, so that the plugin is able to introduce further subcommands related to webp images in the future.

I would prefer it like that as well. Would it make sense to align the function syncMissing to syncMissingWebp?

inc/optimus_cli.class.php

sun · 2019-04-12T11:10:15Z

To be more clear on the actual problem:

In our case, the Optimus bulk image optimizer reported that 100% of all images would have been converted to webp already. But when testing random sample pages, various images were not served as webp, because they were not optimized yet.

It's not clear why the webp versions no longer exist (or whether they ever existed), but that is not the point of this PR. Instead, we want to synchronize the webp status in the database with the actual files in the filesystem.

Another solution would probably have been to implement some code to automatically check and generate missing webp images whenever a post/product is saved in WordPress, so as to ensure that there won't be missing webp images in the future. However, since we need to ensure this for all existing images right now, a bulk operation on the command line seemed more appropriate.

svenba · 2019-05-08T05:49:48Z

inc/optimus_cli.class.php

+     * Note: only works with convert to webp is enabled.
+     */
+    public static function syncMissing () {
+      $options = Optimus::get_options();


Please use 4 spaces for indentation.

juliquiron · 2019-05-09T07:07:43Z

Re-pushed with all the feedback integrated on it. Hope now is ok! 👍

sun

@juliquiron Thanks! 👍 Some minor adjustments are remaining, mostly regarding the documentation. Can you quickly fixup those?

sun · 2019-05-09T08:28:18Z

inc/optimus_cli.class.php

+
+        $cmd_syncmissing = function() { self::syncMissingWebp(); };
+        WP_CLI::add_command( 'optimus webp sync', $cmd_syncmissing, array(
+            'shortdesc' => 'Detects missing optimized assets.',


Suggested change

'shortdesc' => 'Detects missing optimized assets.',

'shortdesc' => 'Synchronizes actual webp file optimization status and missing files on disk with database.',

sun · 2019-05-09T08:29:10Z

inc/optimus_cli.class.php

+            foreach($assets as $asset_path) {
+                if (stream_resolve_include_path($asset_path) === FALSE) {
+                    $metadata = wp_get_attachment_metadata($post['ID']);
+                    // Unregister the optimus flags when the file is not longer there.


Suggested change

// Unregister the optimus flags when the file is not longer there.

// Remove the optimus metadata when the file does not exist.

sun · 2019-05-09T08:29:17Z

inc/optimus_cli.class.php

+
+        foreach ($posts as $key => $post) {
+            $assets = Optimus_Request::get_files_paths($post['ID']);
+            foreach($assets as $asset_path) {


Suggested change

foreach($assets as $asset_path) {

foreach ($assets as $asset_path) {

sun · 2019-05-09T08:32:39Z

inc/optimus_cli.class.php

+                    // Unregister the optimus flags when the file is not longer there.
+                    unset($metadata['optimus']);
+                    update_post_meta($post['ID'], '_wp_attachment_metadata', $metadata);
+                    // Registries works at post level.


Suggested change

// Registries works at post level.

// No need to check further files as the whole attachment

// will be re-optimized.

sun · 2019-05-09T08:33:46Z

inc/optimus_cli.class.php

+            WP_CLI::error('sync-missing command only syncs webp missing images. Looks like you don\'t have this setting enabled.', TRUE);
+        }
+
+        // Retrieves the post ids with optimized assets registered in the DB.


Suggested change

// Retrieves the post ids with optimized assets registered in the DB.

// Retrieve all post IDs with positive optimization status in database.

sun · 2019-05-09T08:37:47Z

inc/optimus_cli.class.php

+     * sync-missing command.
+     *
+     * Checks if all the registered files really have the optimized version.
+     * Note: only works with convert to webp is enabled.


Suggested change

* Note: only works with convert to webp is enabled.

* Note: Only works if convert to webp is enabled.

sun · 2019-05-09T08:38:28Z

inc/optimus_cli.class.php

+     * Checks if all the registered files really have the optimized version.
+     * Note: only works with convert to webp is enabled.
+     */
+    public static function syncMissingWebp () {


Suggested change

public static function syncMissingWebp () {

public static function webpSync () {

sun · 2019-05-09T08:38:47Z

inc/optimus_cli.class.php

@@ -99,6 +129,11 @@ public static function add_commands() {
                ),
            ),
        ));
+
+        $cmd_syncmissing = function() { self::syncMissingWebp(); };


Suggested change

$cmd_syncmissing = function() { self::syncMissingWebp(); };

$cmd_syncmissing = function() { self::webpSync(); };

sun · 2019-05-09T08:40:26Z

inc/optimus_management.class.php

+    }
+
+    /**
+    * Bulk optimizer collect assets


Here and in PHPDoc blocks below: Wrong indentation of PHPDoc lines after the first.

sun · 2019-05-09T08:41:06Z

inc/optimus_request.class.php

+       $files = self::_get_files($metadata, $post_id);
+       $post_files = array();
+
+       foreach( $files as $file ) {


Suggested change

foreach( $files as $file ) {

foreach ( $files as $file ) {

juliquiron · 2019-05-21T10:27:06Z

@svenba all the relevant feedback have been incorporated in c6d7354.

Also in 68dc1e9 I tried to fix the PHPDoc indenting as suggested. Feel free to add or discard it :)

svenba · 2022-06-01T08:09:08Z

Some formatting issue are not fixed and feedback was not properly implemented (e.g. "public static function webpSync"). We can merge this if you provide a clean PR (single commit).

Added sync-missing command to wp client.

817e2a7

sun reviewed Apr 12, 2019

View reviewed changes

svenba reviewed May 8, 2019

View reviewed changes

Fixed broken command when no metadata available.

ec1a26c

juliquiron force-pushed the master branch from 25182b3 to ec1a26c Compare May 9, 2019 07:07

sun reviewed May 9, 2019

View reviewed changes

juliquiron added 2 commits May 21, 2019 11:29

fixup! code comments feedback

c6d7354

Fixed PHPDoc indenting and meaningless empty lines.

68dc1e9

fixup! Fixed PHPDoc indenting and meaningless empty lines.

a11fe21

sun mentioned this pull request Aug 16, 2019

WebP files are not deleted when attachment is deleted #10

Open

svenba closed this Jun 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature request: add sync-missing command to wp client. #7

Feature request: add sync-missing command to wp client. #7

juliquiron commented Apr 5, 2019

sun left a comment

sun Apr 12, 2019

svenba May 8, 2019

sun commented Apr 12, 2019

svenba May 8, 2019

juliquiron commented May 9, 2019

sun left a comment

sun May 9, 2019

sun May 9, 2019

sun May 9, 2019

sun May 9, 2019

sun May 9, 2019

sun May 9, 2019

sun May 9, 2019

sun May 9, 2019

sun May 9, 2019

sun May 9, 2019

juliquiron commented May 21, 2019

svenba commented Jun 1, 2022

	WP_CLI::add_command( 'optimus sync-missing', $cmd_syncmissing, array(
	WP_CLI::add_command( 'optimus webp sync', $cmd_syncmissing, array(

	'shortdesc' => 'Detects missing optimized assets.',
	'shortdesc' => 'Synchronizes actual webp file optimization status and missing files on disk with database.',

	// Unregister the optimus flags when the file is not longer there.
	// Remove the optimus metadata when the file does not exist.

	foreach($assets as $asset_path) {
	foreach ($assets as $asset_path) {

	// Registries works at post level.
	// No need to check further files as the whole attachment
	// will be re-optimized.

	// Retrieves the post ids with optimized assets registered in the DB.
	// Retrieve all post IDs with positive optimization status in database.

	* Note: only works with convert to webp is enabled.
	* Note: Only works if convert to webp is enabled.

	public static function syncMissingWebp () {
	public static function webpSync () {

	$cmd_syncmissing = function() { self::syncMissingWebp(); };
	$cmd_syncmissing = function() { self::webpSync(); };

Feature request: add sync-missing command to wp client. #7

Feature request: add sync-missing command to wp client. #7

Conversation

juliquiron commented Apr 5, 2019

sun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sun commented Apr 12, 2019

Choose a reason for hiding this comment

juliquiron commented May 9, 2019

sun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliquiron commented May 21, 2019

svenba commented Jun 1, 2022