platformos-check 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aebbd738b1045c874460b7f1de2cf2774297f36136fce816521dda29ce371652
-  data.tar.gz: c348e3afc68f2a664fe1ad313d41497ad7c977f8de72f3b82df9dda297926c38
+  metadata.gz: 579d15b95d0e00e65eb562778f0870bc28698bfe2f6c97ca66e7ca81a18b855c
+  data.tar.gz: 2f6afe88f067cccc169d62a9744399b5b11294537dd8c7653ca9d5ed9165f1f3
 SHA512:
-  metadata.gz: 368d39315a05ab34eff3797012af56775ca9a5ff4d8209ed0c44aa2916f97fe5740afa859bbfbbdf34409aa40967efe4236b2394eafcdecfc313c97f62a4dba7
-  data.tar.gz: f912bda1de7e0be84e887ab2f19cde9072e03468ea52265f910e20ff5a7317b7f7f4e6fe83aef690350f21543ffbd495e01c72eddca5c393acfc5500055d6939
+  metadata.gz: 2fa86abf31229208eaff48e7f95b212977682bd560234d99d2fa9b3162a33ca7139b8faad2960152951295b056ef41b834e9faa756b0627f02a14034f6d4e468
+  data.tar.gz: 18fa38e2613faf4e31dfdf0a432e4fbe3a8ced0b18f8f194698bf73606affd770cf2589dadb852c26c19f5ec31146535e95e863d7c31ab9c8977feb67fa99a07

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-v0.4.7 / 2023-12-22
+v0.4.8 / 2023-12-20
+==================
+
+  * Add GraphqlInForLoop check
+
+v0.4.7 / 2023-12-27
 ==================
 
   * Add UnreachableCode check

data/config/default.yml

@@ -99,6 +99,10 @@ FormAuthenticityToken:
   enabled: true
   ignore: []
 
+GraphqlInForLoop:
+  enabled: true
+  ignore: []
+
 HtmlParsingError:
   enabled: true
   ignore: []

data/docs/checks/graphql_in_for_loop.md

