skylight 1.0.0.beta4 → 1.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17f5108640b6ddd60f1e126dda1e69005a2aa130
-  data.tar.gz: ee06fc206e7a6b570db1e23c89b83c53362f4b5d
+  metadata.gz: 4cc154a1ba48ba4464fde882dc8fe46dc8134613
+  data.tar.gz: 4e6ad10d34bdc717cb73a3df2bb96ef6df8e7dd9
 SHA512:
-  metadata.gz: adde4cc18fa3673ce4dd410e1446f6dad659884f88ad7a6095f0f1444a2ae28148d24679eda2ee2dd86c17f264ba90eeba2d9d51526436846f1dcd5a7d584d52
-  data.tar.gz: 3548e5730c12bce02eee29f46a4a415b80ebe8f811c0fe83d584836d565d8bb435bc72488d730cd90b8b2bbc4e1fb09c8077beefca3bca91caf058d889cb3513
+  metadata.gz: f29f9b1c1a8fd5d33e27bb0aa9593fa2cda1971661f2bb2e485bbcb462a4c2a65cbc7ae4ac99effaae3d089810781ee89c3bdc5c68abaddd2e5f318b95b037d8
+  data.tar.gz: 8affdbb2297f3aa1d18927d7a63aefabab7a244c7884935d248fe96f5536aec494a35aab42a79112d7727405da0501753fa2c636eb91aa60f262d0cb7cf9ba2d

data/CHANGELOG.md

@@ -1,23 +1,36 @@
-## 1.0.0.beta4 (April 22, 2016)
-
-* [FEATURE] Track formats separately in Rails endpoints. Turn on with `separate_formats: true`.
-* [BUGFIX] Finish Rack::Responses in Middleware as some Rack apps don't do this
-
-## 1.0.0.beta3 (February 23, 2016)
-
-* [BUGFIX] Update Rust Agent with SQL improvements, including handling for arrays and WITH
-* [BUGFIX] Don't validate config on disabled environments
-* [IMPROVEMENT] Better message when config/skylight.yml already exists
-* [IMPROVEMENT] Test new Sinatra versions
-
-## 1.0.0.beta2 (January 14, 2016)
-
-* [BUGFIX] Fix version format so Rust agent can load config.
-
-## 1.0.0.beta1 (January 14, 2016) [YANKED]
-
-* [FEATURE] Deploy tracking support. Contact support@skylight.io to have this enabled for your account.
-* [BUGFIX] Correct documentation link in `skylight setup`.
+## 1.0.0-beta5 (June 29, 2016)
+
+* [BETA FEATURE] Track separate segments for endpoints. Contact support@skylight.io to have this feature enabled for your account.
+* [FEATURE] Initial 'skylight doctor' command
+* [BREAKING] Removed old `skylight setup` without creation token
+* [BREAKING] Remove Ruby based SQL lexer
+* [IMPROVEMENT] Internal refactors
+* [IMPROVEMENT] On Heroku, log to STDOUT instead of logfile
+* [BUGFIX] Correctly pass 'false' config values to Rust agent
+
+## 0.10.5 (June 22, 2016)
+
+* [BUGFIX] Fix issue with Grape multi-method naming
+* [BUGFIX] Add http to proxy_url for native fetching
+* [BUGFIX] Fix setting `proxy_url` in config YML
+* [IMPROVEMENT] Log errors during authentication validation
+
+## 0.10.4 (June 3, 2016)
+
+* [BUGFIX] Sinatra instrumenation now works for latest master
+* [BUGFIX] Sequel support for 4.35.0
+* [BUGFIX] Handle latest ActiveModel::Serializers version
+* [BUGFIX] More precise check for existence of Rails
+* [BREAKING] Drop official support for Sinatra 1.2 (it likely never worked correctly)
+* [IMPROVEMENT] On Heroku, logs are now written to STDOUT
+* [IMPROVEMENT] Allow Skylight to raise on logged errors, useful for testing and debugging
+* [IMPROVEMENT] Finish Rack::Responses in Middleware
+* [IMRPOVEMENT] Better message when config/skylight.yml already exists
+* [IMPROVEMENT] Update Rust Agent with SQL improvements, including handling for arrays and WITH
+
+## 0.10.3 (February 2, 2016)
+
+* [BUGFIX] Don't validate configuration on disabled environments.
 
 ## 0.10.2 (January 19, 2016)
 

