fix(plugin-typescript): add a timeout to the Algolia auto-types lookup#7206
Open
sebdanielsson wants to merge 1 commit into
Open
fix(plugin-typescript): add a timeout to the Algolia auto-types lookup#7206sebdanielsson wants to merge 1 commit into
sebdanielsson wants to merge 1 commit into
Conversation
Author
|
CI failures seem to be pre-existing. |
`yarn add` queries Algolia's `npm-search` index to detect whether the added package needs a matching `@types` package. On restricted networks (eg. a corporate proxy that drops or refuses the request) this lookup had no timeout and could make `yarn add` hang indefinitely, while `yarn install` kept working against the configured registry. This caps the lookup at 10s and, on timeout or network failure, warns the user (pointing at the `tsEnableAutoTypes: false` / `YARN_TS_ENABLE_AUTO_TYPES="false"` escape hatch) before letting the install proceed without the `@types` package. It also hardens the Algolia requester so a connection error without a `response` no longer throws an unrelated `TypeError`. Closes yarnpkg#7111 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NS1JKnVAz9uPwdyUhfub2g
sebdanielsson
force-pushed
the
claude/berry-7111-fix-8doaul
branch
from
2ac69a6 to
0749d72
Compare
There was a problem hiding this comment.
Pull request overview
This PR addresses yarn add hanging in network-restricted environments by bounding the optional Algolia lookup used by @yarnpkg/plugin-typescript to decide whether to add a matching @types/* dependency, and by improving resilience to connection errors.
Changes:
- Add a 10s timeout wrapper around the Algolia
npm-searchlookup and warn (then continue) on timeout/network failure. - Harden the Algolia requester error path to avoid throwing when
error.responseis missing. - Add a versioning file to release
@yarnpkg/plugin-typescriptas a patch.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| packages/plugin-typescript/sources/typescriptUtils.ts | Adds a timeout + warning path for the Algolia auto-types lookup and guards requester error handling. |
| .yarn/versions/7111fix0.yml | Declares a patch release for @yarnpkg/plugin-typescript. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+41
to
+48
| const packageInfo = await Promise.race([ | ||
| index.getObject<AlgoliaObj>(stringifiedIdent, {attributesToRetrieve: [`types`]}), | ||
| new Promise<never>((resolve, reject) => { | ||
| timeout = setTimeout(() => { | ||
| reject(new AlgoliaTimeoutError()); | ||
| }, ALGOLIA_TIMEOUT); | ||
| }), | ||
| ]); |
Comment on lines
+67
to
+70
| process.emitWarning( | ||
| `Couldn't reach the npm search registry to check whether ${prettyIdent} needs a matching @types package (${error.message}); the package will be added without it.\n` + | ||
| `You can disable this lookup by setting ${formatUtils.pretty(configuration, `tsEnableAutoTypes`, formatUtils.Type.SETTING)} to false in your .yarnrc.yml (or by setting the YARN_TS_ENABLE_AUTO_TYPES="false" environment variable).`, | ||
| ); |
Comment on lines
+51
to
+56
| } catch (error) { | ||
| // A timeout or a network error (eg. a proxy blocking the request) shouldn't | ||
| // prevent the package from being added - we just can't tell whether it needs | ||
| // a matching `@types` package, so we let the user know and carry on. | ||
| if (error instanceof AlgoliaTimeoutError || error?.name === `RetryError`) | ||
| reportAutoTypesError(configuration, descriptor, error); |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What's the problem this PR addresses?
Closes #7111
yarn addqueries Algolia'snpm-searchindex to detect whether the added package needs a matching@typespackage. In our corporate network, all egress traffic traverses our HTTP proxy. If this is set globally usingHTTPS_PROXY,HTTP_PROXY, andNO_PROXY, but not explicitly with Yarn's HTTP proxy config, this query will not go through the proxy but will instead try to make a direct connection. In our case, this means the firewall silently drops the connection.httpTimeoutis not what's bounding a single attempt. I dropped it from 15s to 10s and got an identical ~135s per attempt. The wait is the Linux kernel's TCP SYN-retry exhaustion (default tcp_syn_retries=6, ~127–135s in my tests). Because the TCP socket never establishes, got's timeout.socket (which is socket-inactivity-after-connect) never starts. Got then retries httpRetry times, which multiplies the dead time.My tests:
httpTimeout=10s httpRetry=0httpTimeout=10s httpRetry=1httpTimeout=15s httpRetry=1httpTimeout=1m httpRetry=3)How did you fix it?
This caps the lookup at 10s and, on timeout or network failure, warns the user (pointing at the
tsEnableAutoTypes: false/YARN_TS_ENABLE_AUTO_TYPES="false"escape hatch) before letting the install proceed without the@typespackage. It also hardens the Algolia requester so a connection error without aresponseno longer throws an unrelatedTypeError.Future fixes
My last comment in the linked issue proposes additional fixes to make this more stable, but I wanted to keep this PR small and easy to review. A future enhancement would be to have the Algolia lookup respect the global HTTP environments, just like the installation does today.
Checklist