anycable-rails-core 1.4.0

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

@@ -0,0 +1,300 @@
+# 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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,48 @@
+# 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

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,9 @@
+# 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

data/lib/generators/anycable/with_os_helpers.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module AnyCableRailsGenerators
+  module WithOSHelpers
+    OS_NAMES = %w[linux darwin freebsd win].freeze
+    CPU_NAMES = %w[amd64 arm64 386 arm].freeze
+    DEFAULT_BIN_PATH = "/usr/local/bin"
+
+    def self.included(base)
+      base.class_option :os,
+        type: :string,
+        desc: "Specify the OS for AnyCable-Go server binary (options: #{OS_NAMES.join(", ")})"
+      base.class_option :cpu,
+        type: :string,
+        desc: "Specify the CPU architecturefor AnyCable-Go server binary (options: #{CPU_NAMES.join(", ")})"
+
+      private :current_cpu, :supported_current_cpu, :supported_current_os
+    end
+
+    def current_cpu
+      case Gem::Platform.local.cpu
+      when "x86_64", "x64"
+        "amd64"
+      when "x86_32", "x86", "i386", "i486", "i686"
+        "i386"
+      when "aarch64", "aarch64_be", "arm64", /armv8/
+        "arm64"
+      when "arm", /armv7/, /armv6/
+        "arm"
+      else
+        "unknown"
+      end
+    end
+
+    def os_name
+      options[:os] ||
+        supported_current_os ||
+        ask("What is your OS name?", limited_to: OS_NAMES)
+    end
+
+    def cpu_name
+      options[:cpu] ||
+        supported_current_cpu ||
+        ask("What is your CPU architecture?", limited_to: CPU_NAMES)
+    end
+
+    def supported_current_cpu
+      CPU_NAMES.find(&current_cpu.method(:==))
+    end
+
+    def supported_current_os
+      OS_NAMES.find(&Gem::Platform.local.os.method(:==))
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: anycable-rails-core
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- palkan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anycable-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  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: AnyCable integration for Rails (w/o RPC dependencies)
+email:
+- dementiev.vm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- lib/action_cable/subscription_adapter/any_cable.rb
+- lib/action_cable/subscription_adapter/anycable.rb
+- lib/anycable-rails.rb
+- lib/anycable/rails.rb
+- lib/anycable/rails/action_cable_ext/channel.rb
+- lib/anycable/rails/action_cable_ext/connection.rb
+- lib/anycable/rails/action_cable_ext/remote_connections.rb
+- lib/anycable/rails/channel_state.rb
+- lib/anycable/rails/compatibility.rb
+- lib/anycable/rails/compatibility/rubocop.rb
+- lib/anycable/rails/compatibility/rubocop/config/default.yml
+- lib/anycable/rails/compatibility/rubocop/cops/anycable/instance_vars.rb
+- lib/anycable/rails/compatibility/rubocop/cops/anycable/periodical_timers.rb
+- lib/anycable/rails/compatibility/rubocop/cops/anycable/stream_from.rb
+- lib/anycable/rails/config.rb
+- lib/anycable/rails/connection.rb
+- lib/anycable/rails/connection_factory.rb
+- lib/anycable/rails/connections/persistent_session.rb
+- lib/anycable/rails/connections/serializable_identification.rb
+- lib/anycable/rails/connections/session_proxy.rb
+- lib/anycable/rails/middlewares/executor.rb
+- lib/anycable/rails/middlewares/log_tagging.rb
+- lib/anycable/rails/rack.rb
+- lib/anycable/rails/railtie.rb
+- lib/anycable/rails/version.rb
+- lib/generators/anycable/download/USAGE
+- lib/generators/anycable/download/download_generator.rb
+- lib/generators/anycable/setup/USAGE
+- lib/generators/anycable/setup/setup_generator.rb
+- lib/generators/anycable/setup/templates/Procfile.dev.tt
+- lib/generators/anycable/setup/templates/config/anycable.yml.tt
+- lib/generators/anycable/setup/templates/config/cable.yml.tt
+- lib/generators/anycable/setup/templates/config/initializers/anycable.rb.tt
+- lib/generators/anycable/with_os_helpers.rb
+homepage: http://github.com/anycable/anycable-rails
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: http://github.com/anycable/anycable-rails/issues
+  changelog_uri: https://github.com/anycable/anycable-rails/blob/master/CHANGELOG.md
+  documentation_uri: https://docs.anycable.io/#/using_with_rails
+  homepage_uri: https://anycable.io/
+  source_code_uri: http://github.com/anycable/anycable-rails
+  funding_uri: https://github.com/sponsors/anycable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.8
+signing_key:
+specification_version: 4
+summary: AnyCable integration for Rails (w/o RPC dependencies)
+test_files: []