theme-check 1.6.2 → 1.8.0

data/lib/theme_check/language_server/server.rb

@@ -13,141 +13,149 @@ module ThemeCheck
       attr_reader :should_raise_errors
 
       def initialize(
-        in_stream: STDIN,
-        out_stream: STDOUT,
-        err_stream: STDERR,
-        should_raise_errors: false
+        messenger:,
+        should_raise_errors: false,
+        number_of_threads: 2
       )
-        validate!([in_stream, out_stream, err_stream])
+        # This is what does the IO
+        @messenger = messenger
 
-        @handler = Handler.new(self)
-        @in = in_stream
-        @out = out_stream
-        @err = err_stream
+        # This is what you use to communicate with the language client
+        @bridge = Bridge.new(@messenger)
 
-        # Because programming is fun,
-        #
-        # Ruby on Windows turns \n into \r\n. Which means that \r\n
-        # gets turned into \r\r\n. Which means that the protocol
-        # breaks on windows unless we turn STDOUT into binary mode.
-        #
-        # Hours wasted: 9.
-        @out.binmode
+        # The handler handles messages from the language client
+        @handler = Handler.new(@bridge)
 
-        @out.sync = true # do not buffer
-        @err.sync = true # do not buffer
+        # The queue holds the JSON RPC messages
+        @queue = Queue.new
 
-        @should_raise_errors = should_raise_errors
-      end
+        # The JSON RPC thread pushes messages onto the queue
+        @json_rpc_thread = nil
 
-      def listen
-        loop do
-          process_request
-
-        # support ctrl+c and stuff
-        rescue SignalException, DoneStreaming
-          cleanup
-          return 0
-
-        rescue Exception => e # rubocop:disable Lint/RescueException
-          raise e if should_raise_errors
-          log(e)
-          log(e.backtrace)
-          return 1
-        end
-      end
+        # The handler threads read messages from the queue
+        @number_of_threads = number_of_threads
+        @handlers = []
 
-      def send_response(response)
-        response_body = JSON.dump(response)
-        log(JSON.pretty_generate(response)) if $DEBUG
+        # The error queue holds blocks the main thread. When filled, we exit the program.
+        @error = SizedQueue.new(number_of_threads)
 
-        @out.write("Content-Length: #{response_body.bytesize}\r\n")
-        @out.write("\r\n")
-        @out.write(response_body)
-        @out.flush
+        @should_raise_errors = should_raise_errors
       end
 
-      def log(message)
-        @err.puts(message)
-        @err.flush
+      def listen
+        start_handler_threads
+        start_json_rpc_thread
+        status_code = status_code_from_error(@error.pop)
+        cleanup(status_code)
+      rescue SignalException
+        0
       end
 
-      private
-
-      def supported_io_classes
-        [IO, StringIO]
+      def start_json_rpc_thread
+        @json_rpc_thread = Thread.new do
+          loop do
+            message = @bridge.read_message
+            if message['method'] == 'initialize'
+              handle_message(message)
+            elsif message.key?('result')
+              # Responses are handled on the main thread to prevent
+              # a potential deadlock caused by all handlers waiting
+              # for a responses.
+              handle_response(message)
+            else
+              @queue << message
+            end
+          rescue Exception => e # rubocop:disable Lint/RescueException
+            break @error << e
+          end
+        end
       end
 
-      def validate!(streams = [])
-        streams.each do |stream|
-          unless supported_io_classes.find { |klass| stream.is_a?(klass) }
-            raise IncompatibleStream, incompatible_stream_message
+      def start_handler_threads
+        @number_of_threads.times do
+          @handlers << Thread.new do
+            loop do
+              message = @queue.pop
+              break if @queue.closed? && @queue.empty?
+              handle_message(message)
+            rescue Exception => e # rubocop:disable Lint/RescueException
+              break @error << e
+            end
           end
         end
       end
 
-      def incompatible_stream_message
-        'if provided, in_stream, out_stream, and err_stream must be a kind of '\
-        "one of the following: #{supported_io_classes.join(', ')}"
+      def status_code_from_error(e)
+        raise e
+
+      # support ctrl+c and stuff
+      rescue SignalException, DoneStreaming
+        0
+
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        raise e if should_raise_errors
+        @bridge.log("#{e.class}: #{e.message}\n#{e.backtrace.join("\n")}")
+        2
       end
 
-      def process_request
-        request_body = read_new_content
-        request_json = JSON.parse(request_body)
-        log(JSON.pretty_generate(request_json)) if $DEBUG
+      private
 
-        id = request_json['id']
-        method_name = request_json['method']
-        params = request_json['params']
-        method_name = "on_#{to_snake_case(method_name)}"
+      def handle_message(message)
+        id = message['id']
+        method_name = message['method']
+        method_name &&= "on_#{to_snake_case(method_name)}"
+        params = message['params']
 
         if @handler.respond_to?(method_name)
           @handler.send(method_name, id, params)
         end
