comments: Add proposal author updates. #2549

amass01 · 2021-08-26T11:44:06Z

Spec

Proposal authors need to be able to give periodic updates on the status
of their proposal. These updates will be given as comments. The Politeia
users will have the ability to interact with the author and ask further
questions.

Before this commit, once a proposal vote has finished the proposal is
locked and no additional comments can be made. This commit changes
that to the following:

Once a proposal vote has finished, all existing comment threads are
locked.
When a proposal author wants to give an update they will start a new
comment thread. The author is the only user that will have the
ability to start a new comment thread once the voting period has
finished. Each update will have an author provided title.
Anyone can reply to any comments in the thread and can cast
upvotes/downvotes for any comments in the thread.
The comment thread will remain open until either the author starts a
new update thread or an admin marks the proposal as
closed/completed.

implementation

Each update is shown as its own comment section. The updates will be
displayed from newest to oldest.
Each author update has a title - comment form updated & title
displayed if the comment in an author update.
This diff refactors/normalizes the comments redux state, by
storing the comments as a map vs as an array before this.
This improves the performance and avoids extra expensive
re-renders on the containers level where they need to process the
comments array to split the comments to different sections in case
the proposal has author updates which are separated threads from
the main comments thread.

Closes #2547.
Closes #2570.
Depends on decred/politeia#1491.

src/actions/api.js

available

amass01 · 2021-09-02T22:33:12Z

src/containers/Proposal/Detail/Detail.jsx

+        <Card className={classNames("container", styles.commentsHeaderWrapper)}>
+          <LoggedInContent
+            fallback={
+              <WhatAreYourThoughts
+                onLoginClick={handleOpenLoginModal}
+                onSignupClick={onRedirectToSignup}
+              />
+            }>
+            <Or>
+              {readOnly && (
+                <Message kind="blocked" title="Comments are not allowed">
+                  {readOnlyReason}
+                </Message>
+              )}
+              {!isPaid && paywallEnabled && currentUser && (
+                <Message kind="error">
+                  <P>
+                    You won't be able to submit comments or proposals before
+                    paying the paywall, please visit your{" "}
+                    <Link to={`/user/${userid}?tab=credits`}>account</Link> page
+                    to correct this problem.
+                  </P>
+                </Message>
+              )}
+              {!readOnly && !!identityError && <IdentityMessageError />}
+              {areAuthorUpdatesAllowed && !isCurrentUserProposalAuthor && (
+                <Message>
+                  Replies & upvotes/downvotes are allowed only on the latest
+                  author update thread.
+                </Message>
+              )}
+            </Or>
+            {!isSingleThread &&
+              (!readOnly ||
+                (areAuthorUpdatesAllowed && isCurrentUserProposalAuthor)) &&
+              proposalToken && (
+                <CommentForm
+                  persistKey={`commenting-on-${tokenFromUrl}`}
+                  onSubmit={handleSubmitComment}
+                  disableSubmit={!!identityError || paywallMissing}
+                  isAuthorUpdate={
+                    areAuthorUpdatesAllowed && isCurrentUserProposalAuthor
+                  }
+                />
+              )}
+          </LoggedInContent>
+          {commentsError && (
+            <Message kind="error" className="margin-top-m">
+              {commentsError.toString()}
+            </Message>
+          )}
+        </Card>


This used to be in container/Comments/Comments.jsx but as it could be displayed now multiple times for each
author update section this logic moved to container/Proposal/Detail/Details.jsx as it should be displayed
once in the proposal details page.

amass01

just found a bug when viewing single thread using comment specific link while having multiple author update threads

amass01 · 2021-09-03T13:50:27Z

just found a bug when viewing single thread using comment specific link while having multiple author update threads

Fixed.

Another minor bug I just found, if proposal author posts a new author update it goes to the bottom while
it should show up as the first section.

amass01 · 2021-09-03T19:34:43Z

Another minor bug I just found, if proposal author posts a new author update it goes to the bottom while
it should show up as the first section.

Fixed.

lukebp

Comment plugin errors need human readable messages. Note, this error was caused by me not having my comments allowextradata plugin setting set to true, so it was not caused by something in this PR.

The update title should be the title for the comments section, not in the comment itself. Example: the Comments text from Comments (1) in the image below should be the update title.

If I was a proposal author that was using this feature for the first time, I would not really know how to use it. The rules of proposal updates are not clear from the existing UX. Here are some things I think a first time user would struggle with.

How am I suppose to know that the comment markdown editor is suppose to be used for proposal updates? It looks like I'm leaving a normal comment. I probably wouldn't know that this is for author updates only and would likely assume that this is availble for every user.
How would I know that creating a new update locks the old thread? I would probably assume that I can use this like normal comments, which could lead to me creating multiple updates instead of replying to comments in the original thread.

