fix: add build store option and refactor bootup

Author: nokome

.dockerignore

@@ -1,4 +1,4 @@
 /*.sqlite3
 /Dockerfile
-/nixstore
+/nixroot
 /node_modules

.gitignore

@@ -5,6 +5,6 @@
 /demo.cast
 /dist
 /docs
-/nixstore
+/nixster.tgz
+/nixroot
 /node_modules
-/node_modules.tar.gz

Makefile

@@ -27,25 +27,31 @@ docker:
 docker-push:
 	docker push stencila/nixster
 
-# Build the Nixster environments within the local `nixstore` directory
+# Build the Nixster environments within the local `nixroot` directory
 # Currently this builds the `multi-mega` environment but in the future it
-# may build all environments
+# may build all environments.
 # The --privileged flag is necessary to avoid `error: cloning builder process: Operation not permitted`
 # (see https://github.com/NixOS/nix/issues/2636 and other issues)
+# This mounts the local ./nixroot directory and tells Nixster (and thus Nix :) to build into it
 docker-build:
-	docker run --rm --interactive --tty --volume $$PWD/nixstore:/nixstore --privileged stencila/nixster nixster build multi-mega
+	docker run --rm --interactive --tty \
+		--privileged \
+		--volume $$PWD/nixroot:/nixroot \
+		stencila/nixster nixster build multi-mega --store /nixroot
 
 # Run the Nixster server 
 docker-serve:
 	docker run --rm --interactive --tty \
-		--volume $$PWD/nixstore:/nixstore \
 		--volume /var/run/docker.sock:/var/run/docker.sock \
 		--publish 3000:3000 \
 		stencila/nixster nixster serve
 
 # Interact with the container in a Bash shell. Useful for debugging build errors
 docker-interact:
-	docker run --rm --interactive --tty --volume $$PWD/nixstore:/nixstore --privileged stencila/nixster bash
+	docker run --rm --interactive --tty \
+		--privileged \
+		--volume $$PWD/nixroot:/nixroot \
+		stencila/nixster bash
 
 docs:
 	npm run docs

package-lock.json

@@ -13,7 +13,8 @@
     "cover": "jest --collectCoverage",
     "build": "npm run build:dist && npm run build:bins",
     "build:dist": "tsc && cp -TRv src/static/ dist/static/",
-    "build:bins": "tar czf node_modules.tar.gz node_modules/better-sqlite3 node_modules/integer node_modules/node-pty && pkg --target=node10 --out-path=build .",
+    "build:tgz": "tar czf nixster.tgz envs node_modules/better-sqlite3 node_modules/integer node_modules/node-pty",
+    "build:bins": "npm run build:tgz && pkg --target=node10 --out-path=build .",
     "contributors:add": "all-contributors add",
     "docs": "markdown-toc -i --maxdepth=4 README.md && typedoc --readme README.md --mode file --out ./docs ./src",
     "serve:dev": "ts-node-dev src/cli.ts serve",
@@ -70,6 +71,7 @@
     "express": "^4.16.4",
     "express-async-handler": "^1.1.4",
     "express-ws": "^4.0.0",
+    "fs-extra": "^7.0.1",
     "glob": "^7.1.3",
     "js-yaml": "^3.12.1",
     "mkdirp": "^0.5.1",
@@ -82,9 +84,8 @@
   },
   "pkg": {
     "assets": [
-      "./envs/**/*",
       "./dist/static/**/*",
-      "./node_modules.tar.gz"
+      "./nixster.tgz"
     ]
   }
 }

package.json

@@ -11,12 +11,10 @@ import * as pty from 'node-pty'
 import tmp from 'tmp'
 import yaml from 'js-yaml'
 
+import {home} from './boot'
 import spawn from './spawn'
 import * as nix from './nix'
 
-// The home directory for environments
-let home = path.join(path.dirname(__dirname), 'envs')
-
 export enum Platform {
   UNIX, WIN, DOCKER
 }
@@ -103,21 +101,11 @@ export default class Environment {
     if (read) this.read()
   }
 
