Merge pull request #128 from microservices-suite/repo-engineering/universal-cli

GAndanje · web-flow · commit 845481406438 · 2024-05-23T21:58:23.000+03:00
Repo engineering/universal cli
diff --git a/.suite-cli/cli/cli.js b/.suite-cli/cli/cli.js
@@ -5,7 +5,8 @@ const { Command } = require('commander');
 const { createPromptModule } = require('inquirer');
 const { execSync } = require('node:child_process')
 const actionHandlers = require('./scripts')
-const { logInfo } = require('./scripts/scripts.module');
+const { logInfo, getExistingServices, getNextAvailablePort } = require('./scripts/scripts.module');
+const { cwd } = require('node:process');
 const program = new Command()
 const prompt = createPromptModule()
 program
@@ -155,6 +156,12 @@ program
                 name: 'service_name',
                 message: 'Initial service:',
                 default: 'microservice1'
+              }, {
+                type: 'input',
+                name: 'port',
+                message: 'Enter port (optional):',
+                default: 9001,
+                validate: input => input === '' || !isNaN(input) ? true : 'Port must be a number.'
               }
 
             ])
@@ -166,13 +173,20 @@ program
               });
             break;
           case 'service':
+            const existing_services = getExistingServices({ currentDir: cwd() })
             prompt([
               {
                 type: 'input',
                 name: 'service_name',
                 message: 'Enter service name:',
                 // TODO: validate workspace compliant name using regex
                 validate: input => input ? true : 'Name cannot be empty',
+              }, {
+                type: 'input',
+                name: 'port',
+                message: 'Enter port (optional):',
+                default: getNextAvailablePort({ services: existing_services }),
+                validate: input => input === '' || !isNaN(input) ? true : 'Port must be a number.'
               }
             ]).then((answers) => actionHandlers.scaffoldNewService({ answers: { ...answers, private: true } }))
             break;
diff --git a/.suite-cli/cli/package.json b/.suite-cli/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@microservices-suite/cli",
-  "version": "2.0.4",
+  "version": "2.0.9",
   "description": "This is the CLI tool for running the microservices-suite monorepo. It contains functionalities and tools required for automation and managing the repo across supported platforms. Works on Windows,MacOS and Linux as well as support to some extend other variants like SunOS, IBM AIX, FreeBSD, OpenBSD and more",
   "main": "cli.js",
   "repository": "https://github.com/microservices-suite/node-microservices-suite.git",
diff --git a/.suite-cli/cli/scripts/assets/apolloServerContent.asset.js b/.suite-cli/cli/scripts/assets/apolloServerContent.asset.js
@@ -1,4 +1,4 @@
-module.exports = () => `
+module.exports = ({ answers }) => `
 const { ApolloServer, gql } = require('apollo-server-express');
 const express = require('express');
 
@@ -19,7 +19,7 @@ const server = new ApolloServer({ typeDefs, resolvers });
 const app = express();
 server.applyMiddleware({ app });
 
