-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Initial support for outbound webhooks. * Refactor outbound into it's own connection type. * Add support for media / encrypted media. * Ensure we configure a sensible User Agent * Add a test for outbound webhooks * Checkpoint for feature completeness. * Lint tidy * Finish up media tests. * changelog * Add outbound documentation * update default config * fix tests
- Loading branch information
Showing
18 changed files
with
840 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Add support for new connection type "Outgoing Webhooks". This feature allows you to send outgoing HTTP requests to other services | ||
| when a message appears in a Matrix room. See [the documentation](https://matrix-org.github.io/matrix-hookshot/latest/setup/webhooks.html) | ||
| for help with this feature. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,8 +48,8 @@ | |
| "@octokit/rest": "^20.0.2", | ||
| "@octokit/webhooks": "^12.0.10", | ||
| "@sentry/node": "^7.52.1", | ||
| "@vector-im/compound-design-tokens": "^0.1.0", | ||
| "@vector-im/compound-web": "^0.9.4", | ||
| "@vector-im/compound-design-tokens": "^1.3.0", | ||
| "@vector-im/compound-web": "^4.8.0", | ||
| "ajv": "^8.11.0", | ||
| "axios": "^1.6.3", | ||
| "cors": "^2.8.5", | ||
|
|
@@ -86,6 +86,7 @@ | |
| "@rollup/plugin-alias": "^5.1.0", | ||
| "@tsconfig/node18": "^18.2.2", | ||
| "@types/ajv": "^1.0.0", | ||
| "@types/busboy": "^1.5.4", | ||
| "@types/chai": "^4.2.22", | ||
| "@types/cors": "^2.8.12", | ||
| "@types/express": "^4.17.14", | ||
|
|
@@ -100,6 +101,7 @@ | |
| "@typescript-eslint/eslint-plugin": "^6.17.0", | ||
| "@typescript-eslint/parser": "^6.17.0", | ||
| "@uiw/react-codemirror": "^4.12.3", | ||
| "busboy": "^1.6.0", | ||
| "chai": "^4.3.4", | ||
| "eslint": "^8.49.0", | ||
| "eslint-config-preact": "^1.3.0", | ||
|
|
@@ -116,5 +118,6 @@ | |
| "ts-node": "^10.9.1", | ||
| "typescript": "^5.3.3", | ||
| "vite": "^5.0.13" | ||
| } | ||
| }, | ||
| "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e" | ||
| } | ||
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| import { E2ESetupTestTimeout, E2ETestEnv, E2ETestMatrixClient } from "./util/e2e-test"; | ||
| import { describe, it, beforeEach, afterEach } from "@jest/globals"; | ||
| import { OutboundHookConnection } from "../src/Connections"; | ||
| import { TextualMessageEventContent } from "matrix-bot-sdk"; | ||
| import { IncomingHttpHeaders, createServer } from "http"; | ||
| import busboy, { FileInfo } from "busboy"; | ||
| import { TEST_FILE } from "./util/fixtures"; | ||
|
|
||
| async function createOutboundConnection(user: E2ETestMatrixClient, botMxid: string, roomId: string) { | ||
| const join = user.waitForRoomJoin({ sender: botMxid, roomId }); | ||
| const connectionEvent = user.waitForRoomEvent({ | ||
| eventType: OutboundHookConnection.CanonicalEventType, | ||
| stateKey: 'test', | ||
| sender: botMxid | ||
| }); | ||
| await user.inviteUser(botMxid, roomId); | ||
| await user.setUserPowerLevel(botMxid, roomId, 50); | ||
| await join; | ||
|
|
||
| // Note: Here we create the DM proactively so this works across multiple | ||
| // tests. | ||
| // Get the DM room so we can get the token. | ||
| const dmRoomId = await user.dms.getOrCreateDm(botMxid); | ||
|
|
||
| await user.sendText(roomId, '!hookshot outbound-hook test http://localhost:8111/test-path'); | ||
| // Test the contents of this. | ||
| await connectionEvent; | ||
|
|
||
| const msgPromise = user.waitForRoomEvent({ sender: botMxid, eventType: "m.room.message", roomId: dmRoomId }); | ||
| const { data: msgData } = await msgPromise; | ||
|
|
||
| const [_match, token ] = /<code>(.+)<\/code>/.exec((msgData.content as unknown as TextualMessageEventContent).formatted_body ?? "") ?? []; | ||
| return token; | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @returns | ||
| */ | ||
| function awaitOutboundWebhook() { | ||
| return new Promise<{headers: IncomingHttpHeaders, files: {name: string, file: Buffer, info: FileInfo}[]}>((resolve, reject) => { | ||
| const server = createServer((req, res) => { | ||
| const bb = busboy({headers: req.headers}); | ||
| const files: {name: string, file: Buffer, info: FileInfo}[] = []; | ||
| bb.on('file', (name, stream, info) => { | ||
| const buffers: Buffer[] = []; | ||
| stream.on('data', d => { | ||
| buffers.push(d) | ||
| }); | ||
| stream.once('close', () => { | ||
| files.push({name, info, file: Buffer.concat(buffers)}) | ||
| }); | ||
| }); | ||
|
|
||
| bb.once('close', () => { | ||
| res.writeHead(200, { 'Content-Type': 'text/plain' }); | ||
| res.end('OK'); | ||
| resolve({ | ||
| headers: req.headers, | ||
| files, | ||
| }); | ||
| clearTimeout(timer); | ||
| server.close(); | ||
| }); | ||
|
|
||
| req.pipe(bb); | ||
| }); | ||
| server.listen(8111); | ||
| let timer: NodeJS.Timeout; | ||
| timer = setTimeout(() => { | ||
| reject(new Error("Request did not arrive")); | ||
| server.close(); | ||
| }, 10000); | ||
|
|
||
| }); | ||
| } | ||
|
|
||
| describe('OutboundHooks', () => { | ||
| let testEnv: E2ETestEnv; | ||
|
|
||
| beforeAll(async () => { | ||
| const webhooksPort = 9500 + E2ETestEnv.workerId; | ||
| testEnv = await E2ETestEnv.createTestEnv({ | ||
| matrixLocalparts: ['user'], | ||
| config: { | ||
| generic: { | ||
| enabled: true, | ||
| outbound: true, | ||
| urlPrefix: `http://localhost:${webhooksPort}` | ||
| }, | ||
| listeners: [{ | ||
| port: webhooksPort, | ||
| bindAddress: '0.0.0.0', | ||
| // Bind to the SAME listener to ensure we don't have conflicts. | ||
| resources: ['webhooks'], | ||
| }], | ||
| } | ||
| }); | ||
| await testEnv.setUp(); | ||
| }, E2ESetupTestTimeout); | ||
|
|
||
| afterAll(() => { | ||
| return testEnv?.tearDown(); | ||
| }); | ||
|
|
||
| it('should be able to create a new webhook and push an event.', async () => { | ||
| const user = testEnv.getUser('user'); | ||
| const roomId = await user.createRoom({ name: 'My Test Webhooks room'}); | ||
| const token = await createOutboundConnection(user, testEnv.botMxid, roomId); | ||
| const gotWebhookRequest = awaitOutboundWebhook(); | ||
|
|
||
| const eventId = await user.sendText(roomId, 'hello!'); | ||
| const { headers, files } = await gotWebhookRequest; | ||
| expect(headers['x-matrix-hookshot-roomid']).toEqual(roomId); | ||
| expect(headers['x-matrix-hookshot-eventid']).toEqual(eventId); | ||
| expect(headers['x-matrix-hookshot-token']).toEqual(token); | ||
|
|
||
| // And check the JSON payload | ||
| const [event, media] = files; | ||
| expect(event.name).toEqual('event'); | ||
| expect(event.info.mimeType).toEqual('application/json'); | ||
| expect(event.info.filename).toEqual('event_data.json'); | ||
| const eventJson = JSON.parse(event.file.toString('utf-8')); | ||
|
|
||
| // Check that the content looks sane. | ||
| expect(eventJson.room_id).toEqual(roomId); | ||
| expect(eventJson.event_id).toEqual(eventId); | ||
| expect(eventJson.sender).toEqual(await user.getUserId()); | ||
| expect(eventJson.content.body).toEqual('hello!'); | ||
|
|
||
| // No media should be present. | ||
| expect(media).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('should be able to create a new webhook and push a media attachment.', async () => { | ||
| const user = testEnv.getUser('user'); | ||
| const roomId = await user.createRoom({ name: 'My Test Webhooks room'}); | ||
| await createOutboundConnection(user, testEnv.botMxid, roomId); | ||
| const gotWebhookRequest = awaitOutboundWebhook(); | ||
|
|
||
| const mxcUrl = await user.uploadContent(TEST_FILE, 'image/svg+xml', "matrix.svg"); | ||
| await user.sendMessage(roomId, { | ||
| url: mxcUrl, | ||
| msgtype: "m.file", | ||
| body: "matrix.svg", | ||
| }) | ||
| const { files } = await gotWebhookRequest; | ||
| const [event, media] = files; | ||
| expect(event.info.mimeType).toEqual('application/json'); | ||
| expect(event.info.filename).toEqual('event_data.json'); | ||
| const eventJson = JSON.parse(event.file.toString('utf-8')); | ||
| expect(eventJson.content.body).toEqual('matrix.svg'); | ||
|
|
||
|
|
||
| expect(media.info.mimeType).toEqual('image/svg+xml'); | ||
| expect(media.info.filename).toEqual('matrix.svg'); | ||
| expect(media.file).toEqual(TEST_FILE); | ||
| }); | ||
|
|
||
| // TODO: This requires us to support Redis in test conditions, as encryption is not possible | ||
| // in hookshot without it at the moment. | ||
|
|
||
| // it.only('should be able to create a new webhook and push an encrypted media attachment.', async () => { | ||
| // const user = testEnv.getUser('user'); | ||
| // const roomId = await user.createRoom({ name: 'My Test Webhooks room', initial_state: [{ | ||
| // content: { | ||
| // "algorithm": "m.megolm.v1.aes-sha2" | ||
| // }, | ||
| // state_key: "", | ||
| // type: "m.room.encryption" | ||
| // }]}); | ||
| // await createOutboundConnection(user, testEnv.botMxid, roomId); | ||
| // const gotWebhookRequest = awaitOutboundWebhook(); | ||
|
|
||
| // const encrypted = await user.crypto.encryptMedia(Buffer.from(TEST_FILE)); | ||
| // const mxc = await user.uploadContent(TEST_FILE); | ||
| // await user.sendMessage(roomId, { | ||
| // msgtype: "m.image", | ||
| // body: "matrix.svg", | ||
| // info: { | ||
| // mimetype: "image/svg+xml", | ||
| // }, | ||
| // file: { | ||
| // url: mxc, | ||
| // ...encrypted.file, | ||
| // }, | ||
| // }); | ||
|
|
||
| // const { headers, files } = await gotWebhookRequest; | ||
| // const [event, media] = files; | ||
| // expect(event.info.mimeType).toEqual('application/json'); | ||
| // expect(event.info.filename).toEqual('event_data.json'); | ||
| // const eventJson = JSON.parse(event.file.toString('utf-8')); | ||
| // expect(eventJson.content.body).toEqual('matrix.svg'); | ||
|
|
||
|
|
||
| // expect(media.info.mimeType).toEqual('image/svg+xml'); | ||
| // expect(media.info.filename).toEqual('matrix.svg'); | ||
| // expect(media.file).toEqual(TEST_FILE); | ||
| // }); | ||
| }); |
Oops, something went wrong.