Changeset 11544

Timestamp:

02/10/2022 09:38:45 AM (3 years ago)

Author:

dd32

Message:

Trac: Add the ability to include Tickets that you've added a GitHub PR to, in the 'my patches' reports.

See ​https://core.trac.wordpress.org/my-patches + https://meta.trac.wordpress.org/report/12
Fixes #5596.

Location:

sites/trunk

Files:

• api.wordpress.org/public_html/dotorg/trac/pr/functions.php (modified) (1 diff)
• api.wordpress.org/public_html/dotorg/trac/pr/index.php (modified) (4 diffs)
• api.wordpress.org/public_html/dotorg/trac/pr/webhook.php (modified) (2 diffs)
• trac.wordpress.org/templates/site.html (modified) (1 diff)
• trac.wordpress.org/templates/wporg-head.html (modified) (1 diff)
• wordpress.org/public_html/style/trac/wp-trac.js (modified) (3 diffs)

sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/functions.php

@@ -103 +103 @@
  * Find a WordPress.org user by a Github login.
  */
-function find_wporg_user_by_github( $github_user ) {
+function find_wporg_user_by_github( $github_user, $what = 'user_login' ) {
     global $wpdb;
 
+    if ( ! in_array( $what, [ 'ID', 'user_login' ], true ) ) {
+        return false;
+    }
+
     return $wpdb->get_var( $wpdb->prepare(
-        "SELECT u.user_login
+        "SELECT u.{$what}
             FROM wporg_github_users g
                 JOIN {$wpdb->users} u ON g.user_id = u.ID

sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/index.php

@@ -7 +7 @@
 $trac          = preg_replace( '![^a-z]!', '', $_GET['trac'] ?? '' );
 $ticket        = intval( $_GET['ticket'] ?? 0 );
+$author        = wp_unslash( $_GET['author'] ?? '' );
 $authenticated = ! empty( $_GET['authenticated'] ); // Longer caches for logged out requests.
 
-if ( empty( $trac ) || empty( $ticket ) ) {
+header( 'Content-Type: application/json' );
+header( 'Access-Control-Allow-Origin: *' );
+
+if ( empty( $trac ) || ( empty( $ticket ) && empty( $author ) ) ) {
     header( 'HTTP/1.0 400 Bad Request' );
-    header( 'Content-Type: application/json' );
-    die( '{"error":"Ticket number is invalid."}' );
+    die( '{"error":"Trac, Ticket number, or Author is invalid."}' );
+}
+
+// Type one: Return PRs by Author.
+if ( $author ) {
+    header( 'Cache-Control: max-age=' . HOUR_IN_SECONDS );
+    header( 'Expires: ' . gmdate( 'D, d M Y H:i:s \G\M\T', time() + HOUR_IN_SECONDS ) );
+
+    $user_id = get_user_by( 'slug', $author )->ID ?? 0;
+
+    $tickets = $wpdb->get_col( $wpdb->prepare(
+        "SELECT `ticket`
+        FROM `trac_github_prs`
+        WHERE trac = %s AND author = %d",
+        $trac,
+        $user_id
+    ) );
+
+    echo wp_json_encode( $tickets );
+    die();
 }
 
 // Fetch any linked PRs
 $prs = $wpdb->get_results( $wpdb->prepare(
-    "SELECT `repo`, `pr`, `data`, `last_checked`
+    "SELECT `repo`, `pr`, `data`, `last_checked`, `author`
     FROM `trac_github_prs`
     WHERE trac = %s AND ticket = %s",
@@ -65 +87 @@
             unset( $data->data->trac_ticket );
 
+            // Check if we now have an author for this PR, the author may link their account after creating the PR.
+            if ( ! $data->author ) {
+                $data->author = (int) find_wporg_user_by_github( $pr_data->user->name, 'ID' );
+            }
+
             $wpdb->update(
                 'trac_github_prs',
@@ -70 +97 @@
                     'data'         => json_encode( $pr_data ),
                     'last_checked' => gmdate( 'Y-m-d H:i:s' ),
+                    'author'       => $data->author,
                 ],
                 [
@@ -98 +126 @@
 header( 'Cache-Control: max-age=' . $expiry );
 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s \G\M\T', time() + $expiry ) );
-header( 'Content-Type: application/json' );
-header( 'Access-Control-Allow-Origin: *' );
 
 // Only return the actual PR data needed

sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/webhook.php

@@ -81 +81 @@
         // Step 3. If not in DB, or $pr_data->trac_ticket isn't yet in the DB, add a new row of it.
         if ( $pr_data->trac_ticket && ( ! $existing_refs || ! $matched_existing_ref ) ) {
+
+            $user_id = (int) find_wporg_user_by_github( $pr_data->user->name, 'ID' );
+
             $wpdb->insert(
                 'trac_github_prs',
@@ -91 +94 @@
                     'pr'           => $pr_number,
                     'data'         => json_encode( $_pr_data_no_ticket ),
+                    'author'       => $user_id,
                 ]
             );

sites/trunk/trac.wordpress.org/templates/site.html

@@ -5 +5 @@
 
 <?python
-    scripts_version = '161'
+    scripts_version = '162'
     project_slug = req.environ['HTTP_HOST'].split(':')[0].split('.')[0]
     wporg_endpoint = 'https://make.wordpress.org/' + project_slug + '/'

sites/trunk/trac.wordpress.org/templates/wporg-head.html

@@ -46 +46 @@
 .has-text-align-justify{text-align:justify;}
 </style>
-  <link rel="stylesheet" id="wporg-global-header-footer-css" href="https://wordpress.org/wp-content/mu-plugins/pub-sync/blocks/global-header-footer/build/style.css?ver=1643748587" type="text/css" media="all"/>
+  <link rel="stylesheet" id="wporg-global-header-footer-css" href="https://wordpress.org/wp-content/mu-plugins/pub-sync/blocks/global-header-footer/build/style.css?ver=1643748639" type="text/css" media="all"/>
   <link rel="stylesheet" id="mediaelement-css" href="https://wordpress.org/wp-includes/js/mediaelement/mediaelementplayer-legacy.min.css?ver=4.2.16" type="text/css" media="all"/>
   <link rel="stylesheet" id="wp-mediaelement-css" href="https://wordpress.org/wp-includes/js/mediaelement/wp-mediaelement.min.css?ver=6.0-alpha-52660" type="text/css" media="all"/>

sites/trunk/wordpress.org/public_html/style/trac/wp-trac.js

@@ -1666 +1666 @@
                 }
 
+                if ( ! trac ) {
+                    return;
+                }
+
+                // Add ability to include GitHub tickets into a 'my-patches' report.
+                // "Just" include a variable called '$GITHUBTICKETS' in the Query.
+                var $warning = $("#warning.system-message:contains('GITHUBTICKETS')");
+                if ( $warning.length ) {
+                    renderReportLoadGitHubTickets( $warning );
+                }
+
                 // This seems to be the easiest place to find the current Ticket ID..
                 var canonical = $( 'link[rel="canonical"]' ).prop( 'href' );
@@ -1672 +1683 @@
                 }
 
-                if ( ! trac || ! ticket ) {
+                if ( ! ticket ) {
                     return;
                 }
@@ -1733 +1744 @@
                     return ! $div.hasClass( 'collapsed' );
                 } );
+            }
+
+            function renderReportLoadGitHubTickets( $warning ) {
+                var user = wpTracCurrentUser,
+                    match = document.location.search.match( /USER=([^&]+)/ );
+                if ( match ) {
+                    user = match[1];
+                }
+
+                // Logged out requests without a user context.
+                if ( 'anonymous' === user ) {
+                    $warning.remove();
+                    return;
+                }
+
+                $warning.html(
+                    '<strong>Warning:</strong> Tickets with an attached GitHub PRs not included <button>Load PRs</button>'  
+                );
+
+                $warning.on( 'click', function() {
+                    $(this).find('button').prop( 'disabled', 'disabled' ).text( 'Please wait..' );
+
+                    $.ajax(
+                        apiEndpoint
+                            + '?trac=' + trac
+                            + '&author=' + user
+                            + ( authenticated ? '&authenticated=1' : '' )
+                    ).success( function( ticketList ) {
+                        document.location = document.location.toString() +
+                            ( document.location.search ? '&' : '?' ) +
+                            'GITHUBTICKETS=' + ticketList.join(',');
+                    } );
+                } )
+
             }