hyper-operation 1.0.alpha1.3 → 1.0.alpha1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9684386e717f491348c6acab32279464d69eae7a30dad4177a86e5b05e34b47a
-  data.tar.gz: 8a7ffd0abd510e70a657ce14ee796265520646a8a709fd4e98b8589c568da42e
+  metadata.gz: 89a7c07b2cab1760bb41bcff159333e5ea985d8eca22329f4a39f7890d295e5f
+  data.tar.gz: 5955718c34bba9f9af227ea92e0d0869a4f21c131deccd2ad2f0e707c97b8219
 SHA512:
-  metadata.gz: a52bbf0183579a349caaa55afc19179d851a900c335bda1a51a13fafc0a9535ec456dd4f2c864bb33766ca2329bf912bde9fba0b13c236a65a5d5bd9763843e1
-  data.tar.gz: 7a2127f42df5613b3a4f030afa05fc1b3c30e5d0d2afa7b6c32df05ccf33e43678584fa4e54e58562d65caad7936279baf0b700c4fd2c482cecec42ddc0eddf4
+  metadata.gz: 215aaf6fa7aa4084551d000b96a5dcf62c1839ff346fd8e0c75b6c66eea32274867e93eca3d1f485ccef0ed0f2cbc5e7442da994016a8446d49daa8156c51832
+  data.tar.gz: 18944dce11ebdbd25616d2b4a0d7565ea2ddbbf033ba78f36608102220e95278433f4a7b5e4241032758fda4f5b7a5bec99cb6d1236501f4c6ee729b17bd2736

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

@@ -29,24 +29,25 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'opal-activesupport', '~> 0.3.1'
   spec.add_dependency 'tty-table'
 
-  spec.add_development_dependency 'bundler', ['>= 1.17.3', '< 2.1']
+  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,6 +28,7 @@ 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'
@@ -45,7 +46,7 @@ else
   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/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 = {})
@@ -104,6 +123,7 @@ class Promise
 
     begin
       if block = @action[:success] || @action[:always]
+        @realized = :resolve
         value = block.call(value)
       end
 
@@ -137,6 +157,9 @@ class Promise
 
     begin
       if block = @action[:failure] || @action[:always]
+        # temporarily set values so always can determine if this
+        # was a reject or resolve
+        @realized = :reject
         value = block.call(value)
       end
 
@@ -164,8 +187,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,36 @@ 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
+        @promise_chain = @promise_chain
+          .always do |result|
+            @state = :failed if @promise_chain.rejected? && @state != :abort
+            apply(result, :failed, opts)
           end
-        elsif @state == :failed
-          apply(opts)
-        end
       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 +95,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,8 +13,8 @@ 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]
@@ -129,6 +129,10 @@ module Hyperstack
         promise.reject e
       end
 
+      def headers
+        {}
+      end
+
       def serialize_params(hash)
         hash
       end

data/lib/hyper-operation/transport/client_drivers.rb

@@ -35,16 +35,35 @@ module Hyperstack
 
 
   if RUBY_ENGINE == 'opal'
+    # Patch in a dummy copy of Model.load in case we are not using models
+    # this will be defined properly by hyper-model
+    module Model
+      def self.load
+        Promise.new.tap { |promise| promise.resolve(yield) }
+      end unless respond_to?(:load)
+    end
+
     def self.connect(*channels)
       channels.each do |channel|
         if channel.is_a? Class
           IncomingBroadcast.connect_to(channel.name)
         elsif channel.is_a?(String) || channel.is_a?(Array)
           IncomingBroadcast.connect_to(*channel)
-        elsif channel.id
-          IncomingBroadcast.connect_to(channel.class.name, channel.id)
+        elsif channel.respond_to?(:id)
+          Hyperstack::Model.load do
+            channel.id
+          end.then do |id|
+            raise "Hyperstack.connect cannot connect to #{channel.inspect}.  "\
+                  "The id is nil. This can be caused by connecting to a model "\
+                  "that is not saved, or that does not exist." unless id
+            IncomingBroadcast.connect_to(channel.class.name, id)
+          end
         else
