gitlab-org--gitlab-foss/lib/gitlab/utils/log_limited_array.rb

# frozen_string_literal: true

module Gitlab
  module Utils
    module LogLimitedArray
      MAXIMUM_ARRAY_LENGTH = 10.kilobytes

      # Prepare an array for logging by limiting its JSON representation
      # to around 10 kilobytes. Once we hit the limit, add the sentinel
      # value as the last item in the returned array.
      def self.log_limited_array(array, sentinel: '...')
        return [] unless array.is_a?(Array) || array.is_a?(Enumerator::Lazy)

        total_length = 0
        limited_array = array.take_while do |arg|
          total_length += JsonSizeEstimator.estimate(arg)

          total_length <= MAXIMUM_ARRAY_LENGTH
        end.to_a

        limited_array.push(sentinel) if total_length > MAXIMUM_ARRAY_LENGTH

        limited_array
      end
    end
  end
end