anycable-rails 1.0.0.preview2 → 1.0.0

data/lib/generators/anycable/setup/USAGE

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

data/lib/{rails/generators → generators}/anycable/setup/setup_generator.rb

@@ -1,34 +1,23 @@
 # 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__)
 
-    METHODS = %w[skip local docker].freeze
-    # TODO(release): change to latest release
-    SERVER_VERSION = "v1.0.0.preview1"
-    OS_NAMES = %w[linux darwin freebsd win].freeze
-    CPU_NAMES = %w[amd64 arm64 386 arm].freeze
+    DOCS_ROOT = "https://docs.anycable.io/v1/#"
+    DEVELOPMENT_METHODS = %w[skip local docker].freeze
     SERVER_SOURCES = %w[skip brew binary].freeze
-    DEFAULT_BIN_PATH = "/usr/local/bin"
 
-    class_option :method,
+    class_option :devenv,
       type: :string,
-      desc: "Select your development environment (options: #{METHODS.join(", ")})"
+      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 :bin_path,
-      type: :string,
-      desc: "Where to download AnyCable-Go server binary (default: #{DEFAULT_BIN_PATH})"
-    class_option :os,
-      type: :string,
-      desc: "Specify the OS for AnyCable-Go server binary (options: #{OS_NAMES.join(", ")})"
-    class_option :cpu,
-      type: :string,
-      desc: "Specify the CPU architecturefor AnyCable-Go server binary (options: #{CPU_NAMES.join(", ")})"
     class_option :skip_heroku,
       type: :boolean,
       desc: "Do not copy Heroku configs"
@@ -36,6 +25,15 @@ module AnyCableRailsGenerators
       type: :boolean,
       desc: "Do not create Procfile.dev"
 
+    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
@@ -51,32 +49,36 @@ module AnyCableRailsGenerators
       environment(nil, env: :development) do
         <<~SNIPPET
           # Specify AnyCable WebSocket server URL to use by JS client
-          config.action_cable.url = ENV.fetch("CABLE_URL", "ws://localhost:3334/cable").presence
+          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.action_cable.url = ENV["CABLE_URL"].presence
+          config.after_initialize do
+            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL") 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 " \
+      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 = METHODS.index(options[:method]) || 99
+      answer = DEVELOPMENT_METHODS.index(options[:devenv]) || 99
 
-      until METHODS[answer.to_i]
+      until DEVELOPMENT_METHODS[answer.to_i]
         answer = ask "Which environment do you use for development? (1) Local, (2) Docker, (0) Skip"
       end
 
-      case env = METHODS[answer.to_i]
+      case env = DEVELOPMENT_METHODS[answer.to_i]
       when "skip"
-        say_status :help, "⚠️ Please, read this guide on how to install AnyCable-Go server 👉 https://docs.anycable.io/#/anycable-go/getting_started", :yellow
+        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
@@ -84,15 +86,21 @@ module AnyCableRailsGenerators
 
     def heroku
       if options[:skip_heroku].nil?
-        return unless yes? "Do you use Heroku for deployment?"
+        return unless yes? "Do you use Heroku for deployment? [Yn]"
       elsif options[:skip_heroku]
         return
       end
 
-      template "Procfile"
-      inside("bin") { template "heroku-web" }
+      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 👉 https://docs.anycable.io/#/deployment/heroku", :yellow
+      say_status :help, "️️⚠️  Please, read the required steps to configure Heroku applications 👉 #{DOCS_ROOT}/deployment/heroku", :yellow
     end
 
     def devise
@@ -107,6 +115,20 @@ module AnyCableRailsGenerators
       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: https://docs.anycable.io/v1/#/ruby/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 https://docs.anycable.io/v1/#/ruby/compatibility" unless res
+    end
+
     def finish
       say_status :info, "✅ AnyCable has been configured successfully!"
     end
@@ -114,7 +136,19 @@ module AnyCableRailsGenerators
     private
 
     def stimulus_reflex?
-      !gemfile_lock&.match?(/^\s+stimulus_reflex\b/).nil?
+      !!gemfile_lock&.match?(/^\s+stimulus_reflex\b/)
+    end
+
+    def redis?
+      !!gemfile_lock&.match?(/^\s+redis\b/)
+    end
+
+    def webpacker?
+      !!gemfile_lock&.match?(/^\s+webpacker\b/)
+    end
+
+    def rubocop?
+      !!gemfile_lock&.match?(/^\s+rubocop\b/)
     end
 
     def gemfile_lock
@@ -129,32 +163,41 @@ module AnyCableRailsGenerators
     end
 
     def install_for_docker
-      say_status :help, "️️⚠️ Docker development configuration could vary", :yellow
+      # 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
         ─────────────────────────────────────────
