RubyGems - mission_control-web - Versions diffs - 0.0.1 → 0.2.0 - Mend

mission_control-web 0.0.1 → 0.2.0

Files changed (53) hide show

data/app/models/mission_control/web/application/routes.rb ADDED Viewed

@@ -0,0 +1,24 @@
+module MissionControl::Web::Application::Routes
+  extend ActiveSupport::Concern
+  def routes
+    MissionControl::Web::Route.where(application_id: id)
+  end
+  def route_was_updated(route)
+    routes_cache.put(route)
+  end
+  def route_was_deleted(route)
+    routes_cache.remove(route)
+  end
+  def route_disabled?(path)
+    routes_cache.disabled?(path)
+  end
+  private
+    def routes_cache
+      @routes_cache ||= MissionControl::Web::RoutesCache.new(self)
+    end
+end

data/app/models/mission_control/web/application.rb ADDED Viewed

@@ -0,0 +1,34 @@
+class MissionControl::Web::Application
+  include ActiveModel::Model
+  include Routes
+  attr_accessor :name, :redis
+  class << self
+    def all
+      MissionControl::Web.configuration.administered_applications.map { |app| new(**app) }
+    end
+    def find(id)
+      all.find { |application| application.id == id }
+    end
+    def find!(id)
+      find(id) or raise MissionControl::Web::Errors::ResourceNotFound
+    end
+    def find_or_initialize_by_name(name)
+      find(name.parameterize) || new(name: name)
+    end
+    def default
+      all.first or raise MissionControl::Web::Errors::ResourceNotFound
+    end
+  end
+  def id
+    name.parameterize
+  end
+  alias to_param id
+end

data/app/models/mission_control/web/application_record.rb ADDED Viewed

@@ -0,0 +1,3 @@
+class MissionControl::Web::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/mission_control/web/current.rb ADDED Viewed

@@ -0,0 +1,8 @@
+class MissionControl::Web::Current < ActiveSupport::CurrentAttributes
+  attribute :application
+  def application=(application)
+    super
+    MissionControl::Web.current_redis = application.redis
+  end
+end

data/app/models/mission_control/web/route.rb ADDED Viewed

@@ -0,0 +1,14 @@
+class MissionControl::Web::Route < ApplicationRecord
+  include Applications
+  validates :name, :pattern, presence: true
+  validates :pattern, uniqueness: { scope: :application_id }
+  def application
+    @application ||= MissionControl::Web::Application.find!(application_id)
+  end
+  def disabled?
+    !enabled?
+  end
+end

data/app/views/layouts/mission_control/web/application.html.erb ADDED Viewed

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Mission Control - Web</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag "mission_control/web/application", "data-turbo-track": "reload" %>
+    <%= javascript_importmap_tags %>
+  </head>
+  <body>
+    <div class="container">
+      <section class="section">
+        <%= render "navbar" %>
+        <%= render "flash" %>
+        <%= yield %>
+      </section>
+    </div>
+  </body>
+</html>

data/app/views/mission_control/web/application/_current_application_selector.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<% if selectable_applications.any? %>
+  <div class="application-selector navbar-item has-dropdown is-hoverable">
+    <a class="navbar-link">
+      <%= MissionControl::Web::Current.application.name %>
+    </a>
+    <div class="navbar-dropdown">
+      <% selectable_applications.each do |application| %>
+        <%= link_to application_routes_path(application), class: "navbar-item" do %>
+          <span><%= application.name %></span>
+        <% end %>
+      <% end %>
+    </div>
+  </div>
+<% end %>

data/app/views/mission_control/web/application/_flash.html.erb ADDED Viewed

@@ -0,0 +1,3 @@
+<% if notice %>
+  <div class="notification"><%= notice %></div>
+<% end %>

