Refactor.interface.conflict fix

.gitignore

@@ -55,7 +55,6 @@ uploads
 # Ignore Mac DS_Store files
 *.DS_Store
 
-
 public/assessment/web
 public/assessment/web2
 public/tmp
@@ -77,4 +76,6 @@ src/globalConfig.json
 
 dev-ops/report
 
-src/package-lock.json
+src/package-lock.json
+
+src/configs/.config.json

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18
+FROM node:17
 
 #Set working directory
 WORKDIR /var/src/
@@ -7,7 +7,7 @@ WORKDIR /var/src/
 COPY ./src/package.json .
 
 #Install node packages
-RUN npm install && npm install -g [email protected]
+RUN npm install --unsafe-perm
 #Copy all files 
 COPY ./src .
 

Jenkinsfile

@@ -0,0 +1,47 @@
+node('build-slave') {
+    try {
+        String ANSI_GREEN = "\u001B[32m"
+        String ANSI_NORMAL = "\u001B[0m"
+        String ANSI_BOLD = "\u001B[1m"
+        String ANSI_RED = "\u001B[31m"
+        String ANSI_YELLOW = "\u001B[33m"
+
+        ansiColor('xterm') {
+                stage('Checkout') {
+                    if (!env.hub_org) {
+                        println(ANSI_BOLD + ANSI_RED + "Uh Oh! Please set a Jenkins environment variable named hub_org with value as registery/sunbidrded" + ANSI_NORMAL)
+                        error 'Please resolve the errors and rerun..'
+                    } else
+                        println(ANSI_BOLD + ANSI_GREEN + "Found environment variable named hub_org with value as: " + hub_org + ANSI_NORMAL)
+                }
+
+                cleanWs()
+                checkout scm
+                commit_hash = sh(script: 'git rev-parse --short HEAD', returnStdout: true).trim()
+                build_tag = sh(script: "echo " + params.github_release_tag.split('/')[-1] + "_" + commit_hash + "_" + env.BUILD_NUMBER, returnStdout: true).trim()
+                echo "build_tag: " + build_tag
+
+
+            stage('Build') {
+                env.NODE_ENV = "build"
+                print "Environment will be : ${env.NODE_ENV}"
+                sh('chmod 777 build.sh')
+                sh("bash -x build.sh ${build_tag} ${env.NODE_NAME} ${docker_server}")
+            }
+
+
+               stage('ArchiveArtifacts') {
+	       	   sh ("echo ${build_tag} > build_tag.txt")
+                   archiveArtifacts "metadata.json"		     
+                    archiveArtifacts "build_tag.txt" 
+                    currentBuild.description = "${build_tag}"
+                }
+
+        }
+    }
+    catch (err) {
+        currentBuild.result = "FAILURE"
+        throw err
+    }
+
+}

README.md

@@ -123,7 +123,6 @@ interface-service/src$ sudo nano .env
 APPLICATION_PORT=3569
 API_DOC_URL= /interface/api-doc
 APPLICATION_ENV= development
-INSTALLED_PACKAGES= "elevate-user elevate-mentoring elevate-scheduler"
 MENTORING_SERVICE_BASE_URL= http://localhost:3000
 NOTIFICATION_SERVICE_BASE_URL= http://localhost:7201
 REQUIRED_PACKAGES= "[email protected] [email protected] [email protected]"

