[MDS-5927] Bring Projects Form to CORE #3145

taraepp · 2024-06-07T21:36:13Z

Objective

Bring Projects form to CORE to make it match MS

Bonus:

streamlined a lot of props so components handled things themselves
the ProjectSummaryForm is the only instance using the common SteppedForm, so made it handle the form itself, check for errors, etc.
some bugs in authorizations documents (going away when you navigate to a different page, showing up in both new/amendment)

Tech Debt:

there's no "cancel confirmation" when you try to leave the page on CORE
CORE had the "edit/view mode" toggle, and I did keep that, but some of the components don't have a view mode yet. What's a checkbox supposed to look like, for example? The Add button still shows up on the Related Projects page
previously CORE users could remove and archive documents, if they had either admin role or edit project summaries. Did not bring this in yet
the status doesn't display on the header for every page yet, and if you want to update it you have to do that under "Ministry Contact"
- I'm also not really sure if either of those fields should be required, so they're not
if we decide to fix the view mode, should probably also stop the tabs disabling while it's in View mode

MDS-5927

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

…TES, update references, remove restriction on CORE viewing/saving a draft, fix a style issue

…d up as props, make the forms have proper references. Use label props instead of hardcoding label text

…ct summary form on the CORE project summary page, make adjustments both there and on MS

taraepp · 2024-06-07T21:38:45Z

services/common/src/components/forms/RenderFileUpload.tsx

    const secondLine = abbrevLabel
-      ? `<div>We accept most common ${fileTypeDisplayString} files</div>`
+      ? `<div>We accept most common ${fileTypeDisplayString} files${fileSize}.</div>`


just for Denise- making file-size show up by default.

taraepp · 2024-06-07T21:39:06Z

services/common/src/components/forms/Step.tsx

@@ -0,0 +1,12 @@
+import React, { FC } from "react";


One of many, many components to get moved or copied to common

More more more!

taraepp · 2024-06-07T21:42:22Z

services/common/src/components/forms/SteppedForm.tsx

+import React, { FC, ReactElement, useEffect, useState } from "react";
+import { useSelector, useDispatch } from "react-redux";
+import { getFormSyncErrors, getFormValues, submit } from "redux-form";
+import { Button, Col, Menu, Popconfirm, Row, StepProps } from "antd";


Basically, SteppedForm in this state:

makes its own FormWrapper with the settings that are ideal for it

checks for errors

passes down isEditMode to FormWrapper to enable a view mode

transforms the values according to a function prop

taraepp · 2024-06-07T21:50:41Z

services/common/src/components/projectSummary/AuthorizationsInvolved.tsx

@@ -540,14 +459,15 @@ const RenderAuthCodeFormSection = ({
  );
 };

