* Initial scaffolding for comments CRUD APIs * add actions * add assets * state management for existing comments and creating new * add ui components * add overlay comments wrapper to baseWidget * add toggle comment mode button at editor header * trigger tests * Disallow commenting as someone else * Add applicationId for comments * lint * Add overlay blacklist to prevent component interaction while adding comments * Comment thread style updates * Placeholder comment context menu * Controlled comment thread visibility for making new comments visible by default * Update comment type description * Reset input on save * Resolve comment thread button ui * fix close on esc key, dont create new comment on outside click * Submit on enter * add emoji picker * Attempt at adding a websocket server in Java * CRUD APIs for comment threads * Add API for getting all threads in application * Move types to a separate file * Initial commit for real time server (RTS) * Add script to start RTS * Fix position property * Use create comment thread API * Use add comment to thread API * Add custom cursor * Dispatch logout init on 401 errors * Allow CORS for real time connection * Add more logs to RTS * Fix construction of MongoClient * WIP: Real time comments * Enable comments * Minor updates * Read backend API base URL from environment * Escape to reset comments mode * Set popover position as auto and boundary as scroll parent * Disable warning * Added permissions for comment threads * Add resolved API for comment threads * Migration to set commenting permission on existing apps * Fix updates bringing the RTS down * Show view latest button, scroll to bottom on creating a new comment * Cleanup comment reducer * Move to typescript for RTS * Add missing server.ts and tsconfig files * Resolve / unresolve comment * Scaffold app comments * Minor fixes: comment on top of all widgets, add toggle button at viewer header * Reconnect socket on creating a new app, set connected status in store * Retry socket connection flow * Integration tests for comments with api mocks using msw * Fix circular depependency * rm file * Minor cleanup and comments * Minor refactors: move isScrolledToBottom to common hooks, decouple prevent interactions overlay from comments wrapper * Use policies when pushing updates in RTS * ENV var to set if comments are enabled * Fix: check if editor/viewer is initialised before waiting for init action * Add tests for comments reducer * Revert "ENV var to set if comments are enabled" This reverts commit 988efeaa69d378d943a387e1e73510334958adc5. * Enable comments for users with appsmith email * lint * fix * Try running a socket.io server inside backend * Update comment reducer tests * Init mentions within comments * Fix comment thread updates with email rooms * Minor fixes * Refactors / review suggestions * lint * increase cache limit for builds * Comment out tests for feature that's under development * Add Dockerfile for RTS * Fix policies missing for first comment in threads * Use draftJS for comments input with mentions support * fix fixtures * Use thread's policies when querying for threads * Update socket.io to v4 * Add support for richer body with mentions * Update comment body type to RawDraftContentState * fix stale method * Fix mentions search * Minor cleanups * Comment context menu and thread UI updates * revert: Scaffold app comments * Yarn dependencies * Delete comment using id api added * Init app comments * Add test for creating thread * Api for delete comment with id * Test comment creation response and policies * Copy comment links * Fix reset editor state * Delete valid comment testcase added * Delete comment TC : code refactor * Don't allow creating comments with an empty body * Pin comments WIP[] * Ignore dependency-reduced-pom.xml files from VCS * Cleanup of some dev-only files, for review * Delete comment * Update socket.io to v4 in RTS * Pin and resolve comment thread object added in commentThread * Pin and resolve comment thread object added in commentThread * Update comment thread API * Added creationTime and updationTime in comment thread response * Added creationTime and updationTime in comment thread response * Added human readable id to comment threads, fallback to username for null name in user document * Refactor * lint * fix test, rm duplicate selector * comment out saga used for dev * CommentThread viewed status, username fallback for getName=null, username field added in pin & resolve status * lint * trigger tests Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: Abhijeet <abhi.nagarnaik@gmail.com>
142 lines
4.0 KiB
TypeScript
142 lines
4.0 KiB
TypeScript
import React, { useRef } from "react";
|
|
import { useDispatch } from "react-redux";
|
|
|
|
import CommentCard from "comments/CommentCard/CommentCard";
|
|
import AddCommentInput from "comments/inlineComments/AddCommentInput";
|
|
import ScrollToLatest from "./ScrollToLatest";
|
|
|
|
import {
|
|
addCommentToThreadRequest,
|
|
setCommentResolutionRequest,
|
|
} from "actions/commentActions";
|
|
|
|
import useIsScrolledToBottom from "utils/hooks/useIsScrolledToBottom";
|
|
|
|
import { CommentThread } from "entities/Comments/CommentsInterfaces";
|
|
import { RawDraftContentState } from "draft-js";
|
|
|
|
import styled from "styled-components";
|
|
|
|
const ThreadContainer = styled.div`
|
|
width: 400px;
|
|
max-width: 100%;
|
|
`;
|
|
|
|
const CommentsContainer = styled.div<{ inline?: boolean }>`
|
|
position: relative;
|
|
max-height: ${(props) => (!props.inline ? "unset" : "285px")};
|
|
overflow: auto;
|
|
`;
|
|
|
|
const ChildCommentsContainer = styled.div`
|
|
display: flex;
|
|
`;
|
|
|
|
const ChildCommentIndent = styled.div`
|
|
width: 1px;
|
|
background-color: ${(props) =>
|
|
props.theme.colors.comments.childCommentsIndent};
|
|
margin-left: ${(props) => props.theme.spaces[11]}px;
|
|
margin-bottom: ${(props) => props.theme.spaces[7]}px;
|
|
margin-top: ${(props) => props.theme.spaces[5]}px;
|
|
`;
|
|
|
|
const ChildComments = styled.div`
|
|
flex: 1;
|
|
`;
|
|
|
|
function CommentThreadContainer({
|
|
commentThread,
|
|
hideInput,
|
|
inline,
|
|
}: {
|
|
commentThread: CommentThread;
|
|
isOpen?: boolean;
|
|
hideInput?: boolean;
|
|
inline?: boolean;
|
|
}) {
|
|
const dispatch = useDispatch();
|
|
const { comments, id: commentThreadId } = commentThread;
|
|
const messagesBottomRef = useRef<HTMLDivElement>(null);
|
|
const commentsContainerRef = useRef<HTMLDivElement>(null);
|
|
|
|
// Check if the comments window is scrolled to the bottom
|
|
// We don't autoscroll for the user receiving the updates
|
|
// for better UX, instead we'd show a helper message to indicate
|
|
const isScrolledToBottom = useIsScrolledToBottom(commentsContainerRef, [
|
|
comments,
|
|
]);
|
|
|
|
const addComment = (text: RawDraftContentState) => {
|
|
dispatch(
|
|
addCommentToThreadRequest({
|
|
commentThread,
|
|
commentBody: text,
|
|
// scroll to bottom when the user creates a new comment
|
|
// should be called once the comment is rendered on the dom
|
|
callback: scrollToBottom,
|
|
}),
|
|
);
|
|
};
|
|
|
|
const scrollToBottom = () => {
|
|
if (
|
|
typeof messagesBottomRef.current?.scrollIntoView === "function" &&
|
|
inline
|
|
)
|
|
messagesBottomRef.current?.scrollIntoView();
|
|
};
|
|
|
|
const resolveCommentThread = () => {
|
|
dispatch(
|
|
setCommentResolutionRequest({
|
|
threadId: commentThread.id,
|
|
resolved: !commentThread.resolved,
|
|
}),
|
|
);
|
|
};
|
|
|
|
const parentComment = Array.isArray(comments) && comments[0];
|
|
const childComments = Array.isArray(comments) && comments.slice(1);
|
|
|
|
return (
|
|
<ThreadContainer tabIndex={0}>
|
|
<div style={{ position: "relative" }}>
|
|
<CommentsContainer inline={inline} ref={commentsContainerRef}>
|
|
{parentComment && (
|
|
<CommentCard
|
|
comment={parentComment}
|
|
commentThreadId={commentThreadId}
|
|
isParentComment
|
|
key={parentComment.id}
|
|
resolved={!!commentThread.resolved}
|
|
toggleResolved={resolveCommentThread}
|
|
/>
|
|
)}
|
|
{childComments && childComments.length > 0 && (
|
|
<ChildCommentsContainer>
|
|
<ChildCommentIndent />
|
|
<ChildComments>
|
|
{childComments.map((comment) => (
|
|
<CommentCard
|
|
comment={comment}
|
|
commentThreadId={commentThreadId}
|
|
key={comment.id}
|
|
/>
|
|
))}
|
|
</ChildComments>
|
|
</ChildCommentsContainer>
|
|
)}
|
|
<div ref={messagesBottomRef} />
|
|
</CommentsContainer>
|
|
{!isScrolledToBottom && (
|
|
<ScrollToLatest scrollToBottom={scrollToBottom} />
|
|
)}
|
|
</div>
|
|
{!hideInput && <AddCommentInput onSave={addComment} />}
|
|
</ThreadContainer>
|
|
);
|
|
}
|
|
|
|
export default CommentThreadContainer;
|