klenod-build 0.0.25 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceb99aac4328e67769eebf0c137e9e2f8412bbfc65c51c0757906f7e5e1ce88f
-  data.tar.gz: 7bd420cb85700ace2a34e6e0460ee5f63f8a9b1530264f8b1f5d4a8f7f4583e3
+  metadata.gz: 583e74384e061c34bf2da93cd71156adc1b4d8c9d43dc86fec044364ff00f049
+  data.tar.gz: afa864b06807f97cf1e68d04128c77d930136982fccabcd91013893491b12f28
 SHA512:
-  metadata.gz: a8225fdd2f9208f17b2feeb832d03ed7bbb0fd5669bfd875fccdff579d05050a846f229996ccdce028e028d47b48cc70f24355b7a9384409d99c77e31a0a4a62
-  data.tar.gz: 0c5e2b51e492c0a56772ff6a9ed4309924a2da19e3a973c60782b1182605be59cec2cc3b10cc4c20a1641c21ae8102d9d37c3a6b00549fcf0e6a2b6347e84430
+  metadata.gz: 2d33327a02fc995e93eb644b558dcee29fe32dd1223f6dc2a50fa47e922d7bddb50f81065bc4df3f95297e43cc9e4aa7b89336f723edc762e7531457956a180e
+  data.tar.gz: 7e29a8f5aaacef578ca6efa7c2e10e0595afee4058d8a58726899f2d97f28c12b7c5376931a6d0ab993b4c11b6ea8c4bb065c0a4abbab18df51ebf14069a27a0

data/lib/klenod/build/exception_formatter.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "klenod/runtime/backtrace_rewriter"
+
+require_relative "source_excerpt"
+
+module Klenod
+  module Build
+    # A runtime exception as a development report, in the same shape as a
+    # SourceError: the class and message, an excerpt of the first frame that
+    # has source, then the frames.
+    #
+    #   × NameError: undefined local variable or method 'x'
+    #
+    #       ╭─[app:/routes/page.haml:4]
+    #     3 │ %h1 Hello
+    #   > 4 │ %p= x
+    #       ╰────
+    #     at app:/routes/page.haml:4:in 'render'
+    #     at /gems/rack/lib/rack.rb:12:in 'call'
+    #
+    # Rewriting lives in Klenod::Runtime::BacktraceRewriter, so a production
+    # application keeps corrected backtraces without loading any of this.
+    module ExceptionFormatter
+      Entry = Runtime::BacktraceRewriter::ParsedBacktraceEntry
+
+      module_function
+
+      # `mods` maps module IDs to evaluated modules, as Graph#mods does. The
+      # error is rewritten in place.
+      def format(error, mods: {}, ansi: true, links: ansi && SourceExcerpt.hyperlinks?)
+        rewriter = Runtime::BacktraceRewriter.new(mods)
+        rewriter.rewrite_exception(error)
+        module_ids = mods.values.select { it.respond_to?(:eval_path) }.to_h { [it.eval_path.to_s, it.path.to_s] }
+        frames = Array(error.backtrace).map { Entry.parse(it) || it.to_s }
+
+        [
+          SourceExcerpt.header(error.class.name, error.message, ansi:),
+          [
+            excerpt(frames, rewriter, module_ids, ansi:, links:),
+            *frames.map { "  #{frame(it, module_ids, ansi:, links:)}" }
+          ].compact.join("\n")
+        ].reject(&:empty?).join("\n\n")
+      end
+
+      # The first frame the rewriter has original source for, boxed.
+      def excerpt(frames, rewriter, module_ids, ansi:, links:)
+        frames.grep(Entry).each do |entry|
+          source = rewriter.source_for(entry.file)
+          next unless source
+
+          location = location(entry, module_ids, ansi:, links:)
+          excerpt = SourceExcerpt.excerpt(source:, line: entry.line, ansi:, location:)
+          return excerpt if excerpt
+        end
+
+        nil
+      end
+
+      # "at app:/routes/page.haml:4:in 'render'". Frames outside the graph are
+      # dimmed so the application's own frames stand out.
+      def frame(entry, module_ids, ansi:, links:)
+        return SourceExcerpt.dim("at #{entry}", ansi:) unless entry.is_a?(Entry) && module_ids.key?(entry.file)
+
+        "#{SourceExcerpt.dim("at", ansi:)} #{location(entry, module_ids, ansi:, links:)}#{SourceExcerpt.dim(":in '#{entry.description}'", ansi:)}"
+      end
+
+      # Graph modules are named by module ID and linked to the file they were
+      # evaluated from.
+      def location(entry, module_ids, ansi:, links:)
+        SourceExcerpt.styled_location(
+          module_id: module_ids.fetch(entry.file, entry.file),
+          line: entry.line,
+          path: entry.file,
+          ansi:,
+          links:
+        )
+      end
+    end
+  end
+end

data/lib/klenod/build/graph/invalidator.rb

