//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2024, the clio developers.

    Permission to use, copy, modify, and distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.

    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================

#include "data/Types.h"
#include "feed/SubscriptionManager.h"
#include "util/Fixtures.h"
#include "util/MockWsBase.h"
#include "util/Taggable.h"
#include "util/TestObject.h"
#include "util/config/Config.h"
#include "web/interface/ConnectionBase.h"

#include <boost/asio/executor_work_guard.hpp>
#include <boost/asio/io_context.hpp>
#include <boost/asio/spawn.hpp>
#include <boost/json/object.hpp>
#include <boost/json/parse.hpp>
#include <boost/json/serialize.hpp>
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <ripple/protocol/Book.h>
#include <ripple/protocol/Fees.h>
#include <ripple/protocol/Issue.h>
#include <ripple/protocol/STObject.h>

#include <memory>
#include <string>
#include <thread>
#include <vector>

constexpr static auto ACCOUNT1 = "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn";
constexpr static auto ACCOUNT2 = "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun";
constexpr static auto CURRENCY = "0158415500000000C1F76FF6ECB0BAC600000000";
constexpr static auto ISSUER = "rK9DrarGKnVEo2nYp5MfVRXRYf5yRX3mwD";
constexpr static auto LEDGERHASH = "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652";

namespace json = boost::json;
using namespace feed;
using namespace feed::impl;

class SubscriptionManagerTest : public MockBackendTest, public SyncAsioContextTest {
protected:
    util::Config cfg;
    std::shared_ptr<SubscriptionManager> SubscriptionManagerPtr;
    util::TagDecoratorFactory tagDecoratorFactory{cfg};
    std::shared_ptr<web::ConnectionBase> session;

    void
    SetUp() override
    {
        MockBackendTest::SetUp();
        SyncAsioContextTest::SetUp();
        SubscriptionManagerPtr = std::make_shared<SubscriptionManager>(ctx, backend);
        session = std::make_shared<MockSession>(tagDecoratorFactory);
    }

    void
    TearDown() override
    {
        session.reset();
        SubscriptionManagerPtr.reset();
        SyncAsioContextTest::TearDown();
        MockBackendTest::TearDown();
    }

    std::string const&
    receivedFeedMessage() const
    {
        auto const mockSession = dynamic_cast<MockSession*>(session.get());
        [&] { ASSERT_NE(mockSession, nullptr); }();
        return mockSession->message;
    }

    void
    cleanReceivedFeed()
    {
        auto mockSession = dynamic_cast<MockSession*>(session.get());
        [&] { ASSERT_NE(mockSession, nullptr); }();
        mockSession->message.clear();
    }
};

TEST_F(SubscriptionManagerTest, MultipleThreadCtx)
{
    std::vector<std::thread> workers;
    workers.reserve(2);

    SubscriptionManagerPtr->subManifest(session);
    SubscriptionManagerPtr->subValidation(session);

    SubscriptionManagerPtr->forwardManifest(json::parse(R"({"manifest":"test"})").get_object());
    SubscriptionManagerPtr->forwardValidation(json::parse(R"({"validation":"test"})").get_object());

    for (int i = 0; i < 2; ++i)
        workers.emplace_back([this]() { ctx.run(); });

    // wait for all jobs in ctx to finish
    for (auto& worker : workers)
        worker.join();

    EXPECT_TRUE(
        receivedFeedMessage() == R"({"manifest":"test"}{"validation":"test"})" ||
        receivedFeedMessage() == R"({"validation":"test"}{"manifest":"test"})"
    ) << "receivedFeedMessage() = "
      << receivedFeedMessage();

    session.reset();
    SubscriptionManagerPtr.reset();
}

TEST_F(SubscriptionManagerTest, MultipleThreadCtxSessionDieEarly)
{
    boost::asio::executor_work_guard<boost::asio::io_context::executor_type> work_ = boost::asio::make_work_guard(ctx);

    std::vector<std::thread> workers;
    workers.reserve(2);
    for (int i = 0; i < 2; ++i)
        workers.emplace_back([this]() { ctx.run(); });

    SubscriptionManagerPtr->subManifest(session);
    SubscriptionManagerPtr->subValidation(session);

    SubscriptionManagerPtr->forwardManifest(json::parse(R"({"manifest":"test"})").get_object());
    SubscriptionManagerPtr->forwardValidation(json::parse(R"({"validation":"test"})").get_object());

    session.reset();

    work_.reset();
    for (auto& worker : workers)
        worker.join();
    // SubscriptionManager's pub job is running in thread pool, so we let thread pool run out of work, otherwise
    // SubscriptionManager will die before the job is called
    SubscriptionManagerPtr.reset();
}

