feat: commands should be able to separate resource model fetch from view transformation functions

starpit · starpit · commit e903bc7af135 · 2020-05-03T13:31:02.000-04:00
Fixes #4437
diff --git a/packages/core/src/core/command-tree.ts b/packages/core/src/core/command-tree.ts
@@ -494,20 +494,6 @@ const _read = async <T extends KResponse, O extends ParsedOptions>(
       return false
     }
   } else {
-    if (leaf.options && leaf.options.requiresFullyQualifiedRoute) {
-      const routeWithoutContext = `/${originalArgv.join('/')}`
-      if (leaf.route !== routeWithoutContext) {
-        // e.g. executing "help" we don't want to use the default
-        // context (see "subtree help" above for an example use of
-        // this feature)
-        if (argv.length === originalArgv.length && argv.every((elt, idx) => elt === originalArgv[idx])) {
-          return false
-        } else {
-          return _read(getModelInternal().root, originalArgv, undefined, originalArgv, tryCatchalls)
-        }
-      }
-    }
-
     return withEvents<T, O>(evaluator, leaf)
   }
 }
diff --git a/packages/core/src/models/command.ts b/packages/core/src/models/command.ts
@@ -68,12 +68,6 @@ export interface CommandOptions extends CapabilityRequirements {
   // hint for screen height in popup mode
   height?: number
 
-  // request that the REPL be cleared of the initial command in popup mode
-  clearREPLOnLoad?: boolean
-
-  // show this placeholder text when executing the command in popup mode (instead of the command line)
-  placeholder?: string
-
   /** is this an interior node ("directory", versus a leaf-node with a command handler */
   isDirectory?: boolean
 
@@ -84,8 +78,12 @@ export interface CommandOptions extends CapabilityRequirements {
   override?: CommandHandler<KResponse, ParsedOptions>
   plugin?: string
   okOptions?: string[]
-  isIntention?: boolean
-  requiresFullyQualifiedRoute?: boolean
+
+  /** model to view transformer */
+  viewTransformer?<T extends KResponse, O extends ParsedOptions>(
+    args: EvaluatorArgs<O>,
+    response: T
+  ): Promise<T> | void | Promise<void>
 }
 
 export interface Event {
diff --git a/packages/core/src/models/entity.ts b/packages/core/src/models/entity.ts
@@ -160,10 +160,12 @@ export function isRawResponse<Content extends RawContent>(entity: Entity<Content
  */
 export type ScalarResponse<RowType extends Row = Row> = SimpleEntity | Table<RowType> | MixedResponse
 
+export type ViewableResponse = MultiModalResponse | NavResponse
+
 export type StructuredResponse<
   Content = void,
   SomeSortOfResource extends MetadataBearing<Content> = MetadataBearing<Content>
-> = MultiModalResponse | NavResponse | UsageModel | SomeSortOfResource | RawResponse<Content>
+> = ViewableResponse | UsageModel | SomeSortOfResource | RawResponse<Content>
 
 /**
  * A potentially more complex entity with a "spec"
diff --git a/packages/core/src/repl/exec.ts b/packages/core/src/repl/exec.ts
@@ -35,6 +35,7 @@ import { isNavResponse } from '../models/NavResponse'
 import {
   CommandTreeResolution,
   CommandHandlerWithEvents,
+  EvaluatorArgs as Arguments,
   ExecType,
   EvaluatorArgs,
   KResponse,
@@ -336,21 +337,23 @@ class InProcessExecutor implements Executor {
 
       this.loadSymbolTable(tab, execOptions)
 
+      const args: Arguments<O> = {
+        tab,
+        REPL,
+        block: execOptions.block,
+        nextBlock: undefined,
+        argv,
+        command,
+        execOptions,
+        argvNoOptions,
+        parsedOptions: parsedOptions as O,
+        createOutputStream: execOptions.createOutputStream || (() => this.makeStream(getTabId(tab), execUUID))
+      }
+
       let response: T | Promise<T>
       try {
         response = await Promise.resolve(
-          currentEvaluatorImpl.apply<T, O>(commandUntrimmed, execOptions, evaluator, {
-            tab,
-            REPL,
-            block: execOptions.block,
-            nextBlock: undefined,
-            argv,
-            command,
-            execOptions,
-            argvNoOptions,
-            parsedOptions: parsedOptions as O,
-            createOutputStream: execOptions.createOutputStream || (() => this.makeStream(getTabId(tab), execUUID))
-          })
+          currentEvaluatorImpl.apply<T, O>(commandUntrimmed, execOptions, evaluator, args)
         ).then(response => {
           // indicate that the command was successfuly completed
           evaluator.success({
@@ -371,6 +374,13 @@ class InProcessExecutor implements Executor {
         response = err
       }
 
+      if (evaluator.options.viewTransformer) {
+        response = await Promise.resolve(response).then(async _ => {
+          const maybeAView = await evaluator.options.viewTransformer(args, _)
+          return maybeAView || _
+        })
+      }
+
       // the || true part is a safeguard for cases where typescript
       // didn't catch a command handler returning nothing; it
       // shouldn't happen, but probably isn't a sign of a dire
diff --git a/plugins/plugin-kubectl/components/src/CurrentNamespace.tsx b/plugins/plugin-kubectl/components/src/CurrentNamespace.tsx
@@ -52,7 +52,7 @@ export default class CurrentNamespace extends React.PureComponent<{}, State> {
       const currentContext = await getCurrentContext(tab)
       eventChannelUnsafe.emit('/kubeui/context/current', currentContext)
 
-      if (currentContext.metadata.namespace) {
+      if (currentContext && currentContext.metadata && currentContext.metadata.namespace) {
         this.setState({
           text: currentContext === undefined ? '' : this.renderNamespace(currentContext),
           viewLevel: 'normal' // only show normally if we succeed; see https://github.com/IBM/kui/issues/3537
diff --git a/plugins/plugin-kubectl/oc/src/controller/kubectl/delegates.ts b/plugins/plugin-kubectl/oc/src/controller/kubectl/delegates.ts
@@ -19,9 +19,9 @@ import {
   commandPrefix,
   defaultFlags,
   doCreate,
-  doGet,
+  getter,
   doDelete,
-  doDescribe,
+  describer,
   doEdit,
   doRun
 } from '@kui-shell/plugin-kubectl'
@@ -32,8 +32,9 @@ export default (registrar: Registrar) => {
   registrar.listen(`/${commandPrefix}/${command}/apply`, doCreate('apply', command), defaultFlags)
   registrar.listen(`/${commandPrefix}/${command}/create`, doCreate('create', command), defaultFlags)
   registrar.listen(`/${commandPrefix}/${command}/delete`, doDelete(command), defaultFlags)
-  registrar.listen(`/${commandPrefix}/${command}/describe`, doDescribe(command), defaultFlags)
   registrar.listen(`/${commandPrefix}/${command}/edit`, doEdit(command), defaultFlags)
-  registrar.listen(`/${commandPrefix}/${command}/get`, doGet(command), defaultFlags)
   registrar.listen(`/${commandPrefix}/${command}/run`, doRun(command), defaultFlags)
+
+  getter(registrar, command)
+  describer(registrar, command)
 }
diff --git a/plugins/plugin-kubectl/src/controller/kubectl/contexts.ts b/plugins/plugin-kubectl/src/controller/kubectl/contexts.ts
@@ -14,18 +14,7 @@
  * limitations under the License.
  */
 
-import {
-  i18n,
-  Tab,
-  Table,
-  Row,
-  RawResponse,
-  Arguments,
-  ExecOptions,
-  Registrar,
-  UsageModel,
-  KResponse
-} from '@kui-shell/core'
+import { i18n, Tab, Table, Row, RawResponse, Arguments, Registrar, UsageModel, KResponse } from '@kui-shell/core'
 
 import flags from './flags'
 import apiVersion from './apiVersion'
@@ -55,26 +44,17 @@ const usage = {
  * Add click handlers to change context
  *
  */
-const addClickHandlers = (table: Table, { REPL }: Arguments, execOptions: ExecOptions): Table => {
+const addClickHandlers = (table: Table, { REPL }: Arguments): Table => {
   const body = table.body.map(row => {
     const nameAttr = row.attributes.find(({ key }) => key === 'NAME')
     const { value: contextName } = nameAttr
 
-    nameAttr.outerCSS += ' entity-name-group-narrow'
-
     const onclick = async () => {
-      await REPL.qexec(
-        `kubectl config use-context ${REPL.encodeComponent(contextName)}`,
-        undefined,
-        undefined,
-        Object.assign({}, execOptions, { raw: true })
-      )
-      row.setSelected()
+      await REPL.pexec(`kubectl config use-context ${REPL.encodeComponent(contextName)}`)
     }
 
     row.name = contextName
     row.onclick = onclick
-    nameAttr.onclick = onclick
 
     return row
   })
@@ -134,7 +114,7 @@ const listContexts = async (args: Arguments): Promise<RawResponse<KubeContext[]>
       }))
     }
   } else {
-    return addClickHandlers(contexts, args, execOptions)
+    return addClickHandlers(contexts, args)
   }
 }
 
