feat: add support for krakend api gateway

GAndanje · GAndanje · commit da33fc626eaf · 2024-09-20T03:54:20.000+03:00
diff --git a/.suite-cli/cli/cli.js b/.suite-cli/cli/cli.js
@@ -5,7 +5,7 @@ const { Command } = require('commander');
 const { createPromptModule } = require('inquirer');
 const { execSync } = require('node:child_process')
 const actionHandlers = require('./scripts')
-const { logInfo, getExistingServices, getNextAvailablePort, scaffoldApp } = require('./scripts/scripts.module');
+const { logInfo, getExistingServices, getExistingApps, getNextAvailablePort, scaffoldApp, scaffoldGateways } = require('./scripts/scripts.module');
 const { cwd } = require('node:process');
 const program = new Command()
 const prompt = createPromptModule()
@@ -239,10 +239,83 @@ program
                   checked: true, // Default all services to be selected
                 })),
               },
+              {
+                type: 'input',
+                name: 'gateway_port',
+                message: 'Enter port (optional):',
+                default: 8080,
+                validate: input => !isNaN(input) ? true : 'Port must be a number.'
+              },
+              {
+                type: 'input',
+                name: 'api_version',
+                message: 'Whats the api version? (optional):',
+                default: 'v1',
+              },
+              {
+                type: 'input',
+                name: 'gateway_cache_period',
+                message: 'How long do you want the gateway to cache data (optional):',
+                default: 3600,
+                validate: input => !isNaN(input) ? true : 'Caching period must be a number.'
+              },
+              {
+                type: 'input',
+                name: 'gateway_timeout',
+                message: 'How long should a request take before timing out (optional):',
+                default: 300,
+                validate: input => input === '' || !isNaN(input) ? true : 'Timeout must be a number.'
+              }
             ]).then(answers => {
               scaffoldApp({ answers })
             })
             break;
+          case 'gateway':
+            const all_apps = getExistingApps({ currentDir: cwd() });
+            console.log({all_apps})
+            const formatAppsName = (app) => app.name;
+            prompt([
+              {
+                type: 'checkbox',
+                name: 'apps',
+                message: 'Select apps',
+                choices: all_apps.map(app => ({
+                  name: formatAppsName(app),
+                  value: app,
+                  checked: true, // Default all services to be selected
+                })),
+              },
+              {
+                type: 'input',
+                name: 'gateway_port',
+                message: 'Enter port (optional):',
+                default: 8080,
+                validate: input => !isNaN(input) ? true : 'Port must be a number.'
+              },
+              {
+                type: 'input',
+                name: 'api_version',
+                message: 'Whats the api version? (optional):',
+                default: 'v1',
+              },
+              {
+                type: 'input',
+                name: 'gateway_cache_period',
+                message: 'How long do you want the gateway to cache data (optional):',
+                default: 3600,
+                validate: input => !isNaN(input) ? true : 'Caching period must be a number.'
+              },
+              {
+                type: 'input',
+                name: 'gateway_timeout',
+                message: 'How long should a request take before timing out (optional):',
+                default: 300,
+                validate: input => input === '' || !isNaN(input) ? true : 'Timeout must be a number.'
+              }
+            ]).then(answers => {
+              scaffoldGateways({ answers })
+            })
+            break;
           default:
             console.log('Handling other resources, not yet implemented.');
           // Handle other cases or provide feedback that other options are not yet implemented