-  /**
-   * Get or set the ome directory for environments
-   *
-   * @param value Value for home directory
-   */
-  static home (value?: string): string {
-    if (value) home = value
-    return home
-  }
-
   /**
    * Path to the environment specification files
    */
   path (): string {
-    return path.join(Environment.home(), this.name) + '.yaml'
+    return path.join(home, 'envs', this.name + '.yaml')
   }
 
   /**
@@ -137,7 +125,7 @@ export default class Environment {
     if (this.adds && this.adds.length === 0) this.adds = undefined
     if (this.removes && this.removes.length === 0) this.removes = undefined
 
-    mkdirp.sync(Environment.home())
+    mkdirp.sync(path.join(home, 'envs'))
     const yml = yaml.safeDump(this, { skipInvalid: true })
     fs.writeFileSync(this.path(), yml)
     return this
@@ -180,13 +168,13 @@ export default class Environment {
    * List the environments on this machine
    */
   static async envs (): Promise<Array<any>> {
-    const names = glob.sync('*.yaml', { cwd: Environment.home() }).map(file => file.slice(0, -5))
+    const names = glob.sync('*.yaml', { cwd: path.join(home, 'envs') }).map(file => file.slice(0, -5))
     const envs = []
     for (let name of names) {
       const env = new Environment(name)
       envs.push(Object.assign({}, env, {
         path: env.path(),
-        built: await nix.built(name),
+        built: await env.built(),
         location: await nix.location(name)
       }))
     }
@@ -313,8 +301,8 @@ export default class Environment {
    *
    * @param docker Also build a Docker container for the environment?
    */
-  async build (docker: boolean = false): Promise<Environment> {
-    await nix.install(this.name, this.pkgs(), true)
+  async build (store?: string, docker: boolean = false): Promise<Environment> {
+    await nix.install(this.name, this.pkgs(), true, store)
 
     if (docker) {
       // TODO: complete implementation of this, using these files...
@@ -337,6 +325,18 @@ export default class Environment {
     return this.write()
   }
 
+  /**
+   * Has this environment been built?
+   */
+  async built (): Promise<boolean> {
+    try {
+      await nix.location(this.name)
+      return true
+    } catch {
+      return false
+    }
+  }
+
   /**
    * Upgrade all packages in the environment
    *
@@ -358,7 +358,7 @@ export default class Environment {
    *
    * @param pure Should the shell that this command is executed in be 'pure'?
    */
-  async vars (pure: boolean = false) : Promise<{[key: string]: string}> {
+  async vars (pure: boolean = false): Promise<{[key: string]: string}> {
     const location = await nix.location(this.name)
 
     let PATH = `${location}/bin:${location}/sbin`
@@ -379,6 +379,8 @@ export default class Environment {
    * @param pure Should the shell that this command is executed in be 'pure'?
    */
   async within (command: string, pure: boolean = false) {
+    if (!this.built()) throw new Error(`Environment "${this.name}" has not be built yet.`)
+
     // Get the path to bash because it may not be available in
     // the PATH of a pure shell
     let shell = await spawn('which', ['bash'])
@@ -395,6 +397,8 @@ export default class Environment {
    * @param sessionParameters Parameters of the session
    */
   async enter (sessionParameters: SessionParameters) {
+    if (!this.built()) throw new Error(`Environment "${this.name}" has not be built yet.`)
+
     let { command, platform, pure, stdin, stdout } = sessionParameters
     const location = await nix.location(this.name)
 

src/Environment.ts

@@ -13,24 +13,21 @@
  *   - https://github.com/JoshuaWise/better-sqlite3/issues/173
  *   - `package.json`
  */
-import fs from 'fs'
 import path from 'path'
 
+import fs from 'fs-extra'
 import tar from 'tar'
-import mkdirp from 'mkdirp'
 
-if (
-  (process.mainModule && process.mainModule.id.endsWith('.exe') || process.hasOwnProperty('pkg')) &&
-  fs.existsSync(path.join('/', 'snapshot'))
-) {
-  const modules = path.join(path.dirname(process.execPath), 'node_modules')
-  if (!fs.existsSync(modules)) {
-    mkdirp.sync(modules)
-    tar.x({
-      sync: true,
-      file: path.join('/', 'snapshot', 'nixster', 'node_modules.tar.gz'),
-      strip: 1,
-      C: modules
-    })
-  }
+export const packaged = (
+  process.mainModule && process.mainModule.id.endsWith('.exe') || process.hasOwnProperty('pkg')
+) && fs.existsSync(path.join('/', 'snapshot'))
+
+export const home = packaged ? path.dirname(process.execPath) : path.dirname(__dirname)
+
+if(packaged && !fs.existsSync(path.join(home, 'node_modules'))) {
+  tar.x({
+    sync: true,
+    file: path.join('/', 'snapshot', 'nixster', 'nixster.tgz'),
+    C: home
+  })
 }

src/boot.ts

@@ -178,14 +178,19 @@ yargs
         type: 'string'
       })
       .env('NIXSTER')
+      .option('store', {
+        describe: 'The Nix store to be built into.',
+        type: 'string',
+        alias: 's'
+      })
       .option('docker', {
         describe: 'Also build a Docker container for the environment?',
         type: 'boolean',
         alias: 'd',
         default: false
       })
   }, async (argv: any) => {
-    await new Environment(argv.name).build(argv.docker)
+    await new Environment(argv.name).build(argv.store, argv.docker)
     info(`Environment "${argv.name}" built`)
   })