Skip to content

A platform for community discussion. Free, open, simple.

FIX: `LockOn` keeps polling after timing out

Régis Hanol6271285b96c4
diff --git a/frontend/discourse/app/lib/lock-on.js b/frontend/discourse/app/lib/lock-on.js
index 6c77490ad0d..d6c57acd992 100644
--- a/frontend/discourse/app/lib/lock-on.js
+++ b/frontend/discourse/app/lib/lock-on.js
@@ -105,7 +105,7 @@ export default class LockOn {
if (!this.previousTop && !elementTop) {
// …but not too long
if (Date.now() - this.startedAt > LOCK_TIMEOUT_MS) {
- this.clearLock();
+ return this.clearLock();
}
this._requestId = window.requestAnimationFrame(this._performLocking);
diff --git a/frontend/discourse/tests/unit/lib/lock-on-test.js b/frontend/discourse/tests/unit/lib/lock-on-test.js
new file mode 100644
index 00000000000..394f9005515
--- /dev/null
+++ b/frontend/discourse/tests/unit/lib/lock-on-test.js
@@ -0,0 +1,20 @@
+import { setupTest } from "ember-qunit";
+import { module, test } from "qunit";
+import sinon from "sinon";
+import LockOn from "discourse/lib/lock-on";
+
+module("Unit | Utility | lock-on", function (hooks) {
+ setupTest(hooks);
+
+ test("stops polling for a missing element once it times out", async function (assert) {
+ const clock = sinon.useFakeTimers({ toFake: ["Date"] });
+ const finished = sinon.spy();
+
+ new LockOn("#missing-element", { finished }).lock();
+ clock.tick(10_000);
+ await new Promise(requestAnimationFrame);
+ await new Promise(requestAnimationFrame);
+
+ assert.true(finished.calledOnce, "finishes exactly once");
+ });
+});