Class: Noiseless::Introspection::QueryVisualizer

Inherits:
Object
  • Object
show all
Defined in:
lib/noiseless/introspection/query_visualizer.rb

Class Method Summary collapse

Class Method Details

.adapter_capability_matrix_to_mermaid ⇒ Object 



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 403

def self.adapter_capability_matrix_to_mermaid
  return "# Mermaid diagrams require 'diagrams' and 'mermaid' gems\n# Add to Gemfile: gem 'diagrams'; gem 'mermaid'" unless DIAGRAMS_AVAILABLE

  # Create an ER diagram showing adapter capabilities
  diagram = Diagrams::ERDiagram.new

  # Add adapter entities
  diagram.add_entity(
    name: "ADAPTER",
    attributes: [
      { type: "string", name: "type", keys: [:PK] },
      { type: "string", name: "execution_mode" },
      { type: "string", name: "engine_name" }
    ]
  )

  diagram.add_entity(
    name: "CAPABILITY",
    attributes: [
      { type: "string", name: "name", keys: [:PK] },
      { type: "string", name: "description" }
    ]
  )

  diagram.add_entity(
    name: "ADAPTER_CAPABILITY",
    attributes: [
      { type: "string", name: "adapter_type", keys: %i[PK FK] },
      { type: "string", name: "capability_name", keys: %i[PK FK] }
    ]
  )

  # Add relationships
  diagram.add_relationship(
    entity1: "ADAPTER",
    entity2: "ADAPTER_CAPABILITY",
    cardinality1: :ONE_ONLY,
    cardinality2: :ZERO_OR_MORE,
    label: "has"
  )

  diagram.add_relationship(
    entity1: "CAPABILITY",
    entity2: "ADAPTER_CAPABILITY",
    cardinality1: :ONE_ONLY,
    cardinality2: :ZERO_OR_MORE,
    label: "provided by"
  )

  diagram.to_mermaid
end

.add_ast_children_to_class_diagram(diagram, node, parent_class_name) ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 497

def self.add_ast_children_to_class_diagram(diagram, node, parent_class_name)
  return unless node.respond_to?(:instance_variables)

  node.instance_variables.each do |var|
    child_value = node.instance_variable_get(var)

    next unless child_value.is_a?(Noiseless::AST::Node)

    child_class_name = child_value.class.name.split("::").last

    # Add child class if not already added
    unless diagram.classes.any? { |c| c.name == child_class_name }
      child_class = Diagrams::Elements::ClassEntity.new(
        name: child_class_name,
        attributes: child_value.instance_variables.map do |cv|
          "#{cv.to_s.delete('@')}: #{child_value.instance_variable_get(cv).class.name.split('::').last}"
        end
      )
      diagram.add_class(child_class)
    end

    # Add relationship
    relationship = Diagrams::Elements::Relationship.new(
      source_class_name: parent_class_name,
      target_class_name: child_class_name,
      type: "composition",
      label: var.to_s.delete("@")
    )
    diagram.add_relationship(relationship)

    # Recursively add children
    add_ast_children_to_class_diagram(diagram, child_value, child_class_name)
  end
end

.add_ast_node_to_flowchart(diagram, node, node_id) ⇒ Object 



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 455

def self.add_ast_node_to_flowchart(diagram, node, node_id)
  # Add current node
  flowchart_node = Diagrams::Elements::Node.new(
    id: node_id,
    label: node.class.name.split("::").last.to_s
  )
  diagram.add_node(flowchart_node)

  # Add child nodes and connect them
  return unless node.respond_to?(:instance_variables)

  node.instance_variables.each_with_index do |var, _index|
    child_value = node.instance_variable_get(var)

    if child_value.is_a?(Noiseless::AST::Node)
      child_id = "#{node_id}_#{var.to_s.delete('@')}"
      add_ast_node_to_flowchart(diagram, child_value, child_id)

      edge = Diagrams::Elements::Edge.new(
        source_id: node_id,
        target_id: child_id,
        label: var.to_s.delete("@")
      )
      diagram.add_edge(edge)
    elsif child_value.is_a?(Array) && child_value.any?(Noiseless::AST::Node)
      child_value.each_with_index do |item, item_index|
        next unless item.is_a?(Noiseless::AST::Node)

        child_id = "#{node_id}_#{var.to_s.delete('@')}_#{item_index}"
        add_ast_node_to_flowchart(diagram, item, child_id)

        edge = Diagrams::Elements::Edge.new(
          source_id: node_id,
          target_id: child_id,
          label: "#{var.to_s.delete('@')}[#{item_index}]"
        )
        diagram.add_edge(edge)
      end
    end
  end