-        anycable-ws:
-          image: anycable/anycable-go:v0.6.4
+        ws:
+          image: anycable/anycable-go:1.0
           ports:
-            - '3334:3334'
+            - '8080:8080'
           environment:
-            PORT: 3334
+            ANYCABLE_HOST: "0.0.0.0"
             ANYCABLE_REDIS_URL: redis://redis:6379/0
-            ANYCABLE_RPC_HOST: anycable-rpc:50051
+            ANYCABLE_RPC_HOST: anycable:50051
+            ANYCABLE_DEBUG: 1
           depends_on:
-            - anycable-rpc
-            - redis
+            redis:
+              condition: service_healthy
 
-        anycable-rpc:
+        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
@@ -173,7 +216,7 @@ module AnyCableRailsGenerators
 
       case answer.to_i
       when 0
-        say_status :help, "⚠️ Please, read this guide on how to install AnyCable-Go server 👉 https://docs.anycable.io/#/anycable-go/getting_started", :yellow
+        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]}")
@@ -185,8 +228,8 @@ module AnyCableRailsGenerators
     def template_proc_files
       file_name = "Procfile.dev"
 
-      if File.exist?(file_name)
-        append_file file_name, 'anycable: bundle exec anycable --server-command "anycable-go --port 3334"'
+      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
 
@@ -206,62 +249,31 @@ module AnyCableRailsGenerators
     end
 
     def install_from_binary
-      out = options[:bin_path] if options[:bin_path]
-      out ||= "/usr/local/bin" if options[:method] # User don't want interactive mode
-      out ||= ask "Please, enter the path to download the AnyCable-Go binary to", default: DEFAULT_BIN_PATH, path: true
-
-      os_name = options[:os] ||
-        OS_NAMES.find(&Gem::Platform.local.os.method(:==)) ||
-        ask("What is your OS name?", limited_to: OS_NAMES)
-
-      cpu_name = options[:cpu] ||
-        CPU_NAMES.find(&current_cpu.method(:==)) ||
-        ask("What is your CPU architecture?", limited_to: CPU_NAMES)
+      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
 
-      download_exe(
-        "https://github.com/anycable/anycable-go/releases/download/#{SERVER_VERSION}/" \
-        "anycable-go-#{os_name}-#{cpu_name}",
-        to: out,
-        file_name: "anycable-go"
-      )
+      generate "anycable:download", download_options(bin_path: bin_path)
 
       true
     end
 
-    def download_exe(url, to:, file_name:)
-      file_path = File.join(to, file_name)
-
-      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
+    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 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
+    def anycable_go_options
+      redis? ? " --port=8080" : " --port=8080 --broadcast_adapter=http"
     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", /armv8/
-        "arm64"
-      when "arm", /armv7/, /armv6/
-        "arm"
-      else
-        "unknown"
+    def file_exists?(name)
+      in_root do
+        return File.file?(name)
       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/{rails/generators → generators}/anycable/setup/templates/config/anycable.yml.tt

@@ -7,26 +7,44 @@
 # 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: https://docs.anycable.io/#/ruby/configuration
+# Read more about AnyCable configuration here: <%= DOCS_ROOT %>/ruby/configuration
 #
 default: &default
   # Turn on/off access logs ("Started..." and "Finished...")
   access_logs_disabled: false
-  # Persist "dirty" session between RPC calls (might be required for StimulusReflex apps)
-  persistent_session_enabled: <%= stimulus_reflex? %>
+  # Persist "dirty" session between RPC calls (might be required for apps using stimulus_reflex <3.0)
+  # persistent_session_enabled: true
   # This is the host and the port to run AnyCable RPC server on.
   # You must configure your WebSocket server to connect to it, e.g.:
   #   $ anycable-go --rpc-host="<rpc hostname>:50051"
   rpc_host: "127.0.0.1:50051"
   # Whether to enable gRPC level logging or not
   log_grpc: false
+  <%- if redis? -%>
+  # Use Redis to broadcast messages to AnyCable server
+  broadcast_adapter: redis
+  <%- 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
-  redis_url: "redis://localhost:6379/1"
+
+test:
+  <<: *default
 
 production:
   <<: *default
+  <%- if !redis? -%>
+  # Use Redis in production
+  broadcast_adapter: redis
+  <%- 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/{rails/generators/anycable/setup/templates/config/initializers/anycable.rb → generators/anycable/setup/templates/config/initializers/anycable.rb.tt}

@@ -3,7 +3,7 @@
 # Add Warden middkeware to AnyCable stack to allow accessing
 # Devise current user via `env["warden"].user`.
 #
-# See http://docs.anycable.io/#/ruby/authentication
+# 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", /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