Support HTTP_TIMEOUT environment variable #116
Merged
Conversation
This file contains 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
camden11
commented
Mar 11, 2024
| @@ -9,6 +9,10 @@ export const DEFAULT_USER_AGENT_HEADERS = { | |||
| 'User-Agent': `HubSpot Local Dev Lib/${version}`, | |||
| }; | |||
|
|
|||
| const DEFAULT_TRANSITIONAL = { | |||
| clarifyTimeoutError: true, | |||
| }; | |||
There was a problem hiding this comment.
This tells axios to use ETIMEDOUT as the code for timeout errors
config/config_DEPRECATED.ts
Outdated
| @@ -736,6 +736,9 @@ function getConfigVariablesFromEnv() { | |||
| personalAccessKey: env[ENVIRONMENT_VARIABLES.HUBSPOT_PERSONAL_ACCESS_KEY], | |||
| portalId: parseInt(env[ENVIRONMENT_VARIABLES.HUBSPOT_PORTAL_ID] || '', 10), | |||
| refreshToken: env[ENVIRONMENT_VARIABLES.HUBSPOT_REFRESH_TOKEN], | |||
| httpTimeout: env[ENVIRONMENT_VARIABLES.HTTP_TIMEOUT] | |||
| ? parseInt(env[ENVIRONMENT_VARIABLES.HTTP_TIMEOUT] || '') | |||
There was a problem hiding this comment.
Is this part necessary? env[ENVIRONMENT_VARIABLES.HTTP_TIMEOUT] || ''
Since env[ENVIRONMENT_VARIABLES.HTTP_TIMEOUT] would already have to resolve to true for this section of the ternary to run.
There was a problem hiding this comment.
Oh good catch, that was left over from before I added the ternary (and would end with httpTimeout being NaN if not provided)
lib/fileMapper.ts
Outdated
| @@ -265,7 +265,7 @@ async function writeFileMapperNode( | |||
| } | |||
|
|
|||
| function isTimeout(err: BaseError): boolean { | |||
| return !!err && (err.status === 408 || err.code === 'ESOCKETTIMEDOUT'); | |||
| return !!err && (err.status === 408 || err.code === 'ETIMEDOUT'); | |||
There was a problem hiding this comment.
Would isSpecifiedError help here?
There was a problem hiding this comment.
Ah maybe we should update this to be able to check for code
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.
Description and Context
Currently, you can use the
--use-envflag on the CLI to pull certain config values from environment variables, but until now, setting the HTTP timeout this way wasn't supported. It's possible this could cause issues for customers using CLI commands in environments where using ahubspot.config.ymlfile doesn't work or doesn't make sense (see HubSpot/hubspot-cli#1015). This adds support for anHTTP_TIMEOUTenvironment variable.It also makes some other more minor changes
filemapperwhere timeout errors weren't being identified properlyTesting
Run a command with a request that takes a long time with a low timeout to confirm this is working.
Example:
TODO
Who to Notify
@brandenrodgers @kemmerle