feat: cd command handles VFS mounts

Fixes #6988

Author: myan9

packages/core/src/index.ts

@@ -248,7 +248,7 @@ export {
 
 // Util
 export { findFileWithViewer, findFile, isSpecialDirectory } from './core/find-file'
-export { expandHomeDir } from './util/home'
+export { expandHomeDir, cwd } from './util/home'
 export { flatten } from './core/utility'
 export { promiseEach } from './util/async'
 export { isHTML, isPromise } from './util/types'

packages/core/src/models/tab-state.ts

@@ -18,6 +18,7 @@ import Debug from 'debug'
 
 import { WatchableJob } from '../core/jobs/job'
 import { inBrowser } from '../core/capabilities'
+import { cwd as kuiCwd } from '../util/home'
 import { eventBus, StatusStripeChangeEvent } from '../core/events'
 
 const debug = Debug('core/models/TabState')
@@ -81,7 +82,7 @@ export default class TabState {
   /** Capture contextual global state */
   public capture() {
     this._env = Object.assign({}, process.env)
-    this._cwd = inBrowser() ? process.env.PWD : process.cwd().slice(0) // just in case, copy the string
+    this._cwd = kuiCwd()
 
     debug('captured tab state', this.uuid, this.cwd)
   }
@@ -196,7 +197,7 @@ export default class TabState {
     process.env = this._env
 
     if (this._cwd !== undefined) {
-      if (inBrowser()) {
+      if (inBrowser() || process.env.VIRTUAL_CWD) {
         debug('changing cwd', process.env.PWD, this._cwd)
         process.env.PWD = this._cwd
       } else {

packages/core/src/util/home.ts

@@ -17,6 +17,8 @@
 import { join } from 'path'
 import { homedir as home } from 'os'
 
+import { inBrowser } from '../core/capabilities'
+
 const homedir = home()
 
 export const expandHomeDir = function(path: string): string {
@@ -32,3 +34,5 @@ export const expandHomeDir = function(path: string): string {
 }
 
 export default expandHomeDir
+
+export const cwd = () => process.env.VIRTUAL_CWD || (inBrowser() ? process.env.PWD || '/' : process.cwd().slice(0))

plugins/plugin-bash-like/fs/src/lib/cd.ts

@@ -0,0 +1,122 @@
+/*
+ * Copyright 2017-21 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * This plugin introduces commands that dispatch to a local bash-like
+ * shell
+ *
+ */
+
+import Debug from 'debug'
+import { join } from 'path'
+
+import { cwd, inBrowser, Arguments, Registrar, i18n, expandHomeDir } from '@kui-shell/core'
+import { localFilepath } from './usage-helpers'
+import { findMount } from '../vfs'
+
+const strings = i18n('plugin-bash-like')
+const debug = Debug('plugins/bash-like/cmds/general')
+
+const usage = {
+  cd: {
+    strict: 'cd',
+    command: 'cd',
+    title: strings('cdUsageTitle'),
+    header: strings('cdUsageHeader'),
+    optional: localFilepath
+  }
+}
+
+/**
+ * cd command
+ *
+ */
+const cd = async (args: Arguments) => {
+  const dirAsProvided = args.REPL.split(args.command, true, true)[1] || ''
+  if (dirAsProvided === '-' && !process.env.OLDPWD) {
+    throw new Error(`cd: not a directory: ${dirAsProvided}`)
+  }
+
+  const dir = !dirAsProvided ? expandHomeDir('~') : dirAsProvided === '-' ? process.env.OLDPWD : dirAsProvided
+
+  const mount = findMount(dir)
+  try {
+    const resolveDir =
+      mount.isLocal || dirAsProvided === '-' ? dir : process.env.VIRTUAL_CWD ? join(process.env.VIRTUAL_CWD, dir) : dir
+    debug('cd dir', resolveDir)
+    const stat = await mount.fstat(args, resolveDir)
+
+    if (stat.isDirectory) {
+      if (process.env.OLDPWD === undefined) {
+        process.env.OLDPWD = ''
+      }
+
+      const OLDPWD = cwd() // remember it for when we're done
+      const newDir = expandHomeDir(stat.fullpath)
+
+      if (mount.isLocal && !inBrowser()) {
+        process.chdir(newDir)
+      }
+
+      process.env.OLDPWD = OLDPWD
+      process.env.PWD = newDir
+      if (mount.isLocal) {
+        delete process.env.VIRTUAL_CWD
+      } else {
+        process.env.VIRTUAL_CWD = newDir
+      }
+
+      if (args.tab.state) {
+        args.tab.state.capture()
+      }
+      return newDir
+    } else {
+      throw new Error(`cd: not a directory: ${dirAsProvided}`)
+    }
+  } catch (err) {
+    if (err.message && err.message.includes('no such file or directory')) {
+      throw new Error(`cd: no such file or directory: ${dirAsProvided}`)
+    } else {
+      throw err
+    }
+  }
+}
+
+const bcd = async ({ command, execOptions, REPL }: Arguments) => {
+  const pwd: string = await REPL.qexec(command.replace(/^cd/, 'kuicd'), undefined, undefined, execOptions)
+  process.env.PWD = pwd
+  return pwd
+}
+
+/**
+ * Register command handlers
+ *
+ */
+export default (commandTree: Registrar) => {
+  commandTree.listen('/kuicd', cd, {
+    requiresLocal: true
+  })
+
+  if (!inBrowser()) {
+    commandTree.listen('/cd', cd, {
+      usage: usage.cd
+    })
+  } else {
+    commandTree.listen('/cd', bcd, {
+      usage: usage.cd
+    })
+  }
+}

plugins/plugin-bash-like/fs/src/plugin.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import cd from './lib/cd'
 import ls from './lib/ls'
 import edit from './lib/edit'
 import open from './lib/open'
@@ -30,6 +31,7 @@ import { Registrar } from '@kui-shell/core'
  */
 export default async (registrar: Registrar) => {
   await Promise.all([
+    cd(registrar),
     ls(registrar),
     edit(registrar),
     open(registrar),

plugins/plugin-bash-like/fs/src/vfs/index.ts

@@ -17,7 +17,7 @@
 import Debug from 'debug'
 import slash from 'slash'
 import { isAbsolute, join } from 'path'
-import { Arguments, ParsedOptions, REPL, Table, eventBus, getCurrentTab, inBrowser } from '@kui-shell/core'
+import { cwd, Arguments, ParsedOptions, REPL, Table, eventBus, getCurrentTab, inBrowser } from '@kui-shell/core'
 
 import { FStat } from '../lib/fstat'
 import { KuiGlobOptions, GlobStats } from '../lib/glob'
@@ -181,11 +181,6 @@ export async function mount(vfs: VFS | VFSProducingFunction) {
   }
 }
 
-/** @return current working directory */
-function cwd() {
-  return inBrowser() ? process.env.PWD || '/' : process.cwd()
-}
-
 /** @return the absolute path to `filepath` */
 function absolute(filepath: string): string {
   return isAbsolute(filepath) ? filepath : join(cwd(), filepath)

plugins/plugin-bash-like/src/lib/cmds/bash-like.ts

@@ -23,14 +23,12 @@
 import Debug from 'debug'
 import { exec, ExecOptions as ChildProcessExecOptions } from 'child_process'
 
-import { inBrowser, Arguments, ExecOptions, ExecType, Registrar, i18n } from '@kui-shell/core'
+import { Arguments, ExecOptions, ExecType, Registrar } from '@kui-shell/core'
 
 import { handleNonZeroExitCode } from '../util/exec'
 import { extractJSON } from '../util/json'
-import { localFilepath } from '../util/usage-helpers'
 import { dispatchToShell } from './catchall'
 
-const strings = i18n('plugin-bash-like')
 const debug = Debug('plugins/bash-like/cmds/general')
 
 export const doExec = (
@@ -121,128 +119,6 @@ export const doExec = (
     })
   })
 
-const doShell = (argv: string[], args: Arguments) =>
-  // eslint-disable-next-line no-async-promise-executor
-  new Promise(async (resolve, reject) => {
-    const { execOptions, REPL } = args
-
-    if (inBrowser()) {
-      reject(new Error('Local file access not supported when running in a browser'))
-    }
-
-    // purposefully imported lazily, so that we don't spoil browser mode (where shell is not available)
-    const shell = await import('shelljs')
-
-    if (argv.length < 2) {
-      reject(new Error('Please provide a bash command'))
-    }
-
-    const cmd = argv[1]
-    debug('argv', argv)
-    debug('cmd', cmd)
-
-    // shell.echo prints the the outer console, which we don't want
-    if (shell[cmd] && (inBrowser() || (cmd !== 'mkdir' && cmd !== 'echo'))) {
-      const args = argv.slice(2)
-
-      // remember OLDPWD, so that `cd -` works (shell issue #78)
-      if (process.env.OLDPWD === undefined) {
-        process.env.OLDPWD = ''
-      }
-      const OLDPWD = shell.pwd() // remember it for when we're done
-      if (cmd === 'cd' && args[0] === '-') {
-        // special case for "cd -"
-        args[0] = process.env.OLDPWD
-      }
-
-      // see if we should use the built-in shelljs support
-      if (
-        !args.find(arg => arg.charAt(0) === '-') && // any options? then no
-        !args.find(arg => arg === '>') && // redirection? then no
-        cmd !== 'ls'
-      ) {
-        // shelljs doesn't like dash args
-        // otherwise, shelljs has a built-in handler for this
-
-        debug('using internal shelljs', cmd, args)
-
-        const output = shell[cmd](args)
-        if (cmd === 'cd') {
-          const newDir = shell.pwd().toString()
-          process.env.OLDPWD = OLDPWD
-          process.env.PWD = newDir
-
-          if (output.code === 0) {
-            // special case: if the user asked to change working
-            // directory, respond with the new working directory
-            resolve(shell.pwd().toString())
-          } else {
-            reject(new Error(output.stderr))
-          }
-        } else {
-          // otherwise, respond with the output of the command;
-          if (output && output.length > 0) {
-            if (execOptions && execOptions['json']) {
-              resolve(JSON.parse(output))
-            } else {
-              resolve(output.toString())
-            }
-          } else {
-            resolve(true)
-          }
-        }
-      }
-    }
-
-    //
-    // otherwise, we use exec to implement the shell command; here, we
-    // cross our fingers that the platform implements the requested
-    // command
-    //
-    const rest = argv.slice(1) // skip over '!'
-    const cmdLine = rest.map(_ => REPL.encodeComponent(_)).join(' ')
-    debug('cmdline', cmdLine, rest)
-
-    doExec(cmdLine, execOptions).then(resolve, reject)
-  })
-
-const usage = {
-  cd: {
-    strict: 'cd',
-    command: 'cd',
-    title: strings('cdUsageTitle'),
-    header: strings('cdUsageHeader'),
-    optional: localFilepath
-  }
-}
-
-/**
- * cd command
- *
- */
-const cd = (args: Arguments) => {
-  const dir = args.REPL.split(args.command, true, true)[1] || ''
-  debug('cd dir', dir)
-  return doShell(['!', 'cd', dir], args)
-    .then(newDir => {
-      if (args.tab.state) {
-        args.tab.state.capture()
-      }
-      return newDir
-    })
-    .catch(err => {
-      err['code'] = 500
-      throw err
-    })
-}
-
-const bcd = async ({ command, execOptions, REPL }: Arguments) => {
-  const pwd: string = await REPL.qexec(command.replace(/^cd/, 'kuicd'), undefined, undefined, execOptions)
-  debug('pwd', pwd)
-  process.env.PWD = pwd
-  return pwd
-}
-
 const specialHandler = (args: Arguments) => {
   if (args.execOptions.type === ExecType.TopLevel) {
     throw new Error('this command is intended for internal consumption only')
@@ -265,17 +141,5 @@ export default (commandTree: Registrar) => {
     hidden: true
   })
 
-  commandTree.listen('/kuicd', cd, {
-    requiresLocal: true
-  })
-
-  if (!inBrowser()) {
-    commandTree.listen('/cd', cd, {
-      usage: usage.cd
-    })
-  } else {
-    commandTree.listen('/cd', bcd, {
-      usage: usage.cd
-    })
-  }
+  commandTree.listen('/pwd', () => process.env.PWD)
 }

plugins/plugin-bash-like/src/test/bash-like/cd.ts

@@ -35,7 +35,7 @@ describe(`bash-like cd ${process.env.MOCHA_RUN_TARGET || ''}`, function(this: Co
     CLI.command('pwd', this.app)
       .then(ReplExpect.okWithAny)
       .then(async () => {
-        initialDirectory = await this.app.client.$(Selectors.OUTPUT_LAST_PTY).then(_ => _.getText())
+        initialDirectory = await this.app.client.$(Selectors.OUTPUT_LAST).then(_ => _.getText())
       })
       .catch(Common.oops(this, true))
   )

plugins/plugin-bash-like/src/test/bash-like/export.ts

@@ -42,7 +42,7 @@ describe('export command', function(this: Common.ISuite) {
 
     return CLI.command('cd', this.app)
       .then(ReplExpect.okWithAny)
-      .then(() => CLI.command('pwd', this.app).then(ReplExpect.okWithPtyOutput(process.env.HOME)))
+      .then(() => CLI.command('pwd', this.app).then(ReplExpect.okWithString(process.env.HOME)))
       .then(() => CLI.command('printenv HOME', this.app).then(ReplExpect.okWithPtyOutput(home)))
       .catch(Common.oops(this))
   })