Changeset 10065

Timestamp:

07/13/2020 07:40:02 PM (5 years ago)

Author:

ryelle

Message:

Plugin Directory: Update duplicate block name check

Switches the check to flag an error if we find the block name in a different repo plugin, or a warning if the found block has the same author.

See #5303

Location:

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

Files:

• cli/class-block-plugin-checker.php (modified) (3 diffs)
• shortcodes/class-block-validator.php (modified) (3 diffs)

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

@@ -400 +400 @@
     /**
      * Does the plugin have a block name that already exists in the DB?
-     * Note that this isn't a blocker if we're re-running checks on a plugin that has already been uploaded, since it will match with itself.
+     * Note that this does not flag a match if we can tell it's the same plugin already in the repo. It will only
+     * trigger a warning if we identify the matched plugin to be the same author, and will trigger an error in all
+     * other cases.
      */
     function check_for_duplicate_block_name() {
         foreach ( $this->blocks as $block ) {
-            if ( !trim( strval( $block->name ) ) )
+            if ( ! trim( strval( $block->name ) ) ) {
                 continue;
+            }
 
             $query_args = array(
@@ -413 +416 @@
                         'key' => 'block_name',
                         'value' => $block->name,
-                    )
-                )
+                    ),
+                ),
             );
 
@@ -420 +423 @@
             if ( $query->found_posts > 0 ) {
                 foreach ( $query->posts as $post ) {
-                    if ( $this->slug && $this->slug === $post->post_name )
-                        continue; // It's this very same plugin
-
-                    $this->record_result( __FUNCTION__,
-                        'info',
-                        sprintf( __( 'Block name %s already exists in plugin %s.', 'wporg-plugins' ), $block->name, $query->posts[0]->post_name ),
+                    if ( $this->slug && $this->slug === $post->post_name ) {
+                        continue; // It's this very same plugin.
+                    }
+
+                    $this->record_result(
+                        __FUNCTION__,
+                        // Check the author, since this might be the same plugin hosted on github.
+                        ( get_current_user_id() === $post->post_author ) ? 'warning' : 'error',
+                        sprintf(
+                            // translators: %1$s is the block slug, %2$s is the found plugin title.
+                            __( 'Block name %1$s already exists in the plugin "%2$s."', 'wporg-plugins' ),
+                            '<code>' . $block->name . '</code>',
+                            $query->posts[0]->post_title
+                        ),
                         [ 'block_name' => $block->name, 'slug' => $post->post_name ]
                     );

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

@@ -192 +192 @@
             foreach ( $results_by_type[ $type ] as $item ) {
                 // Only get details if this is a warning or error.
-                $details = ( 'info' === $type ) ? false : self::get_detailed_help( $item->check_name );
+                $details = ( 'info' === $type ) ? false : self::get_detailed_help( $item->check_name, $item );
                 if ( $details ) {
                     $details = '<p>' . implode( '</p><p>', (array) $details ) . '</p>';
@@ -226 +226 @@
      *
      * @param string $method The name of the check method.
+     * @param array  $result The full result data.
      *
      * @return string|array More details for a given block issue. Array of strings if there should be a linebreak.
      */
-    public static function get_detailed_help( $method ) {
+    public static function get_detailed_help( $method, $result ) {
         switch ( $method ) {
             // These don't need more details.
@@ -242 +243 @@
                 return __( 'The readme.txt file must contain the tag "block" (singular) for this to be added to the block directory.', 'wporg-plugins' );
             case 'check_for_duplicate_block_name':
-                return [
+                $details = [
                     __( "Block names must be unique, otherwise it can cause problems when using the block. It is recommended to use your plugin's name as the namespace.", 'wporg-plugins' ),
-                    '<em>' . __( 'If this is a different version of your own plugin, you can ignore this warning.', 'wporg-plugins' ) . '</em>',
                 ];
+                if ( 'warning' === $result->type ) {
+                    $details[] = '<em>' . __( 'If this is a different version of your own plugin, you can ignore this warning.', 'wporg-plugins' ) . '</em>';
+                }
+                return $details;
             case 'check_for_blocks':
                 return [