diff --git a/plugins/plugin-kubectl/src/controller/kubectl/describe.ts b/plugins/plugin-kubectl/src/controller/kubectl/describe.ts
@@ -16,11 +16,10 @@
 
 import { Arguments, Registrar, KResponse } from '@kui-shell/core'
 
-import flags from './flags'
 import { exec } from './exec'
 import commandPrefix from '../command-prefix'
 
-import { doGetAsEntity } from './get'
+import { doGetAsEntity, getFlags as flags } from './get'
 import { KubeOptions } from './options'
 import { isUsage, doHelp } from '../../lib/util/help'
 import { commandWithoutResource } from '../../lib/util/util'
@@ -33,7 +32,7 @@ function prepareArgsForDescribe(args: Arguments<KubeOptions>) {
   return `${args.command.replace(/(k|kubectl|oc)(\s+)describe(\s+)/, '$1$2get$3')} -o yaml`
 }
 
-export const doDescribe = (command = 'kubectl') =>
+const doDescribe = (command: string) =>
   async function(args: Arguments<KubeOptions>): Promise<KResponse> {
     if (isUsage(args)) {
       return doHelp(command, args)
@@ -46,8 +45,12 @@ export const doDescribe = (command = 'kubectl') =>
     }
   }
 
+/** Register a command listener */
+export function describer(registrar: Registrar, command: string, cli = command) {
+  registrar.listen(`/${commandPrefix}/${command}/describe`, doDescribe(cli), flags)
+}
+
 export default (registrar: Registrar) => {
-  const handler = doDescribe()
-  registrar.listen(`/${commandPrefix}/kubectl/describe`, handler, flags)
-  registrar.listen(`/${commandPrefix}/k/describe`, handler, flags)
+  describer(registrar, 'kubectl')
+  describer(registrar, 'k', 'kubectl')
 }