end

.analyze_cross_engine_compatibility(translations) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 150

def self.analyze_cross_engine_compatibility(translations)
  available_engines = translations.reject { |_, data| data.key?(:error) }

  analysis = {
    compatible_engines: available_engines.keys,
    query_variations: {},
    potential_issues: []
  }

  # Compare query structures across engines
  queries = available_engines.transform_values { |data| data[:engine_query] }

  if queries.values.uniq.size > 1
    analysis[:query_variations] = queries
    analysis[:potential_issues] << {
      type: :query_structure_differences,
      description: "Engines produce different query structures",
      severity: :medium
    }
  end

  # Check for feature compatibility
  features_by_engine = available_engines.transform_values do |data|
    data[:adapter_info][:capabilities]
  end

  common_features = features_by_engine.values.reduce(:&)
  analysis[:common_features] = common_features

  analysis
end

.analyze_query_differences(original_ast, engine_query) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 88

def self.analyze_query_differences(original_ast, engine_query)
  differences = []

  # Check for field mapping differences
  original_fields = extract_fields_from_ast(original_ast)
  engine_fields = extract_fields_from_query(engine_query)

  if original_fields != engine_fields
    differences << {
      type: :field_mapping,
      original: original_fields,
      engine: engine_fields,
      impact: :medium
    }
  end

  # Check for query structure differences
  if has_structural_differences?(original_ast, engine_query)
    differences << {
      type: :structural_change,
      description: "Query structure adapted for engine compatibility",
      impact: :low
    }
  end

  differences
end

.ast_to_mermaid_class_diagram(ast_node) ⇒ Object 



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 381

def self.ast_to_mermaid_class_diagram(ast_node)
  return "# Mermaid diagrams require 'diagrams' and 'mermaid' gems\n# Add to Gemfile: gem 'diagrams'; gem 'mermaid'" unless DIAGRAMS_AVAILABLE

  diagram = Diagrams::ClassDiagram.new(version: "1.0")

  # Create a class representation of the AST structure
  root_class = Diagrams::Elements::ClassEntity.new(
    name: ast_node.class.name.split("::").last,
    attributes: ast_node.instance_variables.map do |var|
      "#{var.to_s.delete('@')}: #{ast_node.instance_variable_get(var).class.name.split('::').last}"
    end,
    methods: ast_node.public_methods(false).map { |method| "+#{method}()" }
  )

  diagram.add_class(root_class)

  # Add child nodes as related classes
  add_ast_children_to_class_diagram(diagram, ast_node, root_class.name)

  diagram.to_mermaid
end

.ast_to_mermaid_flowchart(ast_node) ⇒ Object

New methods using your diagram/mermaid gems



370
371
372
373
374
375
376
377
378
379
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 370

def self.ast_to_mermaid_flowchart(ast_node)
  return "# Mermaid diagrams require 'diagrams' and 'mermaid' gems\n# Add to Gemfile: gem 'diagrams'; gem 'mermaid'" unless DIAGRAMS_AVAILABLE

  diagram = Diagrams::FlowchartDiagram.new(version: "1.0")

  # Convert AST structure to flowchart nodes and edges
  add_ast_node_to_flowchart(diagram, ast_node, "root")

  diagram.to_mermaid
end

.calculate_query_complexity(query) ⇒ Object 



352
353
354
355
356
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 352

def self.calculate_query_complexity(query)
  complexity_counter = { count: 0 }
  count_recursive(query, complexity_counter)
  complexity_counter[:count]
end

.compare_across_engines(ast_node, **_opts) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
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
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 13

