@rancher/shell 3.0.6 → 3.0.8-rc.1

package/plugins/dashboard-store/resource-class.js

@@ -62,7 +62,7 @@ const DEFAULT_COLOR = 'warning';
 const DEFAULT_ICON = 'x';
 
 const DEFAULT_WAIT_INTERVAL = 1000;
-const DEFAULT_WAIT_TMIMEOUT = 30000;
+const DEFAULT_WAIT_TIMEOUT = 30000;
 
 export const STATES_ENUM = {
   IN_USE:           'in-use',
@@ -806,7 +806,7 @@ export default class Resource {
   // ------------------------------------------------------------------
 
   waitForTestFn(fn, msg, timeoutMs, intervalMs) {
-    return waitFor(() => fn.apply(this), msg, timeoutMs || DEFAULT_WAIT_TMIMEOUT, intervalMs || DEFAULT_WAIT_INTERVAL, true);
+    return waitFor(() => fn.apply(this), msg, timeoutMs || DEFAULT_WAIT_TIMEOUT, intervalMs || DEFAULT_WAIT_INTERVAL, true);
   }
 
   waitForState(state, timeout, interval) {
@@ -855,7 +855,7 @@ export default class Resource {
     return (entry.status || '').toLowerCase() === `${ withStatus }`.toLowerCase();
   }
 
-  waitForCondition(name, withStatus = 'True', timeoutMs = DEFAULT_WAIT_TMIMEOUT, intervalMs = DEFAULT_WAIT_INTERVAL) {
+  waitForCondition(name, withStatus = 'True', timeoutMs = DEFAULT_WAIT_TIMEOUT, intervalMs = DEFAULT_WAIT_INTERVAL) {
     return this.waitForTestFn(() => {
       return this.isCondition(name, withStatus);
     }, `condition ${ name }=${ withStatus }`, timeoutMs, intervalMs);
@@ -1264,6 +1264,12 @@ export default class Resource {
       delete opt.replace;
     }
 
+    // Will loading this resource invalidate the resources in the cache that represent a page (resource is not from page)
+    // By default we set this to no, it won't pollute the cache. Most likely either
+    // 1. The resource came from a list already (loaded resource is already in the page that is in the cache)
+    // 2. UI is not on a page with a list (cache doesn't represent a list)
+    const invalidatePageCache = opt.invalidatePageCache || false;
+
     try {
       const res = await this.$dispatch('request', { opt, type: this.type } );
 
@@ -1272,7 +1278,9 @@ export default class Resource {
 
       // Steve sometimes returns Table responses instead of the resource you just saved.. ignore
       if ( res && res.kind !== 'Table') {
-        await this.$dispatch('load', { data: res, existing: (forNew ? this : undefined ) });
+        await this.$dispatch('load', {
+          data: res, existing: (forNew ? this : undefined ), invalidatePageCache
+        });
       }
     } catch (e) {
       if ( this.type && this.id && e?._status === 409) {
@@ -1280,7 +1288,14 @@ export default class Resource {
         await this.$dispatch('find', {
           type: this.type,
           id:   this.id,
-          opt:  { force: true }
+          opt:  {
+            // We want to update the value in cache, so force the request
+            force: true,
+            // We're not interested in opening a watch for this specific resource
+            watch: false,
+            // Unless overridden, this will be false, we're probably from a list and we don't want to clear it's state
+            invalidatePageCache
+          }
         });
       }
 

package/plugins/steve/__tests__/subscribe.spec.ts

@@ -1,17 +1,19 @@
 import { actions, getters, mutations } from '../subscribe';
 import { REVISION_TOO_OLD } from '../../../utils/socket';
-import { STEVE_WATCH_EVENT } from '../../../types/store/subscribe.types';
+import { STEVE_WATCH_MODE } from '../../../types/store/subscribe.types';
 import backOff from '../../../utils/back-off';
+import { SteveWatchEventListenerManager } from '../../subscribe-events';
 
 describe('steve: subscribe', () => {
   describe('actions', () => {
     describe('watch', () => {
-      const state = {};
+      const state = { listenerManager: new SteveWatchEventListenerManager() };
       const getters = {
-        normalizeType: (type: string) => type,
-        schemaFor:     () => null,
-        inError:       () => false,
-        watchStarted:  () => false,
+        normalizeType:   (type: string) => type,
+        schemaFor:       () => null,
+        inError:         () => false,
+        watchStarted:    () => false,
+        listenerManager: state.listenerManager
       };
       const rootGetters = {
         'type-map/isSpoofed': () => false,
@@ -211,15 +213,11 @@ describe('steve: subscribe', () => {
         }, {
           ...obj,
           revision,
-          mode:  STEVE_WATCH_EVENT.CHANGES,
+          mode:  STEVE_WATCH_MODE.RESOURCE_CHANGES,
           force: true,
         });
 
-        expect(dispatch).toHaveBeenNthCalledWith(1, 'unwatchIncompatible', {
-          id: undefined, mode: STEVE_WATCH_EVENT.CHANGES, namespace: undefined, selector: undefined, type: obj.type
-        });
-
-        expect(dispatch).toHaveBeenNthCalledWith(2, 'send', {
+        expect(dispatch).toHaveBeenNthCalledWith(1, 'send', {
           debounceMs:      4000,
           mode:            'resource.changes',
           resourceType:    obj.type,
@@ -231,7 +229,7 @@ describe('steve: subscribe', () => {
           state, dispatch, getters, commit
         }, { ...msg });
 
-        expect(dispatch).toHaveBeenCalledTimes(2);
+        expect(dispatch).toHaveBeenCalledTimes(1);
         dispatch.mockClear();
       };
 
@@ -252,7 +250,7 @@ describe('steve: subscribe', () => {
         });
         expect(state.inError).toStrictEqual(
           {
-            'type=abc,namespace=,id=,selector=': {
+            'type=abc,namespace=,id=,selector=,mode=resource.changes': {
               obj: {
                 type: msg.resourceType,
                 mode: msg.mode,
@@ -268,7 +266,7 @@ describe('steve: subscribe', () => {
         }, { ...msg });
         // stop tries to watch again, however we're in error so will be ignored
         expect(dispatch).toHaveBeenNthCalledWith(1, 'watch', {
-          id: undefined, mode: STEVE_WATCH_EVENT.CHANGES, namespace: undefined, selector: undefined, type: obj.type
+          id: undefined, mode: STEVE_WATCH_MODE.RESOURCE_CHANGES, namespace: undefined, selector: undefined, standardWatch: true, type: obj.type
         });
 
         dispatch.mockClear();
@@ -349,19 +347,24 @@ describe('steve: subscribe', () => {
       const obj = { type: 'abc' };
       const msg = {
         resourceType: obj.type,
-        mode:         STEVE_WATCH_EVENT.CHANGES,
+        mode:         STEVE_WATCH_MODE.RESOURCE_CHANGES,
       };
 
       const initStore = () => {
-        const state = { started: [], inError: {} };
+        const state = {
+          started:         [],
+          inError:         {},
+          listenerManager: new SteveWatchEventListenerManager()
+        };
         const _getters = {
-          normalizeType: (type: string) => type,
-          schemaFor:     () => ({}),
-          storeName:     'test',
-          inError:       (...args) => getters.inError(state)(...args),
-          watchStarted:  (...args) => getters.watchStarted(state)(...args),
-          backOffId:     (...args) => getters.backOffId()(...args),
-          canBackoff:    () => true,
+          normalizeType:   (type: string) => type,
+          schemaFor:       () => ({}),
+          storeName:       'test',
+          inError:         (...args) => getters.inError(state)(...args),
+          watchStarted:    (...args) => getters.watchStarted(state)(...args),
+          backOffId:       (...args) => getters.backOffId()(...args),
+          canBackoff:      () => true,
+          listenerManager: state.listenerManager
         };
         const commit = (type, ...args) => mutations[type](state, ...args);
 

package/plugins/steve/index.js

@@ -9,6 +9,8 @@ import {
 import getters, { STEVE_MODEL_TYPES } from './getters';
 import mutations from './mutations';
 import actions from './actions';
+import { SteveWatchEventListenerManager } from '@shell/plugins/subscribe-events';
+import { markRaw } from 'vue';
 
 export function SteveFactory(namespace, baseUrl) {
   return {
@@ -17,16 +19,22 @@ export function SteveFactory(namespace, baseUrl) {
     state() {
       return {
         ...coreStoreState(namespace, baseUrl),
-        socket:           null,
-        queue:            [], // For change event coalescing
-        wantSocket:       false,
-        debugSocket:      false,
-        allowStreaming:   true,
-        pendingFrames:    [],
-        deferredRequests: {},
-        started:          [],
-        inError:          {},
-        podsByNamespace:  {}, // Cache of pods by namespace
+        socket:                null,
+        queue:                 [], // For change event coalescing
+        wantSocket:            false,
+        debugSocket:           false,
+        allowStreaming:        true,
+        pendingFrames:         [],
+        deferredRequests:      {},
+        started:               [],
+        inError:               {},
+        /**
+         * Socket listener manager for this store
+         *
+         * Instance of @SteveWatchEventListenerManager . See it's description for more info
+         */
+        socketListenerManager: markRaw(new SteveWatchEventListenerManager()),
+        podsByNamespace:       {}, // Cache of pods by namespace
       };
     },
 

package/plugins/steve/mutations.js

@@ -164,10 +164,10 @@ export default {
   },
 
   reset(state) {
-    // Reset generic store things.... then steve specific things
-
+    // 1. Reset generic store things
     resetStore(state, this.commit);
 
+    // 2. Reset steve specific store things
     this.commit(`${ state.config.namespace }/resetSubscriptions`);
 
     // Clear the podsByNamespace cache

package/plugins/steve/resourceWatcher.js

@@ -40,10 +40,10 @@ export const WATCH_STATUSES = {
  * Create a unique key for a specific resource watch's params
  */
 export const keyForSubscribe = ({
-  resourceType, type, namespace, id, selector
+  resourceType, type, namespace, id, selector, mode
 } = {}) => {
   const keyMap = {
-    type: resourceType || type, namespace, id, selector
+    type: resourceType || type, namespace, id, selector, mode
   };
 
   return Object.entries(keyMap)

package/plugins/steve/steve-pagination-utils.ts

@@ -17,9 +17,10 @@ import {
 } from '@shell/config/types';
 import { CAPI as CAPI_LAB_AND_ANO, CATTLE_PUBLIC_ENDPOINTS, STORAGE, UI_PROJECT_SECRET_COPY } from '@shell/config/labels-annotations';
 import { Schema } from '@shell/plugins/steve/schema';
-import { PaginationSettingsStore } from '@shell/types/resources/settings';
+import { PaginationSettingsStores } from '@shell/types/resources/settings';
 import paginationUtils from '@shell/utils/pagination-utils';
 import { KubeLabelSelector, KubeLabelSelectorExpression } from '@shell/types/kube/kube-api';
+import { parseField } from '@shell/utils/sort';
 
 /**
  * This is a workaround for a ts build issue found in check-plugins-build.
@@ -401,9 +402,13 @@ class StevePaginationUtils extends NamespaceProjectFilters {
 
       const joined = opt.pagination.sort
         .map((s) => {
-          this.validateField(validateFields, schema, s.field);
+          // Use the same mechanism as local sorting to flip logic for asc/des
+          const { field, reverse } = parseField(s.field);
+          const asc = reverse ? !s.asc : s.asc;
 
-          return `${ s.asc ? '' : '-' }${ this.convertArrayPath(s.field) }`;
+          this.validateField(validateFields, schema, field);
+
+          return `${ asc ? '' : '-' }${ this.convertArrayPath(field) }`;
         })
         .join(',');
 
@@ -615,7 +620,6 @@ class StevePaginationUtils extends NamespaceProjectFilters {
         res.push(`filter=!${ labelKey }`);
         break;
       case 'Gt':
-        // Currently broken - see https://github.com/rancher/rancher/issues/50057
         // Only applicable to node affinity (atm) - https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#operators
 
         if (typeof exp.values !== 'string') {
@@ -628,7 +632,6 @@ class StevePaginationUtils extends NamespaceProjectFilters {
         res.push(`filter=${ labelKey } > (${ exp.values })`);
         break;
       case 'Lt':
-        // Currently broken - see https://github.com/rancher/rancher/issues/50057
         // Only applicable to node affinity (atm) - https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#operators
         if (typeof exp.values !== 'string') {
           console.error(`Skipping labelSelector to API filter param conversion for ${ exp.key }(Lt) as no value was supplied`); // eslint-disable-line no-console
@@ -649,7 +652,7 @@ class StevePaginationUtils extends NamespaceProjectFilters {
   }
 }
 
-export const PAGINATION_SETTINGS_STORE_DEFAULTS: PaginationSettingsStore = {
+export const PAGINATION_SETTINGS_STORE_DEFAULTS: PaginationSettingsStores = {
   cluster: {
     resources: {
       enableAll:  false,
@@ -662,7 +665,7 @@ export const PAGINATION_SETTINGS_STORE_DEFAULTS: PaginationSettingsStore = {
           CATALOG.APP, CATALOG.OPERATION,
           HPA, INGRESS, SERVICE,
           PV, CONFIG_MAP, STORAGE_CLASS, PVC, SECRET,
-          WORKLOAD_TYPES.REPLICA_SET, WORKLOAD_TYPES.REPLICATION_CONTROLLER
+          WORKLOAD_TYPES.REPLICA_SET, WORKLOAD_TYPES.REPLICATION_CONTROLLER,
         ],
         generic: true,
       }
@@ -673,8 +676,8 @@ export const PAGINATION_SETTINGS_STORE_DEFAULTS: PaginationSettingsStore = {
       enableAll:  false,
       enableSome: {
         enabled: [
-          // { resource: CAPI.RANCHER_CLUSTER, context: ['home', 'side-bar'] }, // Disabled due to https://github.com/rancher/dashboard/issues/14493
-          // { resource: MANAGEMENT.CLUSTER, context: ['side-bar'] }, // Disabled due to https://github.com/rancher/dashboard/issues/14493
+          { resource: CAPI.RANCHER_CLUSTER, context: ['side-bar'] },
+          { resource: MANAGEMENT.CLUSTER, context: ['side-bar'] },
           { resource: CATALOG.APP, context: ['branding'] },
           SECRET
         ],