Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Story Locking: Ensure author users and below correctly see information #12559

Merged
merged 6 commits into from
Nov 3, 2022
Merged

Story Locking: Ensure author users and below correctly see information #12559

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c7f2c16
Embed user data in REST API for post lock.
spacedmonkey Oct 28, 2022
4a64c17
Apply suggestions from code review
spacedmonkey Oct 31, 2022
c7b72c0
Use new fields in dashboard as well.
spacedmonkey Nov 2, 2022
00beefd
Merge branch 'main' into fix/12441
spacedmonkey Nov 2, 2022
5fef560
Remove all references to wp:lockuser.
spacedmonkey Nov 2, 2022
bb234cb
Remove more wp:lockuser.
spacedmonkey Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 61 additions & 4 deletions includes/REST_API/Stories_Lock_Controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,10 +303,17 @@ public function prepare_item_for_response( $item, $request ) {
$lock_data = [
'locked' => false,
'time' => '',
'user' => 0,
'user' => [
'name' => '',
'id' => 0,
],
'nonce' => $nonce,
];

if ( get_option( 'show_avatars' ) ) {
$lock_data['user']['avatar'] = [];
}

if ( ! empty( $item ) ) {
/** This filter is documented in wp-admin/includes/ajax-actions.php */
$time_window = apply_filters( 'wp_check_post_lock_window', 150 );
Expand All @@ -318,6 +325,19 @@ public function prepare_item_for_response( $item, $request ) {
'user' => isset( $item['user'] ) ? (int) $item['user'] : 0,
'nonce' => $nonce,
];
if ( isset( $item['user'] ) ) {
$user = get_user_by( 'id', $item['user'] );
if ( $user ) {
$lock_data['user'] = [
'name' => $user->display_name,
'id' => $item['user'],
];

if ( get_option( 'show_avatars' ) ) {
$lock_data['user']['avatar'] = rest_get_avatar_urls( $user );
}
}
}
}
}

Expand Down Expand Up @@ -433,13 +453,50 @@ public function get_item_schema(): array {
'context' => [ 'view', 'edit', 'embed' ],
],
'user' => [
'description' => __( 'The ID for the author of the lock.', 'web-stories' ),
'type' => 'integer',
'context' => [ 'view', 'edit', 'embed' ],
'description' => __( 'User', 'web-stories' ),
'type' => 'object',
'properties' => [
'id' => [
'description' => __( 'The ID for the author of the lock.', 'web-stories' ),
'type' => 'integer',
'readonly' => true,
'context' => [ 'view', 'edit', 'embed' ],
],
'name' => [
'description' => __( 'Display name for the user.', 'web-stories' ),
'type' => 'string',
'readonly' => true,
'context' => [ 'embed', 'view', 'edit' ],
],
],
],
],
];

if ( get_option( 'show_avatars' ) ) {
$avatar_properties = [];

$avatar_sizes = rest_get_avatar_sizes();

foreach ( $avatar_sizes as $size ) {
$avatar_properties[ $size ] = [
/* translators: %d: Avatar image size in pixels. */
'description' => sprintf( __( 'Avatar URL with image size of %d pixels.', 'web-stories' ), $size ),
'type' => 'string',
'format' => 'uri',
'context' => [ 'embed', 'view', 'edit' ],
];
}

$schema['properties']['user']['properties']['avatar'] = [
'description' => __( 'Avatar URLs for the user.', 'web-stories' ),
'type' => 'object',
'context' => [ 'embed', 'view', 'edit' ],
'readonly' => true,
'properties' => $avatar_properties,
];
}

$this->schema = $schema;

return $this->add_additional_fields_schema( $this->schema );
Expand Down
21 changes: 10 additions & 11 deletions packages/wp-dashboard/src/api/utils/reshapeStoryObject.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ export default function reshapeStoryObject(originalStoryData) {
preview_link: previewLink,
edit_link: editStoryLink,
story_poster: storyPoster,
_embedded: {
author = [{ name: '', id: 0 }],
'wp:lock': lock = [{ locked: false }],
'wp:lockuser': lockUser = [{ id: 0, name: '' }],
} = {},
_embedded: { author, 'wp:lock': lock } = {},
_links: links = {},
} = originalStoryData;
if (!id) {
return null;
}

