@rancher/shell 1.2.3 → 1.2.5

package/edit/provisioning.cattle.io.cluster/tabs/AddOnConfig.vue

@@ -0,0 +1,97 @@
+<script>
+import { Banner } from '@components/Banner';
+
+import Questions from '@shell/components/Questions';
+import YamlEditor from '@shell/components/YamlEditor';
+import { labelForAddon } from '@shell/utils/cluster';
+import { _EDIT } from '@shell/config/query-params';
+
+export default {
+  components: {
+    Banner,
+    Questions,
+    YamlEditor
+  },
+
+  props: {
+    mode: {
+      type:     String,
+      required: true,
+    },
+    value: {
+      type:     Object,
+      required: true,
+    },
+    versionInfo: {
+      type:     Object,
+      required: true,
+    },
+    addonVersion: {
+      type:     Object,
+      required: false,
+      default:  null
+    },
+    addonsRev: {
+      type:     Number,
+      required: true,
+    },
+    userChartValuesTemp: {
+      type:     Object,
+      required: true,
+    },
+    initYamlEditor: {
+      type:     Function,
+      required: true,
+    }
+  },
+
+  data() {
+    return { labelForAddon };
+  },
+
+  computed: {
+    isEdit() {
+      return this.mode === _EDIT;
+    },
+  }
+};
+</script>
+
+<template>
+  <div>
+    <Banner
+      v-if="isEdit"
+      color="warning"
+    >
+      {{ t('cluster.addOns.dependencyBanner') }}
+    </Banner>
+    <div
+      v-if="versionInfo && addonVersion"
+      :key="addonsRev"
+    >
+      <h3>{{ labelForAddon(addonVersion.name) }}</h3>
+      <Questions
+        v-if="versionInfo[addonVersion.name] && versionInfo[addonVersion.name].questions && addonVersion.name && userChartValuesTemp[addonVersion.name]"
+        v-model="userChartValuesTemp[addonVersion.name]"
+        :emit="true"
+        in-store="management"
+        :mode="mode"
+        :tabbed="false"
+        :source="versionInfo[addonVersion.name]"
+        :target-namespace="value.metadata.namespace"
+        @updated="$emit('update-questions', addonVersion.name)"
+      />
+      <YamlEditor
+        v-else
+        ref="yaml-values"
+        :value="initYamlEditor(addonVersion.name)"
+        :scrolling="true"
+        :as-object="true"
+        :editor-mode="mode === 'view' ? 'VIEW_CODE' : 'EDIT_CODE'"
+        :hide-preview-buttons="true"
+        @input="data => $emit('update-values', addonVersion.name, data)"
+      />
+      <div class="spacer" />
+    </div>
+  </div>
+</template>

package/mixins/chart.js

@@ -263,6 +263,8 @@ export default {
             id:   `${ this.query.appNamespace }/${ this.query.appName }`,
           });
 
