Deseng 464 : Poll widget UI #2367

ratheesh-aot · 2024-01-27T00:36:19Z

Issue #: https://apps.itsm.gov.bc.ca/jira/browse/DESENG-464

Description of changes:

Created UI for Poll Widget.
Updated Poll widget API and unit tests.

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

codecov-commenter · 2024-01-27T00:41:57Z

Codecov Report

Attention: 284 lines in your changes are missing coverage. Please review.

Comparison is base (ed80ca2) 73.22% compared to head (da2ce7f) 72.20%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2367      +/-   ##
==========================================
- Coverage   73.22%   72.20%   -1.03%     
==========================================
  Files         498      508      +10     
  Lines       16753    17123     +370     
  Branches     1227     1290      +63     
==========================================
+ Hits        12267    12363      +96     
- Misses       4262     4520     +258     
- Partials      224      240      +16

Flag	Coverage Δ
metapi	`86.91% <82.35%> (-0.01%)`	⬇️
metweb	`59.08% <28.38%> (-1.37%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
met-web/src/apiManager/endpoints/index.ts	`100.00% <ø> (ø)`
...b/src/components/engagement/form/ActionContext.tsx	`58.82% <100.00%> (ø)`
...gement/form/EngagementWidgets/WidgetDrawerTabs.tsx	`100.00% <100.00%> (ø)`
...ement/form/EngagementWidgets/WidgetOptionCards.tsx	`100.00% <100.00%> (ø)`
...ponents/engagement/form/EngagementWidgets/type.tsx	`100.00% <ø> (ø)`
...omponents/engagement/view/widgets/WidgetSwitch.tsx	`100.00% <100.00%> (ø)`
met-web/src/constants/engagementStatus.ts	`100.00% <100.00%> (ø)`
met-web/src/models/widget.tsx	`100.00% <100.00%> (ø)`
...s/engagement/form/EngagementWidgets/Poll/index.tsx	`83.33% <83.33%> (ø)`
...et-api/src/met_api/services/widget_poll_service.py	`90.21% <84.00%> (-3.12%)`	⬇️
... and 12 more

... and 1 file with indirect coverage changes

Baelx

Looks great! Could I ask for a few small changes:

Correct variable names that use snake_case
Fix PollDisplay.tsx map keys. Change from using index to a string containing the index

Let's discuss:

Creating wrapper methods at the Poll resource API layer. Could you just let me know why those are necessary?

Baelx · 2024-01-29T17:49:34Z

met-api/src/met_api/resources/widget_poll.py

        if not valid_format:
            errors = schema_utils.serialize(errors)
        return valid_format, errors

+    @staticmethod


Just curious why we need this wrapper function around is_poll_engagement_published

Will update the structure as other resource file to avoid confusion

Baelx · 2024-01-29T17:50:56Z

met-api/src/met_api/resources/widget_poll.py

+    def is_poll_engagement_published(poll_id):
+        """Check if engagement of this poll is published or not."""
+        return WidgetPollService.is_poll_engagement_published(poll_id)
+
    @staticmethod
    def is_poll_limit_exceeded(poll_id, participant_id):


I know this is from a previous PR but why do we need a wrapper function for this?

Will update the structure as other resource file to avoid confusion

Baelx · 2024-01-29T17:53:10Z

met-api/src/met_api/services/widget_poll_service.py

+        try:
+            poll = WidgetPollService.get_poll_by_id(poll_id)
+            engagement = EngagementService().get_engagement(poll.engagement_id)
+            pub_val = EngagementStatus.Published.value


Did you save this to a variable to keep the line length short on line 102?

Yes. as the max length of line by flake8 is 79

Baelx · 2024-01-29T17:53:30Z

met-api/src/met_api/services/widget_poll_service.py

+            if engagement is None:
+                return False
+            # Check if the engagement's status matches the published value
+            return engagement.get('status_id') == pub_val


Suggested change

return engagement.get('status_id') == pub_val

return engagement.get('status_id') == EngagementStatus.Published.value

the max length of the line by flake8 is 79.

Baelx · 2024-01-29T17:58:58Z

met-api/src/met_api/services/widget_poll_service.py

-        answers_data = poll_data.get('answers', [])
-        PollAnswerService.create_bulk_poll_answers(poll_id, answers_data)
+        try:
+            if 'answers' in poll_data and len(poll_data['answers']) > 0:


By the looks of this, if a user tried to save a poll with no answers then it would fail silently, correct?

This probably won't happen that often but we should probably notify them that their save was unsuccessful. Does that happen somewhere? Or does the frontend block saving if no answers are provided?

This function ensures that if there are no changes to the answers in the API, there is no need to update the answers. Especially, while patching status only when engagement is published.

Got it, it's clear now!

Baelx · 2024-01-29T18:52:44Z

met-web/src/components/engagement/form/EngagementWidgets/Poll/Form.tsx

+        onSubmit(restructuredData);
+    };
+
+    const savePollWidget = (data: DetailsForm) => {


Could be a way to make this function a bit shorter.

Suggested change

const savePollWidget = (data: DetailsForm) => {

const savePollWidget = (data: DetailsForm) => !pollWidget ? createPoll(data) : updatePoll(data);

thanks. will do that

Baelx · 2024-01-29T19:45:39Z

met-web/src/components/engagement/form/EngagementWidgets/Poll/PollDisplay.tsx

+            >
+                {pollWidget.answers.map((answer, index) => (
+                    <FormControlLabel
+                        key={index}


Suggested change

key={index}

key={'answer' + index}

Baelx · 2024-01-29T21:39:38Z

met-web/src/components/engagement/view/widgets/Poll/PollWidgetView.tsx

+
+    const fetchPollDetails = async () => {
+        try {
+            const poll_widgets = await fetchPollWidgets(widget.id);


It can be confusing going between JS and Python sometimes I know :P

Suggested change

const poll_widgets = await fetchPollWidgets(widget.id);

const pollWidgets = await fetchPollWidgets(widget.id);

True!!, Thanks for noting that.

Baelx · 2024-01-29T21:54:03Z

met-web/src/components/engagement/view/widgets/Poll/PollWidgetView.tsx

+            setInteractionEnabled(true);
+        }
+        // Irrespective of the error mark the poll as submitted to avoid re-submitting
+        setIsSubmitted(true);


Is this an anti-spam measure? I'm thinking there may be a situation where someone has loaded the app but then loses connection and tries to submit. The server may not respond but their submission would still be counted toward their total

Yes, its for anti-spamming. But as you pointed out we need to consider server unavailability scenario too. Will update the logic like if limit error, disable poll otherwise keep it enabled for re-submission

Baelx · 2024-01-29T22:09:59Z

met-web/src/components/engagement/view/widgets/Poll/PollWidgetView.tsx

+                        interactionEnabled={interactionEnabled && !isSubmitted && !isLoggedIn}
+                        onOptionChange={handleOptionChange}
+                    />
+                    {!isLoggedIn && (


Does this prevent users of the backend from voting?

yes, logged in users cannot vote

sonarqubecloud · 2024-01-31T00:03:42Z

Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

13 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

ratheesh-aot added 8 commits January 25, 2024 13:08

DESENG-464: Poll UI basic

0cf44a6

DESENG-464: Updated service

41680d6

DESENG-464: Updating MODEL

a28a0b8

DESENG-464: Poll Editing restricted

bfd0fff

DESENG-464: Poll UI wrapping up

5e2a50a

DESENF-464: Poll UI wrapped up

e2cebe5

Changelog updated

6177797

Merge remote-tracking branch 'upstream/main' into DESENG-464-POLL-UI

7c7f8f5

ratheesh-aot requested review from Baelx, NatSquared and VineetBala-AOT January 27, 2024 00:36

ratheesh-aot added 3 commits January 26, 2024 16:58

Fixing issues

d6780cc

DESENG-464: Refactoring Poll Widget

d620ab5

Fixed Build issues with github

4d4b138

Baelx requested changes Jan 29, 2024

View reviewed changes

ratheesh-aot added 2 commits January 30, 2024 09:12

Merge remote-tracking branch 'upstream/main' into DESENG-464-POLL-UI

eedbd91

Fixing review comments

da2ce7f

ratheesh-aot requested a review from Baelx January 31, 2024 00:02

Baelx approved these changes Jan 31, 2024

View reviewed changes

ratheesh-aot merged commit 40fe3b9 into bcgov:main Jan 31, 2024
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deseng 464 : Poll widget UI #2367

Deseng 464 : Poll widget UI #2367

ratheesh-aot commented Jan 27, 2024

codecov-commenter commented Jan 27, 2024 •

edited

Loading

Baelx left a comment

Baelx Jan 29, 2024

ratheesh-aot Jan 31, 2024

Baelx Jan 29, 2024

ratheesh-aot Jan 31, 2024

Baelx Jan 29, 2024

ratheesh-aot Jan 30, 2024

Baelx Jan 29, 2024

ratheesh-aot Jan 30, 2024 •

edited

Loading

Baelx Jan 29, 2024

ratheesh-aot Jan 30, 2024

Baelx Jan 30, 2024

Baelx Jan 29, 2024

ratheesh-aot Jan 30, 2024

Baelx Jan 29, 2024

ratheesh-aot Jan 30, 2024

Baelx Jan 29, 2024

ratheesh-aot Jan 30, 2024

Baelx Jan 29, 2024

ratheesh-aot Jan 30, 2024 •

edited

Loading

Baelx Jan 29, 2024

ratheesh-aot Jan 30, 2024

sonarqubecloud bot commented Jan 31, 2024

	return engagement.get('status_id') == pub_val
	return engagement.get('status_id') == EngagementStatus.Published.value

	const savePollWidget = (data: DetailsForm) => {
	const savePollWidget = (data: DetailsForm) => !pollWidget ? createPoll(data) : updatePoll(data);

	const poll_widgets = await fetchPollWidgets(widget.id);
	const pollWidgets = await fetchPollWidgets(widget.id);

Deseng 464 : Poll widget UI #2367

Deseng 464 : Poll widget UI #2367

Conversation

ratheesh-aot commented Jan 27, 2024

codecov-commenter commented Jan 27, 2024 • edited Loading

Codecov Report

Baelx left a 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

ratheesh-aot Jan 30, 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

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

ratheesh-aot Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 31, 2024

Quality Gate passed

codecov-commenter commented Jan 27, 2024 •

edited

Loading

ratheesh-aot Jan 30, 2024 •

edited

Loading

ratheesh-aot Jan 30, 2024 •

edited

Loading