WikiEducationFoundation/WikiEduDashboard

# frozen_string_literal: true

require_dependency "#{Rails.root}/app/workers/blocked_edits_worker"
#= Reports message to Sentry about the success or failure of wiki edits
class WikiResponse
  ###############
  # Entry point #
  ###############
  def self.capture(response_data, opts)
    message = new(response_data, opts)
    message.parse_api_response
    message.send_to_sentry
  end

  #################
  # Main routines #
  #################

  def initialize(response_data, opts={})
    @response_data = response_data
    @edit_data = response_data['edit']
    @current_user = opts[:current_user] || {}
    @post_data = opts[:post_data]
    @type = opts[:type]
  end

  def parse_api_response
    # {"edit"=>
    #   {"result"=>"Success",
    #    "pageid"=>11543696,
    #    "title"=>"User:Ragesock",
    #    "contentmodel"=>"wikitext",
    #    "oldrevid"=>671572777,
    #    "newrevid"=>674946741,
    #    "newtimestamp"=>"2015-08-07T05:27:43Z"}}
    #
    # A failed edit will have a response like this:
    # {"servedby"=>"mw1135",
    #  "error"=>
    #    {"code"=>"protectedpage",
    #     "info"=>"The \"templateeditor\" right is required to edit this page",
    #     "*"=>"See https://en.wikipedia.org/w/api.php for API usage"}}
    #
    # An edit stopped by the abuse filter will respond like this:
    # {"edit"=>
    #   {"result"=>"Failure",
    #    "code"=>"abusefilter-warning-email",
    #    "info"=>"Hit AbuseFilter: Adding emails in articles",
    #    "warning"=>"[LOTS OF HTML WARNING TEXT]"}}
    if @response_data['error']
      parse_api_error_response
    elsif @edit_data
      parse_api_edit_response
    elsif @response_data['query']
      parse_api_query_response
    elsif @response_data['options']
      parse_api_options_response
    elsif @response_data['createaccount']
      parse_api_createaccount_response
    else
      parse_api_unknown_response
    end
  end

  # These represent well-known messages that we do not need to capture.
  # Bypassing Sentry capture avoids a performance hit.
  MESSAGES_TO_IGNORE = [
    'Successful edit',
    'tokens query',
    'Successful options update'
  ].freeze
  def send_to_sentry
    return if MESSAGES_TO_IGNORE.include?(@title)
    Sentry.capture_message @title,
                           level: @level,
                           tags: { username: @current_user[:username],
                                   action_type: @type },
                           extra: { response_data: @response_data,
                                    post_data: @post_data,
                                    current_user: @current_user[:username] }
  end

  ###################
  # Parsing methods #
  ###################

  private

  def parse_api_edit_response
    if @edit_data['result'] == 'Success'
      @title = "Successful #{@type}"
      @level = 'info'
    else
      parse_failed_edit
    end
  end

  def parse_failed_edit
    @title = "Failed #{@type}"
    @title += ': CAPTCHA' if @edit_data['captcha']
    code = @response_data['edit']['code']
    @title += ": #{code}" if @edit_data['code']
    @level = 'warning'
  end

  def parse_api_error_response
    code = @response_data['error']['code']
    info = @response_data.dig('error', 'info')

    case code
    when 'mwoauth-invalid-authorization'
      # If the OAuth credentials are invalid, we need to flag this.
      # It gets handled by application controller.
      # However, if it's just a case of overlapping actions that invalidate
      # an individual edit, don't invalidate the token in that case.
      # The info message for such errors is something like this:
      # The authorization headers in your request are not valid: Nonce already used: kj7w9...
      @current_user.update(wiki_token: 'invalid') unless info.include?('Nonce already used')
    when 'blocked', 'autoblocked', 'wikimedia-globalblocking-ipblocked-range'
      BlockedEditsWorker.schedule_notifications(user: @current_user, response_data: @response_data)
    end

    @title = "Failed #{@type}: #{code}"
    @level = 'warning'
  end

  def parse_api_query_response
    @title = "#{@type} query"
    @level = 'info'
  end

  def parse_api_options_response
    if @response_data['warnings']
      @title = "Unexpected warning for #{@type} update"
      @level = 'error'
    else
      @title = "Successful #{@type} update"
      @level = 'info'
    end
  end

  def parse_api_createaccount_response
    @level = 'info'
    result = @response_data['createaccount']['status']
    @title = "Create account result: #{result}"
  end

  def parse_api_unknown_response
    @title = "Unknown response for #{@type}"
    @level = 'error'
  end
end