startback-jobs 0.14.0 → 0.14.1

data/spec/unit/operation/test_create_job.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Startback
+  module Jobs
+    describe CreateJob do
+
+      let(:request) do
+        {
+          isReady: false,
+          opClass: 'CowSay',
+          opInput: {},
+          opContext: {},
+          createdBy: 'blambeau',
+        }
+      end
+
+      let(:jobs_relvar) do
+        Bmg.mutable([])
+      end
+
+      let(:context) do
+        Context.new.with_world(startback_jobs: jobs_relvar)
+      end
+
+      subject do
+        CreateJob.new(request).bind({
+          context: context,
+        }).call
+      end
+
+      it 'creates a job' do
+        expect(subject).to be_a(Model::Job)
+        expect(subject.id).not_to be_nil
+      end
+
+      it 'inserts the job in the relvar' do
+        subject
+        expect(jobs_relvar.count).to eql(1)
+      end
+    end
+  end
+end

data/spec/unit/operation/test_run_job.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Startback
+  module Jobs
+    describe RunJob do
+
+      let(:job_data) do
+        a_job_data
+      end
+
+      let(:jobs_relvar) do
+        Bmg.mutable([job_data])
+      end
+
+      let(:context) do
+        Context.new.with_world(startback_jobs: jobs_relvar)
+      end
+
+      subject do
+        RunJob.new(id: 'abcdef').bind({
+          context: context,
+        }).call
+      end
+
+      it 'runs the job' do
+        expect(subject).to eql('Hello !!')
+      end
+
+      it 'updates the job' do
+        subject
+        job_info = jobs_relvar.one
+        expect(job_info[:opResult]).to eql('Hello !!')
+        expect(job_info[:isReady]).to eql(true)
+      end
+    end
+  end
+end

data/spec/unit/test_finitio_schema.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Startback
+  module Jobs
+    describe 'Finitio schemas' do
+
+      it 'is correctly installed on stdlib' do
+        system = Finitio.system <<~FIO
+          @import startback/jobs
+
+          Job.Ref
+        FIO
+        expect {
+          system.dress({ id: "hello" })
+        }.not_to raise_error
+      end
+
+    end
+  end
+end

data/tasks/test.rake

@@ -1,5 +1,4 @@
 require 'rspec/core/rake_task'
-require 'path'
 
 namespace :test do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback-jobs
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -118,14 +118,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.14.1
 description: Asynchronous jobs on top of the Startback framework
 email: blambeau@gmail.com
 executables: []
@@ -133,97 +133,34 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- README.md
 - Rakefile
-- lib/startback.rb
-- lib/startback/audit.rb
-- lib/startback/audit/prometheus.rb
-- lib/startback/audit/shared.rb
-- lib/startback/audit/trailer.rb
-- lib/startback/caching/entity_cache.rb
-- lib/startback/caching/no_store.rb
-- lib/startback/caching/store.rb
-- lib/startback/context.rb
-- lib/startback/context/h_factory.rb
-- lib/startback/context/middleware.rb
-- lib/startback/errors.rb
-- lib/startback/event.rb
-- lib/startback/event/agent.rb
-- lib/startback/event/bus.rb
-- lib/startback/event/bus/bunny.rb
-- lib/startback/event/bus/bunny/async.rb
-- lib/startback/event/bus/memory.rb
-- lib/startback/event/bus/memory/async.rb
-- lib/startback/event/bus/memory/sync.rb
-- lib/startback/event/engine.rb
-- lib/startback/event/ext/context.rb
-- lib/startback/event/ext/operation.rb
 - lib/startback/ext.rb
