FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[FIX] includeExpired set to false should not automatically return null by rafaelsorto · Pull Request #397 · Shopify/shopify-api-php · GitHub

/ shopify-api-php Public

[FIX] includeExpired set to false should not automatically return null - #397

Open
rafaelsorto wants to merge 1 commit into
Shopify:mainfrom
rafaelsorto:main
ConversationCommits (1)ChecksFiles changed
Open

[FIX] includeExpired set to false should not automatically return null #397
rafaelsorto wants to merge 1 commit into
Shopify:mainfrom
rafaelsorto:main

Conversation

rafaelsorto commented Jan 31, 2025

Copy link
Copy Markdown

includeExpired set to false is incorrectly forcing the loadOfflineSession method to always return null. Offline sessions should not be considered invalid automatically if they don't have an expiration date and the property should be used in the valid check to discard expired sessions.

WHY are these changes introduced?

  • Bug not reported for this issue. Identified on production.

  • Offline sessions not used even when they exist and token is valid

WHAT is this pull request doing?

  • It fixes the incorrect checks for a Offline Session

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 updated the documentation for public APIs from the library (if applicable)

rafaelsorto commented Jan 31, 2025

Copy link
Copy Markdown
Author

I have signed the CLA!

Arkham commented Feb 3, 2025

Copy link
Copy Markdown
Contributor

hey @rafaelsorto, thanks for your contribution. Could you please add a test?

rafaelsorto commented Feb 4, 2025

Copy link
Copy Markdown
Author

hey @rafaelsorto, thanks for your contribution. Could you please add a test?

Hey @Arkham I see that the tests are passing even with the previous code and also pass with my changes. Looking further into this it seems the only change is that isValid is not actually checked if you pass includeExpired set to true which misses the checks for a valid access_token and a valid scope.

The default includeExpired check for a valid token, but the validity check does 3 things at once, checks the scope, checks the access_token and checks the date, includeExpired set to true avoids the expiration check but also avoids the other 2 checks at the same time.

Arkham commented Feb 4, 2025

Copy link
Copy Markdown
Contributor

Yeah, what I'm suggesting is that you add a new test that would fail with the existing code, then it should pass when we change the implementation.

This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Waiting for Response

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL