hyper-operation 1.0.alpha1.1 → 1.0.alpha1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c92ceabb98fa585a85ae66c8dac864da129e8e93068394081ff799eab32559e2
-  data.tar.gz: c2e73fba94fd2bda03bc8d1e221f2d251285025fb37f4fa113f6f675b47a63b7
+  metadata.gz: bf7ea211cf5d34d735df9a5318691ff4261b26e15816c6529138da58ce23ead5
+  data.tar.gz: bbce8cdf73f646fe7abd922a0667739f486368c723800b7f6efecbbec9ad7468
 SHA512:
-  metadata.gz: 4eead7193a415dcc6f21aabd0eb964e1614806d9c9508bde214d71db050e88f1f8707b2b834ee97589d6c49c8ec9977b5aa2b4a086806f436d924d99767ef5ce
-  data.tar.gz: 937c223809bc3322a6df12bd19d9b70d83061dc80f86d9294f5c0f30db7215d4de33f94952a01641619468a9cec47225c38a1362d99c00d670d4d5507d0480ef
+  metadata.gz: afdb25d53a08ed95794a3419f0d3ea341f04c8da594d68189029f2c5c87568b4c0edd9fe4b57df4a42042f63f66de585e4a1a65dde8efb56063d79019fddee75
+  data.tar.gz: c5fbd8014773c171dee7d8556f84da60fcdfc77509a7ae6f4380c3b7b729a2c438faa4cd5c1d09a92dc19ceed2b77203154314ebd75b6e3b01988383485caf88

data/.gitignore

@@ -53,3 +53,7 @@ bower.json
 .idea
 .vscode
 *.iml
+
+# ignore Gemfile.locks https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+/spec/test_app/Gemfile.lock
+/Gemfile.lock

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - ruby-head
 services:
   - mysql
+  - redis-server
 env:
   - DRIVER=google-chrome TZ=Europe/Berlin
 matrix:

data/hyper-operation.gemspec

@@ -27,25 +27,27 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hyper-component', Hyperstack::Operation::VERSION
   spec.add_dependency 'mutations'
   spec.add_dependency 'opal-activesupport', '~> 0.3.1'
+  spec.add_dependency 'tty-table'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'chromedriver-helper'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'hyper-spec', Hyperstack::Operation::VERSION
   spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'opal', '>= 0.11.0', '< 0.12.0'
   spec.add_development_dependency 'opal-browser', '~> 0.2.0'
-  spec.add_development_dependency 'opal-rails', '~> 0.9.4'
+  spec.add_development_dependency 'opal-rails', '>= 0.9.4', '< 2.0'
   spec.add_development_dependency 'pry-rescue'
+  spec.add_development_dependency 'pry-stack_explorer'
   spec.add_development_dependency 'puma'
   spec.add_development_dependency 'pusher'
   spec.add_development_dependency 'pusher-fake'
-  spec.add_development_dependency 'rails', '>= 4.0.0'
+  spec.add_development_dependency 'rails', ENV['RAILS_VERSION'] || '>= 5.0.0', '< 7.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'react-rails', '>= 2.4.0', '< 2.5.0'
+  spec.add_development_dependency 'redis'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'rspec-steps', '~> 2.1.1'
   spec.add_development_dependency 'rspec-wait'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'sqlite3', '~> 1.4.2' # see https://github.com/rails/rails/issues/35153
   spec.add_development_dependency 'timecop', '~> 0.8.1'
 end

data/lib/hyper-operation.rb

@@ -28,7 +28,9 @@ if RUBY_ENGINE == 'opal'
   require 'hyper-operation/railway/validations'
   require 'hyper-operation/server_op'
   require 'hyper-operation/boot'
+  require 'hyper-operation/async_sleep'
 else
+  require 'tty-table'
   require 'hyperstack-config'
   require 'mutations'
   Mutations::HashFilter.register_additional_filter(Mutations::DuckFilter, :duck)
@@ -40,10 +42,11 @@ else
   require 'hyper-operation/transport/connection'
   require 'hyper-operation/transport/hyperstack'
   require 'hyper-operation/transport/policy'
+  require 'hyper-operation/transport/policy_diagnostics'
   require 'hyper-operation/transport/client_drivers'
   require 'hyper-operation/transport/acting_user'
   require 'opal-activesupport'
