@rancher/shell 3.0.5-rc.8 → 3.0.5

package/store/__tests__/catalog.test.ts

@@ -296,4 +296,67 @@ describe('catalog', () => {
       expect(result).toHaveLength(0);
     });
   });
+
+  describe('getters', () => {
+    describe('version', () => {
+      it('should find a version from a chart, respecting the showDeprecated flag for charts', () => {
+        // A regular chart with some versions
+        const regularChart = {
+          repoType:   'cluster',
+          repoName:   'rancher-charts',
+          chartName:  'regular-chart',
+          deprecated: false,
+          versions:   [{ version: '1.2.3' }, { version: '1.2.4' }]
+        };
+        // A deprecated chart with some versions
+        const deprecatedChart = {
+          repoType:   'cluster',
+          repoName:   'rancher-charts',
+          chartName:  'deprecated-chart',
+          deprecated: true,
+          versions:   [{ version: '2.0.0' }, { version: '2.1.0' }]
+        };
+
+        const allCharts = [regularChart, deprecatedChart];
+        const state = {};
+        const localGetters = {
+          charts: allCharts,
+          chart:  (args: any) => getters.chart(state, { charts: allCharts })(args)
+        };
+
+        // Scenario 1: Get a version from a regular chart
+        const result1 = getters.version(state, localGetters)({
+          repoType:       'cluster',
+          repoName:       'rancher-charts',
+          chartName:      'regular-chart',
+          versionName:    '1.2.3',
+          showDeprecated: false
+        });
+
+        expect(result1).toStrictEqual({ version: '1.2.3' });
+
+        // Scenario 2: Get a version from a deprecated chart
+        const result2 = getters.version(state, localGetters)({
+          repoType:       'cluster',
+          repoName:       'rancher-charts',
+          chartName:      'deprecated-chart',
+          versionName:    '2.0.0',
+          showDeprecated: true
+        });
+
+        expect(result2).toStrictEqual({ version: '2.0.0' });
+
+        // Scenario 3: Try to get a version from a deprecated chart without the flag should fail
+        const result3 = getters.version(state, localGetters)({
+          repoType:       'cluster',
+          repoName:       'rancher-charts',
+          chartName:      'deprecated-chart',
+          versionName:    '2.0.0',
+          showDeprecated: false
+        });
+
+        expect(result3).toBeNull();
+      });
+    });
+  });
 });

package/store/__tests__/cookies.test.ts

@@ -0,0 +1,72 @@
+import cookieStore from '../cookies';
+
+// Mock cookie-universal
+const mockCookie = {
+  get:                  jest.fn(),
+  set:                  jest.fn(),
+  remove:               jest.fn(),
+  getAll:               jest.fn(),
+  addChangeListener:    jest.fn(),
+  removeChangeListener: jest.fn()
+};
+
+jest.mock('cookie-universal', () => {
+  return jest.fn(() => mockCookie);
+});
+
+describe('store: cookies', () => {
+  let state: any;
+
+  beforeEach(() => {
+    state = cookieStore.state();
+    // Reset mocks before each test
+    mockCookie.get.mockClear();
+    mockCookie.set.mockClear();
+    mockCookie.remove.mockClear();
+  });
+
+  describe('getters', () => {
+    it('get should call cookies.get with the correct parameters', () => {
+      const { getters } = cookieStore;
+      const key = 'test-key';
+      const options = { from: 'server' };
+
+      getters.get(state, {}, {}, {})({ key, options });
+      expect(mockCookie.get).toHaveBeenCalledWith(key, options);
+    });
+  });
+
+  describe('mutations', () => {
+    it('set should call cookies.set with the correct parameters', () => {
+      const { mutations } = cookieStore;
+      const key = 'test-key';
+      const value = { data: 'test-value' };
+      const options = { path: '/' };
+
+      mutations.set(state, {
+        key, value, options
+      });
+      expect(mockCookie.set).toHaveBeenCalledWith(key, value, options);
+    });
+
+    it('remove should call cookies.remove with the correct key', () => {
+      const { mutations } = cookieStore;
+      const key = 'test-key';
+
+      mutations.remove(state, { key });
+      expect(mockCookie.remove).toHaveBeenCalledWith(key);
+    });
+  });
+
+  describe('state', () => {
+    it('should return a cookies object', () => {
+      expect(state.cookies).toBeDefined();
+    });
+  });
+
+  describe('namespaced', () => {
+    it('should be namespaced', () => {
+      expect(cookieStore.namespaced).toBe(true);
+    });
+  });
+});

