[MI-2061]: Refactoring and optimisations around Forms, RTK query, and types and constants management

server/constants/constants.go

@@ -3,25 +3,23 @@ package constants
 const (
 	// Bot configs
 	BotUsername    = "azuredevops"
-	BotDisplayName = "Azure Devops"
-	BotDescription = "A bot account created by the Azure Devops plugin."
+	BotDisplayName = "Azure DevOps"
+	BotDescription = "A bot account created by the Azure DevOps plugin."
 
 	// Plugin configs
 	PluginID               = "mattermost-plugin-azure-devops"
 	ChannelID              = "channel_id"
 	HeaderMattermostUserID = "Mattermost-User-ID"
-	// TODO: Change later according to the needs.
-	HeaderMattermostUserIDAPI = "User-ID"
 
 	// Command configs
 	CommandTriggerName = "azuredevops"
-	HelpText           = "###### Mattermost Azure Devops Plugin - Slash Command Help\n"
-	InvalidCommand     = "Invalid command parameters. Please use `/azuredevops help` for more information."
-
-	// Azure API Routes
-	CreateTask = "/%s/%s/_apis/wit/workitems/$%s?api-version=7.1-preview.3"
-	GetTask    = "%s/_apis/wit/workitems/%s?api-version=7.1-preview.3"
-	GetProject = "/%s/_apis/projects/%s?api-version=7.1-preview.4"
+	HelpText           = "###### Mattermost Azure DevOps Plugin - Slash Command Help\n" +
+		"* `/azuredevops connect` - Connect your Mattermost account to your Azure DevOps account.\n" +
+		"* `/azuredevops disconnect` - Disconnect your Mattermost account from your Azure DevOps account.\n" +
+		"* `/azuredevops link [projectURL]` - Link your project to a current channel.\n" +
+		"* `/azuredevops boards create [title] [description]` - Create a new task for your project.\n" +
+		"* `/azuredevops subscribe` - Create subscriptions to track changes in tasks for your linked projects.\n"
+	InvalidCommand = "Invalid command parameters. Please use `/azuredevops help` for more information."
 
 	// Get task link preview constants
 	HTTPS              = "https:"
@@ -35,6 +33,20 @@ const (
 	TasksIDAPIVersion    = "5.1"
 	TasksAPIVersion      = "6.0"
 
+	// Subscription constants
+	PublisherID      = "tfs"
+	ConsumerID       = "webHooks"
+	ConsumerActionID = "httpRequest"
+	Create           = "create"
+	Update           = "update"
+	Delete           = "delete"
+
+	// Path params
+	PathParamTeamID = "team_id"
+
+	// URL query params constants
+	ProjectParam = "project"
+
 	// Authorization constants
 	Bearer        = "Bearer"
 	Authorization = "Authorization"
@@ -45,4 +57,8 @@ const (
 	PageQueryParam       = "$top"
 	APIVersionQueryParam = "api-version"
 	IDsQueryParam        = "ids"
+
+	// Websocket events
+	WSEventConnect    = "connect"
+	WSEventDisconnect = "disconnect"
 )

server/constants/messages.go

@@ -2,27 +2,46 @@ package constants
 
 const (
 	// TODO: all these messages are to be verified from Mike at the end
-	GenericErrorMessage             = "Something went wrong, please try again later"
+	// Generic
+	GenericErrorMessage  = "Something went wrong, please try again later"
+	ConnectAccount       = "[Click here to connect your Azure DevOps account](%s%s)"
+	ConnectAccountFirst  = "Your Azure DevOps account is not connected \n%s"
+	UserConnected        = "Your Azure DevOps account is successfully connected!"
+	UserAlreadyConnected = "Your Azure DevOps account is already connected"
+	UserDisconnected     = "Your Azure DevOps account is now disconnected"
+	CreatedTask          = "Link for newly created task: %s"
+	TaskTitle            = "[%s #%d: %s](%s)"
+	TaskPreviewMessage   = "State: %s\nAssigned To: %s\nDescription: %s"
+	AlreadyLinkedProject = "This project is already linked."
+	NoProjectLinked      = "No project is linked, please link a project."
+
+	// Validations Errors
+	OrganizationRequired = "organization is required"
+	ProjectRequired      = "project is required"
+	TaskTypeRequired     = "task type is required"
+	TaskTitleRequired    = "task title is required"
+	EventTypeRequired    = "event type is required"
+	ChannelIDRequired    = "channel ID is required"
+)
+
+const (
+	// Error messages
 	Error                           = "error"
 	NotAuthorized                   = "not authorized"
-	OrganizationRequired            = "organization is required"
-	ProjectRequired                 = "project is required"
-	TaskTypeRequired                = "task type is required"
-	TaskTitleRequired               = "task title is required"
-	ConnectAccount                  = "[Click here to link your Azure DevOps account](%s%s)"
-	ConnectAccountFirst             = "You do not have any Azure Devops account connected. Kindly link the account first"
-	UserConnected                   = "Your Azure Devops account is succesfully connected!"
-	UserAlreadyConnected            = "Your Azure Devops account is already connected"
-	UserDisconnected                = "Your Azure Devops account is now disconnected"
 	UnableToDisconnectUser          = "Unable to disconnect user"
 	UnableToCheckIfAlreadyConnected = "Unable to check if user account is already connected"
 	UnableToStoreOauthState         = "Unable to store oAuth state for the userID %s"
 	AuthAttemptExpired              = "Authentication attempt expired, please try again"
 	InvalidAuthState                = "Invalid oauth state, please try again"
-	CreatedTask                     = "Link for newly created task: %s"
-	TaskTitle                       = "[%s #%d: %s](%s)"
-	TaskPreviewMessage              = "**State:** %s\n**Assigned To:** %s\n**Description:** %s"
-	AlreadyLinkedProject            = "This project is already linked."
 	GetProjectListError             = "Error getting Project List"
 	ErrorFetchProjectList           = "Error in fetching project list"
+	ErrorDecodingBody               = "Error in decoding body"
+	ProjectNotFound                 = "Requested project does not exists"
+	ErrorUnlinkProject              = "Error in unlinking the project"
+	FetchSubscriptionListError      = "Error in fetching subscription list"
+	CreateSubscriptionError         = "Error in creating subscription"
+	ProjectNotLinked                = "Requested project is not linked"
+	GetSubscriptionListError        = "Error getting Subscription List"
+	SubscriptionAlreadyPresent      = "Requested subscription already exists"
+	SubscriptionNotFound            = "Requested subscription does not exists"
 )

server/constants/oauth_config.go

@@ -5,6 +5,7 @@ const (
 	Scopes              = "vso.code 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"
 
 	// URL
 	BaseOauthURL = "https://app.vssps.visualstudio.com"

server/constants/routes.go

@@ -2,9 +2,24 @@ package constants
 
 const (
 	// Plugin API Routes
-	APIPrefix                = "/api/v1"
-	WildRoute                = "{anything:.*}"
-	PathOAuthConnect         = "/oauth/connect"
-	PathOAuthCallback        = "/oauth/complete"
-	PathGetAllLinkedProjects = "/link/project"
+	APIPrefix                     = "/api/v1"
+	WildRoute                     = "{anything:.*}"
+	PathOAuthConnect              = "/oauth/connect"
+	PathOAuthCallback             = "/oauth/complete"
+	PathLinkedProjects            = "/project/link"
+	PathGetAllLinkedProjects      = "/project/link"
+	PathUnlinkProject             = "/project/unlink"
+	PathUser                      = "/user"
+	PathCreateTasks               = "/tasks"
+	PathLinkProject               = "/link"
+	PathSubscriptions             = "/subscriptions"
+	PathSubscriptionNotifications = "/notification"
+	PathGetUserChannelsForTeam    = "/channels/{team_id:[A-Za-z0-9]+}"
+
+	// Azure API paths
+	CreateTask         = "/%s/%s/_apis/wit/workitems/$%s?api-version=7.1-preview.3"
+	GetTask            = "%s/_apis/wit/workitems/%s?api-version=7.1-preview.3"
+	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"
 )

server/constants/store.go

@@ -8,7 +8,8 @@ const (
 	TTLSecondsForOAuthState int64 = 60
 
 	// KV store prefix keys
-	OAuthPrefix   = "oAuth_%s"
-	ProjectKey    = "%s_%s"
-	ProjectPrefix = "project_list"
+	OAuthPrefix        = "oAuth_%s"
+	ProjectKey         = "%s_%s"
+	ProjectPrefix      = "project_list"
+	SubscriptionPrefix = "subscription_list"
 )