ServiceBrokerCreateOperationInProgressException should accept and return operation state

[gberche-orange]

Expected behavior

• As a broker developer
• In order to comply to OSB API specs
• I need to return a 202 with an operation state field

/~https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#response-3 mentions

Status Code	Description
[..]
202 Accepted	MUST be returned if the Service Instance provisioning is in progress. The operation string MUST match that returned for the original request. This triggers the Platform to poll the Last Operation for Service Instances endpoint for operation status. Note that a re-sent PUT request MUST return a 202 Accepted, not a 200 OK, if the Service Instance is not yet fully provisioned.

Observed behavior

Currently the operation string does not seem to be returned in the response body in a parseable json string

spring-cloud-open-service-broker/spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/exception/ServiceBrokerCreateOperationInProgressException.java

Line 28 in a8fa63f

public class ServiceBrokerCreateOperationInProgressException extends ServiceBrokerException {

spring-cloud-open-service-broker/spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/controller/ServiceBrokerExceptionHandler.java

Lines 181 to 185 in a8fa63f

	@ExceptionHandler(ServiceBrokerCreateOperationInProgressException.class)
	@ResponseStatus(HttpStatus.ACCEPTED)
	public ErrorMessage handleException(ServiceBrokerCreateOperationInProgressException ex) {
	return getErrorResponse(ex);
	}

As a workaround, don't use ServiceBrokerCreateOperationInProgressException, and directly control status code and response body.

return Mono.just(CreateServiceInstanceResponse.builder()
						.dashboardUrl(dashboard)
						.operation(operation)
						.async(true)
						.instanceExisted(false)
						.build());

[royclarkson]

Thanks for reporting!

[royclarkson]

This is part of the OSBAPI 2.15 spec, so will need to be back ported to 3.1.x.

/~https://github.com/openservicebrokerapi/servicebroker/blob/v2.15/spec.md#response-3

[royclarkson]

There are five scenarios where this applies with three different exception objects:

• Service instance provisioning via ServiceBrokerCreateOperationInProgressException
• Service instance updating via ServiceBrokerUpdateOperationInProgressException
• Service instance deleting via ServiceBrokerDeleteOperationInProgressException
• Service instance binding via ServiceBrokerCreateOperationInProgressException
• Service instance unbinding via ServiceBrokerDeleteOperationInProgressException