28971 Document Record Service Common Utils by flutistar · Pull Request #3624 · bcgov/lear

flutistar · 2025-07-04T17:08:47Z

Description of changes:
This PR introduces utility functions for the Document Record Service (DRS) integration.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the lear license (Apache 2.0).

doug-lovett

Looks good so far. You may want to remove unused document classes. The max allowed files size could be an env variable.

kialj876 · 2025-07-07T13:27:46Z

python/common/document-record-service/src/document_record_service/document_service.py

+            current_app.logger.info(f"Error on deleting document {e}")
+            return {}
+
+    def get_document(self, request_info: RequestInfo) -> dict:


I think this name is misleading as you are 'searching' for a document. I would expect the 'get_document' to retrieve the document by document id (a different drs endpoint which is also used by the legal api - similar to update/delete).

Also, will this document exist in the lear db documents table if it exists? Just wondering if it makes more sense to check the db and then retrieve the document via the id. This would also allow you to get the pdf directly by passing 'application/pdf' in the headers to drs instead of getting the url first and then making another call for the pdf

Actually, I am just realizing that everything in here is using a different set of endpoints meant for 'document class' logic so this can stay as is. I think we'll probably just have 2 different DRS classes because there isn't much overlap ('documents/...' endpoints vs 'application-reports/...' endpoints). We can look at it later and probably make a base class for that each one extends

Thank you, that makes sense — checking the lear DB first before making the API call is a good approach. However, for the search functionality, there are some DRS records that don’t have an associated document record (e.g. we create a DRS record for staff filings to capture the barcode number). So for the download function, I’m going to check the LEAR DB instead.

kialj876 · 2025-07-07T13:43:36Z

python/common/document-record-service/src/document_record_service/document_service.py

+        dt = datetime.now(timezone.utc)
+        return dt.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+
+    def post_document(self, request_info: RequestInfo, file: bytes = None, has_file: bool = True) -> dict:


We're also posting to DRS for generated filing documents at a different endpoint so I think we should rename this so that when we add the other one in here it still makes sense. I think renaming this to 'post_class_document' would make sense?

The other endpoint is more general and covers all types of documents under any product/some entity/some identifier (i.e. filing id)/document name. I think it will more sense to have it as the 'post_document' because it isn't tied to lear logic / will be used by other apis. Just thinking of the future because its likely we'd split this class out later and then extend it here for the lear specific things

The function has been renamed, and corresponding unit tests have been added.

flutistar · 2025-07-10T13:50:49Z

This PR is ready for review.

flutistar · 2025-07-14T15:30:10Z

I have several follow-up PRs pending, so I’d appreciate it if this could be reviewed at your earliest convenience.

python/common/document-record-service/src/document_record_service/document_service.py

BrandonSharratt · 2025-07-14T22:38:26Z

I approved, with the caveat that as it is this will not address the LEAR use case

python/common/document-record-service/src/document_record_service/constants.py

argush3 · 2025-07-17T22:42:11Z

python/common/document-record-service/src/document_record_service/constants.py

+    "amalgamationApplication": DocumentTypes.AMLG.value,
+    "amalgamationOut": DocumentTypes.AMLO.value,
+    "annualReport": DocumentTypes.ANNR.value,
+    "changeOfAddress": DocumentTypes.FRMA.value,
+    "consentAmalgamationOut": DocumentTypes.AMLO.value,
+    "consentContinuationOut": DocumentTypes.CNTO.value,
+    "continuationIn": DocumentTypes.CNTI.value,
+    "continuationOut": DocumentTypes.CNTO.value,
+    "conversion": DocumentTypes.CNVS.value,
+    "correction": DocumentTypes.CORR.value,
+    "courtOrder": DocumentTypes.CRT.value,
+    "registrarsNotation": DocumentTypes.REGN.value,
+    "registrarsOrder": DocumentTypes.REGO.value,
+    "systemIsTheRecord": DocumentTypes.SYSR.value,


I think DOCUMENT_TYPES is still missing a lot of entries if my understanding of how things are supposed to work is correct.

For example an incorporation application have the following documents available. I'm assuming we can ignore the receipt and it will be continue being retrieved via pay api?