const { locked = false, user: lockUser = { id: 0, name: '' } } =
lock?.[0] || {};
const storyAuthor = author?.[0] || { id: 0, name: '' };
swissspidy marked this conversation as resolved.
Show resolved Hide resolved
const capabilities = {
hasEditAction: Object.prototype.hasOwnProperty.call(links, REST_LINKS.EDIT),
hasDeleteAction: Object.prototype.hasOwnProperty.call(
Expand All @@ -59,14 +59,13 @@ export default function reshapeStoryObject(originalStoryData) {
modified,
modifiedGmt: `${modified_gmt}Z`,
author: {
name: author[0].name,
id: author[0].id,
id: storyAuthor.id,
name: storyAuthor.name,
},
locked: lock[0]?.locked,
locked,
lockUser: {
id: lockUser[0].id,
name: lockUser[0].name,
avatar: lockUser[0]?.avatar_urls?.['96'] || null,
...lockUser,
avatar: lockUser?.avatar?.['96'] || null,
},
bottomTargetAction: editStoryLink,
featuredMediaUrl: storyPoster?.url,
Expand Down
6 changes: 1 addition & 5 deletions packages/wp-story-editor/src/api/storyLock.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,7 @@ import { addQueryArgs } from '@googleforcreators/url';
import apiFetch from '@wordpress/api-fetch';

export function getStoryLockById(storyId, stories) {
const path = addQueryArgs(`${stories}${storyId}/lock/`, {
_embed: 'author',
});

return apiFetch({ path });
return apiFetch({ path: `${stories}${storyId}/lock/` });
}

export function setStoryLockById(storyId, stories) {
Expand Down
24 changes: 14 additions & 10 deletions packages/wp-story-editor/src/components/postLock/postLock.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,17 @@ function PostLock() {

// When async call only if dialog is true, current user is loaded and post locking is enabled.
const doGetStoryLock = useCallback(() => {
if (showLockedDialog && currentUserLoaded) {
getStoryLockById(storyId, stories)
.then(({ locked, nonce: newNonce, _embedded }) => {
(async () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Converted this to async code is not needed for this, but made it easier to read.

if (showLockedDialog && currentUserLoaded) {
try {
const {
locked,
nonce: newNonce,
user,
} = await getStoryLockById(storyId, stories);
const lockAuthor = {
id: _embedded?.author?.[0]?.id || 0,
name: _embedded?.author?.[0]?.name || '',
avatar: _embedded?.author?.[0]?.avatar_urls?.['96'] || '',
...user,
avatar: user?.avatar?.['96'] || '',
};
if (locked && initialOwner === null) {
setInitialOwner(lockAuthor);
Expand All @@ -114,11 +118,11 @@ function PostLock() {
}
// Refresh nonce on every request.
setNonce(newNonce);
})
.catch((err) => {
} catch (err) {
trackError('post_lock', err.message);
});
}
}
}
})();
}, [
setCurrentOwner,
storyId,
Expand Down
41 changes: 41 additions & 0 deletions tests/phpunit/integration/tests/REST_API/Stories_Lock_Controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,47 @@ public function test_get_item_with_lock(): void {
$data = $response->get_data();
$links = $response->get_links();
$this->assertArrayHasKey( 'locked', $data );
$this->assertArrayHasKey( 'user', $data );
$this->assertArrayHasKey( 'id', $data['user'] );
$this->assertArrayHasKey( 'name', $data['user'] );
$this->assertArrayHasKey( 'avatar', $data['user'] );
$this->assertSame( self::$author_id, $data['user']['id'] );
$this->assertTrue( $data['locked'] );

$this->assertArrayHasKey( 'self', $links );
$this->assertArrayHasKey( 'author', $links );
}

/**
* @covers ::get_item
* @covers ::prepare_item_for_response
* @covers ::prepare_links
* @covers ::get_item_permissions_check
*/
public function test_get_item_with_lock_disabled_avatar(): void {
update_option( 'show_avatars', false );
$this->controller->register();

wp_set_current_user( self::$author_id );
$story = self::factory()->post->create(
[
'post_type' => \Google\Web_Stories\Story_Post_Type::POST_TYPE_SLUG,
'post_status' => 'draft',
'post_author' => self::$author_id,
]
);
$new_lock = ( time() - 100 ) . ':' . self::$author_id;
update_post_meta( $story, '_edit_lock', $new_lock );
$request = new WP_REST_Request( \WP_REST_Server::READABLE, '/web-stories/v1/web-story/' . $story . '/lock' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$links = $response->get_links();
$this->assertArrayHasKey( 'locked', $data );
$this->assertArrayHasKey( 'user', $data );
$this->assertArrayHasKey( 'id', $data['user'] );
$this->assertArrayHasKey( 'name', $data['user'] );
$this->assertArrayNotHasKey( 'avatar', $data['user'] );
$this->assertSame( self::$author_id, $data['user']['id'] );
$this->assertTrue( $data['locked'] );

$this->assertArrayHasKey( 'self', $links );
Expand Down