mbeditor 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d378fdda8fc933a3c3d1f5b1fc5eb1622ca4ebee91db435378dd069827f708e2
-  data.tar.gz: 2c58b8db51c1df5e7f746af61550dc2ccf62ba33a515cb374c79931aefed1beb
+  metadata.gz: cf6000382b991d7d35aa850c38fc80c743089c60f4a2277310f552e5a3b85477
+  data.tar.gz: 4d9c42bc71a9db592172eb09a601b134628f3c7f4d619a271349dda9b675c5ac
 SHA512:
-  metadata.gz: 43753349cc14d328dbb45c4d6413cb0a56b9ac49979e7cd0bafe884de0889ede353decdd8552da38d872c278fa3c70162a1730df5827f45d0f629aa0d44a1f6f
-  data.tar.gz: 3547eec20751a3c7279765e79429dda30398dfd6aa64c7b70d7e2f70cda6e8de6d9ae8c30a0c671a9750dcce1422d115d2b42f1a3d35b6679e81d795ba134c3e
+  metadata.gz: 9e4b14f3d506a23c1f157a7dd91d4c522a568623fd555b3ef10e6e83e561b4bdcaf040b822ea1c2ec86ca1eed8f47992f7fa1060cb18a9600ee2f43b10de4730
+  data.tar.gz: '0911b0a22050d16d96a1e841ae16e73673fd0579549efd5590d538efe405ca66e7f1470597680e0102954b4d4ce6ef9337d02a22dc736c487998f990808ff34f'

data/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.3] - 2026-04-22
+
+### Added
+- Documented optional Action Cable host-app setup and fallback behavior for realtime editor updates.
+
+### Changed
+- `bundle exec rake test` now includes `test/lib/**/*_test.rb` so release validation covers library-level regression tests.
+
+### Fixed
+- Action Cable availability detection now respects whether `/cable` is actually mounted, and websocket handshake failures fall back to polling without noisy console errors.
+- Circular loading indicators keep animating even when global reduced-motion styles are active in production.
+- `CableLogFilter` now remains compatible with untagged logger stacks used outside full Action Cable setups.
+
 ## [0.4.2] - 2026-04-22
 
 ### Fixed

data/README.md