-      end
 
-      def to_snake_case(method_name)
-        StringHelpers.underscore(method_name.gsub(/[^\w]/, '_'))
+      rescue DoneStreaming => e
+        raise e
+      rescue StandardError => e
+        is_request = id
+        raise e unless is_request
+        # Errors obtained in request handlers should be sent
+        # back as internal errors instead of closing the program.
+        @bridge.send_internal_error(id, e)
       end
 
-      def initial_line
-        # Scanning for lines that fit the protocol.
-        while true
-          initial_line = @in.gets
-          # gets returning nil means the stream was closed.
-          raise DoneStreaming if initial_line.nil?
-
-          if initial_line.match(/Content-Length: (\d+)/)
-            break
-          end
-        end
-        initial_line
+      def handle_response(message)
+        id = message['id']
+        result = message['result']
+        @bridge.receive_response(id, result)
       end
 
-      def read_new_content
-        length = initial_line.match(/Content-Length: (\d+)/)[1].to_i
-        content = ''
-        while content.length < length + 2
-          begin
-            # Why + 2? Because \r\n
-            content += @in.read(length + 2)
-          rescue => e
-            log(e)
-            log(e.backtrace)
-            # We have almost certainly been disconnected from the server
-            cleanup
-            raise DoneStreaming
-          end
-        end
-
-        content
+      def to_snake_case(method_name)
+        StringHelpers.underscore(method_name.gsub(/[^\w]/, '_'))
       end
 
-      def cleanup
-        @err.close
-        @out.close
-      rescue
-        # I did my best
+      def cleanup(status_code)
+        # Stop listenting to RPC calls
+        @messenger.close_input
+        # Wait for rpc loop to close
+        @json_rpc_thread&.join if @json_rpc_thread&.alive?
+        # Close the queue
+        @queue.close unless @queue.closed?
+        # Give 10 seconds for the handlers to wrap up what they were
+        # doing/emptying the queue. 👀 unit tests.
+        @handlers.each { |thread| thread.join(10) if thread.alive? }
+
+        # Hijack the status_code if an error occurred while cleaning up.
+        # 👀 unit tests.
+        until @error.empty?
+          code = status_code_from_error(@error.pop)
+          # Promote the status_code to ERROR if one of the threads
+          # resulted in an error, otherwise leave the status_code as
+          # is. That's because one thread could end successfully in a
+          # DoneStreaming error while the other failed with an
+          # internal error. If we had an internal error, we should
+          # return with a status_code that fits.
+          status_code = code if code > status_code
+        end
+        status_code
+      ensure
+        @messenger.close_output
       end
     end
   end

data/lib/theme_check/language_server.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 require_relative "language_server/protocol"
 require_relative "language_server/constants"
+require_relative "language_server/channel"
+require_relative "language_server/messenger"
+require_relative "language_server/io_messenger"
+require_relative "language_server/bridge"
 require_relative "language_server/uri_helper"
 require_relative "language_server/handler"
 require_relative "language_server/server"
@@ -12,6 +16,7 @@ require_relative "language_server/completion_engine"
 require_relative "language_server/document_link_provider"
 require_relative "language_server/document_link_engine"
 require_relative "language_server/diagnostics_tracker"
+require_relative "language_server/diagnostics_engine"
 
 Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
   require file
@@ -24,7 +29,7 @@ end
 module ThemeCheck
   module LanguageServer
     def self.start
-      Server.new.listen
+      Server.new(messenger: IOMessenger.new).listen
     end
   end
 end

data/lib/theme_check/liquid_node.rb

@@ -74,6 +74,34 @@ module ThemeCheck
       position.end_index
     end
 
+    def start_token_index
+      return position.start_index if inside_liquid_tag?
+      position.start_index - (start_token.length + 1)
+    end
+
+    def end_token_index
+      return position.end_index if inside_liquid_tag?
+      position.end_index + end_token.length
+    end
+
+    def render_start_tag
+      "#{start_token} #{@value.raw}#{end_token}"
+    end
+
+    def render_end_tag
+      "#{start_token} #{@value.block_delimiter} #{end_token}"
+    end
+
+    def block_body_start_index
+      return unless block_tag?
+      block_regex.begin(:body)
+    end
+
+    def block_body_end_index
+      return unless block_tag?
+      block_regex.end(:body)
+    end
+
     # Literals are hard-coded values in the liquid file.
     def literal?
       @value.is_a?(String) || @value.is_a?(Integer)
@@ -184,6 +212,11 @@ module ThemeCheck
 
     private
 
