0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-24 23:48:13 -05:00
ghost/apps/comments-ui/src/actions.js
Simon Backx b701ba9c0d Cleaned up Comment component (#8)
refs https://github.com/TryGhost/Team/issues/1858
fixes https://github.com/TryGhost/Team/issues/1789

- Split up the Comment component in many small Components to make it easier to read and maintain
- Added support for synchronous actions, which are required for actions that affect the context state based on the current value (e.g., increasing a value by one) because of the asynchronous nature of setState:

Before this change
```
// Context state: {hello: 0};
dispatchAction('increaseHelloByOne')
dispatchAction('increaseHelloByOne')
```

Could end up having a state `{hello: 1}` instead of the expected `{hello: 2}`, because underlying this would resolve into:

```
// Context state: {hello: 0};
const hello = {hello: 0};
setState({hello: hello + 1});
setState({hello: hello + 1});
```

Instead of

```
// Context state: {hello: 0};
setState(({hello}) => {hello: hello + 1});
setState(({hello}) => {hello: hello + 1});
```

Synchronous actions now support this.

- Removed deprecated `onAction` context state function
- Replaced the boolean based form checking by the more reliable counter based checking that uses synchronous actions (reason we needed synchronous actions) (fixes https://github.com/TryGhost/Team/issues/1789)
- Prevent creating a new `dispatchAction` function every time the context state changes, by using bind. This prevents infinte updates in `useEffect` hooks that depend on `dispatchAction` and also update the context via actions.
2022-08-30 16:25:40 +02:00

392 lines
9.9 KiB
JavaScript

async function loadMoreComments({state, api}) {
let page = 1;
if (state.pagination && state.pagination.page) {
page = state.pagination.page + 1;
}
const data = await api.comments.browse({page, postId: state.postId});
// Note: we store the comments from new to old, and show them in reverse order
return {
comments: [...state.comments, ...data.comments],
pagination: data.meta.pagination
};
}
async function loadMoreReplies({state, api, data: {comment, limit}}) {
const data = await api.comments.replies({commentId: comment.id, afterReplyId: comment.replies[comment.replies.length - 1]?.id, limit});
// Note: we store the comments from new to old, and show them in reverse order
return {
comments: state.comments.map((c) => {
if (c.id === comment.id) {
return {
...comment,
replies: [...comment.replies, ...data.comments]
};
}
return c;
})
};
}
async function addComment({state, api, data: comment}) {
const data = await api.comments.add({comment});
comment = data.comments[0];
return {
comments: [comment, ...state.comments],
commentCount: state.commentCount + 1
};
}
async function addReply({state, api, data: {reply, parent}}) {
let comment = reply;
comment.parent_id = parent.id;
const data = await api.comments.add({comment});
comment = data.comments[0];
// When we add a reply,
// it is possible that we didn't load all the replies for the given comment yet.
// To fix that, we'll save the reply to a different field that is created locally to differentiate between replies before and after pagination 😅
// Replace the comment in the state with the new one
return {
comments: state.comments.map((c) => {
if (c.id === parent.id) {
return {
...parent,
replies: [...parent.replies, comment],
count: {
...parent.count,
replies: parent.count.replies + 1
}
};
}
return c;
}),
commentCount: state.commentCount + 1
};
}
async function hideComment({state, adminApi, data: comment}) {
await adminApi.hideComment(comment.id);
return {
comments: state.comments.map((c) => {
const replies = c.replies.map((r) => {
if (r.id === comment.id) {
return {
...r,
status: 'hidden'
};
}
return r;
});
if (c.id === comment.id) {
return {
...c,
status: 'hidden',
replies
};
}
return {
...c,
replies
};
}),
commentCount: state.commentCount - 1
};
}
async function showComment({state, api, adminApi, data: comment}) {
await adminApi.showComment(comment.id);
// We need to refetch the comment, to make sure we have an up to date HTML content
// + all relations are loaded as the current member (not the admin)
const data = await api.comments.read(comment.id);
const updatedComment = data.comments[0];
return {
comments: state.comments.map((c) => {
const replies = c.replies.map((r) => {
if (r.id === comment.id) {
return updatedComment;
}
return r;
});
if (c.id === comment.id) {
return updatedComment;
}
return {
...c,
replies
};
}),
commentCount: state.commentCount + 1
};
}
async function likeComment({state, api, data: comment}) {
await api.comments.like({comment});
return {
comments: state.comments.map((c) => {
const replies = c.replies.map((r) => {
if (r.id === comment.id) {
return {
...r,
liked: true,
count: {
...r.count,
likes: r.count.likes + 1
}
};
}
return r;
});
if (c.id === comment.id) {
return {
...c,
liked: true,
replies,
count: {
...c.count,
likes: c.count.likes + 1
}
};
}
return {
...c,
replies
};
})
};
}
async function reportComment({state, api, data: comment}) {
await api.comments.report({comment});
return {};
}
async function unlikeComment({state, api, data: comment}) {
await api.comments.unlike({comment});
return {
comments: state.comments.map((c) => {
const replies = c.replies.map((r) => {
if (r.id === comment.id) {
return {
...r,
liked: false,
count: {
...r.count,
likes: r.count.likes - 1
}
};
}
return r;
});
if (c.id === comment.id) {
return {
...c,
liked: false,
replies,
count: {
...c.count,
likes: c.count.likes - 1
}
};
}
return {
...c,
replies
};
})
};
}
async function deleteComment({state, api, data: comment}) {
await api.comments.edit({
comment: {
id: comment.id,
status: 'deleted'
}
});
return {
comments: state.comments.map((c) => {
const replies = c.replies.map((r) => {
if (r.id === comment.id) {
return {
...r,
status: 'deleted'
};
}
return r;
});
if (c.id === comment.id) {
return {
...c,
status: 'deleted',
replies
};
}
return {
...c,
replies
};
}),
commentCount: state.commentCount - 1
};
}
async function editComment({state, api, data: {comment, parent}}) {
const data = await api.comments.edit({
comment
});
comment = data.comments[0];
// Replace the comment in the state with the new one
return {
comments: state.comments.map((c) => {
if (parent && parent.id === c.id) {
return {
...c,
replies: c.replies.map((r) => {
if (r.id === comment.id) {
return comment;
}
return r;
})
};
} else if (c.id === comment.id) {
return comment;
}
return c;
})
};
}
async function updateMember({data, state, api}) {
const {name, bio} = data;
const patchData = {};
const originalName = state?.member?.name;
if (name && originalName !== name) {
patchData.name = name;
}
const originalBio = state?.member?.bio;
if (bio !== undefined && originalBio !== bio) {
// Allow to set it to an empty string or to null
patchData.bio = bio;
}
if (Object.keys(patchData).length > 0) {
try {
const member = await api.member.update(patchData);
if (!member) {
throw new Error('Failed to update member');
}
return {
member,
success: true
};
} catch (err) {
return {
success: false,
error: err
};
}
}
return null;
}
function openPopup({data}) {
return {
popup: data
};
}
function closePopup() {
return {
popup: null
};
}
function increaseSecundaryFormCount({state}) {
return {
secundaryFormCount: state.secundaryFormCount + 1
};
}
function decreaseSecundaryFormCount({state}) {
return {
secundaryFormCount: state.secundaryFormCount - 1
};
}
// Sync actions make use of setState((currentState) => newState), to avoid 'race' conditions
const SyncActions = {
openPopup,
closePopup,
increaseSecundaryFormCount,
decreaseSecundaryFormCount
};
const Actions = {
// Put your actions here
addComment,
editComment,
hideComment,
deleteComment,
showComment,
likeComment,
unlikeComment,
reportComment,
addReply,
loadMoreComments,
loadMoreReplies,
updateMember
};
export function isSyncAction(action) {
return !!SyncActions[action];
}
/** Handle actions in the App, returns updated state */
export async function ActionHandler({action, data, state, api, adminApi}) {
const handler = Actions[action];
if (handler) {
return await handler({data, state, api, adminApi}) || {};
}
return {};
}
/** Handle actions in the App, returns updated state */
export function SyncActionHandler({action, data, state, api, adminApi}) {
const handler = SyncActions[action];
if (handler) {
// Do not await here
return handler({data, state, api, adminApi}) || {};
}
return {};
}