anycable-rails 1.4.0 → 1.4.1

data/lib/anycable/rails/railtie.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require "anycable/rails/action_cable_ext/connection"
-require "anycable/rails/action_cable_ext/channel"
-require "anycable/rails/action_cable_ext/remote_connections"
-
-require "anycable/rails/channel_state"
-require "anycable/rails/connection_factory"
-
-module AnyCable
-  module Rails
-    class Railtie < ::Rails::Railtie # :nodoc:
-      initializer "anycable.disable_action_cable_mount", after: "action_cable.set_configs" do |app|
-        next unless AnyCable::Rails.enabled?
-
-        app.config.action_cable.mount_path = nil
-      end
-
-      initializer "anycable.logger", after: "action_cable.logger" do |_app|
-        AnyCable.logger = ::ActionCable.server.config.logger
-
-        AnyCable.configure_server do
-          server_logger = AnyCable.logger = ::ActionCable.server.config.logger
-          AnyCable.logger = ActiveSupport::TaggedLogging.new(server_logger) if server_logger.is_a?(::Logger)
-          # Broadcast server logs to STDOUT in development
-          if ::Rails.env.development? &&
-              !ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, $stdout)
-            console = ActiveSupport::Logger.new($stdout)
-            console.formatter = ::Rails.logger.formatter if ::Rails.logger.respond_to?(:formatter)
-            console.level = ::Rails.logger.level if ::Rails.logger.respond_to?(:level)
-            AnyCable.logger.extend(ActiveSupport::Logger.broadcast(console))
-          end
-        end
-
-        # Add tagging middleware
-        if AnyCable.logger.respond_to?(:tagged)
-          require "anycable/rails/middlewares/log_tagging"
-
-          AnyCable.middleware.use(AnyCable::Rails::Middlewares::LogTagging)
-        end
-      end
-
-      initializer "anycable.executor" do |app|
-        require "anycable/rails/middlewares/executor"
-        # see https://github.com/rails/rails/pull/33469/files
-        executor = app.config.reload_classes_only_on_change ? app.reloader : app.executor
-        AnyCable.middleware.use(AnyCable::Rails::Middlewares::Executor.new(executor))
-
-        if app.executor.respond_to?(:error_reporter)
-          AnyCable.capture_exception do |ex, method, message|
-            ::Rails.error.report(ex, handled: false, context: {method: method.to_sym, payload: message})
-          end
-        end
-      end
-
-      initializer "anycable.connection_factory", after: "action_cable.set_configs" do |app|
-        ActiveSupport.on_load(:action_cable) do
-          app.config.to_prepare do
-            AnyCable.connection_factory = AnyCable::Rails::ConnectionFactory.new
-          end
-
-          if AnyCable.config.persistent_session_enabled?
-            require "anycable/rails/connections/persistent_session"
-          end
-        end
-      end
-
-      initializer "anycable.routes" do
-        next unless AnyCable::Rails.enabled?
-
-        config.after_initialize do |app|
-          config = AnyCable.config
-          unless config.http_rpc_mount_path.nil?
-            app.routes.prepend do
-              mount AnyCable::HTTRPC::Server.new => config.http_rpc_mount_path, :internal => true
-            end
-          end
-        end
-      end
-
-      # Since Rails 6.1
-      if respond_to?(:server)
-        server do
-          next unless AnyCable.config.embedded? && AnyCable::Rails.enabled?
-
-          require "anycable/cli"
-          AnyCable::CLI.embed!
-        end
-      end
-    end
-  end
-end

data/lib/anycable/rails/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module AnyCable
-  module Rails
-    VERSION = "1.4.0"
-  end
-end

