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

Instantiate CacheableLookup only when needed #1529

Merged
merged 3 commits into from Nov 19, 2020
Merged

Instantiate CacheableLookup only when needed #1529

merged 3 commits into from Nov 19, 2020

Conversation

fungiboletus
Copy link
Contributor

@fungiboletus fungiboletus commented Nov 19, 2020

The dnsCache option is disabled by default but a CacheableLookup instance is always created. The proposed change is to instantiate CacheableLookup only when needed, which may make got a bit faster to load by default and when you do not use the DNS cache.

Moreover, the CacheableLookup class instantiates the DNS Resolver class in NodeJS the standard library, and the test framework Jest has a problem with it. It wrongly detects that something keeps running after the tests are finished, while it's just an instance of the DNS Resolver class. See facebook/jest#6423

Jest should be fixed but meanwhile this small improvement in got may also hide the Jest issue for many developers.

Checklist

  • I have read the documentation.
  • I have included a pull request description of my changes.
  • I have included some tests.
  • If it's a new feature, I have included documentation updates in both the README and the types.

The `dnsCache` option is disabled by default but a `CacheableLookup` instance is always created. The proposed change is to instantiate CacheableLookup only when needed, which may make `got` a bit faster to load by default and when you do not use the DNS cache.

Moreover, the CacheableLookup class instantiates the DNS [`Resolver` class in NodeJS the standard library](https://nodejs.org/api/dns.html#dns_class_dnspromises_resolver), and the test framework [Jest](https://github.com/facebook/jest/) has a problem with it. It wrongly detects that something keeps running after the tests are finished, while it's just an instance of the DNS Resolver class. See facebook/jest#6423

Jest should be fixed but meanwhile this small improvement in got may also hide the Jest issue for many developers.
@fungiboletus
Copy link
Contributor Author

@fungiboletus fungiboletus commented Nov 19, 2020

It looks like the tests succeed excepts with Node 12. But I'm not sure it's related to the changes in this pull request. The last commit on the master branch was also failing on Node 12 : https://github.com/sindresorhus/got/runs/1342216844

@szmarczak
Copy link
Collaborator

@szmarczak szmarczak commented Nov 19, 2020

This will cause the CacheableLookup instance to be genereated on every got call, which we don't want. dnsCache: true needs to point to a global instance, which is the current code. Unfortunately the bug needs to be fixed by Jest themselves.

@szmarczak szmarczak closed this Nov 19, 2020
@fungiboletus
Copy link
Contributor Author

@fungiboletus fungiboletus commented Nov 19, 2020

Are you sure ? I think it will be generated only the first time. It's still a global instance, just not initialized before it's used.

@szmarczak
Copy link
Collaborator

@szmarczak szmarczak commented Nov 19, 2020

It's still a global instance, just not initialized before it's used.

043c950

@szmarczak
Copy link
Collaborator

@szmarczak szmarczak commented Nov 19, 2020

I'm sure.

@fungiboletus
Copy link
Contributor Author

@fungiboletus fungiboletus commented Nov 19, 2020

I understand you don't want to create one instance for each call, and this test is still successful with my suggested modification.

https://travis-ci.com/github/sindresorhus/got/jobs/443599127

image

@szmarczak
Copy link
Collaborator

@szmarczak szmarczak commented Nov 19, 2020

Ah, I see now. I didn't notice the if.

@szmarczak szmarczak reopened this Nov 19, 2020
@szmarczak szmarczak requested review from sindresorhus and Giotino Nov 19, 2020
@szmarczak szmarczak merged commit 5fefc20 into sindresorhus:master Nov 19, 2020
1 check failed
@fungiboletus
Copy link
Contributor Author

@fungiboletus fungiboletus commented Nov 19, 2020

No problems, I understand why you were suspicious. Many thanks for the merge!

@fungiboletus fungiboletus deleted the cacheablelookup-delayed-instantiation branch Nov 19, 2020
@szmarczak
Copy link
Collaborator

@szmarczak szmarczak commented Nov 19, 2020

Thanks to you for the PR! Never underestimate your work :)

jeremysf added a commit to propellerfactory/node-openid-client that referenced this issue Dec 30, 2020
jeremysf added a commit to propellerfactory/node-openid-client that referenced this issue Dec 30, 2020
@yinzara
Copy link

@yinzara yinzara commented Feb 19, 2021

Could we get a release cut of got (I assume 10.8.2) to get this and other issues fixed since the last release? It's been 4 months.

@szmarczak
Copy link
Collaborator

@szmarczak szmarczak commented Feb 19, 2021

No, there is v11 already and v12 is pending.

@sindresorhus
Copy link
Owner

@sindresorhus sindresorhus commented Feb 26, 2021

We decided to back port it: https://github.com/sindresorhus/got/releases/tag/v11.8.2

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.

None yet

5 participants