Changeset 5446

Timestamp:

04/30/2017 04:20:16 PM (9 years ago)

Author:

ocean90

Message:

Plugin Directory: Restore Slack notifications for i18n imports.

Location:

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

Files:

• bin/import-plugin-to-glotpress.php (modified) (5 diffs)
• cli/i18n/class-code-import.php (modified) (1 diff)
• clients/class-slack.php (modified) (6 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/bin/import-plugin-to-glotpress.php

@@ -1 +1 @@
 <?php
 namespace WordPressdotorg\Plugin_Directory;
+
+use Exception;
+use WordPressdotorg\Plugin_Directory\Clients\Slack;
 
 // This script should only be called in a CLI environment.
@@ -7 +10 @@
 }
 
-$opts = getopt( '', array( 'url:', 'abspath:', 'plugin:', 'tag:', 'type:' ) );
+$opts = getopt( '', array( 'url:', 'abspath:', 'plugin:', 'tag:', 'type:', 'no-slack' ) );
 
 // Guess the default parameters:
@@ -30 +33 @@
 }
 
+if ( ! in_array( $opts['type'], [ 'code', 'readme' ] ) ) {
+    fwrite( STDERR, "Invalid value for type argument: {$opts['type']}\n" );
+    die();
+}
+
 // Bootstrap WordPress
 $_SERVER['HTTP_HOST']   = parse_url( $opts['url'], PHP_URL_HOST );
@@ -50 +58 @@
 $start_time  = microtime( 1 );
 
+$plugin = Plugin_Directory::get_plugin_post( $plugin_slug );
+if ( ! $plugin ) {
+    fwrite( STDERR, "[{$plugin_slug}] Plugin I18N Import Failed: Plugin doesn't exist.\n" );
+    exit( 1 );
+}
+
+// Prepare Slack notification.
+$send_slack = defined( 'PLUGIN_IMPORTS_SLACK_WEBHOOK' ) && ! isset( $opts['no-slack'] );
+if ( $send_slack ) {
+    $slack_client = new Slack( PLUGIN_IMPORTS_SLACK_WEBHOOK );
+    $slack_client->add_attachment( 'ts', time() );
+    $slack_client->add_attachment( 'fallback', "{$plugin->post_title} has been imported." );
+    $slack_client->add_attachment( 'title', "{$plugin->post_title} has been imported" );
+    $slack_client->add_attachment( 'title_link', "https://translate.wordpress.org/projects/wp-plugins/{$plugin_slug}" );
+    $fields = [
+        [
+            'title' => 'Type',
+            'value' => ( 'readme' === $type ) ? 'Readme' : 'Code',
+            'short' => true,
+        ],
+        [
+            'title' => 'Version',
+            'value' => $tag,
+            'short' => true,
+        ],
+    ];
+}
+
 echo "Processing I18N Import for $plugin_slug...\n";
 try {
@@ -60 +96 @@
     }
 
