diff --git a/api/resolvers/item.js b/api/resolvers/item.js index a03a0cf9c..c1f2474cd 100644 --- a/api/resolvers/item.js +++ b/api/resolvers/item.js @@ -739,6 +739,24 @@ export default { homeMaxBoost: homeAgg._max.boost || 0, subMaxBoost: subAgg?._max.boost || 0 } + }, + newComments: async (parent, { rootId, after }, { models, me }) => { + const comments = await itemQueryWithMeta({ + me, + models, + query: ` + ${SELECT} + FROM "Item" + -- comments can be nested, so we need to get all comments that are descendants of the root + ${whereClause( + '"Item".path <@ (SELECT path FROM "Item" WHERE id = $1)', + activeOrMine(me), + '"Item"."created_at" > $2' + )} + ORDER BY "Item"."created_at" ASC` + }, Number(rootId), after) + + return { comments } } }, diff --git a/api/typeDefs/item.js b/api/typeDefs/item.js index a40a99ae1..4d19c7440 100644 --- a/api/typeDefs/item.js +++ b/api/typeDefs/item.js @@ -11,6 +11,7 @@ export default gql` auctionPosition(sub: String, id: ID, boost: Int): Int! boostPosition(sub: String, id: ID, boost: Int): BoostPositions! itemRepetition(parentId: ID): Int! + newComments(rootId: ID, after: Date): Comments! } type BoostPositions { @@ -148,6 +149,7 @@ export default gql` ncomments: Int! nDirectComments: Int! comments(sort: String, cursor: String): Comments! + newComments(rootId: ID, after: Date): Comments! path: String position: Int prior: Int diff --git a/components/comment.js b/components/comment.js index 73e64d0c3..3159026c6 100644 --- a/components/comment.js +++ b/components/comment.js @@ -28,6 +28,7 @@ import LinkToContext from './link-to-context' import Boost from './boost-button' import { gql, useApolloClient } from '@apollo/client' import classNames from 'classnames' +import { ShowNewComments } from './show-new-comments' function Parent ({ item, rootText }) { const root = useRoot() @@ -260,6 +261,11 @@ export default function Comment ({ : !noReply && {root.bounty && !bountyPaid && } +
+ {item.newComments?.length > 0 && ( + + )} +
} {children}
@@ -304,8 +310,9 @@ function ReplyOnAnotherPage ({ item }) { } return ( - + {text} + {item.newComments?.length > 0 &&
} ) } diff --git a/components/comment.module.css b/components/comment.module.css index 6f24ab615..215993d64 100644 --- a/components/comment.module.css +++ b/components/comment.module.css @@ -135,4 +135,27 @@ .comment:has(.comment) + .comment{ padding-top: .5rem; +} + +.newCommentDot { + width: 10px; + height: 10px; + border-radius: 50%; + background-color: var(--bs-primary); + animation: pulse 2s infinite; +} + +@keyframes pulse { + 0% { + background-color: #FADA5E; + opacity: 0.7; + } + 50% { + background-color: #F6911D; + opacity: 1; + } + 100% { + background-color: #FADA5E; + opacity: 0.7; + } } \ No newline at end of file diff --git a/components/comments.js b/components/comments.js index cb5d86416..fa8ce9c7b 100644 --- a/components/comments.js +++ b/components/comments.js @@ -8,6 +8,8 @@ import { defaultCommentSort } from '@/lib/item' import { useRouter } from 'next/router' import MoreFooter from './more-footer' import { FULL_COMMENTS_THRESHOLD } from '@/lib/constants' +import useLiveComments from './use-live-comments' +import { ShowNewComments } from './show-new-comments' export function CommentsHeader ({ handleSort, pinned, bio, parentCreatedAt, commentSats }) { const router = useRouter() @@ -64,9 +66,11 @@ export function CommentsHeader ({ handleSort, pinned, bio, parentCreatedAt, comm export default function Comments ({ parentId, pinned, bio, parentCreatedAt, - commentSats, comments, commentsCursor, fetchMoreComments, ncomments, ...props + commentSats, comments, commentsCursor, fetchMoreComments, ncomments, newComments, lastCommentAt, ...props }) { const router = useRouter() + // fetch new comments that arrived after the lastCommentAt, and update the item.newComments field in cache + useLiveComments(parentId, lastCommentAt || parentCreatedAt, router.query.sort) const pins = useMemo(() => comments?.filter(({ position }) => !!position).sort((a, b) => a.position - b.position), [comments]) @@ -88,6 +92,9 @@ export default function Comments ({ }} /> : null} + {newComments?.length > 0 && ( + + )} {pins.map(item => ( diff --git a/components/header.module.css b/components/header.module.css index 1134e8480..33cf61032 100644 --- a/components/header.module.css +++ b/components/header.module.css @@ -109,4 +109,32 @@ padding-top: 1px; background-color: var(--bs-body-bg); z-index: 1000; -} \ No newline at end of file +} + +.newCommentDot { + width: 10px; + height: 10px; + border-radius: 50%; + background-color: var(--bs-primary); + animation: pulse 2s infinite; +} + +.newCommentDot.paused { + background-color: var(--bs-grey-darkmode); + animation: none; +} + +@keyframes pulse { + 0% { + background-color: #FADA5E; + opacity: 0.7; + } + 50% { + background-color: #F6911D; + opacity: 1; + } + 100% { + background-color: #FADA5E; + opacity: 0.7; + } +} diff --git a/components/item-full.js b/components/item-full.js index 72c60b9c6..5129f55cd 100644 --- a/components/item-full.js +++ b/components/item-full.js @@ -191,6 +191,8 @@ export default function ItemFull ({ item, fetchMoreComments, bio, rank, ...props comments={item.comments.comments} commentsCursor={item.comments.cursor} fetchMoreComments={fetchMoreComments} + newComments={item.newComments} + lastCommentAt={item.lastCommentAt} />
} diff --git a/components/reply.js b/components/reply.js index ec12d0a5f..e89816c70 100644 --- a/components/reply.js +++ b/components/reply.js @@ -13,6 +13,7 @@ import { useRoot } from './root' import { CREATE_COMMENT } from '@/fragments/paidAction' import useItemSubmit from './use-item-submit' import gql from 'graphql-tag' +import { updateAncestorsCommentCount } from '@/lib/comments' export default forwardRef(function Reply ({ item, @@ -82,17 +83,7 @@ export default forwardRef(function Reply ({ const ancestors = item.path.split('.') // update all ancestors - ancestors.forEach(id => { - cache.modify({ - id: `Item:${id}`, - fields: { - ncomments (existingNComments = 0) { - return existingNComments + 1 - } - }, - optimistic: true - }) - }) + updateAncestorsCommentCount(cache, ancestors, 1) // so that we don't see indicator for our own comments, we record this comments as the latest time // but we also have record num comments, in case someone else commented when we did diff --git a/components/show-new-comments.js b/components/show-new-comments.js new file mode 100644 index 000000000..1951b7814 --- /dev/null +++ b/components/show-new-comments.js @@ -0,0 +1,80 @@ +import { useCallback, useMemo } from 'react' +import { useApolloClient } from '@apollo/client' +import { COMMENT_WITH_NEW_RECURSIVE } from '../fragments/comments' +import styles from './comment.module.css' +import { itemUpdateQuery, commentUpdateFragment } from './use-live-comments' +import { updateAncestorsCommentCount } from '@/lib/comments' + +function prepareComments (client, newComments) { + return (data) => { + // newComments is an array of comment ids that allows us + // to read the latest newComments from the cache, guaranteeing that we're not reading stale data + const freshNewComments = newComments.map(id => { + const fragment = client.cache.readFragment({ + id: `Item:${id}`, + fragment: COMMENT_WITH_NEW_RECURSIVE, + fragmentName: 'CommentWithNewRecursive' + }) + + if (!fragment) { + return null + } + + return fragment + }).filter(Boolean) + + // count the total number of new comments including its nested new comments + let totalNComments = freshNewComments.length + for (const comment of freshNewComments) { + totalNComments += (comment.ncomments || 0) + } + + // update all ancestors, but not the item itself + const ancestors = data.path.split('.').slice(0, -1) + updateAncestorsCommentCount(client.cache, ancestors, totalNComments) + + return { + ...data, + comments: { ...data.comments, comments: [...freshNewComments, ...data.comments.comments] }, + ncomments: data.ncomments + totalNComments, + newComments: [] + } + } +} + +// ShowNewComments is a component that dedupes, refreshes and injects newComments into the comments field +export function ShowNewComments ({ topLevel = false, comments, newComments = [], itemId, sort }) { + const client = useApolloClient() + + const dedupedNewComments = useMemo(() => { + const existingIds = new Set(comments.map(c => c.id)) + return newComments.filter(id => !existingIds.has(id)) + }, [newComments, comments]) + + const showNewComments = useCallback(() => { + // fetch the latest version of the comments from the cache by their ids + const payload = prepareComments(client, dedupedNewComments) + + if (topLevel) { + itemUpdateQuery(client, itemId, sort, payload) + } else { + commentUpdateFragment(client, itemId, payload) + } + }, [client, itemId, dedupedNewComments, topLevel, sort]) + + if (dedupedNewComments.length === 0) { + return null + } + + return ( +
+ {dedupedNewComments.length > 1 + ? `${dedupedNewComments.length} new comments` + : 'show new comment'} +
+
+ ) +} diff --git a/components/use-live-comments.js b/components/use-live-comments.js new file mode 100644 index 000000000..f5396444a --- /dev/null +++ b/components/use-live-comments.js @@ -0,0 +1,133 @@ +import { useQuery, useApolloClient } from '@apollo/client' +import { SSR } from '../lib/constants' +import { GET_NEW_COMMENTS, COMMENT_WITH_NEW_LIMITED, COMMENT_WITH_NEW_RECURSIVE } from '../fragments/comments' +import { ITEM_FULL } from '../fragments/items' +import { useEffect, useRef, useState } from 'react' + +const POLL_INTERVAL = 1000 * 10 // 10 seconds + +// useLiveComments fetches new comments under an item (rootId), that arrives after the latest comment createdAt +// and inserts them into the newComment client field of their parent comment/post. +export default function useLiveComments (rootId, after, sort) { + const client = useApolloClient() + const [latest, setLatest] = useState(after) + const queue = useRef([]) + + const { data } = useQuery(GET_NEW_COMMENTS, SSR + ? {} + : { + pollInterval: POLL_INTERVAL, + // only get comments newer than the passed latest timestamp + variables: { rootId, after: latest }, + nextFetchPolicy: 'cache-and-network' + }) + + useEffect(() => { + if (!data?.newComments) return + + // sometimes new comments can arrive as orphans because their parent might not be in the cache yet + // queue them up, retry until the parent shows up. + const newComments = [...data.newComments.comments, ...queue.current] + const { queuedComments } = cacheNewComments(client, rootId, newComments, sort) + + // keep the queued comments for the next poll + queue.current = queuedComments + + // update latest timestamp to the latest comment created at + setLatest(prevLatest => getLatestCommentCreatedAt(data.newComments.comments, prevLatest)) + }, [data, client, rootId, sort]) + + // cleanup queue on unmount to prevent memory leaks + useEffect(() => { + return () => { + queue.current = [] + } + }, []) +} + +// the item query is used to update the item's newComments field +export function itemUpdateQuery (client, id, sort, fn) { + client.cache.updateQuery({ + query: ITEM_FULL, + // updateQuery needs the correct variables to update the correct item + // the Item query might have the router.query.sort in the variables, so we need to pass it in if it exists + variables: sort ? { id, sort } : { id } + }, (data) => { + if (!data) return data + return { item: fn(data.item) } + }) +} + +// update the newComments field of a nested comment fragment +export function commentUpdateFragment (client, id, fn) { + let result = client.cache.updateFragment({ + id: `Item:${id}`, + fragment: COMMENT_WITH_NEW_RECURSIVE, + fragmentName: 'CommentWithNewRecursive' + }, (data) => { + if (!data) return data + return fn(data) + }) + + // sometimes comments can reach their depth limit, and lack adherence to the CommentsRecursive fragment + // for this reason, we update the fragment with a limited version that only includes the CommentFields fragment + if (!result) { + result = client.cache.updateFragment({ + id: `Item:${id}`, + fragment: COMMENT_WITH_NEW_LIMITED, + fragmentName: 'CommentWithNewLimited' + }, (data) => { + if (!data) return data + return fn(data) + }) + } + + return result +} + +function cacheNewComments (client, rootId, newComments, sort) { + const queuedComments = [] + + for (const newComment of newComments) { + const { parentId } = newComment + const topLevel = Number(parentId) === Number(rootId) + + // if the comment is a top level comment, update the item + if (topLevel) { + // merge the new comment into the item's newComments field, checking for duplicates + itemUpdateQuery(client, rootId, sort, (data) => mergeNewComment(data, newComment)) + } else { + // if the comment is a reply, update the parent comment + // merge the new comment into the parent comment's newComments field, checking for duplicates + const result = commentUpdateFragment(client, parentId, (data) => mergeNewComment(data, newComment)) + + if (!result) { + // parent not in cache, queue for retry + queuedComments.push(newComment) + } + } + } + + return { queuedComments } +} + +// merge new comment into item's newComments +// and prevent duplicates by checking if the comment is already in item's newComments or existing comments +function mergeNewComment (item, newComment) { + const existingNewComments = item.newComments || [] + const existingComments = item.comments?.comments || [] + + // is the incoming new comment already in item's new comments or existing comments? + if (existingNewComments.includes(newComment.id) || existingComments.some(c => c.id === newComment.id)) { + return item + } + + return { ...item, newComments: [...existingNewComments, newComment.id] } +} + +function getLatestCommentCreatedAt (comments, latest) { + return comments.reduce( + (max, { createdAt }) => (createdAt > max ? createdAt : max), + latest + ) +} diff --git a/fragments/comments.js b/fragments/comments.js index 2fd28d0f1..06b1605cb 100644 --- a/fragments/comments.js +++ b/fragments/comments.js @@ -47,6 +47,7 @@ export const COMMENT_FIELDS = gql` otsHash ncomments nDirectComments + newComments @client imgproxyUrls rel apiKey @@ -116,3 +117,55 @@ export const COMMENTS = gql` } } }` + +export const COMMENT_WITH_NEW_RECURSIVE = gql` + ${COMMENT_FIELDS} + ${COMMENTS} + + fragment CommentWithNewRecursive on Item { + ...CommentFields + comments { + comments { + ...CommentsRecursive + } + } + newComments @client + } +` + +export const COMMENT_WITH_NEW_LIMITED = gql` + ${COMMENT_FIELDS} + + fragment CommentWithNewLimited on Item { + ...CommentFields + comments { + comments { + ...CommentFields + } + } + newComments @client + } +` + +// TODO: fragment for comments without item.comments field +// TODO: remove if useless to pursue +export const COMMENT_WITH_NEW = gql` + ${COMMENT_FIELDS} + + fragment CommentWithNew on Item { + ...CommentFields + newComments @client + } +` + +export const GET_NEW_COMMENTS = gql` + ${COMMENTS} + + query GetNewComments($rootId: ID, $after: Date) { + newComments(rootId: $rootId, after: $after) { + comments { + ...CommentsRecursive + } + } + } +` diff --git a/fragments/items.js b/fragments/items.js index 151587a20..95eed0421 100644 --- a/fragments/items.js +++ b/fragments/items.js @@ -59,6 +59,7 @@ export const ITEM_FIELDS = gql` bio ncomments nDirectComments + newComments @client commentSats commentCredits lastCommentAt diff --git a/lib/apollo.js b/lib/apollo.js index 3739ba3fd..dc7b8127b 100644 --- a/lib/apollo.js +++ b/lib/apollo.js @@ -313,6 +313,11 @@ function getClient (uri) { } } }, + newComments: { + read (newComments) { + return newComments || [] + } + }, meAnonSats: { read (existingAmount, { readField }) { if (SSR) return null diff --git a/lib/comments.js b/lib/comments.js new file mode 100644 index 000000000..b41e5c754 --- /dev/null +++ b/lib/comments.js @@ -0,0 +1,14 @@ +export function updateAncestorsCommentCount (cache, ancestors, increment) { + // update all ancestors + ancestors.forEach(id => { + cache.modify({ + id: `Item:${id}`, + fields: { + ncomments (existingNComments = 0) { + return existingNComments + increment + } + }, + optimistic: true + }) + }) +}