-- lib/startback/ext/date_time.rb
-- lib/startback/ext/time.rb
-- lib/startback/model.rb
-- lib/startback/operation.rb
-- lib/startback/operation/error_operation.rb
-- lib/startback/operation/multi_operation.rb
-- lib/startback/services.rb
-- lib/startback/support.rb
-- lib/startback/support/data_object.rb
-- lib/startback/support/env.rb
-- lib/startback/support/fake_logger.rb
-- lib/startback/support/hooks.rb
-- lib/startback/support/log_formatter.rb
-- lib/startback/support/logger.rb
-- lib/startback/support/operation_runner.rb
-- lib/startback/support/robustness.rb
-- lib/startback/support/transaction_manager.rb
-- lib/startback/support/transaction_policy.rb
-- lib/startback/support/world.rb
-- lib/startback/version.rb
-- lib/startback/web/api.rb
-- lib/startback/web/auto_caching.rb
-- lib/startback/web/catch_all.rb
-- lib/startback/web/cors_headers.rb
-- lib/startback/web/health_check.rb
-- lib/startback/web/magic_assets.rb
-- lib/startback/web/magic_assets/ng_html_transformer.rb
-- lib/startback/web/magic_assets/rake_tasks.rb
-- lib/startback/web/middleware.rb
-- lib/startback/web/prometheus.rb
-- lib/startback/web/shield.rb
+- lib/startback/ext/support/operation_runner.rb
+- lib/startback/ext/web/api.rb
+- lib/startback/jobs.fio
+- lib/startback/jobs.rb
+- lib/startback/jobs/agent.rb
+- lib/startback/jobs/api.rb
+- lib/startback/jobs/event.rb
+- lib/startback/jobs/event/job_created.rb
+- lib/startback/jobs/event/job_ran.rb
+- lib/startback/jobs/model.rb
+- lib/startback/jobs/model/job.rb
+- lib/startback/jobs/operation.rb
+- lib/startback/jobs/operation/create_job.rb
+- lib/startback/jobs/operation/run_job.rb
+- lib/startback/jobs/services.rb
+- lib/startback/jobs/support.rb
+- lib/startback/jobs/support/job_result.rb
+- lib/startback/jobs/support/job_result/embedded.rb
+- lib/startback/jobs/support/job_result/not_ready.rb
+- lib/startback/jobs/support/job_result/redirect.rb
 - spec/spec_helper.rb
-- spec/unit/audit/test_prometheus.rb
-- spec/unit/audit/test_trailer.rb
-- spec/unit/caching/test_entity_cache.rb
-- spec/unit/context/test_abstraction_factory.rb
-- spec/unit/context/test_dup.rb
-- spec/unit/context/test_fork.rb
-- spec/unit/context/test_h_factory.rb
-- spec/unit/context/test_middleware.rb
-- spec/unit/context/test_with_world.rb
-- spec/unit/context/test_world.rb
-- spec/unit/event/bus/memory/test_async.rb
-- spec/unit/event/bus/memory/test_sync.rb
-- spec/unit/support/hooks/test_after_hook.rb
-- spec/unit/support/hooks/test_before_hook.rb
-- spec/unit/support/operation_runner/test_around_run.rb
-- spec/unit/support/operation_runner/test_before_after_call.rb
-- spec/unit/support/test_data_object.rb
-- spec/unit/support/test_env.rb
-- spec/unit/support/test_robusteness.rb
-- spec/unit/support/test_transaction_manager.rb
-- spec/unit/support/test_world.rb
-- spec/unit/test_event.rb
-- spec/unit/test_operation.rb
-- spec/unit/test_support.rb
-- spec/unit/web/fixtures/assets/app/hello.es6
-- spec/unit/web/fixtures/assets/app/hello.html
-- spec/unit/web/fixtures/assets/index.es6
-- spec/unit/web/test_api.rb
-- spec/unit/web/test_auto_caching.rb
-- spec/unit/web/test_catch_all.rb
-- spec/unit/web/test_cors_headers.rb
-- spec/unit/web/test_healthcheck.rb
-- spec/unit/web/test_magic_assets.rb
+- spec/unit/api/test_job_result.rb
+- spec/unit/model/test_job.rb
+- spec/unit/operation/test_create_job.rb
+- spec/unit/operation/test_run_job.rb
+- spec/unit/test_finitio_schema.rb
 - tasks/test.rake
 homepage: https://www.enspirit.be
 licenses:

data/README.md

@@ -1,13 +0,0 @@
-# Startback - Got Your Ruby Back
-
-Yet another ruby framework, I'm afraid. Here, we srongly seperate between:
-
-1. the web layer, in charge of a quality HTTP handling
-2. the operations layer, in charge of the high-level software operations
-3. the database layer, abstracted using the Relations As First Class Citizen pattern
-
-Currently,
-
-1. is handled using extra support on top of Sinatra
-2. is handled using Startback specific classes
-3. is handled using Bmg

