turbo_boost-commands 0.0.18 → 0.1.1

data/lib/turbo_boost/commands/command.rb

@@ -77,17 +77,15 @@ class TurboBoost::Commands::Command
     end
   end
 
-  attr_reader :controller, :state_manager, :params, :turbo_streams
-
-  alias_method :state, :state_manager
+  attr_reader :controller, :state, :params, :turbo_streams
   alias_method :streams, :turbo_streams
 
   delegate :css_id_selector, to: :"self.class"
   delegate :dom_id, to: :"controller.view_context"
 
-  def initialize(controller, state_manager, params = {})
+  def initialize(controller, state, params = {})
     @controller = controller
-    @state_manager = state_manager
+    @state = state
     @params = params
     @turbo_streams = Set.new
   end

data/lib/turbo_boost/commands/controller_pack.rb

@@ -1,29 +1,26 @@
 # frozen_string_literal: true
 
-require_relative "../state/manager"
 require_relative "runner"
 
 class TurboBoost::Commands::ControllerPack
   include TurboBoost::Commands::AttributeHydration
 
-  attr_reader :controller, :state_manager, :runner, :command
-  alias_method :state, :state_manager
+  attr_reader :runner, :command
 
   delegate(
     :command_aborted?,
     :command_errored?,
-    :command_performing?,
     :command_performed?,
+    :command_performing?,
     :command_requested?,
     :command_succeeded?,
-    :meta_tag,
+    :controller,
+    :state,
     to: :runner
   )
 
   def initialize(controller)
-    @controller = controller
-    @state_manager = TurboBoost::State::Manager.new(controller)
-    @runner = TurboBoost::Commands::Runner.new(controller, state_manager)
+    @runner = TurboBoost::Commands::Runner.new(controller)
     @command = runner.command_instance
   end
 end

data/lib/turbo_boost/commands/engine.rb

@@ -2,9 +2,9 @@
 
 require "turbo-rails"
 require "turbo_boost/streams"
+require "universalid"
 require_relative "version"
 require_relative "http_status_codes"
-require_relative "../errors"
 require_relative "errors"
 require_relative "patches"
 require_relative "command"
@@ -19,13 +19,14 @@ module TurboBoost::Commands
 
   class Engine < ::Rails::Engine
     config.turbo_boost_commands = ActiveSupport::OrderedOptions.new
-    config.turbo_boost_commands[:max_cookie_size] = ActionDispatch::Cookies::MAX_COOKIE_SIZE / 3
     config.turbo_boost_commands[:validate_client_token] = false
 
     # must opt-in to state overrides
     config.turbo_boost_commands[:apply_client_state_overrides] = false
     config.turbo_boost_commands[:apply_server_state_overrides] = false
 
+    config.turbo_boost_commands.precompile_assets = true
+
     initializer "turbo_boost_commands.configuration" do
       Mime::Type.register "text/vnd.turbo-boost.html", :turbo_boost
 
@@ -40,5 +41,13 @@ module TurboBoost::Commands
         ActionView::Helpers::TagHelper::TagBuilder.prepend TurboBoost::Commands::Patches::ActionViewHelpersTagHelperTagBuilderPatch
       end
     end
+
+    initializer "turbo_boost_commands.asset" do
+      config.after_initialize do |app|
+        if app.config.respond_to?(:assets) && app.config.turbo_boost_commands.precompile_assets
+          app.config.assets.precompile += %w[@turbo-boost/commands.js]
+        end
+      end
+    end
   end
 end

data/lib/turbo_boost/commands/errors.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module TurboBoost::Commands
+  class InvalidTokenError < StandardError; end
+
   class InvalidClassError < StandardError; end
 
   class InvalidMethodError < StandardError; end

data/lib/turbo_boost/commands/runner.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "sanitizer"
+require_relative "state"
 
 class TurboBoost::Commands::Runner
   SUPPORTED_MEDIA_TYPES = {
@@ -9,22 +10,18 @@ class TurboBoost::Commands::Runner
     "text/vnd.turbo-stream.html" => true
   }.freeze
 
-  attr_reader :controller, :state_manager
+  attr_reader :controller
 
-  def initialize(controller, state_manager)
+  def initialize(controller)
     @controller = controller
-    @state_manager = state_manager
   end
 
