feat: add deletion command to remove 1 or all resources

GAndanje · GAndanje · commit bd9d2dd03866 · 2024-10-23T02:22:55.000+03:00
diff --git a/.suite-cli/cli/cli.js b/.suite-cli/cli/cli.js
@@ -8,11 +8,11 @@ const { cwd } = require('node:process');
 const { readFileSync } = require('node:fs');
 const path = require('node:path');
 const actionHandlers = require('./scripts')
-const { logInfo, getExistingComponent, getExistingApps, getNextAvailablePort, scaffoldApp, scaffoldGateways,readFileContent } = require('./scripts/scripts.module');
+const { logInfo, getExistingComponent, getExistingApps, getNextAvailablePort, scaffoldApp, scaffoldGateways, readFileContent } = require('./scripts/scripts.module');
 
 const program = new Command();
 const packageJsonPath = path.join(__dirname, 'package.json');
-const packageJSON = JSON.parse(readFileSync(packageJsonPath,{'encoding':'utf8'}));
+const packageJSON = JSON.parse(readFileSync(packageJsonPath, { 'encoding': 'utf8' }));
 program.version(packageJSON.version); //get library version set by release script
 const prompt = createPromptModule();
 program
@@ -131,9 +131,9 @@ program
       .then(answers => {
         let existing_services = []
         try {
-           existing_services = getExistingComponent({ key: 'services', currentDir: cwd() })
+          existing_services = getExistingComponent({ key: 'services', currentDir: cwd() })
         } catch (error) {
-          
+
         }
         switch (answers.resource) {
           case 'monorepo':
@@ -242,7 +242,7 @@ program
             ]).then((answers) => actionHandlers.scaffoldNewLibrary({ answers: { ...answers, private: false } }))
             break
           case 'app':
-            const existing_apps = getExistingComponent({ key: 'apps', currentDir: cwd() })||[]
+            const existing_apps = getExistingComponent({ key: 'apps', currentDir: cwd() }) || []
             const formatServiceName = (service) => `${service.name}: ${service.port}`;
             prompt([
               {
@@ -306,7 +306,7 @@ program
             break;
           case 'gateway':
             const apps = getExistingApps({ currentDir: cwd() });
-            if(!apps) {
+            if (!apps) {
               logInfo({ message: `No apps found in this project. You need to have atleast one app to generate a gateway` })
               ora().info(`Run 'suite generate' to create one...`)
               process.exit(0);
@@ -362,16 +362,45 @@ program
       });
   });
   program
-  .command('remove')
-  .description('Clean remove a monorepo resource plus all the associated files. No residual files remain behind')
-  .option('service', 'remove service and associated files')
-  .option('app', 'remove app and associated files')
-  .option('library', 'remove library and associated files')
-  .option('microservice', 'remove microservice and associated files')
-  .option('gateway', 'remove gateway and associated files')
-  .action(async (options) => {
-    console.log({options})
-     await actionHandlers.dockerPrune({ options }) 
-    });
+  .command('remove <resource> [resource_name]')
+  .description('Clean remove a monorepo resource or all resources of a specific type with the --all flag.')
+  .option('-f, --force', 'Force removal without confirmation')
+  .option('--all', 'Remove all resources of the specified type')  // Add --all flag
+  .action(async (resource, resource_name, options) => {
+    const spinner = ora();
+
+    // Validate --all flag usage
+    if (!resource_name && !options.all) {
+      spinner.fail('You must provide either a resource name or the --all flag to remove all resources.');
+      return;
+    }
+
+    try {
+      // Confirm the deletion if --force is not provided
+      if (!options.force) {
+        const { confirmRemoval } = await prompt([
+          {
+            type: 'confirm',
+            name: 'confirmRemoval',
+            message: `Are you sure you want to remove ${options.all ? `all ${resource}s` : `${resource} "${resource_name}"`} ?`,
+            default: false
+          }
+        ]);
+
+        if (!confirmRemoval) {
+          spinner.info('Operation cancelled.');
+          return;
+        }
+      }
+
+      // Call the resource removal handler
+      await actionHandlers.removeResource({ answers: { resource, resource_name, options } });
+
+    } catch (error) {
+      spinner.fail(`Failed to remove ${resource} ${resource_name || 'resources'}: ${error.message}`);
+    }
+  });
+
+
 program.parse(process.argv);
 module.exports = program
diff --git a/.suite-cli/cli/scripts/commands/removeResource.cmd.js b/.suite-cli/cli/scripts/commands/removeResource.cmd.js
@@ -0,0 +1,10 @@
+
+const { removeResource, logError } = require('../scripts.module')
+
+module.exports = async ({ answers }) => {
+    try {
+        await removeResource({ answers });
+    } catch (error) {
+        logError({ error })
+    }
+}
diff --git a/.suite-cli/cli/scripts/index.js b/.suite-cli/cli/scripts/index.js
@@ -23,3 +23,4 @@ module.exports.releasePackage = require('./commands/releasePackage.cmd');
 module.exports.scaffoldNewService = require('./commands/scaffoldNewService.cmd');
 module.exports.scaffoldNewLibrary = require('./commands/scaffoldNewLibrary.cmd');
 module.exports.test = require('./commands/test.cmd');
+module.exports.removeResource = require('./commands/removeResource.cmd');
diff --git a/.suite-cli/cli/scripts/scripts.module.js b/.suite-cli/cli/scripts/scripts.module.js
@@ -1,9 +1,11 @@
 const chalk = require('chalk')
 const { join, sep, resolve } = require('node:path')
+const fs = require('fs');
+const path = require('node:path');
 const os = require('os')
 const { mkdirSync, readFile } = require('fs')
 const { cwd, chdir, exit, platform } = require('node:process')
-const { existsSync, statSync, readdirSync, writeFileSync, readFileSync, rmSync } = require('node:fs');
+const { existsSync, statSync, readdirSync, writeFileSync, readFileSync, rmSync, rm } = require('node:fs');
 let { exec, spawn } = require('node:child_process');
 const { writeFile } = require('node:fs/promises');
 const assets = require('./assets')
@@ -1643,7 +1645,7 @@ const scaffoldGateways = async ({ answers }) => {
     const { projectName } = readFileContent({ currentDir: cwd() });
     let { apps } = answers;
     const project_root = generatRootPath({ currentDir: cwd() });
-    const service_objects = getExistingComponent({ key:'services', currentDir: cwd() });
+    const service_objects = getExistingComponent({ key: 'services', currentDir: cwd() });
     // add port to services in each app eg ['auth']=>[{name:'auth',port:9001}]
     apps = apps.map((app) => {
         app.services.map((name, i) => {
@@ -1705,6 +1707,244 @@ const scaffoldGateway = ({ project_root, app, answers, webserver, projectName })
 
 }
 
+/**
+ * Removes a microservice and all associated files.
+ * @param {Object} options - Options for removing the microservice.
+ * @param {string} options.project_root - The root directory of the project.
+ * @param {string} options.service_name - The name of the microservice to be removed.
+ * @param {boolean} [options.sync] - If true, use synchronous file removal.
+ */
+const removeResource = async ({ answers }) => {
+    const { resource, resource_name, options } = answers;
+    let project_root;
+
+    try {
+        project_root = generatRootPath({ currentDir: cwd() });
+    } catch (error) {
+        // Not within a suite repo
+        if (error.message && error.message === 'suite.json and(or) .git not found') {
+            ora('This does not look like a suite repo').warn()
+            ora().info('If it is run <suite init> from project root to reinitialize suite project and try again')
+            exit(1)
+        }
+        else {
+            // rethrow the error
+            throw new Error('Error code 10005.Kindly raise an issue at https://github.com/microservices-suite/node-microservices-suite/issues')
+        }
+    }
+    const spinner = ora();
+    if (options.all) {
+        // Logic to remove all resources of the given type
+        
+        const resourceEnum = {
+            library: ['shared'],
+            app: ['gateways', 'apps'],
+            service: ['microservices'],
+            gateway: ['gateways', 'apps']
+        }
+        if(!resourceEnum[resource]) return ora().warn(`Unkown resource name ${resource}`)
+        const allResourceChildrenPath = path.join(project_root, ...(resourceEnum[resource]));
+        if (!fs.existsSync(allResourceChildrenPath)) {
+            spinner.warn(`No ${resource}(s) found.`);
+            return;
+        }
+
+        // Remove all resources
+        const services = fs.readdirSync(allResourceChildrenPath);
+        if (services.length === 0) {
+            spinner.warn(`No ${resource}(s) found.`);
+            return;
+        }
+
+        // Synchronous removal of all services
+        services.forEach(service => {
+            const fullPath = path.join(allResourceChildrenPath, service);
+            fs.rmSync(fullPath, { recursive: true, force: true });
+        });
+        spinner.succeed(`All ${resource}(s) have been removed.`);
+
+        return;
+    }
+
+    // Call the appropriate action handler based on the resource type
+    switch (resource) {
+        case 'service':
+            await removeService({ service_name: resource_name, project_root, sync: true });
+            break;
+        case 'app':
+            await removeApp({ app_name: resource_name, project_root, sync: true });
+            break;
+        case 'library':
+            await removeLibrary({ library_name: resource_name, project_root, sync: true });
+            break;
+        case 'gateway':
+            await removeGateway({ gateway_name: resource_name, project_root, sync: true });
+            break;
+        default:
+            throw new Error(`Unknown resource type: ${resource}`);
+    }
+
+};
+/**
+ * Removes a microservice and all associated files.
+ * @param {Object} options - Options for removing the microservice.
+ * @param {string} options.project_root - The root directory of the project.
+ * @param {string} options.service_name - The name of the microservice to be removed.
+ * @param {boolean} [options.sync] - If true, use synchronous file removal.
+ * @param {boolean} [options.all] - If true, remove all services of the specified type.
+ */
+const removeService = async ({ service_name, project_root, sync }) => {
+    const servicePath = path.join(project_root, 'microservices', service_name);
+    const spinner = ora(`Removing microservice "${service_name}"...`).start();
+
+    try {
+        // Check if the specific service exists
+        if (!fs.existsSync(servicePath)) {
+            spinner.warn(`Microservice "${service_name}" not found.`);
+            return;
+        }
+
+        if (sync) {
+            // Synchronous removal of the specific service
+            fs.rmSync(servicePath, { recursive: true, force: true });
+            spinner.succeed(`Microservice "${service_name}" and all associated files have been removed.`);
+        } else {
+            // Asynchronous removal of the specific service
+            fs.rm(servicePath, { recursive: true, force: true }, (err) => {
+                if (err) throw err;
+                spinner.succeed(`Microservice "${service_name}" and all associated files have been removed.`);
+            });
+        }
+    } catch (error) {
+        spinner.fail(`Error while removing microservice "${service_name}": ${error.message}`);
+    }
+};
+
+
+/**
+ * Removes a microservice and all associated files.
+ * @param {Object} options - Options for removing the microservice.
+ * @param {string} options.project_root - The root directory of the project.
+ * @param {string} options.app_name - The name of the microapp to be removed.
+ * @param {boolean} [options.sync] - If true, use synchronous file removal.
+ */
+/**
+ * Removes an app from both Docker and Kubernetes directories.
+ * @param {Object} options - Options for removing the app.
+ * @param {string} options.app_name - The name of the app to be removed.
+ * @param {string} options.project_root - The root directory of the project.
+ * @param {boolean} [options.sync] - If true, use synchronous file removal.
+ */
+const removeApp = async ({ app_name, project_root, sync = true }) => {
+    const appDockerPath = path.join(project_root, 'gateways', 'apps', app_name);
+    const appKubePath = path.join(project_root, 'k8s', app_name);
+
+    // Check if the app exists in either Docker or Kubernetes directories
+    const dockerExists = existsSync(appDockerPath);
+    const kubeExists = existsSync(appKubePath);
+
+    if (!dockerExists && !kubeExists) {
+        ora().warn(`App "${app_name}" not found in Docker or Kubernetes.`);
+        return;
+    }
+
+    try {
+        if (sync) {
+            // Use synchronous removal
+            if (dockerExists) {
+                rmSync(appDockerPath, { recursive: true, force: true });
+                ora().info(`Docker files for app "${app_name}" have been removed.`);
+            }
+
+            if (kubeExists) {
+                rmSync(appKubePath, { recursive: true, force: true });
+                ora().info(`Kubernetes files for app "${app_name}" have been removed.`);
+            }
+        } else {
+            // Use asynchronous removal
+            if (dockerExists) {
+                rm(appDockerPath, { recursive: true, force: true }, (err) => {
+                    if (err) throw err;
+                    ora().info(`Docker files for app "${app_name}" have been removed.`);
+                });
+            }
+
+            if (kubeExists) {
+                rm(appKubePath, { recursive: true, force: true }, (err) => {
+                    if (err) throw err;
+                    ora().info(`Kubernetes files for app "${app_name}" have been removed.`);
+                });
+            }
+        }
+
+        ora().succeed(`App "${app_name}" removed successfully.`);
+    } catch (error) {
+        ora().fail(`Error while removing app "${app_name}": ${error.message}`);
+    }
+};
+
+/**
+ * Removes a microservice and all associated files.
+ * @param {Object} options - Options for removing the microservice.
+ * @param {string} options.project_root - The root directory of the project.
+ * @param {string} options.library_name - The name of the microlibrary to be removed.
+ * @param {boolean} [options.sync] - If true, use synchronous file removal.
+ */
+const removeLibrary = async ({ library_name, project_root, sync }) => {
+    const libraryPath = path.join(project_root, 'shared', library_name);
+    // Check if the microservice directory exists
+    if (!existsSync(libraryPath)) {
+        ora().warn(`Library "${library_name}" not found.`);
+        return;
+    }
+    try {
+        if (sync) {
+            // Use synchronous removal
+            rmSync(libraryPath, { recursive: true, force: true });
+            ora().info(`Library "${library_name}" and all associated files have been removed.`);
+        } else {
+            // Use asynchronous removal
+            rm(libraryPath, { recursive: true, force: true }, (err) => {
+                if (err) throw err;
+                ora().info(`Library "${library_name}" and all associated files have been removed.`);
+            });
+        }
+        ora().succeed(`Library "${library_name}" removed successfully.`);
+    } catch (error) {
+        ora().fail(`Error while removing Library "${library_name}":`, error.message);
+    }
+};
+
+/**
+ * Removes a microservice and all associated files.
+ * @param {Object} options - Options for removing the microservice.
+ * @param {string} options.project_root - The root directory of the project.
+ * @param {string} options.gateway - The name of the microgateway to be removed.
+ * @param {boolean} [options.sync] - If true, use synchronous file removal.
+ */
+const removeGateway = async ({ gateway, project_root, sync }) => {
+    const gatewayPath = path.join(project_root, 'apps', gateway);
+    if (!existsSync(gatewayPath)) {
+        ora().warn(`Gateway "${gateway}" not found.`);
+        return;
+    }
+    try {
+        if (sync) {
+            // Use synchronous removal
+            rmSync(gatewayPath, { recursive: true, force: true });
+            ora().info(`Gateway "${gateway}" and all associated files have been removed.`);
+        } else {
+            // Use asynchronous removal
+            rm(gatewayPath, { recursive: true, force: true }, (err) => {
+                if (err) throw err;
+                ora().info(`Gateway "${gateway}" and all associated files have been removed.`);
+            });
+        }
+        ora().succeed(`Gateway "${gateway}" removed successfully.`);
+    } catch (error) {
+        ora().fail(`Error while removing Gateway "${gateway}":`, error.message);
+    }
+};
 module.exports = {
     generateDirectoryPath,
     changeDirectory,
@@ -1737,5 +1977,8 @@ module.exports = {
     scaffoldApp,
     scaffoldGateways,
     getExistingApps,
-    readFileContent
+    readFileContent,
+    removeResource,
+    removeService,
+    removeApp
 }
