Solutions Feature Request Report #34026

zandre-eng · 2024-01-24T14:24:40Z

Product Description

A new dropdown option is added called "Solutions Feature Request":

Clicking on this button will cause a popup form to show:

After clicking Submit, a Jira ticket will be created in this project space.

It should be noted that this new Solutions feature request form is only available to staff members. Users that are not staff will not see the new dropdown option or the new modal form.

Technical Summary

Link to ticket here.

This PR adds a reporting system very similar to bug reports where a user can fill out a form which will automatically send an email. This email will, in turn, automatically create a Jira issue.

Note: This PR should only be merged once the changes from this PR have been merged. The linked PR will no longer be merged and the variable for the Solutions feedback email address will be inserted into CommCare HQ's code with this PR.

Feature Flag

None

Safety Assurance

Safety story

Local testing
Unit test
QA passed

Automated test coverage

Unit test exist for view sending email.

QA Plan

QA ticket has been created and is available here.

Note: QA has passed.

Rollback instructions

This PR can be reverted after deploy with no further considerations

Labels & Review

Risk label is set correctly
The set of people pinged as reviewers is appropriate for the level of risk of the change

corehq/apps/hqwebapp/views.py

mkangia

Hey Zandre,

Great PR, good flow of commits.
Left some blocking feedback to consider for improvements.

...hq/apps/hqwebapp/templates/hqwebapp/includes/bootstrap3/modal_solutions_feature_request.html

mkangia · 2024-01-25T07:11:22Z

...hq/apps/hqwebapp/templates/hqwebapp/includes/bootstrap5/modal_solutions_feature_request.html

+                          Comma-separated email addresses of others you want to notify about this request.
+                      {% endblocktrans %}
+                      <span class="badge bade-danger hide">
+                          <i class="fa fa-warning"></i> {% trans 'Incorrect Format' %}


how is the format validated for emails?

I have added the missing JS files (1b19cdf). The validation is happening in these files.

corehq/apps/hqwebapp/templates/hqwebapp/base.html

corehq/apps/hqwebapp/templates/hqwebapp/includes/bootstrap3/global_navigation_bar.html

corehq/apps/hqwebapp/views.py

mkangia · 2024-01-25T07:17:42Z

corehq/apps/hqwebapp/views.py

+@method_decorator([login_required], name='dispatch')
+class SolutionsFeatureRequestView(View):
+    def post(self, request, *args, **kwargs):
+        email = _get_email_message_base(


lets also check here that the user is a staff member?

mkangia · 2024-01-25T07:18:48Z

corehq/apps/hqwebapp/views.py

@@ -864,7 +864,7 @@ def post(self, request, *args, **kwargs):
            post_params=request.POST,
            couch_user=request.couch_user,
            uploaded_file=request.FILES.get('feature_request'),
-            to_email=settings.SOLUTIONS_EMAIL,
+            to_email=settings.INTERNAL_FEEDBACK_EMAIL,


that might have been a better name actually.
dimagi/commcare-cloud#6211 (comment)

SmittieC · 2024-01-25T07:21:28Z

corehq/apps/hqwebapp/views.py

-            email.from_email = settings.SUPPORT_EMAIL
-
-        return email
+        email.send(fail_silently=False)


Might be good to tell the user all went well?

After adding the missing JS files (1b19cdf), the user should now see a success message as follows:

corehq/apps/hqwebapp/static/hqwebapp/js/bootstrap3/solutions-feature-request.js

mkangia · 2024-01-25T18:30:19Z

corehq/apps/hqwebapp/views.py

-            to_email=settings.INTERNAL_FEEDBACK_EMAIL,
-        )
-        email.send(fail_silently=False)
+        if request.couch_user.is_staff:


should we return a 400 or similar in case the user isn't a staff?

Good idea, this would make it more obvious that something went wrong.

mkangia · 2024-01-30T08:18:46Z

corehq/apps/hqwebapp/static/hqwebapp/js/bootstrap3/email-request.js

