Merge pull request #557 from manish-singh-bisht/gh

feat: Github issues support
revertinc · Jul 31, 2024 · 8bcad8e · 8bcad8e
2 parents d4cdc8c + a0c0855
commit 8bcad8e
Show file tree

Hide file tree

Showing 22 changed files with 711 additions and 21 deletions.
diff --git a/fern/docs.yml b/fern/docs.yml
@@ -84,6 +84,8 @@ navigation:
                   path: ./docs/contents/guides/trello.mdx
                 - page: BitBucket
                   path: ./docs/contents/guides/bitbucket.mdx
+                - page: GitHub
+                  path: ./docs/contents/guides/github.mdx
 colors:
     accentPrimary: '#89a3ff'
 logo:

diff --git a/fern/docs/contents/guides/github.mdx b/fern/docs/contents/guides/github.mdx
@@ -0,0 +1,19 @@
+<img src="https://res.cloudinary.com/dwoiwg0t5/image/upload/f_auto,q_auto/lmmkmmgaoatdbzhgbymy" />
+
+#### Obtaining GitHub Client ID and Secret
+
+-   Open a [GitHub account](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home).
+-   Create a GitHub OAuth app, using the steps mentioned [here](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)
+    -   `NOTE:` You can skip this step and use the default revert GitHub app
+-   Set `https://app.revert.dev/oauth-callback/github` as the `redirect` url for your app
+-   **Get your client_id and client_secret**:
+    -   Copy your client_id and client_secret after you created the oauth app.
+
+#### Connect to GitHub via Revert
+
+-   Create an account on Revert if you don't already have one. (https://app.revert.dev/sign-up)
+-   Login to your revert dashboard (https://app.revert.dev/sign-in) and click on `Customize your apps` - `GitHub`
+
+<img src="https://res.cloudinary.com/dfcnic8wq/image/upload/v1705652583/Revert/Docs/nwlrrom2sw5xj7dsgznv.png" />
+
+-   Enter the `client_id` and `client_secret` you copied in the previous step into the App credentials here and click `Submit`.
diff --git a/packages/backend/.env.example b/packages/backend/.env.example
@@ -45,4 +45,6 @@ OPEN_INT_API_KEY=
 TWENTY_ACCOUNT_ID=
 BITBUCKET_CLIENT_ID= 
 BITBUCKET_CLIENT_SECRET=
-DEFAULT_RATE_LIMIT_DEVELOPER_PLAN=
+GITHUB_CLIENT_ID= 
+GITHUB_CLIENT_SECRET=
+DEFAULT_RATE_LIMIT_DEVELOPER_PLAN=
diff --git a/packages/backend/config.ts b/packages/backend/config.ts
@@ -52,6 +52,10 @@ const config = {
     OPEN_INT_API_KEY: process.env.OPEN_INT_API_KEY,
     OPEN_INT_BASE_API_URL: process.env.OPEN_INT_BASE_API_URL,
     TWENTY_ACCOUNT_ID: process.env.TWENTY_ACCOUNT_ID,
+
+    GITHUB_CLIENT_ID: process.env.GITHUB_CLIENT_ID!,
+    GITHUB_CLIENT_SECRET: process.env.GITHUB_CLIENT_SECRET!,
+
     DEFAULT_RATE_LIMIT_DEVELOPER_PLAN: process.env.DEFAULT_RATE_LIMIT_DEVELOPER_PLAN,
 };
 

diff --git a/packages/backend/constants/common.ts b/packages/backend/constants/common.ts
@@ -3,7 +3,7 @@ import { Request, Response } from 'express';
 
 export type CRM_TP_ID = 'zohocrm' | 'sfdc' | 'pipedrive' | 'hubspot' | 'closecrm' | 'ms_dynamics_365_sales';
 export type CHAT_TP_ID = 'slack' | 'discord';
-export type TICKET_TP_ID = 'linear' | 'clickup' | 'asana' | 'jira' | 'trello' | 'bitbucket';
+export type TICKET_TP_ID = 'linear' | 'clickup' | 'asana' | 'jira' | 'trello' | 'bitbucket' | 'github';
 
 export const DEFAULT_SCOPE = {
     [TP_ID.hubspot]: [
@@ -49,6 +49,15 @@ export const DEFAULT_SCOPE = {
     [TP_ID.jira]: ['read:jira-work', 'read:jira-user', 'write:jira-work', 'offline_access'],
     [TP_ID.ms_dynamics_365_sales]: ['offline_access', 'User.Read'],
     [TP_ID.bitbucket]: ['issue', 'issue:write', 'repository', 'account'],
+    [TP_ID.github]: [
+        'repo',
+        'issues:write',
+        'pull_requests:write',
+        'issues:read',
+        'pull_requests:read',
+        'metadata:read',
+        'repository_projects:read',
+    ],
 };
 
 export const mapIntegrationIdToIntegrationName = {
@@ -66,6 +75,7 @@ export const mapIntegrationIdToIntegrationName = {
     [TP_ID.jira]: 'Jira',
     [TP_ID.ms_dynamics_365_sales]: 'Microsoft Dynamics 365 Sales',
     [TP_ID.bitbucket]: 'Bitbucket',
+    [TP_ID.github]: 'GitHub',
 };
 
 export const rootSchemaMappingId = 'revertRootSchemaMapping';

diff --git a/packages/backend/helpers/crm/transform/disunify.ts b/packages/backend/helpers/crm/transform/disunify.ts
@@ -267,5 +267,18 @@ export async function disunifyTicketObject<T extends Record<string, any>>({
             }
             return processedObj;
         }
+        case TP_ID.github: {
+            if (objType === 'ticketTask') {
+                return {
+                    ...transformedObj,
+                    assignees:
+                        obj.assignees && Array.isArray(obj.assignees) && obj.assignees.length > 0
+                            ? obj.assignees
+                            : undefined,
+                };
+            }
+
+            return processedObj;
+        }
     }
 }
diff --git a/packages/backend/helpers/crm/transform/preprocess.ts b/packages/backend/helpers/crm/transform/preprocess.ts
@@ -427,6 +427,7 @@ export const postprocessDisUnifyTicketObject = <T extends Record<string, any>>({
         [TP_ID.trello]: {},
         [TP_ID.asana]: {},
         [TP_ID.bitbucket]: {},
+        [TP_ID.github]: {},
     };
     const transformFn = (preprocessMap[tpId] || {})[objType];
     return transformFn ? transformFn(obj) : obj;

diff --git a/packages/backend/prisma/fields.ts b/packages/backend/prisma/fields.ts
@@ -931,6 +931,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'id',
                 [TP_ID.trello]: 'id',
                 [TP_ID.bitbucket]: 'id',
+                [TP_ID.github]: 'id',
             },
             target_field_name: 'id',
         },
@@ -941,6 +942,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'id',
                 [TP_ID.trello]: 'id',
                 [TP_ID.bitbucket]: 'id',
+                [TP_ID.github]: 'id',
             },
             target_field_name: 'remoteId',
         },
