active_job_k8s 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47a17202dbfd72dab2e898ae6097df0d9f9191de31d05119e6ff4190f4038ea9
-  data.tar.gz: 961f6548436a79621c58b8da0a5d078e14a0db4a2517ec701a43bbed3ea5da87
+  metadata.gz: 57feaec27f10c9503c7e9455b30526d080b446eb9194f93a7a20e8830b3f3ceb
+  data.tar.gz: a1447113bfcdae14dae4e870e859df4997ae1ab8d6a01dc3dd11351301a7a165
 SHA512:
-  metadata.gz: aaad5ff2c9f345e177a7b0017d91fe68e6b064392ecdf7d4c174714256d0ba2cacfeae271102845265ecb9979aafb6495859d6831694d4de5f683ead8134dbc9
-  data.tar.gz: 2e979a40fde5148b72fa00ebe1ab442b570b3ca9ff843a8b77f2f720ef1108423382f72a3c138caf30705f5ae58e149ca9d8543d48a65c4bfb133bdc1cbdc95c
+  metadata.gz: feb62f548aaeffade90f53014060463959c3d672d674f348a82474271291b2f7d00e3bb68a6398a26ff7a77de04b7d137df633ad42141bd1623fbc2b785024bf
+  data.tar.gz: 203f78073d6ce7667ab48facf91262b6cab587142ce8afe1b557220e64dcd574ff093ee160e38e6f1eccbe1b4d23177718b524b0bd13eb548ce75282f35f133b

data/.gitignore

@@ -9,4 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
-spec/dummy
+spec/dummy
+*.gem

data/README.md

@@ -4,7 +4,7 @@ WIP gem to make active job work with kubernetes jobs.
 
 Roadmap for V1.0:
 - [x] ActiveJob.perform_later create a Job in k8s that will execute the job
-- [ ] ActiveJob.perform_later with delay create a Job in k8s in suspended mode, 
+- [x] ActiveJob.perform_later with delay create a Job in k8s in suspended mode, 
       a task will enable it as soon as the time is reached
 - [ ] Limiting the number of concurrent jobs (if there are more jobs they will be created in suspended mode)
 
@@ -66,8 +66,33 @@ Rails.application.configure do
     namespace
   )
 
+  default_manifest = YAML.safe_load(
+          <<~MANIFEST
+          apiVersion: batch/v1
+          kind: Job
+          metadata:
+            name: scheduled-job-name
+            namespace: default
+          spec:
+            template:
+              spec:
+                restartPolicy: Never
+                containers:
+                  - name: app-job
+                    image: image_of_the_rails_application
+                    imagePullPolicy: IfNotPresent
+                    command:
+                      - /bin/bash
+                    args:
+                      - '-c'
+                      - bundle exec rails active_job_k8s:run_job
+
+  MANIFEST
+  )
+
   config.active_job.queue_adapter = ActiveJob::QueueAdapters::K8sAdapter.new(
-    kubeclient_context: context
+    kubeclient_context: context,
+    default_manifest: default_manifest
   )
 
 end
@@ -123,27 +148,12 @@ class HelloWorldJob < ApplicationJob
   def perform(*args)
     Rails.logger.debug "Hello World"
   end
