feat: enable public newsletter posts #272

dkoo · 2020-07-20T23:27:37Z

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:

Allows editors to mark sent/published newsletters as publicly viewable and creates an archive page for newsletter posts. If a published newsletter is publicly viewable, its single page is visible to all users. If not, it's visible as a preview only to logged-in WP admin users (drafts are also visible to logged-in admin users). Also hijacks the main query on the Newsletter archive pages and filters out any posts that are NOT marked as publicly viewable.

Further work required?

~~Posts Inserter block isn't rendering anything on the front-end—need to fix that before we merge~~ fixed in 91b596c
Currently, newsletter ads are not rendered in the page view. I'm not sure this is necessary, but feel free to change my mind.
There might be some further design/front-end work needed on the theme side if we want the archive and single templates for newsletter posts to differ from regular articles (there is probably no need for a byline, or the sidebar widgets, for example). (cc @thomasguillot and/or @laurelfulford)
Maybe disable some interactions with other plugins—e.g. Jetpack Related Posts (this example done in this PR)

Closes #171.
Closes #214.

How to test the changes in this Pull Request:

Check out/build this branch, and flush permalinks. Go to Newsletters > All Newsletters in WP admin.
For any newsletters that have been sent, observe a new "Preview" link when hovering over the item in the post list:

Click the Preview link. Observe that the newsletter is viewable as a single post page while logged into WP admin.

Open a new Incognito window and attempt to visit the same newsletter post. Observe that the page is a 404 while not logged in.

Go to https://[YOUR SITE URL]/newsletter/ to view the newsletter archive page. Right now it should be empty while both logged in and not logged in (only posts explicitly marked as publicly viewable should appear on the archive page).
Edit the newsletter post. Observe a new toggle option in the Document settings sidebar, disabled by default:

Enable the setting. Observe that the previously disabled "Sent" button is now enabled and says "Update." Click "Update" to save the new setting.
Go back to the "All Newsletters" post list. Hover over the post and observe that there's now a "View" link instead of "Preview." Also observe that the "Sent" notice should now have an additional "Published as a page" note attached.

Refresh the archive page—now observe that your public post is listed while both logged in and not logged in.
Visit the newsletter post's single page. Observe that the public post is now visible while both logged in and not logged in.
Set up at least one campaign in the Newspack Campaigns plugin (can be either overlay or inline). Observe that the campaign will never render in the newsletter post's single page under any circumstances.
Edit the newsletter post again and disable the "Make newsletter page public?" setting, then save. Observe that the page is no longer visible in the archive or as a single page to non-logged-in users.
As a sanity check, create a new newsletter but DON'T send it. DO enable the "Make newsletter page public?" setting.

Observe that the "Send" button says "Send and Publish" when the setting is enabled.
Click "Save Draft," then confirm that the draft is visible to logged-in users only.

As another sanity check, ensure that sending newsletters with both Mailchimp and Constant Contact still works as before.

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?

Adds a meta option to newsletter posts that allows specific newsletters to be publicly viewable on the site front-end. Currently uses the standard post template.

Enables archive apges for Newsletter CPT, but only display posts that are marked as publicly viewable.

Uses the 'newspack_newsletters_assess_has_disabled_popups' filter provided by the Campaigns plugin.

Previously, if a non-logged-in user tried to view a non-public newsletter post, the page would display as a 404 but the document title would still match the post title. This fixes that.

Moves the title filter above the template set, otherwise it won't work.

…etters into add/allow-public-newsletter-posts

