SWAMPy

✎ CARVE FLESH

EDITING: info.rb

# frozen_string_literal: true

#
# Copyright (C) 2015 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas 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 GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.

require_relative "../errors"
module Canvas
  class Errors
    # This is a class for taking the common context
    # found in the request/response cycle for an exception
    # and turning it into a pleasent hash for Canvas::Errors
    # to make use of.
    class Info
      attr_reader :req, :account, :user, :rci, :type

MAX_DATA_SIZE = 65_535

def initialize(request, root_account, user, opts = {})
        @req = request
        @account = root_account
        @user = user
        @rci = opts.fetch(:request_context_id, RequestContext::Generator.request_id)
        @type = opts.fetch(:type, nil)
        @canvas_error_info = opts.fetch(:canvas_error_info, {})
      end

# The ideal hash format to pass to Canvas::Errors.capture().
      #
      # If you're trying to find a way to transform some other common
      # context, this is a decent model to follow.
      def to_h
        {
          tags: {
            account_id: @account.try(:global_id),
            user_id: @user.try(:global_id),
            type: @type,
          },
          extra: {
            request_context_id: @rci,
            request_method: @req.request_method_symbol,
            format: @req.format,
          }.merge(self.class.useful_http_env_stuff_from_request(@req))
            .merge(self.class.useful_http_headers(@req))
            .merge(@canvas_error_info)
        }
      end

USEFUL_ENV = %w[
        HTTP_ACCEPT
        HTTP_ACCEPT_ENCODING
        HTTP_HOST
        HTTP_REFERER
        HTTP_USER_AGENT
        PATH_INFO
        QUERY_STRING
        REMOTE_HOST
        REQUEST_METHOD
        REQUEST_PATH
        REQUEST_URI
        SERVER_NAME
        SERVER_PORT
        SERVER_PROTOCOL
        HTTP_X_FORWARDED_HOST
        HTTP_X_FORWARDED_PROTO
        HTTP_X_FORWARDED_FOR
      ].freeze

def self.useful_http_env_stuff_from_request(req)
        stuff = req.env.slice(*USEFUL_ENV)
        req_stuff = stuff.merge(filtered_request_params(req, stuff["QUERY_STRING"]))
        Marshal.load(Marshal.dump(req_stuff))
      end

def self.useful_http_headers(req)
        headers = {
          user_agent: req.headers["User-Agent"]
        }

# if we have an oauth1 header lets get the appropriate info from it
        if req.authorization&.match(/^OAuth/)
          headers.merge!(::OAuth::Helper.parse_header(req.authorization))
        end

headers
      end

def self.filtered_request_params(req, query_string)
        f = LoggingFilter
        {
          # ActionDispatch::Request#remote_ip has proxy smarts
          "REMOTE_ADDR" => req.remote_ip,
          "QUERY_STRING" => f.filter_query_string("?" + (query_string || "")),
          "REQUEST_URI" => f.filter_uri(req.url),
          "path_parameters" => f.filter_params(req.path_parameters.dup).inspect,
          "query_parameters" => f.filter_params(req.query_parameters.dup).inspect,
          "request_parameters" => f.filter_params(req.request_parameters.dup).inspect[0, MAX_DATA_SIZE],
        }
      end
      private_class_method :filtered_request_params
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 info.rb	RB	3.7 KB	2023-09-24 03:36	EDIT
📄 log_entry.rb	RB	2.7 KB	2023-09-24 03:36	EDIT
📄 reporter.rb	RB	1.9 KB	2023-09-24 03:36	EDIT
📄 worker_info.rb	RB	1 KB	2023-09-24 03:36	EDIT