We should talk through the UX for this in the pi-dev channel.

Everything else appears to be working nicely. We just need to work through some of these UX details.

amass01 · 2021-09-06T18:31:14Z

1. Comment plugin errors need human readable messages.  Note, this error was caused by me not having my comments `allowextradata` plugin setting set to true, so it was not caused by something in this PR.

Addressed.

author update comments section.

amass01 · 2021-09-06T20:00:07Z

The update title should be the title for the comments section, not in the comment itself. Example: the Comments text from Comments (1) in the image below should be the update title.

Addressed.

info for the author about the feature.

lukebp · 2021-09-06T22:18:03Z

tmp.mp4

amass01 · 2021-09-14T11:49:12Z

* Comments are getting cleared after the logout action.

Same on master, opening a separate PR with a fix.

amass01 · 2021-09-14T13:23:58Z

* Comments are getting cleared after the logout action.
Same on master, opening a separate PR with a fix.

Fixed on #2582.

amass01 · 2021-09-15T12:11:42Z

e2e tests added ✅

victorgcramos

Hey @amass01 thanks for the PR. Code is looking clean and good. Thanks for addressing my comments. Left minor inline comment regarding mocking test data.

Also, I think you could add more e2e tests to cover more actions over the author updates, for example:

If I submit an author update for the first time, will the author updates be listed correctly?
Submitting a new update locks the previous thread?
Can I submit author updates on not approved proposals?
Can I upvote/downvote an author update?
Should I be able to reply author updates?

You can open an issue to track these e2e tests if you think it's more appropriate, but I think they would be a good addition :D

teste2e/cypress/e2e/comments/authorUpdates.js

amass01 · 2021-09-15T19:30:46Z

Also, I think you could add more e2e tests to cover more actions over the author updates, for example:
* If I submit an author update for the first time, will the author updates be listed correctly?

* Submitting a new update locks the previous thread?

* Can I submit author updates on not approved proposals?

* Can I upvote/downvote an author update?

* Should I be able to reply author updates?
You can open an issue to track these e2e tests if you think it's more appropriate, but I think they would be a good addition :D

I already cover the following two:

If I submit an author update for the first time, will the author updates be listed correctly?
Should I be able to reply author updates?

But I also cover more:

Normal user can't post normal comment on approved proposal and only reply on author update
thread
Proposal author can post new author updates but not normal comments on approved proposal.

I think this is more than enough for the scope of this PR and of course we can add more
in the future.

lukebp · 2021-09-16T01:22:16Z

Is this ready for a final review?

amass01 · 2021-09-16T09:12:14Z

@lukebp yep

lukebp

tACK

Nice work @amass01. This is looking real nice.

Needs final code approval from @tiagoalvesdulce. @victorgcramos can you also give this a final review?

victorgcramos

LGTM! Good job on e2e tests cleanup!

tiagoalvesdulce

The PR is looking pretty good. Great job! I left a few comments.

src/containers/Comments/CommentsList/CommentsListWrapper.jsx

src/containers/Comments/Comment/CommentWrapper.jsx

src/containers/Comments/Download/hooks.js

tiagoalvesdulce · 2021-09-18T02:12:48Z

src/containers/Comments/helpers.js

