Save meta on preview #11409

adamsilverstein · 2018-11-02T14:22:03Z

Description

When clicking the preview button, save all metaboxes. Set preview URL only after metabox save is complete.

How has this been tested?

Using the sample code from #11280 (comment) I added a meta box. I tested changing the metabox value and clicking preview before blurring out of the field or letting a regular autosave trigger. I observed the correct meta on the preview page, and meta was saved to the post (as expected).

Types of changes

when previewing, call requestMetaBoxUpdates if we have metaboxes
defer setting the preview url until both autosave and metabox saevs have completed

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
My code has proper inline documentation.

adamsilverstein · 2018-11-02T14:23:15Z

packages/editor/src/components/post-preview-button/index.js

-		// This relies on the window being responsible to unset itself when
-		// navigation occurs or a new preview window is opened, to avoid
-		// unintentional forceful redirects.
-		if ( previewLink && ! prevProps.previewLink ) {


uncertain about this change: despite the inline comment, I don't understand how prevProps.previewLink is used here and I have removed it. instead, I am testing that both autosave and metabox save have completed.

danielbachhuber

👍 Works as expected in my testing. I'll defer to @aduth for the underlying JavaScript.

danielbachhuber

Approved from a functional perspective, see above comment. Deferring to @aduth on the JavaScript itself.

aduth · 2018-11-02T14:51:17Z

To clarify, is a meta box update meant to occur in response to the interaction of the preview button press, or is it bound to the behavior of save/autosave?

This approach may be sensible for the former, but not the latter.

adamsilverstein · 2018-11-02T15:12:24Z

To clarify, is a meta box update meant to occur in response to the interaction of the preview button press, or is it bound to the behavior of save/autosave?

the former, this alters the behavior for the preview button only and reintroduces the current (unfortunate) core behavior of saving metabox meta to the original post for previews. (see https://core.trac.wordpress.org/ticket/20299 -we can resolve this when we introduce meta revisioning to core)

youknowriad · 2018-11-02T16:23:35Z

packages/editor/src/components/post-preview-button/index.js

+		const {
+			hasMetaBoxes,
+			isSavingMetaBoxes,
+		} = select( 'core/edit-post' );


The editor package shouldn't know anything about the metaboxes, I don't know what this PR is trying to do exactly but we should try to hook into the saving mechanism from the edit-post package instead.

I think you probably want to tweak this condition instead https://github.com/WordPress/gutenberg/blob/master/packages/edit-post/src/store/effects.js#L53

(Curious about the impact on revisions of all these save requests though)

I don't know what this PR is trying to do exactly

@youknowriad
This PR is attempting to save metaboxes when a preview is triggered. That is, when the preview button is clicked, we save meta before displaying the preview so updated meta values will be included.

I think you probably want to tweak this condition instead

Yes thanks for the suggestion... I looked at that originally without much luck because the previewing "condition" is not being tracked. It seemed more straightforward to add metabox saving as an effect of clicking the preview button only and code wise it is maybe simpler.

to move the logic into SET_META_BOXES_PER_LOCATIONS in effects, i think we need to track isPreviewing to know this is a preview autosave not a regular autosave - we don't want to save metabox meta for regular autosaves, only when the user clicks preview - does that sound right? or should i instead try to add a variable to the autosave call, eg autosave( true ) would be a preview autosave?.

(Curious about the impact on revisions of all these save requests though)

no revisions are stored for meta currently in core - the meta is saved directly to the post (unfortunately). only one autosave revision is saved per post (per user).

Why the preview autosave is not just a regular autosave? Is there anything different in the backend or is this the actual different, the need to not trigger ant autosave but an actual save including metaboxes?

Could we just trigger a regular save (instead of autosave) when previewing drafts?

What should happen if we preview a published post and preview is clicked, should we save the metaboxes too? it seems like an unwanted changed could be published inadvertently?

If it's only for drafts, then I'd be fine adding a flag tracking that we're previwing.

Why the preview autosave is not just a regular autosave?

to match core behavior:

regular autosaves do not include saving post meta - they only save the title, excerpt and content. previews also save all meta so that previews can include changes made in meta fields which may affect how the post displays. This fixes the issue raised in #11280. it also re-introduces the issue raised in https://core.trac.wordpress.org/ticket/20299.

I would love to work on a more complete solution - - perhaps as part of phase 2 - that would add meta revisioning to the autosave, so meta values would be associated with the autosave instead of the parent post, which would fix the unwanted saving of meta values to published posts when previewing. The code to achieve this is already available in a patch on the ticket and relies on my Post Meta Revisioning plugin.

Could we just trigger a regular save (instead of autosave) when previewing drafts?

Yes, probably - however that might require more refactoring of how the preview loads its data?

What should happen if we preview a published post and preview is clicked, should we save the metaboxes too? it seems like an unwanted changed could be published inadvertently?

Absolutely right - this is a tricky situation, if we save the metaboxes unwanted changes could be saved, if we don't save the metaboxes we risk the preview not showing the correct information. That is why adding meta revisioning and using that for the preview makes so much sense - it solves both problems. Short of that, we probably want to match the existing core behavior despite the possibility of unwanted data being saved. Since this is such a long standing and well documented bug it has (sadly) become the expected state of affairs.

If it's only for drafts, then I'd be fine adding a flag tracking that we're previwing.

its for drafts and published posts, both need to save meta when previewing.

its for drafts and published posts, both need to save meta when previewing.

Gotcha, this means you're right that we need to distinguish the "preview save" from an "autosave" in the state to be able to trigger the metaboxes save in edit-post.

👍 will try to refactor as you suggest

youknowriad · 2018-11-08T08:49:08Z

I'd love to get this in but it doesn't seem ready for 4.3.

danielbachhuber · 2018-11-09T22:00:40Z

@adamsilverstein Still able to own this through to completion, or do you need to hand it off?

lkraav · 2018-11-13T12:10:04Z

Curious, is post meta saved only to the Preview / autosave revision? If you close the editor without Publish / Update, does live post meta retain their original values?

EDIT OK this might be answered already

no revisions are stored for meta currently in core - the meta is saved directly to the post (unfortunately). only one autosave revision is saved per post (per user).

#11409 (comment)

danielbachhuber · 2018-11-14T15:03:18Z

I don't know what this PR is trying to do exactly but we should try to hook into the saving mechanism from the edit-post package instead.

On a meta note, it would be neat if linting caught this. Do you think this is technically feasible?

youknowriad · 2018-11-14T15:10:24Z

On a meta note, it would be neat if linting caught this. Do you think this is technically feasible?

It should be possible with a custom linting rule, we'd have to check for package.json dependencies and have a mapping between package name and store name.

danielbachhuber · 2018-11-14T15:42:47Z

On a meta note, it would be neat if linting caught this. Do you think this is technically feasible?

It should be possible with a custom linting rule, we'd have to check for package.json dependencies and have a mapping between package name and store name.

Great. Created an issue with #11865

youknowriad · 2018-11-19T08:09:18Z

This doesn't seem to work for me, not sure what's going wrong here. Also question: this doesn't save the featured image, categories ... Are these supposed to be fixed in another issue?

adamsilverstein · 2018-11-19T14:37:26Z

This doesn't seem to work for me, not sure what's going wrong here. Also question: this doesn't save the featured image, categories ... Are these supposed to be fixed in another issue?

Thanks for testing. I'll dig in to see if I can tell what is happening. This addresses meta boxes so far. Featured image is being handles separately in #12037. I didn't realized categories/tags weren't included here, we should add them. One potential issue is I think the post endpoint accepts these directly, I'm not sure the autosave endpoint does.

mtias · 2018-11-19T21:34:57Z

packages/editor/src/store/selectors.js

+ *
+ * @return {boolean} Whether the post is being previewed.
+ */
+export function isPreviewingPost( state ) {


It's slightly weird that preview would have this side-effect but it wouldn't be evident from selector name. Though I guess it matches the expectation of the action itself.

…eview

youknowriad · 2018-11-20T08:37:31Z

packages/editor/src/components/post-preview-button/index.js

-
-			// Once popup redirect is evaluated, even if already closed, delete
-			// reference to avoid later assignment of location in post update.
-			delete this.previewWindow;


@aduth I removed this to be able to refresh the window without an autosave (once the metaboxes finish saving). I'm not aware of any downsides but let me know if I missed something.

youknowriad · 2018-11-20T08:38:12Z

I pushed some updates here, It's working better now.

youknowriad

LGTM 👍 But a second review would be good as I did work on this.

gziolo · 2018-11-20T11:08:01Z

packages/edit-post/src/components/header/index.js

-				<PostPreviewButton />
+				<PostPreviewButton
+					forceIsAutosaveable={ hasActiveMetaboxes }
+					forcePreviewLink={ isSaving ? null : undefined }


It could be refactored to:

forcePreviewLink={ isSaving }

and then we only would need to update the code later in the execution flow to:

previewLink: forcePreviewLink ? null : getAutosaveAttribute( 'preview_link' ),

it can't because we're forcing the null value from outside. The inner component don't know what value to put unless we rename the prop something like forceEmptyPreviewLink

gziolo · 2018-11-20T11:12:25Z

packages/edit-post/src/store/effects.js

-				! wasAutosavingPost &&
-				! isSavingPost &&
-				! isAutosavingPost
+				hasActiveMetaBoxes && (


I hope it works 🙏 😅

gziolo · 2018-11-20T11:17:08Z

packages/editor/src/store/selectors.js

+ * @return {boolean} Whether the post is being previewed.
+ */
+export function isPreviewingPost( state ) {
+	return isSavingPost( state ) && !! state.saving.options.isPreview;


Nit: I don't think we need !! in this condition. If we need it, we should probably be consistent and add it in the previous selector that is updated in this PR.

Updated. it's better to have it to ensure the return value is always a boolean.

…eview

gziolo

It works as expected in my testing using the snippet shared by @danielbachhuber in #11280 (comment).

Adam Silverstein added 2 commits November 2, 2018 08:18

Set the preview url once metabox and autosaves are complete.

0c46e21

when previewing, requestMetaBoxUpdates

b17b85f

adamsilverstein requested a review from aduth November 2, 2018 14:22

adamsilverstein commented Nov 2, 2018

View reviewed changes

danielbachhuber approved these changes Nov 2, 2018

View reviewed changes

danielbachhuber added [Type] Bug An existing feature does not function as intended Backwards Compatibility Issues or PRs that impact backwards compatability [Feature] Saving Related to saving functionality labels Nov 2, 2018

danielbachhuber added this to the 4.3 milestone Nov 2, 2018

adamsilverstein requested a review from danielbachhuber November 2, 2018 14:47

Merge branch 'master' of github.com:WordPress/gutenberg

8e54535

danielbachhuber approved these changes Nov 2, 2018

View reviewed changes

adamsilverstein mentioned this pull request Nov 2, 2018

Setting a featured image and clicking Preview does not show the featured image #9151

Closed

youknowriad reviewed Nov 2, 2018

View reviewed changes

Merge branch 'master' of github.com:WordPress/gutenberg

acde4a5

youknowriad modified the milestones: 4.3, 4.4 Nov 8, 2018

Adam Silverstein added 2 commits November 12, 2018 11:12

Merge branch 'master' of github.com:WordPress/gutenberg

20691f3

Merge branch 'master' of github.com:WordPress/gutenberg

89660bc

danielbachhuber mentioned this pull request Nov 14, 2018

Add linting rule to fail build if package A incorrectly depends on package B #11865

Open

danielbachhuber self-requested a review November 14, 2018 15:43

youknowriad removed this from the 4.4 milestone Nov 15, 2018

This was referenced Nov 18, 2018

Enable previewing changes to the post featured image #12037

Merged

Perform a full save when previewing drafts #12047

Closed

mtias reviewed Nov 19, 2018

View reviewed changes

youknowriad added 2 commits November 20, 2018 08:38

Merge remote-tracking branch 'origin/master' into fix/save-meta-on-pr…

b757300

…eview

Fix save metaboxes condition

74035ca

youknowriad force-pushed the fix/save-meta-on-preview branch from 5fb123c to 74035ca Compare November 20, 2018 07:44

Refresh preview after metabox save

8ab9863

youknowriad reviewed Nov 20, 2018

View reviewed changes

youknowriad added 3 commits November 20, 2018 09:54

Fix consecutive previews

f2f1514

Fix unit tests

da53820

Fix autosaving status

de2a5f1

youknowriad approved these changes Nov 20, 2018

View reviewed changes

youknowriad mentioned this pull request Nov 20, 2018

Perform a complete draft save on preview #12097

Merged

gziolo reviewed Nov 20, 2018

View reviewed changes

youknowriad added 2 commits November 20, 2018 12:20

Merge remote-tracking branch 'origin/master' into fix/save-meta-on-pr…

7e707c7

…eview

Always return a boolean value from isAutosave selector.

99f5bca

gziolo approved these changes Nov 20, 2018

View reviewed changes

youknowriad merged commit 2945a62 into master Nov 20, 2018

gziolo deleted the fix/save-meta-on-preview branch November 20, 2018 12:31

gziolo mentioned this pull request Nov 20, 2018

Meta is not saved to preview #11280

Closed

noisysocks mentioned this pull request Nov 21, 2018

Nagging "Post reverted to draft" bug #12147

Closed

Soean mentioned this pull request Nov 29, 2018

Preview Button Publishes/Updates Custom Fields #12419

Closed

swissspidy mentioned this pull request Dec 3, 2018

Preview page ignore page template until page isn't updated #12545

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Save meta on preview #11409

Save meta on preview #11409

adamsilverstein commented Nov 2, 2018 •

edited by gziolo

Loading

adamsilverstein Nov 2, 2018

danielbachhuber left a comment

danielbachhuber left a comment

aduth commented Nov 2, 2018 •

edited

Loading

adamsilverstein commented Nov 2, 2018

youknowriad Nov 2, 2018

youknowriad Nov 2, 2018

adamsilverstein Nov 4, 2018

adamsilverstein Nov 4, 2018

youknowriad Nov 14, 2018

adamsilverstein Nov 14, 2018

youknowriad Nov 14, 2018

adamsilverstein Nov 15, 2018

youknowriad commented Nov 8, 2018

danielbachhuber commented Nov 9, 2018 •

edited

Loading

lkraav commented Nov 13, 2018 •

edited

Loading

danielbachhuber commented Nov 14, 2018

youknowriad commented Nov 14, 2018

danielbachhuber commented Nov 14, 2018

youknowriad commented Nov 19, 2018

adamsilverstein commented Nov 19, 2018

mtias Nov 19, 2018

youknowriad Nov 20, 2018

youknowriad commented Nov 20, 2018

youknowriad left a comment

gziolo Nov 20, 2018

youknowriad Nov 20, 2018

gziolo Nov 20, 2018

gziolo Nov 20, 2018

youknowriad Nov 20, 2018

gziolo left a comment

Save meta on preview #11409

Save meta on preview #11409

Conversation

adamsilverstein commented Nov 2, 2018 • edited by gziolo Loading

Description

How has this been tested?

Types of changes

Checklist:

Choose a reason for hiding this comment

danielbachhuber left a comment

Choose a reason for hiding this comment

danielbachhuber left a comment

Choose a reason for hiding this comment

aduth commented Nov 2, 2018 • edited Loading

adamsilverstein commented Nov 2, 2018

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

youknowriad commented Nov 8, 2018

danielbachhuber commented Nov 9, 2018 • edited Loading

lkraav commented Nov 13, 2018 • edited Loading

danielbachhuber commented Nov 14, 2018

youknowriad commented Nov 14, 2018

danielbachhuber commented Nov 14, 2018

youknowriad commented Nov 19, 2018

adamsilverstein commented Nov 19, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

youknowriad commented Nov 20, 2018

youknowriad left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gziolo left a comment

Choose a reason for hiding this comment

adamsilverstein commented Nov 2, 2018 •

edited by gziolo

Loading

aduth commented Nov 2, 2018 •

edited

Loading

danielbachhuber commented Nov 9, 2018 •

edited

Loading

lkraav commented Nov 13, 2018 •

edited

Loading