Skip to content

Conversation

@aduh95
Copy link
Contributor

@aduh95aduh95 commented Nov 2, 2020

The function was not checking if the parameter was actually a Promise
instance, but if it has a then method. Removing the utility function
in favor of a clearer typeof check, handling the case when the
thenable throws if then method is accessed more than once.

The difference between a thenable and a Promise may be important when using third party library (the parameter is provided by the user) and/or when Promise.prototype.then value is changed from userland.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/streams

Copy link
Member

@ronagronag left a comment

Choose a reason for hiding this comment

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

I'm not sure this is an improvement? The behavior is the same?

@aduh95
Copy link
ContributorAuthor

Yes the behavior is the same. Another way would be to change the name of the function isPromise -> isThenable.

@benjamingr
Copy link
Member

Actually the current implementation (and the one in this PR) is wrong if someone passes a thenable where then is a getter that throws the second time then is accessed.

It's not a big bug but promise test suites check for it.

The correct implementation would be to do it in "two steps":

  • First do const then = ret?.then
  • Then check if(typeof then === "function")
  • Then do then.call(ret, ...)

See here for an example

ronag added a commit to nodejs/undici that referenced this pull request Nov 2, 2020
The function was not checking if the parameter was actually a Promise instance, but if it has a `then` method. Removing the utility function in favor of a clearer `typeof` check, handling the case when the thenable throws if then method is accessed more than once.
@aduh95aduh95force-pushed the stream-remove-isPromise branch from 35e4d0a to f18db47CompareNovember 2, 2020 16:21
@aduh95aduh95 requested a review from ronagNovember 2, 2020 16:21
@aduh95
Copy link
ContributorAuthor

I've implemented the solution suggested by @benjamingr, PTAL.

Copy link
Member

@benjamingrbenjamingr left a comment

Choose a reason for hiding this comment

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

Please consider adding a test.

If you prefer not to - I'll add one sometime after this lands :]

@aduh95
Copy link
ContributorAuthor

Test added! It does fail on master and not with this PR, PTAL.

@ronag Have your concerns been addressed?

@aduh95
Copy link
ContributorAuthor

@ronag are you still blocking this or can your objection be dismissed?

@aduh95aduh95 added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 8, 2020
@github-actionsgithub-actionsbot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 8, 2020
@nodejs-github-bot

This comment has been minimized.

@nodejs-github-bot

This comment has been minimized.

@nodejs-github-bot

This comment has been minimized.

@nodejs-github-bot
Copy link
Collaborator

Copy link
Member

@mcollinamcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@mcollinamcollina added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 9, 2020
@github-actionsgithub-actionsbot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 9, 2020
@github-actions
Copy link
Contributor

Landed in adae822...ad98cf0

nodejs-github-bot pushed a commit that referenced this pull request Nov 9, 2020
The function was not checking if the parameter was actually a Promise instance, but if it has a `then` method. Removing the utility function in favor of a clearer `typeof` check, handling the case when the thenable throws if then method is accessed more than once. PR-URL: #35925 Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
@aduh95aduh95 deleted the stream-remove-isPromise branch November 9, 2020 08:32
danielleadams pushed a commit that referenced this pull request Nov 9, 2020
The function was not checking if the parameter was actually a Promise instance, but if it has a `then` method. Removing the utility function in favor of a clearer `typeof` check, handling the case when the thenable throws if then method is accessed more than once. PR-URL: #35925 Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
@danielleadamsdanielleadams mentioned this pull request Nov 9, 2020
targos pushed a commit that referenced this pull request May 1, 2021
The function was not checking if the parameter was actually a Promise instance, but if it has a `then` method. Removing the utility function in favor of a clearer `typeof` check, handling the case when the thenable throws if then method is accessed more than once. PR-URL: #35925 Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
@danielleadamsdanielleadams mentioned this pull request May 3, 2021
Sign up for freeto 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.

5 participants

@aduh95@nodejs-github-bot@benjamingr@mcollina@ronag