def self.compare_across_engines(ast_node, **_opts)
  adapters = [
    { name: :elasticsearch, class: Noiseless::Adapters::Elasticsearch },
    { name: :opensearch, class: Noiseless::Adapters::OpenSearch },
    { name: :typesense, class: Noiseless::Adapters::Typesense }
  ]

  comparison = {
    original_ast: ast_node.to_h,
    engine_translations: {},
    compatibility_analysis: {},
    recommendations: []
  }

  adapters.each do |adapter_config|
    adapter = adapter_config[:class].new

    # Get the translated query
    engine_query = adapter.send(:ast_to_hash, ast_node)

    # Get adapter info
    adapter_info = adapter.adapter_info

    comparison[:engine_translations][adapter_config[:name]] = {
      engine_query: engine_query,
      adapter_info: adapter_info,
      query_differences: analyze_query_differences(ast_node.to_h, engine_query),
      estimated_performance: estimate_performance(adapter_info, engine_query)
    }
  rescue StandardError => e
    comparison[:engine_translations][adapter_config[:name]] = {
      error: e.message,
      available: false
    }
  end

  # Analyze compatibility across engines
  comparison[:compatibility_analysis] = analyze_cross_engine_compatibility(comparison[:engine_translations])

  # Generate recommendations
  comparison[:recommendations] = generate_recommendations(comparison)

  comparison
end

.count_recursive(node, complexity) ⇒ Object 



358
359
360
361
362
363
364
365
366
367
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 358

def self.count_recursive(node, complexity)
  case node
  when Hash
    complexity[:count] += node.size
    node.each_value { |value| count_recursive(value, complexity) }
  when Array
    complexity[:count] += node.size
    node.each { |item| count_recursive(item, complexity) }
  end
end

.estimate_performance(adapter_info, engine_query) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 116

def self.estimate_performance(adapter_info, engine_query)
  base_score = 100

  # Adjust based on query complexity
  complexity_penalty = calculate_query_complexity(engine_query) * 5
  base_score -= complexity_penalty

  # Adjust based on adapter capabilities
  if adapter_info[:execution_mode] == :async
    base_score += 10 # Async generally better for I/O
  end

  # Engine-specific adjustments
  case adapter_info[:engine_name]
  when :typesense
    base_score += 15 # Generally faster for simple queries
  when :elasticsearch, :opensearch
    base_score += 5 # Good for complex queries
  end

  {
    estimated_score: [base_score, 0].max,
    factors: {
      complexity_penalty: complexity_penalty,
      async_bonus: adapter_info[:execution_mode] == :async ? 10 : 0,
      engine_factor: case adapter_info[:engine_name]
                     when :typesense then 15
                     when :elasticsearch, :opensearch then 5
                     else 0
                     end
    }
  }
end

.explain_query_flow(ast_node, adapter) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 75

def self.explain_query_flow(ast_node, adapter)
  explanation = adapter.explain_query(ast_node)

  flow_diagram = generate_flow_diagram(explanation)

  {
    explanation: explanation,
    visual_flow: flow_diagram,
    performance_breakdown: format_performance_breakdown(explanation[:performance]),
    optimization_suggestions: suggest_optimizations(explanation)
  }
end

.extract_fields_from_ast(ast) ⇒ Object

Helper methods



322
323
324
325
326
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 322

def self.extract_fields_from_ast(ast)
  fields = []
  extract_recursive(ast, fields)
  fields.uniq
end

.extract_fields_from_query(_query) ⇒ Object 



339
340
341
342
343
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 339

def self.extract_fields_from_query(_query)
  # This would need to be engine-specific
  # For now, return empty array
  []
end

.extract_recursive(node, fields) ⇒ Object 



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 328

def self.extract_recursive(node, fields)
  case node
  when Hash
    fields << node["field"] if node["field"]
    fields << node[:field] if node[:field]
    node.each_value { |value| extract_recursive(value, fields) }
  when Array
    node.each { |item| extract_recursive(item, fields) }
  end
end

.format_performance_breakdown(performance) ⇒ Object 



295
296
297
298
299
300
301
302
303
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 295

def self.format_performance_breakdown(performance)
  performance.map do |metric, value|
    {
      metric: metric.to_s.humanize,
      value: value,
      unit: metric.to_s.end_with?("_ms") ? "milliseconds" : "unknown"
    }
  end
end

.generate_flow_diagram(explanation) ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 271

def self.generate_flow_diagram(explanation)
  # Create a sequence diagram showing the query execution flow
  diagram = "sequenceDiagram\n".dup
  diagram << "    participant Client\n"
  diagram << "    participant Adapter\n"
  diagram << "    participant Engine\n"

  explanation[:execution_plan].each do |step|
    diagram << case step[:description]
               when /validate/i
                 "    Client->>Adapter: #{step[:description]}\n"
               when /convert/i, /format/i
                 "    Adapter->>Adapter: #{step[:description]}\n"
               when /execute/i, /query/i
                 "    Adapter->>Engine: #{step[:description]}\n"
               else
                 "    Engine->>Adapter: #{step[:description]}\n"
               end
  end

  diagram << "    Adapter->>Client: Return results\n"
  diagram
