Fix: Subscriptions --exclude functionality affects all channels #505

sanjaydemansol · 2021-10-26T18:47:39Z

Summary

Now, --exclude is channel specific.

Testing Notes

When using the exclude functionality the exclusion record that get's created owner/repo - notification : disabled is not channel specific. These exclusions appear in channels where no subscriptions have been created yet and no exclusion was specified.

This affects event delivery in channel --exclude was never used and prevents events from being delivered for some of the repositories. Steps:

Create a subscription where an owner is passed in and exclude a repo /github subscriptions add DylanH20 --exclude DylanH20/Hello-World-1

Test and note that events are delivered to the channel for all repos under DylanH20 except for Hello-World-1 (as expected)

Create a new channel

Type /github subscribe list notice DylanH20/Hello-World-1 - notification : disabled is already showing

Type /github subscriptions add DylanH20 to subscribe to all repos underDylanH20

Type /github subscriptions list in current channel and other channels to confirm, excluded repo should be scoped to current channel.

Ticket Link

Fix #494

mattermod · 2021-10-26T18:47:44Z

Hello @sanjaydemansol,

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.

hanzei

I'm wondering if the data model makes sense for the use case. See below for more details.

server/plugin/command.go

server/plugin/subscriptions.go

dipak-demansol · 2021-11-01T11:49:03Z

@sanjaydemansol @hanzei This PR LGTM As Per the Description.
but i found some other issue,its related to exclude but not related to this PR so i reported 2 different issue, here it is, pls check this #507 #508

dipak-demansol

LGTM As Per the Current PR Description.
but i found some other issue,its related to exclude but not related to this PR so i reported 2 different issue, here it is, pls check this #507 #508

hanzei

Discussed offline: The exclude information should be part of the subscription

sanjaydemansol · 2021-11-02T17:45:05Z

Discussed offline: The exclude information should be part of the subscription

Hi, I got it. How should I handle this #505 (comment)?

We still have issues like when user receives direct message, earlier we used to check for exclusion prior to processing webhook

emilyacook · 2021-11-05T17:38:42Z

Thanks for participating in Hacktoberfest! You can claim your sticker set here: https://get.printfection.com/hacktober21/4144583267 @sanjaydemansol

mickmister · 2021-11-11T16:31:26Z

We may already be doing this, but we should make sure to LogDebug when we are avoiding a post creation due to the exclude feature

mattermod · 2021-11-22T01:01:15Z

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!

/cc @jasonblais @jfrerich @emilyacook

server/plugin/command.go

server/plugin/subscriptions.go

sibasankarnayak

@sanjaydemansol have added few suggestions from my side.

mickmister

Thanks for addressing the feedback @sanjaydemansol 👍

I have a few just more requests on the PR

mickmister · 2022-02-01T03:59:09Z

server/plugin/subscriptions.go

