Jakefile.js

// Copyright (c) 2012-2016 Titanium I.T. LLC. All rights reserved. See LICENSE.txt for details.
/*global desc, task, file, jake, rule, fail, complete, directory*/

(function() {
	"use strict";

	var startTime = Date.now();

	// We've put most of our require statements in functions (or tasks) so we don't have the overhead of
	// loading modules we don't need. At the time this refactoring was done, module loading took about half a
	// second, which was 10% of our desired maximum of five seconds for a quick build.
	// The require statements here are just the ones that are used to set up the tasks.
	var paths = require("./build/config/paths.js");

	var strict = !process.env.loose;
	if (strict) console.log("For more forgiving test settings, use 'loose=true'");

	//*** DIRECTORIES

	directory(paths.tempTestfileDir);
	directory(paths.buildDir);
	directory(paths.buildServerDir);
	directory(paths.buildSharedDir);
	directory(paths.buildClientDir);
	directory(paths.incrementalDir);


	//*** GENERAL

	jake.addListener('complete', function () {
		var elapsedSeconds = (Date.now() - startTime) / 1000;
		console.log("\n\nBUILD OK (" + elapsedSeconds.toFixed(2) + "s)");
	});

	desc("Delete all generated files");
	task("clean", [], function() {
		jake.rmRf(paths.generatedDir);
	});

	desc("Lint and test everything");
	task("default", [ "clean", "quick", "smoketest" ]);

	desc("Incrementally lint and test fast targets");
	task("quick", [ "versions", "lint", "test" ]);

	desc("Start Karma server for testing");
	task("karma", [ "versions" ], function() {
		karmaRunner().start({
			configFile: paths.karmaConfig
		}, complete, fail);
	}, { async: true });

	desc("Start localhost server for manual testing");
	task("run", [ "nodeVersion", "build" ], function() {
		var runServer = require("./src/_run_server.js");

		console.log("Running server. Press Ctrl-C to stop.");
		runServer.runInteractively();
		// We never call complete() because we want the task to hang until the user presses 'Ctrl-C'.
	}, { async: true });


	//*** LINT

	desc("Lint everything");
	task("lint", [ "lintLog", "incrementalLint" ], function() {
		console.log();
	});

	task("lintLog", function() { process.stdout.write("Linting JavaScript: "); });

	task("incrementalLint", paths.lintDirectories());
	task("incrementalLint", paths.lintOutput());
	createDirectoryDependencies(paths.lintDirectories());

	rule(".lint", determineLintDependency, function() {
		/*eslint no-invalid-this:off */
		var lint = require("./build/util/lint_runner.js");
		var lintConfig = require("./build/config/eslint.conf.js");

		var passed = lint.validateFile(this.source, lintConfig.options);
		if (passed) fs().writeFileSync(this.name, "lint ok");
		else fail("Lint failed");
	});


	//*** TEST

	desc("Test everything (except smoke tests)");
	task("test", [ "testShared", "testServer", "testClient" ]);

	desc("Test client code");
	task("testClient", [ "testClientUi", "testClientNetwork", "testClientCss" ]);

	desc("Test shared code");
	task("testShared", [ "testSharedOnServer", "testSharedOnClient" ]);

	desc("Test server code");
	incrementalTask("testServer", [ paths.tempTestfileDir ], paths.serverTestDependencies(), function(complete, fail) {
		console.log("Testing server JavaScript: ");
		mochaRunner().runTests({
			files: paths.serverTestFiles(),
			options: mochaConfig()
		}, complete, fail);
	});

	incrementalTask("testSharedOnServer", [], paths.sharedJsTestDependencies(), function(complete, fail) {
		console.log("Testing shared JavaScript on server: ");
		mochaRunner().runTests({
			files: paths.sharedTestFiles(),
			options: mochaConfig()
		}, complete, fail);
	});

	incrementalTask("testSharedOnClient", [], paths.sharedJsTestDependencies(), function(complete, fail) {
		console.log("Testing shared JavaScript on client: ");
		runKarmaOnTaggedSubsetOfTests("SHARED", complete, fail);
	});

	incrementalTask("testClientUi", [], paths.clientJsTestDependencies(), function(complete, fail) {
		console.log("Testing browser UI code: ");
		runKarmaOnTaggedSubsetOfTests("UI", complete, fail);
	});

	incrementalTask("testClientCss", [], paths.cssTestDependencies(), function(complete, fail) {
		console.log("Testing CSS:");
		runKarmaOnTaggedSubsetOfTests("CSS", complete, fail);
	});

	incrementalTask("testClientNetwork", [], paths.clientNetworkTestDependencies(), function(complete, fail) {
		console.log("Testing browser networking code: ");

		var networkHarness = require("./src/client/network/__test_harness_server.js");

		var networkStopFn = networkHarness.start();
		runKarmaOnTaggedSubsetOfTests("NET", networkStopFn(complete), fail);
	});

	function runKarmaOnTaggedSubsetOfTests(tag, complete, fail) {
		karmaRunner().run({
			configFile: paths.karmaConfig,
			expectedBrowsers: testedBrowsers(),
			strict: strict,
			clientArgs: [ "--grep=" + tag + ":" ]
		}, complete, fail);
	}

	desc("End-to-end smoke tests");
	task("smoketest", [ "build" ], function(why) {
		console.log("Smoke testing app: ");
		mochaRunner().runTests({
			files: paths.smokeTestFiles(),
			options: mochaConfig()
		}, complete, fail);
	}, { async: true });


	//*** BUILD DISTRIBUTION DIRECTORY

	desc("Bundle and build code");
	task("build", [ "server", "client" ]);

	task("server", [ paths.buildServerDir, paths.buildSharedDir ], function() {
		console.log("Collating server files: .");

		shell().rm("-rf", paths.buildDir + "/server/*");
		shell().rm("-rf", paths.buildDir + "/shared/*");
		shell().rm("-rf", paths.buildDir + "/node_modules/*");
		shell().cp(
			"-R",
			"src/server",
			"src/shared",
			"src/node_modules",
			paths.buildDir
		);
	});

	task("client", [ "cacheBust" ]);

	task("cacheBust", [ "collateClientFiles", "bundleClientJs" ], function() {
		process.stdout.write("Cache-busting CSS and JavaScript: ");

		var hashCatRunner = require("./build/util/hashcat_runner.js");
		hashCatRunner.go({
			files: [ paths.buildClientIndexHtml, paths.buildClient404Html ]
		}, removeUnwantedFiles, fail);

		function removeUnwantedFiles() {
			shell().rm(paths.buildIntermediateFilesToErase());
			complete();
		}

	}, { async: true });

	task("collateClientFiles", [ paths.buildClientDir ], function() {
		console.log("Collating client files: .");

		shell().rm("-rf", paths.buildClientDir + "/*");
		shell().cp(
			"-R",
			"src/client/content/*", "src/client/ui/vendor", "src/client/network/vendor",
			paths.buildClientDir
		);
	});

	task("bundleClientJs", [ paths.buildClientDir ], function() {
		process.stdout.write("Bundling client files with Browserify: ");

		var browserifyRunner = require("./build/util/browserify_runner.js");
		browserifyRunner.bundle({
			requires: [
				{ path: "./src/client/ui/client.js", expose: "./client.js" },
				{ path: "./src/client/ui/html_element.js", expose: "./html_element.js" },
				{ path: "./src/client/network/real_time_connection.js", expose: "./real_time_connection.js" }
			],
			outfile: paths.buildClientDir + "/bundle.js",
			options: { debug: true }
		}, complete, fail);
	}, { async: true });


	//*** CHECK VERSIONS

	desc("Check dependency versions");
	task("versions", [ "nodeVersion", "socketIoVersion" ]);

	task("nodeVersion", [], function() {
		console.log("Checking Node.js version: .");
		var version = require("./build/util/version_checker.js");

		version.check({
			name: "Node",
			expected: require("./package.json").engines.node,
			actual: process.version,
			strict: strict
		}, complete, fail);
	}, { async: true });

	task("socketIoVersion", [], function() {
		console.log("Checking Socket.IO versions: .");

		var nodeServerVersion = require("socket.io/package").version;
		var nodeClientVersion = require("socket.io-client/package").version;

		if (nodeServerVersion !== nodeClientVersion) {
			console.log("Socket.IO versions did not match!\n" +
				"  socket.io: " + nodeServerVersion + "\n" +
				"  socket.io-client: " + nodeClientVersion
			);
			fail("Socket.IO version mismatch");
		}

		var vendorClientFilename = "./src/client/network/vendor/socket.io-" + nodeServerVersion + ".js";
		try {
			var stat = fs().statSync(vendorClientFilename);
			// file exists, we're all good
		}
		catch (err) {
			console.log("Socket.IO vendor file version did not match or was missing!\n" +
				"  Expected version " + nodeServerVersion + "\n" +
				"  at location " + vendorClientFilename + "\n" +
				"  To get correct version, `jake run` and go to:\n" +
				"    http://localhost:5000/socket.io/socket.io.js\n" +
				"  (" + err + ")"
			);
			fail("Socket.IO version mismatch");
		}
	});


	//*** CHECKLISTS

	desc("Integration checklist");
	task("integrate", function() {
		console.log("1. Make sure 'git status' is clean.");
		console.log("2. Build on the integration box.");
		console.log("   a. Walk over to integration box.");
		console.log("   b. 'git pull'");
		console.log("   c. 'npm rebuild'");
		console.log("   d. Check status for files that need to be .gitignore'd");
		console.log("   e. 'jake'");
		console.log("   f. If jake fails, stop! Try again after fixing the issue.");
		console.log("3. 'git checkout integration'");
		console.log("4. 'git merge master --no-ff --log=100 -m \"INTEGRATE: \" -e'");
		console.log("5. 'git checkout master'");
	});

	desc("Deploy checklist");
	task("deploy", function() {
		console.log("To deploy to production:");
		console.log("1. Make sure `git status` is clean");
		console.log("2. Run full build (`jake`) and make sure it builds okay");
		console.log("3. Check in release code: `git add generated/dist -f && git commit`");
		console.log("4. Integrate");
		console.log("5. Deploy integrated code to staging: `git push staging integration:master`");
		console.log("6. Verify by visiting http://wwp-staging.herokuapp.com");
		console.log("7. Deploy integrated to production: `git push heroku integration:master`");
		console.log("8. Remove `generated/dist` from git");
	});

	desc("End-of-episode checklist");
	task("episode", [], function() {
		console.log("1. Save recording.");
		console.log("2. Double-check sound and framing.");
		console.log("3. Commit source code.");
		console.log("4. Check Windows compatibility");
		console.log("   a. Switch to Windows VM");
		console.log("   b. 'git pull'");
		console.log("   c. 'npm rebuild'");
		console.log("   d. Check status for files that need to be .gitignore'd");
		console.log("   e. 'jake'");
		console.log("5. Tag episode: 'git tag -a episodeXX -m \"End of episode XX\"'");
	});


	//*** UTILITY FUNCTIONS

	function determineLintDependency(name) {
		var result = name.replace(/^generated\/incremental\/lint\//, "");
		return result.replace(/\.lint$/, "");
	}

	function incrementalTask(taskName, taskDependencies, fileDependencies, action) {
		var incrementalFile = paths.incrementalDir + "/" + taskName + ".task";

		task(taskName, taskDependencies.concat(paths.incrementalDir, incrementalFile));
		file(incrementalFile, fileDependencies, function() {
			action(succeed, fail);
		}, {async: true});

		function succeed() {
			fs().writeFileSync(incrementalFile, "ok");
			complete();
		}
	}

	function createDirectoryDependencies(directories) {
		directories.forEach(function(lintDirectory) {
			directory(lintDirectory);
		});
	}


	//*** LAZY-LOADED MODULES

	function fs() {
		return require("fs");
	}

	function karmaRunner() {
		return require("simplebuild-karma");
	}

	function mochaRunner() {
		return require("./build/util/mocha_runner.js");
	}

	function mochaConfig() {
		return require("./build/config/mocha.conf.js");
	}

	function shell() {
		return require("shelljs");
	}

	function testedBrowsers() {
		return require("./build/config/tested_browsers.js");
	}

}());