Reg\Operation - Operation status set to "Registered" conditionally

andrea-williams commented 2 months ago

Describe the task

We need to add functionality to our API that indicates whether a given operation is "fully registered".

A "fully registered" operation has data for all fields that are required in Reg Part 2, and an external user has officially submitted the registration form (i.e., they've clicked all 3 checkboxes on the last step of the form - see here).

No frontend work associated with this ticket.

Acceptance Criteria

[x] if an operation does not have a contact with an assigned "Operation Representative", the status should be Draft
[x] an operation must have at least one Operation Representative with a mailing address tied to their contact info. If this is not the case, the status should be Draft
[x] if an operation has no facilities associated with it, the status should be Draft
[x] if an operation does not have at least 1 reporting activity associated with it, the status should be Draft
[x] if an operation does not have BOTH a "process flow diagram" doc AND a "boundary map" file associated with it, the status should be Draft
[x] if an operation has data for all required fields but no external user has accepted the 3 checkboxes on the last step of the form, the status should be Draft
[ ] if an operation's registration category is New Entrant but there is no record for the operation in the new_entrant table, or if the record in new_entrant is incomplete, the status should be Draft - see #1906
[ ] if an operation's registration category is Opt-in but there is no record for that operation in the opt_in table, or if the record in opt_in is incomplete, the status should be Draft - see #1952
[ ] if an operation has data for all required fields and an external user representing the operator has accepted the 3 checkboxes and "submitted" the form, the status should be Registered
[ ] GET request for an operation by ID + GET request for all options should include in response the status of the operation/s

Note: the operation status should be updated to "Registered" immediately after successful submission of the registration form. BORO IDs and BCGHG IDs will be manually issued later, so it is possible for an operation to have a status of "Registered" but be missing one/both a BORO ID or BCGHG ID

Development Checklist

[ ] upon external user's submission of the Registration form, the status of the operation is set to "Registered" (unless contra-indicated by one of the AC above)
[ ] create pytests for each of the AC

Additional context

will need this functionality for the purpose of determining which tiles on the main dashboard should be disabled/enabled (to help guide external users through the entire workflow in BCIERS)
Reporting module will also have a need to fetch the data returned in this endpoint

andrea-williams commented 3 weeks ago

Might not need this to be a separate ticket because we won't need a separate API endpoint - can just query the status on the operation by its ID. However, saving this ticket for now because the suggested test cases might be useful in the near future.

patriciarussellCAS commented 1 week ago

Do we need any specific AC to differentiate between and LFO and SFO? Do SFOs have to include a facility in order to proceed? I think they do but wasn't sure where that landed.

BCerki commented 4 days ago

@andrea-williams , for this one: an operation must have at least one Operation Representative with a mailing address tied to their contact info. If this is not the case, the status should be Draft. None of the fields in the address model are mandatory, so just checking if there's a foreign key doesn't tell us much. Are all of street address, municipality, province and postal code necessary to be considered a complete address?

andrea-williams commented 4 days ago

@andrea-williams , for this one: an operation must have at least one Operation Representative with a mailing address tied to their contact info. If this is not the case, the status should be Draft. None of the fields in the address model are mandatory, so just checking if there's a foreign key doesn't tell us much. Are all of street address, municipality, province and postal code necessary to be considered a complete address?

I'm going to tentatively say yes. The only argument there might be against that is if the contact info is not within Canada (and therefore province & postal code won't apply). I'd recommend for now assuming that all of (mailing address, municipality, province, postal code) are required.

This highlights a potential larger issue I want to loop @patriciarussellCAS in on - during development of Reg 1 the indication was that contact info for all people would be restricted to Canada. I get the sense that's no longer necessarily the case, but wanted to double check with you? I'm thinking mostly of cases like "multiple operators" for an operation or parent companies - will contacts for those companies always be within Canada?

patriciarussellCAS commented 4 days ago

Thanks @andrea-williams and @BCerki - this is on my list to discuss with BA at next week's collab. Here's what I think are the key questions:

Do all contacts and/or Operation Representatives need to have addresses in Canada? Y/N
Can we allow them to register without complete information for the Operation Representative (so for example, if they haven't filled out the business mailing address info specifically for the Operation Representative, can we still consider the registration "complete" - I know that technically this goes against the regulations, but I want to see if we can push this specific issue to later if possible)

Andrea - regarding address information for multiple operators and parent companies, I would expect those would need to be international, but I can confirm that as well.

Did I miss anything?

BCerki commented 3 days ago

@andrea-williams , me again...

if an operation's registration category is New Entrant but there is no record for the operation in the new_entrant table, or if the record in new_entrant is incomplete--we don't have a new entrant table. I think the required new entrant stuff is only the signed statuatory declaration?
if an operation's registration category is Opt-in but there is no record for that operation in the opt_in table, or if the record in opt_in is incomplete--everything in opted_in_operation_detail is optional. Am I just checking for the existence of the foreign key?
I'm creating a service to check everything is filled and it'll go into /v2/operations/{operation_id}/registration/submission before the update_status service runs. If the anything is incomplete, the status won't be changed to registered, but should I also throw an exception (or something?) to give the user feedback that the status couldn't be changed to registered?

bcgov / cas-registration