Merge pull request #221 from Rakshitha-D/connector_list

#OBS-I145: Connector Read api
Sanketika-Obsrv · Aug 1, 2024 · 508c9b2 · 508c9b2
2 parents 5fe497b + bed4798
commit 508c9b2
Show file tree

Hide file tree

Showing 6 changed files with 549 additions and 94 deletions.
diff --git a/api-service/postman-collection/updated_v2_collection.json b/api-service/postman-collection/updated_v2_collection.json
diff --git a/api-service/src/controllers/ConnectorsList/ConnectorsList.ts b/api-service/src/controllers/ConnectorsList/ConnectorsList.ts
@@ -7,7 +7,7 @@ import { ResponseHandler } from "../../helpers/ResponseHandler";
 import httpStatus from "http-status";
 import { connectorService } from "../../services/ConnectorService";
 
-const defaultFields = ["id", "connector_id", "name", "type", "category", "version", "description", "technology", "runtime", "licence", "owner", "iconurl", "status", "created_by", "updated_by", "created_date", "updated_date"];
+const defaultFields = ["id", "connector_id", "name", "type", "category", "version", "description", "technology", "runtime", "licence", "owner", "iconurl", "status", "created_by", "updated_by", "created_date", "updated_date", "live_date"];
 
 const validateRequest = (req: Request) => {
     const isRequestValid: Record<string, any> = schemaValidation(req.body, ConnectorListSchema)

diff --git a/api-service/src/controllers/ConnectorsRead/ConnectorsRead.ts b/api-service/src/controllers/ConnectorsRead/ConnectorsRead.ts
@@ -0,0 +1,22 @@
+import { Request, Response } from "express";
+import { obsrvError } from "../../types/ObsrvError";
+import { ResponseHandler } from "../../helpers/ResponseHandler";
+import httpStatus from "http-status";
+import { connectorService } from "../../services/ConnectorService";
+import _ from "lodash";
+
+const defaultFields = ["id", "connector_id", "name", "type", "category", "version", "description", "licence", "owner", "iconurl", "status", "ui_spec", "created_by", "updated_by", "created_date", "updated_date", "live_date"];
+
+const connectorsRead = async (req: Request, res: Response) => {
+    const { id } = req.params;
+    const { mode } = req.query;
+    const isEditMode = _.toLower(_.toString(mode)) === "edit"
+    const status = isEditMode ? "Draft" : "Live"
+    const connector = await connectorService.getConnector({ id, status }, defaultFields)
+    if (!connector) {
+        throw obsrvError("", "CONNECTOR_NOT_FOUND", `Connector not found: ${id}`, "NOT_FOUND", 404);
+    }
+    ResponseHandler.successResponse(req, res, { status: httpStatus.OK, data: connector });
+}
+
+export default connectorsRead;
diff --git a/api-service/src/routes/Router.ts b/api-service/src/routes/Router.ts
@@ -25,6 +25,7 @@ import datasetReset from "../controllers/DatasetReset/DatasetReset";
 import DatasetExport from "../controllers/DatasetExport/DatasetExport";
 import DatasetCopy from "../controllers/DatasetCopy/DatasetCopy";
 import ConnectorsList from "../controllers/ConnectorsList/ConnectorsList";
+import ConnectorsRead from "../controllers/ConnectorsRead/ConnectorsRead";
 import DatasetImport from "../controllers/DatasetImport/DatasetImport";
 
 export const router = express.Router();
@@ -51,6 +52,7 @@ router.post("/datasets/dataschema", setDataToRequestObject("api.datasets.datasch
 router.get("/datasets/export/:dataset_id", setDataToRequestObject("api.datasets.export"), onRequest({ entity: Entity.Management }), DatasetExport);
 router.post("/datasets/copy", setDataToRequestObject("api.datasets.copy"), onRequest({ entity: Entity.Management }), DatasetCopy);
 router.post("/connectors/list", setDataToRequestObject("api.connectors.list"), onRequest({ entity: Entity.Management }), ConnectorsList);
+router.get("/connectors/read/:id", setDataToRequestObject("api.connectors.read"), onRequest({entity: Entity.Management }), ConnectorsRead);
 router.post("/datasets/import", setDataToRequestObject("api.datasets.import"), onRequest({ entity: Entity.Management }), DatasetImport);
 
 //Wrapper Service

diff --git a/api-service/src/services/ConnectorService.ts b/api-service/src/services/ConnectorService.ts
@@ -2,10 +2,14 @@ import { ConnectorRegistry } from "../models/ConnectorRegistry";
 
 class ConnectorService {
 
-    findConnectors = async (where?: Record<string, any>, attributes?: string[]): Promise<any> => {
+    findConnectors = (where?: Record<string, any>, attributes?: string[]): Promise<any> => {
         return ConnectorRegistry.findAll({ where, attributes, raw: true });
     }
 
+    getConnector = (where?: Record<string, any>, attributes?: string[]): Promise<any> => {
+        return ConnectorRegistry.findOne({ where, attributes, raw: true });
+    }
+
 }
 
 export const connectorService = new ConnectorService();