warm-blanket 1.0.0

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in warm-blanket.gemspec
+gemspec

data/README.md

@@ -0,0 +1,139 @@
+# WarmBlanket
+
+WarmBlanket is a Ruby gem for warming up web services on boot. Its main target are JRuby web services, although it is not JRuby-specific in any way.
+
+* [WarmBlanket](#warmblanket)
+* [How the magic happens](#how-the-magic-happens)
+  * [Why do we need to warm up web services?](#why-do-we-need-to-warm-up-web-services)
+  * [What does WarmBlanket do?](#what-does-warmblanket-do)
+  * [How does WarmBlanket work?](#how-does-warmblanket-work)
+  * [Limitations/caveats](#limitationscaveats)
+* [How can I make use of it?](#how-can-i-make-use-of-it)
+  * [1. Installation](#1-installation)
+  * [2. Configuration settings](#2-configuration-settings)
+     * [Configuring endpoints to be called](#configuring-endpoints-to-be-called)
+  * [3. Trigger warmup](#3-trigger-warmup)
+* [Development](#development)
+* [Contributing](#contributing)
+
+<sub><sup>ToC created with [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)</sup></sub>
+
+# How the magic happens
+
+## Why do we need to warm up web services?
+
+When the Java Virtual Machine (JVM) starts, it starts by interpreting Java bytecode. As it starts to detect code that runs often, it just-in-time compiles that code into native machine code, improving performance.
+
+This is a known challenge for most JVMs, and the same applies to JRuby applications, which also run on the JVM.
+
+A widely-documented solution to this problem is to perform a warm-up step when starting a service:
+
+* <https://landing.google.com/sre/book/chapters/load-balancing-datacenter.html#unpredictable-performance-factors-JMs7i7trCj>
+* <http://www.brendangregg.com/blog/2016-09-28/java-warmup.html>
+* <https://devcenter.heroku.com/articles/warming-up-a-java-process>
+
+## What does WarmBlanket do?
+
+WarmBlanket warms services by performing repeated web requests for a configurable number of seconds. After that time, it closes shop and you'll never hear about it until the next service restart or deploy.
+
+## How does WarmBlanket work?
+
+WarmBlanket spawns a configurable number of background threads that run inside the service process, and then uses an http client to perform local requests to the web server, simulating load.
+
+As it simulates requests, the JVM is warmed up and thus when real requests come in, no performance degradation is observed.
+
+## Limitations/caveats
+
+We strongly recommend that any services using WarmBlanket, if deployed on Heroku, use [Preboot](https://devcenter.heroku.com/articles/preboot). Preboot allows a service instance to be warmed up for 3 minutes before Heroku starts sending live traffic its way, which is preferable to doing it live.
+
+# How can I make use of it?
+
+To make use of WarmBlanket, you'll need to follow the next sections, which will guide you through installing, configuring and enabling the gem.
+
+## 1. Installation
+
+To install using Bundler, add the following to your `Gemfile`:
+
+```ruby
+gem 'warm-blanket', '~> 1.0'
+```
+
+WarmBlanket uses [semantic versioning](http://semver.org/).
+
+## 2. Configuration settings
+
+This gem can be configured via the following environment variables:
+
+* `PORT`: Local webserver port (automatically set on Heroku)
+* `WARMBLANKET_ENABLED`: Enable warm blanket (defaults to `false`; `true` or `1` enables)
+* `WARMBLANKET_WARMUP_THREADS`: Number of warm up threads to use (defaults to `2`)
+* `WARMBLANKET_WARMUP_TIME_SECONDS`: Time, in seconds, during which to warm up the service (defaults to `150`)
+
+### Configuring endpoints to be called
+
+Configure endpoints to be called as follows (on a `config/warm_blanket.rb`:
+
+```ruby
+require 'warm-blanket'
+
+WarmBlanket.configure do |config|
+  common_headers = {
+    'X-Api-Key': ENV.fetch('API_KEYS').split(',').first,
+  }
+
+  config.endpoints = [
+    {get: '/foo', headers: common_headers},
+    {get: '/', headers: common_headers},
+  ]
+end
+```
+
+Other HTTP verbs are supported (and you can pass in a `body` key if needed), but be careful about side effects from such verbs. And if there's no side effect from a `POST` or `PUT`, do consider if it shouldn't be a `GET` instead ;)
+
+```ruby
+# Example POST request with body
+#
+# Notice that you need to both:
+# * set the Content-Type manually (if needed)
+# * JSON-encode the body  (if needed)
+
+WarmBlanket.configure do |config|
+  common_headers = {
+    'X-Api-Key': ENV.fetch('API_KEY').split(',').first,
+    'Content-Type': 'application/json',
+  }
+
+  post_body = MultiJson.dump(
+    account_id: 'dummy_account',
+    user_id: 'dummy_user_id',
+  )
+
+  config.endpoints = [
+    {post: '/some_endoint', headers: common_headers, body: post_body},
+  ]
+end
+```
+
+## 3. Trigger warmup
+
+Add the following to the end of your `config.ru` file:
+
+```ruby
+WarmBlanket.trigger_warmup
+```
+
+# Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+# Contributors
+
+Open-sourced with :heart: by Talkdesk!
+
+Maintained by [Ivo Anjo](https://github.com/ivoanjo/) and the [Talkdesk Engineering](http://github.com/Talkdesk/) team.
+
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/Talkdesk/warm-blanket>.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'warm-blanket'
+
+require 'pry'
+Pry.start

data/bin/pry

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('pry', 'pry')

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/warm-blanket.rb

@@ -0,0 +1,53 @@
+# WarmBlanket: Ruby gem for warming up web services on boot
+# Copyright (C) 2017 Talkdesk, Inc. <tech@talkdesk.com>
+#
+# This file is part of WarmBlanket.
+#
+# WarmBlanket is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# WarmBlanket is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with WarmBlanket.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'warm_blanket/version'
+require 'warm_blanket/orchestrator'
+
+require 'dry-configurable'
+require 'logging'
+
+module WarmBlanket
+  extend Dry::Configurable
+
+  # Endpoints to be called for warmup, see README
+  setting :endpoints, [], reader: true
+
+  setting :logger, Logging.logger[self], reader: true
+
+  # Local webserver port
+  setting :port, ENV['PORT'], reader: true
+
+  # Enable warmup
+  setting :enabled, ENV['WARMBLANKET_ENABLED'], reader: true
+
+  # Number of threads to use
+  setting :warmup_threads, Integer(ENV['WARMBLANKET_WARMUP_THREADS'] || 2), reader: true
+
+  # Time, in seconds, during which to warm up the service
+  setting :warmup_time_seconds, Float(ENV['WARMBLANKET_WARMUP_TIME_SECONDS'] || 150), reader: true
+
+  def self.trigger_warmup(logger: WarmBlanket.config.logger, orchestrator_factory: Orchestrator)
+    unless [true, 'true', '1'].include?(WarmBlanket.config.enabled)
+      logger.info "WarmBlanket not enabled, ignoring trigger_warmup"
+      return false
+    end
+
+    orchestrator_factory.new.call
+  end
+end

data/lib/warm_blanket/orchestrator.rb

@@ -0,0 +1,136 @@
+# WarmBlanket: Ruby gem for warming up web services on boot
+# Copyright (C) 2017 Talkdesk, Inc. <tech@talkdesk.com>
+#
+# This file is part of WarmBlanket.
+#
+# WarmBlanket is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# WarmBlanket is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with WarmBlanket.  If not, see <http://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'warm_blanket/requester'
+require 'warm_blanket/wait_for_port'
+
+module WarmBlanket
+  # Orchestrates threads to wait for the port to open and to perform the warmup requests
+  class Orchestrator
+
+    DEFAULT_HEADERS = {
+      'X-Forwarded-Proto': 'https',
+      'X-Request-Id': 'WarmBlanket',
+      'X-Client-Id': 'WarmBlanket',
+    }.freeze
+
+    private
+
+    attr_reader :requester_factory
+    attr_reader :wait_for_port_factory
+    attr_reader :logger
+    attr_reader :endpoints
+    attr_reader :hostname
+    attr_reader :port
+    attr_reader :warmup_threads
+    attr_reader :warmup_deadline
+
+    public
+
+    def initialize(
+      requester_factory: Requester,
+      wait_for_port_factory: WaitForPort,
+      logger: WarmBlanket.config.logger,
+      endpoints: WarmBlanket.config.endpoints,
+      hostname: 'localhost',
+      port: WarmBlanket.config.port,
+      warmup_threads: WarmBlanket.config.warmup_threads,
+      warmup_time_seconds: WarmBlanket.config.warmup_time_seconds
+    )
+      raise "Warmup threads cannot be less than 1 (got #{warmup_threads})" if warmup_threads < 1
+
+      @requester_factory = requester_factory
+      @wait_for_port_factory = wait_for_port_factory
+      @logger = logger
+      @endpoints = endpoints
+      @hostname = hostname
+      @port = port
+      @warmup_threads = warmup_threads
+      @warmup_deadline = Time.now + warmup_time_seconds
+    end
+
+    def call
+      safely_spawn_thread do
+        logger.debug 'Started orchestrator thread'
+        orchestrate
+      end
+    end
+
+    private
+
+    def safely_spawn_thread(&block)
+      Thread.new do
+        begin
+          block.call
+        rescue => e
+          logger.error "Caught error that caused background thread to die #{e.class}: #{e.message}"
+          logger.debug "#{e.backtrace.join("\n")}"
+        end
+      end
+    end
+
+    def orchestrate
+      success = wait_for_port_to_open
+
+      spawn_warmup_threads if success
+    end
+
+    def wait_for_port_to_open
+      wait_for_port_factory.new(port: port, time_deadline: warmup_deadline).call
+    end
+
+    def spawn_warmup_threads
+      # Create remaining threads
+      (warmup_threads - 1).times do
+        safely_spawn_thread do
+          perform_warmup_requests
+        end
+      end
+
+      # Reuse current thread
+      perform_warmup_requests
+    end
+
+    def perform_warmup_requests
+      success = false
+
+      if Time.now >= warmup_deadline
+        logger.warn "Warmup deadline already passed, will skip warmup"
+        return
+      end
+
+      logger.debug "Starting warmup requests (remaining deadline: #{[warmup_deadline - Time.now, 0].max})"
+
+      requester = requester_factory.new(
+        base_url: "http://#{hostname}:#{port}",
+        default_headers: DEFAULT_HEADERS,
+        endpoints: endpoints,
+      )
+
+      while Time.now < warmup_deadline
+        requester.call
+      end
+
+      success = true
+    ensure
+      logger.info "Finished warmup work #{success ? 'successfully' : 'with error'}"
+    end
+  end
+end