@rancher/shell 1.2.2 → 1.2.5-rc.1

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/shell/types/shell/index.d.ts

@@ -0,0 +1,2 @@
+// Auto-generated type definitions for shell
+// Do not modify this file as changes will get overwritten

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/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/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/creators/app/app.package.json

@@ -1,13 +0,0 @@
-{
-  "name": "NAME",
-  "version": "0.1.0",
-  "private": false,
-  "engines": {
-    "node": ">=12"
-  },
-  "dependencies": {},
-  "resolutions": {
-    "**/webpack": "4",
-    "@types/node": "^16"
-  }  
-}

package/creators/app/files/.eslintignore

@@ -1,18 +0,0 @@
-assets/fonts
-coverage
-.nyc_output
-node_modules/
-.npm
-.eslintcache
-.env
-.cache
-.next
-.nuxt
-dist
-dist-pkg
-.DS_Store
-dynamic-importer.js
-ksconfig.json
-nuxt.config.js
-shell/utils/dynamic-importer.js
-shell/assets/fonts

package/creators/app/files/.eslintrc.js

@@ -1,173 +0,0 @@
-module.exports = {
-  root: true,
-  env:  {
-    browser: true,
-    node:    true
-  },
-  globals: { NodeJS: true, Timer: true },
-  extends: [
-    'standard',
-    'eslint:recommended',
-    '@nuxtjs/eslint-config-typescript',
-    'plugin:cypress/recommended'
-  ],
-  // add your custom rules here
-  rules: {
-    'dot-notation':             'off',
-    'generator-star-spacing':   'off',
-    'guard-for-in':             'off',
-    'linebreak-style':          'off',
-    'new-cap':                  'off',
-    'no-empty':                 'off',
-    'no-extra-boolean-cast':    'off',
-    'no-new':                   'off',
-    'no-plusplus':              'off',
-    'no-useless-escape':        'off',
-    'nuxt/no-cjs-in-config':    'off',
-    'semi-spacing':             'off',
-    'space-in-parens':          'off',
-    strict:                     'off',
-    'unicorn/no-new-buffer':    'off',
-    'vue/html-self-closing':    'off',
-    'vue/no-unused-components': 'warn',
-    'vue/no-v-html':            'error',
-    'wrap-iife':                'off',
-
-    'array-bracket-spacing':             'warn',
-    'arrow-parens':                      'warn',
-    'arrow-spacing':                     ['warn', { before: true, after: true }],
-    'block-spacing':                     ['warn', 'always'],
-    'brace-style':                       ['warn', '1tbs'],
-    'comma-dangle':                      ['warn', 'only-multiline'],
-    'comma-spacing':                     'warn',
-    curly:                               'warn',
-    eqeqeq:                              'warn',
-    'func-call-spacing':                 ['warn', 'never'],
-    'implicit-arrow-linebreak':          'warn',
-    indent:                              ['warn', 2],
-    'keyword-spacing':                   'warn',
-    'lines-between-class-members':       ['warn', 'always', { exceptAfterSingleLine: true }],
-    'multiline-ternary':                 ['warn', 'never'],
-    'newline-per-chained-call':          ['warn', { ignoreChainWithDepth: 4 }],
-    'no-caller':                         'warn',
-    'no-cond-assign':                    ['warn', 'except-parens'],
-    'no-console':                        'warn',
-    'no-debugger':                       'warn',
-    'no-eq-null':                        'warn',
-    'no-eval':                           'warn',
-    'no-trailing-spaces':                'warn',
-    'no-undef':                          'warn',
-    'no-unused-vars':                    'warn',
-    'no-whitespace-before-property':     'warn',
-    'object-curly-spacing':              ['warn', 'always'],
-    'object-property-newline':           'warn',
-    'object-shorthand':                  'warn',
-    'padded-blocks':                     ['warn', 'never'],
-    'prefer-arrow-callback':             'warn',
-    'prefer-template':                   'warn',
-    'quote-props':                       'warn',
-    'rest-spread-spacing':               'warn',
-    semi:                                ['warn', 'always'],
-    'space-before-function-paren':       ['warn', 'never'],
-    'space-infix-ops':                   'warn',
-    'spaced-comment':                    'warn',
-    'switch-colon-spacing':              'warn',
-    'template-curly-spacing':            ['warn', 'always'],
-    'yield-star-spacing':                ['warn', 'both'],
-
-    'key-spacing':              ['warn', {
-      align: {
-        beforeColon: false,
-        afterColon:  true,
-        on:          'value',
-        mode:        'minimum'
-      },
-      multiLine: {
-        beforeColon: false,
-        afterColon:  true
-      },
-    }],
-
-    'object-curly-newline':          ['warn', {
-      ObjectExpression:  {
-        multiline:     true,
-        minProperties: 3
-      },
-      ObjectPattern:     {
-        multiline:     true,
-        minProperties: 4
-      },
-      ImportDeclaration: {
-        multiline:     true,
-        minProperties: 5
-      },
-      ExportDeclaration: {
-        multiline:     true,
-        minProperties: 3
-      }
-    }],
-
-    'padding-line-between-statements': [
-      'warn',
-      {
-        blankLine: 'always',
-        prev:      '*',
-        next:      'return',
-      },
-      {
-        blankLine: 'always',
-        prev:      'function',
-        next:      'function',
-      },
-      // This configuration would require blank lines after every sequence of variable declarations
-      {
-        blankLine: 'always',
-        prev:      ['const', 'let', 'var'],
-        next:      '*'
-      },
-      {
-        blankLine: 'any',
-        prev:      ['const', 'let', 'var'],
-        next:      ['const', 'let', 'var']
-      }
-    ],
-
-    quotes: [
-      'warn',
-      'single',
-      {
-        avoidEscape:           true,
-        allowTemplateLiterals: true
-      },
-    ],
-
-    'space-unary-ops': [
-      'warn',
-      {
-        words:    true,
-        nonwords: false,
-      }
-    ],
-
-    // FIXME: The following is disabled due to new linter and old JS code. These should all be enabled and underlying issues fixed
-    'vue/order-in-components':              'off',
-    'vue/no-lone-template':                 'off',
-    'vue/v-slot-style':                     'off',
-    'vue/component-tags-order':             'off',
-    'vue/no-mutating-props':                'off',
-    '@typescript-eslint/no-unused-vars':    'off',
-    'array-callback-return':                'off',
-  },
-  overrides: [
-    {
-      files: ['*.js'],
-      rules: {
-        // FIXME: The following is disabled due to new linter and old JS code. These should all be enabled and underlying issues fixed
-        'prefer-regex-literals':                'off',
-        'vue/component-definition-name-casing': 'off',
-        'no-unreachable-loop':                  'off',
-        'computed-property-spacing':            'off',
-      }
-    }
-  ]
-};

