blob: 0bd5c587205f901ee4f5e236fb503b7f1df6a6a7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# frozen_string_literal: true
module RuboCop
module Cop
module BackgroundMigration
# Checks for rescuing errors inside Batched Background Migration Job Classes.
#
# @example
#
# # bad
# def perform
# do_something
# rescue StandardError => error
# logger.error(error.message)
# end
#
# # bad
# def perform
# do_something
# rescue JSON::ParserError, ActiveRecord::StatementTimeout => error
# logger.error(error.message)
# end
#
# # good
# def perform
# do_something
# rescue StandardError => error
# logger.error(error.message)
#
# raise
# end
#
# # good
# def perform
# do_something
# rescue JSON::ParserError, ActiveRecord::StatementTimeout => error
# logger.error(error.message)
#
# raise MyCustomException
# end
class AvoidSilentRescueExceptions < RuboCop::Cop::Base
MSG = 'Avoid rescuing exceptions inside job classes. See ' \
'https://docs.gitlab.com/ee/development/database/batched_background_migrations.html#best-practices'
def_node_matcher :batched_migration_job_class?, <<~PATTERN
(class
const
(const {nil? cbase const} :BatchedMigrationJob)
...
)
PATTERN
# Matches rescued exceptions that were not re-raised
#
# @example
# rescue => error
# rescue Exception => error
# rescue JSON::ParserError => e
# rescue ActiveRecord::StatementTimeout => error
# rescue ActiveRecord::StatementTimeout, ActiveRecord::QueryCanceled => error
def_node_matcher :rescue_timeout_error, <<~PATTERN
(resbody $_ _ (... !(send nil? :raise ...)))
PATTERN
def on_class(node)
@batched_migration_job_class ||= batched_migration_job_class?(node)
end
def on_resbody(node)
return unless batched_migration_job_class
rescue_timeout_error(node) do |error|
range = error ? node.loc.keyword.join(error.loc.expression) : node.loc.keyword
add_offense(range)
end
end
private
attr_reader :batched_migration_job_class
end
end
end
end
|
