Add organizer debrief survey #1038

renintw · 2023-09-13T09:43:38Z

Closes #930

This PR implements what has been concluded in the ticket. The logic refers to #997.

Flow

Manually published Organizer Survey (event debrief) in Central.
When the plugin is activated:
- Create a tix_email in draft status.
  - The email will contain a token generated by hashing the access token key and WordCamp ID, to prevent the survey page from being accessed and abused by individuals other than the lead organizers.
- Schedule a daily cron job.
When the cron job runs:
- Check if we already sent an email for this camp.
- Check to make sure the camp ended exactly 2 days ago.
- Add the lead organizer as an attendee and associate it with tix_email.
- Add tix_email to the queue (set to pending)
  - email gets picked up by camptix cron email sending queue tix_scheduled_every_ten_minutes

Screenshots

View	Screenshot
Email queue
Manually published Organizer Survey (event debrief) page in central
Draft Survey Email
Survey Email Sent
Survey

How to test

Create a Next-Gen Event WordCamp site and fill in Organizer Name and Email Address inside the Organizing Team.
- Make the Start Date in the past.
- Make the End Date the current date.
Visit Cenral
- Go to Pages
  - Manually publish Organizer Survey (event debrief)
  - View the content, which should be the same as the description in ticket.
Visit Next-Gen
- Go to Ticket -> E-Mail
  - Expect to see an email Organizer Survey (event debrief) in Draft mode.
  - The email content is pending an update from the Tardis Team.
- Run the following wp cli script to make sure the cron jobs are scheduled
  - wp cron event list --url=https://events.wordpress.test/{city}/{year}/{type}
  - expect to see the following cron job: wc_organizer_debrief_survey_email
- Go back to the Next-Gen Wordcamp Post type and update the End Date to exact 2 days ago.
- Run this script to set WordCamp to closed wp post update {post_id} --post_status=wcpt-closed --url=https://central.wordcamp.test/
- Run the following cli command:
  - run wp cron event run wc_organizer_debrief_survey_email --url=https://events.wordpress.test/{city}/{year}/{type}
    - Should succeed
    - Status of Organizer Survey (event debrief) in Ticket -> E-Mail should be pending.
    - An attendee should be added in Ticket -> Attendees with tix_first_name and tix_email the same as the one you input when creating the event.
  - run wp cron event run tix_scheduled_every_ten_minutes -url=https://events.wordpress.test/{city}/{year}/{type}
    - Organizer Survey (event debrief) in Ticket -> E-Mail should be published.
    - In, http://localhost:1080/, there should be an email with Subject Organizer Survey (event debrief).
      - Visit the survey link on the front end and submit.
Make sure none of this exists on the traditional WordCamp.

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/admin-page.php

renintw · 2023-09-17T19:35:15Z

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/debrief-survey/cron.php

