Merge pull request #40 from devtron-labs/feat/currency-module-finops

feat: "currency rate conversion for finops"

Author: Ash-exp

.github/workflows/pr-issue-validator.yaml

@@ -0,0 +1,45 @@
+name: Validate Pull Request
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - edited
+      - reopened
+    branches:
+      - 'main'
+      - 'release-**'
+      - 'develop'
+      - 'hotfix-**'
+    # paths-ignore:
+    #   - 'docs/**'
+    #   - '.github/'
+    #   - 'CHANGELOG/'
+    #   - 'charts/'
+    #   - 'manifests/'
+    #   - 'sample-docker-templates/'
+jobs:
+  validate-PR-issue:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up jq (for parsing JSON)
+        run: sudo apt-get install -y jq
+
+      - name: PR Validation Script
+        env:
+          PR_BODY: ${{ github.event.pull_request.body }}
+          PRNUM: ${{ github.event.pull_request.number }}
+          TITLE: ${{ github.event.pull_request.title }}
+          GH_TOKEN: ${{ github.token }}
+          GH_PR_VALIDATOR_TOKEN: ${{ secrets.GH_PR_VALIDATOR_TOKEN }}
+          BASE_REPO: ${{ github.event.pull_request.base.repo.full_name }}
+          HEAD_REPO: ${{ github.event.pull_request.head.repo.full_name }}
+        run: |
+          wget https://raw.githubusercontent.com/devtron-labs/utilities/feat/central-pr-validator/.github/workflows/validateIssue.sh
+          chmod +x validateIssue.sh
+          ./validateIssue.sh

.gitignore

@@ -1 +1,2 @@
-central-api
+central-api
+.idea

Wire.go

