Merge pull request #83 from contentstack/feat/40525

feat: added support to uninstall app from multi or all locations

Author: abhinav-from-contentstack

.gitignore

@@ -17,4 +17,5 @@ dependabot.yml
 /bkp
 .editorconfig
 oclif.manifest.json
-*.env
+*.env
+.vscode/

.vscode/launch.json

@@ -155,12 +155,13 @@ Uninstall an app
 
 ```
 USAGE
-  $ csdx app:uninstall [--org <value>] [--app-uid <value>] [--installation-uid <value>]
+  $ csdx app:uninstall [--org <value>] [--app-uid <value>] [--installation-uid <value>] [--uninstall-all]
 
 FLAGS
   --app-uid=<value>           Provide the app UID
   --installation-uid=<value>  Provide the installation ID of the app that needs to be uninstalled.
   --org=<value>               Provide the organization UID
+  --uninstall-all             Please select stacks from where the app must be uninstalled.
 
 DESCRIPTION
   Uninstall an app

README.md

@@ -1,7 +1,8 @@
 import { BaseCommand } from "./base-command";
 import { flags } from "@contentstack/cli-utilities";
-import { getOrg, getApp, fetchApp, getInstallation, uninstallApp } from "../../util";
+import { getOrg, getApp, fetchApp } from "../../util";
 import { commonMsg, uninstallAppMsg } from "../../messages";
+import { UninstallAppFactory } from "../../factories/uninstall-app-factory";
 
 export default class Uninstall extends BaseCommand<typeof Uninstall> {
     static description = "Uninstall an app";
@@ -19,6 +20,9 @@ export default class Uninstall extends BaseCommand<typeof Uninstall> {
       }),
       'installation-uid': flags.string({
         description: uninstallAppMsg.INSTALLATION_UID
+      }),
+      'uninstall-all': flags.boolean({
+        description: uninstallAppMsg.UNINSTALL_ALL,
       })
     }
 
@@ -34,17 +38,14 @@ export default class Uninstall extends BaseCommand<typeof Uninstall> {
         } else {
           app = await fetchApp(this.flags, this.sharedConfig.org, {managementSdk: this.managementAppSdk, log: this.log})
         }
-        
+
         this.flags['app-uid'] = app?.uid;
         appType = app?.['target_type']
 
-        // select installation uid to uninstall
-        if (!this.flags['installation-uid']) {
-          this.flags['installation-uid'] = await getInstallation(this.flags, this.sharedConfig.org, this.managementSdk, appType, {managementSdk: this.managementAppSdk, log: this.log})
-        }
-        
-        // uninstall app
-        await uninstallApp(this.flags, this.sharedConfig.org, {managementSdk: this.managementAppSdk, log: this.log})
+        const factory = new UninstallAppFactory()
+        const strategy = factory.getStrategyInstance(this.flags['uninstall-all'])
+        await strategy.run(this.flags, this.sharedConfig.org, this.managementSdk, {managementSdk: this.managementAppSdk, log: this.log}, appType)
+
         this.log(this.$t(uninstallAppMsg.APP_UNINSTALLED, { app: app?.name || this.flags["app-uid"] }), "info")
 
       } catch (error: any) {

src/commands/app/uninstall.ts

@@ -0,0 +1,15 @@
+import { UninstallApp } from "../interfaces/uninstall-app";
+import { UninstallAll } from "../strategies/uninstall-all";
+import { UninstallSelected } from "../strategies/uninstall-selected";
+
+export class UninstallAppFactory {
+  public getStrategyInstance(uninstallAll: boolean): UninstallApp {
+    let strategy: UninstallApp;
+    if (uninstallAll) {
+      strategy = new UninstallAll()
+    } else {
+      strategy = new UninstallSelected()
+    }
+    return strategy
+  }
+}

src/factories/uninstall-app-factory.ts

@@ -0,0 +1,7 @@
+import { ContentstackClient, FlagInput } from "@contentstack/cli-utilities";
+import { CommonOptions } from "../util";
+import { AppTarget } from "@contentstack/management/types/app/index"
+
+export interface UninstallApp {
+  run(flags: FlagInput, org: string, managementSdk: ContentstackClient, options: CommonOptions, appType: AppTarget): Promise<void>;
+}

src/interfaces/uninstall-app.ts

@@ -95,7 +95,8 @@ const uninstallAppMsg = {
   INSTALLATION_UID: "Provide the installation ID of the app that needs to be uninstalled.",
   NO_INSTALLATIONS_FOUND: "Cannot find any installations for this app.",
   APP_UNINSTALLED: "{app} uninstalled successfully.",
-  UNINSTALLING_APP: "Uninstalling app from {type}..."
+  UNINSTALLING_APP: "Uninstalling app from {type}...",
+  UNINSTALL_ALL: "Please select stacks from where the app must be uninstalled.",
 }
 
 const messages: typeof errors &

src/messages/index.ts

@@ -0,0 +1,19 @@
+import { ContentstackClient, FlagInput } from "@contentstack/cli-utilities";
+import { UninstallApp } from "../interfaces/uninstall-app";
+import { CommonOptions, getInstallation, uninstallApp } from "../util";
+import { AppTarget } from "@contentstack/management/types/app/index"
+
+export class UninstallAll implements UninstallApp {
+  public async run(flags: FlagInput, org: string, managementSdk: ContentstackClient, options: CommonOptions, appType: AppTarget): Promise<void> {
+    // get all installation uids to uninstall
+    const installationUids = await this.getInstallations(flags, org, managementSdk, options, appType)
+    for (const installationUid of installationUids) {
+      await uninstallApp(flags, org, options, installationUid)
+    }
+  }
+
+  public async getInstallations(flags: FlagInput, org: string, managementSdk: ContentstackClient, options: CommonOptions, appType: AppTarget): Promise<string[]> {
+    let installationUids: string = await getInstallation(flags, org, managementSdk, appType, options, true)
+    return installationUids.split(',')
+  }
+}

src/strategies/uninstall-all.ts

@@ -0,0 +1,22 @@
+import { ContentstackClient, FlagInput } from "@contentstack/cli-utilities";
+import { UninstallApp } from "../interfaces/uninstall-app";
+import { CommonOptions, getInstallation, uninstallApp } from "../util";
+import { AppTarget } from "@contentstack/management/types/app/index"
+
+export class UninstallSelected implements UninstallApp {
+  public async run(flags: FlagInput, org: string, managementSdk: ContentstackClient, options: CommonOptions, appType: AppTarget): Promise<void> {
+    // select installation uid to uninstall
+    const installationUids = await this.getInstallations(flags, org, managementSdk, options, appType)
+    for (const installationUid of installationUids) {
+      await uninstallApp(flags, org, options, installationUid)
+    }
+  }
+
+  public async getInstallations(flags: FlagInput, org: string, managementSdk: ContentstackClient, options: CommonOptions, appType: AppTarget): Promise<string[]> {
+    let installationUids: any = flags['installation-uid'];
+    if (!installationUids) {
+      installationUids = await getInstallation(flags, org, managementSdk, appType, options)
+    }
+    return installationUids.split(',')
+  }
+}

src/strategies/uninstall-selected.ts

@@ -169,10 +169,9 @@ async function getStacks(
   return stacks;
 }
 
-function uninstallApp(flags: FlagInput, orgUid: string, options: CommonOptions) {
+function uninstallApp(flags: FlagInput, orgUid: string, options: CommonOptions, installationUid: string) {
   const {managementSdk} = options;
   const app: unknown = flags['app-uid'];
-  const installationUid: unknown = flags['installation-uid'];
   return managementSdk
   .organization(orgUid)
   .app(app as string)