TEST_F(SubscriptionManagerTest, ReportCurrentSubscriber)
{
    constexpr static auto ReportReturn =
        R"({
            "ledger":0,
            "transactions":2,
            "transactions_proposed":2,
            "manifests":2,
            "validations":2,
            "account":2,
            "accounts_proposed":2,
            "books":2,
            "book_changes":2
        })";
    std::shared_ptr<web::ConnectionBase> const session1 = std::make_shared<MockSession>(tagDecoratorFactory);
    std::shared_ptr<web::ConnectionBase> session2 = std::make_shared<MockSession>(tagDecoratorFactory);
    SubscriptionManagerPtr->subBookChanges(session1);
    SubscriptionManagerPtr->subBookChanges(session2);
    SubscriptionManagerPtr->subManifest(session1);
    SubscriptionManagerPtr->subManifest(session2);
    SubscriptionManagerPtr->subProposedTransactions(session1);
    SubscriptionManagerPtr->subProposedTransactions(session2);
    SubscriptionManagerPtr->subTransactions(session1, 1);
    SubscriptionManagerPtr->subTransactions(session2, 2);
    SubscriptionManagerPtr->subValidation(session1);
    SubscriptionManagerPtr->subValidation(session2);
    auto const account = GetAccountIDWithString(ACCOUNT1);
    SubscriptionManagerPtr->subAccount(account, session1, 1);
    SubscriptionManagerPtr->subAccount(account, session2, 2);
    SubscriptionManagerPtr->subProposedAccount(account, session1);
    SubscriptionManagerPtr->subProposedAccount(account, session2);
    auto const issue1 = GetIssue(CURRENCY, ISSUER);
    ripple::Book const book{ripple::xrpIssue(), issue1};
    SubscriptionManagerPtr->subBook(book, session1, 1);
    SubscriptionManagerPtr->subBook(book, session2, 2);
    EXPECT_EQ(SubscriptionManagerPtr->report(), json::parse(ReportReturn));

    // count down when unsub manually
    SubscriptionManagerPtr->unsubBookChanges(session1);
    SubscriptionManagerPtr->unsubManifest(session1);
    SubscriptionManagerPtr->unsubProposedTransactions(session1);
    SubscriptionManagerPtr->unsubTransactions(session1);
    SubscriptionManagerPtr->unsubValidation(session1);
    SubscriptionManagerPtr->unsubAccount(account, session1);
    SubscriptionManagerPtr->unsubProposedAccount(account, session1);
    SubscriptionManagerPtr->unsubBook(book, session1);

    // try to unsub an account which is not subscribed
    auto const account2 = GetAccountIDWithString(ACCOUNT2);
    SubscriptionManagerPtr->unsubAccount(account2, session1);
    SubscriptionManagerPtr->unsubProposedAccount(account2, session1);
    auto checkResult = [](json::object reportReturn, int result) {
        EXPECT_EQ(reportReturn["book_changes"], result);
        EXPECT_EQ(reportReturn["validations"], result);
        EXPECT_EQ(reportReturn["transactions_proposed"], result);
        EXPECT_EQ(reportReturn["transactions"], result);
        EXPECT_EQ(reportReturn["manifests"], result);
        EXPECT_EQ(reportReturn["accounts_proposed"], result);
        EXPECT_EQ(reportReturn["account"], result);
        EXPECT_EQ(reportReturn["books"], result);
    };
    checkResult(SubscriptionManagerPtr->report(), 1);

    // count down when session disconnect
    session2.reset();
    checkResult(SubscriptionManagerPtr->report(), 0);
}

TEST_F(SubscriptionManagerTest, ManifestTest)
{
    SubscriptionManagerPtr->subManifest(session);
    constexpr static auto dummyManifest = R"({"manifest":"test"})";
    SubscriptionManagerPtr->forwardManifest(json::parse(dummyManifest).get_object());
    ctx.run();

    EXPECT_EQ(json::parse(receivedFeedMessage()), json::parse(dummyManifest));

    cleanReceivedFeed();
    SubscriptionManagerPtr->unsubManifest(session);
    SubscriptionManagerPtr->forwardManifest(json::parse(dummyManifest).get_object());
    ctx.run();
    EXPECT_TRUE(receivedFeedMessage().empty());
}

TEST_F(SubscriptionManagerTest, ValidationTest)
{
    SubscriptionManagerPtr->subValidation(session);
    constexpr static auto dummyManifest = R"({"validation":"test"})";
    SubscriptionManagerPtr->forwardValidation(json::parse(dummyManifest).get_object());
    ctx.run();

    EXPECT_EQ(json::parse(receivedFeedMessage()), json::parse(dummyManifest));
    cleanReceivedFeed();
    SubscriptionManagerPtr->unsubValidation(session);
    SubscriptionManagerPtr->forwardValidation(json::parse(dummyManifest).get_object());
    ctx.restart();
    ctx.run();
    EXPECT_TRUE(receivedFeedMessage().empty());
}

