Add GRPC integration to simulation services

Author: Gutierrez, Andres

.env

@@ -1,17 +1,20 @@
-# GQL SETTINGS
-GQL_PORT=4000
-
-# REST RESOURCES
-BASE_BACKEND_URL=http://localhost:5000/api/v1
-
-# DATABASE
-MONGO_URL=mongodb://localhost:27017
-MONGO_DB=MOCK
-COLLECTION_RESPONSE=responses
-COLLECTION_API=apis
-COLLECTION_DEVICE=devices
-
-# Docker
-IMAGE_NAME=mock-gql
-CONTAINER_NAME=mock-gql-container
-
+# GQL SETTINGS
+GQL_PORT=4000
+
+# REST RESOURCES
+BASE_BACKEND_URL=http://localhost:5000/api/v1
+
+# DATABASE
+MONGO_URL=mongodb://localhost:27017
+MONGO_DB=MOCK
+COLLECTION_RESPONSE=responses
+COLLECTION_API=apis
+COLLECTION_DEVICE=devices
+
+# Docker
+IMAGE_NAME=mock-gql
+CONTAINER_NAME=mock-gql-container
+
+# Protocol Buffers
+PROTOCOL_BUFFER_SERVER=localhost:5001
+

package-lock.json

@@ -19,6 +19,7 @@
   },
   "homepage": "https://github.com/andru1236/mock-gateway#readme",
   "dependencies": {
+    "@grpc/proto-loader": "^0.6.1",
     "apollo-server": "^2.21.1",
     "apollo-server-express": "^2.21.1",
     "body-parser": "^1.19.0",
@@ -30,6 +31,7 @@
     "graphql-tag": "^2.11.0",
     "graphql-tools": "^7.0.4",
     "graphql-type-json": "^0.3.2",
+    "grpc": "^1.24.3",
     "mongodb": "^3.6.5",
     "node-fetch": "^2.6.1",
     "winston": "^3.3.3",

package.json

@@ -36,11 +36,18 @@ class GatewayError extends ApolloError {
   }
 }
 
+class SimulatorError extends Error {
+  constructor(message) {
+    super(message, "SIMULATOR_ERRORS")
+  }
+}
+
 export const errors = {
   DatabaseError,
   ResponseError,
   NoFoundError,
   LegacyErrorSystem,
   LegacyBadRequestError,
   GatewayError,
+  SimulatorError
 };

src/infrastructure/errors/customErrors.js

@@ -1,6 +1,8 @@
+import { ApolloError } from "apollo-server-errors";
 import { errors } from "./customErrors";
 import { logger } from "../logger";
 
+// TODO: Segregate the error handler based on the architecture layer
 export const errorHandler = (error) => {
   logger.error(error.message);
   if (error instanceof errors.DatabaseError) {
@@ -21,9 +23,12 @@ export const errorHandler = (error) => {
   if (error instanceof errors.LegacyErrorSystem) {
     throw new error.GatewayError(error.message);
   }
+  if (error instanceof errors.SimulatorError) {
+    return false;
+  }
   if (error instanceof Error) {
     logger.error(`Critical ${error.message}`);
-    throw error;
+    throw new ApolloError(error.message, "ERROR_APOLLO");
   }
 };
 

src/infrastructure/errors/errorHandler.js

@@ -0,0 +1,18 @@
+import grpc from "grpc";
+import protoLoader from "@grpc/proto-loader";
+import { logger } from "../logger";
+
+// The file is generated for the backend, this client just should copy the proto and build it
+const PROTO_PATH = `${process.cwd()}/src/infrastructure/protocol_buffer/protos/simulator_services.proto`;
+logger.info(`loading file: ${PROTO_PATH}`);
+
+const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
+  keepCase: true,
+  longs: String,
+  enums: String,
+  defaults: true,
+  oneofs: true,
+});
+logger.info(`The gRPC client classes was created successfull`);
+
+export const grpc_services = grpc.loadPackageDefinition(packageDefinition);

src/infrastructure/protocol_buffer/client_grpc.js

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+
+message EntityId {
+    string id = 1;
+}
+
+message DbAgent {
+    string dbAgent=1;
+}
+
+
+message Response {
+    bool sucessfull = 1;
+    string message = 2;
+}
+
+service Simulator {
+    rpc startDeviceSimulation(EntityId) returns (Response);
+    rpc stopDeviceSimulation(EntityId) returns (Response);
+    rpc fixDbAgent(DbAgent) returns (DbAgent);
+}

src/infrastructure/protocol_buffer/protos/simulator_services.proto