data/app/views/mission_control/web/application/_form_errors.html.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<% if model.errors.any? %>
+  <div class="notification content">
+    <h3 class="subtitle is-6"><%= pluralize(model.errors.count, "error") %> prohibited this <%= model.class.name.demodulize %> from being saved:</h3>
+    <ul>
+      <% model.errors.each do |error| %>
+        <li><%= error.full_message %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>

data/app/views/mission_control/web/application/_navbar.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<nav class="navbar" role="navigation" aria-label="main navigation">
+  <div class="navbar-brand">
+    <h1 class="title">Mission Control - Web</h1>
+  </div>
+  <div class="navbar-menu is-active">
+    <div class="navbar-start">
+    </div>
+    <div class="navbar-end">
+      <%= render "current_application_selector" %>
+    </div>
+  </div>
+</nav>

data/app/views/mission_control/web/errors/disallowed.html.erb ADDED Viewed

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Service temporarily unavailable</title>
+  </head>
+  <body>
+    <p>Service temporarily unavailable. Try again in a few minutes.</p>
+  </body>
+</html>

data/app/views/mission_control/web/routes/_form.html.erb ADDED Viewed

@@ -0,0 +1,26 @@
+<%= form_with(model: [ route.application, route] ) do |form| %>
+  <%= render partial: "form_errors", locals: { model: route } %>
+  <div class="field">
+    <%= form.label :name %>
+    <%= form.text_field :name %>
+  </div>
+  <div class="field">
+    <%= form.label :pattern %>
+    <%= form.text_field :pattern %>
+  </div>
+  <div class="field">
+    <%= form.label_check_box :enabled, "Traffic allowed" %>
+    <%= form.check_box :enabled %>
+  </div>
+  <div class="field is-grouped">
+    <%= form.submit_primary %>
+    <%= form.div_control do %>
+      <%= link_to "Cancel", application_routes_path(route.application), class: "button is-link is-light"  %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/mission_control/web/routes/_route.html.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<tr>
+  <td>
+    <%= link_to route.name, [ application, route ] %>
+  </td>
+  <td>
+    <%= route.pattern %>
+  </td>
+  <td>
+    <%= route_status_tag route.enabled %>
+  </td>
+</tr>

data/app/views/mission_control/web/routes/edit.html.erb ADDED Viewed

@@ -0,0 +1,8 @@
+<nav class="breadcrumb" aria-label="breadcrumbs">
+  <ul>
+    <li><%= link_to @application.name, application_routes_path(@application) %></li>
+    <li class="is-active"><a>Editing <%= @route.name %></a></li>
+  </ul>
+</nav>
+<%= render "form", route: @route %>

data/app/views/mission_control/web/routes/index.html.erb ADDED Viewed

@@ -0,0 +1,27 @@
+<div class="level">
+  <div class="level-left">
+    <h2 class="subtitle level-item"><%= @application.name %> - Routes</h2>
+  </div>
+  <div class="level-right">
+    <%= link_to "New Route", new_application_route_path(@application), class: "button is-primary level-item" %>
+  </div>
+</div>
+<div class="content">
+  <% if @routes.any? %>
+    <table class="table">
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Pattern</th>
+          <th>Traffic Status</th>
+        </tr>
+      </thead>
+      <tbody>
+        <%= render @routes, application: @application %>
+      </tbody>
+    </table>
+  <% else %>
+    <p>No Routes have yet been configured.</p>
+  <% end %>
+</div>

data/app/views/mission_control/web/routes/new.html.erb ADDED Viewed

@@ -0,0 +1,8 @@
+<nav class="breadcrumb" aria-label="breadcrumbs">
+  <ul>
+    <li><%= link_to @application.name, application_routes_path(@application) %></li>
+    <li class="is-active"><a>New Route</a></li>
+  </ul>
+</nav>
+<%= render "form", route: @route %>

data/app/views/mission_control/web/routes/show.html.erb ADDED Viewed

