plugin state removal, cleanup, and session file fix (#493)

* plugin state removal, cleanup, and session file fix

* vsix update

* update menu text to reinitialize

* update vsix

* update command to log out

* updated vsix

Author: xavluiz

package.json

@@ -1,7 +1,7 @@
 {
   "name": "swdc-vscode",
   "displayName": "Code Time",
-  "version": "2.7.10",
+  "version": "2.7.11",
   "publisher": "softwaredotcom",
   "description": "Code Time is an open source plugin that provides programming metrics right in Visual Studio Code.",
   "author": {
@@ -95,6 +95,10 @@
       {
         "command": "codetime.exitFlowMode",
         "title": "Code Time: Exit Flow Mode"
+      },
+      {
+        "command": "codetime.logout",
+        "title": "Code Time: Log out"
       }
     ],
     "configuration": [

src/DataController.ts

@@ -1,4 +1,4 @@
-import {window, commands} from 'vscode';
+import {commands} from 'vscode';
 import {isResponseOk, appGet} from './http/HttpClient';
 import {
   getItem,
@@ -7,20 +7,16 @@ import {
   logIt,
   musicTimeExtInstalled,
   editorOpsExtInstalled,
+  showInformationMessage,
 } from './Util';
 import {initializeWebsockets} from './websockets';
 import {SummaryManager} from './managers/SummaryManager';
 import { updateFlowModeStatus } from './managers/FlowManager';
-import { createAnonymousUser } from './menu/AccountManager';
-import { ExtensionManager } from './managers/ExtensionManager';
 
 let currentUser: any | null = null;
-let lastUserFetch: number = 0;
 
 export async function getCachedSlackIntegrations() {
-  if (!currentUser) {
-    currentUser = await getUser();
-  }
+  currentUser = await getCachedUser();
   if (currentUser?.integration_connections?.length) {
     return currentUser?.integration_connections?.filter(
       (integration: any) => integration.status === 'ACTIVE' && (integration.integration_type_id === 14));
@@ -40,10 +36,7 @@ export function isRegistered() {
 }
 
 export async function getUserPreferences() {
-  if (!currentUser) {
-    currentUser = await getUser();
-  }
-
+  currentUser = await getCachedUser()
   if (currentUser) {
     let prefs = currentUser.preferences;
     if (prefs && typeof prefs === 'string') {
@@ -58,11 +51,6 @@ export async function getUserPreferences() {
 }
 
 export async function getUser() {
-  const nowMillis: number = new Date().getTime();
-  if (currentUser && nowMillis - lastUserFetch < 2000) {
-    return currentUser;
-  }
-
   const resp = await appGet('/api/v1/user');
   if (isResponseOk(resp) && resp.data) {
     currentUser = resp.data;
@@ -74,8 +62,6 @@ export async function getUser() {
     } else {
       setItem('authType', 'software');
     }
-
-    lastUserFetch = nowMillis;
     return currentUser;
   }
   return null;
@@ -106,23 +92,33 @@ export async function authenticationCompleteHandler(user: any) {
     }
 
     // update the login status
-    window.showInformationMessage(`Successfully logged on to Code Time`);
+    showInformationMessage(`Successfully logged on to Code Time`);
 
-    updateFlowModeStatus();
+    await reload()
+  }
 
-    try {
-      initializeWebsockets();
-    } catch (e: any) {
-      logIt(`Failed to initialize websockets: ${e.message}`);
-    }
+  return updatedUserInfo;
+}
+
+export async function userDeletedCompletionHandler() {
+  commands.executeCommand('codetime.logout');
+}
 
-    // re-initialize user and preferences
-    await getUser();
+export async function reload() {
+  updateFlowModeStatus();
 
-    // fetch after logging on
-    SummaryManager.getInstance().updateSessionSummaryFromServer();
+  try {
+    initializeWebsockets();
+  } catch (e: any) {
+    logIt(`Failed to initialize websockets: ${e.message}`);
   }
 
+  // re-initialize user and preferences
+  await getUser();
+
+  // fetch after logging on
+  SummaryManager.getInstance().updateSessionSummaryFromServer();
+
   if (musicTimeExtInstalled()) {
     setTimeout(() => {
       commands.executeCommand("musictime.refreshMusicTimeView")
@@ -135,67 +131,5 @@ export async function authenticationCompleteHandler(user: any) {
     }, 1000);
   }
 
-  // update the extensions if its a new user
-  setTimeout(() => {
-    ExtensionManager.getInstance().initialize();
-  }, 1000);
-
   commands.executeCommand('codetime.refreshCodeTimeView');
-
-  logIt('Successfully logged on to Code Time');
-
-  return updatedUserInfo;
-}
-
-export async function userDeletedCompletionHandler() {
-  const user = await getUser();
-  if (!user?.registered) {
-    // reset the user session
-    createAnonymousUser();
-
-    // update the login status
-    window.showInformationMessage(`Successfully deleted your Code Time account`);
-
-    try {
-      initializeWebsockets();
-    } catch (e: any) {
-      logIt(`Failed to initialize websockets: ${e.message}`);
-    }
-
-    // re-initialize user and preferences
-    await getUser();
-
-    // fetch after logging on
-    SummaryManager.getInstance().updateSessionSummaryFromServer();
-
-    if (musicTimeExtInstalled()) {
-      setTimeout(() => {
-        commands.executeCommand("musictime.refreshMusicTimeView")
-      }, 1000);
-    }
-
-    if (editorOpsExtInstalled()) {
-      setTimeout(() => {
-        commands.executeCommand("editorOps.refreshEditorOpsView")
-      }, 1000);
-    }
-
-    commands.executeCommand('codetime.refreshCodeTimeView');
-
-    logIt('Successfully deleted your Code Time account');
-  }
-}
-
-export async function getCachedIntegrations(integration_type_id: number | undefined = undefined) {
-  const user = await getUser();
-  if (user?.integration_connections?.length) {
-    if (integration_type_id) {
-      return user.integration_connections.filter(
-        (integration: any) => integration.status === 'ACTIVE' && integration_type_id === integration.integration_type_id
-      );
-    } else {
-      return user.integration_connections;
-    }
-  }
-  return [];
 }

src/Util.ts

@@ -360,6 +360,7 @@ export function humanizeMinutes(min: any) {
 }
 
 export function showInformationMessage(message: string) {
+  logIt(message);
   return window.showInformationMessage(`${message}`);
 }
 

src/command-helper.ts

@@ -1,8 +1,8 @@
 import {commands, Disposable, window, ExtensionContext} from 'vscode';
-import {launchWebUrl, displayReadme, setItem} from './Util';
+import {launchWebUrl, displayReadme, setItem, showInformationMessage} from './Util';
 import {KpmManager} from './managers/KpmManager';
 import {KpmItem} from './model/models';
-import {showExistingAccountMenu, showSignUpAccountMenu} from './menu/AccountManager';
+import {createAnonymousUser, showExistingAccountMenu, showSignUpAccountMenu} from './menu/AccountManager';
 import {TrackerManager} from './managers/TrackerManager';
 import {app_url, vscode_issues_url} from './Constants';
 import {enableFlow, pauseFlow} from './managers/FlowManager';
@@ -12,10 +12,13 @@ import {toggleStatusBar, updateFlowModeStatusBar, updateStatusBarWithSummaryData
 import {launchEmailSignup, launchLogin} from './user/OnboardManager';
 import {CodeTimeView} from './sidebar/CodeTimeView';
 import { progressIt } from './managers/ProgressManager';
+import { LocalStorageManager } from './managers/LocalStorageManager';
+import { getCachedUser, reload } from './DataController';
 
 export function createCommands(
   ctx: ExtensionContext,
-  kpmController: KpmManager
+  kpmController: KpmManager,
+  storageManager: LocalStorageManager
 ): {
   dispose: () => void;
 } {
@@ -235,5 +238,22 @@ export function createCommands(
     })
   )
 
+  cmds.push(
+    commands.registerCommand('codetime.logout', async () => {
+      const user = await getCachedUser()
+      if (user?.registered) {
+        // clear the storage and recreate an anon user
+        storageManager.clearStorage();
+
+        // reset the user session
+        await createAnonymousUser();
+
+        // update the login status
+        showInformationMessage(`Successfully logged out of your Code Time account`);
+        await reload()
+      }
+    })
+  )
+
   return Disposable.from(...cmds);
 }

src/extension.ts

@@ -32,7 +32,6 @@ import {ChangeStateManager} from './managers/ChangeStateManager';
 import {initializeFlowModeState} from './managers/FlowManager';
 import { ExtensionManager } from './managers/ExtensionManager';
 import { LocalStorageManager } from './managers/LocalStorageManager';
-import { setSessionStorageManager } from './managers/FileManager';
 import { setEndOfDayNotification } from './notifications/endOfDay';
 
 let currentColorKind: number | undefined = undefined;
@@ -69,10 +68,12 @@ export async function activate(ctx: ExtensionContext) {
   initializeSession(storageManager);
 
   // add the code time commands
-  ctx.subscriptions.push(createCommands(ctx, kpmController));
+  ctx.subscriptions.push(createCommands(ctx, kpmController, storageManager));
   TrackerManager.storageMgr = storageManager;
 
-  if (getItem("jwt")) {
+  const jwt = getItem('jwt');
+
+  if (jwt) {
     intializePlugin();
   } else if (window.state.focused) {
     onboardInit(ctx, intializePlugin /*successFunction*/);
@@ -151,7 +152,6 @@ export function getCurrentColorKind() {
 }
 
 function initializeSession(storageManager: LocalStorageManager) {
-  setSessionStorageManager(storageManager);
   if (window.state.focused) {
     setItem('vscode_primary_window', getWorkspaceName());
     if (storageManager) storageManager.clearDupStorageKeys();

src/http/HttpClient.ts

@@ -24,21 +24,30 @@ const appApi: any = axios.create({
   timeout: 15000,
 });
 
-const headers = {
-  'X-SWDC-Plugin-Id': getPluginId(),
-  'X-SWDC-Plugin-Name': getPluginName(),
-  'X-SWDC-Plugin-Version': getVersion(),
-  'X-SWDC-Plugin-OS': getOs(),
-  'X-SWDC-Plugin-TZ': Intl.DateTimeFormat().resolvedOptions().timeZone,
-  'X-SWDC-Plugin-Offset': getOffsetSeconds() / 60,
-  'X-SWDC-Plugin-UUID': getPluginUuid(),
-  'X-SWDC-Plugin-Type': 'codetime',
-  'X-SWDC-Plugin-Editor': 'vscode',
-  'X-SWDC-Plugin-Editor-Version': version
-};
-
-beApi.defaults.headers.common = { ...beApi.defaults.headers.common, ...headers };
-appApi.defaults.headers.common = { ...appApi.defaults.headers.common, ...headers };
+function initializeHeaders() {
+  if (appApi.defaults.headers.common['X-SWDC-Plugin-Id']) {
+    return
+  }
+
+  const headers = {
+    'X-SWDC-Plugin-Id': getPluginId(),
+    'X-SWDC-Plugin-Name': getPluginName(),
+    'X-SWDC-Plugin-Version': getVersion(),
+    'X-SWDC-Plugin-OS': getOs(),
+    'X-SWDC-Plugin-TZ': Intl.DateTimeFormat().resolvedOptions().timeZone,
+    'X-SWDC-Plugin-Offset': getOffsetSeconds() / 60,
+    'X-SWDC-Plugin-UUID': getPluginUuid(),
+    'X-SWDC-Plugin-Type': 'codetime',
+    'X-SWDC-Plugin-Editor': 'vscode',
+    'X-SWDC-Plugin-Editor-Version': version
+  };
+  
+  beApi.defaults.headers.common = { ...beApi.defaults.headers.common, ...headers };
+  appApi.defaults.headers.common = { ...appApi.defaults.headers.common, ...headers };
+
+  beApi.defaults.headers.common = { ...beApi.defaults.headers.common, ...headers };
+  appApi.defaults.headers.common = { ...appApi.defaults.headers.common, ...headers };
+}
 
 export async function appGet(api: string, queryParams: any = {}) {
   updateOutgoingHeader();
@@ -133,6 +142,7 @@ export function isResponseOk(resp: any) {
 }
 
 function updateOutgoingHeader(override_token: any = null) {
+  initializeHeaders()
   const token = getAuthorization();
   if (token || override_token) {
     if (override_token) {

src/managers/FileManager.ts

@@ -1,24 +1,16 @@
-import { getFileNameFromPath, getSoftwareSessionFile, logIt } from '../Util';
+import { getFileNameFromPath, logIt } from '../Util';
 import { LocalStorageManager } from './LocalStorageManager';
 
 const fs = require('fs');
 const path = require('path');
 
 let storageMgr: LocalStorageManager | undefined = undefined;
 
-export function setSessionStorageManager(storageManager: LocalStorageManager) {
-  storageMgr = storageManager;
-
-  // convert old storage to new storage if needed
-  if (!storageMgr?.getValue('session_converion_complete')) {
-    const sessionJson = getFileDataAsJson(getSoftwareSessionFile());
-    if (sessionJson) {
-      for (const key in sessionJson) {
-        storageMgr?.setValue(`session_${key}`, sessionJson[key]);
-      }
-    }
-    storageManager?.setValue('session_converion_complete', 'true')
+function getStorageManager() {
+  if (!storageMgr) {
+    storageMgr = LocalStorageManager.getCachedStorageManager()
   }
+  return storageMgr
 }
 
 export function getBooleanJsonItem(file: string, key: string) {
@@ -31,12 +23,11 @@ export function getBooleanJsonItem(file: string, key: string) {
 }
 
 export function getJsonItem(file: string, key: string, defaultValue: any = '') {
-  return storageMgr?.getValue(`${getFileNameFromPath(file)}_${key}`) || defaultValue;
+  return getStorageManager()?.getValue(`${getFileNameFromPath(file)}_${key}`) || defaultValue;
 }
 
 export function setJsonItem(file: string, key: string, value: any) {
-  const new_key = `${getFileNameFromPath(file)}_${key}`;
-  storageMgr?.setValue(new_key, value);
+  getStorageManager()?.setValue(`${getFileNameFromPath(file)}_${key}`, value);
 }
 
 export function getFileDataAsJson(filePath: string): any {