systemview-plugin 1.0.0 → 1.1.1

package/SystemViewModule.js

@@ -1,13 +1,24 @@
 const fs = require("fs");
-const getAllTests = require("./getAllTest");
-
-module.exports = (specs, projectCode, serviceId, helperMethods = {}) => {
+const {
+  deleteFile,
+  getFile,
+  ensureDir,
+  getName,
+  getFilesByNamespace,
+} = require("./utils");
+module.exports = ({ App, specs, projectCode, serviceId, module = {} }) => {
   specs = specs.substr(-1) === "/" ? specs.substr(0, specs.length - 1) : specs;
-
+  const system = {};
+  App.on("ready", (_system) => {
+    system.connectionData = _system.connectionData;
+    system.modules = _system.modules;
+    system.routing = _system.routing;
+    system.services = _system.services;
+  });
   return function SystemViewPlugin() {
     const { SystemView } = this.useService("SystemView");
-    Object.assign(this, helperMethods);
 
+    Object.assign(this, module);
     this.saveDoc = ({ documentation, namespace }) => {
       const fileName = `${specs}/docs/${getName(namespace)}.md`;
       ensureDir(`${specs}/docs/`);
@@ -33,9 +44,9 @@ module.exports = (specs, projectCode, serviceId, helperMethods = {}) => {
         const tests = JSON.parse(getFile(fileName) || "[]");
         return tests;
       } else if (moduleName) {
-        return getAllTests(`${specs}/tests/`, moduleName);
+        return getFilesByNamespace(`${specs}/tests/`, moduleName);
       } else {
-        return getAllTests(`${specs}/tests/`);
+        return getFilesByNamespace(`${specs}/tests/`);
       }
     };
     this.saveTest = (test, index) => {
@@ -66,32 +77,9 @@ module.exports = (specs, projectCode, serviceId, helperMethods = {}) => {
       docs: fs.readdirSync(`${specs}/docs/`),
       tests: fs.readdirSync(`${specs}/tests/`),
     });
+    this.getConnection = () => {
+      const specList = this.getSpecList();
+      return { projectCode, serviceId, system, specList };
+    };
   };
-
-  function deleteFile(fileName) {
-    try {
-      console.log(fileName);
-      fs.unlinkSync(fileName);
-    } catch (err) {
-      // console.error(err);
-    }
-  }
-  function getFile(fileName) {
-    try {
-      return fs.readFileSync(fileName, "utf8");
-    } catch (error) {
-      // console.log(error);
-    }
-  }
-  function ensureDir(dir) {
-    if (!fs.existsSync(dir)) {
-      fs.mkdirSync(dir, { recursive: true });
-    }
-  }
-
-  function getName({ serviceId, moduleName, methodName }) {
-    if (methodName) return `${moduleName}.${methodName}`;
-    else if (moduleName) return moduleName;
-    else if (serviceId) return serviceId;
-  }
 };

package/index.js

@@ -1,40 +1,38 @@
 const SystemViewModule = require("./SystemViewModule");
-const fs = require("fs");
+const { getSpecList } = require("./utils");
 
-function ensureDir(dir) {
-  if (!fs.existsSync(dir)) {
-    fs.mkdirSync(dir, { recursive: true });
-  }
-}
-
-const getSpecList = (specs) => {
-  ensureDir(`${specs}/docs/`);
-  ensureDir(`${specs}/tests/`);
-  return {
-    docs: fs.readdirSync(`${specs}/docs/`),
-    tests: fs.readdirSync(`${specs}/tests/`),
-  };
-};
 module.exports = function ({
   connection = "http://localhost:3300/systemview/api",
   specs = "./specs",
   projectCode,
   serviceId,
-  helperMethods,
+  module,
 }) {
   return function (App) {
     App.loadService("SystemView", connection)
-      .module("Plugin", SystemViewModule(specs, projectCode, serviceId, helperMethods))
-      .on("ready", async function connectSystemView(system) {
-        try {
-          const { SystemView } = this.useService("SystemView");
-          const specList = getSpecList(specs);
-          console.log("reconnection");
-          await SystemView.connect({ system, projectCode, serviceId, specList });
-          // SystemView.on("reconnect", connectSystemView.bind(this, system));
-        } catch (error) {
-          console.log("SystemView connection failed---->", error);
+      .module(
+        "Plugin",
+        SystemViewModule({
+          specs,
+          App,
+          projectCode,
+          serviceId,
+          module,
+        })
+      )
+      .on(
+        "ready",
+        async function connectSystemView({ connectionData, modules, routing, services }) {
+          const system = { connectionData, modules, routing, services };
+          try {
+            const { SystemView } = this.useService("SystemView");
+            const specList = getSpecList(specs);
+            await SystemView.connect({ system, projectCode, serviceId, specList });
+            console.log(`[SystemView]: ${projectCode}.${serviceId} connected!\n`);
+          } catch (error) {
+            console.log(`[SystemView]: ${projectCode}.${serviceId} connection failed\n`);
+          }
         }
-      });
+      );
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "systemview-plugin",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Connects your SystemLynx project to the SystemView UI",
   "main": "index.js",
   "scripts": {
@@ -18,5 +18,13 @@
   "bugs": {
     "url": "https://github.com/Odion100/systemview-plugin/issues"
   },
-  "homepage": "https://github.com/Odion100/systemview-plugin#readme"
+  "homepage": "https://github.com/Odion100/systemview-plugin#readme",
+  "devDependencies": {
+    "cz-conventional-changelog": "^3.3.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  }
 }

package/utils.js

@@ -0,0 +1,70 @@
+const fs = require("fs");
+const path = require("path");
+
+function deleteFile(fileName) {
+  try {
+    console.log(fileName);
+    fs.unlinkSync(fileName);
+  } catch (err) {
+    // console.error(err);
+  }
+}
+function getFile(fileName) {
+  try {
+    return fs.readFileSync(fileName, "utf8");
+  } catch (error) {
+    // console.log(error);
+  }
+}
+function ensureDir(dir) {
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+}
+
+function getName({ serviceId, moduleName, methodName }) {
+  if (methodName) return `${moduleName}.${methodName}`;
+  else if (moduleName) return moduleName;
+  else if (serviceId) return serviceId;
+}
+
+function getFilesByNamespace(folder, namespace) {
+  const files = fs.readdirSync(folder); // read the contents of the current directory
+  const namespacePattern = namespace
+    ? new RegExp(`^${namespace}\\..+\\.json$`)
+    : /\.json$/;
+
+  return files
+    .filter((file) => namespacePattern.test(file))
+    .reduce((sum, file) => {
+      const filePath = path.join(folder, file);
+      const fileContents = fs.readFileSync(filePath, "utf-8");
+      const parsedData = JSON.parse(fileContents);
+
+      return sum.concat(parsedData);
+    }, []);
+}
+
+function ensureDir(dir) {
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+}
+
+const getSpecList = (specs) => {
+  ensureDir(`${specs}/docs/`);
+  ensureDir(`${specs}/tests/`);
+  return {
+    docs: fs.readdirSync(`${specs}/docs/`),
+    tests: fs.readdirSync(`${specs}/tests/`),
+  };
+};
+
+module.exports = {
+  deleteFile,
+  getFile,
+  getName,
+  getFilesByNamespace,
+  getSpecList,
+  ensureDir,
+};

package/getAllTest.js

@@ -1,21 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-
-module.exports = function getFilesByNamespace(folder, namespace) {
-  const files = fs.readdirSync(folder); // read the contents of the current directory
-  const namespacePattern = namespace
-    ? new RegExp(`^${namespace}\\..+\\.json$`)
-    : /\.json$/;
-
-  return files
-    .filter((file) => namespacePattern.test(file))
-    .reduce((sum, file) => {
-      const filePath = path.join(folder, file);
-      const fileContents = fs.readFileSync(filePath, "utf-8");
-      const parsedData = JSON.parse(fileContents);
-
-      return sum.concat(parsedData);
-    }, []);
-};
-
-// no namespace passed, return all files