handle invalid session (#556)

* handle invalid session

* yarn lock cleanup

* move last time notified to session authenticate

Author: xavluiz

.gitignore

@@ -3,3 +3,5 @@ node_modules
 .DS_Store
 lib/Constants.ts.local
 dist/
+.env.local
+.vscode-test/**

.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'dist/test/**/*.test.js',
+});

.vscode/launch.json

@@ -44,10 +44,10 @@
             "runtimeExecutable": "${execPath}",
             "args": [
                 "--extensionDevelopmentPath=${workspaceFolder}",
-                "--extensionTestsPath=${workspaceFolder}/out/test"
+                "--extensionTestsPath=${workspaceFolder}/dist/test/suite/index"
             ],
             "outFiles": [
-                "${workspaceFolder}/out/test/**/*.js"
+                "${workspaceFolder}/dist/test/**/*.js"
             ],
             "preLaunchTask": "npm: test-compile"
         }
@@ -57,8 +57,8 @@
             "name": "Multiple Extensions",
             // Launch 2 debugger extensions at once
             "configurations": [
-                "Launch Extension",
-                "Launch Extension"
+                "Launch Extension Prod",
+                "Launch Extension Prod"
             ]
         }
     ]

.vscodeignore

@@ -3,6 +3,7 @@ typings/**
 test/**
 **/*.ts
 **/*.map
+**/*.js.map
 .gitignore
 .github/**
 *.vsix

package.json

@@ -1,7 +1,7 @@
 {
   "name": "swdc-vscode",
   "displayName": "Code Time",
-  "version": "2.8.9",
+  "version": "2.8.11",
   "publisher": "softwaredotcom",
   "description": "Code Time is an open source plugin that provides programming metrics right in Visual Studio Code.",
   "author": {
@@ -52,7 +52,8 @@
     "watch:extension": "tsc -watch -p ./",
     "watch:views": "webpack --watch --mode development",
     "vscode:prepublish": "webpack --mode production",
-    "test-compile": "tsc -p ./"
+    "test-compile": "tsc -p ./",
+    "test": "tsc -p ./ & vscode-test"
   },
   "contributes": {
     "commands": [
@@ -133,7 +134,13 @@
     "ts-loader": "^9.2.6",
     "typescript": "^5.4.5",
     "webpack": "^5.94.0",
-    "webpack-cli": "^4.10.0"
+    "webpack-cli": "^4.10.0",
+    "@vscode/test-cli": "^0.0.11",
+    "@vscode/test-electron": "^2.5.2",
+    "mocha": "^11.7.1",
+    "@types/sinon": "^17.0.4",
+    "sinon": "^21.0.0",
+    "dotenv": "^17.2.0"
   },
   "dependencies": {
     "@swdotcom/editor-flow": "1.1.3",

src/DataController.ts

@@ -77,6 +77,7 @@ export async function authenticationCompleteHandler(user: any, override_jwt: any
     if (authProvider) {
       authProvider.updateSession(getItem('jwt'), user);
     }
+    setItem('lastTimeInvalidSessionNotified', 0);
     // update the login status
     showInformationMessage('Successfully logged on to Code Time');
 

src/auth/AuthProvider.ts

@@ -1,7 +1,8 @@
 import {
   authentication, AuthenticationProvider, AuthenticationProviderAuthenticationSessionsChangeEvent,
-  AuthenticationSession, Disposable, Event, env, EventEmitter, ExtensionContext, ProgressLocation,
-  Uri, UriHandler, window
+  Disposable, Event, env, EventEmitter, ExtensionContext, ProgressLocation,
+  Uri, UriHandler, window,
+  AuthenticationSession
 } from "vscode";
 import { v4 as uuid } from 'uuid';
 import { app_url } from "../Constants";

src/command-helper.ts

@@ -61,7 +61,6 @@ export function createCommands(
   cmds.push(
     commands.registerCommand('codetime.toggleStatusBar', () => {
       toggleStatusBar();
-      commands.executeCommand('codetime.refreshCodeTimeView');
     })
   );
 

src/extension.ts

@@ -78,19 +78,18 @@ export async function activate(ctx: ExtensionContext) {
   // session: {id: <String>, accessToken: <String>, account: {label: <String>, id: <Number>}, scopes: [<String>,...]}
   const session = await authentication.getSession(AUTH_TYPE, [], { createIfNone: false });
   let jwt = getItem('jwt');
-  user = await getUser();
-  if (session) {
-    // fetch the user with the non-session jwt to compare
-    if (!user || user.email != session.account.label) {
-      jwt = session.accessToken;
-      // update the local storage with the new user
-      setItem('name', session.account.label);
-      setItem('jwt', jwt);
-      user = await getUser(jwt);
+  if (session?.accessToken) {
+    jwt = session.accessToken;
+    // update local storage with the session information
+    setItem('name', session.account.label);
+    setItem('jwt', jwt);
+    // cache the user based on the session jwt
+    await getUser(jwt);
+  } else if (jwt) {
+    const user = await getUser(jwt);
+    if (user?.registered) {
+      authProvider.updateSession(jwt, user);
     }
-  } else if (jwt && user?.registered) {
-    // update the session with the existing jwt
-    authProvider.updateSession(jwt, user);
   }
 
   if (jwt) {

src/http/HttpClient.ts

@@ -1,6 +1,6 @@
 import axios from 'axios';
-import { version, window } from 'vscode';
-import { app_url } from '../Constants';
+import { commands, version, window } from 'vscode';
+import { app_url, ONE_MIN_MILLIS } from '../Constants';
 import {
   logIt,
   getPluginId,
@@ -9,7 +9,8 @@ import {
   getOs,
   getPluginUuid,
   getItem,
-  setItem
+  setItem,
+  isPrimaryWindow
 } from '../Util';
 
 // build the axios client
@@ -28,6 +29,8 @@ const appApi: any = axios.create({
   }
 });
 
+let invalidSessionNotified: boolean = false;
+
 // Evaluate these headers on every request since these values can change
 async function dynamicHeaders(override_token?: string) {
   let headers: any = {
@@ -50,11 +53,25 @@ async function dynamicHeaders(override_token?: string) {
 }
 
 export async function appGet(api: string, queryParams: any = {}, token_override: any = '') {
-  return await appApi.get(api, { params: queryParams, headers: await dynamicHeaders(token_override) }).catch((err: any) => {
+  const headers = await dynamicHeaders(token_override);
+  if (!headers['Authorization'] && isPrimaryWindow()) {
+    const currentTime = Date.now();
+    const lastTimeInvalidSessionNotified = Number(getItem('lastTimeInvalidSessionNotified') || 0);
+    if (!invalidSessionNotified && (currentTime - lastTimeInvalidSessionNotified > ONE_MIN_MILLIS * 60 * 24)) {
+      logIt(`No authorization token found for GET ${api}. Please ensure you are logged in.`);
+      invalidSessionNotified = true;
+      setItem('lastTimeInvalidSessionNotified', currentTime);
+      await invalidSessionPrompt();
+    }
+    return;
+  }
+  return await appApi.get(api, { params: queryParams, headers: headers }).then((resp: any) => {
+    return resp;
+  }).catch((err: any) => {
     logIt(`error for GET ${api}, message: ${err.message}`);
     if (getResponseStatus(err?.response) === 401) {
       // clear the JWT because it is invalid
-      setItem('jwt', null)
+      setItem('jwt', null);
     }
     return err;
   });
@@ -103,7 +120,7 @@ export function isResponseOk(resp: any) {
   return false;
 }
 
-function getResponseStatus(resp: any) {
+export function getResponseStatus(resp: any) {
   let status = null;
   if (resp?.status) {
     status = resp.status;
@@ -113,10 +130,23 @@ function getResponseStatus(resp: any) {
     status = 500;
   } else if (resp?.code === 'ECONNREFUSED') {
     status = 503;
+  } else if (resp?.code === 'ENOTFOUND') {
+    status = 404;
   }
   return status;
 }
 
+async function invalidSessionPrompt() {
+  const selection = await window.showInformationMessage(
+    "We couldn't verify your session. Please log in again to continue using Code Time features",
+    { modal: true },
+    ...['Login']
+  );
+  if (selection === 'Login') {
+    commands.executeCommand('codetime.login');
+  }
+}
+
 async function getAuthorization() {
   const token = getItem('jwt');