@@ -0,0 +1,56 @@
+# GraphQL in for loop (`GraphqlInForLoop`)
+
+This check is aimed towards identifying performance problems before they arise. Invoking GraphQL queries/mutations inside the `for loop` can lead to performance issues such as increased database load, higher latency, and inefficient use of network resources. It is particularly problematic when dealing with large datasets or when the number of entities grows.
+
+Invoking a GraphQL query within a `for loop` might also be a sign of a so called N+1 problem. The N+1 pattern often arises when dealing with relationships between entities. In an attempt to retrieve related data, developers may inadvertently end up executing a large number of queries, resulting in a significant performance overhead.
+
+To address this problem, developers can use techniques like eager loading, which involves fetching the related data in a single query instead of issuing separate queries for each entity. This helps reduce the number of database round-trips and improves overall system performance. In platformOS the most common technique to fix the N+1 issue is by [using related_records][relalted_records].
+
+## Check Details
+
+This check is aimed towards identifying GraphQL queries invoked within a for loop.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% assign arr = 'a,b,c' | split: ','}
+{% for el in arr %}
+  {% graphql g = 'my/graphql', el: el %}
+  {% print el %}
+{% endfor %}
+
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% assign arr = 'a,b,c' | split: ','}
+{% graphql g = 'my/graphql', arr: arr %}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+GraphqlInForLoop:
+  enabled: true
+```
+
+## When Not To Use It
+
+In the perfect world, there should be no cases where disabling this rule is needed - platformOS most likely already has a way to solve a problem without using GraphQL query / mutation in the for loop.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.4.9.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+- [platformOS - loading related records][related_records]
+
+[codesource]: /lib/platformos_check/checks/graphql_in_for_loop.rb
+[docsource]: /docs/checks/graphql_in_for_loop.md
+[related_records]: https://documentation.platformos.com/developer-guide/records/loading-related-records

data/lib/platformos_check/analyzer.rb

@@ -2,13 +2,15 @@
 
 module PlatformosCheck
   class Analyzer
-    def initialize(platformos_app, checks = Check.all.map(&:new), auto_correct = false)
+    def initialize(platformos_app, checks = Check.all.map(&:new), auto_correct = false, store_warnings = false)
       @platformos_app = platformos_app
       @auto_correct = auto_correct
+      @store_warnings = store_warnings
 
       @liquid_checks = Checks.new
       @yaml_checks = Checks.new
       @html_checks = Checks.new
+      @warnings = {}
 
       checks.each do |check|
         check.platformos_app = @platformos_app
@@ -30,6 +32,8 @@ module PlatformosCheck
         @html_checks.flat_map(&:offenses)
     end
 
+    attr_reader :warnings
+
     def yaml_file_count
       @yaml_file_count ||= @platformos_app.yaml.size
     end
@@ -54,6 +58,7 @@ module PlatformosCheck
           yield(liquid_file.relative_path.to_s, i, total_file_count) if block_given?
           liquid_visitor.visit_liquid_file(liquid_file)
           html_visitor.visit_liquid_file(liquid_file)
+          @warnings[liquid_file.path] = liquid_file.warnings if @store_warnings && !liquid_file.warnings&.empty?
         end
       end
 

data/lib/platformos_check/checks/graphql_in_for_loop.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  class GraphqlInForLoop < LiquidCheck
+    severity :suggestion
+    categories :liquid, :performance
+    doc docs_url(__FILE__)
+
+    PARTIAL_TAG = %i[render include]
+    OFFENSE_MSG = "Do not invoke GraphQL in a for loop"
+
+    class PartialInfo
+      attr_reader :node, :app_file
+
+      def initialize(node:, app_file:)
+        @node = node
+        @app_file = app_file
+      end
+    end
+
+    def self.single_file(**_args)
+      true
+    end
+
+    def initialize
+      @partials = []
+      @all_partials = Set.new
+    end
+
+    def on_for(_node)
+      @in_for = true
+    end
+
+    def on_graphql(node)
+      add_graphql_offense(node:, graphql_node: node) if should_report?
+    end
+
+    def after_for(_node)
+      @in_for = false
+    end
+
+    def on_background(_node)
+      @in_background = true
+    end
+
+    def after_background(_node)
+      @in_background = false
+    end
+
+    def on_include(node)
+      return unless should_report?
+
+      add_partial(path: node.value.template_name_expr, node:)
+    end
+
+    def on_render(node)
+      return unless should_report?
+
+      add_partial(path: node.value.template_name_expr, node:)
+    end
+
+    def on_function(node)
+      return unless should_report?
+
+      add_partial(path: node.value.from, node:)
+    end
+
+    def on_end
+      while (partial_info = @partials.shift)
+        report_offense_on_graphql(LiquidNode.new(partial_info.app_file.parse.root, nil, partial_info.app_file), offense_node: partial_info.node)
+      end
+    end
+
+    protected
+
+    def add_partial(path:, node:)
+      return unless path.is_a?(String)
+      return if @all_partials.include?(path)
+      return if @platformos_app.grouped_files[PlatformosCheck::PartialFile][path].nil?
+
+      @all_partials << path
+      @partials << PartialInfo.new(node:, app_file: @platformos_app.grouped_files[PlatformosCheck::PartialFile][path])
+    end
+
+    def should_report?
+      @in_for && !@in_background
+    end
+
+    def add_graphql_offense(node:, graphql_node:)
+      return add_offense(OFFENSE_MSG, node:) unless graphql_node.value.partial_name
+
+      partial_name = graphql_node.value.partial_name.is_a?(String) ? graphql_node.value.partial_name : "variable: #{graphql_node.value.partial_name.name}"
+      add_offense("#{OFFENSE_MSG} (#{partial_name})", node:)
+    end
+
+    def report_offense_on_graphql(node, offense_node:)
+      if node.type_name == :graphql
+        add_graphql_offense(node: offense_node, graphql_node: node)
+      elsif PARTIAL_TAG.include?(node.type_name)
+        add_partial(path: node.value.template_name_expr, node: offense_node)
+      elsif node.type_name == :function
+        add_partial(path: node.value.from, node: offense_node)
+      elsif node.children && !node.children.empty?
+        node.children.each { |c| report_offense_on_graphql(c, offense_node:) }
+      end
+    end
+  end
+end

data/lib/platformos_check/checks/unreachable_code.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module PlatformosCheck
-  # Recommends using {% liquid ... %} if 5 or more consecutive {% ... %} are found.
   class UnreachableCode < LiquidCheck
     severity :error
     category :liquid

data/lib/platformos_check/liquid_file.rb

@@ -68,7 +68,7 @@ module PlatformosCheck
     end
 
     def warnings
-      @ast.warnings
+      parse&.warnings
     end
 
     def root

data/lib/platformos_check/tags/context.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class Context < Base
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          @node.attributes_expr.values
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags.rb

@@ -53,6 +53,8 @@ module PlatformosCheck
         register_tag('background', Background)
         register_tag('content_for', ContentFor)
         register_tag('session', Session)
+        register_tag('context', Context)
+        register_tag('context_rc', Context)
         register_tag('sign_in', SignIn)
         register_tag('yield', Yield)
         register_tag('graphql', Graphql)

data/lib/platformos_check/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlatformosCheck
-  VERSION = "0.4.7"
+  VERSION = "0.4.8"
 end

data/lib/platformos_check.rb

@@ -47,6 +47,7 @@ require_relative "platformos_check/tags/base"
 require_relative "platformos_check/tags/base_block"
 require_relative "platformos_check/tags/background"
 require_relative "platformos_check/tags/cache"
+require_relative "platformos_check/tags/context"
 require_relative "platformos_check/tags/export"
 require_relative "platformos_check/tags/form"
 require_relative "platformos_check/tags/function"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: platformos-check
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Piotr Bliszczyk
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-27 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -119,6 +119,7 @@ files:
 - docs/checks/deprecated_filter.md
 - docs/checks/form_action.md
 - docs/checks/form_authenticity_token.md
+- docs/checks/graphql_in_for_loop.md
 - docs/checks/html_parsing_error.md
 - docs/checks/img_lazy_loading.md
 - docs/checks/img_width_and_height.md
@@ -164,6 +165,7 @@ files:
 - lib/platformos_check/checks/deprecated_filter.rb
 - lib/platformos_check/checks/form_action.rb
 - lib/platformos_check/checks/form_authenticity_token.rb
+- lib/platformos_check/checks/graphql_in_for_loop.rb
 - lib/platformos_check/checks/html_parsing_error.rb
 - lib/platformos_check/checks/img_lazy_loading.rb
 - lib/platformos_check/checks/img_width_and_height.rb
@@ -316,6 +318,7 @@ files:
 - lib/platformos_check/tags/base_block.rb
 - lib/platformos_check/tags/base_tag_methods.rb
 - lib/platformos_check/tags/cache.rb
+- lib/platformos_check/tags/context.rb
 - lib/platformos_check/tags/export.rb
 - lib/platformos_check/tags/form.rb
 - lib/platformos_check/tags/function.rb