-app.listen({ port: 4000 }, () =>
-  console.log(\`🚀 Server ready at http://localhost:\${config.port}\${server.graphqlPath}\`)
+app.listen({ port: ${(answers.port + 1000) < 5000 ? 4001 : 8001} }, () =>
+  console.log(\`🚀 Server ready at http://localhost:${(answers.port + 1000) < 5000 ? 4001 : 8001}\${server.graphqlPath}\`)
 );
 `;
diff --git a/.suite-cli/cli/scripts/assets/ecosystemContent.asset.js b/.suite-cli/cli/scripts/assets/ecosystemContent.asset.js
@@ -1,21 +1,21 @@
-module.exports = () => `
+module.exports = ({ answers }) => `
 module.exports = {
     apps : [{
-      name   : "upload_service",
+      name   : ${answers.service_name},
       autorestart: true,
       watch: true,
       time: true,
       script : "./index.js",
       instances:4,
       env_production: {
         NODE_ENV: "prod",
-        DATABASE_URL:"mongodb://mongodb:27017/supplier_service_db_dev",
-        PORT:9001
+        DATABASE_URL:"mongodb://mongodb:27017/${answers.service_name}",
+        PORT:${answers.port}
      },
      env_development: {
       NODE_ENV: "dev",
-      DATABASE_URL:"mongodb://mongodb:27017/supplier_service_db_dev",
-      PORT:9001
+      DATABASE_URL:"mongodb://mongodb:27017/${answers.service_name}",
+      PORT:${answers.port}
    }
     }]
   }
diff --git a/.suite-cli/cli/scripts/assets/envContent.asset.js b/.suite-cli/cli/scripts/assets/envContent.asset.js
@@ -1,4 +1,4 @@
-module.exports=()=>`
-PORT=9001
+module.exports = ({ answers }) => `
+PORT=${answers.port}
 DATABASE_URL=mongodb://localhost:27017
 `;
diff --git a/.suite-cli/cli/scripts/scripts.module.js b/.suite-cli/cli/scripts/scripts.module.js
@@ -451,7 +451,7 @@ const spinVanillaServices = async ({ serviceDirectories, microservicesDir, mode
                     spinner.fail(`Service in directory ${dir} exited with code ${code}`);
                 } else {
                     spinner.succeed(`Service in directory ${dir} started successfully`);
-                    
+
                 }
             });
         }));
@@ -967,9 +967,15 @@ const addPackageJson = async ({ project_root, answers }) => {
             }
         }
     });
-
+    let warningMessage
     childProcess.stderr.on('data', data => {
-        spinner.text = 'Encountered an issue, check logs for more info.';
+        const output = data.toString();
+
+        if (output.toLowerCase().includes('warning')) {
+            warningMessage = output.split('\n').find(line => line.toLowerCase().includes('warning'));
+        } else {
+            spinner.text = 'Encountered an issue, check logs for more info.';
+        }
     });
 
     childProcess.on('error', error => {
@@ -981,6 +987,12 @@ const addPackageJson = async ({ project_root, answers }) => {
             spinner.fail('Command failed to complete successfully');
             return;
         }
+        spinner.stop()
+        if (warningMessage) {
+            console.log('============================')
+            console.warn(warningMessage)
+            console.log('============================')
+        }
         spinner.succeed('Dependencies installed successfully');
         spinner.info(`To start the project, run 'cd ${answers.repo_name} && suite start -v ${answers.service_name}'`)
     });
@@ -1069,7 +1081,7 @@ const addMicroservice = ({ project_root, answers }) => {
                 writeFile(join(current_dir, 'test1.js'), assets.snapshotTestContent());
                 break;
             case `GraphQL/app1`:
-                writeFile(join(current_dir, 'appollo-server.js'), assets.apolloServerContent());
+                writeFile(join(current_dir, 'appollo-server.js'), assets.apolloServerContent({ answers }));
                 break;
             case `k8s/${answers.service_name}`:
                 // TODO: move k8s into a function
@@ -1084,10 +1096,6 @@ const addMicroservice = ({ project_root, answers }) => {
     });
 
     generateMCSHelper({ project_root, answers })
-    writeFile(join(`${project_root}/microservices/${answers.service_name}`, 'index.js'), assets.serverContent({ answers }));
-    writeFile(join(`${project_root}/microservices/${answers.service_name}`, '.env'), assets.envContent());
-    writeFile(join(`${project_root}/microservices/${answers.service_name}`, '.env.dev'), assets.envContent());
-    writeFile(join(`${project_root}/microservices/${answers.service_name}`, 'ecosystem.config.js'), assets.ecosystemContent());
     mkdirSync(join(project_root, '.vscode'), { recursive: true })
     writeFileSync(join(project_root, '.gitignore'), assets.gitignoreContent());
     writeFileSync(join(project_root, '.vscode', 'launch.json'), JSON.stringify(assets.debuggerConfigContent(), null, 2));
@@ -1203,7 +1211,7 @@ const injectService = async ({ project_root, answers, workspace_name }) => {
         });
 
         await writeFile(join(service_path, 'package.json'), JSON.stringify(packageJsonContent, null, 2));
-
+        registerServiceWithSuiteJson({ root_dir: project_root, name: answers.service_name, port: answers.port })
         spinner.succeed('Service injected successfully');
     } catch (error) {
         spinner.fail(`Failed to inject service: ${error.message}`);
@@ -1259,6 +1267,10 @@ const generateMCSHelper = ({ project_root, answers }) => {
         const indexContent = mcs === 'models' ? assets.modelIndexContent() : mcs === 'routes' ? assets.routesIndexContent() : mcs === 'controllers' ? assets.controllersIndexContent() : assets.servicesIndexContent();
         writeFileSync(join(mcsPath, 'index.js'), indexContent);
     });
+    writeFile(join(`${project_root}/microservices/${answers.service_name}`, 'index.js'), assets.serverContent({ answers }));
+    writeFile(join(`${project_root}/microservices/${answers.service_name}`, '.env'), assets.envContent({ answers }));
+    writeFile(join(`${project_root}/microservices/${answers.service_name}`, '.env.dev'), assets.envContent({ answers }));
+    writeFile(join(`${project_root}/microservices/${answers.service_name}`, 'ecosystem.config.js'), assets.ecosystemContent({ answers }));
 }
 
 /**
@@ -1356,11 +1368,52 @@ const scaffoldNewLibrary = async ({ answers }) => {
  * @returns {void}
  */
 const addProjectConfigs = ({ project_root, answers }) => {
-    writeFile(join(project_root, 'suite.json'), JSON.stringify(assets.suiteJSON({ answers }), null, 2));
+    const { service_name, port, ...suite_json } = answers
+    suite_json['services'] = [
+        {
+            name: service_name,
+            port: answers.port
+        }
+    ]
+    answers.apis.includes('GraphQL') && (suite_json['apollo_servers'] = [{
+        name: 'app1',
+        port: (answers.port + 1000) < 5000 ? 4001 : 8001
+    }])
+    writeFile(join(project_root, 'suite.json'), JSON.stringify(assets.suiteJSON({ answers: suite_json }), null, 2));
     writeFile(join(project_root, 'suite.config'), assets.suiteConfig({ answers }));
     writeFile(join(project_root, '.suiterc'), assets.suiteRC({ answers }));
 
 }
+
+// Function to get the next available port
+const getNextAvailablePort = ({ services }) => {
+    const usedPorts = services.map(service => service.port);
+    let port = 9001;
+    while (usedPorts.includes(port)) {
+        port++;
+    }
+    return port;
+};
+
+const getExistingServices = ({ currentDir }) => {
+    const root_dir = generatRootPath({ currentDir, height: 5 })
+    // Read the project configuration file
+    const configPath = resolve(root_dir, 'suite.json');
+    const config = JSON.parse(readFileSync(configPath, 'utf8'));
+    const existingServices = config.services || [];
+    return existingServices
+}
+const registerServiceWithSuiteJson = ({ root_dir, name, port }) => {
+    // Read the project configuration file
+    const configPath = resolve(root_dir, 'suite.json');
+    const config = JSON.parse(readFileSync(configPath, 'utf8'));
+    if (!config.services) {
+        config.services = [];
+    }
+    config.services.push({ name, port });
+    writeFile(configPath, JSON.stringify(config, null, 2), 'utf8');
+}
+const readFileContent = ({ path }) => { }
 module.exports = {
     generateDirectoryPath,
     changeDirectory,
@@ -1386,5 +1439,7 @@ module.exports = {
     scaffoldNewRepo,
     releasePackage,
     scaffoldNewService,
-    scaffoldNewLibrary
+    scaffoldNewLibrary,
+    getNextAvailablePort,
+    getExistingServices
 }
diff --git a/gateway/apps/ecommerce-app/docker-compose.dev.yml b/gateway/apps/ecommerce-app/docker-compose.dev.yml
@@ -4,71 +4,71 @@ services:
     build: 
       dockerfile: DockerFile
       context: ../../../data-persistence/mongodb
-  rabbitmq:
-    image: rabbitmq:3.8
-    container_name: rabbitmq
-    ports:
-      - '5672:5672'
-      - '15672:15672'
-    healthcheck:
-      test: ["CMD", "rabbitmq-diagnostics", "ping"]
-      interval: 30s
-      retries: 5
-    restart: unless-stopped
-  customer-service:
-    depends_on:
-      rabbitmq:
-        condition: service_healthy
-      # shared:
-      #   condition: service_healthy
-    container_name: customer
-    restart: always
-    build:
-      context: ../../../microservices/customer-service
-      dockerfile: DockerFile.dev
-    ports:
-      - 9000:9000
-    volumes:
-      - /app/node_modules
-      - ../../../microservices/customer-service:/app
-  supplier-service:
-    depends_on:
-      rabbitmq:
-        condition: service_healthy
-      # shared:
-      #   condition: service_healthy
-    container_name: supplier
-    restart: always
-    build:
-      context: ../../../microservices/supplier-service
-      dockerfile: DockerFile.dev
-    ports:
-      - 9001:9001
-    volumes:
-      - /app/node_modules
-      - ../../../microservices/supplier-service:/app  
-  # user-service:
+  # rabbitmq:
+  #   image: rabbitmq:3.8
+  #   container_name: rabbitmq
+  #   ports:
+  #     - '5672:5672'
+  #     - '15672:15672'
+  #   healthcheck:
+  #     test: ["CMD", "rabbitmq-diagnostics", "ping"]
+  #     interval: 30s
+  #     retries: 5
+  #   restart: unless-stopped
+  # customer-service:
+  #   depends_on:
+  #     rabbitmq:
+  #       condition: service_healthy
+  #     # shared:
+  #     #   condition: service_healthy
+  #   container_name: customer
+  #   restart: always
   #   build:
+  #     context: ../../../microservices/customer-service
   #     dockerfile: DockerFile.dev
-  #     context: ../../../microservices/user-service
   #   ports:
-  #     - '9003:9003'
-  #   depends_on:
-  #     - mongodb
+  #     - 9000:9000
   #   volumes:
   #     - /app/node_modules
-  #     - ../../../microservices/user-service:/app
-  # upload-service:
+  #     - ../../../microservices/customer-service:/app
+  # supplier-service:
+  #   depends_on:
+  #     rabbitmq:
+  #       condition: service_healthy
+  #     # shared:
+  #     #   condition: service_healthy
+  #   container_name: supplier
+  #   restart: always
   #   build:
+  #     context: ../../../microservices/supplier-service
   #     dockerfile: DockerFile.dev
-  #     context: ../../../microservices/upload-service
   #   ports:
-  #     - '9004:9004'
-  #   depends_on:
-  #     - mongodb
+  #     - 9001:9001
   #   volumes:
   #     - /app/node_modules
-  #     - ../../../microservices/upload-service:/app
+  #     - ../../../microservices/supplier-service:/app  
+  user-service:
+    build:
+      dockerfile: DockerFile.dev
+      context: ../../../microservices/user-service
+    ports:
+      - '9003:9003'
+    depends_on:
+      - mongodb
+    volumes:
+      - /app/node_modules
+      - ../../../microservices/user-service:/app
+  upload-service:
+    build:
+      dockerfile: DockerFile.dev
+      context: ../../../microservices/upload-service
+    ports:
+      - '9004:9004'
+    depends_on:
+      - mongodb
+    volumes:
+      - /app/node_modules
+      - ../../../microservices/upload-service:/app
   # shared:
   #   build: 
   #     context: ./shared
diff --git a/microservices/user-service/.env.dev b/microservices/user-service/.env.dev
@@ -1,2 +1,2 @@
-DATABASE_URL=mongodb://mongodb:27017/user_service_db_dev
+DATABASE_URL=mongodb://localhost:27017/user_service_db_dev
 PORT=9003
diff --git a/suite.json b/suite.json
@@ -1,4 +0,0 @@
-/**
- * This is the main configuration file for Suite.
- * For full documentation, please see https://github.com/microservices-suite/node-microservices-suite
- */

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@microservices-suite/cli",`
`3`		`- "version": "2.0.4",`
	`3`	`+ "version": "2.0.9",`
`4`	`4`	`"description": "This is the CLI tool for running the microservices-suite monorepo. It contains functionalities and tools required for automation and managing the repo across supported platforms. Works on Windows,MacOS and Linux as well as support to some extend other variants like SunOS, IBM AIX, FreeBSD, OpenBSD and more",`
`5`	`5`	`"main": "cli.js",`
`6`	`6`	`"repository": "https://github.com/microservices-suite/node-microservices-suite.git",`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-DATABASE_URL=mongodb://mongodb:27017/user_service_db_dev`
	`1`	`+DATABASE_URL=mongodb://localhost:27017/user_service_db_dev`
`2`	`2`	`PORT=9003`
-Original file line number
+Diff line change
@@ @@ -1,4 +0,0 @@ @@
 -/**
 - * This is the main configuration file for Suite.
 - * For full documentation, please see https://github.com/microservices-suite/node-microservices-suite
 - */