ground_control-api 0.1.0

data/app/controllers/concerns/ground_control/api/adapter_features.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    module AdapterFeatures
+      extend ActiveSupport::Concern
+
+      private
+
+      def supported_job_statuses
+        MissionControl::Jobs::Current.server.queue_adapter.supported_job_statuses
+      end
+
+      def queue_pausing_supported?
+        MissionControl::Jobs::Current.server.queue_adapter.supports_queue_pausing?
+      end
+
+      def workers_exposed?
+        MissionControl::Jobs::Current.server.queue_adapter.exposes_workers?
+      end
+
+      def recurring_tasks_supported?
+        MissionControl::Jobs::Current.server.queue_adapter.supports_recurring_tasks?
+      end
+
+      def adapter_features
+        {
+          statuses: supported_job_statuses,
+          queue_pausing: queue_pausing_supported?,
+          workers: workers_exposed?,
+          recurring_tasks: recurring_tasks_supported?
+        }
+      end
+    end
+  end
+end

data/app/controllers/concerns/ground_control/api/error_handling.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    module ErrorHandling
+      extend ActiveSupport::Concern
+
+      included do
+        rescue_from ActiveJob::Errors::JobNotFoundError do |_exception|
+          render json: { error: "Job not found" }, status: :not_found
+        end
+
+        rescue_from MissionControl::Jobs::Errors::ResourceNotFound do |exception|
+          render json: { error: exception.message }, status: :not_found
+        end
+
+        rescue_from StandardError do |exception|
+          raise exception unless Rails.env.production?
+
+          render json: { error: "Internal server error" }, status: :internal_server_error
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/ground_control/api/job_filters.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    module JobFilters
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :set_filters
+      end
+
+      private
+
+      def set_filters
+        filter = params[:filter] || {}
+
+        job_class_name = filter[:job_class_name]&.strip.presence
+        queue_name = filter[:queue_name]&.strip.presence
+        finished_at = build_finished_at_range(filter)
+
+        @job_filters = {
+          job_class_name: job_class_name,
+          queue_name: queue_name,
+          finished_at: finished_at
+        }.compact
+      end
+
+      def build_finished_at_range(filter)
+        start_time = filter[:finished_at_start].present? ? Time.zone.parse(filter[:finished_at_start]) : nil
+        end_time = filter[:finished_at_end].present? ? Time.zone.parse(filter[:finished_at_end]) : nil
+
+        return nil unless start_time || end_time
+
+        (start_time..end_time)
+      end
+
+      def active_filters?
+        @job_filters.present?
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/application_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class ApplicationController < ActionController::API
+      include MissionControl::Jobs::ApplicationScoped
+      include JobFilters
+      include AdapterFeatures
+      include ErrorHandling
+
+      before_action :authenticate!
+
+      private
+
+      def authenticate!
+        GroundControl::Api.authenticate_with&.call(self)
+      end
+
+      def serialize(resource)
+        resource.serializable_hash
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/applications_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class ApplicationsController < ApplicationController
+      def index
+        applications = MissionControl::Jobs.applications
+
+        render json: { data: ApplicationResource.new(applications).serializable_hash }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/bulk_discards_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class BulkDiscardsController < ApplicationController
+      def create
+        jobs = ActiveJob.jobs.where(**@job_filters).failed
+
+        if active_filters?
+          count = [jobs.count, 3000].min
+          jobs.limit(3000).discard_all
+        else
+          count = jobs.count
+          jobs.discard_all
+        end
+
+        render json: { message: "Discarded #{count} jobs" }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/bulk_retries_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class BulkRetriesController < ApplicationController
+      def create
+        jobs = ActiveJob.jobs.where(**@job_filters).failed
+        count = [jobs.count, 3000].min
+        jobs.limit(3000).retry_all
+
+        render json: { message: "Retried #{count} jobs" }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/discards_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class DiscardsController < ApplicationController
+      def create
+        job = ActiveJob.jobs.find_by_id(params[:job_id])
+        job.discard
+
+        render json: { message: "Discarded job #{job.job_id}" }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/dispatches_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class DispatchesController < ApplicationController
+      def create
+        job = ActiveJob.jobs.find_by_id(params[:job_id])
+        job.dispatch
+
+        render json: { message: "Dispatched job #{job.job_id}" }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/features_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class FeaturesController < ApplicationController
+      def show
+        render json: { data: adapter_features }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/jobs_controller.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class JobsController < ApplicationController
+      def index
+        status = params[:status]
+        jobs = ActiveJob.jobs.where(**@job_filters).with_status(status)
+        page = MissionControl::Jobs::Page.new(jobs, page: params[:page].to_i, page_size: GroundControl::Api.page_size)
+
+        job_class_names = begin
+          ActiveJob.jobs.with_status(status).job_class_names
+        rescue
+          []
+        end
+
+        queue_names = ActiveJob.queues.map(&:name)
+
+        render json: {
+          data: PageResource.new(page, inner_resource_class: JobResource).serializable_hash,
+          meta: {
+            status: status,
+            filters: @job_filters,
+            job_class_names: job_class_names,
+            queue_names: queue_names
+          }
+        }
+      end
+
+      def show
+        job = ActiveJob.jobs.find_by_id(params[:id])
+
+        render json: { data: JobResource.new(job).serializable_hash }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/queues/pauses_controller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    module Queues
+      class PausesController < ApplicationController
+        before_action :set_queue
+
+        def create
+          @queue.pause
+
+          render json: { message: "Queue paused" }
+        end
+
+        def destroy
+          @queue.resume
+
+          render json: { message: "Queue resumed" }
+        end
+
+        private
+
+        def set_queue
+          @queue = ActiveJob.queues[params[:queue_id]]
+        end
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/queues_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class QueuesController < ApplicationController
+      def index
+        queues = ActiveJob.queues.sort_by(&:name)
+
+        render json: {
+          data: QueueResource.new(queues).serializable_hash,
+          meta: { features: adapter_features }
+        }
+      end
+
+      def show
+        queue = ActiveJob.queues[params[:id]]
+        page = MissionControl::Jobs::Page.new(queue.jobs, page: params[:page].to_i, page_size: GroundControl::Api.page_size)
+
+        render json: {
+          data: QueueResource.new(queue).serializable_hash,
+          jobs: PageResource.new(page, inner_resource_class: JobResource).serializable_hash
+        }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/recurring_tasks_controller.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class RecurringTasksController < ApplicationController
+      before_action :ensure_recurring_tasks_supported
+
+      def index
+        tasks = MissionControl::Jobs::Current.server.recurring_tasks
+
+        render json: { data: RecurringTaskResource.new(tasks).serializable_hash }
+      end
+
+      def show
+        task = MissionControl::Jobs::Current.server.find_recurring_task(params[:id])
+        page = MissionControl::Jobs::Page.new(task.jobs, page: params[:page].to_i, page_size: GroundControl::Api.page_size)
+
+        render json: {
+          data: RecurringTaskResource.new(task).serializable_hash,
+          jobs: PageResource.new(page, inner_resource_class: JobResource).serializable_hash
+        }
+      end
+
+      def update
+        task = MissionControl::Jobs::Current.server.find_recurring_task(params[:id])
+        task.enqueue
+
+        render json: { message: "Enqueued recurring task #{task.id}" }
+      end
+
+      private
+
+      def ensure_recurring_tasks_supported
+        unless recurring_tasks_supported?
+          render json: { error: "Recurring tasks not supported by this adapter" }, status: :not_found
+        end
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/retries_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class RetriesController < ApplicationController
+      def create
+        job = ActiveJob.jobs.failed.find_by_id(params[:job_id])
+        job.retry
+
+        render json: { message: "Retried job #{job.job_id}" }
+      end
+    end
+  end
+end

