Skip to content

[INTERNAL] testRunner middleware: Use ETag caching #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

[INTERNAL] testRunner middleware: Use ETag caching #354

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 31 additions & 8 deletions lib/middleware/testRunner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,43 @@ const path = require("path");
const mime = require("mime-types");
const parseurl = require("parseurl");
const log = require("@ui5/logger").getLogger("server:middleware:testRunner");
const etag = require("etag");
const fresh = require("fresh");

const testRunnerResourceRegEx = /\/test-resources\/sap\/ui\/qunit\/(testrunner\.(html|css)|TestRunner.js)$/;
const resourceCache = {};

function serveResource(res, resourcePath, resourceContent) {
function isFresh(req, res) {
return fresh(req.headers, {
"etag": res.getHeader("ETag")
});
}

async function readResourceInfo(resourceName) {
const content = await readFile(path.join(__dirname, "testRunner", resourceName), {encoding: "utf8"});
return {
content,
etag: etag(content)
};
}

function serveResource(req, res, resourcePath, resourceInfo) {
const type = mime.lookup(resourcePath) || "application/octet-stream";
const charset = mime.charset(type);
const contentType = type + (charset ? "; charset=" + charset : "");
res.setHeader("Content-Type", contentType);

// resources served by this middleware do not change often
res.setHeader("Cache-Control", "public, max-age=1800");
// Enable ETag caching
res.setHeader("ETag", resourceInfo.etag);

res.setHeader("Content-Type", contentType);
res.end(resourceContent);
if (isFresh(req, res)) {
// client has a fresh copy of the resource
res.statusCode = 304;
res.end();
return;
}

res.end(resourceInfo.content);
}

/**
Expand All @@ -40,14 +63,14 @@ function createMiddleware({resources}) {
log.verbose(`Serving ${pathname}`);
let pResource;
if (!resourceCache[pathname]) {
pResource = readFile(path.join(__dirname, "testRunner", resourceName), {encoding: "utf8"});
pResource = readResourceInfo(resourceName);
resourceCache[pathname] = pResource;
} else {
pResource = resourceCache[pathname];
}

const resourceContent = await pResource;
serveResource(res, pathname, resourceContent);
const resourceInfo = await pResource;
serveResource(req, res, pathname, resourceInfo);
} else {
next();
}
Expand Down