[bugfix] default params for signedUrl() #749
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
nextstrain-bot
temporarily deployed
to
nextstrain-s-james-fix--6sn87p
jameshadfield
added a commit
that referenced
this pull request
Nov 7, 2023
This is #749 here for testing purposes only
tsibley
reviewed
Nov 7, 2023
src/s3.js
Outdated
| export async function signedUrl({method, bucket, key, headers, expiresIn, issuedAt} = {method: "GET", headers: {}}) { | ||
| const normalizedHeaders = normalizeHeaders(headers); | ||
| export async function signedUrl({method, bucket, key, headers, expiresIn, issuedAt}) { |
There was a problem hiding this comment.
Ahh, thanks for the catch! I get this backwards sometimes. I meant to write:
-export async function signedUrl({method, bucket, key, headers, expiresIn, issuedAt} = {method: "GET", headers: {}}) {
+export async function signedUrl({method = "GET", bucket, key, headers = {}, expiresIn, issuedAt} = {}) {which makes the headers || {} and method || 'GET' in the function body unnecessary. This is my preferred way to support optional args in a destructuring, as it naturally documents them in the function signature.
jameshadfield
force-pushed
the
james/fix-s3-params
branch
from
9aea0d4
to
b83d0b5
Compare
|
Updated to use the requested syntax, rebased onto master and tested locally. Will merge once CI passes. |
The default parameter values for this function would only be used in the case where no argument was provided, which makes no sense as a bucket and key will always be needed.
jameshadfield
force-pushed
the
james/fix-s3-params
branch
from
b83d0b5
to
2aeb62c
Compare
tsibley
reviewed
Jan 10, 2024
| * @param {object} [params.headers] - Content-Type and/or Content-Encoding headers for PUT | ||
| * @param {number} [params.expiresIn] - seconds until the URL expires | ||
| * @param {number} [params.issuedAt] - absolute time in seconds since the Unix epoch at which the signed URL should be considered issued at, i.e. when the countdown for expiresIn starts | ||
| * @returns {string} signed URL | ||
| */ | ||
| export async function signedUrl({method, bucket, key, headers, expiresIn, issuedAt} = {method: "GET", headers: {}}) { | ||
| export async function signedUrl({method="GET", bucket, key, headers={}, expiresIn, issuedAt}) { |
There was a problem hiding this comment.
FWIW, this dropped the trailing = {} that I'd intentionally suggested in {method="GET", …} = {}. Without it, a call to signedUrl() generates an error like:
Uncaught TypeError: Cannot read properties of undefined (reading 'method')
While calling signedUrl() is always an error, omitting the default = {} seems a weirder way to throw the error compared to signedUrl({}):
Uncaught Error: No value provided for input HTTP label: Bucket.
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.
The default parameter values for this function would only be used in the case where no argument was provided, which makes no sense as a bucket and key will always be needed. These changes preserve the intended defaults of headers={} and method='GET'. (Reading the previous code it seems the intention was to allow a default method of 'GET', despite the docstring indicating it was required.)