data/lib/anycable/rails.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require "anycable"
-require "anycable/rails/version"
-require "anycable/rails/config"
-require "anycable/rails/rack"
-
-require "globalid"
-
-module AnyCable
-  # Rails handler for AnyCable
-  module Rails
-    require "anycable/rails/railtie"
-
-    ADAPTER_ALIASES = %w[any_cable anycable].freeze
-
-    class << self
-      def enabled?
-        adapter = ::ActionCable.server.config.cable&.fetch("adapter", nil)
-        compatible_adapter?(adapter)
-      end
-
-      def compatible_adapter?(adapter)
-        ADAPTER_ALIASES.include?(adapter)
-      end
-
-      # Serialize connection/channel state variable to string
-      # using GlobalID where possible or JSON (if json: true)
-      def serialize(obj, json: false)
-        obj.try(:to_gid_param) || (json ? obj.to_json : obj)
-      end
-
-      # Deserialize previously serialized value from string to
-      # Ruby object.
-      # If the resulting object is a Hash, make it indifferent
-      def deserialize(str, json: false)
-        str.yield_self do |val|
-          next val unless val.is_a?(String)
-
-          gval = GlobalID::Locator.locate(val)
-          return gval if gval
-
-          next val unless json
-
-          JSON.parse(val)
-        end.yield_self do |val|
-          next val.with_indifferent_access if val.is_a?(Hash)
-          val
-        end
-      end
-
-      module Extension
-        def broadcast(channel, payload)
-          super
-          ::AnyCable.broadcast(channel, payload)
-        end
-      end
-
-      def extend_adapter!(adapter)
-        adapter.extend(Extension)
-      end
-    end
-  end
-end
-
-# Warn if application has been already initialized.
-# AnyCable should be loaded before initialization in order to work correctly.
-if defined?(::Rails) && ::Rails.application && ::Rails.application.initialized?
-  puts("\n**************************************************")
-  puts(
-    "⛔️  WARNING: AnyCable loaded after application initialization. Might not work correctly.\n" \
-    "Please, make sure to remove `require: false` in your Gemfile or " \
-    "require manually in `environment.rb` before `Rails.application.initialize!`"
-  )
-  puts("**************************************************\n\n")
-end

data/lib/anycable-rails.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require "anycable/rails"

data/lib/generators/anycable/download/USAGE

@@ -1,14 +0,0 @@
-Description:
-    Install AnyCable-Go web server locally (the latest version by default).
-
-Example:
-    rails generate anycable:download
-
-    This will ask:
-        Where to store a binary file.
-    This will create:
-        `<bin_path>/anycable-go`.
-
-    rails generate anycable:download --bin-path=/usr/local/bin
-
-    rails generate anycable:download --version=1.0.0

data/lib/generators/anycable/download/download_generator.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require "generators/anycable/with_os_helpers"
-
-module AnyCableRailsGenerators
-  # Downloads anycable-go binary
-  class DownloadGenerator < ::Rails::Generators::Base
-    namespace "anycable:download"
-
-    include WithOSHelpers
-
-    VERSION = "latest"
-
-    class_option :bin_path,
-      type: :string,
-      desc: "Where to download AnyCable-Go server binary (default: #{DEFAULT_BIN_PATH})"
-    class_option :version,
-      type: :string,
-      desc: "Specify the AnyCable-Go version (defaults to latest release)"
-
-    def download_bin
-      out = options[:bin_path] || DEFAULT_BIN_PATH
-      version = options[:version] || VERSION
-
-      download_exe(
-        release_url(version),
-        to: out,
-        file_name: "anycable-go"
-      )
-
-      true
-    end
-
-    private
-
-    def release_url(version)
-      return latest_release_url(version) if version == "latest"
-
-      if Gem::Version.new(version).segments.first >= 1
-        new_release_url("v#{version}")
-      else
-        legacy_release_url("v#{version}")
-      end
-    end
-
-    def legacy_release_url(version)
-      "https://github.com/anycable/anycable-go/releases/download/#{version}/" \
-        "anycable-go-v#{version}-#{os_name}-#{cpu_name}"
-    end
-
-    def new_release_url(version)
-      "https://github.com/anycable/anycable-go/releases/download/#{version}/" \
-        "anycable-go-#{os_name}-#{cpu_name}"
-    end
-
-    def latest_release_url(version)
-      "https://github.com/anycable/anycable-go/releases/latest/download/" \
-        "anycable-go-#{os_name}-#{cpu_name}"
-    end
-
-    def download_exe(url, to:, file_name:)
-      file_path = File.join(to, file_name)
-
-      FileUtils.mkdir_p(to) unless File.directory?(to)
-
-      run "#{sudo(to)}curl -L #{url} -o #{file_path}", abort_on_failure: true
-      run "#{sudo(to)}chmod +x #{file_path}", abort_on_failure: true
-      run "#{file_path} -v", abort_on_failure: true
-    end
-
-    def sudo(path)
-      sudo = ""
-      unless File.writable?(path)
-        if yes? "Path is not writable 😕. Do you have sudo privileges?"
-          sudo = "sudo "
-        else
-          say_status :error, "❌ Failed to install AnyCable-Go WebSocket server", :red
-          raise StandardError, "Path #{path} is not writable!"
-        end
-      end
-
-      sudo
-    end
-  end
-end

data/lib/generators/anycable/setup/USAGE

@@ -1,2 +0,0 @@
-Description:
-    Configures your application to work with AnyCable interactively.

data/lib/generators/anycable/setup/setup_generator.rb

