Save drafts of comments #1994

grokys · 2018-10-17T10:27:57Z

Save drafts of inline comments, PR reviews and PRs.

Note: This feature required a refactoring of the comment view models because they now need async initialization and to be available from GitHub.App. This part of the PR has been submitted separately as #1993 to ease review. The two PRs can alternatively be reviewed as one if that's more convenient.

As described in #1905, it is easy to lose a comment that you're working on if you close the diff view accidentally. This PR saves drafts of comments as they are being written to an SQLite database.

In addition to saving drafts of inline comments, it also saves comments to PR reviews and PRs themselves.

The comments are written to an SQLite database directly instead of going through Akavache because in the case of inline reviews, there can be many drafts in progress on a separate file. When a diff is opened we need to look for any comments present on that file and show the most recent. That use-case didn't fit well with Akavache (being a pure key/value store).

Testing

Inline Comments

Open a PR
Open the diff of a file
Start adding a comment
Close the comment by closing the peek view, or the document tab
Reopen the diff
You should see the comment displayed in edit mode with the draft of the comment you were previously writing

PR reviews

Open a PR
Click "Add your review"
Start adding a review
Click the "Back" button and navigate to a different PR
Click the "Back" button and navigate to the original PR
Click "Add your review"
You should see the the draft of the review you were previously writing

PRs

Click "Create new" at the top of the PR list
Start adding a PR title/description
Close VS
Restart VS and click "Create new" again
You should see the the draft of the PR you were previously writing

Depends on #1993
Fixes #1905

- Renamed `InlineCommentThreadViewModel` -> `PullRequestReviewCommentThreadViewModel` - Moved `PullRequestReviewCommentThreadViewModel` to GitHub.App - Make comment view models MEF creatable - Add `InitializeAsync` methods to initialize them with data.

So that it can be used everywhere. Had to refactor it slightly to remove some dependencies.

codecov · 2018-10-18T09:08:26Z

Codecov Report

Merging #1994 into master will decrease coverage by 1.17%.
The diff coverage is 56.56%.

@@            Coverage Diff             @@
##           master    #1994      +/-   ##
==========================================
- Coverage   40.51%   39.34%   -1.18%     
==========================================
  Files         372      410      +38     
  Lines       16099    17573    +1474     
  Branches     2216     2425     +209     
==========================================
+ Hits         6523     6914     +391     
- Misses       9054    10112    +1058     
- Partials      522      547      +25

Impacted Files	Coverage Δ
...rc/GitHub.App/Services/InlineCommentPeekService.cs	`0% <0%> (ø)`
src/GitHub.App/Services/SqliteMessageDraftStore.cs	`0% <0%> (ø)`
...ub.InlineReviews/Peek/InlineCommentPeekableItem.cs	`0% <0%> (ø)`	⬆️
...Reviews/Commands/InlineCommentNavigationCommand.cs	`0% <0%> (ø)`	⬆️
...ub.InlineReviews/Tags/InlineCommentGlyphFactory.cs	`0% <0%> (ø)`	⬆️
...GitHub.App/Models/Drafts/PullRequestReviewDraft.cs	`100% <100%> (ø)`
...neReviews/ViewModels/InlineCommentPeekViewModel.cs	`76.23% <100%> (-1.24%)`	⬇️
...App/Models/Drafts/PullRequestReviewCommentDraft.cs	`100% <100%> (ø)`
...pp/ViewModels/PullRequestReviewCommentViewModel.cs	`94.87% <100%> (+0.13%)`	⬆️
src/GitHub.App/Models/Drafts/PullRequestDraft.cs	`100% <100%> (ø)`
... and 51 more

meaghanlewis · 2018-10-18T20:32:01Z

This is looking great! Really enjoying using this feature so far.

When leaving an inline comment, the comment posts successfully and then a new comment is drafted with the same text.

If I leave a review comment, I'm still given the option to start a review and selecting that option throws an error.

- Make posting a PR review comment delete the draft - Remove the placeholder logic from `InlineCommentPeekViewModel` as this is now handled by the draft system

grokys · 2018-10-19T10:39:31Z

Oops, sorry about that @meaghanlewis - I was sure I tested those things, but must have got messed up again at some point. Should be fixed now.

meaghanlewis · 2018-10-19T22:29:02Z

Thanks @grokys. This looks great to me.

jcansdale · 2018-10-26T16:07:54Z

All of the inline comment stuff seems to be working great! I cloned and opened solutions and my comments are still there. 🎉

With the pull request saving functionality, I tried the following:

Create a new pull request:
Pull request created
Click Create New again

The details from the previously created pull request are restored.

Are you missing a clear when a pull request is created?

jcansdale

This is looking great!

Just a few comments on the tests. Is WithScheduler still necessary? There are a bunch of tests that still use it. I few other minor commands inline on the tests.

jcansdale · 2018-10-26T16:33:47Z

test/GitHub.App.UnitTests/ViewModels/CommentThreadViewModelTests.cs

+        [Test]
+        public async Task SavesDraftForEditingComment()
+        {
+            using (TestUtils.WithScheduler(Scheduler.CurrentThread))


Do we still need to use WithScheduler after your unit testing fix?

jcansdale · 2018-10-26T16:35:48Z

test/GitHub.App.UnitTests/ViewModels/PullRequestReviewCommentThreadViewModelTests.cs

@@ -115,6 +171,13 @@ IEnumerable<InlineCommentModel> CreateComments(params string[] bodies)
            }
        }

