FeatureFlagHistoryDialog.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_QT_FEATURE_FLAG_HISTORY_DIALOG_HPP
#define ORES_QT_FEATURE_FLAG_HISTORY_DIALOG_HPP
 
#include <memory>
#include <QPair>
#include <QWidget>
#include <QString>
#include <QVector>
#include <QToolBar>
#include <QAction>
#include "ores.qt/ClientManager.hpp"
#include "ores.variability/domain/feature_flags.hpp"
#include "ores.logging/make_logger.hpp"
#include "ui_FeatureFlagHistoryDialog.h"
 
namespace Ui {
class FeatureFlagHistoryDialog;
}
 
namespace ores::qt {
 
class FeatureFlagHistoryDialog : public QWidget {
    Q_OBJECT
 
private:
    inline static std::string_view logger_name =
        "ores.qt.feature_flag_history_dialog";
 
    [[nodiscard]] static auto& lg() {
        using namespace ores::logging;
        static auto instance = make_logger(logger_name);
        return instance;
    }
 
    const QIcon& getHistoryIcon() const;
 
public:
    explicit FeatureFlagHistoryDialog(QString name,
        ClientManager* clientManager,
        QWidget* parent = nullptr);
    ~FeatureFlagHistoryDialog() override;
 
    void loadHistory();
 
    QSize sizeHint() const override;
 
    void markAsStale();
 
    [[nodiscard]] QString flagName() const { return flagName_; }
 
    [[nodiscard]] const std::vector<variability::domain::feature_flags>& getHistory() const {
        return history_;
    }
 
signals:
    void statusChanged(const QString& message);
    void errorOccurred(const QString& error_message);
 
    void openVersionRequested(const variability::domain::feature_flags& flag, int versionNumber);
 
    void revertVersionRequested(const variability::domain::feature_flags& flag);
 
private slots:
    void onVersionSelected(int index);
    void onHistoryLoaded();
    void onHistoryLoadError(const QString& error);
    void onOpenClicked();
    void onRevertClicked();
    void onReloadClicked();
 
private:
    void displayChangesTab(int version_index);
    void displayFullDetailsTab(int version_index);
 
    using DiffResult = QVector<QPair<QString, QPair<QString, QString>>>;
    DiffResult calculateDiff(
        const variability::domain::feature_flags& current,
        const variability::domain::feature_flags& previous);
 
    void setupToolbar();
    void updateButtonStates();
    int selectedVersionIndex() const;
 
    std::unique_ptr<Ui::FeatureFlagHistoryDialog> ui_;
    ClientManager* clientManager_;
    QString flagName_;
    std::vector<variability::domain::feature_flags> history_;
 
    QToolBar* toolBar_;
    QAction* reloadAction_;
    QAction* openAction_;
    QAction* revertAction_;
};
 
}
 
#endif