Changeset 10111

Timestamp:

08/03/2020 05:12:17 PM (4 years ago)

Author:

ryelle

Message:

Plugin Directory: Add a total size check for block plugins

This will trigger a warning if the total size of the plugin exceeds 1MB. A larger plugin will cause a longer wait when inserting into the editor, which degrades the user experience.

See #5303

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• cli/class-block-plugin-checker.php (modified) (1 diff)
• shortcodes/class-block-validator.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php

@@ -826 +826 @@
 
     /**
+     * File size check for downloads.
+     */
+    function check_total_size() {
+        $files = Filesystem::list_files( $this->path_to_plugin, true );
+        $total_size = 0;
+        foreach ( $files as $file ) {
+            $total_size += filesize( $file );
+        }
+        if ( $total_size > 1 * MB_IN_BYTES ) {
+            $this->record_result(
+                __FUNCTION__,
+                'warning',
+                // translators: %s is the file size.
+                sprintf( __( 'Plugin size is %s.', 'wporg-plugins' ), size_format( $total_size ) ),
+                $total_size
+            );
+        }
+    }
+
+    /**
      * Check that the plugin uses `wp_set_script_translations`.
      */

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php

@@ -324 +324 @@
                     'https://developer.wordpress.org/block-editor/developers/internationalization/'
                 );
+            case 'check_total_size':
+                return __( 'Larger plugins will take longer to install. This is more noticeable in the Block Directory, where the user expects blocks to be added immediately. Try reducing your file size by optimizing images & SVGs, only including the assets you need (images, fonts, etc), and using core-provided JavaScript libraries.', 'wporg-plugins' );
             // This is a special case, since multiple values may be collapsed.
             case 'check_block_json_is_valid':