[MI-2360] Updated APIs to create/delete subscriptions and subscription card for "Build" and "Release" events

server/constants/constants.go

@@ -28,6 +28,7 @@ const (
 	CommandLink         = "link"
 	CommandBoards       = "boards"
 	CommandRepos        = "repos"
+	CommandPipelines    = "pipelines"
 	CommandCreate       = "create"
 	CommandSubscription = "subscription"
 	CommandAdd          = "add"
@@ -40,24 +41,38 @@ const (
 	// Regex to verify pull request link
 	PullRequestLinkRegex = `http(s)?:\/\/dev.azure.com\/[a-zA-Z0-9!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?]*\/[a-zA-Z0-9!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?]*\/_git\/[a-zA-Z0-9!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?]*\/pullrequest\/[1-9]+`
 
+	// Regex to verify pipeline build details link
+	BuildDetailsLinkRegex = `http(s)?:\/\/dev.azure.com\/[a-zA-Z0-9!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?]*\/[a-zA-Z0-9!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?]*\/_build\/results\?buildId=[a-zA-Z0-9!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?]+`
+
 	// Azure API Versions
 	CreateTaskAPIVersion = "7.1-preview.3"
 	TasksIDAPIVersion    = "5.1"
 	TasksAPIVersion      = "6.0"
 
 	// Subscription constants
-	PublisherID                           = "tfs"
-	ConsumerID                            = "webHooks"
-	ConsumerActionID                      = "httpRequest"
-	SubscriptionEventPullRequestCreated   = "git.pullrequest.created"
-	SubscriptionEventPullRequestUpdated   = "git.pullrequest.updated"
-	SubscriptionEventPullRequestCommented = "ms.vss-code.git-pullrequest-comment-event"
-	SubscriptionEventPullRequestMerged    = "git.pullrequest.merged"
-	SubscriptionEventCodePushed           = "git.push"
-	SubscriptionEventWorkItemCreated      = "workitem.created"
-	SubscriptionEventWorkItemUpdated      = "workitem.updated"
-	SubscriptionEventWorkItemDeleted      = "workitem.deleted"
-	SubscriptionEventWorkItemCommented    = "workitem.commented"
+	PublisherID                                         = "tfs"
+	ConsumerID                                          = "webHooks"
+	ConsumerActionID                                    = "httpRequest"
+	SubscriptionEventPullRequestCreated                 = "git.pullrequest.created"
+	SubscriptionEventPullRequestUpdated                 = "git.pullrequest.updated"
+	SubscriptionEventPullRequestCommented               = "ms.vss-code.git-pullrequest-comment-event"
+	SubscriptionEventPullRequestMerged                  = "git.pullrequest.merged"
+	SubscriptionEventCodePushed                         = "git.push"
+	SubscriptionEventWorkItemCreated                    = "workitem.created"
+	SubscriptionEventWorkItemUpdated                    = "workitem.updated"
+	SubscriptionEventWorkItemDeleted                    = "workitem.deleted"
+	SubscriptionEventWorkItemCommented                  = "workitem.commented"
+	SubscriptionEventBuildCompleted                     = "build.complete"
+	SubscriptionEventReleaseAbandoned                   = "ms.vss-release.release-abandoned-event"
+	SubscriptionEventReleaseCreated                     = "ms.vss-release.release-created-event"
+	SubscriptionEventReleaseDeploymentApprovalCompleted = "ms.vss-release.deployment-approval-completed-event"
+	SubscriptionEventReleaseDeploymentEventPending      = "ms.vss-release.deployment-approval-pending-event"
+	SubscriptionEventReleaseDeploymentCompleted         = "ms.vss-release.deployment-completed-event"
+	SubscriptionEventReleaseDeploymentStarted           = "ms.vss-release.deployment-started-event"
+	SubscriptionEventRunStageApprovalCompleted          = "ms.vss-pipelinechecks-events.approval-completed"
+	SubscriptionEventRunStageStateChanged               = "ms.vss-pipelines.stage-state-changed-event"
+	SubscriptionEventRunStageWaitingForApproval         = "ms.vss-pipelinechecks-events.approval-pending"
+	SubscriptionEventRunStateChanged                    = "ms.vss-pipelines.run-state-changed-event"
 
 	// Path params
 	PathParamTeamID       = "team_id"
@@ -75,12 +90,15 @@ const (
 	QueryParamPerPage     = "per_page"
 
 	// Filters
-	FilterCreatedByMe     = "me"
-	FilterCreatedByAnyone = "anyone"
-	FilterAllChannels     = "all_channels"
-	FilterAll             = "all"
-	FilterBoards          = "boards"
-	FilterRepos           = "repos"
+	FilterCreatedByMe            = "me"
+	FilterCreatedByAnyone        = "anyone"
+	FilterAllChannels            = "all_channels"
+	FilterAll                    = "all"
+	FilterBoards                 = "boards"
+	FilterRepos                  = "repos"
+	EventTypeRelease             = "release"
+	FilterIDReleaseDefinitionID  = "releaseDefinitionId"
+	FilterIDReleaseEnvironmentID = "releaseEnvironmentId"
 
 	DefaultPage         = 0
 	DefaultPerPageLimit = 50
@@ -103,22 +121,25 @@ const (
 	WSEventSubscriptionDeleted = "subscription_deleted"
 
 	// Colors
-	ReposIconColor  = "#d74f27"
-	BoardsIconColor = "#53bba1"
+	ReposIconColor    = "#d74f27"
+	BoardsIconColor   = "#53bba1"
+	PipelineIconColor = "#4275E4"
 
 	SubscriptionEventTypeDummy = "dummy"
 	FileNameGitBranchIcon      = "git-branch-icon.svg"
 	FileNameProjectIcon        = "project-icon.svg"
 	FileNameReposIcon          = "repos-icon.svg"
 	FileNameBoardsIcon         = "boards-icon.svg"
+	FileNamePipeline           = "pipeline-icon.svg"
 	IconColorBoards            = "#53bba1"
 	IconColorRepos             = "#d74f27"
 
 	SlackAttachmentAuthorNameRepos  = "Azure Repos"
 	SlackAttachmentAuthorNameBoards = "Azure Boards"
 
-	ServiceTypeBoards = "boards"
-	ServiceTypeRepos  = "repos"
+	ServiceTypeBoards    = "boards"
+	ServiceTypeRepos     = "repos"
+	ServiceTypePipelines = "pipelines"
 )
 
 var (

server/constants/messages.go

@@ -12,6 +12,7 @@ const (
 	CreatedTask          = "[%s #%d](%s) (%s) was successfully created by %s."
 	TaskTitle            = "[%s #%d: %s](%s)"
 	PullRequestTitle     = "[#%d: %s](%s)"
+	BuildDetailsTitle    = "[#%s](%s): %s"
 	AlreadyLinkedProject = "This project is already linked."
 	NoProjectLinked      = "No project is linked, please link a project."
 

server/constants/oauth_config.go

@@ -2,7 +2,7 @@ package constants
 
 const (
 	ResponseType        = "Assertion"
-	Scopes              = "vso.code_full vso.work_full"
+	Scopes              = "vso.build_execute vso.code_full vso.release_manage vso.work_full"
 	ClientAssertionType = "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"
 	GrantType           = "urn:ietf:params:oauth:grant-type:jwt-bearer"
 	GrantTypeRefresh    = "refresh_token"

server/constants/routes.go

@@ -16,18 +16,17 @@ const (
 	PathGetSubscriptions                    = "/subscriptions/{team_id:[A-Za-z0-9]+}"
 	PathSubscriptionNotifications           = "/notification"
 	PathGetUserChannelsForTeam              = "/channels/{team_id:[A-Za-z0-9]+}"
-	PathGetGitRepositories                  = "/{organization:[A-Za-z0-9-/ ]+}/{project:[A-Za-z0-9-/ ]+}/repositories"
-	PathGetGitRepositoryBranches            = "/{organization:[A-Za-z0-9-/ ]+}/{project:[A-Za-z0-9-/ ]+}/repositories/{repository:[A-Za-z0-9-/]+}/branches"
 	PathGetSubscriptionFilterPossibleValues = "/subscriptions/filters"
 
 	// Azure API paths
 	CreateTask                          = "/%s/%s/_apis/wit/workitems/$%s?api-version=7.1-preview.3"
 	GetTask                             = "%s/%s/_apis/wit/workitems/%s?api-version=7.1-preview.3"
 	GetPullRequest                      = "%s/%s/_apis/git/pullrequests/%s?api-version=6.0"
+	GetBuildDetails                     = "%s/%s/_apis/build/builds/%s?api-version=6.0"
 	GetGitRepositories                  = "%s/%s/_apis/git/repositories?api-version=6.0"
 	GetGitRepositoryBranches            = "%s/%s/_apis/git/repositories/%s/refs?filter=heads"
-	GetSubscriptionFilterPossibleValues = "%s/_apis/hooks/inputValuesQuery?api-version=6.0"
 	GetProject                          = "/%s/_apis/projects/%s?api-version=7.1-preview.4"
 	CreateSubscription                  = "/%s/_apis/hooks/subscriptions?api-version=6.0"
 	DeleteSubscription                  = "/%s/_apis/hooks/subscriptions/%s?api-version=6.0"
+	GetSubscriptionFilterPossibleValues = "%s/_apis/hooks/inputValuesQuery?api-version=6.0"
 )

server/plugin/api.go

@@ -47,8 +47,6 @@ func (p *Plugin) InitRoutes() {
 	s.HandleFunc(constants.PathSubscriptionNotifications, p.handleSubscriptionNotifications).Methods(http.MethodPost)
 	s.HandleFunc(constants.PathSubscriptions, p.handleAuthRequired(p.checkOAuth(p.handleDeleteSubscriptions))).Methods(http.MethodDelete)
 	s.HandleFunc(constants.PathGetUserChannelsForTeam, p.handleAuthRequired(p.getUserChannelsForTeam)).Methods(http.MethodGet)
-	s.HandleFunc(constants.PathGetGitRepositories, p.handleAuthRequired(p.checkOAuth(p.handleGetGitRepositories))).Methods(http.MethodGet)
-	s.HandleFunc(constants.PathGetGitRepositoryBranches, p.handleAuthRequired(p.checkOAuth(p.handleGetGitRepositoryBranches))).Methods(http.MethodGet)
 	s.HandleFunc(constants.PathGetSubscriptionFilterPossibleValues, p.handleAuthRequired(p.checkOAuth(p.handleGetSubscriptionFilterPossibleValues))).Methods(http.MethodPost)
 }
 
@@ -268,6 +266,13 @@ func (p *Plugin) handleCreateSubscription(w http.ResponseWriter, r *http.Request
 		MergeResult:                  body.MergeResult,
 		NotificationType:             body.NotificationType,
 		AreaPath:                     body.AreaPath,
+		BuildStatus:                  body.BuildStatus,
+		BuildPipeline:                body.BuildPipeline,
+		StageName:                    body.StageName,
+		ReleasePipeline:              body.ReleasePipeline,
+		ReleaseStatus:                body.ReleaseStatus,
+		ApprovalType:                 body.ApprovalType,
+		ApprovalStatus:               body.ApprovalStatus,
 	}); isSubscriptionPresent {
 		p.API.LogError(constants.SubscriptionAlreadyPresent, "Error")
 		p.handleError(w, r, &serializers.Error{Code: http.StatusBadRequest, Message: constants.SubscriptionAlreadyPresent})
@@ -325,6 +330,19 @@ func (p *Plugin) handleCreateSubscription(w http.ResponseWriter, r *http.Request
 		NotificationType:                 body.NotificationType,
 		NotificationTypeName:             body.NotificationTypeName,
 		AreaPath:                         body.AreaPath,
+		BuildStatus:                      body.BuildStatus,
+		BuildPipeline:                    body.BuildPipeline,
+		StageName:                        body.StageName,
+		ReleasePipeline:                  body.ReleasePipeline,
+		ReleaseStatus:                    body.ReleaseStatus,
+		ApprovalType:                     body.ApprovalType,
+		ApprovalStatus:                   body.ApprovalStatus,
+		BuildStatusName:                  body.BuildStatusName,
+		StageNameValue:                   body.StageNameValue,
+		ReleasePipelineName:              body.ReleasePipelineName,
+		ReleaseStatusName:                body.ReleaseStatusName,
+		ApprovalTypeName:                 body.ApprovalTypeName,
+		ApprovalStatusName:               body.ApprovalStatusName,
 	}); storeErr != nil {
 		p.API.LogError("Error in creating a subscription", "Error", storeErr.Error())
 		p.handleError(w, r, &serializers.Error{Code: http.StatusInternalServerError, Message: storeErr.Error()})
@@ -408,7 +426,14 @@ func (p *Plugin) handleGetSubscriptions(w http.ResponseWriter, r *http.Request)
 				subscriptionByProject[i].PushedByName+
 				subscriptionByProject[i].MergeResultName+
 				subscriptionByProject[i].NotificationTypeName+
-				subscriptionByProject[i].AreaPath <
+				subscriptionByProject[i].AreaPath+
+				subscriptionByProject[i].ReleasePipelineName+
+				subscriptionByProject[i].BuildPipeline+
+				subscriptionByProject[i].BuildStatusName+
+				subscriptionByProject[i].ApprovalStatusName+
+				subscriptionByProject[i].ApprovalTypeName+
+				subscriptionByProject[i].StageNameValue+
+				subscriptionByProject[i].ReleaseStatusName <
 				subscriptionByProject[j].ChannelName+
 					subscriptionByProject[j].EventType+
 					subscriptionByProject[j].TargetBranch+
@@ -417,7 +442,14 @@ func (p *Plugin) handleGetSubscriptions(w http.ResponseWriter, r *http.Request)
 					subscriptionByProject[j].PushedByName+
 					subscriptionByProject[j].MergeResultName+
 					subscriptionByProject[j].NotificationTypeName+
-					subscriptionByProject[j].AreaPath
+					subscriptionByProject[j].AreaPath+
+					subscriptionByProject[i].ReleasePipelineName+
+					subscriptionByProject[i].BuildPipeline+
+					subscriptionByProject[i].BuildStatusName+
+					subscriptionByProject[i].ApprovalStatusName+
+					subscriptionByProject[i].ApprovalTypeName+
+					subscriptionByProject[i].StageNameValue+
+					subscriptionByProject[i].ReleaseStatusName
 		})
 
 		filteredSubscriptionList, filteredSubscriptionErr := p.GetSubscriptionsForAccessibleChannelsOrProjects(subscriptionByProject, teamID, mattermostUserID)
@@ -637,6 +669,13 @@ func (p *Plugin) handleDeleteSubscriptions(w http.ResponseWriter, r *http.Reques
 		MergeResult:                  body.MergeResult,
 		NotificationType:             body.NotificationType,
 		AreaPath:                     body.AreaPath,
+		BuildStatus:                  body.BuildStatus,
+		BuildPipeline:                body.BuildPipeline,
+		StageName:                    body.StageName,
+		ReleasePipeline:              body.ReleasePipeline,
+		ReleaseStatus:                body.ReleaseStatus,
+		ApprovalType:                 body.ApprovalType,
+		ApprovalStatus:               body.ApprovalStatus,
 	})
 	if !isSubscriptionPresent {
 		p.API.LogError(constants.SubscriptionNotFound)
@@ -664,6 +703,13 @@ func (p *Plugin) handleDeleteSubscriptions(w http.ResponseWriter, r *http.Reques
 		MergeResult:                  body.MergeResult,
 		NotificationType:             body.NotificationType,
 		AreaPath:                     body.AreaPath,
+		BuildStatus:                  body.BuildStatus,
+		BuildPipeline:                body.BuildPipeline,
+		StageName:                    body.StageName,
+		ReleasePipeline:              body.ReleasePipeline,
+		ReleaseStatus:                body.ReleaseStatus,
+		ApprovalType:                 body.ApprovalType,
+		ApprovalStatus:               body.ApprovalStatus,
 	}); deleteErr != nil {
 		p.API.LogError(constants.DeleteSubscriptionError, "Error", deleteErr.Error())
 		p.handleError(w, r, &serializers.Error{Code: http.StatusInternalServerError, Message: deleteErr.Error()})
@@ -787,60 +833,6 @@ func (p *Plugin) handleGetUserAccountDetails(w http.ResponseWriter, r *http.Requ
 	p.writeJSON(w, &userDetails)
 }
 
-func (p *Plugin) handleGetGitRepositories(w http.ResponseWriter, r *http.Request) {
-	mattermostUserID := r.Header.Get(constants.HeaderMattermostUserID)
-
-	pathParams := mux.Vars(r)
-	organization := pathParams[constants.PathParamOrganization]
-	project := pathParams[constants.PathParamProject]
-
-	if len(strings.TrimSpace(organization)) == 0 || len(strings.TrimSpace(project)) == 0 {
-		p.API.LogError(constants.ErrorOrganizationOrProjectQueryParam)
-		p.handleError(w, r, &serializers.Error{Code: http.StatusBadRequest, Message: constants.ErrorOrganizationOrProjectQueryParam})
-		return
-	}
-
-	response, statusCode, err := p.Client.GetGitRepositories(organization, project, mattermostUserID)
-	if err != nil {
-		p.API.LogError("Error in fetching git repositories", err.Error())
-		p.handleError(w, r, &serializers.Error{Code: statusCode, Message: err.Error()})
-		return
-	}
-
-	p.writeJSON(w, response.Value)
-}
-
-func (p *Plugin) handleGetGitRepositoryBranches(w http.ResponseWriter, r *http.Request) {
-	mattermostUserID := r.Header.Get(constants.HeaderMattermostUserID)
-
-	pathParams := mux.Vars(r)
-	organization := strings.TrimSpace(pathParams[constants.PathParamOrganization])
-	project := strings.TrimSpace(pathParams[constants.PathParamProject])
-	repository := strings.TrimSpace(pathParams[constants.PathParamRepository])
-
-	if len(organization) == 0 || len(project) == 0 || len(repository) == 0 {
-		p.API.LogError(constants.ErrorRepositoryPathParam)
-		p.handleError(w, r, &serializers.Error{Code: http.StatusBadRequest, Message: constants.ErrorRepositoryPathParam})
-		return
-	}
-
-	response, statusCode, err := p.Client.GetGitRepositoryBranches(organization, project, repository, mattermostUserID)
-	if err != nil {
-		p.API.LogError("Error in fetching git repository branches", err.Error())
-		p.handleError(w, r, &serializers.Error{Code: statusCode, Message: err.Error()})
-		return
-	}
-
-	// Azure DevOps returns branch name as "refs/heads/<branch-name>", but we need to use only "<branch-name>" so, remove unused part from the name
-	for _, value := range response.Value {
-		if strings.Contains(value.Name, "refs/heads/") && len(value.Name) > 11 {
-			value.Name = value.Name[11:]
-		}
-	}
-
-	p.writeJSON(w, response.Value)
-}
-
 func (p *Plugin) handleGetSubscriptionFilterPossibleValues(w http.ResponseWriter, r *http.Request) {
 	mattermostUserID := r.Header.Get(constants.HeaderMattermostUserID)