I'm ok with approving this PR and fleshing this out as we go but this list will need to be exhaustive at the end of the day to cover all the document types.

I also think we need to include things like incorporationApplication, alteration and changeOfDirectors now as they are pretty common.

We have a document type called System is the record. For any other documents not listed, the document type will be SYSR.
For better clarity, I’ll send you the spreadsheet link via direct message.

As per our conversation, there will need to be some additional work done in subsequent PRs to ensure all the existing DOCUMENT_TYPE entries are accurate and any missing ones are added.

Things that should be addressed in subsequent PRs should include:

are consent entries accurate? two entries map to CNTO

does staff continuation authorization entry need to be added

spreadsheet has missing document type entries for IA and other filings. if they are not SYSR, these entries will need to be added

there are no entries in spreadsheet for firms. i'm assuming there will be non SYSR entries. if so they need to be added

argush3

approving with the understanding that subsequent updates will be made to ensure DOCUMENT_TYPES is accurate and includes all the required entries for all business types + filing types

flutistar · 2025-07-18T17:04:00Z

Thanks Argus, This ticket is intended to cover the missing document types, this will be handled in follow-up PRs.

flutistar added 3 commits July 4, 2025 10:00

DRS common utils

9ec1459

ignore .local directory

ffa7078

removed unused code block

c0a906f

flutistar requested review from BrandonSharratt, argush3, cameron-eyds, doug-lovett, kialj876 and thorwolpert July 4, 2025 17:09

vysakh-menon-aot assigned flutistar Jul 4, 2025

flutistar requested a review from vysakh-menon-aot July 4, 2025 18:05

doug-lovett approved these changes Jul 4, 2025

View reviewed changes

kialj876 reviewed Jul 7, 2025

View reviewed changes

implement unit test

d86ce92

vysakh-menon-aot reviewed Jul 14, 2025

View reviewed changes

python/common/document-record-service/src/document_record_service/document_service.py Outdated Show resolved Hide resolved

BrandonSharratt approved these changes Jul 14, 2025

View reviewed changes

argush3 reviewed Jul 15, 2025

View reviewed changes

python/common/document-record-service/src/document_record_service/constants.py Outdated Show resolved Hide resolved

argush3 reviewed Jul 15, 2025

View reviewed changes

python/common/document-record-service/src/document_record_service/constants.py Outdated Show resolved Hide resolved

argush3 reviewed Jul 15, 2025

View reviewed changes

python/common/document-record-service/src/document_record_service/constants.py Show resolved Hide resolved

flutistar added 2 commits July 16, 2025 08:19

Added firm document class

2c8155b

additional legal types

32dee63

flutistar requested review from argush3, kialj876 and vysakh-menon-aot July 16, 2025 15:44

argush3 reviewed Jul 17, 2025

View reviewed changes

python/common/document-record-service/src/document_record_service/constants.py Outdated Show resolved Hide resolved

argush3 reviewed Jul 17, 2025

View reviewed changes

removed unused legal types

806081a

argush3 approved these changes Jul 18, 2025

View reviewed changes

vysakh-menon-aot approved these changes Jul 18, 2025

View reviewed changes

argush3 merged commit 90d730b into bcgov:main Jul 18, 2025
1 check passed

severinbeauvais changed the title ~~Document Record Service Common Utils~~ 28971 Document Record Service Common Utils Aug 5, 2025

flutistar mentioned this pull request Aug 20, 2025

Add missing document types #3716

Open

Conversation

flutistar commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

doug-lovett left a comment

Choose a reason for hiding this comment

Uh oh!

kialj876 Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kialj876 Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flutistar Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

kialj876 Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

flutistar Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

flutistar commented Jul 10, 2025

Uh oh!

flutistar commented Jul 14, 2025

Uh oh!

Uh oh!

BrandonSharratt commented Jul 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

argush3 Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flutistar Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

argush3 Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

argush3 left a comment

Choose a reason for hiding this comment

Uh oh!

flutistar commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

flutistar commented Jul 4, 2025 •

edited

Loading

kialj876 Jul 7, 2025 •

edited

Loading

kialj876 Jul 7, 2025 •

edited

Loading

argush3 Jul 17, 2025 •

edited

Loading

flutistar commented Jul 18, 2025 •

edited

Loading