Improve upgrade docs #1525
Merged
Improve upgrade docs #1525
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andyw8
commented
Oct 5, 2022
| generate a block in the `shopify_app` initializer. To do so manually, ensure the following is | ||
| part of the `after_initialize` block in `shopify_app.rb`. | ||
|
|
||
| ```ruby |
There was a problem hiding this comment.
(For easier long-term maintenance of this document, I think it's better to refer to the template rather than duplicating its contents here.)
|
FYI @teddy. (I have more to add). I'm also thinking it maybe useful to have separate internal page for aspects that apply only to first-party apps. |
andyw8
commented
Oct 5, 2022
|
|
||
| Previously, we set the entire app user object in the `session` object. | ||
| As of v19, since we no longer save the app user to the session (but only the shopify user id), we now store it as `session[:shopify_user_id]`. Please make sure to update any references to that object. | ||
|
|
||
| #### Webhook Jobs | ||
|
|
||
| It is assumed that you have an ActiveJob implementation configured for `perform_later`, e.g. Sidekiq. |
There was a problem hiding this comment.
(some apps may have been using a plain Ruby class with the perform method).
andyw8
force-pushed
the
andyw8/improve-upgrade-docs
branch
2 times, most recently
from
28199b4 to
67dfce6
Compare
andyw8
commented
Oct 14, 2022
docs/Upgrading.md
Outdated
| # Common Errors | ||
|
|
||
| * `redirect_uri is not whitelisted` – you likely need to update the App Setup on https://partners.shopify.com/. | ||
| * `This app can’t load due to an issue with browser cookies` - this can be caused by an infinite redirect due to coding error. |
There was a problem hiding this comment.
If we proceed with #1530 then it should hopefully reduce the need for this.
andyw8
force-pushed
the
andyw8/improve-upgrade-docs
branch
3 times, most recently
from
f6c0c9d to
381293c
Compare
nelsonwittwer
approved these changes
Oct 14, 2022
andyw8
force-pushed
the
andyw8/improve-upgrade-docs
branch
3 times, most recently
from
d188e55 to
d261a19
Compare
teddyhwang
reviewed
Oct 14, 2022
docs/Upgrading.md
Outdated
Comment on lines
50
to
51
| This can be caused by an infinite redirect due to a coding error. | ||
| To investigate the cause, you can add a breakpoint or logging to the `rescue` clause of `ShopifyApp::CallbackController`. |
There was a problem hiding this comment.
Can we add in specific examples that we are aware of that would cause this redirect loop?
There was a problem hiding this comment.
Yeah, we might want to mention that this could be cause by using the Authenticated concern in a Fetch request.
paulomarg
approved these changes
Oct 17, 2022
andyw8
force-pushed
the
andyw8/improve-upgrade-docs
branch
3 times, most recently
from
04ff80b to
25d19f0
Compare
|
/shipit |
andyw8
force-pushed
the
andyw8/improve-upgrade-docs
branch
from
25d19f0 to
86f8fc1
Compare
fabriazza
pushed a commit
to fabriazza/shopify_app
that referenced
this pull request
Feb 1, 2023
Co-authored-by: Andy Waite <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
Reviewer's guide to testing
Things to focus on
Checklist
Before submitting the PR, please consider if any of the following are needed:
CHANGELOG.mdif the changes would impact usersREADME.md, if appropriate./docs, if necessary