dashboard-shell-shell 3.0.2-test.20250913 → 3.0.5-logTest.2

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

@@ -15,9 +15,13 @@ import {
   HPA,
   SECRET
 } from '@shell/config/types';
-import { CAPI as CAPI_LAB_AND_ANO, CATTLE_PUBLIC_ENDPOINTS } from '@shell/config/labels-annotations';
+import {
+  CAPI as CAPI_LAB_AND_ANO, CATTLE_PUBLIC_ENDPOINTS, STORAGE, UI_PROJECT_SECRET, UI_PROJECT_SECRET_COPY
+} from '@shell/config/labels-annotations';
 import { Schema } from '@shell/plugins/steve/schema';
 import { PaginationSettingsStore } from '@shell/types/resources/settings';
+import paginationUtils from '@shell/utils/pagination-utils';
+import { KubeLabelSelector, KubeLabelSelectorExpression } from '@shell/types/kube/kube-api';
 
 /**
  * This is a workaround for a ts build issue found in check-plugins-build.
@@ -25,19 +29,30 @@ import { PaginationSettingsStore } from '@shell/types/resources/settings';
  * The build would error on <ns>.name, it somehow doesn't know about the steve model's properties (they are included in typegen)
  */
 interface Namespace extends ModelNamespace {
+  id: string;
   name: string;
+  metadata: {
+    name: string
+  }
 }
 
 class NamespaceProjectFilters {
   /**
    * User needs all resources.... except if there's some settings which should remove resources in specific circumstances
    */
-  protected handlePrefAndSettingFilter(allNamespaces: Namespace[], showDynamicRancherNamespaces: boolean, productHidesSystemNamespaces: boolean): PaginationParamFilter[] {
+  protected handlePrefAndSettingFilter(args: {
+    allNamespaces: Namespace[],
+    showReservedRancherNamespaces: boolean,
+    productHidesSystemNamespaces: boolean,
+  }): PaginationParamFilter[] {
+    const { allNamespaces, showReservedRancherNamespaces, productHidesSystemNamespaces } = args;
+
     // These are AND'd together
     // Not ns 1 AND ns 2
     return allNamespaces.reduce((res, ns) => {
       // Links to ns.isObscure and covers things like `c-`, `user-`, etc (see OBSCURE_NAMESPACE_PREFIX)
-      const hideObscure = showDynamicRancherNamespaces ? false : ns.isObscure;
+      const hideObscure = showReservedRancherNamespaces ? false : ns.isObscure;
+
       // Links to ns.isSystem and covers things like ns with system annotation, hardcoded list, etc
       const hideSystem = productHidesSystemNamespaces ? ns.isSystem : false;
 
@@ -58,7 +73,12 @@ class NamespaceProjectFilters {
    *
    * Users resources are those not in system namespaces
    */
-  protected handleSystemOrUserFilter(allNamespaces: Namespace[], isAllSystem: boolean, isAllUser: boolean) {
+  protected handleSystemOrUserFilter(args: {
+    allNamespaces: Namespace[],
+    isAllSystem: boolean,
+    isAllUser: boolean,
+  }) {
+    const { allNamespaces, isAllSystem } = args;
     const allSystem = allNamespaces.filter((ns) => ns.isSystem);
 
     // > Neither of these use projectsOrNamespaces to avoid scenarios where the local cluster provides a namespace which has
@@ -118,6 +138,14 @@ class NamespaceProjectFilters {
  * Helper functions for steve pagination
  */
 class StevePaginationUtils extends NamespaceProjectFilters {
+  /**
+   * Match
+   * - a-z (case insensitive)
+   * - 0-9
+   * - `-`, `_`, `.`
+   */
+  static VALID_FIELD_VALUE_REGEX = /^[\w\-.]+$/;
+
   /**
    * Filtering with the vai cache supports specific fields
    * 1) Those listed here
@@ -158,6 +186,10 @@ class StevePaginationUtils extends NamespaceProjectFilters {
     [CONFIG_MAP]: [
       { field: 'metadata.labels[harvesterhci.io/cloud-init-template]' }
     ],
+    [SECRET]: [
+      { field: `metadata.labels[${ UI_PROJECT_SECRET }]` },
+      { field: `metadata.annotations[${ UI_PROJECT_SECRET_COPY }]` },
+    ],
     [NAMESPACE]: [
       { field: 'metadata.labels[field.cattle.io/projectId]' }
     ],
@@ -168,7 +200,7 @@ class StevePaginationUtils extends NamespaceProjectFilters {
       { field: '_type' },
       { field: 'reason' },
       { field: 'involvedObject.kind' },
-      // { field: 'involvedObject.uid' }, // Pending API Support - https://github.com/rancher/rancher/issues/48603
+      { field: 'involvedObject.uid' },
       { field: 'message' },
     ],
     [CATALOG.CLUSTER_REPO]: [
@@ -189,17 +221,17 @@ class StevePaginationUtils extends NamespaceProjectFilters {
     ],
     [SERVICE]: [
       { field: 'spec.type' },
-      // { field: 'spec.clusterIP' }, // Pending API support  (blocked https://github.com/rancher/rancher/issues/48473 (index fields)
+      { field: 'spec.clusterIP' },
     ],
     [INGRESS]: [
-      // { field: 'spec.rules.host' }, // Pending API support  (blocked https://github.com/rancher/rancher/issues/48473 (index fields)
-      // { field: 'spec.ingressClassName' }, // Pending API support  (blocked https://github.com/rancher/rancher/issues/48473 (index fields)
+      { field: 'spec.rules.host' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50526
+      { field: 'spec.ingressClassName' },
     ],
     [HPA]: [
-      // { field: 'spec.scaleTargetRef.name' }, // Pending API support https://github.com/rancher/rancher/issues/48473 (hpa filtering fix)
-      // { field: 'spec.minReplicas' }, // Pending API support https://github.com/rancher/rancher/issues/48473 (hpa filtering fix)
-      // { field: 'spec.maxReplicas' }, // Pending API support https://github.com/rancher/rancher/issues/48473 (hpa filtering fix)
-      // { field: 'spec.currentReplicas' }, // Pending API support https://github.com/rancher/rancher/issues/48473 (hpa filtering fix)
+      { field: 'spec.scaleTargetRef.name' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50527
+      { field: 'spec.minReplicas' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50527
+      { field: 'spec.maxReplicas' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50527
+      { field: 'spec.currentReplicas' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50527
     ],
     [PVC]: [
       { field: 'spec.volumeName' },
@@ -210,27 +242,37 @@ class StevePaginationUtils extends NamespaceProjectFilters {
     ],
     [STORAGE_CLASS]: [
       { field: 'provisioner' },
-      // { field: `metadata.annotations[STORAGE.DEFAULT_STORAGE_CLASS]` }, // Pending API Support - https://github.com/rancher/rancher/issues/48453
+      { field: `metadata.annotations[${ STORAGE.DEFAULT_STORAGE_CLASS }]` },
     ],
     [CATALOG.APP]: [
       { field: 'spec.chart.metadata.name' }
     ],
     [WORKLOAD_TYPES.CRON_JOB]: [
-      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` }
+      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` },
+      { field: 'spec.template.spec.containers.image' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50526
     ],
     [WORKLOAD_TYPES.DAEMON_SET]: [
-      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` }
+      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` },
+      { field: 'spec.template.spec.containers.image' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50526
     ],
     [WORKLOAD_TYPES.DEPLOYMENT]: [
-      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` }
+      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` },
+      { field: 'spec.template.spec.containers.image' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50526
     ],
     [WORKLOAD_TYPES.JOB]: [
-      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` }
+      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` },
+      { field: 'spec.template.spec.containers.image' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50526
     ],
     [WORKLOAD_TYPES.STATEFUL_SET]: [
-      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` }
-    ]
-
+      { field: `metadata.annotations[${ CATTLE_PUBLIC_ENDPOINTS }]` },
+      { field: 'spec.template.spec.containers.image' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50526
+    ],
+    [WORKLOAD_TYPES.REPLICA_SET]: [
+      { field: 'spec.template.spec.containers.image' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50526
+    ],
+    [WORKLOAD_TYPES.REPLICATION_CONTROLLER]: [
+      { field: 'spec.template.spec.containers.image' }, // Pending API Support - BUG - https://github.com/rancher/rancher/issues/50526
+    ],
   }
 
   private convertArrayPath(path: string): string {
@@ -253,7 +295,7 @@ class StevePaginationUtils extends NamespaceProjectFilters {
     selection,
     isAllNamespaces,
     isLocalCluster,
-    showDynamicRancherNamespaces,
+    showReservedRancherNamespaces,
     productHidesSystemNamespaces,
   }: {
     allNamespaces: Namespace[],
@@ -263,14 +305,18 @@ class StevePaginationUtils extends NamespaceProjectFilters {
      */
     isAllNamespaces: boolean,
     /**
-     * Weird things be happening if the target cluster is local / upstream. Uses this to check what cluster we're in
+     * Weird things be happening if the target cluster is local / upstream. Use this to check what cluster we're in
      */
     isLocalCluster: boolean,
     /**
+     * User preference states we should show reserved rancher namespaces. Preference description "Show dynamic Namespaces managed by Rancher (not intended for editing or deletion)"
+     *
      * Links to ns.isObscure and covers things like `c-`, `user-`, etc (see OBSCURE_NAMESPACE_PREFIX)
      */
-    showDynamicRancherNamespaces: boolean,
+    showReservedRancherNamespaces: boolean,
     /**
+     * Product config states that system namespaces should be hidden
+     *
      * Links to ns.isSystem and covers things like ns with system annotation, hardcoded list, etc
      */
     productHidesSystemNamespaces: boolean,
@@ -288,7 +334,7 @@ class StevePaginationUtils extends NamespaceProjectFilters {
     //   - Only System Namespaces - Gimme resources in the system namespaces (which shouldn't be many namespaces)
     //   - Only User Namespaces - Gimme resources NOT in system namespaces
     //   - User selection - Gimme resources in specific Projects or Namespaces
-    if (isAllNamespaces && (showDynamicRancherNamespaces && !productHidesSystemNamespaces)) {
+    if (isAllNamespaces && (showReservedRancherNamespaces && !productHidesSystemNamespaces)) {
       // No-op. Everything is returned
       return {
         projectsOrNamespaces: [],
@@ -303,9 +349,11 @@ class StevePaginationUtils extends NamespaceProjectFilters {
     // &filter=metadata.namespace=abc
     let filters: PaginationParamFilter[] = [];
 
-    if (!showDynamicRancherNamespaces || productHidesSystemNamespaces) {
-      // We need to hide dynamic namespaces ('c-', 'p-', etc) OR system namespaces
-      filters = this.handlePrefAndSettingFilter(allNamespaces, showDynamicRancherNamespaces, productHidesSystemNamespaces);
+    if (!showReservedRancherNamespaces || productHidesSystemNamespaces) {
+      // We need to hide reserved namespaces ('c-', 'user-', etc) OR system namespaces
+      filters = this.handlePrefAndSettingFilter({
+        allNamespaces, showReservedRancherNamespaces, productHidesSystemNamespaces
+      });
     }
 
     const isAllSystem = selection[0] === NAMESPACE_FILTER_ALL_SYSTEM;
@@ -313,7 +361,9 @@ class StevePaginationUtils extends NamespaceProjectFilters {
 
     if (selection.length === 1 && (isAllSystem || isAllUser)) {
       // Filter by resources either in or not in system namespaces
-      filters.push(...this.handleSystemOrUserFilter(allNamespaces, isAllSystem, isAllUser ));
+      filters.push(...this.handleSystemOrUserFilter({
+        allNamespaces, isAllSystem, isAllUser
+      }));
     } else {
       // User has one or more projects or namespaces
       const res = this.handleSelectionFilter(selection, isLocalCluster);
@@ -328,13 +378,13 @@ class StevePaginationUtils extends NamespaceProjectFilters {
     };
   }
 
-  public createParamsForPagination(schema: Schema, opt: ActionFindPageArgs): string | undefined {
+  public createParamsForPagination({ schema, opt }: {schema?: Schema, opt: ActionFindPageArgs}): string | undefined {
     if (!opt.pagination) {
       return;
     }
 
     const params: string[] = [];
-    const namespaceParam = this.convertPaginationParams(schema, opt.pagination.projectsOrNamespaces);
+    const namespaceParam = this.convertPaginationParams({ schema, filters: opt.pagination.projectsOrNamespaces });
 
     if (namespaceParam) {
       params.push(namespaceParam);
@@ -344,8 +394,11 @@ class StevePaginationUtils extends NamespaceProjectFilters {
       params.push(`page=${ opt.pagination.page }`);
     }
 
-    if (opt.pagination.pageSize) {
+    if (!!opt.pagination.pageSize || opt.pagination.pageSize === 0) {
       params.push(`pagesize=${ opt.pagination.pageSize }`);
+    } else {
+      // Prevent unlimited resources in response
+      params.push(`pagesize=${ paginationUtils.defaultPageSize }`);
     }
 
     if (opt.pagination.sort?.length) {
@@ -365,12 +418,20 @@ class StevePaginationUtils extends NamespaceProjectFilters {
       params.push(`sort=${ joined }`);
 
       if (validateFields.invalid.length) {
-        console.warn(`Pagination API does not support sorting '${ schema.id }' by the requested fields: ${ uniq(validateFields.invalid).join(', ') }`); // eslint-disable-line no-console
+        console.warn(`Pagination API does not support sorting '${ schema?.id || opt.url }' by the requested fields: ${ uniq(validateFields.invalid).join(', ') }`); // eslint-disable-line no-console
       }
     }
 
     if (opt.pagination.filters?.length) {
-      const filters = this.convertPaginationParams(schema, opt.pagination.filters);
+      const filters = this.convertPaginationParams({ schema, filters: opt.pagination.filters });
+
+      if (filters) {
+        params.push(filters);
+      }
+    }
+
+    if (opt.pagination.labelSelector) {
+      const filters = this.convertLabelSelectorPaginationParams({ labelSelector: opt.pagination.labelSelector });
 
       if (filters) {
         params.push(filters);
@@ -386,7 +447,7 @@ class StevePaginationUtils extends NamespaceProjectFilters {
   /**
    * Check if the API supports filtering by this field
    */
-  private validateField(state: { checked: string[], invalid: string[]}, schema: Schema, field?: string) {
+  private validateField(state: { checked: string[], invalid: string[]}, schema?: Schema, field?: string) {
     if (!field) {
       return; // no field, so not invalid
     }
@@ -399,7 +460,7 @@ class StevePaginationUtils extends NamespaceProjectFilters {
 
     // First check in our hardcoded list of supported filters
     if (
-      process.env.NODE_ENV === 'dev' &&
+      !!schema &&
       [
         StevePaginationUtils.VALID_FIELDS[''], // Global
         StevePaginationUtils.VALID_FIELDS[schema.id], // Type specific
@@ -430,7 +491,7 @@ class StevePaginationUtils extends NamespaceProjectFilters {
   /**
    * Convert our {@link PaginationParam} definition of params to a set of url params
    */
-  private convertPaginationParams(schema: Schema, filters: PaginationParam[] = []): string {
+  private convertPaginationParams({ schema, filters = [] }: {schema?: Schema, filters: PaginationParam[]}): string {
     const validateFields = {
       checked: new Array<string>(),
       invalid: new Array<string>(),
@@ -444,15 +505,29 @@ class StevePaginationUtils extends NamespaceProjectFilters {
               // Check if the API supports filtering by this field
               this.validateField(validateFields, schema, field.field);
 
-              const value = encodeURIComponent(field.value);
+              // we're just checking that the field exists, so there's no value
+              if (field.exists) {
+                return field.field;
+              }
+              const encodedValue = encodeURIComponent(field.value || '');
 
               // = exact match (equals + exact)
               // ~ partial match (equals + !exact)
               // != not exact match (!equals + exact)
               // !~ not partial match (!equals + !exact)
               const operator = `${ field.equals ? '' : '!' }${ field.exact ? '=' : '~' }`;
-
-              return `${ this.convertArrayPath(field.field) }${ operator }${ value }`;
+              let safeValue;
+
+              if (StevePaginationUtils.VALID_FIELD_VALUE_REGEX.test(field.value || '')) {
+                // Does not contain any protected characters, send as is
+                safeValue = encodedValue;
+              } else {
+                // Contains protected characters, wrap in quotes to ensure backend doesn't fail
+                // - replace reserver `"`/`%22` with empty string - see https://github.com/rancher/dashboard/issues/14549 for improvement
+                safeValue = `"${ encodedValue.replaceAll('%22', '') }"`;
+              }
+
+              return `${ this.convertArrayPath(field.field) }${ operator }${ safeValue }`;
             }
 
             return field.value;
@@ -470,11 +545,116 @@ class StevePaginationUtils extends NamespaceProjectFilters {
     const res = Object.keys(unique).join('&'); // This means AND
 
     if (validateFields.invalid.length) {
-      console.warn(`Pagination API does not support filtering '${ schema.id }' by the requested fields: ${ uniq(validateFields.invalid).join(', ') }`); // eslint-disable-line no-console
+      console.warn(`Pagination API does not support filtering '${ schema?.id || 'unknown' }' by the requested fields: ${ uniq(validateFields.invalid).join(', ') }`); // eslint-disable-line no-console
     }
 
     return res;
   }
+
+  /**
+   * Convert kube labelSelector object into steve filter params
+   *
+   * A lot of the requirements and details are taken directly from
+   * https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
+   */
+  private convertLabelSelectorPaginationParams({ labelSelector }: { labelSelector: KubeLabelSelector}): string {
+    // Get a list of matchExpressions
+    const expressions: KubeLabelSelectorExpression[] = labelSelector.matchExpressions ? [...labelSelector.matchExpressions] : [];
+
+    // matchLabels are just simpler versions of matchExpressions, for ease convert them
+    if (labelSelector.matchLabels) {
+      Object.entries(labelSelector.matchLabels).forEach(([key, value]) => {
+        const expression: KubeLabelSelectorExpression = {
+          key,
+          values:   [value],
+          operator: 'In'
+        };
+
+        expressions.push(expression);
+      });
+    }
+
+    // concert all matchExpressions into string params
+    const filters: string[] = expressions.reduce((res, exp) => {
+      const labelKey = `metadata.labels[${ exp.key }]`;
+
+      switch (exp.operator) {
+      case 'In':
+        if (!exp.values?.length) {
+          console.error(`Skipping labelSelector to API filter param conversion for ${ exp.key }(IN) as no value was supplied`); // eslint-disable-line no-console
+
+          return res;
+        }
+
+        // foo IN [bar] => ?filter=foo+IN+(bar)
+        // foo IN [bar, baz2] => ?filter=foo+IN+(bar,baz2)
+        res.push(`filter=${ labelKey } IN (${ exp.values.join(',') })`);
+        break;
+      case 'NotIn':
+
+        if (!exp.values?.length) {
+          console.error(`Skipping labelSelector to API filter param conversion for ${ exp.key }(NOTIN) as no value was supplied`); // eslint-disable-line no-console
+
+          return res;
+        }
+
+        // aaa NotIn [bar, baz2]=> ?filter=foo+NOTIN+(bar,baz2)
+        res.push(`filter=${ labelKey } NOTIN (${ exp.values.join(',') })`);
+        break;
+      case 'Exists':
+
+        if (exp.values?.length) {
+          console.error(`Skipping labelSelector to API filter param conversion for ${ exp.key }(Exists) as no value was supplied`); // eslint-disable-line no-console
+
+          return res;
+        }
+
+        // bbb Exists=> ?filter=bbb
+        res.push(`filter=${ labelKey }`);
+        break;
+      case 'DoesNotExist':
+        if (exp.values?.length) {
+          console.error(`Skipping labelSelector to API filter param conversion for ${ exp.key }(DoesNotExist) as no value was supplied`); // eslint-disable-line no-console
+
+          return res;
+        }
+
+        // ccc DoesNotExist ?filter=!bbb. # or %21bbb
+        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') {
+          console.error(`Skipping labelSelector to API filter param conversion for ${ exp.key }(Gt) as no value was supplied`); // eslint-disable-line no-console
+
+          return res;
+        }
+
+        // ddd Gt 1=> ?filter=ddd+>+1
+        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
+
+          return res;
+        }
+
+        // eee Lt 2=> ?filter=eee+<+2
+        res.push(`filter=${ labelKey } < (${ exp.values })`);
+        break;
+      }
+
+      return res;
+    }, [] as string[]);
+
+    // "All of the requirements, from both matchLabels and matchExpressions are ANDed together -- they must all be satisfied in order to match"
+    return filters.join('&');
+  }
 }
 
 export const PAGINATION_SETTINGS_STORE_DEFAULTS: PaginationSettingsStore = {
@@ -487,7 +667,7 @@ export const PAGINATION_SETTINGS_STORE_DEFAULTS: PaginationSettingsStore = {
         enabled: [
           NODE, EVENT,
           WORKLOAD_TYPES.CRON_JOB, WORKLOAD_TYPES.DAEMON_SET, WORKLOAD_TYPES.DEPLOYMENT, WORKLOAD_TYPES.JOB, WORKLOAD_TYPES.STATEFUL_SET, POD,
-          CATALOG.APP, CATALOG.CLUSTER_REPO, CATALOG.OPERATION,
+          CATALOG.APP, CATALOG.OPERATION,
           HPA, INGRESS, SERVICE,
           PV, CONFIG_MAP, STORAGE_CLASS, PVC, SECRET,
           WORKLOAD_TYPES.REPLICA_SET, WORKLOAD_TYPES.REPLICATION_CONTROLLER
@@ -501,8 +681,10 @@ export const PAGINATION_SETTINGS_STORE_DEFAULTS: PaginationSettingsStore = {
       enableAll:  false,
       enableSome: {
         enabled: [
-          { resource: CAPI.RANCHER_CLUSTER, context: ['home', 'side-bar'] },
-          { resource: MANAGEMENT.CLUSTER, context: ['side-bar'] },
+          // { 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: CATALOG.APP, context: ['branding'] },
+          SECRET
         ],
         generic: false,
       }