BigW Consortium Gitlab

module_with_instance_variables.md 7.87 KB
Newer Older
1
## Modules with instance variables could be considered harmful
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

### Background

Rails somehow encourages people using modules and instance variables
everywhere. For example, using instance variables in the controllers,
helpers, and views. They're also encouraging the use of
`ActiveSupport::Concern`, which further strengthens the idea of
saving everything in a giant, single object, and people could access
everything in that one giant object.

### The problems

Of course this is convenient to develop, because we just have everything
within reach. However this has a number of downsides when that chosen object
is growing, it would later become out of control for the same reason.

There are just too many things in the same context, and we don't know if
those things are tightly coupled or not, depending on each others or not.
It's very hard to tell when the complexity grows to a point, and it makes
tracking the code also extremely hard. For example, a class could be using
3 different instance variables, and all of them could be initialized and
manipulated from 3 different modules. It's hard to track when those variables
start giving us troubles. We don't know which module would suddenly change
one of the variables. Everything could touch anything.

### Similar concerns

People are saying multiple inheritance is bad. Mixing multiple modules with
multiple instance variables scattering everywhere suffer from the same issue.
The same applies to `ActiveSupport::Concern`. See:
[Consider replacing concerns with dedicated classes & composition](
https://gitlab.com/gitlab-org/gitlab-ce/issues/23786)

There's also a similar idea:
[Use decorators and interface segregation to solve overgrowing models problem](
https://gitlab.com/gitlab-org/gitlab-ce/issues/13484)

Note that `included` doesn't solve the whole issue. They define the
dependencies, but they still allow each modules to talk implicitly via the
instance variables in the final giant object, and that's where the problem is.

### Solutions

We should split the giant object into multiple objects, and they communicate
46
with each other with the API, i.e. public methods. In short, composition over
47 48 49 50 51 52 53 54 55
inheritance. This way, each smaller objects would have their own respective
limited states, i.e. instance variables. If one instance variable goes wrong,
we would be very clear that it's from that single small object, because
no one else could be touching it.

With clearly defined API, this would make things less coupled and much easier
to debug and track, and much more extensible for other objects to use, because
they communicate in a clear way, rather than implicit dependencies.

56
### Acceptable use
57

58 59 60
However, it's not always bad to use instance variables in a module,
as long as it's contained in the same module; that is, no other modules or
objects are touching them, then it would be an acceptable use.
61

62 63
We especially allow the case where a single instance variable is used with
`||=` to setup the value. This would look like:
64 65

``` ruby
66 67 68 69 70 71 72 73
module M
  def f
    @f ||= true
  end
end
```

Unfortunately it's not easy to code more complex rules into the cop, so
74 75
we rely on people's best judgement. If we could find another good pattern
we could easily add to the cop, we should do it.
76 77 78 79

### How to rewrite and avoid disabling this cop

Even if we could just disable the cop, we should avoid doing so. Some code
80
could be easily rewritten in simple form. Consider this acceptable method:
81 82 83 84 85 86 87 88 89 90 91 92 93

``` ruby
module Gitlab
  module Emoji
    def emoji_unicode_version(name)
      @emoji_unicode_versions_by_name ||=
        JSON.parse(File.read(Rails.root.join('fixtures', 'emojis', 'emoji-unicode-version-map.json')))
      @emoji_unicode_versions_by_name[name]
    end
  end
end
```

94 95 96 97 98 99
This method is totally fine because it's already self-contained. No other
methods should be using `@emoji_unicode_versions_by_name` and we're good.
However it's still offending the cop because it's not just `||=`, and the
cop is not smart enough to judge that this is fine.

On the other hand, we could split this method into two:
100 101 102 103 104 105

``` ruby
module Gitlab
  module Emoji
    def emoji_unicode_version(name)
      emoji_unicode_versions_by_name[name]
106 107
    end

108 109 110 111 112 113
    private

    def emoji_unicode_versions_by_name
      @emoji_unicode_versions_by_name ||=
        JSON.parse(File.read(Rails.root.join('fixtures', 'emojis', 'emoji-unicode-version-map.json')))
    end
114 115 116 117
  end
end
```

118
Now the cop won't complain. Here's a bad example which we could rewrite:
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

``` ruby
module SpamCheckService
  def filter_spam_check_params
    @request            = params.delete(:request)
    @api                = params.delete(:api)
    @recaptcha_verified = params.delete(:recaptcha_verified)
    @spam_log_id        = params.delete(:spam_log_id)
  end

  def spam_check(spammable, user)
    spam_service = SpamService.new(spammable, @request)

    spam_service.when_recaptcha_verified(@recaptcha_verified, @api) do
      user.spam_logs.find_by(id: @spam_log_id)&.update!(recaptcha_verified: true)
    end
  end
end
```

There are several implicit dependencies here. First, `params` should be
140
defined before use. Second, `filter_spam_check_params` should be called
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
before `spam_check`. These are all implicit and the includer could be using
those instance variables without awareness.

This should be rewritten like:

``` ruby
class SpamCheckService
  def initialize(request:, api:, recaptcha_verified:, spam_log_id:)
    @request            = request
    @api                = api
    @recaptcha_verified = recaptcha_verified
    @spam_log_id        = spam_log_id
  end

  def spam_check(spammable, user)
    spam_service = SpamService.new(spammable, @request)

    spam_service.when_recaptcha_verified(@recaptcha_verified, @api) do
      user.spam_logs.find_by(id: @spam_log_id)&.update!(recaptcha_verified: true)
    end
  end
end
```

And use it like:

``` ruby
class UpdateSnippetService < BaseService
  def execute
    # ...
    spam = SpamCheckService.new(params.slice!(:request, :api, :recaptcha_verified, :spam_log_id))

    spam.check(snippet, current_user)
    # ...
  end
end
```

This way, all those instance variables are isolated in `SpamCheckService`
180 181 182
rather than whatever includes the module, and those modules which were also
included, making it much easier to track down any issues,
and reducing the chance of having name conflicts.
183

184 185 186 187 188 189 190
### How to disable this cop

Put the disabling comment right after your code in the same line:

``` ruby
module M
  def violating_method
191
    @f + @g # rubocop:disable Gitlab/ModuleWithInstanceVariables
192 193 194 195 196 197 198 199
  end
end
```

If there are multiple lines, you could also enable and disable for a section:

``` ruby
module M
200
  # rubocop:disable Gitlab/ModuleWithInstanceVariables
201 202 203 204 205
  def violating_method
    @f = 0
    @g = 1
    @h = 2
  end
206
  # rubocop:enable Gitlab/ModuleWithInstanceVariables
207 208 209 210 211 212
end
```

Note that you need to enable it at some point, otherwise everything below
won't be checked.

213 214
### Things we might need to ignore right now

215
Because of the way Rails helpers and mailers work, we might not be able to
216 217
avoid the use of instance variables there. For those cases, we could ignore
them at the moment. At least we're not going to share those modules with
218
other random objects, so they're still somewhat isolated.
219

220
### Instance variables in views
221

222 223 224
They're bad because we can't easily tell who's using the instance variables
(from controller's point of view) and where we set them up (from partials'
point of view), making it extremely hard to track data dependency.
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

We're trying to use something like this instead:

``` haml
= render 'projects/commits/commit', commit: commit, ref: ref, project: project
```

And in the partial:

``` haml
- ref = local_assigns.fetch(:ref)
- commit = local_assigns.fetch(:commit)
- project = local_assigns.fetch(:project)
```

240 241
This way it's clearer where those values were coming from, and we gain the
benefit to have typo check over using instance variables. In the future,
242
we should also forbid the use of instance variables in partials.