@@ -0,0 +1,42 @@
+<nav class="breadcrumb" aria-label="breadcrumbs">
+  <ul>
+    <li><%= link_to @application.name, application_routes_path(@application) %></li>
+    <li class="is-active"><%= link_to @route.name, [ @application, @route ] %></li>
+  </ul>
+</nav>
+<div class="my-4">
+  <div class="columns">
+    <div class="column is-one-fifth">
+      <p class="has-text-weight-semibold">Name</p>
+    </div>
+    <div class="column">
+      <p><%= @route.name %></p>
+    </div>
+  </div>
+  <div class="columns">
+    <div class="column is-one-fifth">
+      <p class="has-text-weight-semibold">Pattern</p>
+    </div>
+    <div class="column">
+      <p><%= @route.pattern %></p>
+    </div>
+  </div>
+  <div class="columns">
+    <div class="column is-one-fifth">
+      <p class="has-text-weight-semibold">Traffic Status</p>
+    </div>
+    <div class="column">
+    <p><%= route_status_tag @route.enabled %></p>
+    </div>
+  </div>
+</div>
+<div class="level">
+  <div class="level-left">
+    <%= link_to "Edit", edit_application_route_path(@application, @route), class: "button level-item" %>
+    <%= button_to "Delete", [ @application, @route ], method: :delete, class: "button is-danger level-item" %>
+  </div>
+</div>

data/config/importmap.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ pin "application", to: "mission_control/web/application.js", preload: true
2	+ pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,7 @@
+MissionControl::Web::Engine.routes.draw do
+  resources :applications, only: [] do
+    resources :routes
+  end
+  root to: "routes#index"
+end

data/db/migrate/20221025093008_create_mission_control_web_routes.rb ADDED Viewed

@@ -0,0 +1,14 @@
+class CreateMissionControlWebRoutes < ActiveRecord::Migration[7.0]
+  def up
+    create_table :mission_control_web_routes do |t|
+      t.string :name, null: false
+      t.string :pattern, null: false
+      t.boolean :enabled, default: true
+      t.string :application_id, null: false, index: true
+      t.timestamps
+    end
+    add_index :mission_control_web_routes, [ :application_id, :pattern ], unique: true
+  end
+end

data/lib/generators/mission_control/web/install/admin_generator.rb ADDED Viewed

@@ -0,0 +1,38 @@
+module MissionControl::Web::Install
+  class AdminGenerator < Rails::Generators::Base
+    INITIALIZER_FILE_PATH = "config/initializers/mission_control_web.rb"
+    def create_initializer_file
+      create_file INITIALIZER_FILE_PATH, <<~RUBY, skip: true
+        Rails.application.configure do
+        end
+      RUBY
+    end
+    def insert_admin_configuration
+      initializer = <<~RUBY
+        config.mission_control.web.middleware_enabled = false
+        # Admin
+        config.mission_control.web.administered_applications = [
+          { name: "My App", redis: Redis.new(url: ENV.fetch("REDIS_URL", "redis://localhost:6379/0")) }
+        ]
+      RUBY
+      insert_into_file INITIALIZER_FILE_PATH, indent(initializer), after: "Rails.application.configure do\n"
+    end
+    def add_engine_routes
+      route "mount MissionControl::Web::Engine => '/mission_control-web'"
+    end
+    def copy_migrations
+      rake "mission_control_web:install:migrations"
+    end
+    def run_migrations
+      say "Running migrations..."
+      rails_command "db:migrate"
+    end
+  end
+end

data/lib/generators/mission_control/web/install/middleware_generator.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module MissionControl::Web::Install
+  class MissionControl::Web::Install::MiddlewareGenerator < Rails::Generators::Base
+    INITIALIZER_FILE_PATH = "config/initializers/mission_control_web.rb"
+    def create_initializer_file
+      create_file INITIALIZER_FILE_PATH, <<~RUBY, skip: true
+        Rails.application.configure do
+        end
+      RUBY
+    end
+    def insert_middleware_configuration
+      initializer = <<~RUBY
+        # Middleware
+        config.mission_control.web.host_application_name = "My App"
+        config.mission_control.web.redis = Redis.new(url: ENV.fetch("REDIS_URL", "redis://localhost:6379/0"))
+      RUBY
+      insert_into_file INITIALIZER_FILE_PATH, indent(initializer), after: "Rails.application.configure do\n"
+    end
+    def toggle_middleware_enabled
+      gsub_file INITIALIZER_FILE_PATH, "middleware_enabled = false", "middleware_enabled = true"
+    end
+  end
+end