TEST_F(SubscriptionManagerTest, BookChangesTest)
{
    SubscriptionManagerPtr->subBookChanges(session);
    EXPECT_EQ(SubscriptionManagerPtr->report()["book_changes"], 1);

    auto const ledgerinfo = CreateLedgerInfo(LEDGERHASH, 32);
    auto transactions = std::vector<TransactionAndMetadata>{};
    auto trans1 = TransactionAndMetadata();
    ripple::STObject const obj = CreatePaymentTransactionObject(ACCOUNT1, ACCOUNT2, 1, 1, 32);
    trans1.transaction = obj.getSerializer().peekData();
    trans1.ledgerSequence = 32;
    ripple::STObject const metaObj = CreateMetaDataForBookChange(CURRENCY, ISSUER, 22, 1, 3, 3, 1);
    trans1.metadata = metaObj.getSerializer().peekData();
    transactions.push_back(trans1);

    SubscriptionManagerPtr->pubBookChanges(ledgerinfo, transactions);
    constexpr static auto bookChangePublish =
        R"({
            "type":"bookChanges",
            "ledger_index":32,
            "ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
            "ledger_time":0,
            "changes":
            [
                {
                    "currency_a":"XRP_drops",
                    "currency_b":"rK9DrarGKnVEo2nYp5MfVRXRYf5yRX3mwD/0158415500000000C1F76FF6ECB0BAC600000000",
                    "volume_a":"2",
                    "volume_b":"2",
                    "high":"-1",
                    "low":"-1",
                    "open":"-1",
                    "close":"-1"
                }
            ]
        })";
    ctx.run();

    EXPECT_EQ(json::parse(receivedFeedMessage()), json::parse(bookChangePublish));

    SubscriptionManagerPtr->unsubBookChanges(session);
    EXPECT_EQ(SubscriptionManagerPtr->report()["book_changes"], 0);
}

TEST_F(SubscriptionManagerTest, LedgerTest)
{
    backend->setRange(10, 30);
    auto const ledgerinfo = CreateLedgerInfo(LEDGERHASH, 30);
    EXPECT_CALL(*backend, fetchLedgerBySequence).WillOnce(testing::Return(ledgerinfo));

    auto const feeBlob = CreateFeeSettingBlob(1, 2, 3, 4, 0);
    EXPECT_CALL(*backend, doFetchLedgerObject).WillOnce(testing::Return(feeBlob));
    // check the function response
    // Information about the ledgers on hand and current fee schedule. This
    // includes the same fields as a ledger stream message, except that it omits
    // the type and txn_count fields
    constexpr static auto LedgerResponse =
        R"({
            "validated_ledgers":"10-30",
            "ledger_index":30,
            "ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
            "ledger_time":0,
            "fee_base":1,
            "reserve_base":3,
            "reserve_inc":2
        })";
    boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) {
        auto const res = SubscriptionManagerPtr->subLedger(yield, session);
        // check the response
        EXPECT_EQ(res, json::parse(LedgerResponse));
    });
    ctx.run();
    EXPECT_EQ(SubscriptionManagerPtr->report()["ledger"], 1);

    // test publish
    auto const ledgerinfo2 = CreateLedgerInfo(LEDGERHASH, 31);
    auto fee2 = ripple::Fees();
    fee2.reserve = 10;
    SubscriptionManagerPtr->pubLedger(ledgerinfo2, fee2, "10-31", 8);
    constexpr static auto ledgerPub =
        R"({
            "type":"ledgerClosed",
            "ledger_index":31,
            "ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
            "ledger_time":0,
            "fee_base":0,
            "reserve_base":10,
            "reserve_inc":0,
            "validated_ledgers":"10-31",
            "txn_count":8
        })";
    ctx.restart();
    ctx.run();

    EXPECT_EQ(json::parse(receivedFeedMessage()), json::parse(ledgerPub));

    // test unsub
    SubscriptionManagerPtr->unsubLedger(session);
    EXPECT_EQ(SubscriptionManagerPtr->report()["ledger"], 0);
}

