Merge "Add additional tracking information to mediawiki.searchSuggest"

diff --combined docs/hooks.txt
index 8955f54,dc86ef1..c5f2424
--- 1/docs/hooks.txt
--- 2/docs/hooks.txt
+++ b/docs/hooks.txt
@@@ -2914,6 -2914,14 +2914,14 @@@ go to the existing page
  $t: title object searched for
  &$params: an array of the default message name and page title (as parameter)
  
+ 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
+ canceled and a normal search will be performed. Returning true without setting
+ $url does a standard redirect to $title. Setting $url redirects to the
+ specified URL.
+ $term - The string the user searched for
+ $title - The title the 'go' feature has decided to forward the user to
+ &$url - Initially null, hook subscribers can set this to specify the final url to redirect to
+ 
  'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
  target doesn't exist.
  &$title: title object generated from the text entered by the user
@@@ -3066,11 -3074,6 +3074,11 @@@ $old: old titl
  $nt: new title
  $user: user who does the move
  
 +'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
 +$old: old title
 +$nt: new title
 +$user: user who does the move
 +
  'TitleMoveComplete': After moving an article (title), post-commit.
  &$old: old title
  &$nt: new title

diff --combined resources/src/mediawiki/mediawiki.searchSuggest.js
index 923dfc2,7390645..17a3b21
--- 1/resources/src/mediawiki/mediawiki.searchSuggest.js
--- 2/resources/src/mediawiki/mediawiki.searchSuggest.js
+++ b/resources/src/mediawiki/mediawiki.searchSuggest.js
@@@ -12,12 -12,13 +12,13 @@@
                                namespace: 0,
                                limit: maxRows,
                                suggest: true
-                       } ).done( function ( data ) {
-                               response( data[ 1 ] );
+                       } ).done( function ( data, jqXHR ) {
+                               response( data[ 1 ], {
+                                       type: jqXHR.getResponseHeader( 'X-OpenSearch-Type' ),
+                                       query: query
+                               } );
                        } );
-               },
-               // The name of the request api for event logging purposes
-               type: 'prefix'
+               }
        };
  
        $( function () {
@@@ -90,42 -91,63 +91,68 @@@
                        previousSearchText = searchText;
                }
  
+               /**
+                * defines the location of autocomplete. Typically either
+                * header, which is in the top right of vector (for example)
+                * and content which identifies the main search bar on
+                * Special:Search.  Defaults to header for skins that don't set
+                * explicitly.
+                *
+                * @ignore
+                */
+               function getInputLocation( context ) {
+                       return context.config.$region
+                                       .closest( 'form' )
+                                       .find( '[data-search-loc]' )
+                                       .data( 'search-loc' ) || 'header';
+               }
+ 
                /**
                 * Callback that's run when suggestions have been updated either from the cache or the API
                 * 'this' is the search input box (jQuery object)
                 *
                 * @ignore
                 */
-               function onAfterUpdate() {
+               function onAfterUpdate( metadata ) {
                        var context = this.data( 'suggestionsContext' );
  
                        mw.track( 'mediawiki.searchSuggest', {
                                action: 'impression-results',
                                numberOfResults: context.config.suggestions.length,
-                               resultSetType: mw.searchSuggest.type
+                               resultSetType: metadata.type || 'unknown',
+                               query: metadata.query,
+                               inputLocation: getInputLocation( context )
                        } );
                }
  
                // The function used to render the suggestions.
                function renderFunction( text, context ) {
 -                      var formData = getFormData( context );
 +                      var formData = getFormData( context ),
 +                              textboxConfig = context.data.$textbox.data( 'mw-searchsuggest' ) || {};
  
                        // linkParams object is modified and reused
                        formData.linkParams[ formData.textParam ] = text;
  
+                       // Allow trackers to attach tracking information, such
+                       // as wprov, to clicked links.
+                       mw.track( 'mediawiki.searchSuggest', {
+                               action: 'render-one',
+                               formData: formData,
+                               index: context.config.suggestions.indexOf( text ) + 1
+                       } );
+ 
                        // this is the container <div>, jQueryfied
 -                      this.text( text )
 -                              .wrap(
 +                      this.text( text );
 +
 +                      // wrap only as link, if the config doesn't disallow it
 +                      if ( textboxConfig.wrapAsLink !== false ) {
 +                              this.wrap(
                                        $( '<a>' )
                                                .attr( 'href', formData.baseHref + $.param( formData.linkParams ) )
                                                .attr( 'title', text )
                                                .addClass( 'mw-searchSuggest-link' )
                                );
 +                      }
                }
  
                // The function used when the user makes a selection
@@@ -213,6 -235,10 +240,10 @@@
                                                return true;
                                        }
                                },
+                               update: {
+                                       before: onBeforeUpdate,
+                                       after: onAfterUpdate
+                               },
                                cache: true,
                                highlightInput: true
                        } )
@@@ -267,7 -293,9 +298,9 @@@
                                var context = $searchInput.data( 'suggestionsContext' );
                                mw.track( 'mediawiki.searchSuggest', {
                                        action: 'submit-form',
-                                       numberOfResults: context.config.suggestions.length
+                                       numberOfResults: context.config.suggestions.length,
+                                       $form: context.config.$region.closest( 'form' ),
+                                       inputLocation: getInputLocation( context )
                                } );
                        } )
                        // If the form includes any fallback fulltext search buttons, remove them