feat: improve vnc console

Signed-off-by: Andy Lee <andy.lee@suse.com>

package.json

@@ -7,6 +7,7 @@
   },
   "dependencies": {
     "@babel/plugin-transform-class-static-block": "7.29.7",
+    "@novnc/novnc": "1.7.0",
     "@rancher/shell": "3.0.13",
     "@vue-flow/background": "^1.3.0",
     "@vue-flow/controls": "^1.1.1",
@@ -27,6 +28,7 @@
     "yaml": "^2.5.1"
   },
   "resolutions": {
+    "@novnc/novnc": "1.7.0",
     "@types/node": "25.9.5",
     "cronstrue": "2.59.0",
     "d3-color": "3.1.0",

pkg/harvester/components/novnc/NovncConsole.vue

@@ -1,64 +1,99 @@
-<template>
-  <div>
-    <div v-if="connected && disconnected">
-      <main class="main-layout error">
-        <div class="text-center">
-          <BrandImage
-            file-name="error-desert-landscape.svg"
-            width="900"
-            height="300"
-          />
-          <h1>
-            {{ t('generic.notification.title.warning') }}
-          </h1>
-          <h2 class="text-secondary mt-20">
-            {{ t('vncConsole.error.message') }}
-          </h2>
-        </div>
-      </main>
-    </div>
-    <div v-if="reconnecting">
-      <main class="main-layout">
-        <div class="text-center">
-          <h2 class="text-secondary mt-20">
-            {{ t('vncConsole.reconnecting.message') }}：{{ retryTimes }} of {{ maximumRetryTimes }}
-          </h2>
-        </div>
-      </main>
-    </div>
-    <div
-      ref="view"
-    />
-  </div>
-</template>
-
 <script>
-import RFB from '@novnc/novnc/core/rfb';
 import BrandImage from '@shell/components/BrandImage';
+import ZoomableRFB from './ZoomableRFB';
+
+export const CONSOLE_STATUS = {
+  CONNECTING:   'connecting',
+  CONNECTED:    'connected',
+  RECONNECTING: 'reconnecting',
+  DISCONNECTED: 'disconnected',
+  FAILED:       'failed',
+};
+
+const MAXIMUM_RETRY_TIMES = 10;
+const BASE_RECONNECT_DELAY = 1000;
+const MAXIMUM_RECONNECT_DELAY = 30000;
+
+const clampLevel = (value, fallback) => {
+  const level = Number.parseInt(value, 10);
+
+  if (Number.isNaN(level)) {
+    return fallback;
+  }
+
+  return Math.min(Math.max(level, 0), 9);
+};
 
 export default {
+  name: 'NovncConsole',
+
+  components: { BrandImage },
+
   props: {
     url: {
       type:    String,
       default: ''
-    }
+    },
+
+    settings: {
+      type:    Object,
+      default: () => ({})
+    },
   },
 
-  components: { BrandImage },
+  emits: ['status-changed', 'capabilities'],
 
   data() {
     return {
       rfb:               null,
-      connected:         false,
+      status:            CONSOLE_STATUS.CONNECTING,
-      disconnected:      false,
+      statusDetail:      '',
-      reconnectDelay:    3000,
+      desktopName:       '',
-      reconnecting:      false,
-      maximumRetryTimes: 10,
       retryTimes:        0,
-      setTimeout:        null,
+      maximumRetryTimes: MAXIMUM_RETRY_TIMES,
+      reconnectTimer:    null,
+      isClosed:          false,
     };
   },
 
+  computed: {
+    statusInfo() {
+      return {
+        status:            this.status,
+        detail:            this.statusDetail,
+        desktopName:       this.desktopName,
+        retryTimes:        this.retryTimes,
+        maximumRetryTimes: this.maximumRetryTimes,
+      };
+    },
+
+    showError() {
+      return this.status === CONSOLE_STATUS.FAILED;
+    },
+
+    showReconnecting() {
+      return this.status === CONSOLE_STATUS.RECONNECTING;
+    },
+  },
+
+  watch: {
+    url() {
+      this.reconnect();
+    },
+
+    settings: {
+      deep:    true,
+      handler: 'applySettings'
+    },
+
+    statusInfo: {
+      immediate: true,
+      handler(neu) {
+        this.$emit('status-changed', neu);
+      }
+    },
+  },
+
   mounted() {
     this.$nextTick(() => {
       this.connect();
@@ -66,88 +101,307 @@ export default {
   },
 
   beforeUnmount() {
-    this.clearTimeout();
+    this.isClosed = true;
+    this.clearReconnectTimer();
+    this.teardown();
   },
 
   methods: {
-    connect() {
+    connect(takeOver = false) {
-      const rfb = new RFB(this.$refs.view, this.url);
+      if (!this.url || this.isClosed) {
+        return;
+      }
 
-      rfb.addEventListener('connect', () => {
+      this.teardown();
-        this.clearTimeout();
 
-        this.connected = true;
+      this.status = this.retryTimes > 0 ? CONSOLE_STATUS.RECONNECTING : CONSOLE_STATUS.CONNECTING;
-        this.retryTimes = 0;
-        this.reconnecting = false;
-      });
 
-      rfb.addEventListener('disconnect', (e) => {
+      let rfb;
-        this.clearTimeout();
 
-        this.disconnected = true;
+      try {
-        this.rfb = null;
+        const url = new URL(this.url);
-        this.reconnect();
+
-      });
+        url.searchParams.set('preserveSession', takeOver === true ? 'false' : 'true');
+        rfb = new ZoomableRFB(this.$refs.view, url.href, { shared: true });
+      } catch (err) {
+        this.statusDetail = err?.message || `${ err }`;
+        this.status = CONSOLE_STATUS.FAILED;
+
+        return;
+      }
+
+      rfb.addEventListener('connect', this.onConnect);
+      rfb.addEventListener('disconnect', this.onDisconnect);
+      rfb.addEventListener('securityfailure', this.onSecurityFailure);
+      rfb.addEventListener('credentialsrequired', this.onCredentialsRequired);
+      rfb.addEventListener('desktopname', this.onDesktopName);
+      rfb.addEventListener('capabilities', this.onCapabilities);
 
       this.rfb = rfb;
+      this.applySettings();
     },
 
     reconnect() {
+      this.clearReconnectTimer();
+
+      this.isClosed = false;
+      this.retryTimes = 0;
+      this.statusDetail = '';
+      this.connect();
+    },
+
+    takeOver() {
+      if (!window.confirm(this.t('harvester.virtualMachine.detail.console.takeOver.confirm'))) {
+        return;
+      }
+
+      this.clearReconnectTimer();
+      this.isClosed = false;
+      this.retryTimes = 0;
+      this.statusDetail = '';
+      this.connect(true);
+    },
+
+    disconnect() {
+      this.isClosed = true;
+      this.clearReconnectTimer();
+      this.teardown();
+      this.status = CONSOLE_STATUS.DISCONNECTED;
+    },
+
+    onConnect() {
+      this.clearReconnectTimer();
+
+      this.retryTimes = 0;
+      this.statusDetail = '';
+      this.status = CONSOLE_STATUS.CONNECTED;
+      this.applySettings();
+    },
+
+    onDisconnect() {
+      const wasConnected = this.status === CONSOLE_STATUS.CONNECTED;
+
+      this.teardown(false);
+
+      if (this.isClosed) {
+        if (this.status !== CONSOLE_STATUS.FAILED) {
+          this.status = CONSOLE_STATUS.DISCONNECTED;
+        }
+
+        return;
+      }
+
+      if (wasConnected) {
+        this.scheduleReconnect();
+      } else {
+        this.clearReconnectTimer();
+        this.statusDetail = this.t('harvester.virtualMachine.detail.console.status.unavailable');
+        this.status = CONSOLE_STATUS.FAILED;
+      }
+    },
+
+    // Authentication problems will not fix themselves, so stop retrying.
+    onSecurityFailure(e) {
+      this.statusDetail = e?.detail?.reason || '';
+      this.isClosed = true;
+      this.clearReconnectTimer();
+      this.status = CONSOLE_STATUS.FAILED;
+    },
+
+    onCredentialsRequired() {
+      this.statusDetail = this.t('harvester.virtualMachine.detail.console.status.credentialsRequired');
+      this.isClosed = true;
+      this.clearReconnectTimer();
+      this.status = CONSOLE_STATUS.FAILED;
+    },
+
+    onDesktopName(e) {
+      this.desktopName = e?.detail?.name || '';
+    },
+
+    onCapabilities(e) {
+      this.$emit('capabilities', e?.detail?.capabilities || {});
+    },
+
+    scheduleReconnect() {
+      this.clearReconnectTimer();
+
+      if (this.isClosed) {
+        return;
+      }
+
       if (this.retryTimes >= this.maximumRetryTimes) {
-        this.reconnecting = false;
+        this.status = CONSOLE_STATUS.FAILED;
-        this.connected = true;
-        this.disconnected = true;
 
         return;
       }
 
       this.retryTimes += 1;
-      this.reconnecting = true;
+      this.status = CONSOLE_STATUS.RECONNECTING;
-      this.connected = false;
-      this.disconnected = false;
 
-      this.setTimeout = setTimeout(() => {
+      const delay = Math.min(BASE_RECONNECT_DELAY * (2 ** (this.retryTimes - 1)), MAXIMUM_RECONNECT_DELAY);
+
+      this.reconnectTimer = setTimeout(() => {
+        this.reconnectTimer = null;
         this.connect();
-      }, this.reconnectDelay);
+      }, delay);
     },
 
-    clearTimeout() {
+    clearReconnectTimer() {
-      if (this.setTimeout) {
+      if (this.reconnectTimer) {
-        clearTimeout(this.setTimeout);
+        clearTimeout(this.reconnectTimer);
+        this.reconnectTimer = null;
       }
     },
 
-    disconnect() {
+    teardown(disconnect = true) {
-      this.rfb.disconnect();
+      const rfb = this.rfb;
+
+      if (!rfb) {
+        return;
+      }
+
+      this.rfb = null;
+
+      rfb.removeEventListener('connect', this.onConnect);
+      rfb.removeEventListener('disconnect', this.onDisconnect);
+      rfb.removeEventListener('securityfailure', this.onSecurityFailure);
+      rfb.removeEventListener('credentialsrequired', this.onCredentialsRequired);
+      rfb.removeEventListener('desktopname', this.onDesktopName);
+      rfb.removeEventListener('capabilities', this.onCapabilities);
+
+      if (!disconnect) {
+        return;
+      }
+
+      try {
+        rfb.disconnect();
+      } catch (err) {
+        // The socket may already be gone, nothing left to clean up.
+      }
+    },
+
+    applySettings() {
+      const rfb = this.rfb;
+
+      if (!rfb) {
+        return;
+      }
+
+      const settings = this.settings || {};
+
+      rfb.viewOnly = !!settings.viewOnly;
+      rfb.scaleViewport = !!settings.scaleViewport;
+      rfb.resizeSession = !!settings.resizeSession;
+      rfb.clipViewport = !!settings.clipViewport;
+      rfb.dragViewport = !!settings.dragViewport;
+      rfb.zoomPercent = settings.zoomPercent;
+      rfb.focusOnClick = settings.focusOnClick !== false;
+      rfb.qualityLevel = clampLevel(settings.qualityLevel, 6);
+      rfb.compressionLevel = clampLevel(settings.compressionLevel, 2);
     },
 
     ctrlAltDelete() {
-      this.rfb.sendCtrlAltDel();
+      this.rfb?.sendCtrlAltDel();
     },
 
     sendKey(keysym, code, down) {
-      this.rfb.sendKey(keysym, code, down);
+      this.rfb?.sendKey(keysym, code, down);
-    }
+    },
+
   }
 };
 </script>
 
-<style lang="scss" scoped>
+<template>
-  .error {
+  <div class="novnc-console">
-    overflow: hidden;
+    <div
+      ref="view"
+      class="novnc-screen"
+    />
 
-    .row {
+    <div
-      align-items: center;
+      v-if="showError || showReconnecting"
-    }
+      class="novnc-overlay"
+    >
+      <div
+        v-if="showError"
+        class="text-center"
+      >
+        <BrandImage
+          file-name="error-desert-landscape.svg"
+          width="900"
+          height="300"
+        />
+        <h1>
+          {{ t('generic.notification.title.warning') }}
+        </h1>
+        <h2 class="text-secondary mt-20">
+          {{ t('vncConsole.error.message') }}
+        </h2>
+        <p
+          v-if="statusDetail"
+          class="text-muted mt-10"
+        >
+          {{ statusDetail }}
+        </p>
+        <button
+          class="btn role-primary mt-20"
+          @click="reconnect"
+        >
+          {{ t('harvester.action.reconnect') }}
+        </button>
+        <button
+          v-if="!isClosed"
+          class="btn role-secondary mt-20 ml-10"
+          @click="takeOver"
+        >
+          {{ t('harvester.virtualMachine.detail.console.takeOver.label') }}
+        </button>
+      </div>
+
+      <h2
+        v-else
+        class="text-secondary"
+      >
+        {{ t('vncConsole.reconnecting.message') }}：{{ retryTimes }} of {{ maximumRetryTimes }}
+      </h2>
+    </div>
+  </div>
+</template>
+
+<style lang="scss" scoped>
+  .novnc-console {
+    position: relative;
+    box-sizing: border-box;
+    height: 100%;
+    padding: 8px;
+    overflow: hidden;
+  }
+
+  .novnc-screen {
+    height: 100%;
+  }
+
+  .novnc-overlay {
+    position: absolute;
+    top: 0;
+    right: 0;
+    bottom: 0;
+    left: 0;
+    z-index: 1;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    overflow: auto;
+    background: rgba(0, 0, 0, 0.75);
 
     h1 {
       font-size: 5rem;
     }
 
-    .desert-landscape {
+    img {
-      img {
+      max-width: 100%;
-        max-width: 100%;
-      }
     }
   }
 </style>

pkg/harvester/components/novnc/NovncConsoleCustomKeys.vue

@@ -1,264 +0,0 @@
-<script>
-import { STEVE } from '@shell/config/types';
-import Banner from '@components/Banner/Banner.vue';
-import AsyncButton from '@shell/components/AsyncButton';
-import ModalWithCard from '@shell/components/ModalWithCard';
-
-const PREFERED_SHORTCUT_KEYS = 'prefered-shortcut-keys';
-
-export default {
-  name: 'NovncConsoleCustomKeys',
-
-  emits: ['close'],
-
-  components: {
-    ModalWithCard, Banner, AsyncButton
-  },
-
-  data() {
-    return {
-      keysRecord:            [],
-      addedShortcutKeys:     [],
-      preferredShortcutKeys: [],
-      isRecording:           false,
-    };
-  },
-
-  computed: {
-    savedShortcutKeys() {
-      const preference = this.$store.getters['management/all'](STEVE.PREFERENCE);
-      const preferedShortcutKeys = preference?.[0]?.data?.[PREFERED_SHORTCUT_KEYS];
-      let out = [];
-
-      if (!preferedShortcutKeys) {
-        return out;
-      }
-
-      try {
-        out = JSON.parse(preferedShortcutKeys);
-      } catch (err) {
-        this.$store.dispatch('growl/fromError', {
-          title: this.t('generic.notification.title.error', { name: this.t('harvester.virtualMachine.detail.console.customShortcutKeys') }),
-          err,
-        }, { root: true });
-      }
-
-      return out;
-    },
-
-    displayedKeys() {
-      const out = this.addedShortcutKeys.concat(this.preferredShortcutKeys).map((item) => {
-        const out = item.map((K) => ` <code>${ K.key.charAt(0).toUpperCase() + K.key.slice(1) }</code>`);
-
-        return out.join(',');
-      });
-
-      return out;
-    },
-
-    recordButton() {
-      if (this.isRecording) {
-        return 'harvester.virtualMachine.detail.console.record.stop';
-      }
-
-      return 'harvester.virtualMachine.detail.console.record.start';
-    },
-
-    keysRecordFormat() {
-      if (!this.isRecording && this.keysRecord.length === 0) {
-        return this.t('harvester.virtualMachine.detail.console.record.tips');
-      }
-
-      const out = this.keysRecord.map((item) => ` <code>${ item.key.charAt(0).toUpperCase() + item.key.slice(1) }</code>`);
-
-      return `Keys: ${ out.join(',') }`;
-    },
-
-    canAdd() {
-      const hasRecord = this.keysRecord.length > 0;
-      let validationList = [].concat(this.preferredShortcutKeys, this.addedShortcutKeys);
-
-      if (!hasRecord) {
-        return false;
-      }
-
-      validationList.push(this.keysRecord);
-
-      validationList = validationList.map((item) => {
-        const out = item.map((K) => K.key);
-
-        return out.join(',');
-      });
-
-      return validationList.length === new Set(validationList).size;
-    },
-  },
-
-  watch: {
-    savedShortcutKeys: {
-      handler() {
-        this.preferredShortcutKeys = [].concat(this.savedShortcutKeys) || [];
-      },
-      immediate: true
-    },
-  },
-
-  methods: {
-    closeRecordingModal() {
-      window.removeEventListener('keydown', this.handleShortcut);
-      this.$emit('close');
-    },
-
-    toggleRecording() {
-      this.isRecording = !this.isRecording;
-
-      if (this.isRecording) {
-        this.keysRecord = [];
-        window.addEventListener('keydown', this.handleShortcut);
-      } else {
-        window.removeEventListener('keydown', this.handleShortcut);
-      }
-    },
-
-    handleShortcut(event) {
-      event.preventDefault();
-
-      const {
-        key, keyCode, code, location, charCode
-      } = event;
-
-      this.keysRecord.push({
-        key, keyCode, code, location, charCode
-      });
-    },
-
-    addShortcutKey() {
-      this.addedShortcutKeys.push([].concat(this.keysRecord));
-    },
-
-    removeKey(keys) {
-      const key = keys.replace(/(\s*)<code>|<\/code>/g, '').replace(/\s*,\s*/g, ',');
-
-      this.addedShortcutKeys = this.addedShortcutKeys.filter((item) => {
-        const formatkey = item.map((K) => K.key.charAt(0).toUpperCase() + K.key.slice(1)).join(',');
-
-        return formatkey !== key;
-      });
-
-      this.preferredShortcutKeys = this.preferredShortcutKeys.filter((item) => {
-        const formatkey = item.map((K) => K.key.charAt(0).toUpperCase() + K.key.slice(1)).join(',');
-
-        return formatkey !== key;
-      });
-    },
-
-    async saveKeys(buttonCb) {
-      const out = [].concat(this.preferredShortcutKeys, this.addedShortcutKeys);
-      const preference = this.$store.getters['management/all'](STEVE.PREFERENCE)?.[0];
-
-      try {
-        preference.data[PREFERED_SHORTCUT_KEYS] = JSON.stringify(out);
-        await preference.save();
-        this.closeRecordingModal();
-        buttonCb(true);
-      } catch (err) {
-        buttonCb(false);
-      }
-    },
-  }
-};
-</script>
-
-<template>
-  <ModalWithCard
-    name="recordShortcutKeys"
-    :width="550"
-  >
-    <template #title>
-      <t k="harvester.virtualMachine.detail.console.customShortcutKeys" />
-    </template>
-
-    <template #content>
-      <div class="row">
-        <div class="col span-12">
-          <Banner color="info">
-            <span v-clean-html="keysRecordFormat"></span>
-          </Banner>
-        </div>
-      </div>
-      <div class="row">
-        <div class="col span-12">
-          <button
-            class="btn bg-primary"
-            @click="toggleRecording"
-          >
-            <t :k="recordButton" />
-            <i
-              class="icon icon-fw"
-              :class="isRecording ? 'icon-dot-open' : 'icon-dot'"
-            />
-          </button>
-          <button
-            :disabled="!canAdd"
-            class="btn bg-primary"
-            @click="addShortcutKey"
-          >
-            <t k="generic.add" />
-          </button>
-        </div>
-      </div>
-
-      <hr>
-
-      <div class="displayed-keys mt-20">
-        <h4
-          v-clean-html="t('harvester.virtualMachine.detail.console.record.preferredKeys')"
-          class="text-default-text"
-        />
-
-        <div class="displayed-banners">
-          <Banner
-            v-for="(keys,index) in displayedKeys"
-            :key="index"
-          >
-            <span v-clean-html="keys"></span>
-          </Banner>
-        </div>
-      </div>
-    </template>
-
-    <template #footer>
-      <div class="actions">
-        <button
-          class="btn role-secondary mr-20"
-          @click.prevent="closeRecordingModal"
-        >
-          <t k="generic.close" />
-        </button>
-        <AsyncButton
-          mode="done"
-          @click="saveKeys"
-        />
-      </div>
-    </template>
-  </ModalWithCard>
-</template>
-
-<style lang="scss" scoped>
-  .displayed-keys {
-    .banner {
-      margin: 0;
-    }
-  }
-
-  .displayed-banners {
-    max-height: 155px;
-    overflow: auto;
-  }
-
-  .actions {
-    width: 100%;
-    display: flex;
-    justify-content: flex-end;
-  }
-</style>

pkg/harvester/components/novnc/NovncConsoleWrapper.vue

@@ -1,15 +1,26 @@
 <script>
-import { STEVE } from '@shell/config/types';
 import { escapeHtml } from '@shell/utils/string';
 import { allHash } from '@shell/utils/promise';
 import KeyTable from '@novnc/novnc/core/input/keysym';
-import * as KeyboardUtil from '@novnc/novnc/core/input/util';
 import { HCI } from '../../types';
 import NovncConsole from './NovncConsole';
 import NovncConsoleItem from './NovncConsoleItem';
-import NovncConsoleCustomKeys from './NovncConsoleCustomKeys';
+import { normalizeZoom } from './ZoomableRFB';
 
-const PREFERED_SHORTCUT_KEYS = 'prefered-shortcut-keys';
+const CONSOLE_SETTINGS_KEY = 'harvester-vnc-console-settings';
+
+const VIEW_MODE = {
+  SCALE:  'scale',
+  NONE:   'none',
+};
+
+const DEFAULT_SETTINGS = {
+  viewMode:         VIEW_MODE.NONE,
+  zoomPercent:      100,
+  viewOnly:         false,
+  qualityLevel:     6,
+  compressionLevel: 2,
+};
 
 const SHORT_KEYS = {
   ControlLeft: {
@@ -105,9 +116,7 @@ const F_KEYS = {
 
 export default {
   name:       'NovncConsoleWrapper',
-  components: {
+  components: { NovncConsole, NovncConsoleItem },
-    NovncConsole, NovncConsoleItem, NovncConsoleCustomKeys
-  },
 
   async fetch() {
     const _hash = { vmResource: this.$store.dispatch('harvester/find', { type: HCI.VM, id: this.value.id }) };
@@ -131,39 +140,21 @@ export default {
     return {
       keysRecord:        [],
       vmResource:        {},
-      renderKeysModal:   false,
+      settings:          { ...DEFAULT_SETTINGS },
-      currentUser:       null,
+      capabilities:      {},
-      hideCustomKeysBar: false,
+      isFullscreen:      false,
+      consoleStatus:     {
+        status:            'connecting',
+        retryTimes:        0,
+        maximumRetryTimes: 0,
+        desktopName:       '',
+      },
     };
   },
 
   computed: {
-    savedShortcutKeys() {
+    canSendKeys() {
-      const preference = this.$store.getters['management/all'](STEVE.PREFERENCE);
+      return this.consoleStatus.status === 'connected' && !this.settings.viewOnly;
-      const preferedShortcutKeys = preference?.[0]?.data?.[PREFERED_SHORTCUT_KEYS];
-      let out = [];
-
-      if (!preference?.[0]?.data) {
-        // eslint-disable-next-line vue/no-side-effects-in-computed-properties
-        this.hideCustomKeysBar = true;
-
-        return out;
-      }
-
-      if (!preferedShortcutKeys) {
-        return out;
-      }
-
-      try {
-        out = JSON.parse(preferedShortcutKeys);
-      } catch (err) {
-        this.$store.dispatch('growl/fromError', {
-          title: this.t('generic.notification.title.error', { name: escapeHtml(this.value.metadata.name) }),
-          err,
-        }, { root: true });
-      }
-
-      return out;
     },
 
     isDown() {
@@ -192,13 +183,16 @@ export default {
         ...F_KEYS,
       };
 
-      out.AltLeft.keys = { PrintScreen: FUNCTION_KEYS.PrintScreen, ...F_KEYS };
+      out.AltLeft = { ...SHORT_KEYS.AltLeft, keys: { PrintScreen: FUNCTION_KEYS.PrintScreen, ...F_KEYS } };
-      out.ControlLeft.keys = {
+      out.ControlLeft = {
-        AltLeft: {
+        ...SHORT_KEYS.ControlLeft,
-          ...Object.assign(SHORT_KEYS.AltLeft, {}),
+        keys: {
-          keys: { Delete: FUNCTION_KEYS.Delete }
+          AltLeft: {
+            ...SHORT_KEYS.AltLeft,
+            keys: { Delete: FUNCTION_KEYS.Delete }
+          },
+          ...NORMAL_KEYS,
         },
-        ...NORMAL_KEYS,
       };
 
       return out;
@@ -208,14 +202,53 @@ export default {
       return !!this.vmResource?.actions?.softreboot;
     },
 
-    preferredShortcutKeys() {
+    rfbSettings() {
-      return (this.savedShortcutKeys || []).map((item) => {
+      return {
-        return {
+        viewOnly:         this.settings.viewOnly,
-          label: item.map((K) => K.key.charAt(0).toUpperCase() + K.key.slice(1)).join('+'),
+        scaleViewport:    this.settings.viewMode === VIEW_MODE.SCALE,
-          value: item
+        zoomPercent:      normalizeZoom(this.settings.zoomPercent),
-        };
+        resizeSession:    false,
-      });
+        clipViewport:     false,
+        dragViewport:     false,
+        qualityLevel:     this.settings.qualityLevel,
+        compressionLevel: this.settings.compressionLevel,
+      };
     },
+
+    viewModeOptions() {
+      return Object.values(VIEW_MODE).map((value) => ({
+        value,
+        label: this.t(`harvester.virtualMachine.detail.console.settings.viewMode.${ value }`)
+      }));
+    },
+
+    statusLabel() {
+      const { status, retryTimes, maximumRetryTimes } = this.consoleStatus;
+
+      if (status === 'reconnecting') {
+        return this.t('harvester.virtualMachine.detail.console.status.reconnecting', { retryTimes, maximumRetryTimes });
+      }
+
+      return this.t(`harvester.virtualMachine.detail.console.status.${ status }`);
+    },
+  },
+
+  watch: {
+    settings: {
+      deep: true,
+      handler(neu) {
+        window.localStorage.setItem(CONSOLE_SETTINGS_KEY, JSON.stringify(neu));
+      }
+    },
+  },
+
+  mounted() {
+    this.loadSettings();
+    document.addEventListener('fullscreenchange', this.onFullscreenChange);
+  },
+
+  beforeUnmount() {
+    document.removeEventListener('fullscreenchange', this.onFullscreenChange);
   },
 
   methods: {
@@ -233,137 +266,221 @@ export default {
 
     // Send function key, e.g. ALT + F
     sendKeys() {
+      if (!this.canSendKeys || !this.$refs.novncConsole) {
+        return;
+      }
+
       this.keysRecord.forEach((key) => {
         this.$refs.novncConsole.sendKey(this.allKeys[key].value, key, true);
       });
 
-      this.keysRecord.reverse().forEach((key) => {
+      [...this.keysRecord].reverse().forEach((key) => {
         this.$refs.novncConsole.sendKey(this.allKeys[key].value, key, false);
       });
 
-      this.$refs.popover.isOpen = false;
+      this.$refs.popover.hide();
       this.keysRecord = [];
     },
 
-    sendCustomKeys(keys) {
-      const keyList = [].concat(keys);
-
-      keyList.forEach((K) => {
-        this.$refs.novncConsole.sendKey(KeyboardUtil.getKeysym(K), KeyboardUtil.getKeycode(K), true);
-      });
-
-      keyList.reverse().forEach((K) => {
-        this.$refs.novncConsole.sendKey(KeyboardUtil.getKeysym(K), KeyboardUtil.getKeycode(K), false);
-      });
-    },
-
     reconnect() {
       this.$refs.novncConsole.reconnect();
     },
 
+    loadSettings() {
+      try {
+        const saved = JSON.parse(window.localStorage.getItem(CONSOLE_SETTINGS_KEY) || '{}');
+
+        this.settings = {
+          viewMode:         Object.values(VIEW_MODE).includes(saved?.viewMode) ? saved.viewMode : DEFAULT_SETTINGS.viewMode,
+          zoomPercent:      normalizeZoom(saved?.zoomPercent ?? DEFAULT_SETTINGS.zoomPercent),
+          viewOnly:         saved?.viewOnly === true,
+          qualityLevel:     saved?.qualityLevel ?? DEFAULT_SETTINGS.qualityLevel,
+          compressionLevel: saved?.compressionLevel ?? DEFAULT_SETTINGS.compressionLevel,
+        };
+      } catch (err) {
+        this.settings = { ...DEFAULT_SETTINGS };
+      }
+    },
+
+    onStatusChanged(info) {
+      this.consoleStatus = info;
+    },
+
+    onCapabilities(capabilities) {
+      this.capabilities = capabilities;
+    },
+
+    ctrlAltDelete() {
+      if (this.canSendKeys) {
+        this.$refs.novncConsole?.ctrlAltDelete();
+      }
+    },
+
+    async toggleFullscreen() {
+      try {
+        if (document.fullscreenElement) {
+          await document.exitFullscreen();
+        } else {
+          await this.$refs.consoleContainer.requestFullscreen();
+          // Keyboard lock lets shortcuts such as Ctrl+W and F11 reach the guest.
+          await navigator.keyboard?.lock?.(['KeyW', 'F11']);
+        }
+      } catch (err) {
+        this.$store.dispatch('growl/fromError', {
+          title: this.t('generic.notification.title.error', { name: escapeHtml(this.value.metadata.name) }),
+          err,
+        }, { root: true });
+      }
+    },
+
+    onFullscreenChange() {
+      this.isFullscreen = !!document.fullscreenElement;
+
+      if (!this.isFullscreen) {
+        navigator.keyboard?.unlock?.();
+      }
+    },
+
     softReboot() {
       this.vmResource.doSoftReboot();
     },
 
-    showKeysModal() {
-      this.renderKeysModal = true;
-    },
-
-    hideKeysModal() {
-      this.renderKeysModal = false;
-    },
   }
 };
 </script>
 
 <template>
   <div id="app">
-    <div class="vm-console">
+    <div
+      ref="consoleContainer"
+      class="vm-console"
+    >
       <div class="combination-keys">
-        <v-dropdown
+        <div class="toolbar-group">
-          ref="popover"
+          <v-dropdown
-          placement="top"
+            ref="popover"
-          trigger="click"
+            placement="top"
-          :container="false"
+            trigger="click"
-          @auto-hide="keysRecord = []"
+            :container="false"
-        >
+            @auto-hide="keysRecord = []"
-          <button class="btn btn-sm bg-primary">
+          >
-            {{ t("harvester.virtualMachine.detail.console.shortcutKeys") }}
+            <button
-          </button>
+              class="btn btn-sm bg-primary"
-
+              :disabled="!canSendKeys"
-          <template #popper>
-            <novnc-console-item
-              :items="keymap"
-              :path="keysRecord"
-              :pos="0"
-              @update="update"
-              @send-keys="sendKeys"
-            />
-          </template>
-        </v-dropdown>
-
-        <button
-          v-if="hasSoftRebootAction"
-          class="btn btn-sm bg-primary"
-          @click="softReboot"
-        >
-          {{ t("harvester.action.softreboot") }}
-        </button>
-
-        <button
-          class="btn btn-sm bg-primary"
-          @click="reconnect"
-        >
-          {{ t("harvester.action.reconnect") }}
-        </button>
-
-        <v-dropdown
-          v-if="!hideCustomKeysBar"
-          ref="customKeyPopover"
-          placement="top"
-          trigger="click"
-          :container="false"
-        >
-          <button class="btn btn-sm bg-primary">
-            {{ t("harvester.virtualMachine.detail.console.customShortcutKeys") }}
-          </button>
-
-          <template #popper>
-            <div>
-              <button
-                class="btn btn-sm bg-primary"
-                @click="showKeysModal"
-              >
-                {{ t("harvester.virtualMachine.detail.console.management") }}
-              </button>
-            </div>
-
-            <hr>
-
-            <div
-              v-for="(keys, index) in preferredShortcutKeys"
-              :key="index"
             >
-              <button
+              {{ t("harvester.virtualMachine.detail.console.shortcutKeys") }}
-                class="btn btn-sm bg-primary"
+            </button>
-                @click="sendCustomKeys(keys.value)"
-              >
-                {{ keys.label }}
-              </button>
-            </div>
-          </template>
-        </v-dropdown>
 
-        <NovncConsoleCustomKeys
+            <template #popper>
-          v-if="renderKeysModal"
+              <novnc-console-item
-          :current-user="currentUser"
+                :items="keymap"
-          @close="hideKeysModal"
+                :path="keysRecord"
-        />
+                :pos="0"
+                @update="update"
+                @send-keys="sendKeys"
+              />
+            </template>
+          </v-dropdown>
+
+          <button
+            class="btn btn-sm bg-primary"
+            :disabled="!canSendKeys"
+            @click="ctrlAltDelete"
+          >
+            Ctrl+Alt+Del
+          </button>
+
+          <v-dropdown
+            placement="top"
+            trigger="click"
+            :container="false"
+          >
+            <button class="btn btn-sm bg-primary">
+              {{ t("harvester.virtualMachine.detail.console.settings.label") }}
+            </button>
+
+            <template #popper>
+              <div class="console-panel">
+                <label>{{ t('harvester.virtualMachine.detail.console.settings.viewMode.label') }}</label>
+                <div
+                  v-for="option in viewModeOptions"
+                  :key="option.value"
+                >
+                  <label class="console-panel__option">
+                    <input
+                      v-model="settings.viewMode"
+                      type="radio"
+                      :value="option.value"
+                    >
+                    {{ option.label }}
+                  </label>
+                </div>
+
+                <label
+                  for="vnc-zoom"
+                  class="console-panel__zoom-label"
+                >
+                  <span>{{ t('harvester.virtualMachine.detail.console.settings.zoom') }}</span>
+                  <span>{{ settings.zoomPercent }}%</span>
+                </label>
+                <input
+                  id="vnc-zoom"
+                  v-model.number="settings.zoomPercent"
+                  class="console-panel__zoom"
+                  type="range"
+                  min="50"
+                  max="200"
+                  step="10"
+                  :disabled="settings.viewMode === 'scale'"
+                  :aria-valuetext="`${ settings.zoomPercent }%`"
+                >
+
+                <label class="console-panel__option">
+                  <input
+                    v-model="settings.viewOnly"
+                    type="checkbox"
+                  >
+                  {{ t('harvester.virtualMachine.detail.console.settings.viewOnly') }}
+                </label>
+              </div>
+            </template>
+          </v-dropdown>
+        </div>
+
+        <div class="toolbar-group">
+          <span class="console-status">{{ statusLabel }}</span>
+
+          <button
+            v-if="hasSoftRebootAction"
+            class="btn btn-sm bg-primary"
+            @click="softReboot"
+          >
+            {{ t("harvester.action.softreboot") }}
+          </button>
+
+          <button
+            class="btn btn-sm bg-primary"
+            @click="reconnect"
+          >
+            {{ t("harvester.action.reconnect") }}
+          </button>
+
+          <button
+            class="btn btn-sm bg-primary"
+            @click="toggleFullscreen"
+          >
+            {{ isFullscreen ? t('harvester.virtualMachine.detail.console.fullscreen.exit') : t('harvester.virtualMachine.detail.console.fullscreen.enter') }}
+          </button>
+        </div>
       </div>
+
       <NovncConsole
         v-if="url && !isDown"
         ref="novncConsole"
         :url="url"
+        :settings="rfbSettings"
+        @status-changed="onStatusChanged"
+        @capabilities="onCapabilities"
       />
       <p v-if="isDown">
         {{ t("harvester.virtualMachine.detail.console.down") }}
@@ -374,14 +491,56 @@ export default {
 
 <style lang="scss" scoped>
   .vm-console {
-    height: 100%;
+    height: 100vh;
+    height: 100dvh;
     display: grid;
-    grid-template-rows: 30px auto;
+    grid-template-rows: 32px minmax(0, 1fr);
   }
 
   .combination-keys {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
     background: rgb(40, 40, 40);
   }
+
+  .toolbar-group {
+    display: flex;
+    align-items: center;
+    gap: 4px;
+  }
+
+  .console-status {
+    color: #fff;
+    font-size: 12px;
+    margin-right: 8px;
+  }
+
+  .console-panel {
+    display: flex;
+    flex-direction: column;
+    width: 260px;
+    padding: 4px;
+
+    &__zoom-label {
+      display: flex;
+      justify-content: space-between;
+      margin-top: 8px;
+      font-variant-numeric: tabular-nums;
+    }
+
+    &__zoom {
+      width: 100%;
+      margin: 4px 0 8px;
+    }
+
+    &__option {
+      display: flex;
+      align-items: center;
+      gap: 6px;
+      margin: 2px 0;
+    }
+  }
 </style>
 
 <style lang="scss">

pkg/harvester/components/novnc/ZoomableRFB.js

@@ -0,0 +1,31 @@
+import RFB from '@novnc/novnc/core/rfb';
+
+export function normalizeZoom(value) {
+  const percent = Number(value);
+
+  if (!Number.isFinite(percent)) {
+    return 100;
+  }
+
+  return Math.min(200, Math.max(50, Math.round(percent / 10) * 10));
+}
+
+export default class ZoomableRFB extends RFB {
+  get zoomPercent() {
+    return this._zoomPercent ?? 100;
+  }
+
+  set zoomPercent(value) {
+    this._zoomPercent = normalizeZoom(value);
+    this._updateScale();
+  }
+
+  _updateScale() {
+    if (this.scaleViewport) {
+      super._updateScale();
+    } else {
+      this._display.scale = this.zoomPercent / 100;
+      this._fixScrollbars();
+    }
+  }
+}

pkg/harvester/l10n/en-us.yaml

@@ -953,15 +953,33 @@ harvester:
       console:
         down: This virtual machine is down. Please start it to access its console.
         shortcutKeys: Shortcut Keys
-        customShortcutKeys: Custom Shortcut Keys
+        settings:
-        management: Management Shortcut Keys
+          label: Settings
-        record:
+          viewMode:
-          start: Record
+            label: Display
-          recording: Recording
+            scale: Scale the display to fit the window
-          stop: Stop Recording
+            resize: Resize the virtual machine display to the window
-          tips: Press the record button to capture your keyboard inputs.
+            none: Manual zoom
-          send: Send
+          zoom: Zoom
-          preferredKeys: Preferred Custom Shortcut Keys
+          clipViewport: Clip to the window instead of showing scrollbars
+          viewOnly: View only
+          quality: JPEG quality
+          compression: Compression level
+          reset: Reset to defaults
+        fullscreen:
+          enter: Full Screen
+          exit: Exit Full Screen
+        takeOver:
+          label: Take Over
+          confirm: Take over this console? Any existing VNC session for this virtual machine will be disconnected.
+        status:
+          connecting: Connecting
+          connected: Connected
+          disconnected: Disconnected
+          failed: Connection failed
+          reconnecting: 'Reconnecting {retryTimes} of {maximumRetryTimes}'
+          credentialsRequired: This console requires credentials that the dashboard cannot provide.
+          unavailable: Unable to connect. Another VNC session may be active, or the console may be unavailable.
     terminationGracePeriodSeconds:
       label: Termination Grace Period
     affinity:

pkg/harvester/pages/c/_cluster/console/_uid/vnc.vue

@@ -1,10 +1,18 @@
 <script>
+import { defineAsyncComponent } from 'vue';
 import Loading from '@shell/components/Loading';
+import TabTitle from '@shell/components/TabTitle';
 import { HCI } from '../../../../../types';
-import NovncConsoleWrapper from '../../../../../components/novnc/NovncConsoleWrapper.vue';
 
 export default {
-  components: { NovncConsoleWrapper, Loading },
+  components: {
+    NovncConsoleWrapper: defineAsyncComponent({
+      loader:           () => import('../../../../../components/novnc/NovncConsoleWrapper.vue'),
+      loadingComponent: Loading,
+    }),
+    Loading,
+    TabTitle
+  },
 
   async fetch() {
     this.rows = await this.$store.dispatch('harvester/findAll', { type: HCI.VMI });
@@ -28,17 +36,21 @@ export default {
 
   mounted() {
     window.addEventListener('beforeunload', () => {
-      this.$refs.console.close();
+      this.$refs.console?.close();
     });
   },
 
-  head() {
-    return { title: this.vmi?.metadata?.name };
-  },
 };
 </script>
 
 <template>
+  <TabTitle
+    v-if="vmi?.metadata?.name"
+    :breadcrumb="false"
+    :show-child="false"
+  >
+    {{ vmi.metadata.name }}
+  </TabTitle>
   <Loading v-if="$fetchState.pending" />
   <NovncConsoleWrapper
     v-else

pkg/harvester/vue.config.js

@@ -1 +1,24 @@
-module.exports = require('@rancher/shell/pkg/vue.config')(__dirname);
+const path = require('path');
+
+const baseConfig = require('@rancher/shell/pkg/vue.config')(__dirname);
+
+const baseConfigureWebpack = baseConfig.configureWebpack;
+
+// noVNC >= 1.7 only publishes `./core/rfb.js` in its `exports` map, so resolve the
+// package by path to keep the keysym/input helpers importable.
+const NOVNC_DIR = path.resolve(__dirname, '..', '..', 'node_modules', '@novnc', 'novnc');
+
+module.exports = {
+  ...baseConfig,
+
+  configureWebpack(config) {
+    if (typeof baseConfigureWebpack === 'function') {
+      baseConfigureWebpack(config);
+    }
+
+    config.resolve.alias['@novnc/novnc'] = NOVNC_DIR;
+
+    // noVNC 1.7 uses top-level await for WebCodecs detection.
+    config.output = { ...config.output, environment: { ...config.output?.environment, asyncFunction: true } };
+  }
+};

vue.config.js

@@ -1,6 +1,26 @@
+const path = require('path');
 const config = require('@rancher/shell/vue.config');
 
-module.exports = config(__dirname, {
+const baseConfig = config(__dirname, {
   excludes: [],
   // excludes: ['harvester']
 });
+
+const baseConfigureWebpack = baseConfig.configureWebpack;
+
+module.exports = {
+  ...baseConfig,
+
+  configureWebpack(webpackConfig) {
+    if (typeof baseConfigureWebpack === 'function') {
+      baseConfigureWebpack(webpackConfig);
+    }
+
+    // noVNC >= 1.7 only publishes `./core/rfb.js` in its `exports` map, so resolve the
+    // package by path to keep the keysym/input helpers importable.
+    webpackConfig.resolve.alias['@novnc/novnc'] = path.resolve(__dirname, 'node_modules/@novnc/novnc');
+
+    // noVNC 1.7 uses top-level await for WebCodecs detection.
+    webpackConfig.output = { ...webpackConfig.output, environment: { ...webpackConfig.output?.environment, asyncFunction: true } };
+  }
+};

yarn.lock

@@ -2097,10 +2097,10 @@
     "@nodelib/fs.scandir" "2.1.5"
     fastq "^1.6.0"
 
-"@novnc/novnc@1.2.0":
+"@novnc/novnc@1.2.0", "@novnc/novnc@1.7.0":
-  version "1.2.0"
+  version "1.7.0"
-  resolved "https://registry.yarnpkg.com/@novnc/novnc/-/novnc-1.2.0.tgz#535ffd7d074022d35205deae2753100f1f2b29f3"
+  resolved "https://registry.yarnpkg.com/@novnc/novnc/-/novnc-1.7.0.tgz#7f832cf07c66475a81a25708b8e5299a5c4efec5"
-  integrity sha512-FaUckOedGhSbwQBXk/KGyxKt9ngskg4wPw6ghbHWXOUEmQscAZr3467lTU5DSfppwHJt5k+lQiHoeYUuY90l2Q==
+  integrity sha512-ucEJOx4T2avIRCleodk7YobZj5O2Ga2AeLfQ69A/yjG9HHba2+PDgwSkN3FttrmG+70ZGx21sElNFouK13RzyA==
 
 "@one-ini/wasm@0.1.1":
   version "0.1.1"