Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Problem/Motivation
When typing in a text field that auto-generates a machine name, the server can be flooded with transliteration requests.
Quick steps to reproduce:
- Create a new View and bring up the browser's debug console on the Network tab.
- In the view name field, type something like "a long delay starts here" but type quickly, make a few mistakes, backspace to fix them, etc.
- Notice the dozens of requests sent to the server
- If you click the "Save & edit" button (or hit enter) before the final request has returned, you'll end up with an abbreviated view machine name.
Proposed resolution
Provide a minimum time (say, 250 milliseconds) between server requests and use cached values for transliteration requests that arrive during the "quiet time."
Remaining tasks
User interface changes
None.
API changes
None.
Original report by [username]
Originally raised in comment #36 of #1686174: Refactor machine-name.js.
| Comment | File | Size | Author |
|---|---|---|---|
| #4 | 2353015-3-transliteration-caching.patch | 2.54 KB | mikeker |
| #4 | 2353015-3-transliteration-caching.interdiff.txt | 3.19 KB | mikeker |
| #2 | 2353015-2-transliteration-caching.patch | 1.6 KB | mikeker |
| #1 | 2353015-1-transliteration-caching.patch | 1.6 KB | mikeker |
Comments
Comment #1
mikeker CreditAttribution: mikeker commentedComment #2
mikeker CreditAttribution: mikeker commentedSorry, the previous patch builds on refactoring done in #1686174: Refactor machine-name.js. While it applies, this patch is against a clean D8 code.
Comment #3
nod_Since we're adding things could you declare a
Drupal.MachineNameconstructor and move all the extra stuff added to the behaviors object to that?Also we have debounce and throttle available. You're reimplementing them basically, see the tableheader or the toolbar code for examples on how to use what we have.
Comment #4
mikeker CreditAttribution: mikeker commented@nod_: And thanks for pointing me at debounce -- didn't realize that existed and it's probably a better way to handle this!
Just in case it's not, I've redone the previous patch using an object outside of Drupal.behaviors to store the data. Apologies, I saw your comment about that in the previous issue but forgot to add that. Patch and interdiff attached. (Note: also adds the ability for force the call to the server in case that's needed, sorry to clutter the interdiff).
Another issue raised while testing this is there is no ordering of the return values from the server. If one request takes longer than the next, an earlier server responses values overwrites more recent ones. But fixing that using debounce would be a more systemic change and may cause conflicts with #1686174: Refactor machine-name.js. If we go the debounce route and order the server replies, should that be part of the machine-name.js rewrite? I'm happy do the the patch in either place, but am worried about make more merge work for whichever patch goes in second.
Thoughts?
Comment #5
nod_It's debounced now.