mbeditor 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fe258515a6f0945da8bfcbfbe85197262af224c054924367597d97d370530e2
-  data.tar.gz: d3f65b3c351fef56291170d9401103d9b73d4b3a7ebad24885713b8deef5df85
+  metadata.gz: 47a8199a082957d396dce3cfa9de010ece11a11b2b938cf0cf81adfa6dd171f1
+  data.tar.gz: 30dfee949bc6d06245c6bd1ba5b682431b36b064e0ad510b0dac44b320c5a287
 SHA512:
-  metadata.gz: 4de0d8f9374a370f4df1339166ff648013dafb07b23eeba6936f3ebf1d492c831905d7143d5ece2ece4e397f4f4b314b7461e496cec00003c507db5701347604
-  data.tar.gz: 17c4ef992175fc0a5fd8f18102214ac46cce75963ba7d06661f3ffac66eb7e7d55e69bef6c6f71e3ddb9999839c78fd9a2668abb99397442ac7bfb68da6ee561
+  metadata.gz: 81c342ce0dc3f80c44259ae3a130710013dcb81f45052d4cc4488d2a7dc112f7decc6b5d67f3f6aaa81cbcd7ef391d82136ee1adccdd369b369c7cfcd4d6afa7
+  data.tar.gz: b201dda9b9fe55e9f44981725788b1587bc052f940652e8eb7d86a8dcc3d17c45bb0984f71cd3bbbd9f3a001b3b0125ac09a9e53eedd3e580eab96a445be6a17

data/CHANGELOG.md

@@ -5,6 +5,43 @@ 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.10.1] - 2026-07-27
+
+### Removed
+- **The `listen`-based file watcher, and with it `config.watch_files`.**
+  0.10.0 enabled a workspace watcher by default. On Linux each watched
+  directory costs an inotify watch from `fs.inotify.max_user_watches`, a
+  *per-user* budget shared with everything else watching files — including the
+  host app's own code reloader and any other gem using `listen`. Exhausting it
+  raises `iNotify max watches exceeded`, and because `listen` reports some of
+  those failures from its own background thread, mbeditor could not even
+  rescue them. Claiming a share of a scarce OS resource by default was the
+  wrong trade for a development tool, and raising the limit needs root, which
+  a developer may not have.
+
+  Nothing is lost: external changes are picked up by polling, which is how the
+  editor already tracked git state. If you set `config.watch_files`, remove it
+  — it is now ignored.
+
+### Fixed
+- **The file tree never refreshed for changes made outside the editor.** Its
+  10-second poll returned early whenever the Action Cable socket was connected,
+  on the reasoning that the push covered it — but the server only broadcasts
+  from mbeditor's own mutation endpoints. With a socket connected, which is the
+  normal case, an external `git checkout` or generator run was never picked up.
+  The poll now always runs; the push remains the instant path for our own
+  writes. This is the bug the 0.10.0 watcher was compensating for.
+- **Git line-number tinting went stale for external changes**, for the same
+  reason, and its refresh timer was being cleared and recreated on every
+  re-render so it never survived long enough to fire. It now polls on its own
+  timer and on window focus, matching the file tree.
+- **Watched paths were dropped when the workspace was reached through a
+  symlink** (macOS `/var` → `/private/var`, or a symlinked checkout), because
+  reported paths resolve to the real path and no longer matched the configured
+  root.
+
+---
+
 ## [0.10.0] - 2026-07-27
 
 ### Added

data/README.md

@@ -16,7 +16,6 @@ Mbeditor (Mini Browser Editor) is a mountable Rails engine that adds a browser-b
 - Optional RuboCop lint and format endpoints (uses host app RuboCop)
 - Optional Ruby language-server integration (definitions, hover, completion, diagnostics)
 - Optional test runner with inline failure markers and a dedicated results panel (Minitest and RSpec)
-- Optional workspace file watching, so changes made outside the editor refresh the tree and git decorations
 
 ## Security Warning
 Mbeditor exposes read and write access to your Rails application directory over HTTP. It is intended only for local development.