+    def block_regex
+      return unless block_tag?
+      /(?<start_token>#{render_start_tag})(?<body>.*)(?<end_token>#{render_end_tag})/m.match(source)
+    end
+
     def position
       @position ||= Position.new(
         markup,

data/lib/theme_check/locale_diff.rb

@@ -14,24 +14,43 @@ module ThemeCheck
       visit_object(@default, @other, [])
     end
 
-    def add_as_offenses(check, key_prefix: [], node: nil, theme_file: nil)
+    def add_as_offenses(check, key_prefix: [], node: nil, theme_file: nil, schema: {})
       if extra_keys.any?
-        add_keys_offense(check, "Extra translation keys", extra_keys,
-          key_prefix: key_prefix, node: node, theme_file: theme_file)
+        remove_extra_keys_offense(check, "Extra translation keys", extra_keys,
+          key_prefix: key_prefix, node: node, theme_file: theme_file, schema: schema)
       end
 
       if missing_keys.any?
-        add_keys_offense(check, "Missing translation keys", missing_keys,
-          key_prefix: key_prefix, node: node, theme_file: theme_file)
+        add_missing_keys_offense(check, "Missing translation keys", missing_keys,
+          key_prefix: key_prefix, node: node, theme_file: theme_file, schema: schema)
       end
     end
 
     private
 
-    def add_keys_offense(check, cause, keys, key_prefix:, node: nil, theme_file: nil)
-      message = "#{cause}: #{format_keys(key_prefix, keys)}"
+    def remove_extra_keys_offense(check, cause, extra_keys, key_prefix:, node: nil, theme_file: nil, schema: {})
+      message = "#{cause}: #{format_keys(key_prefix, extra_keys)}"
       if node
-        check.add_offense(message, node: node)
+        check.add_offense(message, node: node) do |corrector|
+          extra_keys.each do |k|
+            corrector.remove_key(schema, key_prefix + k)
+          end
+          corrector.replace_block_body(node, schema)
+        end
+      else
+        check.add_offense(message, theme_file: theme_file)
+      end
+    end
+
+    def add_missing_keys_offense(check, cause, missing_keys, key_prefix:, node: nil, theme_file: nil, schema: {})
+      message = "#{cause}: #{format_keys(key_prefix, missing_keys)}"
+      if node
+        check.add_offense(message, node: node) do |corrector|
+          missing_keys.each do |k|
+            corrector.add_key(schema, key_prefix + k, "TODO")
+          end
+          corrector.replace_block_body(node, schema)
+        end
       else
         check.add_offense(message, theme_file: theme_file)
       end
@@ -46,10 +65,12 @@ module ThemeCheck
       other = {} unless other.is_a?(Hash)
       return if pluralization?(default) && pluralization?(other)
 
-      @extra_keys += (other.keys - default.keys).map { |key| path + [key] }
+      shopify_translations = system_translations(path)
+
+      @extra_keys += (other.keys - default.keys - shopify_translations.keys).map { |key| path + [key] }
 
       default.each do |key, default_value|
-        translated_value = other[key]
+        translated_value = other[key] || shopify_translations[key]
         new_path = path + [key]
 
         if translated_value.nil?
@@ -65,5 +86,10 @@ module ThemeCheck
         PLURALIZATION_KEYS.include?(key) && !value.is_a?(Hash)
       end
     end
+
+    def system_translations(path)
+      return ShopifyLiquid::SystemTranslations.translations_hash if path.empty?
+      ShopifyLiquid::SystemTranslations.translations_hash.dig(*path) || {}
+    end
   end
 end

data/lib/theme_check/position.rb

@@ -64,6 +64,10 @@ module ThemeCheck
       strict_position.end_column
     end
 
+    def content_line_count
+      @content_line_count ||= contents.count("\n")
+    end
+
     private
 
     def compute_start_offset
@@ -78,10 +82,6 @@ module ThemeCheck
       @contents
     end
 
-    def content_line_count
-      @content_line_count ||= contents.count("\n")
-    end
-
     def line_number
       return 0 if @line_number_1_indexed.nil?
       bounded(0, @line_number_1_indexed - 1, content_line_count)

data/lib/theme_check/shopify_liquid/system_translations.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module ThemeCheck
+  module ShopifyLiquid
+    module SystemTranslations
+      extend self
+
+      def translations
+        @translations ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_translation_keys.yml")).to_set
+      end
+
+      def translations_hash
+        @translations_hash ||= translations.reduce({}) do |acc, k|
+          dig_set(acc, k.split('.'), "")
+        end
+      end
+
+      def include?(key)
+        translations.include?(key)
+      end
+
+      private
+
+      def dig_set(obj, keys, value)
+        key = keys.first
+        if keys.length == 1
+          obj[key] = value
+        else
+          obj[key] = {} unless obj[key]
+          dig_set(obj[key], keys.slice(1..-1), value)
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/tag.rb

@@ -7,10 +7,17 @@ module ThemeCheck
       extend self
 
       def labels
-        @tags ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/tags.yml"))
+        @labels ||= tags_file_contents
+          .map { |x| to_label(x) }
           .to_set
       end
 
+      def end_labels
+        @end_labels ||= tags_file_contents
+          .select { |x| x.is_a?(Hash) }
+          .map { |x| x.values[0] }
+      end
+
       def tag_regex(tag)
         return unless labels.include?(tag)
         @tag_regexes ||= {}
@@ -22,6 +29,17 @@ module ThemeCheck
         @tag_liquid_regexes ||= {}
         @tag_liquid_regexes[tag] ||= /^\s*#{tag}/m
       end
+
+      private
+
+      def to_label(label)
+        return label if label.is_a?(String)
+        label.keys[0]
+      end
+
+      def tags_file_contents
+        @tags_file_contents ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/tags.yml"))
+      end
     end
   end
 end

data/lib/theme_check/shopify_liquid.rb

@@ -3,3 +3,4 @@ require_relative 'shopify_liquid/deprecated_filter'
 require_relative 'shopify_liquid/filter'
 require_relative 'shopify_liquid/object'
 require_relative 'shopify_liquid/tag'
+require_relative 'shopify_liquid/system_translations'

data/lib/theme_check/tags.rb

@@ -66,7 +66,6 @@ module ThemeCheck
 
       def initialize(tag_name, markup, options)
         super
-
         if (matches = markup.match(SYNTAX))
           @liquid_variable_name = matches[:liquid_variable_name]
           @page_size = parse_expression(matches[:page_size])

data/lib/theme_check/theme_file_rewriter.rb

@@ -25,6 +25,12 @@ module ThemeCheck
       )
     end
 
+    def remove(node)
+      @rewriter.remove(
+        range(node.start_token_index, node.end_token_index)
+      )
+    end
+
     def replace(node, content)
       @rewriter.replace(
         range(node.start_index, node.end_index),
@@ -32,6 +38,13 @@ module ThemeCheck
       )
     end
 
+    def replace_body(node, content)
+      @rewriter.replace(
+        range(node.block_body_start_index, node.block_body_end_index),
+        content
+      )
+    end
+
     def wrap(node, insert_before, insert_after)
       @rewriter.wrap(
         range(node.start_index, node.end_index),

data/lib/theme_check/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ThemeCheck
-  VERSION = "1.6.2"
+  VERSION = "1.8.0"
 end

data/lib/theme_check.rb

@@ -51,6 +51,10 @@ Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
 module ThemeCheck
+  def self.debug?
+    ENV["THEME_CHECK_DEBUG"] == "true"
+  end
+
   def self.with_liquid_c_disabled
     if defined?(Liquid::C)
       was_enabled = Liquid::C.enabled

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -201,6 +201,8 @@ files:
 - lib/theme_check/json_helpers.rb
 - lib/theme_check/json_printer.rb
 - lib/theme_check/language_server.rb
+- lib/theme_check/language_server/bridge.rb
+- lib/theme_check/language_server/channel.rb
 - lib/theme_check/language_server/completion_engine.rb
 - lib/theme_check/language_server/completion_helper.rb
 - lib/theme_check/language_server/completion_provider.rb
@@ -209,6 +211,7 @@ files:
 - lib/theme_check/language_server/completion_providers/render_snippet_completion_provider.rb
 - lib/theme_check/language_server/completion_providers/tag_completion_provider.rb
 - lib/theme_check/language_server/constants.rb
+- lib/theme_check/language_server/diagnostics_engine.rb
 - lib/theme_check/language_server/diagnostics_tracker.rb
 - lib/theme_check/language_server/document_link_engine.rb
 - lib/theme_check/language_server/document_link_provider.rb
@@ -217,6 +220,8 @@ files:
 - lib/theme_check/language_server/document_link_providers/render_document_link_provider.rb
 - lib/theme_check/language_server/document_link_providers/section_document_link_provider.rb
 - lib/theme_check/language_server/handler.rb
+- lib/theme_check/language_server/io_messenger.rb
+- lib/theme_check/language_server/messenger.rb
 - lib/theme_check/language_server/protocol.rb
 - lib/theme_check/language_server/server.rb
 - lib/theme_check/language_server/tokens.rb
@@ -241,6 +246,7 @@ files:
 - lib/theme_check/shopify_liquid/deprecated_filter.rb
 - lib/theme_check/shopify_liquid/filter.rb
 - lib/theme_check/shopify_liquid/object.rb
+- lib/theme_check/shopify_liquid/system_translations.rb
 - lib/theme_check/shopify_liquid/tag.rb
 - lib/theme_check/storage.rb
 - lib/theme_check/string_helpers.rb