data/lib/generators/mission_control/web/install_generator.rb ADDED Viewed

@@ -0,0 +1,6 @@
+class MissionControl::Web::InstallGenerator < Rails::Generators::Base
+  def install_components
+    rails_command "generate mission_control:web:install:admin"
+    rails_command "generate mission_control:web:install:middleware"
+  end
+end

data/lib/mission_control/web/action_dispatch_request.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module MissionControl::Web
+  module ActionDispatchRequest
+    def mission_control
+      MissionControl::Web::RequestFilter.new(self)
+    end
+  end
+end

data/lib/mission_control/web/bulma_form_builder.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# Inspired by https://medium.com/@dyanagi/a-bulma-form-builder-for-ruby-on-rails-applications-aef780808bab
+class MissionControl::Web::BulmaFormBuilder < ActionView::Helpers::FormBuilder
+  def label_default(method, text = nil, options = {}, &block)
+    label(method, text, merge_class(options, "label"), &block)
+  end
+  def label_check_box(method, text = nil, options = {}, &block)
+    label(method, text, merge_class(options, "checkbox"), &block)
+  end
+  def text_field(method, options = {})
+    super(method, merge_class(options, "input"))
+  end
+  def submit(value = nil, options = {})
+    div_control do
+      super(value, merge_class(options, "button"))
+    end
+  end
+  def submit_primary(value = nil, options = {})
+    submit(value, merge_class(options, "is-primary"))
+  end
+  def div_control
+    @template.content_tag(:div, class: "control") do
+      yield
+    end
+  end
+  def select_with_label(method, choices = nil, options = {}, html_options = {}, &block)
+    label_default(method) + select(method, choices, options, html_options, &block)
+  end
+  def select(method, choices = nil, options = {}, html_options = {}, &block)
+    label(method, class: "select") do
+      super
+    end
+  end
+  private
+    def merge_class_attribute_value(options, value)
+      new_options = options.clone
+      new_options[:class] = [ value, new_options[:class] ].join(" ")
+      new_options
+    end
+    alias_method :merge_class, :merge_class_attribute_value
+end

data/lib/mission_control/web/configuration.rb ADDED Viewed

@@ -0,0 +1,21 @@
+class MissionControl::Web::Configuration
+  include ActiveModel::Attributes, ActiveModel::Dirty
+  attribute :host_application_name,      :string
+  attribute :middleware_enabled,         :boolean, default: true
+  attribute :routes_cache_ttl,           :integer, default: 10.seconds
+  attribute :base_controller_class,      :string,  default: "::ApplicationController"
+  attr_writer :redis, :administered_applications
+  attr_accessor :errors_controller
+  alias :middleware_enabled? :middleware_enabled
+  def redis
+    @redis || raise("Redis client not configured. Configure with MissionControl::Web.configuration.redis = Redis.new")
+  end
+  def administered_applications
+    @administered_applications || []
+  end
+end

data/lib/mission_control/web/engine.rb ADDED Viewed

