stoplight 4.1.0 → 5.0.1

data/lib/stoplight/admin/actions/action.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    module Actions
+      # @abstract
+      class Action
+        # @!attribute lights_repository
+        #   @return [Stoplight::Admin::LightsRepository]
+        attr_reader :lights_repository
+        private :lights_repository
+
+        # @return lights_repository [Stoplight::Admin::LightsRepository]
+        def initialize(lights_repository:)
+          @lights_repository = lights_repository
+        end
+
+        def call(params)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/actions/lock.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    module Actions
+      # This action locks light
+      class Lock < Action
+        # @param params [Hash] query parameters
+        # @return [void]
+        def call(params)
+          light_names(params).each do |name|
+            lights_repository.lock(name)
+          end
+        end
+
+        private def light_names(params)
+          Array(params[:names])
+            .map { |name| CGI.unescape(name) }
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/actions/lock_all_green.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    module Actions
+      # This action locks all lights green
+      class LockAllGreen < Action
+        # @return [void]
+        def call(*)
+          lights_repository
+            .with_color(RED, YELLOW)
+            .map(&:name)
+            .each { |name| lights_repository.lock(name, GREEN) }
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/actions/lock_green.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    module Actions
+      # This action locks light with the specific name green
+      class LockGreen < Action
+        # @param params [Hash] query parameters
+        # @return [void]
+        def call(params)
+          light_names(params).each do |name|
+            lights_repository.lock(name, GREEN)
+          end
+        end
+
+        private def light_names(params)
+          Array(params[:names])
+            .map { |name| CGI.unescape(name) }
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/actions/lock_red.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    module Actions
+      # This action locks light with the specific name red
+      class LockRed < Action
+        # @param params [Hash] query parameters
+        # @return [void]
+        def call(params)
+          light_names(params).each do |name|
+            lights_repository.lock(name, RED)
+          end
+        end
+
+        private def light_names(params)
+          Array(params[:names])
+            .map { |name| CGI.unescape(name) }
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/actions/stats.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    module Actions
+      class Stats < Action
+        # @!attribute lights_stats
+        #   @return [Class<Stoplight::Admin::LightsStats>]
+        attr_reader :lights_stats
+        private :lights_stats
+
+        # @param lights_stats [Class<Stoplight::Admin::LightsStats>]
+        def initialize(lights_stats:, **deps)
+          super(**deps)
+          @lights_stats = lights_stats
+        end
+
+        # @return [(Stoplight::Admin::LightsRepository::Light)]
+        def call(*)
+          lights = lights_repository.all
+          stats = lights_stats.call(lights)
+          [lights, stats]
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/actions/unlock.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    module Actions
+      # This action unlocks light
+      class Unlock < Action
+        # @param params [Hash] query parameters
+        # @return [void]
+        def call(params)
+          light_names(params).each do |name|
+            lights_repository.unlock(name)
+          end
+        end
+
+        private def light_names(params)
+          Array(params[:names])
+            .map { |name| CGI.unescape(name) }
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/dependencies.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    class Dependencies
+      # @!attribute data_store
+      #   @return [Stoplight::DataStore::Base]
+      attr_reader :data_store
+      private :data_store
+
+      # @param data_store [Stoplight::DataStore::Base]
+      def initialize(data_store:)
+        @data_store = data_store
+      end
+
+      # @return [Stoplight::Admin::LightsRepository]
+      def lights_repository
+        Stoplight::Admin::LightsRepository.new(data_store: data_store)
+      end
+
+      # @return [Stoplight::Admin::Actions::Stats]
+      def stats_action
+        Stoplight::Admin::Actions::Stats.new(
+          lights_repository: lights_repository,
+          lights_stats: Stoplight::Admin::LightsStats
+        )
+      end
+
+      # @return [Stoplight::Admin::Actions::Unlock]
+      def unlock_action
+        Stoplight::Admin::Actions::Unlock.new(lights_repository: lights_repository)
+      end
+
+      # @return [Stoplight::Admin::Actions::LockGreen]
+      def green_action
+        Stoplight::Admin::Actions::LockGreen.new(lights_repository: lights_repository)
+      end
+
+      # @return [Stoplight::Admin::Actions::LockRed]
+      def red_action
+        Stoplight::Admin::Actions::LockRed.new(lights_repository: lights_repository)
+      end
+
+      # @return [Stoplight::Admin::Actions::LockAllGreen]
+      def green_all_action
+        Stoplight::Admin::Actions::LockAllGreen.new(lights_repository: lights_repository)
+      end
+    end
+  end
+end

