[MM-15100] Add /jira assign <issue-key> <assignee> command #60

jfrerich · 2019-05-16T18:56:17Z

Summary
This PR adds the ability to change the assignee of an issue via the MM jira assign slash command.

The go-jira module was also updated to the latest version. The JIRA REST API uses AccountID and version 1.6 of go-jira did not have this field in the jira.User struct fields.

Ticket Link
Please view the following ticket for list of use cases and error handling.
https://mattermost.atlassian.net/browse/MM-15100

@hanzei

* Refactored the JIRA plugin to support more events * Removed Enabled config setting * PR feedback * PR feedback from @hanzei * Added back webhook tests, updated for MD * coverage * Added back formatting as Slack attachments * Add atlassian connect functionality * Updated plugin.json * merged the minimal webapp from hackathon * Updated .gitignore * wip Merged plugin.go from hackathon * wip oauth failures * wip oauth2 with a static clientid seems to work * wip /jira connect seems to work * wip trying JWT webhook setup * wiop * wip * wip connect auth and the beginning of issue * Added webapp from hackathon * Create JIRA Issue is showing up * wip create issue with semi-fakeuser mapping * JWT verification in user-config page * moved JWT verification into auth.go * WIP WIP WIP in the middle of something * wip flow works, need to add encryption * User mapping works * added /jira-disconnect * Fix websocket event handling for connect and add disconnect * WIP fixed websocket initialization * WIP - TODO encrypt Atl account ID in config * Secured the auth flow, passing mm_token and jwt to the final endpoint * Restored legacy webhook support * Process mentions in Webhooks, rearrange files * Point Gopkg.toml at mattermost-server/master for now * Adding comments for posts mentioning JIRA issues * Some error logging * Cleanup * 5.8 compatibility: replace GetBundlePath with old-style config hacking * go test cleanup * Removed unused files * Fixed MM-15004, no lnger requires admin to connect user * wip prefixing and instances - appears to work with connect * MM-15003 Prefix KV keys with the JIRA instance ID - Reworked the kv store functions to use the JIRA BaseURL as a part of the key. - Other cleanup * Added JIRA Server and OAuth1 - Added back OAuth1 functionality - Added `type JIRAInstance` and moved a lot of instance-specific data there - Added "cloud" and "server" instance types, for now with switches - Added `/jira add server url` command to add JIRA Server instances * wip style/naming * JIRA Server auth appears to work * Cosmetic PR feedback, fixed atlassian-connect.json * Fixed a crash if no current JIRAInsttance exists * GetJIRAClient refactor * GetJIRACLient appears to work * CreateIssue works in server and cloud * Added (encoded) URL to Atlassian-connect.json `key` value (e.g. `"mattermost-https-e1ba36fb-ngrok-io"`), making it unique per Mattermost instance. Now can add multiple Mattermost instances to the same JIRA Cloud instance * Removed caching of the project keys in anticipation of the new cache * Webapp CreateIssue: use f.schema.system rather than f.key to identify field keys, this works with JIRA Server and Cloud versions. * Webapp: CreateIssue renderFields: initialize `description` to an empty value to avoid JS errors * PR feedback: ephf -> responsef * Cleanup, /jira command improvements - added `/jira help` - added instance numbers to `/jira instance list`, ability to do `/jira instance select {number}` - style: refactored command.go - style: http naming, and using constants for all routes - style: updated webapp to match - style: eliminated unused oauth2.code * Fixed 2 typos in 1 URL * WIP prep to having a revoke button on the confirm page - fixed a typo in `/jira instance listt` output - removed unused routeOAuth1Connect and related code - renamed StoreOAuth1RequestToken to StoreOneTimeSecret and such * PR feedback (style), expire OTS * PR feedback: Do not change original posts - Do not change the original posts when creating issues - require MM server 5.6 to build - Style, error handling * Fixed "Connect to JIRA" URL in post menu item * PR feedback: added explicit Gopkg.toml deps * PR feedback: style and error handling * PR feedback: more style * Fix tests. * Fix linting. * Removed notify() from webhooks for now, to pass the tests * Uncommented the tests @cristopher took out * Uncommented the test I missed * Minor fixes

