fix: specify dependency versions

[prikha]

BREAKING CHANGE: Requires graphql ~> 1.9.8 and google-protobuf ~> 3.7

There is no version specified for the dependencies. This is unpleasant for those trying to integrate the gem with existing codebase. Even though the library is its early development stage it would be nice to at least specify requirements. Versions could be adjusted later on, but it's way easier to spot a problem that to see misleading protobuf errors.

[rylanc]

@lennyburdette Any idea what the minimum version of google-protobuf is that would work with federated tracing?

[rylanc]

This is technically going to be a breaking change, since it may require users to upgrade their versions of google-protobuf and graphql (and those upgrades may include breaking changes). I'd like to keep the required dependencies at the lowest reasonable versions. Personally, my company uses version 1.9.8 of grapqhl and things are working well. Since graphql-ruby sometimes introduces breaking changes in minor versions (and even patch versions), let's make it ~> 1.9.8. Unless someone else has a lower version they can report success with.

I'd like to nail down a good range for google-protobuf too. It seems like the gem uses traditional semantic versioning, so we may be OK with ~> 3.0. @lennyburdette does that sound right?

[lennyburdette]

Using ~> 3.0 should work just fine, but I wouldn't say that google-protobuf uses strict semantic versioning. Glancing at the changelog, they've dropped support for older versions of Ruby and removed API in minor releases.

[prikha]

@lennyburdette @rylanc I get what you say, but the PR came from a need:

Version 3.6.0 clearly doesn't work

Failure/Error:
  add_file('apollo.proto', syntax: :proto3) do
    add_message 'mdg.engine.proto.Trace' do
      optional :start_time, :message, 4, 'google.protobuf.Timestamp'
      optional :end_time, :message, 3, 'google.protobuf.Timestamp'
      optional :duration_ns, :uint64, 11
      optional :root, :message, 14, 'mdg.engine.proto.Trace.Node'
      optional :signature, :string, 19
      optional :details, :message, 6, 'mdg.engine.proto.Trace.Details'
      optional :client_name, :string, 7
      optional :client_version, :string, 8

NoMethodError:
  undefined method `add_file' for #<Google::Protobuf::Internal::Builder:0x00007fbb4ca90f10>
  Did you mean?  add_enum

Version 3.7.0 and above seems to be good. So changed the minimum required version to 3.7.0

[prikha]

@lennyburdette @rylanc @noaelad ☝️

[prikha]

@lennyburdette @rylanc @noaelad ☝️

[rylanc]

Sorry for the delay. We'll need to set the version of google-protobuf to ~> 3.7 instead of ~> 3.7.0. If we leave the patch number, it means that 3.8 and above won't match. Also, it should mean that the Gemfile.lock version is unchanged.

[prikha]

@rylanc done

[rylanc]

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