data/lib/startback/audit/prometheus.rb

@@ -1,87 +0,0 @@
-require_relative 'shared'
-require 'prometheus/client'
-
-module Startback
-  module Audit
-    #
-    # Prometheus exporter abstraction, that can be registered as an around
-    # hook on OperationRunner and as a prometheus client on Context instances.
-    #
-    # The exporter uses the ruby client for prometheus to expose metrics regarding Operation runs.
-    #
-    # The following metrics are exported:
-    #
-    # A counter 'operation_errors' (failed runs)
-    # A histogram 'operation_calls'
-    #
-    # All these metrics use the following labels
-    # - operation : class name of the operation executed
-    #
-    # Given that this Exporter is intended to be used as around hook on an
-    # `OperationRunner`, operations that fail at construction time will not be
-    # exported at all, since they can't be ran in the first place. This may lead
-    # to metrics not containing important errors cases if operations check their
-    # input at construction time.
-    #
-    class Prometheus
-      include Shared
-
-      def initialize(options = {})
-        @prefix = options[:prefix] || "startback"
-        @options = options
-        @registry = ::Prometheus::Client.registry
-        all_labels = [:operation, :startback_version] + option_labels.keys
-        @errors = @registry.counter(
-          :"#{prefix}_operation_errors",
-          docstring: 'A counter of operation errors',
-          labels: all_labels)
-        @calls = @registry.histogram(
-          :"#{prefix}_operation_calls",
-          docstring: 'A histogram of operation latency',
-          labels: all_labels)
-      end
-      attr_reader :registry, :calls, :errors, :options, :prefix
-
-      def call(runner, op)
-        name = op_name(op)
-        result = nil
-        time = Benchmark.realtime{
-          result = yield
-        }
-        ignore_safely {
-          @calls.observe(time, labels: get_labels(name))
-        }
-        result
-      rescue => ex
-        ignore_safely {
-          @errors.increment(labels: get_labels(name))
-        }
-        raise
-      end
-
-    protected
-
-      def ignore_safely
-        yield
-      rescue => ex
-        nil
-      end
-
-      def get_labels(op_name)
-        option_labels.merge({
-          operation: op_name,
-          startback_version: version
-        })
-      end
-
-      def option_labels
-        @options[:labels] || {}
-      end
-
-      def version
-        Startback::VERSION
-      end
-
-    end # class Prometheus
-  end # module Audit
-end # module Startback

data/lib/startback/audit/shared.rb

@@ -1,17 +0,0 @@
-module Startback
-  module Audit
-    module Shared
-
-      def op_name(op)
-        return op.op_name if op.respond_to?(:op_name)
-
-        case op
-        when String then op
-        when Class  then op.name
-        else op.class.name
-        end
-      end
-
-    end # module Shared
-  end # module Audit
-end # module Startback

data/lib/startback/audit/trailer.rb

