Skip to content
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.

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

fix: redirect when missing trailing slash #28

Merged
merged 2 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions src/handlers/get.ts
MoLow marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import responses from '../responses';
import {
isCacheEnabled,
isDirectoryPath,
hasTrailingSlash,
mapUrlPathToBucketPath,
parseUrl,
} from '../util';
Expand Down Expand Up @@ -39,6 +40,9 @@ const getHandler: Handler = async (request, env, ctx, cache) => {
// File not found since we should only be allowing
// file paths if directory listing is off
return responses.FILE_NOT_FOUND(request);
} else if (isPathADirectory && !hasTrailingSlash(bucketPath)) {
url.pathname += '/';
return Response.redirect(url.toString(), 301);
}

const response: Response = isPathADirectory
Expand Down
18 changes: 13 additions & 5 deletions src/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,18 @@ export function mapBucketPathToUrlPath(
: ['/' + bucketPath];
}

export function hasTrailingSlash(path: string): boolean {
return path[path.length - 1] === '/';
}

export function isExtensionless(path: string): boolean {
// `path.lastIndexOf('.') == -1` is a Node-specific
// heuristic here. There aren't any files that don't
// have file extensions, so, if there are no file extensions
// specified in the url, treat it like a directory.
return path.lastIndexOf('.') === -1;
}

/**
* Checks if a R2 path is for a directory or not.
* If a path ends in a `/` or there's no file
Expand All @@ -107,11 +119,7 @@ export function mapBucketPathToUrlPath(
* @returns True if it's for a directory
*/
export function isDirectoryPath(path: string): boolean {
// `path.lastIndexOf('.') == -1` is a Node-specific
// heuristic here. There aren't any files that don't
// have file extensions, so, if there are no file extensions
// specified in the url, treat it like a directory.
return path[path.length - 1] == '/' || path.lastIndexOf('.') == -1;
return hasTrailingSlash(path) || isExtensionless(path);
}

/**
Expand Down
45 changes: 31 additions & 14 deletions tests/e2e/directory.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,16 @@ describe('Directory Tests (Restricted Directory Listing)', () => {
url = await mf.ready;
});

it('allows `/dist` and returns expected html', async () => {
const [res, expectedHtml] = await Promise.all([
mf.dispatchFetch(`${url}dist`),
it('redirects `/dist` to `/dist/` and returns expected html', async () => {
const [originalRes, expectedHtml] = await Promise.all([
mf.dispatchFetch(`${url}dist`, { redirect: 'manual' }),
readFile('./tests/e2e/test-data/expected-html/dist.html', {
encoding: 'utf-8',
}),
]);

assert.strictEqual(res.status, 200);
assert.strictEqual(originalRes.status, 301);
const res = await mf.dispatchFetch(originalRes.headers.get('location')!);

// Assert that the html matches what we're expecting
// to be returned. If this passes, we can assume
Expand All @@ -48,8 +49,12 @@ describe('Directory Tests (Restricted Directory Listing)', () => {
assert.strictEqual(res.status, 200);
});

it('allows `/download`', async () => {
const res = await mf.dispatchFetch(`${url}download`);
it('redirects `/download` to `/download/`', async () => {
const originalRes = await mf.dispatchFetch(`${url}download`, {
redirect: 'manual',
});
assert.strictEqual(originalRes.status, 301);
const res = await mf.dispatchFetch(originalRes.headers.get('location')!);
assert.strictEqual(res.status, 200);
});

Expand All @@ -58,8 +63,12 @@ describe('Directory Tests (Restricted Directory Listing)', () => {
assert.strictEqual(res.status, 200);
});

it('allows `/docs`', async () => {
const res = await mf.dispatchFetch(`${url}docs`);
it('redirects `/docs` to `/docs/`', async () => {
const originalRes = await mf.dispatchFetch(`${url}docs`, {
redirect: 'manual',
});
assert.strictEqual(originalRes.status, 301);
const res = await mf.dispatchFetch(originalRes.headers.get('location')!);
assert.strictEqual(res.status, 200);
});

Expand All @@ -68,8 +77,12 @@ describe('Directory Tests (Restricted Directory Listing)', () => {
assert.strictEqual(res.status, 200);
});

it('allows `/api`', async () => {
const res = await mf.dispatchFetch(`${url}api`);
it('redirects `/api` to `/api/`', async () => {
const originalRes = await mf.dispatchFetch(`${url}api`, {
redirect: 'manual',
});
assert.strictEqual(originalRes.status, 301);
const res = await mf.dispatchFetch(originalRes.headers.get('location')!);
assert.strictEqual(res.status, 200);
});

Expand All @@ -78,8 +91,12 @@ describe('Directory Tests (Restricted Directory Listing)', () => {
assert.strictEqual(res.status, 200);
});

it('allows `/metrics`', async () => {
const res = await mf.dispatchFetch(`${url}metrics`);
it('redirects `/metrics` to `/metrics/`', async () => {
const originalRes = await mf.dispatchFetch(`${url}metrics`, {
redirect: 'manual',
});
assert.strictEqual(originalRes.status, 301);
const res = await mf.dispatchFetch(originalRes.headers.get('location')!);
assert.strictEqual(res.status, 200);
});

Expand All @@ -92,15 +109,15 @@ describe('Directory Tests (Restricted Directory Listing)', () => {
let res = await mf.dispatchFetch(url);
assert.strictEqual(res.status, 401);

res = await mf.dispatchFetch(`${url}/asd`);
res = await mf.dispatchFetch(`${url}/asd/`);
assert.strictEqual(res.status, 401);

res = await mf.dispatchFetch(`${url}/asd/123/`);
assert.strictEqual(res.status, 401);
});

it('returns 404 for unknown directory', async () => {
const res = await mf.dispatchFetch(`${url}/dist/asd123`);
const res = await mf.dispatchFetch(`${url}/dist/asd123/`);
assert.strictEqual(res.status, 404);

const body = await res.text();
Expand Down
4 changes: 2 additions & 2 deletions tests/e2e/test-data/expected-html/dist.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Index of /dist</title>
<title>Index of /dist/</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<style type="text/css">
Expand All @@ -24,7 +24,7 @@
</style>
</head>
<body>
<h1>Index of /dist</h1>
<h1>Index of /dist/</h1>
<table>
<tr><th>Filename</th><th>Modified</th><th>Size</th></tr>
<tr>
Expand Down