@rancher/shell 1.2.3 → 1.2.5

package/scripts/test-plugins-build.sh

@@ -7,6 +7,9 @@ echo "Checking plugin build"
 SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 BASE_DIR="$( cd $SCRIPT_DIR && cd ../.. & pwd)"
 SHELL_DIR=$BASE_DIR/shell/
+SHELL_VERSION="99.99.99"
+DEFAULT_NPM_REGISTRY="https://registry.npmjs.org/"
+VERDACCIO_NPM_REGISTRY="http://localhost:4873"
 
 echo ${SCRIPT_DIR}
 
@@ -66,29 +69,46 @@ else
   rm -rf ~/.config/verdaccio/storage/@rancher/*
 fi
 
-export YARN_REGISTRY=http://localhost:4873
+export NPM_REGISTRY=$VERDACCIO_NPM_REGISTRY
 export NUXT_TELEMETRY_DISABLED=1
 
 # Remove test package from previous run, if present
-rm -rf ${BASE_DIR}/pkg/test-pkg
+if [ "${TEST_PERSIST_BUILD}" != "true" ]; then
+  echo "Removing folder ${BASE_DIR}/pkg/test-pkg"
+  rm -rf ${BASE_DIR}/pkg/test-pkg
+fi
 
 # We need to patch the version number of the shell, otherwise if we are running
 # with the currently published version, things will fail as those versions
 # are already published and Verdaccio will check, since it is a read-through cache
-sed -i.bak -e "s/\"version\": \"[0-9]*.[0-9]*.[0-9]*\",/\"version\": \"7.7.7\",/g" ${SHELL_DIR}/package.json
-rm ${SHELL_DIR}/package.json.bak
+update_version_in_package_json() {
+  local package_json_path="$1"
+  local version="$2"
+
+  sed -i.bak -e "s/\"version\": \"[0-9]*.[0-9]*.[0-9]*\(-alpha\.[0-9]*\|-release[0-9]*.[0-9]*.[0-9]*\|-rc\.[0-9]*\)\{0,1\}\",/\"version\": \"${version}\",/g" "$package_json_path"
+  rm "${package_json_path}.bak"
+}
 
-# Same as above for Rancher Components
-# We might have bumped the version number but its not published yet, so this will fail
-sed -i.bak -e "s/\"version\": \"[0-9]*.[0-9]*.[0-9]*\",/\"version\": \"7.7.7\",/g" ${BASE_DIR}/pkg/rancher-components/package.json
+update_version_in_package_json "${SHELL_DIR}/package.json" "${SHELL_VERSION}"
+update_version_in_package_json "${BASE_DIR}/pkg/rancher-components/package.json" "${SHELL_VERSION}"
+update_version_in_package_json "${BASE_DIR}/creators/extension/package.json" "${SHELL_VERSION}"
 
-# Publish shell
-echo "Publishing shell packages to local registry"
+# Publish shell pkg (tag is needed as publish-shell is optimized to work with release-shell-pkg workflow)
+echo "Publishing Shell package to local registry"
 yarn install
+export TAG="shell-pkg-v${SHELL_VERSION}"
+${SHELL_DIR}/scripts/publish-shell.sh
+
+# Publish creators pkg (tag is needed as publish-shell is optimized to work with release-shell-pkg workflow)
+echo "Publishing Creators package to local registry"
+export TAG="creators-pkg-v${SHELL_VERSION}"
 ${SHELL_DIR}/scripts/publish-shell.sh
 
 # Publish rancher components
 yarn build:lib
+
+npm set registry ${VERDACCIO_NPM_REGISTRY}
+yarn config set registry ${VERDACCIO_NPM_REGISTRY}
 yarn publish:lib
 
 # We pipe into cat for cleaner logging - we need to set pipefail
@@ -101,25 +121,18 @@ if [ "${SKIP_STANDALONE}" == "false" ]; then
 
   echo "Using temporary directory ${DIR}"
 
-  echo "Verifying app creator package"
+  echo "Verifying extension creator"
 
-  yarn create @rancher/app test-app
-  pushd test-app
-  yarn install
-
-  echo "Building skeleton app"
-  FORCE_COLOR=true yarn build | cat
+  FORCE_COLOR=true yarn create @rancher/extension test-pkg --app-name test-app | cat
 
-  # Package creator
-  echo "Verifying package creator package"
-  yarn create @rancher/pkg test-pkg
+  pushd test-app > /dev/null
 
-  echo "Building test package"
-  FORCE_COLOR=true yarn build-pkg test-pkg | cat
+  yarn install
+  FORCE_COLOR=true yarn build | cat
 
   # Add test list component to the test package
   # Validates rancher-components imports
-  mkdir pkg/test-pkg/list
+  mkdir -p pkg/test-pkg/list
   cp ${SHELL_DIR}/list/catalog.cattle.io.clusterrepo.vue pkg/test-pkg/list
 
   FORCE_COLOR=true yarn build-pkg test-pkg | cat
@@ -127,22 +140,91 @@ if [ "${SKIP_STANDALONE}" == "false" ]; then
   echo "Cleaning temporary dir"
   popd > /dev/null
 
-  rm -rf ${DIR}
+  if [ "${TEST_PERSIST_BUILD}" != "true" ]; then
+    echo "Removing folder ${DIR}"
+    rm -rf ${DIR}
+  fi
 fi
 
 pushd $BASE_DIR
-pwd
-ls
 
 # Now try a plugin within the dashboard codebase
 echo "Validating in-tree package"
 
 yarn install
 
-rm -rf ./pkg/test-pkg
-yarn create @rancher/pkg test-pkg -t
+if [ "${TEST_PERSIST_BUILD}" != "true" ]; then
+  echo "Removing folder ./pkg/test-pkg"
+  rm -rf ./pkg/test-pkg
+fi
+
+yarn create @rancher/extension test-pkg -i
 cp ${SHELL_DIR}/list/catalog.cattle.io.clusterrepo.vue ./pkg/test-pkg/list
 FORCE_COLOR=true yarn build-pkg test-pkg | cat
-rm -rf ./pkg/test-pkg
 
-echo "All done"
+if [ "${TEST_PERSIST_BUILD}" != "true" ]; then
+  echo "Removing folder ./pkg/test-pkg"
+  rm -rf ./pkg/test-pkg
+fi
+
+# function to clone repos and install dependencies (including the newly published shell version)
+function clone_repo_test_extension_build() {
+  REPO_NAME=$1
+  PKG_NAME=$2
+
+  echo -e "\nSetting up $REPO_NAME repository locally\n"
+
+  # set registry to default (to install all of the other dependencies)
+  yarn config set registry ${DEFAULT_NPM_REGISTRY}
+
+  if [ "${TEST_PERSIST_BUILD}" != "true" ]; then
+    echo "Removing folder ${BASE_DIR}/$REPO_NAME"
+    rm -rf ${BASE_DIR}/$REPO_NAME
+  fi
+
+  # cloning repo
+  git clone https://github.com/rancher/$REPO_NAME.git
+  pushd ${BASE_DIR}/$REPO_NAME
+
+  echo -e "\nInstalling dependencies for $REPO_NAME\n"
+  yarn install
+
+  # set registry to local verdaccio (to install new shell)
+  yarn config set registry ${VERDACCIO_NPM_REGISTRY}
+
+  # update package.json to use a specific version of shell
+  sed -i.bak -e "s/\"\@rancher\/shell\": \"[0-9]*.[0-9]*.[0-9]*\",/\"\@rancher\/shell\": \"${SHELL_VERSION}\",/g" package.json
+  rm package.json.bak
+
+  # we need to remove yarn.lock, otherwise it would install a version that we don't want
+  rm yarn.lock
+
+  echo -e "\nInstalling newly built shell version\n"
+
+  # installing new version of shell
+  yarn add @rancher/shell@${SHELL_VERSION}
+
+  # test build-pkg
+  FORCE_COLOR=true yarn build-pkg $PKG_NAME | cat
+
+  # # kubewarden has some unit tests and they should be quick to run... Let's check them as well
+  # if [ "${REPO_NAME}" == "kubewarden-ui" ]; then
+  #   yarn test:ci
+  # fi
+
+  # return back to the base path
+  popd
+
+  # delete folder
+  echo "Removing folder ${BASE_DIR}/$REPO_NAME"
+  rm -rf ${BASE_DIR}/$REPO_NAME
+  yarn config set registry ${DEFAULT_NPM_REGISTRY}
+}
+
+# Here we just add the extension that we want to include as a check (all our official extensions should be included here)
+# Don't forget to add the unit tests exception to clone_repo_test_extension_build function if a new extension has those
+# clone_repo_test_extension_build "kubewarden-ui" "kubewarden"
+# clone_repo_test_extension_build "elemental-ui" "elemental"
+# clone_repo_test_extension_build "capi-ui-extension" "capi"
+
+echo "All done"

package/scripts/typegen.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
-BASE_DIR="$( cd $SCRIPT_DIR && cd ../.. & pwd)"
+BASE_DIR="$(git rev-parse --show-toplevel)"
 SHELL_DIR=$BASE_DIR/shell
 
 echo "Generating typescript definitions"
@@ -12,37 +12,40 @@ mkdir -p ${SHELL_DIR}/tmp
 echo "Generating ..."
 
 # utils
-${BASE_DIR}/node_modules/.bin/tsc shell/utils/*.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/utils > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/utils/validators/*.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/utils/validators > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/utils/crypto/*.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/utils/crypto > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/utils/*.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/utils > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/utils/validators/*.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/utils/validators > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/utils/crypto/*.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/utils/crypto > /dev/null
 
 # config
-${BASE_DIR}/node_modules/.bin/tsc shell/config/query-params.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/config > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/config/table-headers.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/config > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/config/types.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/config > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/config/labels-annotations.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/config > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/config/query-params.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/config > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/config/table-headers.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/config > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/config/types.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/config > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/config/labels-annotations.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/config > /dev/null
 
-# store
-${BASE_DIR}/node_modules/.bin/tsc shell/store/features.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/store > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/store/prefs.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/store > /dev/null
+# # store
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/store/features.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/store > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/store/prefs.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/store > /dev/null
 
-# plugins
-${BASE_DIR}/node_modules/.bin/tsc shell/plugins/dashboard-store/normalize.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/plugins/dashboard-store/resource-class.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/plugins/dashboard-store/classify.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/plugins/dashboard-store/actions.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
+# # plugins
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/plugins/dashboard-store/normalize.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/plugins/dashboard-store/resource-class.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/plugins/dashboard-store/classify.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/plugins/dashboard-store/actions.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store/ > /dev/null
 
-# mixins
-${BASE_DIR}/node_modules/.bin/tsc shell/mixins/create-edit-view/index.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/mixins/create-edit-view > /dev/null
+# # mixins
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/mixins/create-edit-view/index.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/mixins/create-edit-view > /dev/null
 
-# models
-${BASE_DIR}/node_modules/.bin/tsc shell/models/namespace.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/models/ > /dev/null
-${BASE_DIR}/node_modules/.bin/tsc shell/models/networking.k8s.io.ingress.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/models/ > /dev/null
+# # models
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/models/namespace.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/models/ > /dev/null
+${BASE_DIR}/node_modules/.bin/tsc ${SHELL_DIR}/models/networking.k8s.io.ingress.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/models/ > /dev/null
 
-#./node_modules/.bin/tsc shell/plugins/dashboard-store/*.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store > /dev/null
+#./node_modules/.bin/tsc ${SHELL_DIR}/plugins/dashboard-store/*.js --declaration --allowJs --emitDeclarationOnly --outDir ${SHELL_DIR}/tmp/plugins/dashboard-store
 
 # Go through all of the folders and combine by wrapping with 'declare module'
 
+echo "Contents of ${SHELL_DIR}/tmp after tsc commands:"
+find ${SHELL_DIR}/tmp
+
 echo "Combining type definitions ..."
 
 DEST=${SHELL_DIR}/types/shell
@@ -90,4 +93,4 @@ function processDir() {
 
 processDir ${SHELL_DIR}/tmp @shell
 
-rm -rf ${SHELL_DIR}/tmp
+rm -rf ${SHELL_DIR}/tmp

package/store/catalog.js

@@ -354,7 +354,7 @@ export const actions = {
 
     // As per comment above, when there are no clusters this will be management. Store it such that it can be used for those cases
     commit('setInStore', inStore);
-    hash.cluster = hash.cluster.filter((repo) => !(repo?.metadata?.annotations?.[CATALOG_ANNOTATIONS.HIDDEN_REPO] === 'true'));
+    hash.cluster = hash.cluster?.filter((repo) => !(repo?.metadata?.annotations?.[CATALOG_ANNOTATIONS.HIDDEN_REPO] === 'true'));
 
     commit('setRepos', hash);
 

package/store/features.js

@@ -32,6 +32,7 @@ export const FLEET = create('continuous-delivery', true);
 export const HARVESTER = create('harvester', true);
 export const HARVESTER_CONTAINER = create('harvester-baremetal-container-workload', false);
 export const FLEET_WORKSPACE_BACK = create('provisioningv2-fleet-workspace-back-population', false);
+export const PROVISIONING_PRE_BOOTSTRAP = create('provisioningprebootstrap', false);
 
 // Not currently used.. no point defining ones we don't use
 // export const EMBEDDED_CLUSTER_API = create('embedded-cluster-api', true);

package/store/type-map.utils.ts

@@ -0,0 +1,44 @@
+import { VuexStoreGetters } from '@shell/types/store/vuex';
+import { COUNT } from '@shell/config/types';
+import { ActionFindAllArgs } from '@shell/types/store/dashboard-store.types';
+
+type conditionalDepaginateArgs ={
+  ctx: { rootGetters: VuexStoreGetters},
+  args: { type: string, opt: ActionFindAllArgs},
+};
+type conditionalDepaginateFn = (args: conditionalDepaginateArgs) => boolean
+
+/**
+ * Conditionally determine if a resource should use naive kube pagination api to fetch all results
+ * (not just first page)
+ */
+export const conditionalDepaginate = (
+  depaginate?: conditionalDepaginateFn | boolean,
+  depaginateArgs?: conditionalDepaginateArgs
+): boolean => {
+  if (typeof depaginate === 'function') {
+    return !!depaginateArgs ? depaginate(depaginateArgs) : false;
+  }
+
+  return depaginate as boolean;
+};
+
+/**
+ * Setup a function that will determine if a resource should use native kube pagination api to fetch all resources
+ * (not just the first page)
+ */
+export const configureConditionalDepaginate = (
+  { maxResourceCount, isNorman = false }: { maxResourceCount: number, isNorman: boolean },
+): conditionalDepaginateFn => {
+  return (fnArgs: conditionalDepaginateArgs ): boolean => {
+    const { rootGetters } = fnArgs.ctx;
+    const { type } = fnArgs.args;
+    const safeType = isNorman ? `management.cattle.io.${ type }` : type;
+
+    const inStore = rootGetters['currentStore'](safeType);
+    const resourceCounts = rootGetters[`${ inStore }/all`](COUNT)[0]?.counts[safeType];
+    const resourceCount = resourceCounts?.summary?.count;
+
+    return resourceCount !== undefined ? resourceCount < maxResourceCount : false;
+  };
+};

