src/developer/forensics/feedback_data/integrity_reporter.h

// Copyright 2020 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_DEVELOPER_FORENSICS_FEEDBACK_DATA_INTEGRITY_REPORTER_H_
#define SRC_DEVELOPER_FORENSICS_FEEDBACK_DATA_INTEGRITY_REPORTER_H_

#include <lib/fit/result.h>

#include <optional>
#include <string>

#include "src/developer/forensics/feedback_data/annotations/types.h"
#include "src/developer/forensics/feedback_data/attachments/types.h"

namespace forensics {
namespace feedback_data {

// Reports on the integrity of the provided Annotations and Attachments.
class IntegrityReporter {
 public:
  IntegrityReporter(const AnnotationKeys& annotation_allowlist,
                    const AttachmentKeys& attachment_allowlist);

  // Returns a JSON integrity report. No report is returned if no annotations or attachments will be
  // in the bugreport.
  //
  // |missing_non_platform_annotations| indicates whether some non-platform annotations are
  // missing, i.e. whether clients tried to insert more non-platform annotations than the maximum
  // number of non-platform annotations the Datastore can hold.
  std::optional<std::string> MakeIntegrityReport(const ::fit::result<Annotations>& annotations,
                                                 const ::fit::result<Attachments>& attachments,
                                                 bool missing_non_platform_annotations) const;

 private:
  AnnotationKeys annotation_allowlist_;
  AttachmentKeys attachment_allowlist_;
};

}  // namespace feedback_data
}  // namespace forensics

#endif  // SRC_DEVELOPER_FORENSICS_FEEDBACK_DATA_INTEGRITY_REPORTER_H_