-  require 'hyper-operation/delay_and_interval'
+  require 'hyper-operation/async_sleep'
   require 'hyper-operation/exception'
   require 'hyper-operation/promise'
   require 'hyper-operation/railway'

data/lib/hyper-operation/api.rb

@@ -46,8 +46,12 @@ module Hyperstack
           @_railway.process_params(args)
           @_railway.process_validations
           @_railway.run
-          @_railway.dispatch
-          @_railway.result
+          # return the result from dispatch in case there is an error
+          if (dispatch_result = @_railway.dispatch).rejected?
+            dispatch_result
+          else
+            @_railway.result
+          end
         end
       end
 

data/lib/hyper-operation/async_sleep.rb

@@ -0,0 +1,23 @@
+module Hyperstack
+  module AsyncSleep
+    if RUBY_ENGINE == 'opal'
+      def self.every(*args, &block)
+        every(*args, &block)
+      end
+
+      def self.after(*args, &block)
+        after(*args, &block)
+      end
+    else
+      extend self
+
+      def every(time, &block)
+        Thread.new { loop { sleep time; block.call } }
+      end
+
+      def after(time, &block)
+        Thread.new { sleep time; block.call }
+      end
+    end
+  end
+end

data/lib/hyper-operation/exception.rb

@@ -1,13 +1,39 @@
+module Mutations
+  class ErrorArray
+    def self.new_from_error_hash(errors)
+      new(errors.collect do |key, values|
+        ErrorAtom.new(key, values[:symbol], values)
+      end)
+    end
+  end
+end
+
 module Hyperstack
   class AccessViolation < StandardError
-    def message
-      "Hyperstack::Operation::AccessViolation: #{super}"
+    attr_accessor :details
+
+    def initialize(message = nil, details = nil)
+      super("Hyperstack::AccessViolation#{':' + message.to_s if message}")
+      @details = details
+    end
+
+    def __hyperstack_on_error(operation, params, fmted_message)
+      Hyperstack.on_error(operation, self, params, fmted_message)
     end
   end
 
   class Operation
     class ValidationException < Mutations::ValidationException
+      def as_json(*)
+        errors.as_json
+      end
+
+      def initialize(errors)
+        unless errors.is_a? Mutations::ErrorHash
+          errors = Mutations::ErrorArray.new_from_error_hash(errors)
+        end
+        super(errors)
+      end
     end
   end
-
 end

data/lib/hyper-operation/promise.rb

@@ -1,3 +1,15 @@
+# Caution.  For now Hyperstack maintains its own copy of the Promise class.
+# Eventually the diff between hyperstacks version and the official Opal version
+# should be put into a PR.
+
+# A key feature add is the Fail Exception class which is simply there to allow
+# a `always` block to reject without raising an error.  To use this see the run.rb
+# module.
+
+# Also see exception! method for the part of the code that detects the Fail exception.
+
+# See https://github.com/opal/opal/issues/1967 for details.
+
 class Promise
   def self.value(value)
     new.resolve(value)
@@ -11,6 +23,13 @@ class Promise
     When.new(promises)
   end
 
+  class Fail < StandardError
+    attr_reader :result
+    def initialize(result)
+      @result = result
+    end
+  end
+
   attr_reader :error, :prev, :next
 
   def initialize(action = {})
@@ -164,8 +183,15 @@ class Promise
   end
 
   def exception!(error)
-    @exception = true
-
+    # If the error is a Promise::Fail, then
+    # the error becomes the error.result value
+    # this allows code to raise an error on an
+    # object that is not an error.
+    if error.is_a? Promise::Fail
+      error = error.result
+    else
+      @exception = true
+    end
     reject!(error)
   end
 

data/lib/hyper-operation/railway/dispatcher.rb

@@ -1,7 +1,6 @@
 module Hyperstack
   class Operation
     class Railway
-
       def receivers
         self.class.receivers
       end

data/lib/hyper-operation/railway/run.rb

@@ -4,10 +4,13 @@ module Hyperstack
     class Exit < StandardError
       attr_reader :state
       attr_reader :result
-      def initialize(state, result)
+      def initialize(state, result = nil)
         @state = state
         @result = result
       end