data/bin/skylight

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require "skylight/cli"
-Skylight::CLI.start(ARGV)
+Skylight::CLI::Base.start(ARGV)

data/lib/skylight/api.rb

@@ -3,7 +3,9 @@ require 'uri'
 module Skylight
   # @api private
   class Api
-    attr_reader :config, :http
+    include Util::Logging
+
+    attr_reader :config
 
     class CreateFailed < StandardError
       attr_reader :res
@@ -29,51 +31,89 @@ module Skylight
       end
     end
 
-    def initialize(config, service = :auth)
-      @config = config
-      @http   = Util::HTTP.new(config, service)
-    end
+    class ConfigValidationResults
 
-    def authentication
-      @http.authentication
-    end
+      include Util::Logging
 
-    def authentication=(token)
-      @http.authentication = token
-    end
+      attr_reader :raw_response
 
-    def validate_authentication
-      url = URI.parse(config[:auth_url])
+      def initialize(config, raw_response)
+        @config = config
+        @raw_response = raw_response
+      end
 
-      res = @http.get(url.path)
+      def is_error_response?
+        raw_response.is_a?(Util::HTTP::ErrorResponse) || status > 499
+      end
 
-      case res.status
-      when 200...300
-        :ok
-      when 400...500
-        :invalid
-      else
-        :unknown
+      def status
+        raw_response.status
       end
-    rescue
-      :unknown
-    end
 
-    def login(email, password)
-      res = http.get('/me', 'X-Email' => email, 'X-Password' => password)
+      def body
+        return nil if is_error_response?
 
-      if res && res.success?
-        res.get('me.authentication_token')
+        unless raw_response.body.is_a?(Hash)
+          warn("Unable to parse server response: status=%s, body=%s", raw_response.status, raw_response.body)
+          return {}
+        end
+
+        raw_response.body
+      end
+
+      def token_valid?
+        # Don't prevent boot if it's an error response, so assume token is valid
+        return true if is_error_response?
+        # A 2xx response means everything is good!
+        return true if raw_response.success?
+        # A 422 means an invalid config, but the token must be valid if we got this far
+        return true if status === 422
       end
+
+      def config_valid?
+        # Only assume config is good if we have positive confirmation
+        raw_response.success?
+      end
+
+      def validation_errors
+        return if config_valid?
+        body ? body['errors'] : nil
+      end
+
+      def corrected_config
+        return if config_valid?
+        body ? body['corrected'] : nil
+      end
+
+    end
+
+    def initialize(config)
+      @config = config
     end
 
     def create_app(name, token=nil)
       params = { app: { name: name } }
       params[:token] = token if token
-      res = @http.post('/apps', params)
+
+      res = http_request(:app_create, :post, params)
+
       raise CreateFailed, res unless res.success?
       res
     end
 
+    def validate_config
+      res = http_request(:validation, :post, config)
+      ConfigValidationResults.new(config, res)
+    end
+
+    private
+
+    # TODO: Improve handling here: https://github.com/tildeio/direwolf-agent/issues/274
+    def http_request(service, method, *args)
+      http = Util::HTTP.new(config, service)
+      uri = URI.parse(config.get("#{service}_url"))
+      http.send(method, uri.path, *args)
+    end
+
   end
 end

data/lib/skylight/cli.rb

@@ -6,34 +6,37 @@ require 'yaml'
 require 'highline'
 require 'active_support/inflector'
 
+require 'skylight/cli/helpers'
+require 'skylight/cli/doctor'
+
 module Skylight
-  # @api private
-  class CLI < Thor
+  module CLI
+    # @api private
+    class Base < Thor
+      include Helpers
+
+      register(Doctor, "doctor", "doctor", "Run some basic tests to look out for common problems")
 
-    desc "setup TOKEN", "Sets up a new app using the provided token"
-    def setup(token=nil)
-      if File.exist?(config_path)
-        say <<-OUT, :green
+      desc "setup TOKEN", "Sets up a new app using the provided token"
+      def setup(token)
+        if File.exist?(config_path)
+          say <<-OUT, :green
 A config/skylight.yml already exists for your application.
 
 Visit your app at https://www.skylight.io/app or remove config/skylight.yml
 to set it up as a new app in Skylight.
