Redmine

Background / Purpose¶

Currently, autocompletion for issue numbers (#123), usernames (@username), and Wiki page names ([[wiki page name]]) sends a request for every keystroke.

For example, when typing aaaaaaaaaa quickly after # in an issue description, the endpoint /issues/auto_complete is called 10 times:

Started GET "/issues/auto_complete?project_id=ecookbook&q=a" for ...
Started GET "/issues/auto_complete?project_id=ecookbook&q=aa" for ...
Started GET "/issues/auto_complete?project_id=ecookbook&q=aaa" for ...
(snip)
Started GET "/issues/auto_complete?project_id=ecookbook&q=aaaaaaaaaa" for ...

In practice, a single request with the final input (aaaaaaaaaa) is sufficient.

Although a single /issues/auto_complete request is lightweight, sending many in quick succession can consume processes and DB connections, potentially degrading performance.

This patch introduces debounce to all autocompletion requests to reduce unnecessary traffic.

Details¶

• Implemented a debounce() function
• Applied a 300ms debounce to all autocomplete requests

Verification¶

• All tests pass, including test/system/inline_autocomplete_test.rb
  • https://github.com/hidakatsuya/redmine/actions/runs/17714688875
• Verified that the number of requests decreases
  • When typing #aaaaaaaaaa quickly, only ONE request is sent
  • Also confirmed that the total number of requests in test/system/inline_autocomplete_test.rb decreased from 19 to 12
• Verified that autocompletion for issue numbers, usernames, and Wiki page names works as before