[MDS-6232] IRT/Application statuses #3317

taraepp · 2024-11-25T22:13:30Z

Objective

add those status options
make them work the way they're supposed to
hunt down bugs that were making it so I couldn't test if it was working

Not done:

I actually didn't get to the status emails and notifications 🥹 (In a new ticket now)

MDS-6232

Why are you making this change? Provide a short explanation and/or screenshots

taraepp · 2024-11-25T22:23:35Z

services/common/src/constants/API.ts

@@ -188,8 +188,6 @@ export const INFORMATION_REQUIREMENTS_TABLES = (projectGuid) =>
  `/projects/${projectGuid}/information-requirements-table`;
 export const INFORMATION_REQUIREMENTS_TABLE = (projectGuid, irtGuid) =>
  `/projects/${projectGuid}/information-requirements-table/${irtGuid}`;


Long story short:

separate endpoint for status has been nuked.

status now combined with document endpoint (and also action creator, etc)

caveat here is that additional parameters have to be added in form data (pretty obvious when you look at the action creator)

taraepp · 2024-11-25T22:24:57Z

services/common/src/constants/enums.ts

@@ -155,6 +155,15 @@ export enum PROJECT_STATUS_CODES {
  CHR = "CHR",
 }

+export enum MAJOR_MINE_APPLICATION_AND_IRT_STATUS_CODE_CODES {


This is a really terrible name, I know! And so long! I just couldn't think of anything else and MAJOR_MINE_APPLICATION_AND_IRT_STATUS_CODES was already taken. It needed making but I'd be more than happy to see it renamed. 😂

taraepp · 2024-11-25T22:28:00Z

.../app/api/projects/information_requirements_table/resources/information_requirements_table.py

+        except BadRequest as err:
+            current_app.logger.error("Error occurred while retrieving file | document_guid")
+            current_app.logger.info(err)
+            raise BadRequest('Missing file information')


this was just extracting the file update into its own function.

taraepp · 2024-11-25T22:28:46Z

.../app/api/projects/information_requirements_table/resources/information_requirements_table.py

@@ -42,25 +52,22 @@ def get(self, project_guid, irt_guid):
    @requires_any_of([MINE_ADMIN, MINESPACE_PROPONENT, EDIT_INFORMATION_REQUIREMENTS_TABLE])
    @api.marshal_with(IRT_MODEL, code=200)


in hindsight, it really doesn't make much sense to keep the @api.marshal_with(IRT_MODEL) and also the params. 🤦‍♀️

taraepp · 2024-11-25T22:31:04Z

services/core-api/app/api/projects/project_decision_package/models/project_decision_package.py

@@ -142,8 +142,6 @@ def update(self,
            self.save(commit=False)

        if len(documents) > 0:
-            mine_document_guid = documents[0].mine_document_guid


this is/was a bug in project decision package.
It's a new document, so it doesn't have a mine_document_guid. Also, project is passed in as a parameter so it doesn't need to be queried below.

There was a spot to show project decision docs on the MMA and I wanted to see it populated, and this was a surprisingly quick fix. In the end, with discussion with Rebecca, it's hidden behind a feature flag (on the FE it was a document table with documents=[], so not at all useful)

taraepp · 2024-11-25T22:33:49Z

services/core-web/src/components/mine/Projects/MajorMineApplicationTab.tsx

+
+  const headerHeight = 121;
+  const tabNavHeight = 60;
+  const topOffset = headerHeight + tabNavHeight;


at this point, should probably pull this out to the parent component, and/or find a better way. Buuuut it looks and works better now at least.

taraepp · 2024-11-25T22:34:42Z

services/core-web/src/constants/routes.ts

-  component: MajorMineApplicationTab,
-  helpKey: "Major-Mine-Application",
-};
-


this came up when I did a quick search for "final-app" and it turns out it's not referenced anywhere. So I deleted it.

taraepp · 2024-11-25T22:38:21Z

...s/minespace-web/src/components/Forms/projects/informationRequirementsTable/IRTFileImport.tsx

  };

  const onRemoveFile = (err, fileItem) => {
    remove(documents, { document_manager_guid: fileItem.serverId });
-    return dispatch(change(FORM.INFORMATION_REQUIREMENTS_TABLE, "final_irt", documents));


the manually dispatched changes aren't necessary any more- gave the input the name of "final_irt" so now it handles it on its own

taraepp · 2024-11-25T22:44:27Z

.../components/Forms/projects/informationRequirementsTable/InformationRequirementsTableForm.tsx

-              );
-            })}
-          </Tabs>
+            items={tabItems}


I was a bit baffled by the buggy UI on this page and did some paring down in the process of figuring out what was wrong. (the flashy IRT page on the bugs channel! Locally, you'll get a ResizeObserver Loop error, possibly depending on the height of your browser but it's the natural height of my browser so it just always happened)

Turned out to be an antd/CSS issue. For the tabs, when there's overflow, antd wants to put a little ellipses button to show the overflow items. But when it's just on the threshold, it's like it doesn't know whether to show it or not, and so the result is constant layout changes. I didn't see a prop in the antd docs I could control this with, so instead I hid the button and made it scroll to show overflow in the scss file. Note that this is the only instance of "vertical-tabs" on MS, so the rule is quite specific to this area. My first idea was to make the menu like the other menus but the page structure was too different for that to be a simple change (updating the UI is going to be a major overhaul FYI)

taraepp · 2024-11-25T22:56:06Z