package/types/shell/index.d.ts

@@ -2873,6 +2873,7 @@ export const FLEET: any;
 export const HARVESTER: any;
 export const HARVESTER_CONTAINER: any;
 export const FLEET_WORKSPACE_BACK: any;
+export const PROVISIONING_PRE_BOOTSTRAP: any;
 export namespace getters {
     function get(state: any, getters: any, rootState: any, rootGetters: any): (name: any) => any;
 }
@@ -3127,6 +3128,7 @@ export function filterHiddenLocalCluster(mgmtClusters: any, store: any): any;
  * @example smallIdentifier('word-wide-web') => 'www'
  */
 export function abbreviateClusterName(input: string): string;
+export function labelForAddon(name: any, configuration?: boolean): any;
 }
 
 // @shell/utils/color

package/types/store/dashboard-store.types.ts

@@ -0,0 +1,23 @@
+/**
+ * Properties on all findX actions
+ */
+export type ActionCoreFindArgs = {
+  force?: boolean,
+}
+
+/**
+ * Args used for findAll action
+ */
+export interface ActionFindAllArgs extends ActionCoreFindArgs {
+  watch?: boolean,
+  namespaced?: string[],
+  incremental?: boolean,
+  hasManualRefresh?: boolean,
+  limit?: number,
+  /**
+   * Iterate over all pages and return all resources.
+   *
+   * This is done via the native kube pagination api, not steve
+   */
+  depaginate?: boolean,
+}