-  def meta_tag
-    masked_token = message_verifier.generate(new_token)
-    options = {
-      id: "turbo-boost",
-      name: "turbo-boost",
-      content: masked_token,
-      data: {busy: false, state: state_manager.payload}
-    }
-    controller.view_context.tag("meta", options).html_safe
+  def state
+    @state ||= begin
+      sgid = command_params[:signed_state]
+      value = TurboBoost::Commands::State.from_sgid_param(sgid) if sgid
+      value || TurboBoost::Commands::State.new
+    end
   end
 
   def command_requested?
@@ -48,15 +45,15 @@ class TurboBoost::Commands::Runner
 
     # validate csrf token
     unless valid_client_token?
-      raise TurboBoost::InvalidTokenError,
-        "CSRF token mismatch! The request header `TurboBoost-Token: #{client_token}` does not match the expected value of `#{server_token}`."
+      raise TurboBoost::Commands::InvalidTokenError,
+        "Token mismatch! The token: #{client_token}` does not match the expected value of `#{server_token}`."
     end
 
     true
   end
 
   def command_params
-    return ActionController::Parameters.new if controller.params[:turbo_boost_command].nil?
+    return ActionController::Parameters.new if controller.params.keys.none?(/\A(tbc|turbo_boost_command)\z/o)
     @command_params ||= begin
       payload = parsed_command_params.deep_transform_keys(&:underscore)
       ActionController::Parameters.new(payload).permit!
@@ -86,7 +83,7 @@ class TurboBoost::Commands::Runner
   end
 
   def command_instance
-    @command_instance ||= command_class&.new(controller, state_manager, command_params).tap do |instance|
+    @command_instance ||= command_class&.new(controller, state, command_params).tap do |instance|
       instance&.add_observer self, :handle_command_event
     end
   end
@@ -126,6 +123,7 @@ class TurboBoost::Commands::Runner
     return if command_errored?
     return if command_performing?
     return if command_performed?
+    state.resolve command_params[:client_state]
     command_instance.perform_with_callbacks command_method_name
   end
 
@@ -148,8 +146,8 @@ class TurboBoost::Commands::Runner
       append_error_to_response error
     end
 
-    append_meta_tag_to_response_body # called before `write_cookie` so all state is emitted to the DOM
-    state_manager.write_cookie # truncates state to stay within cookie size limits (4k)
+    append_command_token_to_response_body
+    append_command_state_to_response_body
   end
 
   def update_response
@@ -159,8 +157,8 @@ class TurboBoost::Commands::Runner
     return if controller_action_prevented?
 
     append_to_response_headers
-    append_meta_tag_to_response_body # called before `write_cookie` so all state is emitted to the DOM
-    state_manager.write_cookie # truncates state to stay within cookie size limits (4k)
+    append_command_token_to_response_body
+    append_command_state_to_response_body
     append_success_to_response if command_succeeded?
   rescue => error
     Rails.logger.error "TurboBoost::Commands::Runner failed to update the response! #{error.message}"
@@ -181,11 +179,6 @@ class TurboBoost::Commands::Runner
     ActiveSupport::MessageVerifier.new Rails.application.secret_key_base, digest: "SHA256"
   end
 
-  # Same implementation as ActionController::Base but with public visibility
-  def cookies
-    controller.request.cookie_jar
-  end
-
   def handle_command_event(*args)
     event = args.shift
     options = args.extract_options!
@@ -198,31 +191,36 @@ class TurboBoost::Commands::Runner
   private
 
   def parsed_command_params
-    @parsed_command_params ||= JSON.parse(controller.params[:turbo_boost_command])
+    @parsed_command_params ||= JSON.parse(controller.params[:tbc] || controller.params[:turbo_boost_command])
   end
 
   def content_sanitizer
     TurboBoost::Commands::Sanitizer.instance
   end
 
+  # TODO: revisit command token validation
   def new_token
-    @new_token ||= SecureRandom.urlsafe_base64(12)
+    @new_token ||= SecureRandom.alphanumeric(13)
   end
 
+  # TODO: revisit command token validation
   def server_token
-    cookies.encrypted["turbo_boost.token"]
+    nil
   end
 
+  # TODO: revisit command token validation
   def client_token
-    (controller.request.headers["TurboBoost-Token"] || command_params[:token]).to_s
+    command_params[:token].to_s
   end
 
+  # TODO: revisit command token validation
   def valid_client_token?
-    return true unless Rails.configuration.turbo_boost_commands.validate_client_token
-    return false unless client_token.present?
-    return false unless message_verifier.valid_message?(client_token)
-    unmasked_client_token = message_verifier.verify(client_token)
-    unmasked_client_token == server_token
+    # return true unless Rails.configuration.turbo_boost_commands.validate_client_token
+    # return false unless client_token.present?
+    # return false unless message_verifier.valid_message?(client_token)
+    # unmasked_client_token = message_verifier.verify(client_token)
+    # unmasked_client_token == server_token
+    true
   end
 
   def should_redirect?
