`require': cannot load such file -- typhoeus

[adrian-gomez]

Bug Report

Version

ruby svix-1.56.0

Platform

OSx

Description

It seems the hard requirement for typhoeus was reintroduced by mistake (?)
The PR #1486 made it optional but I just tried to add svix to our project and got the error in the title when trying to run any rails command.

The require comes from lib/svix.rb#L82 -> lib/svix/api_client.rb#L18

We only plan to validate webhooks so we don't want to the extra dependency if we can avoid it.

[tasn]

Oh, what you're saying is that even though you only plan on using Svix for webhook verification, it's still causing issues for you?

I don't think it was reintroduced (have we even made any changes to the lib since?), but maybe the previous solution wasn't sufficient?

Any idea what we should do to fix it? I don't know Ruby myself, so not sure what's the right solution here. Though how do we make that import path that you shared be optional? (so it doesn't import api_client unless you use it).

[msantam2]

Just chiming in that I'm having the exact same issue -- just making a note that yes, adding typhoeus gem to the Gemfile did resolve this issue - but agreed I'd prefer to not have this dependency in the project if I don't need it

[tasn]

We had it, but removed it following a PR from the community (#1486).

Any suggestions on how to resolve this? CC @jjb

[jjb]

lib/svix/api_client.rb is not in the repo, it is generated by this:

svix-webhooks/ruby/templates/api_client_typhoeus_partial.mustache

Lines 67 to 76 in e1196a9

	begin
	require 'typhoeus'
	rescue LoadError
	raise <<~MESSAGE
	To use svix for sending outgoing webhooks, you need to install the typheous gem.
	Please add it to your Gemfile and then run `bundle install`:
	gem 'typhoeus'
	MESSAGE
	end

so the error message should be different from what @adrian-gomez is experiencing

looking at the published gem:

→ gem install svix
➔ gem which svix
..../gems/svix-1.56.0/lib/svix.rb

looking at ...gems/svix-1.56.0/lib/svix/api_client.rb

we have this at the top

require 'date'
require 'json'
require 'logger'
require 'tempfile'
require 'time'
require 'typhoeus'

so, something in the openapi-generator stack is adding that to the top even though it's not in the template.

[tasn]

Thanks @jjb!

We are in the process of changing how the Ruby code is generated anyway, so I think it'll probably fix itself in the next 7-10 days.

Is there a way to make the api part optional? As in, only make the typeoeus import happen if someone is actually using it?

[jjb]

need to someone make this optional

svix-webhooks/ruby/lib/svix.rb

Line 82 in e1196a9

require "svix/api_client"

a silly way to do that is only require it if typhoeus is installed... may find yourself with confused users

[tasn]

OK, I think we'll just wait until the Ruby lib overhaul @svix-mman and @svix-jplatte are working on.