@@ -951,6 +953,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'summary',
                 [TP_ID.trello]: 'name',
                 [TP_ID.bitbucket]: 'title',
+                [TP_ID.github]: 'title',
             },
             target_field_name: 'name',
         },
@@ -961,6 +964,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'assignee',
                 [TP_ID.trello]: 'idMembers',
                 [TP_ID.bitbucket]: 'assignee',
+                [TP_ID.github]: 'assignees',
             },
             target_field_name: 'assignees',
         },
@@ -971,6 +975,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'description',
                 [TP_ID.trello]: 'desc',
                 [TP_ID.bitbucket]: 'content.raw',
+                [TP_ID.github]: 'body',
             },
             target_field_name: 'description',
         },
@@ -981,6 +986,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'status.name',
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: 'state',
+                [TP_ID.github]: 'state',
             },
             target_field_name: 'status',
         },
@@ -991,6 +997,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'priority.name',
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: 'priority',
+                [TP_ID.github]: undefined,
             },
             target_field_name: 'priority',
         },
@@ -1001,6 +1008,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'creator.accountId',
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: 'reporter.account_id',
+                [TP_ID.github]: 'user.id',
             },
             target_field_name: 'creatorId',
         },
@@ -1011,6 +1019,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'created',
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: 'created_on',
+                [TP_ID.github]: 'created_at',
             },
             target_field_name: 'createdTimeStamp',
         },
@@ -1021,6 +1030,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'updated',
                 [TP_ID.trello]: 'dateLastActivity',
                 [TP_ID.bitbucket]: 'updated_on',
+                [TP_ID.github]: 'updated_at',
             },
             target_field_name: 'updatedTimeStamp',
         },
@@ -1031,6 +1041,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'duedate',
                 [TP_ID.trello]: 'due',
                 [TP_ID.bitbucket]: undefined,
+                [TP_ID.github]: undefined,
             },
             target_field_name: 'dueDate',
         },
@@ -1041,6 +1052,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: undefined,
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: undefined,
+                [TP_ID.github]: 'closed_at',
             },
             target_field_name: 'completedDate',
         },
@@ -1051,6 +1063,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'parent.id',
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: undefined,
+                [TP_ID.github]: undefined,
             },
             target_field_name: 'parentId',
         },
@@ -1076,6 +1089,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'accountId',
                 [TP_ID.trello]: 'id',
                 [TP_ID.bitbucket]: 'account_id',
+                [TP_ID.github]: 'id',
             },
             target_field_name: 'id',
         },
@@ -1086,6 +1100,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'accountId',
                 [TP_ID.trello]: 'id',
                 [TP_ID.bitbucket]: 'account_id',
+                [TP_ID.github]: 'id',
             },
             target_field_name: 'remoteId',
         },
