Better error message and support logs for /v3/service_offerings and plans #4213
+58
−8
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
jochenehret
previously approved these changes
Feb 13, 2025
svkrieger
reviewed
Feb 13, 2025
svkrieger
requested changes
Feb 14, 2025
| @@ -1260,7 +1260,10 @@ def check_filtered_instances(*instances) | |||
| expect(last_response).to have_status_code(422) | |||
| expect(parsed_response['errors']).to include( | |||
| include({ | |||
| 'detail' => 'Invalid service plan. Ensure that the service plan exists, is available, and you have access to it.', | |||
| 'detail' => 'Invalid service plan. This could be due to a space-scoped broker which is offering the service plan ' \ | |||
There was a problem hiding this comment.
Would be good to have the same tests for the update case (PATCH). If we had those, above bug which results in a 500 would have been detected.
There was a problem hiding this comment.
Good point, will add it
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.
Users may be confused why they receive a 422 with error message "Invalid service plan. Ensure that the service plan exists, is available, and you have access to it." unprocessable_service_plan! when trying to create a service instance.
The root cause of this can have different origins:
A short explanation of the proposed change:
Split the error into different errors depending on the root cause. Error message will stay the same if user can not see the service plan in any org.
For case 1 and 2 error message will stay:
Invalid service plan. Ensure that the service plan exists, is available, and you have access to it.For case 3 error message will now be:
Invalid service plan. The service plan 'service_plan' with guid 'some-guid' has been removed from the service broker's catalog. It is not possible to create new service instances using this plan.For case 4 error message will now be:
Invalid service plan. Ensure that the service plan 'service_plan' with guid 'some-guid' is visible in your current space 'space' with guid 'some-guid'.An explanation of the use cases your change solves
More fine granulated error messages, helping the user to solve the error better.
Links to any other associated PRs
I have reviewed the contributing guide
I have viewed, signed, and submitted the Contributor License Agreement
I have made this pull request to the
mainbranchI have run all the unit tests using
bundle exec rakeI have run CF Acceptance Tests