util.promise: Add promise:finally()

2 files changed, 73 insertions, 0 deletions

diff --git a/spec/util_promise_spec.lua b/spec/util_promise_spec.lua
index 109c0a7b..778a7661 100644
--- a/spec/util_promise_spec.lua
+++ b/spec/util_promise_spec.lua
@@ -264,4 +264,71 @@ describe("util.promise", function ()
 			assert.spy(cb).was_called(0);
 		end);
 	end);
+	describe("finally()", function ()
+		local p, p2, resolve, reject, on_finally;
+		before_each(function ()
+			p = promise.new(function (_resolve, _reject)
+				resolve, reject = _resolve, _reject;
+			end);
+			on_finally = spy.new(function () end);
+			p2 = p:finally(on_finally);
+		end);
+		it("runs when a promise is resolved", function ()
+			assert.spy(on_finally).was_called(0);
+			resolve("foo");
+			assert.spy(on_finally).was_called(1);
+			assert.spy(on_finally).was_not_called_with("foo");
+		end);
+		it("runs when a promise is rejected", function ()
+			assert.spy(on_finally).was_called(0);
+			reject("foo");
+			assert.spy(on_finally).was_called(1);
+			assert.spy(on_finally).was_not_called_with("foo");
+		end);
+		it("returns a promise that fulfills with the original value", function ()
+			local cb2 = spy.new(function () end);
+			p2:next(cb2);
+			assert.spy(on_finally).was_called(0);
+			assert.spy(cb2).was_called(0);
+			resolve("foo");
+			assert.spy(on_finally).was_called(1);
+			assert.spy(cb2).was_called(1);
+			assert.spy(on_finally).was_not_called_with("foo");
+			assert.spy(cb2).was_called_with("foo");
+		end);
+		it("returns a promise that rejects with the original error", function ()
+			local on_finally_err = spy.new(function () end);
+			local on_finally_ok = spy.new(function () end);
+			p2:catch(on_finally_err);
+			p2:next(on_finally_ok);
+			assert.spy(on_finally).was_called(0);
+			assert.spy(on_finally_err).was_called(0);
+			reject("foo");
+			assert.spy(on_finally).was_called(1);
+			-- Since the original promise was rejected, the finally promise should also be
+			assert.spy(on_finally_ok).was_called(0);
+			assert.spy(on_finally_err).was_called(1);
+			assert.spy(on_finally).was_not_called_with("foo");
+			assert.spy(on_finally_err).was_called_with("foo");
+		end);
+		it("returns a promise that rejects with an uncaught error inside on_finally", function ()
+			p = promise.new(function (_resolve, _reject)
+				resolve, reject = _resolve, _reject;
+			end);
+			local test_error = {};
+			on_finally = spy.new(function () error(test_error) end);
+			p2 = p:finally(on_finally);
+
+			local on_finally_err = spy.new(function () end);
+			p2:catch(on_finally_err);
+			assert.spy(on_finally).was_called(0);
+			assert.spy(on_finally_err).was_called(0);
+			reject("foo");
+			assert.spy(on_finally).was_called(1);
+			assert.spy(on_finally_err).was_called(1);
+			assert.spy(on_finally).was_not_called_with("foo");
+			assert.spy(on_finally).was_not_called_with(test_error);
+			assert.spy(on_finally_err).was_called_with(test_error);
+		end);
+	end);
 end);
diff --git a/util/promise.lua b/util/promise.lua
index c988ddc9..8b57c822 100644
--- a/util/promise.lua
+++ b/util/promise.lua
@@ -126,6 +126,12 @@ function promise_methods:catch(on_rejected)
 	return self:next(nil, on_rejected);
 end
 
+function promise_methods:finally(on_finally)
+	local function _on_finally(value) on_finally(); return value; end
+	local function _on_catch_finally(err) on_finally(); return reject(err); end
+	return self:next(_on_finally, _on_catch_finally);
+end
+
 return {
 	new = new;
 	resolve = resolve;