package/store/auth.js

@@ -8,6 +8,13 @@ import { removeEmberPage } from '@shell/utils/ember-page';
 import { randomStr } from '@shell/utils/string';
 import { addParams, parse as parseUrl, removeParam } from '@shell/utils/url';
 
+// configuration for Single Logout/SLO
+// admissable auth providers compatible with SLO, based on shell/models/management.cattle.io.authconfig "configType"
+export const SLO_AUTH_PROVIDERS = ['oidc', 'saml'];
+
+// this is connected to the redirect url, for which the logic can be found in "shell/store/auth"
+const SLO_TOKENS_ENDPOINT_LOGOUT_RES_BASETYPE = ['authConfigLogoutOutput'];
+
 export const BASE_SCOPES = {
   github:       ['read:org'],
   googleoauth:  ['openid profile email'],
@@ -85,8 +92,6 @@ export const mutations = {
   loggedInAs(state, principalId) {
     state.loggedIn = true;
     state.principalId = principalId;
-
-    this.$cookies.remove(KEY);
   },
 
   loggedOut(state) {
@@ -136,10 +141,18 @@ export const actions = {
     commit('initialPass', pass);
   },
 
-  getAuthProviders({ dispatch }) {
+  getAuthProviders({ dispatch }, opt) {
+    let force = false;
+
+    if (opt?.force) {
+      force = true;
+    }
+
     return dispatch('rancher/findAll', {
       type: 'authProvider',
-      opt:  { url: `/v3-public/authProviders`, watch: false }
+      opt:  {
+        url: `/v3-public/authProviders`, watch: false, force
+      }
     }, { root: true });
   },
 
@@ -183,13 +196,17 @@ export const actions = {
    * Save nonce details. Information it contains will be used to validate auth requests/responses
    * Note - this may be structurally different than the nonce we encode and send
    */
-  saveNonce(ctx, opt) {
+  saveNonce({ commit }, opt) {
     const strung = JSON.stringify(opt);
 
-    this.$cookies.set(KEY, strung, {
+    const options = {
       path:     '/',
       sameSite: true,
       secure:   true,
+    };
+
+    commit('cookies/set', {
+      key: KEY, value: strung, options
     });
 
     return strung;
@@ -265,8 +282,8 @@ export const actions = {
     }
   },
 
-  verifyOAuth({ dispatch }, { nonce, code, provider }) {
-    const expectJSON = this.$cookies.get(KEY, { parseJSON: false });
+  verifyOAuth({ dispatch, rootGetters }, { nonce, code, provider }) {
+    const expectJSON = rootGetters['cookies/get']({ key: KEY, options: { parseJSON: false } });
     let parsed;
 
     try {
@@ -351,6 +368,12 @@ export const actions = {
     }
   },
 
+  loggedInAs({ commit }, principalId) {
+    commit('loggedInAs', principalId);
+
+    commit('cookies/remove', { key: KEY });
+  },
+
   uiLogout({ commit, dispatch }) {
     removeEmberPage();
 
@@ -398,8 +421,8 @@ export const actions = {
         redirectUnauthorized: false,
       }, { root: true });
 
-      // Single-sign logout for SAML providers that allow for it
-      if (res.baseType === 'samlConfigLogoutOutput' && res.idpRedirectUrl) {
+      // Single-sign logout redirect for SLO compatible auth providers
+      if (SLO_TOKENS_ENDPOINT_LOGOUT_RES_BASETYPE.includes(res.baseType) && res.idpRedirectUrl) {
         window.location.href = res.idpRedirectUrl;
 
         return;

package/store/catalog.js

@@ -237,10 +237,10 @@ export const getters = {
 
   version(state, getters) {
     return ({
-      repoType, repoName, chartName, versionName
+      repoType, repoName, chartName, versionName, showDeprecated
     }) => {
       const chart = getters['chart']({
-        repoType, repoName, chartName
+        repoType, repoName, chartName, showDeprecated
       });
 
       if ( !chart ) {

package/store/cookies.ts

@@ -0,0 +1,30 @@
+import { MutationTree, GetterTree, ActionTree } from 'vuex';
+import Cookie, { ICookie, ICookieGetOpts } from 'cookie-universal';
+
+type State = { cookies: ICookie };
+const options = { parseJSON: true };
+const state = (): State => ({ cookies: Cookie(undefined, undefined, options.parseJSON) });
+
+const getters: GetterTree<State, any> = {
+  get(state) {
+    return ({ key, options }: {key: string, options?: ICookieGetOpts}) => state.cookies.get(key, options);
+  }
+};
+const mutations: MutationTree<State> = {
+  set(state, { key, value, options }) {
+    return state.cookies.set(key, value, options);
+  },
+
+  remove(state, { key }) {
+    return state.cookies.remove(key);
+  },
+};
+const actions: ActionTree<State, any> = {};
+
+export default {
+  namespaced: true,
+  state,
+  getters,
+  mutations,
+  actions
+};

package/store/prefs.js

@@ -289,12 +289,16 @@ export const actions = {
     commit('load', { key, value });
 
     if ( definition.asCookie ) {
-      const opt = {
+      const options = {
         ...cookieOptions,
         parseJSON: definition.parseJSON === true
       };
 
-      this.$cookies.set(`${ cookiePrefix }${ key }`.toUpperCase(), value, opt);
+      const computedKey = `${ cookiePrefix }${ key }`.toUpperCase();
+
+      commit('cookies/set', {
+        key: computedKey, value, options
+      }, { root: true });
     }
 
     if ( definition.asUserPreference ) {
@@ -336,7 +340,7 @@ export const actions = {
     await dispatch('set', { key: THEME, value: val });
   },
 
-  loadCookies({ state, commit }) {
+  loadCookies({ state, commit, rootGetters }) {
     if ( state.cookiesLoaded ) {
       return;
     }
@@ -348,8 +352,9 @@ export const actions = {
         continue;
       }
 
-      const opt = { parseJSON: definition.parseJSON === true };
-      const value = this.$cookies.get(`${ cookiePrefix }${ key }`.toUpperCase(), opt);
+      const options = { parseJSON: definition.parseJSON === true };
+      const computedKey = `${ cookiePrefix }${ key }`.toUpperCase();
+      const value = rootGetters['cookies/get']({ key: computedKey, options });
 
       if (value !== undefined) {
         commit('load', { key, value });

package/store/type-map.js

@@ -103,8 +103,6 @@
 //                               depaginate: undefined -- Use this to depaginate requests for this type
 //                               resourceEditMasthead: true   -- Show the Masthead in the edit resource component
 //                               customRoute: undefined,
-//                               hasGraph: undefined   -- If true, render ForceDirectedTreeChart graph (ATTENTION: option graphConfig is needed also!!!)
-//                               graphConfig: undefined   -- Use this to pass along the graph configuration
 //                               notFilterNamespace:  undefined -- Define namespaces that do not need to be filtered
 //                               localOnly: False -- Hide this type from the nav/search bar on downstream clusters
 //                               custom: any - Custom options for a given type
@@ -208,7 +206,6 @@ export const SPOOFED_PREFIX = '__[[spoofed]]__';
 export const SPOOFED_API_PREFIX = '__[[spoofedapi]]__';
 
 const instanceMethods = {};
-const graphConfigMap = {};
 
 export const IF_HAVE = {
   V2_MONITORING:            'v2-monitoring',
@@ -291,10 +288,6 @@ export function DSL(store, product, module = 'type-map') {
     },
 
     configureType(match, options) {
-      if (options.graphConfig) {
-        graphConfigMap[match] = options.graphConfig;
-        delete options.graphConfig;
-      }
       store.commit(`${ module }/configureType`, { ...options, match });
     },
 
@@ -1178,14 +1171,9 @@ export const getters = {
     };
   },
 
-  hasGraph(state, getters) {
-    return (resource) => {
-      const typeOptions = getters['optionsFor'](resource);
-
-      if (typeOptions && typeOptions.hasGraph) {
-        return graphConfigMap[resource];
-      }
-
+  // This has to be left in to support extensions which use shell version 3.0.5-rc.8 or earlier, this extensions have a version of ResourceDetail/index.vue which still invokes this method.
+  hasGraph() {
+    return () => {
       return null;
     };
   },

package/types/extension-manager.ts

@@ -0,0 +1,26 @@
+import { ClusterProvisionerContext } from '@shell/core/types';
+export type ExtensionManager = {
+  internal(): any;
+  loadPluginAsync(plugin: any): Promise<void>;
+  loadAsync(id: string, mainFile: string): Promise<void>;
+  loadBuiltinExtensions(): void;
+  registerBuiltinExtension(id: string, module: any): void;
+  initBuiltinExtension(id: string, module: any): void;
+  logout(): Promise<void>;
+  removePlugin(name: string): Promise<void>;
+  removeTypeFromStore(store: any, storeName: string, types: string[]): any[];
+  applyPlugin(plugin: any): void;
+  register(type: string, name: string, fn: Function): void;
+  unregister(type: string, name: string, fn: Function): void;
+  getAll(): any;
+  getPlugins(): any;
+  getDynamic(typeName: string, name: string): any;
+  getValidator(name: string): any;
+  getUIConfig(type: string, uiArea: string): any[];
+  getAllUIConfig(): any;
+  getProviders(context: ClusterProvisionerContext): any[];
+  lastLoad: number;
+  listDynamic(typeName: string): string[];
+  products: any[];
+  loadProducts(loadPlugins: any[]): void;
+}

package/types/shell/index.d.ts

@@ -121,7 +121,6 @@ export namespace FLEET {
     export { CLUSTER_NAMESPACE_1 as CLUSTER_NAMESPACE };
     export let CLUSTER: string;
     export let CREATED_BY_USER_ID: string;
-    export let CREATED_BY_USER_NAME: string;
     export let OCI_STORAGE_SECRET_DEFAULT: string;
     export let OCI_STORAGE_SECRET_GENERATED: string;
 }
@@ -199,6 +198,7 @@ export const _STAGE: "stage";
 export const _IMPORT: "import";
 export const LEGACY: "legacy";
 export const AS: "as";
+export const VIEW: "view";
 export const _DETAIL: "detail";
 export const _CONFIG: "config";
 export const _YAML: "yaml";
@@ -2613,6 +2613,20 @@ export default class Namespace {
     cleanForNew(): void;
     metadata: any;
     get hideDetailLocation(): boolean;
+    get glance(): any[];
+    get projectGlance(): {
+        name: string;
+        label: any;
+        formatter: string;
+        formatterOpts: {
+            to: any;
+            row: {};
+            options: {
+                internal: boolean;
+            };
+        };
+        content: any;
+    };
 }
 }
 
@@ -3275,6 +3289,112 @@ export default class Resource {
         };
         content: any;
     })[];
+    get glance(): ({
+        name: string;
+        label: any;
+        formatter: string;
+        formatterOpts: {
+            row: this;
+            to?: undefined;
+            options?: undefined;
+        };
+        content: any;
+    } | {
+        name: string;
+        label: any;
+        formatter: string;
+        formatterOpts: {
+            to: {
+                name: string;
+                params: {
+                    product: any;
+                    cluster: any;
+                    resource: any;
+                };
+            };
+            row: {};
+            options: {
+                internal: boolean;
+            };
+        };
+        content: any;
+    } | {
+        name: string;
+        label: any;
+        formatter: string;
+        formatterOpts: {
+            to: {
+                name: string;
+                product: any;
+                cluster: any;
+                resource: any;
+            };
+            row: {};
+            options: {
+                internal: boolean;
+            };
+        };
+        content: any;
+    } | {
+        name: string;
+        label: any;
+        formatter: string;
+        content: any;
+        formatterOpts?: undefined;
+    })[];
+    get _glance(): ({
+        name: string;
+        label: any;
+        formatter: string;
+        formatterOpts: {
+            row: this;
+            to?: undefined;
+            options?: undefined;
+        };
+        content: any;
+    } | {
+        name: string;
+        label: any;
+        formatter: string;
+        formatterOpts: {
+            to: {
+                name: string;
+                params: {
+                    product: any;
+                    cluster: any;
+                    resource: any;
+                };
+            };
+            row: {};
+            options: {
+                internal: boolean;
+            };
+        };
+        content: any;
+    } | {
+        name: string;
+        label: any;
+        formatter: string;
+        formatterOpts: {
+            to: {
+                name: string;
+                product: any;
+                cluster: any;
+                resource: any;
+            };
+            row: {};
+            options: {
+                internal: boolean;
+            };
+        };
+        content: any;
+    } | {
+        name: string;
+        label: any;
+        formatter: string;
+        content: any;
+        formatterOpts?: undefined;
+    })[];
     get t(): any;
     findOwners(): any[];
     getOwners(): any[];
@@ -3481,9 +3601,10 @@ export namespace actions {
     function setTheme({ dispatch }: {
         dispatch: any;
     }, val: any): Promise<void>;
-    function loadCookies({ state, commit }: {
+    function loadCookies({ state, commit, rootGetters }: {
         state: any;
         commit: any;
+        rootGetters: any;
     }): void;
     function loadTheme({ dispatch }: {
         dispatch: any;
@@ -3556,20 +3677,6 @@ export function parseAuthProvidersInfo(rows: any): {
     };
     enabled: any;
 };
-/**
- * Attempt to set the product in our datastore if the route matches a known product. Otherwise show an error page instead.
- */
-export function setProduct(store: any, to: any): any;
-/**
- * Check that the resource is valid, if not redirect to fail whale
- *
- * This requires that
- * - product is set
- * - product's store is set and setup (so we can check schema's within it)
- * - product's store has the schemaFor getter (extension stores might not have it)
- * - there's a resource associated with route (meta or param)
- */
-export function validateResource(store: any, to: any): boolean;
 /**
  * Attempt to load the current user's principal
  */
@@ -3744,16 +3851,6 @@ declare function _default(context: any, inject: any): void;
 export default _default;
 }
 
-// @shell/utils/cookie-universal
-
-declare module '@shell/utils/cookie-universal' {
-declare function _default({ req, res }: {
-    req: any;
-    res: any;
-}, inject: any): void;
-export default _default;
-}
-
 // @shell/utils/create-yaml
 
 declare module '@shell/utils/create-yaml' {
@@ -4389,7 +4486,6 @@ export function routeRequiresInstallRedirect(to: any): boolean;
 // @shell/utils/select
 
 declare module '@shell/utils/select' {
-export function onClickOption(option: any, e: any): void;
 export function calculatePosition(dropdownList: any, component: any, width: any, placement: any): void;
 }