@@ -1096,6 +1111,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'emailAddress',
                 [TP_ID.trello]: 'email',
                 [TP_ID.bitbucket]: undefined,
+                [TP_ID.github]: 'email',
             },
             target_field_name: 'email',
         },
@@ -1106,6 +1122,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'displayName',
                 [TP_ID.trello]: 'fullName',
                 [TP_ID.bitbucket]: 'display_name',
+                [TP_ID.github]: 'name',
             },
             target_field_name: 'name',
         },
@@ -1116,6 +1133,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'active',
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: 'account_status',
+                [TP_ID.github]: undefined,
             },
             target_field_name: 'isActive',
         },
@@ -1126,6 +1144,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'avatarUrls."48x48"',
                 [TP_ID.trello]: 'avatarUrl',
                 [TP_ID.bitbucket]: 'links.avatar',
+                [TP_ID.github]: 'avatar_url',
             },
             target_field_name: 'avatar',
         },
@@ -1136,6 +1155,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: undefined,
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: 'created_on',
+                [TP_ID.github]: 'created_at',
             },
             target_field_name: 'createdTimeStamp',
         },
@@ -1146,6 +1166,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: undefined,
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: undefined,
+                [TP_ID.github]: 'updated_at',
             },
             target_field_name: 'updatedTimeStamp',
         },
@@ -1156,6 +1177,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: undefined,
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: 'is_staff',
+                [TP_ID.github]: 'site_admin',
             },
             target_field_name: 'isAdmin',
         },
@@ -1168,6 +1190,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'id',
                 [TP_ID.trello]: 'id',
                 [TP_ID.bitbucket]: 'id',
+                [TP_ID.github]: 'id',
             },
             target_field_name: 'id',
         },
@@ -1178,6 +1201,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'id',
                 [TP_ID.trello]: 'id',
                 [TP_ID.bitbucket]: 'id',
+                [TP_ID.github]: 'id',
             },
             target_field_name: 'remoteId',
         },
@@ -1188,6 +1212,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'body',
                 [TP_ID.trello]: 'data.text',
                 [TP_ID.bitbucket]: 'content.raw',
+                [TP_ID.github]: 'body',
             },
             target_field_name: 'body',
         },
@@ -1198,6 +1223,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'author.accountId',
                 [TP_ID.trello]: 'idMemberCreator',
                 [TP_ID.bitbucket]: 'user.account_id',
+                [TP_ID.github]: 'user.id',
             },
             target_field_name: 'createdBy',
         },
@@ -1208,6 +1234,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'created',
                 [TP_ID.trello]: 'date',
                 [TP_ID.bitbucket]: 'created_on',
+                [TP_ID.github]: 'created_at',
             },
             target_field_name: 'createdTimestamp',
         },
@@ -1218,6 +1245,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: 'updated',
                 [TP_ID.trello]: 'data.dateLastEdited',
                 [TP_ID.bitbucket]: 'updated_on',
+                [TP_ID.github]: 'updated_at',
             },
             target_field_name: 'updatedTimeStamp',
         },
@@ -1228,6 +1256,7 @@ export const ticketingFields = {
                 [TP_ID.jira]: undefined,
                 [TP_ID.trello]: undefined,
                 [TP_ID.bitbucket]: undefined,
+                [TP_ID.github]: undefined,
             },
             target_field_name: 'parentId',
         },

diff --git a/packages/backend/prisma/migrations/20240506085720_github/migration.sql b/packages/backend/prisma/migrations/20240506085720_github/migration.sql
@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "TP_ID" ADD VALUE 'github';
diff --git a/packages/backend/prisma/schema.prisma b/packages/backend/prisma/schema.prisma
@@ -22,6 +22,7 @@ enum TP_ID {
   trello
   jira
   bitbucket
+  github
 }
 
 enum ENV {

diff --git a/packages/backend/prisma/seed.ts b/packages/backend/prisma/seed.ts
@@ -158,7 +158,8 @@ async function main() {
                     tpId === 'clickup' ||
                     tpId === 'jira' ||
                     tpId === 'trello' ||
-                    tpId === 'bitbucket'
+                    tpId === 'bitbucket' ||
+                    tpId === 'github'
                 )
             )
                 return;

diff --git a/packages/backend/routes/v1/ticket/auth.ts b/packages/backend/routes/v1/ticket/auth.ts
@@ -11,6 +11,7 @@ import clickup from './authHandlers/clickup';
 import trello from './authHandlers/trello';
 import bitbucket from './authHandlers/bitbucket';
 import jira from './authHandlers/jira';
+import github from './authHandlers/github';
 
 const authRouter = express.Router();
 
@@ -71,6 +72,8 @@ authRouter.get('/oauth-callback', async (req, res) => {
                     return jira.handleOAuth(authProps);
                 case TP_ID.bitbucket:
                     return bitbucket.handleOAuth(authProps);
+                case TP_ID.github:
+                    return github.handleOAuth(authProps);
 
                 default:
                     return processOAuthResult({