-    echo "OK. Took " . round( microtime(1) - $start_time, 2 )  . "s\n";
-} catch( \Exception $e ) {
-    echo "Failed. Took " . round( microtime(1) - $start_time, 2 )  . "s\n";
+    $runtime = round( microtime( 1 ) - $start_time, 2 );
+
+    // Send Slack notification.
+    if ( $send_slack ) {
+        $fields[] = [
+            'title' => 'Status',
+            'value' => sprintf( '%s Successfully imported! (%ss)', $slack_client->get_success_emoji(), $runtime ),
+            'short' => false,
+        ];
+        $fields[] = [
+            'title' => 'Plugin',
+            'value' => sprintf(
+                '<%1$s|%2$s> | <https://plugins.trac.wordpress.org/log/%3$s|Log> | <%4$s|SVN>',
+                get_permalink( $plugin ),
+                $plugin->post_title,
+                $plugin_slug,
+                $importer->get_plugin_svn_url( $tag )
+            ),
+            'short' => false,
+        ];
+        $slack_client->add_attachment( 'fields', $fields );
+        $slack_client->set_status( 'success' );
+        $slack_client->send( '#meta-language-packs' );
+    }
+
+    echo "OK. Took {$runtime}s\n";
+} catch ( Exception $e ) {
+    $runtime = round( microtime( 1 ) - $start_time, 2 );
+
+    // Send Slack notification.
+    if ( $send_slack ) {
+        $fields[] = [
+            'title' => 'Status',
+            'value' => sprintf( '%s %s (%ss)', $slack_client->get_failure_emoji(), $e->getMessage(), $runtime ),
+            'short' => false,
+        ];
+        $fields[] = [
+            'title' => 'Plugin',
+            'value' => sprintf(
+                '<%1$s|%2$s> | <https://plugins.trac.wordpress.org/log/%3$s|Log> | <%4$s|SVN>',
+                get_permalink( $plugin ),
+                $plugin->post_title,
+                $plugin_slug,
+                $importer->get_plugin_svn_url( $tag )
+            ),
+            'short' => false,
+        ];
+        $slack_client->add_attachment( 'fields', $fields );
+        $slack_client->set_status( 'failure' );
+        $slack_client->send( '#meta-language-packs' );
+    }
+
+    echo "Failed. Took {$runtime}s\n";
 
     fwrite( STDERR, "[{$plugin_slug}] Plugin I18N Import Failed: " . $e->getMessage() . "\n" );
-    exit(1);
+    exit( 2 );
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/i18n/class-code-import.php

@@ -50 +50 @@
         $makepot  = new \MakePOT;
 
-        if ( $makepot->wp_plugin( $export_directory, $pot_file, $this->plugin ) || ! file_exists( $pot_file ) ) {
+        if ( ! $makepot->wp_plugin( $export_directory, $pot_file, $this->plugin ) || ! file_exists( $pot_file ) ) {
             throw new Exception( "POT file couldn't be created." );
         }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/clients/class-slack.php

@@ -21 +21 @@
      * @var array
      */
-    private $attachment = array();
+    private $attachment = [];
 
     /**
@@ -28 +28 @@
      * @var array
      */
-    private $text = array();
+    private $text = [];
+
+    /**
+     * Holds Emoji codes for success.
+     *
+     * @var array
+     */
+    private $success_emoji = [
+        ':green_heart:', ':white_check_mark:', ':smiley:', ':ok: ',
+    ];
+
+    /**
+     * Holds Emoji codes for failure.
+     *
+     * @var array
+     */
+    private $failure_emoji = [
+        ':broken_heart:', ':umbrella_with_rain_drops:', ':cry:', ':sos:',
+    ];
 
     /**
@@ -63 +81 @@
      *
      * @param string $key   Key of the attachment property.
-     * @param string $value Value of the attachment property.
+     * @param mixed  $value Value of the attachment property.
      */
     public function add_attachment( $key, $value ) {
@@ -98 +116 @@
 
     /**
+     * Returns a random emoji for a failure message.
+     *
+     * @return string Emoji code.
+     */
+    public function get_failure_emoji() {
+        $index = array_rand( $this->failure_emoji, 1 );
+        return $this->failure_emoji[ $index ];
+    }
+
+    /**
+     * Returns a random emoji for a success message.
+     *
+     * @return string Emoji code.
+     */
+    public function get_success_emoji() {
+        $index = array_rand( $this->success_emoji, 1 );
+        return $this->success_emoji[ $index ];
+    }
+
+    /**
      * Publishes a Slack notifcation to a channel.
      *
@@ -105 +143 @@
     public function send( $channel ) {
         $text = $this->get_text();
-        if ( empty( $text ) ) {
-            return false;
+        if ( ! empty( $text ) ) {
+            $this->add_attachment( 'text', $text );
         }
 
-        $this->add_attachment( 'text', $text );
-        $this->add_attachment( 'mrkdwn_in', array( 'text' ) );
+        $this->add_attachment( 'mrkdwn_in', [ 'text', 'fields' ] );
 
-        $payload = array(
+        $payload = [
             'icon_emoji'  => ':wordpress:',
             'username'    => 'Plugin Imports',
             'channel'     => $channel,
             'attachments' => $this->get_attachments(),
-        );
+        ];
 
         $payload = json_encode( $payload );
         $content = http_build_query( compact( 'payload' ) );
 
-        $context = stream_context_create( array(
-            'http' => array(
+        $context = stream_context_create( [
+            'http' => [
                 'method'  => 'POST',
                 'header'  => 'Content-Type: application/x-www-form-urlencoded' . PHP_EOL,
                 'content' => $content,
-            ),
-        ) );
+            ],
+        ] );
 
         $this->flush();
@@ -139 +176 @@
      */
     public function flush() {
-        $this->text       = array();
-        $this->attachment = array();
+        $this->text       = [];
+        $this->attachment = [];
     }
 }