@rancher/shell 2.0.0 → 3.0.0-rc.1

package/store/__tests__/catalog.test.ts

@@ -1,7 +1,6 @@
 import { CATALOG } from '@shell/config/types';
 import { state, getters, actions, mutations } from '../catalog';
-import Vuex from 'vuex';
-import { createLocalVue } from '@vue/test-utils';
+import { createStore } from 'vuex';
 
 const clusterRepo = { _key: 'testClusterRepo' };
 const repoChartName = 'abc';
@@ -47,10 +46,6 @@ describe('catalog', () => {
         actions,
       };
 
-      const localVue = createLocalVue();
-
-      localVue.use(Vuex);
-
       return {
         modules: {
           i18n: {
@@ -104,11 +99,7 @@ describe('catalog', () => {
     };
 
     it('no force', async() => {
-      const localVue = createLocalVue();
-
-      localVue.use(Vuex);
-
-      const store = new Vuex.Store(constructStore());
+      const store = createStore(constructStore());
 
       // Validate initial state of store
       expect(store.getters[`${ catalogStoreName }/rawCharts`]).toStrictEqual(initialRawCharts);
@@ -135,11 +126,7 @@ describe('catalog', () => {
     });
 
     it('force', async() => {
-      const localVue = createLocalVue();
-
-      localVue.use(Vuex);
-
-      const store = new Vuex.Store(constructStore());
+      const store = createStore(constructStore());
 
       // Validate initial state of store
       let rawCharts = store.getters[`${ catalogStoreName }/rawCharts`];
@@ -181,11 +168,7 @@ describe('catalog', () => {
     });
 
     it('force + reset', async() => {
-      const localVue = createLocalVue();
-
-      localVue.use(Vuex);
-
-      const store = new Vuex.Store(constructStore());
+      const store = createStore(constructStore());
 
       // Validate initial state of store
       expect(store.getters[`${ catalogStoreName }/rawCharts`]).toStrictEqual(initialRawCharts);

package/store/auth.js

@@ -13,7 +13,7 @@ export const BASE_SCOPES = {
   googleoauth:  ['openid profile email'],
   azuread:      [],
   keycloakoidc: ['openid profile email'],
-  oidc:         ['openid profile email'],
+  genericoidc:  ['openid profile email'],
 };
 
 const KEY = 'rc_nonce';
@@ -345,9 +345,14 @@ export const actions = {
     }
   },
 
-  async logout({
-    dispatch, commit, getters, rootState
-  }, options = {}) {
+  uiLogout({ commit, dispatch }) {
+    removeEmberPage();
+
+    commit('loggedOut');
+    dispatch('onLogout', null, { root: true });
+  },
+
+  async logout({ dispatch, getters, rootState }, options = {}) {
     // So, we only do this check if auth has been initialized.
     //
     // It's possible to be logged in and visit auth/logout directly instead
@@ -367,20 +372,33 @@ export const actions = {
     // Unload plugins - we will load again on login
     await rootState.$plugin.logout();
 
+    let logoutAction = 'logout';
+    const data = {};
+
+    // SLO - Single-sign logout - will logout auth provider from all places where it's logged in
+    if (options.slo) {
+      logoutAction = 'logoutAll';
+      data.finalRedirectUrl = returnTo({ isSlo: true }, this);
+    }
+
     try {
-      await dispatch('rancher/request', {
-        url:                  '/v3/tokens?action=logout',
+      const res = await dispatch('rancher/request', {
+        url:                  `/v3/tokens?action=${ logoutAction }`,
         method:               'post',
-        data:                 {},
+        data,
         headers:              { 'Content-Type': 'application/json' },
         redirectUnauthorized: false,
       }, { root: true });
+
+      // Single-sign logout for SAML providers that allow for it
+      if (res.baseType === 'samlConfigLogoutOutput' && res.idpRedirectUrl) {
+        window.location.href = res.idpRedirectUrl;
+
+        return;
+      }
     } catch (e) {
     }
 
-    removeEmberPage();
-
-    commit('loggedOut');
-    dispatch('onLogout', null, { root: true });
+    dispatch('uiLogout');
   }
 };

package/store/index.js

@@ -2,7 +2,7 @@ import { BACK_TO } from '@shell/config/local-storage';
 import { setBrand, setVendor } from '@shell/config/private-label';
 import { NAME as EXPLORER } from '@shell/config/product/explorer';
 import {
-  LOGGED_OUT, IS_SSO, TIMED_OUT, UPGRADED, _FLAGGED
+  LOGGED_OUT, IS_SSO, IS_SLO, TIMED_OUT, UPGRADED, _FLAGGED
 } from '@shell/config/query-params';
 import { SETTING } from '@shell/config/settings';
 import {
@@ -248,9 +248,9 @@ export const state = () => {
     isRancherInHarvester:    false,
     targetRoute:             null,
     rootProduct:             undefined,
-    $router:                 markRaw(undefined),
-    $route:                  markRaw(undefined),
-    $plugin:                 markRaw(undefined),
+    $router:                 markRaw({}),
+    $route:                  markRaw({}),
+    $plugin:                 markRaw({}),
   };
 };
 
@@ -594,7 +594,7 @@ export const getters = {
   },
 
   releaseNotesUrl(state, getters) {
-    const version = getters['management/byId'](MANAGEMENT.SETTING, 'server-version')?.value;
+    const version = getters['management/byId'](MANAGEMENT.SETTING, SETTING.VERSION_RANCHER)?.value;
 
     const base = 'https://github.com/rancher/rancher/releases';
 
@@ -696,6 +696,11 @@ export const mutations = {
   },
 
   setError(state, { error: obj, locationError }) {
+    // We don't want to clobber one error with another, doing so can hide the original cause of an error
+    if (obj && state.error) {
+      return;
+    }
+
     const err = new ApiError(obj);
 
     console.log('Loading error', err); // eslint-disable-line no-console
@@ -729,15 +734,15 @@ export const mutations = {
   },
 
   setRouter(state, router) {
-    state.$router = markRaw(router);
+    state.$router = markRaw(router || {});
   },
 
   setRoute(state, route) {
-    state.$route = markRaw(route);
+    state.$route = markRaw(route || {});
   },
 
   setPlugin(state, pluginDefinition) {
-    state.$plugin = markRaw(pluginDefinition);
+    state.$plugin = markRaw(pluginDefinition || {});
   }
 };
 
@@ -1137,7 +1142,7 @@ export const actions = {
     commit('catalog/reset');
 
     const router = state.$router;
-    const route = router.currentRoute;
+    const route = router.currentRoute.value;
 
     if ( route.name === 'index' ) {
       router.replace('/auth/login');
@@ -1156,6 +1161,9 @@ export const actions = {
       // adds IS_SSO query param to login route if logout came with an auth provider enabled
       QUERY += (IS_SSO in route.query) ? `&${ IS_SSO }` : '';
 
+      // adds IS_SLO query param to login route if logout came with an auth provider with Single Logout enabled
+      QUERY += (IS_SLO in route.query) ? `&${ IS_SLO }` : '';
+
       // Go back to login and force a full page reload, this ensures we unload any dangling resources the user is no longer authorized to use (like extensions).
       // We use document instead of router because router does a clunky job of visiting a new page and reloading. In this case it would cause the login page to flash before actually reloading.
       const base = process.env.routerBase || '/';

package/store/prefs.js

@@ -1,7 +1,6 @@
 import { SETTING } from '@shell/config/settings';
 import { MANAGEMENT, STEVE } from '@shell/config/types';
 import { clone } from '@shell/utils/object';
-import Vue from 'vue';
 
 const definitions = {};
 /**
@@ -239,7 +238,7 @@ export const getters = {
 
 export const mutations = {
   load(state, { key, value }) {
-    Vue.set(state.data, key, value);
+    state.data[key] = value;
   },
 
   cookiesLoaded(state) {
@@ -302,9 +301,9 @@ export const actions = {
           }
 
           if ( definition.parseJSON ) {
-            Vue.set(server.data, key, JSON.stringify(value));
+            server.data[key] = JSON.stringify(value);
           } else {
-            Vue.set(server.data, key, value);
+            server.data[key] = value;
           }
 
           await server.save({ redirectUnauthorized: false });

package/types/resources/settings.d.ts

@@ -30,3 +30,57 @@ export interface PaginationSettings {
     }
   }
 }
+
+type Links = {
+  remove: string;
+  self: string;
+  update: string;
+  view: string;
+};
+
+type FieldsV1 = {
+  'f:customized': {};
+  'f:default': {};
+  'f:source': {};
+  'f:value': {};
+};
+
+type ManagedFields = {
+  apiVersion: string;
+  fieldsType: string;
+  fieldsV1: FieldsV1;
+  manager: string;
+  operation: string;
+  time: string;
+};
+
+type Metadata = {
+  creationTimestamp: string;
+  fields: string[];
+  generation: number;
+  managedFields: ManagedFields[];
+  name: string;
+  relationships: null;
+  resourceVersion: string;
+  state: {
+    error: boolean;
+    message: string;
+    name: string;
+    transitioning: boolean;
+  };
+  uid: string;
+};
+
+export type Setting = {
+  id: string;
+  type: string;
+  links: Links;
+  apiVersion: string;
+  customized: boolean;
+  default: string;
+  kind: string;
+  metadata: Metadata;
+  source: string;
+  value: string | null;
+  save: () => void;
+};

package/types/store/pagination.types.ts

@@ -227,7 +227,7 @@ export class PaginationParamFilter extends PaginationParam {
   /**
    * Convenience method when you just want an instance of {@link PaginationParamFilter} with a simple `filter=x=y` param
    */
-  static createSingleField(field: { field?: string; value: string; equals?: boolean; }): PaginationParam {
+  static createSingleField(field: { field?: string; value: string; equals?: boolean; exact?: boolean }): PaginationParam {
     return new PaginationParamFilter({ fields: [new PaginationFilterField(field)] });
   }
 

package/utils/__tests__/kontainer.test.ts

@@ -1,4 +1,4 @@
-import { diffUpstreamSpec } from '@shell/utils/kontainer';
+import { diffUpstreamSpec, syncUpstreamConfig } from '@shell/utils/kontainer';
 
 describe('fx: diffUpstreamSpec', () => {
   it.each([
@@ -90,3 +90,91 @@ describe('fx: diffUpstreamSpec', () => {
     expect(diffUpstreamSpec(upstream, local)).toStrictEqual(diff);
   });
 });
+
+describe('fx: syncUpstreamSpec', () => {
+  it('should set any fields defined in upstream spec and not local spec', () => {
+    const upstream = {
+      string:                 'def',
+      'other-string':         '123',
+      alreadySet:             'abc',
+      alreadySetArray:        [2, 3, 4],
+      alreadySetBooleanFalse: false,
+      alreadySetBooleanTrue:  true
+    };
+    const local = {
+      alreadySet:             'def',
+      alreadySetArray:        [1, 2, 3],
+      alreadySetBooleanFalse: false,
+      alreadySetBooleanTrue:  true
+    };
+
+    const expected = {
+      string:                 'def',
+      'other-string':         '123',
+      alreadySet:             'def',
+      alreadySetArray:        [1, 2, 3],
+      alreadySetBooleanFalse: false,
+      alreadySetBooleanTrue:  true
+    };
+
+    const testCluster = { eksConfig: local, eksStatus: { upstreamSpec: upstream } };
+
+    syncUpstreamConfig( 'eks', testCluster);
+
+    expect(testCluster.eksConfig).toStrictEqual(expected);
+  });
+
+  it('should not set empty objects or arrays from upstream spec', () => {
+    const upstream = {
+      emptyArray:      [],
+      emptyObject:     {},
+      nonEmptyArray:   [1, 2, 3],
+      nonEmptyObject:  { foo: 'bar' },
+      alreadySet:      'abc',
+      alreadySetArray: [2, 3, 4],
+    };
+    const local = {
+      alreadySet:      'def',
+      alreadySetArray: [1, 2, 3],
+    };
+
+    const expected = {
+      nonEmptyArray:   [1, 2, 3],
+      nonEmptyObject:  { foo: 'bar' },
+      alreadySet:      'def',
+      alreadySetArray: [1, 2, 3],
+    };
+
+    const testCluster = { eksConfig: local, eksStatus: { upstreamSpec: upstream } };
+
+    syncUpstreamConfig( 'eks', testCluster);
+
+    expect(testCluster.eksConfig).toStrictEqual(expected);
+  });
+
+  it('should not overwrite boolean values explicitly set false', () => {
+    const upstream = {
+      falseBoolean:           false,
+      trueBoolean:            true,
+      alreadySetBooleanFalse: true,
+      alreadySetBooleanTrue:  false
+    };
+    const local = {
+      alreadySetBooleanFalse: false,
+      alreadySetBooleanTrue:  true
+    };
+
+    const expected = {
+      falseBoolean:           false,
+      trueBoolean:            true,
+      alreadySetBooleanFalse: false,
+      alreadySetBooleanTrue:  true
+    };
+
+    const testCluster = { eksConfig: local, eksStatus: { upstreamSpec: upstream } };
+
+    syncUpstreamConfig( 'eks', testCluster);
+
+    expect(testCluster.eksConfig).toStrictEqual(expected);
+  });
+});

package/utils/auth.js

@@ -1,7 +1,7 @@
 import { Popup, popupWindowOptions } from '@shell/utils/window';
 import { parse as parseUrl, addParam } from '@shell/utils/url';
 import {
-  BACK_TO, SPA, _EDIT, _FLAGGED, TIMED_OUT
+  BACK_TO, SPA, _EDIT, _FLAGGED, TIMED_OUT, IS_SLO, LOGGED_OUT
 } from '@shell/config/query-params';
 import { MANAGEMENT, NORMAN } from '@shell/config/types';
 import { allHash } from '@shell/utils/promise';
@@ -60,6 +60,11 @@ export function returnTo(opt, vm) {
     returnToUrl = addParam(returnToUrl, 'config', opt.config);
   }
 
+  if (opt.isSlo) {
+    returnToUrl = addParam(returnToUrl, IS_SLO, _FLAGGED);
+    returnToUrl = addParam(returnToUrl, LOGGED_OUT, _FLAGGED);
+  }
+
   return returnToUrl;
 }
 
@@ -67,11 +72,23 @@ export function returnTo(opt, vm) {
  * Determines common auth provider info as those that are available (non-local) and the location of the enabled provider
  */
 export const authProvidersInfo = async(store) => {
-  const rows = await store.dispatch(`management/findAll`, { type: MANAGEMENT.AUTH_CONFIG });
+  try {
+    const rows = await store.dispatch(`management/findAll`, { type: MANAGEMENT.AUTH_CONFIG });
+
+    return parseAuthProvidersInfo(rows);
+  } catch (error) {
+    return {};
+  }
+};
+
+/**
+ * Parses auth provider's info to return if there's an auth provider enabled
+ */
+export function parseAuthProvidersInfo(rows) {
   const nonLocal = rows.filter((x) => x.name !== 'local');
   const enabled = nonLocal.filter((x) => x.enabled === true );
 
-  const supportedNonLocal = nonLocal.filter((x) => x.id !== 'genericoidc');
+  const supportedNonLocal = nonLocal.filter((x) => x.id !== 'oidc');
 
   const enabledLocation = enabled.length === 1 ? {
     name:   'c-cluster-auth-config-id',
@@ -84,7 +101,7 @@ export const authProvidersInfo = async(store) => {
     enabledLocation,
     enabled
   };
-};
+}
 
 export const checkSchemasForFindAllHash = (types, store) => {
   const hash = {};
@@ -187,9 +204,7 @@ export function setProduct(store, to) {
   (product && !store.getters['type-map/isProductRegistered'](product))) {
     const error = new Error(store.getters['i18n/t']('nav.failWhale.productNotFound', { productNotFound: product }, true));
 
-    store.dispatch('loadingError', error);
-
-    throw new Error('loadingError', new Error(store.getters['i18n/t']('nav.failWhale.productNotFound', { productNotFound: product }, true)));
+    return store.dispatch('loadingError', error);
   }
 
   if ( !product ) {

package/utils/axios.js

@@ -75,7 +75,7 @@ const createAxiosInstance = (axiosOptions) => {
 };
 
 const setupProgress = (axios) => {
-  // A noop loading inteterface for when $nuxt is not yet ready
+  // A noop loading inteterface for when $loading is not yet ready
   const noopLoading = {
     finish: () => { },
     start:  () => { },

package/utils/download.js

@@ -2,7 +2,7 @@ import JSZip from 'jszip';
 
 export async function downloadFile(fileName, content, contentType = 'text/plain;charset=utf-8') {
   const blob = new Blob([content], { type: contentType });
-  const { saveAs } = await import('file-saver');
+  const saveAs = (await import('file-saver')).default;
 
   return saveAs(blob, fileName);
 }

package/utils/dynamic-importer.js

@@ -2,12 +2,14 @@
 // So it can be disabled just on this file that does nothing else, instead of every file that uses
 // an import with a variable in the path.
 
+import { defineAsyncComponent } from 'vue';
+
 export function importCloudCredential(name) {
   if (!name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "cloud-credential" */ `@shell/cloud-credential/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "cloud-credential" */ `@shell/cloud-credential/${name}`));
 }
 
 export function importMachineConfig(name) {
@@ -15,7 +17,7 @@ export function importMachineConfig(name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "machine-config" */ `@shell/machine-config/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "machine-config" */ `@shell/machine-config/${name}`));
 }
 
 export function importLogin(name) {
@@ -23,7 +25,7 @@ export function importLogin(name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "login" */ `@shell/components/auth/login/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "login" */ `@shell/components/auth/login/${name}`));
 }
 
 export function importChart(name) {
@@ -31,7 +33,7 @@ export function importChart(name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "chart" */ `@shell/chart/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "chart" */ `@shell/chart/${name}`));
 }
 
 export function importList(name) {
@@ -39,7 +41,7 @@ export function importList(name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "list" */ `@shell/list/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "list" */ `@shell/list/${name}`));
 }
 
 export function importDetail(name) {
@@ -47,7 +49,7 @@ export function importDetail(name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "detail" */ `@shell/detail/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "detail" */ `@shell/detail/${name}`));
 }
 
 export function importEdit(name) {
@@ -55,7 +57,7 @@ export function importEdit(name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "edit" */ `@shell/edit/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "edit" */ `@shell/edit/${name}`));
 }
 
 export function importDialog(name) {
@@ -63,7 +65,7 @@ export function importDialog(name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "dialog" */ `@shell/dialog/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "dialog" */ `@shell/dialog/${name}`));
 }
 
 export function importWindowComponent(name) {
@@ -71,7 +73,7 @@ export function importWindowComponent(name) {
     throw new Error('Name required');
   }
 
-  return () => import(/* webpackChunkName: "components/nav" */ `@shell/components/nav/WindowManager/${name}`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "components/nav" */ `@shell/components/nav/WindowManager/${name}`));
 }
 
 export function loadProduct(name) {
@@ -85,7 +87,7 @@ export function loadProduct(name) {
 
 export function listProducts() {
   const ctx = require.context('@shell/config/product', true, /.*/);
-  const products = ctx.keys().filter(path => !path.endsWith('.js')).map(path => path.substr(2));
+  const products = ctx.keys().filter(path => !path.endsWith('.js') && path.startsWith('./')).map(path => path.substr(2));
 
   return products;
 }
@@ -100,7 +102,7 @@ export function loadTranslation(name) {
 }
 
 export function importCustomPromptRemove(name) {
-  return () => import(/* webpackChunkName: "custom-prompt-remove" */ `@shell/promptRemove/${ name }`);
+  return defineAsyncComponent(() => import(/* webpackChunkName: "custom-prompt-remove" */ `@shell/promptRemove/${ name }`));
 }
 
 export function resolveList(key) {
@@ -129,4 +131,4 @@ export function resolveMachineConfigComponent(key) {
 
 export function resolveCloudCredentialComponent(key) {
   return require.resolve(`@shell/cloud-credential/${ key }`);
-}
+}

package/utils/error.js

@@ -1,11 +1,11 @@
 import { isArray } from '@shell/utils/array';
 
 export class ClusterNotFoundError extends Error {
-  static name = 'ClusterNotFoundError'
+  static NAME = 'ClusterNotFoundError'
 
   constructor(message) {
     super(message);
-    this.name = ClusterNotFoundError.name;
+    this.name = ClusterNotFoundError.NAME;
   }
 }
 
@@ -13,12 +13,12 @@ export class ClusterNotFoundError extends Error {
  * An error occurred and the user should be redirected to a certain location (where this is handled)
  */
 export class RedirectToError extends Error {
-  static name = 'RedirectToError'
+  static NAME = 'RedirectToError'
 
   constructor(message, url) {
     super(message);
     this.url = url;
-    this.name = RedirectToError.name;
+    this.name = RedirectToError.NAME;
   }
 }
 

package/utils/kontainer.ts

@@ -17,7 +17,11 @@ export function syncUpstreamConfig(configPrefix: string, normanCluster: {[key: s
 
   if (!isEmpty(upstreamConfig)) {
     Object.keys(upstreamConfig).forEach((key) => {
-      if (isEmpty(rancherConfig[key]) && !isEmpty(upstreamConfig[key])) {
+      if (typeof upstreamConfig[key] === 'object') {
+        if (isEmpty(rancherConfig[key]) && !isEmpty(upstreamConfig[key])) {
+          set(rancherConfig, key, upstreamConfig[key]);
+        }
+      } else if ((rancherConfig[key] === null || rancherConfig[key] === undefined) && upstreamConfig[key] !== null && upstreamConfig[key] !== undefined) {
         set(rancherConfig, key, upstreamConfig[key]);
       }
     });

package/utils/object.js

@@ -2,7 +2,6 @@ import cloneDeep from 'lodash/cloneDeep';
 import flattenDeep from 'lodash/flattenDeep';
 import compact from 'lodash/compact';
 import { JSONPath } from 'jsonpath-plus';
-import Vue from 'vue';
 import transform from 'lodash/transform';
 import isObject from 'lodash/isObject';
 import isArray from 'lodash/isArray';
@@ -24,10 +23,10 @@ export function set(obj, path, value) {
     const key = parts[i];
 
     if ( i === parts.length - 1 ) {
-      Vue.set(ptr, key, value);
+      ptr[key] = value;
     } else if ( !ptr[key] ) {
       // Make sure parent keys exist
-      Vue.set(ptr, key, {});
+      ptr[key] = {};
     }
 
     ptr = ptr[key];
@@ -95,14 +94,14 @@ export function remove(obj, path) {
   // Remove the very last part of the path
 
   if (parentAry.length === 1) {
-    Vue.set(obj, path, undefined);
+    obj[path] = undefined;
     delete obj[path];
   } else {
     const leafKey = parentAry.pop();
     const parent = get(obj, joinObjectPath(parentAry));
 
     if ( parent ) {
-      Vue.set(parent, leafKey, undefined);
+      parent[leafKey] = undefined;
       delete parent[leafKey];
     }
   }