Enable post locking in Gutenberg #4217

adamsilverstein · 2018-01-01T02:50:48Z

Description

Enable the post locking feature in gutenberg:

Fixes #4331

uses the existing mechanism to set the post as locked.
works in both and between classic/gutenberg editors.
~~uses the existing core code, slightly refactored to pass Gutenberg linting.~~
show the locked dialog when opening a post that is already opened by another user.
show the takeover dialog shown when someone tries to take over a locked post.

How Has This Been Tested?

Create or edit a post.
Log in as a separate user and go to the posts screen, note the post is locked.
Test the three buttons: preview, take over and post list
Take over the post, make some edits without saving, then toggle back to the browser where the other user had the post open, this user will get an autosave fired and the 'another user has take over' dialog.

Screenshots (jpeg or gifs if applicable):

Types of changes

Add heartbeat.js in editor/utils, exporting setupHearthbeat
call setupHearthbeat before initial editor render.
monitor heartbeat for lock events - displaying a "user has taken over" modal when another user takes over the post
localize data for existing locks, displaying an "Already Locked" modal

Checklist:

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

editor/utils/heartbeat.js

adamsilverstein · 2018-01-01T15:50:33Z

Closing in favor of #4218 which builds on this and adds heartbeat based autosaves as well.

adamsilverstein · 2018-06-08T16:36:18Z

Reopening to work on standalone post locking since we took a different route with autosaves.

# Conflicts: # editor/index.js

# Conflicts: # edit-post/index.js

# Conflicts: # packages/editor/src/store/reducer.js

… into feature/post-locking

gutenberg.php

lib/client-assets.php

packages/components/src/modal/README.md

aduth · 2018-10-04T14:55:56Z

packages/editor/src/components/post-locked-modal/index.js

+/**
+ * External dependencies
+ */
+import jQuery from 'jquery';


We should add jquery as a dependency of the wp-editor script

This still needs to be done.

packages/editor/src/components/post-locked-modal/index.js

aduth · 2018-10-04T15:10:02Z

packages/editor/src/components/post-locked-modal/index.js

+			updatePostLock,
+		};
+	} ),
+


We're inconsistent with newlines between these members of the array. I'd recommend omitting them for broader consistency with the project.

packages/editor/src/store/reducer.js

karmatosed · 2018-10-04T16:12:58Z

Looks good to me. Thanks for all the hard work.

mcsf

Added i18n feedback, which I'll address right now. (By typing it out I can refer to it later.)

packages/editor/src/components/post-locked-modal/index.js

youknowriad · 2018-10-04T16:50:51Z

Thanks for the hard work everyone. Now it's in we can enhance it with API endpoints at a more reasonable pace :)

aduth · 2018-10-04T17:03:08Z

Now it's in we can enhance it with API endpoints at a more reasonable pace :)

Is this tracked as an issue somewhere I can follow?

danielbachhuber · 2018-10-04T17:04:00Z

Is this tracked as an issue somewhere I can follow?

There's https://core.trac.wordpress.org/ticket/44862

dmsnell · 2018-10-11T01:00:05Z

packages/editor/src/components/post-locked-modal/index.js

+		// https://developer.wordpress.org/plugins/javascript/heartbeat-api/
+		jQuery( document )
+			.on( 'heartbeat-send.refresh-lock', this.sendPostLock )
+			.on( 'heartbeat-tick.refresh-lock', this.receivePostLock );


@adamsilverstein is there a reason we need to rely on jQuery here? could we have gotten by with addEventListener() (and for IE attachEvent)?

given the assumption that WordPress is already loaded jQuery seems free, but for external uses these few lines can pull in a huge dependency

thoughts?

We should do similar as to what was done in #8311 as a short-term solution.

In fact, at least for the heartbeat-tick event, we should already have the action provided through #8311.

Pull request at #11781

Adam Silverstein added 3 commits December 31, 2017 21:49

Enable post locking via the heartbeat api, following core

4f38c60

remove interval change

8578fc7

Docblock updates

b370721

adamsilverstein mentioned this pull request Jan 1, 2018

Improve autosaves #4156

Closed

3 tasks

travislopes reviewed Jan 1, 2018

View reviewed changes

editor/utils/heartbeat.js Outdated Show resolved Hide resolved

adamsilverstein closed this Jan 1, 2018

gziolo deleted the feature/post-locking branch May 7, 2018 11:15

adamsilverstein restored the feature/post-locking branch June 8, 2018 16:35

adamsilverstein reopened this Jun 8, 2018

adamsilverstein mentioned this pull request Jun 8, 2018

Enable Heartbeat Post Locking #4331

Closed

Adam Silverstein added 11 commits July 6, 2018 12:33

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

940f338

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

18290b2

Merge branch 'master' into feature/post-locking

aa301d2

# Conflicts: # editor/index.js

revert unintended changes

fbf7d08

remove nonce handling

