feat: support default path environment variable

Composer/packages/client/src/CreationFlow/LocationBrowser/LocationSelectContent.tsx

@@ -7,22 +7,18 @@ import path from 'path';
 import { jsx } from '@emotion/core';
 import { Fragment, useEffect, useState, useContext, useRef } from 'react';
 
-import storage from '../../utils/storage';
-
 import { FileSelector } from './FileSelector';
 import { StoreContext } from './../../store';
 import { FileTypes } from './../../constants';
 
-const NEW_BOT_LOCATION_KEY = 'newBotLocation';
-
 export function LocationSelectContent(props) {
   const { state, actions } = useContext(StoreContext);
   const { storages, focusedStorageFolder, storageFileLoadingStatus } = state;
   const { onOpen, onChange, allowOpeningBot = true } = props;
 
   const { fetchFolderItemsByPath } = actions;
   const currentStorageIndex = useRef(0);
-  const [currentPath, setCurrentPath] = useState(storage.get(NEW_BOT_LOCATION_KEY, ''));
+  const [currentPath, setCurrentPath] = useState('');
   const currentStorageId = storages[currentStorageIndex.current] ? storages[currentStorageIndex.current].id : 'default';
 
   useEffect(() => {
@@ -39,6 +35,7 @@ export function LocationSelectContent(props) {
       // const formatedPath = path.normalize(newPath.replace(/\\/g, '/'));
       const formatedPath = path.normalize(newPath);
       await fetchFolderItemsByPath(storageId, formatedPath);
+      await actions.updateCurrentPath(formatedPath);
       setCurrentPath(formatedPath);
     }
   };
@@ -48,7 +45,7 @@ export function LocationSelectContent(props) {
     let path = currentPath;
     let id = '';
     if (storages[index]) {
-      path = path || storages[index].path;
+      path = storages[index].path;
       id = storages[index].id;
     }
     updateCurrentPath(path, id);
@@ -58,7 +55,6 @@ export function LocationSelectContent(props) {
     if (onChange) {
       onChange(currentPath);
     }
-    storage.set(NEW_BOT_LOCATION_KEY, currentPath);
   }, [currentPath]);
 
   const onSelectionChanged = item => {

Composer/packages/client/src/store/action/storage.ts

@@ -93,3 +93,7 @@ export const fetchFolderItemsByPath: ActionCreator = async ({ dispatch }, id, pa
     });
   }
 };
+
+export const updateCurrentPath: ActionCreator = async ({ dispatch }, path) => {
+  await httpClient.put(`/storages/currentPath`, { path: path });
+};

Composer/packages/server/__tests__/services/project.test.ts

@@ -16,6 +16,7 @@ jest.mock('../../src/store/store', () => {
         name: 'This PC',
         type: 'LocalDisk',
         path: '.',
+        defaultPath: '.',
       },
     ],
     recentBotProjects: [] as any[],

Composer/packages/server/__tests__/services/storage.test.ts

