Merge pull request #6 from stencila/feature/enter

feat: add `enter` command

Author: nokome

package-lock.json

@@ -42,6 +42,7 @@
     "@types/mkdirp": "^0.5.2",
     "@types/sprintf-js": "^1.1.1",
     "@types/stream-to-promise": "^2.2.0",
+    "@types/tmp": "0.0.33",
     "@types/yargs": "^12.0.5",
     "all-contributors-cli": "^5.7.0",
     "jest": "^23.6.0",
@@ -62,7 +63,9 @@
     "glob": "^7.1.3",
     "js-yaml": "^3.12.1",
     "mkdirp": "^0.5.1",
+    "node-pty": "^0.8.0",
     "sprintf-js": "^1.1.2",
+    "tmp": "0.0.33",
     "yargs": "^12.0.5"
   }
 }

package.json

@@ -1,11 +1,15 @@
 import fs from 'fs'
+import os from 'os'
 import path from 'path'
 
-// @ts-ignore
-import spawn from 'await-spawn'
+import chalk from 'chalk'
 import del from 'del'
 import glob from 'glob'
 import mkdirp from 'mkdirp'
+import * as pty from 'node-pty'
+// @ts-ignore
+import spawn from 'await-spawn'
+import tmp from 'tmp'
 import yaml from 'js-yaml'
 
 import * as nix from './nix'