@@ -0,0 +1,45 @@
+require "importmap-rails"
+require "turbo-rails"
+module MissionControl
+  module Web
+    class Engine < ::Rails::Engine
+      isolate_namespace MissionControl::Web
+      config.mission_control = ActiveSupport::OrderedOptions.new unless config.try(:mission_control)
+      config.mission_control.web = ActiveSupport::OrderedOptions.new
+      initializer "mission_control-web.config" do
+        config.mission_control.web.each do |key, value|
+          MissionControl::Web.configuration.public_send("#{key}=", value)
+        end
+      end
+      initializer "mission_control-web.request" do
+        ActiveSupport.on_load :action_dispatch_request do
+          include MissionControl::Web::ActionDispatchRequest
+        end
+      end
+      initializer "mission_control-web.add_middleware", after: "mission_control-web.config" do |app|
+        if MissionControl::Web.configuration.middleware_enabled?
+          app.middleware.use MissionControl::Web::RequestFilterMiddleware
+        end
+      end
+      initializer "mission_control-web.assets" do |app|
+        app.config.assets.paths << root.join("app/javascript")
+        app.config.assets.precompile += %w[ mission_control_web_manifest ]
+      end
+      initializer "mission_control-web.importmap", before: "importmap" do |app|
+        app.config.importmap.paths << root.join("config/importmap.rb")
+        app.config.importmap.cache_sweepers << root.join("app/javascript")
+      end
+      config.after_initialize do
+        MissionControl::Web.configuration.host_application_name ||= ::Rails.application.class.module_parent.to_s
+      end
+    end
+  end
+end

data/lib/mission_control/web/errors/resource_not_found.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ class MissionControl::Web::Errors::ResourceNotFound < StandardError
2	+ end

data/lib/mission_control/web/request_filter.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module MissionControl::Web
+  class RequestFilter
+    attr_reader :request
+    def initialize(request)
+      @request = request
+    end
+    def action
+      request.fetch_header("mission_control.action") do
+        if MissionControl::Web.host_application.route_disabled?(request.path)
+          :disallowed
+        end
+      end
+    end
+  end
+end

data/lib/mission_control/web/request_filter_middleware.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module MissionControl::Web
+  class RequestFilterMiddleware
+    def initialize(app)
+      @app = app
+    end
+    def call(env)
+      filter(env) || @app.call(env)
+    end
+    def filter(env)
+      return unless MissionControl::Web.configuration.middleware_enabled?
+      request = ActionDispatch::Request.new(env)
+      if action = request.mission_control.action
+        errors_controller.action(action).call(request.env)
+      end
+    end
+    private
+      def errors_controller
+        MissionControl::Web.configuration.errors_controller || MissionControl::Web::ErrorsController
+      end
+  end
+end

data/lib/mission_control/web/routes_cache.rb ADDED Viewed

@@ -0,0 +1,52 @@
+class MissionControl::Web::RoutesCache
+  delegate :redis, to: MissionControl::Web
+  def initialize(application)
+    @application = application
+  end
+  def put(route)
+    remove(route)
+    if route.disabled?
+      add(route)
+    end
+  end
+  def remove(route)
+    redis.srem redis_key, [ route.pattern_previously_was.to_s, route.pattern.to_s ]
+  end
+  def disabled?(path)
+    all_disabled_patterns.any? { |pattern| Regexp.new(pattern) =~ path }
+  end
+  private
+    attr_reader :application
+    def add(route)
+      redis.sadd redis_key, route.pattern.to_s
+    end
+    def redis_key
+      :"mission_control_web_#{application.id}_disabled_patterns"
+    end
+    def all_disabled_patterns
+      memoize(ttl: MissionControl::Web.configuration.routes_cache_ttl) do
+        # Using Redis client rather than Kredis as request interception with a middleware is performance-critical.
+        redis.smembers redis_key
+      end
+    rescue Redis::BaseConnectionError
+      []
+    end
+    def memoize(ttl:)
+      if !@patterns.nil? && @patterns_expires_at > Time.now
+        @patterns
+      else
+        @patterns_expires_at = Time.now + ttl
+        @patterns = yield
+      end
+    end
+end

data/lib/mission_control/web/version.rb CHANGED Viewed

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
 module MissionControl
   module Web
-    VERSION = "0.0.1"
+    VERSION = "0.2.0"
   end
 end