@rancher/shell 3.0.5-rc.5 → 3.0.5-rc.7

package/utils/__tests__/string.test.ts

@@ -1,4 +1,4 @@
-import { decodeHtml, resourceNames } from '@shell/utils/string';
+import { decodeHtml, resourceNames, pathArrayToTree } from '@shell/utils/string';
 
 describe('fx: decodeHtml', () => {
   it('should decode HTML values from escaped string into valid markup', () => {
@@ -89,3 +89,275 @@ describe('fx: resourceNames', () => {
     });
   });
 });
+
+describe('fx: pathArrayToTree', () => {
+  interface TreeNode {
+    name: string;
+    children: TreeNode[];
+  }
+
+  function sortTree(nodes: TreeNode[]): void {
+    if (!nodes) return;
+    nodes.sort((a, b) => a.name.localeCompare(b.name));
+    nodes.forEach((node) => {
+      if (node.children && node.children.length > 0) {
+        sortTree(node.children);
+      }
+    });
+  }
+
+  it('should return an empty array for an empty input array', () => {
+    const paths: string[] = [];
+
+    expect(pathArrayToTree(paths)).toStrictEqual([]);
+  });
+
+  it('should convert simple single-level paths correctly', () => {
+    const paths: string[] = [
+      'file1.txt',
+      'folderA',
+      'itemB'
+    ];
+    const expected: TreeNode[] = [
+      { name: 'file1.txt', children: [] },
+      { name: 'folderA', children: [] },
+      { name: 'itemB', children: [] },
+    ];
+    const actual = pathArrayToTree(paths);
+
+    sortTree(actual); // Sort the actual output for deterministic comparison
+    expect(actual).toStrictEqual(expected);
+  });
+
+  it('should convert two-level nested paths correctly', () => {
+    const paths: string[] = [
+      'folderA/file1.txt',
+      'folderC/file3.txt'
+    ];
+    const expected: TreeNode[] = [
+      {
+        name:     'folderA',
+        children: [
+          { name: 'file1.txt', children: [] },
+        ]
+      },
+      {
+        name:     'folderC',
+        children: [
+          { name: 'file3.txt', children: [] }
+        ]
+      },
+    ];
+    const actual = pathArrayToTree(paths);
+
+    sortTree(actual);
+    expect(actual).toStrictEqual(expected);
+  });
+
+  it('should handle deep nesting and common prefixes correctly', () => {
+    const paths: string[] = [
+      'root/level1/level2/file.doc',
+      'root/level1/another_file.txt',
+      'root/diff_level1/config.json'
+    ];
+    const expected: TreeNode[] = [
+      {
+        name:     'root',
+        children: [
+          {
+            name:     'diff_level1',
+            children: [
+              { name: 'config.json', children: [] }
+            ]
+          },
+          {
+            name:     'level1',
+            children: [
+              { name: 'another_file.txt', children: [] },
+              {
+                name:     'level2',
+                children: [
+                  { name: 'file.doc', children: [] }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ];
+    const actual = pathArrayToTree(paths);
+
+    sortTree(actual);
+    expect(actual).toStrictEqual(expected);
+  });
+
+  it('should handle leading/trailing/multiple slashes by treating them as path segments', () => {
+    const paths: string[] = [
+      '/path/to/file.txt', // Starts with a slash
+      'path/to/another.txt/', // Ends with a slash (adds an empty segment)
+      '//root/item//subitem//', // Multiple slashes (adds empty segments)
+      'root/item/another_subitem'
+    ];
+    const expected: TreeNode[] = [
+      {
+        name:     '',
+        children: [
+          {
+            name:     '',
+            children: [
+              {
+                name:     'root',
+                children: [
+                  {
+                    name:     'item',
+                    children: [
+                      {
+                        name:     '',
+                        children: [
+                          {
+                            name:     'subitem',
+                            children: [
+                              {
+                                name:     '',
+                                children: [
+                                  {
+                                    name:     '',
+                                    children: [
+                                    ],
+                                  },
+                                ],
+                              },
+                            ],
+                          },
+                        ],
+                      },
+                    ],
+                  },
+                ],
+              },
+            ],
+          },
+          {
+            name:     'path',
+            children: [
+              {
+                name:     'to',
+                children: [
+                  {
+                    name:     'file.txt',
+                    children: [
+                    ],
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+      },
+      {
+        name:     'path',
+        children: [
+          {
+            name:     'to',
+            children: [
+              {
+                name:     'another.txt',
+                children: [
+                  {
+                    name:     '',
+                    children: [
+                    ],
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+      },
+      {
+        name:     'root',
+        children: [
+          {
+            name:     'item',
+            children: [
+              {
+                name:     'another_subitem',
+                children: [
+                ],
+              },
+            ],
+          },
+        ],
+      },
+    ];
+    const actual = pathArrayToTree(paths);
+
+    sortTree(actual);
+    expect(actual).toStrictEqual(expected);
+  });
+
+  it('should produce the same structure regardless of input order', () => {
+    const paths1: string[] = ['a/b', 'a/c'];
+    const paths2: string[] = ['a/c', 'a/b'];
+
+    const actual1 = pathArrayToTree(paths1);
+
+    sortTree(actual1);
+    const actual2 = pathArrayToTree(paths2);
+
+    sortTree(actual2);
+
+    expect(actual1).toStrictEqual(actual2);
+  });
+
+  it('should handle names with special characters (not slashes) correctly', () => {
+    const paths: string[] = [
+      'my-folder/file_name.1.txt',
+      'another folder/item with spaces'
+    ];
+    const expected: TreeNode[] = [
+      {
+        name:     'another folder',
+        children: [
+          { name: 'item with spaces', children: [] }
+        ]
+      },
+      {
+        name:     'my-folder',
+        children: [
+          { name: 'file_name.1.txt', children: [] }
+        ]
+      }
+    ];
+    const actual = pathArrayToTree(paths);
+
+    sortTree(actual);
+    expect(actual).toStrictEqual(expected);
+  });
+
+  it('should handle duplicate paths correctly, only adding unique structure', () => {
+    const paths: string[] = [
+      'folder/file.txt',
+      'folder/file.txt', // Duplicate
+      'other_folder/another_file.txt'
+    ];
+    const expected: TreeNode[] = [
+      {
+        name:     'folder',
+        children: [
+          { name: 'file.txt', children: [] }
+        ]
+      },
+      {
+        name:     'other_folder',
+        children: [
+          { name: 'another_file.txt', children: [] }
+        ]
+      }
+    ];
+    const actual = pathArrayToTree(paths);
+
+    sortTree(actual);
+    expect(actual).toStrictEqual(expected);
+  });
+});

package/utils/__tests__/time.test.ts

@@ -0,0 +1,31 @@
+import { DATE_FORMAT, TIME_FORMAT } from '@shell/store/prefs';
+import { dateTimeFormat } from '@shell/utils/time';
+import { type Store } from 'vuex';
+
+describe('function: dateTimeFormat', () => {
+  jest.useFakeTimers()
+    .setSystemTime(new Date('21-10-2010 4:29:00'));
+  const store = {
+    getters: {
+      'prefs/get': (key: string) => {
+        return {
+          [DATE_FORMAT]: 'ddd, MMM D YYYY',
+          [TIME_FORMAT]: 'h:mm:ss a',
+        }[key];
+      },
+    },
+  } as Store<any>;
+
+  it('should format date and time correctly', () => {
+    const date = new Date('2010-10-21T04:29:00Z');
+    const formattedDate = dateTimeFormat(date.toISOString(), store);
+
+    expect(formattedDate).toBe('Thu, Oct 21 2010 4:29:00 am');
+  });
+
+  it('should return empty string for undefined value', () => {
+    const formattedDate = dateTimeFormat(undefined, store);
+
+    expect(formattedDate).toBe('');
+  });
+});

package/utils/auth.js

@@ -8,6 +8,7 @@ import { allHash } from '@shell/utils/promise';
 import { getProductFromRoute, getResourceFromRoute } from '@shell/utils/router';
 import { NAME as EXPLORER } from '@shell/config/product/explorer';
 import { findBy } from '@shell/utils/array';
+import { onExtensionsReady } from '@shell/utils/uiplugins';
 
 export const AUTH_BROADCAST_CHANNEL_NAME = 'rancher-auth-test-callback';
 
@@ -333,9 +334,15 @@ export async function tryInitialSetup(store, password = 'admin') {
 /**
  * Record in our state management that we're indeed logged in
  */
-export function isLoggedIn(store, me) {
+export async function isLoggedIn(store, userData) {
   store.commit('auth/hasAuth', true);
-  store.commit('auth/loggedInAs', me.id);
+  store.commit('auth/loggedInAs', userData.id);
+
+  // Init the notification center now that we know who the user is
+  await store.dispatch('notifications/init', userData);
+
+  // Let the extensions know that the user is logged in
+  await onExtensionsReady(store);
 }
 
 /**

package/utils/create-yaml.js

@@ -70,13 +70,14 @@ export const ACTIVELY_REMOVE = [
 
 const INDENT = 2;
 
-export function createYamlWithOptions(schemas, type, data, options) {
+export function createYamlWithOptions(schemas, type, data, options, commentFieldsOptions) {
   return createYaml(
     schemas,
     type,
     data,
     true, 0, '', null,
-    options
+    options,
+    commentFieldsOptions
   );
 }
 
@@ -89,6 +90,7 @@ export function createYaml(
   path = '',
   rootType = null,
   dataOptions = {},
+  commentFieldsOptions = null
 ) {
   data = data || {};
 
@@ -133,6 +135,10 @@ export function createYaml(
 
   const regularFields = [];
 
+  if ( !commentFieldsOptions ) {
+    commentFieldsOptions = data?.commentFieldsOptions;
+  }
+
   if (processAlwaysAdd) {
     // Add all the parents of each key so that spec.template.foo.blah
     // causes 'spec', 'template' and 'foo' keys to be created
@@ -230,6 +236,18 @@ export function createYaml(
       out = 'type:';
     }
 
+    commentFieldsOptions = addCommentSubFieldsOptions(commentFieldsOptions, data, path, key);
+
+    // If commentFieldOptions is defined on the model and the currentPath matches the path and key
+    // defined in one of the options, then comment out that line.
+    if ( Array.isArray(commentFieldsOptions) && commentFieldsOptions.length ) {
+      const currentPath = path ? `${ path }.${ key }` : key;
+
+      if ( commentFieldsOptions.some((option) => `${ option.path }.${ option.key }` === currentPath) ) {
+        out = `#${ out }`;
+      }
+    }
+
     // if a key on data is not listed in the schema's resourceFields, just convert it to yaml, add indents where needed, and return
     if ( !field ) {
       if (data[key]) {
@@ -275,7 +293,7 @@ export function createYaml(
         out += `#  key: ${ mapOf }`;
       } else {
         // If not a simple type ie some sort of object/array, recursively build out commented fields (note data = null here) per the type's (mapOf's) schema
-        const chunk = createYaml(schemas, mapOf, null, processAlwaysAdd, depth + 1, (path ? `${ path }.${ key }` : key), rootType, dataOptions);
+        const chunk = createYaml(schemas, mapOf, null, processAlwaysAdd, depth + 1, (path ? `${ path }.${ key }` : key), rootType, dataOptions, commentFieldsOptions);
         let indented = indent(chunk);
 
         // convert "#    foo" to "#foo"
@@ -296,7 +314,34 @@ export function createYaml(
           if ( cleaned?.[key] ) {
             const parsedData = jsyaml.dump(cleaned[key]);
 
-            out += `\n${ indent(parsedData.trim()) }`;
+            let chunk;
+
+            // If commentFieldOptions is defined on the model and the array has the property (`key`)
+            // defined in one of the options, then comment out that line.
+            if ( Array.isArray(commentFieldsOptions) && commentFieldsOptions.length ) {
+              let lines = parsedData.split('\n');
+
+              commentFieldsOptions.forEach((option) => {
+                // Assuming the path for the current array matches the option's path
+                // and the specific key to comment out exists in the array
+                if ( `${ path }.${ key }` === option.path && data[key][option.key] !== undefined ) {
+                  // Comment out the line containing the target line
+                  lines = lines.map((line, i) => {
+                    if ( i === Number(option.key) ) {
+                      return `#${ line }`;
+                    }
+
+                    return line;
+                  });
+                }
+              });
+
+              chunk = lines.join('\n').trim();
+            } else {
+              chunk = parsedData.trim();
+            }
+
+            out += `\n${ indent(chunk) }`;
           }
         } catch (e) {
           console.error(`Error: Unable to parse array data for yaml of type: ${ type }`, e); // eslint-disable-line no-console
@@ -306,7 +351,7 @@ export function createYaml(
       if ( SIMPLE_TYPES.includes(arrayOf) ) {
         out += `\n#  - ${ arrayOf }`;
       } else {
-        const chunk = createYaml(schemas, arrayOf, null, false, depth + 1, (path ? `${ path }.${ key }` : key), rootType, dataOptions);
+        const chunk = createYaml(schemas, arrayOf, null, false, depth + 1, (path ? `${ path }.${ key }` : key), rootType, dataOptions, commentFieldsOptions);
         let indented = indent(chunk, 2);
 
         // turn "#        foo" into "#  - foo"
@@ -357,19 +402,45 @@ export function createYaml(
 
     const subDef = schemaDefinitions?.[type] || findBy(schemas, 'id', type);
 
-    if ( subDef) {
+    if ( subDef ) {
       let chunk;
 
       if (subDef?.resourceFields && !isEmpty(subDef?.resourceFields)) {
-        chunk = createYaml(schemas, type, data[key], processAlwaysAdd, depth + 1, (path ? `${ path }.${ key }` : key), rootType, dataOptions);
+        chunk = createYaml(schemas, type, data[key], processAlwaysAdd, depth + 1, (path ? `${ path }.${ key }` : key), rootType, dataOptions, commentFieldsOptions);
       } else if (data[key]) {
         // if there are no fields defined on the schema but there are in the data, just format data as yaml and add to output yaml
         try {
           const parsed = jsyaml.dump(data[key]);
 
-          chunk = parsed.trim();
+          // If commentFieldOptions is defined on the model and `data[key]` has the property (`key`)
+          // defined in one of the options, then comment out that line.
+          if ( Array.isArray(commentFieldsOptions) && commentFieldsOptions.length ) {
+            let lines = parsed.split('\n');
+
+            commentFieldsOptions.forEach((option) => {
+              // Assuming the path for the current data[key] matches the option's path
+              // and the specific key to comment out exists in the data[key]
+              if ( `${ path }.${ key }` === option.path && data[key][option.key] !== undefined ) {
+                const targetKeyString = `${ option.key }:`;
+
+                // Comment out the line containing the target key
+                lines = lines.map((line) => {
+                  if ( line.trim().startsWith(targetKeyString) ) {
+                    return `# ${ line }`;
+                  }
+
+                  return line;
+                });
+              }
+            });
+
+            chunk = lines.join('\n').trim();
+          } else {
+            // If commentFieldsOptions do not exist, use the original `parsed` string
+            chunk = parsed.trim();
+          }
         } catch (e) {
-          console.error(`Error: Unale to parse data for yaml of type: ${ type }`, e); // eslint-disable-line no-console
+          console.error(`Error: Unable to parse data for yaml of type: ${ type }`, e); // eslint-disable-line no-console
         }
       }
 
@@ -380,6 +451,29 @@ export function createYaml(
 
     return out;
   }
+
+  /**
+   * Extends original commentFieldsOptions to cover nested objects
+   */
+  function addCommentSubFieldsOptions(options, data, path, key) {
+    if (!!options) {
+      if ( Array.isArray(options) && options.length ) {
+        const currentPath = path ? `${ path }.${ key }` : key;
+
+        if ( options.some((option) => `${ option.path }.${ option.key }` === currentPath) ) {
+          options = [
+            ...options,
+            ...Object.keys(data[key]).map((k) => ({
+              path: `${ path }.${ key }`,
+              key:  k
+            }))
+          ];
+        }
+      }
+    }
+
+    return options;
+  }
 }
 
 function comment(lines) {

package/utils/crypto/encryption.ts

@@ -0,0 +1,103 @@
+/**
+ * Helpers for string encryption and decryption
+ */
+
+// We just use a static salt
+const SALT = new TextEncoder().encode('rancher-dashboard');
+
+/**
+ * Type for the result of encryption
+ */
+export type EncryptedString = {
+  cipher: string;
+  iv: string;
+};
+
+/**
+ * Generate an encryption key from a password
+ *
+ * @param password Password to use for the key
+ * @returns Encryption key
+ */
+export async function deriveKey(password: string): Promise<CryptoKey> {
+  const passwordBytes = stringToBytes(password);
+
+  const initialKey = await crypto.subtle.importKey(
+    'raw',
+    passwordBytes,
+    { name: 'PBKDF2' },
+    false,
+    ['deriveKey']
+  );
+
+  return await crypto.subtle.deriveKey(
+    {
+      name:       'PBKDF2',
+      salt:       SALT,
+      iterations: 100000,
+      hash:       'SHA-256'
+    },
+    initialKey,
+    {
+      name:   'AES-GCM',
+      length: 256
+    },
+    false,
+    [
+      'encrypt',
+      'decrypt'
+    ]
+  );
+}
+
+/**
+ * Encrypt data
+ *
+ * @param content String to be encrypted
+ * @param key Encryption key
+ * @returns Encrypted data
+ */
+export async function encrypt(content: string, key: CryptoKey): Promise<EncryptedString> {
+  const iv = crypto.getRandomValues(new Uint8Array(12));
+  const contentBytes = stringToBytes(content);
+  const cipher = new Uint8Array(
+    await crypto.subtle.encrypt({ name: 'AES-GCM', iv }, key, contentBytes)
+  );
+
+  return {
+    iv:     bytesToBase64(iv),
+    cipher: bytesToBase64(cipher),
+  };
+}
+
+/**
+ * Decrypt encrypted data
+ * @param encryptedData Encrypted data with `cipher` and `iv` field
+ * @param key Key to use for decryption
+ * @returns Decrypted value as a string
+ */
+export async function decrypt(encryptedData: EncryptedString, key: CryptoKey): Promise<string> {
+  const iv = base64ToBytes(encryptedData.iv);
+  const cipher = base64ToBytes(encryptedData.cipher);
+  const contentBytes = new Uint8Array(
+    await crypto.subtle.decrypt({ name: 'AES-GCM', iv }, key, cipher)
+  );
+
+  return bytesToString(contentBytes);
+}
+
+function bytesToString(bytes: any): string {
+  return new TextDecoder().decode(bytes);
+}
+
+function stringToBytes(str: string): Uint8Array {
+  return new TextEncoder().encode(str);
+}
+
+function bytesToBase64(arr: Uint8Array) {
+  return btoa(Array.from(arr, (b: number) => String.fromCharCode(b)).join(''));
+}
+
+function base64ToBytes(base64: string): Uint8Array {
+  return Uint8Array.from(atob(base64), (c) => c.charCodeAt(0));
+}

package/utils/cspAdaptor.ts

@@ -0,0 +1,51 @@
+// For testing these could be changed to something like...
+
+import { CATALOG } from '@shell/config/types';
+import { FilterArgs, PaginationFilterField, PaginationParamFilter } from '@shell/types/store/pagination.types';
+import { VuexStore } from '@shell/types/store/vuex';
+
+const CSP_ADAPTER_APPS = ['rancher-csp-adapter', 'rancher-csp-billing-adapter'];
+// For testing above line could be replaced with below line...
+// const cspAdaptorApp = ['rancher-webhooka', 'rancher-webhook'];
+
+/**
+ * Helpers in order to
+ */
+class CspAdapterUtils {
+  static canPagination($store: VuexStore): boolean {
+    return $store.getters[`management/paginationEnabled`]({ id: CATALOG.APP, context: 'branding' });
+  }
+
+  static fetchCspAdaptorApp($store: VuexStore): Promise<any> {
+    // For the login page, the schemas won't be loaded - we don't need the apps in this case
+    if ($store.getters['management/canList'](CATALOG.APP)) {
+      if (CspAdapterUtils.canPagination($store)) {
+        // Restrict the amount of apps we need to fetch
+        return $store.dispatch('management/findPage', {
+          type: CATALOG.APP,
+          opt:  { // Of type ActionFindPageArgs
+            pagination: new FilterArgs({
+              filters: PaginationParamFilter.createMultipleFields(CSP_ADAPTER_APPS.map(
+                (t) => new PaginationFilterField({
+                  field: 'metadata.name',
+                  value: t,
+                })
+              )),
+            })
+          }
+        });
+      }
+
+      return $store.dispatch('management/findAll', { type: CATALOG.APP });
+    }
+
+    return Promise.resolve([]);
+  }
+
+  static hasCspAdapter({ $store, apps }: { $store: VuexStore, apps: any[]}): Object {
+    // In theory this should contain the filtered apps when pagination is on, and all apps when off. Keep filtering though in both cases just in case
+    return apps?.find((a) => CSP_ADAPTER_APPS.includes(a.metadata?.name));
+  }
+}
+
+export default CspAdapterUtils;