Merge pull request #355 from CatalystCode/itye/create-persistent-folder

Itye/create persistent folder

README.md

@@ -5,6 +5,15 @@
 [Ibex](http://aka.ms/ibex) is a dashboarding application that enables building dashboard and templates.
 It mainly supports **Application Insights** but data sources and visual components are easily extendable.
 
+## Changes
+
+### Version 1.2 (October 16, 2017)
+Version 1.2 breaks the persitency paths of dashboard files and custom templates. If you are upgrading to this version, copy your private dashboards from `/dashboards` into `/dashboards/persistent/` as follows: 
+
+> Private Files: Move files from `/dashboards/*.private.js` to `/dashboards/persistent/private`.
+
+> Custom Templates: Move files from `/dashboards/customTemplates/*.private.ts` to `/dashboards/persistent/customTemplates`.
+
 # Preview
 
 [![Preview](/docs/images/bot-fmk-dashboard.png)](/docs/images/bot-fmk-dashboard.png)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibex-dashboard",
-  "version": "0.1.0",
+  "version": "1.2.0",
   "private": true,
   "dependencies": {
     "npm-run-all": "^4.0.2"

server/routes/api.js

@@ -46,9 +46,9 @@ const getMetadata = (text) => {
 }
 
 const paths = () => ({
-  privateDashboard: path.join(__dirname, '..', 'dashboards'),
+  privateDashboard: path.join(__dirname, '..', 'dashboards','persistent','private'),
   preconfDashboard: path.join(__dirname, '..', 'dashboards', 'preconfigured'),
-  privateTemplate: path.join(__dirname, '..', 'dashboards', 'customTemplates')
+  privateTemplate: path.join(__dirname, '..', 'dashboards','persistent', 'customTemplates')
 });
 
 const isValidFile = (filePath) => {
@@ -63,8 +63,12 @@ const getFileContents = (filePath) => {
     : contents;
 }
 
-const ensureCustomTemplatesFolderExists = () => {
-  const { privateTemplate } = paths();
+const ensureCustomFoldersExists = () => {
+  const { privateTemplate, privateDashboard } = paths();
+
+  if (!fs.existsSync(privateDashboard)) {
+    fs.mkdirSync(privateDashboard);
+  }
 
   if (!fs.existsSync(privateTemplate)) {
     fs.mkdirSync(privateTemplate);
@@ -72,7 +76,7 @@ const ensureCustomTemplatesFolderExists = () => {
 }
 
 router.get('/dashboards', (req, res) => {
-
+  ensureCustomFoldersExists();
   const { privateDashboard, preconfDashboard, privateTemplate } = paths();
 
   let script = '';
@@ -134,7 +138,6 @@ router.get('/dashboards', (req, res) => {
     });
   }
 
-  ensureCustomTemplatesFolderExists();
   let customTemplates = fs.readdirSync(privateTemplate);
   if (customTemplates && customTemplates.length) {
     customTemplates.forEach((fileName) => {
@@ -195,7 +198,7 @@ router.get('/dashboards/:id*', (req, res) => {
 router.post('/dashboards/:id', (req, res) => {
   let { id } = req.params;
   let { script } = req.body || '';
-
+  ensureCustomFoldersExists();
   const { privateDashboard } = paths();
   let dashboardFile = getFileById(privateDashboard, id);
   let filePath = path.join(privateDashboard, dashboardFile);
@@ -213,7 +216,7 @@ router.post('/dashboards/:id', (req, res) => {
 router.get('/templates/:id', (req, res) => {
 
   let templateId = req.params.id;
-  let templatePath = path.join(__dirname, '..', 'dashboards', 'preconfigured');
+  let templatePath = paths().preconfDashboard;
 
   let script = '';
 
@@ -221,7 +224,7 @@ router.get('/templates/:id', (req, res) => {
 
   if (!templateFile) {
     //fallback to custom template
-    templatePath = path.join(__dirname, '..', 'dashboards', 'customTemplates');
+    templatePath = paths().privateTemplate;
     templateFile = getFileById(templatePath, templateId);
   }
   if (templateFile) {
@@ -254,7 +257,7 @@ router.put('/templates/:id', (req, res) => {
 
   const { privateTemplate } = paths();
 
-  ensureCustomTemplatesFolderExists();
+  ensureCustomFoldersExists();
 
   let templatePath = path.join(privateTemplate, id + '.private.ts');
   let templateFile = getFileById(privateTemplate, id);