/**
 *    Copyright (C) 2021-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */
#pragma once

#include <memory>

#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/process_health/fault_manager_config.h"
#include "mongo/db/process_health/health_check_status.h"
#include "mongo/util/duration.h"

namespace mongo {
namespace process_health {

/**
 * Tracks the state of one particular fault facet.
 * The instance is created and deleted by the fault observer when a fault
 * condition is detected or resolved.
 */
class FaultFacet : public std::enable_shared_from_this<FaultFacet> {
public:
    virtual ~FaultFacet() = default;

    virtual FaultFacetType getType() const = 0;

    /**
     * The interface used to communicate with the Fault instance that
     * owns all facets.
     *
     * @return HealthCheckStatus
     */
    virtual HealthCheckStatus getStatus() const = 0;

    virtual Milliseconds getDuration() const = 0;

    /**
     * Change the state of this Facet with health check result.
     */
    virtual void update(HealthCheckStatus status) = 0;

    virtual void appendDescription(BSONObjBuilder* builder) const = 0;

    BSONObj toBSON() const {
        BSONObjBuilder builder;
        appendDescription(&builder);
        return builder.obj();
    }
};

using FaultFacetPtr = std::shared_ptr<FaultFacet>;

}  // namespace process_health
}  // namespace mongo
