unpkg/server/middleware/fetchFile.js

241 lines
7.4 KiB
JavaScript
Raw Normal View History

2018-02-17 00:00:06 +00:00
const fs = require("fs");
const path = require("path");
const semver = require("semver");
const createPackageURL = require("../utils/createPackageURL");
const createSearch = require("./utils/createSearch");
const getPackageInfo = require("./utils/getPackageInfo");
const getPackage = require("./utils/getPackage");
const incrementCounter = require("./utils/incrementCounter");
2017-08-24 07:12:26 +00:00
function getBasename(file) {
2018-02-17 00:00:06 +00:00
return path.basename(file, path.extname(file));
2017-08-24 07:12:26 +00:00
}
2017-08-23 03:16:21 +00:00
/**
* File extensions to look for when automatically resolving.
*/
2018-02-17 00:00:06 +00:00
const FindExtensions = ["", ".js", ".json"];
/**
* Resolves a path like "lib/file" into "lib/file.js" or "lib/file.json"
* depending on which one is available, similar to require('lib/file').
*/
function findFile(base, useIndex, callback) {
2017-11-08 18:14:46 +00:00
FindExtensions.reduceRight((next, ext) => {
2018-02-17 00:00:06 +00:00
const file = base + ext;
2017-12-14 00:22:58 +00:00
return () => {
fs.stat(file, (error, stats) => {
if (error) {
2017-11-25 21:25:01 +00:00
if (error.code === "ENOENT" || error.code === "ENOTDIR") {
2018-02-17 00:00:06 +00:00
next();
} else {
2018-02-17 00:00:06 +00:00
callback(error);
}
} else if (useIndex && stats.isDirectory()) {
2018-02-17 00:00:06 +00:00
findFile(
path.join(file, "index"),
false,
(error, indexFile, indexStats) => {
if (error) {
callback(error);
} else if (indexFile) {
callback(null, indexFile, indexStats);
} else {
next();
}
}
2018-02-17 00:00:06 +00:00
);
} else {
2018-02-17 00:00:06 +00:00
callback(null, file, stats);
}
2018-02-17 00:00:06 +00:00
});
};
}, callback)();
}
/**
* Fetch the file from the registry and get its stats. Redirect if the URL
2017-12-14 00:22:58 +00:00
* specifies a tag, a semver version number, or an inexact path in ?module mode.
*/
function fetchFile(req, res, next) {
2017-12-14 00:22:58 +00:00
getPackageInfo(req.packageName, (error, packageInfo) => {
if (error) {
2018-02-17 00:00:06 +00:00
console.error(error);
2017-11-08 16:57:15 +00:00
return res
.status(500)
2017-11-25 21:25:01 +00:00
.type("text")
2018-02-17 00:00:06 +00:00
.send(`Cannot get info for package "${req.packageName}"`);
}
if (packageInfo == null || packageInfo.versions == null)
2017-11-08 16:57:15 +00:00
return res
.status(404)
2017-11-25 21:25:01 +00:00
.type("text")
2018-02-17 00:00:06 +00:00
.send(`Cannot find package "${req.packageName}"`);
2018-02-17 00:00:06 +00:00
req.packageInfo = packageInfo;
if (req.packageVersion in req.packageInfo.versions) {
// A valid request for a package we haven't downloaded yet.
2018-02-17 00:00:06 +00:00
req.packageConfig = req.packageInfo.versions[req.packageVersion];
2017-12-14 00:22:58 +00:00
getPackage(req.packageConfig, (error, outputDir) => {
if (error) {
2018-02-17 00:00:06 +00:00
console.error(error);
2017-11-08 16:57:15 +00:00
res
.status(500)
2017-11-25 21:25:01 +00:00
.type("text")
2018-02-17 00:00:06 +00:00
.send(`Cannot fetch package ${req.packageSpec}`);
} else {
2018-02-17 00:00:06 +00:00
req.packageDir = outputDir;
2018-02-17 00:00:06 +00:00
let filename = req.filename;
let useIndex = true;
2017-08-24 06:33:58 +00:00
if (req.query.module != null) {
// They want an ES module. Try "module", "jsnext:main", and "/"
// https://github.com/rollup/rollup/wiki/pkg.module
2017-12-14 00:22:58 +00:00
if (!filename) {
2018-02-17 00:00:06 +00:00
filename =
req.packageConfig.module ||
req.packageConfig["jsnext:main"] ||
"/";
2017-12-14 00:22:58 +00:00
}
2017-08-24 06:33:58 +00:00
} else if (filename) {
// They are requesting an explicit filename. Only try to find an
// index file if they are NOT requesting an HTML directory listing.
2018-02-17 00:00:06 +00:00
useIndex = filename[filename.length - 1] !== "/";
} else if (
req.query.main &&
typeof req.packageConfig[req.query.main] === "string"
) {
2017-08-24 06:33:58 +00:00
// They specified a custom ?main field.
2018-02-17 00:00:06 +00:00
filename = req.packageConfig[req.query.main];
2017-11-17 02:25:50 +00:00
incrementCounter(
2017-11-25 21:25:01 +00:00
"package-json-custom-main",
req.packageSpec + "?main=" + req.query.main,
2017-11-17 02:25:50 +00:00
1
2018-02-17 00:00:06 +00:00
);
2017-11-25 21:25:01 +00:00
} else if (typeof req.packageConfig.unpkg === "string") {
2017-08-24 06:33:58 +00:00
// The "unpkg" field allows packages to explicitly declare the
// file to serve at the bare URL (see #59).
2018-02-17 00:00:06 +00:00
filename = req.packageConfig.unpkg;
2017-11-25 21:25:01 +00:00
} else if (typeof req.packageConfig.browser === "string") {
2017-08-24 06:33:58 +00:00
// Fall back to the "browser" field if declared (only support strings).
2018-02-17 00:00:06 +00:00
filename = req.packageConfig.browser;
// Count which packages + versions are actually using this fallback
// so we can warn them when we deprecate this functionality.
// See https://github.com/unpkg/unpkg/issues/63
2018-02-17 00:00:06 +00:00
incrementCounter(
"package-json-browser-fallback",
req.packageSpec,
1
);
} else {
2017-08-24 06:33:58 +00:00
// Fall back to "main" or / (same as npm).
2018-02-17 00:00:06 +00:00
filename = req.packageConfig.main || "/";
2017-08-24 06:33:58 +00:00
}
2018-02-17 00:00:06 +00:00
findFile(
path.join(req.packageDir, filename),
useIndex,
(error, file, stats) => {
if (error) console.error(error);
if (file == null) {
return res
.status(404)
.type("text")
.send(
`Cannot find module "${filename}" in package ${
req.packageSpec
}`
);
}
filename = file.replace(req.packageDir, "");
if (
req.query.main != null ||
getBasename(req.filename) !== getBasename(filename)
) {
// Need to redirect to the module file so relative imports resolve
// correctly. Cache module redirects for 1 minute.
delete req.query.main;
res
.set({
"Cache-Control": "public, max-age=60",
"Cache-Tag": "redirect,module-redirect"
})
.redirect(
302,
createPackageURL(
req.packageName,
req.packageVersion,
filename,
createSearch(req.query)
)
);
} else {
req.filename = filename;
req.stats = stats;
next();
}
}
2018-02-17 00:00:06 +00:00
);
}
2018-02-17 00:00:06 +00:00
});
2017-11-25 21:25:01 +00:00
} else if (req.packageVersion in req.packageInfo["dist-tags"]) {
// Cache tag redirects for 1 minute.
2017-11-08 16:57:15 +00:00
res
.set({
2017-11-25 21:25:01 +00:00
"Cache-Control": "public, max-age=60",
"Cache-Tag": "redirect,tag-redirect"
2017-11-08 16:57:15 +00:00
})
.redirect(
302,
createPackageURL(
req.packageName,
2017-11-25 21:25:01 +00:00
req.packageInfo["dist-tags"][req.packageVersion],
2017-11-08 16:57:15 +00:00
req.filename,
req.search
)
2018-02-17 00:00:06 +00:00
);
} else {
2017-11-08 16:57:15 +00:00
const maxVersion = semver.maxSatisfying(
Object.keys(req.packageInfo.versions),
req.packageVersion
2018-02-17 00:00:06 +00:00
);
if (maxVersion) {
// Cache semver redirects for 1 minute.
2017-11-08 16:57:15 +00:00
res
.set({
2017-11-25 21:25:01 +00:00
"Cache-Control": "public, max-age=60",
"Cache-Tag": "redirect,semver-redirect"
2017-11-08 16:57:15 +00:00
})
2018-02-17 00:00:06 +00:00
.redirect(
302,
createPackageURL(
req.packageName,
maxVersion,
req.filename,
req.search
)
);
} else {
2017-11-08 16:57:15 +00:00
res
.status(404)
2017-11-25 21:25:01 +00:00
.type("text")
2018-02-17 00:00:06 +00:00
.send(`Cannot find package ${req.packageSpec}`);
}
}
2018-02-17 00:00:06 +00:00
});
}
2018-02-17 00:00:06 +00:00
module.exports = fetchFile;