[GH-626]: Supported filtering on comment visibility for subscriptions

server/client.go

@@ -26,8 +26,10 @@ import (
 )
 
 const autocompleteSearchRoute = "2/jql/autocompletedata/suggestions"
+const commentVisibilityRoute = "2/user"
 const userSearchRoute = "2/user/assignable/search"
 const unrecognizedEndpoint = "_unrecognized"
+const visibleToAllUsers = "visible-to-all-users"
 
 // Client is the combined interface for all upstream APIs and convenience methods.
 type Client interface {
@@ -64,6 +66,7 @@ type SearchService interface {
 	SearchUsersAssignableToIssue(issueKey, query string, maxResults int) ([]jira.User, error)
 	SearchUsersAssignableInProject(projectKey, query string, maxResults int) ([]jira.User, error)
 	SearchAutoCompleteFields(params map[string]string) (*AutoCompleteResult, error)
+	SearchCommentVisibilityFields(params map[string]string) (*CommentVisibilityResult, error)
 }
 
 // IssueService is the interface for issue-related APIs.
@@ -252,6 +255,18 @@ type AutoCompleteResult struct {
 	Results []Result `json:"results"`
 }
 
+type JiraUserGroup struct {
+	Name string `json:"name"`
+}
+
+type JiraUserGroupCollection struct {
+	JiraUserGroups []*JiraUserGroup `json:"items"`
+}
+
+type CommentVisibilityResult struct {
+	Groups *JiraUserGroupCollection `json:"groups"`
+}
+
 // SearchAutoCompleteFields searches fieldValue specified in the params and returns autocomplete suggestions
 // for that fieldValue
 func (client JiraClient) SearchAutoCompleteFields(params map[string]string) (*AutoCompleteResult, error) {
@@ -264,6 +279,17 @@ func (client JiraClient) SearchAutoCompleteFields(params map[string]string) (*Au
 	return result, nil
 }
 
+// SearchCommentVisibilityFields searches fieldValue specified in the params and returns the comment visibility suggestions
+// for that fieldValue
+func (client JiraClient) SearchCommentVisibilityFields(params map[string]string) (*CommentVisibilityResult, error) {
+	result := &CommentVisibilityResult{}
+	if err := client.RESTGet(commentVisibilityRoute, params, result); err != nil {
+		return nil, err
+	}
+	result.Groups.JiraUserGroups = append(result.Groups.JiraUserGroups, &JiraUserGroup{visibleToAllUsers})
+	return result, nil
+}
+
 // DoTransition executes a transition on an issue.
 func (client JiraClient) DoTransition(issueKey, transitionID string) error {
 	resp, err := client.Jira.Issue.DoTransition(issueKey, transitionID)

server/http.go

@@ -32,6 +32,7 @@ const (
 	routeAPIGetJiraProjectMetadata              = "/api/v2/get-jira-project-metadata"
 	routeAPIGetSearchIssues                     = "/api/v2/get-search-issues"
 	routeAPIGetAutoCompleteFields               = "/api/v2/get-search-autocomplete-fields"
+	routeAPIGetCommentVisibilityFields          = "/api/v2/get-comment-visibility-fields"
 	routeAPIGetSearchUsers                      = "/api/v2/get-search-users"
 	routeAPIAttachCommentToIssue                = "/api/v2/attach-comment-to-issue"
 	routeAPIUserInfo                            = "/api/v2/userinfo"
@@ -126,6 +127,8 @@ func (p *Plugin) serveHTTP(c *plugin.Context, w http.ResponseWriter, r *http.Req
 		return p.httpGetSearchIssues(w, r)
 	case routeAPIGetAutoCompleteFields:
 		return p.httpGetAutoCompleteFields(w, r)
+	case routeAPIGetCommentVisibilityFields:
+		return p.httpGetCommentVisibilityFields(w, r)
 	case routeAPIGetSearchUsers:
 		return p.httpGetSearchUsers(w, r)
 	case routeAPIAttachCommentToIssue:

server/issue.go

@@ -22,12 +22,16 @@ import (
 )
 
 const (
-	labelsField      = "labels"
-	statusField      = "status"
-	reporterField    = "reporter"
-	priorityField    = "priority"
-	descriptionField = "description"
-	resolutionField  = "resolution"
+	labelsField            = "labels"
+	statusField            = "status"
+	reporterField          = "reporter"
+	priorityField          = "priority"
+	descriptionField       = "description"
+	resolutionField        = "resolution"
+	headerMattermostUserID = "Mattermost-User-ID"
+	instanceIDQueryParam   = "instance_id"
+	fieldValueQueryParam   = "fieldValue"
+	expandQueryParam       = "expand"
 )
 
 func makePost(userID, channelID, message string) *model.Post {
@@ -404,6 +408,47 @@ func (p *Plugin) GetCreateIssueMetadataForProjects(instanceID, mattermostUserID
 	})
 }
 
+func (p *Plugin) httpGetCommentVisibilityFields(w http.ResponseWriter, r *http.Request) (int, error) {
+	if r.Method != http.MethodGet {
+		return http.StatusMethodNotAllowed, fmt.Errorf("Request: " + r.Method + " is not allowed, must be GET")
+	}
+
+	mattermostUserID := r.Header.Get(headerMattermostUserID)
+	if mattermostUserID == "" {
+		return http.StatusUnauthorized, errors.New("not authorized")
+	}
+
+	instanceID := r.FormValue(instanceIDQueryParam)
+	client, _, connection, err := p.getClient(types.ID(instanceID), types.ID(mattermostUserID))
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+
+	params := map[string]string{
+		"fieldValue": r.FormValue(fieldValueQueryParam),
+		"expand":     r.FormValue(expandQueryParam),
+		"accountId":  connection.AccountID,
+	}
+	response, err := client.SearchCommentVisibilityFields(params)
+	if err != nil {
+		return http.StatusInternalServerError, err
+	}
+	if response == nil {
+		return http.StatusInternalServerError, errors.New("failed to return the response")
+	}
+
+	jsonResponse, err := json.Marshal(response)
+	if err != nil {
+		return http.StatusInternalServerError, errors.WithMessage(err, "failed to marshal the response")
+	}
+
+	w.Header().Set("Content-Type", "application/json")
+	if _, err = w.Write(jsonResponse); err != nil {
+		return http.StatusInternalServerError, errors.WithMessage(err, "failed to write the response")
+	}
+	return http.StatusOK, nil
+}
+
 func (p *Plugin) httpGetSearchIssues(w http.ResponseWriter, r *http.Request) (int, error) {
 	if r.Method != http.MethodGet {
 		return respondErr(w, http.StatusMethodNotAllowed,

server/subscribe.go

@@ -31,6 +31,7 @@ const (
 	FilterEmpty      = "empty"
 
 	MaxSubscriptionNameLength = 100
+	CommentVisibility         = "commentVisibility"
 )
 
 type FieldFilter struct {
@@ -123,7 +124,7 @@ func (p *Plugin) getUserID() string {
 	return p.getConfig().botUserID
 }
 
-func (p *Plugin) matchesSubsciptionFilters(wh *webhook, filters SubscriptionFilters) bool {
+func (p *Plugin) matchesSubsciptionFilters(wh *webhook, filters SubscriptionFilters, visibilityAttribute string) bool {
 	webhookEvents := wh.Events()
 	foundEvent := false
 	eventTypes := filters.Events
@@ -159,6 +160,12 @@ func (p *Plugin) matchesSubsciptionFilters(wh *webhook, filters SubscriptionFilt
 		}
 
 		value := getIssueFieldValue(&wh.JiraWebhook.Issue, field.Key)
+		if visibilityAttribute != "" {
+			value[visibilityAttribute] = true
+		} else if field.Key == CommentVisibility {
+			value[visibleToAllUsers] = true
+		}
+
 		containsAny := value.ContainsAny(field.Values.Elems()...)
 		containsAll := value.ContainsAll(field.Values.Elems()...)
 
@@ -174,7 +181,7 @@ func (p *Plugin) matchesSubsciptionFilters(wh *webhook, filters SubscriptionFilt
 	return validFilter
 }
 
-func (p *Plugin) getChannelsSubscribed(wh *webhook, instanceID types.ID) ([]ChannelSubscription, error) {
+func (p *Plugin) getChannelsSubscribed(wh *webhook, instanceID types.ID, visibilityAttribute string) ([]ChannelSubscription, error) {
 	subs, err := p.getSubscriptions(instanceID)
 	if err != nil {
 		return nil, err
@@ -183,7 +190,7 @@ func (p *Plugin) getChannelsSubscribed(wh *webhook, instanceID types.ID) ([]Chan
 	var channelSubscriptions []ChannelSubscription
 	subIds := subs.Channel.ByID
 	for _, sub := range subIds {
-		if p.matchesSubsciptionFilters(wh, sub.Filters) {
+		if p.matchesSubsciptionFilters(wh, sub.Filters, visibilityAttribute) {
 			channelSubscriptions = append(channelSubscriptions, sub)
 		}
 	}

server/subscribe_test.go

@@ -1385,7 +1385,7 @@ func TestGetChannelsSubscribed(t *testing.T) {
 			wh, err := ParseWebhook(bb)
 			assert.Nil(t, err)
 
-			actual, err := p.getChannelsSubscribed(wh.(*webhook), testInstance1.InstanceID)
+			actual, err := p.getChannelsSubscribed(wh.(*webhook), testInstance1.InstanceID, "")
 			assert.Nil(t, err)
 			assert.Equal(t, len(tc.ChannelSubscriptions), len(actual))
 			actualChannelIDs := NewStringSet()

server/webhook_worker.go

@@ -4,6 +4,8 @@
 package main
 
 import (
+	jira "github.com/andygrunwald/go-jira"
+
 	"github.com/mattermost/mattermost-plugin-jira/server/utils/types"
 )
 
@@ -27,6 +29,30 @@ func (ww webhookWorker) work() {
 	}
 }
 
+func isCommentRelatedWebhook(wh Webhook) bool {
+	return wh.Events().Intersection(commentEvents).Len() > 0
+}
+
+func (ww webhookWorker) getVisibilityAttribute(msg *webhookMessage, v *webhook) (string, error) {
+	mattermostUserID, err := ww.p.userStore.LoadMattermostUserID(msg.InstanceID, v.JiraWebhook.Comment.Author.AccountID)
+	if err != nil {
+		ww.p.API.LogInfo("Commentator is not connected with the mattermost", "Error", err.Error())
+		return "", err
+	}
+
+	client, _, _, err := ww.p.getClient(msg.InstanceID, mattermostUserID)
+	if err != nil {
+		return "", err
+	}
+
+	comment := jira.Comment{}
+	if err = client.RESTGet(v.JiraWebhook.Comment.Self, nil, &comment); err != nil {
+		return "", err
+	}
+
+	return comment.Visibility.Value, nil
+}
+
 func (ww webhookWorker) process(msg *webhookMessage) (err error) {
 	defer func() {
 		if err == ErrWebhookIgnored {
@@ -49,7 +75,14 @@ func (ww webhookWorker) process(msg *webhookMessage) (err error) {
 		return err
 	}
 
-	channelsSubscribed, err := ww.p.getChannelsSubscribed(v, msg.InstanceID)
+	visibilityAttribute := ""
+	if isCommentRelatedWebhook(wh) {
+		if visibilityAttribute, err = ww.getVisibilityAttribute(msg, v); err != nil {
+			return err
+		}
+	}
+
+	channelsSubscribed, err := ww.p.getChannelsSubscribed(v, msg.InstanceID, visibilityAttribute)
 	if err != nil {
 		return err
 	}

webapp/src/actions/index.ts

@@ -157,6 +157,13 @@ export const searchAutoCompleteFields = (params) => {
     };
 };
 
+export const searchCommentVisibilityFields = (params) => {
+    return async (dispatch, getState) => {
+        const url = `${getPluginServerRoute(getState())}/api/v2/get-comment-visibility-fields`;
+        return doFetchWithResponse(`${url}${buildQueryString(params)}`);
+    };
+};
+
 export const searchUsers = (params) => {
     return async (dispatch, getState) => {
         const url = getPluginServerRoute(getState()) + '/api/v2/get-search-users';

webapp/src/components/data_selectors/jira_commentvisibility_selector/index.ts

@@ -0,0 +1,13 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+import {connect} from 'react-redux';
+import {bindActionCreators} from 'redux';
+
+import {searchCommentVisibilityFields} from 'actions';
+
+import JiraCommentVisibilitySelector from './jira_commentvisibility_selector';
+
+const mapDispatchToProps = (dispatch) => bindActionCreators({searchCommentVisibilityFields}, dispatch);
+
+export default connect(null, mapDispatchToProps)(JiraCommentVisibilitySelector);

webapp/src/components/data_selectors/jira_commentvisibility_selector/jira_commentvisibility_selector.tsx

@@ -0,0 +1,54 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+import React from 'react';
+
+import {ReactSelectOption} from 'types/model';
+
+import BackendSelector, {Props as BackendSelectorProps} from '../backend_selector';
+
+const stripHTML = (text: string) => {
+    if (!text) {
+        return text;
+    }
+
+    const doc = new DOMParser().parseFromString(text, 'text/html');
+    return doc.body.textContent || '';
+};
+
+type Props = BackendSelectorProps & {
+    searchCommentVisibilityFields: (params: {fieldValue: string}) => (
+        Promise<{data: {groups: {items: {name: string}[]}}; error?: Error}>
+    );
+    fieldName: string;
+};
+
+const JiraCommentVisibilitySelector = (props: Props) => {
+    const {value, isMulti, instanceID, searchCommentVisibilityFields} = props;
+    const fetchInitialSelectedValues = async (): Promise<ReactSelectOption[]> =>
+        ((!value || (isMulti && !value.length)) ? [] : commentVisibilityFields(''));
+
+    const commentVisibilityFields = async (inputValue: string): Promise<ReactSelectOption[]> => {
+        const params = {
+            fieldValue: inputValue,
+            instance_id: instanceID,
+            expand: 'groups',
+        };
+        return searchCommentVisibilityFields(params).then(({data}) => {
+            return data.groups.items.map((suggestion) => ({
+                value: suggestion.name,
+                label: stripHTML(suggestion.name),
+            }));
+        });
+    };
+
+    return (
+        <BackendSelector
+            {...props}
+            fetchInitialSelectedValues={fetchInitialSelectedValues}
+            search={commentVisibilityFields}
+        />
+    );
+};
+
+export default JiraCommentVisibilitySelector;

webapp/src/components/modals/channel_subscriptions/__snapshots__/channel_subscription_filter.test.tsx.snap

@@ -50,6 +50,34 @@ exports[`components/ChannelSubscriptionFilter should match snapshot 1`] = `
                 "label": "Affects versions",
                 "value": "versions",
               },
+              Object {
+                "label": "Comment Visibility",
+                "value": "commentVisibility",
+              },
+              Object {
+                "label": "Comment Visibility",
+                "value": "commentVisibility",
+              },
+              Object {
+                "label": "Comment Visibility",
+                "value": "commentVisibility",
+              },
+              Object {
+                "label": "Comment Visibility",
+                "value": "commentVisibility",
+              },
+              Object {
+                "label": "Comment Visibility",
+                "value": "commentVisibility",
+              },
+              Object {
+                "label": "Comment Visibility",
+                "value": "commentVisibility",
+              },
+              Object {
+                "label": "Comment Visibility",
+                "value": "commentVisibility",
+              },
               Object {
                 "label": "Epic Link",
                 "value": "customfield_10014",