-        OUT
-        return
-      end
-
-      unless token
-        api.authentication = login
-      end
+          OUT
+          return
+        end
 
-      res = api.create_app(app_name, token)
+        res = api.create_app(app_name, token)
 
-      config[:application]    = res.get('app.id')
-      config[:authentication] = res.get('app.token')
-      config.write(config_path)
+        config[:application]    = res.get('app.id')
+        config[:authentication] = res.get('app.token')
+        config.write(config_path)
 
-      say "Congratulations. Your application is on Skylight! http://www.skylight.io", :green
-      say <<-OUT
+        say "Congratulations. Your application is on Skylight! http://www.skylight.io", :green
+        say <<-OUT
 
 The application was registered for you and we generated a config file
 containing your API token at:
@@ -51,113 +54,79 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
 
   #{config[:authentication]}
 
-      OUT
-    rescue Api::CreateFailed => e
-      say "Could not create the application", :red
-      say e.to_s, :yellow
-    rescue Interrupt
-    end
-
-    desc "disable_dev_warning", "Disables warning about running Skylight in development mode for all local apps"
-    def disable_dev_warning
-      user_config.disable_dev_warning = true
-      user_config.save
-
-      say "Development mode warning disabled", :green
-    end
+        OUT
+      rescue Api::CreateFailed => e
+        say "Could not create the application", :red
+        say e.to_s, :yellow
+      rescue Interrupt
+      end
 
-  private
+      desc "disable_dev_warning", "Disables warning about running Skylight in development mode for all local apps"
+      def disable_dev_warning
+        user_config.disable_dev_warning = true
+        user_config.save
 
-    def app_name
-      @app_name ||=
-        begin
-          name = nil
+        say "Development mode warning disabled", :green
+      end
 
-          if File.exist?("config/application.rb")
-            # This looks like a Rails app, lets make sure we have the railtie loaded
-            # skylight.rb checks for Rails, but when running the CLI, Skylight loads before Rails does
-            begin
-              require "skylight/railtie"
-            rescue LoadError => e
-              error "Unable to load Railtie. Please notify support@skylight.io."
-            end
+    private
+
+      def app_name
+        @app_name ||=
+          begin
+            name = nil
+
+            if is_rails?
+              # Get the name in a process so that we don't pollute our environment here
+              # This is especially important since users may have things like WebMock that
+              # will prevent us from communicating with the Skylight API
+              begin
+                namefile = Tempfile.new('skylight-app-name')
+                # Windows appears to need double quotes for `rails runner`
+                `rails runner "File.open('#{namefile.path}', 'w') {|f| f.write(Rails.application.class.name) rescue '' }"`
+                name = namefile.read.split("::").first.underscore.titleize
+                name = nil if name.empty?
+              rescue => e
+                if ENV['DEBUG']
+                  puts e.class.name
+                  puts e.to_s
+                  puts e.backtrace.join("\n")
+                end
+              ensure
+                namefile.close
+                namefile.unlink
+              end
 
-            # Get the name in a process so that we don't pollute our environment here
-            # This is especially important since users may have things like WebMock that
-            # will prevent us from communicating with the Skylight API
-            begin
-              namefile = Tempfile.new('skylight-app-name')
-              # Windows appears to need double quotes for `rails runner`
-              `rails runner "File.open('#{namefile.path}', 'w') {|f| f.write(Rails.application.class.name) rescue '' }"`
-              name = namefile.read.split("::").first.underscore.titleize
-              name = nil if name.empty?
-            rescue => e
-              if ENV['DEBUG']
-                puts e.class.name
-                puts e.to_s
-                puts e.backtrace.join("\n")
+              unless name
+                warn "Unable to determine Rails application name. Using directory name."
               end
-            ensure
-              namefile.close
-              namefile.unlink
             end
 
             unless name
-              warn "Unable to determine Rails application name. Using directory name."
+              name = File.basename(File.expand_path('.')).titleize
             end
-          end
 
-          unless name
-            name = File.basename(File.expand_path('.')).titleize
+            name
           end