@@ -258,11 +256,16 @@ class TurboBoost::Commands::Runner
     command_instance.turbo_streams.each { |stream| append_to_response_body stream }
   end
 
-  def append_meta_tag_to_response_body
-    cookies.encrypted["turbo_boost.token"] = {value: new_token, path: "/"}
-    append_to_response_body turbo_stream.invoke("morph", args: [meta_tag], selector: "#turbo-boost")
+  def append_command_token_to_response_body
+    append_to_response_body turbo_stream.invoke("TurboBoost.Commands.token=", args: [new_token], camelize: false)
+  rescue => error
+    Rails.logger.error "TurboBoost::Commands::Runner failed to append the Command token to the response! #{error.message}"
+  end
+
+  def append_command_state_to_response_body
+    append_to_response_body turbo_stream.invoke("TurboBoost.State.initialize", args: [state.to_json, state.to_sgid_param], camelize: false)
   rescue => error
-    Rails.logger.error "TurboBoost::Commands::Runner failed to append the meta tag to the response! #{error.message}"
+    Rails.logger.error "TurboBoost::Commands::Runner failed to append the Command state to the response! #{error.message}"
   end
 
   def append_success_event_to_response_body

data/lib/turbo_boost/commands/state.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class TurboBoost::Commands::State
+  include Enumerable
+
+  class << self
+    def from_sgid_param(sgid)
+      new URI::UID.from_sgid(sgid, for: name)&.decode
+    end
+
+    attr_reader :resolver
+
+    def assign_resolver(&block)
+      @resolver = block
+    end
+  end
+
+  def initialize(store = nil, provisional: false)
+    @store = store || ActiveSupport::Cache::MemoryStore.new(expires_in: 1.day, size: 2.kilobytes)
+    @store.cleanup
+    @provisional = provisional
+  end
+
+  delegate :to_json, to: :to_h
+  delegate_missing_to :store
+
+  def each
+    data.keys.each do |key|
+      yield key, self[key]
+    end
+  end
+
+  # Provisional state is for the current request/response and is exposed as `State#now`
+  # Standard state is preserved across multiple requests
+  def provisional?
+    !!@provisional
+  end
+
+  # TODO: implement state resolution
+  def resolve(client_state)
+    # return unless self.class.resolver
+    # self.class.resolver.call self, client_state
+  end
+
+  def now
+    return nil if provisional? # provisional state cannot hold child provisional state
+    @now ||= self.class.new(provisional: true)
+  end
+
+  def cache_key
+    "TurboBoost::Commands::State/#{Digest::SHA2.base64digest(to_json)}"
+  end
+
+  def read(...)
+    now&.read(...) || store.read(...)
+  end
+
+  def [](...)
+    read(...)
+  end
+
+  def []=(...)
+    write(...)
+  end
+
+  def to_sgid_param
+    store.cleanup
+    URI::UID.build(store, include_blank: false).to_sgid_param for: self.class.name, expires_in: 1.week
+  end
+
+  private
+
+  attr_reader :store
+
+  def data
+    store.instance_variable_get(:@data) || {}
+  end
+end

data/lib/turbo_boost/commands/version.rb

@@ -2,6 +2,6 @@
 
 module TurboBoost
   module Commands
-    VERSION = "0.0.18"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbo_boost-commands
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.1.1
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-03 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: universalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -344,7 +358,6 @@ files:
 - README.md
 - app/assets/builds/@turbo-boost/commands.js
 - app/assets/builds/@turbo-boost/commands.js.map
-- app/assets/builds/@turbo-boost/commands.metafile.json
 - app/assets/images/apple-touch-icon.png
 - app/assets/images/favicon-16x16.png
 - app/assets/images/favicon-32x32.png
@@ -369,7 +382,6 @@ files:
 - app/javascript/index.js
 - app/javascript/lifecycle.js
 - app/javascript/logger.js
-- app/javascript/meta.js
 - app/javascript/renderer.js
 - app/javascript/schema.js
 - app/javascript/state/index.js
@@ -377,6 +389,7 @@ files:
 - app/javascript/turbo.js
 - app/javascript/urls.js
 - app/javascript/uuids.js