* Update README.md * Update README.md * Update README.md

* Proposed text updates for /jira slash commands Feedback welcome * Address review feedback on command.go

* Update instance_server.go * JIRA -> Jira in error text * JIRA > Jira, text update for Jira Server URL help text * Update kv.go * Update message_posted.go * JIRA > Jira * Update user_oauth1.go * Update utils.go * JIRA > Jira * JIRA > Jira * Update create_issue.jsx * Update http.go * JIRA > Jira

* Adjusted the cloud auth flow as per spec - changed cloud user mapping flow: 1. serve a page that retrieves mm_token and auto-resubmits (`/ac/user_redirect.html`) 2. (skipped/not implemented) a confirm page that would displat both usernames, and have a submit button 3. connect the accounts, and serve a summary page with a "Disconnect" button (`/ac/user_connected.html`) 4. disconnect the accounts if the above button is clicked, (`/ac/user_disconnected.html`) - refactored http to use withXxxInstance - refactored use of templates * Added OTS to Jira Cloud user connect flow - Added `Secret` field to `type AuthToken` - Populate `Secret` with a random md5(256bytes) secret - Verify and remove OTS - Added a missing ./server/templates/ac/user_connected.html * Added a confirm page in tthe flow * Cleanup of Jira server connect flow * PR feedback: style * Careful with that lock, Eugene * Style, govet, added a template I missed * CAREFUL with that lock, Eugene * resolved merge conflicts * PR feedback: clarified respondWithTemplate * PR feedback: md5->sha256 * PR feedback: separated Store[Current]JIRAInstance functions * PR feedback: Like _really_ careful with that lock, Eugene

* WIP: Doc updates for roadmap and Jira Server install docs * Update README.md * Update README.md * Update based on feedback

* Adding /jira transition * Moving transitionJiraIssue to a better home.

* Refactor of create-issue modal. * Names feeback.

* Fixed creating server/dist/templates/templates on 2nd make * make the cp switch portable ref: https://unix.stackexchange.com/questions/18712/difference-between-cp-r-and-cp-r-copy-command

* UI fixes for template and menu item * Updating flexparent * Updating templates

Also added `/jira webhook` command to see a URL custom-fit to the current channel

* Added some protections to /installed link * Forgot to reset the timeout back to 15min * PR feedback: Installed flag * Fixed s in URLs * PR feedback: use more consistently * PR feedback: return a 403, not a 401 if already installed

* [MM-14773] [MM-15440] - simplify settings and setup * * restrict `/jira webhook` to system admins; some cleanup * * remove public webhook instructions, remove generate webhook secret * fixups * Update server/command.go Co-Authored-By: Jason Blais <13119842+jasonblais@users.noreply.github.com> * Update server/command.go Co-Authored-By: Jason Blais <13119842+jasonblais@users.noreply.github.com> * PR comments

Upgrade go-jira version

jasonblais · 2019-05-27T19:26:46Z

show matches from search and allow the user to click the correct name to complete the assign task

That sounds like a great idea. Perhaps included within an ephemeral message.

I'd also be happy to smoke test this feature prior to merge, let me know.

mattermod · 2019-06-11T00:00:40Z

This issue 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 @hanzei

…ra into MM-15100

- if if multiple returned users, print the display names as bullet list - limit number of users shown to 10

jfrerich · 2019-06-28T17:10:05Z

@jasonblais After some discussion with @levb we limited the scope of this ticket to the following use cases:

Require minimum of 3 characters in assignee value

Show bullet list of matched users

Show first X users if # users > X. (X = 3 for testing, X = 10 in released code)

issue key not found

User successfully assigned

**help text for /jira assign

jasonblais

Thanks @jfrerich! One text proposal. @levb I know Jason is out next week so if you'd prefer to merge, we can do that and update the text separately. Not a blocker to get this merged.

For requiring at least three characters, I assume that's to avoid returning too many search results?

jasonblais · 2019-06-29T03:16:41Z

server/issue.go

