fix(storage): return the appropriate error for method not supported (#11416)

BrennaEpp · web-flow · commit 56d704e30378 · 2025-01-08T16:10:01.000-05:00
diff --git a/storage/http_client.go b/storage/http_client.go
@@ -863,7 +863,7 @@ func (c *httpStorageClient) RewriteObject(ctx context.Context, req *rewriteObjec
 
 // NewMultiRangeDownloader is not supported by http client.
 func (c *httpStorageClient) NewMultiRangeDownloader(ctx context.Context, params *newMultiRangeDownloaderParams, opts ...storageOption) (mr *MultiRangeDownloader, err error) {
-	return nil, errMethodNotValid
+	return nil, errMethodNotSupported
 }
 
 func (c *httpStorageClient) NewRangeReader(ctx context.Context, params *newRangeReaderParams, opts ...storageOption) (r *Reader, err error) {
diff --git a/storage/storage.go b/storage/storage.go
@@ -72,8 +72,8 @@ var (
 	// errMethodNotSupported indicates that the method called is not currently supported by the client.
 	// TODO: Export this error when launching the transport-agnostic client.
 	errMethodNotSupported = errors.New("storage: method is not currently supported")
-	// errMethodNotValid indicates that given HTTP method is not valid.
-	errMethodNotValid = fmt.Errorf("storage: HTTP method should be one of %v", reflect.ValueOf(signedURLMethods).MapKeys())
+	// errSignedURLMethodNotValid indicates that given HTTP method is not valid.
+	errSignedURLMethodNotValid = fmt.Errorf("storage: HTTP method should be one of %v", reflect.ValueOf(signedURLMethods).MapKeys())
 )
 
 var userAgent = fmt.Sprintf("gcloud-golang-storage/%s", internal.Version)
@@ -689,7 +689,7 @@ func validateOptions(opts *SignedURLOptions, now time.Time) error {
 	}
 	opts.Method = strings.ToUpper(opts.Method)
 	if _, ok := signedURLMethods[opts.Method]; !ok {
-		return errMethodNotValid
+		return errSignedURLMethodNotValid
 	}
 	if opts.Expires.IsZero() {
 		return errors.New("storage: missing required expires option")
diff --git a/storage/storage_test.go b/storage/storage_test.go
@@ -540,15 +540,15 @@ func TestSignedURL_MissingOptions(t *testing.T) {
 				GoogleAccessID: "access_id",
 				PrivateKey:     pk,
 			},
-			errMethodNotValid.Error(),
+			errSignedURLMethodNotValid.Error(),
 		},
 		{
 			&SignedURLOptions{
 				GoogleAccessID: "access_id",
 				PrivateKey:     pk,
 				Method:         "getMethod", // wrong method name
 			},
-			errMethodNotValid.Error(),
+			errSignedURLMethodNotValid.Error(),
 		},
 		{
 			&SignedURLOptions{
@@ -563,7 +563,7 @@ func TestSignedURL_MissingOptions(t *testing.T) {
 				GoogleAccessID: "access_id",
 				SignBytes:      func(b []byte) ([]byte, error) { return b, nil },
 			},
-			errMethodNotValid.Error(),
+			errSignedURLMethodNotValid.Error(),
 		},
 		{
 			&SignedURLOptions{
@@ -611,7 +611,7 @@ func TestSignedURL_MissingOptions(t *testing.T) {
 				Expires:        expires,
 				Scheme:         SigningSchemeV4,
 			},
-			errMethodNotValid.Error(),
+			errSignedURLMethodNotValid.Error(),
 		},
 		{
 			&SignedURLOptions{

Original file line number	Diff line number	Diff line change
`@@ -863,7 +863,7 @@ func (c httpStorageClient) RewriteObject(ctx context.Context, req rewriteObjec`
`863`	`863`
`864`	`864`	`// NewMultiRangeDownloader is not supported by http client.`
`865`	`865`	`func (c httpStorageClient) NewMultiRangeDownloader(ctx context.Context, params newMultiRangeDownloaderParams, opts ...storageOption) (mr *MultiRangeDownloader, err error) {`
`866`		`- return nil, errMethodNotValid`
	`866`	`+ return nil, errMethodNotSupported`
`867`	`867`	`}`
`868`	`868`
`869`	`869`	`func (c httpStorageClient) NewRangeReader(ctx context.Context, params newRangeReaderParams, opts ...storageOption) (r *Reader, err error) {`
Original file line number	Diff line number	Diff line change
`@@ -72,8 +72,8 @@ var (`
`72`	`72`	`// errMethodNotSupported indicates that the method called is not currently supported by the client.`
`73`	`73`	`// TODO: Export this error when launching the transport-agnostic client.`
`74`	`74`	`errMethodNotSupported = errors.New("storage: method is not currently supported")`
`75`		`- // errMethodNotValid indicates that given HTTP method is not valid.`
`76`		`- errMethodNotValid = fmt.Errorf("storage: HTTP method should be one of %v", reflect.ValueOf(signedURLMethods).MapKeys())`
	`75`	`+ // errSignedURLMethodNotValid indicates that given HTTP method is not valid.`
	`76`	`+ errSignedURLMethodNotValid = fmt.Errorf("storage: HTTP method should be one of %v", reflect.ValueOf(signedURLMethods).MapKeys())`
`77`	`77`	`)`
`78`	`78`
`79`	`79`	`var userAgent = fmt.Sprintf("gcloud-golang-storage/%s", internal.Version)`
`@@ -689,7 +689,7 @@ func validateOptions(opts *SignedURLOptions, now time.Time) error {`
`689`	`689`	`}`
`690`	`690`	`opts.Method = strings.ToUpper(opts.Method)`
`691`	`691`	`if _, ok := signedURLMethods[opts.Method]; !ok {`
`692`		`- return errMethodNotValid`
	`692`	`+ return errSignedURLMethodNotValid`
`693`	`693`	`}`
`694`	`694`	`if opts.Expires.IsZero() {`
`695`	`695`	`return errors.New("storage: missing required expires option")`