Transaction.h

/*
 * MIT License
 *
 * Copyright (c) 2025 Adriano dos Santos Fernandes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef FBCPP_TRANSACTION_H
#define FBCPP_TRANSACTION_H
 
#include "fb-cpp-export.h"
#include "fb-api.h"
#include "SmartPtrs.h"
#include <memory>
#include <optional>
#include <span>
#include <stdexcept>
#include <string>
#include <string_view>
#include <vector>
#include <cstddef>
 
 
namespace fbcpp
{
    class Attachment;
 
    enum class TransactionIsolationLevel
    {
        CONSISTENCY,
 
        READ_COMMITTED,
 
        SNAPSHOT
    };
 
    enum class TransactionReadCommittedMode
    {
        NO_RECORD_VERSION,
 
        RECORD_VERSION
    };
 
    enum class TransactionAccessMode
    {
        READ_ONLY,
 
        READ_WRITE
    };
 
    enum class TransactionWaitMode
    {
        NO_WAIT,
 
        WAIT
    };
 
    class TransactionOptions final
    {
    public:
        const std::vector<std::uint8_t>& getTpb() const
        {
            return tpb;
        }
 
        TransactionOptions& setTpb(const std::vector<std::uint8_t>& value)
        {
            tpb = value;
            return *this;
        }
 
        TransactionOptions& setTpb(std::vector<std::uint8_t>&& value)
        {
            tpb = std::move(value);
            return *this;
        }
 
        const std::optional<TransactionIsolationLevel> getIsolationLevel() const
        {
            return isolationLevel;
        }
 
        TransactionOptions& setIsolationLevel(TransactionIsolationLevel value)
        {
            isolationLevel = value;
            return *this;
        }
 
        const std::optional<TransactionReadCommittedMode> getReadCommittedMode() const
        {
            return readCommittedMode;
        }
 
        TransactionOptions& setReadCommittedMode(TransactionReadCommittedMode value)
        {
            readCommittedMode = value;
            return *this;
        }
 
        const std::optional<TransactionAccessMode> getAccessMode() const
        {
            return accessMode;
        }
 
        TransactionOptions& setAccessMode(TransactionAccessMode value)
        {
            accessMode = value;
            return *this;
        }
 
        const std::optional<TransactionWaitMode> getWaitMode() const
        {
            return waitMode;
        }
 
        TransactionOptions& setWaitMode(TransactionWaitMode value)
        {
            waitMode = value;
            return *this;
        }
 
        bool getNoAutoUndo() const
        {
            return noAutoUndo;
        }
 
        TransactionOptions& setNoAutoUndo(bool value)
        {
            noAutoUndo = value;
            return *this;
        }
 
        bool getIgnoreLimbo() const
        {
            return ignoreLimbo;
        }
 
        TransactionOptions& setIgnoreLimbo(bool value)
        {
            ignoreLimbo = value;
            return *this;
        }
 
        bool getRestartRequests() const
        {
            return restartRequests;
        }
 
        TransactionOptions& setRestartRequests(bool value)
        {
            restartRequests = value;
            return *this;
        }
 
        bool getAutoCommit() const
        {
            return autoCommit;
        }
 
        TransactionOptions& setAutoCommit(bool value)
        {
            autoCommit = value;
            return *this;
        }
 
    private:
        std::vector<std::uint8_t> tpb;
        std::optional<TransactionIsolationLevel> isolationLevel;
        std::optional<TransactionReadCommittedMode> readCommittedMode;
        std::optional<TransactionAccessMode> accessMode;
        std::optional<TransactionWaitMode> waitMode;
        bool noAutoUndo = false;
        bool ignoreLimbo = false;
        bool restartRequests = false;
        bool autoCommit = false;
    };
 
    class Client;
 
    enum class TransactionState
    {
        ACTIVE,
 
        PREPARED,
 
        COMMITTED,
 
        ROLLED_BACK
    };
 
    class FB_CPP_EXPORT Transaction final
    {
    public:
        explicit Transaction(Attachment& attachment, const TransactionOptions& options = {});
 
        explicit Transaction(Attachment& attachment, std::string_view setTransactionCmd);
 
        explicit Transaction(
            std::span<std::reference_wrapper<Attachment>> attachments, const TransactionOptions& options = {});
 
        Transaction(Transaction&& o) noexcept
            : client{o.client},
              handle{std::move(o.handle)},
              state{o.state},
              isMultiDatabase{o.isMultiDatabase}
        {
            o.state = TransactionState::ROLLED_BACK;
        }
 
        Transaction& operator=(Transaction&&) = delete;
 
        Transaction(const Transaction&) = delete;
        Transaction& operator=(const Transaction&) = delete;
 
        ~Transaction() noexcept
        {
            if (isValid())
            {
                assert(state != TransactionState::PREPARED &&
                    "Prepared transaction must be explicitly committed or rolled back");
 
                try
                {
                    if (state == TransactionState::ACTIVE)
                        rollback();
                }
                catch (...)
                {
                    // swallow
                }
            }
        }
 
    public:
        bool isValid() noexcept
        {
            return handle != nullptr;
        }
 
        FbRef<fb::ITransaction> getHandle() noexcept
        {
            return handle;
        }
 
        TransactionState getState() const noexcept
        {
            return state;
        }
 
        void prepare();
 
        void prepare(std::string_view message);
 
        void prepare(std::span<const std::uint8_t> message);
 
        void commit();
 
        void commitRetaining();
 
        void rollback();
 
        void rollbackRetaining();
 
    private:
        Client& client;
        FbRef<fb::ITransaction> handle;
        TransactionState state = TransactionState::ACTIVE;
        const bool isMultiDatabase = false;
    };
}  // namespace fbcpp
 
 
#endif  // FBCPP_TRANSACTION_H