-export const AuthorizationsInvolved = (props) => {
+export const AuthorizationsInvolved = () => {


initialValues does not need to be passed as a prop when we're using reduxForm. Redux has all that in the state already (both initial & current values, and data about errors, etc) so we can use a selector to get that context right where we need it instead of prop drilling.
Most of the edits here are just taking out props that duplicate redux state.

taraepp · 2024-06-07T21:52:37Z

services/common/src/components/projectSummary/AuthorizationsInvolved.tsx

        required
        validate={[requiredList]}
        normalize={normalizeGroupCheckBox}
+        onDrop={(event) => {


This onDrop though was for a bug. I noticed that when I had "amendment" checked, and dropped a file, that it unchecked the box on me! Can be replicated in test, currently.

taraepp · 2024-06-07T21:54:40Z

services/common/src/components/projectSummary/AuthorizationsInvolved.tsx

      arrayPush(
        FORM.ADD_EDIT_PROJECT_SUMMARY,
-        `authorizations.[${code}].AMENDMENT.[${index}].amendment_documents`,
+        `authorizations.[${code}].${type}[${index}].amendment_documents`,


this here was for the documents duplicating. The change from AMENDMENT to ${type} is to stop them duplicating across new/amendment, and the index now being a prop set by the parent is what stops them from being duplicated across multiple amendments.

services/common/src/components/projectSummary/DocumentUpload.spec.tsx

taraepp · 2024-06-07T22:01:28Z

services/common/src/components/projectSummary/DocumentUpload.tsx

  };

  const tableDocuments =
-    initialValues?.documents?.map(
+    documents?.map(


I think that having initialValues here was also making bugs (not showing files that weren't in initialValues)

taraepp · 2024-06-07T22:04:04Z

services/common/src/setupTests.ts

@@ -23,7 +31,7 @@ jest.mock("@mds/common/providers/featureFlags/useFeatureFlag", () => ({
    isFeatureEnabled: () => true,
  }),
 }));
-
+window.scrollTo = jest.fn();


I was getting so many console errors from window.scrollTo and useLayoutEffect that I ran out of terminal lines and couldn't see the tests that were actually failing! Mocking made that better.

taraepp · 2024-06-07T22:04:28Z

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

-            return cls.query.filter_by(
-                project_summary_guid=project_summary_guid, deleted_ind=False).one_or_none()
-        return cls.query.filter(ProjectSummary.status_code.is_distinct_from("DFT")).filter_by(
+    def find_by_project_summary_guid(cls, project_summary_guid):


no longer filtering out DRAFT on CORE.

taraepp · 2024-06-07T22:06:54Z

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

@@ -195,21 +195,20 @@ export const MINE_PRE_APPLICATIONS = {
 };

 export const ADD_PROJECT_SUMMARY = {
-  route: "/mines/:mineGuid/project-description/new",
-  dynamicRoute: (mineGuid) => `/mines/${mineGuid}/project-description/new`,
+  route: "/mines/:mineGuid/project-description/new/:tab",


changed both these routes to match the name on MS so I could use GLOBAL_ROUTES

taraepp · 2024-06-07T22:08:14Z

...es/minespace-web/src/tests/components/project/projectSummaryPage/ProjectSummaryPage.spec.tsx

@@ -8,7 +8,8 @@ import {
  REGIONS,
 } from "@mds/common/tests/mocks/dataMocks";
 import { PROJECTS, STATIC_CONTENT } from "@mds/common/constants/reducerTypes";
-import { ReduxWrapper } from "@/tests/utils/ReduxWrapper";
+import { ReduxWrapper as CommonWrapper } from "@mds/common/tests/utils/ReduxWrapper";
+import { ReduxWrapper as MSWrapper } from "@/tests/utils/ReduxWrapper";


… table, don't clear documents on load, include separation of doc types to the initial formatting of the project summary. Remove a console log

…onding form values and apply it to accept an array of files

taraepp · 2024-06-11T22:53:50Z

services/common/src/components/projectSummary/AuthorizationSupportDocumentUpload.tsx

-    newDocuments.forEach((newDoc) => {
-      updateAmendmentDocuments(newDoc, code);
-    });
+    updateAmendmentDocuments(newDocuments);


the changes to updateAmendmentDocuments is a fix for the bug Alex posted in the bugs channel today. Before it was updating a single document, not really having the power of removing documents. Now it takes as its parameter the desired value of the field, allowing us to remove documents here.

taraepp · 2024-06-11T22:58:32Z

services/common/src/components/projectSummary/DocumentUpload.tsx

+        ...spatial_documents,
+        ...support_documents,
+      ])
+    );


Making sure that documents persist between user navigation events and are added to the table when uploaded. spatial & support variables are populated right in formatProjectSummary

taraepp · 2024-06-11T23:01:52Z

services/common/src/models/documents/document.ts

-    const canModify = is_latest_version && !this.is_archived;
-    if (!this.mine_document_guid) return [];
+    const canModify = is_latest_version && !this.is_archived && this.mine_document_guid;
+    const canView = this.file_type === ".pdf" && this.document_manager_guid;


For cypress tests. So that the actions column can be there before we save the file (download/view actions require document_manager_guid, not mine_document_guid, but I kept the other actions from being allowed)

henryoforeh-dev · 2024-06-12T15:25:07Z

services/common/src/components/projectSummary/LegalLandOwnerInformation.spec.tsx

+  <FormWrapper name={formName} onSubmit={() => {}}>
+    <LegalLandOwnerInformation />
+  </FormWrapper>
+);


Wondering if the ReduxWrapper can be used here for consistency.

With the .getActions used in the test, can't use ReduxWrapper. This one was only updated to make it stop console logging errors about missing form context.

Yes, this is correct. getActions() is a method of the store object which is encapsulated in ReduxWrapper.

services/common/src/components/forms/SteppedForm.tsx

sonarqubecloud · 2024-06-12T16:57:34Z

Quality Gate failed for 'bcgov-sonarcloud_mds_minespace-web'

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

See analysis details on SonarCloud

sonarqubecloud · 2024-06-12T16:57:52Z

Quality Gate failed for 'bcgov-sonarcloud_mds_common'

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

sonarqubecloud · 2024-06-12T16:58:02Z

Quality Gate failed for 'bcgov-sonarcloud_mds_core-web'

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

See analysis details on SonarCloud

sonarqubecloud · 2024-06-12T16:58:03Z

Quality Gate failed for 'bcgov-sonarcloud_mds_core-api'

Failed conditions
E Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

matbusby-fw · 2024-06-12T17:30:47Z

services/common/src/components/projectSummary/AuthorizationsInvolved.tsx

-
-const RenderEMAPermitCommonSections = ({ props }) => {
-  const { code } = props;
+const RenderEMAPermitCommonSections = ({ code, isAmendment, index }) => {


Love this change. Much clearer

matbusby-fw · 2024-06-12T18:08:08Z

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

            "Successfully updated project.",
            false
          )
        );
      })
-      .then(() => {
+      .then(async () => {


Do we need this async here?

matbusby-fw · 2024-06-12T18:09:20Z

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

-
-  const handleUpdate = (message) => {
-    const { project_guid, mrc_review_required, contacts, project_lead_party_guid } = formValues;
+  const handleUpdateProjectSummary = async (payload, message) => {


The combo of .then and async await here feels a bit clunky. Is it possible to make it all async/await?

That's probably a good thing to do. I don't want to expand the scope too much though, and want to unblock AMS work so I'll leave it as something to keep in mind for the future.

matbusby-fw

Looking great. Left one comment on maybe making one of the functions fully async/await rather than a mix of .then and async.

Some of the refactors are a bit tricky to track in a PR, but it all looks really solid!

taraepp added 7 commits June 7, 2024 20:08

remove some test noise using mocks, move components into common

4586872

update components for CORE: change route to be able to use GLOBAL_ROU…

6c99c39

…TES, update references, remove restriction on CORE viewing/saving a draft, fix a style issue

authorizations document bug- get rid of redux form state being double…

bdecc9d

…d up as props, make the forms have proper references. Use label props instead of hardcoding label text

fix indent error on BE

9d4588c

add ministry contact page, fix bug on project contacts, put the proje…

3aaf367

…ct summary form on the CORE project summary page, make adjustments both there and on MS

take out save draft

c12ab4b

make test work without mocking component, remove some temporary text

ac373c7

taraepp commented Jun 7, 2024

View reviewed changes

services/common/src/components/projectSummary/DocumentUpload.spec.tsx Outdated Show resolved Hide resolved

fix document upload snap test

eee764e

taraepp commented Jun 7, 2024

View reviewed changes

taraepp added 10 commits June 7, 2024 22:28

try fixing a cypress test

ccdb035

fix text

f50477b

fix text

eef25ac

click after on next page

50e2930

fix text in selector

1dc02b6

make edit/view mode persistent on CORE

bf9b2b7

take out unnecessary step from test

d49aeef

update selector

ee0c151

syntax error

47bfc54

add missing fields in contact

565b2a4

taraepp added 8 commits June 10, 2024 23:03

select differently

c863a13

scroll differently

4eb4949

scroll

6133eae

selector before going to Declaration page

90920af

fix bug with submitting on last page

648d1f7

change documents up a bit: different condition for view/download from…

e1e2c6f

… table, don't clear documents on load, include separation of doc types to the initial formatting of the project summary. Remove a console log

fix a documents bug. Make updateAmendmentDocuments update the corresp…

3185dd4

…onding form values and apply it to accept an array of files

revert showing version history on doc upload

3c8bccb

taraepp commented Jun 11, 2024

View reviewed changes

taraepp requested review from asinn134, simensma-fresh, henryoforeh-dev, matbusby-fw and isuru-aot June 11, 2024 23:22

henryoforeh-dev reviewed Jun 12, 2024

View reviewed changes

matbusby-fw reviewed Jun 12, 2024

View reviewed changes

services/common/src/components/forms/SteppedForm.tsx Outdated Show resolved Hide resolved

make SteppedForm extend FormWrapper props

f8afa66

henryoforeh-dev approved these changes Jun 12, 2024

View reviewed changes

matbusby-fw reviewed Jun 12, 2024

View reviewed changes

matbusby-fw approved these changes Jun 12, 2024

View reviewed changes

taraepp merged commit c8431da into develop Jun 12, 2024
20 of 24 checks passed

taraepp deleted the mds-5927-core-projects branch June 12, 2024 18:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MDS-5927] Bring Projects Form to CORE #3145

[MDS-5927] Bring Projects Form to CORE #3145

taraepp commented Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

matbusby-fw Jun 12, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 7, 2024

taraepp Jun 11, 2024

taraepp Jun 11, 2024

taraepp Jun 11, 2024

henryoforeh-dev Jun 12, 2024

taraepp Jun 12, 2024

henryoforeh-dev Jun 12, 2024

sonarqubecloud bot commented Jun 12, 2024

sonarqubecloud bot commented Jun 12, 2024

sonarqubecloud bot commented Jun 12, 2024

sonarqubecloud bot commented Jun 12, 2024

matbusby-fw Jun 12, 2024

matbusby-fw Jun 12, 2024

matbusby-fw Jun 12, 2024

taraepp Jun 12, 2024

matbusby-fw left a comment

[MDS-5927] Bring Projects Form to CORE #3145

[MDS-5927] Bring Projects Form to CORE #3145

Conversation

taraepp commented Jun 7, 2024

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

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 Jun 12, 2024

Quality Gate failed for 'bcgov-sonarcloud_mds_minespace-web'

sonarqubecloud bot commented Jun 12, 2024

Quality Gate failed for 'bcgov-sonarcloud_mds_common'

sonarqubecloud bot commented Jun 12, 2024

Quality Gate failed for 'bcgov-sonarcloud_mds_core-web'

sonarqubecloud bot commented Jun 12, 2024

Quality Gate failed for 'bcgov-sonarcloud_mds_core-api'

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

matbusby-fw left a comment

Choose a reason for hiding this comment