Debounce submitCustom

[soundsbywise]

Overview

The submitCustom method can be called several times in rapid succession which leads to BE race conditions. To offset this we debounce the method so that each successive call has to wait 1 second.

Notes

1. Updates are aggregated so that the latest key value pairs are sent to the BE when a call goes through.
2. If the method is called and the form is about to be completed, we send the pending changes to the backend regardless of the wait time

Testing

Submitted the Book A Demo feathery form before and after changes - works the same.

[soundsbywise]

added: to immediately submit changes we must call the flush method in this way

[bo-dun-1]

i'm not familiar with the flush function. will this return the promise from the network request so it can be awaited by the client of this function?

[soundsbywise]

Yep, the return value of flush is the promise from the network request. When resolved, the value is the Response object. See below

flushed is the me logging the return value from flush():

[bo-dun-1]

i'm not sure this method is necessary actually. if there is data to flush, there will be a debounced, pending submitCustom call as well so no need to call this again or have this helper function. .flush() can be called directly.

[soundsbywise]

I think wrapping the flush call in this method creates for a cleaner API long term.

There's currently 3 instances where we flush. Since the lodash.flush implementation has this caveat that requires us to

1. call the debounced function
2. then call flush()

It's easier to debug and refactor the flush call if its defined in one place.

Otherwise, there's going to be 3 instances of:

this.debouncedSubmitCustom(override ?? true);
this.debouncedSubmitCustom.flush();

For that reason, my vote is to keep flushPendingSubmitCustomUpdates