mirror of
https://github.com/gitlabhq/gitlabhq.git
synced 2025-07-25 16:00:50 +00:00
95 lines
2.6 KiB
Ruby
95 lines
2.6 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
class WebHookLog < ApplicationRecord
|
|
include Presentable
|
|
include DeleteWithLimit
|
|
include CreatedAtFilterable
|
|
include PartitionedTable
|
|
|
|
OVERSIZE_REQUEST_DATA = { 'oversize' => true }.freeze
|
|
MAX_RECENT_DAYS = 7
|
|
|
|
attr_accessor :interpolated_url
|
|
|
|
self.primary_key = :id
|
|
self.table_name = :web_hook_logs_daily
|
|
partitioned_by :created_at, strategy: :daily, retain_for: 14.days
|
|
|
|
belongs_to :web_hook
|
|
|
|
serialize :request_headers, type: Hash # rubocop:disable Cop/ActiveRecordSerialize
|
|
serialize :request_data, type: Hash # rubocop:disable Cop/ActiveRecordSerialize
|
|
serialize :response_headers, type: Hash # rubocop:disable Cop/ActiveRecordSerialize
|
|
|
|
validates :web_hook, presence: true
|
|
|
|
before_save :obfuscate_basic_auth
|
|
before_save :redact_user_emails
|
|
before_save :set_url_hash, if: -> { interpolated_url.present? }
|
|
|
|
scope :by_status_code, ->(status_code) { where(response_status: status_code) }
|
|
|
|
def self.recent(number_of_days = 2)
|
|
if number_of_days > MAX_RECENT_DAYS
|
|
raise ArgumentError,
|
|
"`recent` scope can only provide up to #{MAX_RECENT_DAYS} days of log records"
|
|
end
|
|
|
|
where(created_at: number_of_days.days.ago.beginning_of_day..Time.zone.now)
|
|
.order(created_at: :desc)
|
|
end
|
|
|
|
# Delete a batch of log records. Returns true if there may be more remaining.
|
|
def self.delete_batch_for(web_hook, batch_size:)
|
|
raise ArgumentError, 'batch_size is too small' if batch_size < 1
|
|
|
|
where(web_hook: web_hook).limit(batch_size).delete_all == batch_size
|
|
end
|
|
|
|
def success?
|
|
response_status =~ /^2/
|
|
end
|
|
|
|
def internal_error?
|
|
response_status == WebHookService::InternalErrorResponse::ERROR_MESSAGE
|
|
end
|
|
|
|
def oversize?
|
|
request_data == OVERSIZE_REQUEST_DATA
|
|
end
|
|
|
|
def request_headers
|
|
return super unless self[:request_headers]['X-Gitlab-Token']
|
|
|
|
self[:request_headers].merge('X-Gitlab-Token' => _('[REDACTED]'))
|
|
end
|
|
|
|
def idempotency_key
|
|
self[:request_headers]['Idempotency-Key']
|
|
end
|
|
|
|
def url_current?
|
|
# URL hash hasn't been set, so we must assume there's no prior value to
|
|
# compare to.
|
|
return true if url_hash.nil?
|
|
|
|
Gitlab::CryptoHelper.sha256(web_hook.interpolated_url) == url_hash
|
|
end
|
|
|
|
private
|
|
|
|
def obfuscate_basic_auth
|
|
self.url = Gitlab::UrlSanitizer.sanitize_masked_url(url)
|
|
end
|
|
|
|
def redact_user_emails
|
|
self.request_data.deep_transform_values! do |value|
|
|
URI::MailTo::EMAIL_REGEXP.match?(value.to_s) ? _('[REDACTED]') : value
|
|
end
|
|
end
|
|
|
|
def set_url_hash
|
|
self.url_hash = Gitlab::CryptoHelper.sha256(interpolated_url)
|
|
end
|
|
end
|