Merge pull request #1 from clemy/packaging

Feature: Delivery Package Creation

Author: clemy

.gitignore

@@ -1 +1,5 @@
 node_modules/
+
+# files from build
+/prexvis
+/prexvis-*.tgz

README.md

@@ -43,6 +43,32 @@ chrome http://localhost:3000/
 | `./bin/aalwines`              | binary of AalWiNes tool |
 | `./bin/moped`                 | binary of moped tool |
 
+## Building a binary delivery package
+
+Building a package containing a binary delivery can easily be done with the command
+
+```bash
+npm run pack
+```
+
+The delivery package including aalwines, moped, sample data and the prexvis binary is in:
+
+`./prexvis-0.1.0.tgz`
+
+Beside the prexvis tool it includes everything necessary to run it: nodejs, aalwines, moped and sample data.
+
+Unpack it, run the binary and use your browser to go to http://localhost:3000/
+
+```bash
+tar -xzvf prexvis-0.1.0.tgz
+cd prexvis-0.1.0
+./prexvis
+
+# browse to http://localhost:3000/
+```
+
+Own sample data can be added in the directory `data/models`.
+
 ## Optional Requirements
 
 ### PM2 (optional)

app.js

@@ -4,8 +4,11 @@ const path = require('path');
 const http = require('http').createServer(app);
 const io = require('socket.io')(http);
 
-const modelsPath = path.join(__dirname, 'data', 'models');
-const binPath = path.join(__dirname, 'bin');
+console.log('prexvis - Visualization for AaalWiNes');
+console.log('  Version 0.1.0');
+
+const modelsPath = path.join(process.cwd(), 'data', 'models');
+const binPath = path.join(process.cwd(), 'bin');
 const models = require('./backend/models')(modelsPath, binPath, models => {
     io.emit('models', models);
 });
@@ -38,5 +41,6 @@ app.use(function(req, res) {
 });
 
 http.listen(3000, function() {
-    console.log('Listening on port 3000!');
+    console.log();
+    console.log('Start your browser and go to http://localhost:3000/');
 });

backend/models.js

@@ -6,44 +6,40 @@ const path = require('path');
 const tmp = require('tmp-promise');
 
 class Models {
-    #modelsPath;
-    #binPath;
-    #models = [];
-    #cb;
-
     constructor(modelsPath, binPath, cb) {
-        this.#modelsPath = modelsPath;
-        this.#binPath = binPath;
-        this.#cb = cb;
+        this._modelsPath = modelsPath;
+        this._binPath = binPath;
+        this._cb = cb;
+        this._models = [];
         const onChange = async () => {
             try {
-                var items = await fsp.readdir(this.#modelsPath, { withFileTypes: true });
+                var items = await fsp.readdir(this._modelsPath, { withFileTypes: true });
             } catch (err) {
                 console.error('Error during readdir', err);
                 var items = [];
             }
             const models = items.filter(entry => entry.isDirectory()).map(entry => entry.name).sort();
-            if (models.length !== this.#models.length || models.some((value, index) => value !== this.#models[index])) {
+            if (models.length !== this._models.length || models.some((value, index) => value !== this._models[index])) {
                 // if array changed
-                this.#models = models;
-                this.#cb(this.#models);
+                this._models = models;
+                this._cb(this._models);
             }
         };
-        fs.watch(this.#modelsPath, { persistent: false }, onChange);
+        fs.watch(this._modelsPath, { persistent: false }, onChange);
         onChange();
     }
 
     get models() {
-        return this.#models;
+        return this._models;
     }
 
     async loadModel(name) {
-        const mopedPath = path.join(this.#binPath, 'moped');
-        const topologyFile = path.join(this.#modelsPath, name, 'topo.xml');
-        const routingFile = path.join(this.#modelsPath, name, 'routing.xml');
+        const mopedPath = path.join(this._binPath, 'moped');
+        const topologyFile = path.join(this._modelsPath, name, 'topo.xml');
+        const routingFile = path.join(this._modelsPath, name, 'routing.xml');
         var stdout, stderr;
         try {
-            ({ stdout, stderr } = await execFile(path.join(this.#binPath, 'aalwines'),
+            ({ stdout, stderr } = await execFile(path.join(this._binPath, 'aalwines'),
                 ['--topology', topologyFile, '--routing', routingFile, '--net'],
                 { env: { MOPED_PATH: mopedPath }}
             ));
@@ -55,22 +51,22 @@ class Models {
     }
 
     async doQuery(model, query, options) {
-        const mopedPath = path.join(this.#binPath, 'moped');
-        const topologyFile = path.join(this.#modelsPath, model, 'topo.xml');
-        const routingFile = path.join(this.#modelsPath, model, 'routing.xml');
+        const mopedPath = path.join(this._binPath, 'moped');
+        const topologyFile = path.join(this._modelsPath, model, 'topo.xml');
+        const routingFile = path.join(this._modelsPath, model, 'routing.xml');
         var stdout, stderr;
         await tmp.withFile(async ({ path: tmpQueryFile }) => {
             await fsp.writeFile(tmpQueryFile, query);
             try {
-                ({ stdout, stderr } = await execFile(path.join(this.#binPath, 'aalwines'),
+                ({ stdout, stderr } = await execFile(path.join(this._binPath, 'aalwines'),
                     ['--topology', topologyFile, '--routing', routingFile, '-e', options.engine, '-t', '-q', tmpQueryFile],
                     { env: { MOPED_PATH: mopedPath }}
                 ));
             } catch (err) {
                 console.error('loadModel error', model, err);
                 throw err.toString();
             }
-        }, { discardDescriptor: true/*, dir: path.join(this.#modelsPath, model)*/ });
+        }, { discardDescriptor: true/*, dir: path.join(this._modelsPath, model)*/ });
         return JSON.parse(stdout);
     }
 }