Brief introduction
Example of scenario with a deployed instance with two element:
- user call undeploy command
- first instance element success with UNDEPLOYED state
- second instance element fail with DEPLOYED state
- user call undeploy command again
- first instance element does not know that the element is already UNDEPLOYED
Add support for the participant to understand what was the last state.
Additional comments
It is important to make distinction between the state of the instance/element in the flow, and the state of the application involved. A deployed element means that a participant has completed a deploy action, and should not be confused with a deployed application.
In the example there are scenarios where it make sense when a process is failed, all elements should be repeat fully, by in other scenarios could de different, it depend of the context. Is the participant that has the responsibility to know what have to do.
In order to cover the scenario where the process is failed but elements that are in a success state should not be repeat the process, the participant have to know what was the previous state
Solutions
A simple solution from participant side is that they can use "useState" or "operationalState" to save information related to the deployment process.
Into the participant implementation they can send by sendAcElementInfo method.
To support the participant implementation we can add "useState" and "operationalState" into the InstanceElementDto:
public record InstanceElementDto(UUID instanceId, UUID elementId, ToscaServiceTemplate toscaServiceTemplateFragment,
Map<String, Object> inProperties, Map<String, Object> outProperties, String operationalState, String useState) {
}
Below an example how could be used:
@Override
public void deploy(CompositionElementDto compositionElement, InstanceElementDto instanceElement)
throws PfModelException {
if ("DEPLOYED".equals(instanceElement.useState())) {
// deploy process already done
intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId,
DeployState.DEPLOYED, null, StateChangeResult.NO_ERROR, "Already Deployed");
return;
}
.......................................
.......................................
intermediaryApi.sendAcElementInfo(instanceElement.instanceId(), instanceElement.elementId(),
"", "DEPLOYED", instanceElement.outProperties());
intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId,
DeployState.DEPLOYED, null, StateChangeResult.NO_ERROR, "Deployed");
}
@Override
public void undeploy(CompositionElementDto compositionElement, InstanceElementDto instanceElement)
throws PfModelException {
if ("UNDEPLOYED".equals(instanceElement.useState())) {
// undeploy process already done
intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId,
DeployState.UNDEPLOYED, null, StateChangeResult.NO_ERROR, "Already Undeployed");
return;
}
.......................................
.......................................
intermediaryApi.sendAcElementInfo(instanceElement.instanceId(), instanceElement.elementId(),
"", "UNDEPLOYED", instanceElement.outProperties());
intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId,
DeployState.UNDEPLOYED, null, StateChangeResult.NO_ERROR, "Undeployed");
}