@@ -53,7 +54,7 @@ hqDefine('hqwebapp/js/bootstrap3/email-request', [
                return false;
            }

-            if (!self.isRequestReportSubmitting && self.$submitBtn.text() === self.$submitBtn.data("success-text")) {
+            if (!self.isRequestReportSubmitting && self.isReportSent) {


mkangia · 2024-01-30T08:22:32Z

Thanks for the follow up @zandre-eng

Cool, will look forward to QA before I set this as approved. No blocking feedback now.

only available to Dimagi staff members

One small detail here would be to simply say "only available to Staff members" or "users marked as staff" or "users with staff access" to keep this generic.

…ons-feature-request-option

mkangia · 2024-02-08T19:37:34Z

corehq/apps/hqwebapp/static/hqwebapp/js/bootstrap5/email-request.js

@@ -36,7 +36,7 @@ hqDefine('hqwebapp/js/bootstrap5/email-request', [
        self.$formElement.submit(() => {
            resetErrors();

-            const isDescriptionEmpty = !self.subjectText() && !self.descriptionText();
+            const isDescriptionEmpty = !self.subjectText();


should the name be changed here as well? isSubjectEmpty.

Ah, yes that should. This should match how we have it for the bootstrap 3 version.

mkangia · 2024-02-09T10:36:41Z

settings.py

@@ -491,6 +491,7 @@
 DAILY_DEPLOY_EMAIL = None
 EMAIL_SUBJECT_PREFIX = '[commcarehq] '
 SAAS_REPORTING_EMAIL = None
+INTERNAL_FEEDBACK_EMAIL = '[email protected]'


we don't need this now yes?

We don't, I'll remove this (1d22c49)

Charl1996

Nice work, @zandre-eng !

orangejenny · 2024-06-11T19:12:49Z

FYI, this broke the report an issue functionality for B5 pages, and I don't think the solutions feature request modal has ever worked on B5 pages. There's logic around validating the subject that's missing from the B5 templates (see this diff line for some code that I suspect should be in both B3 and B5 versions of the template), which is causing validation to always fail.

zandre-eng · 2024-06-12T09:21:43Z

FYI, this broke the report an issue functionality for B5 pages, and I don't think the solutions feature request modal has ever worked on B5 pages. There's logic around validating the subject that's missing from the B5 templates (see this diff line for some code that I suspect should be in both B3 and B5 versions of the template), which is causing validation to always fail.

@orangejenny Thanks for flagging this, I'll take a look into it. I think all the testing was done on B3 pages which is probably how this managed to slip past.

orangejenny · 2024-06-12T12:30:19Z

@zandre-eng Cool, thank you. Yeah, I was looking at the date and figuring there might not have even been any B5 pages to test on at the time.

zandre-eng added 8 commits January 18, 2024 09:29

create modal HTML template

63641f0

add nav option

92acd37

extract email logic to separate func

fb5beb7

implement view for sending email

20d6974

rename email property

73c3c9a

add property to settings file

f74ecd1

add urlname

a99d5f3

add unit test

4adf0f1

zandre-eng added Open for review: do not merge A work in progress product/all-users-all-environments Change impacts all users on all environments labels Jan 24, 2024

zandre-eng requested review from kaapstorm, Charl1996 and SmittieC January 24, 2024 14:24

dimagimon added the Risk: Medium Change affects files that have been flagged as medium risk. label Jan 24, 2024

zandre-eng marked this pull request as ready for review January 24, 2024 14:26

zandre-eng requested a review from orangejenny as a code owner January 24, 2024 14:26

build bootstrap diffs

ea4c1e5

zandre-eng requested a review from mkangia January 25, 2024 05:54

SmittieC reviewed Jan 25, 2024

View reviewed changes

corehq/apps/hqwebapp/views.py Outdated Show resolved Hide resolved

mkangia requested changes Jan 25, 2024

View reviewed changes

SmittieC reviewed Jan 25, 2024

View reviewed changes

zandre-eng added 4 commits January 25, 2024 10:27

revert name change

d128f19

copy js files

1b19cdf

fix incorrect JS file name

6c1635f

add staff check

59fa94f

mkangia reviewed Jan 25, 2024

View reviewed changes

corehq/apps/hqwebapp/static/hqwebapp/js/bootstrap3/solutions-feature-request.js Outdated Show resolved Hide resolved

lint fixes

39afa9b

mkangia reviewed Jan 25, 2024

View reviewed changes

zandre-eng added 2 commits January 26, 2024 09:22

create generic emailRequest JS file

1dbaf53

add model variables

2e000fa

zandre-eng added 3 commits January 30, 2024 09:43

remove unused ko variable

d7e5bb8

replace text comparison with flag

2d377ef

bootstrap5 diffs

b0d01ef

mkangia reviewed Jan 30, 2024

View reviewed changes

biyeun and others added 6 commits February 6, 2024 22:14

Merge branch 'master' of github.com:dimagi/commcare-hq into ze/soluti…

d275825

…ons-feature-request-option

change check to is_dimagi

a9e792b

check for couch user instead of user

70423fa

make subject required field

8ce397a

make subject required field (bootstrap 5)

1dbf1ab

reset report sent flag before closing modal

2afeb2e

mkangia reviewed Feb 8, 2024

View reviewed changes

change var name for bootstrap 5 JS file

d0ebdda

zandre-eng added QA Passed and removed Open for review: do not merge A work in progress labels Feb 9, 2024

zandre-eng requested review from mkangia and SmittieC February 9, 2024 08:39

mkangia reviewed Feb 9, 2024

View reviewed changes

mkangia approved these changes Feb 9, 2024

View reviewed changes

remove feedback email var from settings

1d22c49

mkangia approved these changes Feb 9, 2024

View reviewed changes

Charl1996 approved these changes Feb 9, 2024

View reviewed changes

zandre-eng merged commit a75cf96 into master Feb 9, 2024
13 checks passed

zandre-eng deleted the ze/solutions-feature-request-option branch February 9, 2024 12:31

This was referenced Feb 15, 2024

Add Check Before Applying KO Bindings #34127

Merged

Add Check Before Applying KO Bindings on Bug Report #34129

Merged

zandre-eng mentioned this pull request Jun 12, 2024

Fix Solutions Feedback/Bug Report Request + Rewording for B5 #34760

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Solutions Feature Request Report #34026

Solutions Feature Request Report #34026

zandre-eng commented Jan 24, 2024 •

edited

Loading

mkangia left a comment

mkangia Jan 25, 2024

zandre-eng Jan 25, 2024 •

edited

Loading

mkangia Jan 25, 2024

mkangia Jan 25, 2024

SmittieC Jan 25, 2024

zandre-eng Jan 25, 2024

mkangia Jan 25, 2024

zandre-eng Jan 26, 2024

zandre-eng Jan 26, 2024

mkangia Jan 30, 2024

mkangia commented Jan 30, 2024

mkangia Feb 8, 2024

zandre-eng Feb 9, 2024

zandre-eng Feb 9, 2024

mkangia Feb 9, 2024

zandre-eng Feb 9, 2024

Charl1996 left a comment

orangejenny commented Jun 11, 2024 •

edited

Loading

zandre-eng commented Jun 12, 2024

orangejenny commented Jun 12, 2024

Solutions Feature Request Report #34026

Solutions Feature Request Report #34026

Conversation

zandre-eng commented Jan 24, 2024 • edited Loading

Product Description

Technical Summary

Feature Flag

Safety Assurance

Safety story

Automated test coverage

QA Plan

Rollback instructions

Labels & Review

mkangia left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zandre-eng Jan 25, 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

mkangia commented Jan 30, 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

Charl1996 left a comment

Choose a reason for hiding this comment

orangejenny commented Jun 11, 2024 • edited Loading

zandre-eng commented Jun 12, 2024

orangejenny commented Jun 12, 2024

zandre-eng commented Jan 24, 2024 •

edited

Loading

zandre-eng Jan 25, 2024 •

edited

Loading

orangejenny commented Jun 11, 2024 •

edited

Loading