feature(FS-388): Update dissolution controller to return draft or pending transaction model dissolutions - #796

JIRA Ticket ID: FS-388

Context

As part of the Dissolution Transaction Model migration, all the new routes will include a transaction_id path parameter, which the client (dissolution-web) provides after it has created a transaction and a new DRAFT dissolution for a new application.

However, there isn't a mechanism in place to handle the scenarios where you need to get a dissolution without a transaction_id, particularly when:

• the applicant resumes an application
• a signatory views an application

We need a way to handle these cases and return a transaction_id in the GetDissolutionResponse payload.

There was some investigations done around this:

• https://companieshouse.atlassian.net/wiki/spaces/FIL/pages/6625034255/Investigate+dissolution-api+changes+required+to+support+transaction+updates
• https://companieshouse.atlassian.net/wiki/spaces/FIL/pages/6690209815/States+and+Routing
• https://companieshouse.atlassian.net/wiki/spaces/FIL/pages/6562185218/Investigate+amending+dissolution+web+URLs+to+include+the+company+number+and+transaction+ID

Description

This PR adds the transaction_id and a top level DissolutionStatus to the dissolution model, returning these in the GET endpoint defined in the DissolutionController.

These changes will enable the redirect.controller in dissolution-web to fetch a draft or pending dissolution and resume the transaction model journey for an application.

There are important considerations with the approach taken here, which I will outline:

• The same endpoint is used by the existing dissolution implementation
  • the existing dissolution lookup is prioritised first, so as to not break the existing implementation in the client
  • it uses the company number and active flag
• New transaction model dissolutions are returned only if there is no active dissolutions for the company

These changes assume / require that a new dissolution db document is created with:

• a transaction_id
• a DissolutionStatus
• and the active flag set to false

Warning: We must ensure that transaction model dissolutions do not set active to true otherwise they might get picked up by the existing dissolution process.

FAQ

Will this impact the existing dissolutions

No, there isn't a mechanism to create dissolutions with a transaction_id, it should be set as null/undefined/empty string in the db.