perf: speed up the VM list with many VMs (#1189)

* perf: speed up the VM list with many VMs The VM list scanned whole store lists for every row and re-evaluated the same values per row on every render and sort. With several hundred VMs this blocked the browser on sorting and on every VM update. Performance: - look up launcher pods and migrations through shared indexes (namespace/name -> resource) instead of scanning per row; the indexes are computed per store list, so they stay in sync with in-place store updates - use the same migration lookup (getLatestMigration) in the VM model and on the VM detail page - look up PVCs, PVs, VMIs and restore backups by id - merge VMs and VMIs with a Set - evaluate the VM state once when sorting by state - check the unschedulable condition before the pod based state checks - cache feature flag results and per-schema/per-setting values that are the same for every row Bug fixes: - the launcher pod map was never rebuilt, because the store keeps the same array - pods, volumes and migrations of a VM with the same name in another namespace could be picked up The order of the volumes of a VM (vm.volumes) now follows the VM spec instead of the store order. Nothing depends on it. Measured in a synthetic setup, 100 rows per page, sorting by state (Chrome, dev build): - ~490 VMs, ~500 PVCs/PVs: 1.9 s -> 1.0 s - ~490 VMs, 600 PVs, 200 migrations: 6.0 s -> 0.7 s, main thread blocked during VM updates 78% -> 32% With few volumes the gain is much smaller (8-20%). Related to: https://github.com/harvester/harvester/issues/9513 Signed-off-by: Volker Theile <vtheile@suse.com> * fix: read VM data from the store of the resource instead of a fixed one The migrations of a VMI and the migration badge of the state column were read from the hardcoded `harvester` store. In the Rancher explorer (embedded and standalone) the data is loaded into the `cluster` store, so a running migration was shown neither in the VM state nor as badge. The VM model remembered the store of the current product in a module variable on first use and never updated it. The same model is used in the Harvester product (`harvester` store) and in the Rancher explorer (`cluster` store), and Rancher keeps the page loaded when going from the explorer of a Harvester cluster to Virtualization Management and into the Harvester product. The VM list then read the VMIs, launcher pods, volumes and restores from the wrong store, and running VMs were shown as Starting until the page was reloaded. Read the data from the store the resource lives in (`this.$getters`, in the formatter the store of the current product). In the Harvester product this is still the `harvester` store, so nothing changes there. Not covered: volume details like the lock icon of encrypted volumes. The explorer uses the generic Rancher PVC model, which does not know them, and settings based checks (feature flags, backup target) are not loaded there either. Related to: https://github.com/harvester/harvester/issues/11882 Signed-off-by: Volker Theile <vtheile@suse.com> --------- Signed-off-by: Volker Theile <vtheile@suse.com>
2026-11-15 13:26:15 +08:00 · 2026-10-14 13:31:09 +02:00
parent 71141b257a
commit 5406c08f76
14 changed files with 388 additions and 116 deletions
@@ -5,18 +5,15 @@ import { HCI } from '../../types';

 // The Steve base model and the shell resource class pull in most of the dashboard, none of that is needed here
 jest.mock('../harvester', () => ({ __esModule: true, default: class {} }));
-jest.mock('@shell/plugins/dashboard-store/resource-class', () => ({ colorForState: (state) => (state === 'Running' ? 'text-success' : 'text-info') }));
+jest.mock('@shell/plugins/dashboard-store/resource-class', () => ({
+  colorForState: (state) => (state === 'Running' ? 'text-success' : 'text-info'),
+  stateSort:     (color, display) => `${ color.replace(/^text-/, '') } ${ display }`,
+}));

 const VM_ID = 'ns1/vm1';

-/**
- * Create a VM model instance without the full Steve model plumbing. Only the store getters that the
- * VM model reads are mocked, backed by plain lists (like the real store, `all` returns the same array
- * that is mutated in place on updates).
- *
- * The model reads its store either through `$rootGetters` (`harvester/...`) or through `$getters`, the getters of the
- * store it lives in. Both are backed by the same data, so the tests do not depend on which of them the model uses.
- */
+// Creates a VM model with mocked store getters. Like the real store, `all` returns the same array that is mutated in place.
+// Reads from the global `$rootGetters` are recorded in `globalReads`.
 function createVm({
  vm = {}, vmi, pods = [], pvcs = [], restores = [], backups = [], claims = ['disk-pvc'], printableStatus
 } = {}) {
@@ -33,12 +30,14 @@ function createVm({
    byId:      (type, id) => (byId[type] || lists[type] || []).find((x) => x.id === id),
    schemaFor: () => undefined,
  };
-  const rootGetters = {
-    'harvester-common/getFeatureEnabled': () => false,
-    currentProduct:                       { inStore: 'harvester' },
-    'harvester/all':                      getters.all,
-    'harvester/byId':                     getters.byId,
-  };
+  const globalReads = [];
+  const rootGetters = new Proxy({ 'harvester-common/getFeatureEnabled': () => false }, {
+    get(target, key) {
+      globalReads.push(key);
+
+      return target[key];
+    }
+  });

  const obj = Object.create(VirtVm.prototype);

@@ -66,7 +65,9 @@ function createVm({
  Object.defineProperty(obj, '$getters', { value: getters });
  Object.defineProperty(obj, 't', { value: (k) => k });

-  return { vm: obj, lists };
+  return {
+    vm: obj, lists, globalReads
+  };
 }

 const readyVmi = (extra = {}) => ({
@@ -287,6 +288,24 @@ describe('class VirtVm', () => {
    });
  });

+  describe('stateSort', () => {
+    it('should be built from the same state as stateDisplay and stateColor', () => {
+      const { vm } = createVm({ vmi: readyVmi() });
+
+      expect(vm.stateSort).toBe(`${ vm.stateColor.replace(/^text-/, '') } ${ vm.stateDisplay }`);
+    });
+
+    it('should evaluate the state only once', () => {
+      const { vm } = createVm({ vmi: readyVmi() });
+      const spy = jest.spyOn(vm, 'actualState', 'get');
+
+      expect(vm.stateSort).toBe('success Running');
+      expect(spy).toHaveBeenCalledTimes(1);
+
+      spy.mockRestore();
+    });
+  });
+
  describe('podResource', () => {
    it('should find the launcher pod by owner name', () => {
      const pod = { metadata: { namespace: 'ns1', ownerReferences: [{ name: 'vm1' }] } };
@@ -311,6 +330,62 @@ describe('class VirtVm', () => {

      expect(vm.podResource.metadata.name).toBe('launcher-target');
    });
+
+    it('should find pods that are added to the store later', () => {
+      const { vm, lists } = createVm({ vmi: readyVmi(), pods: [] });
+
+      expect(vm.podResource).toBeUndefined();
+
+      const pod = { metadata: { namespace: 'ns1', ownerReferences: [{ name: 'vm1' }] } };
+
+      lists[POD].push(pod);
+
+      expect(vm.podResource).toStrictEqual(pod);
+    });
+
+    it('should not return a pod of a VM with the same name in another namespace', () => {
+      const other = { metadata: { namespace: 'ns2', ownerReferences: [{ name: 'vm1' }] } };
+      const mine = { metadata: { namespace: 'ns1', ownerReferences: [{ name: 'vm1' }] } };
+      const { vm } = createVm({ vmi: readyVmi(), pods: [mine, other] });
+
+      expect(vm.podResource).toStrictEqual(mine);
+    });
+
+    it('should not return pods that were removed from the store', () => {
+      const pod = { metadata: { namespace: 'ns1', ownerReferences: [{ name: 'vm1' }] } };
+      const { vm, lists } = createVm({ vmi: readyVmi(), pods: [pod] });
+
+      expect(vm.podResource).toStrictEqual(pod);
+
+      lists[POD].splice(0, 1);
+
+      expect(vm.podResource).toBeUndefined();
+    });
+  });
+
+  describe('store', () => {
+    it('should read the data of the VM from the store the VM lives in, not from a fixed one', () => {
+      // The VM model is used with the `harvester` store (Harvester product) and the `cluster` store (Rancher explorer)
+      const pod = { metadata: { namespace: 'ns1', ownerReferences: [{ name: 'vm1' }] } };
+      const { vm, globalReads } = createVm({
+        vmi:      readyVmi(),
+        pods:     [pod],
+        pvcs:     [pvc('disk-pvc', false)],
+        restores: [{ id: 'ns1/r1', isComplete: true }],
+        vm:       {
+          metadata: {
+            name: 'vm1', namespace: 'ns1', annotations: { 'restore.harvesterhci.io/name': 'r1' }
+          }
+        },
+      });
+
+      expect(vm.vmi.id).toBe(VM_ID);
+      expect(vm.podResource).toStrictEqual(pod);
+      expect(vm.volumes).toHaveLength(1);
+      expect(vm.restoreResource.id).toBe('ns1/r1');
+      expect(vm.actualState).toBe('Running');
+      expect(globalReads.filter((key) => /^(harvester|cluster)\//.test(key))).toStrictEqual([]);
+    });
  });

  describe('isRestartRequired', () => {