async-cable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d7aec9e4d2af6f7e33c0684d7e5f1d7ec6484cd055f2be48bd08b4f635935a5
+  data.tar.gz: 4bac0fc445833442bab84556ca34aed98872e9f1d250b411a8abfef777c85555
+SHA512:
+  metadata.gz: 3af7edbe1360eff3316b2fc88076476006ad39f607a20fdf112ddb40130dad0b9cd26316cc7c14e6c7af9cbe6a5320daab159ff71e219799ba9445592d523a2f
+  data.tar.gz: 8c021590476f294e34448d59d629fd9499f082ba5a8ed68d72677f52c799fcbd2a10cc7872c10e6ccc317e093ec708c992c70b8e055478ce66b1576b814cb7df

data/lib/action_cable/subscription_adapters/async_cable_redis.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require "action_cable/subscription_adapter/base"
+require "action_cable/subscription_adapter/channel_prefix"
+require "action_cable/subscription_adapter/subscriber_map"
+
+require "async/redis"
+
+module ActionCable::SubscriptionAdapter
+	class AsyncCableRedis < Base
+		prepend ChannelPrefix
+		
+		def initialize(*arguments, endpoint: nil, **options)
+			super(*arguments, **options)
+			
+			@endpoint = endpoint || ::Async::Redis.local_endpoint
+			@client = ::Async::Redis::Client.new(endpoint)
+			
+			@subscriber = Subscriber.new(@client, self.executor)
+		end
+		
+		def subscribe(channel, callback, success_callback = nil)
+			@subscriber.add_subscriber(channel, callback, success_callback)
+		end
+		
+		def unsubscribe(channel, callback)
+			@subscriber.remove_subscriber(channel, callback)
+		end
+		
+		def broadcast(channel, payload)
+			@client.publish(channel, payload)
+		end
+		
+		def shutdown
+			@subscriber&.close
+		end
+		
+		private
+		
+		class Subscriber < SubscriberMap::Async
+			CHANNEL = "_action_cable_internal"
+			
+			def initialize(client, executor, parent: Async::Task.current)
+				super(executor)
+				
+				@context = @client.subscribe(CHANNEL)
+				@task = parent.async{self.listen(CHANNEL)}
+			end
+
+			def add_channel(channel, on_success)
+				@context.subscribe(channel)
+				on_success&.call
+			end
+
+			def remove_channel(channel)
+				@context.unsubscribe(channel)
+			end
+
+			def close
+				if task = @task
+					@task = nil
+					task.stop
+				end
+				
+				if context = @context
+					@context = nil
+					context.close
+				end
+			end
+
+			private
+
+			def listen
+				context.each do |type, channel, message|
+					self.broadcast(event[1], event[2])
+				end
+			end
+		end
+	end
+end

data/lib/async/cable/middleware.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require "async/websocket/adapters/rack"
+require "action_cable"
+
+require_relative "socket"
+
+module Async
+	module Cable
+		class Middleware
+			def initialize(app, server: ActionCable.server)
+				@app = app
+				@server = server
+				@coder = ActiveSupport::JSON
+				@protocols = ::ActionCable::INTERNAL[:protocols]
+			end
+			
+			attr :server
+			
+			def call(env)
+				if Async::WebSocket::Adapters::Rack.websocket?(env) and allow_request_origin?(env)
+					Async::WebSocket::Adapters::Rack.open(env, protocols: @protocols) do |websocket|
+						handle_incoming_websocket(env, websocket)
+					end
+				else
+					@app.call(env)
+				end
+			end
+			
+			private
+			
+			def handle_incoming_websocket(env, websocket)
+				socket = Socket.new(env, websocket, @server, coder: @coder)
+				connection = @server.config.connection_class.call.new(@server, socket)
+				
+				connection.handle_open
+				@server.add_connection(connection)
+				@server.setup_heartbeat_timer
+				
+				socket_task = socket.run
+				
+				while message = websocket.read
+					Console.debug(self, "Received cable data:", message.buffer)
+					connection.handle_incoming(@coder.decode(message.buffer))
+				end
+			rescue Protocol::WebSocket::ClosedError, EOFError
+				# This is a normal disconnection.
+			rescue => error
+				Console.warn(self, error)
+			ensure
+				if connection
+					@server.remove_connection(connection)
+					connection.handle_close
+				end
+				
+				socket_task&.stop
+			end
+			
+			# TODO: Shouldn't this be moved to ActionCable::Server::Base?
+			def allow_request_origin?(env)
+				if @server.config.disable_request_forgery_protection
+					return true
+				end
+				
+				proto = ::Rack::Request.new(env).ssl? ? "https" : "http"
+				
+				if @server.config.allow_same_origin_as_host && env["HTTP_ORIGIN"] == "#{proto}://#{env["HTTP_HOST"]}"
+					return true
+				elsif Array(@server.config.allowed_request_origins).any?{|allowed_origin| allowed_origin === env["HTTP_ORIGIN"]}
+					return true
+				end
+				
+				Console.warn(self, "Request origin not allowed!", origin: env["HTTP_ORIGIN"])
+				return false
+			end
+		end
+	end
+end

