Add support for deletion of an installation (InstallationStore / MemoryInstallationStore)

examples/oauth-v2/app.js

@@ -53,6 +53,19 @@ const installer = new InstallProvider({
       }
       throw new Error('Failed fetching installation');
     },
+    deleteInstallation: async (installQuery) => {
+      if (installQuery.isEnterpriseInstall) {
+        if (installQuery.enterpriseId !== undefined) {       
+          // delete org installation
+          return await keyv.delete(installQuery.enterpriseId)
+        }
+      }
+      if (installQuery.teamId !== undefined) {
+        // delete single team installation
+        return await keyv.delete(installQuery.teamId);
+      }
+      throw new Error('Failed to delete installation');
+    },
   },
 });
 

packages/oauth/README.md

@@ -184,16 +184,31 @@ const installer = new InstallProvider({
     // returns installation object from database
     fetchInstallation: async (installQuery) => {
       // replace myDB.get with your own database or OEM getter
-      if (query.isEnterpriseInstall && query.enterpriseId !== undefined) {
+      if (installQuery.isEnterpriseInstall && installQuery.enterpriseId !== undefined) {
         // org wide app installation lookup
         return await myDB.get(installQuery.enterpriseId);
       }
-      if (query.teamId !== undefined) {
+      if (installQuery.teamId !== undefined) {
         // single team app installation lookup
         return await myDB.get(installQuery.teamId);
       }
       throw new Error('Failed fetching installation');
     },
+    // takes in an installQuery as an argument
+    // installQuery = {teamId: 'string', enterpriseId: 'string', userId: 'string', conversationId: 'string', isEnterpriseInstall: boolean};
+    // returns nothing
+    deleteInstallation: async (installQuery) => {
+      // replace myDB.get with your own database or OEM getter
+      if (query.isEnterpriseInstall && query.enterpriseId !== undefined) {
+        // org wide app installation deletion
+        return await myDB.delete(installQuery.enterpriseId);
+      }
+      if (query.teamId !== undefined) {
+        // single team app installation deletion
+        return await myDB.delete(installQuery.teamId);
+      }
+      throw new Error('Failed to delete installation');
+    },
   },
 });
 ```

packages/oauth/src/index.spec.js

@@ -74,6 +74,13 @@ const installationStore = {
     return new Promise((resolve) => {
         resolve(item);
     });
+  },
+  deleteInstallation: (installQuery) => {
+    // db delete
+    delete devDB[installQuery.teamId];
+    return new Promise((resolve) => {
+        resolve();
+    });
   }
 }
 
@@ -450,7 +457,7 @@ describe('OAuth', async () => {
     });
   });
 
-  describe('MemoryInstallStore', async () => {
+  describe('MemoryInstallationStore', async () => {
     it('should store and fetch an installation', async () => {
       const installer = new InstallProvider({clientId, clientSecret, stateSecret});
       const fakeTeamId = storedInstallation.team.id;
@@ -460,6 +467,17 @@ describe('OAuth', async () => {
       assert.deepEqual(fetchedResult, storedInstallation);
       assert.deepEqual(storedInstallation, installer.installationStore.devDB[fakeTeamId]);
     });
+
+    it('should delete a stored installation', async () => {
+      const installer = new InstallProvider({clientId, clientSecret, stateSecret});
+      const fakeTeamId = storedInstallation.team.id;
+
+      await installer.installationStore.storeInstallation(storedInstallation);
+      assert.isNotEmpty(installer.installationStore.devDB);
+
+      await installer.installationStore.deleteInstallation({ teamId:fakeTeamId }); 
+      assert.isEmpty(installer.installationStore.devDB);
+    });
   });
 
   describe('ClearStateStore', async () => {

packages/oauth/src/index.ts

@@ -456,9 +456,12 @@ export interface InstallationStore {
     logger?: Logger): Promise<void>;
   fetchInstallation:
     (query: InstallationQuery<boolean>, logger?: Logger) => Promise<Installation<'v1' | 'v2', boolean>>;
+  deleteInstallation:
+    (query: InstallationQuery<boolean>, logger?: Logger) => Promise<void>;
 }
 
 // using a javascript object as a makeshift database for development
+// storing user tokens is not supported
 interface DevDatabase {
   [teamIdOrEnterpriseId: string]: Installation;
 }
@@ -513,6 +516,32 @@ class MemoryInstallationStore implements InstallationStore {
     }
     throw new Error('Failed fetching installation');
   }
+
+  public async deleteInstallation(query: InstallationQuery<boolean>, logger?: Logger): Promise<void> {
+    if (logger !== undefined) {
+      logger.warn('Deleting Access Token from DB. Please use a real Installation Store for production!');
+    }
+
+    if (query.isEnterpriseInstall && query.enterpriseId !== undefined) {
+      if (logger !== undefined) {
+        logger.debug('deleting org installation');
+      }
+
+      const { [query.enterpriseId]: _, ...devDB } = this.devDB;
+      this.devDB = devDB;
+
+    } else if (query.teamId !== undefined) {
+      if (logger !== undefined) {
+        logger.debug('deleting single team installation');
+      }
+
+      const { [query.teamId]: _, ...devDB } = this.devDB;
+      this.devDB = devDB;
+
+    } else {
+      throw new Error('Failed to delete installation');
+    }
+  }
 }
 
 /**