✨implement 3pid binding invite hook ( #158 ) (#187)

* ✨ feat: add list invitation tokens db method

* 🧑‍💻 feat: added server name extractor helper

* ✨ feat: call onbind hook

* 🏷️ chore: added related types

* 🎨 chore: update getServerNameFromMatrixId helper

* 🧪 chore: added utils tests

* 🧪 chore: add invitation tokens listing tests

* 🎨 fix: skip calling onbind API when no pending invitations found

Author: rezk2ll

packages/matrix-identity-server/src/3pid/bind.ts

@@ -7,6 +7,8 @@ import {
   validateParameters,
   type expressAppHandler
 } from '@twake/utils'
+import { buildUrl, getServerNameFromMatrixId } from '../utils'
+import type { onBindRequestPayload } from '../types'
 
 const clientSecretRe = /^[0-9a-zA-Z.=_-]{6,255}$/
 const mxidRe = /^@[0-9a-zA-Z._=-]+:[0-9a-zA-Z.-]+$/
@@ -78,7 +80,18 @@ const bind = <T extends string = never>(
                   return
                 }
 
-                // TODO : hook for any pending invite and call the onbind api : https://spec.matrix.org/v1.11/client-server-api/#room-aliases
+                _onBind(
+                  idServer,
+                  (obj as RequestTokenArgs).mxid,
+                  rows[0].address as string,
+                  rows[0].medium as string
+                )
+                  .then(() => {
+                    idServer.logger.info(`Finished server onbind for ${mxid}`)
+                  })
+                  .catch((err) => {
+                    idServer.logger.error('Error calling server onbind', err)
+                  })
 
                 idServer.db
                   .get('keys', ['data'], { name: 'pepper' })
@@ -152,4 +165,59 @@ const bind = <T extends string = never>(
   }
 }
 
+/**
+ * Calls the Matrix server onbind hook
+ * @summary spec: https://spec.matrix.org/v1.13/server-server-api/#third-party-invites
+ *
+ * @param {MatrixIdentityServer} idServer
+ * @param {string} mxid
+ * @param {string} address
+ * @param {string} medium
+ */
+const _onBind = async <T extends string = never>(
+  idServer: MatrixIdentityServer<T>,
+  mxid: string,
+  address: string,
+  medium: string
+): Promise<void> => {
+  try {
+    const server = getServerNameFromMatrixId(mxid)
+    const invitationTokens = await idServer.db.listInvitationTokens(address)
+
+    if (!invitationTokens || !invitationTokens.length) {
+      idServer.logger.info(`No pending invitations found for ${address}`)
+      console.info(`No pending invitations found for ${address}`)
+
+      return
+    }
+
+    const invites = invitationTokens.map(({ data }) => data)
+
+    const response = await fetch(
+      buildUrl(server, `/_matrix/federation/v1/3pid/onbind`),
+      {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({
+          mxid,
+          address,
+          medium,
+          invites
+        } satisfies onBindRequestPayload)
+      }
+    )
+
+    if (response.status !== 200) {
+      throw new Error(
+        `Failed to call onbind hook, status code: ${response.status}`
+      )
+    }
+  } catch (error) {
+    console.error(`Failed to call onbind hook`, { error })
+    idServer.logger.error('Error calling onbind hook', error)
+  }
+}
+
 export default bind

packages/matrix-identity-server/src/db/index.test.ts

@@ -5,6 +5,7 @@ import DefaultConfig from '../config.json'
 import { type Config, type DbGetResult } from '../types'
 import IdDb from './index'
 import fs from 'fs'
+import { assert } from 'console'
 
 const baseConf: Config = {
   ...DefaultConfig,
@@ -1224,4 +1225,33 @@ describe('Id Server DB', () => {
       })
       .catch(done)
   })
