Change to Copy Page Hierarchy API exception handling

What is changing?

Currently, on execution of the Copy Page Hierarchy API endpoint, exceptions are swallowed and the CPH is sometimes re-tried multiple times. With this change, CPH will no longer swallow exceptions and instead fail if an exception is thrown.

On failure, CPH will report this exception to the messages field in the Long Running task response, so the caller can determine the reason for failure.

Why is it changing?

This change is happening in order to make it easier for the caller of the API to determine the reason for failure.

What do I need to do?

If you use the Copy Page Hierarchy API, be advised that the endpoint will now fail due to exceptions, and information about these exceptions can be found using the Long Running Tasks API.

By when do I need to do it?

This change will release to the Confluence Ecosystem Beta group on June 7th, 2021, and start rolling out in increments to production during June 14-22nd, 2021. (changed to June 21-29th, see below comment)

[June 10 Update: Rollout has been postponed, see below comment]
[June 17 Update: Rollout has been unblocked, see below comment]

3 Likes

This is great news – it’s something we have been asking for for years.

That said, can you provide details on a simple method(s) to cause an error that will be surfaced in this way so that we can test effectively in advance of it hitting production?

5 Likes

Hi Bob, I am happy to hear! Unfortunately, all known issues that should cause CPH to fail with an error during execution + add add this error to LRT will be resolved by the time this change rolls out. There is no known way to force an issue using the API. (if you do find one, please let us know so we can resolve it!)

There is one known issue right now that happens with this change, and it was brought up here. However, our team is now working to resolve this issue before we roll this change out. You will be able to follow the progress for that fix with this ticket here. Please let me know if I can answer anything else!

The rollout of this change has been postponed. This change is blocked by CONFCLOUD-72284 here. Once the above is resolved, this change will be rolled out.

1 Like

CONFCLOUD-72284 (reference) has been resolved. This change will now starting rolling out in increments to production during June 21-29th, 2021.