Runtime Dependencies / Deprecation Warnings / More Visibility into Compatibility

[nickagliano-st]

Hello!

I ran into some pretty difficult-to-track-down bugs recently while upgrading a codebase from Rails 6.x to 7.x.

(This was exacerbated by the fact that I use ScoutAPM in production, but not staging.)

I was on the very old scout_apm (2.6.10) and upgrading to scout_apm (5.6.1) fixed it.

The specific error I was getting was on all of my models, Incorrect number of arguments passed: 2, expected 3..4, when calling Model.first, Model.find, Model.find_by, etc.

All this to say, I think it might save other developers a headache if there are more guardrails around this.

It could be deprecation warnings, a minimum Rails version set in gemspec, etc. I'm not very familiar with gemspecs or publishing gems--I'm more used to the consumer side of things--so I'm sorry if this issue/suggestion is malinformed.

Thank you!!

[lancetarn]

Hi @nickagliano-st I appreciate the suggestion. The fact that our gem doesn't take hard dependencies on many others (i.e. the things we instrument tend to be completely optional) makes this a bit tricky, but I'm sure we can do better.