Add Teams connector #1679

jacobtomlinson · 2020-11-25T17:39:56Z

@FabioRosado and I started working on a Teams connector today.

Things are functional, the bot can receive messages and respond.

Teams is a little weird because the bot has to be @ mentioned in every message in order for it to process it. And to send notification messages to a room the user has to have spoken to the bot in that room at least once. Other than that things are pretty standard.

Tests
Docs

codecov · 2020-11-25T17:42:43Z

Codecov Report

Merging #1679 (32bc6e9) into master (cc45e5a) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #1679   +/-   ##
=======================================
  Coverage   99.28%   99.29%           
=======================================
  Files          78       80    +2     
  Lines        4633     4695   +62     
=======================================
+ Hits         4600     4662   +62     
  Misses         33       33

Impacted Files	Coverage Δ
opsdroid/connector/teams/__init__.py	`100.00% <100.00%> (ø)`
opsdroid/connector/teams/teams.py	`100.00% <100.00%> (ø)`
opsdroid/testing/utils.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cc45e5a...32bc6e9. Read the comment docs.

stale · 2020-12-19T08:31:37Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

cognifloyd · 2020-12-30T18:52:11Z

Is the @ only restriction due to using BotFramework?

FabioRosado · 2020-12-30T19:19:26Z

Is the @ only restriction due to using BotFramework?

When I tried to implement this connector I've used the webhooks approach and that was still the only way to trigger the webhook.

Even the docs say that for you to interact with a bot you need to @ it so it must be a design choice

cognifloyd

Very cool. I just went surfing through the docs to see if I could find anything helpful. Here is what I found.

opsdroid/connector/teams/teams.py

cognifloyd · 2020-12-30T21:58:27Z

opsdroid/connector/teams/teams.py