build.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+echo "Docker build script"
+
+# Build script
+set -eo pipefail
+
+build_tag=$1
+name=mentoring-interface-service
+node=$2
+org=$3
+
+docker build -f ./Dockerfile --label commitHash=$(git rev-parse --short HEAD) -t ${org}/${name}:${build_tag} .
+
+echo {\"image_name\" : \"${name}\", \"image_tag\" : \"${build_tag}\", \"node_name\" : \"$node\"} > metadata.json

src/.env.sample

@@ -0,0 +1,53 @@
+# CORS allowed host, optional with default value "*"
+ALLOWED_HOST=*
+
+# Base URL for API documentation access, optional
+API_DOC_URL=/interface/api-doc
+
+# Required node environment (e.g., development, production)
+APPLICATION_ENV=development
+
+# Required application port number for running the server
+APPLICATION_PORT=3567
+
+# Required base URL for the mentoring service
+MENTORING_SERVICE_BASE_URL=http://localhost:7101
+
+# Required base URL for the notification service
+NOTIFICATION_SERVICE_BASE_URL=http://localhost:7201
+
+# Global flag to enable rate limiting, required
+RATE_LIMITER_ENABLED=true
+
+# Required limit for general type rate limiting
+RATE_LIMITER_GENERAL_LIMIT=50
+
+# Required window duration for general type rate limiting (milliseconds)
+RATE_LIMITER_GENERAL_WINDOW=60000
+
+# Required limit for internal type rate limiting
+RATE_LIMITER_INTERNAL_LIMIT=50
+
+# Required window duration for internal type rate limiting (milliseconds)
+RATE_LIMITER_INTERNAL_WINDOW=60000
+
+# Required number of proxies to consider for rate limiting
+RATE_LIMITER_NUMBER_OF_PROXIES=3
+
+# Required limit for public-low type rate limiting
+RATE_LIMITER_PUBLIC_LOW_LIMIT=5
+
+# Required window duration for public-low type rate limiting (milliseconds)
+RATE_LIMITER_PUBLIC_LOW_WINDOW=120000
+
+# Required packages for the application
+REQUIRED_PACKAGES="[email protected] [email protected] [email protected]"
+
+# Required base URL for the scheduler service
+SCHEDULER_SERVICE_BASE_URL=http://localhost:7401
+
+# Required supported HTTP types for the server
+SUPPORTED_HTTP_TYPES="GET POST PUT PATCH DELETE"
+
+# Required base URL for the user service
+USER_SERVICE_BASE_URL=http://localhost:7001

src/api-doc/interface-2.5-setup.md

@@ -60,7 +60,6 @@ interface-service/src$ sudo nano .env
 APPLICATION_PORT=3569
 API_DOC_URL= /interface/api-doc
 APPLICATION_ENV= development
-INSTALLED_PACKAGES= "elevate-user elevate-mentoring elevate-scheduler"
 MENTORING_SERVICE_BASE_URL= http://localhost:3000
 NOTIFICATION_SERVICE_BASE_URL= http://localhost:7201
 REQUIRED_PACKAGES= "[email protected] [email protected] [email protected]"

src/app.js

@@ -5,18 +5,24 @@ const cors = require('cors')
 require('dotenv').config({ path: './.env' })
 const packageInstaller = require('./utils/packageInstaller')
 
+packageInstaller(process.env.REQUIRED_PACKAGES).catch((error) => {
+	console.error(`An error occurred in package installer: ${error}`)
+	process.exit()
+})
+
+const { runCombineRoutes } = require('./scripts/combineRoutesConfigs')
+runCombineRoutes()
+
+const dependencyManager = require('@helpers/dependencyManager')
+dependencyManager()
+
 let environmentData = require('./envVariables')()
 if (!environmentData.success) {
 	console.error('Server could not start . Not all environment variable is provided')
 	process.exit()
 }
 require('./init')
 
-packageInstaller(process.env.REQUIRED_PACKAGES).catch((error) => {
-	console.error(`An error occurred in package installer: ${error}`)
-	process.exit()
-})
-
 const app = express()
 const path = require('path')
 app.set('trust proxy', parseInt(process.env.RATE_LIMITER_NUMBER_OF_PROXIES))

src/configs/dependencyConfig.json

@@ -0,0 +1,18 @@
+{
+	"requiredDependencies": [
+		{
+			"packageName": "sunbird-user",
+			"dependencies": [{ "name": "kafka" }]
+		},
+		{
+			"packageName": "kb-mentoring-notification",
+			"dependencies": [{ "name": "kafka" }]
+		}
+	],
+	"supportedDependencies": [
+		{
+			"name": "kafka",
+			"packageName": "elevate-kafka"
+		}
+	]
+}

src/configs/requiredEnvs.json

@@ -0,0 +1,12 @@
+{
+	"requiredEnvs": {
+		"USER_SERVICE_BASE_URL": {
+			"message": "Required user service base URL",
+			"optional": false
+		},
+		"MENTORING_SERVICE_BASE_URL": {
+			"message": "Required mentoring service base URL",
+			"optional": false
+		}
+	}
+}

src/constants/routesConfigs.js → src/configs/routesConfigs.js

@@ -1,5 +1,5 @@
 'use strict'
-const config = require('@constants/config.json')
+const config = require('@configs/.config.json')
 
 exports.routesConfigs = {
 	services: ['user', 'mentoring', 'notification', 'scheduler'],

src/configs/routesConfigs/elevate-scheduler.json

@@ -0,0 +1,84 @@
+{
+    "routes": [
+        {
+            "sourceRoute": "/scheduler/jobs/create",
+            "type": "POST",
+            "priority": "MUST_HAVE",
+            "inSequence": false,
+            "orchestrated": false,
+            "targetPackages": [
+                {
+                    "basePackageName": "scheduler",
+                    "packageName": "elevate-scheduler"
+                }
+            ],
+            "rateLimit": {
+                "type": "none"
+            }
+        },
+        {
+            "sourceRoute": "/scheduler/jobs/updateDelay",
+            "type": "POST",
+            "priority": "MUST_HAVE",
+            "inSequence": false,
+            "orchestrated": false,
+            "targetPackages": [
+                {
+                    "basePackageName": "scheduler",
+                    "packageName": "elevate-scheduler"
+                }
+            ],
+            "rateLimit": {
+                "type": "none"
+            }
+        },
+        {
+            "sourceRoute": "/scheduler/jobs/remove",
+            "type": "POST",
+            "priority": "MUST_HAVE",
+            "inSequence": false,
+            "orchestrated": false,
+            "targetPackages": [
+                {
+                    "basePackageName": "scheduler",
+                    "packageName": "elevate-scheduler"
+                }
+            ],
+            "rateLimit": {
+                "type": "none"
+            }
+        },
+        {
+            "sourceRoute": "/scheduler/jobs/list",
+            "type": "GET",
+            "priority": "MUST_HAVE",
+            "inSequence": false,
+            "orchestrated": false,
+            "targetPackages": [
+                {
+                    "basePackageName": "scheduler",
+                    "packageName": "elevate-scheduler"
+                }
+            ],
+            "rateLimit": {
+                "type": "none"
+            }
+        },
+        {
+            "sourceRoute": "/scheduler/jobs/purge",
+            "type": "POST",
+            "priority": "MUST_HAVE",
+            "inSequence": false,
+            "orchestrated": false,
+            "targetPackages": [
+                {
+                    "basePackageName": "scheduler",
+                    "packageName": "elevate-scheduler"
+                }
+            ],
+            "rateLimit": {
+                "type": "none"
+            }
+        }
+    ]
+}