+      def to_s
+        @state
+      end
     end
 
     class Railway
@@ -21,7 +24,7 @@ module Hyperstack
           @tracks ||= []
         end
 
-        def to_opts(tie, args, block)
+        def build_tie(tie, args, block)
           if args.count.zero?
             { run: block }
           elsif args[0].is_a?(Hash)
@@ -41,7 +44,7 @@ module Hyperstack
 
         [:step, :failed, :async].each do |tie|
           define_method :"add_#{tie}" do |*args, &block|
-            tracks << to_opts(tie, args, block)
+            tracks << build_tie(tie, args, block)
           end
         end
 
@@ -55,44 +58,33 @@ module Hyperstack
       end
 
       def step(opts)
-        if @last_result.is_a? Promise
-          @last_result = @last_result.then do |*result|
-            @last_result = result
-            apply(opts, :in_promise)
-          end
-        elsif @state == :success
-          apply(opts)
-        end
+        @promise_chain = @promise_chain
+          .then { |result| apply(result, :success, opts) }
       end
 
       def failed(opts)
-        if @last_result.is_a? Promise
-          @last_result = @last_result.fail do |e|
-            @last_result = e
-            apply(opts, :in_promise)
-            raise @last_result if @last_result.is_a? Exception
-            raise e
-          end
-        elsif @state == :failed
-          apply(opts)
-        end
+        @promise_chain = @promise_chain
+          .always { |result| apply(result, :failed, opts) }
       end
 
       def async(opts)
-        apply(opts) if @state != :failed
+        @promise_chain = @promise_chain_start = Promise.new
+        @promise_chain.resolve(@last_async_result)
+        step(opts)
       end
 
-      def apply(opts, in_promise = nil)
+      def apply(result, state, opts)
+        return result unless @state == state
         if opts[:scope] == :class
-          args = [@operation, *@last_result]
+          args = [@operation, *result]
           instance = @operation.class
         else
-          args = @last_result
+          args = result
           instance = @operation
         end
         block = opts[:run]
         block = instance.method(block) if block.is_a? Symbol
-        @last_result =
+        last_result =
           if block.arity.zero?
             instance.instance_exec(&block)
           elsif args.is_a?(Array) && block.arity == args.count
@@ -100,40 +92,54 @@ module Hyperstack
           else
             instance.instance_exec(args, &block)
           end
-        return @last_result unless @last_result.is_a? Promise
-        raise @last_result.error if @last_result.rejected?
-        @last_result = @last_result.value if @last_result.resolved?
-        @last_result
+        @last_async_result = last_result unless last_result.is_a? Promise
+        last_result
       rescue Exit => e
-        @state = e.state
-        @last_result = (e.state != :failed || e.result.is_a?(Exception)) ? e.result : e
-        raise e
+        # the promise chain ends with an always block which will process
+        # any immediate exits by checking the value of @state.   All other
+        # step/failed/async blocks will be skipped because state will not equal
+        # :succeed or :failed
+        if e.state == :failed
+          @state = :abort
+          # exit via the final always block with the exception
+          raise e.result.is_a?(Exception) ? e.result : e
+        else
+          @state = :succeed
+          # exit via the final then block with the success value
+          e.result
+        end
       rescue Exception => e
         @state = :failed
-        @last_result = e
-        raise e if in_promise
+        raise e
       end
 
       def run
-        if @operation.has_errors? || @state
-          @last_result ||= ValidationException.new(@operation.instance_variable_get('@errors'))
-          return if @state  # handles abort out of validation
-          @state = :failed
-        else
-          @state = :success
-        end
-        tracks.each { |opts| opts[:tie].bind(self).call(opts) }
-      rescue Exit
+        # if @operation.has_errors? || @state
+        #   @last_result ||= ValidationException.new(@operation.instance_variable_get('@errors'))
+        #   # following handles abort out of validation.  if state is already set then we are aborting
+        #   # otherwise if state is not set but we have errors then we are failed
+        #   @state ||= :failed
+        # else
+        #   @state = :success
+        # end
+        @state ||= :success
+        @promise_chain_start = @promise_chain = Promise.new
+        @promise_chain_start.resolve(@last_result)
+        tracks.each { |opts| opts[:tie].bind(self).call(opts) } unless @state == :abort
       end
 
       def result
