Merge remote-tracking branch 'shopify/main' into denis/merge-shopify-main

denisdefreyne · denisdefreyne · commit a33237f0e9cc · 2025-04-11T11:14:07.000+02:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
+    groups:
+      minor-and-patch:
+        update-types:
+          - "minor"
+          - "patch"
+    open-pull-requests-limit: 100
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,10 +12,10 @@ jobs:
     name: Ruby ${{ matrix.version }}
     strategy:
       matrix:
-        version: [3.0, 3.1, 3.2]
+        version: [3.0, 3.1, 3.2, 3.3]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.version }}
         uses: ruby/setup-ruby@v1
         with:
diff --git a/.github/workflows/rubocop.yml b/.github/workflows/rubocop.yml
@@ -7,11 +7,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 3.0
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0
         bundler-cache: true
     - name: Install gems
       run: |
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -2,7 +2,6 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 3.0
   NewCops: disable
   SuggestExtensions: false
   Exclude:
diff --git a/.ruby-version b/.ruby-version
@@ -0,0 +1 @@
+3.3.0
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.7.2)
+    smart_todo (1.10.0)
       prism (~> 1.0)
 
 GEM
diff --git a/dev.yml b/dev.yml
@@ -4,7 +4,7 @@ type:
   - ruby
 
 up:
-  - ruby: 3.0.2
+  - ruby
   - bundler
 
 console:
diff --git a/lib/smart_todo/cli.rb b/lib/smart_todo/cli.rb
@@ -69,6 +69,9 @@ def define_options
         opts.on("--read-repository-config") do |_repository_config|
           @options[:repository_config] = GitConfigParser.new
         end
+        opts.on("--repo [REPO]", "Repository name to include in notifications") do |repo|
+          @options[:repo] = repo || File.basename(Dir.pwd)
+        end
       end
     end
 
diff --git a/lib/smart_todo/comment_parser.rb b/lib/smart_todo/comment_parser.rb
@@ -2,6 +2,9 @@
 
 module SmartTodo
   class CommentParser
+    SUPPORTED_TAGS = ["TODO", "FIXME", "OPTIMIZE"].freeze
+    TAG_PATTERN = /^#\s(#{SUPPORTED_TAGS.join("|")})\(/
+
     attr_reader :todos
 
     def initialize
@@ -54,7 +57,7 @@ def parse_comments(comments, filepath)
 
         source = comment.location.slice
 