data/lib/stoplight/admin/helpers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    module Helpers
+      COLORS = [
+        GREEN = Stoplight::Color::GREEN,
+        YELLOW = Stoplight::Color::YELLOW,
+        RED = Stoplight::Color::RED
+      ].freeze
+
+      # @return [Stoplight::Admin::Dependencies]
+      def dependencies
+        Dependencies.new(data_store:)
+      end
+
+      private def data_store
+        settings.data_store.tap do |data_store|
+          if data_store.is_a?(Stoplight::DataStore::Memory)
+            raise "Stoplight Admin requires a persistent data store, but the current data store is Memory. " \
+              "Please configure a different data store in your Stoplight configuration."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/lights_repository/light.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module Stoplight
+  class Admin
+    class LightsRepository
+      class Light
+        COLORS = [
+          GREEN = Stoplight::Color::GREEN,
+          YELLOW = Stoplight::Color::YELLOW,
+          RED = Stoplight::Color::RED
+        ].freeze
+
+        # @!attribute id
+        #   @return [String]
+        attr_reader :id
+
+        # @!attribute name
+        #   @return [String]
+        attr_reader :name
+
+        # @!attribute color
+        #   @return [String]
+        attr_reader :color
+
+        # @!attribute state
+        #   @return [String]
+        attr_reader :state
+
+        # @!attribute failures
+        #   @return [<Stoplight::Failure>]
+        attr_reader :failures
+
+        # @param name [String]
+        # @param color [String]
+        # @param state [String]
+        # @param failures [<Stoplight::Failure>]
+        def initialize(name:, color:, state:, failures:)
+          @id = SecureRandom.uuid
+          @name = name
+          @color = color
+          @state = state
+          @failures = failures
+        end
+
+        def latest_failure
+          failures.first
+        end
+
+        # @return [Boolean]
+        def locked?
+          !unlocked?
+        end
+
+        # @return [Boolean]
+        def unlocked?
+          state == Stoplight::State::UNLOCKED
+        end
+
+        # @return [Hash]
+        def as_json
+          {
+            name: name,
+            color: color,
+            failures: failures,
+            locked: locked?
+          }
+        end
+
+        # @return [Array]
+        def default_sort_key
+          [-COLORS.index(color), name]
+        end
+
+        # @return [String, nil]
+        def last_check_in_words
+          last_error_time = latest_failure&.time
+          return unless last_error_time
+
+          time_difference = Time.now - last_error_time
+          if time_difference < 1
+            "just now"
+          elsif time_difference < 60
+            "#{time_difference.to_i}s ago"
+          elsif time_difference < 3600
+            "#{(time_difference / 60).to_i}m ago"
+          else
+            "#{(time_difference / 3600).to_i}h ago"
+          end
+        end
+
+        # @return [String]
+        def description_title
+          case color
+          when RED
+            if locked? && failures.empty?
+              "Locked Open"
+            else
+              "Last Error"
+            end
+          when Stoplight::Color::YELLOW
+            "Testing Recovery"
+          when GREEN
+            if locked?
+              "Forced Healthy"
+            else
+              "Healthy"
+            end
+          end
+        end
+
+        # @return [String]
+        def description_message
+          case color
+          when RED
+            if locked? && failures.empty?
+              "Circuit manually locked open"
+            else
+              "#{latest_failure.error_class}: #{latest_failure.error_message}"
+            end
+          when Stoplight::Color::YELLOW
+            "#{latest_failure.error_class}: #{latest_failure.error_message}"
+          when GREEN
+            if locked?
+              "Circuit manually locked closed"
+            else
+              "No recent errors"
+            end
+          end
+        end
+
+        # @return [String]
+        def description_comment
+          case color
+          when RED
+            if locked?
+              "Override active - all requests blocked"
+            else
+              "Will attempt recovery after cooling period"
+            end
+          when YELLOW
+            "Allowing limited test traffic (0 of 1 requests)"
+          when GREEN
+            if locked?
+              "Override active - all requests processed"
+            else
+              "Operating normally"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/admin/lights_repository.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    class LightsRepository
+      # @!attribute data_store
+      #   @return [Stoplight::DataStore::Base]
+      attr_reader :data_store
+      private :data_store
+
+      #  @param data_store [Stoplight::DataStore::Base]
+      def initialize(data_store:)
+        @data_store = data_store
+      end
+
+      # @return [<Stoplight::Admin::LightsRepository::Light>]
+      def all
+        data_store
+          .names
+          .map { |name| load_light(name) }
+          .sort_by(&:default_sort_key)
+      end
+
+      # @param colors <String>] colors name
+      # @return [<Stoplight::Admin::LightsRepository::Light>] lights with the requested colors
+      #
+      def with_color(*colors)
+        requested_colors = Array(colors)
+
+        all.select do |light|
+          requested_colors.include?(light.color)
+        end
+      end
+
+      # @param name [String] locks light by its name
+      # @param color [String, nil] locks to this color. When nil is given, locks to the current
+      #   color
+      # @return [void]
+      def lock(name, color = nil)
+        light = build_light(name)
+
+        case color || light.color
+        when Stoplight::Color::GREEN
+          light.lock(Stoplight::Color::GREEN)
+        else
+          light.lock(Stoplight::Color::RED)
+        end
+      end
+
+      # @param name [String] unlocks light by its name
+      # @return [void]
+      def unlock(name)
+        build_light(name).unlock
+      end
+
+      private def load_light(name)
+        light = build_light(name)
+        # failures, state
+        metadata = data_store.get_metadata(light.config)
+
+        Light.new(
+          name: name,
+          color: light.color,
+          state: metadata.locked_state,
+          failures: [metadata.last_error].compact
+        )
+      end
+
+      private def build_light(name)
+        Stoplight(name, data_store: data_store)
+      end
+    end
+  end
+end

