1178205 - Make CancellableTimeout shared in a common toolkit module

Status: RESOLVED WONTFIX

(Toolkit :: Telemetry, defect, P4)

Description

[Georg Fritzsche [:gfritzsche]]

TelemetrySend introduces a CancellableTimeout, which allows async code to wait for a promise with a timeout, but still be woken up earlier if needed.

This is potentially useful elsewhere, we should share this in a toolkit module.

Comment 1

[Alessio Placitelli [:Dexter]]

As suggested by Yoric, this should probably go in PromiseUtils.jsm [0].

[0] - http://hg.mozilla.org/mozilla-central/annotate/5fe9ed3edd68/toolkit/modules/PromiseUtils.jsm

Comment 2

[Alessio Placitelli [:Dexter]]

This bug could be potentially mentored, but we need to figure out how to deal with testing first.

We're using our Policy object to set/clear the timeout in [0].

[0] - https://dxr.mozilla.org/mozilla-central/rev/e790bba372f14241addda469a4bdb7ab00786ab3/toolkit/components/telemetry/TelemetrySend.jsm#279

Comment 3

[Chris H-C :chutten]

Since nsITimer supports cancellation and the couple of other places cancellable timers and timeouts have been implemented, do we still want to pursue this?

Comment 4

[Alessio Placitelli [:Dexter]]

(In reply to Chris H-C :chutten from comment #3)
> Since nsITimer supports cancellation and the couple of other places
> cancellable timers and timeouts have been implemented, do we still want to
> pursue this?

This is slightly different, as this CancellableTimeout (which is built on timers) resolves the promise when cancelled *and* when timing out.

However, given comment 0, maybe Georg has stronger opinions on this. I personally think it should be ok to just close this as WONTFIX and re-open if needed :)

Comment 5

[Georg Fritzsche [:gfritzsche]]

What Alessio said.
This was well intended but is not something important to do.