Adds a check for publish status in the Constant Contact class before sending the newsletter, to match Mailchimp (so that we don't try to send a newsletter again if it's been published already and we're just updating the post). Also restores an error message in the Mailchimp class that got lost.

dkoo · 2020-08-12T17:44:30Z

@adekbadek I just realized that the Post Inserter block isn't rendering anything on the front-end. Before I go down the rabbit hole of trying to make it work, is there something off the top of your head we can change to fix this?

adekbadek · 2020-08-13T10:55:57Z

I just realized that the Post Inserter block isn't rendering anything on the front-end. Before I go down the rabbit hole of trying to make it work, is there something off the top of your head we can change to fix this?

@dkoo, it can be rendered as in the email renderer. The block saves resulting markup in a innerBlocksToInsert attribute. Other solution would be to duplicate the block rendering logic in PHP, as most blocks out there do.

…etters into add/allow-public-newsletter-posts

Adds a server-side render callback for the Posts Inserter so that it can show content on the front-end. Also updates the checkbox for the "disable ads" attribute to be a ToggleControl, to match the other toggleable UI elements from the plugin.

dkoo · 2020-08-13T21:07:49Z

@dkoo, it can be rendered as in the email renderer. The block saves resulting markup in a innerBlocksToInsert attribute. Other solution would be to duplicate the block rendering logic in PHP, as most blocks out there do.

Thanks for the hint! I ended up using that attribute to just render the inner blocks via server-side callback. Added in 91b596c.

- use lockPostAutosaving instead of dequeueing autosave script to disable autosave - change language of "published as a page" to "published as a post"

dkoo · 2020-08-14T18:15:54Z

The post publish button is set to "Update" after being briefly set to "Send". On master, this button is set to "Send" and stays that way. It's content does not change after marking the Newsletter as public in the sidebar.

Addressed this in c15f2e6. The problem was that I was relying on WP core's isEditedPostDirty selector, which supposedly checks whether the editor is in a dirty state. But because we're setting some meta based on async ops from the service providers, isEditedPostDirty always returns true. Now, I only check whether the is_public meta value has changed from the post's saved state before changing the button state.

This means that if you edit other post attributes or post content, the "Update" button won't be enabled, but it's still possible to make those edits, change the "public" setting, and then save all changes. Kind of an edge case since I don't see much of a use case for editing newsletter content after it has been sent, but I could also add a comparison of post content vs. edited post content if you think that's warranted.

adekbadek · 2020-08-17T10:25:12Z

This means that if you edit other post attributes or post content [of a sent newsletter], the "Update" button won't be enabled […] Kind of an edge case

I agree it's an edge case, I'm fine with it staying that way

thomasguillot

It works fairly well but I noticed a bug when I change the public status of a newsletter where the newsletter single view is still available even when setting has been changed to don't publish.

dkoo · 2020-08-17T15:29:57Z

I noticed a bug when I change the public status of a newsletter where the newsletter single view is still available even when setting has been changed to don't publish.

@thomasguillot, are you logged in as an admin user? If that's the case then newsletter posts will always be visible as a preview. Try viewing the same post in a new incognito window and see if the page still renders?

Adds a checkbox option that lets editors decide whether Jetpack Related Posts should be enabled on single newsletter posts. Only shown if Related Posts module is active.

thomasguillot · 2020-08-17T15:46:46Z

I noticed a bug when I change the public status of a newsletter where the newsletter single view is still available even when setting has been changed to don't publish.

@thomasguillot, are you logged in as an admin user? If that's the case then newsletter posts will always be visible as a preview. Try viewing the same post in a new incognito window and see if the page still renders?

Oh ok yeah it work as expected then. But why will it always be visible as a preview if I specifically un-toggled the option?

dkoo · 2020-08-17T15:49:55Z

But why will it always be visible as a preview if I specifically un-toggled the option?

It's the only way I could think of that would allow editors to preview a single newsletter post without making it public. It more or less works the same way as a draft post, but since the newsletter is already "published" (a.k.a. sent) regardless of whether the post is marked as public, we can't use the WP publish status in the same way as we would use it in a regular post.

thomasguillot

Thanks @dkoo -- makes sense 😊

# [1.9.0-alpha.1](v1.8.1...v1.9.0-alpha.1) (2020-08-20) ### Bug Fixes * button custom colors ([#301](#301)) ([8ebcf5d](8ebcf5d)) * first time set up flow ([c16d6bf](c16d6bf)) * pre-send info if no list set ([#297](#297)) ([f575d94](f575d94)) ### Features * enable public newsletter posts ([#272](#272)) ([ef90bf9](ef90bf9))

matticbot · 2020-08-20T16:45:28Z

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

The release is available on GitHub release

Your semantic-release bot 📦🚀

# [1.9.0](v1.8.1...v1.9.0) (2020-08-20) ### Bug Fixes * button custom colors ([#301](#301)) ([8ebcf5d](8ebcf5d)) * first time set up flow ([c16d6bf](c16d6bf)) * pre-send info if no list set ([#297](#297)) ([f575d94](f575d94)) ### Features * enable public newsletter posts ([#272](#272)) ([ef90bf9](ef90bf9))

matticbot · 2020-08-20T17:16:29Z

🎉 This PR is included in version 1.9.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

dkoo added 3 commits July 20, 2020 17:20

feat: enable public newsletter rewrites

8bd193f

Adds a meta option to newsletter posts that allows specific newsletters to be publicly viewable on the site front-end. Currently uses the standard post template.

feat: editor sidebar UI for toggling public meta option

af8c5c5

fix: better hook for disabling autosave on published newsletters

7952fbd

dkoo mentioned this pull request Jul 20, 2020

Convert Newsletter To Post #171

Closed

dkoo added 5 commits July 20, 2020 17:28

fix: remove unnecessary args for admin_enqueue_scripts hook

d37761f

Merge branch 'master' into add/allow-public-newsletter-posts

bd7477f

fix: fatal from using transition_post_status instead of publish hook

78ab685

feat: enable archive pages for newsletters with public posts only

af3dc0c

Enables archive apges for Newsletter CPT, but only display posts that are marked as publicly viewable.

feat: disable Newspack Campaigns on Newsletter CPTs

5acafbe

Uses the 'newspack_newsletters_assess_has_disabled_popups' filter provided by the Campaigns plugin.

dkoo requested review from adekbadek and jeffersonrabb and removed request for adekbadek August 12, 2020 16:13

dkoo added 3 commits August 12, 2020 10:51

feat: set page title to "Page not found" for non-public newsletters

7abc67d

Previously, if a non-logged-in user tried to view a non-public newsletter post, the page would display as a 404 but the document title would still match the post title. This fixes that.

fix: move wpseo_title filter

ab78785

Moves the title filter above the template set, otherwise it won't work.

Merge branch 'master' of https://github.com/Automattic/newspack-newsl…

367b9fd

…etters into add/allow-public-newsletter-posts

dkoo marked this pull request as ready for review August 12, 2020 16:59

dkoo added the [Status] Needs Review label Aug 12, 2020

dkoo changed the title ~~Allow public newsletter posts~~ feat: enable public newsletter posts Aug 12, 2020

dkoo added 2 commits August 12, 2020 11:30

feat: disable Jetpack Related Posts module on newsletter posts

ce05d0c

dkoo changed the title ~~feat: enable public newsletter posts~~ [WIP] feat: enable public newsletter posts Aug 12, 2020

dkoo added 2 commits August 13, 2020 12:23

Merge branch 'master' of https://github.com/Automattic/newspack-newsl…

96c89ea

…etters into add/allow-public-newsletter-posts

dkoo changed the title ~~[WIP] feat: enable public newsletter posts~~ feat: enable public newsletter posts Aug 13, 2020

dkoo added [Status] Needs Review and removed [Status] Needs Review labels Aug 13, 2020

adekbadek added [Status] Needs Changes or Feedback and removed [Status] Needs Review labels Aug 14, 2020

dkoo added 2 commits August 14, 2020 10:25

fix: feedback from PR

6815be4

- use lockPostAutosaving instead of dequeueing autosave script to disable autosave - change language of "published as a page" to "published as a post"

fix: send button behavior after newsletter has been sent

c15f2e6

dkoo requested a review from adekbadek August 14, 2020 18:16

adekbadek approved these changes Aug 17, 2020

View reviewed changes

github-actions bot added the [Status] Approved Ready to merge label Aug 17, 2020

thomasguillot requested changes Aug 17, 2020

View reviewed changes

thomasguillot removed [Status] Approved Ready to merge [Status] Needs Design Review labels Aug 17, 2020

feat: add settings option to enable/disable Jetpack Related Posts

cbaa4d3

Adds a checkbox option that lets editors decide whether Jetpack Related Posts should be enabled on single newsletter posts. Only shown if Related Posts module is active.

dkoo requested review from thomasguillot and adekbadek August 17, 2020 15:50

thomasguillot approved these changes Aug 17, 2020

View reviewed changes

thomasguillot added [Status] Approved Ready to merge and removed [Status] Needs Changes or Feedback labels Aug 17, 2020

dkoo merged commit ef90bf9 into master Aug 18, 2020

dkoo deleted the add/allow-public-newsletter-posts branch August 18, 2020 15:26

matticbot added the released on @alpha label Aug 20, 2020

matticbot added the released label Aug 20, 2020

adekbadek mentioned this pull request Oct 28, 2021

fix: enable prompts on public newsletters #606

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enable public newsletter posts #272

feat: enable public newsletter posts #272

dkoo commented Jul 20, 2020 •

edited

Loading

dkoo commented Aug 12, 2020

adekbadek commented Aug 13, 2020 •

edited

Loading

dkoo commented Aug 13, 2020

dkoo commented Aug 14, 2020

adekbadek commented Aug 17, 2020

thomasguillot left a comment

dkoo commented Aug 17, 2020

thomasguillot commented Aug 17, 2020

dkoo commented Aug 17, 2020

thomasguillot left a comment

matticbot commented Aug 20, 2020

matticbot commented Aug 20, 2020

feat: enable public newsletter posts #272

feat: enable public newsletter posts #272

Conversation

dkoo commented Jul 20, 2020 • edited Loading

All Submissions:

Changes proposed in this Pull Request:

Further work required?

How to test the changes in this Pull Request:

Other information:

dkoo commented Aug 12, 2020

adekbadek commented Aug 13, 2020 • edited Loading

dkoo commented Aug 13, 2020

dkoo commented Aug 14, 2020

adekbadek commented Aug 17, 2020

thomasguillot left a comment

Choose a reason for hiding this comment

dkoo commented Aug 17, 2020

thomasguillot commented Aug 17, 2020

dkoo commented Aug 17, 2020

thomasguillot left a comment

Choose a reason for hiding this comment

matticbot commented Aug 20, 2020

matticbot commented Aug 20, 2020

dkoo commented Jul 20, 2020 •

edited

Loading

adekbadek commented Aug 13, 2020 •

edited

Loading