diff --git a/.suite-cli/cli/scripts/assets/dockerComposeContent.asset.js b/.suite-cli/cli/scripts/assets/dockerComposeContent.asset.js
@@ -1,4 +1,4 @@
-module.exports = ({ services, webserver }) => {
+module.exports = ({ services, webserver, krakend_port, env }) => {
   const servicesConfig = services.map(service => `
   ${service.name.toLowerCase().replace(/\s+/g, '-')}: 
     build: 
@@ -54,5 +54,13 @@ ${serviceNames.map(service => `      - ${service}`).join('\n')}
     volumes:
       - type: bind
         source: ./data
-        target: /data/db`;
+        target: /data/db
+  krakend:
+    image: devopsfaith/krakend:2.7${env === 'dev' ? '-watch' : ''}
+    ports:
+      - '${krakend_port}:${krakend_port}'
+      - '8090:8090'
+    volumes:
+      - ./krakend/:/etc/krakend/
+    command: ['run','-d','-c','/etc/krakend/krakend.json']`;
 };
diff --git a/.suite-cli/cli/scripts/assets/index.js b/.suite-cli/cli/scripts/assets/index.js
@@ -58,5 +58,6 @@ module.exports.brokerSubscriberContent = require('./brokerSubscriberContent.asse
 module.exports.brokerWorkerQueueContent = require('./brokerWorkerQueueContent.asset'); 
 module.exports.subscriberContent = require('./subscriberContent.asset'); 
 module.exports.subscriberIndexContent = require('./subscriberIndexContent.asset'); 
+module.exports.krakendConfigContent = require('./krakendConfigContent.asset'); 
 
 
diff --git a/.suite-cli/cli/scripts/assets/krakendConfigContent.asset.js b/.suite-cli/cli/scripts/assets/krakendConfigContent.asset.js
@@ -0,0 +1,69 @@
+module.exports = ({
+  services,
+  projectName,
+  api_version,
+  gateway_cache_period,
+  gateway_timeout,
+  gateway_port
+}) => {
+  // Health check for all services
+  const suiteStatusCheckBackends = services.map((service) => `
+    {
+      "host": ["http://${service.name.toLowerCase()}:${service.port}"],
+      "url_pattern": "/",
+      "mapping": {
+        "message": "${service.name.toLowerCase()}"
+      }
+    }`).join(',\n');
+
+  // List all services
+  const allServicesListBackends = services.map((service) => `
+    {
+      "host": ["http://${service.name.toLowerCase()}:${service.port}"],
+      "url_pattern": "/api/${api_version}/${service.name.toLowerCase()}s",
+      "mapping": {
+        "data": "${service.name.toLowerCase()}s"
+      }
+    }`).join(',\n');
+
+  // Each service backend
+  const eachServiceListBackends = [services[0]].map((service) => `
+    {
+      "host": ["http://${service.name.toLowerCase()}:${service.port}"],
+      "url_pattern": "/api/${api_version}/${service.name.toLowerCase()}s",
+      "mapping": {
+        "data": "${service.name.toLowerCase()}s"
+      }
+    }`).join(',\n');
+
+  // The JSON result string
+  return `
+{
+  "$schema": "https://www.krakend.io/schema/v2.5/krakend.json",
+  "version": 3,
+  "name": "${projectName.charAt(0).toUpperCase() + projectName.slice(1)} API Gateway",
+  "port": ${gateway_port},
+  "cache_ttl": "${gateway_cache_period}s",
+  "timeout": "${gateway_timeout}s",
+  "endpoints": [
+    {
+      "@comment": "Check the health of all your APIs",
+      "endpoint": "/__suite_status",
+      "method": "GET",
+      "backend": [${suiteStatusCheckBackends}]
+    },
+    {
+      "@comment": "Hit all API list endpoints simultaneously",
+      "endpoint": "/api/${api_version}/",
+      "method": "GET",
+      "backend": [${allServicesListBackends}]
+    },
+    {
+      "@comment": "Fetch all data from the ${services[0].name.toLowerCase()} service",
+      "endpoint": "/api/${api_version}/${services[0].name.toLowerCase()}s",
+      "method": "GET",
+      "backend": [${eachServiceListBackends}]
+    }
+  ]
+}`;
+};
diff --git a/.suite-cli/cli/scripts/scripts.module.js b/.suite-cli/cli/scripts/scripts.module.js
@@ -1351,6 +1351,13 @@ const getExistingServices = ({ currentDir }) => {
     const { services } = readFileContent({ currentDir })
     return services
 }
+
+const getExistingApps = ({ currentDir }) => {
+    const { apps } = readFileContent({ currentDir });
+
+    return apps
+}
+
 const registerServiceWithSuiteJson = ({ root_dir, name, port }) => {
     // Read the project configuration file
     const configPath = resolve(root_dir, 'suite.json');
@@ -1365,6 +1372,20 @@ const registerServiceWithSuiteJson = ({ root_dir, name, port }) => {
     writeFile(configPath, JSON.stringify(config, null, 2), 'utf8');
 }
 
+const registerAppWithSuiteJson = ({ root_dir, name, services }) => {
+    // Read the project configuration file
+    const configPath = resolve(root_dir, 'suite.json');
+    const config = JSON.parse(readFileSync(configPath, 'utf8'));
+    const services_names = services.map((s) => s.name);
+    if (!config.apps) {
+        config.apps = [];
+    }
+    config.apps.push({ name, services: services_names });
+
+    // keep the apps ordered by names
+    config.apps.sort((a, b) => a.name - b.name);
+    writeFile(configPath, JSON.stringify(config, null, 2), 'utf8');
+}
 /**
  * Releases a package or generates a release for the workspace.
  * @async
@@ -1395,20 +1416,35 @@ const test = async ({ package }) => {
 
 const scaffoldApp = ({ answers }) => {
 
-    const { webserver } = readFileContent({ currentDir: cwd() })
-    const project_root = generatRootPath({ currentDir: cwd() })
-    const app_directory = join(project_root, 'gateways/apps', answers.app_name)
-    const webserver_dir = join(app_directory, webserver)
-    const data_dir = join(app_directory, 'data')
+    const { webserver } = readFileContent({ currentDir: cwd() });
+    const { projectName } = readFileContent({ currentDir: cwd() });
+    const project_root = generatRootPath({ currentDir: cwd() });
+    const app_directory = join(project_root, 'gateways/apps', answers.app_name);
+    const webserver_dir = join(app_directory, webserver);
+    const krakend_dir = join(app_directory, 'krakend');
+    const data_dir = join(app_directory, 'data');
 
     // Remove the directory if it already exists
     if (existsSync(app_directory)) {
         rmSync(app_directory, { recursive: true });
     }
     mkdirSync(webserver_dir, { recursive: true });
+    mkdirSync(krakend_dir, { recursive: true });
     mkdirSync(data_dir, { recursive: true });
-    writeFileSync(join(app_directory, 'docker-compose.dev.yml'), assets.dockerComposeContent({ services: answers.services, app_name: answers.app_name, webserver }));
-    writeFileSync(join(app_directory, 'docker-compose.yml'), assets.dockerComposeContent({ services: answers.services, app_name: answers.app_name, webserver }));
+    writeFileSync(join(app_directory, 'docker-compose.dev.yml'), assets.dockerComposeContent({
+        services: answers.services,
+        app_name: answers.app_name,
+        webserver,
+        krakend_port: answers.gateway_port,
+        env: 'dev'
+    }));
+    writeFileSync(join(app_directory, 'docker-compose.yml'), assets.dockerComposeContent({
+        services: answers.services,
+        app_name: answers.app_name,
+        webserver,
+        krakend_port: answers.gateway_port,
+        env: 'prod'
+    }));
     ora().succeed(`Generated docker-compose configs at: ${app_directory}`)
     switch (webserver) {
         case 'nginx':
@@ -1418,6 +1454,17 @@ const scaffoldApp = ({ answers }) => {
 
             ora().info('Handling other webservers');
     }
+    generateKrakendConfiguration({
+        services: answers.services,
+        krakend_dir,
+        projectName,
+        gateway_port: answers.gateway_port,
+        api_version: answers.api_version,
+        gateway_cache_period: answers.gateway_cache_period,
+        gateway_timeout: answers.gateway_timeout
+    });
+    registerAppWithSuiteJson({ root_dir: project_root, name: answers.app_name, services: answers.services })
+
 }
 const readFileContent = ({ currentDir }) => {
     const root_dir = generatRootPath({ currentDir, height: 5 })
@@ -1433,6 +1480,27 @@ const generateNginxConfiguration = ({ services, webserver_dir }) => {
     writeFile(join(webserver_dir, 'Dockerfile.dev'), assets.nginxDockerfileContent());
     ora().succeed(`Generated webserver configs at: ${webserver_dir}`)
 }
+const generateKrakendConfiguration = ({
+    services,
+    krakend_dir,
+    projectName,
+    gateway_port,
+    api_version,
+    gateway_cache_period,
+    gateway_timeout
+}) => {
+    writeFile(join(krakend_dir,
+        'krakend.json'),
+        assets.krakendConfigContent({
+            services,
+            projectName,
+            gateway_port,
+            api_version,
+            gateway_cache_period,
+            gateway_timeout
+        }));
+    ora().succeed(`Generated krakend gateway configs at: ${krakend_dir}`)
+}
 const installDependencies = async ({ project_base, workspace, spinner, deps, flags }) => {
 
 
@@ -1549,6 +1617,66 @@ const getDependencies = ({ type, workspace }) => {
             break
     }
 }
+
+
+const scaffoldGateways = async ({ answers }) => {
+    console.log({answers})
+    const { webserver } = readFileContent({ currentDir: cwd() });
+    const { projectName } = readFileContent({ currentDir: cwd() });
+    const { apps } = answers;
+    const project_root = generatRootPath({ currentDir: cwd() });
+
+    await Promise.all(apps.map(async (app) => {
+        return scaffoldGateway({ project_root, app, webserver, projectName })
+    }))
+}
+
+const scaffoldGateway = ({ project_root, app, webserver, projectName }) => {
+    const app_directory = join(project_root, 'gateways/apps', app.name);
+    const webserver_dir = join(app_directory, webserver);
+    const krakend_dir = join(app_directory, 'krakend');
+    const services = app.services;
+
+    // Remove the directory if it already exists
+    if (existsSync(krakend_dir)) {
+        rmSync(krakend_dir, { recursive: true });
+    }
+    mkdirSync(webserver_dir, { recursive: true });
+    mkdirSync(krakend_dir, { recursive: true });
+    writeFileSync(join(app_directory, 'docker-compose.dev.yml'), assets.dockerComposeContent({
+        services,
+        app_name: app.name,
+        webserver,
+        krakend_port: answers.gateway_port,
+        env: 'dev'
+    }));
+    writeFileSync(join(app_directory, 'docker-compose.yml'), assets.dockerComposeContent({
+        services,
+        app_name: app.name,
+        webserver,
+        krakend_port: answers.gateway_port,
+        env: 'prod'
+    }));
+    ora().succeed(`Generated docker-compose configs at: ${app_directory}`)
+    switch (webserver) {
+        case 'nginx':
+            generateNginxConfiguration({ services, webserver_dir });
+            break
+        default:
+            ora().info('Handling other webservers');
+    }
+    generateKrakendConfiguration({
+        services,
+        krakend_dir,
+        projectName,
+        gateway_port: answers.gateway_port,
+        api_version: answers.api_version,
+        gateway_cache_period: answers.gateway_cache_period,
+        gateway_timeout: answers.gateway_timeout
+    });
+
+}
+
 module.exports = {
     generateDirectoryPath,
     changeDirectory,
@@ -1578,5 +1706,7 @@ module.exports = {
     getNextAvailablePort,
     getExistingServices,
     test,
-    scaffoldApp
+    scaffoldApp,
+    scaffoldGateways,
+    getExistingApps
 }