@@ -1,300 +0,0 @@
-# frozen_string_literal: true
-
-require "generators/anycable/with_os_helpers"
-
-module AnyCableRailsGenerators
-  # Entry point for interactive installation
-  class SetupGenerator < ::Rails::Generators::Base
-    namespace "anycable:setup"
-    source_root File.expand_path("templates", __dir__)
-
-    DOCS_ROOT = "https://docs.anycable.io"
-    DEVELOPMENT_METHODS = %w[skip local docker].freeze
-    SERVER_SOURCES = %w[skip brew binary].freeze
-
-    class_option :devenv,
-      type: :string,
-      desc: "Select your development environment (options: #{DEVELOPMENT_METHODS.join(", ")})"
-    class_option :source,
-      type: :string,
-      desc: "Choose a way of installing AnyCable-Go server (options: #{SERVER_SOURCES.join(", ")})"
-    class_option :skip_heroku,
-      type: :boolean,
-      desc: "Do not copy Heroku configs"
-    class_option :skip_procfile_dev,
-      type: :boolean,
-      desc: "Do not create Procfile.dev"
-    class_option :skip_jwt,
-      type: :boolean,
-      desc: "Do not install anycable-rails-jwt"
-    class_option :skip_install,
-      type: :boolean,
-      desc: "Do not run bundle install when adding new gems"
-
-    include WithOSHelpers
-
-    class_option :bin_path,
-      type: :string,
-      desc: "Where to download AnyCable-Go server binary (default: #{DEFAULT_BIN_PATH})"
-    class_option :version,
-      type: :string,
-      desc: "Specify the AnyCable-Go version (defaults to latest release)"
-
-    def welcome
-      say "👋 Welcome to AnyCable interactive installer."
-    end
-
-    def configs
-      inside("config") do
-        template "cable.yml"
-        template "anycable.yml"
-      end
-    end
-
-    def cable_url
-      environment(nil, env: :development) do
-        <<~SNIPPET
-          # Specify AnyCable WebSocket server URL to use by JS client
-          config.after_initialize do
-            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL", "ws://localhost:8080/cable") if AnyCable::Rails.enabled?
-          end
-        SNIPPET
-      end
-
-      environment(nil, env: :production) do
-        <<~SNIPPET
-          # Specify AnyCable WebSocket server URL to use by JS client
-          config.after_initialize do
-            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL", "/cable") if AnyCable::Rails.enabled?
-          end
-        SNIPPET
-      end
-
-      say_status :info, "✅ 'config.action_cable.url' has been configured"
-      say_status :help, "⚠️  If you're using JS client make sure you have " \
-                        "`action_cable_meta_tag` included before any <script> tag in your application.html"
-    end
-
-    def development_method
-      answer = DEVELOPMENT_METHODS.index(options[:devenv]) || 99
-
-      until DEVELOPMENT_METHODS[answer.to_i]
-        answer = ask "Which environment do you use for development? (1) Local, (2) Docker, (0) Skip"
-      end
-
-      case env = DEVELOPMENT_METHODS[answer.to_i]
-      when "skip"
-        say_status :help, "⚠️  Please, read this guide on how to install AnyCable-Go server 👉 #{DOCS_ROOT}/anycable-go/getting_started", :yellow
-      else
-        send "install_for_#{env}"
-      end
-    end
-
-    def heroku
-      if options[:skip_heroku].nil?
-        return unless yes? "Do you use Heroku for deployment? [Yn]"
-      elsif options[:skip_heroku]
-        return
-      end
-
-      in_root do
-        next unless File.file?("Procfile")
-
-        contents = File.read("Procfile")
-        contents.sub!(/^web: (.*)$/, %q(web: [[ "$ANYCABLE_DEPLOYMENT" == "true" ]] && bundle exec anycable --server-command="anycable-go" || \1))
-        File.write("Procfile", contents)
-        say_status :info, "✅ Procfile updated"
-      end
-
-      say_status :help, "️️⚠️  Please, read the required steps to configure Heroku applications 👉 #{DOCS_ROOT}/deployment/heroku", :yellow
-    end
-
-    def devise
-      in_root do
-        return unless File.file?("config/initializers/devise.rb")
-      end
-
-      inside("config/initializers") do
-        template "anycable.rb"
-      end
-
-      say_status :info, "✅ config/initializers/anycable.rb with Devise configuration has been added"
-    end
-
-    def stimulus_reflex
-      return unless stimulus_reflex?
-
-      say_status :help, "⚠️  Please, check out the documentation on using AnyCable with Stimulus Reflex: #{DOCS_ROOT}/rails/stimulus_reflex"
-    end
-
-    def rubocop_compatibility
-      return unless rubocop?
-
-      say_status :info, "🤖 Running static compatibility checks with RuboCop"
-      res = run "bundle exec rubocop -r 'anycable/rails/compatibility/rubocop' --only AnyCable/InstanceVars,AnyCable/PeriodicalTimers,AnyCable/InstanceVars"
-      say_status :help, "⚠️  Please, take a look at the icompatibilities above and fix them. See #{DOCS_ROOT}/rails/compatibility" unless res
-    end
-
-    def jwt
-      return if options[:skip_jwt]
-
-      return unless options[:skip_jwt] == false || yes?("Do you want to use JWT for authentication? [Yn]")
-
-      opts = " --skip-install" if options[:skip_install]
-
-      run "bundle add anycable-rails-jwt#{opts}"
-    end
-
-    def finish
-      say_status :info, "✅ AnyCable has been configured successfully!"
-    end
-
-    private
-
-    def stimulus_reflex?
-      !!gemfile_lock&.match?(/^\s+stimulus_reflex\b/)
-    end
-
-    def redis?
-      !!gemfile_lock&.match?(/^\s+redis\b/)
-    end
-
-    def nats?
-      !!gemfile_lock&.match?(/^\s+nats-pure\b/)
-    end
-
-    def webpacker?
-      !!gemfile_lock&.match?(/^\s+webpacker\b/)
-    end
-
-    def rubocop?
-      !!gemfile_lock&.match?(/^\s+rubocop\b/)
-    end
-
-    def gemfile_lock
-      @gemfile_lock ||= begin
-        res = nil
-        in_root do
-          next unless File.file?("Gemfile.lock")
-          res = File.read("Gemfile.lock")
-        end
-        res
-      end
-    end
-
-    def install_for_docker
-      # Remove localhost from configuraiton
-      gsub_file "config/anycable.yml", /^.*redis_url:.*localhost[^\n]+\n/, ""
-
-      say_status :help, "️️⚠️  Docker development configuration could vary", :yellow
-
-      say "Here is an example snippet for docker-compose.yml:"
-      say <<~YML
-        ─────────────────────────────────────────
-        ws:
-          image: anycable/anycable-go:1.2
-          ports:
-            - '8080:8080'
-          environment:
-            ANYCABLE_HOST: "0.0.0.0"
-            ANYCABLE_REDIS_URL: redis://redis:6379/0
-            ANYCABLE_RPC_HOST: anycable:50051
-            ANYCABLE_DEBUG: 1
-          depends_on:
-            redis:
-              condition: service_healthy
-
-        anycable:
-          <<: *backend
-          command: bundle exec anycable
-          environment:
-            <<: *backend_environment
-            ANYCABLE_REDIS_URL: redis://redis:6379/0
-            ANYCABLE_RPC_HOST: 0.0.0.0:50051
-            ANYCABLE_DEBUG: 1
-          ports:
-            - '50051'
-          depends_on:
-            <<: *backend_depends_on
-            ws:
-              condition: service_started
-        ─────────────────────────────────────────
-      YML
-    end
-
-    def install_for_local
-      install_server
-      template_proc_files
-    end
-
-    def install_server
-      answer = SERVER_SOURCES.index(options[:source]) || 99
-
-      until SERVER_SOURCES[answer.to_i]
-        answer = ask "How do you want to install AnyCable-Go WebSocket server? (1) Homebrew, (2) Download binary, (0) Skip"
-      end
-
-      case answer.to_i
-      when 0
-        say_status :help, "⚠️  Please, read this guide on how to install AnyCable-Go server 👉 #{DOCS_ROOT}/anycable-go/getting_started", :yellow
-        return
-      else
-        return unless send("install_from_#{SERVER_SOURCES[answer.to_i]}")
-      end
-
-      say_status :info, "✅ AnyCable-Go WebSocket server has been successfully installed"
-    end
-
-    def template_proc_files
-      file_name = "Procfile.dev"
-
-      if file_exists?(file_name)
-        append_file file_name, "anycable: bundle exec anycable\nws: anycable-go#{anycable_go_options}", force: true
-      else
-        say_status :help, "💡 We recommend using Hivemind to manage multiple processes in development 👉 https://github.com/DarthSim/hivemind", :yellow
-
-        if options[:skip_procfile_dev].nil?
-          return unless yes? "Do you want to create a '#{file_name}' file?"
-        elsif options[:skip_procfile_dev]
-          return
-        end
-
-        template file_name
-      end
-    end
-
-    def install_from_brew
-      run "brew install anycable-go", abort_on_failure: true
-      run "anycable-go -v", abort_on_failure: true
-    end
-
-    def install_from_binary
-      bin_path ||= DEFAULT_BIN_PATH if options[:devenv] # User don't want interactive mode
-      bin_path ||= ask "Please, enter the path to download the AnyCable-Go binary to", default: DEFAULT_BIN_PATH, path: true
-
-      generate "anycable:download", download_options(bin_path: bin_path)
-
-      true
-    end
-
-    def download_options(**params)
-      opts = options.merge(params)
-      [].tap do |args|
-        args << "--os #{opts[:os]}" if opts[:os]
-        args << "--cpu #{opts[:cpu]}" if opts[:cpu]
-        args << "--bin-path=#{opts[:bin_path]}" if opts[:bin_path]
-        args << "--version #{opts[:version]}" if opts[:version]
-      end.join(" ")
-    end
-
-    def anycable_go_options
-      redis? ? " --port=8080" : " --port=8080 --broadcast_adapter=http"
-    end
-
-    def file_exists?(name)
-      in_root do
-        return File.file?(name)
-      end
-    end
-  end
-end