@@ -0,0 +1,56 @@
+import grpc from "grpc";
+import readEnv from "../readEnv";
+import { grpc_services } from "./client_grpc";
+import { logger } from "../logger";
+
+readEnv();
+
+const PROTOCOL_BUFFER_SERVER = process.env.PROTOCOL_BUFFER_SERVER;
+
+export const client_for_simulator = new grpc_services.Simulator(
+  PROTOCOL_BUFFER_SERVER,
+  grpc.credentials.createInsecure()
+);
+
+export const grpcStartSimulation = (id) => {
+  return new Promise((resolve, reject) => {
+    client_for_simulator.startDeviceSimulation({ id }, (err, grpcResponse) => {
+      if (err) {
+        logger.error("Problems to start simulation");
+        resolve(false);
+      }
+      logger.debug(`Response: ${JSON.stringify(grpcResponse)}`);
+      return grpcResponse?.sucessfull
+        ? resolve(grpcResponse.sucessfull)
+        : resolve(false);
+    });
+  });
+};
+
+export const grpcStopSimulation = async (id) => {
+  return new Promise((resolve, reject) => {
+    client_for_simulator.stopDeviceSimulation({ id }, (err, grpcResponse) => {
+      if (err) {
+        logger.error("Problems to stop simulation");
+        resolve(false);
+      }
+      logger.debug(`Response: ${JSON.stringify(grpcResponse)}`);
+      return grpcResponse?.sucessfull
+        ? resolve(grpcResponse.sucessfull)
+        : resolve(false);
+    });
+  });
+};
+
+export const grpcFixDbAgent = async (dbAgent) => {
+  return new Promise((resolve, reject) => {
+    client_for_simulator.fixDbAgent({ dbAgent }, (error, response) => {
+      if (error) {
+        logger.error("Problems to fix the db Agent simulation");
+        reject(dbAgent);
+      }
+      logger.debug(`No errors`);
+      response?.dbAgent ? resolve(response.dbAgent): reject(dbAgent);
+    });
+  });
+};

src/infrastructure/protocol_buffer/simulator_client.js

@@ -1,32 +1,56 @@
-import { logger } from "../../infrastructure";
-import dal from "./dal";
-
-const createDevice = async (_, args) => {
-  logger.info("Executing MUTATION| createDevice");
-  const { name, port, agentDb } = args;
-  await dal.saveDevice(name, port, agentDb);
-  return true;
-};
-
-const updateDevice = async (_, args, { loaders }) => {
-  logger.info("Executing MUTATION| UpdateDevice");
-  const { deviceId, name, port, agentDb } = args;
-  await dal.updateDevice(deviceId, name, port, agentDb);
-  const deviceObj = await dal.searchOneDevice(deviceId);
-  await loaders.devices.prime(deviceId, deviceObj[0]);
-  return true;
-};
-
-const removeDevice = async (_, args, { loaders }) => {
-  logger.info("Executing MUTATION| removeDevice");
-  const { deviceId } = args;
-  await dal.removeDevice(deviceId);
-  await loaders.devices.clear(deviceId);
-  return true;
-};
-
-export default {
-  createDevice,
-  updateDevice,
-  removeDevice,
-};
+import {
+  grpcStopSimulation,
+  grpcStartSimulation,
+  grpcFixDbAgent,
+} from "../../infrastructure/protocol_buffer/simulator_client";
+
+import { logger } from "../../infrastructure";
+import dal from "./dal";
+
+const createDevice = async (_, args) => {
+  logger.info("Executing MUTATION| createDevice");
+  const { name, port, agentDb } = args;
+  await dal.saveDevice(name, port, agentDb);
+  return true;
+};
+
+const updateDevice = async (_, args, { loaders }) => {
+  logger.info("Executing MUTATION| UpdateDevice");
+  const { deviceId, name, port, agentDb } = args;
+  await dal.updateDevice(deviceId, name, port, agentDb);
+  const deviceObj = await dal.searchOneDevice(deviceId);
+  await loaders.devices.prime(deviceId, deviceObj[0]);
+  return true;
+};
+
+const removeDevice = async (_, args, { loaders }) => {
+  logger.info("Executing MUTATION| removeDevice");
+  const { deviceId } = args;
+  await dal.removeDevice(deviceId);
+  await loaders.devices.clear(deviceId);
+  return true;
+};
+
+const startSimulation = async (_, { deviceId }) => {
+  logger.info("Executing MUTATION| startSimulation");
+  return await grpcStartSimulation(deviceId);
+};
+
+const stopSimulation = async (_, { deviceId }) => {
+  logger.info("Executing MUTATION| stopSimulation");
+  return await grpcStopSimulation(deviceId);
+};
+
+const fixAgentDb = async (_, { agentDb }) => {
+  logger.info("Executing MUTATION| fixAgent");
+  return await grpcFixDbAgent(agentDb);
+};
+
+export default {
+  createDevice,
+  updateDevice,
+  removeDevice,
+  startSimulation,
+  stopSimulation,
+  fixAgentDb,
+};