feat: slack integration (#322)

* removed install state for rebasing * slack integration with refactored code * removed cert.pem * client side updated with respect to slack integration * localhost https configs removed * Refactored code worked successfully with hubspot * Added PubSub for chat feature * removed install-state to fix rebase * make improvements & fixes post testing * update header text --------- Co-authored-by: Ashutosh Dhande <[email protected]>
revertinc · Oct 20, 2023 · 1176f76 · 1176f76 · vercel · Oct 20, 2023
1 parent a8a5faf
commit 1176f76
Show file tree

Hide file tree

Showing 37 changed files with 909 additions and 89 deletions.
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/fern/api/definition/chat/channels.yml b/fern/api/definition/chat/channels.yml
@@ -0,0 +1,45 @@
+imports:
+    errors: ../common/errors.yml
+    types: ../common/types.yml
+    unified: ../common/unified.yml
+    associations: ../common/associations.yml
+
+types:
+    GetChannelsResponse:
+        properties:
+            status: types.ResponseStatus
+            next: optional<string>
+            previous: optional<string>
+            results: list<unified.Channel>
+
+service:
+    base-path: /chat/channels
+    auth: false
+    headers:
+        x-revert-api-token:
+            type: string
+            docs: Your official API key for accessing revert apis.
+        x-revert-t-id:
+            type: string
+            docs: The unique customer id used when the customer linked their account.
+        x-api-version:
+            type: optional<string>
+            docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
+    audiences:
+        - external
+    endpoints:
+        getChannels:
+            docs: Get all the channels
+            method: GET
+            path: ''
+            request:
+                name: GetChannelsRequest
+                query-parameters:
+                    fields: optional<string>
+                    pageSize: optional<string>
+                    cursor: optional<string>
+            response: GetChannelsResponse
+            errors:
+                - errors.UnAuthorizedError
+                - errors.InternalServerError
+                - errors.NotFoundError
diff --git a/fern/api/definition/chat/messages.yml b/fern/api/definition/chat/messages.yml
@@ -0,0 +1,43 @@
+imports:
+    errors: ../common/errors.yml
+    types: ../common/types.yml
+    unified: ../common/unified.yml
+    associations: ../common/associations.yml
+
+types:
+    CreateorUpdateMessageRequest:
+        extends: unified.Message
+    CreateorUpdateMessageResponse:
+        properties:
+            status: types.ResponseStatus
+            result: unified.Message
+
+service:
+    base-path: /chat/message
+    auth: false
+    headers:
+        x-revert-api-token:
+            type: string
+            docs: Your official API key for accessing revert apis.
+        x-revert-t-id:
+            type: string
+            docs: The unique customer id used when the customer linked their account.
+        x-api-version:
+            type: optional<string>
+            docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
+    audiences:
+        - external
+    endpoints:
+        createMessage:
+            docs: Create a new message
+            method: POST
+            path: ''
+            request:
+                name: CreateMessageRequest
+                body: CreateorUpdateMessageRequest
+            response: CreateorUpdateMessageResponse
+            errors:
+                - errors.UnAuthorizedError
+                - errors.InternalServerError
+                - errors.NotFoundError
+                - errors.BadRequestError
diff --git a/fern/api/definition/chat/users.yml b/fern/api/definition/chat/users.yml
@@ -0,0 +1,45 @@
+imports:
+    errors: ../common/errors.yml
+    types: ../common/types.yml
+    unified: ../common/unified.yml
+    associations: ../common/associations.yml
+
+types:
+    GetUsersResponse:
+        properties:
+            status: types.ResponseStatus
+            next: optional<string>
+            previous: optional<string>
+            results: list<unified.UserChat>
+
+service:
+    base-path: /chat/users
+    auth: false
+    headers:
+        x-revert-api-token:
+            type: string
+            docs: Your official API key for accessing revert apis.
+        x-revert-t-id:
+            type: string
+            docs: The unique customer id used when the customer linked their account.
+        x-api-version:
+            type: optional<string>
+            docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
+    audiences:
+        - external
+    endpoints:
+        getUsers:
+            docs: Get all the users
+            method: GET
+            path: ''
+            request:
+                name: GetUsersRequest
+                query-parameters:
+                    fields: optional<string>
+                    pageSize: optional<string>
+                    cursor: optional<string>
+            response: GetUsersResponse
+            errors:
+                - errors.UnAuthorizedError
+                - errors.InternalServerError
+                - errors.NotFoundError
diff --git a/fern/api/definition/common/types.yml b/fern/api/definition/common/types.yml
@@ -49,6 +49,7 @@ types:
             - zohocrm
             - sfdc
             - pipedrive
+            - slack
     StandardObject:
         enum:
             - company

diff --git a/fern/api/definition/common/unified.yml b/fern/api/definition/common/unified.yml
@@ -195,3 +195,33 @@ types:
         extends:
             - CommonUnifiedFields
             - UserWrite
+    UserChat:
+        properties:
+            id:
+                type: string
+                docs: Id of user according to connected communication app
+            name:
+                type: string
+                docs: The name of user in communication app
+            createdTimestamp:
+                type: unknown
+                docs: Date at which user account has been created
+    Channel:
+        properties:
+            id:
+                type: string
+                docs: Id of channel belonging to workspace
+            name:
+                type: string
+                docs: The name of channel in communication app
+            createdTimestamp:
+                type: unknown
+                docs: Date at which channel has been created
+    Message:
+        properties:
+            text:
+                type: string
+                docs: Message sent by user
+            channelId:
+                type: string
+                docs: Id of channel to which message was sent
diff --git a/packages/backend/config.ts b/packages/backend/config.ts
@@ -26,6 +26,9 @@ const config = {
     WHITE_LISTED_DOMAINS: process.env.WHITE_LISTED_DOMAINS?.split(','),
     AES_ENCRYPTION_SECRET: process.env.AES_ENCRYPTION_SECRET!,
     MOESIF_APPLICATION_ID: process.env.MOESIF_APPLICATION_ID,
+    SLACK_CLIENT_ID: process.env.SLACK_CLIENT_ID!,
+    SLACK_CLIENT_SECRET: process.env.SLACK_CLIENT_SECRET!,
+    SLACK_BOT_TOKEN: process.env.SLACK_BOT_TOKEN!,
 };
 
 export default config;
diff --git a/packages/backend/constants/common.ts b/packages/backend/constants/common.ts
@@ -1,5 +1,8 @@
 import { TP_ID } from '@prisma/client';
 
+export type CRM_TP_ID = 'zohocrm' | 'sfdc' | 'pipedrive' | 'hubspot';
+// export type CHAT_TP_ID = 'slack';
+
 export const DEFAULT_SCOPE = {
     [TP_ID.hubspot]: [
         'crm.objects.contacts.read',
@@ -34,14 +37,16 @@ export const DEFAULT_SCOPE = {
     [TP_ID.zohocrm]: ['ZohoCRM.modules.ALL', 'ZohoCRM.settings.ALL', 'ZohoCRM.users.ALL', 'AaaServer.profile.READ'],
     [TP_ID.sfdc]: [], // https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_tokens_scopes.htm&type=5
     [TP_ID.pipedrive]: [],
+    [TP_ID.slack]: ['users:read', 'users.profile:read'],
 };
 
 export const mapIntegrationIdToIntegrationName = {
-    [TP_ID.hubspot]: "Hubspot",
-    [TP_ID.pipedrive]: "Pipedrive",
-    [TP_ID.sfdc]: "Salesforce",
-    [TP_ID.zohocrm]: "Zoho",
-}
+    [TP_ID.hubspot]: 'Hubspot',
+    [TP_ID.pipedrive]: 'Pipedrive',
+    [TP_ID.sfdc]: 'Salesforce',
+    [TP_ID.zohocrm]: 'Zoho',
+    [TP_ID.slack]: 'Slack',
+};
 
 export const rootSchemaMappingId = 'revertRootSchemaMapping';
 
@@ -56,7 +61,7 @@ export enum StandardObjects {
     user = 'user',
 }
 
-export const objectNameMapping: Record<string, Record<TP_ID, string | undefined>> = {
+export const objectNameMapping: Record<string, Record<CRM_TP_ID, string | undefined>> = {
     [StandardObjects.company]: {
         [TP_ID.hubspot]: 'companies',
         [TP_ID.pipedrive]: 'organization',

diff --git a/packages/backend/helpers/crm/transform/disunify.ts b/packages/backend/helpers/crm/transform/disunify.ts
@@ -1,5 +1,5 @@
 import { TP_ID, accountFieldMappingConfig } from '@prisma/client';
-import { StandardObjects } from '../../../constants/common';
+import { CRM_TP_ID, StandardObjects } from '../../../constants/common';
 import { transformModelToFieldMapping } from '.';
 import { handleHubspotDisunify, handlePipedriveDisunify, handleSfdcDisunify, handleZohoDisunify } from '..';
 import { postprocessDisUnifyObject } from './preprocess';
@@ -13,7 +13,7 @@ export async function disunifyObject<T extends Record<string, any>>({
     accountFieldMappingConfig,
 }: {
     obj: T;
-    tpId: TP_ID;
+    tpId: CRM_TP_ID;
     objType: StandardObjects;
     tenantSchemaMappingId?: string;
     accountFieldMappingConfig?: accountFieldMappingConfig;

diff --git a/packages/backend/helpers/crm/transform/preprocess.ts b/packages/backend/helpers/crm/transform/preprocess.ts
@@ -1,5 +1,5 @@
 import { TP_ID } from '@prisma/client';
-import { StandardObjects } from '../../../constants/common';
+import { CRM_TP_ID, StandardObjects } from '../../../constants/common';
 import { PipedriveDealStatus } from '../../../constants/pipedrive';
 
 export const preprocessUnifyObject = <T extends Record<string, any>>({
@@ -8,7 +8,7 @@ export const preprocessUnifyObject = <T extends Record<string, any>>({
     objType,
 }: {
     obj: T;
-    tpId: TP_ID;
+    tpId: CRM_TP_ID;
     objType: StandardObjects;
 }) => {
     const preprocessMap: any = {
@@ -39,10 +39,10 @@ export const postprocessDisUnifyObject = <T extends Record<string, any>>({
     objType,
 }: {
     obj: T;
-    tpId: TP_ID;
+    tpId: CRM_TP_ID;
     objType: StandardObjects;
 }) => {
-    const preprocessMap: Record<TP_ID, Record<any, Function>> = {
+    const preprocessMap: Record<CRM_TP_ID, Record<any, Function>> = {
         [TP_ID.pipedrive]: {
             [StandardObjects.event]: (obj: T) => {
                 return {
@@ -66,13 +66,13 @@ export const postprocessDisUnifyObject = <T extends Record<string, any>>({
             [StandardObjects.contact]: (obj: T) => {
                 return {
                     ...obj,
-                    name: `${obj.first_name} ${obj.last_name}`
+                    name: `${obj.first_name} ${obj.last_name}`,
                 };
             },
             [StandardObjects.lead]: (obj: T) => {
                 return {
                     ...obj,
-                    person: undefined
+                    person: undefined,
                 };
             },
         },

diff --git a/packages/backend/helpers/crm/transform/unify.ts b/packages/backend/helpers/crm/transform/unify.ts
@@ -1,5 +1,5 @@
-import { TP_ID, accountFieldMappingConfig } from '@prisma/client';
-import { StandardObjects } from '../../../constants/common';
+import { accountFieldMappingConfig } from '@prisma/client';
+import { CRM_TP_ID, StandardObjects } from '../../../constants/common';
 import { transformFieldMappingToModel } from '.';
 import { preprocessUnifyObject } from './preprocess';
 
@@ -11,7 +11,7 @@ export async function unifyObject<T extends Record<string, any>, K>({
     accountFieldMappingConfig,
 }: {
     obj: T;
-    tpId: TP_ID;
+    tpId: CRM_TP_ID;
     objType: StandardObjects;
     tenantSchemaMappingId?: string;
     accountFieldMappingConfig?: accountFieldMappingConfig;

diff --git a/packages/backend/index.ts b/packages/backend/index.ts
@@ -145,5 +145,6 @@ app.listen(config.PORT, () => {
     // TODO: do this optimistically.
     cron.schedule(`*/2 * * * *`, async () => {
         await AuthService.refreshOAuthTokensForThirdParty();
+        await AuthService.refreshOAuthTokensForThirdPartyChatServices();
     });
 }).setTimeout(600000);
diff --git a/packages/backend/models/unified/channel.ts b/packages/backend/models/unified/channel.ts
@@ -0,0 +1,24 @@
+export interface UnifiedChannel {
+    id: string;
+    name: string;
+    createdTimeStamp: string;
+    additional: any;
+}
+
+export function unifyChannel(channel: any) {
+    const unifiedChannel: UnifiedChannel = {
+        id: channel.id,
+        name: channel.name_normalized,
+        createdTimeStamp: new Date(channel.created * 1000).toISOString(),
+        additional: {},
+    };
+
+    // Map additional fields
+    Object.keys(channel).forEach((key) => {
+        if (!(key in unifiedChannel)) {
+            unifiedChannel['additional'][key] = channel[key];
+        }
+    });
+
+    return unifiedChannel;
+}
diff --git a/packages/backend/models/unified/chatUsers.ts b/packages/backend/models/unified/chatUsers.ts
@@ -0,0 +1,24 @@
+export interface UnifiedChatUser {
+    id: string;
+    name: string;
+    createdTimeStamp: string;
+    additional: any;
+}
+
+export function unifyChatUser(user: any): UnifiedChatUser {
+    const unifiedUser: UnifiedChatUser = {
+        id: user.id,
+        name: user.real_name,
+        createdTimeStamp: new Date(user.updated * 1000).toISOString(),
+        additional: {},
+    };
+
+    // Map additional fields
+    Object.keys(user).forEach((key) => {
+        if (!(key in unifiedUser)) {
+            unifiedUser['additional'][key] = user[key];
+        }
+    });
+
+    return unifiedUser;
+}