+  }
+
+  // Convert comment array to a map
+  const commentsMap = comments.reduce((map, comment) => {


src/helpers.js

src/hooks/api/useComments.js

tiagoalvesdulce

tACK

amass01 added 2 commits August 26, 2021 14:42

enable author updates on approved proposals

c538acd

bug fixes & cleanup

abda44a

amass01 commented Aug 26, 2021

View reviewed changes

src/actions/api.js Outdated Show resolved Hide resolved

amass01 added 8 commits August 26, 2021 21:43

allow replies only on latest author update

d81b762

allow replies only on the latest author update thread

60395bb

if author updates allowed display comment form only to record author

d3c40cf

add an XXX as a reminder to consider the billing status when it's

1ed1331

available

enable comment votes only on latest author update thread

b9ba6d9

visually indicate author updates.

087bb2d

[wip] display each author update in a separate comments section

ebb26c7

styling, cleanup & bug fixes

e1ad910

amass01 commented Sep 2, 2021

View reviewed changes

yarn prettify

3c9502a

amass01 changed the title ~~[wip] comments: Add proposal author updates.~~ comments: Add proposal author updates. Sep 2, 2021

amass01 marked this pull request as ready for review September 2, 2021 22:36

amass01 commented Sep 2, 2021

View reviewed changes

amass01 added 2 commits September 3, 2021 13:51

Merge branch 'master' into authoruodates

19a4e29

single thread tweaks and fixes

7c08970

amass01 added 2 commits September 3, 2021 16:56

fix document.getElementById is undefined in scrollToElement.

812efeb

add new author updates to the top

108d345

lukebp requested changes Sep 6, 2021

View reviewed changes

map backend extra data not allowed error code

b2b3fce

replace Comment $numofcomments with $updatetitle $numofcomments for

ffdba8a

author update comments section.

display a tooltip next to the author update title with

cc91d16

info for the author about the feature.

tooltip tweaks

56189bc

amass01 added 2 commits September 14, 2021 12:48

move useComments to global hooks dir

491cb7a

typo

95a7f44

amass01 added 3 commits September 14, 2021 16:25

Merge branch 'master' into authoruodates

0faa540

add entity dirs for e2e tests.

dca90eb

e2e: Add author update thread e2e tests.

c02c8ff

opps

562792c

victorgcramos mentioned this pull request Sep 15, 2021

proposal: Data persistence after unvetted logout. #2585

Merged

tiny cleanup

0f885ec

victorgcramos approved these changes Sep 15, 2021

View reviewed changes

teste2e/cypress/e2e/comments/authorUpdates.js Outdated Show resolved Hide resolved

add summaries mock as middleware

1fb3fe3

lukebp approved these changes Sep 16, 2021

View reviewed changes

victorgcramos approved these changes Sep 16, 2021

View reviewed changes

This was referenced Sep 17, 2021

fix: Show login modal when user session expires. #2541

Merged

fix: Under Review pagination issues for big screens. #2581

Merged

tiagoalvesdulce requested changes Sep 18, 2021

View reviewed changes

amass01 added 2 commits September 18, 2021 12:29

code review nits

0b63edc

cleanup unnecessary useMemo usage.

83446c9

tiagoalvesdulce approved these changes Sep 20, 2021

View reviewed changes

tiagoalvesdulce merged commit 0c1f08e into decred:master Sep 20, 2021

tiagoalvesdulce added the pi-not-deployed label Sep 20, 2021

amass01 deleted the authoruodates branch September 20, 2021 15:01

This was referenced Sep 24, 2021

Testing v1.2.0 release. #2597

Closed

fix: Comments timestamp download infinite loop #2608

Merged

victorgcramos mentioned this pull request Oct 18, 2021

Re-rendering and page positioning issues. #2615

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

comments: Add proposal author updates. #2549

comments: Add proposal author updates. #2549

amass01 commented Aug 26, 2021 •

edited

Loading

amass01 Sep 2, 2021 •

edited

Loading

amass01 left a comment

amass01 commented Sep 3, 2021

amass01 commented Sep 3, 2021

lukebp left a comment

amass01 commented Sep 6, 2021

amass01 commented Sep 6, 2021

lukebp commented Sep 6, 2021

amass01 commented Sep 14, 2021

amass01 commented Sep 14, 2021

amass01 commented Sep 15, 2021

victorgcramos left a comment

amass01 commented Sep 15, 2021 •

edited

Loading

lukebp commented Sep 16, 2021

amass01 commented Sep 16, 2021

lukebp left a comment

victorgcramos left a comment

tiagoalvesdulce left a comment

tiagoalvesdulce Sep 18, 2021

tiagoalvesdulce left a comment

comments: Add proposal author updates. #2549

comments: Add proposal author updates. #2549

Conversation

amass01 commented Aug 26, 2021 • edited Loading

amass01 Sep 2, 2021 • edited Loading

Choose a reason for hiding this comment

amass01 left a comment

Choose a reason for hiding this comment

amass01 commented Sep 3, 2021

amass01 commented Sep 3, 2021

lukebp left a comment

Choose a reason for hiding this comment

amass01 commented Sep 6, 2021

amass01 commented Sep 6, 2021

lukebp commented Sep 6, 2021

amass01 commented Sep 14, 2021

amass01 commented Sep 14, 2021

amass01 commented Sep 15, 2021

victorgcramos left a comment

Choose a reason for hiding this comment

amass01 commented Sep 15, 2021 • edited Loading

lukebp commented Sep 16, 2021

amass01 commented Sep 16, 2021

lukebp left a comment

Choose a reason for hiding this comment

victorgcramos left a comment

Choose a reason for hiding this comment

tiagoalvesdulce left a comment

Choose a reason for hiding this comment

tiagoalvesdulce Sep 18, 2021

Choose a reason for hiding this comment

tiagoalvesdulce left a comment

Choose a reason for hiding this comment

amass01 commented Aug 26, 2021 •

edited

Loading

amass01 Sep 2, 2021 •

edited

Loading

amass01 commented Sep 15, 2021 •

edited

Loading