[GH-512,513] Fixed issue #512 and #513 on github plugin 'Updated subscription success messages' #661

Kshitij-Katiyar · 2023-03-23T09:39:44Z

Summary

If a user creates a new subscription for a repo or organization for which a subscription already exists, the events of the previous subscription get overwritten. So now added the list of events that got overwritten in the subscription message.
Added additional information like the username, events, etc in the subscription message.
Issue #512
Issue #513

…gin (#25) * [MI-2904]:Fixed issue mattermost#512 and mattermost#513 on github plugin * [MI-2904]:Fixed review comments * [MI-2904]:Fixed review comments

mattermost-build · 2023-03-23T09:39:54Z

Hello @Kshitij-Katiyar,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

server/plugin/command.go

hanzei · 2023-03-23T09:49:42Z

server/plugin/command.go

@@ -266,15 +287,14 @@ func (p *Plugin) handleSubscriptionsList(_ *plugin.Context, args *model.CommandA
 }

 func (p *Plugin) handleSubscribesAdd(_ *plugin.Context, args *model.CommandArgs, parameters []string, userInfo *GitHubUserInfo) string {
+	defaultEvents := Features("pulls,issues,creates,deletes")


Maybe this should even be a global variable?

(suggestion) perhaps defaultEvents is a bit misleading, as it's a mutable variable that can change later on in the function, so it's not always holding the default events.

@hanzei I don't think so there is a need for making this variable global as we are only using this in this function.
@m1lt0n Changed the name for this variable.

server/plugin/command.go

m1lt0n · 2023-03-23T12:12:51Z

server/plugin/command.go

@@ -266,15 +287,14 @@ func (p *Plugin) handleSubscriptionsList(_ *plugin.Context, args *model.CommandA
 }

 func (p *Plugin) handleSubscribesAdd(_ *plugin.Context, args *model.CommandArgs, parameters []string, userInfo *GitHubUserInfo) string {
+	defaultEvents := Features("pulls,issues,creates,deletes")


(suggestion) perhaps defaultEvents is a bit misleading, as it's a mutable variable that can change later on in the function, so it's not always holding the default events.

server/plugin/command.go

#26)

codecov-commenter · 2023-03-24T11:19:32Z

Codecov Report

Attention: 119 lines in your changes are missing coverage. Please review.

Comparison is base (573e4a3) 15.70% compared to head (047d2e0) 15.42%.

❗ Current head 047d2e0 differs from pull request most recent head a20d986. Consider uploading reports for the commit a20d986 to get more accurate results

Files	Patch %	Lines
server/plugin/command.go	0.00%	104 Missing ⚠️
server/plugin/subscriptions.go	0.00%	15 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #661      +/-   ##
==========================================
- Coverage   15.70%   15.42%   -0.29%     
==========================================
  Files          15       15              
  Lines        5660     5595      -65     
==========================================
- Hits          889      863      -26     
+ Misses       4729     4690      -39     
  Partials       42       42

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mickmister

Mostly LGTM, mainly just a few requests for readability. Thanks @Kshitij-Katiyar!

server/plugin/command.go

mickmister · 2023-03-24T18:07:55Z

server/plugin/command.go

 }

+func (p *Plugin) getSubscribedFeatures(channelID, owner, repo string) (Features, error) {
+	var previousFeatures Features


Why is this named previousFeatures?

These are Features or events of an subscription which are going to be overwritten due to creation of new subscription.

mickmister · 2023-03-24T18:08:36Z

server/plugin/command.go

-	msg := fmt.Sprintf("Successfully subscribed to [%s](%s).", repo, repoLink)
+	msg := fmt.Sprintf("@%v subscribed this channel to [%s/%s](%s) with the following events: %s", user.Username, owner, repo, repoLink, subscriptionEvents.FormattedString())
+	if previousSubscribedEvents != "" {
+		msg += previousSubscribedEventMessage


Should we add a space between the two concatenated strings? Same for other concatenations here in this function

@mickmister This is how it looks

server/plugin/command.go

mickmister · 2023-03-24T18:17:46Z

server/plugin/command.go

+		subscriptionSuccess := fmt.Sprintf("@%v subscribed this channel to [%s](%s) with the following events: %s.", user.Username, owner, orgLink, subscriptionEvents.FormattedString())
+
+		if previousSubscribedEvents != "" {
+			subscriptionSuccess += previousSubscribedEventMessage
+		}

-		return fmt.Sprintf("Successfully subscribed to organization %s.", owner)
+		if appErr = p.CreatePost(args.ChannelId, p.BotUserID, subscriptionSuccess); appErr != nil {
+			return fmt.Sprintf("%s error creating the public post: %s", subscriptionSuccess, appErr.Error())
+		}
+
+		return ""


I just realized this is going to be really noisy if the admin subscribes to several projects in succession. I prefer having those as ephemeral instead of public, but that is just my own preference.

Is it part of this ticket to make this message public?

@hanzei Please refer to this discussion #513 (comment)

server/plugin/command.go

Kshitij-Katiyar · 2023-04-14T08:34:16Z

Heads up that there are conflicts to resolve.

@hanzei Fixed the merged conflicts

mattermost-build · 2023-05-04T01:01:55Z

This PR has been automatically labelled "stale" because it hasn't had recent activity.
A core team member will check in on the status of the PR to help with questions.
Thank you for your contribution!

hanzei · 2023-07-06T05:05:56Z

@Kshitij-Katiyar Would you please merge master?

…ub into MM-512,513

Kshitij-Katiyar · 2023-07-07T09:57:24Z

@Kshitij-Katiyar Would you please merge master?

@hanzei synced with master

AayushChaudhary0001

Tested and Approved.
Subscriptions message is reflected fine for new subscriptions. Also, events and usernames are also reflected in the subscription message.
Working fine, LGTM.

hanzei · 2023-11-27T10:01:58Z

@Kshitij-Katiyar Would you please resolve the conflicts?

…hub into MM-512,513

avas27JTG · 2023-11-28T11:28:52Z

@Kshitij-Katiyar Would you please resolve the conflicts?

@hanzei I've done it.

[MI-2904]:Fixed issue mattermost#512 and mattermost#513 on github plu…

5d191e8

…gin (#25) * [MI-2904]:Fixed issue mattermost#512 and mattermost#513 on github plugin * [MI-2904]:Fixed review comments * [MI-2904]:Fixed review comments

Kshitij-Katiyar requested a review from m1lt0n March 23, 2023 09:39

Kshitij-Katiyar requested a review from hanzei as a code owner March 23, 2023 09:39

mattermost-build added the Contributor label Mar 23, 2023

Kshitij-Katiyar changed the title ~~[GH-512,513] Fixed issue #512 and #513 on github plugin~~ [GH-512,513] Fixed issue #512 and #513 on github plugin 'Updated subscription success messages' Mar 23, 2023

hanzei reviewed Mar 23, 2023

View reviewed changes

hanzei added 2: Dev Review Requires review by a core committer 3: QA Review Requires review by a QA tester labels Mar 23, 2023

hanzei reviewed Mar 23, 2023

View reviewed changes

server/plugin/command.go Outdated Show resolved Hide resolved

m1lt0n suggested changes Mar 23, 2023

View reviewed changes

Kshitij-Katiyar mentioned this pull request Mar 24, 2023

[MI-2928]:Fixed review comments for issue 512 and 513 on github plugin Brightscout/mattermost-plugin-github#26

Merged

[MI-2928]:Fixed review comments for issue 512 and 513 on github plugin (

ea7461f

#26)

Kshitij-Katiyar requested review from m1lt0n and hanzei March 24, 2023 11:52

m1lt0n requested review from mickmister and removed request for m1lt0n March 24, 2023 13:52

mickmister requested changes Mar 24, 2023

View reviewed changes

Kshitij-Katiyar added 3 commits March 28, 2023 10:54

[MM-512,513]:Fixed review comments given by mm team

83b1838

[MM-512,513]:Updated user error msg

8ae5dd4

[MM-512,513]:Fixed lint errors

22d71b0

Kshitij-Katiyar requested review from m1lt0n and mickmister March 28, 2023 12:16

mickmister approved these changes Mar 28, 2023

View reviewed changes

m1lt0n approved these changes Mar 29, 2023

View reviewed changes

hanzei approved these changes Mar 30, 2023

View reviewed changes

hanzei requested a review from DHaussermann March 30, 2023 07:16

hanzei removed the 2: Dev Review Requires review by a core committer label Mar 30, 2023

mattermost-build added the Lifecycle/1:stale label Apr 10, 2023

Kshitij-Katiyar added 2 commits April 14, 2023 13:57

[MM-512,513]:Fixed merge conflicts

67c1ba5

[MM-512,513]: reverted package-lock.json changes

be331c1

Kshitij-Katiyar requested a review from hanzei April 17, 2023 11:25

hanzei removed their request for review April 23, 2023 20:37

hanzei removed Awaiting Submitter Action Blocked on the author Lifecycle/1:stale labels Apr 23, 2023

mattermost-build added the Lifecycle/1:stale label May 4, 2023

Merge branch 'master' of github.com:mattermost/mattermost-plugin-gith…

047d2e0

…ub into MM-512,513

hanzei requested a review from AayushChaudhary0001 September 29, 2023 07:34

hanzei removed the Lifecycle/1:stale label Sep 29, 2023

Kshitij-Katiyar added this to the v2.3.0 milestone Oct 5, 2023

hanzei removed the request for review from DHaussermann October 16, 2023 20:39

This was linked to issues Oct 16, 2023

After Subscribing event ex "pulls", existing event is removed so also need to print those removed event at the time of displaying the Success message. #512

Closed

After subscribing the event, need to display event name with the success message. #513

Closed

hanzei mentioned this pull request Nov 9, 2023

Bump version to 2.2.0. #709

Merged

avas27JTG modified the milestones: v2.3.0, v2.2.0 Nov 13, 2023

AayushChaudhary0001 approved these changes Nov 21, 2023

View reviewed changes

hanzei added 4: Reviews Complete All reviewers have approved the pull request and removed 3: QA Review Requires review by a QA tester labels Nov 27, 2023

avas27JTG added 3 commits November 28, 2023 15:12

Merge branch 'master' of github.com:Brightscout/mattermost-plugin-git…

375cef5

…hub into MM-512,513

Merge branch 'master' of github.com:Brightscout/mattermost-plugin-git…

56e3e83

…hub into MM-512,513

Fixed lint.

a20d986

hanzei merged commit 8cf783f into mattermost:master Nov 28, 2023
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GH-512,513] Fixed issue #512 and #513 on github plugin 'Updated subscription success messages' #661

[GH-512,513] Fixed issue #512 and #513 on github plugin 'Updated subscription success messages' #661

Kshitij-Katiyar commented Mar 23, 2023

mattermost-build commented Mar 23, 2023

hanzei Mar 23, 2023

m1lt0n Mar 23, 2023

Kshitij-Katiyar Mar 24, 2023

m1lt0n Mar 23, 2023

codecov-commenter commented Mar 24, 2023 •

edited

mickmister left a comment

mickmister Mar 24, 2023

Kshitij-Katiyar Mar 28, 2023

mickmister Mar 24, 2023

Kshitij-Katiyar Mar 28, 2023

mickmister Mar 24, 2023

Kshitij-Katiyar Mar 28, 2023

Kshitij-Katiyar commented Apr 14, 2023

mattermost-build commented May 4, 2023

hanzei commented Jul 6, 2023

Kshitij-Katiyar commented Jul 7, 2023

AayushChaudhary0001 left a comment

hanzei commented Nov 27, 2023

avas27JTG commented Nov 28, 2023

[GH-512,513] Fixed issue #512 and #513 on github plugin 'Updated subscription success messages' #661

[GH-512,513] Fixed issue #512 and #513 on github plugin 'Updated subscription success messages' #661

Conversation

Kshitij-Katiyar commented Mar 23, 2023

mattermost-build commented Mar 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Mar 24, 2023 • edited

Codecov Report

mickmister left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kshitij-Katiyar commented Apr 14, 2023

mattermost-build commented May 4, 2023

hanzei commented Jul 6, 2023

Kshitij-Katiyar commented Jul 7, 2023

AayushChaudhary0001 left a comment

Choose a reason for hiding this comment

hanzei commented Nov 27, 2023

avas27JTG commented Nov 28, 2023

codecov-commenter commented Mar 24, 2023 •

edited