Combine LT Session Status bar items into a single one

Author: Keegan Irby

packages/core/src/awsService/cloudWatchLogs/commands/tailLogGroup.ts

@@ -71,7 +71,7 @@ async function prepareDocument(session: LiveTailSession): Promise<vscode.TextDoc
     await clearDocument(textDocument)
     await vscode.window.showTextDocument(textDocument, { preview: false })
     await vscode.languages.setTextDocumentLanguage(textDocument, 'log')
-    session.showStatusBarItems()
+    session.showStatusBarItem()
     return textDocument
 }
 
@@ -164,48 +164,44 @@ function trimOldestLines(
 }
 
 function updateStatusBarItemsOnStreamEvent(session: LiveTailSession, event: LiveTailSessionUpdate) {
-    updateIsSampledStatusBar(session.statusBarItems.isSampled, event)
-    updateEventRateStatusBar(session.statusBarItems.eventRate, event)
+    updateIsSampled(session, event)
+    updateEventRate(session, event)
 }
 
-function updateIsSampledStatusBar(isSampledStatusBarItem: vscode.StatusBarItem, event: LiveTailSessionUpdate) {
+function updateIsSampled(session: LiveTailSession, event: LiveTailSessionUpdate) {
     let isSampled: boolean
     //sessionMetadata is expected to always be present on a LiveTail stream update
     if (event.sessionMetadata === undefined || event.sessionMetadata.sampled === undefined) {
         isSampled = false
     } else {
         isSampled = event.sessionMetadata.sampled
     }
-    isSampledStatusBarItem.text = `Sampled: ${isSampled ? 'Yes' : 'No'}`
-    return isSampledStatusBarItem
+    session.isSampled = isSampled
 }
 
-function updateEventRateStatusBar(eventRateStatusBarItem: vscode.StatusBarItem, event: LiveTailSessionUpdate) {
+function updateEventRate(session: LiveTailSession, event: LiveTailSessionUpdate) {
     let numEvents
     if (event.sessionResults === undefined) {
         numEvents = 0
     } else {
         numEvents = event.sessionResults.length
     }
-    eventRateStatusBarItem.text = `${numEvents} events/sec.`
-    return eventRateStatusBarItem
+    session.eventRate = numEvents
 }
 
 function hideShowStatusBarItemsOnActiveEditor(session: LiveTailSession, document: vscode.TextDocument) {
     vscode.window.onDidChangeActiveTextEditor((editor) => {
         if (editor?.document === document) {
-            session.showStatusBarItems()
+            session.showStatusBarItem()
         } else {
-            session.hideStatusBarItems()
+            session.hideStatusBarItem()
         }
     })
 }
 
 function startSessionTimer(session: LiveTailSession): NodeJS.Timer {
     return globals.clock.setInterval(() => {
-        const elapsedTime = session.getLiveTailSessionDuration()
-        const timeString = convertToTimeString(elapsedTime)
-        session.statusBarItems.sessionTimer.text = `LiveTail Session Timer: ${timeString}`
+        session.updateStatusBarItemText()
     }, 500)
 }
 

packages/core/src/awsService/cloudWatchLogs/registry/liveTailSession.ts

@@ -10,16 +10,10 @@ import {
 } from '@aws-sdk/client-cloudwatch-logs'
 import { LogStreamFilterResponse } from '../wizard/liveTailLogStreamSubmenu'
 import { CloudWatchLogsSettings } from '../cloudWatchLogsUtils'
-import { Settings, ToolkitError } from '../../../shared'
+import { convertToTimeString, Settings, ToolkitError } from '../../../shared'
 import { createLiveTailURIFromArgs } from './liveTailSessionRegistry'
 import { getUserAgent } from '../../../shared/telemetry/util'
 
-export type LiveTailSessionStatusBarItems = {
-    isSampled: vscode.StatusBarItem
-    eventRate: vscode.StatusBarItem
-    sessionTimer: vscode.StatusBarItem
-}
-
 export type LiveTailSessionConfiguration = {
     logGroupName: string
     logStreamFilter?: LogStreamFilterResponse
@@ -39,9 +33,11 @@ export class LiveTailSession {
     private logEventFilterPattern?: string
     private _maxLines: number
     private _uri: vscode.Uri
-    private _statusBarItems: LiveTailSessionStatusBarItems
+    private statusBarItem: vscode.StatusBarItem
     private startTime: number | undefined
     private endTime: number | undefined
+    private _eventRate: number
+    private _isSampled: boolean
 
     static settings = new CloudWatchLogsSettings(Settings.instance)
 
@@ -57,7 +53,9 @@ export class LiveTailSession {
         }
         this._maxLines = LiveTailSession.settings.get('limit', 10000)
         this._uri = createLiveTailURIFromArgs(configuration)
-        this._statusBarItems = this.createStatusBarItems()
+        this.statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 0)
+        this._eventRate = 0
+        this._isSampled = false
     }
 
     public get maxLines() {
@@ -72,8 +70,12 @@ export class LiveTailSession {
         return this._logGroupName
     }
 
-    public get statusBarItems(): LiveTailSessionStatusBarItems {
-        return this._statusBarItems
+    public set eventRate(rate: number) {
+        this._eventRate = rate
+    }
+
+    public set isSampled(isSampled: boolean) {
+        this._isSampled = isSampled
     }
 
     public async startLiveTailSession(): Promise<AsyncIterable<StartLiveTailResponseStream>> {
@@ -95,7 +97,7 @@ export class LiveTailSession {
 
     public stopLiveTailSession() {
         this.endTime = Date.now()
-        this.disposeStatusBarItems()
+        this.statusBarItem.dispose()
         this.liveTailClient.abortController.abort()
         this.liveTailClient.cwlClient.destroy()
     }
@@ -133,29 +135,18 @@ export class LiveTailSession {
         })
     }
 
-    private createStatusBarItems(): LiveTailSessionStatusBarItems {
-        return {
-            sessionTimer: vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 0),
-            eventRate: vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 1),
-            isSampled: vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 2),
-        }
-    }
-
-    public showStatusBarItems() {
-        this.statusBarItems.eventRate.show()
-        this.statusBarItems.isSampled.show()
-        this.statusBarItems.sessionTimer.show()
+    public showStatusBarItem() {
+        this.statusBarItem.show()
     }
 
-    public hideStatusBarItems() {
-        this.statusBarItems.eventRate.hide()
-        this.statusBarItems.isSampled.hide()
-        this.statusBarItems.sessionTimer.hide()
+    public hideStatusBarItem() {
+        this.statusBarItem.hide()
     }
 
-    private disposeStatusBarItems() {
-        this.statusBarItems.eventRate.dispose()
-        this.statusBarItems.isSampled.dispose()
-        this.statusBarItems.sessionTimer.dispose()
+    public updateStatusBarItemText() {
+        const elapsedTime = this.getLiveTailSessionDuration()
+        const timeString = convertToTimeString(elapsedTime)
+        const sampledString = this._isSampled ? 'Yes' : 'No'
+        this.statusBarItem.text = `Tailing Session: ${timeString}, ${this._eventRate} events/sec, Sampled: ${sampledString}`
     }
 }