anycable-rails-core 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bc0b1eac8c453d0054d508826fd33e58b32684c89694fbbc393d2796db8f0c1
-  data.tar.gz: 82ff10fabf21471a9fdcc14e6d76d294902b89372002734538b66e1e7569ab1d
+  metadata.gz: d59e7b74ab037c4e2dfdf18b5fb289fad3f7eac9d1a08df798f656ed35dda95c
+  data.tar.gz: a1304fbd9db3f26c92ef5008b196135a2f09a5922bde5137d7e604e652250354
 SHA512:
-  metadata.gz: 53cda30136d94edc95e319a0e80bed3ce19716d15dd0e69eae0fc14ffb0c45d58ec0fb466bece171736f4821a7aeeba6ec774c228e8915deb7b2eea01fed1565
-  data.tar.gz: 2787f8c23179f2283fe9b68982f0e3f0ea8fde5222ef97dba7294464523d8968f57f1c71f166f0d44583047747bbd40433e7603afb07c45f3b58eac98bba3cf4
+  metadata.gz: 8a7eebcf805f8c72c300b734fe52a7ce952b60527b8644f004ca7bb3414cc04da49b8ee2ce36d84f6f7d8bf0438450dfdffb019610b091894c3dcf7e65ec4897
+  data.tar.gz: 488065254235777ef04b781ef98f1c20c8c12f2f6c268c6044fb683e4a9774f1ae5abbdcbec53199065e57ec8df1df15d13f85c152471a5a54ceb23e6ddbd832

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master
 
+## 1.4.1 (2023-09-27)
+
+- Fix compatibility with Rails 7.1. ([@palkan][])
+
+- Upgrade `anycable:setup` generator to support v1.4 features. ([@palkan][])
+
+Add `bin/anycable-go` to use `anycable-go` locally. Add `--rpc=http` to configure for using AnyCable with HTTP RPC.
+
 ## 1.4.0 (2023-07-07)
 
 - Add HTTP RPC integration. ([@palkan][])

data/lib/anycable/rails/railtie.rb

@@ -21,15 +21,23 @@ module AnyCable
 
         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))
+
+            # Rails 7.1+
+            if defined?(ActiveSupport::BroadcastLogger)
+              AnyCable.logger = ActiveSupport::BroadcastLogger.new(AnyCable.logger, console)
+            else
+              AnyCable.logger.extend(ActiveSupport::Logger.broadcast(console))
+            end
           end
+
+          AnyCable.logger = ActiveSupport::TaggedLogging.new(AnyCable.logger) if server_logger.is_a?(::Logger)
         end
 
         # Add tagging middleware

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.4.0"
+    VERSION = "1.4.1"
   end
 end

data/lib/generators/anycable/setup/USAGE

@@ -1,2 +1,11 @@
 Description:
     Configures your application to work with AnyCable interactively.
+
+Example:
+    rails generate anycable:setup
+
+    # You can opt-in to use HTTP RPC
+    rails generate anycable:setup --rpc=http
+
+    # You can specify which version of anycable-go to use
+    rails generate anycable:setup --version=1.4

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

@@ -10,14 +10,15 @@ module AnyCableRailsGenerators
 
     DOCS_ROOT = "https://docs.anycable.io"
     DEVELOPMENT_METHODS = %w[skip local docker].freeze
-    SERVER_SOURCES = %w[skip brew binary].freeze
+    RPC_IMPL = %w[grpc http].freeze
 
     class_option :devenv,
       type: :string,
       desc: "Select your development environment (options: #{DEVELOPMENT_METHODS.join(", ")})"
-    class_option :source,
+    class_option :rpc,
       type: :string,
-      desc: "Choose a way of installing AnyCable-Go server (options: #{SERVER_SOURCES.join(", ")})"
+      desc: "Select RPC implementation (options: #{RPC_IMPL.join(", ")})",
+      default: "grpc"
     class_option :skip_heroku,
       type: :boolean,
       desc: "Do not copy Heroku configs"
