lex-scheduler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c22cca866470f3df8eb371b2a467fbdbe6d9b9a37ff81eba37705640a5c813e4
+  data.tar.gz: f502c95d2cbb51c45fe052493603db98dbc01cc21970a8650353736cfbcb91f3
+SHA512:
+  metadata.gz: a3ca95510c2fb415ab488727cbe87a11d32d1387abcf156329f473f1f93b3ebf3b4133251900a4756360cbb13544f42ff2b90058aa22735098f5400d4e0447a3
+  data.tar.gz: 4112f741dc77173ed6e52cc77dd718b0d5db4fd0b389509e0e6080b1bf785bc800e00cc1ec1b92bcc1805c52d3bd7471e587b07df515d16f4e76a62154257af7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 30
+Metrics/ClassLength:
+  Max: 1500
+Metrics/BlockLength:
+  Max: 50
+Metrics/AbcSize:
+  Max: 50
+Style/Documentation:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matthewdiverson@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Esity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+# Legion::Extensions::Scheduler
+Used to schedule tasks cron style inside Legion
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'legion/extensions/scheduler'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lex-scheduler.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/legion/extensions/scheduler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lex-scheduler'
+  spec.version       = Legion::Extensions::Scheduler::VERSION
+  spec.authors       = ['Esity']
+  spec.email         = ['matthewdiverson@gmail.com']
+
+  spec.summary       = 'LEX::Scheduler'
+  spec.description   = 'Schedules and manages delayed, async and cron style tasks'
+  spec.homepage      = 'https://bitbucket.org/legion-io/lex-scheduler'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://bitbucket.org/legion-io/lex-scheduler'
+  spec.metadata['changelog_uri'] = 'https://bitbucket.org/legion-io/lex-scheduler/src/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'fugit', '>= 1.3.9'
+
+  spec.add_development_dependency 'legionio'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/legion/extensions/scheduler.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'legion/extensions/scheduler/version'
+require 'legion/extensions'
+
+module Legion
+  module Extensions
+    module Scheduler
+      extend Legion::Extensions::Core
+
+      def data_required?
+        true
+      end
+    end
+  end
+end

data/lib/legion/extensions/scheduler/actors/run_scheduler.rb

@@ -0,0 +1,23 @@
+module Legion::Extensions::Scheduler::Actor
+  class RunScheduler < Legion::Extensions::Actors::Every
+    def runner_function
+      'schedule_tasks'
+    end
+
+    def runner_class
+      Legion::Extensions::Scheduler::Runners::Schedule
+    end
+
+    def use_runner?
+      false
+    end
+
+    def check_subtask?
+      false
+    end
+
+    def generate_task?
+      false
+    end
+  end
+end

data/lib/legion/extensions/scheduler/actors/schedule_task.rb

@@ -0,0 +1,23 @@
+module Legion::Extensions::Scheduler::Actor
+  class ScheduleTask < Legion::Extensions::Actors::Every
+    def runner_function
+      'push_refresh'
+    end
+
+    def runner_class
+      Legion::Extensions::Scheduler::Runners::Schedule
+    end
+
+    def use_runner?
+      false
+    end
+
+    def check_subtask?
+      false
+    end
+
+    def generate_task?
+      false
+    end
+  end
+end

data/lib/legion/extensions/scheduler/data/migrations/001_schedule_table.rb

@@ -0,0 +1,24 @@
+Sequel.migration do
+  up do
+    run '
+      create table schedules (
+        id int auto_increment,
+        function_id int null,
+        active tinyint default 1 not null,
+        `interval` int null,
+        cron varchar(255) null,
+        name varchar(255) null,
+        description blob null,
+        task_ttl int null,
+        last_run datetime null,
+        created datetime default CURRENT_TIMESTAMP not null,
+        updated datetime null,
+        constraint schedules_pk
+          primary key (id)
+      );'
+  end
+
+  down do
+    drop_table :schedules
+  end
+end

data/lib/legion/extensions/scheduler/data/migrations/002_schedule_log.rb

@@ -0,0 +1,19 @@
+Sequel.migration do
+  up do
+    run '
+      create table schedule_logs (
+        id int auto_increment,
+        schedule_id int not null,
+        status varchar(255) null,
+        time_queued datetime default CURRENT_TIMESTAMP not null,
+        task_id int null,
+        created datetime default CURRENT_TIMESTAMP not null,
+        updated datetime null,
+        constraint schedule_logs_pk primary key (id)
+      );'
+  end
+
+  down do
+    drop_table :schedule_logs
+  end
+end

data/lib/legion/extensions/scheduler/data/migrations/003_schedule_indexes.rb

@@ -0,0 +1,8 @@
+Sequel.migration do
+  change do
+    add_index :schedules, :last_run, name: 'schedules_last_run_index'
+    add_index :schedules, :interval, name: 'schedules_interval_index'
+    add_index :schedules, :function_id, name: 'schedules_function_id_index'
+    add_index :schedules, :active, name: 'schedules_active_index'
+  end
+end

data/lib/legion/extensions/scheduler/data/migrations/004_schedule_logs_indexes.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    add_index :schedule_logs, :schedule_id
+    add_index :schedule_logs, :task_id
+    add_index :schedule_logs, :status
+  end
+end

data/lib/legion/extensions/scheduler/data/migrations/005_add_payload_column.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:schedules) do
+      add_column :payload, File, null: false, default: '{}'
+    end
+  end
+end

data/lib/legion/extensions/scheduler/data/models/schedule.rb

@@ -0,0 +1,7 @@
+module Legion::Extensions::Scheduler::Data::Model
+  class Schedule < Sequel::Model
+    one_to_many :schedule_logs
+    many_to_one :task
+    many_to_one :function
+  end
+end

