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.

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

feat: protect routes plugin #487

Merged
merged 3 commits into from
Sep 4, 2023
Merged

feat: protect routes plugin #487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1c36cd
feat: protect routes plugin
iuioiua Sep 4, 2023
61c465a
tweak
iuioiua Sep 4, 2023
842eea5
tweaks
iuioiua Sep 4, 2023
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
22 changes: 22 additions & 0 deletions e2e_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,28 @@ Deno.test("[e2e]", async (test) => {
assertEquals(resp.status, 303);
});

await test.step("GET /dashboard/stats", async () => {
const resp = await handler(
new Request("http://localhost/dashboard/stats"),
);

assertFalse(resp.ok);
assertFalse(resp.body);
assertEquals(resp.headers.get("location"), "/signin");
assertEquals(resp.status, 303);
});

await test.step("GET /dashboard/users", async () => {
const resp = await handler(
new Request("http://localhost/dashboard/users"),
);

assertFalse(resp.ok);
assertFalse(resp.body);
assertEquals(resp.headers.get("location"), "/signin");
assertEquals(resp.status, 303);
});

await test.step("GET /submit", async () => {
const resp = await handler(
new Request("http://localhost/submit"),
Expand Down
3 changes: 2 additions & 1 deletion fresh.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
import twindPlugin from "$fresh/plugins/twindv1.ts";
import twindConfig from "./twind.config.ts";
import kvOAuthPlugin from "./plugins/kv_oauth.ts";
import protectedRoutes from "./plugins/protected_routes.ts";
import { FreshOptions } from "$fresh/server.ts";

export default {
plugins: [twindPlugin(twindConfig), kvOAuthPlugin],
plugins: [kvOAuthPlugin, protectedRoutes, twindPlugin(twindConfig)],
} as FreshOptions;
118 changes: 54 additions & 64 deletions fresh.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,33 @@ import * as $0 from "./routes/_404.tsx";
import * as $1 from "./routes/_500.tsx";
import * as $2 from "./routes/_app.tsx";
import * as $3 from "./routes/_middleware.ts";
import * as $4 from "./routes/account/_middleware.ts";
import * as $5 from "./routes/account/index.tsx";
import * as $6 from "./routes/account/manage.ts";
import * as $7 from "./routes/account/upgrade.ts";
import * as $8 from "./routes/api/_middleware.ts";
import * as $9 from "./routes/api/items/[id]/comments.ts";
import * as $10 from "./routes/api/items/[id]/index.ts";
import * as $11 from "./routes/api/items/[id]/vote.ts";
import * as $12 from "./routes/api/items/index.ts";
import * as $13 from "./routes/api/me/_middleware.ts";
import * as $14 from "./routes/api/me/notifications.ts";
import * as $15 from "./routes/api/me/votes.ts";
import * as $16 from "./routes/api/stripe-webhooks.ts";
import * as $17 from "./routes/api/users/[login]/index.ts";
import * as $18 from "./routes/api/users/[login]/items.ts";
import * as $19 from "./routes/api/users/index.ts";
import * as $20 from "./routes/blog/[slug].tsx";
import * as $21 from "./routes/blog/index.tsx";
import * as $22 from "./routes/dashboard/_middleware.ts";
import * as $23 from "./routes/dashboard/index.tsx";
import * as $24 from "./routes/dashboard/stats.tsx";
import * as $25 from "./routes/dashboard/users.tsx";
import * as $26 from "./routes/feed.ts";
import * as $27 from "./routes/index.tsx";
import * as $28 from "./routes/items/[id].tsx";
import * as $29 from "./routes/notifications/[id].ts";
import * as $30 from "./routes/notifications/_middleware.ts";
import * as $31 from "./routes/notifications/index.tsx";
import * as $32 from "./routes/pricing.tsx";
import * as $33 from "./routes/submit/_middleware.tsx";
import * as $34 from "./routes/submit/index.tsx";
import * as $35 from "./routes/users/[login].tsx";
import * as $4 from "./routes/account/index.tsx";
import * as $5 from "./routes/account/manage.ts";
import * as $6 from "./routes/account/upgrade.ts";
import * as $7 from "./routes/api/_middleware.ts";
import * as $8 from "./routes/api/items/[id]/comments.ts";
import * as $9 from "./routes/api/items/[id]/index.ts";
import * as $10 from "./routes/api/items/[id]/vote.ts";
import * as $11 from "./routes/api/items/index.ts";
import * as $12 from "./routes/api/me/notifications.ts";
import * as $13 from "./routes/api/me/votes.ts";
import * as $14 from "./routes/api/stripe-webhooks.ts";
import * as $15 from "./routes/api/users/[login]/index.ts";
import * as $16 from "./routes/api/users/[login]/items.ts";
import * as $17 from "./routes/api/users/index.ts";
import * as $18 from "./routes/blog/[slug].tsx";
import * as $19 from "./routes/blog/index.tsx";
import * as $20 from "./routes/dashboard/index.tsx";
import * as $21 from "./routes/dashboard/stats.tsx";
import * as $22 from "./routes/dashboard/users.tsx";
import * as $23 from "./routes/feed.ts";
import * as $24 from "./routes/index.tsx";
import * as $25 from "./routes/items/[id].tsx";
import * as $26 from "./routes/notifications/[id].ts";
import * as $27 from "./routes/notifications/index.tsx";
import * as $28 from "./routes/pricing.tsx";
import * as $29 from "./routes/submit.tsx";
import * as $30 from "./routes/users/[login].tsx";
import * as $$0 from "./islands/Chart.tsx";
import * as $$1 from "./islands/CommentsList.tsx";
import * as $$2 from "./islands/ItemsList.tsx";
Expand All @@ -51,38 +46,33 @@ const manifest = {
"./routes/_500.tsx": $1,
"./routes/_app.tsx": $2,
"./routes/_middleware.ts": $3,
"./routes/account/_middleware.ts": $4,
"./routes/account/index.tsx": $5,
"./routes/account/manage.ts": $6,
"./routes/account/upgrade.ts": $7,
"./routes/api/_middleware.ts": $8,
"./routes/api/items/[id]/comments.ts": $9,
"./routes/api/items/[id]/index.ts": $10,
"./routes/api/items/[id]/vote.ts": $11,
"./routes/api/items/index.ts": $12,
"./routes/api/me/_middleware.ts": $13,
"./routes/api/me/notifications.ts": $14,
"./routes/api/me/votes.ts": $15,
"./routes/api/stripe-webhooks.ts": $16,
"./routes/api/users/[login]/index.ts": $17,
"./routes/api/users/[login]/items.ts": $18,
"./routes/api/users/index.ts": $19,
"./routes/blog/[slug].tsx": $20,
"./routes/blog/index.tsx": $21,
"./routes/dashboard/_middleware.ts": $22,
"./routes/dashboard/index.tsx": $23,
"./routes/dashboard/stats.tsx": $24,
"./routes/dashboard/users.tsx": $25,
"./routes/feed.ts": $26,
"./routes/index.tsx": $27,
"./routes/items/[id].tsx": $28,
"./routes/notifications/[id].ts": $29,
"./routes/notifications/_middleware.ts": $30,
"./routes/notifications/index.tsx": $31,
"./routes/pricing.tsx": $32,
"./routes/submit/_middleware.tsx": $33,
"./routes/submit/index.tsx": $34,
"./routes/users/[login].tsx": $35,
"./routes/account/index.tsx": $4,
"./routes/account/manage.ts": $5,
"./routes/account/upgrade.ts": $6,
"./routes/api/_middleware.ts": $7,
"./routes/api/items/[id]/comments.ts": $8,
"./routes/api/items/[id]/index.ts": $9,
"./routes/api/items/[id]/vote.ts": $10,
"./routes/api/items/index.ts": $11,
"./routes/api/me/notifications.ts": $12,
"./routes/api/me/votes.ts": $13,
"./routes/api/stripe-webhooks.ts": $14,
"./routes/api/users/[login]/index.ts": $15,
"./routes/api/users/[login]/items.ts": $16,
"./routes/api/users/index.ts": $17,
"./routes/blog/[slug].tsx": $18,
"./routes/blog/index.tsx": $19,
"./routes/dashboard/index.tsx": $20,
"./routes/dashboard/stats.tsx": $21,
"./routes/dashboard/users.tsx": $22,
"./routes/feed.ts": $23,
"./routes/index.tsx": $24,
"./routes/items/[id].tsx": $25,
"./routes/notifications/[id].ts": $26,
"./routes/notifications/index.tsx": $27,
"./routes/pricing.tsx": $28,
"./routes/submit.tsx": $29,
"./routes/users/[login].tsx": $30,
},
islands: {
"./islands/Chart.tsx": $$0,
Expand Down
54 changes: 54 additions & 0 deletions plugins/protected_routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Copyright 2023 the Deno authors. All rights reserved. MIT license.
import { Plugin } from "$fresh/server.ts";
import { ensureSignedIn, type State } from "@/middleware/session.ts";

/**
* Adds middleware to the defined routes that ensures the client is signed-in
* before proceeding. The {@linkcode ensureSignedIn} middleware throws an error
* equivalent to the
* {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401|HTTP 401 Unauthorized}
* error if `ctx.state.sessionUser` is `undefined`.
*
* The thrown error is then handled by {@linkcode handleNotSignedInWebpage}, or
* {@linkcode handleNotSignedInRest}, if the request is made to a REST API
* endpoint.
*
* @example
* ```ts
* import { FreshOptions } from "$fresh/server.ts";
* import protectedRoutes from "@/plugins/protected_routes.ts";
*
* const options: FreshOptions = {
* plugins: [protectedRoutes]
* }
* ```
*
* @see {@link https://fresh.deno.dev/docs/concepts/plugins|Plugins documentation}
* for more information on Fresh's plugin functionality.
*/
const middleware = { handler: ensureSignedIn };
export default {
name: "protected-routes",
middlewares: [
{
path: "/account",
middleware,
},
{
path: "/dashboard",
middleware,
},
{
path: "/notifications",
middleware,
},
{
path: "/submit",
middleware,
},
{
path: "/api/me",
middleware,
},
],
} as Plugin<State>;
2 changes: 0 additions & 2 deletions routes/account/_middleware.ts
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions routes/api/me/_middleware.ts
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions routes/dashboard/_middleware.ts
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions routes/notifications/_middleware.ts
View file
Open in desktop

This file was deleted.

0 routes/submit/index.tsx → routes/submit.tsx
View file
Open in desktop
File renamed without changes.
2 changes: 0 additions & 2 deletions routes/submit/_middleware.tsx
View file
Open in desktop

This file was deleted.