gi_job 0.1.3

data/lib/gi_job/jobs/concerns/jobable.rb

@@ -0,0 +1,28 @@
+require "gi_job/jobs/concerns/job_constructor"
+require "gi_job/jobs/concerns/job_runner"
+
+module GiJob
+  module Jobs
+    module Concerns
+      module Jobable
+
+        extend ActiveSupport::Concern
+        included do # begin included
+          include GiJob::Jobs::Concerns::JobConstructor
+          include GiJob::Jobs::Concerns::JobRunner
+
+          def abc()
+            puts "abc!"
+          end
+        end # end included
+
+        class_methods do # begin class_methods
+          def abcd()
+            puts "abc!"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/gi_job/jobs/job_command_suspended.rb

@@ -0,0 +1,11 @@
+module GiJob
+  module Jobs
+    class JobCommandSuspended < StandardError
+      attr_reader :process_progress
+      def initialize(process_progress)
+        super
+        @process_progress = process_progress
+      end
+    end
+  end
+end

data/lib/gi_job/jobs/job_utils.rb

@@ -0,0 +1,22 @@
+module GiJob
+  module Jobs
+    class JobUtils
+
+      def logging_fatal(execption)
+        GiJob.logger.fatal(execption.message)
+        GiJob.logger.fatal(execption.backtrace.join("\n"))
+      end
+
+      def self.check_job_suspended(gi_job_transaction)
+        if gi_job_transaction.process_status_suspended?
+          # 一時停止の場合は解除する
+          gi_job_transaction.append_log_info(division: "job再開", description: "ジョブを再開しました")
+          gi_job_transaction.process_status_none!
+        end
+      end
+
+    end # end JobUtils
+  end
+end
+
+# Commons::GemUtils.reload("/gems/gi_job/lib/gi_job") && reload! && ConsoleTest.new.test_c

data/lib/gi_job/models/concerns/gi_job_fileable.rb

@@ -0,0 +1,79 @@
+module GiJob
+  module Models
+    module Concerns
+      module GiJobFileable
+
+        extend ActiveSupport::Concern
+
+        included do # begin included
+
+          mount_uploader :file, GiLogFileCarrierWaveUploader
+
+          belongs_to :gi_job_transaction
+
+        end # end included
+
+        class_methods do # begin class_methods
+
+          def create_file!(
+            gi_job_transaction:,
+            file_path: nil,
+            uploaded_file: nil,
+            rows: 0
+          )
+            file = nil
+            name = nil
+            size = 0
+
+            if file_path.present?
+              name = File.basename(file_path)
+              file = File.open(file_path)
+              size = File.size(file_path)
+
+            elsif uploaded_file.present?
+              GiJob.logger.ap(uploaded_file: uploaded_file)
+              name = File.basename(uploaded_file.original_filename)
+              file = uploaded_file
+              size = uploaded_file.size
+            end
+
+            self.create!({
+              gi_job_transaction: gi_job_transaction,
+              name: name,
+              file: file,
+              rows: rows,
+              size: size,
+            })
+          end
+
+
+          def create_action_dispatch_uploaded_file(file, file_name)
+            params = {
+              :filename => "#{file_name}",
+              :type => File.extname(file_name).delete('.'),
+              :tempfile => file
+            }
+            # logger.ap({"method": "base64_conversion", params: params})
+            ActionDispatch::Http::UploadedFile.new(params)
+          end
+
+        end # end class_methods
+
+
+
+        def data_source
+          self.file.force_encoding('utf-8')
+        end
+
+        def delete_data_source!
+          self.update!({file: nil})
+        end
+
+        def has_file?
+          self.file_blob.present? || self.file.present?
+        end
+
+      end # end GiJobFileable
+    end
+  end
+end

data/lib/gi_job/models/concerns/gi_job_loggable.rb

@@ -0,0 +1,26 @@
+module GiJob
+  module Models
+    module Concerns
+      module GiJobLoggable
+
+        extend ActiveSupport::Concern
+
+        included do # begin included
+
+          belongs_to :gi_job_transaction
+
+          enum level: {
+            info:    100,
+            warning: 200,
+            error:   300,
+          }, _prefix: true
+
+        end # end included
+
+        class_methods do # begin class_methods
+        end # end class_methods
+
+      end # end GiJobLoggable
+    end
+  end
+end

data/lib/gi_job/models/concerns/gi_job_ownerble.rb

@@ -0,0 +1,20 @@
+module GiJob
+  module Models
+    module Concerns
+      module GiJobOwnerble
+
+        extend ActiveSupport::Concern
+
+        included do # begin included
+
+          has_many :gi_job_transaction, as: :owner
+
+        end # end included
+
+        class_methods do # begin class_methods
+        end # end class_methods
+
+      end # end GiJobLoggable
+    end
+  end
+end

