Change Binary Download Distribution #161
Open
+151
−22
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the binary download distribution functionality by modifying the API of the binaryPath method and enhancing error handling. Key changes include:
- Updating calls to binaryPath in tests to incorporate additional parameters (key and retries).
- Introducing a new module (fetchDownloadSourceUrl.js) to retrieve download endpoints.
- Changing the binary download logic and error reporting in LocalBinary.js and Local.js to support updated configurations.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/local.js | Updated tests to pass additional parameters to binaryPath. |
| lib/fetchDownloadSourceUrl.js | New module to fetch download source URL over HTTPS. |
| lib/LocalBinary.js | Modified binaryPath API and improved error handling in downloads. |
| lib/Local.js | Adjusted retries and updated binaryPath invocations accordingly. |
Comments suppressed due to low confidence (1)
test/local.js:283
- [nitpick] Document the use of the hard-coded test values ('abc' for key and 9 for retries) so that their purpose is clear to future maintainers.
(new LocalBinary()).binaryPath({}, 'abc', 9, function(binaryPath) {
| return that.retryBinaryDownload(conf, destParentDir, null, retries, binaryPath); | ||
| } | ||
| } catch(err) { | ||
| console.error('Download failed with error', err); | ||
| that.binaryDownloadError('Download failed with error', err.getMessage()); |
There was a problem hiding this comment.
Consider using err.message instead of err.getMessage(), as standard Error objects do not have a getMessage() method.
Suggested change
| that.binaryDownloadError('Download failed with error', err.getMessage()); | |
| that.binaryDownloadError('Download failed with error', err.message); |
Copilot uses AI. Check for mistakes.
07souravkunda
requested changes
Jun 10, 2025
Comment on lines
+62
to
+63
| const binaryDownloadErrorMessage = `Error while trying to execute binary: ${error}`; | ||
| console.error(binaryDownloadErrorMessage); |
There was a problem hiding this comment.
if want to show full error with stack else error.message
Suggested change
| const binaryDownloadErrorMessage = `Error while trying to execute binary: ${error}`; | |
| console.error(binaryDownloadErrorMessage); | |
| const binaryDownloadErrorMessage = `Error while trying to execute binary: ${util.format(error)}`; | |
| console.error(binaryDownloadErrorMessage); |
|
|
||
| this.getSourceUrl = function(conf, retries) { | ||
| /* Request for an endpoint from Rails no more than twice with 5 retries each */ | ||
| if (![4, 9].includes(retries) && this.sourceURL != null) { |
There was a problem hiding this comment.
why this check only for 4th and 9th retry?
| return this.sourceURL; | ||
| } | ||
|
|
||
| if (process.env.BINARY_DOWNLOAD_SOURCE_URL !== undefined && process.env.BINARY_DOWNLOAD_FALLBACK_ENABLED == 'true' && this.parentRetries != 4) { |
There was a problem hiding this comment.
significance of parentRetries != 4?
| cmd = 'node'; | ||
| opts = [path.join(__dirname, 'fetchDownloadSourceUrl.js'), this.key]; | ||
|
|
||
| if (retries == 4 || (process.env.BINARY_DOWNLOAD_FALLBACK_ENABLED == 'true' && this.parentRetries == 4)) { |
| this.sourceURL = null; | ||
| this.downloadErrorMessage = null; | ||
|
|
||
| this.getSourceUrl = function(conf, retries) { |
There was a problem hiding this comment.
please add a comment above explaining the method
|
|
||
| let body = '', data = {'auth_token': authToken}; | ||
| const options = { | ||
| // hostname: 'local.browserstack.com', |
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.
No description provided.