Merge pull request #287 from Power-Maverick/copilot/fix-connection-timeout-indicator

Fix: Add visual indicators and notifications for expired connection tokens

Author: Power-Maverick

resources/dark/dataverse-expired.svg

@@ -111,6 +111,16 @@ export async function registerCommands(vscontext: vscode.ExtensionContext, tr: T
                 }
             },
         },
+        {
+            command: "dvdt.explorer.connections.updateStatusBar",
+            callback: (conn: IConnection | undefined) => {
+                try {
+                    updateConnectionStatusBar(conn);
+                } catch (error) {
+                    errorHandler.log(error, "updateStatusBar");
+                }
+            },
+        },
         {
             command: "dvdt.explorer.entities.showEntityDetails",
             callback: async (enItem: EntitiesTreeItem) => {
@@ -313,7 +323,12 @@ export async function registerCommands(vscontext: vscode.ExtensionContext, tr: T
  */
 export function updateConnectionStatusBar(conn: IConnection | undefined): void {
     if (conn) {
-        dvStatusBarItem.text = conn.userName ? `Connected to: ${conn.environmentUrl} as ${conn.userName}` : `Connected to: ${conn.environmentUrl}`;
+        const isExpired = conn.tokenExpiresAt ? Date.now() >= conn.tokenExpiresAt : false;
+        const statusIcon = isExpired ? "$(warning)" : "$(plug)";
+        const statusSuffix = isExpired ? " (Token Expired)" : "";
+        dvStatusBarItem.text = conn.userName 
+            ? `${statusIcon} Connected to: ${conn.environmentUrl} as ${conn.userName}${statusSuffix}` 
+            : `${statusIcon} Connected to: ${conn.environmentUrl}${statusSuffix}`;
         dvStatusBarItem.show();
     } else {
         dvStatusBarItem.hide();

resources/light/dataverse-expired.svg

@@ -15,6 +15,10 @@ const extensionVersion = extension.packageJSON.version;
 // telemetry reporter
 let reporter: TelemetryReporter;
 
+// Token expiration check interval (in milliseconds) - check every 60 seconds
+const TOKEN_CHECK_INTERVAL = 60000;
+let tokenExpirationTimer: NodeJS.Timeout | undefined;
+
 // this method is called when your extension is activated
 // your extension is activated the very first time the command is executed
 export function activate(context: vscode.ExtensionContext) {
@@ -29,6 +33,9 @@ export function activate(context: vscode.ExtensionContext) {
     registerTreeDataProviders(context, reporter);
     registerCommands(context, reporter);
 
+    // Start periodic token expiration check
+    startTokenExpirationCheck(context);
+
     let dataverseToolsPublicApi = {
         currentConnectionToken() {
             const dvHelper = new DataverseHelper(context);
@@ -41,5 +48,57 @@ export function activate(context: vscode.ExtensionContext) {
 
 // this method is called when your extension is deactivated
 export function deactivate() {
+    if (tokenExpirationTimer) {
+        clearInterval(tokenExpirationTimer);
+    }
     reporter.dispose();
 }
+
+/**
+ * Start periodic token expiration check
+ */
+function startTokenExpirationCheck(context: vscode.ExtensionContext) {
+    let lastNotifiedExpiration = false;
+    
+    tokenExpirationTimer = setInterval(() => {
+        const dvHelper = new DataverseHelper(context);
+        const isExpired = dvHelper.isCurrentConnectionTokenExpired();
+        
+        if (isExpired && !lastNotifiedExpiration) {
+            // Get current connection to create tree item for reconnect
+            const conn = dvHelper.getCurrentWorkspaceConnection();
+            
+            // Show notification to user
+            vscode.window.showWarningMessage(
+                "Your Dataverse connection token has expired. Please reconnect to continue working.",
+                "Reconnect"
+            ).then(selection => {
+                if (selection === "Reconnect" && conn) {
+                    // Create a tree item with the connection name to pass to the command
+                    const connItem = {
+                        label: conn.connectionName,
+                        desc: conn.userName,
+                        collapsibleState: vscode.TreeItemCollapsibleState.Collapsed,
+                        level: 2,
+                        current: true,
+                        expired: true
+                    };
+                    vscode.commands.executeCommand("dvdt.explorer.connections.connectDataverse", connItem);
+                }
+            });
+            
+            lastNotifiedExpiration = true;
+            
+            // Refresh the connection tree to show expired icon
+            vscode.commands.executeCommand("dvdt.explorer.connections.refreshConnection");
+            
+            // Update status bar to show expired state
+            if (conn) {
+                vscode.commands.executeCommand("dvdt.explorer.connections.updateStatusBar", conn);
+            }
+        } else if (!isExpired) {
+            // Reset notification flag when token is refreshed
+            lastNotifiedExpiration = false;
+        }
+    }, TOKEN_CHECK_INTERVAL);
+}

src/commands/registerCommands.ts

@@ -66,6 +66,8 @@ export class DataverseHelper {
                 if (tokenResponse) {
                     conn.currentAccessToken = tokenResponse.access_token!;
                     conn.refreshToken = tokenResponse.refresh_token!;
+                    // Set token expiration timestamp (expires_in is in seconds, convert to milliseconds)
+                    conn.tokenExpiresAt = Date.now() + (tokenResponse.expires_in * 1000);
                     this.vsstate.saveInWorkspace(connectionCurrentStoreKey, conn);
                 }
             }
@@ -132,6 +134,8 @@ export class DataverseHelper {
                                 break;
                         }
                         conn.refreshToken = tokenResponse.refresh_token!;
+                        // Set token expiration timestamp (expires_in is in seconds, convert to milliseconds)
+                        conn.tokenExpiresAt = Date.now() + (tokenResponse.expires_in * 1000);
                     } else {
                         vscode.window.showErrorMessage("Unable to connect to Dataverse. Please try again.");
                         return undefined;
@@ -180,6 +184,15 @@ export class DataverseHelper {
         return undefined;
     }
 
+    /**
+     * Get the current workspace connection without reloading data.
+     * @returns The connection object.
+     */
+    public getCurrentWorkspaceConnection(): IConnection | undefined {
+        const connFromWS: IConnection = this.vsstate.getFromWorkspace(connectionCurrentStoreKey);
+        return connFromWS;
+    }
+
     /**
      * Get the current access token from the current connection.
      * @returns The current access token.
@@ -189,6 +202,19 @@ export class DataverseHelper {
         return connFromWS.currentAccessToken;
     }
 
+    /**
+     * Check if the current connection's token is expired.
+     * @returns True if the token is expired, false otherwise.
+     */
+    public isCurrentConnectionTokenExpired(): boolean {
+        const connFromWS: IConnection = this.vsstate.getFromWorkspace(connectionCurrentStoreKey);
+        if (connFromWS && connFromWS.tokenExpiresAt) {
+            return Date.now() >= connFromWS.tokenExpiresAt;
+        }
+        // If no expiration time is set, assume it's not expired for backward compatibility
+        return false;
+    }
+
     /**
      * Get the entty definition from the current connection.
      */
@@ -428,6 +454,8 @@ export class DataverseHelper {
         if (tokenResponse) {
             currentConnection.currentAccessToken = tokenResponse.access_token;
             currentConnection.refreshToken = tokenResponse.refresh_token;
+            // Set token expiration timestamp (expires_in is in seconds, convert to milliseconds)
+            currentConnection.tokenExpiresAt = Date.now() + (tokenResponse.expires_in * 1000);
         }
 
         this.vsstate.saveInWorkspace(connectionCurrentStoreKey, currentConnection);