e387b39

rename file & setup

3a3deb9

Ensure heartbeat interval is low enough to work for post locking

6980a89

Unlock the post when the window is closed or exited.

810119d

Fixes for eslint

c510e37

Merge branch 'master' into feature/post-locking

a9d7922

# Conflicts: # edit-post/index.js

tabs not spaces

60c6ccc

adamsilverstein added this to the Merge Proposal: Editor milestone Jul 27, 2018

adamsilverstein self-assigned this Jul 27, 2018

post locking WIP

c611a7b

chrisvanpatten mentioned this pull request Aug 1, 2018

Post Locking does not work #8366

Closed

Adam Silverstein added 3 commits August 1, 2018 10:23

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

7f35914

Merge branch 'master' into feature/post-locking

ca38176

# Conflicts: # packages/editor/src/store/reducer.js

modal on load first pass

a5d1764

youknowriad added 2 commits October 3, 2018 10:40

Merge remote-tracking branch 'origin/master' into feature/post-locking

10bd363

Try fixing the release post issue

008872b

mtias modified the milestones: Merge: Editor, 4.1 Oct 3, 2018

Adam Silverstein added 4 commits October 3, 2018 23:01

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

6afbc96

Merge branch 'feature/post-locking' of github.com:WordPress/gutenberg…

3d84894

… into feature/post-locking

Merge branch 'master' into feature/post-locking

9611023

include and use an unclock nonce

1fee125

youknowriad modified the milestones: 4.1, 4.0 Oct 4, 2018

aduth reviewed Oct 4, 2018

View reviewed changes

youknowriad added 2 commits October 4, 2018 11:32

Remove the heartbeat interval tweak

6bc1196

Code style and documentation tweaks

240f3e7

youknowriad force-pushed the feature/post-locking branch from 1e140a0 to 240f3e7 Compare October 4, 2018 15:53

karmatosed approved these changes Oct 4, 2018

View reviewed changes

mcsf reviewed Oct 4, 2018

View reviewed changes

packages/editor/src/components/post-locked-modal/index.js Outdated Show resolved Hide resolved

packages/editor/src/components/post-locked-modal/index.js Outdated Show resolved Hide resolved

mcsf added 2 commits October 4, 2018 12:29

i18n: Drop untranslatable postType interpolation.

719175b

i18n: Separate strings for more versatile translation

f89696c

youknowriad merged commit 37bd1e6 into master Oct 4, 2018

youknowriad deleted the feature/post-locking branch October 4, 2018 16:50

youknowriad mentioned this pull request Oct 4, 2018

Fix Editor Styles regression #10342

Merged

dmsnell reviewed Oct 11, 2018

View reviewed changes

dimadin mentioned this pull request Oct 21, 2018

Improve post locking modal #10886

Merged

aduth mentioned this pull request Nov 12, 2018

Hooks: Dispatch all heartbeat events as hooks actions #11781

Merged

swissspidy mentioned this pull request Jul 10, 2020

Implement Post Locking MVP GoogleForCreators/web-stories-wp#3126

Closed

spacedmonkey mentioned this pull request Jan 7, 2022

REST API: Post locking endpoint #37789

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable post locking in Gutenberg #4217

Enable post locking in Gutenberg #4217

adamsilverstein commented Jan 1, 2018 •

edited

Loading

adamsilverstein commented Jan 1, 2018

adamsilverstein commented Jun 8, 2018

aduth Oct 4, 2018

aduth Oct 4, 2018

karmatosed commented Oct 4, 2018

mcsf left a comment

youknowriad commented Oct 4, 2018

aduth commented Oct 4, 2018

danielbachhuber commented Oct 4, 2018

dmsnell Oct 11, 2018

aduth Oct 16, 2018

aduth Oct 16, 2018

aduth Nov 12, 2018

Enable post locking in Gutenberg #4217

Enable post locking in Gutenberg #4217

Conversation

adamsilverstein commented Jan 1, 2018 • edited Loading

Description

How Has This Been Tested?

Screenshots (jpeg or gifs if applicable):

Types of changes

Checklist:

adamsilverstein commented Jan 1, 2018

adamsilverstein commented Jun 8, 2018

aduth Oct 4, 2018

Choose a reason for hiding this comment

aduth Oct 4, 2018

Choose a reason for hiding this comment

karmatosed commented Oct 4, 2018

mcsf left a comment

Choose a reason for hiding this comment

youknowriad commented Oct 4, 2018

aduth commented Oct 4, 2018

danielbachhuber commented Oct 4, 2018

dmsnell Oct 11, 2018

Choose a reason for hiding this comment

aduth Oct 16, 2018

Choose a reason for hiding this comment

aduth Oct 16, 2018

Choose a reason for hiding this comment

aduth Nov 12, 2018

Choose a reason for hiding this comment

adamsilverstein commented Jan 1, 2018 •

edited

Loading