debian-mirror-gitlab/lib/gitlab/spamcheck/client.rb

# frozen_string_literal: true
require 'spamcheck'

module Gitlab
  module Spamcheck
    class Client
      include ::Spam::SpamConstants

      DEFAULT_TIMEOUT_SECS = 2

      VERDICT_MAPPING = {
        ::Spamcheck::SpamVerdict::Verdict::ALLOW => ALLOW,
        ::Spamcheck::SpamVerdict::Verdict::CONDITIONAL_ALLOW => CONDITIONAL_ALLOW,
        ::Spamcheck::SpamVerdict::Verdict::DISALLOW => DISALLOW,
        ::Spamcheck::SpamVerdict::Verdict::BLOCK => BLOCK_USER,
        ::Spamcheck::SpamVerdict::Verdict::NOOP => NOOP
      }.freeze

      ACTION_MAPPING = {
        create: ::Spamcheck::Action::CREATE,
        update: ::Spamcheck::Action::UPDATE
      }.freeze

      URL_SCHEME_REGEX = %r{^grpc://|^tls://}.freeze

      def initialize
        @endpoint_url = Gitlab::CurrentSettings.current_application_settings.spam_check_endpoint_url

        @creds = client_creds(@endpoint_url)

        # remove the `grpc://` or 'tls://' as it's only useful to ensure we're expecting to
        # connect with Spamcheck
        @endpoint_url = @endpoint_url.sub(URL_SCHEME_REGEX, '')
      end

      def spam?(spammable:, user:, context: {}, extra_features: {})
        metadata = { 'authorization' => Gitlab::CurrentSettings.spam_check_api_key || '' }
        protobuf_args = { spammable: spammable, user: user, context: context, extra_features: extra_features }

        pb, grpc_method = build_protobuf(**protobuf_args)
        response = grpc_method.call(pb, metadata: metadata)

        verdict = convert_verdict_to_gitlab_constant(response.verdict)
        [verdict, response.extra_attributes.to_h, response.error]
      end

      private

      def get_spammable_mappings(spammable)
        case spammable
        when Issue
          [::Spamcheck::Issue, grpc_client.method(:check_for_spam_issue)]
        when Snippet
          [::Spamcheck::Snippet, grpc_client.method(:check_for_spam_snippet)]
        else
          raise ArgumentError, "Not a spammable type: #{spammable.class.name}"
        end
      end

      def convert_verdict_to_gitlab_constant(verdict)
        VERDICT_MAPPING.fetch(::Spamcheck::SpamVerdict::Verdict.resolve(verdict), verdict)
      end

      def build_protobuf(spammable:, user:, context:, extra_features:)
        protobuf_class, grpc_method = get_spammable_mappings(spammable)
        pb = protobuf_class.new(**extra_features)
        pb.title = spammable.spam_title || ''
        pb.description = spammable.spam_description || ''
        pb.created_at = convert_to_pb_timestamp(spammable.created_at) if spammable.created_at
        pb.updated_at = convert_to_pb_timestamp(spammable.updated_at) if spammable.updated_at
        pb.action = ACTION_MAPPING.fetch(context.fetch(:action)) if context.has_key?(:action)
        pb.user = build_user_protobuf(user)

        unless spammable.project.nil?
          pb.user_in_project = user.authorized_project?(spammable.project)
          pb.project = build_project_protobuf(spammable)
        end

        [pb, grpc_method]
      end

      def build_user_protobuf(user)
        user_pb = ::Spamcheck::User.new
        user_pb.username = user.username
        user_pb.org = user.organization || ''
        user_pb.created_at = convert_to_pb_timestamp(user.created_at)

        user_pb.emails << build_email(user.email, user.confirmed?)

        user.emails.each do |email|
          next if email.user_primary_email?

          user_pb.emails << build_email(email.email, email.confirmed?)
        end

        user_pb
      end

      def build_email(email, verified)
        email_pb = ::Spamcheck::User::Email.new
        email_pb.email = email
        email_pb.verified = verified
        email_pb
      end

      def build_project_protobuf(issue)
        project_pb = ::Spamcheck::Project.new
        project_pb.project_id = issue.project_id
        project_pb.project_path = issue.project.full_path
        project_pb
      end

      def convert_to_pb_timestamp(ar_timestamp)
        Google::Protobuf::Timestamp.new(seconds: ar_timestamp.to_time.to_i,
                                        nanos: ar_timestamp.to_time.nsec)
      end

      def client_creds(url)
        if URI(url).scheme == 'tls'
          GRPC::Core::ChannelCredentials.new(::Gitlab::X509::Certificate.ca_certs_bundle)
        else
          :this_channel_is_insecure
        end
      end

      def grpc_client
        @grpc_client ||= ::Spamcheck::SpamcheckService::Stub.new(@endpoint_url, @creds,
                                                        interceptors: interceptors,
                                                        timeout: DEFAULT_TIMEOUT_SECS)
      end

      def interceptors
        [Labkit::Correlation::GRPC::ClientInterceptor.instance]
      end
    end
  end
end