Merge 1fe6e31 into ee3bfa2

README.md

@@ -29,24 +29,26 @@ frau-local-appresolver --appclass|-c urn:d2l:fra:class:some-app
 However additional options (described below) can be configured:
 
 ```javascript
-frau-local-appresolver --appclass|-c urn:d2l:fra:class:some-app 
-                       --configfile|-f appconfig.json 
-                       --hostname|-h acme.com 
-                       --port|-p 3000 
+frau-local-appresolver --appclass|-c urn:d2l:fra:class:some-app
+                       --configfile|-f appconfig.json
+                       --hostname|-h acme.com
+                       --port|-p 3000
                        --dist|-d dist
+                       --baseRoute|-b app/
 ```
 
 ```javascript
 "scripts": {
   "resolver": "frau-local-appresolver"
 },
-"config": { 
+"config": {
   "frauLocalAppResolver": {
     "appClass": "urn:d2l:fra:class:some-app",
     "configFile": "appconfig.json",
     "hostname": "acme.com",
     "port": "3000",
-    "dist": "dist"
+    "dist": "dist",
+    "baseRoute": "app/"
    }
 }
 ```
@@ -77,6 +79,7 @@ var target = appResolver.getUrl();
   - `port` - The port to listen on.  By default, port `3000` is used, which is the port that the LMS expects it on.
   - `hostname` - The hostname (or IP) to listen on. By default, the hostname of the operating system is used.  You should not need to change this.
   - `configFile` - The name of the app config file.  By default, `appconfig.json` is used.  You should not need to change this.
+  - `baseRoute` - Specifies the base route to be included in urls.  By default, `app/` is used.  Setting this to different values (e.g. `''`) will allow you to use tools such as `es-dev-server` where you want the endpoint hosted at `http://localhost:3000/index.html` instead of `http://localhost:3000/app/index.html`.
 
 ## Contributing
 Contributions are welcome, please submit a pull request!

bin/appresolvercli

@@ -4,13 +4,14 @@ var chalk = require('chalk'),
 	argv = require('yargs')
 	optionsProvider = require('../src/optionsProvider');
 
-argv = argv.usage('Usage: frau-local-appresolver --appclass|-c [--configfile|-f] [--hostname|-h] [--port|-p] [--dist|-d]')
+argv = argv.usage('Usage: frau-local-appresolver --appclass|-c [--configfile|-f] [--hostname|-h] [--port|-p] [--dist|-d] [--baseRoute|-b]')
 	.example('frau-local-appresolver -c urn:d2l:fra:class:some-app -f appconfig.json -h acme.com -p 3000 -d dist')
 	.alias('c', 'appclass')
 	.alias('f', 'configfile')
 	.alias('h', 'hostname')
 	.alias('p', 'port')
 	.alias('d', 'dist')
+	.alias('b', 'baseRoute')
 	.argv;
 
 var appResolver = require('../src/appresolver');

src/appresolver.js

@@ -42,6 +42,7 @@ function LocalAppRegistry(appClass, opts) {
 	opts.port = opts.port || 3000;
 	opts.dist = opts.dist || 'dist';
 	opts.configFile = opts.configFile || 'appconfig.json';
+	opts.baseRoute = opts.baseRoute !== undefined ? opts.baseRoute : '/app';
 
 	this._opts = opts;
 }
@@ -55,7 +56,7 @@ LocalAppRegistry.prototype.host = function() {
 
 	app.use(cors());
 
-	app.use('/app', serveStatic(self._opts.dist));
+	app.use(this._opts.baseRoute, serveStatic(self._opts.dist));
 
 	var encodedAppClass = encodeURIComponent(self._opts.appClass);
 	app.get('/resolve/' + encodedAppClass, function(req, res) {
@@ -80,7 +81,7 @@ LocalAppRegistry.prototype.host = function() {
 };
 
 LocalAppRegistry.prototype.getUrl = function() {
-	return 'http://' + this._opts.hostname + ':' + this._opts.port + '/app/';
+	return 'http://' + this._opts.hostname + ':' + this._opts.port + this._opts.baseRoute + '/';
 };
 
 LocalAppRegistry.prototype.getConfigUrl = function() {

src/optionsProvider.js

@@ -21,13 +21,18 @@ module.exports = {
 		return argv.port ||
 			process.env.npm_package_config_frauLocalAppResolver_port;
 	},
+	getBaseRoute: function(argv) {
+		return argv.baseRoute ||
+			process.env.npm_package_config_frauLocalAppResolver_baseRoute;
+	},
 	getOptions: function(argv) {
 		return {
 			appClass: this.getAppClass(argv),
 			configFile: this.getConfigFile(argv),
 			dist: this.getDist(argv),
 			hostname: this.getHostname(argv),
-			port: this.getPort(argv)
+			port: this.getPort(argv),
+			baseRoute: this.getBaseRoute(argv)
 		};
 	}
 };

test/appresolver.js

@@ -30,14 +30,6 @@ describe('appresolver', function() {
 			}).to.throw(Error, 'appClass is a required argument for LocalAppResolver.');
 		});
 
-		it('hostname', function() {
-			var hostname = appresolver(APP_CLASS)._opts.hostname;
-			expect(hostname)
-				.to.have.string(require('os').hostname().replace('.local', ''));
-			expect(hostname)
-				.to.not.have.string('.local');
-		});
-
 		it('port', function() {
 			expect(appresolver(APP_CLASS)._opts.port)
 				.to.be.equal(DEFAULT_PORT);
@@ -53,6 +45,11 @@ describe('appresolver', function() {
 				.to.be.equal('appconfig.json');
 		});
 
+		it('baseRoute', function() {
+			expect(appresolver(APP_CLASS)._opts.baseRoute)
+				.to.be.equal('/app');
+		});
+
 	});
 
 	describe('hostname', function() {
@@ -62,6 +59,11 @@ describe('appresolver', function() {
 				.to.be.equal('http://somehost:' + DEFAULT_PORT + '/app/');
 		});
 
+		it('should strip ".local" domain from OSX hostname - with baseRoute', function() {
+			expect(appresolver(APP_CLASS, { hostname: 'somehost.local', baseRoute: '' }).getUrl())
+				.to.be.equal('http://somehost:' + DEFAULT_PORT + '/');
+		});
+
 	});
 
 	describe('getUrl', function() {
@@ -71,6 +73,11 @@ describe('appresolver', function() {
 				.to.be.equal('http://somehost.com:11111/app/');
 		});
 
+		it('should return expected url - with baseRoute', function() {
+			expect(appresolver(APP_CLASS, { hostname: 'somehost.com', port: 11111, baseRoute: '' }).getUrl())
+				.to.be.equal('http://somehost.com:11111/');
+		});
+
 	});
 
 	describe('getConfigUrl', function() {
@@ -80,6 +87,11 @@ describe('appresolver', function() {
 				.to.be.equal('http://somehost.com:11111/app/someconf.js');
 		});
 
+		it('should return expected url - with baseRoute', function() {
+			expect(appresolver(APP_CLASS, { hostname: 'somehost.com', port: 11111, configFile: 'someconf.js', baseRoute: '' }).getConfigUrl())
+				.to.be.equal('http://somehost.com:11111/someconf.js');
+		});
+
 	});
 
 	describe('host', function() {