package/creators/app/files/.gitignore

@@ -1,70 +0,0 @@
-# compiled output
-/dist
-/tmp
-/out-tsc
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# IDEs and editors
-.idea
-.project
-.classpath
-.c9/
-*.launch
-.settings/
-*.sublime-workspace
-
-# IDE - VSCode
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-
-# misc
-.sass-cache
-connect.lock
-typings
-
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# System Files
-.DS_Store
-Thumbs.db

package/creators/app/files/.vscode/settings.json

@@ -1,22 +0,0 @@
-{
-  "files.exclude": {
-    ".ackrc": true,
-    ".dockerignore": true,
-    ".drone.yml": true,
-    ".editorconfig": true,
-    ".eslintcache": true,
-    ".eslintignore": true,
-    ".eslintrc.js": true,
-    ".gitignore": true,
-    ".nuxt*": true,
-    ".nyc_output": true,
-    ".vscode": true,
-    "LICENSE": true,
-    "node_modules": true,
-    "babel.config.js": true,
-    "jsconfig.json": true,
-    "yarn-error.log": true,
-    "pkg/**/.shell": true,
-    "pkg/**/node_modules": true,
-  }
-}

package/creators/app/files/babel.config.js

@@ -1 +0,0 @@
-module.exports = require('@rancher/shell/babel.config.js');

package/creators/app/files/tsconfig.json

@@ -1,42 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2018",
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "lib": [
-      "ESNext",
-      "ESNext.AsyncIterable",
-      "DOM"
-    ],
-    "esModuleInterop": true,
-    "allowJs": true,
-    "sourceMap": true,
-    "strict": true,
-    "noEmit": true,
-    "baseUrl": ".",
-    "paths": {
-      "~/*": [
-        "./*"
-      ],
-      "@/*": [
-        "./*"
-      ],
-      "@shell/*": [
-        "./node_modules/@rancher/shell/*"
-      ]
-    },
-    "typeRoots": [
-      "./node_modules",
-      "./node_modules/@rancher/shell/types"
-    ],    
-    "types": [
-      "@types/node",
-      "cypress",
-      "rancher",
-      "shell"
-    ]
-  },
-  "exclude": [
-    "node_modules"
-  ]
-}

package/creators/app/files/vue.config.js

@@ -1,6 +0,0 @@
-const config = require('@rancher/shell/vue.config');
-
-module.exports = config(__dirname, {
-  excludes: [],
-  // excludes: ['fleet', 'example']
-});