alchemymvc 1.3.21 → 1.4.0-alpha.1

package/lib/stages.js

@@ -1,513 +0,0 @@
-/**
- * This file is loaded after the main 'init' & 'core' folder files.
- * Its main purpose is to launch the server in several stages and
- * allow the app-specific logic to hook into them.
- *
- * Alchemy: Node.js MVC Framework
- * Copyright 2013-2018
- *
- * Licensed under The MIT License
- * Redistributions of files must retain the above copyright notice.
- *
- * @copyright   Copyright 2013-2018
- * @since       0.0.1
- * @version     1.1.0
- */
-let path       = alchemy.modules.path,
-    settings   = alchemy.settings,
-    http       = alchemy.modules.http,
-    hawkejs    = alchemy.hawkejs,
-    fs         = alchemy.use('fs'),
-    total_http_requests = 0;
-
-if (alchemy.settings.debug) {
-	alchemy.sputnik.on('launching', function onLaunch(stage) {
-
-		let colored_name = alchemy.colors.fg.getRgb(0, 5, 5) + stage.name + alchemy.colors.reset;
-
-		let args = ['Launching', colored_name, 'stage…'];
-
-		let line = alchemy.printLog(alchemy.INFO, args, {level: 1});
-
-		if (line && line.args) {
-			stage.pledge.then(function finished() {
-				line.args.push('Done in', stage.ended - stage.started, 'ms');
-				line.dissect();
-				line.render();
-			});
-		}
-	});
-}
-
-/**
- * Add a getter for the total amount of http requests
- *
- * @author    Jelle De Loecker   <jelle@elevenways.be>
- * @since     1.3.1
- * @version   1.3.1
- *
- * @type      {Number}
- */
-Alchemy.setProperty(function http_request_counter() {
-	return total_http_requests;
-});
-
-/**
- * The "http" stage:
- * Create the server and listen to requests
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       1.3.1
- */
-alchemy.sputnik.add(function http() {
-
-	// Create the server
-	alchemy.server = alchemy.modules.http.createServer();
-
-	// Listen for requests
-	alchemy.server.on('request', function onRequest(request, response) {
-		Router.resolve(request, response);
-		total_http_requests++;
-	});
-});
-
-/**
- * The "coreApp" stage:
- * Load in Alchemy's main 'app' folder.
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       1.1.0
- */
-alchemy.sputnik.add(function core_app() {
-	alchemy.usePath(path.resolve(PATH_CORE, 'app'), {weight: 1});
-});
-
-/**
- * The "datasources" stage:
- * Make a connection to all the datasources.
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       1.1.0
- */
-alchemy.sputnik.add(function datasources() {
-
-	var tasks = [];
-
-	// Force Blast to load
-	try {
-		Blast.doLoaded();
-	} catch (err) {
-		alchemy.printLog('error', ['Failed to load application:', err.message], {err: err, level: 1});
-		return
-	}
-
-	// Require the environment datasources configuration
-	try {
-		require(path.resolve(PATH_ROOT, 'app', 'config', settings.environment, 'database'));
-	} catch (err) {
-
-		if (err.code == 'MODULE_NOT_FOUND') {
-			if (!alchemy.settings.client_mode) {
-				// Only output a warning when not in client mode
-				log.warn('Could not find ' + settings.environment + ' database settings');
-			}
-		} else {
-			log.warn('Could not load ' + settings.environment + ' database settings:', err);
-		}
-
-		return;
-	}
-
-	// Get all available datasources
-	Object.each(Datasource.get(), function eachDatasource(datasource, key) {
-		tasks.push(datasource.setup());
-	});
-
-	return Function.parallel(tasks);
-});
-
-/**
- * The "plugins" stage:
- * Initialize the defined plugins.
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       1.2.7
- */
-alchemy.sputnik.add(function plugins() {
-	// Load in the plugins
-	try {
-		alchemy.startPlugins();
-	} catch (err) {
-		// Constitutors sometimes throw errors during this stage.
-		// Not sure yet why they don't get caught by sputnik
-		// @TODO: refactor!
-		log.error('Caught error during "plugins" stage:', err);
-		throw err;
-	}
-});
-
-/**
- * The "baseApp" stage:
- * Load all the files in the user-defined 'app' folder
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       0.0.1
- */
-alchemy.sputnik.add(function base_app() {
-	// Load in the app
-	alchemy.usePath(PATH_APP, {weight: 20});
-});
-
-/**
- * The "defineDebug" stage:
- * Setup some debug settings
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       1.1.0
- */
-alchemy.sputnik.add(function define_debug() {
-	// See if we want to enable debugging
-	if (settings.debug) {
-		log.info('Hawkejs debugging has been ENABLED');
-		alchemy.hawkejs._debug = true;
-	}
-});
-
-/**
- * The "hawkejsSetup" stage:
- * Initialize Hawkejs
- *
- * @author        Jelle De Loecker   <jelle@elevenways.be>
- * @since         0.0.1
- * @version       1.3.3
- */
-alchemy.sputnik.add(function hawkejs_setup() {
-
-	// Set the correct asset paths
-	alchemy.hawkejs.style_path = 'stylesheets/';
-	alchemy.hawkejs.script_path = 'scripts/';
-
-	// Serve the hawkejs file
-	Router.use('/hawkejs/hawkejs-client.js', function getHawkejs(req, res, next) {
-
-		var retries = 0;
-
-		Blast.getClientPath({
-			modify_prototypes : true,
-			ua                : req.conduit.headers.useragent,
-			create_source_map : alchemy.settings.source_map,
-			enable_coverage   : !!global.__coverage__
-		}).done(gotClientFile);
-
-		function gotClientFile(err, path) {
-
-			if (err) {
-				return retryFnc(err);
-			}
-
-			let options = {};
-
-			if (req.conduit && req.conduit.supports('async') === false) {
-				options.add_async_support = true;
-			}
-
-			alchemy.minifyScript(path, options, function gotMinifiedPath(err, mpath) {
-
-				var options;
-
-				if (!retries) {
-					options = {
-						onError: retryFnc
-					}
-				}
-
-				req.conduit.serveFile(mpath || path, options);
-			});
-		}
-
-		function retryFnc(err) {
-
-			if (retries > 0) {
-				return req.conduit.error(new Error('Failed to serve client file'));
-			}
-
-			retries++;
-
-			Blast.getClientPath({
-				refresh           : true,
-				modify_prototypes : true,
-				ua                : req.conduit.headers.useragent,
-				create_source_map : alchemy.settings.source_map,
-			}).done(gotClientFile);
-		}
-	});
-
-	// Serve the static file with exposed variables
-	Router.use('/hawkejs/static.js', function getHawkejs(req, res, next) {
-		alchemy.hawkejs.getStaticExposedPath((err, path) => {
-
-			if (err) {
-				return req.conduit.error(err);
-			}
-
-			req.conduit.serveFile(path);
-		});
-	});
-
-	// Serve multiple template files
-	Router.use('/hawkejs/templates', function onGetTemplates(req, res) {
-
-		var names = req.conduit.param('name');
-
-		if (!names) {
-			return req.conduit.error(new Error('No template names have been given'));
-		}
-
-		alchemy.hawkejs.getFirstAvailableSource(names, function gotResult(err, result) {
-
-			if (err) {
-				return req.conduit.error(err);
-			}
-
-			if (!result || !result.name) {
-				return req.conduit.notFound('Could not find any of the given templates');
-			}
-
-			req.conduit.setHeader('cache-control', 'public, max-age=3600, must-revalidate');
-
-			// Don't use json dry, hawkejs expects regular json
-			req.conduit.json_dry = false;
-
-			req.conduit.end(result);
-		});
-	}, {methods: ['get'], weight: 19});
-
-	// Serve single template files
-	Router.use('/hawkejs/template', function onGetTemplate(req, res) {
-
-		var name = req.conduit.param('name');
-
-		if (!name) {
-			return req.conduit.error(new Error('No template name has been given'));
-		}
-
-		alchemy.hawkejs.getTemplatePath(name, function gotTemplate(err, path) {
-
-			if (err) {
-				return req.conduit.error(err);
-			}
-
-			if (!path) {
-				req.conduit.notFound('Could not find ' + name);
-			} else {
-				req.conduit.serveFile(path);
-			}
-		});
-	}, {methods: ['get'], weight: 19});
-});
-
-/**
- * The "middleware" stage:
- * Setup middleware
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       1.1.3
- */
-alchemy.sputnik.add(function middleware() {
-
-	// Serve public files
-	Router.use('/public/', alchemy.publicMiddleware, 50);
-
-	// Serve stylesheets
-	Router.use('/stylesheets/', alchemy.styleMiddleware, 50);
-
-	// Serve scripts
-	Router.use('/scripts/', alchemy.scriptMiddleware, 50);
-
-	// Serve fonts
-	Router.use('/fonts/', alchemy.fontMiddleware, 50);
-
-	// Serve root files
-	Router.use('/', alchemy.rootMiddleware, 49);
-
-	if (alchemy.settings.debug) {
-		// Serve sourcemap files
-		Router.use('/_sourcemaps/', alchemy.sourcemapMiddleware, 50);
-	}
-
-	// Parse body (form-data & json, no multipart)
-	// @todo: not all routes require body parsing
-	Router.use(function parseBody(req, res, next) {
-
-		// Don't re-check internal redirects, they always should have a body set
-		if (req.original.body != null || (req.conduit && req.conduit instanceof Classes.Alchemy.Conduit.Loopback)) {
-			return next();
-		}
-
-		alchemy.parseRequestBody(req, res, next);
-
-	}, {methods: ['post'], weight: 99999});
-});
-
-/**
- * The "routes" stage:
- * Initialize all the routes
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       0.4.0
- */
-alchemy.sputnik.add(function routes() {
-	try {
-		alchemy.useOnce(path.resolve(PATH_APP, 'config', 'routes'));
-	} catch (err) {
-		// Only output warning when not in client mode
-		if (!alchemy.settings.client_mode) {
-			log.warn('No route config was found');
-		}
-	}
-});
-
-/**
- * The "startServer" stage:
- * Actually start the server
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       1.3.5
- */
-alchemy.sputnik.add(function start_server() {
-
-	if (process.send) {
-		// Create a connection to the hohenheim parent
-		alchemy.hohenheim = new Classes.Alchemy.Reciprocal(process, 'hohenheim');
-	}
-
-	if (alchemy.settings.client_mode) {
-		return alchemy.sputnik.launch('listening');
-	}
-
-	alchemy.exposeDefaultStaticVariables();
-
-	// If a falsy (non-null) port is given (and no socket file), do nothing
-	if (!settings.port && settings.port !== null && !settings.socket) {
-		return;
-	}
-
-	let listen_target;
-
-	// Are we using a socket file?
-	if (typeof settings.socket == 'string') {
-		let stat;
-
-		try {
-			stat = fs.statSync(settings.socket);
-		} catch (err) {
-			// File not found, so it's safe to use
-		}
-
-		if (stat) {
-			log.info('Found existing socketfile at', settings.socket, ', need to remove it');
-			fs.unlinkSync(settings.socket);
-		}
-
-		listen_target = settings.socket;
-	}
-
-	if (!listen_target && settings.port) {
-		listen_target = settings.port;
-	}
-
-	// Start listening on the given port
-	// The actual `requests` listener is defined in the 'http' stage
-	alchemy.server.listen(listen_target, function areListening(){
-
-		let address = alchemy.server.address();
-		let url = alchemy.settings.url;
-
-		if (typeof address == 'string') {
-			settings.socket = address;
-			log.info('HTTP server listening on socket file', address);
-
-			// Make readable by everyone
-			if (settings.socketfile_chmod) {
-				fs.chmodSync(address, settings.socketfile_chmod);
-			}
-		} else {
-			// Get the actual server port
-			settings.port = address.port;
-			log.info('HTTP server listening on port', settings.port);
-
-			if (!url) {
-				url = 'http://localhost:' + address.port;
-			}
-		}
-
-		if (url) {
-			let pretty_url = alchemy.colors.bg.getRgb(1, 0, 1) + alchemy.colors.fg.getRgb(5, 3, 0) + ' ' + url + ' ' + alchemy.colors.reset;
-			log.info('Served at »»', pretty_url, '««');
-		}
-
-		// If this process is a child, tell the parent we're ready
-		if (process.send) {
-			log.info('Letting the parent know we\'re ready!');
-			process.send({alchemy: {ready: true}});
-
-			process.on('disconnect', function onParentExit() {
-				log.info('Parent exited, closing down');
-				process.exit();
-			});
-		}
-
-		alchemy.sputnik.launch('listening');
-	});
-
-	// Listen for errors (like EADDRINUSE)
-	alchemy.server.on('error', function onError(err) {
-
-		if (process.send) {
-			process.send({alchemy: {error: err}});
-			return process.exit();
-		}
-
-		throw err;
-	});
-});
-
-/**
- * Launch the "startServer" stage after datasources & socket
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       0.5.0
- */
-alchemy.sputnik.after(['datasources', 'socket'], function scheduleServerStart() {
-
-	// Need to wait for all classes to load
-	Blast.loaded(function hasLoaded() {
-
-		alchemy.sputnik.launch('start_server');
-
-		// Indicate the server has started
-		alchemy.started = true;
-	});
-});
-
-alchemy.sputnik.launch([
-	'http',
-	'core_app',
-	'plugins',
-	'base_app',
-	'middleware',
-	'datasources',
-	'define_debug',
-	'socket',
-	'hawkejs_setup',
-	'routes']);