Skip to content
This repository has been archived by the owner on Mar 8, 2019. It is now read-only.

Commit

Permalink
Merge pull request #2 from AirVantage/bugfix/configure-cache-options
Browse files Browse the repository at this point in the history 
Fix cache option naming
  • Loading branch information
@phtrivier
phtrivier committed May 21, 2015
2 parents f761e49 + 3adde32 commit 084dbfd
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 64 deletions.
130 changes: 73 additions & 57 deletions techStatic.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,39 @@ var logger = require("node-tech-logger");
var assert = require("assert");
var ls = require('list-directory-contents');

function printDir(dirname) {
ls(dirname, function (err, tree) {
if (err) {
logger.error("[tech-static] Error while listing dir " + dirname + " : " + JSON.stringify(err));
} else {
logger.debug("[tech-static] Counted " + _.size(tree) + " elements in dir " + dirname);
}
function configure(app, configuration, dirs, bundles) {

logger.debug("[tech-static] Configuring static resources with configuration");

checkOptimizedDir(dirs[0], configuration);

serveStaticAssets(app, {
version: configuration.AV_VERSION,
optimize: configuration.resources.optimize,
cache: configuration.resources.cache,
dirs: dirs
});

if (bundles) {
serveI18nBundles(app, {
version: configuration.AV_VERSION,
contextUrl: configuration.contextUrl,
bundles: bundles
});
}

}

function checkOptimizedDir(dirname, configuration) {
if (configuration.resources.optimize) {
fs.exists(path.join(dirname, "dist", "public"), function(exists) {
if (!exists) {
throw new Error("Trying to launch server with optimized resources, but dist/public does not exts ; run grunt dist");
}
});
} else {
logger.warn("Will use non-optimized resources");
}
}

/**
Expand All @@ -28,10 +53,10 @@ function printDir(dirname) {
* @param opts.version
* {String} the version of the web application released. It is used to compute the URL of all static resources (eg "15.01")
*
* @param opts.cacheOptions
* @param [opts.cacheOptions.ms]
* @param opts.cache
* @param [opts.cache.ms]
* {Integer} number of ms during which resources should be cached
* @param [opts.cacheOptions.seconds]
* @param [opts.cache.seconds]
* {Integer} number of seconds during which resources should be cached
*
* @param [opts.staticMw]
Expand All @@ -40,6 +65,8 @@ function printDir(dirname) {
*/
var serveStaticAssets = function(app, opts) {

logger.debug("[tech-static] Opts", opts);

assert.ok(opts.dirs);
assert.ok(opts.version);

Expand All @@ -50,11 +77,10 @@ var serveStaticAssets = function(app, opts) {

var dirs = opts.dirs;
var optimize = opts.optimize;
var cacheOptions = staticCacheOptions(opts.cache);
var staticMw = opts.staticMw || express.static;
var expressStaticCacheOptions = toExpressStaticCacheOptions(opts.cache);
var staticMw = opts.staticMw || _testing.staticMw || express.static;


logger.debug("Using cache Options", cacheOptions);
logger.debug("[tech-static] Express Cache Options", expressStaticCacheOptions);
logger.debug("[tech-static] StaticPrefix:", resourcesUrlBase);
logger.debug("[tech-static] StaticPrefix for debug:", resourcesDebugUrlBase);

Expand All @@ -63,7 +89,7 @@ var serveStaticAssets = function(app, opts) {
logger.debug("[tech-static] Serving optimized resources " + resourcesUrlBase + " from folder:", distDir);
printDir(distDir);

app.use(resourcesUrlBase, staticMw(distDir, cacheOptions));
app.use(resourcesUrlBase, staticMw(distDir, expressStaticCacheOptions));

_.each(dirs, function(dir) {
var publicDir = path.join(dir, "public");
Expand All @@ -78,19 +104,30 @@ var serveStaticAssets = function(app, opts) {
var cssDir = path.join(distDir, "css");
logger.debug("[tech-static] Serving all.css file for debug url " + resourcesDebugUrlBase + "/css from folder " + cssDir);
printDir(cssDir);
app.use(resourcesDebugUrlBase + "/css", staticMw(cssDir, cacheOptions));
app.use(resourcesDebugUrlBase + "/css", staticMw(cssDir, expressStaticCacheOptions));
} else {
_.each(dirs, function(dir) {
var publicDir = path.join(dir, "public");
logger.debug("[tech-static] Serving non optimized resources from folder:", publicDir);
app.use(resourcesUrlBase, staticMw(publicDir, cacheOptions));
app.use(resourcesUrlBase, staticMw(publicDir, expressStaticCacheOptions));
});
}
};

function staticCacheOptions(cacheConfiguration) {
/**
* Convert a, object with ms or seconds, into a 'cache options' usable by
* express 'static' middleware.
*
* @options cacheConfiguration
* @options [cacheConfiguration.ms]
* @options []cacheConfiguration.seconds]
*/
function toExpressStaticCacheOptions(cacheConfiguration) {

logger.debug("[tech-static] computing cache options", cacheConfiguration);

var res = {
ms: 0
maxAge : 0
};
if (cacheConfiguration) {
if (cacheConfiguration.seconds) {
Expand All @@ -107,6 +144,16 @@ function staticCacheOptions(cacheConfiguration) {
return res;
}

function printDir(dirname) {
ls(dirname, function(err, tree) {
if (err) {
logger.warn("[tech-static] Error while listing dir " + dirname + " : " + JSON.stringify(err));
} else {
logger.debug("[tech-static] Counted " + _.size(tree) + " elements in dir " + dirname);
}
});
}

/**
* Configure application to serve i18n bundles like ("CommonMessages_en.properties) by
* redirecting to file "CommonMessage.properties".
Expand Down Expand Up @@ -135,7 +182,7 @@ var serveI18nBundles = function(app, opts) {

var bundles = opts.bundles;

[resourcesUrlBase, resourcesDebugUrlBase].forEach(function (urlBase) {
[resourcesUrlBase, resourcesDebugUrlBase].forEach(function(urlBase) {
bundles.forEach(function(bundle) {
var en_path = [urlBase, "/i18n/", bundle, "_en.properties"].join("");
var no_locale_path = [urlBase, "/i18n/", bundle, ".properties"].join("");
Expand All @@ -147,44 +194,13 @@ var serveI18nBundles = function(app, opts) {

};

function checkOptimizedDir(dirname, configuration) {
if (configuration.resources.optimize) {
fs.exists(path.join(dirname, "dist", "public"), function(exists) {
if (!exists) {
throw new Error("Trying to launch server with optimized resources, but dist/public does not exts ; run grunt dist");
}
});
} else {
logger.warn("Will use non-optimized resources");
}
}

function configure(app, configuration, dirs, bundles) {

checkOptimizedDir(dirs[0], configuration);

serveStaticAssets(app, {
version: configuration.AV_VERSION,
optimize: configuration.resources.optimize,
cacheOptions: configuration.resources.cache,
dirs: dirs
});

if (bundles) {
serveI18nBundles(app, {
version: configuration.AV_VERSION,
contextUrl: configuration.contextUrl,
bundles: bundles
});
}

}

module.exports = {

var _testing = {
serveStaticAssets: serveStaticAssets,
serveI18nBundles: serveI18nBundles,
checkOptimizedDir: checkOptimizedDir,
configure: configure
checkOptimizedDir: checkOptimizedDir
};

module.exports = {
configure: configure,
_testing : _testing
};
41 changes: 34 additions & 7 deletions test/techStaticSpec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,33 @@ describe("node-tech-static", function() {

});

describe("#configure", function() {

it("Uses cache options from configuration", function() {

var configuration = {
AV_VERSION : "1.0",
resources : {
cache : {
seconds : 15
}
}
};

techStatic._testing.staticMw = function(folder, options) {
return [folder.split(path.sep).join("/"), options];
};
techStatic.configure(app, configuration, ["dir1"], []);

sinon.assert.calledWith(app.use, "/resources/1.0", ["dir1/public", {
maxAge : 15000
}]);

});


});

describe("#serveStaticAssets", function() {
beforeEach(function() {
opts = {
Expand All @@ -34,7 +61,7 @@ describe("node-tech-static", function() {

it("Serves from a list of dirs", function() {

techStatic.serveStaticAssets(app, opts);
techStatic._testing.serveStaticAssets(app, opts);

sinon.assert.calledWith(app.use, "/resources/1.0", ["public", {
maxAge: 123456
Expand All @@ -49,7 +76,7 @@ describe("node-tech-static", function() {

opts.optimize = true;

techStatic.serveStaticAssets(app, opts);
techStatic._testing.serveStaticAssets(app, opts);

sinon.assert.calledWith(app.use, "/resources/1.0", ["dist/public", {
maxAge: 123456
Expand All @@ -61,7 +88,7 @@ describe("node-tech-static", function() {

opts.optimize = true;

techStatic.serveStaticAssets(app, opts);
techStatic._testing.serveStaticAssets(app, opts);

sinon.assert.calledWith(app.use, "/resources-debug/1.0", ["public", {
maxAge: 0
Expand All @@ -75,7 +102,7 @@ describe("node-tech-static", function() {
opts.cache.seconds = 1;
delete opts.cache.ms;

techStatic.serveStaticAssets(app, opts);
techStatic._testing.serveStaticAssets(app, opts);

sinon.assert.calledWith(app.use, "/resources/1.0", ["public", {
maxAge: 1000
Expand All @@ -89,7 +116,7 @@ describe("node-tech-static", function() {

it("Adds default service for all bundles", function() {

techStatic.serveI18nBundles(app, {
techStatic._testing.serveI18nBundles(app, {
bundles: ["Portal", "Error"],
version: "1.0",
contextUrl: "/portal"
Expand All @@ -101,7 +128,7 @@ describe("node-tech-static", function() {
});

it("Redirects en to default property files", function() {
techStatic.serveI18nBundles(app, {
techStatic._testing.serveI18nBundles(app, {
bundles: ["Portal"],
version: "1.0",
contextUrl: "/portal"
Expand All @@ -120,7 +147,7 @@ describe("node-tech-static", function() {
});

it("Redirects en to default for 'debug' resources", function() {
techStatic.serveI18nBundles(app, {
techStatic._testing.serveI18nBundles(app, {
bundles: ["Portal"],
version: "1.0",
contextUrl: "/portal"
Expand Down

0 comments on commit 084dbfd

Please sign in to comment.