data/lib/gi_job/models/concerns/gi_job_transactionable.rb

@@ -0,0 +1,220 @@
+module GiJob
+  module Models
+    module Concerns
+      module GiJobTransactionable
+
+        extend ActiveSupport::Concern
+
+        included do # begin included
+
+          serialize  :parameter
+          serialize  :process_progress
+
+          belongs_to :owner, polymorphic: true, optional: true
+          has_many   :gi_job_logs,   dependent: :destroy
+          has_many   :gi_job_files,  dependent: :destroy
+
+          enum status: {
+            registerd:  100,
+            running:    200,
+            completed:  300,
+            error:      400,
+          }, _prefix: true
+
+          enum process_status: {
+            none:       100,
+            suspended:  200,
+            terminated: 300,
+          }, _prefix: true
+
+          enum command: {
+            none:       100,
+            stop:       200,
+          }, _prefix: true
+
+
+          scope :search_jobs, -> (params) {
+            search_by_id(params[:id])
+              .search_by_name(params[:name])
+              .search_by_status(params[:status])
+              .order_by(params[:order_by])
+          }
+
+          scope :search_by_id, -> (value) {
+            where(id: value) if value.present?
+          }
+
+          scope :search_by_name, -> (value) {
+            where(name: value) if value.present?
+          }
+
+          scope :search_by_status, -> (value) {
+            v = value.is_a?(String) ? GiJobTransaction.statuses[value] : value
+            where(status: v) if v.present?
+          }
+
+          scope :order_by, -> (order_by = nil){
+            if order_by.present?
+              order("#{order_by}")
+            else
+              order("gi_job_transactions.updated_at desc")
+            end
+          }
+
+          scope :ghosts, -> (no_reaction_minutes) {
+            # TODO 更新が無いjobを検出する
+            # 本来であればちゃんとprocessキルがされる際にstatusを更新する
+            # これは、何らかの原因で jobレコードが更新さずに jobプロセスが死んでしまった場合の暫定的な救済処置である
+
+            to_datetime = Time.zone.now - no_reaction_minutes.minutes
+            where(process_status: :none)
+              .where(status: [GiJobTransaction.statuses[:registerd], GiJobTransaction.statuses[:running]])
+              .where("gi_job_transactions.updated_at < ?", to_datetime)
+          }
+
+          scope :suspended, -> () {
+            where(process_status: :suspended)
+          }
+
+          scope :ended, -> () {
+            where(status: [GiJobTransaction.statuses[:completed], GiJobTransaction.statuses[:error]])
+          }
+
+          scope :old_ended, -> (time_limit = 14.days) {
+            # 既に終了して2週間起つjobを検出する
+            time_now = Time.now
+            to_datetime =  time_now - time_limit
+            Rails.logger.ap("delete_old_file #{time_now} - #{time_limit} = to_datetime: #{to_datetime}")
+            where(process_status: :none)
+              .ended
+              .where("gi_job_transactions.updated_at < ?", to_datetime)
+          }
+
+          scope :has_job_file_data_sources, -> () {
+            # 有効なdata_sourcesを持っているジョブを検出する
+            eager_load(:gi_job_files)
+              .where("gi_job_files.file is not null")
+          }
+
+          scope :past_ended_same_type_jobs, -> (gi_job_transaction) {
+            where(
+              owner: gi_job_transaction.owner,
+              name: gi_job_transaction.name
+            ).where(
+              "gi_job_transactions.created_at < ?", gi_job_transaction.created_at
+            ).ended.where.not(
+              id: gi_job_transaction.id
+            )
+          }
+
+        end # end included
+
+        class_methods do # begin class_methods
+
+          def delete_old_for_one_shot(gi_job_transaction)
+            # 単発ジョブ向け。過去のjob_transactionを削除する。
+            self.past_ended_same_type_jobs(gi_job_transaction).destroy_all
+          end
+
+        end # end class_methods
+
+        def append_log_info(**args) append_log(level: :info, **args) end
+        def append_log_warning(**args) append_log(level: :warning, **args) end
+        def append_log_error(**args) append_log(level: :error, **args) end
+
+        def append_log(level: :info, position: nil, division: :none, description: nil)
+          GiJobLog.create!({
+            gi_job_transaction: self,
+            level: GiJobLog.levels[level],
+            position: position,
+            division: division,
+            description: description
+          })
+        end
+
+        def append_log(level: :info, position: nil, division: :none, description: nil)
+          GiJobLog.create!({
+            gi_job_transaction: self,
+            level: GiJobLog.levels[level],
+            position: position,
+            division: division,
+            description: description
+          })
+        end
+
+        def create_job_logs_hash
+          hash = {
+            info: [],
+            warning: [],
+            error: [],
+          }
+          self.gi_job_logs.each {|job_log| hash[job_log.level.to_sym] << job_log}
+          hash
+        end
+
+        def counts_ended
+          (counts_completed || 0) + (counts_errord || 0)
+        end
+
+        def has_error_log?
+          gi_job_logs.any?{|job_log| job_log.error?}
+        end
+
+        def to_simple
+          job_logs_hash = create_job_logs_hash
+          {
+            id: self.id,
+            name: self.name,
+            status: self.status,
+            counts_all: self.counts_all,
+            counts_progress: self.counts_progress,
+            counts_completed: self.counts_completed,
+            counts_errord: self.counts_errord,
+            process_status: self.process_status,
+            created_at: self.created_at,
+            updated_at: self.updated_at,
+            gi_job_logs: self.gi_job_logs,
+            job_logs_hash: job_logs_hash,
+            has_error_log: job_logs_hash[:error].present?,
+          }
+        end
+
+        def status_ended?
+          status_completed? || status_error?
+        end
+
+        def create_file!(**params)
+          GiJobFile.create_file!(gi_job_transaction: self, **params)
+        end
+
+        def log_files_filter_common_warns
+          gi_job_log_files.filter do |gi_job_log_file|
+            gi_job_log_file.file_name.start_with?("警告")
+          end
+        end
+
+        def log_files_filter_common_errors
+          gi_job_log_files.filter do |gi_job_log_file|
+            gi_job_log_file.file_name.start_with?("エラー")
+          end
+        end
+
+
+        ### for displays
+        def to_string_line
+          [
+            "#{self.id}",
+            "#{self.updated_at}",
+            "#{self.owner_type}(#{self.owner_id})",
+            "#{self.name}",
+            "#{self.status}",
+            "#{self.counts_progress}/#{self.counts_all}",
+            "errord: #{self.counts_errord}",
+          ].join(", ")
+        end
+
+
+      end # end GiJobTransactionable
+    end
+  end
+end