-
-  def manifest
-    YAML.safe_load(
-      <<~MANIFEST
-          apiVersion: batch/v1
-          kind: Job
-          metadata:
-            name: scheduled-job-name
-            namespace: default
-          spec:
-            template:
-              spec:
-                restartPolicy: Never
-                containers:
-                  - name: app-job
-                    image: image_of_the_rails_application
-                    imagePullPolicy: IfNotPresent
-
-    MANIFEST
-    )
-  end
+      
+  #[Optional] if not present it will be taken from scheduler configuration
+  # def manifest
+  # .....
+  # end 
+      
 end
 ```
 

data/active_job_k8s.gemspec

@@ -9,13 +9,13 @@ Gem::Specification.new do |spec|
   spec.summary       = "ActiveJob adapter for kubernetes job"
   spec.homepage      = "https://github.com/oniram88/active_job_k8s"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/bin/setup

@@ -11,21 +11,35 @@ bundle exec rails new spec/dummy --skip-git --skip-javascript --skip-hotwire --s
 
 echo "Changes to application"
 
-sed -i 's/"2.7.4"/">= 2.7.4"/' spec/dummy/Gemfile
+sed -i 's/2.7.4/>= 2.7.4/' spec/dummy/Gemfile
 sed -i '/end/i root "main#index"' spec/dummy/config/routes.rb
 sed -i '/root "main#index"/i get  "create_job", to:  "main#create_job", as: "create_job"' spec/dummy/config/routes.rb
+sed -i '/root "main#index"/i get  "send_email", to:  "main#send_email", as: "send_email"' spec/dummy/config/routes.rb
 
 echo '
 class MainController < ApplicationController
   include ActionView::Helpers::UrlHelper
-  def index
-    render inline: "#{link_to HelloWorldJob.name,create_job_path}"
-  end
 
-  def create_job
-    HelloWorldJob.perform_later
-    redirect_to root_path
-  end
+   def index
+     render inline: "#{link_to HelloWorldJob.name, create_job_path}<br>
+                     #{link_to HelloWorldJob.name, create_job_path(wait: 1)}<br>
+                     #{link_to SubscriptionMailer, send_email_path}"
+   end
+
+   def create_job
+     j = HelloWorldJob
+     if params[:wait]
+       j = j.set(wait: params[:wait].to_i.minutes)
+     end
+     j.perform_later
+
+     redirect_to root_path
+   end
+
+   def send_email
+     SubscriptionMailer.notify.deliver_later
+     redirect_to root_path
+   end
 
 end
 ' > spec/dummy/app/controllers/main_controller.rb
@@ -52,8 +66,46 @@ Rails.application.configure do
     namespace
   )
 
+  default_manifest = YAML.safe_load(
+    <<~MANIFEST
+      apiVersion: batch/v1
+      kind: Job
+      metadata:
+        name: scheduled-job-name
+        namespace: default
+      spec:
+        template:
+          spec:
+            restartPolicy: Never
+            containers:
+            - name: app-job
+              image: activejobk8s:0.1.0
+              imagePullPolicy: IfNotPresent
+              env:
+                - name: RAILS_SERVE_STATIC_FILES
+                  value: "1"
+                - name: RAILS_LOG_TO_STDOUT
+                  value: "1"
+                - name: RAILS_ENV
+                  value: "development"
+              command: ["/bin/sh"]
+              args:
+                - "-ec"
+                - "bundle install && bundle exec rails active_job_k8s:run_job"
+              volumeMounts:
+              - mountPath: /usr/src/app
+                name: application-volume
+            volumes:
+            - name: application-volume
+              hostPath:
+                # directory location on host
+                path: /application
+  MANIFEST
+  )
+
   config.active_job.queue_adapter = ActiveJob::QueueAdapters::K8sAdapter.new(
-    kubeclient_context: context
+    kubeclient_context: context,
+    default_manifest: default_manifest
   )
 
 end
@@ -67,48 +119,16 @@ class HelloWorldJob < ApplicationJob
     Rails.logger.debug "Hello World"
     FileUtils.touch(Rails.root.join("tmp","#{SecureRandom.hex}.test"))
   end
+end
+' > spec/dummy/app/jobs/hello_world_job.rb
 
-  def manifest
-    YAML.safe_load(
-      <<~MANIFEST
-          apiVersion: batch/v1
-          kind: Job
-          metadata:
-            name: scheduled-job-name
-            namespace: default
-          spec:
-            template:
-              spec:
-                restartPolicy: Never
-                containers:
-                - name: app-job
-                  image: activejobk8s:0.1.0
-                  imagePullPolicy: IfNotPresent
-                  env:
-                    - name: RAILS_SERVE_STATIC_FILES
-                      value: "1"
-                    - name: RAILS_LOG_TO_STDOUT
-                      value: "1"
-                    - name: RAILS_ENV
-                      value: "development"
-                  command: ["/bin/sh"]
-                  args:
-                    - "-ec"
-                    - "bundle install && bundle exec rails active_job_k8s:run_job"
-                  volumeMounts:
-                  - mountPath: /usr/src/app
-                    name: application-volume
-                volumes:
-                - name: application-volume
-                  hostPath:
-                    # directory location on host
-                    path: /application
-
-    MANIFEST
-    )
+echo '
+class SubscriptionMailer < ApplicationMailer
+  def notify
+    mail(to: "test@domain.tld", subject: "test", body: "message")
   end
 end
-' > spec/dummy/app/jobs/hello_world_job.rb
+'  > spec/dummy/app/mailers/subscription_mailer.rb
 
 echo 'FROM ruby:3.0.4-alpine3.16
 

data/lib/active_job/queue_adapters/k8s_adapter.rb

@@ -16,12 +16,10 @@ module ActiveJob
         scheduler.create_job(job)
       end
 
-      def enqueue_at(*)
-        # :nodoc:
-        raise NotImplementedError, "It will be implemented in the future. Read the roadmap"
+      def enqueue_at(job,scheduled_at)
+        scheduler.create_job(job,scheduled_at:scheduled_at)
       end
 
-
     end
   end
 end

data/lib/active_job_k8s/railtie.rb

@@ -5,5 +5,17 @@ module ActiveJobK8s
     rake_tasks do
       require 'active_job_k8s/tasks'
     end
+
+    server do
+      puts "=> START ActiveJobK8s - ControlLoop sleep [5]"
+      Thread.new do
+        Rails.application.reloader.wrap do
+          loop do
+            Rails.application.config.active_job.queue_adapter.scheduler.un_suspend_jobs
+            sleep 5
+          end
+        end
+      end
+    end
   end
 end

data/lib/active_job_k8s/scheduler.rb

@@ -5,26 +5,32 @@ require "json"
 module ActiveJobK8s
   class Scheduler
 
+    #@return [Kubeclient::Config::Context]
     attr_reader :kubeclient_context
 
-    # @param [Hash{ kubeclient_context: [Kubeclient::Config::Context] }] opts
+    #@return [Hash]
+    attr_reader :default_manifest
+
+    # @param [Hash{ kubeclient_context: Kubeclient::Config::Context, default_manifest: Hash }] opts
     def initialize(**opts)
       raise "No KubeClientContext given" if opts[:kubeclient_context].nil?
       # or to use a specific context, by name:
       @kubeclient_context = opts[:kubeclient_context]
+      @default_manifest = opts[:default_manifest] || {}
 
     end
 
-    def create_job(job)
+    def create_job(job, scheduled_at: nil)
 
       serialized_job = JSON.dump(job.serialize)
 
-      kube_job = Kubeclient::Resource.new(job.manifest)
+      manifest = (job.respond_to?(:manifest) and job.manifest.is_a?(Hash) and !job.manifest.empty?) ? job.manifest : default_manifest
+      kube_job = Kubeclient::Resource.new(manifest)
 
-      # kube_job.spec.suspend = false FIXME complete for delayed jobs
       kube_job.metadata.name = "#{kube_job.metadata.name}-#{job.job_id}"
-      kube_job.metadata.job_id = job.job_id
-      kube_job.metadata.queue_name = job.queue_name
+      kube_job.metadata.annotations ||= {}
+      kube_job.metadata.annotations.job_id = job.job_id
+      kube_job.metadata.annotations.queue_name = job.queue_name
       kube_job.metadata.namespace = kube_job.metadata.namespace || kubeclient_context.namespace
       kube_job.spec.template.spec.containers.map do |container|
         container.env ||= []
@@ -40,6 +46,14 @@ module ActiveJobK8s
       end
       kube_job.spec.ttlSecondsAfterFinished = 300 #number of seconds the job will be erased
 
+      kube_job.metadata.labels ||= {}
+      if scheduled_at
+        kube_job.spec.suspend = true
+        kube_job.metadata.annotations.scheduled_at = scheduled_at.to_s
+        kube_job.metadata.labels.activeJobK8s = "scheduled" # job to be execute when time comes
+      else
+        kube_job.metadata.labels.activeJobK8s = "delayed" # job to be execute when possible
+      end
       client.create_job(kube_job)
     end
 
@@ -47,6 +61,17 @@ module ActiveJobK8s
       ActiveJob::Base.execute(JSON.parse(ENV['SERIALIZED_JOB']))
     end
 
+    ##
+    # Un-suspend jobs if the scheduled at is outdated
+    def un_suspend_jobs
+      suspended_jobs.each do |sj|
+        scheduled_at = Time.at(sj.metadata.annotations.scheduled_at.to_f)
+        if Time.now > scheduled_at and sj.spec.suspend
+          client.patch_job(sj.metadata.name, { spec: { suspend: false } }, sj.metadata.namespace).inspect
+        end
+      end
+    end
+
     protected
 
     def client
@@ -55,6 +80,16 @@ module ActiveJobK8s
                                          ssl_options: @kubeclient_context.ssl_options,
                                          auth_options: @kubeclient_context.auth_options)
     end
+
+    private
+
+    ##
+    # Internal list of all suspended jobs
+    def suspended_jobs
+      client.get_jobs(namespace: kubeclient_context.namespace,
+                      label_selector: "activeJobK8s=scheduled",
+                      field_selector: 'status.successful!=1')
+    end
   end
 
 end

data/lib/active_job_k8s/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobK8s
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_k8s
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-30 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kubeclient
@@ -79,7 +79,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/oniram88/active_job_k8s
   source_code_uri: https://github.com/oniram88/active_job_k8s
-  changelog_uri: https://github.com/oniram88/active_job_k8s/CHANGELOG.md
+  changelog_uri: https://github.com/oniram88/active_job_k8s/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -88,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="