fix: JS console may contain xtermjs error messages when sidecar is minimized

Fixes #5454

Author: starpit

packages/core/src/core/events.ts

@@ -36,6 +36,9 @@ eventChannelUnsafe.setMaxListeners(100)
 
 export default eventChannelUnsafe
 
+export type TabLayoutChangeEvent = { isSidecarNowHidden: boolean }
+type TabLayoutChangeHandler = (evt: TabLayoutChangeEvent) => void
+
 class EventBusBase {
   protected readonly eventBus: EventEmitter
 
@@ -59,8 +62,8 @@ class WriteEventBus extends EventBusBase {
     this.eventBus.emit('/tab/switch/split', tab)
   }
 
-  public emitTabLayoutChange(tabUUID: string): void {
-    setTimeout(() => this.eventBus.emit(`/tab/layout/change/${tabUUID}`))
+  public emitTabLayoutChange(tabUUID: string, evt: TabLayoutChangeEvent = { isSidecarNowHidden: false }): void {
+    setTimeout(() => this.eventBus.emit(`/tab/layout/change/${tabUUID}`, evt))
   }
 
   private emitCommandEvent(which: 'start' | 'complete', event: CommandStartEvent | CommandCompleteEvent) {
@@ -158,11 +161,11 @@ class ReadEventBus extends WriteEventBus {
     this.eventBus.off('/tab/switch/split', listener)
   }
 
-  public onTabLayoutChange(tabUUID: string, listener: () => void): void {
+  public onTabLayoutChange(tabUUID: string, listener: TabLayoutChangeHandler): void {
     this.eventBus.on(`/tab/layout/change/${tabUUID}`, listener)
   }
 
-  public offTabLayoutChange(tabUUID: string, listener: () => void): void {
+  public offTabLayoutChange(tabUUID: string, listener: TabLayoutChangeHandler): void {
     this.eventBus.off(`/tab/layout/change/${tabUUID}`, listener)
   }
 

packages/core/src/index.ts

@@ -71,7 +71,13 @@ export { isUsageError, UsageError, UsageModel, UsageRow } from './core/usage-err
 export { isMessageWithUsageModel, isMessageWithCode } from './core/usage-error'
 
 // eventChannelUnsafe
-export { default as eventChannelUnsafe, wireToTabEvents, wireToStandardEvents, eventBus } from './core/events'
+export {
+  default as eventChannelUnsafe,
+  wireToTabEvents,
+  wireToStandardEvents,
+  eventBus,
+  TabLayoutChangeEvent
+} from './core/events'
 
 // i18n
 export { fromMap as i18nFromMap, default as i18n } from './util/i18n'

plugins/plugin-client-common/src/components/Client/TabContent.tsx

@@ -250,7 +250,7 @@ export default class TabContent extends React.PureComponent<Props, State> {
 
   private onWillChangeSize(desiredWidth: Width) {
     this.setState(curState => {
-      eventBus.emitTabLayoutChange(curState.tab.uuid)
+      eventBus.emitTabLayoutChange(curState.tab.uuid, { isSidecarNowHidden: desiredWidth === Width.Closed })
 
       const sidecarWidth = desiredWidth
 

plugins/plugin-client-common/src/components/Content/Editor/index.tsx

@@ -27,6 +27,7 @@ import {
   ToolbarText,
   ToolbarProps,
   MultiModalResponse,
+  TabLayoutChangeEvent,
   eventChannelUnsafe,
   eventBus,
   i18n
@@ -293,8 +294,10 @@ export default class Editor extends React.PureComponent<Props, State> {
       eventChannelUnsafe.on('/zoom', onZoom)
       cleaners.push(() => eventChannelUnsafe.off('/zoom', onZoom))
 
-      const onTabLayoutChange = () => {
-        editor.layout()
+      const onTabLayoutChange = (evt: TabLayoutChangeEvent) => {
+        if (!evt.isSidecarNowHidden) {
+          editor.layout()
+        }
       }
       eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange)
       cleaners.push(() => eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange))

plugins/plugin-kubectl/src/lib/view/modes/ExecIntoPod.tsx

@@ -25,6 +25,7 @@ import {
   ToolbarText,
   i18n,
   getPrimaryTabId,
+  TabLayoutChangeEvent,
   eventBus,
   eventChannelUnsafe
 } from '@kui-shell/core'
@@ -141,12 +142,13 @@ export class Terminal<S extends TerminalState = TerminalState> extends Container
     eventChannelUnsafe.on(focusOffEvent, xoff)
     this.cleaners.push(() => eventChannelUnsafe.off(focusOffEvent, xoff))
 
-    const resizeListener = this.onResize.bind(this)
+    const resizeListener = this.onWindowResize.bind(this)
     window.addEventListener('resize', resizeListener)
     this.cleaners.push(() => window.removeEventListener('resize', resizeListener))
 
-    eventBus.onTabLayoutChange(uuid, resizeListener)
-    this.cleaners.push(() => eventBus.offTabLayoutChange(uuid, resizeListener))
+    const layoutListener = this.onTabLayoutChange.bind(this)
+    eventBus.onTabLayoutChange(uuid, layoutListener)
+    this.cleaners.push(() => eventBus.offTabLayoutChange(uuid, layoutListener))
   }
 
   /** Which container should we focus on by default? */
@@ -233,12 +235,18 @@ export class Terminal<S extends TerminalState = TerminalState> extends Container
     }
   }
 
-  private onResize() {
+  private onWindowResize() {
     if (this.state.xterm) {
       this.state.doResize()
     }
   }
 
+  private onTabLayoutChange(evt: TabLayoutChangeEvent) {
+    if (this.state.xterm && !evt.isSidecarNowHidden) {
+      this.state.doResize()
+    }
+  }
+
   /** When we are going away, make sure to abort the streaming job. */
   public componentWillUnmount() {
     this._unmounted = true

plugins/plugin-kubectl/src/lib/view/modes/logs.tsx

@@ -98,6 +98,9 @@ export class Logs extends Terminal<State> {
 
     if (!msgAndType) {
       return
+    } else if (!msgAndType[status]) {
+      console.error(`Unknown streaming status: ${status}`)
+      return
     }
 
     const msg1 = msgAndType[status].message