Deprecate ShopifyAPI::Context in favour of instance-based configuration

[sterrym]

Description

This is an experiment to allow all methods that use ShopifyAPI::Context to use an instance-based configuration instead. There is an attempt to maintain backwards-compatibility as all method parameters still default to ShopifyAPI::Context

At time of writing, these are the impacted methods:

• [x] ShopifyAPI::Auth.embedded_app_url
• [x] ShopifyAPI::Auth::JwTPayload.new
• [x] ShopifyAPI::Auth::Oauth.begin_auth
• [x] ShopifyAPI::Auth::Oauth.validate_auth_callback
• [x] ShopifyAPI::Auth::Session.temp
• [x] ShopifyAPI::Clients::Graphql::Admin.new
• [x] ShopifyAPI::Clients::Graphql::Client.new
• [x] ShopifyAPI::Clients::HttpClient.new
• [x] ShopifyAPI::Clients::Rest::Admin.new
• [x] ShopifyAPI::Rest::Base.new
• [x] ShopifyAPI::Utils::GraphqlProxy.proxy_query
• [x] ShopifyAPI::Utils::HmacValidator.validate
• [x] ShopifyAPI::Utils::SessionUtils.current_session_id
• [x] ShopifyAPI::Webhooks::Registration.new
• [x] ShopifyAPI::Webhooks::Registrations::Http.new
• [x] ShopifyAPI::Webhooks::Registry.add_registration
• [x] ShopifyAPI::Webhooks::Registry.process
• [ ] ShopifyAPI::Logger.debug
• [ ] ShopifyAPI::Logger.info
• [ ] ShopifyAPI::Logger.warn
• [ ] ShopifyAPI::Logger.error
• [ ] ShopifyAPI::Logger.deprecated

Please, include a summary of what the PR is for:

• What is the problem it is solving?

There is a desire/need to create more than one Shopify App within a single Rails application.

• What is the context of these changes?

• What is the impact of this PR?

We are attempting to have zero-impact on current users other than potentially a deprecation notification.

How has this been tested?

All existing tests continue to function. We added configuration parameter options to all tests as well. We also top-hatted these changes by using this branch to create and install a new Shopify App

Checklist:

• [x] My commit message follow the pattern described in here
• [x] I have performed a self-review of my own code.
• [ ] I have added tests that prove my fix is effective or that my feature works.
• [ ] I have updated the project documentation.
• [ ] I have added a changelog line.

[lizkenyon]

Hi there 👋

Could you give us a bit more context on the use case for this 👇

desire/need to create more than one Shopify App within a single Rails application.

[sterrym]

Hi there 👋

Could you give us a bit more context on the use case for this 👇

desire/need to create more than one Shopify App within a single Rails application.

Absolutely. This was initially an internal need that we figured other partners would be interested in as well. Specifically, we are building multiple payments apps within an existing Shopify rails app. In our specific case, we are actually building a single Rails engine that supports three different types of payments apps. Each of them needs to be configured in a different way.

Internally, we ended up going another direction and are just using internal Shopify tools but I still suspect there's a valid use-case here.

[lizkenyon]

Thanks @sterrym for the added context!

I am going to close this for now. But we may reach out for additional context if we want to move forward at a later date!