data/lib/stoplight/admin/lights_stats.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Stoplight
+  class Admin
+    class LightsStats
+      EMPTY_STATS = {
+        count_red: 0, count_yellow: 0, count_green: 0,
+        percent_red: 0, percent_yellow: 0, percent_green: 0
+      }.freeze
+
+      # @!attribute lights
+      #   @return [<Stoplight::Admin::LightsRepository::Light>]
+      attr_reader :lights
+      private :lights
+
+      class << self
+        def call(lights)
+          new(lights).call
+        end
+      end
+
+      # @param lights [<Stoplight::Admin::LightsRepository::Light>]
+      def initialize(lights)
+        @lights = lights
+      end
+
+      def call
+        return EMPTY_STATS if size.zero?
+
+        EMPTY_STATS.merge(
+          count_red: count_red,
+          count_yellow: count_yellow,
+          count_green: count_green,
+          percent_red: percent_red,
+          percent_yellow: percent_yellow,
+          percent_green: percent_green
+        )
+      end
+
+      private def count_red
+        count_lights(RED)
+      end
+
+      private def percent_red
+        percent_lights(RED)
+      end
+
+      private def count_green
+        count_lights(GREEN)
+      end
+
+      private def percent_green
+        percent_lights(GREEN)
+      end
+
+      private def count_yellow
+        count_lights(YELLOW)
+      end
+
+      private def percent_yellow
+        percent_lights(YELLOW)
+      end
+
+      private def count_lights(color)
+        lights.count { |l| l.color == color }
+      end
+
+      private def percent_lights(color)
+        (100 * count_lights(color).fdiv(size)).ceil
+      end
+
+      private def size
+        lights.size
+      end
+    end
+  end
+end

data/lib/stoplight/admin/views/_card.erb