+
+  it('should list invitation tokens', async () => {
+    const idDb = new IdDb(baseConf, logger)
+
+    await idDb.ready
+
+    await idDb.createInvitationToken('[email protected]', { test: 'a' })
+    await idDb.createInvitationToken('+21652111333', { test: 'b' })
+    await idDb.createInvitationToken('[email protected]', { test: 'c' })
+
+    const tokens = await idDb.listInvitationTokens('[email protected]')
+    assert(tokens)
+
+    expect(tokens?.length).toBe(2)
+  })
+
+  it('should return an empty array of no invitation tokens were found', async () => {
+    const idDb = new IdDb(baseConf, logger)
+
+    await idDb.ready
+
+    await idDb.createInvitationToken('[email protected]', { test: 'a' })
+
+    const tokens = await idDb.listInvitationTokens('+21652111222')
+
+    assert(tokens)
+
+    expect(tokens?.length).toBe(0)
+  })
 })

packages/matrix-identity-server/src/db/index.ts

@@ -1,6 +1,6 @@
 import { generateKeyPair, randomString } from '@twake/crypto'
 import { type TwakeLogger } from '@twake/logger'
-import { type Config, type DbGetResult } from '../types'
+import { type invitationToken, type Config, type DbGetResult } from '../types'
 import { epoch } from '@twake/utils'
 import Pg from './sql/pg'
 import { type ISQLCondition } from './sql/sql'
@@ -581,6 +581,35 @@ class IdentityServerDb<T extends string = never>
     })
   }
 
+  /**
+   * list invitation tokens
+   *
+   * @param {string} address - the invited 3pid address
+   * @returns {Promise<invitationToken[]>} - list of invitation tokens
+   */
+  async listInvitationTokens(
+    address: string
+  ): Promise<invitationToken[] | undefined> {
+    if (this.db == null) {
+      throw new Error('Wait for database to be ready')
+    }
+
+    try {
+      const tokenResults = await this.db.get(
+        'invitationTokens',
+        ['data', 'address', 'id'],
+        { address }
+      )
+      return tokenResults.map((row) => JSON.parse(row.data as string))
+    } catch (error) {
+      console.error(`Failed to list invitation tokens for address`, {
+        error
+      })
+
+      this.logger.error('Failed to get tokens', error)
+    }
+  }
+
   // eslint-disable-next-line @typescript-eslint/promise-function-async
   verifyInvitationToken(id: string): Promise<object> {
     /* istanbul ignore if */

packages/matrix-identity-server/src/types.ts

@@ -89,3 +89,35 @@ export interface UserQuota {
 export interface ISMSService {
   send: (to: string, body: string) => Promise<void>
 }
+
+export interface IdentityServerDomainSignature {
+  'ed25519:0': string
+}
+
+export interface IdServerSignature {
+  mxid: string
+  signatures: Record<string, IdentityServerDomainSignature>
+  token: string
+}
+
+export interface ThirPartyInvitePayload {
+  address: string
+  medium: string
+  mxid: string
+  room_id: string
+  sender: string
+  signed: IdServerSignature
+}
+
+export interface onBindRequestPayload {
+  address: string
+  invites: ThirPartyInvitePayload[]
+  medium: string
+  mxid: string
+}
+
+export interface invitationToken {
+  id: string
+  address: string
+  data: ThirPartyInvitePayload
+}

packages/matrix-identity-server/src/utils.test.ts

@@ -0,0 +1,11 @@
+import { getServerNameFromMatrixId } from './utils'
+
+describe('the getServerNameFromMatrixId helper', () => {
+  it('should extract the server name correctly', () => {
+    const firstServer = getServerNameFromMatrixId('@test:example.com')
+    const secondServer = getServerNameFromMatrixId('@support:linagora.com')
+
+    expect(firstServer).toEqual('example.com')
+    expect(secondServer).toEqual('linagora.com')
+  })
+})

packages/matrix-identity-server/src/utils.ts

@@ -120,3 +120,13 @@ export const buildUrl = (base: string, path: string): string => {
 
   return finalUrl.toString()
 }
+
+/**
+ * Extracts the server name from a Matrix ID
+ *
+ * @param {string} mxid
+ * @return {string}
+ */
+export const getServerNameFromMatrixId = (mxid: string): string => {
+  return mxid.split(':')[1]
+}