-        return @last_result if @last_result.is_a? Promise
-        @last_result =
-          if @state == :success
-            Promise.new.resolve(@last_result)
+        @result ||= @promise_chain.always do |e|
+          if %i[abort failed].include? @state
+            if e.is_a? Exception
+              raise e
+            else
+              raise Promise::Fail.new(e)
+            end
           else
-            Promise.new.reject(@last_result)
+            e
           end
+        end
       end
     end
   end

data/lib/hyper-operation/railway/validations.rb

@@ -28,6 +28,8 @@ module Hyperstack
             rescue Exit => e
               raise e unless e.state == :failed
               add_error(param, symbol, message)
+              # use a bogus exit state which will skip adding
+              # a validation error (see catch block in process_validations method)
               raise Exit.new(:abort_from_add_error, e.result)
             end
           end
@@ -47,17 +49,22 @@ module Hyperstack
             when :failed
               add_validation_error(i, "param validation #{i+1} aborted")
             end
-            @state = :failed
+            @state = :abort
             return # break does not work in Opal
           rescue AccessViolation => e
             add_validation_error(i, e)
-            @state = :failed
+            @state = :abort
             @last_result = e
             return # break does not work in Opal
           rescue Exception => e
             add_validation_error(i, e)
           end
         end
+      ensure
+        if @operation.has_errors?
+          @last_result ||= ValidationException.new(@operation.instance_variable_get('@errors'))
+          @state ||= :failed
+        end
       end
     end
   end

data/lib/hyper-operation/server_op.rb

@@ -13,14 +13,18 @@ module Hyperstack
             hash = serialize_params(hash)
             Hyperstack::HTTP.post(
               "#{`window.HyperstackEnginePath`}/execute_remote",
-              payload: {json: {operation: name, params: hash}.to_json},
-              headers: {'X-CSRF-Token' => Hyperstack::ClientDrivers.opts[:form_authenticity_token] }
+              payload: {hyperstack_secured_json: {operation: name, params: hash}.to_json},
+              headers: headers.merge('X-CSRF-Token' => Hyperstack::ClientDrivers.opts[:form_authenticity_token])
               )
             .then do |response|
               deserialize_response response.json[:response]
             end
             .fail do |response|
-              Exception.new response.json[:error]
+              begin
+                const_get(response.json[:error_class]).new(response.json[:error])
+              rescue
+                Exception.new response.json[:error]
+              end
             end
           end
         elsif on_opal_server?
@@ -74,7 +78,7 @@ module Hyperstack
           if _Railway.params_wrapper.method_defined?(:controller)
             params[:controller] = controller
           elsif !_Railway.params_wrapper.method_defined?(security_param)
-            raise AccessViolation
+            raise AccessViolation.new(:remote_access_not_allowed)
           end
           run(deserialize_params(params))
           .then { |r| return { json: { response: serialize_response(r) } } }
@@ -84,13 +88,27 @@ module Hyperstack
         handle_exception(e, operation, params)
       end
 
+      def status(e)
+        if e.is_a? AccessViolation
+          403
+        elsif e.is_a? Operation::ValidationException
+          400
+        else
+          500
+        end
+      end
+
       def handle_exception(e, operation, params)
-        if defined? ::Rails
-          params.delete(:controller)
-          ::Rails.logger.debug "\033[0;31;1mERROR: Hyperstack::ServerOp exception caught when running "\
-                               "#{operation} with params \"#{params}\": #{e}\033[0;30;21m"
+        if e.respond_to? :__hyperstack_on_error
+          params = params.to_h
+          message = []
+          message << Pastel.new.red("HYPERSTACK ERROR during #{operation} #{e.inspect}")
+          params.each { |param, value| message << "  #{param} => #{value.inspect.truncate(120, separator: '...')}" }
+          message << "\n#{e.details}" if e.respond_to? :details
+          e.__hyperstack_on_error(operation, params, message.join("\n"))
         end
-        { json: { error: e }, status: 500 }
+
+        { json: { error_class: e.class.to_s, error: e}, status: status(e) }
       end
 
 
@@ -111,6 +129,10 @@ module Hyperstack
         promise.reject e
       end
 
+      def headers
+        {}
+      end
+
       def serialize_params(hash)
         hash
       end