Backport to Quince: survey report changes #34044

luisfelipec95 · 2024-01-12T03:48:34Z

Description

This is a backport to Quince.

feat: added banner message for survey report #33633 (This PR adds a custom banner message to the admin site. Right now the message only appears if a survey report hasn't been generated in 6 months but this threshold is configurable . Also this PR will send the report when it's generated as well.)
docs: add more details to the survey report README #33623 (This PR only adds extra information to the Survey Report Django App in the README.)
refactor: allow editing of ANONYMOUS_SURVEY_REPORT from env tokens #33954 (This PR adds the code that allows editing the value of the setting ANONYMOUS_SURVEY_REPORT from ENV_TOKENS.)
refactor: changed survey report message location and added a new info… #34033 (This PR introduces a refactor of the Survey Report management in the Django admin site. The changes include two key modifications aimed at enhancing the clarity and functionality of the admin interface.)
feat: added setting to disable the survey report banner entirely #34092 (This PR adds a new setting ENABLE_SURVEY_REPORT which determines if the Survey Report Banner should appear or disable it entirely in the django admin.)
refactor: change survey report message location #34126 (This PR introduces a refactor of the Survey Report management in the Django admin site.)
feat: add state sent to state column #34127 (Adding a New State "Sent" to Reports)
feat: add dismiss button to survey report banner #34160 (This PR introduces a dismiss button to hide the survey report banner and a thank-you message to users upon report submission.)

openedx-webhooks · 2024-01-12T03:48:39Z

Thanks for the pull request, @luisfelipec95!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

MaferMazu · 2024-01-16T21:37:43Z

@luisfelipec95, the #34033 was merged; you can cherry-pick it.

mariajgrimaldi · 2024-01-22T13:54:23Z

I'll be reviewing this as part of the BTR anytime soon. Thanks!

georgebabey · 2024-01-22T14:17:54Z

openedx/features/survey_report/context_processors.py

