QueryWise 0.2.0

data/lib/query_optimizer_client/tasks.rake

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+namespace :query_optimizer do
+  desc "Check configuration and connectivity"
+  task check: :environment do
+    puts "🔍 Query Optimizer Client Configuration Check"
+    puts "=" * 50
+    
+    config = QueryOptimizerClient.configuration
+    
+    puts "API URL: #{config.api_url}"
+    puts "API Key: #{config.api_key ? '[SET]' : '[NOT SET]'}"
+    puts "Enabled: #{config.enabled?}"
+    puts "Timeout: #{config.timeout}s"
+    puts "Retries: #{config.retries}"
+    puts "Batch Size: #{config.batch_size}"
+    puts "Default Threshold: #{config.default_threshold}%"
+    
+    if config.enabled?
+      puts "\n🔗 Testing API connectivity..."
+      
+      begin
+        result = QueryOptimizerClient.client.health_check
+        
+        if result&.dig('status') == 'ok'
+          puts "✅ API connection successful"
+          puts "   Version: #{result['version']}"
+          puts "   Services: #{result['services']}"
+        else
+          puts "⚠️  API responded but status is: #{result&.dig('status')}"
+        end
+      rescue QueryOptimizerClient::AuthenticationError
+        puts "❌ Authentication failed - check your API key"
+      rescue QueryOptimizerClient::APIError => e
+        puts "❌ API error: #{e.message}"
+      rescue => e
+        puts "❌ Connection failed: #{e.message}"
+      end
+    else
+      puts "\n⚠️  Client is disabled or not configured"
+    end
+  end
+
+  desc "Analyze sample queries"
+  task analyze: :environment do
+    unless QueryOptimizerClient.enabled?
+      puts "❌ Query Optimizer Client is not enabled"
+      exit 1
+    end
+
+    puts "🔍 Analyzing sample queries..."
+    
+    # Collect some sample queries from your application
+    queries = collect_sample_queries
+    
+    if queries.empty?
+      puts "⚠️  No queries to analyze"
+      exit 0
+    end
+    
+    puts "Collected #{queries.length} queries"
+    
+    begin
+      result = QueryOptimizerClient.analyze_queries(queries)
+      
+      if result&.dig('success')
+        display_analysis_results(result['data'])
+      else
+        puts "❌ Analysis failed: #{result&.dig('error')}"
+      end
+    rescue => e
+      puts "❌ Error during analysis: #{e.message}"
+    end
+  end
+
+  desc "Run CI performance check"
+  task :ci, [:threshold] => :environment do |t, args|
+    threshold = args[:threshold]&.to_i || QueryOptimizerClient.configuration.default_threshold
+    
+    unless QueryOptimizerClient.enabled?
+      puts "⚠️  Query Optimizer Client is disabled, skipping check"
+      exit 0
+    end
+
+    puts "🔍 Running CI performance check (threshold: #{threshold}%)"
+    
+    queries = collect_sample_queries
+    
+    if queries.empty?
+      puts "⚠️  No queries to analyze, passing by default"
+      exit 0
+    end
+    
+    begin
+      result = QueryOptimizerClient.analyze_for_ci(queries, threshold: threshold)
+      
+      if result&.dig('data', 'passed')
+        puts "✅ Performance check PASSED (Score: #{result['data']['score']}%)"
+        exit 0
+      else
+        puts "❌ Performance check FAILED (Score: #{result['data']['score']}%)"
+        
+        if result['data']['recommendations']
+          puts "\n💡 Recommendations:"
+          result['data']['recommendations'].each do |rec|
+            puts "  - #{rec}"
+          end
+        end
+        
+        exit 1
+      end
+    rescue => e
+      puts "❌ CI check failed: #{e.message}"
+      exit 1
+    end
+  end
+
+  desc "Generate API key"
+  task :generate_key, [:app_name] => :environment do |t, args|
+    app_name = args[:app_name] || "Rails App #{Time.current.strftime('%Y%m%d')}"
+    
+    puts "🔑 Generating API key for: #{app_name}"
+    
+    begin
+      result = QueryOptimizerClient.client.create_api_key(app_name)
+      
+      if result&.dig('success')
+        puts "✅ API key created successfully!"
+        puts "App Name: #{result['data']['app_name']}"
+        puts "API Key: #{result['data']['api_key']}"
+        puts "\nAdd this to your environment:"
+        puts "QUERY_OPTIMIZER_API_KEY=#{result['data']['api_key']}"
+      else
+        puts "❌ Failed to create API key: #{result&.dig('error')}"
+      end
+    rescue => e
+      puts "❌ Error creating API key: #{e.message}"
+    end
+  end
+
+  private
+
+  def collect_sample_queries
+    queries = []
+    
+    # Try to collect some real queries from your models
+    if defined?(ActiveRecord::Base)
+      subscription = ActiveSupport::Notifications.subscribe('sql.active_record') do |name, start, finish, id, payload|
+        duration = (finish - start) * 1000
+        next if payload[:name] =~ /SCHEMA|CACHE/ || duration < 1
+        
+        queries << {
+          sql: payload[:sql],
+          duration_ms: duration.round(2)
+        }
+      end
+      
+      # Execute some common queries
+      begin
+        if defined?(User) && User.respond_to?(:limit)
+          User.limit(5).to_a
+        end
+        
+        if defined?(ApplicationRecord)
+          ApplicationRecord.descendants.first(3).each do |model|
+            next if model.abstract_class?
+            model.limit(3).to_a rescue nil
+          end
+        end
+      rescue => e
+        # Ignore errors, we're just trying to collect sample queries
+      ensure
+        ActiveSupport::Notifications.unsubscribe(subscription) if subscription
+      end
+    end
+    
+    # Add some default queries if we couldn't collect any
+    if queries.empty?
+      queries = [
+        { sql: "SELECT * FROM users WHERE active = true", duration_ms: 45 },
+        { sql: "SELECT * FROM posts WHERE created_at > '2024-01-01'", duration_ms: 120 }
+      ]
+    end
+    
+    queries
+  end
+
+  def display_analysis_results(data)
+    puts "\n📊 Analysis Results"
+    puts "=" * 30
+    puts "Overall Score: #{data['summary']['optimization_score']}/100"
+    puts "Issues Found: #{data['summary']['issues_found']}"
+    puts "Queries Analyzed: #{data['summary']['total_queries']}"
+    
+    if data['n_plus_one']['detected']
+      puts "\n🔍 N+1 Query Issues:"
+      data['n_plus_one']['patterns'].each do |pattern|
+        puts "  ⚠️  #{pattern['table']}.#{pattern['column']}"
+        puts "     💡 #{pattern['suggestion']}"
+      end
+    end
+    
+    unless data['slow_queries'].empty?
+      puts "\n🐌 Slow Queries:"
+      data['slow_queries'].each do |query|
+        puts "  ⚠️  #{query['duration_ms']}ms: #{query['sql'][0..80]}..."
+        query['suggestions'].each do |suggestion|
+          puts "     💡 #{suggestion}"
+        end
+      end
+    end
+    
+    unless data['missing_indexes'].empty?
+      puts "\n📊 Missing Indexes:"
+      data['missing_indexes'].each do |index|
+        puts "  💡 #{index['sql']}"
+      end
+    end
+    
+    if data['summary']['optimization_score'] >= 80
+      puts "\n✅ Great job! Your queries are well optimized."
+    elsif data['summary']['optimization_score'] >= 60
+      puts "\n⚠️  Some optimization opportunities found."
+    else
+      puts "\n🚨 Significant performance issues detected."
+    end
+  end
+end