data/lib/generators/anycable/setup/templates/Procfile.dev.tt

@@ -1,6 +0,0 @@
-server: bundle exec rails s
-<%- if webpacker? -%>
-assets: bundle exec bin/webpack-dev-server
-<%- end -%>
-anycable: bundle exec anycable
-ws: anycable-go<%= anycable_go_options %>

data/lib/generators/anycable/setup/templates/config/anycable.yml.tt

@@ -1,48 +0,0 @@
-# This file contains per-environment settings for AnyCable.
-#
-# Since AnyCable config is based on anyway_config (https://github.com/palkan/anyway_config), all AnyCable settings
-# can be set or overridden through the corresponding environment variables.
-# E.g., `rpc_host` is overridden by ANYCABLE_RPC_HOST, `debug` by ANYCABLE_DEBUG etc.
-#
-# Note that AnyCable recognizes REDIS_URL env variable for Redis pub/sub adapter. If you want to
-# use another Redis instance for AnyCable, provide ANYCABLE_REDIS_URL variable.
-#
-# Read more about AnyCable configuration here: <%= DOCS_ROOT %>/ruby/configuration
-#
-default: &default
-  # Turn on/off access logs ("Started..." and "Finished...")
-  access_logs_disabled: false
-  # Whether to enable gRPC level logging or not
-  log_grpc: false
-  <%- if redis? -%>
-  # Use Redis to broadcast messages to AnyCable server
-  broadcast_adapter: redis
-  <%- elsif nats? -%>
-  # Use NATS to broadcast messages to AnyCable server
-  broadcast_adapter: nats
-  <%- else -%>
-  # Use HTTP adapter for a quick start (since redis gem is not present in the project)
-  broadcast_adapter: http
-  <%- end -%>
-  # Use the same channel name for WebSocket server, e.g.:
-  #   $ anycable-go --redis_channel="__anycable__"
-  redis_channel: "__anycable__"
-  <%- if redis? -%>
-  # You can use REDIS_URL env var to configure Redis URL.
-  # Localhost is used by default.
-  # redis_url: "redis://localhost:6379/1"
-  <%- end -%>
-
-development:
-  <<: *default
-
-test:
-  <<: *default
-
-production:
-  <<: *default
-  <%- if !redis? && !nats? -%>
-  # Use Redis or NATS in production
-  broadcast_adapter: redis
-  # broadcast_adapter: nats
-  <%- end -%>

data/lib/generators/anycable/setup/templates/config/cable.yml.tt

@@ -1,11 +0,0 @@
-# Make it possible to switch adapters by passing the ACTION_CABLE_ADAPTER env variable.
-# For example, you can use it fallback to the standard Action Cable in staging/review
-# environments (by setting `ACTION_CABLE_ADAPTER=redis`).
-development:
-  adapter: <%%= ENV.fetch("ACTION_CABLE_ADAPTER", "any_cable") %>
-
-test:
-  adapter: test
-
-production:
-  adapter: <%%= ENV.fetch("ACTION_CABLE_ADAPTER", "any_cable") %>

data/lib/generators/anycable/setup/templates/config/initializers/anycable.rb.tt

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# Add Warden middleware to AnyCable stack to allow accessing
-# Devise current user via `env["warden"].user`.
-#
-# See <%= DOCS_ROOT %>/ruby/authentication
-AnyCable::Rails::Rack.middleware.use Warden::Manager do |config|
-  Devise.warden_config = config
-end