+func GetExcludedNotificationRepos(s Subscription) []string {
+	return s.Flags.ExcludedRepos


Looks like it's still here 🙂

mickmister · 2022-02-01T04:08:30Z

server/plugin/command.go

+	var repoMatch []string
+	if len(subs) != 0 {
+		for _, sub := range subs {
+			if len(sub.Flags.ExcludedRepos) > 0 {
+				repoMatch = strings.Split(strings.Trim(strings.Join(sub.Flags.ExcludedRepos, ", "), "/"), "/")
+			}
+		}
+		if len(repoMatch) == 0 {
+			return "", nil
+		}
+		return repoMatch[1], nil
+	}
+	return "", nil


This seems a bit off. Should we add a break after the repoMatch = line?

Or or it could be written this way:

Suggested change

var repoMatch []string

if len(subs) != 0 {

for _, sub := range subs {

if len(sub.Flags.ExcludedRepos) > 0 {

repoMatch = strings.Split(strings.Trim(strings.Join(sub.Flags.ExcludedRepos, ", "), "/"), "/")

}

}

if len(repoMatch) == 0 {

return "", nil

}

return repoMatch[1], nil

}

return "", nil

for _, sub := range subs {

if len(sub.Flags.ExcludedRepos) > 0 {

repoMatch = strings.Split(strings.Trim(strings.Join(sub.Flags.ExcludedRepos, ", "), "/"), "/")

if len(repoMatch) > 1 {

return repoMatch[1], nil

}

}

}

return "", nil

ok, i updated as suggest

mickmister · 2022-02-01T04:22:51Z

server/plugin/command.go

+	// if config.GitHubOrg != "" {
+	subscriptionsAdd.AddNamedStaticListArgument("", "Currently supports --exclude and --exclude-org-member", true, []model.AutocompleteListItem{
+		{
+			HelpText: "notifications for these repos will be turned off",
+			Hint:     "(optional)",
+			Item:     "--exclude",
+		},
+		{
+			HelpText: "Events triggered by organization members will not be delivered (the organization config should be set, otherwise this flag has no effect)",
+			Hint:     "(optional)",
+			Item:     "--exclude-org-member",
+		},
+	})
+	// }


This won't produce the right autocomplete because we are supposed to have two different field types here. One is text-based, and one is boolean-based.

In order to support boolean-based arguments in our flag argument system, we will need to treat that field as a separate select element:

commandArgumentExcludeHint := "Notifications for these repos will be turned off" commandArgumentExcludeOrgMemberHint := "Events triggered by organization members will not be delivered (default false)" cmd.AddNamedTextArgument("exclude", commandArgumentExcludeHint, "", false) if config.GitHubOrg != "" { cmd.AddNamedStaticListArgument("exclude-org-member", commandArgumentExcludeOrgMemberHint, false, []model.AutocompleteListItem{ { Item: "true", HelpText: "Exclude posts from members of the configured organization", }, { Item: "false", HelpText: "Include posts from members of the configured organization", }, }) }

feedback point 1, remove GithubOrg, #505 (comment)
point 3 exclude and exclude-org-member is positional arguments. fixed it.

i will check and update as feedback

mickmister · 2022-02-01T04:23:43Z

server/plugin/command.go

@@ -353,7 +362,16 @@ func (p *Plugin) handleSubscribesAdd(_ *plugin.Context, args *model.CommandArgs,
 		return "--exclude feature currently support on organization level."
 	}

-	if err := p.Subscribe(ctx, githubClient, args.UserId, owner, repo, args.ChannelId, features, flags); err != nil {
+	repoMatch, err := p.getExcludedRepo(args)


Shouldn't we support more than one excluded repo here?

@mickmister 1/5 we may add support for the same in next release. User may call the command multiple times if needed. Do you want me to add it in this PR?

@sanjaydemansol Most of the code related to the exclude feature seems to imply it works with multiple repos. I need to review the original PR to understand the code better as I wasn't a reviewer on the PR.

Shouldn't we support more than one repo here?

I said this with the assumption that the feature already supports it in general, and that I genuinely don't know if we need to support that in this piece of code as well

mickmister · 2022-02-01T04:25:26Z

server/plugin/command.go

+						for _, excludedRepo := range flags.ExcludedRepos {
+							var subscribedRepo = strings.Trim(sub.Repository, "/")
+							if subscribedRepo == excludedRepo {
+								msg := fmt.Sprintf("Failed to add subscription to %s organization with --exclude. The repository %s cannot be excluded as a subscription already exists. Please remove the existing subscription first.", owner, excludedRepo)


Suggested change

msg := fmt.Sprintf("Failed to add subscription to %s organization with --exclude. The repository %s cannot be excluded as a subscription already exists. Please remove the existing subscription first.", owner, excludedRepo)

msg := fmt.Sprintf("Failed to add subscription to %s organization with --exclude. The repository %s cannot be excluded as a subscription already exists in another subscription for this channel. Please remove the existing subscription first.", owner, excludedRepo)

update message as per feedback

hanzei · 2022-02-09T08:41:13Z

There as conflicts to resolve as #457 has been reverted

mattermod · 2022-02-21T01:01:23Z

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!

/cc @aspleenic

mattermod · 2022-04-22T01:01:06Z

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!

maisnamrajusingh · 2022-04-24T03:46:53Z

@mickmister please ignore as I clicked on re-request by mistake

mickmister · 2022-08-04T15:22:46Z

Note: The original feature was reverted here #529, so master is currently not affected by this

sanjaydemansol added 2 commits October 27, 2021 00:03

Fix mattermost#494

232e53a

remove debug code

03877c4

sanjaydemansol requested a review from hanzei as a code owner October 26, 2021 18:47

mattermod added Hacktoberfest hacktoberfest-accepted Contributor labels Oct 26, 2021

hanzei reviewed Oct 27, 2021

View reviewed changes

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

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

hanzei added 2: Dev Review Requires review by a core committer 3: QA Review Requires review by a QA tester labels Oct 27, 2021

hanzei added this to the v2.1.0 milestone Oct 27, 2021

sanjaydemansol marked this pull request as draft October 28, 2021 05:38

dipak-demansol self-requested a review October 28, 2021 12:38

This was referenced Nov 1, 2021

There should be a auto suggestion for a exclude Command #507

Closed

after Exclude the Repo, if user Subscribe the same Repo then notification is not working for that Repo. #508

Closed

dipak-demansol added QA Review Done PR has been approved by QA and removed 3: QA Review Requires review by a QA tester labels Nov 1, 2021

dipak-demansol approved these changes Nov 1, 2021

View reviewed changes

hanzei requested changes Nov 2, 2021

View reviewed changes

mattermod added the Lifecycle/1:stale label Nov 22, 2021

sibasankarnayak reviewed Nov 29, 2021

View reviewed changes

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

sibasankarnayak reviewed Nov 29, 2021

View reviewed changes

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

sibasankarnayak reviewed Nov 29, 2021

View reviewed changes

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

sibasankarnayak reviewed Nov 29, 2021

View reviewed changes

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

sibasankarnayak suggested changes Nov 29, 2021

View reviewed changes

hanzei added 2: Dev Review Requires review by a core committer and removed Awaiting Submitter Action Blocked on the author labels Jan 31, 2022

mickmister suggested changes Feb 1, 2022

View reviewed changes

- resolved comments

16b10d3

hanzei modified the milestones: v2.1.0, v2.2.0 Feb 3, 2022

hanzei removed the Triage label Feb 3, 2022

hanzei mentioned this pull request Feb 9, 2022

Add --exclude option to subscriptions command #418

Closed

hanzei added the Awaiting Submitter Action Blocked on the author label Feb 9, 2022

hanzei removed their request for review February 9, 2022 08:41

Merge branch 'master' into mm-494

55ae26e

mattermod added the Lifecycle/1:stale label Feb 21, 2022

hanzei removed 2: Dev Review Requires review by a core committer 3: QA Review Requires review by a QA tester labels Mar 11, 2022

mickmister mentioned this pull request Mar 17, 2022

[GH-470] allow users to specify notifications verbosity using a new render-style flag #534

Merged

maisnamrajusingh self-assigned this Mar 31, 2022

maisnamrajusingh removed the Lifecycle/1:stale label Mar 31, 2022

mattermod added the Lifecycle/1:stale label Apr 22, 2022

maisnamrajusingh requested a review from mickmister April 24, 2022 03:45

mickmister removed their request for review August 4, 2022 15:22

hanzei removed Hacktoberfest hacktoberfest-accepted labels Sep 18, 2022

hanzei removed this from the v2.2.0 milestone Sep 20, 2022

hanzei closed this Feb 20, 2023

mattermost-build removed the Awaiting Submitter Action Blocked on the author label Feb 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Subscriptions --exclude functionality affects all channels #505

Fix: Subscriptions --exclude functionality affects all channels #505

sanjaydemansol commented Oct 26, 2021

mattermod commented Oct 26, 2021

hanzei left a comment

dipak-demansol commented Nov 1, 2021 •

edited

Loading

dipak-demansol left a comment

hanzei left a comment

sanjaydemansol commented Nov 2, 2021

emilyacook commented Nov 5, 2021

mickmister commented Nov 11, 2021

mattermod commented Nov 22, 2021

sibasankarnayak left a comment

mickmister left a comment

mickmister Feb 1, 2022

mickmister Feb 1, 2022

sanjaydemansol Feb 1, 2022

mickmister Feb 1, 2022 •

edited

Loading

sanjaydemansol Feb 1, 2022

sanjaydemansol Feb 1, 2022

mickmister Feb 1, 2022

sanjaydemansol Feb 1, 2022

mickmister Feb 2, 2022

mickmister Feb 1, 2022

sanjaydemansol Feb 1, 2022

hanzei commented Feb 9, 2022

mattermod commented Feb 21, 2022

mattermod commented Apr 22, 2022

maisnamrajusingh commented Apr 24, 2022

mickmister commented Aug 4, 2022

		func GetExcludedNotificationRepos(s Subscription) []string {
		return s.Flags.ExcludedRepos

	msg := fmt.Sprintf("Failed to add subscription to %s organization with --exclude. The repository %s cannot be excluded as a subscription already exists. Please remove the existing subscription first.", owner, excludedRepo)
	msg := fmt.Sprintf("Failed to add subscription to %s organization with --exclude. The repository %s cannot be excluded as a subscription already exists in another subscription for this channel. Please remove the existing subscription first.", owner, excludedRepo)

Fix: Subscriptions --exclude functionality affects all channels #505

Fix: Subscriptions --exclude functionality affects all channels #505

Conversation

sanjaydemansol commented Oct 26, 2021

Summary

Testing Notes

Ticket Link

mattermod commented Oct 26, 2021

hanzei left a comment

Choose a reason for hiding this comment

dipak-demansol commented Nov 1, 2021 • edited Loading

dipak-demansol left a comment

Choose a reason for hiding this comment

hanzei left a comment

Choose a reason for hiding this comment

sanjaydemansol commented Nov 2, 2021

emilyacook commented Nov 5, 2021

mickmister commented Nov 11, 2021

mattermod commented Nov 22, 2021

sibasankarnayak left a comment

Choose a reason for hiding this comment

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

mickmister Feb 1, 2022 • edited Loading

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

Choose a reason for hiding this comment

hanzei commented Feb 9, 2022

mattermod commented Feb 21, 2022

mattermod commented Apr 22, 2022

maisnamrajusingh commented Apr 24, 2022

mickmister commented Aug 4, 2022

dipak-demansol commented Nov 1, 2021 •

edited

Loading

mickmister Feb 1, 2022 •

edited

Loading