Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Change beginAuth sessions default to online #203

Merged
merged 15 commits into from
Oct 13, 2021

Conversation

Paulinakhew
Copy link
Contributor

@Paulinakhew Paulinakhew commented Jun 18, 2021

WHY are these changes introduced?

Change the default for OAuth.beginAuth to online sessions to match the default for loadCurrentSession.

WHAT is this pull request doing?

  • change default for beginAuth's isOnline parameter to true for online access tokens

Type of change

  • Patch: Bug (non-breaking change which fixes an issue)
  • Minor: New feature (non-breaking change which adds functionality)
  • Major: Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have added a changelog entry, prefixed by the type of change noted above
  • I have added/updated tests for this change
  • I have documented new APIs/updated the documentation for modified APIs (for public APIs)

@Paulinakhew Paulinakhew requested a review from a team as a code owner June 18, 2021 15:56
Copy link
Contributor

@paulomarg paulomarg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with one nit: we should update the docs page for this method too, to make sure the param is documented, and so is its default value.

Copy link
Contributor

@paulomarg paulomarg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Let's not merge this yet until we've had a chance to make all of the breaking changes so we can release it all at once.

@caution-tape-bot
Copy link

Shopify's style guide prefers avoiding terms like "white-list" and "black-list".

Drop in replacements include "allow-list" and "deny-list", or "clearlist" and "blocklist". Also consider if there is a domain specific term you could use.

For example, "parameter white-list" could be replaced with "parameter allow-list", but "trusted parameters" may more suitable.

docs/usage/oauth.md Outdated Show resolved Hide resolved
@Paulinakhew Paulinakhew force-pushed the beginAuth-set-online-sessions branch from 0779b13 to 6287278 Compare July 12, 2021 15:34
Copy link
Contributor

@paulomarg paulomarg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a nit on the docs.

docs/usage/oauth.md Outdated Show resolved Hide resolved
Paulinakhew and others added 5 commits August 23, 2021 11:03
Register webhooks section (Express) loadCurrentSession method uses `request` and `response` props instead of `req` and `res` as returned in the callback
Copy link
Contributor

@mkevinosullivan mkevinosullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, some minor nit picks.

docs/usage/webhooks.md Outdated Show resolved Hide resolved
src/auth/oauth/test/oauth.test.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@mkevinosullivan mkevinosullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - one small note

@mllemango mllemango changed the base branch from main to v2 October 13, 2021 20:37
@mllemango mllemango merged commit 39f1623 into v2 Oct 13, 2021
@mllemango mllemango deleted the beginAuth-set-online-sessions branch October 13, 2021 20:39
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants