Implement JIRA issue expanding

src/github.com/matrix-org/go-neb/services/jira/jira.go

@@ -11,6 +11,7 @@ import (
 	"github.com/matrix-org/go-neb/plugin"
 	"github.com/matrix-org/go-neb/realms/jira"
 	"github.com/matrix-org/go-neb/types"
+	"html"
 	"net/http"
 	"regexp"
 	"strings"
@@ -22,22 +23,31 @@ var projectKeyRegex = regexp.MustCompile("^[A-z]+$")
 
 type jiraService struct {
 	id           string
-	UserID string
-	Rooms  []string
+	BotUserID    string
+	ClientUserID string
+	Rooms        map[string]struct { // room_id => {}
+		RealmID  string              // Determines the JIRA endpoint
+		Projects map[string]struct { // SYN => {}
+			Expand bool
+			Track  bool
+		}
+	}
 }
 
-func (s *jiraService) ServiceUserID() string          { return s.UserID }
+func (s *jiraService) ServiceUserID() string { return s.BotUserID }
 func (s *jiraService) ServiceID() string     { return s.id }
 func (s *jiraService) ServiceType() string   { return "jira" }
-func (s *jiraService) RoomIDs() []string              { return s.Rooms }
+func (s *jiraService) RoomIDs() []string {
+	var keys []string
+	for k := range s.Rooms {
+		keys = append(keys, k)
+	}
+	return keys
+}
 func (s *jiraService) Register() error                { return nil }
 func (s *jiraService) PostRegister(old types.Service) {}
-func (s *jiraService) Plugin(roomID string) plugin.Plugin {
-	return plugin.Plugin{
-		Commands: []plugin.Command{
-			plugin.Command{
-				Path: []string{"jira", "create"},
-				Command: func(roomID, userID string, args []string) (interface{}, error) {
+
+func (s *jiraService) cmdJiraCreate(roomID, userID string, args []string) (interface{}, error) {
 	// E.g jira create PROJ "Issue title" "Issue desc"
 	if len(args) <= 1 {
 		return nil, errors.New("Missing project key (e.g 'ABC') and/or title")
@@ -100,8 +110,77 @@ func (s *jiraService) Plugin(roomID string) plugin.Plugin {
 
 	return &matrix.TextMessage{
 		"m.notice",
-						fmt.Sprintf("Created issue: %s", i.Key),
+		fmt.Sprintf("Created issue: %sbrowse/%s", r.JIRAEndpoint, i.Key),
 	}, nil
+}
+
+func (s *jiraService) expandIssue(roomID, userID, issueKey string) interface{} {
+	issueKey = strings.ToUpper(issueKey)
+	logger := log.WithField("issue_key", issueKey)
+	// [ISSU-123, ISSU, 123]
+	groups := issueKeyRegex.FindStringSubmatch(issueKey)
+	if len(groups) != 3 {
+		logger.Print("Failed to find issue key")
+		return nil
+	}
+
+	projectKey := groups[1]
+	if !s.Rooms[roomID].Projects[projectKey].Expand {
+		return nil
+	}
+
+	// Use the person who *provisioned* the service to check for project keys
+	// rather than the person who mentioned the issue key, as it is unlikely
+	// some random who mentioned the issue will have the intended auth.
+	r, err := s.projectToRealm(s.ClientUserID, projectKey)
+	if err != nil {
+		logger.WithError(err).Print("Failed to map project key to realm")
+		return nil
+	}
+	if r == nil {
+		logger.Print("No known project exists with that project key.")
+		return nil
+	}
+
+	logger.WithField("room_id", roomID).Print("Expanding issue")
+	cli, err := r.JIRAClient(s.ClientUserID, false)
+	if err != nil {
+		logger.WithFields(log.Fields{
+			log.ErrorKey: err,
+			"user_id":    s.ClientUserID,
+		}).Print("Failed to retrieve client")
+		return nil
+	}
+
+	issue, _, err := cli.Issue.Get(issueKey)
+	if err != nil {
+		logger.WithError(err).Print("Failed to GET issue")
+		return err
+	}
+	return matrix.GetHTMLMessage(
+		"m.notice",
+		fmt.Sprintf(
+			"%sbrowse/%s : %s",
+			r.JIRAEndpoint, issueKey, htmlSummaryForIssue(issue),
+		),
+	)
+}
+
+func (s *jiraService) Plugin(roomID string) plugin.Plugin {
+	return plugin.Plugin{
+		Commands: []plugin.Command{
+			plugin.Command{
+				Path: []string{"jira", "create"},
+				Command: func(roomID, userID string, args []string) (interface{}, error) {
+					return s.cmdJiraCreate(roomID, userID, args)
+				},
+			},
+		},
+		Expansions: []plugin.Expansion{
+			plugin.Expansion{
+				Regexp: issueKeyRegex,
+				Expand: func(roomID, userID, issueKey string) interface{} {
+					return s.expandIssue(roomID, userID, issueKey)
 				},
 			},
 		},
@@ -174,6 +253,20 @@ func (s *jiraService) projectToRealm(userID, pkey string) (*realms.JIRARealm, er
 	return nil, nil
 }
 
+func htmlSummaryForIssue(issue *jira.Issue) string {
+	// form a summary of the issue being affected e.g:
+	//   "Flibble Wibble [P1, In Progress]"
+	status := html.EscapeString(issue.Fields.Status.Name)
+	if issue.Fields.Resolution != nil {
+		status = fmt.Sprintf("%s (%s)",
+			status, html.EscapeString(issue.Fields.Resolution.Name))
+	}
+	return fmt.Sprintf("%s [%s, %s]",
+		html.EscapeString(issue.Fields.Summary),
+		html.EscapeString(issue.Fields.Priority.Name),
+		status)
+}
+
 func init() {
 	types.RegisterService(func(serviceID, webhookEndpointURL string) types.Service {
 		return &jiraService{id: serviceID}