Changeset 9340

Timestamp:

12/13/2019 05:02:31 AM (5 years ago)

Author:

dd32

Message:

Trac: Add initial code to show Github PRs on Trac tickets.

Props dd32, andraganescu, desrosj, isabel_brison, noisysocks, pento, talldanwp.
See #4903.

Location:

sites/trunk

Files:

• api.wordpress.org/public_html/dotorg/trac/pr (added)
• api.wordpress.org/public_html/dotorg/trac/pr/functions.php (added)
• api.wordpress.org/public_html/dotorg/trac/pr/index.php (added)
• api.wordpress.org/public_html/dotorg/trac/pr/webhook.php (added)
• wordpress.org/public_html/style/trac/wp-trac.css (modified) (1 diff)
• wordpress.org/public_html/style/trac/wp-trac.js (modified) (2 diffs)

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

@@ -2293 +2293 @@
     }
 }
+#github-prs .hidden {
+    display: none;
+}
+#github-prs ul.pull-requests {
+    border: 1px solid #ccc;
+    padding: 0 1em;
+    position: relative;
+}
+#github-prs ul.pull-requests li {
+    align-items: center;
+    display: flex;
+    justify-content: space-between;
+    padding: 0;
+}
+#github-prs ul.pull-requests li div {
+    margin: 0.5em 0;
+}
+#github-prs .button {
+    color: black;
+}
+#github-prs ins {
+    color: green;
+    text-decoration: none
+}
+#github-prs del {
+    color: red;
+    text-decoration: none;
+}
+@media screen and (max-width: 782px) {
+    #github-prs .button {
+        line-height: 20px;
+        margin-right: 0.3em;
+    }
+    #github-prs li {
+        display: block;
+    }
+}

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

@@ -85 +85 @@
             wpTrac.linkMentions();
             wpTrac.linkGutenbergIssues();
+            wpTrac.githubPRs.init();
 
             if ( ! $body.hasClass( 'plugins' ) ) {
@@ -1542 +1543 @@
         }()),
 
+        githubPRs: (function() {
+            var apiEndpoint = 'https://api.wordpress.org/dotorg/trac/pr/',
+                authenticated = !! ( wpTracCurrentUser && wpTracCurrentUser !== "anonymous" ),
+                trac = false, ticket = 0,
+                container;
+
+            function init() {
+                // TODO: If this is added to other Trac's, expand this..
+                if ( $body.hasClass( 'core' ) ) {
+                    trac = 'core';
+                }
+
+                // This seems to be the easiest place to find the current Ticket ID..
+                var canonical = $( 'link[rel="canonical"]' ).prop( 'href' );
+                if ( canonical ) {
+                    ticket = canonical.match( /\/ticket\/(\d+)$/ )[1];
+                }
+
+                if ( ! trac || ! ticket ) {
+                    return;
+                }
+
+                // Add the section immediately.
+                renderAddSection();
+
+                if ( authenticated ) {
+                    // Fetch the PRs immediately for authenciated users.
+                    fetchPRs();
+
+                    // ..and expand the section by default.
+                    container.toggleClass( 'collapsed', false );
+                } else {
+                    // Not authenticated? Fetch PRs upon expanding.
+                    container.find( 'h3 a' ).one( 'click', function() {
+                        fetchPRs();
+                    });
+                }
+            }
+
+            function fetchPRs() {
+                $.ajax(
+                    apiEndpoint
+                        + '?trac=' + trac
+                        + '&ticket=' + ticket
+                        + ( authenticated ? '&authenticated=1' : '' )
+                ).success( function( data ) {
+                    // Update the number
+                    container.find( 'h3 .trac-count' ).removeClass( 'hidden' ).find( 'span' ).text( data.length );
+
+                    var prContainer = container.find( '.pull-requests' );
+                    if ( data.length ) {
+                        // Remove the placeholder.
+                        prContainer.find( '.loading' ).remove();
+
+                        // Render the PRs
+                        for ( var i in data ) {
+                            renderPR( prContainer, data[i] );
+                        }
+                    } else {
+                        // Change the loading placeholder
+                        prContainer.find( '.loading' ).text( 'No linked PRs found.' );
+                    }
+                });
+            }
+
+            function renderAddSection() {
+                // Add the Pull Requests section.
+                $( '#attachments' ).append(
+                    '<div id="github-prs" class="collapsed">' +
+                        '<h3 class="foldable"><a id="section-pr" href="#section-pr">Pull requests <span class="trac-count hidden">(<span></span>)</span></a></h3>' +
+                        '<ul class="pull-requests">' +
+                            '<li class="loading">Loading...</li>' +
+                        '</ul>' +
+                    '</div>'
+                );
+                // keep this for later.
+                container = $( '#github-prs' );
+
+                // Make the section collapse.
+                container.find( '#section-pr' ).on( 'click', function() {
+                    var $div = $( this.parentNode.parentNode ).toggleClass( 'collapsed' );
+                    return ! $div.hasClass( 'collapsed' );
+                } );
+            }
+
+            // Logic to determine what the PRs status is
+            function prStatus( data ) {
+                // Closed?
+                if ( data.closed_at ) {
+                    if ( data.mergeable_state == 'clean' ) {
+                        return '✅ Closed';
+                    } else {
+                        return '❌ Closed'
+                    }
+                }
+
+                // Merge State then
+                switch ( data.mergeable_state ) {
+                    case 'draft':
+                        return 'Work in progress';
+                    case 'clean':
+                        return '✅ All checks pass';
+                    case 'dirty':
+                        return '❌ Merge conflicts';
+                    case 'unstable':
+                        return '❌ Failing tests';
+                }
+            }
+
+            function renderPR( container, data ) {
+                // Not the nicest, but it works and escapes things properly if given correct inputs.
+                var htmlElement = function( element, attributes, text = '' ) {
+                    return $( '<p>' ).append(
+                        $( '<' + element + '/>', attributes ).text( text )
+                    ).html();
+                }
+
+                container.append(
+                    '<li>' +
+                    '<div>' +
+                        htmlElement(
+                            'a',
+                            { href: data.changes.html_url, title: data.title },
+                            '#' + data.number + ' ' +
+                                ( data.title.length > 23 ? data.title.substr( 0, 20 ) + '...' : data.title )
+                        ) +
+                        ' by ' +
+                        htmlElement( 'a', { href: data.user.url }, '@' + data.user.name ) +
+                    '</div>' +
+                    '<div>' +
+                        prStatus( data ) +
+                    '</div>' +
+                    '<div>' +
+                        htmlElement( 'ins', {}, '+' + data.changes.additions ) +
+                        '&nbsp;' +
+                        htmlElement( 'del', {}, '-' + data.changes.deletions ) +
+                    '</div>' +
+                    '<div>' +
+                        htmlElement( 'a', { href: data.changes.patch_url, class: 'button' }, 'View patch' ) +
+                        '&nbsp;' +
+                        htmlElement( 'a', { href: data.changes.html_url, class: 'button' }, 'View PR' ) +
+                    '</div>' +
+                    '</li>'
+                );
+            }
+
+            return {
+                init: init
+            };
+        }()),
+
         patchTracFor122Changes: function() {
             console.log( "wp-trac: Applying compat patches for Trac 1.2.2" );