data/lib/gi_job/tasks/gi_job_task.rake

@@ -0,0 +1,176 @@
+require 'sidekiq/api'
+
+namespace :gi_job_task do
+  desc "job_status が更新されずにプロセスが無くなってしまったジョブの job_status を errorにする"
+  task :terminate_ghost_jobs => :environment do
+    # puts "start terminate_ghost_jobs"
+    time_now = Time.now
+    no_reaction_minutes = 30 # 30分間更新されていない未完了のジョブ
+    jobs = Job.ghosts(no_reaction_minutes)
+    counts_target_jobs = jobs.size
+    counts_terminated = 0
+    jobs.each do |job|
+      # Rails.logger.ap({job: job})
+
+      # ジョブステータスを更新
+      job.append_error("強制停止", "ジョブが停止されました。再度実行してください。")
+      job.update_columns({job_status: Job.job_statuses[:error]})
+      counts_terminated += 1
+
+      Rails.logger.fatal("terminate_ghost_job: job_id: #{job.id}")
+    end
+
+    puts "#{time_now.strftime('%Y/%m/%d %H:%M:%S')} end terminate_ghost_jobs #{counts_terminated}/#{counts_target_jobs}"
+  end
+
+  task :delete_old_tmp_files => :environment do
+    time_now = Time.now
+    # 一時ディレクトリ内の古いファイルを削除
+    # クラスタ環境下では一時ディレクトリのファイルはdistでは作成されないが、
+    # materialize_job_files で作成されたファイルを削除するために動かしている
+    paths = Jobable.delete_old_files
+    local_deleted_counts = 0
+    paths.each do |path|
+      Rails.logger.info("delete_old_files: path: #{path}")
+      local_deleted_counts += 1
+    end
+
+    # 終了している古い job_files の file を削除する
+    old_ended_has_data_sources_jobs = Job.old_ended.has_job_file_data_sources
+    db_deleted_counts = 0
+    old_ended_has_data_sources_jobs.each do |job|
+      job.job_files.each do |job_file|
+        Rails.logger.info("job_file.delete_data_source: job_id: #{job.id}, job_file_id: #{job_file.id}")
+        job_file.delete_data_source!
+        db_deleted_counts += 1
+      end
+    end
+
+    puts "#{time_now.strftime('%Y/%m/%d %H:%M:%S')} end delete_old_tmp_files local: #{local_deleted_counts}, db: #{db_deleted_counts}"
+  end
+
+  ##### 状況確認のための task
+  desc "job / sidekiq の状態を表示する"
+  task :status => :environment do
+    Rake::Task["gi_job_task:show_recently_jobs"].invoke
+    Rake::Task["gi_job_task:show_job_statuses"].invoke
+    Rake::Task["gi_job_task:show_sidekiq_statuses"].invoke
+  end
+
+  desc "直近10ジョブを表示する"
+  task :show_recently_jobs => :environment do
+    puts "- show recentry jobs"
+    gi_job_transaction = GiJobTransaction.preload(:owner, :gi_job_logs).order(updated_at: :desc).limit(10)
+    strings = gi_job_transaction.map(&:to_string_line)
+    puts strings.join("\n")
+  end
+
+  desc "全ジョブのステータス集計を表示する"
+  task :show_job_statuses => :environment do
+    puts "- show jobs statuses"
+    grouped = GiJobTransaction.group(:status, :process_status).count
+    Rails.logger.ap({grouped: grouped})
+    display = grouped.map do |keys, counts|
+      "#{sprintf("%-12s", keys[0])} | #{sprintf("%-12s", keys[1])}: #{sprintf("%12d", counts)}"
+    end.join("\n")
+    puts display
+  end
+
+  desc "sidekiqの状況を表示する"
+  task :show_sidekiq_statuses => :environment do
+    puts "- show sidekiq statuses"
+    # Rails.logger.ap({task: "show sidekiq statuses"})
+
+    puts "実行中: #{Sidekiq::Workers.new.size} 件"
+    Sidekiq::Workers.new.each do |process_id, thread_id, sidekiq_job|
+      Rails.logger.ap({
+        process_id: process_id,
+        thread_id: thread_id,
+        sidekiq_job:  sidekiq_job
+      })
+      payload = sidekiq_job["payload"]
+      payload_args = payload["args"][0]
+      job_argument = payload_args["arguments"][0]
+      strings = []
+      strings << "pid: #{process_id}"
+      strings << "tid: #{thread_id}"
+      strings << "sjid: #{payload_args["job_id"]}"
+      if job_argument && job_argument["gi_job_transaction"] && job_argument["gi_job_transaction"]["_aj_globalid"]
+        strings << "job_id: #{job_argument["gi_job_transaction"]["_aj_globalid"]}"
+      end
+      strings << "class: #{payload_args["job_class"]}"
+
+      puts "[#{strings.join("][")}]"
+    end
+
+    display_waiting_proc = Proc.new do |sidekiq_job|
+      Rails.logger.ap({
+        sidekiq_job:  sidekiq_job
+      })
+      payload = sidekiq_job.item
+      payload_args = payload["args"][0]
+      job_argument = payload_args["arguments"][0]
+      strings = []
+      strings << "sjid: #{payload_args["job_id"]}"
+      if job_argument && job_argument["gi_job_transaction"] && job_argument["gi_job_transaction"]["_aj_globalid"]
+        strings << "job_id: #{job_argument["gi_job_transaction"]["_aj_globalid"]}"
+      end
+      strings << "class: #{payload_args["job_class"]}"
+
+      puts "[#{strings.join("][")}]"
+    end
+
+    puts "キュー: #{Sidekiq::Queue.new.size} 件"
+    Sidekiq::Queue.new.each do |sidekiq_job|
+      display_waiting_proc.call(sidekiq_job)
+    end
+
+    puts "再試行: #{Sidekiq::RetrySet.new.size} 件"
+    Sidekiq::RetrySet.new.each do |sidekiq_job|
+      display_waiting_proc.call(sidekiq_job)
+    end
+  end
+
+
+
+  task :change_maintenance, ['mode'] => :environment do |task, args|
+    mode = args[:mode]
+    if mode.blank?
+      # modeが指定されなかった場合は現在のモードを表示して終了する
+      maintenance = Maintenance.find_record
+      puts "current mode: #{maintenance.mode}"
+
+    else
+      # mode変更
+      Maintenance.change_mode!(mode)
+
+      if mode == "none"
+        # suspendedされていたジョブを再起動する
+        jobs = Job.suspended
+        jobs.each do |job|
+          job_class_string = job.job_type.classify
+          Rails.logger.ap("class => #{job_class_string}")
+
+          job_class = job_class_string.constantize # -> ModelName
+          Rails.logger.ap({job_class: job_class})
+
+          job_class.start_job(job)
+
+        end
+      end
+    end
+  end
+
+  task :materialize_job_files, ['job_id'] => :environment do |task, args|
+    # dbに格納されたjob_fileを/tmpに作成する
+    job_id = args[:job_id]
+    job = Job.eager_load(:job_files).find_by(id: job_id)
+    job.job_files.each_with_index do |job_file, index|
+      file_name_suffix = "#{index == 0 ? "" : "_#{index.to_s}"}_#{job_file.file_name}"
+      file_path = Jobable.create_file_path(job, file_name_suffix)
+      Jobable.file_create(job_file.data_source, file_path)
+      puts "create_file: #{file_path}"
+    end
+  end
+
+end