+	maxDisplayedUsers := 10
+	if len(jiraUsers) > 1 {
+
+		errorMsg := fmt.Sprintf("`%s` matches %d users.  Please make your user request unique.\n", assignee, len(jiraUsers))


Suggested change

errorMsg := fmt.Sprintf("`%s` matches %d users. Please make your user request unique.\n", assignee, len(jiraUsers))

errorMsg := fmt.Sprintf("`%s` matches %d users. Please specify a unique assignee.\n", assignee, len(jiraUsers))

@jasonblais, yes the three-character minimum is to avoid returning too many search results and limit Jira from auto-selecting a user that wasn't really intended.

For example:
I used /jira assign EXT-20 a. I was expecting to see use, jason, asaad, and anyone else with an a. Instead, the Jira assigned directly to Asaad.

levb · 2019-07-08T19:29:59Z

server/issue.go

+	}
+
+	// check for valid issue key
+	_, _, err = jiraClient.Issue.Get(issueKey, nil)


Can this check be skipped? I'd imagine the subsequent request(s) would fail on a non-existing ticket anyway...

@levb, this does get checked later it the code if a non-existent issue key is provided. Unfortunately, the message returned by jiraClient.Issue.UpdateAssignee() is generic. In the image below, you can see the two cases. The first is where I handle the err and the second is the return value from Jira.

* iterate through instances when printing out the channel subscriptions update tests for new printing output format don't require --intance for subscribelist * Update tests * shorten field name * several PR feedback fixes * remove unused variable rename map variable * Disconnect users on instance uninstall (#41) * [GH-4] add EE license check (#22) * restrict plugin activation based on license * run go mod tidy -v * wip * add enterprise package * rename license naming to enterprise if user does not have enterprise license, check number of instances installed before allowed to install another cloud or server instance * remove function * fix review feedback * Add license checking tests * wip * wip by Lev * wip * wip * remove comments * remove function to return pointer to true bool value * getMockInstanceStoreKV(0) should return initialized empty store was returning instance store with one instance correct all occurences call of getMockInstanceStoreKV(0) to call with 1 instanance. This fixes many failing tests Add tests for InstallInstance function with extensive license checking * fix linting Co-authored-by: Lev Brouk <lev@mattermost.com> * Fixed #31, #33 (#54) - Use plugin URL as the "home" for app links - Added extra logging for suspicious callbacks - Use templates for `/jira instance install` output * Fix test (#64) * GH-21 Fixed websocket update on user disconnect, instance uninstall (#61) * Fixed websocket update on user disconnect * Revert "Fixed websocket update on user disconnect" This reverts commit 84ca4b27ca2a3ed55408bf359786b3162dc1b29a. * Fixed empty set refresh, defaulting in commands * fixed instance status update * GH-49: Fixed webhook, transition commands (#67) * Use connectInstances array for userConnected redux selector (#71) * Use connectInstances array for userConnected redux selector * add null check * [GH-45] Make sure frontend has up-to-date default instance data (#65) * fetch instances on modal open * Fix errors regarding redux update and missing channelId prop * Get instances when subscribe modal opens * fix tests * Handle case where default instance value in frontend is stale (uninstalled) * Make if statement more safe * Make if statement more safe * fix test * lint * GH-60: Fixed multi-work command alias parsing in webapp (#72) * Fixed --instance Co-authored-by: Lev <1187448+levb@users.noreply.github.com> Co-authored-by: Lev Brouk <lev@mattermost.com> Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com>