-          raise "cannot connect to model before it has been saved"
+          raise "Hyperstack.connect cannot connect to #{channel.inspect}.\n"\
+                "Channels must be either a class, or a class name,\n"\
+                "a string in the form 'ClassName-id',\n"\
+                "an array in the form [class, id] or [class-name, id],\n"\
+                "or an object that responds to the id method with a non-nil value"
         end
       end
     end
@@ -65,19 +84,22 @@ module Hyperstack
 
       def self.add_connection(channel_name, id = nil)
         channel_string = "#{channel_name}#{'-'+id.to_s if id}"
+        return if open_channels.include? channel_string
         open_channels << channel_string
         channel_string
       end
 
       def self.connect_to(channel_name, id = nil)
         channel_string = add_connection(channel_name, id)
+        return unless channel_string # already connected!
         if ClientDrivers.opts[:transport] == :pusher
           channel = "#{ClientDrivers.opts[:channel]}-#{channel_string}"
           %x{
             var channel = #{ClientDrivers.opts[:pusher_api]}.subscribe(#{channel.gsub('::', '==')});
             channel.bind('dispatch', #{ClientDrivers.opts[:dispatch]})
-            channel.bind('pusher:subscription_succeeded', #{lambda {ClientDrivers.get_queued_data("connect-to-transport", channel_string)}})
+            channel.bind('pusher:subscription_succeeded', #{->(*) { ClientDrivers.get_queued_data("connect-to-transport", channel_string)}})
           }
+          @pusher_dispatcher_registered = true
         elsif ClientDrivers.opts[:transport] == :action_cable
           channel = "#{ClientDrivers.opts[:channel]}-#{channel_string}"
           Hyperstack::HTTP.post(ClientDrivers.polling_path('action-cable-auth', channel), headers: { 'X-CSRF-Token' => ClientDrivers.opts[:form_authenticity_token] }).then do |response|
@@ -147,7 +169,7 @@ module Hyperstack
       config_hash = {
         transport: Hyperstack.transport,
         id: id,
-        acting_user_id: (controller.acting_user && controller.acting_user.id),
+        acting_user_id: (controller.acting_user.respond_to?(:id) && controller.acting_user.id),
         env: ::Rails.env,
         client_logging: Hyperstack.client_logging,
         pusher_fake_js: pusher_fake_js,
@@ -163,12 +185,17 @@ module Hyperstack
         # not sure why the second check is needed.  It happens in the test app
         route.app == Hyperstack::Engine or (route.app.respond_to?(:app) and route.app.app == Hyperstack::Engine)
       end
-      raise 'Hyperstack::Engine mount point not found.  Check your config/routes.rb file' unless path
-      path = path.path.spec
-      "<script type='text/javascript'>\n"\
-        "window.HyperstackEnginePath = '#{path}';\n"\
-        "window.HyperstackOpts = #{config_hash.to_json}\n"\
-      "</script>\n"
+      if path
+        path = path.path.spec
+        "<script type='text/javascript'>\n"\
+          "window.HyperstackEnginePath = '#{path}';\n"\
+          "window.HyperstackOpts = #{config_hash.to_json}\n"\
+        "</script>\n"
+      else
+        "<script type='text/javascript'>\n"\
+          "window.HyperstackOpts = #{config_hash.to_json}\n"\
+        "</script>\n"
+      end
     end if RUBY_ENGINE != 'opal'
 
     class << self
@@ -222,6 +249,9 @@ module Hyperstack
 
         @opts = Hash.new(`window.HyperstackOpts`)
 
+        if opts[:transport] != :none && `typeof(window.HyperstackEnginePath) == 'undefined'`
+          raise "No hyperstack mount point found!\nCheck your Rails routes.rb file";
+        end
 
         if opts[:transport] == :pusher