({
+ eventType: 'm.room.message', sender: testEnv.botMxid, roomId: testRoomId, body: 'Hello world!'
+ });
+
+ // Send a webhook
+ await fetch(webhookUrl, {
+ method: 'POST',
+ headers: { 'Content-Type': 'application/json' },
+ body: JSON.stringify({text: 'Hello world!'})
+ });
+
+ // And await the notice.
+ await webhookNotice;
+ });
+});
diff --git a/spec/generic-hooks.spec.ts b/spec/generic-hooks.spec.ts
new file mode 100644
index 000000000..8b1f266b4
--- /dev/null
+++ b/spec/generic-hooks.spec.ts
@@ -0,0 +1,119 @@
+import { E2ESetupTestTimeout, E2ETestEnv, E2ETestMatrixClient } from "./util/e2e-test";
+import { describe, it } from "@jest/globals";
+import { GenericHookConnection } from "../src/Connections";
+import { TextualMessageEventContent } from "matrix-bot-sdk";
+import { add } from "date-fns/add";
+
+async function createInboundConnection(user: E2ETestMatrixClient, botMxid: string, roomId: string, duration?: string) {
+ const join = user.waitForRoomJoin({ sender: botMxid, roomId });
+ const connectionEvent = user.waitForRoomEvent({
+ eventType: GenericHookConnection.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 webhook test' + (duration ? ` ${duration}` : ""));
+ // 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 msgContent = msgData.content as unknown as TextualMessageEventContent;
+ const [_unused1, _unused2, url] = msgContent.body.split('\n');
+ return url;
+}
+
+describe('Inbound (Generic) Webhooks', () => {
+ let testEnv: E2ETestEnv;
+
+ beforeAll(async () => {
+ const webhooksPort = 9500 + E2ETestEnv.workerId;
+ testEnv = await E2ETestEnv.createTestEnv({
+ matrixLocalparts: ['user'],
+ config: {
+ generic: {
+ enabled: true,
+ // Prefer to wait for complete as it reduces the concurrency of the test.
+ waitForComplete: 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 handle an incoming request.', async () => {
+ const user = testEnv.getUser('user');
+ const roomId = await user.createRoom({ name: 'My Test Webhooks room'});
+ const okMsg = user.waitForRoomEvent({ eventType: "m.room.message", sender: testEnv.botMxid, roomId });
+ const url = await createInboundConnection(user, testEnv.botMxid, roomId);
+ expect((await okMsg).data.content.body).toEqual('Room configured to bridge webhooks. See admin room for secret url.');
+
+ const expectedMsg = user.waitForRoomEvent({ eventType: "m.room.message", sender: testEnv.botMxid, roomId });
+ const req = await fetch(url, {
+ method: "PUT",
+ body: "Hello world"
+ });
+ expect(req.status).toEqual(200);
+ expect(await req.json()).toEqual({ ok: true });
+ expect((await expectedMsg).data.content).toEqual({
+ msgtype: 'm.notice',
+ body: 'Received webhook data: Hello world',
+ formatted_body: 'Received webhook data: Hello world
',
+ format: 'org.matrix.custom.html',
+ 'uk.half-shot.hookshot.webhook_data': 'Hello world'
+ });
+ });
+
+ it('should be able to create a new expiring webhook and handle valid requests.', async () => {
+ jest.useFakeTimers();
+ const user = testEnv.getUser('user');
+ const roomId = await user.createRoom({ name: 'My Test Webhooks room'});
+ const okMsg = user.waitForRoomEvent({ eventType: "m.room.message", sender: testEnv.botMxid, roomId });
+ const url = await createInboundConnection(user, testEnv.botMxid, roomId, '2h');
+ expect((await okMsg).data.content.body).toEqual('Room configured to bridge webhooks. See admin room for secret url.');
+
+ const expectedMsg = user.waitForRoomEvent({ eventType: "m.room.message", sender: testEnv.botMxid, roomId });
+ const req = await fetch(url, {
+ method: "PUT",
+ body: "Hello world"
+ });
+ expect(req.status).toEqual(200);
+ expect(await req.json()).toEqual({ ok: true });
+ expect((await expectedMsg).data.content).toEqual({
+ msgtype: 'm.notice',
+ body: 'Received webhook data: Hello world',
+ formatted_body: 'Received webhook data: Hello world
',
+ format: 'org.matrix.custom.html',
+ 'uk.half-shot.hookshot.webhook_data': 'Hello world'
+ });
+ jest.setSystemTime(add(new Date(), { hours: 3 }));
+ const expiredReq = await fetch(url, {
+ method: "PUT",
+ body: "Hello world"
+ });
+ expect(expiredReq.status).toEqual(404);
+ expect(await expiredReq.json()).toEqual({
+ ok: false,
+ error: "This hook has expired",
+ });
+ });
+});
diff --git a/spec/setup-jest.ts b/spec/setup-jest.ts
new file mode 100644
index 000000000..a5481961e
--- /dev/null
+++ b/spec/setup-jest.ts
@@ -0,0 +1,2 @@
+// In CI, the network creation for the homerunner containers can race (https://github.com/matrix-org/complement/issues/720).
+jest.retryTimes(process.env.CI ? 3 : 1);
\ No newline at end of file
diff --git a/spec/util/e2e-test.ts b/spec/util/e2e-test.ts
index 20cf38c25..7d842c7b3 100644
--- a/spec/util/e2e-test.ts
+++ b/spec/util/e2e-test.ts
@@ -5,13 +5,24 @@ import { BridgeConfig, BridgeConfigRoot } from "../../src/config/Config";
import { start } from "../../src/App/BridgeApp";
import { RSAKeyPairOptions, generateKeyPair } from "node:crypto";
import path from "node:path";
+import Redis from "ioredis";
-const WAIT_EVENT_TIMEOUT = 10000;
+const WAIT_EVENT_TIMEOUT = 20000;
export const E2ESetupTestTimeout = 60000;
+const REDIS_DATABASE_URI = process.env.HOOKSHOT_E2E_REDIS_DB_URI ?? "redis://localhost:6379";
interface Opts {
matrixLocalparts?: string[];
config?: Partial,
+ enableE2EE?: boolean,
+ useRedis?: boolean,
+}
+
+interface WaitForEventResponse> {
+ roomId: string,
+ data: {
+ sender: string, type: string, state_key?: string, content: T, event_id: string,
+ }
}
export class E2ETestMatrixClient extends MatrixClient {
@@ -55,13 +66,10 @@ export class E2ETestMatrixClient extends MatrixClient {
}, `Timed out waiting for powerlevel from in ${roomId}`)
}
- public async waitForRoomEvent>(
- opts: {eventType: string, sender: string, roomId?: string, stateKey?: string, body?: string}
- ): Promise<{roomId: string, data: {
- sender: string, type: string, state_key?: string, content: T, event_id: string,
- }}> {
- const {eventType, sender, roomId, stateKey} = opts;
- return this.waitForEvent('room.event', (eventRoomId: string, eventData: {
+ private async innerWaitForRoomEvent>(
+ {eventType, sender, roomId, stateKey, eventId, body}: {eventType: string, sender: string, roomId?: string, stateKey?: string, body?: string, eventId?: string}, expectEncrypted: boolean,
+ ): Promise> {
+ return this.waitForEvent(expectEncrypted ? 'room.decrypted_event' : 'room.event', (eventRoomId: string, eventData: {
sender: string, type: string, state_key?: string, content: T, event_id: string,
}) => {
if (eventData.sender !== sender) {
@@ -73,21 +81,36 @@ export class E2ETestMatrixClient extends MatrixClient {
if (roomId && eventRoomId !== roomId) {
return undefined;
}
+ if (eventId && eventData.event_id !== eventId) {
+ return undefined;
+ }
if (stateKey !== undefined && eventData.state_key !== stateKey) {
return undefined;
}
- const body = 'body' in eventData.content && eventData.content.body;
- if (opts.body && body !== opts.body) {
+ const evtBody = 'body' in eventData.content && eventData.content.body;
+ if (body && body !== evtBody) {
return undefined;
}
console.info(
// eslint-disable-next-line max-len
- `${eventRoomId} ${eventData.event_id} ${eventData.type} ${eventData.sender} ${eventData.state_key ?? body ?? ''}`
+ `${eventRoomId} ${eventData.event_id} ${eventData.type} ${eventData.sender} ${eventData.state_key ?? evtBody ?? ''}`
);
return {roomId: eventRoomId, data: eventData};
}, `Timed out waiting for ${eventType} from ${sender} in ${roomId || "any room"}`)
}
+ public async waitForRoomEvent>(
+ opts: Parameters[0]
+ ): Promise> {
+ return this.innerWaitForRoomEvent(opts, false);
+ }
+
+ public async waitForEncryptedEvent>(
+ opts: Parameters[0]
+ ): Promise> {
+ return this.innerWaitForRoomEvent(opts, true);
+ }
+
public async waitForRoomJoin(
opts: {sender: string, roomId?: string}
): Promise<{roomId: string, data: unknown}> {
@@ -173,10 +196,11 @@ export class E2ETestEnv {
if (err) { reject(err) } else { resolve(privateKey) }
}));
+ const dir = await mkdtemp('hookshot-int-test');
+
// Configure homeserver and bots
- const [homeserver, dir, privateKey] = await Promise.all([
- createHS([...matrixLocalparts || []], workerID),
- mkdtemp('hookshot-int-test'),
+ const [homeserver, privateKey] = await Promise.all([
+ createHS([...matrixLocalparts || []], workerID, opts.enableE2EE ? path.join(dir, 'client-crypto') : undefined),
keyPromise,
]);
const keyPath = path.join(dir, 'key.pem');
@@ -193,6 +217,15 @@ export class E2ETestEnv {
providedConfig.github.auth.privateKeyFile = keyPath;
}
+ opts.useRedis = opts.enableE2EE || opts.useRedis;
+
+ let cacheConfig: BridgeConfigRoot["cache"]|undefined;
+ if (opts.useRedis) {
+ cacheConfig = {
+ redisUri: `${REDIS_DATABASE_URI}/${workerID}`,
+ }
+ }
+
const config = new BridgeConfig({
bridge: {
domain: homeserver.domain,
@@ -201,10 +234,7 @@ export class E2ETestEnv {
bindAddress: '0.0.0.0',
},
logging: {
- level: 'info',
- },
- queue: {
- monolithic: true,
+ level: 'debug',
},
// Always enable webhooks so that hookshot starts.
generic: {
@@ -217,6 +247,12 @@ export class E2ETestEnv {
resources: ['webhooks'],
}],
passFile: keyPath,
+ ...(opts.enableE2EE ? {
+ encryption: {
+ storagePath: path.join(dir, 'crypto-store'),
+ }
+ } : undefined),
+ cache: cacheConfig,
...providedConfig,
});
const registration: IAppserviceRegistration = {
@@ -230,7 +266,8 @@ export class E2ETestEnv {
}],
rooms: [],
aliases: [],
- }
+ },
+ "de.sorunome.msc2409.push_ephemeral": true
};
const app = await start(config, registration);
app.listener.finaliseListeners();
@@ -258,6 +295,12 @@ export class E2ETestEnv {
await this.app.bridgeApp.stop();
await this.app.listener.stop();
await this.app.storage.disconnect?.();
+
+ // Clear the redis DB.
+ if (this.config.cache?.redisUri) {
+ await new Redis(this.config.cache.redisUri).flushdb();
+ }
+
this.homeserver.users.forEach(u => u.client.stop());
await destroyHS(this.homeserver.id);
await rm(this.dir, { recursive: true });
diff --git a/spec/util/fixtures.ts b/spec/util/fixtures.ts
new file mode 100644
index 000000000..ae6de768c
--- /dev/null
+++ b/spec/util/fixtures.ts
@@ -0,0 +1 @@
+export const TEST_FILE = Buffer.from(`<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 13.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 14576)  -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
	 width="793.322px" height="340.809px" viewBox="0 0 793.322 340.809" enable-background="new 0 0 793.322 340.809"
	 xml:space="preserve">
<path opacity="0.5" fill="#FFFFFF" d="M34.004,340.809H2c-1.104,0-2-0.896-2-2V2c0-1.104,0.896-2,2-2h32.004c1.104,0,2,0.896,2,2
	v7.71c0,1.104-0.896,2-2,2h-21.13v317.386h21.13c1.104,0,2,0.896,2,2.001v7.712C36.004,339.913,35.108,340.809,34.004,340.809
	L34.004,340.809z"/>
<path opacity="0.5" fill="#FFFFFF" d="M10.875,9.711v321.386h23.13v7.711H1.999V2.001h32.006v7.71H10.875z"/>
<path opacity="0.5" fill="#FFFFFF" d="M252.402,233.711h-32.993c-1.104,0-2-0.896-2-2v-68.073c0-3.949-0.154-7.722-0.457-11.213
	c-0.289-3.282-1.074-6.153-2.332-8.53c-1.204-2.276-3.017-4.119-5.384-5.476c-2.393-1.362-5.775-2.056-10.042-2.056
	c-4.238,0-7.674,0.798-10.213,2.371c-2.565,1.596-4.604,3.701-6.053,6.258c-1.498,2.643-2.51,5.694-3.013,9.067
	c-0.526,3.513-0.793,7.125-0.793,10.741v66.91c0,1.104-0.896,2-2,2h-32.991c-1.104,0-2-0.896-2-2v-67.373
	c0-3.435-0.078-6.964-0.228-10.485c-0.148-3.251-0.767-6.278-1.841-8.995c-1.018-2.571-2.667-4.584-5.047-6.153
	c-2.372-1.552-6.029-2.341-10.865-2.341c-1.372,0-3.265,0.328-5.629,0.976c-2.28,0.624-4.536,1.826-6.705,3.577
	c-2.152,1.732-4.036,4.306-5.605,7.655c-1.569,3.356-2.367,7.877-2.367,13.438v69.701c0,1.104-0.895,2-2,2H68.857
	c-1.104,0-2-0.896-2-2V111.594c0-1.104,0.896-1.999,2-1.999h31.13c1.104,0,2,0.896,2,1.999v11.007
	c3.834-4.499,8.248-8.152,13.173-10.896c6.396-3.559,13.799-5.362,22.002-5.362c7.846,0,15.127,1.548,21.642,4.604
	c5.794,2.722,10.424,7.26,13.791,13.52c3.449-4.362,7.833-8.306,13.071-11.752c6.422-4.228,14.102-6.371,22.824-6.371
	c6.499,0,12.625,0.807,18.209,2.399c5.686,1.628,10.635,4.271,14.712,7.857c4.088,3.605,7.318,8.357,9.601,14.123
	c2.25,5.719,3.391,12.649,3.391,20.604v80.384C254.402,232.815,253.507,233.711,252.402,233.711L252.402,233.711z"/>
<path opacity="0.5" fill="#FFFFFF" d="M99.988,111.595v16.264h0.463c4.338-6.191,9.563-10.998,15.684-14.406
	c6.117-3.402,13.129-5.11,21.027-5.11c7.588,0,14.521,1.475,20.793,4.415c6.274,2.945,11.038,8.131,14.291,15.567
	c3.56-5.265,8.4-9.913,14.521-13.94c6.117-4.025,13.358-6.042,21.724-6.042c6.351,0,12.234,0.776,17.66,2.325
	c5.418,1.549,10.065,4.027,13.938,7.434c3.869,3.41,6.889,7.863,9.062,13.357c2.167,5.504,3.253,12.122,3.253,19.869v80.385H219.41
	v-68.074c0-4.025-0.154-7.82-0.465-11.385c-0.313-3.56-1.161-6.656-2.555-9.293c-1.395-2.631-3.45-4.724-6.157-6.274
	c-2.711-1.543-6.391-2.322-11.037-2.322s-8.403,0.896-11.269,2.671c-2.868,1.784-5.112,4.109-6.737,6.971
	c-1.626,2.869-2.711,6.12-3.252,9.762c-0.545,3.638-0.814,7.318-0.814,11.035v66.91h-32.991v-67.375c0-3.562-0.081-7.087-0.23-10.57
	c-0.158-3.487-0.814-6.7-1.978-9.645c-1.162-2.94-3.099-5.304-5.809-7.088c-2.711-1.775-6.699-2.671-11.965-2.671
	c-1.551,0-3.603,0.349-6.156,1.048c-2.556,0.697-5.036,2.016-7.435,3.949c-2.404,1.938-4.454,4.726-6.158,8.363
	c-1.705,3.642-2.556,8.402-2.556,14.287v69.701h-32.99V111.595H99.988z"/>
<path opacity="0.5" fill="#FFFFFF" d="M304.909,236.733c-5.883,0-11.46-0.729-16.574-2.163c-5.192-1.464-9.806-3.774-13.713-6.871
	c-3.944-3.117-7.068-7.111-9.282-11.871c-2.205-4.733-3.324-10.412-3.324-16.876c0-7.13,1.293-13.117,3.846-17.797
	c2.542-4.674,5.877-8.464,9.912-11.263c3.97-2.752,8.556-4.842,13.63-6.209c4.901-1.322,9.937-2.394,14.961-3.184
	c4.986-0.775,9.949-1.404,14.754-1.872c4.679-0.452,8.88-1.139,12.489-2.039c3.412-0.854,6.118-2.09,8.042-3.672
	c1.666-1.37,2.416-3.384,2.292-6.151c-0.002-3.289-0.502-5.816-1.492-7.595c-0.998-1.798-2.283-3.15-3.927-4.138
	c-1.703-1.02-3.725-1.713-6.012-2.062c-2.47-0.37-5.146-0.557-7.947-0.557c-6.034,0-10.789,1.271-14.135,3.783
	c-3.233,2.424-5.155,6.64-5.714,12.527c-0.098,1.026-0.961,1.812-1.992,1.812h-32.992c-0.552,0-1.079-0.229-1.457-0.629
	c-0.376-0.402-0.572-0.941-0.54-1.491c0.485-8.073,2.55-14.894,6.142-20.272c3.548-5.331,8.147-9.682,13.661-12.931
	c5.424-3.191,11.612-5.498,18.392-6.857c6.684-1.335,13.5-2.013,20.26-2.013c6.096,0,12.365,0.437,18.626,1.296
	c6.377,0.88,12.285,2.622,17.562,5.177c5.376,2.604,9.845,6.29,13.282,10.951c3.498,4.744,5.271,11.048,5.271,18.731v62.494
	c0,5.307,0.306,10.462,0.915,15.319c0.576,4.64,1.572,8.116,2.963,10.338c0.385,0.616,0.407,1.395,0.055,2.031
	c-0.353,0.635-1.022,1.03-1.75,1.03h-33.457c-0.861,0-1.624-0.55-1.898-1.367c-0.646-1.941-1.176-3.939-1.572-5.936
	c-0.141-0.696-0.267-1.402-0.38-2.12c-4.825,4.184-10.349,7.24-16.474,9.105C320.033,235.609,312.489,236.733,304.909,236.733
	L304.909,236.733z M341.941,176.661c-0.809,0.409-1.676,0.768-2.596,1.074c-2.161,0.72-4.511,1.326-6.988,1.807
	c-2.442,0.475-5.033,0.872-7.699,1.186c-2.631,0.311-5.251,0.697-7.784,1.146c-2.329,0.433-4.705,1.035-7.051,1.792
	c-2.194,0.711-4.114,1.667-5.699,2.842c-1.531,1.128-2.785,2.587-3.731,4.335c-0.917,1.709-1.385,3.97-1.385,6.719
	c0,2.598,0.465,4.778,1.385,6.481c0.928,1.722,2.142,3.035,3.716,4.018c1.644,1.026,3.601,1.757,5.816,2.17
	c2.344,0.439,4.799,0.663,7.297,0.663c6.105,0,10.836-0.996,14.063-2.961c3.244-1.973,5.666-4.349,7.199-7.062
	c1.568-2.78,2.542-5.62,2.892-8.436c0.376-3.019,0.565-5.436,0.565-7.187V176.661L341.941,176.661z"/>
<path opacity="0.5" fill="#FFFFFF" d="M273.544,129.255c3.405-5.113,7.744-9.215,13.012-12.316
	c5.264-3.097,11.186-5.303,17.771-6.621c6.582-1.315,13.205-1.976,19.865-1.976c6.042,0,12.158,0.428,18.354,1.277
	c6.195,0.855,11.85,2.522,16.962,4.997c5.111,2.477,9.292,5.926,12.546,10.338c3.253,4.414,4.879,10.262,4.879,17.543v62.494
	c0,5.428,0.31,10.611,0.931,15.567c0.615,4.959,1.701,8.676,3.251,11.153H347.66c-0.621-1.86-1.126-3.755-1.511-5.693
	c-0.39-1.933-0.661-3.908-0.813-5.923c-5.267,5.422-11.465,9.217-18.585,11.386c-7.127,2.163-14.407,3.251-21.842,3.251
	c-5.733,0-11.077-0.698-16.033-2.09c-4.958-1.395-9.293-3.562-13.01-6.51c-3.718-2.938-6.622-6.656-8.713-11.147
	s-3.138-9.84-3.138-16.033c0-6.813,1.199-12.43,3.604-16.84c2.399-4.417,5.495-7.939,9.295-10.575
	c3.793-2.632,8.129-4.607,13.01-5.923c4.878-1.315,9.795-2.358,14.752-3.137c4.957-0.772,9.835-1.393,14.638-1.857
	c4.801-0.466,9.062-1.164,12.779-2.093c3.718-0.929,6.658-2.282,8.829-4.065c2.165-1.781,3.172-4.375,3.02-7.785
	c0-3.56-0.58-6.389-1.742-8.479c-1.161-2.09-2.711-3.719-4.646-4.88c-1.937-1.161-4.183-1.936-6.737-2.325
	c-2.557-0.382-5.309-0.58-8.248-0.58c-6.506,0-11.617,1.395-15.335,4.183c-3.716,2.788-5.889,7.437-6.506,13.94h-32.991
	C268.199,140.794,270.132,134.363,273.544,129.255z M338.713,175.838c-2.09,0.696-4.337,1.275-6.736,1.741
	c-2.402,0.465-4.918,0.853-7.551,1.161c-2.635,0.313-5.268,0.698-7.899,1.163c-2.48,0.461-4.919,1.086-7.317,1.857
	c-2.404,0.779-4.495,1.822-6.274,3.138c-1.784,1.317-3.216,2.985-4.3,4.994c-1.085,2.014-1.626,4.571-1.626,7.668
	c0,2.94,0.541,5.422,1.626,7.431c1.084,2.017,2.558,3.604,4.416,4.765s4.025,1.976,6.507,2.438c2.475,0.466,5.031,0.698,7.665,0.698
	c6.505,0,11.537-1.082,15.103-3.253c3.561-2.166,6.192-4.762,7.899-7.785c1.702-3.019,2.749-6.072,3.137-9.174
	c0.384-3.097,0.58-5.576,0.58-7.434v-12.316C342.547,174.173,340.805,175.14,338.713,175.838z"/>
<path opacity="0.5" fill="#FFFFFF" d="M444.542,234.874c-5.187,0-10.173-0.361-14.823-1.069c-4.802-0.732-9.104-2.183-12.779-4.313
	c-3.789-2.185-6.821-5.341-9.006-9.375c-2.163-3.986-3.26-9.232-3.26-15.59v-68.859h-17.981c-1.104,0-2-0.896-2-1.999v-22.073
	c0-1.104,0.896-1.999,2-1.999h17.981V75.582c0-1.104,0.896-2,2-2h32.992c1.104,0,2,0.896,2,2v34.014h22.162c1.104,0,2,0.896,2,1.999
	v22.073c0,1.104-0.896,1.999-2,1.999h-22.162v57.479c0,6.229,1.198,8.731,2.202,9.733c1.004,1.007,3.506,2.205,9.738,2.205
	c1.804,0,3.542-0.076,5.161-0.225c1.604-0.144,3.174-0.367,4.669-0.665c0.13-0.026,0.261-0.039,0.391-0.039
	c0.458,0,0.907,0.159,1.27,0.454c0.463,0.379,0.73,0.946,0.73,1.546v25.555c0,0.979-0.707,1.813-1.672,1.974
	c-2.834,0.472-6.041,0.794-9.527,0.957C451.015,234.798,447.718,234.874,444.542,234.874L444.542,234.874z"/>
<path opacity="0.5" fill="#FFFFFF" d="M463.825,111.595v22.072h-24.161v59.479c0,5.573,0.928,9.292,2.788,11.149
	c1.856,1.859,5.576,2.788,11.152,2.788c1.859,0,3.638-0.076,5.343-0.232c1.703-0.152,3.33-0.388,4.878-0.696v25.557
	c-2.788,0.465-5.887,0.773-9.293,0.931c-3.407,0.149-6.737,0.23-9.99,0.23c-5.111,0-9.953-0.35-14.521-1.048
	c-4.571-0.695-8.597-2.047-12.081-4.063c-3.486-2.011-6.236-4.88-8.248-8.597c-2.016-3.714-3.021-8.595-3.021-14.639v-70.859h-19.98
	v-22.072h19.98V75.583h32.992v36.012H463.825z"/>
<path opacity="0.5" fill="#FFFFFF" d="M512.613,233.711h-32.991c-1.104,0-2-0.896-2-2V111.594c0-1.104,0.896-1.999,2-1.999h31.366
	c1.104,0,2,0.896,2,1.999v15.069c0.967-1.516,2.034-2.978,3.199-4.382c2.754-3.312,5.949-6.182,9.496-8.522
	c3.545-2.332,7.385-4.169,11.415-5.462c4.056-1.298,8.327-1.954,12.691-1.954c2.341,0,4.953,0.418,7.766,1.243
	c0.852,0.25,1.437,1.032,1.437,1.92v30.67c0,0.6-0.269,1.167-0.732,1.547c-0.361,0.296-0.808,0.452-1.265,0.452
	c-0.133,0-0.265-0.013-0.398-0.039c-1.484-0.3-3.299-0.565-5.392-0.787c-2.098-0.224-4.136-0.339-6.062-0.339
	c-5.706,0-10.572,0.95-14.467,2.823c-3.862,1.86-7.012,4.428-9.361,7.629c-2.389,3.263-4.115,7.12-5.127,11.47
	c-1.043,4.479-1.574,9.409-1.574,14.647v54.132C514.613,232.815,513.717,233.711,512.613,233.711L512.613,233.711z"/>
<path opacity="0.5" fill="#FFFFFF" d="M510.988,111.595V133.9h0.465c1.546-3.72,3.636-7.163,6.272-10.341
	c2.634-3.172,5.652-5.885,9.06-8.131c3.405-2.242,7.047-3.985,10.923-5.228c3.868-1.237,7.898-1.859,12.081-1.859
	c2.168,0,4.566,0.39,7.202,1.163v30.67c-1.551-0.312-3.41-0.584-5.576-0.814c-2.17-0.233-4.26-0.35-6.274-0.35
	c-6.041,0-11.152,1.01-15.332,3.021c-4.182,2.014-7.55,4.761-10.107,8.247c-2.555,3.487-4.379,7.55-5.462,12.198
	c-1.083,4.645-1.625,9.682-1.625,15.102v54.133h-32.991V111.595H510.988z"/>
<path opacity="0.5" fill="#FFFFFF" d="M603.923,233.711H570.93c-1.104,0-2-0.896-2-2V111.594c0-1.104,0.896-1.999,2-1.999h32.994
	c1.104,0,2,0.896,2,1.999v120.117C605.923,232.815,605.027,233.711,603.923,233.711L603.923,233.711z M603.923,95.006H570.93
	c-1.104,0-2-0.896-2-1.999V65.825c0-1.104,0.896-2,2-2h32.994c1.104,0,2,0.896,2,2v27.182
	C605.923,94.11,605.027,95.006,603.923,95.006L603.923,95.006z"/>
<path opacity="0.5" fill="#FFFFFF" d="M570.93,93.007V65.824h32.994v27.183H570.93z M603.924,111.595v120.117H570.93V111.595
	H603.924z"/>
<path opacity="0.5" fill="#FFFFFF" d="M742.163,233.711h-37.64c-0.671,0-1.297-0.335-1.667-0.896l-23.426-35.352l-23.426,35.352
	c-0.369,0.561-0.995,0.896-1.667,0.896h-36.938c-0.741,0-1.424-0.411-1.77-1.067c-0.345-0.654-0.3-1.449,0.118-2.061l42.435-62.055
	l-38.71-55.793c-0.424-0.613-0.474-1.408-0.128-2.069c0.343-0.658,1.028-1.071,1.771-1.071h37.636c0.665,0,1.287,0.33,1.658,0.882
	l19.477,28.893l19.255-28.884c0.372-0.556,0.996-0.891,1.665-0.891h36.475c0.746,0,1.43,0.415,1.776,1.078
	c0.343,0.66,0.289,1.46-0.139,2.071l-38.69,55.082l43.578,62.744c0.424,0.61,0.474,1.408,0.128,2.066
	C743.591,233.298,742.908,233.711,742.163,233.711L742.163,233.711z"/>
<path opacity="0.5" fill="#FFFFFF" d="M621.115,111.595h37.637l21.144,31.365l20.911-31.365h36.476l-39.496,56.226l44.377,63.892
	h-37.64l-25.093-37.87l-25.094,37.87h-36.938l43.213-63.193L621.115,111.595z"/>
<path opacity="0.5" fill="#FFFFFF" d="M791.322,340.809h-32.008c-1.105,0-2-0.896-2-2v-7.712c0-1.105,0.896-2.001,2-2.001h21.13
	V11.71h-21.13c-1.105,0-2-0.896-2-2V2c0-1.104,0.896-2,2-2h32.008c1.104,0,2,0.896,2,2v336.809
	C793.322,339.913,792.426,340.809,791.322,340.809L791.322,340.809z"/>
<path opacity="0.5" fill="#FFFFFF" d="M782.443,331.097V9.711h-23.13v-7.71h32.008v336.807h-32.008v-7.711H782.443z"/>
<path d="M10.875,9.711v321.386h23.13v7.711H1.999V2.001h32.006v7.71H10.875z"/>
<path d="M99.988,111.595v16.264h0.463c4.338-6.191,9.563-10.998,15.684-14.406c6.117-3.402,13.129-5.11,21.027-5.11
	c7.588,0,14.521,1.475,20.793,4.415c6.274,2.945,11.038,8.131,14.291,15.567c3.56-5.265,8.4-9.913,14.521-13.94
	c6.117-4.025,13.358-6.042,21.724-6.042c6.351,0,12.234,0.776,17.66,2.325c5.418,1.549,10.065,4.027,13.938,7.434
	c3.869,3.41,6.889,7.863,9.062,13.357c2.167,5.504,3.253,12.122,3.253,19.869v80.385H219.41v-68.074
	c0-4.025-0.154-7.82-0.465-11.385c-0.313-3.56-1.161-6.656-2.555-9.293c-1.395-2.631-3.45-4.724-6.157-6.274
	c-2.711-1.543-6.391-2.322-11.037-2.322s-8.403,0.896-11.269,2.671c-2.868,1.784-5.112,4.109-6.737,6.971
	c-1.626,2.869-2.711,6.12-3.252,9.762c-0.545,3.638-0.814,7.318-0.814,11.035v66.91h-32.991v-67.375c0-3.562-0.081-7.087-0.23-10.57
	c-0.158-3.487-0.814-6.7-1.978-9.645c-1.162-2.94-3.099-5.304-5.809-7.088c-2.711-1.775-6.699-2.671-11.965-2.671
	c-1.551,0-3.603,0.349-6.156,1.048c-2.556,0.697-5.036,2.016-7.435,3.949c-2.404,1.938-4.454,4.726-6.158,8.363
	c-1.705,3.642-2.556,8.402-2.556,14.287v69.701h-32.99V111.595H99.988z"/>
<path d="M273.544,129.255c3.405-5.113,7.744-9.215,13.012-12.316c5.264-3.097,11.186-5.303,17.771-6.621
	c6.582-1.315,13.205-1.976,19.865-1.976c6.042,0,12.158,0.428,18.354,1.277c6.195,0.855,11.85,2.522,16.962,4.997
	c5.111,2.477,9.292,5.926,12.546,10.338c3.253,4.414,4.879,10.262,4.879,17.543v62.494c0,5.428,0.31,10.611,0.931,15.567
	c0.615,4.959,1.701,8.676,3.251,11.153H347.66c-0.621-1.86-1.126-3.755-1.511-5.693c-0.39-1.933-0.661-3.908-0.813-5.923
	c-5.267,5.422-11.465,9.217-18.585,11.386c-7.127,2.163-14.407,3.251-21.842,3.251c-5.733,0-11.077-0.698-16.033-2.09
	c-4.958-1.395-9.293-3.562-13.01-6.51c-3.718-2.938-6.622-6.656-8.713-11.147s-3.138-9.84-3.138-16.033
	c0-6.813,1.199-12.43,3.604-16.84c2.399-4.417,5.495-7.939,9.295-10.575c3.793-2.632,8.129-4.607,13.01-5.923
	c4.878-1.315,9.795-2.358,14.752-3.137c4.957-0.772,9.835-1.393,14.638-1.857c4.801-0.466,9.062-1.164,12.779-2.093
	c3.718-0.929,6.658-2.282,8.829-4.065c2.165-1.781,3.172-4.375,3.02-7.785c0-3.56-0.58-6.389-1.742-8.479
	c-1.161-2.09-2.711-3.719-4.646-4.88c-1.937-1.161-4.183-1.936-6.737-2.325c-2.557-0.382-5.309-0.58-8.248-0.58
	c-6.506,0-11.617,1.395-15.335,4.183c-3.716,2.788-5.889,7.437-6.506,13.94h-32.991
	C268.199,140.794,270.132,134.363,273.544,129.255z M338.713,175.838c-2.09,0.696-4.337,1.275-6.736,1.741
	c-2.402,0.465-4.918,0.853-7.551,1.161c-2.635,0.313-5.268,0.698-7.899,1.163c-2.48,0.461-4.919,1.086-7.317,1.857
	c-2.404,0.779-4.495,1.822-6.274,3.138c-1.784,1.317-3.216,2.985-4.3,4.994c-1.085,2.014-1.626,4.571-1.626,7.668
	c0,2.94,0.541,5.422,1.626,7.431c1.084,2.017,2.558,3.604,4.416,4.765s4.025,1.976,6.507,2.438c2.475,0.466,5.031,0.698,7.665,0.698
	c6.505,0,11.537-1.082,15.103-3.253c3.561-2.166,6.192-4.762,7.899-7.785c1.702-3.019,2.749-6.072,3.137-9.174
	c0.384-3.097,0.58-5.576,0.58-7.434v-12.316C342.547,174.173,340.805,175.14,338.713,175.838z"/>
<path d="M463.825,111.595v22.072h-24.161v59.479c0,5.573,0.928,9.292,2.788,11.149c1.856,1.859,5.576,2.788,11.152,2.788
	c1.859,0,3.638-0.076,5.343-0.232c1.703-0.152,3.33-0.388,4.878-0.696v25.557c-2.788,0.465-5.887,0.773-9.293,0.931
	c-3.407,0.149-6.737,0.23-9.99,0.23c-5.111,0-9.953-0.35-14.521-1.048c-4.571-0.695-8.597-2.047-12.081-4.063
	c-3.486-2.011-6.236-4.88-8.248-8.597c-2.016-3.714-3.021-8.595-3.021-14.639v-70.859h-19.98v-22.072h19.98V75.583h32.992v36.012
	H463.825z"/>
<path d="M510.988,111.595V133.9h0.465c1.546-3.72,3.636-7.163,6.272-10.341c2.634-3.172,5.652-5.885,9.06-8.131
	c3.405-2.242,7.047-3.985,10.923-5.228c3.868-1.237,7.898-1.859,12.081-1.859c2.168,0,4.566,0.39,7.202,1.163v30.67
	c-1.551-0.312-3.41-0.584-5.576-0.814c-2.17-0.233-4.26-0.35-6.274-0.35c-6.041,0-11.152,1.01-15.332,3.021
	c-4.182,2.014-7.55,4.761-10.107,8.247c-2.555,3.487-4.379,7.55-5.462,12.198c-1.083,4.645-1.625,9.682-1.625,15.102v54.133h-32.991
	V111.595H510.988z"/>
<path d="M570.93,93.007V65.824h32.994v27.183H570.93z M603.924,111.595v120.117H570.93V111.595H603.924z"/>
<path d="M621.115,111.595h37.637l21.144,31.365l20.911-31.365h36.476l-39.496,56.226l44.377,63.892h-37.64l-25.093-37.87
	l-25.094,37.87h-36.938l43.213-63.193L621.115,111.595z"/>
<path d="M782.443,331.097V9.711h-23.13v-7.71h32.008v336.807h-32.008v-7.711H782.443z"/>
</svg>
`, "base64");
\ No newline at end of file
diff --git a/spec/util/homerunner.ts b/spec/util/homerunner.ts
index a33bbc96a..ac7ada3bb 100644
--- a/spec/util/homerunner.ts
+++ b/spec/util/homerunner.ts
@@ -1,9 +1,10 @@
-import { MatrixClient } from "matrix-bot-sdk";
+import { MatrixClient, MemoryStorageProvider, RustSdkCryptoStorageProvider, RustSdkCryptoStoreType } from "matrix-bot-sdk";
import { createHash, createHmac, randomUUID } from "crypto";
import { Homerunner } from "homerunner-client";
import { E2ETestMatrixClient } from "./e2e-test";
+import path from "node:path";
-const HOMERUNNER_IMAGE = process.env.HOMERUNNER_IMAGE || 'ghcr.io/element-hq/synapse/complement-synapse:latest';
+const HOMERUNNER_IMAGE = process.env.HOMERUNNER_IMAGE || 'ghcr.io/element-hq/synapse/complement-synapse:nightly';
export const DEFAULT_REGISTRATION_SHARED_SECRET = (
process.env.REGISTRATION_SHARED_SECRET || 'complement'
);
@@ -41,7 +42,7 @@ async function waitForHomerunner() {
}
}
-export async function createHS(localparts: string[] = [], workerId: number): Promise {
+export async function createHS(localparts: string[] = [], workerId: number, cryptoRootPath?: string): Promise {
await waitForHomerunner();
const appPort = 49600 + workerId;
@@ -60,26 +61,36 @@ export async function createHS(localparts: string[] = [], workerId: number): Pro
URL: `http://${COMPLEMENT_HOSTNAME_RUNNING_COMPLEMENT}:${appPort}`,
SenderLocalpart: 'hookshot',
RateLimited: false,
- ...{ASToken: asToken,
- HSToken: hsToken},
+ ASToken: asToken,
+ HSToken: hsToken,
+ SendEphemeral: true,
+ EnableEncryption: true,
}]
}],
}
});
const [homeserverName, homeserver] = Object.entries(blueprintResponse.homeservers)[0];
// Skip AS user.
- const users = Object.entries(homeserver.AccessTokens)
+ const users = await Promise.all(Object.entries(homeserver.AccessTokens)
.filter(([_uId, accessToken]) => accessToken !== asToken)
- .map(([userId, accessToken]) => ({
- userId: userId,
- accessToken,
- deviceId: homeserver.DeviceIDs[userId],
- client: new E2ETestMatrixClient(homeserver.BaseURL, accessToken),
- })
- );
+ .map(async ([userId, accessToken]) => {
+ const cryptoStore = cryptoRootPath ? new RustSdkCryptoStorageProvider(path.join(cryptoRootPath, userId), RustSdkCryptoStoreType.Sqlite) : undefined;
+ const client = new E2ETestMatrixClient(homeserver.BaseURL, accessToken, new MemoryStorageProvider(), cryptoStore);
+ if (cryptoStore) {
+ await client.crypto.prepare();
+ }
+ // Start syncing proactively.
+ await client.start();
+ return {
+ userId: userId,
+ accessToken,
+ deviceId: homeserver.DeviceIDs[userId],
+ client,
+ }
+ }
+ ));
+
- // Start syncing proactively.
- await Promise.all(users.map(u => u.client.start()));
return {
users,
id: blueprint,
@@ -119,7 +130,7 @@ export async function registerUser(
.update(password).update("\x00")
.update(user.admin ? 'admin' : 'notadmin')
.digest('hex');
- return await fetch(registerUrl, { method: "POST", body: JSON.stringify(
+ const req = await fetch(registerUrl, { method: "POST", body: JSON.stringify(
{
nonce,
username: user.username,
@@ -127,8 +138,10 @@ export async function registerUser(
admin: user.admin,
mac: hmac,
}
- )}).then(res => res.json()).then(res => ({
- mxid: (res as {user_id: string}).user_id,
- client: new MatrixClient(homeserverUrl, (res as {access_token: string}).access_token),
- })).catch(err => { console.log(err.response.body); throw new Error(`Failed to register user: ${err}`); });
+ )});
+ const res = await req.json() as {user_id: string, access_token: string};
+ return {
+ mxid: res.user_id,
+ client: new MatrixClient(homeserverUrl, res.access_token),
+ };
}
diff --git a/spec/webhooks.spec.ts b/spec/webhooks.spec.ts
new file mode 100644
index 000000000..9238caa41
--- /dev/null
+++ b/spec/webhooks.spec.ts
@@ -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>/.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);
+ // });
+});
diff --git a/src/AdminRoom.ts b/src/AdminRoom.ts
index efa2c130c..9c9b85553 100644
--- a/src/AdminRoom.ts
+++ b/src/AdminRoom.ts
@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/ban-ts-comment */
import "reflect-metadata";
import { AdminAccountData, AdminRoomCommandHandler, Category } from "./AdminRoomCommandHandler";
import { botCommand, compileBotCommands, handleCommand, BotCommands, HelpFunction } from "./BotCommands";
@@ -16,7 +15,7 @@ import { Intent } from "matrix-bot-sdk";
import { JiraBotCommands } from "./jira/AdminCommands";
import { NotifFilter, NotificationFilterStateContent } from "./NotificationFilters";
import { ProjectsListResponseData } from "./github/Types";
-import { UserTokenStore } from "./UserTokenStore";
+import { UserTokenStore } from "./tokens/UserTokenStore";
import { Logger } from "matrix-appservice-bridge";
import markdown from "markdown-it";
type ProjectsListForRepoResponseData = Endpoints["GET /repos/{owner}/{repo}/projects"]["response"];
diff --git a/src/AdminRoomCommandHandler.ts b/src/AdminRoomCommandHandler.ts
index 10102e7e8..e11a081f1 100644
--- a/src/AdminRoomCommandHandler.ts
+++ b/src/AdminRoomCommandHandler.ts
@@ -1,7 +1,7 @@
import EventEmitter from "events";
import { Intent } from "matrix-bot-sdk";
import { BridgeConfig } from "./config/Config";
-import { UserTokenStore } from "./UserTokenStore";
+import { UserTokenStore } from "./tokens/UserTokenStore";
export enum Category {
@@ -13,7 +13,6 @@ export enum Category {
export interface AdminAccountData {
- // eslint-disable-next-line camelcase
admin_user: string;
github?: {
notifications?: {
diff --git a/src/App/BridgeApp.ts b/src/App/BridgeApp.ts
index a21049e48..83f90957d 100644
--- a/src/App/BridgeApp.ts
+++ b/src/App/BridgeApp.ts
@@ -1,6 +1,5 @@
import { Bridge } from "../Bridge";
import { BridgeConfig, parseRegistrationFile } from "../config/Config";
-import { Webhooks } from "../Webhooks";
import { MatrixSender } from "../MatrixSender";
import { UserNotificationWatcher } from "../Notifications/UserNotificationWatcher";
import { ListenerService } from "../ListenerService";
@@ -10,6 +9,7 @@ import { getAppservice } from "../appservice";
import BotUsersManager from "../Managers/BotUsersManager";
import * as Sentry from '@sentry/node';
import { GenericHookConnection } from "../Connections";
+import { UserTokenStore } from "../tokens/UserTokenStore";
Logger.configure({console: "info"});
const log = new Logger("App");
@@ -27,7 +27,7 @@ export async function start(config: BridgeConfig, registration: IAppserviceRegis
const {appservice, storage} = getAppservice(config, registration);
- if (config.queue.monolithic) {
+ if (!config.queue) {
const matrixSender = new MatrixSender(config, appservice);
matrixSender.listen();
const userNotificationWatcher = new UserNotificationWatcher(config);
@@ -51,7 +51,8 @@ export async function start(config: BridgeConfig, registration: IAppserviceRegis
const botUsersManager = new BotUsersManager(config, appservice);
- const bridgeApp = new Bridge(config, listener, appservice, storage, botUsersManager);
+ const tokenStore = await UserTokenStore.fromKeyPath(config.passFile , appservice.botIntent, config);
+ const bridgeApp = new Bridge(config, tokenStore, listener, appservice, storage, botUsersManager);
process.once("SIGTERM", () => {
log.error("Got SIGTERM");
diff --git a/src/Bridge.ts b/src/Bridge.ts
index c92517458..36bd695e7 100644
--- a/src/Bridge.ts
+++ b/src/Bridge.ts
@@ -10,7 +10,7 @@ import { GetIssueResponse, GetIssueOpts } from "./Gitlab/Types"
import { GithubInstance } from "./github/GithubInstance";
import { IBridgeStorageProvider } from "./Stores/StorageProvider";
import { IConnection, GitHubDiscussionSpace, GitHubDiscussionConnection, GitHubUserSpace, JiraProjectConnection, GitLabRepoConnection,
- GitHubIssueConnection, GitHubProjectConnection, GitHubRepoConnection, GitLabIssueConnection, FigmaFileConnection, FeedConnection, GenericHookConnection, WebhookResponse } from "./Connections";
+ GitHubIssueConnection, GitHubProjectConnection, GitHubRepoConnection, GitLabIssueConnection, FigmaFileConnection, FeedConnection, GenericHookConnection } from "./Connections";
import { IGitLabWebhookIssueStateEvent, IGitLabWebhookMREvent, IGitLabWebhookNoteEvent, IGitLabWebhookPushEvent, IGitLabWebhookReleaseEvent, IGitLabWebhookTagPushEvent, IGitLabWebhookWikiPageEvent } from "./Gitlab/WebhookTypes";
import { JiraIssueEvent, JiraIssueUpdatedEvent, JiraVersionEvent } from "./jira/WebhookTypes";
import { JiraOAuthResult } from "./jira/Types";
@@ -23,7 +23,7 @@ import { NotificationsEnableEvent, NotificationsDisableEvent, Webhooks } from ".
import { GitHubOAuthToken, GitHubOAuthTokenResponse, ProjectsGetResponseData } from "./github/Types";
import { retry } from "./PromiseUtil";
import { UserNotificationsEvent } from "./Notifications/UserNotificationWatcher";
-import { UserTokenStore } from "./UserTokenStore";
+import { UserTokenStore } from "./tokens/UserTokenStore";
import * as GitHubWebhookTypes from "@octokit/webhooks-types";
import { Logger } from "matrix-appservice-bridge";
import { Provisioner } from "./provisioning/provisioner";
@@ -39,8 +39,9 @@ import { JiraOAuthRequestCloud, JiraOAuthRequestOnPrem, JiraOAuthRequestResult }
import { GenericWebhookEvent, GenericWebhookEventResult } from "./generic/types";
import { SetupWidget } from "./Widgets/SetupWidget";
import { FeedEntry, FeedError, FeedReader, FeedSuccess } from "./feeds/FeedReader";
-import PQueue from "p-queue";
import * as Sentry from '@sentry/node';
+import { HoundConnection, HoundPayload } from "./Connections/HoundConnection";
+import { HoundReader } from "./hound/reader";
const log = new Logger("Bridge");
@@ -49,12 +50,11 @@ export class Bridge {
private readonly queue: MessageQueue;
private readonly commentProcessor: CommentProcessor;
private readonly notifProcessor: NotificationProcessor;
- private readonly tokenStore: UserTokenStore;
private connectionManager?: ConnectionManager;
private github?: GithubInstance;
private adminRooms: Map = new Map();
- private widgetApi?: BridgeWidgetApi;
private feedReader?: FeedReader;
+ private houndReader?: HoundReader;
private provisioningApi?: Provisioner;
private replyProcessor = new RichRepliesPreprocessor(true);
@@ -62,6 +62,7 @@ export class Bridge {
constructor(
private config: BridgeConfig,
+ private readonly tokenStore: UserTokenStore,
private readonly listener: ListenerService,
private readonly as: Appservice,
private readonly storage: IBridgeStorageProvider,
@@ -71,8 +72,6 @@ export class Bridge {
this.messageClient = new MessageSenderClient(this.queue);
this.commentProcessor = new CommentProcessor(this.as, this.config.bridge.mediaUrl || this.config.bridge.url);
this.notifProcessor = new NotificationProcessor(this.storage, this.messageClient);
- this.tokenStore = new UserTokenStore(this.config.passFile || "./passkey.pem", this.as.botIntent, this.config);
- this.tokenStore.on("onNewToken", this.onTokenUpdated.bind(this));
// Legacy routes, to be removed.
this.as.expressAppInstance.get("/live", (_, res) => res.send({ok: true}));
@@ -81,14 +80,15 @@ export class Bridge {
public stop() {
this.feedReader?.stop();
+ this.houndReader?.stop();
this.tokenStore.stop();
this.as.stop();
if (this.queue.stop) this.queue.stop();
}
public async start() {
+ this.tokenStore.on("onNewToken", this.onTokenUpdated.bind(this));
log.info('Starting up');
- await this.tokenStore.load();
await this.storage.connect?.();
await this.queue.connect?.();
@@ -97,7 +97,7 @@ export class Bridge {
while (!reached) {
try {
// Make a request to determine if we can reach the homeserver
- await this.as.botIntent.getJoinedRooms();
+ await this.as.botIntent.underlyingClient.getWhoAmI();
reached = true;
} catch (e) {
log.warn("Failed to connect to homeserver, retrying in 5s", e);
@@ -343,6 +343,12 @@ export class Bridge {
(c, data) => c.onMergeRequestOpened(data),
);
+ this.bindHandlerToQueue(
+ "gitlab.merge_request.reopen",
+ (data) => connManager.getConnectionsForGitLabRepo(data.project.path_with_namespace),
+ (c, data) => c.onMergeRequestReopened(data),
+ );
+
this.bindHandlerToQueue(
"gitlab.merge_request.close",
(data) => connManager.getConnectionsForGitLabRepo(data.project.path_with_namespace),
@@ -599,7 +605,7 @@ export class Bridge {
if (!connections.length) {
await this.queue.push({
- data: {notFound: true},
+ data: {successful: true, notFound: true},
sender: "Bridge",
messageId: messageId,
eventName: "response.generic-webhook.event",
@@ -614,21 +620,19 @@ export class Bridge {
await c.onGenericHook(data.hookData);
return;
}
- let successful: boolean|null = null;
- let response: WebhookResponse|undefined;
if (this.config.generic?.waitForComplete || c.waitForComplete) {
const result = await c.onGenericHook(data.hookData);
- successful = result.successful;
- response = result.response;
await this.queue.push({
- data: {successful, response},
+ data: result,
sender: "Bridge",
messageId,
eventName: "response.generic-webhook.event",
});
} else {
await this.queue.push({
- data: {},
+ data: {
+ successful: null,
+ },
sender: "Bridge",
messageId,
eventName: "response.generic-webhook.event",
@@ -681,67 +685,76 @@ export class Bridge {
(c, data) => c.handleFeedError(data),
);
- const queue = new PQueue({
- concurrency: 2,
- });
- // Set up already joined rooms
- await queue.addAll(this.botUsersManager.joinedRooms.map((roomId) => async () => {
- log.debug("Fetching state for " + roomId);
+ this.bindHandlerToQueue(
+ "hound.activity",
+ (data) => connManager.getConnectionsForHoundChallengeId(data.challengeId),
+ (c, data) => c.handleNewActivity(data.activity)
+ );
- try {
- await connManager.createConnectionsForRoomId(roomId, false);
- } catch (ex) {
- log.error(`Unable to create connection for ${roomId}`, ex);
- return;
- }
+ const allRooms = this.botUsersManager.joinedRooms;
- const botUser = this.botUsersManager.getBotUserInRoom(roomId);
- if (!botUser) {
- log.error(`Failed to find a bot in room '${roomId}' when setting up admin room`);
- return;
- }
+ const processRooms = async () => {
+ for (let roomId = allRooms.pop(); roomId !== undefined; roomId = allRooms.pop()) {
+ log.debug("Fetching state for " + roomId);
- // TODO: Refactor this to be a connection
- try {
- let accountData = await botUser.intent.underlyingClient.getSafeRoomAccountData(
- BRIDGE_ROOM_TYPE, roomId,
- );
- if (!accountData) {
- accountData = await botUser.intent.underlyingClient.getSafeRoomAccountData(
- LEGACY_BRIDGE_ROOM_TYPE, roomId,
- );
- if (!accountData) {
- log.debug(`Room ${roomId} has no connections and is not an admin room`);
- return;
- } else {
- // Upgrade the room
- await botUser.intent.underlyingClient.setRoomAccountData(BRIDGE_ROOM_TYPE, roomId, accountData);
- }
+ try {
+ await connManager.createConnectionsForRoomId(roomId, false);
+ } catch (ex) {
+ log.error(`Unable to create connection for ${roomId}`, ex);
+ continue;
}
-
- let notifContent;
+
+ const botUser = this.botUsersManager.getBotUserInRoom(roomId);
+ if (!botUser) {
+ log.error(`Failed to find a bot in room '${roomId}' when setting up admin room`);
+ continue;
+ }
+
+ // TODO: Refactor this to be a connection
try {
- notifContent = await botUser.intent.underlyingClient.getRoomStateEvent(
- roomId, NotifFilter.StateType, "",
+ let accountData = await botUser.intent.underlyingClient.getSafeRoomAccountData(
+ BRIDGE_ROOM_TYPE, roomId,
);
- } catch (ex) {
+ if (!accountData) {
+ accountData = await botUser.intent.underlyingClient.getSafeRoomAccountData(
+ LEGACY_BRIDGE_ROOM_TYPE, roomId,
+ );
+ if (!accountData) {
+ log.debug(`Room ${roomId} has no connections and is not an admin room`);
+ continue;
+ } else {
+ // Upgrade the room
+ await botUser.intent.underlyingClient.setRoomAccountData(BRIDGE_ROOM_TYPE, roomId, accountData);
+ }
+ }
+
+ let notifContent;
try {
notifContent = await botUser.intent.underlyingClient.getRoomStateEvent(
- roomId, NotifFilter.LegacyStateType, "",
+ roomId, NotifFilter.StateType, "",
);
+ } catch (ex) {
+ try {
+ notifContent = await botUser.intent.underlyingClient.getRoomStateEvent(
+ roomId, NotifFilter.LegacyStateType, "",
+ );
+ }
+ catch (ex) {
+ // No state yet
+ }
}
- catch (ex) {
- // No state yet
- }
- }
- const adminRoom = await this.setUpAdminRoom(botUser.intent, roomId, accountData, notifContent || NotifFilter.getDefaultContent());
- // Call this on startup to set the state
- await this.onAdminRoomSettingsChanged(adminRoom, accountData, { admin_user: accountData.admin_user });
- log.debug(`Room ${roomId} is connected to: ${adminRoom.toString()}`);
- } catch (ex) {
- log.error(`Failed to set up admin room ${roomId}:`, ex);
+ const adminRoom = await this.setUpAdminRoom(botUser.intent, roomId, accountData, notifContent || NotifFilter.getDefaultContent());
+ // Call this on startup to set the state
+ await this.onAdminRoomSettingsChanged(adminRoom, accountData, { admin_user: accountData.admin_user });
+ log.debug(`Room ${roomId} is connected to: ${adminRoom.toString()}`);
+ } catch (ex) {
+ log.error(`Failed to set up admin room ${roomId}:`, ex);
+ }
}
- }));
+ }
+
+ // Concurrency of two.
+ const roomQueue = await Promise.all([processRooms(), processRooms()])
// Handle spaces
for (const discussion of connManager.getAllConnectionsOfType(GitHubDiscussionSpace)) {
@@ -755,7 +768,7 @@ export class Bridge {
if (apps.length > 1) {
throw Error('You may only bind `widgets` to one listener.');
}
- this.widgetApi = new BridgeWidgetApi(
+ new BridgeWidgetApi(
this.adminRooms,
this.config,
this.storage,
@@ -774,7 +787,7 @@ export class Bridge {
if (this.config.metrics?.enabled) {
this.listener.bindResource('metrics', Metrics.expressRouter);
}
- await queue.onIdle();
+ await roomQueue;
log.info(`All connections loaded`);
// Load feeds after connections, to limit the chances of us double
@@ -788,6 +801,15 @@ export class Bridge {
);
}
+ if (this.config.challengeHound?.token) {
+ this.houndReader = new HoundReader(
+ this.config.challengeHound,
+ this.connectionManager,
+ this.queue,
+ this.storage,
+ );
+ }
+
const webhookHandler = new Webhooks(this.config);
this.listener.bindResource('webhooks', webhookHandler.expressRouter);
@@ -1142,10 +1164,14 @@ export class Bridge {
}
if (!existingConnections.length) {
// Is anyone interested in this state?
- const connection = await this.connectionManager.createConnectionForState(roomId, new StateEvent(event), true);
- if (connection) {
- log.info(`New connected added to ${roomId}: ${connection.toString()}`);
- this.connectionManager.push(connection);
+ try {
+ const connection = await this.connectionManager.createConnectionForState(roomId, new StateEvent(event), true);
+ if (connection) {
+ log.info(`New connected added to ${roomId}: ${connection.toString()}`);
+ this.connectionManager.push(connection);
+ }
+ } catch (ex) {
+ log.error(`Failed to handle connection for state ${event.type} in ${roomId}`, ex);
}
}
diff --git a/src/CommentProcessor.ts b/src/CommentProcessor.ts
index 7f1bf2f7c..b2d0fb6e8 100644
--- a/src/CommentProcessor.ts
+++ b/src/CommentProcessor.ts
@@ -16,7 +16,6 @@ const log = new Logger("CommentProcessor");
const mime = import('mime');
interface IMatrixCommentEvent extends MatrixMessageContent {
- // eslint-disable-next-line camelcase
external_url: string;
"uk.half-shot.matrix-hookshot.github.comment": {
id: number;
@@ -158,7 +157,7 @@ export class CommentProcessor {
body = body.replace(rawUrl, url);
} catch (ex) {
- log.warn("Failed to upload file");
+ log.warn("Failed to upload file", ex);
}
}
return body;
diff --git a/src/ConnectionManager.ts b/src/ConnectionManager.ts
index c475aa778..5f8508c82 100644
--- a/src/ConnectionManager.ts
+++ b/src/ConnectionManager.ts
@@ -8,7 +8,8 @@ import { Appservice, Intent, StateEvent } from "matrix-bot-sdk";
import { ApiError, ErrCode } from "./api";
import { BridgeConfig, BridgePermissionLevel, GitLabInstance } from "./config/Config";
import { CommentProcessor } from "./CommentProcessor";
-import { ConnectionDeclaration, ConnectionDeclarations, GenericHookConnection, GitHubDiscussionConnection, GitHubDiscussionSpace, GitHubIssueConnection, GitHubProjectConnection, GitHubRepoConnection, GitHubUserSpace, GitLabIssueConnection, GitLabRepoConnection, IConnection, IConnectionState, JiraProjectConnection } from "./Connections";
+import { ConnectionDeclaration, ConnectionDeclarations, GenericHookConnection, GitHubDiscussionConnection, GitHubDiscussionSpace, GitHubIssueConnection,
+ GitHubProjectConnection, GitHubRepoConnection, GitHubUserSpace, GitLabIssueConnection, GitLabRepoConnection, IConnection, IConnectionState, JiraProjectConnection } from "./Connections";
import { FigmaFileConnection, FeedConnection } from "./Connections";
import { GetConnectionTypeResponseItem } from "./provisioning/api";
import { GitLabClient } from "./Gitlab/Client";
@@ -17,11 +18,12 @@ import { IBridgeStorageProvider } from "./Stores/StorageProvider";
import { JiraProject, JiraVersion } from "./jira/Types";
import { Logger } from "matrix-appservice-bridge";
import { MessageSenderClient } from "./MatrixSender";
-import { UserTokenStore } from "./UserTokenStore";
+import { UserTokenStore } from "./tokens/UserTokenStore";
import BotUsersManager from "./Managers/BotUsersManager";
import { retry, retryMatrixErrorFilter } from "./PromiseUtil";
import Metrics from "./Metrics";
import EventEmitter from "events";
+import { HoundConnection } from "./Connections/HoundConnection";
const log = new Logger("ConnectionManager");
@@ -341,6 +343,10 @@ export class ConnectionManager extends EventEmitter {
return this.connections.filter(c => c instanceof FeedConnection && c.feedUrl === url) as FeedConnection[];
}
+ public getConnectionsForHoundChallengeId(challengeId: string): HoundConnection[] {
+ return this.connections.filter(c => c instanceof HoundConnection && c.challengeId === challengeId) as HoundConnection[];
+ }
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
public getAllConnectionsOfType(typeT: new (...params : any[]) => T): T[] {
return this.connections.filter((c) => (c instanceof typeT)) as T[];
diff --git a/src/Connections/FigmaFileConnection.ts b/src/Connections/FigmaFileConnection.ts
index 1a662dede..918fc7360 100644
--- a/src/Connections/FigmaFileConnection.ts
+++ b/src/Connections/FigmaFileConnection.ts
@@ -65,7 +65,7 @@ export class FigmaFileConnection extends BaseConnection implements IConnection {
}
}
- private readonly grantChecker: GrantChecker<{fileId: string, instanceName: string}> = new ConfigGrantChecker("figma", this.as, this.config);
+ private readonly grantChecker: GrantChecker<{fileId: string, instanceName: string}>;
constructor(
roomId: string,
@@ -76,6 +76,7 @@ export class FigmaFileConnection extends BaseConnection implements IConnection {
private readonly intent: Intent,
private readonly storage: IBridgeStorageProvider) {
super(roomId, stateKey, FigmaFileConnection.CanonicalEventType)
+ this.grantChecker = new ConfigGrantChecker("figma", this.as, this.config);
}
public isInterestedInStateEvent() {
diff --git a/src/Connections/GenericHook.ts b/src/Connections/GenericHook.ts
index 5aa87de04..2f0e831f7 100644
--- a/src/Connections/GenericHook.ts
+++ b/src/Connections/GenericHook.ts
@@ -8,9 +8,13 @@ import { Appservice, Intent, StateEvent } from "matrix-bot-sdk";
import { ApiError, ErrCode } from "../api";
import { BaseConnection } from "./BaseConnection";
import { GetConnectionsResponseItem } from "../provisioning/api";
-import { BridgeConfigGenericWebhooks } from "../config/Config";
+import { BridgeConfigGenericWebhooks } from "../config/sections";
import { ensureUserIsInRoom } from "../IntentUtils";
import { randomUUID } from 'node:crypto';
+import { GenericWebhookEventResult } from "../generic/types";
+import { StatusCodes } from "http-status-codes";
+import { IBridgeStorageProvider } from "../Stores/StorageProvider";
+import { formatDuration, isMatch, millisecondsToHours } from "date-fns";
export interface GenericHookConnectionState extends IConnectionState {
/**
@@ -21,11 +25,17 @@ export interface GenericHookConnectionState extends IConnectionState {
* The name given in the provisioning UI and displaynames.
*/
name: string;
- transformationFunction: string|undefined;
+ transformationFunction?: string;
/**
* Should the webhook only respond on completion.
*/
- waitForComplete: boolean|undefined;
+ waitForComplete?: boolean|undefined;
+
+ /**
+ * If the webhook has an expriation date, then the date at which the webhook is no longer value
+ * (in UTC) time.
+ */
+ expirationDate?: string;
}
export interface GenericHookSecrets {
@@ -37,6 +47,10 @@ export interface GenericHookSecrets {
* The hookId of the webhook.
*/
hookId: string;
+ /**
+ * How long remains until the webhook expires.
+ */
+ timeRemainingMs?: number
}
export type GenericHookResponseItem = GetConnectionsResponseItem;
@@ -64,6 +78,14 @@ interface WebhookTransformationResult {
webhookResponse?: WebhookResponse;
}
+export interface GenericHookServiceConfig {
+ userIdPrefix?: string;
+ allowJsTransformationFunctions?: boolean,
+ waitForComplete?: boolean,
+ maxExpiryTime?: number,
+ requireExpiryTime: boolean,
+}
+
const log = new Logger("GenericHookConnection");
const md = new markdownit();
@@ -71,6 +93,12 @@ const TRANSFORMATION_TIMEOUT_MS = 500;
const SANITIZE_MAX_DEPTH = 10;
const SANITIZE_MAX_BREADTH = 50;
+const WARN_AT_EXPIRY_MS = 3 * 24 * 60 * 60 * 1000;
+const MIN_EXPIRY_MS = 60 * 60 * 1000;
+const CHECK_EXPIRY_MS = 15 * 60 * 1000;
+
+const EXPIRY_NOTICE_MESSAGE = "The webhook **%NAME** will be expiring in %TIME."
+
/**
* Handles rooms connected to a generic webhook.
*/
@@ -123,8 +151,8 @@ export class GenericHookConnection extends BaseConnection implements IConnection
return obj;
}
- static validateState(state: Record): GenericHookConnectionState {
- const {name, transformationFunction, waitForComplete} = state;
+ static validateState(state: Partial>): GenericHookConnectionState {
+ const {name, transformationFunction, waitForComplete, expirationDate: expirationDateStr} = state;
if (!name) {
throw new ApiError('Missing name', ErrCode.BadValue);
}
@@ -143,14 +171,26 @@ export class GenericHookConnection extends BaseConnection implements IConnection
throw new ApiError('Transformation functions must be a string', ErrCode.BadValue);
}
}
+ let expirationDate: string|undefined;
+ if (expirationDateStr != undefined) {
+ if (typeof expirationDateStr !== "string" || !expirationDateStr) {
+ throw new ApiError("'expirationDate' must be a non-empty string", ErrCode.BadValue);
+ }
+ if (!isMatch(expirationDateStr, "yyyy-MM-dd'T'HH:mm:ss.SSSXX")) {
+ throw new ApiError("'expirationDate' must be a valid date", ErrCode.BadValue);
+ }
+ expirationDate = expirationDateStr;
+ }
+
return {
name,
transformationFunction: transformationFunction || undefined,
waitForComplete,
+ expirationDate,
};
}
- static async createConnectionForState(roomId: string, event: StateEvent>, {as, intent, config, messageClient}: InstantiateConnectionOpts) {
+ static async createConnectionForState(roomId: string, event: StateEvent>, {as, intent, config, messageClient, storage}: InstantiateConnectionOpts) {
if (!config.generic) {
throw Error('Generic webhooks are not configured');
}
@@ -162,6 +202,10 @@ export class GenericHookConnection extends BaseConnection implements IConnection
if (!hookId) {
hookId = randomUUID();
log.warn(`hookId for ${roomId} not set in accountData, setting to ${hookId}`);
+ // If this is a new hook...
+ if (config.generic.requireExpiryTime && !state.expirationDate) {
+ throw new Error('Expiration date must be set');
+ }
await GenericHookConnection.ensureRoomAccountData(roomId, intent, hookId, event.stateKey);
}
@@ -174,18 +218,41 @@ export class GenericHookConnection extends BaseConnection implements IConnection
config.generic,
as,
intent,
+ storage,
);
}
- static async provisionConnection(roomId: string, userId: string, data: Record = {}, {as, intent, config, messageClient}: ProvisionConnectionOpts) {
+ static async provisionConnection(roomId: string, userId: string, data: Partial> = {}, {as, intent, config, messageClient, storage}: ProvisionConnectionOpts) {
if (!config.generic) {
throw Error('Generic Webhooks are not configured');
}
const hookId = randomUUID();
const validState = GenericHookConnection.validateState(data);
+ if (validState.expirationDate) {
+ const durationRemaining = new Date(validState.expirationDate).getTime() - Date.now();
+ if (config.generic.maxExpiryTimeMs) {
+ if (durationRemaining > config.generic.maxExpiryTimeMs) {
+ throw new ApiError('Expiration date cannot exceed the configured max expiry time', ErrCode.BadValue);
+ }
+ }
+ if (durationRemaining < MIN_EXPIRY_MS) {
+ // If the webhook is actually created with a shorter expiry time than
+ // our warning period, then just mark it as warned.
+ throw new ApiError('Expiration date must at least be a hour in the future', ErrCode.BadValue);
+ }
+ if (durationRemaining < WARN_AT_EXPIRY_MS) {
+ // If the webhook is actually created with a shorter expiry time than
+ // our warning period, then just mark it as warned.
+ await storage.setHasGenericHookWarnedExpiry(hookId, true);
+ }
+ } else if (config.generic.requireExpiryTime) {
+ throw new ApiError('Expiration date must be set', ErrCode.BadValue);
+ }
+
+
await GenericHookConnection.ensureRoomAccountData(roomId, intent, hookId, validState.name);
await intent.underlyingClient.sendStateEvent(roomId, this.CanonicalEventType, validState.name, validState);
- const connection = new GenericHookConnection(roomId, validState, hookId, validState.name, messageClient, config.generic, as, intent);
+ const connection = new GenericHookConnection(roomId, validState, hookId, validState.name, messageClient, config.generic, as, intent, storage);
return {
connection,
stateEventContent: validState,
@@ -218,6 +285,8 @@ export class GenericHookConnection extends BaseConnection implements IConnection
private transformationFunction?: string;
private cachedDisplayname?: string;
+ private warnOnExpiryInterval?: NodeJS.Timeout;
+
/**
* @param state Should be a pre-validated state object returned by {@link validateState}
*/
@@ -230,11 +299,19 @@ export class GenericHookConnection extends BaseConnection implements IConnection
private readonly config: BridgeConfigGenericWebhooks,
private readonly as: Appservice,
private readonly intent: Intent,
+ private readonly storage: IBridgeStorageProvider,
) {
super(roomId, stateKey, GenericHookConnection.CanonicalEventType);
if (state.transformationFunction && GenericHookConnection.quickModule) {
this.transformationFunction = state.transformationFunction;
}
+ this.handleExpiryTimeUpdate(false).catch(ex => {
+ log.warn("Failed to configure expiry time warning for hook", ex);
+ });
+ }
+
+ public get expiresAt(): Date|undefined {
+ return this.state.expirationDate ? new Date(this.state.expirationDate) : undefined;
}
/**
@@ -313,7 +390,49 @@ export class GenericHookConnection extends BaseConnection implements IConnection
} else {
this.transformationFunction = undefined;
}
+
+ const prevDate = this.state.expirationDate;
this.state = validatedConfig;
+ if (prevDate !== validatedConfig.expirationDate) {
+ await this.handleExpiryTimeUpdate(true);
+ }
+ }
+
+ /**
+ * Called when the expiry time has been updated for the connection. If the connection
+ * no longer has an expiry time. This voids the interval.
+ * @returns
+ */
+ private async handleExpiryTimeUpdate(shouldWrite: boolean) {
+ if (!this.config.sendExpiryNotice) {
+ return;
+ }
+ if (this.warnOnExpiryInterval) {
+ clearInterval(this.warnOnExpiryInterval);
+ this.warnOnExpiryInterval = undefined;
+ }
+ if (!this.state.expirationDate) {
+ return;
+ }
+
+ const durationRemaining = new Date(this.state.expirationDate).getTime() - Date.now();
+ if (durationRemaining < WARN_AT_EXPIRY_MS) {
+ // If the webhook is actually created with a shorter expiry time than
+ // our warning period, then just mark it as warned.
+ if (shouldWrite) {
+ await this.storage.setHasGenericHookWarnedExpiry(this.hookId, true);
+ }
+ } else {
+ const fuzzCheckTimeMs = Math.round((Math.random() * CHECK_EXPIRY_MS));
+ this.warnOnExpiryInterval = setInterval(() => {
+ this.checkAndWarnExpiry().catch(ex => {
+ log.warn("Failed to check expiry time for hook", ex);
+ })
+ }, CHECK_EXPIRY_MS + fuzzCheckTimeMs);
+ if (shouldWrite) {
+ await this.storage.setHasGenericHookWarnedExpiry(this.hookId, false);
+ }
+ }
}
public transformHookData(data: unknown): {plain: string, html?: string} {
@@ -424,8 +543,18 @@ export class GenericHookConnection extends BaseConnection implements IConnection
* @param data Structured data. This may either be a string, or an object.
* @returns `true` if the webhook completed, or `false` if it failed to complete
*/
- public async onGenericHook(data: unknown): Promise<{successful: boolean, response?: WebhookResponse}> {
+ public async onGenericHook(data: unknown): Promise {
log.info(`onGenericHook ${this.roomId} ${this.hookId}`);
+
+ if (this.expiresAt && new Date() >= this.expiresAt) {
+ log.warn("Ignoring incoming webhook. This hook has expired");
+ return {
+ successful: false,
+ statusCode: StatusCodes.NOT_FOUND,
+ error: 'This hook has expired',
+ };
+ }
+
let content: {plain: string, html?: string, msgtype?: string}|undefined;
let webhookResponse: WebhookResponse|undefined;
let successful = true;
@@ -467,7 +596,6 @@ export class GenericHookConnection extends BaseConnection implements IConnection
successful,
response: webhookResponse,
};
-
}
public static getProvisionerDetails(botUserId: string) {
@@ -488,16 +616,19 @@ export class GenericHookConnection extends BaseConnection implements IConnection
transformationFunction: this.state.transformationFunction,
waitForComplete: this.waitForComplete,
name: this.state.name,
+ expirationDate: this.state.expirationDate,
},
...(showSecrets ? { secrets: {
url: new URL(this.hookId, this.config.parsedUrlPrefix),
hookId: this.hookId,
- } as GenericHookSecrets} : undefined)
+ timeRemainingMs: this.expiresAt ? this.expiresAt.getTime() - Date.now() : undefined,
+ } satisfies GenericHookSecrets} : undefined)
}
}
public async onRemove() {
log.info(`Removing ${this.toString()} for ${this.roomId}`);
+ clearInterval(this.warnOnExpiryInterval);
// Do a sanity check that the event exists.
try {
await this.intent.underlyingClient.getRoomStateEvent(this.roomId, GenericHookConnection.CanonicalEventType, this.stateKey);
@@ -509,8 +640,9 @@ export class GenericHookConnection extends BaseConnection implements IConnection
await GenericHookConnection.ensureRoomAccountData(this.roomId, this.intent, this.hookId, this.stateKey, true);
}
- public async provisionerUpdateConfig(userId: string, config: Record) {
+ public async provisionerUpdateConfig(_userId: string, config: Record) {
// Apply previous state to the current config, as provisioners might not return "unknown" keys.
+ config.expirationDate = config.expirationDate ?? undefined;
config = { ...this.state, ...config };
const validatedConfig = GenericHookConnection.validateState(config);
await this.intent.underlyingClient.sendStateEvent(this.roomId, GenericHookConnection.CanonicalEventType, this.stateKey,
@@ -522,6 +654,35 @@ export class GenericHookConnection extends BaseConnection implements IConnection
this.state = validatedConfig;
}
+ private async checkAndWarnExpiry() {
+ const remainingMs = this.expiresAt ? this.expiresAt.getTime() - Date.now() : undefined;
+ if (!remainingMs) {
+ return;
+ }
+ if (remainingMs < CHECK_EXPIRY_MS) {
+ // Nearly expired
+ return;
+ }
+ if (remainingMs > WARN_AT_EXPIRY_MS) {
+ return;
+ }
+ if (await this.storage.getHasGenericHookWarnedExpiry(this.hookId)) {
+ return;
+ }
+ // Warn
+ const markdownStr = EXPIRY_NOTICE_MESSAGE.replace('%NAME', this.state.name).replace('%TIME', formatDuration({
+ hours: millisecondsToHours(remainingMs)
+ }));
+ await this.messageClient.sendMatrixMessage(this.roomId, {
+ msgtype: "m.notice",
+ body: markdownStr,
+ // render can output redundant trailing newlines, so trim it.
+ formatted_body: md.render(markdownStr).trim(),
+ format: "org.matrix.custom.html",
+ }, 'm.room.message', this.getUserId());
+ await this.storage.setHasGenericHookWarnedExpiry(this.hookId, true);
+ }
+
public toString() {
return `GenericHookConnection ${this.hookId}`;
}
diff --git a/src/Connections/GithubDiscussion.ts b/src/Connections/GithubDiscussion.ts
index 5529118ca..d3787d1d0 100644
--- a/src/Connections/GithubDiscussion.ts
+++ b/src/Connections/GithubDiscussion.ts
@@ -1,6 +1,6 @@
import { Connection, IConnection, InstantiateConnectionOpts } from "./IConnection";
import { Appservice, Intent, StateEvent } from "matrix-bot-sdk";
-import { UserTokenStore } from "../UserTokenStore";
+import { UserTokenStore } from "../tokens/UserTokenStore";
import { CommentProcessor } from "../CommentProcessor";
import { MessageSenderClient } from "../MatrixSender";
import { ensureUserIsInRoom, getIntentForUser } from "../IntentUtils";
diff --git a/src/Connections/GithubIssue.ts b/src/Connections/GithubIssue.ts
index 449349d4d..f5656e49a 100644
--- a/src/Connections/GithubIssue.ts
+++ b/src/Connections/GithubIssue.ts
@@ -2,7 +2,7 @@ import { Connection, IConnection, InstantiateConnectionOpts } from "./IConnectio
import { Appservice, Intent, StateEvent } from "matrix-bot-sdk";
import { MatrixMessageContent, MatrixEvent } from "../MatrixEvent";
import markdown from "markdown-it";
-import { UserTokenStore } from "../UserTokenStore";
+import { UserTokenStore } from "../tokens/UserTokenStore";
import { Logger } from "matrix-appservice-bridge";
import { CommentProcessor } from "../CommentProcessor";
import { MessageSenderClient } from "../MatrixSender";
@@ -20,7 +20,6 @@ export interface GitHubIssueConnectionState {
repo: string;
state: string;
issues: string[];
- // eslint-disable-next-line camelcase
comments_processed: number;
}
diff --git a/src/Connections/GithubProject.ts b/src/Connections/GithubProject.ts
index f9e99fe25..6d21db51b 100644
--- a/src/Connections/GithubProject.ts
+++ b/src/Connections/GithubProject.ts
@@ -7,7 +7,6 @@ import { ConfigGrantChecker, GrantChecker } from "../grants/GrantCheck";
import { BridgeConfig } from "../config/Config";
export interface GitHubProjectConnectionState {
- // eslint-disable-next-line camelcase
project_id: number;
state: "open"|"closed";
}
diff --git a/src/Connections/GithubRepo.ts b/src/Connections/GithubRepo.ts
index 6e77191db..bdd863b77 100644
--- a/src/Connections/GithubRepo.ts
+++ b/src/Connections/GithubRepo.ts
@@ -13,7 +13,7 @@ import { MatrixMessageContent, MatrixEvent, MatrixReactionContent } from "../Mat
import { MessageSenderClient } from "../MatrixSender";
import { CommandError, NotLoggedInError } from "../errors";
import { ReposGetResponseData } from "../github/Types";
-import { UserTokenStore } from "../UserTokenStore";
+import { UserTokenStore } from "../tokens/UserTokenStore";
import axios, { AxiosError } from "axios";
import { emojify } from "node-emoji";
import { Logger } from "matrix-appservice-bridge";
@@ -549,7 +549,7 @@ export class GitHubRepoConnection extends CommandConnection, timeout: NodeJS.Timeout}>();
- private readonly grantChecker = new GitHubGrantChecker(this.as, this.tokenStore);
+ private readonly grantChecker;
constructor(
roomId: string,
@@ -576,6 +576,7 @@ export class GitHubRepoConnection extends CommandConnection ");
+ formatted = md.render(content);
+ } else {
+ formatted = md.renderInline(content);
}
const eventPromise = this.intent.sendEvent(this.roomId, {
msgtype: "m.notice",
body: content,
- formatted_body: md.renderInline(content),
+ formatted_body: formatted,
format: "org.matrix.custom.html",
...relation,
}).catch(ex => {
@@ -845,7 +863,7 @@ ${data.description}`;
if (this.hookFilter.shouldSkip('merge_request', 'merge_request.review', `merge_request.${event.object_attributes.action}`) || !this.matchesLabelFilter(event)) {
return;
}
- log.info(`onMergeRequestReviewed ${this.roomId} ${this.instance}/${this.path} ${event.object_attributes.iid}`);
+ log.info(`onMergeRequestReviewed ${this.roomId} ${this.instance}/${this.path} !${event.object_attributes.iid}`);
this.validateMREvent(event);
this.debounceMergeRequestReview(
event.user,
@@ -865,7 +883,7 @@ ${data.description}`;
return;
}
- log.info(`onMergeRequestReviewed ${this.roomId} ${this.instance}/${this.path} ${event.object_attributes.iid}`);
+ log.info(`onMergeRequestReviewed ${this.roomId} ${this.instance}/${this.path} !${event.object_attributes.iid}`);
this.validateMREvent(event);
this.debounceMergeRequestReview(
event.user,
@@ -883,7 +901,7 @@ ${data.description}`;
if (this.hookFilter.shouldSkip('merge_request', 'merge_request.review')) {
return;
}
- log.info(`onCommentCreated ${this.roomId} ${this.toString()} ${event.merge_request?.iid} ${event.object_attributes.id}`);
+ log.info(`onCommentCreated ${this.roomId} ${this.toString()} !${event.merge_request?.iid} ${event.object_attributes.id}`);
if (!event.merge_request || event.object_attributes.noteable_type !== "MergeRequest") {
// Not a MR comment
return;
diff --git a/src/Connections/HoundConnection.ts b/src/Connections/HoundConnection.ts
new file mode 100644
index 000000000..a70c2e444
--- /dev/null
+++ b/src/Connections/HoundConnection.ts
@@ -0,0 +1,226 @@
+import { Intent, StateEvent } from "matrix-bot-sdk";
+import markdownit from "markdown-it";
+import { BaseConnection } from "./BaseConnection";
+import { IConnection, IConnectionState } from ".";
+import { Connection, InstantiateConnectionOpts, ProvisionConnectionOpts } from "./IConnection";
+import { CommandError } from "../errors";
+import { IBridgeStorageProvider } from "../Stores/StorageProvider";
+import { Logger } from "matrix-appservice-bridge";
+export interface HoundConnectionState extends IConnectionState {
+ challengeId: string;
+}
+
+export interface HoundPayload {
+ activity: HoundActivity,
+ challengeId: string,
+}
+
+/**
+ * @url https://documenter.getpostman.com/view/22349866/UzXLzJUV#0913e0b9-9cb5-440e-9d8d-bf6430285ee9
+ */
+export interface HoundActivity {
+ userId: string,
+ activityId: string,
+ participant: string,
+ /**
+ * @example "07/26/2022"
+ */
+ date: string,
+ /**
+ * @example "2022-07-26T13:49:22Z"
+ */
+ datetime: string,
+ name: string,
+ type: string,
+ /**
+ * @example strava
+ */
+ app: string,
+ durationSeconds: number,
+ /**
+ * @example "1.39"
+ */
+ distanceKilometers: string,
+ /**
+ * @example "0.86"
+ */
+ distanceMiles: string,
+ /**
+ * @example "0.86"
+ */
+ elevationMeters: string,
+ /**
+ * @example "0.86"
+ */
+ elevationFeet: string,
+}
+
+export interface IChallenge {
+ id: string;
+ distance: number;
+ duration: number;
+ elevaion: number;
+}
+
+export interface ILeader {
+ id: string;
+ fullname: string;
+ duration: number;
+ distance: number;
+ elevation: number;
+}
+
+function getEmojiForType(type: string) {
+ switch (type) {
+ case "run":
+ return "🏃";
+ case "virtualrun":
+ return "👨💻🏃";
+ case "ride":
+ case "cycle":
+ case "cycling":
+ return "🚴";
+ case "mountainbikeride":
+ return "⛰️🚴";
+ case "virtualride":
+ return "👨💻🚴";
+ case "walk":
+ case "hike":
+ return "🚶";
+ case "skateboard":
+ return "🛹";
+ case "virtualwalk":
+ case "virtualhike":
+ return "👨💻🚶";
+ case "alpineski":
+ return "⛷️";
+ case "swim":
+ return "🏊";
+ default:
+ return "🕴️";
+ }
+}
+
+const log = new Logger("HoundConnection");
+const md = markdownit();
+@Connection
+export class HoundConnection extends BaseConnection implements IConnection {
+ static readonly CanonicalEventType = "uk.half-shot.matrix-hookshot.challengehound.activity";
+ static readonly LegacyEventType = "uk.half-shot.matrix-challenger.activity"; // Magically import from matrix-challenger
+
+ static readonly EventTypes = [
+ HoundConnection.CanonicalEventType,
+ HoundConnection.LegacyEventType,
+ ];
+ static readonly ServiceCategory = "challengehound";
+
+ public static getIdFromURL(url: string): string {
+ const parts = new URL(url).pathname.split('/');
+ return parts[parts.length-1];
+ }
+
+ public static validateState(data: Record): HoundConnectionState {
+ // Convert URL to ID.
+ if (!data.challengeId && data.url && typeof data.url === "string") {
+ data.challengeId = this.getIdFromURL(data.url);
+ }
+
+ // Test for v1 uuid.
+ if (!data.challengeId || typeof data.challengeId !== "string" || !/^\w{8}(?:-\w{4}){3}-\w{12}$/.test(data.challengeId)) {
+ throw Error('Missing or invalid id');
+ }
+
+ return {
+ challengeId: data.challengeId
+ }
+ }
+
+ public static createConnectionForState(roomId: string, event: StateEvent>, {config, intent, storage}: InstantiateConnectionOpts) {
+ if (!config.challengeHound) {
+ throw Error('Challenge hound is not configured');
+ }
+ return new HoundConnection(roomId, event.stateKey, this.validateState(event.content), intent, storage);
+ }
+
+ static async provisionConnection(roomId: string, _userId: string, data: Record = {}, {intent, config, storage}: ProvisionConnectionOpts) {
+ if (!config.challengeHound) {
+ throw Error('Challenge hound is not configured');
+ }
+ const validState = this.validateState(data);
+ // Check the event actually exists.
+ const statusDataRequest = await fetch(`https://api.challengehound.com/challenges/${validState.challengeId}/status`);
+ if (!statusDataRequest.ok) {
+ throw new CommandError(`Fetch failed, status ${statusDataRequest.status}`, "Challenge could not be found. Is it active?");
+ }
+ const { challengeName } = await statusDataRequest.json() as {challengeName: string};
+ const connection = new HoundConnection(roomId, validState.challengeId, validState, intent, storage);
+ await intent.underlyingClient.sendStateEvent(roomId, HoundConnection.CanonicalEventType, validState.challengeId, validState);
+ return {
+ connection,
+ stateEventContent: validState,
+ challengeName,
+ };
+ }
+
+ constructor(
+ roomId: string,
+ stateKey: string,
+ private state: HoundConnectionState,
+ private readonly intent: Intent,
+ private readonly storage: IBridgeStorageProvider) {
+ super(roomId, stateKey, HoundConnection.CanonicalEventType)
+ }
+
+ public isInterestedInStateEvent() {
+ return false; // We don't support state-updates...yet.
+ }
+
+ public get challengeId() {
+ return this.state.challengeId;
+ }
+
+ public get priority(): number {
+ return this.state.priority || super.priority;
+ }
+
+ public async handleNewActivity(activity: HoundActivity) {
+ log.info(`New activity recorded ${activity.activityId}`);
+ const existingActivityEventId = await this.storage.getHoundActivity(this.challengeId, activity.activityId);
+ const distance = parseFloat(activity.distanceKilometers);
+ const distanceUnits = `${(distance).toFixed(2)}km`;
+ const emoji = getEmojiForType(activity.type);
+ const body = `🎉 **${activity.participant}** completed a ${distanceUnits} ${emoji} ${activity.type} (${activity.name})`;
+ let content: any = {
+ body,
+ format: "org.matrix.custom.html",
+ formatted_body: md.renderInline(body),
+ };
+ content["msgtype"] = "m.notice";
+ content["uk.half-shot.matrix-challenger.activity.id"] = activity.activityId;
+ content["uk.half-shot.matrix-challenger.activity.distance"] = Math.round(distance * 1000);
+ content["uk.half-shot.matrix-challenger.activity.elevation"] = Math.round(parseFloat(activity.elevationMeters));
+ content["uk.half-shot.matrix-challenger.activity.duration"] = Math.round(activity.durationSeconds);
+ content["uk.half-shot.matrix-challenger.activity.user"] = {
+ "name": activity.participant,
+ id: activity.userId,
+ };
+ if (existingActivityEventId) {
+ log.debug(`Updating existing activity ${activity.activityId} ${existingActivityEventId}`);
+ content = {
+ body: `* ${content.body}`,
+ msgtype: "m.notice",
+ "m.new_content": content,
+ "m.relates_to": {
+ "event_id": existingActivityEventId,
+ "rel_type": "m.replace"
+ },
+ };
+ }
+ const eventId = await this.intent.underlyingClient.sendMessage(this.roomId, content);
+ await this.storage.storeHoundActivityEvent(this.challengeId, activity.activityId, eventId);
+ }
+
+ public toString() {
+ return `HoundConnection ${this.challengeId}`;
+ }
+}
diff --git a/src/Connections/IConnection.ts b/src/Connections/IConnection.ts
index 9fe63a9a3..c01c8878d 100644
--- a/src/Connections/IConnection.ts
+++ b/src/Connections/IConnection.ts
@@ -3,7 +3,7 @@ import { IssuesOpenedEvent, IssuesEditedEvent } from "@octokit/webhooks-types";
import { ConnectionWarning, GetConnectionsResponseItem } from "../provisioning/api";
import { Appservice, Intent, IRichReplyMetadata, StateEvent } from "matrix-bot-sdk";
import { BridgeConfig, BridgePermissionLevel } from "../config/Config";
-import { UserTokenStore } from "../UserTokenStore";
+import { UserTokenStore } from "../tokens/UserTokenStore";
import { CommentProcessor } from "../CommentProcessor";
import { MessageSenderClient } from "../MatrixSender";
import { IBridgeStorageProvider } from "../Stores/StorageProvider";
diff --git a/src/Connections/JiraProject.ts b/src/Connections/JiraProject.ts
index a1aa2acd3..05aabec1d 100644
--- a/src/Connections/JiraProject.ts
+++ b/src/Connections/JiraProject.ts
@@ -9,7 +9,7 @@ import { JiraProject, JiraVersion } from "../jira/Types";
import { botCommand, BotCommands, compileBotCommands } from "../BotCommands";
import { MatrixMessageContent } from "../MatrixEvent";
import { CommandConnection } from "./CommandConnection";
-import { UserTokenStore } from "../UserTokenStore";
+import { UserTokenStore } from "../tokens/UserTokenStore";
import { CommandError, NotLoggedInError } from "../errors";
import { ApiError, ErrCode } from "../api";
import JiraApi from "jira-client";
diff --git a/src/Connections/OutboundHook.ts b/src/Connections/OutboundHook.ts
new file mode 100644
index 000000000..a6c4301b2
--- /dev/null
+++ b/src/Connections/OutboundHook.ts
@@ -0,0 +1,281 @@
+import axios, { isAxiosError } from "axios";
+import { BaseConnection } from "./BaseConnection";
+import { Connection, IConnection, IConnectionState, InstantiateConnectionOpts, ProvisionConnectionOpts } from "./IConnection";
+import { ApiError, ErrCode, Logger } from "matrix-appservice-bridge";
+import { MatrixEvent } from "../MatrixEvent";
+import { FileMessageEventContent, Intent, StateEvent } from "matrix-bot-sdk";
+import { randomUUID } from "crypto";
+import UserAgent from "../UserAgent";
+import { hashId } from "../libRs";
+import { GetConnectionsResponseItem } from "../provisioning/api";
+
+export interface OutboundHookConnectionState extends IConnectionState {
+ name: string,
+ url: string;
+ method?: "PUT"|"POST";
+}
+
+export interface OutboundHookSecrets {
+ token: string;
+}
+
+export type OutboundHookResponseItem = GetConnectionsResponseItem;
+
+
+const log = new Logger("OutboundHookConnection");
+
+/**
+ * Handles rooms connected to an outbound generic service.
+ */
+@Connection
+export class OutboundHookConnection extends BaseConnection implements IConnection {
+ static readonly CanonicalEventType = "uk.half-shot.matrix-hookshot.outbound-hook";
+ static readonly ServiceCategory = "genericOutbound";
+
+ static readonly EventTypes = [
+ OutboundHookConnection.CanonicalEventType,
+ ];
+
+ private static getAccountDataKey(stateKey: string) {
+ return `${OutboundHookConnection.CanonicalEventType}:${stateKey}`;
+ }
+
+ static validateState(state: Record): OutboundHookConnectionState {
+ const {url, method, name} = state;
+ if (typeof url !== "string") {
+ throw new ApiError('Outbound URL must be a string', ErrCode.BadValue);
+ }
+
+ if (typeof name !== "string") {
+ throw new ApiError("A webhook name must be a string.", ErrCode.BadValue);
+ }
+
+ try {
+ const validatedUrl = new URL(url);
+ if (validatedUrl.protocol !== "http:" && validatedUrl.protocol !== "https:") {
+ throw new ApiError('Outbound URL protocol must be http or https', ErrCode.BadValue);
+ }
+ } catch (ex) {
+ if (ex instanceof ApiError) {
+ throw ex;
+ }
+ throw new ApiError('Outbound URL is invalid', ErrCode.BadValue);
+ }
+
+ if (method === "PUT" || method === "POST" || method === undefined) {
+ return {
+ name,
+ url,
+ method: method ?? 'PUT',
+ };
+ }
+ throw new ApiError('Outbound Method must be one of PUT,POST', ErrCode.BadValue);
+ }
+
+ static async createConnectionForState(roomId: string, event: StateEvent>, {intent, config, tokenStore}: InstantiateConnectionOpts) {
+ if (!config.generic) {
+ throw Error('Generic webhooks are not configured');
+ }
+ // Generic hooks store the hookId in the account data
+ const state = this.validateState(event.content);
+ const token = await tokenStore.getGenericToken("outboundHookToken", hashId(`${roomId}:${event.stateKey}`));
+
+ if (!token) {
+ throw new Error(`Missing stored token for connection`);
+ }
+
+ return new OutboundHookConnection(
+ roomId,
+ state,
+ token,
+ event.stateKey,
+ intent,
+ );
+ }
+
+ static async provisionConnection(roomId: string, userId: string, data: Record = {}, {intent, config, tokenStore}: ProvisionConnectionOpts) {
+ if (!config.generic) {
+ throw Error('Generic Webhooks are not configured');
+ }
+ if (!config.generic.outbound) {
+ throw Error('Outbound support for Generic Webhooks is not configured');
+ }
+
+ const token = `hs-ob-${randomUUID()}`;
+
+ if (typeof data.name !== "string" || data.name.length < 3 || data.name.length > 64) {
+ throw new ApiError("A webhook name must be between 3-64 characters.", ErrCode.BadValue);
+ }
+
+ const validState = OutboundHookConnection.validateState(data);
+
+ const stateKey = data.name;
+ const tokenKey = hashId(`${roomId}:${stateKey}`);
+ await tokenStore.storeGenericToken("outboundHookToken", tokenKey, token);
+
+ await intent.underlyingClient.sendStateEvent(roomId, this.CanonicalEventType, stateKey, validState);
+ const connection = new OutboundHookConnection(roomId, validState, token, stateKey, intent);
+ return {
+ connection,
+ stateEventContent: validState,
+ }
+ }
+
+ /**
+ * @param state Should be a pre-validated state object returned by {@link validateState}
+ */
+ constructor(
+ roomId: string,
+ private state: OutboundHookConnectionState,
+ public readonly outboundToken: string,
+ stateKey: string,
+ private readonly intent: Intent,
+ ) {
+ super(roomId, stateKey, OutboundHookConnection.CanonicalEventType);
+ }
+
+ public isInterestedInStateEvent(eventType: string, stateKey: string) {
+ return OutboundHookConnection.EventTypes.includes(eventType) && this.stateKey === stateKey;
+ }
+
+ /**
+ * Check for any embedded media in the event, and if present then extract it as a blob. This
+ * function also returns event content with the encryption details stripped from the event contents.
+ * @param ev The Matrix event to inspect for embedded media.
+ * @returns A blob and event object if media is found, otherwise null.
+ * @throws If media was expected (due to the msgtype) but not provided, or if the media could not
+ * be found or decrypted.
+ */
+ private async extractMedia(ev: MatrixEvent): Promise<{blob: Blob, event: MatrixEvent}|null> {
+ // Check for non-extendable event types first.
+ const content = ev.content as FileMessageEventContent;
+
+ if (!["m.image", "m.audio", "m.file", "m.video"].includes(content.msgtype)) {
+ return null;
+ }
+
+ const client = this.intent.underlyingClient;
+ let data: { data: Buffer, contentType?: string};
+ if (client.crypto && content.file) {
+ data = {
+ data: await client.crypto.decryptMedia(content.file),
+ contentType: content.info?.mimetype
+ };
+ const strippedContent = {...ev, content: {
+ ...content,
+ file: null,
+ }};
+ return {
+ blob: new File([await client.crypto.decryptMedia(content.file)], content.body, { type: data.contentType }),
+ event: strippedContent
+ }
+ } else if (content.url) {
+ data = await this.intent.underlyingClient.downloadContent(content.url);
+ return {
+ blob: new File([data.data], content.body, { type: data.contentType }),
+ event: ev,
+ };
+ }
+
+ throw Error('Missing file or url key on event, not handling media');
+ }
+
+
+ public async onEvent(ev: MatrixEvent): Promise {
+ // The event content first.
+ const multipartBlob = new FormData();
+ try {
+ const mediaResult = await this.extractMedia(ev);
+ if (mediaResult) {
+ multipartBlob.set('event', new Blob([JSON.stringify(mediaResult?.event)], {
+ type: 'application/json',
+ }), "event_data.json");
+ multipartBlob.set('media', mediaResult.blob);
+ }
+ } catch (ex) {
+ log.warn(`Failed to get media for ${ev.event_id} in ${this.roomId}`, ex);
+ }
+
+ if (!multipartBlob.has('event')) {
+ multipartBlob.set('event', new Blob([JSON.stringify(ev)], {
+ type: 'application/json',
+ }), "event_data.json");
+ }
+
+ try {
+ await axios.request({
+ url: this.state.url,
+ data: multipartBlob,
+ method: this.state.method,
+ responseType: 'text',
+ validateStatus: (status) => status >= 200 && status <= 299,
+ headers: {
+ 'User-Agent': UserAgent,
+ 'X-Matrix-Hookshot-RoomId': this.roomId,
+ 'X-Matrix-Hookshot-EventId': ev.event_id,
+ 'X-Matrix-Hookshot-Token': this.outboundToken,
+ },
+ });
+ log.info(`Sent webhook for ${ev.event_id}`);
+ } catch (ex) {
+ if (!isAxiosError(ex)) {
+ log.error(`Failed to send outbound webhook`, ex);
+ throw ex;
+ }
+ if (ex.status) {
+ log.error(`Failed to send outbound webhook: HTTP ${ex.status}`);
+ } else {
+ log.error(`Failed to send outbound webhook: ${ex.code}`);
+ }
+ log.debug("Response from server", ex.response?.data);
+ }
+ }
+
+ public static getProvisionerDetails(botUserId: string) {
+ return {
+ service: "genericOutbound",
+ eventType: OutboundHookConnection.CanonicalEventType,
+ type: "Webhook",
+ botUserId: botUserId,
+ }
+ }
+
+ public getProvisionerDetails(showSecrets = false): OutboundHookResponseItem {
+ return {
+ ...OutboundHookConnection.getProvisionerDetails(this.intent.userId),
+ id: this.connectionId,
+ config: {
+ url: this.state.url,
+ method: this.state.method,
+ name: this.state.name,
+ },
+ ...(showSecrets ? { secrets: {
+ token: this.outboundToken,
+ } satisfies OutboundHookSecrets} : undefined)
+ }
+ }
+
+ public async onRemove() {
+ log.info(`Removing ${this.toString()} for ${this.roomId}`);
+ // Do a sanity check that the event exists.
+ await this.intent.underlyingClient.getRoomStateEvent(this.roomId, OutboundHookConnection.CanonicalEventType, this.stateKey);
+ await this.intent.underlyingClient.sendStateEvent(this.roomId, OutboundHookConnection.CanonicalEventType, this.stateKey, { disabled: true });
+ // TODO: Remove token
+
+ }
+
+ public async provisionerUpdateConfig(userId: string, config: Record) {
+ config = { ...this.state, ...config };
+ const validatedConfig = OutboundHookConnection.validateState(config);
+ await this.intent.underlyingClient.sendStateEvent(this.roomId, OutboundHookConnection.CanonicalEventType, this.stateKey,
+ {
+ ...validatedConfig,
+ }
+ );
+ this.state = validatedConfig;
+ }
+
+ public toString() {
+ return `OutboundHookConnection ${this.roomId}`;
+ }
+}
\ No newline at end of file
diff --git a/src/Connections/SetupConnection.ts b/src/Connections/SetupConnection.ts
index 9f4893f3a..176a11b79 100644
--- a/src/Connections/SetupConnection.ts
+++ b/src/Connections/SetupConnection.ts
@@ -1,7 +1,6 @@
-// We need to instantiate some functions which are not directly called, which confuses typescript.
import { BotCommands, botCommand, compileBotCommands, HelpFunction } from "../BotCommands";
import { CommandConnection } from "./CommandConnection";
-import { GenericHookConnection, GenericHookConnectionState, GitHubRepoConnection, JiraProjectConnection, JiraProjectConnectionState } from ".";
+import { GenericHookConnection, GenericHookConnectionState, GitHubRepoConnection, JiraProjectConnection, JiraProjectConnectionState, OutboundHookConnection } from ".";
import { CommandError } from "../errors";
import { BridgePermissionLevel } from "../config/Config";
import markdown from "markdown-it";
@@ -15,9 +14,13 @@ import { IConnection, IConnectionState, ProvisionConnectionOpts } from "./IConne
import { ApiError, Logger } from "matrix-appservice-bridge";
import { Intent } from "matrix-bot-sdk";
import YAML from 'yaml';
+import parseDuration from 'parse-duration';
+import { HoundConnection } from "./HoundConnection";
const md = new markdown();
const log = new Logger("SetupConnection");
+const OUTBOUND_DOCS_LINK = "https://matrix-org.github.io/matrix-hookshot/latest/setup/webhooks.html";
+
/**
* Handles setting up a room with connections. This connection is "virtual" in that it has
* no state, and is only invoked when messages from other clients fall through.
@@ -72,13 +75,13 @@ export class SetupConnection extends CommandConnection {
this.includeTitlesInHelp = false;
}
- @botCommand("github repo", { help: "Create a connection for a GitHub repository. (You must be logged in with GitHub to do this.)", requiredArgs: ["url"], includeUserId: true, category: "github"})
+ @botCommand("github repo", { help: "Create a connection for a GitHub repository. (You must be logged in with GitHub to do this.)", requiredArgs: ["url"], includeUserId: true, category: GitHubRepoConnection.ServiceCategory})
public async onGitHubRepo(userId: string, url: string) {
if (!this.provisionOpts.github || !this.config.github) {
throw new CommandError("not-configured", "The bridge is not configured to support GitHub.");
}
- await this.checkUserPermissions(userId, "github", GitHubRepoConnection.CanonicalEventType);
+ await this.checkUserPermissions(userId, GitHubRepoConnection.ServiceCategory, GitHubRepoConnection.CanonicalEventType);
const octokit = await this.provisionOpts.tokenStore.getOctokitForUser(userId);
if (!octokit) {
throw new CommandError("User not logged in", "You are not logged into GitHub. Start a DM with this bot and use the command `github login`.");
@@ -93,13 +96,13 @@ export class SetupConnection extends CommandConnection {
await this.client.sendNotice(this.roomId, `Room configured to bridge ${connection.org}/${connection.repo}`);
}
- @botCommand("gitlab project", { help: "Create a connection for a GitHub project. (You must be logged in with GitLab to do this.)", requiredArgs: ["url"], includeUserId: true, category: "gitlab"})
+ @botCommand("gitlab project", { help: "Create a connection for a GitHub project. (You must be logged in with GitLab to do this.)", requiredArgs: ["url"], includeUserId: true, category: GitLabRepoConnection.ServiceCategory})
public async onGitLabRepo(userId: string, url: string) {
if (!this.config.gitlab) {
throw new CommandError("not-configured", "The bridge is not configured to support GitLab.");
}
- await this.checkUserPermissions(userId, "gitlab", GitLabRepoConnection.CanonicalEventType);
+ await this.checkUserPermissions(userId, GitLabRepoConnection.ServiceCategory, GitLabRepoConnection.CanonicalEventType);
const {name, instance} = this.config.gitlab.getInstanceByProjectUrl(url) || {};
if (!instance || !name) {
@@ -126,7 +129,7 @@ export class SetupConnection extends CommandConnection {
}
}
- private async getJiraProjectSafeUrl(userId: string, urlStr: string) {
+ private async getJiraProjectSafeUrl(urlStr: string) {
const url = new URL(urlStr);
const urlParts = /\/projects\/(\w+)\/?(\w+\/?)*$/.exec(url.pathname);
const projectKey = urlParts?.[1] || url.searchParams.get('projectKey');
@@ -136,22 +139,22 @@ export class SetupConnection extends CommandConnection {
return `https://${url.host}/projects/${projectKey}`;
}
- @botCommand("jira project", { help: "Create a connection for a JIRA project. (You must be logged in with JIRA to do this.)", requiredArgs: ["url"], includeUserId: true, category: "jira"})
+ @botCommand("jira project", { help: "Create a connection for a JIRA project. (You must be logged in with JIRA to do this.)", requiredArgs: ["url"], includeUserId: true, category: JiraProjectConnection.ServiceCategory})
public async onJiraProject(userId: string, urlStr: string) {
if (!this.config.jira) {
throw new CommandError("not-configured", "The bridge is not configured to support Jira.");
}
- await this.checkUserPermissions(userId, "jira", JiraProjectConnection.CanonicalEventType);
+ await this.checkUserPermissions(userId, JiraProjectConnection.ServiceCategory, JiraProjectConnection.CanonicalEventType);
await this.checkJiraLogin(userId, urlStr);
- const safeUrl = await this.getJiraProjectSafeUrl(userId, urlStr);
+ const safeUrl = await this.getJiraProjectSafeUrl(urlStr);
const res = await JiraProjectConnection.provisionConnection(this.roomId, userId, { url: safeUrl }, this.provisionOpts);
this.pushConnections(res.connection);
await this.client.sendNotice(this.roomId, `Room configured to bridge Jira project ${res.connection.projectKey}.`);
}
- @botCommand("jira list project", { help: "Show JIRA projects currently connected to.", category: "jira"})
+ @botCommand("jira list project", { help: "Show JIRA projects currently connected to.", category: JiraProjectConnection.ServiceCategory})
public async onJiraListProject() {
const projects: JiraProjectConnectionState[] = await this.client.getRoomState(this.roomId).catch((err: any) => {
if (err.body.errcode === 'M_NOT_FOUND') {
@@ -177,11 +180,11 @@ export class SetupConnection extends CommandConnection {
}
}
- @botCommand("jira remove project", { help: "Remove a connection for a JIRA project.", requiredArgs: ["url"], includeUserId: true, category: "jira"})
+ @botCommand("jira remove project", { help: "Remove a connection for a JIRA project.", requiredArgs: ["url"], includeUserId: true, category: JiraProjectConnection.ServiceCategory})
public async onJiraRemoveProject(userId: string, urlStr: string) {
- await this.checkUserPermissions(userId, "jira", JiraProjectConnection.CanonicalEventType);
+ await this.checkUserPermissions(userId, JiraProjectConnection.ServiceCategory, JiraProjectConnection.CanonicalEventType);
await this.checkJiraLogin(userId, urlStr);
- const safeUrl = await this.getJiraProjectSafeUrl(userId, urlStr);
+ const safeUrl = await this.getJiraProjectSafeUrl(urlStr);
const eventTypes = [
JiraProjectConnection.CanonicalEventType,
@@ -207,18 +210,27 @@ export class SetupConnection extends CommandConnection {
return this.client.sendHtmlNotice(this.roomId, md.renderInline(`Room no longer bridged to Jira project \`${safeUrl}\`.`));
}
- @botCommand("webhook", { help: "Create an inbound webhook.", requiredArgs: ["name"], includeUserId: true, category: "generic"})
- public async onWebhook(userId: string, name: string) {
+ @botCommand("webhook", { help: "Create an inbound webhook. The liveDuration must be specified as a duration string (e.g. 30d).", requiredArgs: ["name"], includeUserId: true, optionalArgs: ['liveDuration'], category: GenericHookConnection.ServiceCategory})
+ public async onWebhook(userId: string, name: string, liveDuration?: string) {
if (!this.config.generic?.enabled) {
throw new CommandError("not-configured", "The bridge is not configured to support webhooks.");
}
+ let expirationDate: string|undefined = undefined;
+ if (liveDuration) {
+ const expirationDuration = parseDuration(liveDuration);
+ if (!expirationDuration) {
+ throw new CommandError("Bad webhook duration", "A webhook name must be between 3-64 characters.");
+ }
+ expirationDate = new Date(expirationDuration + Date.now()).toISOString();
+ }
+
await this.checkUserPermissions(userId, "webhooks", GitHubRepoConnection.CanonicalEventType);
if (!name || name.length < 3 || name.length > 64) {
throw new CommandError("Bad webhook name", "A webhook name must be between 3-64 characters.");
}
- const c = await GenericHookConnection.provisionConnection(this.roomId, userId, {name}, this.provisionOpts);
+ const c = await GenericHookConnection.provisionConnection(this.roomId, userId, {name, expirationDate}, this.provisionOpts);
this.pushConnections(c.connection);
const url = new URL(c.connection.hookId, this.config.generic.parsedUrlPrefix);
const adminRoom = await this.getOrCreateAdminRoom(this.intent, userId);
@@ -234,7 +246,7 @@ export class SetupConnection extends CommandConnection {
- @botCommand("webhook list", { help: "Show webhooks currently configured.", category: "generic"})
+ @botCommand("webhook list", { help: "Show webhooks currently configured.", category: GenericHookConnection.ServiceCategory})
public async onWebhookList() {
const webhooks: GenericHookConnectionState[] = await this.client.getRoomState(this.roomId).catch((err: any) => {
if (err.body.errcode === 'M_NOT_FOUND') {
@@ -263,9 +275,9 @@ export class SetupConnection extends CommandConnection {
}
}
- @botCommand("webhook remove", { help: "Remove a webhook from the room.", requiredArgs: ["name"], includeUserId: true, category: "generic"})
+ @botCommand("webhook remove", { help: "Remove a webhook from the room.", requiredArgs: ["name"], includeUserId: true, category: GenericHookConnection.ServiceCategory})
public async onWebhookRemove(userId: string, name: string) {
- await this.checkUserPermissions(userId, "generic", GenericHookConnection.CanonicalEventType);
+ await this.checkUserPermissions(userId, GenericHookConnection.ServiceCategory, GenericHookConnection.CanonicalEventType);
const event = await this.client.getRoomStateEvent(this.roomId, GenericHookConnection.CanonicalEventType, name).catch((err: any) => {
if (err.body.errcode === 'M_NOT_FOUND') {
@@ -284,13 +296,42 @@ export class SetupConnection extends CommandConnection {
return this.client.sendHtmlNotice(this.roomId, md.renderInline(`Removed webhook \`${name}\``));
}
- @botCommand("figma file", { help: "Bridge a Figma file to the room.", requiredArgs: ["url"], includeUserId: true, category: "figma"})
+
+
+ @botCommand("outbound-hook", { help: "Create an outbound webhook.", requiredArgs: ["name", "url"], includeUserId: true, category: GenericHookConnection.ServiceCategory})
+ public async onOutboundHook(userId: string, name: string, url: string) {
+ if (!this.config.generic?.outbound) {
+ throw new CommandError("not-configured", "The bridge is not configured to support webhooks.");
+ }
+
+ await this.checkUserPermissions(userId, "webhooks", GitHubRepoConnection.CanonicalEventType);
+
+ const { connection }= await OutboundHookConnection.provisionConnection(this.roomId, userId, {name, url}, this.provisionOpts);
+ this.pushConnections(connection);
+
+ const adminRoom = await this.getOrCreateAdminRoom(this.intent, userId);
+ const safeRoomId = encodeURIComponent(this.roomId);
+
+ await this.client.sendHtmlNotice(
+ adminRoom.roomId,
+ md.renderInline(
+ `You have bridged the webhook "${name}" in https://matrix.to/#/${safeRoomId} .\n` +
+ // Line break before and no full stop after URL is intentional.
+ // This makes copying and pasting the URL much easier.
+ `Please use the secret token \`${connection.outboundToken}\` when validating the request.\n` +
+ `See the [documentation](${OUTBOUND_DOCS_LINK}) for more information`,
+ ));
+ return this.client.sendNotice(this.roomId, `Room configured to bridge outbound webhooks. See admin room for the secret token.`);
+ }
+
+
+ @botCommand("figma file", { help: "Bridge a Figma file to the room.", requiredArgs: ["url"], includeUserId: true, category: FigmaFileConnection.ServiceCategory})
public async onFigma(userId: string, url: string) {
if (!this.config.figma) {
throw new CommandError("not-configured", "The bridge is not configured to support Figma.");
}
- await this.checkUserPermissions(userId, "figma", FigmaFileConnection.CanonicalEventType);
+ await this.checkUserPermissions(userId, FigmaFileConnection.ServiceCategory, FigmaFileConnection.CanonicalEventType);
const res = /https:\/\/www\.figma\.com\/file\/(\w+).+/.exec(url);
if (!res) {
@@ -302,13 +343,13 @@ export class SetupConnection extends CommandConnection {
return this.client.sendHtmlNotice(this.roomId, md.renderInline(`Room configured to bridge Figma file.`));
}
- @botCommand("feed", { help: "Bridge an RSS/Atom feed to the room.", requiredArgs: ["url"], optionalArgs: ["label"], includeUserId: true, category: "feeds"})
+ @botCommand("feed", { help: "Bridge an RSS/Atom feed to the room.", requiredArgs: ["url"], optionalArgs: ["label"], includeUserId: true, category: FeedConnection.ServiceCategory})
public async onFeed(userId: string, url: string, label?: string) {
if (!this.config.feeds?.enabled) {
throw new CommandError("not-configured", "The bridge is not configured to support feeds.");
}
- await this.checkUserPermissions(userId, "feed", FeedConnection.CanonicalEventType);
+ await this.checkUserPermissions(userId,FeedConnection.ServiceCategory, FeedConnection.CanonicalEventType);
// provisionConnection will check it again, but won't give us a nice CommandError on failure
try {
@@ -327,7 +368,7 @@ export class SetupConnection extends CommandConnection {
return this.client.sendHtmlNotice(this.roomId, md.renderInline(`Room configured to bridge \`${url}\``));
}
- @botCommand("feed list", { help: "Show feeds currently subscribed to. Supported formats `json` and `yaml`.", optionalArgs: ["format"], category: "feeds"})
+ @botCommand("feed list", { help: "Show feeds currently subscribed to. Supported formats `json` and `yaml`.", optionalArgs: ["format"], category: FeedConnection.ServiceCategory})
public async onFeedList(format?: string) {
const useJsonFormat = format?.toLowerCase() === 'json';
const useYamlFormat = format?.toLowerCase() === 'yaml';
@@ -373,7 +414,7 @@ export class SetupConnection extends CommandConnection {
@botCommand("feed remove", { help: "Unsubscribe from an RSS/Atom feed.", requiredArgs: ["url"], includeUserId: true, category: "feeds"})
public async onFeedRemove(userId: string, url: string) {
- await this.checkUserPermissions(userId, "feed", FeedConnection.CanonicalEventType);
+ await this.checkUserPermissions(userId, FeedConnection.ServiceCategory, FeedConnection.CanonicalEventType);
const event = await this.client.getRoomStateEvent(this.roomId, FeedConnection.CanonicalEventType, url).catch((err: any) => {
if (err.body.errcode === 'M_NOT_FOUND') {
@@ -389,6 +430,36 @@ export class SetupConnection extends CommandConnection {
return this.client.sendHtmlNotice(this.roomId, md.renderInline(`Unsubscribed from \`${url}\``));
}
+ @botCommand("challenghound add", { help: "Bridge a ChallengeHound challenge to the room.", requiredArgs: ["url"], includeUserId: true, category: "challengehound"})
+ public async onChallengeHoundAdd(userId: string, url: string) {
+ if (!this.config.challengeHound) {
+ throw new CommandError("not-configured", "The bridge is not configured to support challengeHound.");
+ }
+
+ await this.checkUserPermissions(userId, HoundConnection.ServiceCategory, HoundConnection.CanonicalEventType);
+ const {connection, challengeName} = await HoundConnection.provisionConnection(this.roomId, userId, { url }, this.provisionOpts);
+ this.pushConnections(connection);
+ return this.client.sendHtmlNotice(this.roomId, md.renderInline(`Room configured to bridge ${challengeName}. Good luck!`));
+ }
+
+ @botCommand("challenghound remove", { help: "Unbridge a ChallengeHound challenge.", requiredArgs: ["urlOrId"], includeUserId: true, category: HoundConnection.ServiceCategory})
+ public async onChallengeHoundRemove(userId: string, urlOrId: string) {
+ await this.checkUserPermissions(userId, HoundConnection.ServiceCategory, HoundConnection.CanonicalEventType);
+ const id = urlOrId.startsWith('http') ? HoundConnection.getIdFromURL(urlOrId) : urlOrId;
+ const event = await this.client.getRoomStateEvent(this.roomId, HoundConnection.CanonicalEventType, id).catch((err: any) => {
+ if (err.body.errcode === 'M_NOT_FOUND') {
+ return null; // not an error to us
+ }
+ throw err;
+ });
+ if (!event || Object.keys(event).length === 0) {
+ throw new CommandError("Invalid feed URL", `Challenge "${id}" is not currently bridged to this room`);
+ }
+
+ await this.client.sendStateEvent(this.roomId, FeedConnection.CanonicalEventType, id, {});
+ return this.client.sendHtmlNotice(this.roomId, md.renderInline(`Unsubscribed from challenge`));
+ }
+
@botCommand("setup-widget", {category: "widget", help: "Open the setup widget in the room"})
public async onSetupWidget() {
if (this.config.widgets?.roomSetupWidget === undefined) {
diff --git a/src/Connections/index.ts b/src/Connections/index.ts
index d56143c98..c06b97cbe 100644
--- a/src/Connections/index.ts
+++ b/src/Connections/index.ts
@@ -10,4 +10,5 @@ export * from "./GitlabRepo";
export * from "./IConnection";
export * from "./JiraProject";
export * from "./FigmaFileConnection";
-export * from "./FeedConnection";
\ No newline at end of file
+export * from "./FeedConnection";
+export * from "./OutboundHook";
\ No newline at end of file
diff --git a/src/Gitlab/GrantChecker.ts b/src/Gitlab/GrantChecker.ts
index 66bd7bea7..de759fc6e 100644
--- a/src/Gitlab/GrantChecker.ts
+++ b/src/Gitlab/GrantChecker.ts
@@ -3,7 +3,7 @@ import { Appservice } from "matrix-bot-sdk";
import { BridgeConfigGitLab } from "../config/Config";
import { GitLabRepoConnection } from "../Connections";
import { GrantChecker } from "../grants/GrantCheck";
-import { UserTokenStore } from "../UserTokenStore";
+import { UserTokenStore } from "../tokens/UserTokenStore";
const log = new Logger('GitLabGrantChecker');
diff --git a/src/Gitlab/Types.ts b/src/Gitlab/Types.ts
index b7a29198b..956b8a823 100644
--- a/src/Gitlab/Types.ts
+++ b/src/Gitlab/Types.ts
@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
export interface GitLabAuthor {
id: number;
name: string;
diff --git a/src/Gitlab/WebhookTypes.ts b/src/Gitlab/WebhookTypes.ts
index c721367a6..c331df03d 100644
--- a/src/Gitlab/WebhookTypes.ts
+++ b/src/Gitlab/WebhookTypes.ts
@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
export interface IGitLabWebhookEvent {
object_kind: string;
}
@@ -64,9 +62,9 @@ export interface IGitLabWebhookMREvent {
object_attributes: IGitLabMergeRequestObjectAttributes;
labels: IGitLabLabel[];
changes: {
- [key: string]: {
- before: string;
- after: string;
+ draft?: {
+ previous: boolean;
+ current: boolean;
}
}
}
diff --git a/src/ListenerService.ts b/src/ListenerService.ts
index 32ef379f6..62f2168ec 100644
--- a/src/ListenerService.ts
+++ b/src/ListenerService.ts
@@ -30,6 +30,7 @@ export class ListenerService {
}
for (const listenerConfig of config) {
const app = expressApp();
+ app.set('x-powered-by', false);
app.use(Handlers.requestHandler());
this.listeners.push({
config: listenerConfig,
diff --git a/src/Managers/BotUsersManager.ts b/src/Managers/BotUsersManager.ts
index ab7ab871c..5927cd117 100644
--- a/src/Managers/BotUsersManager.ts
+++ b/src/Managers/BotUsersManager.ts
@@ -171,13 +171,10 @@ export default class BotUsersManager {
// Determine if an avatar update is needed
if (profile.avatar_url) {
try {
- const res = await axios.get(
- botUser.intent.underlyingClient.mxcToHttp(profile.avatar_url),
- { responseType: "arraybuffer" },
- );
+ const res = await botUser.intent.underlyingClient.downloadContent(profile.avatar_url);
const currentAvatarImage = {
- image: Buffer.from(res.data),
- contentType: res.headers["content-type"],
+ image: res.data,
+ contentType: res.contentType,
};
if (
currentAvatarImage.image.equals(avatarImage.image)
diff --git a/src/MatrixEvent.ts b/src/MatrixEvent.ts
index 5fa42599a..67bb5e90b 100644
--- a/src/MatrixEvent.ts
+++ b/src/MatrixEvent.ts
@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
export interface MatrixEvent {
content: T;
event_id: string;
@@ -8,10 +7,7 @@ export interface MatrixEvent {
type: string;
}
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface MatrixEventContent {
-
-}
+type MatrixEventContent = object;
export interface MatrixMemberContent extends MatrixEventContent {
avatar_url: string|null;
diff --git a/src/MatrixSender.ts b/src/MatrixSender.ts
index 924d1f9e8..36b59e127 100644
--- a/src/MatrixSender.ts
+++ b/src/MatrixSender.ts
@@ -34,7 +34,7 @@ export class MatrixSender {
try {
await this.sendMatrixMessage(msg.messageId || randomUUID(), msg.data);
} catch (ex) {
- log.error(`Failed to send message (${msg.data.roomId}, ${msg.data.sender}, ${msg.data.type})`);
+ log.error(`Failed to send message (${msg.data.roomId}, ${msg.data.sender}, ${msg.data.type})`, ex);
}
});
}
diff --git a/src/MessageQueue/MessageQueue.ts b/src/MessageQueue/MessageQueue.ts
index 476e6d862..03dc1d17f 100644
--- a/src/MessageQueue/MessageQueue.ts
+++ b/src/MessageQueue/MessageQueue.ts
@@ -1,4 +1,4 @@
-import { BridgeConfigQueue } from "../config/Config";
+import { BridgeConfigQueue } from "../config/sections";
import { LocalMQ } from "./LocalMQ";
import { RedisMQ } from "./RedisQueue";
import { MessageQueue } from "./Types";
@@ -6,8 +6,8 @@ import { MessageQueue } from "./Types";
const staticLocalMq = new LocalMQ();
let staticRedisMq: RedisMQ|null = null;
-export function createMessageQueue(config: BridgeConfigQueue): MessageQueue {
- if (config.monolithic) {
+export function createMessageQueue(config?: BridgeConfigQueue): MessageQueue {
+ if (!config) {
return staticLocalMq;
}
if (staticRedisMq === null) {
diff --git a/src/MessageQueue/RedisQueue.ts b/src/MessageQueue/RedisQueue.ts
index 2fbda2f3a..0800da894 100644
--- a/src/MessageQueue/RedisQueue.ts
+++ b/src/MessageQueue/RedisQueue.ts
@@ -1,7 +1,7 @@
import { MessageQueue, MessageQueueMessage, DEFAULT_RES_TIMEOUT, MessageQueueMessageOut } from "./Types";
import { Redis, default as redis } from "ioredis";
-import { BridgeConfigQueue } from "../config/Config";
+import { BridgeConfigQueue } from "../config/sections/queue";
import { EventEmitter } from "events";
import { Logger } from "matrix-appservice-bridge";
import { randomUUID } from 'node:crypto';
@@ -22,9 +22,10 @@ export class RedisMQ extends EventEmitter implements MessageQueue {
private myUuid: string;
constructor(config: BridgeConfigQueue) {
super();
- this.redisSub = new redis(config.port ?? 6379, config.host ?? "localhost");
- this.redisPub = new redis(config.port ?? 6379, config.host ?? "localhost");
- this.redis = new redis(config.port ?? 6379, config.host ?? "localhost");
+ const uri = 'redisUri' in config ? config.redisUri : `redis://${config.host ?? 'localhost'}:${config.port ?? 6379}`;
+ this.redisSub = new redis(uri);
+ this.redisPub = new redis(uri);
+ this.redis = new redis(uri);
this.myUuid = randomUUID();
this.redisSub.on("pmessage", (_: string, channel: string, message: string) => {
const msg = JSON.parse(message) as MessageQueueMessageOut;
diff --git a/src/Notifications/UserNotificationWatcher.ts b/src/Notifications/UserNotificationWatcher.ts
index 4531c7b96..fbd47315e 100644
--- a/src/Notifications/UserNotificationWatcher.ts
+++ b/src/Notifications/UserNotificationWatcher.ts
@@ -48,7 +48,7 @@ export class UserNotificationWatcher {
[...this.userIntervals.values()].forEach((v) => {
v.stop();
});
- this.queue.stop ? this.queue.stop() : undefined;
+ this.queue.stop?.();
}
public removeUser(userId: string, type: "github"|"gitlab", instanceUrl?: string) {
diff --git a/src/NotificationsProcessor.ts b/src/NotificationsProcessor.ts
index 8b4ea8013..640e85cb8 100644
--- a/src/NotificationsProcessor.ts
+++ b/src/NotificationsProcessor.ts
@@ -10,7 +10,6 @@ import { GitHubUserNotification } from "./github/Types";
import { components } from "@octokit/openapi-types/types";
import { NotifFilter } from "./NotificationFilters";
-
const log = new Logger("NotificationProcessor");
const md = new markdown();
@@ -21,18 +20,15 @@ export interface IssueDiff {
merged: boolean;
mergedBy: null|{
login: string;
- // eslint-disable-next-line camelcase
html_url: string;
};
user: {
login: string;
- // eslint-disable-next-line camelcase
html_url: string;
};
}
export interface CachedReviewData {
- // eslint-disable-next-line camelcase
requested_reviewers: PullsListRequestedReviewersResponseData;
reviews: PullsListReviewsResponseData;
}
@@ -40,8 +36,6 @@ export interface CachedReviewData {
type PROrIssue = IssuesGetResponseData|PullGetResponseData;
export class NotificationProcessor {
-
- // eslint-disable-next-line camelcase
private static formatUser(user: {login: string, html_url: string}) {
return `**[${user.login}](${user.html_url})**`;
}
diff --git a/src/Stores/MemoryStorageProvider.ts b/src/Stores/MemoryStorageProvider.ts
index 52b5bf545..89f3bc58c 100644
--- a/src/Stores/MemoryStorageProvider.ts
+++ b/src/Stores/MemoryStorageProvider.ts
@@ -14,6 +14,9 @@ export class MemoryStorageProvider extends MSP implements IBridgeStorageProvider
private storedFiles = new QuickLRU({ maxSize: 128 });
private gitlabDiscussionThreads = new Map();
private feedGuids = new Map>();
+ private houndActivityIds = new Map>();
+ private houndActivityIdToEvent = new Map();
+ private hasGenericHookWarnedExpiry = new Set();
constructor() {
super();
@@ -108,4 +111,41 @@ export class MemoryStorageProvider extends MSP implements IBridgeStorageProvider
public async setGitlabDiscussionThreads(connectionId: string, value: SerializedGitlabDiscussionThreads): Promise {
this.gitlabDiscussionThreads.set(connectionId, value);
}
+
+ async storeHoundActivity(challengeId: string, ...activityIds: string[]): Promise {
+ let set = this.houndActivityIds.get(challengeId);
+ if (!set) {
+ set = []
+ this.houndActivityIds.set(challengeId, set);
+ }
+ set.unshift(...activityIds);
+ while (set.length > MAX_FEED_ITEMS) {
+ set.pop();
+ }
+ }
+
+ async hasSeenHoundActivity(challengeId: string, ...activityIds: string[]): Promise {
+ const existing = this.houndActivityIds.get(challengeId);
+ return existing ? activityIds.filter((existingGuid) => existing.includes(existingGuid)) : [];
+ }
+
+ public async hasSeenHoundChallenge(challengeId: string): Promise {
+ return this.houndActivityIds.has(challengeId);
+ }
+
+ public async storeHoundActivityEvent(challengeId: string, activityId: string, eventId: string): Promise {
+ this.houndActivityIdToEvent.set(`${challengeId}.${activityId}`, eventId);
+ }
+
+ public async getHoundActivity(challengeId: string, activityId: string): Promise {
+ return this.houndActivityIdToEvent.get(`${challengeId}.${activityId}`) ?? null;
+ }
+
+ public async getHasGenericHookWarnedExpiry(hookId: string): Promise {
+ return this.hasGenericHookWarnedExpiry.has(hookId);
+ }
+
+ public async setHasGenericHookWarnedExpiry(hookId: string, hasWarned: boolean): Promise {
+ this.hasGenericHookWarnedExpiry[hasWarned ? "add" : "delete"](hookId);
+ }
}
diff --git a/src/Stores/RedisStorageProvider.ts b/src/Stores/RedisStorageProvider.ts
index 12c42a798..54be0a1d6 100644
--- a/src/Stores/RedisStorageProvider.ts
+++ b/src/Stores/RedisStorageProvider.ts
@@ -6,6 +6,7 @@ import { IBridgeStorageProvider, MAX_FEED_ITEMS } from "./StorageProvider";
import { IFilterInfo, IStorageProvider } from "matrix-bot-sdk";
import { ProvisionSession } from "matrix-appservice-bridge";
import { SerializedGitlabDiscussionThreads } from "../Gitlab/Types";
+import { BridgeConfigCache } from "../config/sections";
const BOT_SYNC_TOKEN_KEY = "bot.sync_token.";
const BOT_FILTER_KEY = "bot.filter.";
@@ -22,12 +23,17 @@ const STORED_FILES_EXPIRE_AFTER = 24 * 60 * 60; // 24 hours
const COMPLETED_TRANSACTIONS_EXPIRE_AFTER = 24 * 60 * 60; // 24 hours
const ISSUES_EXPIRE_AFTER = 7 * 24 * 60 * 60; // 7 days
const ISSUES_LAST_COMMENT_EXPIRE_AFTER = 14 * 24 * 60 * 60; // 7 days
+const HOUND_EVENT_CACHE = 90 * 24 * 60 * 60; // 90 days
const WIDGET_TOKENS = "widgets.tokens.";
const WIDGET_USER_TOKENS = "widgets.user-tokens.";
const FEED_GUIDS = "feeds.guids.";
+const HOUND_GUIDS = "hound.guids.";
+const HOUND_EVENTS = "hound.events.";
+
+const GENERIC_HOOK_HAS_WARNED = "generichook.haswarned";
const log = new Logger("RedisASProvider");
@@ -68,8 +74,8 @@ export class RedisStorageContextualProvider implements IStorageProvider {
export class RedisStorageProvider extends RedisStorageContextualProvider implements IBridgeStorageProvider {
- constructor(host: string, port: number, contextSuffix = '') {
- super(new redis(port, host), contextSuffix);
+ constructor(cacheConfig: BridgeConfigCache, contextSuffix = '') {
+ super(new redis(cacheConfig.redisUri), contextSuffix);
this.redis.expire(COMPLETED_TRANSACTIONS_KEY, COMPLETED_TRANSACTIONS_EXPIRE_AFTER).catch((ex) => {
log.warn("Failed to set expiry time on as.completed_transactions", ex);
});
@@ -98,7 +104,7 @@ export class RedisStorageProvider extends RedisStorageContextualProvider impleme
}
public async addRegisteredUser(userId: string) {
- this.redis.sadd(REGISTERED_USERS_KEY, [userId]);
+ await this.redis.sadd(REGISTERED_USERS_KEY, [userId]);
}
public async isUserRegistered(userId: string): Promise {
@@ -106,7 +112,7 @@ export class RedisStorageProvider extends RedisStorageContextualProvider impleme
}
public async setTransactionCompleted(transactionId: string) {
- this.redis.sadd(COMPLETED_TRANSACTIONS_KEY, [transactionId]);
+ await this.redis.sadd(COMPLETED_TRANSACTIONS_KEY, [transactionId]);
}
public async isTransactionCompleted(transactionId: string): Promise {
@@ -239,4 +245,53 @@ export class RedisStorageProvider extends RedisStorageContextualProvider impleme
}
return guids.filter((_guid, index) => res[index][1] !== null);
}
+
+ public async storeHoundActivity(challengeId: string, ...activityHashes: string[]): Promise {
+ if (activityHashes.length === 0) {
+ return;
+ }
+ const key = `${HOUND_GUIDS}${challengeId}`;
+ await this.redis.lpush(key, ...activityHashes);
+ await this.redis.ltrim(key, 0, MAX_FEED_ITEMS);
+ }
+
+ public async hasSeenHoundChallenge(challengeId: string): Promise {
+ const key = `${HOUND_GUIDS}${challengeId}`;
+ return (await this.redis.exists(key)) === 1;
+ }
+
+ public async hasSeenHoundActivity(challengeId: string, ...activityHashes: string[]): Promise {
+ let multi = this.redis.multi();
+ const key = `${HOUND_GUIDS}${challengeId}`;
+
+ for (const guid of activityHashes) {
+ multi = multi.lpos(key, guid);
+ }
+ const res = await multi.exec();
+ if (res === null) {
+ // Just assume we've seen none.
+ return [];
+ }
+ return activityHashes.filter((_guid, index) => res[index][1] !== null);
+ }
+
+ public async storeHoundActivityEvent(challengeId: string, activityId: string, eventId: string): Promise {
+ const key = `${HOUND_EVENTS}${challengeId}.${activityId}`;
+ await this.redis.set(key, eventId);
+ this.redis.expire(key, HOUND_EVENT_CACHE).catch((ex) => {
+ log.warn(`Failed to set expiry time on ${key}`, ex);
+ });
+ }
+
+ public async getHoundActivity(challengeId: string, activityId: string): Promise {
+ return this.redis.get(`${HOUND_EVENTS}${challengeId}.${activityId}`);
+ }
+
+ public async getHasGenericHookWarnedExpiry(hookId: string): Promise {
+ return await this.redis.sismember(GENERIC_HOOK_HAS_WARNED, hookId) === 1;
+ }
+
+ public async setHasGenericHookWarnedExpiry(hookId: string, hasWarned: boolean): Promise {
+ await this.redis[hasWarned ? "sadd" : "srem"](GENERIC_HOOK_HAS_WARNED, hookId);
+ }
}
diff --git a/src/Stores/StorageProvider.ts b/src/Stores/StorageProvider.ts
index 50175d75e..0ec10dddd 100644
--- a/src/Stores/StorageProvider.ts
+++ b/src/Stores/StorageProvider.ts
@@ -9,6 +9,8 @@ import { SerializedGitlabDiscussionThreads } from "../Gitlab/Types";
// seen from this feed, up to a max of 10,000.
// Adopted from https://github.com/matrix-org/go-neb/blob/babb74fa729882d7265ff507b09080e732d060ae/services/rssbot/rssbot.go#L304
export const MAX_FEED_ITEMS = 10_000;
+export const MAX_HOUND_ITEMS = 100;
+
export interface IBridgeStorageProvider extends IAppserviceStorageProvider, IStorageProvider, ProvisioningStore {
connect?(): Promise;
@@ -28,4 +30,13 @@ export interface IBridgeStorageProvider extends IAppserviceStorageProvider, ISto
storeFeedGuids(url: string, ...guids: string[]): Promise;
hasSeenFeed(url: string): Promise;
hasSeenFeedGuids(url: string, ...guids: string[]): Promise;
+
+ storeHoundActivity(challengeId: string, ...activityHashes: string[]): Promise;
+ hasSeenHoundChallenge(challengeId: string): Promise;
+ hasSeenHoundActivity(challengeId: string, ...activityHashes: string[]): Promise;
+ storeHoundActivityEvent(challengeId: string, activityId: string, eventId: string): Promise;
+ getHoundActivity(challengeId: string, activityId: string): Promise;
+
+ getHasGenericHookWarnedExpiry(hookId: string): Promise;
+ setHasGenericHookWarnedExpiry(hookId: string, hasWarned: boolean): Promise;
}
\ No newline at end of file
diff --git a/src/Webhooks.ts b/src/Webhooks.ts
index 4597f7ca0..863d5ed12 100644
--- a/src/Webhooks.ts
+++ b/src/Webhooks.ts
@@ -8,7 +8,7 @@ import { ApiError, ErrCode, Logger } from "matrix-appservice-bridge";
import qs from "querystring";
import axios from "axios";
import { IGitLabWebhookEvent, IGitLabWebhookIssueStateEvent, IGitLabWebhookMREvent, IGitLabWebhookReleaseEvent } from "./Gitlab/WebhookTypes";
-import { EmitterWebhookEvent, EmitterWebhookEventName, Webhooks as OctokitWebhooks } from "@octokit/webhooks"
+import { EmitterWebhookEvent, Webhooks as OctokitWebhooks } from "@octokit/webhooks"
import { IJiraWebhookEvent } from "./jira/WebhookTypes";
import { JiraWebhooksRouter } from "./jira/Router";
import { OAuthRequest } from "./WebhookTypes";
@@ -18,6 +18,7 @@ import { FigmaWebhooksRouter } from "./figma/router";
import { GenericWebhooksRouter } from "./generic/Router";
import { GithubInstance } from "./github/GithubInstance";
import QuickLRU from "@alloc/quick-lru";
+import type { WebhookEventName } from "@octokit/webhooks-types";
const log = new Logger("Webhooks");
@@ -178,7 +179,7 @@ export class Webhooks extends EventEmitter {
}
this.ghWebhooks.verifyAndReceive({
id: githubGuid as string,
- name: req.headers["x-github-event"] as EmitterWebhookEventName,
+ name: req.headers["x-github-event"] as WebhookEventName,
payload: githubData.payload,
signature: githubData.signature,
}).catch((err) => {
diff --git a/src/Widgets/BridgeWidgetApi.ts b/src/Widgets/BridgeWidgetApi.ts
index 385557890..f17d62903 100644
--- a/src/Widgets/BridgeWidgetApi.ts
+++ b/src/Widgets/BridgeWidgetApi.ts
@@ -11,7 +11,7 @@ import BotUsersManager, {BotUser} from "../Managers/BotUsersManager";
import { assertUserPermissionsInRoom, GetConnectionsResponseItem } from "../provisioning/api";
import { Appservice, PowerLevelsEvent } from "matrix-bot-sdk";
import { GithubInstance } from '../github/GithubInstance';
-import { AllowedTokenTypes, TokenType, UserTokenStore } from '../UserTokenStore';
+import { AllowedTokenTypes, TokenType, UserTokenStore } from '../tokens/UserTokenStore';
const log = new Logger("BridgeWidgetApi");
@@ -100,14 +100,15 @@ export class BridgeWidgetApi extends ProvisioningApi {
general: true,
github: !!this.config.github,
gitlab: !!this.config.gitlab,
- generic: !!this.config.generic,
+ generic: !!this.config.generic?.enabled,
+ genericOutbound: !!this.config.generic?.outbound,
jira: !!this.config.jira,
figma: !!this.config.figma,
feeds: !!this.config.feeds?.enabled,
});
}
- private async getServiceConfig(req: ProvisioningRequest, res: Response>) {
+ private async getServiceConfig(req: ProvisioningRequest, res: Response