@@ -0,0 +1,120 @@
+<div class="max-w-xl mr-5 p-6 border border-gray-200 rounded-lg shadow-sm dark:bg-gray-800 dark:border-gray-700">
+  <div class="flex items-center">
+    <% light_name = ERB::Util.html_escape(light.name) %>
+
+    <div class="relative">
+      <div class="relative inline-flex items-center justify-center w-10 h-10 overflow-hidden bg-<%= color %>-100 rounded-full dark:bg-<%= color %>-600">
+        <span class="font-medium text-<%= color %>-600 dark:text-<%= color %>-300"><%= color[0].upcase %></span>
+      </div>
+
+      <div class="absolute inline-flex w-4 h-4 bg-white dark:bg-gray-800 border-2 border-white rounded-full bottom-0 right-0 dark:border-gray-900">
+        <svg class="w-3 h-3 text-<%=color %>-900 dark:text-<%=color %>-200" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+          <% if light.locked? %>
+            <circle cx="12" cy="16" r="1"/>
+            <rect x="3" y="10" width="18" height="12" rx="2"/>
+            <path d="M7 10V7a5 5 0 0 1 10 0v3"/>
+          <% else %>
+            <circle cx="12" cy="16" r="1"/>
+            <rect width="18" height="12" x="3" y="10" rx="2"/>
+            <path d="M7 10V7a5 5 0 0 1 9.33-2.5"/>
+          <% end %>
+        </svg>
+      </div>
+    </div>
+
+    <div class="flex-1 min-w-0 ms-4">
+      <p class="text-sm font-medium text-gray-900 truncate dark:text-white">
+        <%= light.name %>
+      </p>
+      <span class="flex items-center text-sm font-medium text-gray-500 dark:text-gray-400 truncate me-3">
+        <span class="flex w-2.5 h-2.5 bg-<%= color %>-600 rounded-full me-1.5 shrink-0"></span>
+        <% if light.color == "red" %>
+          Open
+        <% elsif light.color == "yellow" %>
+          Half-Open
+        <% else %>
+          Closed
+        <% end %>
+
+        <% if light.color == "yellow" %>
+          (Recovering)
+        <% elsif light.locked? %>
+          (Locked)
+        <% end %>
+      </span>
+    </div>
+
+    <button id="dropdownMenuIconHorizontalButton" data-dropdown-toggle="dropdownDotsHorizontal-<%= light.id %>" class="inline-flex items-center p-2 text-sm font-medium text-center text-gray-900 bg-white rounded-lg hover:bg-gray-100 focus:ring-4 focus:outline-none dark:text-white focus:ring-gray-50 dark:bg-gray-800 dark:hover:bg-gray-700 dark:focus:ring-gray-600" type="button">
+      <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 16 3">
+        <path d="M2 0a1.5 1.5 0 1 1 0 3 1.5 1.5 0 0 1 0-3Zm6.041 0a1.5 1.5 0 1 1 0 3 1.5 1.5 0 0 1 0-3ZM14 0a1.5 1.5 0 1 1 0 3 1.5 1.5 0 0 1 0-3Z"/>
+      </svg>
+    </button>
+
+    <!-- Dropdown menu -->
+    <div id="dropdownDotsHorizontal-<%= light.id %>" class="z-10 hidden bg-white divide-y divide-gray-100 rounded-lg shadow-sm w-44 dark:bg-gray-700 dark:divide-gray-600">
+      <ul class="py-2 text-sm text-gray-700 dark:text-gray-200" aria-labelledby="dropdownMenuIconHorizontalButton">
+        <li>
+          <a href="<%= url("/unlock?names=#{light_name}") %>" data-turbo-method="post" class="flex items-center py-2 px-4 text-sm hover:bg-gray-100 dark:hover:bg-gray-600 dark:hover:text-white">
+            <svg class="flex w-4 h-4 me-1.5 shrink-0" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+              <circle cx="12" cy="16" r="1"/>
+              <rect width="18" height="12" x="3" y="10" rx="2"/>
+              <path d="M7 10V7a5 5 0 0 1 9.33-2.5"/>
+            </svg>
+            Unlock
+          </a>
+        </li>
+        <li>
+          <a href="<%= url("/red?names=#{light_name}") %>" data-turbo-method="post" class="flex items-center py-2 px-4 text-sm hover:bg-gray-100 dark:hover:bg-gray-600 dark:hover:text-white">
+            <svg class="flex w-4 h-4 me-1.5 text-red-600 shrink-0" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+              <circle cx="12" cy="16" r="1"/>
+              <rect x="3" y="10" width="18" height="12" rx="2"/>
+              <path d="M7 10V7a5 5 0 0 1 10 0v3"/>
+            </svg>
+            Lock Red
+          </a>
+        </li>
+        <li>
+          <a href="<%= url("/green?names=#{light_name}") %>" data-turbo-method="post" class="flex items-center py-2 px-4 text-sm hover:bg-gray-100 dark:hover:bg-gray-600 dark:hover:text-white">
+            <svg class="flex w-4 h-4 me-1.5 text-green-600 shrink-0" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+              <circle cx="12" cy="16" r="1"/>
+              <rect x="3" y="10" width="18" height="12" rx="2"/>
+              <path d="M7 10V7a5 5 0 0 1 10 0v3"/>
+            </svg>
+            Lock Green
+          </a>
+        </li>
+      </ul>
+    </div>
+  </div>
+
+  <div class="p-4 my-4 text-sm text-<%= color %>-800 rounded-lg bg-<%= color %>-50 dark:bg-gray-800 dark:text-<%= color %>-400">
+    <div class="flex justify-between items-center">
+      <div class="pr-4">
+        <p class="font-semibold"><%= light.description_title %></p>
+        <p class="font-medium"><%= light.description_message %></p>
+        <p><%= light.description_comment %></p>
+      </div>
+      <% if light.latest_failure %>
+        <div class="whitespace-nowrap">
+          <%= Time.at(light.latest_failure.time).strftime("%T") %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+
+  <!-- Stats Row -->
+  <div class="flex justify-between text-xs text-gray-500 dark:text-gray-400 mt-3">
+    <div>
+      <span class="font-medium">Failures:</span> <%= light.failures.count  %>
+    </div>
+
+    <% light.last_check_in_words.then do |last_check| %>
+      <% if last_check %>
+        <div>
+          <span class="font-medium">Last Check:</span> <%= light.last_check_in_words %>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+</div>
+