-        if source.match?(/^#\sTODO\(/)
+        if source.match?(TAG_PATTERN)
           todos << current_todo if current_todo
           current_todo = Todo.new(source, filepath)
         elsif current_todo && (indent = source[/^#(\s*)/, 1].length) && (indent - current_todo.indent == 2)
diff --git a/lib/smart_todo/dispatchers/base.rb b/lib/smart_todo/dispatchers/base.rb
@@ -68,7 +68,7 @@ def slack_message(user, assignee)
         <<~EOM
           #{header}
 
-          You have an assigned TODO in the `#{filepath_or_url}` file.
+          You have an assigned TODO in the `#{filepath_or_url}` file#{repo}.
           #{@event_message}
 
           Here is the associated comment on your TODO:
@@ -99,6 +99,15 @@ def filepath_or_url
 
         @file
       end
+
+      def repo
+        repo = @options[:repo]
+        return unless repo
+
+        unless repo.empty?
+          " in repository `#{repo}`"
+        end
+      end
     end
   end
 end
diff --git a/lib/smart_todo/dispatchers/slack.rb b/lib/smart_todo/dispatchers/slack.rb
@@ -7,7 +7,8 @@ module Dispatchers
     class Slack < Base
       class << self
         def validate_options!(options)
-          options[:slack_token] ||= ENV.fetch("SMART_TODO_SLACK_TOKEN") { raise(ArgumentError, "Missing :slack_token") }
+          options[:slack_token] ||= ENV.fetch("SMART_TODO_SLACK_TOKEN", "")
+          raise(ArgumentError, "Missing :slack_token") if options[:slack_token].empty?
 
           options.fetch(:fallback_channel) { raise(ArgumentError, "Missing :fallback_channel") }
         end
@@ -35,15 +36,17 @@ def dispatch
       def dispatch_one(assignee)
         user = slack_user_or_channel(assignee)
 
-        client.post_message(user.dig("user", "id"), slack_message(user, assignee))
-      rescue SlackClient::Error => error
-        if ["users_not_found", "channel_not_found", "is_archived"].include?(error.error_code)
-          user = { "user" => { "id" => @options[:fallback_channel] }, "fallback" => true }
-        else
-          raise(error)
-        end
+        return unless user
 
-        client.post_message(user.dig("user", "id"), slack_message(user, assignee))
+        begin
+          client.post_message(user.dig("user", "id"), slack_message(user, assignee))
+        rescue SlackClient::Error => error
+          user = handle_slack_error(error, "Error dispatching message")
+          retry
+        rescue Net::HTTPError => error
+          $stderr.puts "Error dispatching message: #{error.message}"
+          $stderr.puts "Response: #{error.response.body}"
+        end
       end
 
       private
@@ -58,12 +61,25 @@ def slack_user_or_channel(assignee)
         else
           { "user" => { "id" => assignee } }
         end
+      rescue SlackClient::Error => error
+        handle_slack_error(error, "Error finding user or channel")
+      rescue Net::HTTPError => error
+        $stderr.puts "Error finding user or channel: #{error.message}"
+        $stderr.puts "Response: #{error.response.body}"
       end
 
       # @return [SlackClient] an instance of SlackClient
       def client
         @client ||= SlackClient.new(@options[:slack_token])
       end
+
+      def handle_slack_error(error, message)
+        if ["users_not_found", "channel_not_found", "is_archived"].include?(error.error_code)
+          { "user" => { "id" => @options[:fallback_channel] }, "fallback" => true }
+        else
+          $stderr.puts "#{message}: #{error.message}"
+        end
+      end
     end
   end
 end
diff --git a/lib/smart_todo/slack_client.rb b/lib/smart_todo/slack_client.rb
@@ -32,16 +32,17 @@ def initialize(slack_token)
     # Retrieve the Slack ID of a user from his email
     #
     # @param email [String]
+    # @param min_sleep [Integer] - the minimum sleep time in seconds in case of rate limiting
     # @return [Hash]
     #
     # @raise [Net::HTTPError] in case the request to Slack failed
     # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
     #
     # @see https://api.slack.com/methods/users.lookupByEmail
-    def lookup_user_by_email(email)
-      headers = { "Content-Type" => "application/x-www-form-urlencoded" }
-
-      request(:get, "/api/users.lookupByEmail?email=#{CGI.escape(email)}", nil, headers)
+    def lookup_user_by_email(email, min_sleep = 30)
+      headers = default_headers.merge("Content-Type" => "application/x-www-form-urlencoded")
+      request = Net::HTTP::Get.new("/api/users.lookupByEmail?email=#{CGI.escape(email)}", headers)
+      dispatch(request, 5, min_sleep)
     end
 
     # Send a message to a Slack channel or to a user
@@ -55,39 +56,36 @@ def lookup_user_by_email(email)
     #
     # @see https://api.slack.com/methods/chat.postMessage
     def post_message(channel, text)
-      request(:post, "/api/chat.postMessage", JSON.dump(channel: channel, text: text))
+      headers = default_headers
+      request = Net::HTTP::Post.new("/api/chat.postMessage", headers)
+      request.body = JSON.dump(channel: channel, text: text)
+      dispatch(request)
     end
 
     private
 
-    # @param method [Symbol]
-    # @param endpoint [String]
-    # @param data [String] JSON encoded data when making a POST request
-    # @param headers [Hash]
+    # @param request [Net::HTTPRequest]
+    # @param max_attempts [Integer] - the maximum number of attempts to make
+    # @param min_sleep [Integer] - the minimum sleep time in seconds in case of rate limiting
     #
     # @raise [Net::HTTPError] in case the request to Slack failed
     # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
-    def request(method, endpoint, data = nil, headers = {})
-      response = case method
-      when :post, :patch
-        @client.public_send(method, endpoint, data, default_headers.merge(headers))
-      else
-        @client.public_send(method, endpoint, default_headers.merge(headers))
-      end
+    def dispatch(request, max_attempts = 5, min_sleep = 30)
+      response = @client.request(request)
+      attempts = 1
 
-      slack_response!(response)
-    end
+      while response.is_a?(Net::HTTPTooManyRequests) && attempts < max_attempts
+        sleep_time = Integer(response["Retry-After"]).clamp(min_sleep, 120)
+        puts "Rate limited, sleeping for #{sleep_time} seconds"
+        sleep(sleep_time)
+        response = @client.request(request)
+        attempts += 1
+      end
 
-    # Check if the response to Slack was a 200 and the Slack API request was successful
-    #
-    # @param response [Net::HTTPResponse] a net Net::HTTPResponse subclass
-    #   (Net::HTTPOK, Net::HTTPNotFound ...)
-    # @return [Hash]
-    #
-    # @raise [Net::HTTPError] in case the request to Slack failed
-    # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
-    def slack_response!(response)
-      raise(Net::HTTPError.new("Request to slack failed", response)) unless response.code_type < Net::HTTPSuccess
+      unless response.code_type < Net::HTTPSuccess
+        message = "Request to slack failed #{response.body}, code #{response.code}, attempt #{attempts}"
+        raise(Net::HTTPError.new(message, response))
+      end
 
       body = JSON.parse(response.body)
 
diff --git a/lib/smart_todo/version.rb b/lib/smart_todo/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartTodo
-  VERSION = "1.7.2"
+  VERSION = "1.10.0"
 end
diff --git a/lib/smart_todo_cop.rb b/lib/smart_todo_cop.rb
diff --git a/test/smart_todo/comment_parser_test.rb b/test/smart_todo/comment_parser_test.rb
diff --git a/test/smart_todo/dispatchers/output_test.rb b/test/smart_todo/dispatchers/output_test.rb
diff --git a/test/smart_todo/dispatchers/slack_test.rb b/test/smart_todo/dispatchers/slack_test.rb
diff --git a/test/smart_todo/slack_client_test.rb b/test/smart_todo/slack_client_test.rb
diff --git a/test/smart_todo/smart_todo_cop_test.rb b/test/smart_todo/smart_todo_cop_test.rb