data/lib/query_optimizer_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module QueryOptimizerClient
+  VERSION = "0.2.0"
+end

data/lib/query_optimizer_client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "query_optimizer_client/version"
+require_relative "query_optimizer_client/client"
+require_relative "query_optimizer_client/configuration"
+require_relative "query_optimizer_client/middleware"
+require_relative "query_optimizer_client/railtie" if defined?(Rails)
+
+module QueryOptimizerClient
+  class Error < StandardError; end
+  class APIError < Error; end
+  class AuthenticationError < Error; end
+  class RateLimitError < Error; end
+  class ValidationError < Error; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.client
+    @client ||= Client.new(configuration)
+  end
+
+  def self.analyze_queries(queries)
+    client.analyze_queries(queries)
+  end
+
+  def self.analyze_for_ci(queries, threshold: 80)
+    client.analyze_for_ci(queries, threshold: threshold)
+  end
+
+  def self.enabled?
+    configuration.enabled?
+  end
+
+  def self.reset!
+    @configuration = nil
+    @client = nil
+  end
+end

data/public/robots.txt

@@ -0,0 +1 @@
+# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/query_optimizer_client.gemspec

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "lib/query_optimizer_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "QueryWise"
+  spec.version = QueryOptimizerClient::VERSION
+  spec.authors = ["Blair Lane"]
+  spec.email = ["blairjacklane@gmail.com"]
+
+  spec.summary = "QueryWise - Rails Database Query Optimizer"
+  spec.description = "QueryWise is a lightweight, developer-friendly tool that helps Ruby on Rails teams detect, analyze, and fix inefficient database queries. Automatically detect N+1 queries, slow queries, and missing indexes without needing heavy, expensive Application Performance Monitoring (APM) software."
+  spec.homepage = "https://github.com/BlairLane22/QueryWise"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/BlairLane22/QueryWise"
+  spec.metadata["changelog_uri"] = "https://github.com/BlairLane22/QueryWise/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://github.com/BlairLane22/QueryWise/blob/main/README.md"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    Dir.glob("**/*", File::FNM_DOTMATCH).reject do |f|
+      File.directory?(f) ||
+      f.start_with?('.git/', 'tmp/', 'log/', 'spec/', 'test/', 'features/') ||
+      f.match?(/\A\./) ||
+      f.end_with?('.gem') ||
+      f == 'Gemfile' ||
+      f == 'Gemfile.lock' ||
+      f == 'Rakefile' ||
+      f.include?('docker') ||
+      f.include?('scripts/') ||
+      f.include?('docs/') ||
+      f.start_with?('bin/') ||
+      File.expand_path(f) == __FILE__
+    end
+  end
+  
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "httparty", "~> 0.21"
+  spec.add_dependency "activesupport", "~> 7.0"
+
+  # Development dependencies
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "webmock", "~> 3.18"
+  spec.add_development_dependency "vcr", "~> 6.1"
+  spec.add_development_dependency "rails", "~> 7.0"
+  spec.add_development_dependency "sqlite3", "~> 1.4"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,265 @@
+--- !ruby/object:Gem::Specification
+name: QueryWise
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Blair Lane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: QueryWise is a lightweight, developer-friendly tool that helps Ruby on
+  Rails teams detect, analyze, and fix inefficient database queries. Automatically
+  detect N+1 queries, slow queries, and missing indexes without needing heavy, expensive
+  Application Performance Monitoring (APM) software.
+email:
+- blairjacklane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CLOUD_RUN_README.md
+- DOCKER_README.md
+- Dockerfile
+- Dockerfile.cloudrun
+- Dockerfile.dev
+- GEM_Gemfile
+- GEM_README.md
+- GEM_Rakefile
+- GEM_gitignore
+- LICENSE.txt
+- PUBLISHING_GUIDE.md
+- README.md
+- app.yaml
+- app/controllers/api/v1/analysis_controller.rb
+- app/controllers/api/v1/api_keys_controller.rb
+- app/controllers/api/v1/base_controller.rb
+- app/controllers/api/v1/health_controller.rb
+- app/controllers/application_controller.rb
+- app/controllers/concerns/.keep
+- app/jobs/application_job.rb
+- app/mailers/application_mailer.rb
+- app/models/app_profile.rb
+- app/models/application_record.rb
+- app/models/concerns/.keep
+- app/models/optimization_suggestion.rb
+- app/models/query_analysis.rb
+- app/models/query_pattern.rb
+- app/services/missing_index_detector_service.rb
+- app/services/n_plus_one_detector_service.rb
+- app/services/slow_query_analyzer_service.rb
+- app/services/sql_parser_service.rb
+- app/validators/query_data_validator.rb
+- app/views/layouts/mailer.html.erb
+- app/views/layouts/mailer.text.erb
+- cloudbuild.yaml
+- config.ru
+- config/application.rb
+- config/boot.rb
+- config/cable.yml
+- config/cache.yml
+- config/credentials.yml.enc
+- config/database.yml
+- config/deploy.yml
+- config/environment.rb
+- config/environments/development.rb
+- config/environments/production.rb
+- config/environments/test.rb
+- config/initializers/cors.rb
+- config/initializers/filter_parameter_logging.rb
+- config/initializers/inflections.rb
+- config/locales/en.yml
+- config/master.key
+- config/puma.rb
+- config/puma_cloudrun.rb
+- config/queue.yml
+- config/recurring.yml
+- config/routes.rb
+- config/storage.yml
+- db/cable_schema.rb
+- db/cache_schema.rb
+- db/migrate/20250818214709_create_app_profiles.rb
+- db/migrate/20250818214731_create_query_analyses.rb
+- db/migrate/20250818214740_create_query_patterns.rb
+- db/migrate/20250818214805_create_optimization_suggestions.rb
+- db/queue_schema.rb
+- db/schema.rb
+- db/seeds.rb
+- init.sql
+- lib/query_optimizer_client.rb
+- lib/query_optimizer_client/client.rb
+- lib/query_optimizer_client/configuration.rb
+- lib/query_optimizer_client/generators/install_generator.rb
+- lib/query_optimizer_client/generators/templates/README
+- lib/query_optimizer_client/generators/templates/analysis_job.rb
+- lib/query_optimizer_client/generators/templates/initializer.rb
+- lib/query_optimizer_client/middleware.rb
+- lib/query_optimizer_client/railtie.rb
+- lib/query_optimizer_client/tasks.rake
+- lib/query_optimizer_client/version.rb
+- lib/tasks/.keep
+- public/robots.txt
+- query_optimizer_client.gemspec
+- script/.keep
+- storage/.keep
+- storage/development.sqlite3
+- storage/test.sqlite3
+- vendor/.keep
+homepage: https://github.com/BlairLane22/QueryWise
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/BlairLane22/QueryWise
+  source_code_uri: https://github.com/BlairLane22/QueryWise
+  changelog_uri: https://github.com/BlairLane22/QueryWise/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/BlairLane22/QueryWise/blob/main/README.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: QueryWise - Rails Database Query Optimizer
+test_files: []