diff --git a/plugins/plugin-kubectl/src/controller/kubectl/flags.ts b/plugins/plugin-kubectl/src/controller/kubectl/flags.ts
@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import { CommandOptions } from '@kui-shell/core'
+
 const defaultBooleans = [
   'w',
   'watch',
@@ -29,7 +31,7 @@ const defaultBooleans = [
   'show-labels'
 ]
 
-export function flags(booleans: string[] = []) {
+export function flags(booleans: string[] = []): CommandOptions {
   return {
     flags: {
       configuration: {
diff --git a/plugins/plugin-kubectl/src/controller/kubectl/get-namespaces.ts b/plugins/plugin-kubectl/src/controller/kubectl/get-namespaces.ts
@@ -17,10 +17,9 @@
 import Debug from 'debug'
 import { isTable, Arguments, Registrar, Tab, Table, Row, Cell, ExecType } from '@kui-shell/core'
 
-import flags from './flags'
 import { getCurrentContext } from './contexts'
 import commandPrefix from '../command-prefix'
-import { doGet, doGetAsTable, rawGet } from './get'
+import { doGet, doGetAsTable, rawGet, getFlags as flags } from './get'
 import { KubeOptions, isTableRequest, isWatchRequest } from './options'
 
 const debug = Debug('plugin-kubectl/controller/kubectl/get/namespace')
diff --git a/plugins/plugin-kubectl/src/controller/kubectl/get.ts b/plugins/plugin-kubectl/src/controller/kubectl/get.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { CodedError, Arguments, ExecType, Registrar, MultiModalResponse, isHeadless, KResponse } from '@kui-shell/core'
+import { CodedError, Arguments, Registrar, MultiModalResponse, isHeadless, KResponse } from '@kui-shell/core'
 
 import flags from './flags'
 import { exec } from './exec'
@@ -25,7 +25,7 @@ import commandPrefix from '../command-prefix'
 import doGetWatchTable from './watch/get-watch'
 import extractAppAndName from '../../lib/util/name'
 import { isUsage, doHelp } from '../../lib/util/help'
-import { KubeResource } from '../../lib/model/resource'
+import { KubeResource, isKubeResource } from '../../lib/model/resource'
 import { KubeOptions, isEntityRequest, isTableRequest, formatOf, isWatchRequest, getNamespace } from './options'
 import { stringToTable, KubeTableResponse, isKubeTableResponse } from '../../lib/view/formatTable'
 
@@ -76,22 +76,37 @@ export function doGetAsTable(
  * `kubectl get` as entity response
  *
  */
-export async function doGetAsEntity(
-  args: Arguments<KubeOptions>,
-  response: RawResponse
-): Promise<MultiModalResponse<KubeResource>> {
+export async function doGetAsEntity(args: Arguments<KubeOptions>, response: RawResponse): Promise<KubeResource> {
   try {
     // this is the raw data string we get from `kubectl`
     const data = response.content.stdout
 
     // parse the raw response; the parser we use depends on whether
     // the user asked for JSON or for YAML
     const resource = formatOf(args) === 'json' ? JSON.parse(data) : (await import('js-yaml')).safeLoad(data)
+    return Object.assign(resource, {
+      isKubeResource: true,
+      kuiRawData: data
+    })
+  } catch (err) {
+    console.error('error handling entity response; raw=', response.content.stdout)
+    throw err
+  }
+}
 
+/**
+ * `kubectl get` as entity response
+ *
+ */
+export async function doGetAsMMR(
+  args: Arguments<KubeOptions>,
+  resource: KubeResource
+): Promise<MultiModalResponse<KubeResource>> {
+  try {
     // attempt to separate out the app and generated parts of the resource name
     const { name: prettyName, nameHash, version } = extractAppAndName(resource)
 
-    if (resource.kind === 'List' && args.execOptions.type === ExecType.TopLevel) {
+    if (resource.kind === 'List') {
       // then this is a response to e.g. `kubectl get pods -o yaml`
       return {
         apiVersion: resource.apiVersion,
@@ -104,7 +119,7 @@ export async function doGetAsEntity(
         originatingCommand: args.command,
         isKubeResource: true,
         modes: [],
-        kuiRawData: data
+        kuiRawData: resource.kuiRawData
       }
     }
 
@@ -120,10 +135,10 @@ export async function doGetAsEntity(
         namespace: `kubectl get ns ${resource.metadata.namespace || 'default'}`
       },
       modes: [], // this tells Kui that we want the response to be interpreted as a MultiModalResponse
-      kuiRawData: data // also include the raw, uninterpreted data string we got back
+      kuiRawData: resource.kuiRawData // also include the raw, uninterpreted data string we got back
     })
   } catch (err) {
-    console.error('error handling entity response; raw=', response.content.stdout)
+    console.error('error handling entity response', resource)
     throw err
   }
 }
@@ -205,7 +220,21 @@ export const doGet = (command: string) =>
     }
   }
 
-export default (commandTree: Registrar) => {
-  commandTree.listen(`/${commandPrefix}/kubectl/get`, doGet('kubectl'), flags)
-  commandTree.listen(`/${commandPrefix}/k/get`, doGet('kubectl'), flags)
+/** KubeResource -> MultiModalResponse view transformer */
+function viewTransformer(args: Arguments<KubeOptions>, response: KubeResource) {
+  if (isKubeResource(response)) {
+    return doGetAsMMR(args, response)
+  }
+}
+
+export const getFlags = Object.assign({}, flags, { viewTransformer })
+
+/** Register a command listener */
+export function getter(registrar: Registrar, command: string, cli = command) {
+  registrar.listen(`/${commandPrefix}/${command}/get`, doGet(cli), getFlags)
+}
+
+export default (registrar: Registrar) => {
+  getter(registrar, 'kubectl')
+  getter(registrar, 'k', 'kubectl')
 }
diff --git a/plugins/plugin-kubectl/src/index.ts b/plugins/plugin-kubectl/src/index.ts
@@ -89,8 +89,8 @@ export { fqnOf, fqn } from './controller/kubectl/fqn'
  *
  */
 export { doEdit } from './controller/kubectl/edit'
-export { doGet } from './controller/kubectl/get'
+export { getter } from './controller/kubectl/get'
 export { doRun } from './controller/kubectl/run'
 export { doCreate } from './controller/kubectl/create'
 export { doDelete } from './controller/kubectl/delete'
-export { doDescribe } from './controller/kubectl/describe'
+export { describer } from './controller/kubectl/describe'
diff --git a/plugins/plugin-kubectl/src/lib/model/resource.ts b/plugins/plugin-kubectl/src/lib/model/resource.ts
diff --git a/plugins/plugin-kubectl/src/test/k8s/contexts.ts b/plugins/plugin-kubectl/src/test/k8s/contexts.ts