+            teams_channel_id = self.parse_channel_id(message.target)
+            try:
+                connector_client = await self.adapter.create_connector_client(
+                    self.service_endpoints[teams_channel_id]


Hmm. I wonder if there's another API we could use to get the list of users (and therefore endpoints) in a channel...

botbuilder.core.teams.teams_get_team_info looks promising. It returns a TeamInfo object with methods like get_team_details, get_team_channels, and get_team_members. I wonder if that could be used to generate a list of service_endpoints.
https://docs.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core.teams.teamsinfo?view=botbuilder-py-latest

Another possibility to allow sending messages to channels is to use "incoming webhooks": https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook
Sending cards requires using "the actionable message card format".

Maybe Proactive messaging could also be used to allow sending messages.

Here's an interesting quote:

you can use the Microsoft Graph API to proactively install your bot for your users

And a key piece:

When your app is installed for the user, the bot will receive a conversationUpdate event notification that will contain the necessary information to send the proactive message.

Which would provide all those service endpoints.

Reference docs for how to do this in an app:
https://docs.microsoft.com/en-us/microsoftteams/platform/bots/how-to/conversations/send-proactive-messages?tabs=python

cognifloyd · 2020-12-30T22:09:08Z

opsdroid/connector/teams/teams.py

+from botbuilder.core import (
+    BotFrameworkAdapterSettings,
+    BotFrameworkAdapter,
+    MessageFactory,


core.CardFactory might be helpful in addition to MessageFactory

cognifloyd · 2020-12-30T23:07:07Z

Here's the relevant bit about @ mentioning bots:

Bots in channel and group chat conversations require the user to @ mention the bot to invoke it in a channel.
Bots in a one-to-one conversation do not require an @ mention. All messages sent by the user will be routed to your bot.

https://docs.microsoft.com/en-us/microsoftteams/platform/bots/how-to/conversations/conversation-basics

docs/connectors/teams.md

Co-authored-by: Jacob Floyd <[email protected]>

cognifloyd · 2021-01-04T20:34:28Z

OOH! look what I found:
https://docs.microsoft.com/en-us/graph/api/subscription-post-subscriptions?view=graph-rest-1.0&tabs=http

So, if we step outside of the BotFramework supported APIs and use the graph API, it looks like the bot COULD subscribe to all messages in a channel by subscribing to /teams/{id}/channels/{id}/messages

To use this, there are additional "protected API" restrictions: https://docs.microsoft.com/en-us/graph/teams-protected-apis which means everyone (ie every teams admin adding OpsDroid to their teams tenant(s)) would have to apply for access to use the API for their OpsDroid teams-app in their tenant with https://aka.ms/teamsgraph/requestaccess.

opsdroid/connector/teams/teams.py

jacobtomlinson · 2021-01-05T11:26:08Z

Interesting. It seems strange that you are required to request additional permissions via some web form that is reviewed by a human. Sounds like it could be inconsistent. I wonder what the criteria are for approving these?

I'm not saying we shouldn't do it. But it should probably be in addition to the regular bot APIs.

opsdroid/connector/teams/__init__.py

cognifloyd · 2021-01-13T04:39:25Z

Found out why the tests are freezing. Pip is endlessly backtracking.

This is the culprit:

https://github.com/microsoft/botbuilder-python/blob/4.11.0/libraries/botframework-connector/setup.py#L12

botframework-connector specifies PyJWT==1.5.3 which conflicts with ibm-watson's (well ibm-cloud-sdk-core's) requirement: PyJWT>=1.7.1

I didn't notice this locally because I have an old version of pip installed so I wasn't using the new pip resolver.

Co-authored-by: Jacob Floyd <[email protected]>

It is stripping "/" from the end of URLs now probably due to: matrix-nio/matrix-nio@574a2ee But, it looks like that was their intention all along, so this is a bugfix. This adjusts our tests to not expect the final "/" anymore.

cognifloyd · 2021-06-09T05:18:40Z

stale bot: You're wrong.

stale · 2021-06-26T02:32:51Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

pintman · 2021-07-07T10:34:19Z

I hope the feature will be integrated.

opsdroid/connector/teams/teams.py

…ector

cognifloyd · 2021-07-22T06:51:40Z

I wonder if there are any hooks we can use to control uuid generation in the teams lib. Maybe a fixture that makes uuid.uuid() or similar (whatever it is using to generate the uuid) return something consistent?

jacobtomlinson · 2021-07-22T09:41:50Z

I wonder if there are any hooks we can use to control uuid generation in the teams lib.

Possibly! I'd rather avoid digging too deep into the teams SDK. I was thinking about trying to write a custom VCR handler which stripped the uuid. But patching uuid.uuid() might be a better call.

jacobtomlinson · 2021-07-25T21:15:33Z

Found the uuid call that is causing me a headache!

https://github.com/microsoft/botbuilder-python/blob/70fee41f4f122143fd27ac22dc17642642d915c3/libraries/botbuilder-core/botbuilder/core/conversation_reference_extension.py#L16

cognifloyd

Wow. 😥
Looking at the coverage, I think adding a bit to the test will test the rest of the significant code.

Also, I'm not sure what the docker/pip test failure is about.

opsdroid/connector/teams/tests/test_connector_teams.py

jacobtomlinson · 2021-07-29T20:25:42Z

@cognifloyd you've been great at reviewing here. Do you want to give this a last pass and hit the big green button?

Add Teams connector

0b4fd8b

jacobtomlinson and others added 2 commits November 27, 2020 10:05

Linting and one small test

f234db6

Merge branch 'master' into teams-connector

12cbf1b

stale bot added the stale label Dec 19, 2020

stale bot removed the stale label Dec 30, 2020

This was referenced Dec 30, 2020

ChatOps Roadmap Meeting (17 Nov 2020) StackStorm/community#56

Closed

Proposal: Move away from JS-based st2chatops StackStorm/community#8

Closed

cognifloyd reviewed Dec 30, 2020

View reviewed changes

docs/connectors/teams.md Outdated Show resolved Hide resolved

Update docs/connectors/teams.md

d5dcfaf

Co-authored-by: Jacob Floyd <[email protected]>

cognifloyd reviewed Jan 4, 2021

View reviewed changes

opsdroid/connector/teams/teams.py Outdated Show resolved Hide resolved

blag mentioned this pull request Jan 12, 2021

TSC Meeting (12 Jan 2021), v3.4.0 StackStorm/community#60

Closed

Merge branch 'master' into teams-connector

0049e86

cognifloyd reviewed Jan 12, 2021

View reviewed changes

opsdroid/connector/teams/__init__.py Outdated Show resolved Hide resolved

cognifloyd added 3 commits January 12, 2021 18:24

add tox timeouts to github ci workflow

475698c

fix pydocstyle exclude

1bdb2aa

temporarily increase verbosity to debug gha

c2dc5a0

jacobtomlinson and others added 3 commits January 13, 2021 09:45

Update opsdroid/connector/teams/__init__.py

0f31b15

Co-authored-by: Jacob Floyd <[email protected]>

fix botbuilder deps with modified wheels

e2a6e76

Merge branch 'master' into teams-connector

40a9204

cognifloyd force-pushed the teams-connector branch from 8dc26ff to 40a9204 Compare January 18, 2021 20:57

Adjust tests for matrix-nio==0.16.0

504246b

It is stripping "/" from the end of URLs now probably due to: matrix-nio/matrix-nio@574a2ee But, it looks like that was their intention all along, so this is a bugfix. This adjusts our tests to not expect the final "/" anymore.

stale bot removed the stale label Jun 9, 2021

stale bot added the stale label Jun 26, 2021

stale bot removed the stale label Jul 7, 2021

pintman reviewed Jul 7, 2021

View reviewed changes

opsdroid/connector/teams/teams.py Outdated Show resolved Hide resolved

pintman reviewed Jul 7, 2021

View reviewed changes

opsdroid/connector/teams/teams.py Outdated Show resolved Hide resolved

jacobtomlinson added 2 commits July 18, 2021 22:26

Fix docstrings

c6f63a0

Merge branch 'master' of github.com:opsdroid/opsdroid into teams-conn…

c0e4389

…ector

jacobtomlinson added 4 commits July 24, 2021 20:02

Mock uuid in tests

7aa8183

Remove duplicated call

69cf7b3

Update VCR

34f4108

Patch the right uuid call

3f5f2d3

cognifloyd reviewed Jul 26, 2021

View reviewed changes

opsdroid/connector/teams/tests/test_connector_teams.py Show resolved Hide resolved

jacobtomlinson added 8 commits July 28, 2021 21:16

Add more tests

b4ec278

Send message to target by string

d486912

Move ping message to channel instead of DM

f69abb7

Fix payloads

71993a2

Add cargo

94ef83a

Invalid message target

9509cb6

Test string target properly

33b2735

Send to room not spoken in before

32bc6e9

cognifloyd approved these changes Jul 30, 2021

View reviewed changes

cognifloyd merged commit a45490d into opsdroid:master Jul 30, 2021

jacobtomlinson deleted the teams-connector branch July 30, 2021 14:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Teams connector #1679

Add Teams connector #1679

jacobtomlinson commented Nov 25, 2020 •

edited

Loading

codecov bot commented Nov 25, 2020 •

edited

Loading

stale bot commented Dec 19, 2020

cognifloyd commented Dec 30, 2020

FabioRosado commented Dec 30, 2020

cognifloyd left a comment

cognifloyd Dec 30, 2020

cognifloyd Dec 30, 2020

cognifloyd Dec 30, 2020

cognifloyd Dec 30, 2020

cognifloyd commented Dec 30, 2020

cognifloyd commented Jan 4, 2021 •

edited

Loading

jacobtomlinson commented Jan 5, 2021

cognifloyd commented Jan 13, 2021 •

edited

Loading

cognifloyd commented Jun 9, 2021

stale bot commented Jun 26, 2021

pintman commented Jul 7, 2021

cognifloyd commented Jul 22, 2021

jacobtomlinson commented Jul 22, 2021

jacobtomlinson commented Jul 25, 2021

cognifloyd left a comment •

edited

Loading

jacobtomlinson commented Jul 29, 2021

Add Teams connector #1679

Add Teams connector #1679

Conversation

jacobtomlinson commented Nov 25, 2020 • edited Loading

codecov bot commented Nov 25, 2020 • edited Loading

Codecov Report

stale bot commented Dec 19, 2020

cognifloyd commented Dec 30, 2020

FabioRosado commented Dec 30, 2020

cognifloyd left a comment

Choose a reason for hiding this comment

cognifloyd Dec 30, 2020

Choose a reason for hiding this comment

cognifloyd Dec 30, 2020

Choose a reason for hiding this comment

cognifloyd Dec 30, 2020

Choose a reason for hiding this comment

cognifloyd Dec 30, 2020

Choose a reason for hiding this comment

cognifloyd commented Dec 30, 2020

cognifloyd commented Jan 4, 2021 • edited Loading

jacobtomlinson commented Jan 5, 2021

cognifloyd commented Jan 13, 2021 • edited Loading

cognifloyd commented Jun 9, 2021

stale bot commented Jun 26, 2021

pintman commented Jul 7, 2021

cognifloyd commented Jul 22, 2021

jacobtomlinson commented Jul 22, 2021

jacobtomlinson commented Jul 25, 2021

cognifloyd left a comment • edited Loading

Choose a reason for hiding this comment

jacobtomlinson commented Jul 29, 2021

jacobtomlinson commented Nov 25, 2020 •

edited

Loading

codecov bot commented Nov 25, 2020 •

edited

Loading

cognifloyd commented Jan 4, 2021 •

edited

Loading

cognifloyd commented Jan 13, 2021 •

edited

Loading

cognifloyd left a comment •

edited

Loading