+    The current treshhold to show the banner is one month but this can be redefined in the future
+
+    """
+    months = settings.SURVEY_REPORT_CHECK_THRESHOLD


I'd like to request the ability to turn this banner off entirely. Some organizations/operators may not feel comfortable sharing this data back and there doesn't currently seem to be any ability to disable it entirely. Please correct me if I'm wrong.

From what I gather we can set the SURVEY_REPORT_ENDPOINT to a bogus endpoint but the banner will still appear. We could set the SURVEY_REPORT_CHECK_THRESHOLD to a very large number, but the banner will still appear until one report is sent. There seems to be no way to disable this entirely

Hello @georgebabey, you are right, completely disabling is not present at the moment. It was in the first draft and with the many reviews it was sidetracked. Still it is a completely reasonable request. We'll include that in master and add it to the backport.

mariajgrimaldi · 2024-02-05T14:09:24Z

Hi there! Please let me know when this is ready for review. Thanks!

* feat: added banner message for survey report * refactor: addressed PR feedback and changes * fix: fixed styles on admin templates * refactor: changed script location to survey report block * chore: removed whitespaces and renamed the context processor files * feat: added banner message for survey report * refactor: separated survey report template from admin and deleted base template * refactor: changed months variable into a configurable setting --------- Co-authored-by: Maria Fernanda Magallanes Zubillaga <[email protected]> Co-authored-by: María Fernanda Magallanes <[email protected]>

* docs: add more details to the survey report README * docs: improve the doc with numbered steps, bold and capitalize words * docs: add more information about the survey report banner

…nedx#33954)

…nedx#34092) * feat: added setting to disable the survey report banner entirely * fix: fixed unit test with new setting * refactor: changed conditions for better code readability * feat: added exception to stop the report from generating if the setting is set to false * chore: updated the readme file to include the new setting * refactor: move survey settings to common and disable admin by setting * docs: typos in README Co-authored-by: Tim McCormack <[email protected]> * refactor: set default values to survey report settings * refactor: rename ENABLE_SURVEY_REPORT setting to SURVEY_REPORT_ENABLE * test: fix quality tests --------- Co-authored-by: Alejandro Cardenas <[email protected]> Co-authored-by: Tim McCormack <[email protected]>

* refactor: change survey report message location

* feat: add dismiss button to survey report banner * refactor: move banner script to js file * fix: remove not in conditional

Alec4r · 2024-03-06T13:58:24Z

Hi there! Please let me know when this is ready for review. Thanks!

This is already for review @mariajgrimaldi

mariajgrimaldi · 2024-07-22T15:03:37Z

We usually try not to backport features in case is absolutely necessary. @Alec4r @luisfelipec95, is this still needed since it was already included in Redwood? if not, can we close this PR? Thanks!

mphilbrick211 · 2024-08-23T20:37:49Z

We usually try not to backport features in case is absolutely necessary. @Alec4r @luisfelipec95, is this still needed since it was already included in Redwood? if not, can we close this PR? Thanks!

Friendly ping on this @Alec4r @luisfelipec95!

Alec4r · 2024-08-24T00:03:17Z

@mariajgrimaldi @mphilbrick211 Thank you for following up on this! Since the changes have already been included in Redwood, we no longer need this backport. You can go ahead and close the PR.

Thanks again for your support!

openedx-webhooks · 2024-08-26T15:58:55Z

@luisfelipec95 Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 12, 2024

mphilbrick211 added backport PR backports a change from main to a named release. needs test run Author's first PR to this repository, awaiting test authorization from Axim labels Jan 12, 2024

mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jan 19, 2024

mariajgrimaldi self-requested a review January 22, 2024 13:54

georgebabey requested changes Jan 22, 2024

View reviewed changes

mariajgrimaldi self-assigned this Feb 20, 2024

mphilbrick211 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Feb 21, 2024

Asespinel and others added 7 commits February 29, 2024 09:22

docs: add more details to the survey report README (openedx#33623)

6baef6a

* docs: add more details to the survey report README * docs: improve the doc with numbered steps, bold and capitalize words * docs: add more information about the survey report banner

refactor: allow editing of ANONYMOUS_SURVEY_REPORT by env tokens (ope…

440b0b2

…nedx#33954)

refactor: change survey report message location (openedx#34126)

cd0515b

* refactor: change survey report message location

feat: add state sent to state column (openedx#34127)

69e8bb1

feat: add dismiss button to survey report banner (openedx#34160)

da74d0b

* feat: add dismiss button to survey report banner * refactor: move banner script to js file * fix: remove not in conditional

Alec4r force-pushed the lfc/backport-survey-report-message branch from 08dee01 to da74d0b Compare February 29, 2024 14:55

jalondonot requested a review from felipemontoya March 3, 2024 01:29

jalondonot requested a review from georgebabey March 13, 2024 01:21

mphilbrick211 removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Jul 30, 2024

mariajgrimaldi closed this Aug 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Backport to Quince: survey report changes #34044

Backport to Quince: survey report changes #34044

luisfelipec95 commented Jan 12, 2024 •

edited

Loading

openedx-webhooks commented Jan 12, 2024 •

edited

Loading

MaferMazu commented Jan 16, 2024

mariajgrimaldi commented Jan 22, 2024

georgebabey Jan 22, 2024 •

edited

Loading

felipemontoya Jan 22, 2024

mariajgrimaldi commented Feb 5, 2024

Alec4r commented Mar 6, 2024

mariajgrimaldi commented Jul 22, 2024 •

edited

Loading

mphilbrick211 commented Aug 23, 2024

Alec4r commented Aug 24, 2024

openedx-webhooks commented Aug 26, 2024

Backport to Quince: survey report changes #34044

Backport to Quince: survey report changes #34044

Conversation

luisfelipec95 commented Jan 12, 2024 • edited Loading

Description

openedx-webhooks commented Jan 12, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

MaferMazu commented Jan 16, 2024

mariajgrimaldi commented Jan 22, 2024

georgebabey Jan 22, 2024 • edited Loading

Choose a reason for hiding this comment

felipemontoya Jan 22, 2024

Choose a reason for hiding this comment

mariajgrimaldi commented Feb 5, 2024

Alec4r commented Mar 6, 2024

mariajgrimaldi commented Jul 22, 2024 • edited Loading

mphilbrick211 commented Aug 23, 2024

Alec4r commented Aug 24, 2024

openedx-webhooks commented Aug 26, 2024

luisfelipec95 commented Jan 12, 2024 •

edited

Loading

openedx-webhooks commented Jan 12, 2024 •

edited

Loading

georgebabey Jan 22, 2024 •

edited

Loading

mariajgrimaldi commented Jul 22, 2024 •

edited

Loading