@rancher/shell 3.0.12-rc.5 → 3.0.12-rc.6

package/types/store/type-map.ts

@@ -1,3 +1,264 @@
+import { PluginRouteRecordRaw } from '@shell/core/types';
+
+/**
+ * The product as seen by the type-map
+ */
+export interface TypeMapProduct {
+  /**
+   * The category this product belongs under. i.e. 'config'
+   */
+  category?: string;
+
+  /**
+   * Hide the Copy KubeConfig button in the header
+   */
+  hideCopyConfig?: boolean;
+
+  /**
+   * Hide the Download KubeConfig button in the header
+   */
+  hideKubeConfig?: boolean;
+
+  /**
+   * Hide the Kubectl Shell button in the header
+   */
+  hideKubeShell?: boolean;
+
+  /**
+   * Hide the Namespace location
+   */
+  hideNamespaceLocation?: boolean;
+
+  /**
+   * Hide the system resources
+   */
+  hideSystemResources?: boolean;
+
+  /**
+   * The icon that should be displayed beside this item in the navigation.
+   */
+  icon?: string;
+
+    /**
+   * Alternative to the icon property. Uses require
+   */
+  svg?: Function;
+
+  /**
+   * Only load the product if the feature is present
+   */
+  ifFeature?: string | RegExp;
+
+  /**
+   * Only load the product if the type is present
+   */
+  ifHave?: string;
+
+  /**
+   * Only load the product if the group is present
+   */
+  ifHaveGroup?: string | RegExp;
+
+  /**
+   * Only load the product if the type is present
+   */
+  ifHaveType?: string | RegExp;
+
+  /**
+   * Hide the product if the type is present (opposite of ifHaveType)
+   */
+  ifNotHaveType?: string | RegExp;
+
+  /**
+   * The vuex store that this product should use by default i.e. 'management'
+   */
+  inStore?: string;
+
+  /**
+   * Show the cluster switcher in the navigation
+   */
+  showClusterSwitcher?: boolean;
+
+  /**
+   * Indicates whether UI Extensions can add pages to this product
+   */
+  extendable?: boolean;
+
+  /**
+   * Show the namespace filter in the header
+   */
+  showNamespaceFilter?: boolean;
+
+  /**
+   * A number used to determine where in navigation this item will be placed. The highest number will be at the top of the list.
+   */
+  weight?: number;
+
+  /**
+   * The route that the product will lead to if click on in navigation.
+   */
+  to?: PluginRouteRecordRaw;
+
+  /**
+   * Product name
+   *
+   * Defaults to the DSL fn product arg
+   */
+  name?: string;
+
+  /**
+   *
+   */
+  label?: string;
+
+  labelKey?: string;
+
+  iconHeader?: string;
+
+  // Do not use - internal use only
+  version?: number;
+
+  renameGroups?: {
+    /** String or regex to match against group internal IDs */
+    groupSelector: RegExp | string;
+    /** Display name to use for matching groups */
+    newName: string;
+  }[];
+
+  moveToGroup?: {
+    /** Page identifier — the resource `type` string or the custom page `name` */
+    entryId: string;
+    /** Target group name as defined in your group config (`name` property) */
+    groupName: string;
+    /** Ordering weight for the mapping (default: 5). Higher weight takes precedence when multiple rules match */
+    weight?: number;
+  }[];
+
+  ignoreGroups?: {
+    /** String or regex to match against group names */
+    groupSelector: string | RegExp;
+    /** Optional conditional function that accepts the root Dashboard Vuex store getters and returns true if the group should be ignored */
+    condition?: (getters: any) => boolean;
+  }[];
+
+  /**
+   * Whether the product can be removed by users (default: false — products are built-in/not removable unless explicitly set to true)
+   */
+  removable?: boolean;
+  /**
+   *  controls whether a workspace switcher dropdown appears in the header (instead of the namespace filter) if set to true
+   */
+  showWorkspaceSwitcher?: boolean;
+
+  /**
+   * Leaving these here for completeness but I don't think these should be advertised as useable to plugin creators.
+   */
+  // ifHaveVerb: string | RegExp;
+  // supportRoute: string;
+  // typeStoreMap: string;
+}
+
+/**
+ * Used by type-map configureType
+ */
+export interface TypeMapConfigureType {
+  /** Override for the name displayed */
+  displayName?: string;
+  /** Override for the create button string on a list view */
+  listCreateButtonLabelKey?: string;
+  /** If false, disable create even if schema says it's allowed */
+  isCreatable?: boolean;
+  /** If false, disable for edit */
+  isEditable?: boolean;
+  /** If false, disable for remove/delete */
+  isRemovable?: boolean;
+  /** If false, hide state in columns and masthead */
+  showState?: boolean;
+  /** If false, hide age in columns and masthead */
+  showAge?: boolean;
+  /** If false, hide masthead config button in view mode */
+  showConfigView?: boolean;
+  /** If false, hide masthead in list view */
+  showListMasthead?: boolean;
+  /** If false, cannot edit or show yaml */
+  canYaml?: boolean;
+  /** Show the Masthead in the edit resource component */
+  resourceEditMasthead?: boolean;
+  /** Entry route definition for this resource page */
+  customRoute?: PluginRouteRecordRaw | Object;
+  /** Hide this type from the nav/search bar on downstream clusters (will only show in "local" cluster) */
+  localOnly?: boolean;
+  // resource: undefined; // Use this resource in ResourceDetails instead
+  // resourceDetail: undefined; // Use this resource specifically for ResourceDetail's detail component
+  // resourceEdit: undefined; // Use this resource specifically for ResourceDetail's edit component
+  /**
+   * Use this to depaginate requests for this type
+   */
+  depaginate?: undefined;
+  // notFilterNamespace: undefined; // Define namespaces that do not need to be filtered
+  // used in configureType options, to be typed later if needed
+
+  /**
+   * Whether this custom page has list groups (definition for grouping items in the list view)
+   */
+  listGroups?: {
+    /** Icon for the group (relates to icons in rancher-icons */
+    icon?: string;
+    /** Value for the group (used for grouping items in the list view) */
+    value?: string;
+    /** Field for the group (used for grouping items in the list view) */
+    field?: string;
+    /** Column to hide when this group is active */
+    hideColumn?: string;
+    /** Tooltip key for the group */
+    tooltipKey?: string;
+  }[];
+
+      /**
+     * Whether the provided list groups will override the default grouping options (e.g. group by namespace, group by cluster, etc.) or be added to them
+     */
+    listGroupsWillOverride?: boolean;
+
+    /**
+    * Use this to configure subtypes that should be shown in the list view for this type (e.g. show "pods" and "deployments" in the list view for "workloads")
+    */
+    subTypes?: string[];
+}
+
+/**
+ * Used by type-map virtualType
+ */
+export interface TypeMapVirtualType {
+  /** Display only if condition is met (relates to IF_HAVE in shell/store/type-map) */
+  ifHave?: boolean;
+  /** Display only if feature is present (relates to shell/store/features) */
+  ifFeature?: string;
+  /** Display only if resource type exists */
+  ifHaveType?: string;
+  /** Used in conjunction with "ifHaveType", display only if resource type allows this verb (GET, POST, PUT, DELETE) */
+  ifHaveVerb?: string;
+  /** Display label for the custom page */
+  label?: string;
+  /** Translation key for the label */
+  labelKey?: string;
+  name: string;
+  // /** Name of the page (unique identifier) */
+  // name?: string;
+  /** Entry route definition for this custom page */
+  route?: PluginRouteRecordRaw | Object;
+  /** Icon for the custom page (relates to icons in https://github.com/rancher/icons) */
+  icon?: 'compass';
+  /** Whether this custom page is namespaced or not */
+  namespaced?: boolean;
+  /** Ordering weight for the custom page */
+  weight?: number;
+  /** Whether this custom page is exact match */
+  exact?: boolean;
+  /** Whether this custom page will act as an overview page */
+  overview?: boolean;
+  /** Whether this custom page has an exact path match */
+  'exact-path'?: boolean;
+}
 
 /**
  * interface for type-map's' definition for table headers/columns
@@ -11,7 +272,7 @@ export interface TableColumn {
   formatterOpts?: any,
   width?: number,
   tooltip?: string,
-  search?: string | boolean,
+  search?: string | string[] | boolean,
 }
 
 export const COLUMN_BREAKPOINTS = {

package/utils/async.ts

@@ -5,6 +5,8 @@ export const waitFor = (testFn: Function, msg = '', timeoutMs = 3000000, interva
     if (testFn()) {
       gatedLog('Wait for', msg || 'unknown', 'done immediately');
       resolve(this);
+
+      return;
     }
     const timeout = setTimeout(() => {
       gatedLog('Wait for', msg, 'timed out');

package/utils/grafana.js

@@ -1,6 +1,5 @@
-import { haveV2Monitoring } from '@shell/utils/monitoring';
+import { haveV2Monitoring, fetchMonitoringVersion } from '@shell/utils/monitoring';
 import { parse as parseUrl, addParam } from '@shell/utils/url';
-import { CATALOG } from '@shell/config/types';
 
 // these two versions of monitoring included a bug fix attempt that required the local cluster to use a different url
 // the solution going forward doesn't require this, see https://github.com/rancher/dashboard/issues/8885
@@ -60,21 +59,7 @@ export async function dashboardExists(monitoringVersion, store, clusterId, embed
 }
 
 export async function allDashboardsExist(store, clusterId, embeddedUrls, storeName = 'cluster', projectId = null) {
-  let res;
-
-  let monitoringVersion = '';
-
-  if (!projectId && store.getters[`${ storeName }/canList`](CATALOG.APP)) {
-    try {
-      res = await store.dispatch(`${ storeName }/find`, {
-        type: CATALOG.APP,
-        id:   'cattle-monitoring-system/rancher-monitoring'
-      });
-    } catch (err) {
-    }
-
-    monitoringVersion = res?.currentVersion;
-  }
+  const monitoringVersion = projectId ? '' : await fetchMonitoringVersion(store, storeName);
 
   const existPromises = embeddedUrls.map((url) => dashboardExists(monitoringVersion, store, clusterId, url, storeName, projectId));
 

package/utils/monitoring.js

@@ -1,6 +1,6 @@
 // Helpers for determining if V2 or v1 Monitoring are installed
 
-import { SCHEMA, MONITORING, ENDPOINTS } from '@shell/config/types';
+import { SCHEMA, MONITORING, ENDPOINTS, CATALOG } from '@shell/config/types';
 import { normalizeType } from '@shell/plugins/dashboard-store/normalize';
 import { findBy } from '@shell/utils/array';
 import { isEmpty } from '@shell/utils/object';
@@ -30,6 +30,43 @@ export function haveV2Monitoring(getters) {
 
 export const CATTLE_MONITORING_NAMESPACE = 'cattle-monitoring-system';
 
+/**
+ * Look up the installed Rancher monitoring app, preferring the new
+ * `rancher-monitoring-dashboards` chart and falling back to the legacy
+ * `rancher-monitoring`. Returns null if the user lacks permission, neither
+ * chart is installed, or any lookup fails.
+ */
+export async function fetchMonitoringApp(store, storeName) {
+  if (!store.getters[`${ storeName }/canList`](CATALOG.APP)) {
+    return null;
+  }
+
+  const ids = [
+    `${ CATTLE_MONITORING_NAMESPACE }/rancher-monitoring-dashboards`,
+    `${ CATTLE_MONITORING_NAMESPACE }/rancher-monitoring`,
+  ];
+
+  for (const id of ids) {
+    try {
+      const res = await store.dispatch(`${ storeName }/find`, { type: CATALOG.APP, id });
+
+      if (res) {
+        return res;
+      }
+    } catch (err) {
+      // Try the next id; both failing means nothing is installed.
+    }
+  }
+
+  return null;
+}
+
+export async function fetchMonitoringVersion(store, storeName) {
+  const app = await fetchMonitoringApp(store, storeName);
+
+  return app?.currentVersion || '';
+}
+
 async function hasEndpointSubsets(store, id) {
   if (store.getters['cluster/schemaFor'](ENDPOINTS)) {
     const endpoints = await store.dispatch('cluster/findAll', { type: ENDPOINTS }) || [];