Codestin Search App

cheap-glitch · 2020-11-07T14:58:23Z

Thanks for contributing! 🍄

LINKED ISSUES: Add unfinished-comments feature #3694 (cf. this comment)
TEST URLS: Improve unfinished-comments detection logic #3707
SCREENSHOT: n/a

cheap-glitch · 2020-11-07T15:38:38Z

The feature should now work correctly in both of these cases:

when a comment is submitted from a hidden tab
when a comment is submitted from a hidden tab but there are still some drafts in the page

cheap-glitch · 2020-11-07T16:05:18Z

-		documentTitle = undefined;
-	} else if (document.visibilityState === 'hidden' && hasDraftComments()) {
+function updateDocumentTitle(): void {
+	if (document.visibilityState === 'hidden' && hasDraftComments() && !documentTitle) {


I know it's ugly, but the nested if was here to account for the case where a comment is sent from a hidden tab but there are still drafts somewhere on the page (and thus the title shouldn't be reset).
But maybe this possibility doesn't exist in the first place?

You're right, the 2 conditions aren't equivalent when "is hidden, has draft and has a documentTitle". I don't know if it matters at the moment because the change doesn't fix the issue, as mentioned in the other comment.

fregante · 2020-11-07T17:36:05Z

I tested both your last commit and my commit, and neither one actually catch the situation described by #3694 (comment)

submit might happen when the user is still on the page, but the page can be updated when it's hidden.

If possible, perhaps, the easier way is to exclude "sending" textareas in hasDraftComments, example:

	return select.all('textarea').some(textarea => textarea.value.length > 0 && textarea.offsetWidth > 0 && !textarea.closest('.is-sending')); // made-up class

cheap-glitch · 2020-11-07T19:14:47Z

If possible, perhaps, the easier way is to exclude "sending" textareas in hasDraftComments

So the solution would be to mark the submitted forms with a class/attribute in the submit listener?

fregante · 2020-11-08T08:02:41Z

I expect GitHub to already be doing that, so look for such a class in the dom first.

cheap-glitch · 2020-11-08T14:32:07Z

I expect GitHub to already be doing that, so look for such a class in the dom first.

Maybe I didn't look in the right place, but I found no such class.

EDIT: I went ahead and implemented a proper fix using a custom class to tag the sending forms. Tested in both Firefox and Chromium and it works as expected.

fregante · 2020-11-09T03:43:36Z

Maybe I didn't look in the right place, but I found no such class.

The fields and forms don't appear to have the class, but what do you think about looking for non-disabled Comment buttons instead? This slightly complicates the selector to cover the various types of comments and merge commits descriptions, but we wouldn't have to check the content nor the visibility.

Example:

cheap-glitch · 2020-11-09T10:45:59Z

The fields and forms don't appear to have the class, but what do you think about looking for non-disabled Comment buttons instead?

After a few quick tests, I see two problems with this approach:

There are a lot of buttons with the same (or very similar) attributes as the Comment buttons, and those are not disabled but simply hidden. I'm afraid we would still have to rely on checking visibility, parent elements or text content and that would complicate things quickly.
The Comment buttons associated with replies to code comments never get disabled (at least on Firefox) even when the corresponding textareas are hidden, blurred and/or empty — except for a very brief moment when the comment is posted.

fregante

Ok I found a solution for the class removal.

fregante · 2020-11-17T01:51:04Z

+	return select.all<HTMLTextAreaElement>('textarea:not([disabled])').some(textarea =>
+		textarea.value !== textarea.textContent && // Exclude comments being edited but not yet changed (and empty comment fields)
+		textarea.offsetWidth > 0 && // Exclude invisible fields
+		!textarea.closest('.rgh-is-sending-comment') // Exclude forms being submitted


I think this would cover:

regular comments

review comments

PR merges

Suggested change

!textarea.closest('.rgh-is-sending-comment') // Exclude forms being submitted

select.exists('.btn-primary[disabled]', textarea.form!);

This reads as: if the form of the current textarea (which is filled, changed, and visible) contains a disabled "submit" button, then the textarea is being sent.

I'm not sure if the selector needs to be tweaked.

Tested all three cases and they work great! Although the feature doesn't work when creating a new issue/PR — but I don't think it was the goal in the first place?

I think that's just due to pageDetect.hasComments. Perhaps the correct one is hasRichTextEditor

fregante · 2020-11-23T20:34:12Z

Thanks @cheap-glitch!

cheap-glitch added 6 commits November 7, 2020 15:53

Reset document title when comment is posted

5dc7858

Remove useless async

4e92c8d

Handle case where comment is published but there's still draft(s)

fb747c8

Simplify code

8d1c6c8

Switch order of conditions to avoid potential flash in title

990020a

Fix case where original title could be overwritten

e061572

Sort importa and avoid nested if

ad00ed9

cheap-glitch commented Nov 7, 2020

View reviewed changes

cheap-glitch added 2 commits November 8, 2020 15:45

Tag forms sending comment with custom class

7282f02

Fix linter error

274273d

yakov116 added the bug label Nov 10, 2020

fregante reviewed Nov 15, 2020

View reviewed changes

Comment thread source/features/unfinished-comments.tsx Outdated

Comment thread source/features/unfinished-comments.tsx Outdated

fregante requested changes Nov 17, 2020

View reviewed changes

Comment thread source/features/unfinished-comments.tsx Outdated

Comment thread source/features/unfinished-comments.tsx Outdated

fregante requested changes Nov 17, 2020

View reviewed changes

Comment thread source/features/unfinished-comments.tsx Outdated

fregante added 5 commits November 16, 2020 19:37

Exclude fields being submitted by wait-for-build

3a37bb0

Remove the "sending" class at a better moment

5ac2a2d

Lint

b891f1b

Lint

cfd80d1

Lint

83269a1

fregante reviewed Nov 17, 2020

View reviewed changes

cheap-glitch added 2 commits November 21, 2020 13:06

Exclude sending form without tagging them

7f77ef4

Use hasRichTextEditor instead of hasComments to detect page

f8a073b

cheap-glitch requested a review from fregante November 22, 2020 18:05

fregante changed the title ~~Reset document title when draft comment is submitted~~ Improve unfinished-comments detection logic Nov 23, 2020

fregante merged commit 0ad621e into refined-github:master Nov 23, 2020

cheap-glitch deleted the fix-unifinished-comments branch November 24, 2020 08:31

fregante mentioned this pull request Oct 2, 2021

Fix unfinished-comments feature #4826

Closed

	!textarea.closest('.rgh-is-sending-comment') // Exclude forms being submitted
	select.exists('.btn-primary[disabled]', textarea.form!);

Uh oh!

Uh oh!

Conversation

cheap-glitch commented Nov 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cheap-glitch commented Nov 7, 2020

Uh oh!

cheap-glitch Nov 7, 2020

Choose a reason for hiding this comment

Uh oh!

fregante Nov 7, 2020

Choose a reason for hiding this comment

Uh oh!

fregante commented Nov 7, 2020

Uh oh!

cheap-glitch commented Nov 7, 2020

Uh oh!

fregante commented Nov 8, 2020

Uh oh!

cheap-glitch commented Nov 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fregante commented Nov 9, 2020

Uh oh!

cheap-glitch commented Nov 9, 2020

Uh oh!

Uh oh!

Uh oh!

fregante left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fregante Nov 17, 2020

Choose a reason for hiding this comment

Uh oh!

cheap-glitch Nov 21, 2020

Choose a reason for hiding this comment

Uh oh!

fregante Nov 21, 2020

Choose a reason for hiding this comment

Uh oh!

fregante commented Nov 23, 2020

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

cheap-glitch commented Nov 7, 2020 •

edited

Loading

cheap-glitch commented Nov 8, 2020 •

edited

Loading