Make auto-dirty queries feature off by default for now

Author: azimux

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.3.0] - 2026-02-26
+
+- Add auto-dirty queries feature
+
 ## [1.2.7] - 2026-02-16
 
 - Make generated castJsonResult.ts files undefined-safe

Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    foobara-typescript-remote-command-generator (1.2.7)
+    foobara-typescript-remote-command-generator (1.3.0)
       foobara (>= 0.1.16, < 2.0.0)
       foobara-files-generator (< 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     base64 (0.3.0)
     bigdecimal (4.0.1)
@@ -25,7 +27,7 @@ GEM
     foobara-files-generator (0.1.2)
       foobara (>= 0.1.1, < 2.0.0)
     foobara-lru-cache (1.0.0)
-    foobara-rubocop-rules (1.0.11)
+    foobara-rubocop-rules (1.0.12)
       rubocop
       rubocop-rspec
     foobara-spec-helpers (0.1.0)
@@ -51,6 +53,9 @@ GEM
     inheritable-thread-vars (0.0.3)
     io-console (0.8.2)
     json (2.18.1)
+    json-schema (6.1.0)
+      addressable (~> 2.8)
+      bigdecimal (>= 3.1, < 5)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     listen (3.10.0)
@@ -59,6 +64,8 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
     lumberjack (1.4.2)
+    mcp (0.7.1)
+      json-schema (>= 4.1)
     method_source (1.1.0)
     nenv (0.3.0)
     notiffany (0.1.3)
@@ -77,6 +84,7 @@ GEM
     pry-byebug (3.12.0)
       byebug (~> 13.0)
       pry (>= 0.13, < 0.17)
+    public_suffix (7.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.1)
@@ -102,10 +110,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.84.2)
+    rubocop (1.85.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
+      mcp (~> 0.6)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)

spec/remote_generator/write_typescript_to_disk_spec.rb

@@ -9,7 +9,8 @@
       raw_manifest:,
       project_directory:,
       output_directory:,
-      fail_if_does_not_pass_linter:
+      fail_if_does_not_pass_linter:,
+      auto_dirty_queries:
     }
   end
   let(:project_directory) { "#{__dir__}/../../tmp/test-app" }
@@ -18,6 +19,7 @@
   let(:raw_manifest_json) { File.read("spec/fixtures/foobara-manifest.json") }
   let(:raw_manifest) { JSON.parse(raw_manifest_json) }
   let(:fail_if_does_not_pass_linter) { true }
+  let(:auto_dirty_queries) { true }
 
   before do
     FileUtils.mkdir_p(File.dirname(project_directory))

src/generate_typescript.rb

@@ -8,8 +8,11 @@ class MissingManifestError < RuntimeError; end
 
       possible_error MissingManifestError
 
-      inputs raw_manifest: :associative_array,
-             manifest_url: :string
+      inputs do
+        raw_manifest :associative_array
+        manifest_url :string
+        auto_dirty_queries :boolean, default: false
+      end
 
       def execute
         load_manifest_if_needed
@@ -74,6 +77,12 @@ def add_all_commands_to_set_of_elements_to_generate
         end
       end
 
+      def generate_element
+        RemoteGenerator.auto_dirty_queries(auto_dirty_queries) do
+          super
+        end
+      end
+
       def add_root_manifest_to_set_of_elements_to_generate
         elements_to_generate << manifest
       end

src/generators/command_generator.rb

@@ -60,7 +60,7 @@ def result_json_requires_cast?
         end
 
         def queries_that_are_dirtied_by_this_command
-          return {} if query?
+          return {} if query? || !auto_dirty_queries?
 
           return @queries_that_are_dirtied_by_this_command if defined?(@queries_that_are_dirtied_by_this_command)
 

src/generators/typescript_from_manifest_base_generator.rb

@@ -431,6 +431,10 @@ def path_to_root
           path = super
           path.empty? ? "./" : path
         end
+
+        def auto_dirty_queries?
+          RemoteGenerator.auto_dirty_queries?
+        end
       end
     end
   end

src/remote_generator.rb

@@ -1,5 +1,26 @@
 module Foobara
   module RemoteGenerator
     foobara_domain!
+
+    class << self
+      def auto_dirty_queries(auto_dirty_queries)
+        if auto_dirty_queries == @auto_dirty_queries
+          yield
+        else
+          old = @auto_dirty_queries
+          begin
+            @auto_dirty_queries = auto_dirty_queries
+            yield
+          ensure
+            @auto_dirty_queries = old
+          end
+        end
+        @auto_dirty_queries = auto_dirty_queries
+      end
+
+      def auto_dirty_queries?
+        @auto_dirty_queries
+      end
+    end
   end
 end

src/write_typescript_to_disk.rb

@@ -14,6 +14,7 @@ def self.generator_key = "typescript-remote-commands"
                           description: "This lets you specify a directory to run the linter or npm run build in"
         output_directory :string, default: "src/domains"
         fail_if_does_not_pass_linter :boolean, default: false
+        auto_dirty_queries :boolean, default: false
       end
 
       possible_error :missing_manifest
@@ -49,9 +50,17 @@ def generate_typescript
         # TODO: we need a way to allow values to be nil in type declarations
         inputs = raw_manifest ? { raw_manifest: } : { manifest_url: }
 
+        if auto_dirty_queries?
+          inputs[:auto_dirty_queries] = auto_dirty_queries
+        end
+
         self.paths_to_source_code = run_subcommand!(GenerateTypescript, inputs)
       end
 
+      def auto_dirty_queries?
+        auto_dirty_queries
+      end
+
       def run_post_generation_tasks
         Dir.chdir(project_directory || output_directory) do
           eslint_fix

templates/base/RemoteCommand.ts.erb

@@ -1,6 +1,8 @@
 import { type Outcome, SuccessfulOutcome, ErrorOutcome } from './Outcome'
 import { type FoobaraError } from './Error'
+<% if auto_dirty_queries? %>
 import * as QueryCache from './QueryCache'
+<% end %>
 
 export default abstract class RemoteCommand<Inputs, Result, CommandError extends FoobaraError> {
   static _urlBase: string | undefined
@@ -106,7 +108,9 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
     return json
   }
 
+  <% if auto_dirty_queries? %>
   dirties (): Array<[any] | [any, string, any]> { return [] }
+  <% end %>
 
   async _handleResponse (response: Response): Promise<Outcome<Result, CommandError>> {
     const text = await response.text()
@@ -129,6 +133,7 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
     return this.outcome
   }
 
+  <% if auto_dirty_queries? %>
   dirtyQueries () {
     for (const [commandClass, inputs] of this.dirties()) {
       QueryCache.forEachQuery((query) => {
@@ -146,4 +151,5 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
       })
     }
   }
+  <% end %>
 }

version.rb

@@ -1,7 +1,7 @@
 module Foobara
   module TypescriptRemoteCommandGenerator
     module Version
-      VERSION = "1.2.7".freeze
+      VERSION = "1.3.0".freeze
       MINIMUM_RUBY_VERSION = ">= 3.4.0".freeze
     end
   end