<!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>[BuddyPress][14098] trunk/src/bp-activity/js/mentions.js: Activity: Add debounce to `@mentions` remote filter for improved performance.</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://buddypress.trac.wordpress.org/changeset/14098">14098</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/14098","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>espellcaste</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-02-16 15:37:07 +0000 (Sun, 16 Feb 2025)</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'>Activity: Add debounce to `@mentions` remote filter for improved performance.
This change aims to optimize the performance of the `@mentions` feature by minimizing unnecessary AJAX requests and improving overall responsiveness.
Props praveenkumar98.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/9239">#9239</a>
Closes https://github.com/buddypress/buddypress/pull/350</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivityjsmentionsjs">trunk/src/bp-activity/js/mentions.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivityjsmentionsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/js/mentions.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/js/mentions.js 2025-02-16 15:27:26 UTC (rev 14097)
+++ trunk/src/bp-activity/js/mentions.js 2025-02-16 15:37:07 UTC (rev 14098)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -14,6 +14,48 @@
</span><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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Define a debounce function to optimize performance by limiting the rate
+ * of AJAX requests for user mentions.
+ *
+ * This function ensures that the `func` is only called after `wait` milliseconds
+ * have passed since the last invocation, with an optional immediate execution.
+ * This helps reduce the frequency of AJAX requests and improves the efficiency of the @mentions feature.
+ *
+ * @param {Function} func The function to debounce.
+ * @param {number} wait The number of milliseconds to wait before calling `func`.
+ * @param {boolean} [immediate=true] Whether to call the function immediately.
+ * @returns {Function} A debounced version of the provided function.
+ */
+ function debounce(func, wait, immediate) {
+ 'use strict';
+
+ var timeout;
+ wait = (typeof wait !== 'undefined') ? wait : 20;
+ immediate = (typeof immediate !== 'undefined') ? immediate : true;
+
+ return function() {
+
+ var context = this, args = arguments;
+ var later = function() {
+ timeout = null;
+
+ if (!immediate) {
+ func.apply(context, args);
+ }
+ };
+
+ var callNow = immediate && !timeout;
+
+ clearTimeout(timeout);
+ timeout = setTimeout(later, wait);
+
+ if (callNow) {
+ func.apply(context, args);
+ }
+ };
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Adds BuddyPress @mentions to form inputs.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {array|object} options If array, becomes the suggestions' data source. If object, passed as config to $.atwho().
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,15 +199,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * If there are no matches for the query in this.data, then query BuddyPress.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.1.0
+ * @since 3.0.0. Renamed from "remote_filter" for at.js v1.5.4 support.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param {string} query Partial @mention to search for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {function} render_view Render page callback function.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 2.1.0
- * @since 3.0.0. Renamed from "remote_filter" for at.js v1.5.4 support.
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remoteFilter: function( query, render_view ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remoteFilter: debounce(function( query, render_view ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> var self = $( this ),
</span><span class="cx" style="display: block; padding: 0 10px"> params = {};
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Skip AJAX request if query is empty.
+ if (!query.trim()) {
+ // Return an empty array to indicate no results.
+ render_view([]);
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> mentionsItem = mentionsQueryCache[ query ];
</span><span class="cx" style="display: block; padding: 0 10px"> if ( typeof mentionsItem === 'object' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> render_view( mentionsItem );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,8 +237,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Success callback for the @suggestions lookup.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.1.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param {object} response Details of users matching the query.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 2.1.0
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> .done(function( response ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! response.success ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,9 +251,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Create a composite index to determine ordering of results;
</span><span class="cx" style="display: block; padding: 0 10px"> * nicename matches will appear on top.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.1.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param {array} suggestion A suggestion's original data.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return {array} A suggestion's new data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 2.1.0
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function( suggestion ) {
</span><span class="cx" style="display: block; padding: 0 10px"> suggestion.search = suggestion.search || suggestion.ID + ' ' + suggestion.name;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,7 +265,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> mentionsQueryCache[ query ] = data;
</span><span class="cx" style="display: block; padding: 0 10px"> render_view( data );
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }, 500) // 500ms debounce time.
</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"> data: $.map( options.data,
</span></span></pre>
</div>
</div>
</body>
</html>