data/lib/async/cable/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative "middleware"
+
+module Async
+	module Cable
+		class Railtie < Rails::Railtie
+			initializer "async.cable.configure_rails_initialization" do |app|
+				app.middleware.use Async::Cable::Middleware
+			end
+		end
+	end
+end

data/lib/async/cable/socket.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Async::Cable
+	class Socket
+		def initialize(env, websocket, server, coder: ActiveSupport::JSON)
+			@env = env
+			@websocket = websocket
+			@server = server
+			@coder = coder
+			
+			@output = ::Thread::Queue.new
+		end
+		
+		attr :env
+		
+		def logger
+			@server.logger
+		end
+		
+		def request
+			# Copied from ActionCable::Server::Socket#request
+			@request ||= begin
+				if defined?(Rails.application) && Rails.application
+					environment = Rails.application.env_config.merge(@env)
+				end
+				
+				ActionDispatch::Request.new(environment || @env)
+			end
+		end
+		
+		def run(parent: Async::Task.current)
+			parent.async do
+				while buffer = @output.pop
+					@websocket.send_text(buffer)
+					@websocket.flush if @output.empty?
+				end
+			rescue => error
+			ensure
+				@websocket.close_write(error)
+			end
+		end
+		
+		def transmit(data)
+			# Console.info(self, "Transmitting data:", data, task: Async::Task.current?)
+			@output.push(@coder.encode(data))
+		end
+		
+		def close
+			# Console.info(self, "Closing socket.", task: Async::Task.current?)
+			@output.close
+		end
+		
+		# This can be called from the work pool, off the event loop.
+		def perform_work(receiver, ...)
+			# Console.info(self, "Performing work:", receiver)
+			receiver.send(...)
+		end
+	end
+end

data/lib/async/cable/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+# Released under the MIT License.
+# Copyright, 2023-2024, by Samuel Williams.
+
+module Async
+	module Cable
+		VERSION = "0.1.0"
+	end
+end

data/lib/async/cable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative "cable/version"
+
+begin
+	require "rails/railtie"
+rescue LoadError
+	# Ignore.
+end
+
+if defined?(Rails::Railtie)
+	require_relative "cable/railtie"
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2023-2024, by Samuel Williams.  
+
+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,37 @@
+# Async::Cable
+
+This is a proof-of-concept adapter for Rails 7.2+. It depends on `actioncable-next` which completely replaces the internal implementation of Action Cable with a pluggable one.
+
+[![Development Status](https://github.com/socketry/async-cable/workflows/Test/badge.svg)](https://github.com/socketry/async-cable/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/async-cable/) for more details.
+
+  - [Getting Started](https://socketry.github.io/async-cable/guides/getting-started/index) - This guide shows you how to add `async-cable` to your project to enable real-time communication between clients and servers using Falcon and Action Cable.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/async-cable/releases/index) for all releases.
+
+### v0.1.0
+
+  - Initial implementation.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.1.0
+
+  - Initial implementation.

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: async-cable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actioncable-next
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/action_cable/subscription_adapters/async_cable_redis.rb
+- lib/async/cable.rb
+- lib/async/cable/middleware.rb
+- lib/async/cable/railtie.rb
+- lib/async/cable/socket.rb
+- lib/async/cable/version.rb
+- license.md
+- readme.md
+- releases.md
+homepage:
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/async-cable/
+  source_code_uri: https://github.com/socketry/async-cable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: An asynchronous adapter for ActionCable.
+test_files: []