end

.generate_mermaid_diagram(ast_node) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 233

def self.generate_mermaid_diagram(ast_node)
  diagram = "graph TD\n".dup

  add_node = lambda do |diagram, node, parent_id, counter|
    case node
    when Hash
      node.each do |key, value|
        current_id = "N#{counter[:count]}"
        counter[:count] += 1
        diagram << "  #{current_id}[#{key}]\n"
        diagram << "  #{parent_id} --> #{current_id}\n" if parent_id
        add_node.call(diagram, value, current_id, counter)
      end
    when Array
      node.each_with_index do |item, index|
        current_id = "N#{counter[:count]}"
        counter[:count] += 1
        diagram << "  #{current_id}[Item #{index}]\n"
        diagram << "  #{parent_id} --> #{current_id}\n" if parent_id
        add_node.call(diagram, item, current_id, counter)
      end
    else
      current_id = "N#{counter[:count]}"
      counter[:count] += 1
      diagram << "  #{current_id}[#{node}]\n"
      diagram << "  #{parent_id} --> #{current_id}\n" if parent_id
    end
  end

  counter = { count: 0 }
  root_id = "N#{counter[:count]}"
  counter[:count] += 1
  diagram << "  #{root_id}[Root]\n"

  add_node.call(diagram, ast_node.to_h, root_id, counter)
  diagram
end

.generate_recommendations(comparison) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 182

def self.generate_recommendations(comparison)
  recommendations = []

  # Performance recommendations
  best_performance = comparison[:engine_translations]
                     .reject { |_, data| data.key?(:error) }
                     .max_by { |_, data| data[:estimated_performance][:estimated_score] }

  if best_performance
    recommendations << {
      type: :performance,
      recommendation: "Consider using #{best_performance[0]} for optimal performance",
      score: best_performance[1][:estimated_performance][:estimated_score]
    }
  end

  # Compatibility recommendations
  if comparison[:compatibility_analysis][:potential_issues].any?
    recommendations << {
      type: :compatibility,
      recommendation: "Query may behave differently across engines",
      issues: comparison[:compatibility_analysis][:potential_issues]
    }
  end

  recommendations
end

.has_structural_differences?(ast, query) ⇒ Boolean

Returns:

  • (Boolean) 


345
346
347
348
349
350
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 345

def self.has_structural_differences?(ast, query)
  # Simple heuristic - if the query has different top-level keys
  ast_keys = ast.keys.sort
  query_keys = query.keys.sort
  ast_keys != query_keys
end

.suggest_optimizations(explanation) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 305

def self.suggest_optimizations(explanation)
  suggestions = []

  # Check for slow AST conversion
  if explanation[:performance][:ast_conversion_ms] > 1.0
    suggestions << {
      type: :performance,
      area: :ast_conversion,
      suggestion: "AST conversion is slow. Consider simplifying the query structure.",
      impact: :medium
    }
  end

  suggestions
end

.visualize_as_tree(node, depth = 0) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 210

def self.visualize_as_tree(node, depth = 0)
  indent = "  " * depth

  case node
  when Hash
    result = ""
    node.each do |key, value|
      result += "#{indent}#{key}:\n"
      result += visualize_as_tree(value, depth + 1)
    end
    result
  when Array
    result = ""
    node.each_with_index do |item, index|
      result += "#{indent}[#{index}]:\n"
      result += visualize_as_tree(item, depth + 1)
    end
    result
  else
    "#{indent}#{node}\n"
  end
end

.visualize_ast(ast_node, format: :tree) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/noiseless/introspection/query_visualizer.rb', line 58

def self.visualize_ast(ast_node, format: :tree)
  case format
  when :tree
    visualize_as_tree(ast_node.to_h)
  when :json
    JSON.pretty_generate(ast_node.to_h)
  when :yaml
    YAML.dump(ast_node.to_h)
  when :mermaid
    ast_to_mermaid_flowchart(ast_node)
  when :mermaid_class
    ast_to_mermaid_class_diagram(ast_node)
  else
    raise ArgumentError, "Unsupported format: #{format}. Available: :tree, :json, :yaml, :mermaid, :mermaid_class"
  end
end