Support App Bridge 2.0 in shopify_app

[rezaansyed]

What this PR does

⚠️ This is a breaking change

Support App Bridge 2.0 in shopify_app.

Reviewer's guide to testing

• Import local version of this branch to new app
• Ensure that app runs as expected in Admin

Things to focus on

Ensure migration strategy is followed as per the guide.

Checklist

Before submitting the PR, please consider if any of the following are needed:

• Update CHANGELOG.md if the changes would impact users
• Update README.md, if appropriate.
• Update any relevant pages in /docs, if necessary
• For security fixes, the Disclosure Policy must be followed.

[hannachen]

Looks good to me 👍

[paulomarg]

Haven't 🎩 ed it, but the code looks good.

[paulomarg]

I've tried this out now, and I got the following error:

message: "APP::ERROR::INVALID_CONFIG: host must be provided"
name: "AppBridgeError"
type: "APP::ERROR::INVALID_CONFIG"

It seems that coming back from OAuth, we're lacking the host parameter and thus we can't load App Bridge properly.

[rezaansyed]

I've tried this out now, and I got the following error:

message: "APP::ERROR::INVALID_CONFIG: host must be provided"
name: "AppBridgeError"
type: "APP::ERROR::INVALID_CONFIG"

It seems that coming back from OAuth, we're lacking the host parameter and thus we can't load App Bridge properly.

Noticing that on my end too. It has to do with the HomeController not having the host param passed in and can't initialize App Bridge at the top level. Is there any way for us to know of the host during OAuth @hannachen?

[NabeelAhsen]

If the host parameter is part of the callback URL sent by Shopify to the app, step 3 of this doc might be outdated: https://shopify.dev/tutorials/authenticate-with-oauth#step-3-confirm-installation

Is this where the host parameter is initially supposed to come from?

[rezaansyed]

If the host parameter is part of the callback URL sent by Shopify to the app, step 3 of this doc might be outdated: https://shopify.dev/tutorials/authenticate-with-oauth#step-3-confirm-installation

Is this where the host parameter is initially supposed to come from?

It's not part of the callback controller. The failure happens when hitting the home controller at the top level right after the callback controller though.

[paulomarg]

Should we be including the host in the redirect URL when we begin OAuth? That way, we'd be able to reference it when coming back.

[NabeelAhsen]

This is needed because of the following:

shopify_app/app/controllers/shopify_app/callback_controller.rb

Lines 24 to 30 in 2fcf794

	def respond_successfully
	if jwt_request?
	head(:ok)
	else
	redirect_to(return_address)
	end
	end

[NabeelAhsen]

Things I'm unsure about here:

• Right now, there are two known places that use return_address in this code base. Is raising when host isn't found the the correct move here?
• What other tests are affected by this?

[paulomarg]

Considering we currently throw a similar exception for the domain, it makes sense to me to continue to throw here.

[NabeelAhsen]

I've tried this out now, and I got the following error:

message: "APP::ERROR::INVALID_CONFIG: host must be provided"
name: "AppBridgeError"
type: "APP::ERROR::INVALID_CONFIG"
It seems that coming back from OAuth, we're lacking the host parameter and thus we can't load App Bridge properly.

All apps should now be receiving the host param on OAuth callback. I verified this by creating a new app using this branch and checking the OAuth callback redirects.

Should we be including the host in the redirect URL when we begin OAuth? That way, we'd be able to reference it when coming back.

This host param comes from Shopify's generated URLs, so we'd only be aware of them on OAuth return

[paulomarg]

🎩 ed again, OAuth worked correctly for me now.

[paulomarg]

Considering we currently throw a similar exception for the domain, it makes sense to me to continue to throw here.

[asecondwill]

This does not work when trying to update a JWT Turbo Example app. Please can you test with that and provide instructions @NabeelAhsen

[asecondwill]

no host param comes back. this is URGENT because the review team insist on App Bridge 2. PLEASE HELP.

[asecondwill]

Probably worth noting, host is not passed back in the params @paulomarg