-
-          name
-        end
-    end
-
-    def login
-      say "Please enter your email and password below or get a token from https://www.skylight.io/app/setup.", :cyan
-
-      10.times do
-        email    = highline.ask("Email: ")
-        password = highline.ask("Password: ") { |q| q.echo = "*" }
-
-        if token = api.login(email, password)
-          return token
-        end
-
-        say "Sorry. That email and password was invalid. Please try again", :red
-        puts
       end
 
-      say "Could not login", :red
-      return
-    end
-
-    def relative_config_path
-      'config/skylight.yml'
-    end
-
-    def config_path
-      File.expand_path(relative_config_path)
-    end
+      # Is this duplicated?
+      def relative_config_path
+        'config/skylight.yml'
+      end
 
-    def api
-      @api ||= Api.new(config)
-    end
+      def config_path
+        File.expand_path(relative_config_path)
+      end
 
-    def highline
-      @highline ||= HighLine.new
-    end
+      def api
+        config.api
+      end
 
-    def config
-      # Calling .load checks ENV variables
-      @config ||= Config.load
-    end
+      def user_config
+        UserConfig.instance
+      end
 
-    def user_config
-      UserConfig.instance
     end
-
   end
 end

data/lib/skylight/cli/doctor.rb

@@ -0,0 +1,132 @@
+module Skylight
+  module CLI
+    class Doctor < Thor::Group
+      include Helpers
+
+      desc "Run some basic tests to look out for common errors"
+
+      def check_rails
+        say "Checking for Rails"
+
+        indent do
+          if is_rails?
+            say "Rails application detected", :green
+
+            # Normally auto-loaded, but we haven't loaded Rails by the time Skylight is loaded
+            require 'skylight/railtie'
+            require File.expand_path('config/application', Dir.pwd)
+          else
+            say "No Rails application detected", :red
+            abort "Currently `skylight doctor` only works with Rails applications"
+          end
+        end
+
+        say "\n"
+      end
+
+      def check_native
+        say "Checking for native agent"
+
+        indent do
+          if Skylight.native?
+            say "Native agent installed", :green
+          else
+            say "Unable to load native extension", :yellow
+
+            indent do
+              install_log = File.expand_path("../../../ext/install.log", __FILE__)
+              if File.exist?(install_log)
+                File.readlines(install_log).each do |line|
+                  say line, :red
+                end
+              else
+                say "Reason unknown", :red
+              end
+            end
+
+            abort
+          end
+        end
+
+        say "\n"
+      end
+
+      def check_config
+        say "Checking for valid configuration"
+
+        # MEGAHAX
+        railtie = Skylight::Railtie.send(:new)
+        config = railtie.send(:load_skylight_config, Rails.application)
+
+        indent do
+          begin
+            config.validate!
+            say "Configuration is valid", :green
+          rescue ConfigError => e
+            say "Configuration is invalid", :red
+            say "  #{e.message}", :red
+            abort
+          end
+        end
+
+        puts "\n"
+      end
+
+      def check_daemon
+        say "Checking Skylight startup"
+
+        indent do
+          # Set this after we validate. It will give us more detailed information on start.
+          logger = Logger.new("/dev/null") # Rely on `say` in the formatter instead
+          # Log everything
+          logger.level = Logger::DEBUG
+          # Remove excess formatting
+          logger.formatter = proc { |severity, datetime, progname, msg|
+            msg = msg.sub("[SKYLIGHT] [#{Skylight::VERSION}] ", '')
+            say "#{severity} - #{msg}" # Definitely non-standard
+          }
+          config.logger = logger
+
+          config.set(:'daemon.lazy_start', false)
+
+          started = Skylight.start!(config)
+
+          if started
+            say "Successfully started", :green
+          else
+            say "Failed to start", :red
+            abort
+          end
+
+          say "Waiting for daemon... "
+
+          # Doesn't start immediately
+          tries = 0
+          daemon_running = false
+          while tries < 5
+            `ps cax | grep skylightd`
+            if $?.success?
+              daemon_running = true
+              break
+            end
+
+            tries += 1
+            sleep 1
+          end
+
+          if daemon_running
+            say "Success", :green
+          else
+            say "Failed", :red
+          end
+        end
+
+        say "\n"
+      end
+
+      def status
+        say "All checks passed!", :green
+      end
+    end
+  end
+end