gitlab-peek 0.0.1

data/app/controllers/peek/results_controller.rb

@@ -0,0 +1,25 @@
+module Peek
+  class ResultsController < ApplicationController
+    before_action :restrict_non_access
+
+    def show
+      respond_to do |format|
+        format.json do
+          if request.xhr?
+            render json: Peek.adapter.get(params[:request_id])
+          else
+            render nothing: true, status: :not_found
+          end
+        end
+      end
+    end
+
+    private
+
+    def restrict_non_access
+      unless peek_enabled?
+        raise ActionController::RoutingError.new('Not Found')
+      end
+    end
+  end
+end

data/app/views/peek/_bar.html.erb

@@ -0,0 +1,11 @@
+<% if peek_enabled? %>
+<div id="peek" class="<%= Peek.env %><%= ' disabled' if cookies[:peek] == 'false' %>" data-request-id="<%= peek_request_id %>">
+  <div class="wrapper">
+    <% Peek.views.each do |view| %>
+      <div id="<%= view.dom_id %>" class="view">
+        <%= render view.partial_path, view: view %>
+      </div>
+    <% end %>
+  </div>
+</div>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Peek::Railtie.routes.draw do
+  get '/results' => 'results#show', as: :results
+end

data/gitlab-peek.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'peek/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'gitlab-peek'
+  gem.version       = Peek::VERSION
+  gem.authors       = ['Garrett Bjerkhoel']
+  gem.email         = ['me@garrettbjerkhoel.com']
+  gem.description   = %q{Take a peek into your Rails application.}
+  gem.summary       = %q{Take a peek into your Rails application.}
+  gem.homepage      = 'https://github.com/peek/peek'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'railties', '>= 4.0.0'
+end

data/lib/peek.rb

@@ -0,0 +1,93 @@
+require 'peek/version'
+require 'rails'
+
+require 'peek/adapters/memory'
+require 'peek/views/view'
+
+module Peek
+  ALLOWED_ENVS = ['development', 'staging'].freeze
+
+  def self.adapter
+    @adapter
+  end
+
+  def self.adapter=(*adapter_options)
+    adapter, *parameters = *Array.wrap(adapter_options).flatten
+
+    @adapter = case adapter
+    when Symbol
+      adapter_class_name = adapter.to_s.camelize
+      adapter_class =
+        begin
+          require "peek/adapters/#{adapter}"
+        rescue LoadError => e
+          raise "Could not find adapter for #{adapter} (#{e})"
+        else
+          Peek::Adapters.const_get(adapter_class_name)
+        end
+      adapter_class.new(*parameters)
+    when nil
+      Peek::Adapters::Memory.new
+    else
+      adapter
+    end
+
+    @adapter
+  end
+
+  def self.enabled?
+    ALLOWED_ENVS.include?(env)
+  end
+
+  def self.env
+    Rails.env
+  end
+
+  def self.views
+    @cached_views ||= if @views && @views.any?
+      @views.collect { |klass, options| klass.new(options.dup) }.select(&:enabled?)
+    else
+      []
+    end
+  end
+
+  def self.results
+    results = {
+      context: {},
+      data: Hash.new { |h, k| h[k] = {} }
+    }
+
+    views.each do |view|
+      if view.context?
+        results[:context][view.key] = view.context
+      end
+
+      view.results.each do |key, value|
+        results[:data][view.key][key] = value
+      end
+    end
+
+    results
+  end
+
+  def self.into(klass, options = {})
+    @views ||= []
+    @views << [klass, options]
+  end
+
+  # Clears out any and all views.
+  #
+  # Returns nothing.
+  def self.reset
+    @views = nil
+    @cached_views = nil
+  end
+
+  def self.setup
+    ActiveSupport::Deprecation.warn "'Peek.setup' is deprecated and does nothing.", caller
+  end
+end
+
+require 'peek/railtie'
+
+ActiveSupport.run_load_hooks(:peek, Peek)

data/lib/peek/adapters/base.rb