+- app/javascript/version.js
 - lib/turbo_boost/commands.rb
 - lib/turbo_boost/commands/attribute_hydration.rb
 - lib/turbo_boost/commands/attribute_set.rb
@@ -390,12 +403,8 @@ files:
 - lib/turbo_boost/commands/patches/action_view_helpers_tag_helper_tag_builder_patch.rb
 - lib/turbo_boost/commands/runner.rb
 - lib/turbo_boost/commands/sanitizer.rb
+- lib/turbo_boost/commands/state.rb
 - lib/turbo_boost/commands/version.rb
-- lib/turbo_boost/errors.rb
-- lib/turbo_boost/state.rb
-- lib/turbo_boost/state/errors.rb
-- lib/turbo_boost/state/manager.rb
-- lib/turbo_boost/state/provisional_state.rb
 homepage: https://github.com/hopsoft/turbo_boost-commands
 licenses:
 - MIT
@@ -411,7 +420,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.5
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/app/assets/builds/@turbo-boost/commands.metafile.json

@@ -1 +0,0 @@
-{"inputs":{"app/javascript/meta.js":{"bytes":337,"imports":[],"format":"esm"},"app/javascript/events.js":{"bytes":783,"imports":[{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"},"app/javascript/state/observable.js":{"bytes":920,"imports":[{"path":"app/javascript/meta.js","kind":"import-statement","original":"../meta"},{"path":"app/javascript/events.js","kind":"import-statement","original":"../events"}],"format":"esm"},"app/javascript/state/index.js":{"bytes":1835,"imports":[{"path":"app/javascript/meta.js","kind":"import-statement","original":"../meta"},{"path":"app/javascript/state/observable.js","kind":"import-statement","original":"./observable"},{"path":"app/javascript/events.js","kind":"import-statement","original":"../events"},{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"},"app/javascript/renderer.js":{"bytes":475,"imports":[],"format":"esm"},"app/javascript/activity.js":{"bytes":279,"imports":[],"format":"esm"},"app/javascript/lifecycle.js":{"bytes":610,"imports":[{"path":"app/javascript/activity.js","kind":"import-statement","original":"./activity"},{"path":"app/javascript/events.js","kind":"import-statement","original":"./events"}],"format":"esm"},"app/javascript/turbo.js":{"bytes":1952,"imports":[{"path":"app/javascript/meta.js","kind":"import-statement","original":"./meta"},{"path":"app/javascript/state/index.js","kind":"import-statement","original":"./state"},{"path":"app/javascript/renderer.js","kind":"import-statement","original":"./renderer"},{"path":"app/javascript/events.js","kind":"import-statement","original":"./events"},{"path":"app/javascript/lifecycle.js","kind":"import-statement","original":"./lifecycle"},{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"},"app/javascript/schema.js":{"bytes":226,"imports":[{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"},"app/javascript/confirmation.js":{"bytes":947,"imports":[{"path":"app/javascript/events.js","kind":"import-statement","original":"./events"},{"path":"app/javascript/schema.js","kind":"import-statement","original":"./schema"}],"format":"esm"},"app/javascript/delegates.js":{"bytes":923,"imports":[{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"},"app/javascript/elements.js":{"bytes":1451,"imports":[{"path":"app/javascript/schema.js","kind":"import-statement","original":"./schema"},{"path":"app/javascript/lifecycle.js","kind":"import-statement","original":"./lifecycle"}],"format":"esm"},"app/javascript/drivers/form.js":{"bytes":384,"imports":[{"path":"app/javascript/meta.js","kind":"import-statement","original":"../meta"}],"format":"esm"},"app/javascript/urls.js":{"bytes":240,"imports":[],"format":"esm"},"app/javascript/drivers/frame.js":{"bytes":218,"imports":[{"path":"app/javascript/urls.js","kind":"import-statement","original":"../urls"},{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"},"app/javascript/drivers/method.js":{"bytes":265,"imports":[{"path":"app/javascript/urls.js","kind":"import-statement","original":"../urls"},{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"},"app/javascript/drivers/window.js":{"bytes":2033,"imports":[{"path":"app/javascript/meta.js","kind":"import-statement","original":"../meta"},{"path":"app/javascript/state/index.js","kind":"import-statement","original":"../state"},{"path":"app/javascript/events.js","kind":"import-statement","original":"../events"},{"path":"app/javascript/lifecycle.js","kind":"import-statement","original":"../lifecycle"},{"path":"app/javascript/urls.js","kind":"import-statement","original":"../urls"},{"path":"app/javascript/renderer.js","kind":"import-statement","original":"../renderer"},{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"},"app/javascript/drivers/index.js":{"bytes":2044,"imports":[{"path":"app/javascript/elements.js","kind":"import-statement","original":"../elements"},{"path":"app/javascript/drivers/form.js","kind":"import-statement","original":"./form"},{"path":"app/javascript/drivers/frame.js","kind":"import-statement","original":"./frame"},{"path":"app/javascript/drivers/method.js","kind":"import-statement","original":"./method"},{"path":"app/javascript/drivers/window.js","kind":"import-statement","original":"./window"}],"format":"esm"},"app/javascript/logger.js":{"bytes":729,"imports":[{"path":"app/javascript/events.js","kind":"import-statement","original":"./events"}],"format":"esm"},"app/javascript/uuids.js":{"bytes":202,"imports":[],"format":"esm"},"app/javascript/index.js":{"bytes":3558,"imports":[{"path":"app/javascript/turbo.js","kind":"import-statement","original":"./turbo"},{"path":"app/javascript/schema.js","kind":"import-statement","original":"./schema"},{"path":"app/javascript/events.js","kind":"import-statement","original":"./events"},{"path":"app/javascript/activity.js","kind":"import-statement","original":"./activity"},{"path":"app/javascript/confirmation.js","kind":"import-statement","original":"./confirmation"},{"path":"app/javascript/delegates.js","kind":"import-statement","original":"./delegates"},{"path":"app/javascript/drivers/index.js","kind":"import-statement","original":"./drivers"},{"path":"app/javascript/meta.js","kind":"import-statement","original":"./meta"},{"path":"app/javascript/elements.js","kind":"import-statement","original":"./elements"},{"path":"app/javascript/lifecycle.js","kind":"import-statement","original":"./lifecycle"},{"path":"app/javascript/logger.js","kind":"import-statement","original":"./logger"},{"path":"app/javascript/state/index.js","kind":"import-statement","original":"./state"},{"path":"app/javascript/urls.js","kind":"import-statement","original":"./urls"},{"path":"app/javascript/uuids.js","kind":"import-statement","original":"./uuids"},{"path":"<runtime>","kind":"import-statement","external":true}],"format":"esm"}},"outputs":{"app/assets/builds/@turbo-boost/commands.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":37542},"app/assets/builds/@turbo-boost/commands.js":{"imports":[],"exports":["default"],"entryPoint":"app/javascript/index.js","inputs":{"app/javascript/meta.js":{"bytesInOutput":252},"app/javascript/events.js":{"bytesInOutput":500},"app/javascript/state/observable.js":{"bytesInOutput":405},"app/javascript/state/index.js":{"bytesInOutput":762},"app/javascript/renderer.js":{"bytesInOutput":263},"app/javascript/activity.js":{"bytesInOutput":173},"app/javascript/lifecycle.js":{"bytesInOutput":294},"app/javascript/turbo.js":{"bytesInOutput":1024},"app/javascript/schema.js":{"bytesInOutput":166},"app/javascript/confirmation.js":{"bytesInOutput":424},"app/javascript/delegates.js":{"bytesInOutput":473},"app/javascript/elements.js":{"bytesInOutput":782},"app/javascript/drivers/form.js":{"bytesInOutput":246},"app/javascript/urls.js":{"bytesInOutput":166},"app/javascript/drivers/frame.js":{"bytesInOutput":96},"app/javascript/drivers/method.js":{"bytesInOutput":130},"app/javascript/drivers/window.js":{"bytesInOutput":1298},"app/javascript/drivers/index.js":{"bytesInOutput":991},"app/javascript/logger.js":{"bytesInOutput":399},"app/javascript/uuids.js":{"bytesInOutput":159},"app/javascript/index.js":{"bytesInOutput":1686}},"bytes":11186}}}

data/app/javascript/meta.js

@@ -1,19 +0,0 @@
-class Meta {
-  get element() {
-    return document.querySelector('meta[name="turbo-boost"]')
-  }
-
-  get token() {
-    return this.element.getAttribute('content')
-  }
-
-  get busy() {
-    return this.element.dataset.busy === 'true'
-  }
-
-  set busy(value) {
-    return (this.element.dataset.busy = !!value)
-  }
-}
-
-export default new Meta()

data/lib/turbo_boost/errors.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module TurboBoost
-  class InvalidTokenError < StandardError
-  end
-end

data/lib/turbo_boost/state/errors.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-class TurboBoost::State
-  class DeserializationError < StandardError
-  end
-end