# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
# frozen_string_literal: true

require 'contrast/components/assess'
require 'contrast/utils/string_utils'
require 'contrast/agent/reporting/reporting_events/reportable_hash'

module Contrast
  module Agent
    module Reporting
      # This is the new PreflightMessage class which will include all the needed information for the new reporting
      # system to report a single message, part of the main Preflight, to TeamServer. This message represents the
      # identifying information of a Finding/Trace, which TeamServer will use to determine if it requires the full
      # information of the Finding/Trace to be reported.
      class PreflightMessage < Contrast::Agent::Reporting::ReportableHash
        # @return [String] the message identifier; rule_id,hash
        attr_accessor :data
        # @return [String] CRC checksum of the finding to which this message pertains
        attr_accessor :hash_code
        # @return [Array<Contrast::Agent::Reporting::RouteDiscovery] the route that triggered the finding to which this
        #   preflight applies.
        attr_reader :routes

        # The type of this event, as understood by TeamServer. While TRACE and APPUPDATE are both technically valid, we
        # only use the TRACE type.
        CODE = :TRACE

        def initialize
          @routes = []
          super()
        end

        # Convert the instance variables on the class, and other information, into the identifiers required for
        # TeamServer to process the JSON form of this message.
        #
        # @return [Hash]
        # @raise [ArgumentError]
        def to_controlled_hash
          validate
          {
              appLanguage: Contrast::Utils::ObjectShare::RUBY,
              appName: ::Contrast::APP_CONTEXT.name, # rubocop:disable Security/Module/Name
              appPath: ::Contrast::APP_CONTEXT.name, # rubocop:disable Security/Module/Name
              appVersion: ::Contrast::APP_CONTEXT.version,
              code: CODE,
              data: '',
              key: 0,
              session_id: ::Contrast::ASSESS.session_id,
              routes: @routes.map(&:to_controlled_hash)
          }.compact
        end

        # @raise [ArgumentError]
        def validate
          unless Contrast::Utils::StringUtils.present?(data)
            raise(ArgumentError, "#{ cs__class } did not have a proper data. Unable to continue.")
          end
          unless Contrast::APP_CONTEXT.name # rubocop:disable Security/Module/Name
            raise(ArgumentError, "#{ cs__class } did not have a proper Application Name. Unable to continue.")
          end

          nil
        end
      end
    end
  end
end