From b47ca0569e42f712355ddf9691607160905b9c3c Mon Sep 17 00:00:00 2001
From: Simon Brunel <simonbrunel@users.noreply.github.com>
Date: Thu, 24 Aug 2017 18:28:44 +0200
Subject: [PATCH] Implement QPromise::delay(msec)

This method returns a promise that will be fulfilled with the same value as the `input` promise and after at least `msec` milliseconds. If the `input` promise is rejected, the `output` promise is immediately rejected with the same reason.
---
 README.md                            | 11 +++++++++
 src/qtpromise/qpromise.h             |  1 +
 src/qtpromise/qpromise.inl           | 11 +++++++++
 tests/auto/qpromise/tst_qpromise.cpp | 37 ++++++++++++++++++++++++++++
 4 files changed, 60 insertions(+)

diff --git a/README.md b/README.md
index 174fcbf..935e4c9 100644
--- a/README.md
+++ b/README.md
@@ -304,6 +304,7 @@ If `handler` returns a promise (or QFuture), the `output` promise is delayed unt
 This `handler` allows to observe the value of the `input` promise, without changing the propagated value. The `output` promise will be resolved with the same value as the `input` promise (the `handler` returned value will be ignored). However, if `handler` throws, `output` is rejected with the new exception. Unlike [`finally`](#qpromise-finally), this handler is **not** called for rejections.
 
 ```cpp
+QPromise<int> input = {...}
 auto output = input.tap([](int res) {
     log(res);
 }).then([](int res) {
@@ -313,6 +314,16 @@ auto output = input.tap([](int res) {
 
 If `handler` returns a promise (or QFuture), the `output` promise is delayed until the returned promise is resolved and under the same conditions: the delayed value is ignored, the error transmitted to the `output` promise.
 
+### <a name="qpromise-delay"></a> `QPromise<T>::delay(handler) -> QPromise<T>`
+This method returns a promise that will be fulfilled with the same value as the `input` promise and after at least `msec` milliseconds. If the `input` promise is rejected, the `output` promise is immediately rejected with the same reason.
+
+```cpp
+QPromise<int> input = {...}
+auto output = input.delay(2000).then([](int res) {
+    // called 2 seconds after `input` is fulfilled
+});
+```
+
 ### <a name="qpromise-wait"></a> `QPromise<T>::wait() -> QPromise<T>`
 This method holds the execution of the remaining code **without** blocking the event loop of the current thread:
 
diff --git a/src/qtpromise/qpromise.h b/src/qtpromise/qpromise.h
index dd9ca39..e83d23a 100644
--- a/src/qtpromise/qpromise.h
+++ b/src/qtpromise/qpromise.h
@@ -46,6 +46,7 @@ public:
     template <typename THandler>
     inline QPromise<T> tap(THandler handler) const;
 
+    inline QPromise<T> delay(int msec) const;
     inline QPromise<T> wait() const;
 
     void swap(QPromiseBase<T>& other) { qSwap(m_d, other.m_d); }
diff --git a/src/qtpromise/qpromise.inl b/src/qtpromise/qpromise.inl
index ee28700..2778254 100644
--- a/src/qtpromise/qpromise.inl
+++ b/src/qtpromise/qpromise.inl
@@ -1,6 +1,7 @@
 // Qt
 #include <QCoreApplication>
 #include <QSharedPointer>
+#include <QTimer>
 
 namespace QtPromise {
 
@@ -149,6 +150,16 @@ inline QPromise<T> QPromiseBase<T>::tap(THandler handler) const
     });
 }
 
+template <typename T>
+inline QPromise<T> QPromiseBase<T>::delay(int msec) const
+{
+    return tap([=]() {
+        return QPromise<void>([&](const QPromiseResolve<void>& resolve) {
+            QTimer::singleShot(msec, resolve);
+        });
+    });
+}
+
 template <typename T>
 inline QPromise<T> QPromiseBase<T>::wait() const
 {
diff --git a/tests/auto/qpromise/tst_qpromise.cpp b/tests/auto/qpromise/tst_qpromise.cpp
index 2b41528..4dbfbee 100644
--- a/tests/auto/qpromise/tst_qpromise.cpp
+++ b/tests/auto/qpromise/tst_qpromise.cpp
@@ -3,6 +3,7 @@
 
 // Qt
 #include <QtTest>
+#include <QElapsedTimer>
 
 using namespace QtPromise;
 using namespace QtPromisePrivate;
@@ -48,6 +49,9 @@ private Q_SLOTS:
     void tapDelayedResolved();
     void tapDelayedRejected();
 
+    void delayFulfilled();
+    void delayRejected();
+
 }; // class tst_qpromise
 
 QTEST_MAIN(tst_qpromise)
@@ -654,3 +658,36 @@ void tst_qpromise::tapDelayedRejected()
     QCOMPARE(p.isRejected(), true);
     QCOMPARE(values, QVector<int>({2, 3}));
 }
+
+void tst_qpromise::delayFulfilled()
+{
+    QElapsedTimer timer;
+    qint64 elapsed = -1;
+
+    timer.start();
+
+    auto p = QPromise<int>::resolve(42).delay(1000).finally([&]() {
+        elapsed = timer.elapsed();
+    });
+
+    QCOMPARE(waitForValue(p, -1), 42);
+    QCOMPARE(p.isFulfilled(), true);
+    QVERIFY(elapsed >= 1000 * 0.95);    // Qt::CoarseTimer (default) Coarse timers try to
+    QVERIFY(elapsed <= 1000 * 1.05);    // keep accuracy within 5% of the desired interval.
+}
+
+void tst_qpromise::delayRejected()
+{
+    QElapsedTimer timer;
+    qint64 elapsed = -1;
+
+    timer.start();
+
+    auto p = QPromise<int>::reject(QString("foo")).delay(1000).finally([&]() {
+        elapsed = timer.elapsed();
+    });
+
+    QCOMPARE(waitForError(p, QString()), QString("foo"));
+    QCOMPARE(p.isRejected(), true);
+    QVERIFY(elapsed < 5);
+}