Validate confirmation Id (activityId) for Enquiries #121

qhanson55 · 2024-07-26T00:12:06Z

Description

Made it so that a warning toast pops out when the confirmation id (activityId) entered by the proponent doesn't return a submissions search result.
Proponents will now be visually told that they are entering an invalid id but not stopped from doing so.
PADS-181

Types of changes

New feature (non-breaking change which adds functionality)

Checklist

I have read the CONTRIBUTING doc
I have checked that unit tests pass locally with my changes
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)

Further comments

github-actions · 2024-07-26T00:12:46Z

Coverage Report (Application)

Totals
Statements:	46.06% ( 941 / 2043 )
Methods:	36.02% ( 134 / 372 )
Lines:	56.98% ( 612 / 1074 )
Branches:	32.66% ( 195 / 597 )

qhanson55 · 2024-07-26T00:52:10Z

frontend/src/views/DeveloperView.vue

@@ -17,10 +17,6 @@ const { getConfig } = storeToRefs(useConfigStore());
 const permissionService = new PermissionService();
 const router = useRouter();

-async function ssoRequestBasicAccess() {


deleted as was triggering unused warning

github-actions · 2024-07-26T00:52:19Z

Coverage Report (Frontend)

Totals
Statements:	32.35% ( 1422 / 4395 )
Methods:	27.84% ( 245 / 880 )
Lines:	37.06% ( 879 / 2372 )
Branches:	26.07% ( 298 / 1143 )

codeclimate · 2024-07-26T00:52:48Z

Code Climate has analyzed commit 25882d0 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category	Count
Duplication	1

The test coverage on the diff in this pull request is 61.5% (50% is the threshold).

This pull request will bring the total coverage in the repository to 43.2% (0.1% change).

View more on Code Climate.

qhanson55 · 2024-07-26T00:53:09Z

frontend/src/views/housing/submission/SubmissionView.vue

-            (order: number) => {
-              sortOrder = order;
+            (order: number | undefined) => {
+              order !== undefined ? (sortOrder = order) : null;


triggered this error, this fixes it:

Types of parameters 'order' and 'value' are incompatible. Type 'number | undefined' is not assignable to type 'number'. Type 'undefined' is not assignable to type 'number'. 206 @update:sort-order="

wilwong89 · 2024-07-29T17:27:09Z

frontend/src/components/housing/enquiry/EnquiryIntakeForm.vue

+
+  if (activityId) {
+    const submission = (await submissionService.searchSubmissions({ activityId: [activityId] })).data[0];


We could check the backend for activityId when there are exactly 8 characters, as that's the length of it. Will save on network calls.

On another note, I think we need to think a little ahead and make checking for submissions its own endpoint instead of using searchSubmissions. Right now, any user would be able to search our entire DB and retrieve any submission. There should be a new endpoint that only returns existence or non-existence for now.

checking 8 characters now as well as if it is a hexadecimal value.

Implemented a new endpoint for checking the validility.

kyle1morel · 2024-07-29T17:52:38Z

frontend/src/components/housing/enquiry/EnquiryIntakeForm.vue

@@ -234,6 +234,19 @@ async function emailConfirmation(activityId: string) {
  };
  await submissionService.emailConfirmation(emailData);
 }
+
+async function checkValidility(event: Event) {


Function name is unclear. What are we checking the validity of?

added ActivityId for clarity

codeclimate · 2024-07-31T21:16:09Z

app/src/routes/v1/enquiry.ts

@@ -69,4 +69,9 @@ router.patch(
  }
 );

+//** Validates an Activity Id */
+router.get('/validate/:activityId', (req: Request, res: Response, next: NextFunction): void => {


Similar blocks of code found in 3 locations. Consider refactoring.

kyle1morel · 2024-08-01T16:39:11Z

app/src/controllers/enquiry.ts

+      }
+      const activity = await activityService.getActivity(activityId);
+
+      res.status(200).json({ valid: Boolean(activity && !activity.isDeleted) });


Is the Boolean wrapper necessary here? activity && !activity.isDeleted should evaluate to what you're looking for.

If boolean wrapping is required if/when one of the variables ends up being undefined/falsy, it would be better do do it with a double !! as we typically want to avoid using JS boxing functions when we are forced to cast to a different type.

res.status(200).json({ valid: !!activity && !activity.isDeleted });

kyle1morel · 2024-08-01T16:41:36Z

app/src/routes/v1/enquiry.ts

+//** Validates an Activity Id */
+router.get('/validate/:activityId', (req: Request, res: Response, next: NextFunction): void => {
+  enquiryController.validateActivityId(req, res, next);
+});
+


Consider moving this to a new activity route. As we are not touching any enquiry logic this feels out of place here.

jujaga · 2024-08-01T17:13:06Z

app/src/controllers/enquiry.ts

+      }
+      const activity = await activityService.getActivity(activityId);
+
+      res.status(200).json({ valid: Boolean(activity && !activity.isDeleted) });


If boolean wrapping is required if/when one of the variables ends up being undefined/falsy, it would be better do do it with a double !! as we typically want to avoid using JS boxing functions when we are forced to cast to a different type.

res.status(200).json({ valid: !!activity && !activity.isDeleted });

frontend/src/components/housing/enquiry/EnquiryIntakeForm.vue

…s and a new endpoint in backend to perform said check

app/src/routes/v1/activity.ts

qhanson55 requested review from kyle1morel, wilwong89 and sanjaytkbabu as code owners July 26, 2024 00:12

qhanson55 force-pushed the feature/validate-enquiries branch 2 times, most recently from 1a0d931 to 4f990a4 Compare July 26, 2024 00:51

qhanson55 commented Jul 26, 2024

View reviewed changes

wilwong89 reviewed Jul 29, 2024

View reviewed changes

kyle1morel reviewed Jul 29, 2024

View reviewed changes

qhanson55 force-pushed the feature/validate-enquiries branch from 4f990a4 to fbd48ae Compare July 31, 2024 21:14

codeclimate bot reviewed Jul 31, 2024

View reviewed changes

kyle1morel reviewed Aug 1, 2024

View reviewed changes

jujaga reviewed Aug 1, 2024

View reviewed changes

implemented warning in frontend for invalid confirmation(activity) Id…

25882d0

…s and a new endpoint in backend to perform said check

qhanson55 force-pushed the feature/validate-enquiries branch from fbd48ae to 25882d0 Compare August 1, 2024 19:50

codeclimate bot reviewed Aug 1, 2024

View reviewed changes

app/src/routes/v1/activity.ts Show resolved Hide resolved

wilwong89 approved these changes Aug 2, 2024

View reviewed changes

kyle1morel approved these changes Aug 2, 2024

View reviewed changes

wilwong89 merged commit 41caf2f into master Aug 2, 2024
19 checks passed

wilwong89 deleted the feature/validate-enquiries branch August 2, 2024 17:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate confirmation Id (activityId) for Enquiries #121

Validate confirmation Id (activityId) for Enquiries #121

qhanson55 commented Jul 26, 2024

github-actions bot commented Jul 26, 2024 •

edited

Loading

qhanson55 Jul 26, 2024

github-actions bot commented Jul 26, 2024 •

edited

Loading

codeclimate bot commented Jul 26, 2024 •

edited

Loading

qhanson55 Jul 26, 2024 •

edited

Loading

wilwong89 Jul 29, 2024

qhanson55 Jul 31, 2024

kyle1morel Jul 29, 2024

qhanson55 Jul 31, 2024

codeclimate bot Jul 31, 2024

kyle1morel Aug 1, 2024

jujaga Aug 1, 2024

kyle1morel Aug 1, 2024

jujaga Aug 1, 2024


		if (activityId) {
		const submission = (await submissionService.searchSubmissions({ activityId: [activityId] })).data[0];

Validate confirmation Id (activityId) for Enquiries #121

Validate confirmation Id (activityId) for Enquiries #121

Conversation

qhanson55 commented Jul 26, 2024

Description

Types of changes

Checklist

Further comments

github-actions bot commented Jul 26, 2024 • edited Loading

Coverage Report (Application)

Choose a reason for hiding this comment

github-actions bot commented Jul 26, 2024 • edited Loading

Coverage Report (Frontend)

codeclimate bot commented Jul 26, 2024 • edited Loading

qhanson55 Jul 26, 2024 • edited Loading

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

codeclimate bot Jul 31, 2024

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

github-actions bot commented Jul 26, 2024 •

edited

Loading

github-actions bot commented Jul 26, 2024 •

edited

Loading

codeclimate bot commented Jul 26, 2024 •

edited

Loading

qhanson55 Jul 26, 2024 •

edited

Loading