data/app/controllers/ground_control/api/workers_controller.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class WorkersController < ApplicationController
+      before_action :ensure_workers_exposed
+
+      def index
+        page = MissionControl::Jobs::Page.new(
+          MissionControl::Jobs::Current.server.workers_relation,
+          page: params[:page].to_i,
+          page_size: GroundControl::Api.page_size
+        )
+
+        render json: { data: PageResource.new(page, inner_resource_class: WorkerResource).serializable_hash }
+      end
+
+      def show
+        worker = MissionControl::Jobs::Current.server.find_worker(params[:id])
+
+        render json: { data: WorkerResource.new(worker).serializable_hash }
+      end
+
+      private
+
+      def ensure_workers_exposed
+        unless workers_exposed?
+          render json: { error: "Workers not supported by this adapter" }, status: :not_found
+        end
+      end
+    end
+  end
+end

data/app/resources/ground_control/api/application_resource.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class ApplicationResource < BaseResource
+      attribute :id, &:id
+      attribute :name, &:name
+
+      many :servers, resource: ServerResource
+    end
+  end
+end

data/app/resources/ground_control/api/base_resource.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "alba"
+
+module GroundControl
+  module Api
+    class BaseResource
+      include Alba::Resource
+
+      transform_keys :lower_camel
+    end
+  end
+end