data/lib/legion/extensions/scheduler/data/models/schedule_log.rb

@@ -0,0 +1,7 @@
+module Legion::Extensions::Scheduler::Data::Model
+  class Schedule < Sequel::Model
+    one_to_many :schedule_logs
+    many_to_one :task
+    many_to_one :function
+  end
+end

data/lib/legion/extensions/scheduler/runners/schedule.rb

@@ -0,0 +1,43 @@
+module Legion
+  module Extensions
+    module Scheduler
+      module Runners
+        module Schedule
+          include Legion::Extensions::Helpers::Transport
+          include Legion::Extensions::Helpers::Cache
+          include Legion::Extensions::Helpers::Data
+
+          include Legion::Extensions::Helpers::Lex
+          def push_refresh(**)
+            Legion::Extensions::Scheduler::Transport::Messages::Refresh.new.publish
+          end
+
+          def refresh(**)
+            Legion::Cache.set('scheduler_schedule_lock', Legion::Settings[:client][:name], 5)
+          end
+
+          def schedule_tasks(**)
+            return unless Legion::Cache.get('scheduler_schedule_lock') == Legion::Settings[:client][:name]
+
+            models_class::Schedule.where(active: 1).each do |row|
+              next unless row.values[:interval].positive?
+              next if (Time.now - row.values[:last_run]) < row.values[:interval]
+
+              send_task(function_id: row.values[:function_id], **Legion::JSON.load(row.values[:payload]))
+              row.update(last_run: Sequel::CURRENT_TIMESTAMP)
+            end
+          end
+
+          def send_task(**opts)
+            payload = {}
+            %i[runner_class function_id function debug args].each do |thing|
+              payload[thing] = opts[thing] if opts.key? thing
+            end
+
+            Legion::Extensions::Scheduler::Transport::Messages::SendTask.new(**payload).publish
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/scheduler/transport/messages/refresh.rb

@@ -0,0 +1,35 @@
+module Legion::Extensions::Scheduler::Transport::Messages
+  class Refresh < Legion::Transport::Message
+    def routing_key
+      'schedule'
+    end
+
+    def type
+      'task'
+    end
+
+    def expiration
+      5000
+    end
+
+    def encrypt?
+      false
+    end
+
+    def message
+      {
+        function: 'refresh',
+        runner_class: 'Legion::Extensions::Scheduler::Runners::Schedule'
+      }
+    end
+
+    def message_example
+      { function: 'push_cluster_secret',
+        node_name: Legion::Settings[:client][:name],
+        queue_name: "node.#{Legion::Settings[:client][:name]}",
+        runner_class: 'Legion::Extensions::Node::Runners::Crypt',
+        # public_key: Base64.encode64(Legion::Crypt.public_key) }
+        public_key: Legion::Crypt.public_key }
+    end
+  end
+end

data/lib/legion/extensions/scheduler/transport/messages/send_task.rb

@@ -0,0 +1,26 @@
+module Legion::Extensions::Scheduler::Transport::Messages
+  class SendTask < Legion::Transport::Message
+    def type
+      'task'
+    end
+
+    def message
+      {
+        args: @options[:args] || @options,
+        function: function.values[:name]
+      }
+    end
+
+    def routing_key
+      "#{function.runner.extension.values[:name]}.#{function.runner.values[:name]}.#{function.values[:name]}"
+    end
+
+    def exchange
+      Legion::Transport::Exchange.new(function.runner.extension.values[:exchange])
+    end
+
+    def function
+      @function ||= Legion::Data::Model::Function[@options[:function_id]]
+    end
+  end
+end

data/lib/legion/extensions/scheduler/transport/queues/schedule.rb

@@ -0,0 +1,18 @@
+module Legion::Extensions::Scheduler
+  module Transport
+    module Queues
+      class Schedule < Legion::Transport::Queue
+        def queue_options
+          {
+            arguments: {
+              'x-single-active-consumer': true,
+              'x-max-priority': 255,
+              'x-message-ttl': 5
+            },
+            auto_delete: false
+          }
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/scheduler/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Scheduler
+      VERSION = '0.1.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: lex-scheduler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Esity
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fugit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+- !ruby/object:Gem::Dependency
+  name: legionio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Schedules and manages delayed, async and cron style tasks
+email:
+- matthewdiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lex-scheduler.gemspec
+- lib/legion/extensions/scheduler.rb
+- lib/legion/extensions/scheduler/actors/run_scheduler.rb
+- lib/legion/extensions/scheduler/actors/schedule_task.rb
+- lib/legion/extensions/scheduler/data/migrations/001_schedule_table.rb
+- lib/legion/extensions/scheduler/data/migrations/002_schedule_log.rb
+- lib/legion/extensions/scheduler/data/migrations/003_schedule_indexes.rb
+- lib/legion/extensions/scheduler/data/migrations/004_schedule_logs_indexes.rb
+- lib/legion/extensions/scheduler/data/migrations/005_add_payload_column.rb
+- lib/legion/extensions/scheduler/data/models/schedule.rb
+- lib/legion/extensions/scheduler/data/models/schedule_log.rb
+- lib/legion/extensions/scheduler/runners/schedule.rb
+- lib/legion/extensions/scheduler/transport/messages/refresh.rb
+- lib/legion/extensions/scheduler/transport/messages/send_task.rb
+- lib/legion/extensions/scheduler/transport/queues/schedule.rb
+- lib/legion/extensions/scheduler/version.rb
+homepage: https://bitbucket.org/legion-io/lex-scheduler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/legion-io/lex-scheduler
+  source_code_uri: https://bitbucket.org/legion-io/lex-scheduler
+  changelog_uri: https://bitbucket.org/legion-io/lex-scheduler/src/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: LEX::Scheduler
+test_files: []