+function add_temp_attendee() {
+	if ( ! get_wordcamp_attendees_id() ) {
+		$attendees_id = wp_insert_post( array(
+			'post_title' => 'Organizer debrief survey',


The title is (no title) even though the post_title is specified and updated to DB. And after moving it to the Trash, the Title appears. I'm not entirely sure why this happens, but it doesn't affect the overall process.

iandunn

I left a few suggestions but this looks good overall

public_html/wp-content/plugins/wordcamp-organizer-survey/wordcamp-organizer-survey.php

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/admin-page.php

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/debrief-survey/page.php

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/debrief-survey/cron.php

iandunn · 2023-09-19T00:30:20Z

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/debrief-survey/page.php

+
+	<!-- wp:jetpack/contact-form {"subject":"New feedback received from your website","style":{"spacing":{"padding":{"top":"16px","right":"16px","bottom":"16px","left":"16px"}}}} -->
+	<div class="wp-block-jetpack-contact-form" style="padding-top:16px;padding-right:16px;padding-bottom:16px;padding-left:16px"><!-- wp:group {"layout":{"type":"constrained"}} -->
+	<div class="wp-block-group"><!-- wp:jetpack/field-text {"label":"What event did you organize?","required":true,"requiredText":"(required)"} /--></div>


We shouldn't need to ask this, since we already know it based on the current site, who the email is sent to, etc. We can remove the question, but have some code that automatically adds it to the response before it's saved in the database.

It seems there's no proper filter or approach to add the predefined data before inserting the response to Feedback for Jetpack contact form. What's the common way to do so?

Also tried grunion_pre_message_sent and wp_insert_post_data, but I feel they aren't the best solution here.

Maybe using JavaScript to set the default values? I feel like there's a more elegant way to do so.

Known data was added in ad40047

Yeah, I wish there were more filters there 😦

It seems like it might work to hook into template_redirect at priority 5, since process_form_submission() runs at priority 10. Then you might be able to modify $_POST directly.

iandunn · 2023-09-19T00:31:51Z

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/debrief-survey/page.php

+	<!-- /wp:heading -->
+
+	<!-- wp:group {"layout":{"type":"constrained"}} -->
+	<div class="wp-block-group"><!-- wp:jetpack/field-text {"label":"How many tickets were sold?","required":true,"requiredText":"(required)"} /--></div>


This can also be pulled from existing data. There may be other questions that can also be removed for that reason.

In this PR, I've pre-populated the value for the question "What event did you organize?". The data sources for the other questions are different and might need to look for proper functions to retrieve the existing data. I'll handle that in a separate PR.

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/debrief-survey/cron.php

The Organizer Reminders only works on central. It would get too complicated and introduce a few glitches if trying to use it through event site. The extra work doesn't worth the effort at the moment.

The Jetpack contact form fails to submit when there's a query string present.The Jetpack contact form's source code has been traced and no usable hooks found. Although the query string can be removed via JavaScript, the form still can't be submitted successfully. Therefore, it's temporarily disabled.

iandunn

I left some questions/suggestions, but nothing that blocks merging 👍🏻

.docker/wp-config.php

public_html/wp-content/mu-plugins/wcorg-network-plugin-control.php

public_html/wp-content/plugins/wordcamp-organizer-survey/wordcamp-organizer-survey.php

iandunn · 2023-09-25T17:42:48Z

public_html/wp-content/plugins/wordcamp-organizer-survey/wordcamp-organizer-survey.php

+		$labels = $dom->getElementsByTagName('label');
+		foreach ( $labels as $label ) {
+			// phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+			if ( 'What event did you organize?' === $label->nodeValue ) {


🤔 I suspect there may an easier way to do this. Do we need to show the question to the user if we're just going to fill it in anyway?

Another problem is that, If it's in the page, it could be edited by an admin who wouldn't realize that doing that would break this.

If we don't need to show the question, we could insert the value in $_POST some time before Grunion_Contact_Form_Plugin::process_form_submission() runs.

If you do want to show it, it might be possible to add an id/class value to the post content in the database, and then use that in this function. That'd still break if someone edited it, but they'd be less likely to.

iandunn · 2023-09-25T18:05:10Z

public_html/wp-content/plugins/wordcamp-organizer-survey/wordcamp-organizer-survey.php

+			if ( 'What event did you organize?' === $label->nodeValue ) {
+				$input_id         = $label->getAttribute('for');
+				$event_name_field = $dom->getElementById($input_id);
+				$event_name_field->setAttribute('value', $wordcamp_post_data->post_title);


I think it'd be best to save the ID rather than the title, since the title can change. It also won't have the year, unless passed through get_wordcamp_name(). That function might not work well for NextGen camps though, since some of them are monthly, etc.

If we don't remove the question from the user-facing form (see above), then it would be good to show the user the title, but we could still save the ID. Maybe just by modifying $_POST before the value gets saved. Or it could be in a separate field if that's easier.

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/debrief-survey/email.php

renintw self-assigned this Sep 13, 2023

renintw changed the title ~~Add/organizer debrief survey~~ Add organizer debrief survey Sep 13, 2023

renintw mentioned this pull request Sep 13, 2023

Add organizer debrief survey #1028

Closed

5 tasks

renintw force-pushed the add/organizer_debrief_survey branch 7 times, most recently from c4777f1 to 6d32335 Compare September 15, 2023 13:16

renintw commented Sep 15, 2023

View reviewed changes

public_html/wp-content/plugins/wordcamp-organizer-survey/includes/admin-page.php Outdated Show resolved Hide resolved

renintw requested review from StevenDufresne and iandunn September 17, 2023 19:26

renintw marked this pull request as ready for review September 17, 2023 19:27

renintw commented Sep 17, 2023

View reviewed changes

iandunn approved these changes Sep 19, 2023

View reviewed changes

renintw force-pushed the add/organizer_debrief_survey branch from e26379a to 5424875 Compare September 21, 2023 04:06

renintw added 13 commits September 24, 2023 23:17

Add plugin: WordCamp Organizer Survey.

c932b23

Add cron job basic framework.

a512af4

Add email basic framework.

b2d3183

Add central admin-page.

97c1f0a

Add debrief survey page.

37adb85

Integrate email with Plugin: WordCamp Organizer Reminders

a72b43e

Revert Integrating email with Organizer Reminders.

6be535e

The Organizer Reminders only works on central. It would get too complicated and introduce a few glitches if trying to use it through event site. The extra work doesn't worth the effort at the moment.

Update cron job.

63873cd

Tidy up file structure

00e13d1

Naming tidy up.

8b97ac6

Make plugin unable to be network deactivated.

39b397a

Only delete temp attendee when it's next-gen

138e183

Remove delete_option( 'rewrite_rules' );

3834cc0

renintw added 6 commits September 24, 2023 23:17

Set end_date as start_date for 1-day events.

8c05662

Fix tix_email_recipients_backup wrongly updated

8b83dce

Remove debrief page.

7354b3a

Remove Admin Page.

e8742fa

Embed a token in URL for verifying organizer.

00ff49f

Update email content

5ef71c2

renintw force-pushed the add/organizer_debrief_survey branch from ea44ddd to 5ef71c2 Compare September 24, 2023 18:58

renintw added 8 commits September 25, 2023 12:27

Format Cleanup

76ef0d6

Encrypt with wordcamp_id rather than email.

dc27e09

Fill in data that we already know.

ad40047

Fix linting error.

004fa0e

Fix email stats counting error.

0510637

Reveert: Disable validation and automatic filling out and fix the issue

25bc224

Text field can't be disabled or jetpack unable to get the data.

3b71104

iandunn approved these changes Sep 25, 2023

View reviewed changes

renintw added 8 commits September 26, 2023 11:33

Update ORGANIZER_SURVEY_ACCESS_TOKEN_KEY.

5c52648

Comment out network_plugin_state.

ee1825f

Using hash_equals() to avoid timing attacks.

fc01e42

Correctly rename get_verification_token.

f1f2dc2

Update to use sha256.

1cf1f3a

Remove base64 encoding and decoding.

4bf2585

Get top level domain with built-in function.

96e160f

Remove copy duplication.

f65da95

renintw merged commit 0f1c5fe into production Sep 26, 2023
3 checks passed

renintw deleted the add/organizer_debrief_survey branch September 26, 2023 13:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add organizer debrief survey #1038

Add organizer debrief survey #1038

renintw commented Sep 13, 2023 •

edited

renintw Sep 17, 2023

iandunn left a comment

iandunn Sep 19, 2023

renintw Sep 21, 2023 •

edited

renintw Sep 25, 2023

iandunn Sep 25, 2023

iandunn Sep 19, 2023

renintw Sep 25, 2023

iandunn left a comment

iandunn Sep 25, 2023

iandunn Sep 25, 2023

Add organizer debrief survey #1038

Add organizer debrief survey #1038

Conversation

renintw commented Sep 13, 2023 • edited

Screenshots

How to test

Choose a reason for hiding this comment

iandunn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

renintw Sep 21, 2023 • edited

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

iandunn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

renintw commented Sep 13, 2023 •

edited

renintw Sep 21, 2023 •

edited