Class: RailsVitals::Playground::Sandbox

Inherits:
Object
  • Object
show all
Defined in:
lib/rails_vitals/playground/sandbox.rb

Defined Under Namespace

Classes: Result

Constant Summary collapse

BLOCKED_PATTERNS = 
[
  /\b(insert|update|delete|destroy|drop|truncate|create|alter)\b/i,
  /\.save/i, /\.save!/i, /\.update/i, /\.delete/i,
  /\.destroy/i, /`/
].freeze
SAFE_EXPRESSION_PATTERN = 
/\A[a-zA-Z0-9_\.\s\(\),:\[\]{}'"!?=<>|&*+\-\/\\%]+\z/
ASSOCIATION_NAME_PATTERN = 
/\A[a-zA-Z_][a-zA-Z0-9_]*\z/
DEFAULT_LIMIT = 
100

Class Method Summary collapse

Class Method Details

.apply_limit(relation) ⇒ Object 



151
152
153
154
155
156
157
158
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 151

def self.apply_limit(relation)
  # Only apply default limit if no limit already set
  if relation.limit_value.nil?
    relation.limit(DEFAULT_LIMIT)
  else
    relation
  end
end

.associations_for(model_name) ⇒ Object 



112
113
114
115
116
117
118
119
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 112

def self.associations_for(model_name)
  model = safe_constantize(model_name)
  return [] unless model

  model.reflect_on_all_associations.map { |r| r.name.to_s }.sort
rescue
  []
end

.available_models ⇒ Object 



202
203
204
205
206
207
208
209
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 202

def self.available_models
  ActiveRecord::Base.descendants
    .reject(&:abstract_class?)
    .reject { |m| m.name&.start_with?("RailsVitals") }
    .select { |m| m.table_exists? rescue false }
    .map(&:name)
    .sort
end

.blocked_result(message) ⇒ Object 



194
195
196
197
198
199
200
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 194

def self.blocked_result(message)
  Result.new(
    queries: [], query_count: 0, duration_ms: 0,
    error: message, model_name: nil, record_count: 0,
    score: nil, n1_patterns: []
  )
end

.build_relation(expression, model) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 139

def self.build_relation(expression, model)
  chain_str = expression
    .sub(/\A#{Regexp.escape(model.name)}\s*\.?\s*/, "")
    .strip

  return model.all if chain_str.blank?

  SafeChainBuilder.build(chain_str, model)
rescue SafeChainBuilder::ParseError => e
  raise "Expression error: #{e.message}"
end

.detect_n1(queries) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 160

def self.detect_n1(queries)
  normalized = queries.map do |q|
    q[:sql]
      .gsub(/\b\d+\b/, "?")
      .gsub(/'[^']*'/, "?")
      .gsub(/\bIN\s*\([^)]+\)/, "IN (?)")
      .downcase.strip
  end

  normalized
    .tally
    .select { |_, count| count > 1 }
    .map { |sql, count| { pattern: sql, count: count } }
end

.extract_model_name(expression) ⇒ Object 



121
122
123
124
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 121

def self.extract_model_name(expression)
  match = expression.match(/\A([A-Z][A-Za-z0-9]*)/)
  match ? match[1] : nil
end

.project_score(query_count, n1_count) ⇒ Object 



175
176
177
178
179
180
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 175

def self.project_score(query_count, n1_count)
  config = RailsVitals.config
  query_score = score_queries(query_count, config)
  n1_score = score_n1(n1_count)
  (query_score * 0.40 + n1_score * 0.60).round
end

.run(expression, access_associations: []) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 23

def self.run(expression, access_associations: [])
  return blocked_result("No expression provided") if expression.blank?

  expression = expression.gsub(/#[^\n]*/, "").strip
  return blocked_result("No expression provided") if expression.blank?

  return blocked_result(
    "Expression contains invalid characters."
  ) unless expression.match?(SAFE_EXPRESSION_PATTERN)

  BLOCKED_PATTERNS.each do |pattern|
    return blocked_result(
      "Expression contains blocked operation. " \
      "The Playground is read-only — no writes permitted."
    ) if expression.match?(pattern)
  end

  access_associations = access_associations.select do |name|
    name.to_s.match?(ASSOCIATION_NAME_PATTERN)
  end

  model_name = extract_model_name(expression)
  return blocked_result(
    "Could not detect model from expression. " \
    "Start your query with a model name e.g. Post.includes(:likes)"
  ) unless model_name

  model = safe_constantize(model_name)
  return blocked_result(
    "Unknown model: #{model_name}. " \
    "Available models: #{available_models.join(', ')}"
  ) unless model

  queries = []
  start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)

  subscriber = ActiveSupport::Notifications.subscribe("sql.active_record") do |*, payload|
    next if RailsVitals::Notifications::Subscriber.internal_query?(payload[:sql])

    queries << {
      sql: payload[:sql],
      duration_ms: (payload[:duration].to_f / 1000).round(3)
    }
  end

  begin
    Timeout.timeout(2) do
      relation = build_relation(expression, model)
      relation = apply_limit(relation)
      records = relation.load

      # Simulate association access — triggers N+1 if not eager loaded
      if access_associations.any?
        records.each do |record|
          access_associations.each do |assoc|
            next unless record.class.reflect_on_association(assoc.to_sym)
            assoc_value = record.public_send(assoc)
            # Force load if it's a relation
            assoc_value.load if assoc_value.respond_to?(:load)
          end
        end
      end
    end
  rescue Timeout::Error
    return blocked_result("Query timed out after 2 seconds.")
  rescue => e
    return blocked_result("Execution error: #{e.message}")
  ensure
    ActiveSupport::Notifications.unsubscribe(subscriber)
  end

  duration_ms = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000).round(2)
  n1_patterns = detect_n1(queries)
  score = project_score(queries.size, n1_patterns.size)

  Result.new(
    queries: queries,
    query_count: queries.size,
    duration_ms: duration_ms,
    error: nil,
    model_name: model_name,
    record_count: DEFAULT_LIMIT,
    score: score,
    n1_patterns: n1_patterns
  )
rescue => e
  blocked_result("Unexpected error: #{e.message}")
end

.safe_constantize(name) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 128

def self.safe_constantize(name)
  return nil unless name.match?(/\A[A-Z][A-Za-z0-9:]*\z/)

  klass = name.constantize
  return nil unless klass < ActiveRecord::Base

  klass
rescue NameError
  nil
end

.score_n1(count) ⇒ Object 



190
191
192
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 190

def self.score_n1(count)
  Scorers::NPlusOneScorer.score_for(count)
end

.score_queries(count, config) ⇒ Object 



182
183
184
185
186
187
188
 
# File 'lib/rails_vitals/playground/sandbox.rb', line 182

def self.score_queries(count, config)
  return 100 if count <= config.query_warn_threshold
  return 0   if count >= config.query_critical_threshold

  range = config.query_critical_threshold - config.query_warn_threshold
  (100 - ((count - config.query_warn_threshold).to_f / range * 100)).round
end