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

package/core/types.ts

@@ -1,13 +1,9 @@
-import { ProductFunction } from './plugin';
 import { RouteRecordRaw } from 'vue-router';
 import type { ExtensionManager } from '@shell/types/extension-manager';
 import { PaginationSettingsStores } from '@shell/types/resources/settings';
-import type {
-  ProductMetadata, ProductSinglePage,
-  StandardProductName, RouteRecordRawWithParams, ProductChild,
-  ProductChildGroup,
-  ProductChildPage
-} from './plugin-types';
+import { IExtensionProducts } from '@shell/core/plugin-products-external';
+import { RouteRecordRawWithParams } from '@shell/core/plugin-types';
+import { TypeMapProduct } from '@shell/types/store/type-map';
 
 // Cluster Provisioning types
 export * from './types-provisioning';
@@ -200,137 +196,6 @@ export type ExtensionEnvironment = {
   docsVersion: string; /** e.g. 'v2.10' */
 };
 
-export interface ProductOptions {
-  /**
-   * 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,
-
-  /**
-   * 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;
-
-  /**
-   * Whether the product can be removed by users (default: false — products are built-in/not removable unless explicitly set to true)
-   */
-  removable?: boolean;
-
-  /**
-   * Alternative to the icon property. Uses require
-   */
-  svg?: Function;
-
-  /**
-   * Product name
-   */
-  name?: string;
-
-  /**
-   *  controls whether a workspace switcher dropdown appears in the header (instead of the namespace filter) if set to true
-   */
-  showWorkspaceSwitcher?: boolean;
-
-  /**
-   *
-   */
-  label?: string;
-
-  labelKey?: string;
-
-  iconHeader?: string;
-
-  // Do not use - internal use only
-  version?: number;
-
-  /**
-   * 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;
-}
-
 /**
  * Configuration required to show a header in a ResourceTable
  */
@@ -399,17 +264,6 @@ export interface HeaderOptions {
  */
 export type PaginationHeaderOptions = Omit<HeaderOptions, 'getValue'>
 
-export type ResourceTypeConfig = {
-  options?: {
-    isCreatable?: boolean;
-    isEditable?: boolean;
-  },
-  listHeaders?: {
-    legacy?: HeaderOptions[];
-    paginated?: PaginationHeaderOptions[];
-  }
-};
-
 /**
  * External extension configuration for @HeaderOptions
  */
@@ -568,7 +422,7 @@ export interface DSLReturnType {
    * @param options {@link ProductOptions}
    * @returns {@link void}
    */
-  product: (options: ProductOptions) => void;
+  product: (options: TypeMapProduct) => void;
 
   /**
    /**
@@ -691,62 +545,12 @@ export type ModelExtensionContext = {
 /**
  * Constructor signature for a model extension
  */
-export type ModelExtensionConstructor = (context: ModelExtensionContext) => Object;
+export type ModelExtensionConstructor = new (context: ModelExtensionContext) => Object;
 
 /**
  * Interface for a UI Extension
  */
-export interface IExtension {
-  /**
-   * Register a top-level product as a flag on the plugin
-   * @internal - DO NOT USE - Internal API only
-   */
-  _registerTopLevelProduct(): void;
-  /**
-   *
-   * @internal - DO NOT USE - Internal API only
-   */
-  _setStartRouteWithProduct(value: boolean): void;
-
-  /**
-   * Add a product to the sidebar, with children and a side menu for navigation for internal pages
-   * @param name
-   * @param config
-   */
-  addProduct(product: ProductMetadata, config: ProductChildPage[]): void;
-  addProduct(product: ProductMetadata, config: ProductChildGroup[]): void;
-  addProduct(product: ProductMetadata, config: ProductChild[]): void;
-
-  /**
-   * Add a product to the sidebar, without children (no side menu, single page only)
-   * @param product
-   */
-  addProduct(product: ProductSinglePage): void;
-
-  /**
-   * Add a product with just a name (convenience/bridge method for quick setup).
-   * Creates a basic product with an empty page component automatically.
-   * This is useful for getting started quickly - expand to the full API once you're ready to add custom pages.
-   * @param productName Simple product name - will be used as both the name and label
-   */
-  addProduct(productName: string): void;
-
-  /**
-   * Add a product to the sidebar (deprecated, use other signatures of addProduct instead)
-   * @deprecated Use other `addProduct` signatures instead
-   * @param importFn Function that will import the module containing a product definition
-   */
-  addProduct(importFn: ProductFunction): void;
-
-  /**
-   * Extend an existing product in Rancher, with children and a side menu for navigation for internal pages
-   *
-   * @param product Product to be extended
-   * @param config Product extension configuration
-   */
-  extendProduct(product: StandardProductName | string, config: ProductChildPage[]): void;
-  extendProduct(product: StandardProductName | string, config: ProductChildGroup[]): void;
-  extendProduct(product: StandardProductName | string, config: ProductChild[]): void;
+export interface IExtension extends IExtensionProducts {
 
   /**
    * Add a locale to the i18n store

package/detail/__tests__/provisioning.cattle.io.cluster.test.ts

@@ -241,4 +241,56 @@ describe('view: provisioning.cattle.io.cluster', () => {
       expect(wrapper.vm.fakeMachines).toHaveLength(0);
     });
   });
+
+  describe('computed: showLog', () => {
+    it('returns true when mgmt has a log link and extDetailTabs.logs is enabled', async() => {
+      const value = { mgmt: { hasLink: (link: string) => link === 'log' } };
+
+      const wrapper = shallowMount(ProvisioningCattleIoCluster, {
+        props:  { value },
+        global: { mocks },
+      });
+
+      await wrapper.setData({ extDetailTabs: { logs: true } });
+
+      expect(wrapper.vm.showLog).toStrictEqual(true);
+    });
+
+    it('returns false when mgmt does not have a log link', async() => {
+      const value = { mgmt: { hasLink: () => false } };
+
+      const wrapper = shallowMount(ProvisioningCattleIoCluster, {
+        props:  { value },
+        global: { mocks },
+      });
+
+      await wrapper.setData({ extDetailTabs: { logs: true } });
+
+      expect(wrapper.vm.showLog).toStrictEqual(false);
+    });
+
+    it('returns false when mgmt has a log link but extDetailTabs.logs is disabled', async() => {
+      const value = { mgmt: { hasLink: (link: string) => link === 'log' } };
+
+      const wrapper = shallowMount(ProvisioningCattleIoCluster, {
+        props:  { value },
+        global: { mocks },
+      });
+
+      await wrapper.setData({ extDetailTabs: { logs: false } });
+
+      expect(wrapper.vm.showLog).toStrictEqual(false);
+    });
+
+    it('returns false when mgmt is undefined', async() => {
+      const value = {};
+
+      const wrapper = shallowMount(ProvisioningCattleIoCluster, {
+        props:  { value },
+        global: { mocks },
+      });
+
+      expect(wrapper.vm.showLog).toBeFalsy();
+    });
+  });
 });

package/detail/pod.vue

@@ -38,7 +38,7 @@ export default {
       const projectId = namespace?.metadata?.labels[PROJECT];
 
       if (projectId) {
-        this.POD_PROJECT_METRICS_DETAIL_URL = `/api/v1/namespaces/cattle-project-${ projectId }-monitoring/services/http:cattle-project-${ projectId }-monitoring-grafana:80/proxy/d/rancher-pod-containers-1/rancher-pod-containers?orgId=1'`;
+        this.POD_PROJECT_METRICS_DETAIL_URL = `/api/v1/namespaces/cattle-project-${ projectId }-monitoring/services/http:cattle-project-${ projectId }-monitoring-grafana:80/proxy/d/rancher-pod-containers-1/rancher-pod-containers?orgId=1`;
         this.POD_PROJECT_METRICS_SUMMARY_URL = `/api/v1/namespaces/cattle-project-${ projectId }-monitoring/services/http:cattle-project-${ projectId }-monitoring-grafana:80/proxy/d/rancher-pod-1/rancher-pod?orgId=1`;
 
         this.showProjectMetrics = await allDashboardsExist(this.$store, this.currentCluster.id, [this.POD_PROJECT_METRICS_DETAIL_URL, this.POD_PROJECT_METRICS_SUMMARY_URL], 'cluster', projectId);

package/detail/provisioning.cattle.io.cluster.vue

@@ -227,9 +227,7 @@ export default {
     if ( this.$store.getters['management/canList'](MANAGEMENT.RKE_TEMPLATE) ) {
       this.$store.dispatch('management/findAll', { type: MANAGEMENT.RKE_TEMPLATE });
     }
-  },
 
-  created() {
     if ( this.showLog ) {
       this.connectLog();
     }

package/edit/auth/AuthProviderWarningBanners.vue

@@ -1,12 +1,17 @@
 <script lang="ts">
 import { defineComponent } from 'vue';
 import { Banner } from '@components/Banner';
+import { HIDE_LOCAL_AUTH_PROVIDER } from '@shell/store/features';
 
 export default defineComponent({
   name: 'AuthProviderWarningBanners',
 
   components: { Banner },
 
+  data() {
+    return { disableLocalAuth: this.$store.getters['features/get'](HIDE_LOCAL_AUTH_PROVIDER) };
+  },
+
   props: {
     tArgs: {
       type:     Object,
@@ -24,6 +29,13 @@ export default defineComponent({
       color="warning"
       data-testid="auth-provider-disabled-warning-banner"
     />
+    <Banner
+      v-if="disableLocalAuth"
+      color="warning"
+      data-testid="auth-provider-disable-local-auth-banner"
+    >
+      <span v-clean-html="t('authConfig.bannerEnableAuthProvider', {}, true)" />
+    </Banner>
     <Banner
       color="warning"
       data-testid="auth-provider-admin-permissions-warning-banner"

package/edit/auth/__tests__/AuthProviderWarningBanners.test.ts

@@ -4,7 +4,16 @@ import { mount } from '@vue/test-utils';
 describe('component: AuthProviderWarningBanners.vue', () => {
   const wrapper = mount(AuthProviderWarningBanners, {
     props:  { tArgs: { provider: 'Any Provider', username: 'username' } },
-    global: { mocks: { $store: { getters: { 'i18n/t': (text: string) => text } } } }
+    global: {
+      mocks: {
+        $store: {
+          getters: {
+            'i18n/t':       (text: string) => text,
+            'features/get': () => false,
+          }
+        }
+      }
+    }
   });
 
   it('should render properly', () => {

package/edit/auth/__tests__/azuread.test.ts

@@ -52,6 +52,7 @@ const requiredSetup = (modelOverrides = {}) => ({
           'current_store/all':       jest.fn(),
           'i18n/t':                  (val: string) => val,
           'i18n/exists':             jest.fn(),
+          'features/get':            () => false,
         },
         dispatch: jest.fn()
       },

package/edit/auth/__tests__/github.test.ts

@@ -56,6 +56,7 @@ const requiredSetup = (modelOverrides = {}, dataOverrides = {}) => ({
           'current_store/all':       jest.fn(),
           'i18n/t':                  (val: string) => val,
           'i18n/exists':             jest.fn(),
+          'features/get':            () => false,
         },
         dispatch: jest.fn(),
       },

package/edit/auth/__tests__/oidc.test.ts

@@ -69,6 +69,7 @@ describe('oidc.vue', () => {
               'current_store/all':       jest.fn(),
               'i18n/t':                  (val: string) => val,
               'i18n/exists':             jest.fn(),
+              'features/get':            () => false,
             },
             dispatch: jest.fn()
           },

package/edit/auth/__tests__/saml.test.ts

@@ -63,6 +63,7 @@ const mountOptions = (model: object) => ({
           'current_store/all':       jest.fn(),
           'i18n/t':                  (val: string) => val,
           'i18n/exists':             jest.fn(),
+          'features/get':            () => false,
         },
         dispatch: jest.fn(),
       },

package/edit/auth/ldap/__tests__/index.test.ts

@@ -59,6 +59,7 @@ const buildSetup = (type = 'openldap', modelOverride = {}, localDataOverride = {
           'current_store/all':       jest.fn(),
           'i18n/t':                  (val: string) => val,
           'i18n/exists':             jest.fn(),
+          'features/get':            () => false,
         },
         dispatch: jest.fn()
       },

package/edit/provisioning.cattle.io.cluster/index.vue

@@ -87,7 +87,7 @@ export default {
       await this.$store.dispatch('management/watch', { type: MANAGEMENT.CLUSTER, registerType: true });
       await this.$store.dispatch('management/watch', { type: CAPI.RANCHER_CLUSTER, registerType: true });
     } else {
-      hash.mgmtClusters = this.value.waitForMgmt();
+      hash.mgmtCluster = this.value.waitForMgmt();
     }
 
     // No need to fetch charts when editing an RKE1 cluster

package/edit/provisioning.cattle.io.cluster/rke2.vue

@@ -1629,7 +1629,7 @@ export default {
       const isIpv6 = this.hasOnlyIpv6Pools;
 
       const flannelMasqInvalid = isIpv6 && isK3s && !flannelMasqEnabled;
-      const stackPrefInvalid = (isIpv6 && stackPreference !== STACK_PREFS.IPV6) || (isDualStack && ![STACK_PREFS.IPV6, STACK_PREFS.DUAL].includes(stackPreference));
+      const stackPrefInvalid = (isIpv6 && stackPreference !== STACK_PREFS.IPV6) || (isDualStack && stackPreference !== STACK_PREFS.DUAL);
 
       const clusterCIDRInvalid = (isIpv6 || isDualStack) && !clusterCIDR.includes(':');
       const serviceCIDRInvalid = (isIpv6 || isDualStack) && !serviceCIDR.includes(':');

package/edit/provisioning.cattle.io.cluster/tabs/networking/index.vue

@@ -120,7 +120,7 @@ export default {
 
     stackPreference: {
       get() {
-        return this.localValue.spec?.networking?.stackPreference || STACK_PREFS.IPV4;
+        return this.localValue.spec?.networking?.stackPreference || STACK_PREFS.DUAL;
       },
       set(neu) {
         if (!this.localValue.spec.networking) {
@@ -295,7 +295,7 @@ export default {
       <div class="col span-3">
         <LabeledSelect
           :key="hasSomeIpv6Pools"
-          :value="localValue?.spec?.rkeConfig?.networking?.stackPreference || STACK_PREFS.IPV4"
+          :value="localValue?.spec?.rkeConfig?.networking?.stackPreference || STACK_PREFS.DUAL"
           :mode="mode"
           :options="stackPreferenceOptions"
           data-testid="network-tab-stackpreferences"

package/list/management.cattle.io.user.vue

@@ -8,6 +8,8 @@ import ResourceFetch from '@shell/mixins/resource-fetch';
 import { isAdminUser } from '@shell/store/type-map';
 import TableDataUserIcon from '@shell/components/TableDataUserIcon';
 import { RcButton } from '@components/RcButton';
+import { allHash } from '@shell/utils/promise';
+import Loading from '@shell/components/Loading.vue';
 
 export default {
   components: {
@@ -15,7 +17,8 @@ export default {
     ResourceTable,
     Masthead,
     TableDataUserIcon,
-    RcButton
+    RcButton,
+    Loading
   },
   mixins: [ResourceFetch],
   props:  {
@@ -40,9 +43,16 @@ export default {
     }
   },
   async fetch() {
-    await this.$fetchType(this.resource);
+    const promises = {
+      resources:                 this.$fetchType(this.resource),
+      localProviderEnabled:      this.$store.dispatch('auth/getLocalProviderEnabled'),
+      membershipRefreshRequests: this.$store.dispatch('management/create', { type: EXT.GROUP_MEMBERSHIP_REFRESH_REQUESTS }),
+    };
+
+    const res = await allHash(promises);
 
-    this.membershipRefreshRequests = await this.$store.dispatch('management/create', { type: EXT.GROUP_MEMBERSHIP_REFRESH_REQUESTS });
+    this.localProviderEnabled = res.localProviderEnabled;
+    this.membershipRefreshRequests = res.membershipRefreshRequests;
     this.canRefreshMemberships = !!this.membershipRefreshRequests?.canRefreshMemberships;
   },
 
@@ -87,7 +97,14 @@ export default {
 
     isAdmin() {
       return isAdminUser(this.$store.getters);
-    }
+    },
+
+    canCreateUsers() {
+      const userCan = !!this.schema?.collectionMethods?.find((x) => x.toLowerCase() === 'post');
+      const systemCan = this.localProviderEnabled;
+
+      return userCan && systemCan;
+    },
   },
 
   methods: {
@@ -107,13 +124,15 @@ export default {
 </script>
 
 <template>
-  <div>
+  <Loading v-if="$fetchState.pending" />
+  <div v-else>
     <Masthead
       :schema="schema"
       :resource="resource"
       :show-incremental-loading-indicator="incrementalLoadingIndicator"
       :load-resources="loadResources"
       :load-indeterminate="loadIndeterminate"
+      :is-creatable="canCreateUsers"
     >
       <template #extraActions>
         <AsyncButton

package/list/utils/management.cattle.io.cluster.utils.ts

@@ -31,7 +31,7 @@ class ManagementClusterUtils {
     }
 
     const existingFilters = pagination.filters;
-    const requiredFilters = paginationFilterClusters($store, false);
+    const requiredFilters = paginationFilterClusters($store);
 
     for (let i = 0; i < requiredFilters.length; i++) {
       let found = false;