Write a better error message when secret not found

[simonjohansson]

Currently when a secret is not found we get an error message

Response code 404 (Not Found)

If you have multiple secrets it can be tedious to figure out which secret is missing.

This PR fixes that by giving the error message

Unable to retrieve result for "secret/data/notFound". Double check your Key.

[hashicorp-cla]

All committers have signed the CLA.

[simonjohansson]

@jasonodonnell ping pong :)

[jasonodonnell]

Suggested change

	throw Error(`Unable to retrieve result for "${path}". Double check your Key.`)
	throw Error(`Unable to retrieve result for "${path}".`)

[jasonodonnell]

Removing key because it may be due to other things (token perms, connectivity, etc).

[jasonodonnell]

Suggested change

	expect(exportSecrets()).rejects.toEqual(Error(`Unable to retrieve result for "secret/data/notFound". Double check your Key.`));
	expect(exportSecrets()).rejects.toEqual(Error(`Unable to retrieve result for "secret/data/notFound".`));

[ps-jay]

This would be nice to have, see also 400 errors: #273

[dhs3000]

Hi everyone, it would be great if this could be merged. It would be super helpful to see right away what causes the error.

[calvn]

@simonjohansson we've walk through a few scenarios on both making API calls directly and via the CLI that results in errors, and think that there's value in returning the request path as well as the error itself.

API

# Invalid path - non-existent
$ curl -vv -H "X-Vault-Token: $(vault print token)" http://localhost:8200/v1/secret/data/not-found
*   Trying ::1:8200...
* Connected to localhost (::1) port 8200 (#0)
> GET /v1/secret/data/not-found HTTP/1.1
> Host: localhost:8200
> User-Agent: curl/7.77.0
> Accept: */*
> X-Vault-Token: root
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 404 Not Found
< Cache-Control: no-store
< Content-Type: application/json
< Strict-Transport-Security: max-age=31536000; includeSubDomains
< Date: Fri, 15 Apr 2022 17:03:36 GMT
< Content-Length: 14
<
{"errors":[]}
* Connection #0 to host localhost left intact

# Invalid path - no matching handler
$ curl -vv -H "X-Vault-Request: true" -H "X-Vault-Token: $(vault print token)" http://localhost:8200/v1/blah
*   Trying ::1:8200...
* Connected to localhost (::1) port 8200 (#0)
> GET /v1/blah HTTP/1.1
> Host: localhost:8200
> User-Agent: curl/7.77.0
> Accept: */*
> X-Vault-Request: true
> X-Vault-Token: root
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 404 Not Found
< Cache-Control: no-store
< Content-Type: application/json
< Strict-Transport-Security: max-age=31536000; includeSubDomains
< Date: Fri, 15 Apr 2022 17:01:09 GMT
< Content-Length: 43
<
{"errors":["no handler for route 'blah'"]}
* Connection #0 to host localhost left intact

# Invalid permission
› curl -vv -H "X-Vault-Token: $(vault print token)" http://localhost:8200/v1/blah
*   Trying ::1:8200...
* Connected to localhost (::1) port 8200 (#0)
> GET /v1/blah HTTP/1.1
> Host: localhost:8200
> User-Agent: curl/7.77.0
> Accept: */*
> X-Vault-Token: hvs.CAESIKI_FMCZgw5boLpfQY_h-eWyF0-ZehTboHsDrrAxpn2OGh4KHGh2cy5JZTdEWWFjdHpsTllpQ3BvV1RzbHQ3OVM
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 403 Forbidden
< Cache-Control: no-store
< Content-Type: application/json
< Strict-Transport-Security: max-age=31536000; includeSubDomains
< Date: Fri, 15 Apr 2022 17:36:31 GMT
< Content-Length: 60
<
{"errors":["1 error occurred:\n\t* permission denied\n\n"]}
* Connection #0 to host localhost left intact

CLI

# Invalid path - non-existent
$ vault read secret/data/not-found
No value found at secret/data/not-found

# Invalid path - no matching handler
$ vault read blah
No value found at blah

# Invalid permission
$ vault read blah
Error reading blah: Error making API request.

URL: GET http://localhost:8200/v1/blah
Code: 403. Errors:

* 1 error occurred:
	* permission denied

Could you update the PR such that when the error is caught, the Error that we return contains both the path (similar to what you currently have) as well as the error itself, if that's not empty? We can return all errors this way and not just on 404's.

[simonjohansson]

@calvn Howdie. I don't work in the company where we used the action anymore. So I wont have any time/setup to expand the PR.

[swenson]

Thanks @simonjohansson. I'll go ahead and close this one in favor of #306 so that we can address these comments. I've left your commit in so that you still get credit for it.