@@ -16,7 +16,8 @@ module Klenod
           evaluated_module_ids = mods.keys
           changed_module_ids = module_ids_for_paths(changed_paths)
           removed_module_ids = module_ids_for_paths(removed_paths)
-          failed_retry_ids = failed_module_ids_for_created_paths(changed_paths)
+          failed_retry_ids = failed_module_ids - removed_module_ids
+          imported_module_ids = records.each_key.select { |module_id| graph.dependents(module_id).any? }
           pattern_owner_ids = module_ids_for_watched_paths(changed_paths + removed_paths)
           plugin_owner_ids = plugin_invalidated_module_ids(changed_paths + removed_paths)
           reload_module_ids = (changed_module_ids + failed_retry_ids + pattern_owner_ids + plugin_owner_ids).uniq
@@ -31,6 +32,12 @@ module Klenod
           failed_reload_ids = []
           reloaded_module_ids =
             reload_module_ids.filter_map do |module_id|
+              if orphaned_failure?(module_id, imported_module_ids)
+                graph.remove_record(module_id)
+                mods.delete(module_id)
+                next
+              end
+
               if evaluated_module_ids.include?(module_id)
                 graph.load_module(module_id, force: true)
               else
@@ -124,28 +131,22 @@ module Klenod
           end
         end
 
-        def failed_module_ids_for_created_paths(paths)
-          relative_paths = relative_paths_for(paths)
-          return [] if relative_paths.empty?
-
-          records.filter_map do |module_id, record|
-            next unless record.status == :failed
-
-            unresolved_path = record.metadata.fetch(:error).unresolved_path if record.metadata.fetch(:error).respond_to?(:unresolved_path)
-            module_id if unresolved_path && relative_paths.any? { |path| path_satisfies_unresolved_path?(path, unresolved_path) }
-          end
-        end
-
-        def relative_paths_for(paths)
-          paths.filter_map do |path|
-            Pathname.new(path).expand_path.relative_path_from(resolver.source_dir).to_s
-          rescue ArgumentError
-            nil
-          end
+        # A failed record keeps no dependency links, so nothing ties it to the file
+        # that broke it: a missing import, or a new dependency that fails to parse.
+        # Retry every failed module on each change. Failures are rare, and a retry
+        # that fails again reports its error again.
+        def failed_module_ids
+          records.filter_map { |module_id, record| module_id if record.status == :failed }
         end
 
-        def path_satisfies_unresolved_path?(path, unresolved_path)
-          path == unresolved_path || path.start_with?("#{unresolved_path}.")
+        # A failed module whose last importer dropped it earlier in this update.
+        # Nothing can demand it any more, so retrying it would report its error
+        # on every change. Its record goes; importing it again collects it anew.
+        # A failed entry never had an importer and keeps being retried.
+        def orphaned_failure?(module_id, imported_module_ids)
+          records[module_id]&.status == :failed &&
+            imported_module_ids.include?(module_id) &&
+            graph.dependents(module_id).empty?
         end
 
         def plugin_invalidated_module_ids(paths)

data/lib/klenod/build/graph.rb

@@ -386,6 +386,18 @@ module Klenod
           @mods[module_id] = mod
           record
         end
+      rescue SourceError => error
+        error.path ||= source_path_for(error.module_id)
+        raise
+      end
+
+      # The file behind an app module, so error reports can link to it.
+      def source_path_for(module_id)
+        return nil unless module_id.is_a?(ModuleId) && module_id.scheme == :app
+
+        absolute_path(module_id).to_s
+      rescue ResolveError
+        nil
       end
 
       def collect_module(module_id, force: false)
@@ -443,6 +455,9 @@ module Klenod
           @profiler.progress(:collect_module, module_id: record.id.to_s, total_records: @records.length)
           record
         end
+      rescue SourceError => error
+        error.path ||= source_path_for(error.module_id)
+        raise
       end
 
       def evaluate_module(module_id)

data/lib/klenod/build/plugins/haml_plugin/parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "ripper"
-require "syntax_tree/haml"
+require "haml"
 
 module Klenod
   module Build
@@ -60,9 +60,14 @@ module Klenod
               begin
                 attributes, rest, last_line = super
               rescue ::Haml::SyntaxError => error
-                raise unless pairs && error.message.start_with?("Invalid attribute list")
-
-                raise ::Haml::SyntaxError.new("#{error.message}\n\n#{hash_attributes_hint(tag_prefix, pairs)}", error.line)
+                raise unless error.message.start_with?("Invalid attribute list")
+
+                # Haml quotes the list with String#inspect, which escapes every
+                # `"` in it. Show the source as written instead.
+                attribute_list = ::Haml::Util.balance(text, "(", ")")&.first || text
+                message = "Invalid attribute list: `#{attribute_list}`."
+                message = "#{message}\n\n#{hash_attributes_hint(tag_prefix, pairs)}" if pairs
+                raise ::Haml::SyntaxError.new(message, error.line)
               end
               return [attributes, rest, last_line + joined_lines]
             end