…h2 and Added PKCE code for OAuth2 (#953) * Migrate Docs from GitBook (#948) * Migrate Docs from GitBook * Update readme.md * Update readme.md Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> * Update readme.md Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> * Update readme.md Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> --------- Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> * [MI-3153] Fixed issue: comment webhook notification not working * [MI-3153] Added PKCE along with authorization code for getting the access token * [MI-3153] Review fixes * [MI-3159] Review fixes of comments given by Kshitij * [MI-3159] Review fixes given by Ayush * [MI-3159] Removed the code which was forcing the template window to close after user is connected * [MI-3153] Review fixes * [MI-3159] Review fixes * [MI-3159] Review fix * [MI-3282] Added logic to expand issue and issue with DM notification for comment webhook notification (#58) * [MI-3282] Added logic to expand issue in comment webhook notification * [MI-3282] Fix lint errors * [MI-3315] Fixed issue: comment DM notification not working due to invalid API call * [MI-3282] Review fixes * [MI-3282] Review fix * [MI-3331] Review fixes on PR #953 (Comment notification issue) (#60) * [MI-3331] Review fixes on PR #953 (Comment notification issue) * [MI-3331] Added separate condition to check if the instance is a cloud instance or not * [MI-3335] Review fixes on Jira PR #953(Comment notification issue) (#62) 1. Added conditional for separation out the logic for jira cloud and server --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com>

* Initial commit to support OAuth2 authentication * Implemented modal to configure OAuth2 credentials * Made the field names consistent * Removed install_cloud_oauth.md template * Added telemetry tracking for oauth2 setup flow * Fixed typo * Implemented few review comments * Reverted webapp changes * Reverted package-lock.json file * Fixed depreciation * Using refresh token to get another access token * Implemented review comments & QA findings * Implemented few additional review comments * fixed enterprise check while updating instances * Renamed function name for easy understanding * Fixed failing instances test * fix merge issue * fix merge issue 2 * check for cloud oauth instance for comment webhooks * Fixed issue: Comment notification not working after implementing OAuth2 and Added PKCE code for OAuth2 (#953) * Migrate Docs from GitBook (#948) * Migrate Docs from GitBook * Update readme.md * Update readme.md Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> * Update readme.md Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> * Update readme.md Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> --------- Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> * [MI-3153] Fixed issue: comment webhook notification not working * [MI-3153] Added PKCE along with authorization code for getting the access token * [MI-3153] Review fixes * [MI-3159] Review fixes of comments given by Kshitij * [MI-3159] Review fixes given by Ayush * [MI-3159] Removed the code which was forcing the template window to close after user is connected * [MI-3153] Review fixes * [MI-3159] Review fixes * [MI-3159] Review fix * [MI-3282] Added logic to expand issue and issue with DM notification for comment webhook notification (#58) * [MI-3282] Added logic to expand issue in comment webhook notification * [MI-3282] Fix lint errors * [MI-3315] Fixed issue: comment DM notification not working due to invalid API call * [MI-3282] Review fixes * [MI-3282] Review fix * [MI-3331] Review fixes on PR #953 (Comment notification issue) (#60) * [MI-3331] Review fixes on PR #953 (Comment notification issue) * [MI-3331] Added separate condition to check if the instance is a cloud instance or not * [MI-3335] Review fixes on Jira PR #953(Comment notification issue) (#62) 1. Added conditional for separation out the logic for jira cloud and server --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> --------- Co-authored-by: Rohitesh Gupta <1429138+srkgupta@users.noreply.github.com> Co-authored-by: Mattermost Build <build@mattermost.com> Co-authored-by: Raghav Aggarwal <raghav.aggarwal@brightscout.com> Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com>

levb and others added 27 commits April 25, 2019 13:03

Update README.md

a48270e

Revert accidental commit

918faf6

Update README.md (#38)

d6d1389

* Update README.md * Update README.md * Update README.md

Update README.md

0c381e4

quick fix of url

7b82ff1

correct the menu item used in Jira

2e85229

Proposed text updates for /jira slash commands (#41)

f737bf5

* Proposed text updates for /jira slash commands Feedback welcome * Address review feedback on command.go

Doc updates for roadmap and Jira Server install docs (#40)

7991579

* WIP: Doc updates for roadmap and Jira Server install docs * Update README.md * Update README.md * Update based on feedback

MM-15101 Adding /jira transition (#46)

03acbae

* Adding /jira transition * Moving transitionJiraIssue to a better home.

MM-15253 Refactor of create-issue modal. (#44)

33b0a3a

* Refactor of create-issue modal. * Names feeback.

Fixed /jira subcommand parsing consistency (#45)

96bee47

Fixed creating server/dist/templates/templates on a 2nd make (#50)

8ba8802

* Fixed creating server/dist/templates/templates on 2nd make * make the cp switch portable ref: https://unix.stackexchange.com/questions/18712/difference-between-cp-r-and-cp-r-copy-command

small fixes to /jira instance delete (#52)

43eb30e

Some improvments to cloud connect flow. (#55)

6612955

MM-15096 UI fixes for template pages and menu item (#54)

815ad08

* UI fixes for template and menu item * Updating flexparent * Updating templates

Update Jira application link for Cloud (#48)

897cc00

(no ticket?) Fixed a bug in unescaping webhook secret (#53)

10af812

Also added `/jira webhook` command to see a URL custom-fit to the current channel

Update README.md

b17831b

Update README.md

4d8f5a7

Add 'subject to change' for timeline in README

f6dbb7f

Added response logging for Jira API errors (#59)

b8fee88

Added /jira assign <issue-key> <assignee> command

d8505dc

Upgrade go-jira version

jfrerich requested review from jasonblais and levb May 16, 2019 18:56

jfrerich assigned crspeller May 16, 2019

jasonblais mentioned this pull request May 28, 2019

New command /jira unassign <issue-key> #92

Closed

mattermod added the Lifecycle/1:stale label Jun 11, 2019

jasonblais added Lifecycle/frozen and removed Lifecycle/1:stale labels Jun 11, 2019

hanzei added Work In Progress and removed 2: Dev Review Requires review by a core committer labels Jun 21, 2019

jfrerich added 4 commits June 27, 2019 22:17

Merge branch 'MM-15100' of github.com:mattermost/mattermost-plugin-ji…

a785552

…ra into MM-15100

Merge branch 'master' into MM-15100

84bf106

Delete file. It is not in master

19168ed

Add support for assigning issues to jira users

91aec26

- if if multiple returned users, print the display names as bullet list - limit number of users shown to 10

jfrerich requested a review from jasonblais June 28, 2019 17:12

levb approved these changes Jun 28, 2019

View reviewed changes

levb self-requested a review June 28, 2019 17:15

gofmt fix

d75e1d3

jasonblais approved these changes Jun 29, 2019

View reviewed changes

Reword response to user

a3dec9d

levb suggested changes Jul 8, 2019

View reviewed changes

levb approved these changes Jul 8, 2019

View reviewed changes

levb added 4: Reviews Complete All reviewers have approved the pull request and removed Lifecycle/frozen Work In Progress labels Jul 8, 2019

levb merged commit 124c9e4 into master Jul 8, 2019

levb deleted the MM-15100 branch July 8, 2019 20:05

levb added a commit that referenced this pull request Aug 10, 2020

GH-60: Fixed multi-work command alias parsing in webapp (#72)

71d648c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MM-15100] Add /jira assign <issue-key> <assignee> command #60

[MM-15100] Add /jira assign <issue-key> <assignee> command #60

jfrerich commented May 16, 2019

jasonblais commented May 27, 2019

mattermod commented Jun 11, 2019

jfrerich commented Jun 28, 2019 •

edited

Loading

jasonblais left a comment

jasonblais Jun 29, 2019

jfrerich Jul 7, 2019 •

edited

Loading

levb Jul 8, 2019

jfrerich Jul 8, 2019

	errorMsg := fmt.Sprintf("`%s` matches %d users. Please make your user request unique.\n", assignee, len(jiraUsers))
	errorMsg := fmt.Sprintf("`%s` matches %d users. Please specify a unique assignee.\n", assignee, len(jiraUsers))

[MM-15100] Add /jira assign <issue-key> <assignee> command #60

[MM-15100] Add /jira assign <issue-key> <assignee> command #60

Conversation

jfrerich commented May 16, 2019

jasonblais commented May 27, 2019

mattermod commented Jun 11, 2019

jfrerich commented Jun 28, 2019 • edited Loading

jasonblais left a comment

Choose a reason for hiding this comment

jasonblais Jun 29, 2019

Choose a reason for hiding this comment

jfrerich Jul 7, 2019 • edited Loading

Choose a reason for hiding this comment

levb Jul 8, 2019

Choose a reason for hiding this comment

jfrerich Jul 8, 2019

Choose a reason for hiding this comment

jfrerich commented Jun 28, 2019 •

edited

Loading

jfrerich Jul 7, 2019 •

edited

Loading