@@ -121,9 +121,27 @@ The gem keeps host/tooling responsibilities in the host app:
 - `haml_lint` gem (optional, required for HAML lint — add to your app's Gemfile if needed)
 - `git` installed in environment (for Git panel data)
 - `minitest` or `rspec` in the host app's bundle (required for the test runner)
+- `actioncable` framework/gem (optional, required only for realtime file-change push + websocket state saves)
 
 All lint and test tools are auto-detected at runtime. The engine gracefully disables features if the tools are not available. Neither `rubocop`, `haml_lint`, nor any test framework are runtime dependencies of the gem itself — they are discovered from the host app's environment.
 
+### Realtime via Action Cable (Optional)
+
+Mbeditor works without Action Cable. If Action Cable is unavailable, unreachable, or returns transient errors, the editor automatically falls back to polling.
+
+To enable realtime features in a host app:
+
+1. Ensure Action Cable is enabled in the host app (for apps that do not load it by default, add the framework/gem explicitly).
+2. Mount cable in host routes:
+
+```ruby
+mount ActionCable.server => '/cable'
+```
+
+3. Make Action Cable JavaScript available to the page (for asset-pipeline apps, `actioncable.js` is typically sufficient).
+
+If any of these are missing, mbeditor still runs in polling mode.
+
 ### Syntax Highlighting Support
 Monaco runtime assets are served from the engine route namespace (`/mbeditor/monaco-editor/*` and `/mbeditor/monaco_worker.js`).
 The gem includes syntax highlighting for common Rails and React development file types:

data/app/assets/javascripts/mbeditor/websocket_service.js

@@ -11,6 +11,10 @@ var WebSocketService = (function () {
   var _subscription = null;
   var _connected = false;
   var _filesChangedCallbacks = [];
+  var _serverSupportsWs = false;
+  var _reconnectTimer = null;
+  var _lastCableAttemptAt = 0;
+  var RECONNECT_INTERVAL_MS = 30000;
 
   // ---------------------------------------------------------------------------
   // Internal helpers
@@ -20,33 +24,78 @@ var WebSocketService = (function () {
     return typeof window.ActionCable !== 'undefined';
   }
 
+  function _cableUrl() {
+    return window.MBEDITOR_CABLE_URL || '/cable';
+  }
+
   function _getConsumer() {
     // Reuse an existing consumer the host app may have already created (App.cable
     // is the Rails default).  Fall back to creating our own.
     if (typeof window.App !== 'undefined' && window.App.cable) {
       return window.App.cable;
     }
-    var cableUrl = window.MBEDITOR_CABLE_URL || '/cable';
-    return window.ActionCable.createConsumer(cableUrl);
+    return window.ActionCable.createConsumer(_cableUrl());
   }
 
-  function _emitFilesChanged(data) {
-    _filesChangedCallbacks.forEach(function (fn) {
-      try { fn(data); } catch (e) { /* ignore */ }
+  function _cleanupConsumer() {
+    if (_subscription) {
+      try { _subscription.unsubscribe(); } catch (e) { /* ignore */ }
+      _subscription = null;
+    }
+    if (_consumer && typeof _consumer.disconnect === 'function') {
+      try { _consumer.disconnect(); } catch (e) { /* ignore */ }
+    }
+    _consumer = null;
+    _connected = false;
+  }
+
+  function _isCableRelatedRejection(reason) {
+    var url = _cableUrl();
+    if (!reason) return false;
+
+    // Common browser shape: ErrorEvent with target/currentTarget = WebSocket.
+    var target = reason.target || reason.currentTarget;
+    if (target && typeof target.url === 'string' && target.url.indexOf(url) !== -1) {
+      return true;
+    }
+
+    // Some environments stringify this as "[object Event]"; only suppress if
+    // it happened right after a cable connection attempt.
+    var ageMs = Date.now() - _lastCableAttemptAt;
+    var reasonText = String(reason);
+    if (reasonText.indexOf('[object Event]') !== -1 && ageMs >= 0 && ageMs < 3000) {
+      return true;
+    }
+
+    return false;
+  }
+
+  function _installUnhandledRejectionGuard() {
+    if (window.__mbeditorCableRejectionGuardInstalled) return;
+    window.__mbeditorCableRejectionGuardInstalled = true;
+    window.addEventListener('unhandledrejection', function (event) {
+      if (_isCableRelatedRejection(event.reason)) {
+        // Keep cable handshake failures internal; polling fallback remains active.
+        event.preventDefault();
+      }
     });
   }
 
-  // ---------------------------------------------------------------------------
-  // Public API
-  // ---------------------------------------------------------------------------
+  function _scheduleReconnect() {
+    if (_reconnectTimer || !_serverSupportsWs) return;
+    _reconnectTimer = setTimeout(function () {
+      _reconnectTimer = null;
+      _attemptConnect();
+    }, RECONNECT_INTERVAL_MS);
+  }
 
-  // Call once after the workspace response is received.
-  // serverSupportsWs: boolean from workspace.actionCableEnabled
-  function connect(serverSupportsWs) {
-    if (!serverSupportsWs || !_isActionCableAvailable()) {
-      return; // polling remains the only refresh mechanism
+  function _attemptConnect() {
+    if (!_serverSupportsWs || !_isActionCableAvailable() || _connected || _subscription) {
+      return;
     }
 
+    _lastCableAttemptAt = Date.now();
+
     try {
       _consumer = _getConsumer();
       _subscription = _consumer.subscriptions.create(
@@ -56,15 +105,12 @@ var WebSocketService = (function () {
             _connected = true;
           },
           disconnected: function () {
-            _connected = false;
+            _cleanupConsumer();
+            _scheduleReconnect();
           },
           rejected: function () {
-            _connected = false;
-            // Channel was rejected — unsubscribe so we stop trying.
-            if (_subscription) {
-              _subscription.unsubscribe();
-              _subscription = null;
-            }
+            _cleanupConsumer();
+            _scheduleReconnect();
           },
           received: function (data) {
             if (data && data.type === 'files_changed') {
@@ -74,18 +120,41 @@ var WebSocketService = (function () {
         }
       );
     } catch (e) {
-      // Any setup error means we silently stay in polling-only mode.
-      _connected = false;
-      _subscription = null;
+      // Any setup error means we silently stay in polling-only mode for now.
+      _cleanupConsumer();
+      _scheduleReconnect();
+    }
+  }
+
+  function _emitFilesChanged(data) {
+    _filesChangedCallbacks.forEach(function (fn) {
+      try { fn(data); } catch (e) { /* ignore */ }
+    });
+  }
+
+  // ---------------------------------------------------------------------------
+  // Public API
+  // ---------------------------------------------------------------------------
+
+  // Call once after the workspace response is received.
+  // serverSupportsWs: boolean from workspace.actionCableEnabled
+  function connect(serverSupportsWs) {
+    _serverSupportsWs = !!serverSupportsWs;
+    if (!_serverSupportsWs || !_isActionCableAvailable()) {
+      return; // polling remains the only refresh mechanism
     }
+    _installUnhandledRejectionGuard();
+    _attemptConnect();
+    _scheduleReconnect();
   }
 
   function disconnect() {
-    if (_subscription) {
-      _subscription.unsubscribe();
-      _subscription = null;
+    _serverSupportsWs = false;
+    if (_reconnectTimer) {
+      clearTimeout(_reconnectTimer);
+      _reconnectTimer = null;
     }
-    _connected = false;
+    _cleanupConsumer();
   }
 
   // Returns true only when the WebSocket is currently live.

data/app/assets/stylesheets/mbeditor/application.css

@@ -841,4 +841,23 @@
 @keyframes mbeditor-spin {
   to { transform: rotate(360deg); }
 }
+
+@media (prefers-reduced-motion: reduce) {
+  .mbeditor-spinner,
+  .editor-loading-spinner,
+  .search-loading-spinner {
+    animation-duration: 0.75s !important;
+    animation-delay: 0s !important;
+    animation-iteration-count: infinite !important;
+  }
+
+  .editor-loading-spinner {
+    animation-duration: 0.65s !important;
+  }
+
+  .search-loading-spinner {
+    animation-duration: 0.7s !important;
+  }
+}
+
 .cdiff-ctx  { color: var(--ide-text-muted); }

data/app/channels/mbeditor/editor_channel.rb

@@ -4,12 +4,14 @@ require "fileutils"
 require "pathname"
 
 module Mbeditor
-  class EditorChannel < ActionCable::Channel::Base
+  CableBaseClass = defined?(ActionCable::Channel::Base) ? ActionCable::Channel::Base : Object
+
+  class EditorChannel < CableBaseClass
     STATE_MAX_BYTES    = 1 * 1024 * 1024
     SAFE_BRANCH_NAME   = /\A[a-zA-Z0-9._\-\/]+\z/
 
     def subscribed
-      stream_from "mbeditor_editor"
+      stream_from "mbeditor_editor" if respond_to?(:stream_from)
     end
 
     def unsubscribed

data/app/controllers/mbeditor/editors_controller.rb

@@ -39,7 +39,7 @@ module Mbeditor
         blameAvailable: git_blame_available?,
         redmineEnabled: Mbeditor.configuration.redmine_enabled == true,
         testAvailable: test_available?,
-        actionCableEnabled: defined?(ActionCable::Channel::Base) ? true : false
+        actionCableEnabled: action_cable_enabled?
       }
     end
 
@@ -691,6 +691,23 @@ module Mbeditor
       str.match?(SAFE_BRANCH_NAME) ? str : nil
     end
 
+    def action_cable_enabled?
+      return false unless defined?(ActionCable::Channel::Base)
+
+      mount_path = begin
+        ActionCable.server.config.mount_path
+      rescue StandardError
+        nil
+      end
+      mount_path = '/cable' if mount_path.blank?
+
+      Rails.application.routes.routes.any? do |route|
+        route.path.spec.to_s.start_with?(mount_path)
+      end
+    rescue StandardError
+      false
+    end
+
     def allow_missing_file?
       %w[1 true yes on].include?(params[:allow_missing].to_s.downcase)
     end

data/lib/mbeditor/cable_log_filter.rb

@@ -19,10 +19,38 @@ module Mbeditor
     # Tagged-logging compat — the block body still passes through the filter.
     def tagged(*tags, &block)
       if __getobj__.respond_to?(:tagged)
-        __getobj__.tagged(*tags) { block.call }
-      else
+        __getobj__.tagged(*tags, &block)
+      elsif block
         block.call
+      else
+        self
       end
     end
+
+    # Rails/ActiveSupport logger compatibility. Some logger stacks call these
+    # methods even when the underlying logger is not TaggedLogging.
+    def current_tags
+      return __getobj__.current_tags if __getobj__.respond_to?(:current_tags)
+
+      []
+    end
+
+    def push_tags(*tags)
+      return __getobj__.push_tags(*tags) if __getobj__.respond_to?(:push_tags)
+
+      tags
+    end
+
+    def pop_tags(count = 1)
+      return __getobj__.pop_tags(count) if __getobj__.respond_to?(:pop_tags)
+
+      []
+    end
+
+    def clear_tags!
+      return __getobj__.clear_tags! if __getobj__.respond_to?(:clear_tags!)
+
+      nil
+    end
   end
 end

data/lib/mbeditor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mbeditor
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mbeditor
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Oliver Noonan