@rancher/shell 0.3.29 → 0.5.0

package/plugins/steve/__tests__/steve-class.spec.ts

@@ -0,0 +1,59 @@
+import Steve from '@shell/plugins/steve/steve-class.js';
+import { steveClassJunkObject } from './utils/steve-mocks';
+
+describe('class: Steve', () => {
+  describe('given custom resource keys', () => {
+    const customResource = steveClassJunkObject;
+
+    it('should keep internal keys', () => {
+      const steve = new Steve(customResource, {
+        getters:     { schemaFor: () => ({ linkFor: jest.fn() }) },
+        dispatch:    jest.fn(),
+        rootGetters: { 'i18n/t': jest.fn() },
+      });
+
+      expect({ ...steve }).toStrictEqual(customResource);
+    });
+
+    describe('method: save', () => {
+      it('should remove all the internal keys', async() => {
+        const dispatch = jest.fn();
+        const steve = new Steve(customResource, {
+          getters:     { schemaFor: () => ({ linkFor: jest.fn() }) },
+          dispatch,
+          rootGetters: { 'i18n/t': jest.fn() },
+        });
+
+        const expectation = {
+          type:     customResource.type,
+          metadata: {
+            resourceVersion:            'whatever',
+            fields:                     'whatever',
+            clusterName:                'whatever',
+            deletionGracePeriodSeconds: 'whatever',
+            generateName:               'whatever',
+          },
+          spec: { versions: {} }
+        };
+
+        await steve.save();
+
+        const opt = {
+          data:    expectation,
+          headers: {
+            accept:         'application/json',
+            'content-type': 'application/json',
+          },
+          method: 'post',
+          url:    undefined,
+        };
+
+        // Data sent should have been cleaned
+        expect(dispatch).toHaveBeenCalledWith('request', { opt, type: customResource.type });
+
+        // Original workload model should remain unchanged
+        expect({ ...steve }).toStrictEqual(customResource);
+      });
+    });
+  });
+});

package/plugins/steve/__tests__/utils/steve-mocks.ts

@@ -0,0 +1,31 @@
+import { resourceClassJunkObject } from '@shell/plugins/dashboard-store/__tests__/utils/store-mocks';
+
+const customType = 'asdasd';
+
+export const steveClassJunkObject = {
+  ...resourceClassJunkObject,
+  type:     customType,
+  __clone:  'whatever',
+  metadata: {
+    clusterName:                'whatever',
+    creationTimestamp:          'whatever',
+    deletionGracePeriodSeconds: 'whatever',
+    deletionTimestamp:          'whatever',
+    fields:                     'whatever',
+    finalizers:                 'whatever',
+    generateName:               'whatever',
+    generation:                 'whatever',
+    initializers:               'whatever',
+    managedFields:              'whatever',
+    ownerReferences:            'whatever',
+    relationships:              'whatever',
+    selfLink:                   'whatever',
+    state:                      'whatever',
+    uid:                        'whatever',
+    resourceVersion:            'whatever',
+  },
+  spec:       { versions: { schema: 'whatever' } },
+  links:      'whatever',
+  status:     'whatever',
+  stringData: 'whatever',
+};

package/plugins/steve/getters.js

@@ -24,11 +24,14 @@ const GC_IGNORE_TYPES = {
   [UI.NAV_LINK]: true,
 };
 
