Remember preview url query params #129

mohdsayed · 2017-03-04T16:57:49Z

Fixes #107

coveralls · 2017-03-06T12:30:07Z

Coverage decreased (-0.9%) to 75.339% when pulling 6a44a47 on enhancement/remember-preview-url into 973480f on develop.

coveralls · 2017-03-06T13:17:54Z

Coverage decreased (-1.04%) to 75.24% when pulling 95e139b on enhancement/remember-preview-url into 973480f on develop.

mohdsayed · 2017-03-06T13:25:53Z

Ready for review.

I am not sure if preg_match( '/[a-z|\[|\]|_|-|0-9]+/', $value ) would be the correct choice for validating the panel/section/control id , please suggest

coveralls · 2017-03-06T13:35:31Z

Coverage decreased (-1.06%) to 75.226% when pulling 108c865 on enhancement/remember-preview-url into 973480f on develop.

westonruter · 2017-03-07T07:55:11Z

js/compat/customize-snapshots.js

@@ -226,6 +226,11 @@

 			api.previewer.query = function() {
 				var retval = originalQuery.apply( this, arguments );
+
+				if ( 'undefined' !== typeof CustomizerBrowserHistory ) {
+					retval.customize_preview_url_query_vars = JSON.stringify( CustomizerBrowserHistory.getQueryParams( location.href ) );


I don't think that Customizer Browser History should be made a dependency for this feature.

This can be replaced with:

retval.customize_preview_url_query_vars = wp.customize.utils.parseQueryString( location.search.substr( 1 ) );

though on 4.6 a polyfill for wp.customize.utils.parseQueryString would be needed.

westonruter · 2017-03-07T07:55:23Z

js/customize-snapshots.js

@@ -966,6 +966,11 @@

 			api.previewer.query = function() {
 				var retval = originalQuery.apply( this, arguments );
+
+				if ( 'undefined' !== typeof CustomizerBrowserHistory ) {
+					retval.customize_preview_url_query_vars = JSON.stringify( CustomizerBrowserHistory.getQueryParams( location.href ) );


westonruter · 2017-03-07T07:58:42Z

php/class-customize-snapshot-manager.php

+		$allowed_devices = array(
+			'mobile',
+			'desktop',
+			'tablet',


This list needn't be hard-coded. You can use \WP_Customize_Manager::get_previewable_devices().

westonruter · 2017-03-07T08:00:05Z

php/class-customize-snapshot-manager.php

+					(
+						in_array( $param, $allowed_panel_section_control_params )
+						&&
+						preg_match( '/[a-z|\[|\]|_|-|0-9]+/', $value )


This regex seems to be missing the initial ^( and ending )$ if it is doing what I think.

The panel/sections/control ids can be like
post[post][1437]
title_tagline
blogname
nav_menu-61
postmeta[posttype][27450][keywords]

It doesn't follow any initial or ending pattern?

Isn't the purpose to validate that the $param is a valid ID string? If you want to ensure that only the valid characters are included then you should do:

preg_match( '/^[a-z|\[|\]|_|-|0-9]+$/', $value )

Adding the ^ and $ anchors, as otherwise a user could supply an ID like: !@#$%^&*()title_tagline⁄€‹›ﬁﬂ‡°·‚

@westonruter I think I am not able to get it, Can you see this http://regexr.com/3ffv4 ?

I should probably be \[a-z|\[|\]|_|\-|0-9]+\ ( escaped - sign ) but /^[a-z|\[|\]|_|-|0-9]+$/ doesn't match anything.

@sayedtaqui from that example, you can see that it is matching all of those strings, the last one incorrect.

Compare:

and

westonruter · 2017-03-07T08:09:51Z

php/class-customize-snapshot-manager.php

@@ -104,7 +104,8 @@ function hooks() {
 		add_action( 'admin_bar_menu', array( $this, 'remove_all_non_snapshot_admin_bar_links' ), 100000 );
 		add_action( 'wp_before_admin_bar_render', array( $this, 'print_admin_bar_styles' ) );
 		add_filter( 'removable_query_args', array( $this, 'filter_removable_query_args' ) );
-		add_action( 'save_post_customize_changeset', array( $this, 'create_initial_changeset_revision' ) );
+		add_action( 'save_post_' . $this->get_post_type(), array( $this, 'create_initial_changeset_revision' ) );
+		add_action( 'save_post_' . $this->get_post_type() , array( $this, 'save_customize_preview_url_query_vars' ) );


There's an extra space before the comment here.

westonruter · 2017-03-07T08:10:44Z

php/class-post-type.php

+		$preview_url_query_vars = array();
+
+		// If customizer browser history plugin is active.
+		if ( function_exists( 'customizer_browser_history_enqueue_scripts' ) && $post_id ) {


Per above, I think Customizer Browser History shouldn't be made a dependency.

coveralls · 2017-03-08T13:11:14Z

Coverage decreased (-0.9%) to 75.395% when pulling 1774137 on enhancement/remember-preview-url into 973480f on develop.

westonruter · 2017-03-08T18:41:56Z

php/class-post-type.php

+		$preview_url_query_vars = array();
+
+		if ( $post_id ) {
+			$preview_url_query_vars = (array) get_post_meta( $post_id, '_preview_url_query_vars', true );


If there is no postmeta on the changeset post, where get_post_meta() returns false, this will result in $preview_url_query_vars === array( false ).

So this should probably be:

$preview_url_query_vars = get_post_meta( $post_id, '_preview_url_query_vars', true ); if ( ! is_array( $preview_url_query_vars ) ) { $preview_url_query_vars = array(); }

mohdsayed · 2017-03-09T16:28:02Z

Class 'PHPUnit_Framework_TestCase' not found in /tmp/wordpress/tests/phpunit/includes/testcase.

Not sure why the build is failing.

westonruter · 2017-03-09T16:59:48Z

Not sure why the build is failing.

@sayedtaqui it looks like an issue with PHPUnit 6.0. I'm noticing the same thing locally after upgrading from 5.x.

See also WordPress/WordPress-Coding-Standards#870 (comment)

See also:

Looks like travis-ci just updated its PHP 7 images to use PHPUnit 6+, so our PHP 7 builds are failing. We should either fast-track #39822 or install + use and older version of PHPUnit in our travis script
https://wordpress.slack.com/archives/core/p1489073667330796

…query_vars

…t was saved

…res on PHP 7 xwp/wp-dev-lib@85f9cf4...8b767f9

coveralls · 2017-03-10T00:31:25Z

Coverage decreased (-0.8%) to 75.479% when pulling 83dc09f on enhancement/remember-preview-url into 973480f on develop.

coveralls · 2017-03-10T00:35:38Z

Coverage decreased (-0.8%) to 75.479% when pulling 4caa963 on enhancement/remember-preview-url into 973480f on develop.

westonruter · 2017-03-10T01:01:51Z

php/class-customize-snapshot-manager.php

@@ -104,7 +104,8 @@ function hooks() {
 		add_action( 'admin_bar_menu', array( $this, 'remove_all_non_snapshot_admin_bar_links' ), 100000 );
 		add_action( 'wp_before_admin_bar_render', array( $this, 'print_admin_bar_styles' ) );
 		add_filter( 'removable_query_args', array( $this, 'filter_removable_query_args' ) );
-		add_action( 'save_post_customize_changeset', array( $this, 'create_initial_changeset_revision' ) );
+		add_action( 'save_post_' . $this->get_post_type(), array( $this, 'create_initial_changeset_revision' ) );


Good catch!

… for Customize admin bar link

westonruter · 2017-03-10T01:35:08Z

@sayedtaqui Ready for merge after you give a final review of my tweaks.

coveralls · 2017-03-10T01:41:38Z

Coverage decreased (-26.1%) to 50.176% when pulling f5b55cd on enhancement/remember-preview-url into 973480f on develop.

coveralls · 2017-03-10T08:43:06Z

Coverage decreased (-26.1%) to 50.176% when pulling 6d9e9a9 on enhancement/remember-preview-url into 973480f on develop.

coveralls · 2017-03-10T11:57:31Z

Coverage increased (+0.3%) to 76.554% when pulling 43bee5b on enhancement/remember-preview-url into 973480f on develop.

mohdsayed · 2017-03-10T12:02:54Z

👍 Lets merge.

mohdsayed added 2 commits March 4, 2017 02:37

Save history preview url params in changeset meta

31096b4

Add preview history url params to edit in preview and customize link

2b29f14

PatelUtkarsh changed the title ~~[WIP]Rememeber preview url query params~~ [WIP]Remember preview url query params Mar 6, 2017

mohdsayed added 2 commits March 6, 2017 17:21

Add support for 4.6 and check plugin active using function_exists

a9fd390

Resolve conflict with develop

6a44a47

Get snapshot post id from current post

95e139b

Get post type dynamically for save_post_ action

108c865

mohdsayed changed the title ~~[WIP]Remember preview url query params~~ Remember preview url query params Mar 6, 2017

westonruter suggested changes Mar 7, 2017

View reviewed changes

mohdsayed added 2 commits March 8, 2017 17:11

Remove customizer history plugin dependency and review changes.

d5542c1

Fix JSHint issue, remove unused CustomizerBrowserHistory

1774137

westonruter suggested changes Mar 8, 2017

View reviewed changes

Update regex for validating id and fix get_preview_url_query_vars

2c4b599

westonruter added 8 commits March 9, 2017 09:21

Add missing url query param and re-factor save_customize_preview_url_…

34246cc

…query_vars

Ensure frontend preview links use the previewed URL when the changese…

ab61743

…t was saved

Rename Preview Snapshot to Preview Changeset

65c042b

Fix passing of integer scroll

e78ae0a

Remove dependency on Customizer Browser History

d3438ad

Re-use get_frontend_view_link in filter for getting permalink

3534389

Update wp-dev-lib 85f9cf4...8b767f9: Add workaround for phpunit failu…

beaf92a

…res on PHP 7 xwp/wp-dev-lib@85f9cf4...8b767f9

Update .travis.yml with latest from dev-lib

f12a74a

westonruter force-pushed the enhancement/remember-preview-url branch from cccae03 to 83dc09f Compare March 10, 2017 00:22

Update dev-lib with xwp/wp-dev-lib#221

4caa963

westonruter force-pushed the enhancement/remember-preview-url branch from 83dc09f to 4caa963 Compare March 10, 2017 00:30

westonruter reviewed Mar 10, 2017

View reviewed changes

westonruter added 2 commits March 9, 2017 17:29

Add unit tests and improve method naming

1aec717

Ensure the current URL being previewed on the frontend is always used…

f5b55cd

… for Customize admin bar link

westonruter approved these changes Mar 10, 2017

View reviewed changes

westonruter added this to the 0.6.0 milestone Mar 10, 2017

Fix phpunit test for 4.6.1

6d9e9a9

Fix phpunit test for 4.6.1

43bee5b

westonruter merged commit 7f02238 into develop Mar 10, 2017

westonruter mentioned this pull request Mar 10, 2017

Remember the preview URL and expanded panel/section when saving a changeset #107

Closed

valendesigns deleted the enhancement/remember-preview-url branch August 23, 2017 01:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remember preview url query params #129

Remember preview url query params #129

mohdsayed commented Mar 4, 2017 •

edited by westonruter

Loading

coveralls commented Mar 6, 2017 •

edited

Loading

coveralls commented Mar 6, 2017 •

edited

Loading

mohdsayed commented Mar 6, 2017

coveralls commented Mar 6, 2017 •

edited

Loading

westonruter Mar 7, 2017

westonruter Mar 7, 2017

westonruter Mar 7, 2017

westonruter Mar 7, 2017

mohdsayed Mar 8, 2017

westonruter Mar 8, 2017

mohdsayed Mar 8, 2017

mohdsayed Mar 8, 2017

westonruter Mar 8, 2017

mohdsayed Mar 9, 2017

westonruter Mar 7, 2017

westonruter Mar 7, 2017

coveralls commented Mar 8, 2017 •

edited

Loading

westonruter Mar 8, 2017

mohdsayed commented Mar 9, 2017

westonruter commented Mar 9, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading

westonruter Mar 10, 2017

westonruter commented Mar 10, 2017

coveralls commented Mar 10, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading

mohdsayed commented Mar 10, 2017

Remember preview url query params #129

Remember preview url query params #129

Conversation

mohdsayed commented Mar 4, 2017 • edited by westonruter Loading

coveralls commented Mar 6, 2017 • edited Loading

coveralls commented Mar 6, 2017 • edited Loading

mohdsayed commented Mar 6, 2017

coveralls commented Mar 6, 2017 • edited Loading

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

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

coveralls commented Mar 8, 2017 • edited Loading

Choose a reason for hiding this comment

mohdsayed commented Mar 9, 2017

westonruter commented Mar 9, 2017 • edited Loading

coveralls commented Mar 10, 2017 • edited Loading

coveralls commented Mar 10, 2017 • edited Loading

Choose a reason for hiding this comment

westonruter commented Mar 10, 2017

coveralls commented Mar 10, 2017 • edited Loading

coveralls commented Mar 10, 2017 • edited Loading

coveralls commented Mar 10, 2017 • edited Loading

mohdsayed commented Mar 10, 2017

mohdsayed commented Mar 4, 2017 •

edited by westonruter

Loading

coveralls commented Mar 6, 2017 •

edited

Loading

coveralls commented Mar 6, 2017 •

edited

Loading

coveralls commented Mar 6, 2017 •

edited

Loading

coveralls commented Mar 8, 2017 •

edited

Loading

westonruter commented Mar 9, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading

coveralls commented Mar 10, 2017 •

edited

Loading