@@ -101,7 +100,6 @@ end
 | `ruby_lsp` | `:auto` | Use the host's [ruby-lsp](https://github.com/Shopify/ruby-lsp) for Ruby go-to-definition, hover, completion, and diagnostics when it's installed (a persistent process is managed per workspace). `false` disables. Without ruby-lsp everything degrades to the built-in grep/Ripper services — no behavior change. |
 | `ruby_lsp_command` | `nil` | Override the ruby-lsp launch command (String or Array). `nil` auto-resolves `bin/ruby-lsp` → installed gem → `bundle exec ruby-lsp`. |
 | `ruby_lsp_timeout` | `3` | Seconds per LSP request; on timeout (e.g. during initial indexing) the editor falls back to the built-in services for that request. |
-| `watch_files` | `:auto` | Watch the workspace for changes made outside the editor (a terminal `git checkout`, a generator, another editor) and push a refresh to open clients. Requires the host's [`listen`](https://github.com/guard/listen) gem; without it the editor behaves as before and only announces its own writes. `false` disables. |
 
 ### Authentication
 
@@ -205,113 +203,9 @@ The gem keeps host/tooling responsibilities in the host app:
 - `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)
 - `ruby-lsp` gem (optional — see below)
-- `listen` gem (optional — see below)
 
 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.
 
-### Workspace file watching (Optional)
-
-Add [`listen`](https://github.com/guard/listen) to the host app's development
-group and mbeditor watches the workspace for changes it did not make itself:
-
-```ruby
-group :development do
-  gem 'listen'
-end
-```
-
-Without it, only writes made *through* the editor announce themselves, so a
-`git checkout` or a generator run in a terminal leaves the file tree and the
-git line-number colours stale until you reopen the file. With it, those refresh
-on their own.
-
-The watcher runs only in `allowed_environments` and only in processes that
-serve requests, so rake tasks and consoles never start one. It respects
-`excluded_paths`, coalesces bursts (a branch switch is one refresh, not
-hundreds), and requires Action Cable to actually deliver the push. If it cannot
-start — inotify limits, permissions — it logs a warning and the editor carries
-on exactly as it would without the gem. Set `config.watch_files = false` to
-disable it even when `listen` is present.
-
-### Ruby language server (Optional)
-
-Add [ruby-lsp](https://github.com/Shopify/ruby-lsp) to the host app's
-development group and mbeditor uses it automatically for Ruby
-go-to-definition, hover, completion, and diagnostics:
-
-```ruby
-gem "ruby-lsp", require: false, group: :development
-gem "ruby-lsp-rails", require: false, group: :development  # Rails-aware results
-```
-
-`ruby-lsp-rails` needs no mbeditor configuration — ruby-lsp loads it as an
-addon, so associations, model attributes, and route helpers start resolving on
-their own.
-
-What changes when it's present:
-
-- **Diagnostics.** Ruby files are checked by ruby-lsp instead of booting
-  RuboCop over HTTP on every debounce, so you also get Prism syntax errors and
-  warnings alongside RuboCop offenses. Quick-fix lightbulbs still work for
-  correctable cops. Very large files fall back to syntax-only diagnostics.
-- **Definitions, hover, completion.** Answered from the language server's index
-  rather than a workspace grep, including your unsaved buffer contents.
-
-Everything degrades on its own: if ruby-lsp is missing, times out (its first
-index of a large app takes a while), or crashes, that request falls back to the
-built-in grep/Ripper services. ERB templates always use the built-in services —
-ruby-lsp cannot parse ERB.
-
-### 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:
-
-**Web & Template Languages:**
-- **Ruby** (.rb, Gemfile, gemspec, Rakefile)
-- **HTML** 
-- **ERB** (.html.erb, .erb) — dedicated ERB grammar, plus Ruby intellisense
-  inside `<% %>` tags: hover, completion, go-to-definition (Ctrl/Cmd+click or
-  F12) and auto-`end`, all inert in the surrounding HTML. ERB uses the built-in
-  workspace services rather than ruby-lsp, which cannot parse ERB.
-- **HAML** (.haml) — plaintext syntax highlighting (no dedicated HAML grammar in Monaco; haml-lint provides inline error markers when available)
-- **CSS** and **SCSS** stylesheets
-
-**JavaScript & React:**
-- **JavaScript / JSX** (.js, .jsx, .js.jsx) — Monaco's TypeScript worker runs in
-  checked-JS mode with JSX enabled. Built for the Sprockets world where every
-  top-level `var`/`function`/`class` (and `window.X =` assignment) is a global:
-  the editor scans the workspace once at boot (`GET /js_globals`) and declares
-  all of them as ambient globals, so cross-file component references need no
-  `import` and produce no "Cannot find name" diagnostics. The list refreshes
-  automatically when files change. Runtime-only globals the static scan can't
-  see (e.g. `Routes`, `I18n`) can be declared via
-  `config.js_global_identifiers = %w[Routes I18n]`.
-  Known limits: everything is typed `any` (no cross-file type inference), and
-  genuinely undefined names are shown as warnings, not errors.
-- **TypeScript** (.ts, .tsx)
-
-**Configuration & Documentation:**
-- **YAML** (.yml, .yaml)
-- **Markdown** (.md)
-
-These language modules are packaged locally with the gem for true offline operation. No network fallback is needed—all highlighting works without internet connectivity.
 
 ## Asset Pipeline
 

data/app/assets/javascripts/mbeditor/components/EditorPanel.js

@@ -70,6 +70,9 @@ var EditorPanel = function EditorPanel(_ref) {
 
   var blameDecorationsRef = useRef([]);
   var gitLineDecorationsRef = useRef([]);
+  // Latest git line-diff refresh, read by the poll effect so its interval does
+  // not have to be torn down whenever the active tab changes.
+  var gitLineRefreshRef = useRef(null);
   var blameZoneIdsRef = useRef([]);
   var testDecorationIdsRef = useRef([]);
   var testZoneIdsRef = useRef([]);
@@ -1290,7 +1293,14 @@ var EditorPanel = function EditorPanel(_ref) {
   // The ranges come from `git diff -U0` against HEAD, so they describe the file
   // as last written to disk. Monaco anchors decorations to the model and shifts
   // them as you type, which keeps them roughly right mid-edit; the authoritative
-  // refresh happens when the file lands on disk and the server broadcasts it.
+  // refresh happens on the signals wired up at the end of this effect.
+
+  // Poll cadence for the tint, matching the file tree's. Slower to react than a
+  // filesystem watcher would be, at the cost of one `git diff -U0` on one file
+  // per visible pane — against a resource nothing else is competing for, rather
+  // than a share of the kernel's inotify budget.
+  var GIT_LINE_POLL_MS = 10000;
+
   useEffect(function () {
     if (!gitAvailable || !tab.path || tab.isDiff || tab.isCombinedDiff) return;
 
@@ -1347,17 +1357,45 @@ var EditorPanel = function EditorPanel(_ref) {
 
     refresh();
 
+    // Publish the current refresh for the poll below, which lives in its own
+    // effect so a re-render of this one cannot restart its clock.
+    gitLineRefreshRef.current = refresh;
+
+    // Immediate path for writes mbeditor made itself.
     var hasSocket = typeof WebSocketService !== 'undefined' && WebSocketService.onFilesChanged;
     var onChanged = hasSocket ? function () { refresh(); } : null;
     if (onChanged) WebSocketService.onFilesChanged(onChanged);
 
     return function () {
       cancelled = true;
+      gitLineRefreshRef.current = null;
       if (onChanged && WebSocketService.offFilesChanged) WebSocketService.offFilesChanged(onChanged);
       clear();
     };
   }, [tab.path, tab.externalContentVersion, tab.isDiff, tab.isCombinedDiff, gitAvailable]);
 
+  // The poll for changes made outside the editor — a terminal commit or branch
+  // switch alters the diff without touching this buffer.
+  //
+  // Deliberately its own effect with no dependencies. Held inside the effect
+  // above, the interval was cleared and recreated on every re-render of that
+  // one and never survived long enough to fire, so the tint only ever updated
+  // via the WebSocket — i.e. never for external changes, which is the whole
+  // point of it. Reading the refresh through a ref keeps this clock running
+  // across tab switches.
+  useEffect(function () {
+    var tick = function () {
+      if (document.hidden) return;
+      if (gitLineRefreshRef.current) gitLineRefreshRef.current();
+    };
+    var intervalId = setInterval(tick, GIT_LINE_POLL_MS);
+    window.addEventListener('focus', tick);
+    return function () {
+      clearInterval(intervalId);
+      window.removeEventListener('focus', tick);
+    };
+  }, []);
+
   // Handle Blame data fetching
   useEffect(function () {
     if (!isBlameVisible) {

data/app/assets/javascripts/mbeditor/components/MbeditorApp.js

@@ -1498,14 +1498,18 @@ var MbeditorApp = function MbeditorApp() {
     });
   }
 
-  // Auto-refresh the file tree every 10s to pick up external changes (new files, deletions, etc.)
-  // When an ActionCable WebSocket is connected this acts only as a safety-net fallback —
-  // the WebSocket push above handles immediate invalidation after mbeditor mutations.
+  // Auto-refresh the file tree every 10s to pick up external changes (new files,
+  // deletions, a branch switch in a terminal).
+  //
+  // This runs whether or not the WebSocket is connected. It used to skip when
+  // connected, on the reasoning that the push covered it — but the server only
+  // broadcasts from mbeditor's own mutation endpoints, so a connected socket
+  // meant external changes were never picked up at all. The push remains the
+  // instant path for our own writes; this is what catches everything else.
   // Uses functional setTreeData to skip the re-render when nothing has changed.
   useEffect(function () {
     var intervalId = setInterval(function () {
       if (document.hidden) return;
-      if (WebSocketService.isConnected()) return; // WebSocket is handling refreshes
       FileService.getTree().then(function (data) {
         var newData = data || [];
         setTreeData(function (prevData) {

data/lib/mbeditor/configuration.rb

@@ -11,7 +11,7 @@ module Mbeditor
                   :mount_path, :resilient_routing, :js_global_identifiers,
                   :js_syntax_check, :babel_standalone_path,
                   :ruby_lsp, :ruby_lsp_command, :ruby_lsp_timeout,
-                  :search_respect_gitignore, :watch_files
+                  :search_respect_gitignore
 
     def initialize
       @allowed_environments = [:development]
@@ -42,7 +42,6 @@ module Mbeditor
       @ruby_lsp_timeout = 3     # seconds per LSP request before falling back to the built-in services
       @mount_path = nil # explicit URL prefix override; nil falls through to detection/"/mbeditor"
       @resilient_routing = true # serve /mbeditor from middleware so the editor survives a broken host routes.rb; false is the escape hatch
-      @watch_files = :auto # watch the workspace for changes made outside the editor when the host has the `listen` gem; false disables
     end
   end
 end

data/lib/mbeditor/engine.rb

@@ -4,7 +4,6 @@ require "mbeditor/rack/silence_ping_request"
 require "mbeditor/rack/handle_pending_migrations"
 require "mbeditor/rack/resilient_router"
 require "mbeditor/cable_log_filter"
-require "mbeditor/file_watcher"
 
 module Mbeditor
   class Engine < ::Rails::Engine
@@ -82,8 +81,6 @@ module Mbeditor
         raise ArgumentError, "[mbeditor] config.workspace_root is set to '#{cfg.workspace_root}' but that path is not a directory"
       end
 
-      Mbeditor::FileWatcher.start_if_enabled
-
       if cfg.redmine_enabled
         require "uri"
         if cfg.redmine_url.blank?

data/lib/mbeditor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mbeditor
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Oliver Noonan
@@ -136,7 +136,6 @@ files:
 - lib/mbeditor/configuration.rb
 - lib/mbeditor/editor_bootstrap.rb
 - lib/mbeditor/engine.rb
-- lib/mbeditor/file_watcher.rb
 - lib/mbeditor/mount_path.rb
 - lib/mbeditor/private_routes.rb
 - lib/mbeditor/rack/handle_pending_migrations.rb

data/lib/mbeditor/file_watcher.rb

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-module Mbeditor
-  # Watches the workspace for changes made outside the editor — a terminal
-  # `git checkout`, a rebase, another editor, a generator — and broadcasts the
-  # same `files_changed` payload the mutation endpoints send. Clients refresh
-  # the file tree, git line-number tinting and cached globals from it.
-  #
-  # The `listen` gem is an optional host dependency. Without it the editor
-  # behaves exactly as before: only changes made *through* mbeditor announce
-  # themselves. Nothing warns loudly about the missing gem — it is opt-in.
-  #
-  # Only one watcher runs per process. It is deliberately not started in test
-  # or in non-server processes (rake, console, the Rails runner), where a
-  # background listener thread is pure overhead.
-  module FileWatcher
-    # Coalesce bursts: a branch switch touches hundreds of files, and each one
-    # would otherwise be its own broadcast.
-    DEBOUNCE_SECONDS = 0.3
-
-    class << self
-      def available?
-        return @available if defined?(@available)
-
-        @available = begin
-          require "listen"
-          true
-        rescue LoadError
-          false
-        end
-      end
-
-      def running?
-        !@listener.nil?
-      end
-
-      # Boot entry point. Confined to the environments the editor is allowed in
-      # and to processes that actually serve requests — a rake task or console
-      # has no client to broadcast to, and a listener thread there would only
-      # burn file handles. MBEDITOR_FORCE_WATCH overrides the process check for
-      # unusual servers and for tests.
-      def start_if_enabled
-        cfg = Mbeditor.configuration
-        return false if cfg.watch_files == false
-        return false unless cfg.allowed_environments.map(&:to_s).include?(Rails.env.to_s)
-        return false unless serving_requests?
-
-        start(cfg.workspace_root.presence || Rails.root.to_s)
-      end
-
-      # Returns true when a watcher was started, false for every reason not to
-      # (gem absent, already running, no workspace, disabled by config).
-      def start(root)
-        return false unless available?
-        return false if running?
-
-        root = root.to_s
-        return false if root.empty? || !File.directory?(root)
-
-        ignores = ignore_patterns(root)
-        @listener = ::Listen.to(root, ignore: ignores, latency: DEBOUNCE_SECONDS) do |modified, added, removed|
-          broadcast(root, modified + added + removed)
-        end
-        @listener.start
-        Rails.logger.info("[mbeditor] watching #{root} for external changes")
-        true
-      rescue StandardError => e
-        # A watcher that cannot start must never take the host app down with it:
-        # inotify limits on Linux, permission issues, an unreadable root.
-        Rails.logger.warn("[mbeditor] file watcher failed to start: #{e.class}: #{e.message}")
-        @listener = nil
-        false
-      end
-
-      def stop
-        @listener&.stop
-      rescue StandardError
-        nil
-      ensure
-        @listener = nil
-      end
-
-      private
-
-      def serving_requests?
-        return true if ENV["MBEDITOR_FORCE_WATCH"]
-
-        defined?(Rails::Server) || defined?(Puma::Server) || defined?(Unicorn) || defined?(Passenger)
-      end
-
-      # `listen` matches ignores against paths relative to the watched root, so
-      # the configured exclusions become anchored regexps. Escaping matters:
-      # entries like "vendor/bundle" and "public/assets" contain separators, and
-      # a stray metacharacter in host config should not build a bogus pattern.
-      def ignore_patterns(root)
-        Array(Mbeditor.configuration.excluded_paths).map(&:to_s).reject(&:empty?).map do |path|
-          %r{\A#{Regexp.escape(path.delete_prefix("/").delete_suffix("/"))}(/|\z)}
-        end
-      end
-
-      # Paths arrive absolute. Anything that does not sit under the workspace
-      # is dropped rather than sent raw: the client keys everything by
-      # workspace-relative path, and an absolute one would leak host layout.
-      def relative_paths(root, paths)
-        paths.filter_map do |path|
-          rel = path.to_s.delete_prefix("#{root}/")
-          rel unless rel.empty? || rel == path.to_s
-        end
-      end
-
-      def broadcast(root, paths)
-        relative = relative_paths(root, paths)
-
-        invalidate_caches(root)
-        return unless defined?(ActionCable.server)
-
-        payload = { type: "files_changed" }
-        payload[:paths] = relative.first(200) if relative.any?
-        ActionCable.server.broadcast("mbeditor_editor", payload)
-      rescue StandardError => e
-        Rails.logger.warn("[mbeditor] file watcher broadcast failed: #{e.class}: #{e.message}")
-      end
-
-      # Mirrors EditorsController#broadcast_files_changed: a change the editor
-      # did not make invalidates exactly the same caches as one it did.
-      def invalidate_caches(root)
-        FileTreeService.invalidate(root)
-        SearchReplaceService.invalidate_cache(root)
-        JsGlobalsService.invalidate(root)
-        GitInfoService.invalidate(root)
-      rescue StandardError => e
-        Rails.logger.warn("[mbeditor] file watcher cache invalidation failed: #{e.class}: #{e.message}")
-      end
-    end
-  end
-end