The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
feat(teams): match a Teams sender to a workspace member by email (#27659)
Abdul Rahmand92e3b29f2d8
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/data/__tests__/find-workspace-member-id-by-email.test.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/data/__tests__/find-workspace-member-id-by-email.test.tsnew file mode 100644index 00000000000..a9924d1b8d2--- /dev/null+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/data/__tests__/find-workspace-member-id-by-email.test.ts@@ -0,0 +1,50 @@+import { describe, expect, it, vi } from 'vitest';++import { findWorkspaceMemberIdByEmail } from 'src/features/chat/logic-functions/data/find-workspace-member-id-by-email';++const buildClient = (memberIds: string[]) => ({+ query: vi.fn().mockResolvedValue({+ workspaceMembers: {+ edges: memberIds.map((id) => ({ node: { id } })),+ },+ }),+});++describe('findWorkspaceMemberIdByEmail', () => {+ it('should match the email case-insensitively and escape LIKE wildcards', async () => {+ const client = buildClient(['workspace-member-id']);++ expect(+ await findWorkspaceMemberIdByEmail({+ client,+ email: '[email protected]',+ }),+ ).toBe('workspace-member-id');+ expect(client.query).toHaveBeenCalledWith({+ workspaceMembers: expect.objectContaining({+ __args: {+ filter: { userEmail: { ilike: 'Jane\\[email protected]' } },+ first: 2,+ },+ }),+ });+ });++ it('should return nothing when no member has the email', async () => {+ expect(+ await findWorkspaceMemberIdByEmail({+ client: buildClient([]),+ email: '[email protected]',+ }),+ ).toBeUndefined();+ });++ it('should not pick a member when the email matches more than one', async () => {+ expect(+ await findWorkspaceMemberIdByEmail({+ client: buildClient(['first-member-id', 'second-member-id']),+ email: '[email protected]',+ }),+ ).toBeUndefined();+ });+});diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/data/find-workspace-member-id-by-email.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/data/find-workspace-member-id-by-email.tsnew file mode 100644index 00000000000..6254fe1f113--- /dev/null+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/data/find-workspace-member-id-by-email.ts@@ -0,0 +1,28 @@+import { isNonEmptyString } from '@sniptt/guards';+import { type CoreApiClient } from 'twenty-client-sdk/core';++import { escapeSqlLikePattern } from 'src/features/chat/logic-functions/utils/escape-sql-like-pattern';++export const findWorkspaceMemberIdByEmail = async ({+ client,+ email,+}: {+ client: Pick<CoreApiClient, 'query'>;+ email: string;+}): Promise<string | undefined> => {+ const queryResult = await client.query({+ workspaceMembers: {+ __args: {+ filter: { userEmail: { ilike: escapeSqlLikePattern(email) } },+ first: 2,+ },+ edges: { node: { id: true } },+ },+ });++ const matchingMemberIds = (queryResult.workspaceMembers?.edges ?? [])+ .map((edge: { node?: { id?: string } }) => edge.node?.id)+ .filter(isNonEmptyString);++ return matchingMemberIds.length === 1 ? matchingMemberIds[0] : undefined;+};diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/escape-sql-like-pattern.test.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/escape-sql-like-pattern.test.tsnew file mode 100644index 00000000000..4f2603d54c5--- /dev/null+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/escape-sql-like-pattern.test.ts@@ -0,0 +1,19 @@+import { describe, expect, it } from 'vitest';++import { escapeSqlLikePattern } from 'src/features/chat/logic-functions/utils/escape-sql-like-pattern';++describe('escapeSqlLikePattern', () => {+ it('should leave a plain email untouched', () => {+ expect(escapeSqlLikePattern('[email protected]')).toBe('[email protected]');+ });++ it('should escape underscores', () => {+ expect(escapeSqlLikePattern('[email protected]')).toBe(+ 'jane\\[email protected]',+ );+ });++ it('should escape percent signs and backslashes', () => {+ expect(escapeSqlLikePattern('a%b\\c')).toBe('a\\%b\\\\c');+ });+});diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/resolve-teams-sender-workspace-member-id.test.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/resolve-teams-sender-workspace-member-id.test.tsnew file mode 100644index 00000000000..a0acae1df1d--- /dev/null+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/resolve-teams-sender-workspace-member-id.test.ts@@ -0,0 +1,105 @@+import { beforeEach, describe, expect, it, vi } from 'vitest';++import { resolveTeamsSenderWorkspaceMemberId } from 'src/features/chat/logic-functions/utils/resolve-teams-sender-workspace-member-id';++const { getTeamsConversationMemberMock, findWorkspaceMemberIdByEmailMock } =+ vi.hoisted(() => ({+ getTeamsConversationMemberMock: vi.fn(),+ findWorkspaceMemberIdByEmailMock: vi.fn(),+ }));++vi.mock(+ 'src/features/chat/logic-functions/utils/get-teams-conversation-member',+ () => ({ getTeamsConversationMember: getTeamsConversationMemberMock }),+);++vi.mock(+ 'src/features/chat/logic-functions/data/find-workspace-member-id-by-email',+ () => ({ findWorkspaceMemberIdByEmail: findWorkspaceMemberIdByEmailMock }),+);++const CLIENT = { query: vi.fn() };+const CLAIMED_TENANT_ID = 'claimed-tenant-id';++const resolve = () =>+ resolveTeamsSenderWorkspaceMemberId({+ client: CLIENT,+ serviceUrl: 'https://smba.trafficmanager.net/amer/',+ conversationId: 'a:personal-conversation',+ teamsUserId: '29:user-id',+ teamsTenantId: CLAIMED_TENANT_ID,+ accessToken: 'connector-access-token',+ });++describe('resolveTeamsSenderWorkspaceMemberId', () => {+ beforeEach(() => {+ vi.clearAllMocks();+ findWorkspaceMemberIdByEmailMock.mockResolvedValue('workspace-member-id');+ });++ it('should match the sender to a workspace member by email', async () => {+ getTeamsConversationMemberMock.mockResolvedValue({+ id: '29:user-id',+ tenantId: CLAIMED_TENANT_ID,+ email: '[email protected]',+ userPrincipalName: '[email protected]',+ });++ expect(await resolve()).toBe('workspace-member-id');+ expect(getTeamsConversationMemberMock).toHaveBeenCalledWith({+ serviceUrl: 'https://smba.trafficmanager.net/amer/',+ conversationId: 'a:personal-conversation',+ memberId: '29:user-id',+ accessToken: 'connector-access-token',+ });+ expect(findWorkspaceMemberIdByEmailMock).toHaveBeenCalledWith({+ client: CLIENT,+ email: '[email protected]',+ });+ });++ it('should fall back to the user principal name when Teams returns no email', async () => {+ getTeamsConversationMemberMock.mockResolvedValue({+ id: '29:user-id',+ tenantId: CLAIMED_TENANT_ID,+ userPrincipalName: '[email protected]',+ });++ expect(await resolve()).toBe('workspace-member-id');+ expect(findWorkspaceMemberIdByEmailMock).toHaveBeenCalledWith({+ client: CLIENT,+ email: '[email protected]',+ });+ });++ it('should not look up a member when the sender has no email at all', async () => {+ getTeamsConversationMemberMock.mockResolvedValue({+ id: '29:user-id',+ tenantId: CLAIMED_TENANT_ID,+ });++ expect(await resolve()).toBeUndefined();+ expect(findWorkspaceMemberIdByEmailMock).not.toHaveBeenCalled();+ });++ it('should not trust an email asserted by a tenant other than the claimed one', async () => {+ getTeamsConversationMemberMock.mockResolvedValue({+ id: '29:user-id',+ tenantId: 'other-tenant-id',+ email: '[email protected]',+ });++ expect(await resolve()).toBeUndefined();+ expect(findWorkspaceMemberIdByEmailMock).not.toHaveBeenCalled();+ });++ it('should not trust an email when Teams does not report the sender tenant', async () => {+ getTeamsConversationMemberMock.mockResolvedValue({+ id: '29:user-id',+ email: '[email protected]',+ });++ expect(await resolve()).toBeUndefined();+ expect(findWorkspaceMemberIdByEmailMock).not.toHaveBeenCalled();+ });+});diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/escape-sql-like-pattern.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/escape-sql-like-pattern.tsnew file mode 100644index 00000000000..a763bfcce4f--- /dev/null+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/escape-sql-like-pattern.ts@@ -0,0 +1,2 @@+export const escapeSqlLikePattern = (value: string): string =>+ value.replace(/[\\%_]/g, (wildcard) => `\\${wildcard}`);diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/resolve-teams-sender-workspace-member-id.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/resolve-teams-sender-workspace-member-id.tsnew file mode 100644index 00000000000..242e32e1ccb--- /dev/null+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/resolve-teams-sender-workspace-member-id.ts@@ -0,0 +1,50 @@+import { isNonEmptyString } from '@sniptt/guards';+import { type CoreApiClient } from 'twenty-client-sdk/core';+import { isDefined } from 'twenty-sdk/utils';++import { findWorkspaceMemberIdByEmail } from 'src/features/chat/logic-functions/data/find-workspace-member-id-by-email';+import { type TeamsConversationMember } from 'src/features/chat/logic-functions/types/teams-conversation-member.type';+import { getTeamsConversationMember } from 'src/features/chat/logic-functions/utils/get-teams-conversation-member';++const isEmailVouchedForByClaimedTenant = ({+ member,+ teamsTenantId,+}: {+ member: TeamsConversationMember;+ teamsTenantId: string;+}): boolean => member.tenantId === teamsTenantId;++export const resolveTeamsSenderWorkspaceMemberId = async ({+ client,+ serviceUrl,+ conversationId,+ teamsUserId,+ teamsTenantId,+ accessToken,+}: {+ client: Pick<CoreApiClient, 'query'>;+ serviceUrl: string;+ conversationId: string;+ teamsUserId: string;+ teamsTenantId: string;+ accessToken: string;+}): Promise<string | undefined> => {+ const member = await getTeamsConversationMember({+ serviceUrl,+ conversationId,+ memberId: teamsUserId,+ accessToken,+ });++ if (!isEmailVouchedForByClaimedTenant({ member, teamsTenantId })) {+ return undefined;+ }++ const email = [member.email, member.userPrincipalName].find(isNonEmptyString);++ if (!isDefined(email)) {+ return undefined;+ }++ return await findWorkspaceMemberIdByEmail({ client, email });+};diff --git a/packages/twenty-apps/public/teams/src/roles/default-function.role.ts b/packages/twenty-apps/public/teams/src/roles/default-function.role.tsindex 14f2f9ac621..af657534cda 100644--- a/packages/twenty-apps/public/teams/src/roles/default-function.role.ts+++ b/packages/twenty-apps/public/teams/src/roles/default-function.role.ts@@ -10,7 +10,7 @@ export default defineApplicationRole({universalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,label: 'Twenty Microsoft Teams tools role',description:- 'Reads calendar events to match Teams meetings and writes imported transcripts to Call Recordings. Tracks assistant requests received from Teams. Chat tools only forward requests to Microsoft Teams using the configured bot credentials.',+ 'Reads calendar events to match Teams meetings and writes imported transcripts to Call Recordings. Tracks assistant requests received from Teams and reads workspace members to match a Teams sender by email. Chat tools only forward requests to Microsoft Teams using the configured bot credentials.',canReadAllObjectRecords: false,canUpdateAllObjectRecords: false,canSoftDeleteAllObjectRecords: false,@@ -36,6 +36,15 @@ export default defineApplicationRole({canSoftDeleteObjectRecords: false,canDestroyObjectRecords: false,},+ {+ objectUniversalIdentifier:+ STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.workspaceMember+ .universalIdentifier,+ canReadObjectRecords: true,+ canUpdateObjectRecords: false,+ canSoftDeleteObjectRecords: false,+ canDestroyObjectRecords: false,+ },{objectUniversalIdentifier:TEAMS_ASSISTANT_REQUEST_OBJECT_UNIVERSAL_IDENTIFIER,