package/types/store/vuex.d.ts

@@ -0,0 +1,9 @@
+// Unfortunately there's no current way to type the vuex store, however we have ts files that references it
+// Until we bring that in, this file can contain the interfaces and types used by ts files in place of `any`
+
+/**
+ * Generic interface for Vuex getters
+ */
+export interface VuexStoreGetters {
+  [name: string]: Function;
+}

package/utils/cluster.js

@@ -1,4 +1,5 @@
 import semver from 'semver';
+import { camelToTitle } from '@shell/utils/string';
 import { CAPI } from '@shell/config/labels-annotations';
 import { MANAGEMENT, VIRTUAL_HARVESTER_PROVIDER } from '@shell/config/types';
 import { SETTING } from '@shell/config/settings';
@@ -90,3 +91,11 @@ export function abbreviateClusterName(input) {
 
   return result;
 }
+
+export function labelForAddon(name, configuration = true) {
+  const addon = camelToTitle(name.replace(/^(rke|rke2|rancher)-/, ''));
+  const fallback = `${ configuration ? '' : 'Add-on: ' }${ addon }`;
+  const key = `cluster.addonChart."${ name }"${ configuration ? '.configuration' : '.label' }`;
+
+  return this.$store.getters['i18n/withFallback'](key, null, fallback);
+}