@@ -0,0 +1,17 @@
+module Peek
+  module Adapters
+    class Base
+      def initialize(options = {})
+
+      end
+
+      def get(request_id)
+        raise "#{self.class}#get(request_id) is not yet implemented"
+      end
+
+      def save
+        raise "#{self.class}#save is not yet implemented"
+      end
+    end
+  end
+end

data/lib/peek/adapters/elasticsearch.rb

@@ -0,0 +1,33 @@
+require 'peek/adapters/base'
+require 'elasticsearch'
+
+module Peek
+  module Adapters
+    class Elasticsearch < Base
+      def initialize(options = {})
+        @client = options.fetch(:client, ::Elasticsearch::Client.new)
+        @expires_in = Integer(options.fetch(:expires_in, 60 * 30) * 1000)
+        @index = options.fetch(:index, 'peek_requests_index')
+        @type = options.fetch(:type, 'peek_request')
+      end
+
+      def get(request_id)
+        result = @client.get_source index: @index, type: @type, id: "#{request_id}"
+        result.to_json
+      rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
+        # pass
+      end
+
+      def save(request_id)
+        @client.index index: @index,
+                      type: @type,
+                      id: "#{request_id}",
+                      body: Peek.results.to_json,
+                      ttl: @expires_in
+      rescue ::Elasticsearch::Transport::Transport::Errors::BadRequest
+        false
+      end
+
+    end
+  end
+end

data/lib/peek/adapters/memcache.rb

@@ -0,0 +1,25 @@
+require 'peek/adapters/base'
+require 'dalli'
+
+module Peek
+  module Adapters
+    class Memcache < Base
+      def initialize(options = {})
+        @client = options.fetch(:client, ::Dalli::Client.new)
+        @expires_in = options.fetch(:expires_in, 60 * 30)
+      end
+
+      def get(request_id)
+        @client.get("peek:requests:#{request_id}")
+      rescue ::Dalli::DalliError => e
+        Rails.logger.error "#{e.class.name}: #{e.message}"
+      end
+
+      def save(request_id)
+        @client.add("peek:requests:#{request_id}", Peek.results.to_json, @expires_in)
+      rescue ::Dalli::DalliError => e
+        Rails.logger.error "#{e.class.name}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/peek/adapters/memory.rb

@@ -0,0 +1,25 @@
+require 'peek/adapters/base'
+
+module Peek
+  module Adapters
+    class Memory < Base
+      attr_accessor :requests
+
+      def initialize(options = {})
+        @requests = {}
+      end
+
+      def get(request_id)
+        @requests[request_id]
+      end
+
+      def save(request_id)
+        @requests[request_id] = Peek.results
+      end
+
+      def reset
+        @requests.clear
+      end
+    end
+  end
+end

data/lib/peek/adapters/redis.rb

@@ -0,0 +1,21 @@
+require 'peek/adapters/base'
+require 'redis'
+
+module Peek
+  module Adapters
+    class Redis < Base
+      def initialize(options = {})
+        @client = options.fetch(:client, ::Redis.new)
+        @expires_in = Integer(options.fetch(:expires_in, 60 * 30))
+      end
+
+      def get(request_id)
+        @client.get("peek:requests:#{request_id}")
+      end
+
+      def save(request_id)
+        @client.setex("peek:requests:#{request_id}", @expires_in, Peek.results.to_json)
+      end
+    end
+  end
+end

data/lib/peek/controller_helpers.rb

@@ -0,0 +1,22 @@
+module Peek
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      if respond_to? :helper_method
+        helper_method :peek_enabled?
+        helper_method :peek_request_id
+      end
+    end
+
+    protected
+
+    def peek_enabled?
+      Peek.enabled?
+    end
+
+    def peek_request_id
+      request.env['action_dispatch.request_id']
+    end
+  end
+end

data/lib/peek/railtie.rb