data/app/resources/ground_control/api/job_resource.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class JobResource < BaseResource
+      attribute :job_id, &:job_id
+      attribute :job_class_name, &:job_class_name
+      attribute :queue_name, &:queue_name
+
+      attribute :status do |job|
+        job.status.to_s
+      end
+
+      attribute :arguments do |job|
+        if job.respond_to?(:filtered_raw_data) && job.filtered_raw_data
+          job.filtered_raw_data
+        else
+          job.arguments
+        end
+      end
+
+      attribute :priority, &:priority
+      attribute :executions, &:executions
+      attribute :scheduled_at, &:scheduled_at
+      attribute :finished_at, &:finished_at
+      attribute :started_at, &:started_at
+      attribute :failed_at, &:failed_at
+
+      attribute :last_execution_error do |job|
+        error = job.last_execution_error
+        next nil if error.nil?
+
+        {
+          error_class: error.error_class,
+          message: error.message,
+          backtrace: error.backtrace
+        }
+      end
+
+      attribute :blocked_by, &:blocked_by
+      attribute :blocked_until, &:blocked_until
+      attribute :worker_id, &:worker_id
+      attribute :raw_data, &:raw_data
+    end
+  end
+end

data/app/resources/ground_control/api/page_resource.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class PageResource
+      include Alba::Resource
+
+      transform_keys :lower_camel
+
+      attribute :page do |page|
+        page.index
+      end
+
+      attribute :page_size, &:page_size
+
+      attribute :total_count do |page|
+        count = page.total_count
+        count.infinite? ? nil : count
+      rescue NoMethodError
+        count
+      end
+
+      attribute :pages_count, &:pages_count
+
+      attribute :first do |page|
+        page.first?
+      end
+
+      attribute :last do |page|
+        page.last?
+      end
+
+      attribute :records do |page|
+        if @inner_resource_class
+          @inner_resource_class.new(page.records).serializable_hash
+        else
+          page.records.map(&:to_h)
+        end
+      end
+
+      def initialize(object, inner_resource_class: nil)
+        @inner_resource_class = inner_resource_class
+        super(object)
+      end
+    end
+  end
+end

data/app/resources/ground_control/api/queue_resource.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class QueueResource < BaseResource
+      attribute :id do |queue|
+        queue.name.parameterize
+      end
+
+      attribute :name, &:name
+      attribute :size, &:size
+
+      attribute :active do |queue|
+        queue.active?
+      end
+
+      attribute :paused do |queue|
+        queue.paused?
+      end
+    end
+  end
+end

data/app/resources/ground_control/api/recurring_task_resource.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class RecurringTaskResource < BaseResource
+      attribute :id, &:id
+      attribute :job_class_name, &:job_class_name
+      attribute :command, &:command
+      attribute :arguments, &:arguments
+      attribute :schedule, &:schedule
+      attribute :last_enqueued_at, &:last_enqueued_at
+      attribute :next_time, &:next_time
+      attribute :queue_name, &:queue_name
+      attribute :priority, &:priority
+    end
+  end
+end

data/app/resources/ground_control/api/server_resource.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class ServerResource < BaseResource
+      attribute :id, &:id
+      attribute :name, &:name
+    end
+  end
+end

data/app/resources/ground_control/api/worker_resource.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class WorkerResource < BaseResource
+      attribute :id, &:id
+      attribute :name, &:name
+      attribute :hostname, &:hostname
+      attribute :last_heartbeat_at, &:last_heartbeat_at
+      attribute :configuration, &:configuration
+      attribute :raw_data, &:raw_data
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+GroundControl::Api::Engine.routes.draw do
+  resources :applications, only: [:index] do
+    resources :queues, only: [:index, :show] do
+      scope module: :queues do
+        resource :pause, only: [:create, :destroy]
+      end
+    end
+
+    resources :jobs, only: [:show] do
+      resource :retry, only: :create
+      resource :discard, only: :create
+      resource :dispatch, only: :create
+
+      collection do
+        resource :bulk_retries, only: :create
+        resource :bulk_discards, only: :create
+      end
+    end
+
+    resources :jobs, only: :index, path: ":status/jobs"
+    resources :workers, only: [:index, :show]
+    resources :recurring_tasks, only: [:index, :show, :update]
+    resource :features, only: [:show]
+  end
+end

data/lefthook.yml

@@ -0,0 +1,17 @@
+# Lefthook manages git hooks for pre-push checks.
+#
+# Install:  brew install lefthook && lefthook install
+# Skip:     LEFTHOOK=0 git push
+
+pre-push:
+  parallel: true
+  commands:
+    whitespace:
+      run: .lefthook/whitespace-check.sh
+    signed-commits:
+      run: .lefthook/verify-signatures.sh
+    rubocop:
+      run: bundle exec rubocop
+      glob: "**/*.rb"
+    rspec:
+      run: bundle exec rspec --fail-fast

data/lib/ground_control/api/engine.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    class Engine < ::Rails::Engine
+      isolate_namespace GroundControl::Api
+
+      initializer "ground_control.api.middleware" do |app|
+        app.middleware.use ActionDispatch::Flash
+        app.middleware.use Rack::MethodOverride
+      end
+
+      config.after_initialize do
+        require "mission_control/jobs/engine"
+      end
+    end
+  end
+end

data/lib/ground_control/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GroundControl
+  module Api
+    VERSION = "0.1.0"
+  end
+end