services/minespace-web/src/components/pages/Project/InformationRequirementsTablePage.tsx

@@ -138,6 +134,7 @@ export const InformationRequirementsTablePage = () => {
  }, [uploadedSuccessfully]);

  useEffect(() => {
+    handleFetchData();
    return () => {
      dispatch(clearInformationRequirementsTable({}));


fun fact- clearing the IRT means that if you click the back button from the IRT to return to the project overview, your IRT now (on test) shows "Not Started".
So, a couple changes here-

combine useEffects with same dep arrays

it doesn't need to fetch the data on load, because it's a child of the project page

project page looks at the project.irt instead of the irt in the state because I didn't like all the refreshing I had to do.

but I didn't totally refactor the data stuff here, it was just too much

taraepp · 2024-11-25T22:56:41Z

services/minespace-web/src/components/pages/Project/InformationRequirementsTablePage.tsx

@@ -217,8 +214,7 @@ export const InformationRequirementsTablePage = () => {

    await handleFetchData();
    setUploadedSuccessfully(true);
-    setEditMode(!isEditMode);
-    return cleanFilePondFile();


I'm not 100% sure what this function is supposed to do, but it just errored out every time. 🤷‍♀️

taraepp · 2024-11-25T22:57:44Z

services/minespace-web/src/components/pages/Project/InformationRequirementsTableStepForm.tsx

@@ -103,7 +114,7 @@ const StepForms = ({
                state: { current: 2 },
              });
            }}
-            disabled={!uploadedSuccessfully && !project?.information_requirements_table?.irt_guid}
+            disabled={!uploadedSuccessfully}
          >


The second part of the condition made it so that I could click the button and it would take me in circles (if I didn't upload a document).

…ffects with equal dep arrays, take out +=/-= that made no sense

…atus.

sonarqubecloud · 2024-11-28T23:03:03Z

Quality Gate failed for 'bcgov-sonarcloud_mds_minespace-web'

Failed conditions
63.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

sonarqubecloud · 2024-11-28T23:03:04Z

Quality Gate failed for 'bcgov-sonarcloud_mds_common'

Failed conditions
77.9% Coverage on New Code (required ≥ 80%)
5.8% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

sonarqubecloud · 2024-11-28T23:08:03Z

Quality Gate failed for 'bcgov-sonarcloud_mds_core-web'

Failed conditions
30.5% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

sonarqubecloud · 2024-11-29T19:27:39Z

Quality Gate failed for 'bcgov-sonarcloud_mds_core-api'

Failed conditions
35.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

taraepp commented Nov 25, 2024

View reviewed changes

taraepp and others added 9 commits November 28, 2024 15:56

make database changes for application and irt status tables

fc95621

whole lot of FE changes, mostly related to showing the status

6a4a345

deal with the render errors on the MS IRT form, consolidate some useE…

bc0db10

…ffects with equal dep arrays, take out +=/-= that made no sense

FE & BE issues with IRT

061eabe

issues with mma, fix typos, update test

511929e

update BE tests

c681a10

remove commented out code

700faab

remove typo from snaps

b0f2f3b

update status_code change when submitting from a Changes Requested St…

f239f40

…atus.

matbusby-fw force-pushed the mds-6232-irt-app-statuses branch from ef2f7dc to f239f40 Compare November 28, 2024 22:58

matbusby-fw requested review from asinn134, matbusby-fw, simensma-fresh and sggerard November 29, 2024 16:07

matbusby-fw added the 👍 Ready for review Pull request has been double checked by the author and is ready for comments and feedback. label Nov 29, 2024

asinn134 approved these changes Nov 29, 2024

View reviewed changes

matbusby-fw approved these changes Nov 29, 2024

View reviewed changes

matbusby-fw merged commit 2aac6e5 into develop Nov 29, 2024
16 of 20 checks passed

matbusby-fw deleted the mds-6232-irt-app-statuses branch November 29, 2024 21:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MDS-6232] IRT/Application statuses #3317

[MDS-6232] IRT/Application statuses #3317

taraepp commented Nov 25, 2024 •

edited by matbusby-fw

Loading

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

taraepp Nov 25, 2024

sonarqubecloud bot commented Nov 28, 2024

sonarqubecloud bot commented Nov 28, 2024

sonarqubecloud bot commented Nov 28, 2024

sonarqubecloud bot commented Nov 29, 2024

		@@ -42,25 +52,22 @@ def get(self, project_guid, irt_guid):
		@requires_any_of([MINE_ADMIN, MINESPACE_PROPONENT, EDIT_INFORMATION_REQUIREMENTS_TABLE])
		@api.marshal_with(IRT_MODEL, code=200)

[MDS-6232] IRT/Application statuses #3317

[MDS-6232] IRT/Application statuses #3317

Conversation

taraepp commented Nov 25, 2024 • edited by matbusby-fw Loading

Objective

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 28, 2024

Quality Gate failed for 'bcgov-sonarcloud_mds_minespace-web'

sonarqubecloud bot commented Nov 28, 2024

Quality Gate failed for 'bcgov-sonarcloud_mds_common'

sonarqubecloud bot commented Nov 28, 2024

Quality Gate failed for 'bcgov-sonarcloud_mds_core-web'

sonarqubecloud bot commented Nov 29, 2024

Quality Gate failed for 'bcgov-sonarcloud_mds_core-api'

taraepp commented Nov 25, 2024 •

edited by matbusby-fw

Loading