Async.h

// SPDX-FileCopyrightText: 2021 Linus Jahn <lnj@kaidan.im>
// SPDX-FileCopyrightText: 2025 Filipe Azevedo <pasnox@gmail.com>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#ifndef ASYNC_H
#define ASYNC_H
 
#include "QXmppAsync_p.h"
#include "QXmppError.h"
#include "QXmppGlobal.h"
 
#include "Algorithms.h"
 
#include <deque>
#include <memory>
#include <variant>
 
#include <QFutureWatcher>
 
namespace QXmpp::Private {
 
template<typename Function>
auto later(QObject *context, Function function)
{
    QMetaObject::invokeMethod(context, std::forward<Function>(function), Qt::QueuedConnection);
}
 
// QtFuture::makeReadyFuture() is deprecated since Qt 6.6 in favor of
// makeReadyValueFuture() (available since Qt 6.6). Wrap it to stay
// warning-free while keeping Qt 6.4 compatibility.
#if QT_VERSION >= QT_VERSION_CHECK(6, 6, 0)
template<typename T>
auto makeReadyFuture(T &&value)
{
    return QtFuture::makeReadyValueFuture(std::forward<T>(value));
}
#else
using QtFuture::makeReadyFuture;
#endif
 
template<typename T, typename Handler>
void await(const QFuture<T> &future, QObject *context, Handler handler)
{
    auto *watcher = new QFutureWatcher<T>(context);
    QObject::connect(watcher, &QFutureWatcherBase::finished,
                     context, [watcher, handler = std::move(handler)]() mutable {
                         handler(watcher->result());
                         watcher->deleteLater();
                     });
    watcher->setFuture(future);
}
 
template<typename Handler>
void await(const QFuture<void> &future, QObject *context, Handler handler)
{
    auto *watcher = new QFutureWatcher<void>(context);
    QObject::connect(watcher, &QFutureWatcherBase::finished,
                     context, [watcher, handler = std::move(handler)]() mutable {
                         handler();
                         watcher->deleteLater();
                     });
    watcher->setFuture(future);
}
 
template<typename T, typename Err, typename Function>
auto mapSuccess(const std::variant<T, Err> &var, Function lambda)
{
    using MappedVariant = std::variant<std::invoke_result_t<Function, const T &>, Err>;
    return map<MappedVariant>(lambda, var);
}
 
template<typename T, typename Err, typename Function>
auto mapSuccess(std::variant<T, Err> &&var, Function lambda)
{
    using MappedVariant = std::variant<std::invoke_result_t<Function, T &&>, Err>;
    return map<MappedVariant>(lambda, std::move(var));
}
 
template<typename T, typename Err>
auto mapToSuccess(std::variant<T, Err> &&var)
{
    return mapSuccess(std::move(var), [](T) {
        return Success();
    });
}
 
// Creates a task for multiple tasks without a return value.
template<typename T>
QXmppTask<void> joinVoidTasks(QObject *context, std::vector<QXmppTask<T>> &&tasks)
{
    int taskCount = tasks.size();
    auto finishedTaskCount = std::make_shared<int>();
 
    auto promise = std::make_shared<QXmppPromise<void>>();
    auto result = promise->task();
 
    for (auto &task : tasks) {
        task.then(context, [=]() mutable {
            if (++(*finishedTaskCount) == taskCount) {
                promise->finish();
            }
        });
    }
 
    return result;
}
 
template<typename Params, typename Response>
struct AttachableRequests {
    struct Request {
        Params params;
        std::vector<QXmppPromise<Response>> promises;
    };
 
    std::vector<Request> requests;
 
    std::optional<QXmppTask<Response>> attach(const Params &key)
    {
        auto itr = std::ranges::find(requests, key, &Request::params);
        if (itr != requests.end()) {
            QXmppPromise<Response> p;
            auto task = p.task();
            itr->promises.push_back(std::move(p));
            return task;
        }
 
        return std::nullopt;
    }
 
    QXmppTask<Response> makeNew(Params key)
    {
        Q_ASSERT(!contains(requests, key, &Request::params));
 
        QXmppPromise<Response> p;
        auto task = p.task();
        requests.push_back(Request { key, { std::move(p) } });
        return task;
    }
 
    void finish(const Params &key, Response &&response)
    {
        auto itr = std::ranges::find(requests, key, &Request::params);
        Q_ASSERT(itr != requests.end());
        if (itr == requests.end()) {
            return;
        }
 
        auto promises = std::move(itr->promises);
        requests.erase(itr);
 
        for (auto it = promises.begin(); it != promises.end(); ++it) {
            // copy unless this is the last iteration (then do move)
            it->finish(std::next(it) == promises.end() ? std::move(response) : response);
        }
    }
 
    QXmppTask<Response> produce(Params key, std::function<QXmppTask<Response>(Params)> requestFunction, QObject *context)
    {
        if (auto task = attach(key)) {
            return std::move(*task);
        }
        auto task = makeNew(key);
        requestFunction(key).then(context, [this, key](auto &&response) {
            finish(key, std::move(response));
        });
        return task;
    }
};
 
template<typename T>
struct MultiPromise {
    std::deque<QXmppPromise<T>> promises;
 
    void finish(T &&response)
    {
        for (auto it = promises.begin(); it != promises.end(); ++it) {
            // copy unless this is the last iteration (then do move)
            it->finish(std::next(it) == promises.end() ? std::move(response) : response);
        }
    }
    QXmppTask<T> generateTask()
    {
        promises.push_back(QXmppPromise<T>());
        return promises.back().task();
    }
};
 
template<>
struct MultiPromise<void> {
    std::vector<QXmppPromise<void>> promises;
 
    void finish()
    {
        for (auto &p : promises) {
            p.finish();
        }
    }
    QXmppTask<void> generateTask()
    {
        promises.push_back(QXmppPromise<void>());
        return promises.back().task();
    }
};
 
}  // namespace QXmpp::Private
 
#endif  // ASYNC_H