@@ -21,16 +21,18 @@ package main
 
 import (
 	"github.com/devtron-labs/central-api/api"
+	"github.com/devtron-labs/central-api/api/currency"
 	util "github.com/devtron-labs/central-api/client"
-	"github.com/devtron-labs/central-api/internal/logger"
 	"github.com/devtron-labs/central-api/pkg"
+	currencyPkg "github.com/devtron-labs/central-api/pkg/currency"
 	blob_storage "github.com/devtron-labs/common-lib/blob-storage"
+	"github.com/devtron-labs/common-lib/utils"
 	"github.com/google/wire"
 )
 
 func InitializeApp() (*App, error) {
 	wire.Build(
-		logger.NewSugardLogger,
+		utils.NewSugardLogger,
 		//sql.PgSqlWireSet,
 		//releaseNote.NewReleaseNoteRepositoryImpl,
 		//wire.Bind(new(releaseNote.ReleaseNoteRepository), new(*releaseNote.ReleaseNoteRepositoryImpl)),
@@ -50,6 +52,15 @@ func InitializeApp() (*App, error) {
 
 		pkg.NewCiBuildMetadataServiceImpl,
 		wire.Bind(new(pkg.CiBuildMetadataService), new(*pkg.CiBuildMetadataServiceImpl)),
+
+		// Currency service dependencies
+		currencyPkg.NewCurrencyConfig,
+		currencyPkg.NewServiceImpl,
+		wire.Bind(new(currencyPkg.Service), new(*currencyPkg.ServiceImpl)),
+		currency.NewCurrencyRestHandlerImpl,
+		wire.Bind(new(currency.CurrencyRestHandler), new(*currency.CurrencyRestHandlerImpl)),
+		currency.NewRouter,
+		wire.Bind(new(currency.Router), new(*currency.RouterImpl)),
 	)
 	return &App{}, nil
 }

api/RestHandler.go

@@ -17,8 +17,8 @@
 package api
 
 import (
-	"encoding/json"
 	"github.com/Masterminds/semver"
+	"github.com/devtron-labs/central-api/api/handler"
 	util "github.com/devtron-labs/central-api/client"
 	"github.com/devtron-labs/central-api/common"
 	"github.com/devtron-labs/central-api/pkg"
@@ -60,63 +60,32 @@ type RestHandlerImpl struct {
 	ciBuildMetadataService pkg.CiBuildMetadataService
 }
 
-func setupResponse(w *http.ResponseWriter, req *http.Request) {
-	(*w).Header().Set("Access-Control-Allow-Origin", "*")
-	(*w).Header().Set("Access-Control-Allow-Methods", "POST, GET, OPTIONS, PUT, DELETE")
-	(*w).Header().Set("Access-Control-Allow-Headers", "Accept, Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization")
-	(*w).Header().Set("Content-Type", "text/html; charset=utf-8")
-}
-
-func (impl RestHandlerImpl) WriteJsonResp(w http.ResponseWriter, err error, respBody interface{}, status int) {
-	response := common.Response{}
-	response.Code = status
-	response.Status = http.StatusText(status)
-	if err == nil {
-		response.Result = respBody
-	} else {
-		apiErr := &common.ApiError{}
-		apiErr.Code = "000" // 000=unknown
-		apiErr.InternalMessage = err.Error()
-		apiErr.UserMessage = respBody
-		response.Errors = []*common.ApiError{apiErr}
-
-	}
-	b, err := json.Marshal(response)
-	if err != nil {
-		impl.logger.Errorw("error in marshaling err object", "err", err)
-		status = 500
-	}
-	w.Header().Set("Content-Type", "application/json")
-	w.WriteHeader(status)
-	w.Write(b)
-}
-
 func (impl *RestHandlerImpl) GetModules(w http.ResponseWriter, r *http.Request) {
 	impl.logger.Debug("get all modules")
-	setupResponse(&w, r)
+	handler.SetupCorsOriginHeader(&w, r)
 	modules, err := impl.releaseNoteService.GetModules()
 	if err != nil {
-		impl.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
+		handler.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
 		return
 	}
-	impl.WriteJsonResp(w, nil, modules, http.StatusOK)
+	handler.WriteJsonResp(w, nil, modules, http.StatusOK)
 	return
 }
 
 func (impl *RestHandlerImpl) GetModulesV2(w http.ResponseWriter, r *http.Request) {
 	impl.logger.Debug("get all modules")
-	setupResponse(&w, r)
+	handler.SetupCorsOriginHeader(&w, r)
 	modules, err := impl.releaseNoteService.GetModulesV2()
 	if err != nil {
-		impl.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
+		handler.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
 		return
 	}
-	impl.WriteJsonResp(w, nil, modules, http.StatusOK)
+	handler.WriteJsonResp(w, nil, modules, http.StatusOK)
 	return
 }
 
 func (impl *RestHandlerImpl) GetReleases(w http.ResponseWriter, r *http.Request) {
-	setupResponse(&w, r)
+	handler.SetupCorsOriginHeader(&w, r)
 	impl.logger.Debug("get all releases")
 	offset := 0
 	size := 10
@@ -129,14 +98,14 @@ func (impl *RestHandlerImpl) GetReleases(w http.ResponseWriter, r *http.Request)
 	if hasOffsetParam {
 		offset, err = strconv.Atoi(offsetQueryParam)
 		if err != nil {
-			impl.WriteJsonResp(w, err, "invalid offset", http.StatusBadRequest)
+			handler.WriteJsonResp(w, err, "invalid offset", http.StatusBadRequest)
 			return
 		}
 	}
 	if hasSizeParam {
 		size, err = strconv.Atoi(sizeQueryParam)
 		if err != nil {
-			impl.WriteJsonResp(w, err, "invalid size", http.StatusBadRequest)
+			handler.WriteJsonResp(w, err, "invalid size", http.StatusBadRequest)
 			return
 		}
 	}
@@ -149,7 +118,7 @@ func (impl *RestHandlerImpl) GetReleases(w http.ResponseWriter, r *http.Request)
 	//will fetch all the releases from cache and later apply size and offset filter
 	response, err := impl.releaseNoteService.GetReleases(repository)
 	if err != nil {
-		impl.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
+		handler.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
 		return
 	}
 	if len(serverVersion) > 0 {
@@ -185,7 +154,7 @@ func (impl *RestHandlerImpl) GetReleases(w http.ResponseWriter, r *http.Request)
 		response = make([]*common.Release, 0)
 	}
 
-	impl.WriteJsonResp(w, nil, response, http.StatusOK)
+	handler.WriteJsonResp(w, nil, response, http.StatusOK)
 	return
 }
 
@@ -200,61 +169,61 @@ func (impl *RestHandlerImpl) ReleaseWebhookHandler(w http.ResponseWriter, r *htt
 	requestBodyBytes, err := ioutil.ReadAll(r.Body)
 	if err != nil {
 		impl.logger.Errorw("Cannot read the request body:", "err", err)
-		impl.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
+		handler.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
 		return
 	}
 
 	isValidSig := impl.webhookSecretValidator.ValidateSecret(r, requestBodyBytes)
 	impl.logger.Debugw("Secret validation result ", "isValidSig", isValidSig)
 	if !isValidSig {
 		impl.logger.Error("Signature mismatch")
-		impl.WriteJsonResp(w, err, nil, http.StatusUnauthorized)
+		handler.WriteJsonResp(w, err, nil, http.StatusUnauthorized)
 		return
 	}
 	// validate event type
 	eventType := r.Header.Get(impl.client.GitHubConfig.GitHubEventTypeHeader)
 	impl.logger.Debugw("webhook event type header", "eventType : ", eventType)
 	if len(eventType) == 0 || eventType != bean.EventTypeRelease {
 		impl.logger.Errorw("Event type not known ", eventType)
-		impl.WriteJsonResp(w, err, nil, http.StatusBadRequest)
+		handler.WriteJsonResp(w, err, nil, http.StatusBadRequest)
 		return
 	}
 
 	flag, err := impl.releaseNoteService.UpdateReleases(requestBodyBytes)
 	if err != nil {
-		impl.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
+		handler.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
 		return
 	}
-	impl.WriteJsonResp(w, err, flag, http.StatusOK)
+	handler.WriteJsonResp(w, err, flag, http.StatusOK)
 	return
 }
 
 func (impl *RestHandlerImpl) GetModuleByName(w http.ResponseWriter, r *http.Request) {
 	impl.logger.Debug("get module meta info by name")
-	setupResponse(&w, r)
+	handler.SetupCorsOriginHeader(&w, r)
 	vars := mux.Vars(r)
 	name := vars["name"]
 	module, err := impl.releaseNoteService.GetModuleByName(name)
 	if err != nil {
-		impl.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
+		handler.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
 		return
 	}
-	impl.WriteJsonResp(w, nil, module, http.StatusOK)
+	handler.WriteJsonResp(w, nil, module, http.StatusOK)
 	return
 }
 
 func (impl *RestHandlerImpl) GetDockerfileTemplateMetadata(w http.ResponseWriter, r *http.Request) {
 	impl.logger.Debug("get all dockerfile template metadata")
-	setupResponse(&w, r)
+	handler.SetupCorsOriginHeader(&w, r)
 	dockerfileTemplateMetadata := impl.ciBuildMetadataService.GetDockerfileTemplateMetadata()
-	impl.WriteJsonResp(w, nil, dockerfileTemplateMetadata, http.StatusOK)
+	handler.WriteJsonResp(w, nil, dockerfileTemplateMetadata, http.StatusOK)
 	return
 }
 func (impl *RestHandlerImpl) GetBuildpackMetadata(w http.ResponseWriter, r *http.Request) {
 	impl.logger.Debug("get all buildpack metadata")
-	setupResponse(&w, r)
+	handler.SetupCorsOriginHeader(&w, r)
 	buildpackMetadata := impl.ciBuildMetadataService.GetBuildpackMetadata()
-	impl.WriteJsonResp(w, nil, buildpackMetadata, http.StatusOK)
+	handler.WriteJsonResp(w, nil, buildpackMetadata, http.StatusOK)
 	return
 }
 

api/Router.go

@@ -18,30 +18,37 @@ package api
 
 import (
 	"encoding/json"
-	"github.com/devtron-labs/central-api/common"
+	"github.com/devtron-labs/central-api/api/currency"
+	"github.com/devtron-labs/central-api/api/handler"
 	"github.com/gorilla/mux"
 	"go.uber.org/zap"
 	"net/http"
 )
 
 type MuxRouter struct {
-	logger      *zap.SugaredLogger
-	Router      *mux.Router
-	restHandler RestHandler
+	logger         *zap.SugaredLogger
+	Router         *mux.Router
+	restHandler    RestHandler
+	currencyRouter currency.Router
 }
 
-func NewMuxRouter(logger *zap.SugaredLogger, restHandler RestHandler) *MuxRouter {
-	return &MuxRouter{logger: logger, Router: mux.NewRouter(), restHandler: restHandler}
+func NewMuxRouter(logger *zap.SugaredLogger, restHandler RestHandler, currencyRouter currency.Router) *MuxRouter {
+	return &MuxRouter{
+		logger:         logger,
+		Router:         mux.NewRouter(),
+		restHandler:    restHandler,
+		currencyRouter: currencyRouter,
+	}
 }
 
 func (r MuxRouter) Init() {
 	r.Router.StrictSlash(true)
 	//r.Router.Handle("/metrics", promhttp.Handler())
 	r.Router.Path("/health").HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
-		setupResponse(&writer, request)
+		handler.SetupCorsOriginHeader(&writer, request)
 		writer.Header().Set("Content-Type", "application/json")
 		writer.WriteHeader(200)
-		response := common.Response{}
+		response := handler.Response{}
 		response.Code = 200
 		response.Result = "OK"
 		b, err := json.Marshal(response)
@@ -61,4 +68,9 @@ func (r MuxRouter) Init() {
 	r.Router.Path("/module").
 		Queries("name", "{name}").
 		HandlerFunc(r.restHandler.GetModuleByName).Methods("GET")
+
+	// Create a sub-router for currency endpoints
+	currencyRouter := r.Router.PathPrefix("/currency").Subrouter()
+	// Initialize currency routes
+	r.currencyRouter.InitCurrencyRoutes(currencyRouter)
 }