@@ -289,28 +293,114 @@ export default class Environment {
   }
 
   /**
-   * Execute a bash command within the environment
+   * Create variables for an environment.
+   *
+   * This method is used in several other metho
+   * e.g. `within`, `enter`
    *
-   * A 'pure' shell will only hav available the executables that
+   * A 'pure' environment will only have available the executables that
    * were exlicitly installed into the environment
    *
+   * @param pure Should the shell that this command is executed in be 'pure'?
+   */
+  async vars (pure: boolean = false) {
+    const location = await nix.location(this.name)
+
+    let PATH = `${location}/bin:${location}/sbin`
+    if (!pure) PATH += ':' + process.env.PATH
+
+    const R_LIBS_SITE = `${location}/library`
+
+    return {
+      PATH,
+      R_LIBS_SITE
+    }
+  }
+
+  /**
+   * Execute a bash command within the environment
+   *
    * @param command The command to execute
    * @param pure Should the shell that this command is executed in be 'pure'?
    */
   async within (command: string, pure: boolean = false) {
-    const location = await nix.location(this.name)
-    let path = `${location}/bin:${location}/sbin`
-    if (!pure) path += ':' + process.env.PATH
-    // Get the path to bash because it may not be available in the PATH of
-    // a pure shell
-    let bash = await spawn('which', ['bash'])
-    await spawn(bash.toString().trim(), ['-c', command], {
+    // Get the path to bash because it may not be available in
+    // the PATH of a pure shell
+    let shell = await spawn('which', ['bash'])
+    shell = shell.toString().trim()
+    await spawn(shell, ['-c', command], {
       stdio: 'inherit',
-      env: {
-        PATH: path,
-        R_LIBS_SITE: `${location}/library`
+      env: await this.vars()
+    })
+  }
+
+  /**
+   * Enter the a shell within the environment
+   *
+   * @param command An initial command to execute in the shell e.g. R or python
+   * @param pure Should the shell be 'pure'?
+   */
+  async enter (command: string = '', pure: boolean = true) {
+    const shellName = os.platform() === 'win32' ? 'powershell.exe' : 'bash'
+    const shellArgs = ['--noprofile']
+
+    // Path to the shell executable. We need to do this
+    // because the environment may not actually have any shell
+    // in it, in which case, when using `pure` a shell won't be available.
+    let shellPath = await spawn('which', [shellName])
+    shellPath = shellPath.toString().trim()
+
+    // Inject Nixster into the environment as an alias so we can use it
+    // there without polluting the environment with additional binaries.
+    // During development you'll need to use ---pure=false so that
+    // node is available to run Nixster. In production, when a user
+    // has installed a binary, this shouldn't be necessary
+    let nixsterPath = await spawn('which', ['nixster'])
+    const tempRcFile = tmp.fileSync()
+    fs.writeFileSync(tempRcFile.name, `alias nixster="${nixsterPath.toString().trim()}"\n`)
+    shellArgs.push('--rcfile', tempRcFile.name)
+
+    // Environment variables
+    let vars = await this.vars(pure)
+    vars = Object.assign(vars, {
+      // Let Nixster know which environment we're in.
+      NIXSTER_ENV: this.name,
+      // Customise the bash prompt so that the user know that they are in
+      // a Nixster environment and which one.
+      PS1: '☆ ' + chalk.green.bold(this.name) + ':' + chalk.blue('\\w') + '$ '
+    })
+
+    const shellProcess = pty.spawn(shellPath, shellArgs, {
+      name: 'xterm-color',
+      cols: 120,
+      rows: 30,
+      env: vars
+    })
+    shellProcess.on('data', data => {
+      process.stdout.write(data)
+    })
+
+    // To prevent echoing of input set stdin to raw mode (see https://github.com/Microsoft/node-pty/issues/78)
+    // https://nodejs.org/api/tty.html: "When in raw mode, input is always available character-by-character,
+    // not including modifiers. Additionally, all special processing of characters
+    // by the terminal is disabled, including echoing input characters. Note that CTRL+C
+    // will no longer cause a SIGINT when in this mode."
+    // @ts-ignore
+    process.stdin.setRawMode(true)
+
+    // Write the result through to the shell process
+    // Capture Ctrl+D for special handling:
+    //   - if in the top level shell process then exit this process
+    //   - otherwise, pass on the process e.g. node, Rrm
+    const ctrlD = Buffer.from([4])
+    process.stdin.on('data', data => {
+      if (data.equals(ctrlD) && shellProcess.process === shellPath) {
+        process.exit(1)
       }
+      shellProcess.write(data)
     })
+
+    if (command) shellProcess.write(command + '\r')
   }
 
   /**

src/Environment.ts

@@ -51,7 +51,7 @@ yargs
     output(envs, argv, (envs: any) => {
       const layout = '%-15s %-40s %-80s'
       const header = sprintf(layout, chalk.gray('Ready'), chalk.gray('Name'), chalk.gray('Description')) + '\n'
-      return header + 
+      return header +
         envs.map((env: any) => {
           const icon = env.built ? chalk.green('✓') : chalk.yellow('⚪')
           const name = chalk.blue(env.name)
@@ -91,7 +91,7 @@ yargs
         type: 'array'
       })
       .option('removes', {
-        describe: 'Remove packages from environment',
+        describe: 'Remove packages to environment',
         alias: 'r',
         type: 'array'
       })
@@ -201,6 +201,30 @@ yargs
     }
   })
 
+  .command('enter <name> [command..]', 'Enter a shell within the environment', (yargs: any) => {
+    yargs
+      .positional('name', {
+        describe: 'Name of the environment',
+        type: 'string'
+      })
+      .positional('command', {
+        describe: 'An initial command to execute in the shell e.g. `R` or `python`',
+        type: 'string'
+      })
+      .option('pure', {
+        describe: 'Should the environment be pure (no host executables available)?',
+        alias: 'p',
+        type: 'boolean',
+        default: true
+      })
+  }, async (argv: any) => {
+    try {
+      await new Environment(argv.name).enter(argv.command.join(' '), argv.pure)
+    } catch (err) {
+      error(err)
+    }
+  })
+
   // TODO instead of a sperate command, --docker should be an option for the `build`, `within` and `enter` commands
   .command('dockerize [name] [command]', 'Containerize the environment using Docker', (yargs: any) => {
     yargs
@@ -406,7 +430,7 @@ function output (value: any, argv: any = {}, prettifier?: (value: any) => string
  * Add output options to a command.
  *
  * The aim of this approach is to have a consistent
- * and convenient way for users to be able to specify
+ * and convieient way for users to be able to specify
  * the output format across commands.
  *
  * Formats can be specified explicitly e.g.
@@ -459,7 +483,7 @@ function outputOptions (yargs: any) {
  * Create a diagnostic message for the user
  *
  * @param message Message to display
- * @param emoji Emoji to prefix the display
+ * @param emoji Emjoi to prefix the display
  */
 function diag (message: string, emoji: string) {
   if (process.stderr.isTTY && emoji) process.stderr.write(emoji + '  ')

src/cli.ts

@@ -30,7 +30,7 @@ export function semver (version: string): string {
 // Register function in the database
 try {
   db.function('semver', semver)
-} catch(error) {
+} catch (error) {
   // The following error get's thown sometimes (maybe if the function
   // has already been registered?)
   if (error.message !== 'Expected first argument to be a string') {