Documentation Home

Broadleaf Enterprise 3.2.0-GA

Noteworthy Updates

Allow user-driven retry of stuck promotions or deployments

If a promotion or deployment is detected to be in an in-progress state, but there is no associated, active ProcessStatus record, it is considered to be in a stuck state. This is because the auto-retry mechanism used by the system for abandoned promotions depends on an active ProcessStatus record to track the state and engage a retry. If no ProcessStatus record is available, the system cannot proceed with auto retry. However, in such a case, the user should be able to manually engage the retry to allow the promotion to proceed normally.

This should be an infrequent circumstance. There are no currently known use cases that will result in a missing or archived ProcessStatus for a promotion. However, since the case has been reported, we want to provide a way to self-serve to easily workaround the situation. Frequent usage of this feature should be reported to Broadleaf support so that we can attempt to further harden the system against unknown failure cases.

Furthermore, there is an existing problem with 5.x codebases and stuck user promotions. Specifically, those WorkflowEvents appear to be lost in the UI. During my testing, a PROGRESS WorkflowEvent is not shown in any list grid. Noting the description above, a stuck promotion is one that's perpetually stuck in the PROGRESS state. Such a promotion would seem to disappear forever.

The enhancement has the following characteristics:

  1. Only new promotions and deployments are monitored. Pre-existing "stuck" items remain stuck and will need to be manually remediated. This protects against unknown manual modification consequences.
  2. A property admin.allow.user.promotion.retry can be set to false to turn off the behavior, if desired.
  3. Stuck promotions are evidenced on both the pending approval screen in My Changes and the entity detail screen.
  4. In progress promotions are evidenced on both the pending approval screen in My Changes and the entity detail screen.
  5. Stuck deployments are evidences on both the past deployments screen in Deployments and the entity detail screen.
  6. In progress deployments are evidenced on both the past deployments screen in Deployments and the entity detail screen.

An at-a-glance view of the issues that were closed in this release:

Minor Bugs(1)

  • Fix CommonEnterprise version

Enhancements(2)

  • Allow user-driven retry of stuck promotions or deployments
  • Fix compilation issues relating to removing solr-core

Total Resolved Issues: 5