+// Include calls to /v1 AND /k8s/clusters/<cluster id>/v1
+const steveRegEx = new RegExp('(/v1)|(\/k8s\/clusters\/[a-z0-9-]+\/v1)');
+
 export default {
   urlOptions: () => (url, opt) => {
     opt = opt || {};
     const parsedUrl = parse(url);
-    const isSteve = parsedUrl.path.startsWith('/v1');
+    const isSteve = steveRegEx.test(parsedUrl.path);
 
     // Filter
     if ( opt.filter ) {

package/plugins/steve/norman-class.js

@@ -3,6 +3,7 @@ import pickBy from 'lodash/pickBy';
 import Vue from 'vue';
 import { matchesSomeRegex } from '@shell/utils/string';
 import Resource from '@shell/plugins/dashboard-store/resource-class';
+import { findBy } from '@shell/utils/array';
 
 export default class NormanModel extends Resource {
   setLabels(val) {
@@ -56,4 +57,22 @@ export default class NormanModel extends Resource {
       Vue.set(this, key, { ...spec[key] });
     });
   }
+
+  isCondition(condition, withStatus = 'True') {
+    if ( !this.conditions ) {
+      return false;
+    }
+
+    const entry = findBy((this.conditions || []), 'type', condition);
+
+    if ( !entry ) {
+      return false;
+    }
+
+    if ( !withStatus ) {
+      return true;
+    }
+
+    return (entry.status || '').toLowerCase() === `${ withStatus }`.toLowerCase();
+  }
 }

package/plugins/steve/steve-class.js

@@ -1,5 +1,17 @@
 import { DESCRIPTION } from '@shell/config/labels-annotations';
 import HybridModel from './hybrid-class';
+import { NEVER_ADD } from '@shell/utils/create-yaml';
+import { deleteProperty } from '@shell/utils/object';
+
+// Some fields that are removed for YAML (NEVER_ADD) are required via API
+const STEVE_ADD = [
+  'metadata.resourceVersion',
+  'metadata.fields',
+  'metadata.clusterName',
+  'metadata.deletionGracePeriodSeconds',
+  'metadata.generateName',
+];
+const STEVE_NEVER_SAVE = NEVER_ADD.filter((na) => !STEVE_ADD.includes(na));
 
 export default class SteveModel extends HybridModel {
   get name() {
@@ -28,4 +40,14 @@ export default class SteveModel extends HybridModel {
 
     this._description = value;
   }
+
+  cleanForSave(data, forNew) {
+    const val = super.cleanForSave(data);
+
+    for (const field of STEVE_NEVER_SAVE) {
+      deleteProperty(val, field);
+    }
+
+    return val;
+  }
 }

package/plugins/steve/subscribe.js

@@ -332,10 +332,6 @@ const sharedActions = {
 
     commit('setWantSocket', true);
 
-    if ( process.server ) {
-      return;
-    }
-
     state.debugSocket && console.info(`Subscribe [${ getters.storeName }]`); // eslint-disable-line no-console
 
     const url = `${ state.config.baseUrl }/subscribe`;
@@ -601,7 +597,7 @@ const defaultActions = {
   },
 
   rehydrateSubscribe({ state, dispatch }) {
-    if ( process.client && state.wantSocket && !state.socket ) {
+    if ( state.wantSocket && !state.socket ) {
       dispatch('subscribe');
     }
   },
@@ -728,11 +724,9 @@ const defaultActions = {
     }
 
     // Try resending any frames that were attempted to be sent while the socket was down, once.
-    if ( !process.server ) {
-      for ( const obj of state.pendingFrames.slice() ) {
-        commit('dequeuePendingFrame', obj);
-        dispatch('sendImmediate', obj);
-      }
+    for ( const obj of state.pendingFrames.slice() ) {
+      commit('dequeuePendingFrame', obj);
+      dispatch('sendImmediate', obj);
     }
   },
 

package/rancher-components/Accordion/Accordion.test.ts

@@ -0,0 +1,45 @@
+import { shallowMount } from '@vue/test-utils';
+import { Accordion } from './index';
+
+describe('component: Accordion', () => {
+  it('is closed initially by default', () => {
+    const title = 'Test Title';
+
+    const wrapper = shallowMount(Accordion, { propsData: { title } });
+
+    expect(wrapper.find('[data-testid="accordion-body"]').isVisible()).toBe(false);
+    expect(wrapper.find('[data-testid="accordion-header"]').text()).toBe(title);
+  });
+
+  it('is opened initially when openInitially prop is true', () => {
+    const wrapper = shallowMount(Accordion, { propsData: { openInitially: true } });
+
+    expect(wrapper.find('[data-testid="accordion-body"]').isVisible()).toBe(true);
+  });
+
+  it('when closed, opens when the header is clicked', async() => {
+    const wrapper = shallowMount(Accordion, { });
+
+    await wrapper.find('[data-testid="accordion-header"]').trigger('click');
+    expect(wrapper.find('[data-testid="accordion-body"]').isVisible()).toBe(true);
+  });
+
+  it('when open, closes when the header is clicked', async() => {
+    const wrapper = shallowMount(Accordion, { propsData: { openInitially: true } });
+
+    await wrapper.find('[data-testid="accordion-header"]').trigger('click');
+    expect(wrapper.find('[data-testid="accordion-body"]').isVisible()).toBe(false);
+  });
+
+  it('displays a chevron when closed', async() => {
+    const wrapper = shallowMount(Accordion, { propsData: { } });
+
+    expect(wrapper.find('[data-testid="accordion-header"] .icon-chevron-up').exists()).toBe(true);
+  });
+
+  it('displays an inverted chevron when open', async() => {
+    const wrapper = shallowMount(Accordion, { propsData: { openInitially: true } });
+
+    expect(wrapper.find('[data-testid="accordion-header"] .icon-chevron-down').exists()).toBe(true);
+  });
+});

package/rancher-components/Accordion/Accordion.vue

@@ -0,0 +1,86 @@
+<script lang="ts">
+import { defineComponent } from 'vue';
+import { mapGetters } from 'vuex';
+
+export default defineComponent({
+  props: {
+    title: {
+      type:    String,
+      default: ''
+    },
+
+    titleKey: {
+      type:    String,
+      default: null
+    },
+
+    openInitially: {
+      type:    Boolean,
+      default: false
+    }
+  },
+
+  data() {
+    return { isOpen: this.openInitially };
+  },
+
+  computed: { ...mapGetters({ t: 'i18n/t' }) },
+
+  methods: {
+    toggle() {
+      this.isOpen = !this.isOpen;
+    }
+  }
+});
+</script>
+
+<template>
+  <div class="accordion-container">
+    <div
+      class="accordion-header"
+      data-testid="accordion-header"
+      @click="toggle"
+    >
+      <i
+        class="icon text-primary"
+        :class="{'icon-chevron-down':isOpen, 'icon-chevron-up':!isOpen}"
+        data-testid="accordion-chevron"
+      />
+      <slot name="header">
+        <h4
+          data-testid="accordion-title-slot-content"
+          class="mb-0"
+        >
+          {{ titleKey ? t(titleKey) : title }}
+        </h4>
+      </slot>
+    </div>
+    <div
+      v-show="isOpen"
+      class="accordion-body"
+      data-testid="accordion-body"
+    >
+      <slot />
+    </div>
+  </div>
+</template>
+
+<style lang="scss" scoped>
+.accordion-container {
+  border: 1px solid var(--border)
+}
+.accordion-header {
+  padding: 5px;
+  display: flex;
+  align-items: center;
+  &>*{
+    padding: 5px 0px 5px 0px;
+  }
+  I {
+    margin: 0px 10px 0px 10px;
+  }
+}
+.accordion-body {
+  padding: 10px;
+}
+</style>

package/rancher-components/Accordion/index.ts

@@ -0,0 +1 @@
+export { default as Accordion } from './Accordion.vue';

package/rancher-components/BadgeState/BadgeState.vue

@@ -1,5 +1,5 @@
 <script lang="ts">
-import Vue, { PropType } from 'vue';
+import { PropType, defineComponent } from 'vue';
 
 interface Badge {
   stateBackground: string;
@@ -11,7 +11,7 @@ interface Badge {
  * <p>Represents a badge whose label and color is either taken from the value property or
  * from the label and color properties. The state property takes precedence.</p>
  */
-export default Vue.extend({
+export default defineComponent({
   props: {
     /**
      * A value having the properties `stateBackground` and `stateDisplay`
@@ -59,7 +59,7 @@ export default Vue.extend({
 </script>
 
 <template>
-  <span :class="{'badge-state': true, [bg]: true}">
+  <span :class="['badge-state', bg]">
     <i
       v-if="icon"
       class="icon"

package/rancher-components/Banner/Banner.vue

@@ -1,9 +1,9 @@
 <script lang="ts">
-import Vue from 'vue';
+import { defineComponent } from 'vue';
 import { nlToBr } from '@shell/utils/string';
 import { stringify } from '@shell/utils/error';
 
-export default Vue.extend({
+export default defineComponent({
   props: {
     /**
      * A color class that represents the color of the banner.

package/rancher-components/Card/Card.vue

@@ -1,7 +1,7 @@
 <script lang="ts">
-import Vue from 'vue';
+import { defineComponent, PropType } from 'vue';
 
-export default Vue.extend({
+export default defineComponent({
   name:  'Card',
   props: {
     /**
@@ -22,7 +22,7 @@ export default Vue.extend({
      * The function to invoke when the default action button is clicked.
      */
     buttonAction: {
-      type:    Function,
+      type:    Function as PropType<(event: MouseEvent) => void>,
       default: (): void => { }
     },
     /**

package/rancher-components/Form/Checkbox/Checkbox.vue

@@ -1,10 +1,10 @@
 <script lang="ts">
-import Vue, { PropType } from 'vue';
+import { PropType, defineComponent } from 'vue';
 import { _EDIT, _VIEW } from '@shell/config/query-params';
 import { addObject, removeObject } from '@shell/utils/array';
 import cloneDeep from 'lodash/cloneDeep';
 
-export default Vue.extend({
+export default defineComponent({
   name: 'Checkbox',
 
   props: {
@@ -140,7 +140,7 @@ export default Vue.extend({
     /**
      * Toggles the checked state for the checkbox and emits an 'input' event.
      */
-    clicked(event: MouseEvent): boolean | void {
+    clicked(event: MouseEvent | KeyboardEvent): boolean | void {
       if ((event.target as HTMLLinkElement).tagName === 'A' && (event.target as HTMLLinkElement).href) {
         // Ignore links inside the checkbox label so you can click them
         return true;

package/rancher-components/Form/LabeledInput/LabeledInput.test.ts

@@ -1,4 +1,3 @@
-
 import { mount } from '@vue/test-utils';
 import { LabeledInput } from './index';
 
@@ -20,4 +19,22 @@ describe('component: LabeledInput', () => {
     expect(wrapper.emitted('input')).toHaveLength(1);
     expect(wrapper.emitted('input')![0][0]).toBe(value);
   });
+
+  it('using mode "multiline" should emit input value correctly', () => {
+    const value = 'any-string';
+    const delay = 1;
+    const wrapper = mount(LabeledInput as any, {
+      propsData: { delay, multiline: true },
+      mocks:     { $store: { getters: { 'i18n/t': jest.fn() } } }
+    });
+
+    jest.useFakeTimers();
+    wrapper.find('input').setValue('1');
+    wrapper.find('input').setValue(value);
+    jest.advanceTimersByTime(delay);
+    jest.useRealTimers();
+
+    expect(wrapper.emitted('input')).toHaveLength(1);
+    expect(wrapper.emitted('input')![0][0]).toBe(value);
+  });
 });

package/rancher-components/Form/LabeledInput/LabeledInput.vue

@@ -1,21 +1,27 @@
 <script lang="ts">
-import Vue, { VueConstructor } from 'vue';
-import CompactInput from '@shell/mixins/compact-input';
-import LabeledFormElement from '@shell/mixins/labeled-form-element';
+import { defineComponent } from 'vue';
 import TextAreaAutoGrow from '@components/Form/TextArea/TextAreaAutoGrow.vue';
 import LabeledTooltip from '@components/LabeledTooltip/LabeledTooltip.vue';
 import { escapeHtml } from '@shell/utils/string';
 import cronstrue from 'cronstrue';
 import { isValidCron } from 'cron-validator';
 import { debounce } from 'lodash';
+import { useLabeledFormElement, labeledFormElementProps } from '@shell/composables/useLabeledFormElement';
+import { useCompactInput } from '@shell/composables/useCompactInput';
 
-export default (
-  Vue as VueConstructor<Vue & InstanceType<typeof LabeledFormElement> & InstanceType<typeof CompactInput>>
-).extend({
+declare module 'vue/types/vue' {
+  interface Vue {
+    onInput: (event: Event) => void | ((event: Event) => void);
+  }
+}
+
+export default defineComponent({
   components: { LabeledTooltip, TextAreaAutoGrow },
-  mixins:     [LabeledFormElement, CompactInput],
+
+  inheritAttrs: false,
 
   props: {
+    ...labeledFormElementProps,
     /**
      * The type of the Labeled Input.
      * @values text, cron, multiline, multiline-password
@@ -90,24 +96,39 @@ export default (
     delay: {
       type:    Number,
       default: 0
-    }
+    },
+  },
+
+  setup(props, { emit }) {
+    const {
+      focused,
+      onFocusLabeled,
+      onBlurLabeled,
+      isDisabled,
+      validationMessage,
+      requiredField
+    } = useLabeledFormElement(props, emit);
+    const { isCompact } = useCompactInput(props);
+
+    return {
+      focused,
+      onFocusLabeled,
+      onBlurLabeled,
+      isDisabled,
+      validationMessage,
+      requiredField,
+      isCompact,
+    };
   },
 
   data() {
     return {
       updated:          false,
-      validationErrors: ''
+      validationErrors: '',
     };
   },
 
   computed: {
-    /**
-     * Determines if the Labeled Input @input event should be debounced.
-     */
-    onInput(): ((value: string) => void) | void {
-      return this.delay ? debounce(this.delayInput, this.delay) : this.delayInput;
-    },
-
     /**
      * Determines if the Labeled Input should display a label.
      */
@@ -122,7 +143,7 @@ export default (
       return !!this.tooltip || !!this.tooltipKey;
     },
 
-    tooltipValue(): string | undefined {
+    tooltipValue(): string | Record<string, unknown> | undefined {
       if (this.hasTooltip) {
         return this.tooltipKey ? this.t(this.tooltipKey) : this.tooltip;
       }
@@ -144,7 +165,7 @@ export default (
       if (this.type !== 'cron' || !this.value) {
         return;
       }
-      if (!isValidCron(this.value)) {
+      if (typeof this.value === 'string' && !isValidCron(this.value)) {
         return this.t('generic.invalidCron');
       }
       try {
@@ -173,15 +194,22 @@ export default (
     /**
      * The max length for the Labeled Input.
      */
-    _maxlength(): number | null {
+    _maxlength(): number | undefined {
       if (this.type === 'text' && this.maxlength) {
         return this.maxlength;
       }
 
-      return null;
+      return undefined;
     },
   },
 
+  created() {
+    /**
+     * Determines if the Labeled Input @input event should be debounced.
+    */
+    this.onInput = this.delay ? debounce(this.delayInput, this.delay) : this.delayInput;
+  },
+
   methods: {
     /**
      * Attempts to give the Labeled Input focus.
@@ -206,11 +234,23 @@ export default (
       }
     },
 
+    /**
+     * Emit on input change
+     */
+    onChange(event: Event): void {
+      this.$emit('change', event);
+    },
+
     /**
      * Emit on input with delay. Note: Arrow function is avoided due context
      * binding.
+     *
+     * NOTE: In multiline, TextAreaAutoGrow emits a string with the value
+     * https://github.com/rancher/dashboard/issues/10249
      */
-    delayInput(value: string): void {
+    delayInput(val: string | Event): void {
+      const value = typeof val === 'string' ? val : (val?.target as HTMLInputElement)?.value;
+
       this.$emit('input', value);
     },
 
@@ -227,7 +267,7 @@ export default (
      * event.
      * @see labeled-form-element.ts mixin for onBlurLabeled()
      */
-    onBlur(event: string): void {
+    onBlur(event: string | FocusEvent): void {
       this.$emit('blur', event);
       this.onBlurLabeled();
     },
@@ -279,7 +319,7 @@ export default (
         :placeholder="_placeholder"
         autocapitalize="off"
         :class="{ conceal: type === 'multiline-password' }"
-        @input="onInput($event)"
+        @input="onInput"
         @focus="onFocus"
         @blur="onBlur"
       />
@@ -296,9 +336,10 @@ export default (
         autocomplete="off"
         autocapitalize="off"
         :data-lpignore="ignorePasswordManagers"
-        @input="onInput($event.target.value)"
+        @input="onInput"
         @focus="onFocus"
         @blur="onBlur"
+        @change="onChange"
       >
     </slot>
 

package/rancher-components/Form/Radio/RadioButton.test.ts

@@ -4,7 +4,7 @@ import { cleanHtmlDirective } from '@shell/plugins/clean-html-directive';
 
 describe('radioButton.vue', () => {
   it('renders label slot contents', () => {
-    const wrapper = shallowMount(RadioButton, { slots: { label: 'Test Label' } });
+    const wrapper = shallowMount(RadioButton, { slots: { label: 'Test Label' }, propsData: { val: {}, value: {} } });
 
     expect(wrapper.find('.radio-label').text()).toBe('Test Label');
   });
@@ -14,7 +14,9 @@ describe('radioButton.vue', () => {
       RadioButton,
       {
         directives: { cleanHtmlDirective },
-        propsData:  { label: 'Test Label' }
+        propsData:  {
+          label: 'Test Label', val: {}, value: {}
+        }
       });
 
     expect(wrapper.find('.radio-label').text()).toBe('Test Label');
@@ -23,7 +25,9 @@ describe('radioButton.vue', () => {
   it('renders slot contents when both slot and label prop are provided', () => {
     const wrapper = shallowMount(RadioButton, {
       slots:     { label: 'Test Label - Slot' },
-      propsData: { label: 'Test Label - Props' },
+      propsData: {
+        label: 'Test Label - Props', val: {}, value: {}
+      },
     });
 
     expect(wrapper.find('.radio-label').text()).toBe('Test Label - Slot');