feat(ras): skip campaign setup

[jaredrethman]

All Submissions:

• Have you followed the Newspack Contributing guideline?
• Does your code follow the WordPress' coding standards and VIP Go coding standards?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Ability to allow editors to skip "Reader Activation Campaign" setup.

How to test the changes in this Pull Request:

1. Checkout this branch and build assets i.e. git checkout origin/feat/skip-ras-campaign-setup && npm run build
2. Ensure you've completed the first 5 Reader Activation settings, example below:
   
3. Expand "Reader Activation Campaign" and click "Update Reader Activation campaign" or navigate to - /wp-admin/admin.php?page=newspack-engagement-wizard#/reader-activation/campaign.
4. Click (newly added) "Skip" button, at the bottom-right of the screen. Confirm prompt.
5. Observe once response is received from server the "Continue" button is enabled.
6. Navigate back to Newspack / Engagement or /wp-admin/admin.php?page=newspack-engagement-wizard#/reader-activation and confirm "Reader Activation Campaign" has status "Ready (Skipped)"
   

Other information:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes, as applicable?
• Have you successfully ran tests with your changes locally?

[dkoo]

@jaredrethman Thanks for diving into this without much context! The UI work is pretty much exactly what's needed aside from a minor suggestion below. However, we're missing two other requirements to truly skip the campaign setup:

1. If skipping the Campaign step, we should not execute this call to Reader_Activation::activate(). This method is what actually generates the campaign prompts + segments, so to truly skip we shouldn't generate those at all. I suppose we could just set $response to true in this case.
2. A more minor detail: if skipping, we should probably remove this step from the progress animation that shows when you click "activate" on the last step. If skipping campaign setup, we shouldn't be creating segments, so showing this step doesn't make sense.

The end result after skipping is that all prerequisites in the Reader Activation screen should be complete (as you've implemented already), but when visiting Newspack > Campaigns there shouldn't be anything here. Sorry if the business requirement wasn't clear—this feature is meant to support publishers who don't want to use the defaults at all.

[dkoo]

After this could we automatically transition to the next view? I clicked the "Skip" button and didn't realize I still had to click "Continue" to proceed.

[jaredrethman]

@dkoo appreciate the review and feedback, but especially sharing insight into desired outcome. Some responses:

If skipping the Campaign step, we should not execute this call to Reader_Activation::activate(). This method is what actually generates the campaign prompts + segments, so to truly skip we shouldn't generate those at all. I suppose we could just set $response to true in this case.

newspack-plugin/includes/wizards/class-engagement-wizard.php

Lines 285 to 298 in 3110cb5

	public function api_activate_reader_activation( WP_REST_Request $request ) {
	$skip_activation = $request->get_param( 'skip_activation' ) ?? false;
	$response = $skip_activation ? true : Reader_Activation::activate();
	if ( \is_wp_error( $response ) ) {
	return new \WP_REST_Response( [ 'message' => $response->get_error_message() ], 400 );
	}
	if ( true === $response ) {
	Reader_Activation::update_setting( 'enabled', true );
	}
	return rest_ensure_response( $response );
	}

A more minor detail: if skipping, we should probably remove this step from the progress animation that shows when you click "activate" on the last step. If skipping campaign setup, we shouldn't be creating segments, so showing this step doesn't make sense.

newspack-plugin/assets/wizards/engagement/views/reader-activation/complete.js

Lines 68 to 70 in 3110cb5

	if ( isSkippedCampaignSetup && activationSteps.length !== activationStepsCount - 1 ) {
	activationSteps.shift();
	}

but when visiting Newspack > Campaigns there shouldn't be anything here.

I've tested with latest and no Segments + Campaigns were created.

After this could we automatically transition to the next view? I clicked the "Skip" button and didn't realize I still had to click "Continue" to proceed.

Done 👍

Let me know if I missed anything and thanks again 😄

[dkoo]

@jaredrethman this is working really well now! Sorry about this, but I forgot about one other thing that doesn't make sense if you're skipping the campaign setup. In the /complete view there's a list of "what happens next" before you click the "Enable Reader Activation" button:

If you've skipped the campaign setup, could we add [skipped] to the steps that won't happen? Something like this:

[jaredrethman]

@jaredrethman this is working really well now! Sorry about this, but I forgot about one other thing that doesn't make sense if you're skipping the campaign setup. In the /complete view there's a list of "what happens next" before you click the "Enable Reader Activation" button:

Have updated with your feedback. Should now see the below, after your pull latest code with commit:feat: pr feedback, appended [skipped] to select items

Let me know if there's anything else, thanks for such a thorough review!

[dkoo]

Thanks for the changes, @jaredrethman!

[jaredrethman]

@dkoo just double checking the status here. Can this be merged (into trunk)?

[dkoo]

Yes, it can be merged! Sorry I wasn't clear. Approval = good to merge

[dkoo]

And when merging, please squash

[adekbadek]

@jaredrethman – also when squashing, ensure the commit message follows the <type>(<domain>): <message> pattern – in this case: feat(reader-activation): allow skipping campaigns setup.

[dkoo]

Went ahead and merged so it makes it into the next release cycle!

[matticbot]

🎉 This PR is included in version 4.0.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[matticbot]

🎉 This PR is included in version 4.0.0-epic-ras-acc.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[matticbot]

🎉 This PR is included in version 4.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