Trapped by Ruby Operators Precedence

YenTing Chen — Sat, 22 Feb 2020 16:40:23 +0000

Let the story begin

I started to work on a new production code repository, and I could tell my productivity degraded for almost 7 workdays. But this was not because of my lack of domain knowledge in the new production code nor the new development environment and configuration. Even though I had some issues and was unfamiliar, I still deliver several items.

It was the inability to do development and run test all in my most familiar IDE. To workaround this, I had to go back and forth between my IDE and terminal to run my test command.

Observations and the fix

I got two from my investigation. The first one was obvious => the error. It was an unexpected outgoing network request when running test with my IDE. (We don't want test has dependencies on network.) The other was the different commands for tests. In terminal, I used bundle exec rails test <test_file> and my IDE uses ruby -Itest <test_file>.

So simple thing first, could I reproduce it with the same command from my IDE? And the answer was yes. Great, I got consistency in both environments. Different commands may lead to the differences in the flow of the commands. But let me go into the error one which is more likely a human error.

Guess what. It's caused by a network library initialization wrapped by a guard condition. Like below.

if defined? NET_TOOL && !Rails.env.test? # <= The guard does not work
  # DO the initialization
end

Changing it to the code below fixed the problem!

if !Rails.env.test? && defined?(NET_TOOL)
  # DO the initialization
end

Boom!!

What happened?

This is something about Ruby's operator precedence. You can refer the post here.

The original guard condition is,

defined? NET_TOOL && !Rails.env.test?`

With which we want it to be.

defined?(NET_TOOL) && !Rails.env.test?`

However, the && operator has higher order than defined?, so the expression actually becomes defined?(NET_TOOL && !Rails.env.test?).

Further, NET_TOOL namespace exists and !Rails.env.test? is false in testing. The code will be recognized as defined?(false) and it returns a "expression" string.

In Ruby, if-statement cares about falsy and truthy, not the boolean value, true and false.
Truthy means values that are not nil or false. Therefore, our original if-statement always gets a truthy value. And as a result, it always does the initialization.

Pretty interesting, huh?

Thoughts

I believe that the entire effort would never be reduced. It's just moved to somewhere else. Like my story, Ruby allows us to ignore parenthesis but that also makes expression evaluation implicit. To make the program runs as we think, we have to be aware of those implicit rules.

Maybe there are some better pattern to live with no-parenthesis style. If you know, please let me know. I really want to learn that. But before that, I would suggest using parenthesis to reduce the chance that the code runs differently from we think.

Another mysterious thing to dive into but not this time.

Remember the two different commands? That would be another story about what rails does and how it makes different from ruby.

Originally post on https://jimytc.com