Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: correctly check for promise in useLoadData #39

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

NielsJPeschel
Copy link
Contributor

Proposed changes

Currently, useLoadData makes the assumption a promise is a native promises. Non-native promises lead to a bug where we immediately assign loadedData.result a promise without ever evaluating that promise.

The fix is to go into further depth when checking initial promise.

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

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

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

@NielsJPeschel NielsJPeschel requested a review from nthurow January 9, 2025 18:44
hooks/useLoadData/useLoadData.ts Outdated Show resolved Hide resolved
hooks/useLoadData/useLoadData.ts Show resolved Hide resolved
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nthurow Ran this test with how useLoadData was written before (ie using instanceof Promise), and it did in fact fail! I was worried we wouldn't be able to test this scenario adequately, but glad that isn't the case!

@@ -1,6 +1,6 @@
{
"name": "@optum/react-hooks",
"version": "1.0.4",
"version": "1.0.5-next.1",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

we should start looking at automating this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants