Add feedback call to action (#374)

Co-authored-by: Andrew Maddaford <ajmaddaford@gmail.com>

Author: JamesGardiner

Makefile

@@ -17,6 +17,7 @@ build: load-design-system-templates
 
 lint:
 	pipenv run ./scripts/run_lint_python.sh
+	yarn lint
 
 format: format-python
 	yarn format

app/data_models/session_data.py

@@ -19,7 +19,7 @@ def __init__(
         trad_as=None,
         display_address=None,
         confirmation_email_count=0,
-        feedback_sent=False,
+        feedback_count=0,
         **_,
     ):  # pylint: disable=too-many-locals
         self.tx_id = tx_id
@@ -40,4 +40,4 @@ def __init__(
         self.account_service_log_out_url = account_service_log_out_url
         self.display_address = display_address
         self.confirmation_email_count = confirmation_email_count
-        self.feedback_sent = feedback_sent
+        self.feedback_count = feedback_count

app/helpers/session_helpers.py

@@ -2,7 +2,7 @@
 
 from flask_login import current_user
 
-from app.globals import get_questionnaire_store
+from app.globals import get_questionnaire_store, get_session_store
 
 
 def with_questionnaire_store(function):
@@ -19,3 +19,16 @@ def wrapped_function(*args, **kwargs):
         return function(questionnaire_store, *args, **kwargs)
 
     return wrapped_function
+
+
+def with_session_store(function):
+    """Adds the `session_store` as an argument.
+    Use on flask request handlers or methods called by flask request handlers.
+    """
+
+    @wraps(function)
+    def wrapped_function(*args, **kwargs):
+        session_store = get_session_store()
+        return function(session_store, *args, **kwargs)
+
+    return wrapped_function

app/routes/errors.py

@@ -1,6 +1,7 @@
 from flask import Blueprint, request
 from flask import session as cookie_session
 from flask.helpers import url_for
+from flask_babel import lazy_gettext
 from flask_login import current_user
 from flask_wtf.csrf import CSRFError
 from sdc.crypto.exceptions import InvalidTokenException
@@ -15,6 +16,7 @@
 from app.helpers.template_helpers import render_template
 from app.settings import EQ_SESSION_ID
 from app.submitter.submission_failed import SubmissionFailedException
+from app.views.handlers.feedback import FeedbackLimitReached
 from app.views.handlers.individual_response import (
     FulfilmentRequestFailedException,
     IndividualResponseLimitReached,
@@ -78,7 +80,39 @@ def method_not_allowed(error=None):
 @errors_blueprint.app_errorhandler(IndividualResponseLimitReached)
 def too_many_individual_response_requests(error=None):
     log_error(error, 429)
-    return _render_error_page(429, template="429-individual-response")
+    title = lazy_gettext(
+        "You have reached the maximum number of individual access codes"
+    )
+    contact_us_message = lazy_gettext(
+        "If you need more individual access codes, please <a href='{url}'>contact us</a>."
+    )
+
+    return _render_error_page(
+        429,
+        template="429",
+        page_title=title,
+        heading=title,
+        contact_us_message=contact_us_message,
+    )
+
+
+@errors_blueprint.app_errorhandler(FeedbackLimitReached)
+def too_many_feedback_requests(error=None):
+    log_error(error, 429)
+    title = lazy_gettext(
+        "You have reached the maximum number of times for submitting feedback"
+    )
+    contact_us_message = lazy_gettext(
+        "If you need to give more feedback, please <a href='{url}'>contact us</a>."
+    )
+
+    return _render_error_page(
+        429,
+        template="429",
+        page_title=title,
+        heading=title,
+        contact_us_message=contact_us_message,
+    )
 
 
 @errors_blueprint.app_errorhandler(SubmissionFailedException)
@@ -110,7 +144,7 @@ def http_exception(error):
 
 
 @errors_blueprint.app_errorhandler(FulfilmentRequestFailedException)
-def fulfilment_request_failed(error):
+def fulfilment_request_failed(_):
     logger.exception(
         "An individual response fulfilment request failed",
         url=request.url,

app/routes/questionnaire.py

@@ -12,7 +12,7 @@
 from app.globals import get_metadata, get_session_store, get_session_timeout_in_seconds
 from app.helpers.language_helper import handle_language
 from app.helpers.schema_helpers import with_schema
-from app.helpers.session_helpers import with_questionnaire_store
+from app.helpers.session_helpers import with_questionnaire_store, with_session_store
 from app.helpers.template_helpers import get_census_base_url, render_template
 from app.helpers.url_param_serializer import URLParamSerializer
 from app.questionnaire.location import InvalidLocationException
@@ -26,7 +26,7 @@
 )
 from app.views.handlers.feedback import (
     Feedback,
-    FeedbackAlreadySent,
+    FeedbackLimitReached,
     FeedbackNotEnabled,
 )
 from app.views.handlers.section import SectionHandler
@@ -72,7 +72,10 @@ def before_questionnaire_request():
 @post_submission_blueprint.before_request
 @login_required
 def before_post_submission_request():
-    session_data = get_session_store().session_data
+    session_store = get_session_store()
+    session_data = session_store.session_data
+    if not session_data.submitted_time:
+        raise NotFound
 
     handle_language()
 
@@ -277,9 +280,10 @@ def relationships(
 
 
 @post_submission_blueprint.route("thank-you/", methods=["GET", "POST"])
+@with_session_store
 @with_schema
-def get_thank_you(schema):
-    thank_you = ThankYou(schema)
+def get_thank_you(schema, session_store):
+    thank_you = ThankYou(schema, session_store)
 
     if request.method == "POST":
         if not thank_you.confirmation_email:
@@ -288,37 +292,48 @@ def get_thank_you(schema):
         confirmation_email = thank_you.confirmation_email
 
         if confirmation_email.form.validate():
-            confirmation_email.handle_post()
+            confirmation_email.handle_post(session_store)
             return redirect(
                 url_for(
-                    "post_submission.get_confirmation_email_sent",
+                    ".get_confirmation_email_sent",
                     email=confirmation_email.get_url_safe_serialized_email(),
                 )
             )
 
+    show_feedback_call_to_action = True
+
+    try:
+        Feedback(schema, session_store, form_data=request.form)
+    except (FeedbackNotEnabled, FeedbackLimitReached):
+        show_feedback_call_to_action = False
+
     return render_template(
         template=thank_you.template,
-        content=thank_you.get_context(),
+        content={
+            **thank_you.get_context(),
+            "show_feedback_call_to_action": show_feedback_call_to_action,
+        },
         survey_id=schema.json["survey_id"],
         page_title=thank_you.get_page_title(),
     )
 
 
 @post_submission_blueprint.route("confirmation-email/send", methods=["GET", "POST"])
-def send_confirmation_email():
-    if not get_session_store().session_data.confirmation_email_count:
+@with_session_store
+def send_confirmation_email(session_store):
+    if not session_store.session_data.confirmation_email_count:
         raise NotFound
 
     try:
         confirmation_email = ConfirmationEmail()
     except ConfirmationEmailLimitReached:
-        return redirect(url_for("post_submission.get_thank_you"))
+        return redirect(url_for(".get_thank_you"))
 
     if request.method == "POST" and confirmation_email.form.validate():
-        confirmation_email.handle_post()
+        confirmation_email.handle_post(session_store)
         return redirect(
             url_for(
-                "post_submission.get_confirmation_email_sent",
+                ".get_confirmation_email_sent",
                 email=confirmation_email.get_url_safe_serialized_email(),
             )
         )
@@ -332,12 +347,21 @@ def send_confirmation_email():
 
 
 @post_submission_blueprint.route("confirmation-email/sent", methods=["GET"])
-def get_confirmation_email_sent():
-    if not get_session_store().session_data.confirmation_email_count:
+@with_session_store
+@with_schema
+def get_confirmation_email_sent(schema, session_store):
+    if not session_store.session_data.confirmation_email_count:
         raise NotFound
 
     email = URLParamSerializer().loads(request.args.get("email"))
 
+    show_feedback_call_to_action = True
+
+    try:
+        Feedback(schema, session_store, form_data=request.form)
+    except (FeedbackNotEnabled, FeedbackLimitReached):
+        show_feedback_call_to_action = False
+
     return render_template(
         template="confirmation-email-sent",
         content={
@@ -348,35 +372,35 @@ def get_confirmation_email_sent():
             "hide_signout_button": False,
             "show_send_another_email_guidance": not ConfirmationEmail.is_limit_reached(),
             "sign_out_url": url_for("session.get_sign_out"),
+            "show_feedback_call_to_action": show_feedback_call_to_action,
         },
     )
 
 
 @post_submission_blueprint.route("feedback/send", methods=["GET", "POST"])
+@with_session_store
 @with_schema
-def send_feedback(schema):
+def send_feedback(schema, session_store):
     try:
-        feedback = Feedback(schema, form_data=request.form)
+        feedback = Feedback(schema, session_store, form_data=request.form)
     except FeedbackNotEnabled:
         raise NotFound
-    except FeedbackAlreadySent:
-        return redirect(url_for("post_submission.get_feedback_sent"))
 
     if request.method == "POST" and feedback.form.validate():
         feedback.handle_post()
-        return redirect(url_for("post_submission.get_feedback_sent"))
+        return redirect(url_for(".get_feedback_sent"))
 
     return render_template(
         template="feedback",
         content=feedback.get_context(),
-        previous_location_url=url_for("post_submission.get_thank_you"),
         page_title=feedback.get_page_title(),
     )
 
 
 @post_submission_blueprint.route("feedback/sent", methods=["GET"])
-def get_feedback_sent():
-    if not get_session_store().session_data.feedback_sent:
+@with_session_store
+def get_feedback_sent(session_store):
+    if not session_store.session_data.feedback_count:
         raise NotFound
 
     return render_template(

app/settings.py

@@ -53,6 +53,7 @@ def get_env_or_fail(key):
 EQ_PUBLISHER_BACKEND = os.getenv("EQ_PUBLISHER_BACKEND")
 EQ_FULFILMENT_TOPIC_ID = os.getenv("EQ_FULFILMENT_TOPIC_ID", "eq-fulfilment-topic")
 EQ_INDIVIDUAL_RESPONSE_LIMIT = int(os.getenv("EQ_INDIVIDUAL_RESPONSE_LIMIT", "1"))
+EQ_FEEDBACK_LIMIT = int(os.getenv("EQ_INDIVIDUAL_RESPONSE_LIMIT", "10"))
 
 EQ_SUBMISSION_BACKEND = os.getenv("EQ_SUBMISSION_BACKEND")
 EQ_GCS_SUBMISSION_BUCKET_ID = os.getenv("EQ_GCS_SUBMISSION_BUCKET_ID")