<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[10213] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php: Plugin dir: add an email to alert block developers about test failures.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/10213">10213</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/10213","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tellyworth</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-08-27 07:46:52 +0000 (Thu, 27 Aug 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Plugin dir: add an email to alert block developers about test failures.
See <a href="http://meta.trac.wordpress.org/ticket/5303">#5303</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassblockvalidatorphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassblockvalidatorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php 2020-08-27 04:10:55 UTC (rev 10212)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php 2020-08-27 07:46:52 UTC (rev 10213)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,6 +85,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::handle_edit_form();
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $_POST && ! empty( $_POST['block-directory-test'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::handle_test();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $_POST && ! empty( $_POST['block-directory-email'] ) ) {
+ self::handle_send_email();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,6 +164,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return self::validate_block( $post->post_name );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> protected static function plugin_is_in_block_directory( $slug ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin = Plugin_Directory::get_plugin_post( $slug );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -193,11 +208,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<button class="button button-primary button-large" type="submit" name="block-directory-edit" value="add">' . sprintf( __( 'Add %s to Block Directory', 'wporg-plugins' ), $plugin->post_title ) . '</button>';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( current_user_can( 'edit_post', $post->ID ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( current_user_can( 'edit_post', $plugin->ID ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> echo wp_nonce_field( 'block-directory-test-' . $plugin->ID, 'block-directory-test-nonce' );
</span><span class="cx" style="display: block; padding: 0 10px"> // translators: %s plugin title.
</span><span class="cx" style="display: block; padding: 0 10px"> $disabled = ( wp_cache_get( "plugin-e2e-test-{$plugin->ID}", 'plugin-test' ) ? ' disabled="disabled"' : '' );
</span><span class="cx" style="display: block; padding: 0 10px"> 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>';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ 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>';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> echo '</p>';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,6 +325,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $e2e_result = get_post_meta( $plugin->ID, 'e2e_success', true );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $e2e_result ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<h4>' . __( 'Test Results', 'wporg-plugins' ) . '</h4>';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $github_url = get_post_meta( $plugin->ID, 'e2e_lastRunURL', true ) ) {
+ echo '<a href="' .esc_url( $github_url ) . '">Test details</a>';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'true' === $e2e_result ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo "<div class='notice notice-info notice-alt'><p>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> echo __( 'Test passed.', 'wporg-plugins' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -531,4 +555,82 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return wp_mail( $user_email, $email_subject, $email_content, 'From: plugins@wordpress.org' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>