TEST_F(SubscriptionManagerTest, TransactionTest)
{
    auto const issue1 = GetIssue(CURRENCY, ISSUER);
    auto const account = GetAccountIDWithString(ISSUER);
    ripple::Book const book{ripple::xrpIssue(), issue1};
    SubscriptionManagerPtr->subBook(book, session, 1);
    SubscriptionManagerPtr->subTransactions(session, 1);
    SubscriptionManagerPtr->subAccount(account, session, 1);
    EXPECT_EQ(SubscriptionManagerPtr->report()["account"], 1);
    EXPECT_EQ(SubscriptionManagerPtr->report()["transactions"], 1);
    EXPECT_EQ(SubscriptionManagerPtr->report()["books"], 1);

    auto const ledgerinfo = CreateLedgerInfo(LEDGERHASH, 33);
    auto trans1 = TransactionAndMetadata();
    auto obj = CreatePaymentTransactionObject(ACCOUNT1, ACCOUNT2, 1, 1, 32);
    trans1.transaction = obj.getSerializer().peekData();
    trans1.ledgerSequence = 32;

    auto const metaObj = CreateMetaDataForBookChange(CURRENCY, ISSUER, 22, 3, 1, 1, 3);
    trans1.metadata = metaObj.getSerializer().peekData();
    SubscriptionManagerPtr->pubTransaction(trans1, ledgerinfo);

    constexpr static auto OrderbookPublish =
        R"({
            "transaction":
            {
                "Account":"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
                "Amount":"1",
                "DeliverMax":"1",
                "Destination":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
                "Fee":"1",
                "Sequence":32,
                "SigningPubKey":"74657374",
                "TransactionType":"Payment",
                "hash":"51D2AAA6B8E4E16EF22F6424854283D8391B56875858A711B8CE4D5B9A422CC2",
                "date":0
            },
            "meta":
            {
                "AffectedNodes":
                [
                    {
                        "ModifiedNode":
                        {
                            "FinalFields":
                            {
                                "TakerGets":"3",
                                "TakerPays":
                                {
                                    "currency":"0158415500000000C1F76FF6ECB0BAC600000000",
                                    "issuer":"rK9DrarGKnVEo2nYp5MfVRXRYf5yRX3mwD",
                                    "value":"1"
                                }
                            },
                            "LedgerEntryType":"Offer",
                            "PreviousFields":
                            {
                                "TakerGets":"1",
                                "TakerPays":
                                {
                                    "currency":"0158415500000000C1F76FF6ECB0BAC600000000",
                                    "issuer":"rK9DrarGKnVEo2nYp5MfVRXRYf5yRX3mwD",
                                    "value":"3"
                                }
                            }
                        }
                    }
                ],
                "TransactionIndex":22,
                "TransactionResult":"tesSUCCESS",
                "delivered_amount":"unavailable"
            },
            "type":"transaction",
            "validated":true,
            "status":"closed",
            "ledger_index":33,
            "ledger_hash":"1B8590C01B0006EDFA9ED60296DD052DC5E90F99659B25014D08E1BC983515BC",
            "engine_result_code":0,
            "engine_result":"tesSUCCESS",
            "close_time_iso": "2000-01-01T00:00:00Z",
            "engine_result_message":"The transaction was applied. Only final in a validated ledger."
        })";

    ctx.run();

    EXPECT_EQ(receivedFeedMessage().size(), json::serialize(json::parse(OrderbookPublish)).size() * 3);

    SubscriptionManagerPtr->unsubBook(book, session);
    SubscriptionManagerPtr->unsubTransactions(session);
    SubscriptionManagerPtr->unsubAccount(account, session);
    EXPECT_EQ(SubscriptionManagerPtr->report()["account"], 0);
    EXPECT_EQ(SubscriptionManagerPtr->report()["transactions"], 0);
    EXPECT_EQ(SubscriptionManagerPtr->report()["books"], 0);
}

TEST_F(SubscriptionManagerTest, ProposedTransactionTest)
{
    auto const account = GetAccountIDWithString(ACCOUNT1);
    SubscriptionManagerPtr->subProposedAccount(account, session);
    SubscriptionManagerPtr->subProposedTransactions(session);
    EXPECT_EQ(SubscriptionManagerPtr->report()["accounts_proposed"], 1);
    EXPECT_EQ(SubscriptionManagerPtr->report()["transactions_proposed"], 1);

    constexpr static auto dummyTransaction =
        R"({
            "transaction":
            {
                "Account":"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
                "Destination":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun"
            }
        })";

    SubscriptionManagerPtr->forwardProposedTransaction(json::parse(dummyTransaction).get_object());
    ctx.run();

    EXPECT_EQ(receivedFeedMessage().size(), json::serialize(json::parse(dummyTransaction)).size() * 2);

    // unsub account1
    cleanReceivedFeed();
    SubscriptionManagerPtr->unsubProposedAccount(account, session);
    EXPECT_EQ(SubscriptionManagerPtr->report()["accounts_proposed"], 0);
    SubscriptionManagerPtr->unsubProposedTransactions(session);
    EXPECT_EQ(SubscriptionManagerPtr->report()["transactions_proposed"], 0);
}