@@ -30,12 +31,6 @@ module AnyCableRailsGenerators
     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)"
@@ -99,6 +94,7 @@ module AnyCableRailsGenerators
 
       in_root do
         next unless File.file?("Procfile")
+        next if http_rpc?
 
         contents = File.read("Procfile")
         contents.sub!(/^web: (.*)$/, %q(web: [[ "$ANYCABLE_DEPLOYMENT" == "true" ]] && bundle exec anycable --server-command="anycable-go" || \1))
@@ -171,6 +167,10 @@ module AnyCableRailsGenerators
       !!gemfile_lock&.match?(/^\s+rubocop\b/)
     end
 
+    def http_rpc?
+      options[:rpc] == "http"
+    end
+
     def gemfile_lock
       @gemfile_lock ||= begin
         res = nil
@@ -192,7 +192,7 @@ module AnyCableRailsGenerators
       say <<~YML
         ─────────────────────────────────────────
         ws:
-          image: anycable/anycable-go:1.2
+          image: anycable/anycable-go:1.4
           ports:
             - '8080:8080'
           environment:
@@ -223,33 +223,25 @@ module AnyCableRailsGenerators
     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"
+      inside("bin") do
+        template "anycable-go", chmod: 0o755
       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]}")
+      if file_exists?(".gitignore")
+        append_file ".gitignore", "bin/dist\n"
       end
 
-      say_status :info, "✅ AnyCable-Go WebSocket server has been successfully installed"
+      template_proc_files
     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
+        unless http_rpc?
+          append_file file_name, "anycable: bundle exec anycable\n", force: true
+        end
+        append_file file_name, "ws: bin/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
 
@@ -263,32 +255,11 @@ module AnyCableRailsGenerators
       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"
+      opts = ["--port=8080"]
+      opts << "--broadcast_adapter=http" unless redis?
+      opts << "--rpc_impl=http --rpc_host=http://localhost:3000/_anycable" if http_rpc?
+      opts.join(" ")
     end
 
     def file_exists?(name)
@@ -296,5 +267,18 @@ module AnyCableRailsGenerators
         return File.file?(name)
       end
     end
+
+    def anycable_go_version
+      @anycable_go_version ||= (normalize_version(options[:version]) || "latest")
+    end
+
+    def normalize_version(version)
+      return unless version
+
+      # We need a full version for bin/anycable-go script
+      segments = Gem::Version.new(version).segments
+      segments << 0 until segments.size >= 3
+      segments.join(".")
+    end
   end
 end

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

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

data/lib/generators/anycable/setup/templates/bin/anycable-go.tt

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+cd $(dirname $0)/..
+
+# It's recommended to use the exact version of AnyCable-Go here
+version="<%= anycable_go_version %>"
+
+if [ ! -f ./bin/dist/anycable-go ]; then
+  echo "AnyCable-go is not installed, downloading..."
+  ./bin/rails g anycable:download --version=$version --bin-path=./bin/dist
+fi
+
+curVersion=$(./bin/dist/anycable-go -v)
+
+if [[ "$version" != "latest" ]]; then
+  if [[ "$curVersion" != "$version"* ]]; then
+    echo "AnyCable-go version is not $version, downloading a new one..."
+    ./bin/rails g anycable:download --version=$version --bin-path=./bin/dist
+  fi
+fi
+
+./bin/dist/anycable-go $@

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

@@ -32,6 +32,9 @@ default: &default
   # Localhost is used by default.
   # redis_url: "redis://localhost:6379/1"
   <%- end -%>
+  <%- if http_rpc? -%>
+  http_rpc_mount_path: "/_anycable"
+  <%- end -%>
 
 development:
   <<: *default
@@ -41,8 +44,3 @@ test:
 
 production:
   <<: *default
-  <%- if !redis? && !nats? -%>
-  # Use Redis or NATS in production
-  broadcast_adapter: redis
-  # broadcast_adapter: nats
-  <%- end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails-core
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2023-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable-core
@@ -92,6 +92,7 @@ files:
 - 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/bin/anycable-go.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