Merge pull request #97 from wongjn/use-vscode-globalState

Refactor extension state persistence

Author: felipecaputo

src/config.js

@@ -39,6 +39,10 @@ class Config {
         this.supportsSVN = vscodeConfig.get('supportsSVN', false);
         this.displayProjectPath = vscodeConfig.get('displayProjectPath', false);
     }
+
+    get(param, defaultValue = undefined) {
+        return this.hasOwnProperty(param) ? this[param] : defaultValue;
+    }
 }
 
 module.exports = Config;

src/extension.js

@@ -4,11 +4,11 @@ const vscode = require('vscode');
 const ProjectManager = require('./gitProjectManager');
 const Config = require('./config');
 const cfg = new Config(vscode.workspace.getConfiguration('gitProjectManager'))
-const projectManager = new ProjectManager(cfg);
 
 // this method is called when your extension is activated
 // your extension is activated the very first time the command is executed
 function activate(context) {
+    const projectManager = new ProjectManager(cfg, context.globalState);
 
     let disposable = vscode.commands.registerCommand('gitProjectManager.openProject', function () {
         projectManager.showProjectList(false);

src/gitProjectManager.js

@@ -1,5 +1,3 @@
-const EXTENSION_NAME = 'gitProjectManager';
-
 const fs = require('fs');
 const vscode = require('vscode');
 const path = require('path');
@@ -18,32 +16,18 @@ class GitProjectManager {
      * Creates an instance of GitProjectManager.
      *
      * @param {object} config
+     * @param {Memento} state
      */
-    constructor(config) {
+    constructor(config, state) {
         this.config = config;
+        this.state = state;
         this.loadedRepoListFromFile = false;
         this.repoList = [];
         this.storedLists = new Map();
-        this.baseDir = this.getBaseDir();
-        this.gpmRepoListFile = path.join(this.baseDir, this.getChannelPath(), "User/gpm_projects.json");
-        this.recentList = new RecentItems(path.join(this.baseDir, this.getChannelPath(), "User/"));
-        this.recentList.listSize = vscode.workspace.getConfiguration(EXTENSION_NAME).get('gitProjectManager.recentProjectsListSize', 5);
+        this.recentList = new RecentItems(this.state, this.config.get('gitProjectManager.recentProjectsListSize', 5));
 
         this.updateRepoList = this.updateRepoList.bind(this);
         this.addRepoInRepoList = this.addRepoInRepoList.bind(this);
-
-    }
-    /**
-     * Get the base user cfg directory
-     *
-     * @returns {string}
-     */
-    getBaseDir() {
-        if (process.platform == "linux") {
-            return path.join(os.homedir(), '.config');
-        } else {
-            return process.env.APPDATA || (process.platform === 'darwin' ? process.env.HOME + '/Library/Application Support' : '/var/local');
-        }
     }
     getQuickPickList() {
         this.repoList = this.repoList.sort((a, b) => {
@@ -77,47 +61,40 @@ class GitProjectManager {
     get storeDataBetweenSessions() {
         return this.config.storeRepositoriesBetweenSessions;
     }
-    saveListToDisc() {
+    saveList() {
         if (!this.storeDataBetweenSessions)
             return;
 
-        let lists = {};
-        this.storedLists.forEach((value, key) => { lists[key] = value })
-        fs.writeFileSync(this.gpmRepoListFile, JSON.stringify(lists), {
-            encoding: 'utf8'
-        });
+        const lists = Array.from(this.storedLists.entries()).reduce(
+            (storage, [hash, repos]) => ({ ...storage, [hash]: repos }),
+            {},
+        );
+        this.state.update('lists', lists);
     }
-    loadlListFromDisc() {
+    loadList() {
         if (!this.storeDataBetweenSessions)
             return false;
 
-        if (!fs.existsSync(this.gpmRepoListFile))
-            return false;
-
-        let list = JSON.parse(fs.readFileSync(this.gpmRepoListFile, 'utf8'));
-        if (list instanceof Array) {
-            fs.unlinkSync(this.gpmRepoListFile);
+        const list = this.state.get('lists', false);
+        if (!list)
             return false;
-        }
 
-        this.storedLists = new Map();
-        for (let key in list)
-            this.storedLists.set(key, list[key]);
+        this.storedLists = new Map(Array.from(Object.entries(list)));
 
         this.loadedRepoListFromFile = true;
         return true;
     }
     saveRepositoryInfo(directories) {
         this.storedLists.set(this.getDirectoriesHash(directories), this.repoList);
-        this.saveListToDisc();
+        this.saveList();
     }
 
     loadRepositoryInfo() {
         if (this.loadedRepoListFromFile) {
             return false;
         }
 
-        return this.loadlListFromDisc();
+        return this.loadList();
     }
 
     addRepoInRepoList(repoInfo) {

src/recentItems.js

@@ -1,39 +1,14 @@
-const path = require('path');
-const fs = require('fs');
-
-
-const RECENT_FILE_NAME = 'gpm-recentItems.json';
-
 class RecentItems {
     /**
      * Creates an instance of RecentItems.
-     * 
-     * @param {string} pathToSave Path where the RecentItems file will be saved
-     */
-    constructor(pathToSave) {
-        this.pathToSave = pathToSave;
-        this.listSize = 5;
-        this.list = [];
-        this.loadFromFile();
-    }
-    /**
-     * Returns the full path to recent projects file
-     * 
-     * @returns {string}
+     *
+     * @param {Memento} state Global extension state.
+     * @param {number} [listSize=5] Recent items list size.
      */
-    getPathToFile() {
-        return path.join(this.pathToSave, RECENT_FILE_NAME);
-    }
-    loadFromFile() {
-        const filePath = this.getPathToFile();
-        if (fs.existsSync(filePath) && typeof filePath !== 'undefined') {
-            this.list = JSON.parse(fs.readFileSync(filePath, 'utf8'));
-        }
-    }
-    saveToFile() {
-        fs.writeFileSync(this.getPathToFile(), JSON.stringify(this.list), {
-            encoding: 'utf8'
-        });
+    constructor(state, listSize = 5) {
+        this.state = state;
+        this.listSize = listSize;
+        this.list = this.state.get('recent', []);
     }
     addProject(projectPath, gitRepo) {
         const idx = this.list.findIndex(p => p.projectPath === projectPath);
@@ -48,7 +23,7 @@ class RecentItems {
         };
 
         this.sortList();
-        this.saveToFile();
+        this.state.update('recent', this.list);
     }
     sortList() {
         this.list = this.list.sort((a, b) => b.lastUsed - a.lastUsed);

test/gitProjectManager.test.js

@@ -6,8 +6,8 @@ const vscode = require('vscode');
 
 const ProjectManager = require('../src/gitProjectManager');
 const Config = require('../src/config');
-const config = new Config();
-const projectManager = new ProjectManager(config)
+const StateMock = require('./stateMock');
+const projectManager = new ProjectManager(new Config(), new StateMock());
 
 describe("gitProjectManager", function () {
     var sandbox;

test/recentItems.test.js

@@ -2,12 +2,10 @@
 
 const RecentItems = require('../src/recentItems');
 const expect = require('chai').expect;
-const path = require('path');
-const fs = require('fs');
 const rmdir = require('rmdir');
 const sinon = require('sinon');
 
-const TESTING_PATH = path.join(__dirname, 'recents');
+const StateMock = require('./stateMock');
 
 function addProjectsToList(recentList, size) {
     switch (size) {
@@ -27,19 +25,10 @@ function addProjectsToList(recentList, size) {
 }
 
 describe('RecentItems', () => {
-    let recentItems = new RecentItems(TESTING_PATH);
+    let recentItems;
 
     beforeEach(() => {
-        if (fs.existsSync(TESTING_PATH)) {
-            fs.rmdirSync(TESTING_PATH);
-        }
-        fs.mkdirSync(TESTING_PATH);
-        recentItems = new RecentItems(TESTING_PATH);
-
-    });
-
-    afterEach((done) => {
-        rmdir(TESTING_PATH, {}, () => done())
+        recentItems = new RecentItems(new StateMock());
     });
 
     it('should start with an empty list', () => {
@@ -53,7 +42,7 @@ describe('RecentItems', () => {
 
     it('should load projects on create', () => {
         addProjectsToList(recentItems, 2);
-        const secondInstance = new RecentItems(TESTING_PATH);
+        const secondInstance = new RecentItems(recentItems.state);
         expect(secondInstance.list.length).to.be.equals(2);
     })
 

test/stateMock.js

@@ -0,0 +1,11 @@
+module.exports = class {
+    constructor() {
+        this.data = {};
+    }
+    get(key, defaultValue = undefined) {
+        return this.data.hasOwnProperty(key) ? this.data[key] : defaultValue;
+    }
+    async update(key, value) {
+        this.data[key] = value;
+    }
+}