+          await this.existing?.fetchValues(true);
+
           this.mode = _EDIT;
         } catch (e) {
           this.mode = _CREATE;
@@ -420,10 +422,12 @@ export default {
               }
             }
             if (existingCRDApp) {
+              await existingCRDApp.fetchValues(true);
+
               // spec.values are any non-default values the user configured
               // the installation form should show these, as well as any default values from the chart
-              const existingValues = clone(existingCRDApp.spec?.values || {});
-              const defaultValues = clone(existingCRDApp.spec?.chart?.values || {});
+              const existingValues = clone(existingCRDApp.values || {});
+              const defaultValues = clone(existingCRDApp.chartValues || {});
 
               crdVersionInfo.existingValues = existingValues;
               crdVersionInfo.allValues = merge(defaultValues, existingValues);

package/models/catalog.cattle.io.app.js

@@ -4,7 +4,7 @@ import {
 import { CATALOG as CATALOG_ANNOTATIONS, FLEET } from '@shell/config/labels-annotations';
 import { compare, isPrerelease, sortable } from '@shell/utils/version';
 import { filterBy } from '@shell/utils/array';
-import { CATALOG, MANAGEMENT, NORMAN } from '@shell/config/types';
+import { CATALOG, MANAGEMENT, NORMAN, SECRET } from '@shell/config/types';
 import { SHOW_PRE_RELEASE } from '@shell/store/prefs';
 import { set } from '@shell/utils/object';
 
@@ -271,28 +271,119 @@ export default class CatalogApp extends SteveModel {
     };
   }
 
-  get deployedAsLegacy() {
-    return async() => {
-      if (this.spec?.values?.global) {
-        const { clusterName, projectName } = this.spec.values.global;
-
-        if (clusterName && projectName) {
-          try {
-            const legacyApp = await this.$dispatch('rancher/find', {
-              type: NORMAN.APP,
-              id:   `${ projectName }:${ this.metadata?.name }`,
-              opt:  { url: `/v3/project/${ clusterName }:${ projectName }/apps/${ projectName }:${ this.metadata?.name }` }
-            }, { root: true });
-
-            if (legacyApp) {
-              return legacyApp;
-            }
-          } catch (e) {}
-        }
+  async deployedAsLegacy() {
+    await this.fetchValues();
+
+    if (this.values?.global) {
+      const { clusterName, projectName } = this.values.global;
+
+      if (clusterName && projectName) {
+        try {
+          const legacyApp = await this.$dispatch('rancher/find', {
+            type: NORMAN.APP,
+            id:   `${ projectName }:${ this.metadata?.name }`,
+            opt:  { url: `/v3/project/${ clusterName }:${ projectName }/apps/${ projectName }:${ this.metadata?.name }` }
+          }, { root: true });
+
+          if (legacyApp) {
+            return legacyApp;
+          }
+        } catch (e) {}
       }
+    }
 
-      return false;
-    };
+    return false;
+  }
+
+  /**
+   * User and Chart values live in a helm secret, so fetch it (with special param)
+   */
+  async fetchValues(force = false) {
+    if (!this.secretId) {
+      // If there's no secret id this isn't ever going to work, no need to carry on
+      return;
+    }
+
+    const haveValues = !!this._values && !!this._chartValues;
+
+    if (haveValues && !force) {
+      // If we already have the required values and we're not forced to re-fetch, no need to carry on
+      return;
+    }
+
+    try {
+      await this.$dispatch('find', {
+        type: SECRET,
+        id:   this.secretId,
+        opt:  {
+          force:  force || (!!this._secret && !haveValues), // force if explicitly requested or there's ean existing secret without the required values we have a secret without the values in (Secret has been fetched another way)
+          watch:  false, // Cannot watch with custom params (they are dropped on calls made when resyncing over socket)
+          params: { includeHelmData: true }
+        }
+      });
+    } catch (e) {
+      console.error(`Cannot find values for ${ this.id } (unable to fetch)`, e); // eslint-disable-line no-console
+    }
+  }
+
+  get secretId() {
+    const metadata = this.metadata;
+
+    if (!metadata) {
+      return null;
+    }
+    const secretReference = metadata?.ownerReferences?.find((ow) => ow.kind.toLowerCase() === SECRET);
+
+    const secretId = secretReference?.name;
+    const secretNamespace = metadata.namespace;
+
+    if (!secretNamespace || !secretId) {
+      console.warn(`Cannot find values for ${ this.id } (cannot find related secret namespace or id)`); // eslint-disable-line no-console
+
+      return null;
+    }
+
+    return `${ secretNamespace }/${ secretId }`;
+  }
+
+  get _secret() {
+    return this.secretId ? this.$getters['byId'](SECRET, this.secretId) : null;
+  }
+
+  _validateSecret(noun) {
+    if (this._secret === undefined) {
+      throw new Error(`Cannot find ${ noun } for  ${ this.id } (chart secret has not been fetched via app \`fetchValues\`)`);
+    }
+
+    if (this._secret === null) {
+      throw new Error(`Cannot find ${ noun } for ${ this.id } (chart secret cannot or has failed to fetch) `);
+    }
+  }
+
+  /**
+   * The user's helm values
+   */
+  get values() {
+    this._validateSecret('values');
+
+    return this._values;
+  }
+
+  get _values() {
+    return this._secret?.data?.release?.config;
+  }
+
+  /**
+   * The Charts default helm values
+   */
+  get chartValues() {
+    this._validateSecret('chartValues');
+
+    return this._chartValues;
+  }
+
+  get _chartValues() {
+    return this._secret?.data?.release?.chart?.values;
   }
 }
 

package/models/management.cattle.io.cluster.js

@@ -16,6 +16,8 @@ import { LINUX, WINDOWS } from '@shell/store/catalog';
 import { KONTAINER_TO_DRIVER } from './management.cattle.io.kontainerdriver';
 import { PINNED_CLUSTERS } from '@shell/store/prefs';
 
+const DEFAULT_BADGE_COLOR = '#707070';
+
 // See translation file cluster.providers for list of providers
 // If the logo is not named with the provider name, add an override here
 const PROVIDER_LOGO_OVERRIDE = {};
@@ -295,20 +297,30 @@ export default class MgmtCluster extends HybridModel {
 
   // Custom badge to show for the Cluster (if the appropriate annotations are set)
   get badge() {
-    const text = this.metadata?.annotations?.[CLUSTER_BADGE.TEXT];
+    const icon = this.metadata?.annotations?.[CLUSTER_BADGE.ICON_TEXT];
+    const comment = this.metadata?.annotations?.[CLUSTER_BADGE.TEXT];
 
-    if (!text) {
+    if (!icon && !comment) {
       return undefined;
     }
 
-    const color = this.metadata?.annotations[CLUSTER_BADGE.COLOR] || '#7f7f7f';
+    let color = this.metadata?.annotations[CLUSTER_BADGE.COLOR] || DEFAULT_BADGE_COLOR;
     const iconText = this.metadata?.annotations[CLUSTER_BADGE.ICON_TEXT] || '';
+    let foregroundColor;
+
+    try {
+      foregroundColor = textColor(parseColor(color.trim())); // Remove any whitespace
+    } catch (_e) {
+      // If we could not parse the badge color, use the defaults
+      color = DEFAULT_BADGE_COLOR;
+      foregroundColor = textColor(parseColor(color));
+    }
 
     return {
-      text,
+      text:      comment || undefined,
       color,
-      textColor: textColor(parseColor(color)),
-      iconText:  iconText.substr(0, 2)
+      textColor: foregroundColor,
+      iconText:  iconText.substr(0, 3)
     };
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rancher/shell",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Rancher Dashboard Shell",
   "repository": "https://github.com/rancherlabs/dashboard",
   "license": "Apache-2.0",

package/pages/c/_cluster/apps/charts/install.vue

@@ -301,8 +301,9 @@ export default {
         */
         userValues = diff(this.loadedVersionValues, this.chartValues);
       } else if ( this.existing ) {
+        await this.existing.fetchValues(); // In theory this has already been called, but do again to be safe
         /* For an already installed app, use the values from the previous install. */
-        userValues = clone(this.existing.spec?.values || {});
+        userValues = clone(this.existing.values || {});
       } else {
         /* For an new app, start empty. */
         userValues = {};

package/plugins/dashboard-store/actions.js

@@ -8,6 +8,7 @@ import { normalizeType } from './normalize';
 import garbageCollect from '@shell/utils/gc/gc';
 import { addSchemaIndexFields } from '@shell/plugins/steve/schema.utils';
 import { addParam } from '@shell/utils/url';
+import { conditionalDepaginate } from '@shell/store/type-map.utils';
 
 export const _ALL = 'all';
 export const _MERGE = 'merge';
@@ -188,7 +189,7 @@ export default {
     opt = opt || {};
     opt.url = getters.urlFor(type, null, opt);
     opt.stream = opt.stream !== false && load !== _NONE;
-    opt.depaginate = typeOptions?.depaginate;
+    opt.depaginate = conditionalDepaginate(typeOptions?.depaginate, { ctx, args: { type, opt } });
 
     let skipHaveAll = false;
 
@@ -367,7 +368,7 @@ export default {
     opt = opt || {};
     opt.labelSelector = selector;
     opt.url = getters.urlFor(type, null, opt);
-    opt.depaginate = typeOptions?.depaginate;
+    opt.depaginate = conditionalDepaginate(typeOptions?.depaginate, { ctx, args: { type, opt } });
 
     const res = await dispatch('request', { opt, type });
 

package/scripts/extension/bundle

@@ -42,7 +42,7 @@ for d in ${BASE_DIR}/dist-pkg/*; do
   mkdir plugin && mv ./${pkg}/* ./plugin
   rm -rf ./${pkg}/* && mv ./plugin ./${pkg}
 
-  find ${pkg} -type f -printf '%P\n' | sort > ./${pkg}/files.txt
+  find ${pkg} -type f | sed "s|^${pkg}/||" | sort > ./${pkg}/files.txt
   popd > /dev/null
 
   cp -R ${BASE_DIR}/dist-pkg/${pkg} ${TMP}/container/plugin

package/scripts/publish-shell.sh

@@ -1,13 +1,19 @@
 #!/usr/bin/env bash
 
+set -eo pipefail
+
 SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)"
-BASE_DIR="$(
-  cd $SCRIPT_DIR && cd ../.. &
-  pwd
-)"
+BASE_DIR="$(cd $SCRIPT_DIR && cd ../.. && pwd)"
 SHELL_DIR=$BASE_DIR/shell/
-TMP_DIR=$BASE_DIR/tmp
-PUBLISH_ARGS="--no-git-tag-version --access public $PUBLISH_ARGS"
+CREATORS_DIR=$BASE_DIR/creators/extension
+FORCE_PUBLISH_TO_NPM="false"
+DEFAULT_NPM_REGISTRY="https://registry.npmjs.org"
+
+# if TAG doesn't exist, we can exit as it's needed for any type of publish.
+if [ -z "$TAG" ]; then
+  echo "You need to set the TAG variable first!"
+  exit 1
+fi
 
 if [ ! -d "${BASE_DIR}/node_modules" ]; then
   echo "You need to run 'yarn install' first"
@@ -16,41 +22,30 @@ fi
 
 echo "Publishing Shell Packages"
 
-# We use the version from the shell package for the creator packages
-# Need to copy them to a temporary location, so we can patch the version number
-# before publishing
+if [ "$1" == "--npm" ]; then
+  FORCE_PUBLISH_TO_NPM="true"
+fi
 
-# To set a token for NPM registry auth: `npm config set //registry.npmjs.org/:_authToken <TOKEN>``
+if [ "$FORCE_PUBLISH_TO_NPM" == "true" ]; then
+  export NPM_REGISTRY=$DEFAULT_NPM_REGISTRY
+fi
 
-PKG_DIST=$BASE_DIR/dist-pkg/creators
-mkdir -p ${PKG_DIST}
-rm -rf ${PKG_DIST}/app
-rm -rf ${PKG_DIST}/pkg
-rm -rf ${PKG_DIST}/update
+PUBLISH_ARGS="--no-git-tag-version --access public --registry $NPM_REGISTRY"
 
 pushd ${SHELL_DIR} >/dev/null
 
-PKG_VERSION=$(node -p "require('./package.json').version")
-popd >/dev/null
-
-echo "Publishing version: $PKG_VERSION"
-
-cp -R ${SHELL_DIR}/creators/app ${PKG_DIST}
-cp -R ${SHELL_DIR}/creators/pkg ${PKG_DIST}
-cp -R ${SHELL_DIR}/creators/update ${PKG_DIST}
-
-sed -i.bak -e "s/\"0.0.0/"\"$PKG_VERSION"/g" ${PKG_DIST}/app/package.json
-sed -i.bak -e "s/\"0.0.0/"\"$PKG_VERSION"/g" ${PKG_DIST}/pkg/package.json
-sed -i.bak -e "s/\"0.0.0/"\"$PKG_VERSION"/g" ${PKG_DIST}/update/package.json
-
-rm ${PKG_DIST}/app/package.json.bak
-rm ${PKG_DIST}/pkg/package.json.bak
-rm ${PKG_DIST}/update/package.json.bak
-
 function publish() {
   NAME=$1
   FOLDER=$2
 
+  # if we pass a third arg, that is the version number
+  # that we want to actually publish on NPM
+  # they should match with the package.json version stated 
+  # because of the check in the "Check Tags Version Matching" step in the workflow
+  if [ -n "$3" ]; then
+    PKG_VERSION=$3
+  fi
+
   echo "Publishing ${NAME} from ${FOLDER}"
   pushd ${FOLDER} >/dev/null
 
@@ -61,25 +56,20 @@ function publish() {
     cp -R ${BASE_DIR}/pkg/rancher-components/src/components ./rancher-components/
   fi
 
-  if [ "$NAME" == "Update" ]; then
-    # Add files from the app and pkg creators to the update package
-    mkdir -p ./app
-    mkdir -p ./pkg
-    cp -R ${BASE_DIR}/shell/creators/app/* ./app
-    cp -R ${BASE_DIR}/shell/creators/pkg/* ./pkg
-    # Remove index.ts from pkg files, as we don't want to replace that
-    rm -f ./pkg/files/index.ts
-
-    # Update the package.json for the app
-    cd app
-    node ${SCRIPT_DIR}/record-deps.js
-    cd ..
+  # if the PKG_VERSION has a - it means it will be a pre-release of legacy-v1
+  if [[ $PKG_VERSION == *"-"* ]]; then
+    PUBLISH_ARGS="$PUBLISH_ARGS --tag legacy-v1-pre-release"
+  else
+    # If we need to release shell, we tag it as legacy-v1
+    PUBLISH_ARGS="$PUBLISH_ARGS --tag legacy-v1"
   fi
 
   # Make a note of dependency versions, if required
   node ${SCRIPT_DIR}/record-deps.js
 
-  yarn publish . --new-version ${PKG_VERSION} ${PUBLISH_ARGS} --tag v1.2
+  echo "Publishing to registry: $NPM_REGISTRY with args: $PUBLISH_ARGS"
+
+  npm publish ${PUBLISH_ARGS}
   RET=$?
 
   popd >/dev/null
@@ -90,15 +80,32 @@ function publish() {
   fi
 }
 
-# Generate the type definitions for the shell
-${SCRIPT_DIR}/typegen.sh
-
-# Publish the packages - don't tag the git repo and don't auto-increment the version number
-publish "Shell" ${SHELL_DIR}
-publish "Application creator" ${PKG_DIST}/app/
-publish "Package creator" ${PKG_DIST}/pkg/
-publish "Update" ${PKG_DIST}/update/
+echo "TAG ${TAG}"
+  
+  # let's get the package name and version from the tag
+PKG_NAME=$(sed 's/-pkg-v.*//' <<< "$TAG")
+PKG_V=$(sed 's/.*-pkg-v//'<<< "$TAG")
 
-echo "Done"
+echo "PKG_NAME ${PKG_NAME}"
+echo "PKG_V ${PKG_V}"
 
+# Generate the type definitions for the shell
+if [ ${PKG_NAME} == "shell" ]; then
+  ${SCRIPT_DIR}/typegen.sh
+fi
 
+# version comparison checks
+case $PKG_NAME in
+  "shell")
+    echo "Publishing only Shell pkg via tagged release"
+    publish "Shell" ${SHELL_DIR} ${PKG_V}
+    ;;
+  "creators")
+    echo "Publishing only Creators pkg via tagged release"
+    publish "Extension creator" ${CREATORS_DIR} ${PKG_V}
+    ;;
+  *)
+    echo "something went wrong with the tagging name => TAG: ${TAG} , PKG_NAME: ${PKG_NAME}. Admissable names are 'shell' and 'creator'"
+    exit 1
+    ;;
+esac