@@ -0,0 +1,37 @@
+require 'peek/controller_helpers'
+
+module Peek
+  class Railtie < ::Rails::Engine
+    isolate_namespace Peek
+    engine_name :peek
+
+    config.peek = ActiveSupport::OrderedOptions.new
+
+    # Default adapter
+    config.peek.adapter = :memory
+
+    initializer 'peek.set_configs' do |app|
+      ActiveSupport.on_load(:peek) do
+        app.config.peek.each do |k,v|
+          send "#{k}=", v
+        end
+      end
+    end
+
+    initializer 'peek.persist_request_data' do
+      ActiveSupport::Notifications.subscribe('process_action.action_controller') do |_name, _start, _finish, _id, payload|
+        Peek.adapter.save(payload[:headers].env['action_dispatch.request_id'])
+      end
+    end
+
+    initializer 'peek.include_controller_helpers' do
+      ActiveSupport.on_load(:action_controller) do
+        include Peek::ControllerHelpers
+      end
+
+      config.to_prepare do
+        Peek.views
+      end
+    end
+  end
+end

data/lib/peek/version.rb

@@ -0,0 +1,3 @@
+module Peek
+  VERSION = '0.0.1'
+end

data/lib/peek/views/view.rb

@@ -0,0 +1,124 @@
+module Peek
+  module Views
+    class View
+      def initialize(options = {})
+        @options = options
+
+        parse_options
+        setup_subscribers
+      end
+
+      # Where any subclasses should pick and pull from @options to set any and
+      # all instance variables they like.
+      #
+      # Returns nothing.
+      def parse_options
+        # pass
+      end
+
+      # Conditionally enable views based on any gathered data. Helpful
+      # if you don't want views to show up when they return 0 or are
+      # touched during the request.
+      #
+      # Returns true.
+      def enabled?
+        true
+      end
+
+      # The path to the partial that will be rendered to the Peek bar.
+      #
+      # Examples:
+      #
+      #   Peek::Views::PerformanceBar.partial_path => "peek/views/performance_bar"
+      #   CustomResque.partial_path => "performance_bar"
+      #
+      # Returns String.
+      def partial_path
+        self.class.to_s.underscore
+      end
+
+      # The defer key that is derived from the classname.
+      #
+      # Examples:
+      #
+      #   Peek::Views::PerformanceBar => "performance-bar"
+      #   Peek::Views::Resque => "resque"
+      #
+      # Returns String.
+      def key
+        self.class.to_s.split('::').last.underscore.gsub(/\_/, '-')
+      end
+      alias defer_key key
+
+      # The context id that is derived from the classname.
+      #
+      # Examples:
+      #
+      #   Peek::Views::PerformanceBar => "peek-context-performance-bar"
+      #   Peek::Views::Resque => "peek-context-resque"
+      #
+      # Returns String.
+      def context_id
+        "peek-context-#{key}"
+      end
+
+      # The wrapper ID for the individual view in the Peek bar.
+      #
+      # Returns String.
+      def dom_id
+        "peek-view-#{key}"
+      end
+
+      # Additional context for any view to render tooltips for.
+      #
+      # Returns Hash.
+      def context
+        {}
+      end
+
+      def context?
+        context.any?
+      end
+
+      # The data results that are inserted at the end of the request for use in
+      # deferred placeholders in the Peek the bar.
+      #
+      # Returns Hash.
+      def results
+        {}
+      end
+
+      def results?
+        results.any?
+      end
+
+      def subscribe(*args)
+        ActiveSupport::Notifications.subscribe(*args) do |name, start, finish, id, payload|
+          yield name, start, finish, id, payload
+        end
+      end
+
+      private
+
+      def setup_subscribers
+        # pass
+      end
+
+      # Helper method for subscribing to the event that is fired when new
+      # requests are made.
+      def before_request
+        subscribe 'start_processing.action_controller' do |name, start, finish, id, payload|
+          yield name, start, finish, id, payload
+        end
+      end
+
+      # Helper method for subscribing to the event that is fired when requests
+      # are finished.
+      def after_request
+        subscribe 'process_action.action_controller' do |name, start, finish, id, payload|
+          yield name, start, finish, id, payload
+        end
+      end
+    end
+  end
+end