@@ -1,129 +0,0 @@
-require_relative 'shared'
-require 'forwardable'
-module Startback
-  module Audit
-    #
-    # Log & Audit trail abstraction, that can be registered as an around
-    # hook on OperationRunner and as an actual logger on Context instances.
-    #
-    # The trail is outputted as JSON lines, using a Logger on the "device"
-    # passed at construction. The following JSON entries are dumped:
-    #
-    # - severity  : INFO or ERROR
-    # - time      : ISO8601 Datetime of operation execution
-    # - op        : class name of the operation executed
-    # - op_took   : Execution duration of the operation
-    # - op_data   : Dump of operation input data
-    # - context   : Execution context, through its `h` information contract (IC)
-    #
-    # Dumping of operation data follows the following duck typing conventions:
-    #
-    # - If the operation instance responds to `to_trail`, this data is taken
-    # - If the operation instance responds to `input`, this data is taken
-    # - If the operation instance responds to `request`, this data is taken
-    # - Otherwise op_data is a JSON null
-    #
-    # By contributing to the Context's `h` IC, users can easily dump information that
-    # makes sense (such as the operation execution requester).
-    #
-    # The class implements a sanitization process when dumping the context and
-    # operation data. Blacklisted words taken in construction options are used to
-    # prevent dumping hash keys that match them (insentively). Default stop words
-    # are equivalent to:
-    #
-    #     Trailer.new("/var/log/trail.log", {
-    #       blacklist: "token password secret credential"
-    #     })
-    #
-    # Please note that the sanitization process does not apply recursively if
-    # the operation data is hierarchic. It only applies to the top object of
-    # Hash and [Hash]. Use `Operation#to_trail` to fine-tune your audit trail.
-    #
-    # Given that this Trailer is intended to be used as around hook on an
-    # `OperationRunner`, operations that fail at construction time will not be
-    # trailed at all, since they can't be ran in the first place. This may lead
-    # to trails not containing important errors cases if operations check their
-    # input at construction time.
-    #
-    class Trailer
-      include Shared
-      extend Forwardable
-      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
-
-      DEFAULT_OPTIONS = {
-
-        # Words used to stop dumping for, e.g., security reasons
-        blacklist: "token password secret credential"
-
-      }
-
-      def initialize(device, options = {})
-        @options = DEFAULT_OPTIONS.merge(options)
-        @logger = ::Logger.new(device, 'daily')
-        @logger.formatter = Support::LogFormatter.new
-      end
-      attr_reader :logger, :options
-
-      def call(runner, op)
-        result = nil
-        time = Benchmark.realtime{ result = yield }
-        logger.info(op_to_trail(op, time))
-        result
-      rescue => ex
-        logger.error(op_to_trail(op, time, ex))
-        raise
-      end
-
-    protected
-
-      def op_to_trail(op, time = nil, ex = nil)
-        log_msg = {
-          op_took: time ? time.round(8) : nil,
-          op: op_name(op),
-          context: op_context(op),
-          op_data: op_data(op)
-        }.compact
-        log_msg[:error] = ex if ex
-        log_msg
-      end
-
-      def op_context(op)
-        sanitize(op.respond_to?(:context, false) ? op.context.to_h : {})
-      end
-
-      def op_data(op)
-        data = if op.respond_to?(:op_data, false)
-          op.op_data
-        elsif op.respond_to?(:to_trail, false)
-          op.to_trail
-        elsif op.respond_to?(:input, false)
-          op.input
-        elsif op.respond_to?(:request, false)
-          op.request
-        elsif op.is_a?(Operation::MultiOperation)
-          op.ops.map{ |sub_op| op_to_trail(sub_op) }
-        end
-        sanitize(data)
-      end
-
-      def sanitize(data)
-        case data
-        when Hash, OpenStruct
-          data.dup.delete_if{|k| k.to_s =~ blacklist_rx }
-        when Enumerable
-          data.map{|elm| sanitize(elm) }.compact
-        else
-          data
-        end
-      end
-
-      def blacklist_rx
-        @blacklist_rx ||= Regexp.new(
-          options[:blacklist].split(/\s+/).join("|"),
-          Regexp::IGNORECASE
-        )
-      end
-
-    end # class Trailer
-  end # module Audit
-end # module Startback

data/lib/startback/audit.rb

@@ -1,3 +0,0 @@
-require_relative 'audit/shared'
-require_relative 'audit/trailer'
-require_relative 'audit/prometheus'

data/lib/startback/caching/entity_cache.rb

