Changeset 10213

Timestamp:

08/27/2020 07:46:52 AM (4 years ago)

Author:

tellyworth

Message:

Plugin dir: add an email to alert block developers about test failures.

See #5303.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php (modified) (5 diffs)

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

@@ -86 +86 @@
             } elseif ( $_POST && ! empty( $_POST['block-directory-test'] ) ) {
                 self::handle_test();
+            } elseif ( $_POST && ! empty( $_POST['block-directory-email'] ) ) {
+                self::handle_send_email();
             }
             ?>
@@ -163 +165 @@
     }
 
+    protected static function handle_send_email() {
+        $post = get_post( intval( $_POST['plugin-id'] ) );
+        if ( $post && 'error' === $_POST['block-directory-email'] && wp_verify_nonce( $_POST['block-directory-email-nonce'], 'block-directory-email-' . $post->ID ) ) {
+            if ( current_user_can( 'edit_post', $post->ID ) ) {
+                if ( self::maybe_send_email_block_error( $post ) ) {
+                        echo '<div class="notice notice-success notice-alt"><p>' . __( 'Email sent.', 'wporg-plugins' ) . '</p></div>';
+                }
+            }
+        }
+
+        return self::validate_block( $post->post_name );
+    }
+
     protected static function plugin_is_in_block_directory( $slug ) {
         $plugin = Plugin_Directory::get_plugin_post( $slug );
@@ -194 +209 @@
         }
 
-        if ( current_user_can( 'edit_post', $post->ID ) ) {
+        if ( current_user_can( 'edit_post', $plugin->ID ) ) {
             echo wp_nonce_field( 'block-directory-test-' . $plugin->ID, 'block-directory-test-nonce' );
             // translators: %s plugin title.
             $disabled = ( wp_cache_get( "plugin-e2e-test-{$plugin->ID}", 'plugin-test' ) ? ' disabled="disabled"' : '' );
             echo '<button class="button button-secondary button-large" type="submit" name="block-directory-test" value="test"' . $disabled . '>' . sprintf( __( 'Test %s', 'wporg-plugins' ), $plugin->post_title ) . '</button>';
+
+            if ( 'false' === get_post_meta( $plugin->ID, 'e2e_success', true ) ) {
+                $user = get_user_by( 'ID', $plugin->post_author );
+                echo wp_nonce_field( 'block-directory-email-' . $plugin->ID, 'block-directory-email-nonce' );
+            echo '<button class="button button-secondary button-large" type="submit" name="block-directory-email" value="error">' . sprintf( __( 'Email Test Error to %s', 'wporg-plugins' ), $user->user_email ) . '</button>';
+            }
         }
 
@@ -305 +326 @@
                 if ( !empty( $e2e_result ) ) {
                     echo '<h4>' . __( 'Test Results', 'wporg-plugins' ) . '</h4>';
+                    if ( $github_url = get_post_meta( $plugin->ID, 'e2e_lastRunURL', true ) ) {
+                        echo '<a href="' .esc_url( $github_url ) . '">Test details</a>';
+                    }
                     if ( 'true' === $e2e_result ) {
                         echo "<div class='notice notice-info notice-alt'><p>\n";
@@ -532 +556 @@
         return wp_mail( $user_email, $email_subject, $email_content, 'From: plugins@wordpress.org' );
     }
+
+    /**
+     * Sends an email to the plugin author alerting them to a test failure.
+     */
+    protected static function maybe_send_email_block_error( $post ) {
+        $plugin_author = get_user_by( 'id', $post->post_author );
+        if ( empty( $plugin_author ) ) {
+            return false;
+        }
+
+        $error = get_post_meta( $post->ID, 'e2e_error', true );
+        $github_url = get_post_meta( $post->ID, 'e2e_lastRunURL', true );
+        if ( !$error || !$github_url ) {
+            return false;
+        }
+
+        // Don't send duplicate emails about the same error
+        if ( get_post_meta( $post->ID, 'email_sent_about_error', true ) === $error ) {
+            return false;
+        }
+
+        /* translators: %s: plugin name */
+        $email_subject = sprintf(
+            __( '[WordPress Plugin Directory] Error in your block plugin - %s', 'wporg-plugins' ),
+            $post->post_name
+        );
+
+        /*
+            Please leave the blank lines in place.
+        */
+        $email_content = sprintf(
+            // translators: 1: plugin name, 2: error message, 3: plugin slug, 4: github link.
+            __(
+'Thanks for submitting your plugin %1$s to the block directory!
+
+We noticed a problem when testing a recent commit to your plugin:
+
+%2$s
+
+This error was generated by an automated end-to-end test that attempts to insert the block %3%s into a post in the same way a user would. The test failure probably means that the block plugin will not work for users.
+
+Here\'s how to reproduce the problem:
+
+1. Start with a fresh install of WordPress stable.
+2. Make sure it has no plugins or custom themes installed.
+3. Create a new post with the block editor.
+4. In the block inserter, search for "slug:%3$s".
+5. Click the "Add block" button.
+6. Check the browser console and PHP error logs.
+
+If you are able to reproduce the error, you can resolve the problem by committing a bugfix and updating the stable tag. This will automatically trigger a new test.
+
+Further details of the test are available here:
+
+%4$s
+
+If you are unable to reproduce the issue and you think there might be a problem with our testing, please open an issue in that GitHub repository.
+
+--
+The WordPress Plugin Directory Team
+https://make.wordpress.org/plugins', 'wporg-plugins'
+            ),
+            $post->post_title,
+            $error,
+            $post->post_name,
+            $github_url
+        );
+
+        $user_email = $plugin_author->user_email;
+
+        $result = wp_mail( $user_email, $email_subject, $email_content,  'From: plugins@wordpress.org' );
+
+        if ( $result ) {
+            update_post_meta( $post->ID, 'email_sent_about_error', $error );
+        }
+
+        return $result;
+    }
 }