@rancher/shell 3.0.5-rc.6 → 3.0.5-rc.8

package/utils/dynamic-importer.js

@@ -68,6 +68,14 @@ export function importDialog(name) {
   return defineAsyncComponent(() => import(/* webpackChunkName: "dialog" */ `@shell/dialog/${name}`));
 }
 
+export function importDrawer(name) {
+  if ( !name ) {
+    throw new Error('Name required');
+  }
+
+  return defineAsyncComponent(() => import(/* webpackChunkName: "drawer" */ `@shell/components/Drawer/${name}`));
+}
+
 export function importWindowComponent(name) {
   if ( !name ) {
     throw new Error('Name required');

package/utils/kontainer.ts

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

package/utils/pagination-utils.ts

@@ -15,6 +15,7 @@ import { isEqual } from '@shell/utils/object';
 import { STEVE_CACHE } from '@shell/store/features';
 import { getPerformanceSetting } from '@shell/utils/settings';
 import { PAGINATION_SETTINGS_STORE_DEFAULTS } from '@shell/plugins/steve/steve-pagination-utils';
+import { MANAGEMENT } from '@shell/config/types';
 
 /**
  * Helper functions for server side pagination
@@ -54,6 +55,23 @@ class PaginationUtils {
     return rootGetters['features/get']?.(STEVE_CACHE);
   }
 
+  /**
+   * Determine if the downstream cluster has vai enabled
+   *
+   * Almost all the time the downstream cluster vai state will align with upstream (it manages it)
+   * ... unless it's harvester then weird things happen
+   */
+  async isDownstreamSteveCacheEnabled({ dispatch }: any, clusterId: string): Promise<boolean> {
+    const url = `/k8s/clusters/${ clusterId }/v1/${ MANAGEMENT.FEATURE }s/${ STEVE_CACHE }`;
+    const entry = await dispatch('cluster/request', { url });
+
+    if (entry.status.lockedValue !== null) {
+      return entry.status.lockedValue;
+    }
+
+    return (entry.spec.value !== null) ? entry.spec.value : entry.status.default;
+  }
+
   /**
    * Is pagination enabled at a global level or for a specific resource
    */

package/utils/style.ts

@@ -37,3 +37,6 @@ export function getHighestAlertColor(colors: StateColor[]) {
 
   return highestAlert;
 }
+
+// 1x1 transparent image as a placeholder image
+export const BLANK_IMAGE = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7';

package/utils/uiplugins.ts

@@ -1,7 +1,8 @@
 import { matchesSomeRegex } from '@shell/utils/string';
 import { CATALOG as CATALOG_ANNOTATIONS } from '@shell/config/labels-annotations';
 import { CATALOG } from '@shell/config/types';
-import { UI_PLUGIN_BASE_URL, isSupportedChartVersion } from '@shell/config/uiplugins';
+import { UI_PLUGIN_BASE_URL, isSupportedChartVersion, UI_PLUGIN_LABELS } from '@shell/config/uiplugins';
+import { Plugin, Version } from '@shell/types/uiplugins';
 
 const MAX_RETRIES = 10;
 const RETRY_WAIT = 2500;
@@ -180,10 +181,17 @@ export async function getHelmRepositoryExact(store: any, url: string): Promise<H
  *
  * @param store Vue store
  * @param urlRegexes Regex to match a community repository
+ * @param catalogImages Catalog images to match against the repository's labels
  * @returns HelmRepository
  */
-export async function getHelmRepositoryMatch(store: any, urlRegexes: string[]): Promise<HelmRepository> {
+export async function getHelmRepositoryMatch(store: any, urlRegexes: string[], catalogImages: string[]): Promise<HelmRepository> {
   return await getHelmRepository(store, (repository: any) => {
+    // if installed from rancher/ui-plugin-catalog or rancher/ui-extension-harvester-ui-extension
+    const catalog = repository?.metadata?.labels?.[UI_PLUGIN_LABELS.CATALOG_IMAGE] || '';
+
+    if (catalogImages.includes(catalog)) {
+      return true;
+    }
     const target = repository.spec?.gitBranch ? repository.spec?.gitRepo : repository.spec?.url;
 
     return matchesSomeRegex(target, urlRegexes);
@@ -343,3 +351,22 @@ export async function onExtensionsReady(store: any) {
 
   await store.dispatch('uiplugins/setReady', true);
 }
+
+/**
+ * Finds a Helm Chart version which matches plugin displayVersion. First it checks against Chart.appVersion and
+ * falls back to Chart.version if appVersion is not present.
+ *
+ * @param plugin A data object constructed from UIPlugin and Helm Chart versions
+ * @returns string Helm Chart version
+ */
+export function getPluginChartVersion(plugin?: Plugin) {
+  const pluginVersion = plugin?.displayVersion;
+
+  return plugin?.versions?.find((v) => pluginVersion === (v.appVersion ?? v.version))?.version ?? pluginVersion;
+}
+
+export function getPluginChartVersionLabel(version: Version) {
+  if (version.appVersion === version.version) return `${ version.version }`;
+
+  return `${ version.appVersion } (${ version.version })`;
+}

package/utils/validators/__tests__/setting.test.js

@@ -0,0 +1,92 @@
+import {
+  isServerUrl,
+  isHttps,
+  isDomainWithoutProtocol,
+  isLocalhost,
+  hasTrailingForwardSlash,
+} from '@shell/utils/validators/setting';
+
+describe('isServerUrl', () => {
+  it.each([
+    ['server-url', true],
+    ['SERVER-URL', false],
+    ['server-url/', false],
+    ['not-server-url', false],
+    ['', false],
+  ])('should validate that isServerUrl("%s") returns %s', (input, expected) => {
+    expect(isServerUrl(input)).toBe(expected);
+  });
+});
+
+describe('isHttps', () => {
+  it.each([
+    ['https://example.com', true],
+    ['HTTPS://EXAMPLE.COM', true],
+    ['http://example.com', false],
+    ['ftp://example.com', false],
+    ['example.com', false],
+    ['', false],
+  ])('should validate that isHttps("%s") returns %s', (input, expected) => {
+    expect(isHttps(input)).toBe(expected);
+  });
+});
+
+describe('isDomainWithoutProtocol (follows domain format, no protocol)', () => {
+  it.each([
+    ['ec2.us-west-2.amazonaws.com', true],
+    ['ec2.us-west-2.api.aws', true],
+    ['ec2.us-west-2.amazonaws.com.cn', true],
+    ['s3.eu-central-1.amazonaws.com.cn', true],
+    ['my-service.internal.net', true],
+    ['db.example.org:5432', true],
+    ['ex.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.com', true],
+    ['service.company.local/path/to/resource', true],
+    ['example.org:443', true],
+    ['https://ec2.us-west-2.amazonaws.com', false],
+    ['http://example.com', false],
+    ['udp://example.com', false],
+    ['ftp://example.com', false],
+    ['ftps://example.com', false],
+    ['example://example.com', false],
+    ['example', false],
+    ['-bad.example.com', false],
+    ['bad-.example.com', false],
+    ['example.c', false],
+    ['exa mple.com', false],
+    ['exa.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.example.com', false],
+    ['', false],
+  ])('should validate that isDomainWithoutProtocol("%s") returns %s', (input, expected) => {
+    expect(isDomainWithoutProtocol(input)).toBe(expected);
+  });
+});
+
+describe('isLocalhost', () => {
+  it.each([
+    ['localhost', true],
+    ['LOCALHOST', true],
+    ['http://localhost', true],
+    ['https://localhost:3000', true],
+    ['127.0.0.1', true],
+    ['http://127.0.0.1:8080/path', true],
+    ['HTTPS://127.0.0.1/Health', true],
+    ['127.0.0.2', false],
+    ['http://127.0.0.2', false],
+    ['mylocalhost', false],
+  ])('should validate that isLocalhost("%s") returns %s', (input, expected) => {
+    expect(isLocalhost(input)).toBe(expected);
+  });
+});
+
+describe('hasTrailingForwardSlash', () => {
+  it.each([
+    ['https://example.com/', true],
+    ['http://example.com/', true],
+    ['HTTPS://EXAMPLE.COM/', true],
+    ['https://example.com/path/', true],
+    ['https://example.com', false],
+    ['http://example.com/path', false],
+    ['example.com/', false],
+  ])('should validate that hasTrailingForwardSlash("%s") returns %s', (input, expected) => {
+    expect(hasTrailingForwardSlash(input)).toBe(expected);
+  });
+});

package/utils/validators/formRules/__tests__/index.test.ts

@@ -97,32 +97,54 @@ describe('formRules', () => {
   });
 
   describe('urlRepository', () => {
-    const message = JSON.stringify({ message: 'validation.git.url' });
+    const message = JSON.stringify({ message: 'validation.repository.url' });
     const testCases = [
       // Valid HTTP(s)
       ['https://github.com/rancher/dashboard.git', undefined],
       ['http://github.com/rancher/dashboard.git', undefined],
       ['https://github.com/rancher/dashboard', undefined],
       ['https://github.com/rancher/dashboard/', undefined],
+      ['https://github.com/rancher/%20dashboard/', undefined],
+      ['https://github.com/rancher/dashboard/%20', undefined],
+      ['https://localhost:8005', undefined],
 
       // Valid SSH
       ['git@github.com:rancher/dashboard.git', undefined],
       ['git@github.com:rancher/dashboard', undefined],
       ['git@github.com:rancher/dashboard/', undefined],
+      ['git@github.com:rancher/%20dashboard/', undefined],
+      ['git@github.com:rancher/dashboard/%20', undefined],
 
       // Not valid HTTP(s)
       ['https://github.com/rancher/  dashboard.git', message],
       ['http://github.com/rancher/  dashboard.git', message],
+      ['http://github.com/ rancher/dashboard.git', message],
+      ['http://github.com /rancher/dashboard.git', message],
       ['https://github.com/rancher/dashboard ', message],
+      ['https%20://github.com/rancher/dashboard ', message],
+      ['ht%20tps://github.com/rancher/dashboard ', message],
+      ['https://git%20hub.com/rancher/dashboard/%20', message],
+      ['https://https://', message],
+      ['http:/ww.abc.com', message],
+      ['http:ww.abc.com', message],
       ['foo://github.com/rancher/dashboard/', message],
       ['github.com/rancher/dashboard/', message],
 
       // Not valid SSH
       ['git@github.com:rancher/  dashboard.git', message],
       ['git@github.com:rancher/dashboard  ', message],
+      ['git@github.com:rancher/  dashboard', message],
+      ['git @github.com:rancher/dashboard', message],
+      ['git@github.com:  rancher/dashboard', message],
       ['git@github.comrancher/dashboard', message],
+      ['git@githubcomrancher/dashboard', message],
+      ['%20git@github.comrancher/dashboard', message],
+      ['git@git%20hub.comrancher/dashboard', message],
+      ['git@.git', message],
+      ['git@', message],
 
-      [undefined, undefined]
+      [undefined, message],
+      ['', message]
     ];
 
     it.each(testCases)(
@@ -139,20 +161,26 @@ describe('formRules', () => {
     const message = JSON.stringify({ message: 'validation.oci.url' });
     const testCases = [
       // Valid
-      ['oci://bucket/object', undefined],
+      ['oci://registry.example.com', undefined],
+      ['oci://myregistry.dev:5000', undefined],
+      ['oci://192.168.1.100', undefined],
+      ['oci://my.domain.com/my/image:tag', undefined],
+      ['oci://localhost:5000', undefined],
       ['oci://region.objectstorage.example.com/n', undefined],
-      ['oci://a', undefined],
-      ['oci://UPPERCASE/path', undefined],
 
       // Invalid
       ['http://example.com/oci', message],
       ['https://oci.cloud.com', message],
       ['ftp://oci.server.net', message],
-      ['/path/to/oci', message],
+      ['path/to/oci', message],
+      ['oci://a', message],
       ['oci:/missing/slash', message],
       ['oci:', message],
       ['oci://', message],
-      ['oci://space between', message],
+      ['oci://oci://duplicate/protocol', message],
+      ['oci  ://registry.example.com/foo/bar', message],
+      ['oci://registry.example.  com/foo/bar', message],
+      ['oci://registry.example.com/  foo/bar', message],
       ['oci://resource multiple spaces', message],
       ['', message],
       [undefined, message],
@@ -168,6 +196,59 @@ describe('formRules', () => {
     );
   });
 
+  describe('version', () => {
+    const message = JSON.stringify({ message: 'validation.version' });
+    const testCases: (null | string | undefined)[][] = [
+      // Valid
+      ['1.2.3', undefined],
+      ['', undefined],
+      [null, undefined],
+
+      // Invalid
+      ['1.2.x', message],
+      ['foo', message],
+      ['1.2', message],
+      ['1.2.', message],
+      ['.', message],
+    ];
+
+    it.each(testCases)(
+      'should return undefined or correct message based on the provided Version: %p',
+      (version, expected) => {
+        const formRuleResult = formRules.version(version);
+
+        expect(formRuleResult).toStrictEqual(expected);
+      }
+    );
+  });
+
+  describe('semanticVersion', () => {
+    const message = JSON.stringify({ message: 'validation.semanticVersion' });
+    const testCases: (null | string | undefined)[][] = [
+      // Valid
+      ['1.2.x', undefined],
+      ['1.2.3', undefined],
+      ['1.2', undefined],
+      ['> 1', undefined],
+      ['', undefined],
+      [null, undefined],
+
+      // Invalid
+      ['foo', message],
+      ['1.2.', message],
+      ['.', message],
+    ];
+
+    it.each(testCases)(
+      'should return undefined or correct message based on the provided Semantic Version: %p',
+      (version, expected) => {
+        const formRuleResult = formRules.semanticVersion(version);
+
+        expect(formRuleResult).toStrictEqual(expected);
+      }
+    );
+  });
+
   describe('alphanumeric', () => {
     const message = JSON.stringify({ message: 'validation.alphanumeric', key: 'testDisplayKey' });
     const testCases = [

package/utils/validators/formRules/index.ts

@@ -1,3 +1,5 @@
+import semver from 'semver';
+import { parse } from '@shell/utils/url';
 import { RBAC } from '@shell/config/types';
 import { HCI } from '@shell/config/labels-annotations';
 import isEmpty from 'lodash/isEmpty';
@@ -5,7 +7,7 @@ import has from 'lodash/has';
 import isUrl from 'is-url';
 // import uniq from 'lodash/uniq';
 import { Translation } from '@shell/types/t';
-import { isHttps, isLocalhost, hasTrailingForwardSlash } from '@shell/utils/validators/setting';
+import { isHttps, isLocalhost, hasTrailingForwardSlash, isDomainWithoutProtocol } from '@shell/utils/validators/setting';
 import { cronScheduleRule } from '@shell/utils/validators/cron-schedule';
 
 // import uniq from 'lodash/uniq';
@@ -164,6 +166,8 @@ export default function(
 
   const https: Validator = (val: string) => val && !isHttps(val) ? t('validation.setting.serverUrl.https') : undefined;
 
+  const awsStyleEndpoint: Validator = (val: string) => val && !isDomainWithoutProtocol(val) ? t('validation.setting.serverUrl.awsStyleEndpoint') : undefined;
+
   const localhost: Validator = (val: string) => isLocalhost(val) ? t('validation.setting.serverUrl.localhost') : undefined;
 
   const trailingForwardSlash: Validator = (val: string) => hasTrailingForwardSlash(val) ? t('validation.setting.serverUrl.trailingForwardSlash') : undefined;
@@ -173,22 +177,90 @@ export default function(
   const genericUrl: Validator = (val: string) => val && !isUrl(val) ? t('validation.genericUrl') : undefined;
 
   const urlRepository: Validator = (url: string) => {
-    const regexPart1 = /^((http|git|ssh|http(s)|file|\/?)|(git@[\w\.]+))(:(\/\/)?)/gm;
-    const regexPart2 = /^([\w\.@\:\/\-]+)([\d\/\w.-]+?)(.git){0,1}(\/)?$/gm;
+    const message = t('validation.repository.url');
+
+    if (!url) {
+      return message;
+    }
+
+    if (url.includes(' ')) {
+      return message;
+    }
+
+    const {
+      protocol,
+      authority,
+      host,
+      path
+    } = parse(url);
+
+    // Test duplicate protocol
+    if (!host || protocol === host) {
+      return message;
+    }
+
+    // Test http(s) protocol
+    if (protocol && (!/^(http|http(s))/gm.test(protocol) || (!url.startsWith('https://') && !url.startsWith('http://')))) {
+      return message;
+    }
+
+    // Test ssh, authority must be valid (SSH user + host)
+    if (!protocol && !authority.endsWith(':')) {
+      return message;
+    }
 
-    if (url) {
-      const urlPart2 = url.replaceAll(regexPart1, '');
+    // Encoded space characters (%20) are allowed only in the path
+    const hostAndPath = `${ host }${ path.replaceAll('%20', '') }`;
 
-      return !urlPart2 || url === urlPart2 || !regexPart2.test(urlPart2.replaceAll('%20', '')) ? t('validation.git.url') : undefined;
+    // Test host/path
+    if (!/^([\w\.@\:\/\-]+)([\d\/\w.-]+?)(.git){0,1}(\/)?$/gm.test(hostAndPath)) {
+      return message;
     }
 
     return undefined;
   };
 
   const ociRegistry: Validator = (url: string) => {
-    const regex = /^oci:\/\/\S+$/gm;
+    const message = t('validation.oci.url');
+
+    if (!url) {
+      return message;
+    }
+
+    if (url.includes(' ')) {
+      return message;
+    }
+
+    const {
+      protocol,
+      host,
+      path
+    } = parse(url);
+
+    // Test duplicate protocol
+    if (!host || protocol === host) {
+      return message;
+    }
+
+    // Test oci protocol
+    if (!url.startsWith('oci://')) {
+      return message;
+    }
+
+    // Test host/path
+    if (!/^([\w\.@\:\/\-]+)([\d\/\w.-]+?)(\/)?$/gm.test(`${ host }${ path }`)) {
+      return message;
+    }
+
+    return undefined;
+  };
+
+  const version: Validator = (value: string) => {
+    return value && !semver.valid(value) ? t('validation.version') : undefined;
+  };
 
-    return !regex.test(url) ? t('validation.oci.url') : undefined;
+  const semanticVersion: Validator = (value: string) => {
+    return value && !semver.validRange(value) ? t('validation.semanticVersion') : undefined;
   };
 
   const alphanumeric: Validator = (val: string) => val && !/^[a-zA-Z0-9]+$/.test(val) ? t('validation.alphanumeric', { key }) : undefined;
@@ -541,6 +613,7 @@ export default function(
     imageUrl,
     interval,
     https,
+    awsStyleEndpoint,
     localhost,
     trailingForwardSlash,
     url,
@@ -561,9 +634,11 @@ export default function(
     isOctal,
     roleTemplateRules,
     ruleGroups,
+    semanticVersion,
     servicePort,
     subDomain,
     testRule,
+    version,
     wildcardHostname
   };
 }

package/utils/validators/setting.js

@@ -1,9 +1,26 @@
 import isUrl from 'is-url';
 
+// Note that these function cover specific use cases and you need to make sure it works for your use case before using them.
+// ie they would consider empty values as valid, not all endpoint formatting is enforced
+
 export const isServerUrl = (value) => value === 'server-url';
 
 export const isHttps = (value) => value.toLowerCase().startsWith('https://');
 
+/**
+ * Checks that provided string is a domain without protocol (case insensitive):
+ * - Cannot start with any protocol, such as http://, https://, ftp://, ftps://, udp://
+ * - Must only use the letters a to z, the numbers 0 to 9, and the dot (.) and hyphen (-) characters.
+ * - if the hyphen character is used in a domain name, it cannot be the first or the last character in the name.
+ * - The length of each label can be 2-63 characters
+ * - TLD is at least 2 characters
+ * - The total length of a domain name, including the dot at the end, cannot exceed 254 characters.
+ * - Allows for optional port and path
+ * @param {*} value
+ * @returns boolean indicating if the value is a domain without protocol
+ */
+export const isDomainWithoutProtocol = (value) => (/^(?=.{1,254}$)(?![a-z][a-z0-9+.-]*:\/\/)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,}(?::\d{1,5})?(?:\/\S*)?$/i).test(value);
+
 export const isLocalhost = (value) => (/^(?:https?:\/\/)?(?:localhost|127\.0\.0\.1)/i).test(value);
 
 export const hasTrailingForwardSlash = (value) => isUrl(value) && value?.toLowerCase().endsWith('/');

package/cloud-credential/__tests__/harvester.test.ts

@@ -1,18 +0,0 @@
-import { mount } from '@vue/test-utils';
-import HarvesterCloudCreds from '@shell/cloud-credential/harvester.vue';
-
-const mockStore = { getters: { 'i18n/t': jest.fn() } };
-
-describe('cloud credentials: Harvester', () => {
-  const wrapper = mount(HarvesterCloudCreds, {
-    props:  { value: {} },
-    global: { mocks: { $store: mockStore } }
-  });
-
-  it('should display the warning banner for token expiration', async() => {
-    const warningBanner = wrapper.find('[data-testid="harvester-token-expiration-warning-banner"]');
-
-    expect(warningBanner.exists()).toBe(true);
-    expect(warningBanner.isVisible()).toBe(true);
-  });
-});