+        IPullRequestSessionFile CreateFile(string relativePath = "file.cs")


This can be static.

jcansdale · 2018-10-26T16:36:10Z

test/GitHub.App.UnitTests/ViewModels/PullRequestReviewCommentThreadViewModelTests.cs

+            result.RelativePath.Returns(relativePath);
+            return result;
+        }
+
        IViewViewModelFactory CreateFactory()


This can be static.

jcansdale · 2018-10-26T16:36:43Z

test/GitHub.InlineReviews.UnitTests/ViewModels/InlineCommentPeekViewModelTests.cs

@@ -327,12 +291,13 @@ InlineCommentModel CreateComment(string body)

        IViewViewModelFactory CreateFactory()


This can be static.

jcansdale · 2018-10-26T16:37:28Z

test/GitHub.InlineReviews.UnitTests/ViewModels/NewInlineCommentThreadViewModelTests.cs

@@ -0,0 +1,165 @@
+////using System.Collections.Generic;


Looks like commented out test file has come back?

No longer needed after #1997.

jcansdale

This is looking good. LGTM!

grokys added 11 commits October 12, 2018 20:06

Refactor comment view models.

c7c7d25

- Renamed `InlineCommentThreadViewModel` -> `PullRequestReviewCommentThreadViewModel` - Moved `PullRequestReviewCommentThreadViewModel` to GitHub.App - Make comment view models MEF creatable - Add `InitializeAsync` methods to initialize them with data.

Added SqliteMessageDraftStore.

04e6a90

Save/load drafts for new PR review theads.

ad7d558

Move InlineCommentPeekService to GitHub.App.

208710a

So that it can be used everywhere. Had to refactor it slightly to remove some dependencies.

Display most recent draft when diff opened.

8bddb0d

Display drafts for replies.

b6debc7

Don't save drafts for edits.

0e58e32

Select draft text when shown.

832ee25

Added drafts to PR review authoring.

e0c04fa

Added drafts to PR creation.

fecdccf

Create drafts database if necessary.

a07d4eb

grokys mentioned this pull request Oct 17, 2018

Refactor comment view models. #1993

Merged

grokys requested review from StanleyGoldman, meaghanlewis and jcansdale October 17, 2018 10:37

FIx failing tests.

5ec3659

Excluding sqlite-net from codecov reports

447b30a

grokys added 2 commits October 19, 2018 11:43

Fix drafts being retained after submission.

265e2dc

- Make posting a PR review comment delete the draft - Remove the placeholder logic from `InlineCommentPeekViewModel` as this is now handled by the draft system

Fix pending reviews.

b58774f

meaghanlewis added the verified label Oct 19, 2018

Merge branch 'master' into feature/save-drafts

73b2275

jcansdale suggested changes Oct 26, 2018

View reviewed changes

grokys added 3 commits October 29, 2018 11:31

Remove TestUtils.WithScheduler.

428ddd7

No longer needed after #1997.

Fix various CA warnings in tests.

55d6564

Removed unused file.

6c0855e

grokys and others added 2 commits October 29, 2018 11:44

Close PR creation view when PR submitted.

857f094

Merge branch 'master' into feature/save-drafts

f93fdf4

jcansdale approved these changes Oct 29, 2018

View reviewed changes

jcansdale merged commit 82a2ccd into master Oct 29, 2018

jcansdale deleted the feature/save-drafts branch October 29, 2018 13:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Save drafts of comments #1994

Save drafts of comments #1994

grokys commented Oct 17, 2018 •

edited

Loading

codecov bot commented Oct 18, 2018 •

edited

Loading

meaghanlewis commented Oct 18, 2018

grokys commented Oct 19, 2018

meaghanlewis commented Oct 19, 2018

jcansdale commented Oct 26, 2018 •

edited

Loading

jcansdale left a comment

jcansdale Oct 26, 2018

jcansdale Oct 26, 2018

jcansdale Oct 26, 2018

jcansdale Oct 26, 2018

jcansdale Oct 26, 2018

jcansdale left a comment

		@@ -327,12 +291,13 @@ InlineCommentModel CreateComment(string body)

		IViewViewModelFactory CreateFactory()

Save drafts of comments #1994

Save drafts of comments #1994

Conversation

grokys commented Oct 17, 2018 • edited Loading

Testing

Inline Comments

PR reviews

PRs

codecov bot commented Oct 18, 2018 • edited Loading

Codecov Report

meaghanlewis commented Oct 18, 2018

grokys commented Oct 19, 2018

meaghanlewis commented Oct 19, 2018

jcansdale commented Oct 26, 2018 • edited Loading

jcansdale left a comment

Choose a reason for hiding this comment

jcansdale Oct 26, 2018

Choose a reason for hiding this comment

jcansdale Oct 26, 2018

Choose a reason for hiding this comment

jcansdale Oct 26, 2018

Choose a reason for hiding this comment

jcansdale Oct 26, 2018

Choose a reason for hiding this comment

jcansdale Oct 26, 2018

Choose a reason for hiding this comment

jcansdale left a comment

Choose a reason for hiding this comment

grokys commented Oct 17, 2018 •

edited

Loading

codecov bot commented Oct 18, 2018 •

edited

Loading

jcansdale commented Oct 26, 2018 •

edited

Loading