Support the MS Teams Tab App #1942

lieut-data · 2024-09-13T17:08:48Z

Summary

This is the "backend" for https://github.com/mattermost/mattermost-teams-tab, allowing colleagues in Teams to connect to a Mattermost server, proving their membership in a configured tenant via the Microsoft ID token, and getting read-only access to playbook runs that have explicitly invited the @msteams bot.

Ticket Link

Fixes: https://mattermost.atlassian.net/browse/MM-60362
Fixes: https://mattermost.atlassian.net/browse/MM-60363
Fixes: https://mattermost.atlassian.net/browse/MM-60366
Fixes: https://mattermost.atlassian.net/browse/MM-60367
Fixes: https://mattermost.atlassian.net/browse/MM-60368

Checklist

Unit tests updated

lieut-data · 2024-09-13T17:10:54Z

client/actions.go

@@ -18,7 +18,7 @@ type ActionsService struct {
 // Create an action. Returns the id of the newly created action.
 func (s *ActionsService) Create(ctx context.Context, channelID string, opts ChannelActionCreateOptions) (string, error) {
 	actionURL := fmt.Sprintf("actions/channels/%s", channelID)
-	req, err := s.client.newRequest(http.MethodPost, actionURL, opts)
+	req, err := s.client.newAPIRequest(http.MethodPost, actionURL, opts)


This is the first in a series of s/newRequest/newAPIRequest/ to allow the client package to be used with non-/api endpoints.

lieut-data · 2024-09-13T17:11:26Z

client/tabapp.go

+}
+
+func (s *TabAppService) GetRuns(ctx context.Context, token string, options TabAppGetRunsOptions) (*TabAppResults, error) {
+	url := fmt.Sprintf("plugins/%s/tabapp/runs", manifestID)


We don't use the /api endpoint directly here.

lieut-data · 2024-09-13T17:11:55Z

go.mod

@@ -1,6 +1,8 @@
 module github.com/mattermost/mattermost-plugin-playbooks

-go 1.19
+go 1.21


This came for free -- trusting to e2e tests for coverage here.

Same comment as above, but only if no additional changes are needed. otherwise bumping to 1.22 can happen independently.

lieut-data · 2024-09-13T17:12:11Z

plugin.json

-            "help_text": "Enable experimental features that come with in-progress UI, bugs, and cool stuff."
-        }
-        ]
+  "id": "playbooks",


Noisy because of some whitespace cleanup.

lieut-data · 2024-09-13T17:12:33Z

server/api/api.go

@@ -41,8 +41,8 @@ func NewHandler(pluginAPI *pluginapi.Client, config config.Service) *Handler {
 	}

 	root := mux.NewRouter()
+	root.Use(LogRequest)


Moving this to the root to log all requests, not just those on api/.

lieut-data · 2024-09-13T17:12:51Z

server/api/permutation_test.go

@@ -0,0 +1,91 @@
+package api


Copied verbatim from the MS Teams plugin to help with testing permutations -- will lift this to a common place soonish.

lieut-data · 2024-09-13T17:13:07Z

server/api/tabapp.go

+	MicrosoftTeamsAppDomain = "https://playbooks.integrations.mattermost.com"
+	ExpectedAudience        = "api://playbooks.integrations.mattermost.com/8f7d5beb-ed24-4d95-aa31-c26298d5a982"


Both hard-coded to match our production deploy.

lieut-data · 2024-09-13T17:13:43Z

server/api/tabapp_test.go

