From 1e9603635136a4c4248d43b4971f41ca6f283925 Mon Sep 17 00:00:00 2001 From: Jose Date: Sun, 25 Oct 2020 23:06:39 -0600 Subject: [PATCH] fix appendRequestPath = false scenarios --- lib/plugins/static.js | 23 +++---- test/plugins/static.test.js | 124 ++++++++++++++++++++++++++++-------- 2 files changed, 108 insertions(+), 39 deletions(-) diff --git a/lib/plugins/static.js b/lib/plugins/static.js index 0fcdfd267..5d30343c6 100644 --- a/lib/plugins/static.js +++ b/lib/plugins/static.js @@ -87,6 +87,7 @@ function serveStatic(options) { assert.optionalObject(opts.match, 'options.match'); assert.optionalString(opts.charSet, 'options.charSet'); assert.optionalString(opts.file, 'options.file'); + assert.optionalString(opts.file, 'options.default'); assert.bool(opts.appendRequestPath, 'options.appendRequestPath'); var p = path.normalize(opts.directory).replace(/\\/g, '/'); @@ -170,19 +171,19 @@ function serveStatic(options) { } else if (opts.appendRequestPath) { file = path.join(opts.directory, decodeURIComponent(req.path())); } else { - var dirBasename = path.basename(opts.directory); - var reqpathBasename = path.basename(req.path()); - - if ( - path.extname(req.path()) === '' && - dirBasename === reqpathBasename - ) { + if (path.extname(req.path()) === '') { file = opts.directory; } else { - file = path.join( - opts.directory, - decodeURIComponent(path.basename(req.path())) - ); + var fileName = decodeURIComponent(path.basename(req.path())); + // test for requested file, if it doesn't exist we send the directory as path since appendRequestPath = false + if (!fs.existsSync(path.join(opts.directory, fileName))) { + file = opts.directory; + } else { + file = path.join( + opts.directory, + decodeURIComponent(path.basename(req.path())) + ); + } } } diff --git a/test/plugins/static.test.js b/test/plugins/static.test.js index b80bff32b..94b987a1d 100644 --- a/test/plugins/static.test.js +++ b/test/plugins/static.test.js @@ -122,11 +122,22 @@ describe('static resource plugin', function() { }); } - function testNoAppendPath(done, testDefault, tmpDir, regex, staticFile) { + function testNoAppendPath( + done, + testDefault, + tmpDir, + regex, + staticFile, + requestDirectFile, + customRoute + ) { var staticContent = '{"content": "abcdefg"}'; + var staticContent2 = '{"content2": "hijklmn"}'; var staticObj = JSON.parse(staticContent); + var staticObj2 = JSON.parse(staticContent2); var testDir = 'public'; var testFileName = 'index.json'; + var testFileName2 = 'specific.json'; var routeName = 'GET wildcard'; var tmpPath = path.join(__dirname, '../', tmpDir); @@ -140,40 +151,61 @@ describe('static resource plugin', function() { DIRS_TO_DELETE.push(folderPath); var file = path.join(folderPath, testFileName); + var file2 = path.join(folderPath, testFileName2); fs.writeFile(file, staticContent, function(err3) { assert.ifError(err3); FILES_TO_DELETE.push(file); - var p = '/' + testDir + '/' + testFileName; - var opts = { directory: folderPath }; - opts.appendRequestPath = false; - - if (staticFile) { - opts.file = testFileName; - } - - if (testDefault) { - p = '/' + testDir + '/'; - opts.default = testFileName; - routeName += ' with default'; - } - SERVER.get( - { - path: '/' + testDir + '/*', - name: routeName - }, - restify.plugins.serveStatic(opts) - ); - - CLIENT.get(p, function(err4, req, res, obj) { + fs.writeFile(file2, staticContent2, function(err4) { assert.ifError(err4); - assert.equal( - res.headers['cache-control'], - 'public, max-age=3600' + FILES_TO_DELETE.push(file2); + + var p = '/' + testDir + '/' + testFileName; + var opts = { directory: folderPath }; + opts.appendRequestPath = false; + + if (staticFile) { + opts.file = testFileName; + } + + if (testDefault) { + p = + '/' + + testDir + + '/other/route/it/should/serve/default/anyway'; + opts.default = testFileName; + routeName += ' with default'; + } + + if (requestDirectFile) { + p = '/' + testDir + '/specific.json'; + } + + if (customRoute) { + p = '/' + testDir + '/' + customRoute; + } + + SERVER.get( + { + path: '/' + testDir + '/*', + name: routeName + }, + restify.plugins.serveStatic(opts) ); - assert.deepEqual(obj, staticObj); - done(); + + CLIENT.get(p, function(err5, req, res, obj) { + assert.ifError(err5); + assert.equal( + res.headers['cache-control'], + 'public, max-age=3600' + ); + var ojbToCompare = requestDirectFile + ? staticObj2 + : staticObj; + assert.deepEqual(obj, ojbToCompare); + done(); + }); }); }); }); @@ -227,6 +259,42 @@ describe('static resource plugin', function() { testNoAppendPath(done, false, '.tmp', null, true); }); + // eslint-disable-next-line + it('static serves and request an specific file with appendRequestPath = false', function(done) { + testNoAppendPath(done, true, '.tmp', null, null, true); + }); + + // eslint-disable-next-line + it('static serves and request an specific file with appendRequestPath = false, with no default file specified', function(done) { + testNoAppendPath(done, false, '.tmp', null, null, true); + }); + + // eslint-disable-next-line + it('static serves and request an inexistent specific file with appendRequestPath = false, with default file specified', function(done) { + testNoAppendPath( + done, + true, + '.tmp', + null, + null, + false, + 'doesNotExists.json' + ); + }); + + // eslint-disable-next-line + it('static serves and request an inexistent specific route with appendRequestPath = false, with default file specified', function(done) { + testNoAppendPath( + done, + true, + '.tmp', + null, + null, + false, + 'doesNotExists' + ); + }); + it('static responds 404 for missing file', function(done) { var p = '/public/no-such-file.json'; var tmpPath = path.join(process.cwd(), '.tmp');