@@ -24,6 +24,7 @@ jest.mock('../../src/store/store', () => {
       name: 'This PC',
       type: 'LocalDisk',
       path: '.',
+      defaultPath: '.',
     },
   ];
   return {

Composer/packages/server/src/controllers/storage.ts

@@ -15,6 +15,11 @@ function createStorageConnection(req: Request, res: Response) {
   res.status(200).json(StorageService.getStorageConnections());
 }
 
+function updateCurrentPath(req: Request, res: Response) {
+  StorageService.updateCurrentPath(req.body.path);
+  res.status(200).json('success');
+}
+
 async function getBlob(req: Request, res: Response) {
   const storageId = req.params.storageId;
   const reqpath = decodeURI(req.params.path);
@@ -34,4 +39,5 @@ export const StorageController = {
   getStorageConnections,
   createStorageConnection,
   getBlob,
+  updateCurrentPath,
 };

Composer/packages/server/src/router/api.ts

@@ -32,6 +32,7 @@ router.post('/projects/opened/project/saveAs', ProjectController.saveProjectAs);
 router.get('/projects/recent', ProjectController.getRecentProjects);
 
 // storages
+router.put('/storages/currentPath', StorageController.updateCurrentPath);
 router.get('/storages', StorageController.getStorageConnections);
 router.post('/storages', StorageController.createStorageConnection);
 router.get('/storages/:storageId/blobs/:path(*)', StorageController.getBlob);

Composer/packages/server/src/services/storage.ts

@@ -18,6 +18,7 @@ class StorageService {
 
   constructor() {
     this.storageConnections = Store.get(this.STORE_KEY);
+    this.ensureDefaultBotFoldersExist();
   }
 
   public getStorageClient = (storageId: string): IFileStorage => {
@@ -39,11 +40,18 @@ class StorageService {
   };
 
   public getStorageConnections = (): StorageConnection[] => {
-    return this.storageConnections.map(s => {
+    const connections = this.storageConnections.map(s => {
       const temp = Object.assign({}, s);
-      temp.path = Path.resolve(s.path); // resolve path if path is relative, and change it to unix pattern
+      // if the last accessed path exist
+      if (fs.existsSync(s.path)) {
+        temp.path = Path.resolve(s.path); // resolve path if path is relative, and change it to unix pattern
+      } else {
+        temp.path = Path.resolve(s.defaultPath);
+      }
       return temp;
     });
+    this.ensureDefaultBotFoldersExist();
+    return connections;
   };
 
   public checkBlob = async (storageId: string, filePath: string): Promise<boolean> => {
@@ -85,6 +93,17 @@ class StorageService {
     }
   };
 
+  public updateCurrentPath = (path: string) => {
+    this.storageConnections[0].path = path;
+    Store.set(this.STORE_KEY, this.storageConnections);
+  };
+
+  private ensureDefaultBotFoldersExist = () => {
+    this.storageConnections.forEach(s => {
+      this.createFolderRecurively(s.defaultPath);
+    });
+  };
+
   private isBotFolder = (path: string) => {
     // locate Main.dialog
     const mainPath = Path.join(path, 'ComposerDialogs/Main', 'Main.dialog');
@@ -119,6 +138,13 @@ class StorageService {
     const result = await Promise.all(children);
     return result.filter(item => !!item);
   };
+
+  private createFolderRecurively = (path: string) => {
+    if (!fs.existsSync(path)) {
+      this.createFolderRecurively(Path.dirname(path));
+      fs.mkdirSync(path);
+    }
+  };
 }
 
 const service = new StorageService();

Composer/packages/server/src/store/data.template.ts

@@ -1,15 +1,33 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import path from 'path';
+import os from 'os';
+import fs from 'fs';
 
+import { Path } from '../utility/path';
+
+let defaultPath = process.env.DEFAULT_PATH;
+if (defaultPath && defaultPath.endsWith(':')) {
+  defaultPath = defaultPath + '/';
+}
+if (!defaultPath) {
+  console.log(`The default path is set to ${Path.join(os.homedir(), 'Documents', 'Composer')}`);
+  defaultPath = Path.join(os.homedir(), 'Documents', 'Composer');
+} else if (!fs.existsSync(defaultPath)) {
+  console.log(
+    `The default path ${defaultPath} does not exist. We set it to ${Path.join(os.homedir(), 'Documents', 'Composer')}`
+  );
+  defaultPath = Path.join(os.homedir(), 'Documents', 'Composer');
+}
+defaultPath = Path.resolve(defaultPath);
 export default {
   storageConnections: [
     {
       id: 'default',
       name: 'This PC',
       type: 'LocalDisk',
-      path: path.resolve(__dirname, '../../../../../MyBots'),
+      path: '', // this is used as last accessed path, if it is invalid, use defaultPath
+      defaultPath,
     },
   ],
   recentBotProjects: [],

Composer/packages/server/src/store/store.ts

@@ -4,9 +4,11 @@
 import fs from 'fs';
 import path from 'path';
 
+import set from 'lodash/set';
+import get from 'lodash/get';
+
 import localInitData from './data.template';
 import abhInitData from './abh-template.json';
-
 const isHostedInAzure = !!process.env.WEBSITE_NODE_DEFAULT_VERSION;
 const dataStorePath =
   isHostedInAzure && process.env.HOME
@@ -15,14 +17,24 @@ const dataStorePath =
 
 const initData = isHostedInAzure ? abhInitData : localInitData;
 
-// create data.json if not exits
+// create data.json if not exist
 if (!fs.existsSync(dataStorePath)) {
   fs.writeFileSync(dataStorePath, JSON.stringify(initData, null, 2) + '\n');
   if (isHostedInAzure) {
     // for some very odd reason on Azure webapp, fs.readFileSync after writeFileSync doesn't
     // always find the file, add one more io to kick the  virtual file system
     fs.appendFileSync(dataStorePath, ' ');
   }
+} else {
+  //merge data.json if exists
+  const userData = JSON.parse(fs.readFileSync(dataStorePath, 'utf-8'));
+  set(userData, 'storageConnections[0].defaultPath', get(initData, 'storageConnections[0].defaultPath', ''));
+  fs.writeFileSync(dataStorePath, JSON.stringify(userData, null, 2) + '\n');
+  if (isHostedInAzure) {
+    // for some very odd reason on Azure webapp, fs.readFileSync after writeFileSync doesn't
+    // always find the file, add one more io to kick the  virtual file system
+    fs.appendFileSync(dataStorePath, ' ');
+  }
 }
 
 interface KVStore {