+)
+
+// TestValidateToken was inspired by https://github.com/MicahParks/keyfunc/blob/main/keyfunc_test.go.
+func TestValidateToken(t *testing.T) {


These unit tests focus on the validation of the token -- I've added top-level tests that focus on the tabapp results themselves.

lieut-data · 2024-09-13T17:14:10Z

server/api/tabapp_test.go

+			assert.Equal(t, http.StatusUnauthorized, validationErr.StatusCode)
+		})
+
+		t.Run("hmac key pretending to be rsa", func(t *testing.T) {


cc @esarafianou

lieut-data · 2024-09-13T17:14:48Z

server/api_tabapp_test.go

+
+	t.Run("CORS headers, mis-matched Origin header, developer mode", func(t *testing.T) {
+		setTabApp(t, true)
+		setDeveloperMode(t, true)


We basically only test with developer mode, as we can't spoof a token for the production configuration.

lieut-data · 2024-09-13T23:46:55Z

Swapping @sbishel for @crspeller given the dual overlap of Playbook and the "Fast Futures" nature of this initiative.

esarafianou

Thank you Jesse! One comment around Full name and two optional comments

esarafianou · 2024-09-16T08:54:38Z

server/api/tabapp.go

+			FirstName: user.FirstName,
+			LastName:  user.LastName,


We need the same check for the Full name option as when we collect participants.

Gah, thank you @esarafianou -- this was the last change I addressed and I should have given this a bit more "brain soak" time. Will address!

esarafianou · 2024-09-16T09:10:13Z

.github/workflows/ci.yaml

@@ -11,7 +11,7 @@ defaults:

 env:
  TERM: xterm
-  GO_VERSION: 1.19.5
+  GO_VERSION: 1.21.13


Since we're updating it here, can we have it match the mattermost golang version: https://github.com/mattermost/mattermost/blob/master/server/go.mod#L3-L5 ?

esarafianou · 2024-09-16T09:12:36Z

go.mod

@@ -1,6 +1,8 @@
 module github.com/mattermost/mattermost-plugin-playbooks

-go 1.19
+go 1.21


Same comment as above, but only if no additional changes are needed. otherwise bumping to 1.22 can happen independently.

esarafianou

Marking this as requested changes for the Full name one

JulienTant · 2024-09-19T16:07:51Z

client/tabapp.go

+	if err != nil {
+		return nil, err
+	}
+	resp.Body.Close()


nit because unsure: errcheck?

JulienTant · 2024-09-19T16:27:34Z

server/tabapp.go

+			Username:    "msteams",
+			DisplayName: "MS Teams",
+			OwnerId:     "playbooks",
+		}


If the MSTeams plugin is not installed, and as a consequence we don't have the MSTeams bot, what's the advantage of creating a MSTeams bot here instead of using the Playbooks one?

I'm just thinking if the name of the MSTeams bot has to be changed for some reason or we want to update the avatar for the bot, we'll have to remember to do it everywhere 😅

JulienTant

Sorry it took me a minute to review. Swapping my review into "Approved" as I don't have anything that is a blocker to move forward.

lieut-data added 5 commits September 13, 2024 14:06

formatting: plugin.json

aa68c84

move LogRequest to root

9f4dc88

newRequest -> newAPIRequest

f2e0ff1

unset MM_SERVICESETTINGS_ENABLEDEVELOPER during tests

0590f07

tab app configuration and endpoint

5b29527

lieut-data commented Sep 13, 2024

View reviewed changes

lieut-data requested review from JulienTant and sbishel September 13, 2024 17:15

lieut-data added the 2: Dev Review Requires review by a core committer label Sep 13, 2024

lieut-data marked this pull request as ready for review September 13, 2024 17:16

bump workflows Go version

dc143d1

lieut-data requested review from esarafianou and crspeller and removed request for sbishel September 13, 2024 17:24

lieut-data added the 3: Security Review Review requested from Security Team label Sep 13, 2024

esarafianou reviewed Sep 16, 2024

View reviewed changes

esarafianou requested changes Sep 16, 2024

View reviewed changes

lieut-data added 2 commits September 16, 2024 09:59

update Go to v1.22.6

e80b3f0

consistently getLimitedUser

92a3755

lieut-data requested a review from esarafianou September 16, 2024 15:02

esarafianou approved these changes Sep 16, 2024

View reviewed changes

esarafianou removed the 3: Security Review Review requested from Security Team label Sep 17, 2024

JulienTant reviewed Sep 19, 2024

View reviewed changes

JulienTant approved these changes Sep 19, 2024

View reviewed changes

lieut-data mentioned this pull request Sep 19, 2024

Upgrade go #1944

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support the MS Teams Tab App #1942

Support the MS Teams Tab App #1942

lieut-data commented Sep 13, 2024 •

edited

Loading

lieut-data Sep 13, 2024

lieut-data Sep 13, 2024

lieut-data Sep 13, 2024

esarafianou Sep 16, 2024

lieut-data Sep 13, 2024

lieut-data Sep 13, 2024

lieut-data Sep 13, 2024

lieut-data Sep 13, 2024

lieut-data Sep 13, 2024

lieut-data Sep 13, 2024

lieut-data Sep 13, 2024

lieut-data commented Sep 13, 2024

esarafianou left a comment

esarafianou Sep 16, 2024

lieut-data Sep 16, 2024

esarafianou Sep 16, 2024

esarafianou Sep 16, 2024

esarafianou left a comment

JulienTant Sep 19, 2024

JulienTant Sep 19, 2024

JulienTant left a comment

		MicrosoftTeamsAppDomain = "https://playbooks.integrations.mattermost.com"
		ExpectedAudience = "api://playbooks.integrations.mattermost.com/8f7d5beb-ed24-4d95-aa31-c26298d5a982"

Support the MS Teams Tab App #1942

Are you sure you want to change the base?

Support the MS Teams Tab App #1942

Conversation

lieut-data commented Sep 13, 2024 • edited Loading

Summary

Ticket Link

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lieut-data commented Sep 13, 2024

esarafianou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

esarafianou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JulienTant left a comment

Choose a reason for hiding this comment

lieut-data commented Sep 13, 2024 •

edited

Loading