@@ -1,157 +0,0 @@
-module Startback
-  module Caching
-    #
-    # A overriable caching abstraction aiming at making Entity-based caching easy.
-    #
-    # This class MUST be overriden:
-    #
-    # * the `load_entity` protected method MUST be implemented to load data from
-    #   a primary & context unaware key.
-    #
-    # * the `primary_key` protected method MAY be implemented to convert candidate
-    #   keys (received from ultimate callers) to primary keys. The method is also
-    #   a good place to check and/or log the keys actually used by callers.
-    #
-    # * the `context_free_key` protected method MAY be overriden to provide
-    #   domain unrelated caching keys from primary keys, e.g. by encoding the
-    #   context into the caching key itself, if needed.
-    #
-    # * the `valid?` protected method MAY be overriden to check validity of data
-    #   extracted from the cache and force a refresh even if found.
-    #
-    # An EntityCache takes an actual store at construction. The object must meet the
-    # specification writtern in Store. The 'cache' ruby gem can be used in practice.
-    #
-    # Cache hits, outdated and miss are logged in debug, info, and info severity.
-    # The `cache_hit`, `cache_outdated`, `cache_miss` protected methods MAY be
-    # overriden to change that behavior.
-    #
-    class EntityCache
-      include Support::Robustness
-
-      class << self
-
-        # Default time to live, in seconds
-        attr_writer :default_ttl
-
-        def default_ttl
-          @default_ttl || (superclass.respond_to?(:default_ttl, true) && superclass.default_ttl) || 3600
-        end
-
-      end # class DSL
-
-      def initialize(store, context = nil)
-        @store = store
-        @context = context
-      end
-      attr_reader :store, :context
-
-      # Returns the entity corresponding to a given key.
-      #
-      # If the entity is not in cache, loads it and puts it in cache using
-      # the caching options passed as second parameter.
-      def get(candidate_key, caching_options = default_caching_options)
-        pkey = primary_key(candidate_key)
-        cache_key = encode_key(context_free_key(pkey))
-        if store.exist?(cache_key)
-          cached = store.get(cache_key)
-          if valid?(pkey, cached)
-            cache_hit(pkey, cached)
-            return cached
-          else
-            cache_outdated(pkey, cached)
-          end
-        end
-        cache_miss(pkey)
-        load_entity(pkey).tap{|to_cache|
-          store.set(cache_key, to_cache, caching_options)
-        }
-      end
-
-      # Invalidates the cache under a given key.
-      def invalidate(candidate_key)
-        pkey = primary_key(candidate_key)
-        cache_key = encode_key(context_free_key(pkey))
-        store.delete(cache_key)
-      end
-
-    protected
-
-      def cache_hit(pkey, cached)
-        log(:debug, self, "cache_hit", context, op_data: pkey)
-      end
-
-      def cache_outdated(pkey, cached)
-        log(:info, self, "cache_outdated", context, op_data: pkey)
-      end
-
-      def cache_miss(pkey)
-        log(:info, self, "cache_miss", context, op_data: pkey)
-      end
-
-      def default_caching_options
-        { ttl: self.class.default_ttl }
-      end
-
-      # Converts a candidate key to a primary key, so as to prevent
-      # cache duplicates if callers are allowed to request an entity
-      # through various keys.
-      #
-      # The default implementation returns the candidate key and MAY
-      # be overriden.
-      def primary_key(candidate_key)
-        candidate_key
-      end
-
-      # Encodes a context free key to an actual cache key.
-      #
-      # Default implementation uses JSON.fast_generate but MAY be
-      # overriden.
-      def encode_key(context_free_key)
-        JSON.fast_generate(context_free_key)
-      end
-
-      # Returns whether `cached` entity seems fresh enough to
-      # be returned as a cache hit.
-      #
-      # This method provides a way to check freshness using, e.g.
-      # `updated_at` or `etag` kind of entity fields. The default
-      # implementation returns true and MAY be overriden.
-      def valid?(primary_key, cached)
-        true
-      end
-
-      # Converts a primary_key to a context_free_key, using the
-      # context (instance variable) to encode the context itself
-      # into the actual cache key.
-      #
-      # The default implementation simply returns the primary key
-      # and MAY be overriden.
-      def context_free_key(primary_key)
-        full_key(primary_key)
-      end
-
-      # Deprecated, will be removed in 0.6.0. Use context_free_key
-      # instead.
-      def full_key(primary_key)
-        primary_key
-      end
-
-      # Actually loads the entity using the given primary key, and
-      # possibly the cache context.
-      #
-      # This method MUST be implemented and raises a NotImplementedError
-      # by default.
-      def load_entity(primary_key)
-        load_raw_data(primary_key)
-      end
-
-      # Deprecated, will be removed in 0.6.0. Use load_entity
-      # instead.
-      def load_raw_data(*args, &bl)
-        raise NotImplementedError, "#{self.class.name}#load_entity"
-      end
-
-    end # class EntityCache
-  end # module Caching
-end # module Startback