Prisma と Lucia を使った認証システム のバックアップ差分(No.3)
更新- 追加された行はこの色です。
- 削除された行はこの色です。
[[プログラミング/svelte]]
* Prisma と Lucia を使った認証システムを作ってみる [#a42dca10]
SvelteKit+Superforms+Prisma+Luciaでログイン機能を爆速で実装する~
https://zenn.dev/gawarago/articles/f75f5113a3803d
を参考に以下を使ったサイトを作る基本を身に着けたいなと。
- Svelte
- SvelteKit
- SuperForms : フォームバリデーション
- Prisma : データベースアクセス
- Lucia : 認証ライブラリ
- sveltekit-flash-message : flash メッセージの管理
- svelte-french-toast : flash メッセージ（など）を一定時間だけ表示する
* 目次 [#qd1194e2]
#contents
* スケルトンプロジェクトを作成 [#m0ce9b51]
LANG:console
$ pnpm create svelte@latest authtest
.../Local/pnpm/store/v3/tmp/dlx-30292 | +6 +
Packages are hard linked from the content-addressable store to the virtual store.
Content-addressable store is at: C:\Users\osamu\AppData\Local\pnpm\store\v3
Virtual store is at: ../../AppData/Local/pnpm/store/v3/tmp/dlx-30292/node_modules/.pnpm
.../Local/pnpm/store/v3/tmp/dlx-30292 | Progress: resolved 6, reused 5, downloaded 1, added 6, done
create-svelte version 5.3.2
┌ Welcome to SvelteKit!
│
◇ Which Svelte app template?
│ Skeleton project
│
◇ Add type checking with TypeScript?
│ Yes, using TypeScript syntax
│
◇ Select additional options (use arrow keys/space bar)
│ Add ESLint for code linting, Add Prettier for code formatting, Add Playwright for browser testing, Add Vitest for unit testing
│
└ Your project is ready!
✔ Typescript
Inside Svelte components, use <script lang="ts">
✔ ESLint
https://github.com/sveltejs/eslint-plugin-svelte
✔ Prettier
https://prettier.io/docs/en/options.html
https://github.com/sveltejs/prettier-plugin-svelte#options
✔ Playwright
https://playwright.dev
✔ Vitest
https://vitest.dev
Install community-maintained integrations:
https://github.com/svelte-add/svelte-add
Next steps:
1: cd authtest
2: pnpm install
3: git init && git add -A && git commit -m "Initial commit" (optional)
4: pnpm run dev -- --open
To close the dev server, hit Ctrl-C
Stuck? Visit us at https://svelte.dev/chat
そして指示の通りに、
LANG: console
$ cd authtest
$ pnpm install
WARN deprecated @playwright/test@1.28.1: Please update to the latest version of Playwright to test up-to-date browsers.
Packages: +271
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Packages are hard linked from the content-addressable store to the virtual store.
Content-addressable store is at: C:\Users\osamu\AppData\Local\pnpm\store\v3
Virtual store is at: node_modules/.pnpm
Progress: resolved 293, reused 271, downloaded 0, added 271, done
node_modules/.pnpm/@sveltejs+kit@1.27.4_svelte@4.2.7_vite@4.4.2/node_modules/@sveltejs/kit: Running postinstall script, done in 3.9s
devDependencies:
+ @playwright/test 1.28.1 (1.40.0 is available) deprecated
+ @sveltejs/adapter-auto 2.0.0 (2.1.1 is available)
+ @sveltejs/kit 1.27.4 (1.27.6 is available)
+ @typescript-eslint/eslint-plugin 6.0.0 (6.13.1 is available)
+ @typescript-eslint/parser 6.0.0 (6.13.1 is available)
+ eslint 8.28.0 (8.54.0 is available)
+ eslint-config-prettier 9.0.0
+ eslint-plugin-svelte 2.30.0 (2.35.1 is available)
+ prettier 3.0.0 (3.1.0 is available)
+ prettier-plugin-svelte 3.0.0 (3.1.2 is available)
+ svelte 4.2.7
+ svelte-check 3.6.0 (3.6.2 is available)
+ tslib 2.4.1 (2.6.2 is available)
+ typescript 5.0.2 (5.3.2 is available)
+ vite 4.4.2 (5.0.2 is available)
+ vitest 0.32.2 (0.34.6 is available)
Done in 14.3s
$ git init && git add -A && git commit -m "Initial commit"
Initialized empty Git repository in C:/Users/osamu/Desktop/svelte/authtest/.git/
[master (root-commit) 7646d52] Initial commit
20 files changed, 2588 insertions(+)
create mode 100644 .eslintignore
create mode 100644 .eslintrc.cjs
create mode 100644 .gitignore
create mode 100644 .npmrc
create mode 100644 .prettierignore
create mode 100644 .prettierrc
create mode 100644 README.md
create mode 100644 package.json
create mode 100644 playwright.config.ts
create mode 100644 pnpm-lock.yaml
create mode 100644 src/app.d.ts
create mode 100644 src/app.html
create mode 100644 src/index.test.ts
create mode 100644 src/lib/index.ts
create mode 100644 src/routes/+page.svelte
create mode 100644 static/favicon.png
create mode 100644 svelte.config.js
create mode 100644 tests/test.ts
create mode 100644 tsconfig.json
create mode 100644 vite.config.ts
$ pnpm dev
> authtest@0.0.1 dev C:\Users\osamu\Desktop\svelte\authtest
> vite dev
Forced re-optimization of dependencies
VITE v4.4.2 ready in 1947 ms
➜ Local: http://localhost:5173/
➜ Network: use --host to expose
➜ press h to show help
キーボードで "o" を押すとブラウザが立ち上がって
http://localhost:5173/ に Welcome to SvelteKit が表示された。
* コンポーネントのアップデート [#edcf90fe]
インストール時にいろいろ古いと言われていたのでアップデートする。
LANG: console
^C
ELIFECYCLE Command failed with exit code 1.
として pnpm dev を抜けてから、
LANG: console
$ pnpm update
Packages: +48 -56
++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------------------------
Progress: resolved 286, reused 263, downloaded 0, added 48, done
node_modules/.pnpm/@sveltejs+kit@1.27.6_svelte@4.2.7_vite@4.5.0/node_modules/@sveltejs/kit: Running postinstall script, done in 4.1s
devDependencies:
- @playwright/test 1.28.1
+ @playwright/test 1.40.0
- @sveltejs/adapter-auto 2.0.0
+ @sveltejs/adapter-auto 2.1.1
- @sveltejs/kit 1.27.4
+ @sveltejs/kit 1.27.6
- @typescript-eslint/eslint-plugin 6.0.0
+ @typescript-eslint/eslint-plugin 6.13.1
- @typescript-eslint/parser 6.0.0
+ @typescript-eslint/parser 6.13.1
- eslint 8.28.0
+ eslint 8.54.0
- eslint-plugin-svelte 2.30.0
+ eslint-plugin-svelte 2.35.1
- prettier 3.0.0
+ prettier 3.1.0
- prettier-plugin-svelte 3.0.0
+ prettier-plugin-svelte 3.1.2
- svelte-check 3.6.0
+ svelte-check 3.6.2
- tslib 2.4.1
+ tslib 2.6.2
- typescript 5.0.2
+ typescript 5.3.2
- vite 4.4.2
+ vite 4.5.0 (5.0.2 is available)
- vitest 0.32.2
+ vitest 0.32.4 (0.34.6 is available)
Done in 14.5s
さらに新しいものがあると言っているのはなぜなのか？
LANG: console
$ pnpm update
Already up to date
Progress: resolved 286, reused 263, downloaded 0, added 0, done
Done in 5.8s
https://github.com/sveltejs/kit/issues/11062
とかあるし、新しすぎて他とバッティングするということなのかな？
とりあえず今はこれで。
LANG: console
$ git add .
$ git status
On branch master
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
modified: package.json
modified: pnpm-lock.yaml
$ git commit -m "pnpm update"
[master 3621e0b] pnpm update
2 files changed, 267 insertions(+), 302 deletions(-)
再度開発用サーバーを起動しておく。
LANG: console
$ pnpm dev
* prettier を通して commit する [#x915c457]
既存のソースを prettier に通す前に設定を変更
.prettierrc
LANG: js
{
- "useTabs": true,
+ "useTabs": false,
"singleQuote": true,
- "trailingComma": "none",
+ "trailingComma": "es5",
"printWidth": 100,
"plugins": ["prettier-plugin-svelte"],
"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
}
pnpm format で通せる
LANG:console
$ pnpm format
> authtest@0.0.1 format C:\Users\osamu\Desktop\svelte\authtest
> prettier --write .
.eslintrc.cjs 70ms
.prettierrc 26ms
package.json 3ms
playwright.config.ts 170ms
README.md 35ms (unchanged)
src/app.d.ts 5ms
src/app.html 55ms
src/index.test.ts 12ms
src/lib/index.ts 2ms (unchanged)
src/routes/+page.svelte 136ms (unchanged)
svelte.config.js 14ms
tests/test.ts 12ms
tsconfig.json 8ms
vite.config.ts 8ms
$ git add .
$ git status
On branch master
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
modified: .eslintrc.cjs
modified: .prettierrc
modified: package.json
modified: playwright.config.ts
modified: src/app.d.ts
modified: src/app.html
modified: src/index.test.ts
modified: svelte.config.js
modified: tests/test.ts
modified: tsconfig.json
modified: vite.config.ts
$ git commit -m "prettier を通した"
* コミット時に自動的に prettier を通すよう設定 [#ae385321]
add されたファイルに対してコミット直前に prettier を通すよう設定する
https://prettier.io/docs/en/precommit.html#option-5-shell-script に従って、
LANG: console
$ cat > .git/hooks/pre-commit
#!/bin/sh
FILES=$(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g')
[ -z "$FILES" ] && exit 0
# Prettify all selected files
echo "$FILES" | xargs ./node_modules/.bin/prettier --ignore-unknown --write
# Add back the modified/prettified files to staging
echo "$FILES" | xargs git add
exit 0
^D
$ chmod u+x .git/hooks/pre-commit
* サインアップフォームを作成 [#v0f7cb3f]
src/routes/account/new/+page.svelte
LANG: html
<div>
<h1>サインアップ</h1>
<form method="POST">
<label for="name">ユーザー名</label>
<input type="text" name="name" />
<label for="email">メールアドレス</label>
<input type="text" name="email" />
<label for="password">パスワード</label>
<input type="password" name="password" />
<label for="confirmPassword">パスワード（確認）</label>
<input type="password" name="confirm"/>
<div><button>サインアップ</button></div>
</form>
</div>
<style>
input {
display: block;
margin-bottom: 10px;
}
</style>
http://localhost:5173/signup でフォームを表示可能なことを確認
#ref(signup.png);
POST に対応する Action を書いていないため「サインアップ」を押すと
405
POST method not allowed. No actions exist for this page
になることを確認。
src/routes/account/new/+page.server.ts
LANG: ts
import type { Actions } from './$types';
import { fail } from '@sveltejs/kit';
export const actions: Actions = {
default: async () => {
return fail(400, {message: 'サインアップ処理が未実装'})
}
};
これで「ログイン」を押してもエラーは出なくなった一方、エラーメッセージも表示されない。
src/routes/account/new/+page.svelte の冒頭と末尾を下記のように変更
LANG: html
<script lang="ts">
import type { ActionData } from './$types';
export let data: ActionData;
</script>
<div>
<h1>サインアップ</h1>
{#if data?.message}<span class="invalid">{data.message}</span>{/if}
...
</div>
<style>
...
.invalid {
color: red;
}
</style>
これでエラーメッセージが表示されるようになった。
LANG: console
$ git add .
$ git commit -m "/account/new ページを作成"
src/routes/account/new/+page.server.ts 218ms (unchanged)
src/routes/account/new/+page.svelte 433ms (unchanged)
[master 779169b] C:/Program Files/Git/account/new ページを作成
2 files changed, 44 insertions(+)
create mode 100644 src/routes/account/new/+page.server.ts
create mode 100644 src/routes/account/new/+page.svelte
ちゃんと prettier が走っている。
すばらしい。
* 入力内容の validation を行うために SuperForms を入れる [#o1950c2d]
LANG:console
$ pnpm add -D sveltekit-superforms zod
Packages: +2
++
Progress: resolved 288, reused 264, downloaded 1, added 2, done
devDependencies:
+ sveltekit-superforms 1.11.0
+ zod 3.22.4
Done in 3.3s
$ git add .
$ git commit -m "superforms を追加"
package.json 37ms (unchanged)
[master ed1163c] superforms を追加
2 files changed, 25 insertions(+), 1 deletion(-)
** サインアップフォーム用のスキーマを追加 [#ud9711bc]
src/lib/zod/account/new.ts
LANG:ts
import { z } from 'zod';
// メールアドレスを表す現実的な正規表現 by @sakuro
// https://qiita.com/sakuro/items/1eaa307609ceaaf51123
const emailRegexp = /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/;
export const schema = z
.object({
name: z.string().min(3, { message: 'ユーザー名は3文字以上で入力してください' }),
email: z.string().regex(emailRegexp, { message: 'メールアドレスが不正です' }),
password: z
.string()
.regex(/^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9]).{8,}$/, {
message: 'パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください'
}),
confirm: z.string(),
})
.refine((data) => data.password === data.confirm, {
message: '確認用パスワードが一致しません',
path: ['confirm']
});
** バリデーションを行う [#c81e3fa9]
src/routes/account/new/+page.server.ts
LANG:ts
import type { Actions, PageServerLoad } from './$types';
import { schema } from '$lib/zod/account/new';
import { superValidate } from 'sveltekit-superforms/server';
import { fail } from '@sveltejs/kit';
export const load = (async () => {
const form = await superValidate(schema);
return { form };
}) satisfies PageServerLoad;
export const actions: Actions = {
default: async (event) => {
// フォームデータのバリデーション
const form = await superValidate(event, schema);
if (!form.valid) {
return fail(400, { form });
}
// TODO: サインアップ処理をここに
return { form };
}
};
** エラーメッセージを表示するためのフィールドを用意する [#vd7d8e82]
src/routes/account/new/+page.svelte
LANG:html
<script lang="ts">
import type { PageData } from './$types';
import { superForm } from 'sveltekit-superforms/client';
export let data: PageData;
const { form, message, errors, submitting, capture, restore, enhance } =
superForm(data.form, { taintedMessage: false});
export const snapshot = { capture, restore };
</script>
<div>
<h1>サインアップ</h1>
{#if $message}<span class="invalid">{$message}</span>{/if}
<form method="POST" use:enhance>
<label for="name">ユーザー名</label>
<input type="text" name="name" bind:value={$form.name} disabled={$submitting} />
{#if $errors.name}<span class="invalid">{$errors.name}</span>{/if}
<label for="password">パスワード</label>
<input type="password" name="password" bind:value={$form.password} disabled={$submitting} />
{#if $errors.password}<span class="invalid">{$errors.password}</span>{/if}
<label for="confirm">パスワード（確認）</label>
<input type="password" name="confirm" bind:value={$form.confirm} disabled={$submitting} />
{#if $errors.confirm}<span class="invalid">{$errors.confirm}</span>{/if}
<div><button disabled={$submitting}>サインアップ</button></div>
</form>
</div>
<style>
input {
display: block;
margin-bottom: 10px;
}
.invalid {
display: block;
color: red;
}
</style>
これで正しくエラーが検出されるようになった。
#ref(signup-error.png);
LANG: console
$ git add . && git commit -m "account/new にバリデーションを追加"
src/lib/zod/account/new.ts 259ms
src/routes/account/new/+page.server.ts 25ms
src/routes/account/new/+page.svelte 429ms
[master 1a89e62] account/new にバリデーションを追加
3 files changed, 58 insertions(+), 15 deletions(-)
create mode 100644 src/lib/zod/account/new.ts
* Prisma の導入 [#qcf227f1]
https://www.prisma.io/docs/getting-started/quickstart に従って
さしあたり `sqlite` を使うよう初期化
LANG:console
$ pnpm add -D prisma && pnpm add @prisma/client
Packages: +2
++
Progress: resolved 290, reused 267, downloaded 0, added 2, done
devDependencies:
+ prisma 5.6.0
Done in 4.5s
Packages: +2
++
Progress: resolved 292, reused 269, downloaded 0, added 2, done
dependencies:
+ @prisma/client 5.6.0
Done in 5.3s
$ npx prisma init --datasource-provider sqlite
✔ Your Prisma schema was created at prisma/schema.prisma
You can now open it in your favorite editor.
warn You already have a .gitignore file. Don't forget to add `.env` in it to not commit any private information.
Next steps:
1. Set the DATABASE_URL in the .env file to point to your existing database. If your database has no tables yet, read https://pris.ly/d/getting-started
2. Run prisma db pull to turn your database schema into a Prisma schema.
3. Run prisma generate to generate the Prisma Client. You can then start querying your database.
More information in our documentation:
https://pris.ly/d/getting-started
$ cat .env
...
DATABASE_URL="file:./dev.db"
データベースは `(app)/prisma/dev.db` に作成される。
コミットされないよう .gitignore に追加しておく
LANG: console
$ echo "/prisma/*.db" >> .gitignore
$ echo "/prisma/*.db-journal" >> .gitignore
$ git add . && git commit -m "Prisma をインストールした"
** Lucia に対応したテーブルを定義 [#a634da69]
https://lucia-auth.com/database-adapters/prisma/#prisma-schema あたりを参考に：
prisma/schema.prisma
...
model User {
id String @id @unique
sessions Session[]
keys AuthKey[]
name String @unique
email String @unique
}
model Session {
id String @id @unique
user_id String
active_expires BigInt
idle_expires BigInt
user User @relation(references: [id], fields: [user_id], onDelete: Cascade)
@@index([user_id])
}
model AuthKey {
id String @id @unique
hashed_password String?
user_id String
user User @relation(references: [id], fields: [user_id], onDelete: Cascade)
@@index([user_id])
}
** migrate する [#zcaba667]
LANG: console
$ pnpm prisma migrate dev --name "add tables for lucia"
Environment variables loaded from .env
Prisma schema loaded from prisma\schema.prisma
Datasource "db": SQLite database "dev.db" at "file:./dev.db"
SQLite database dev.db created at file:./dev.db
Applying migration `20231128121010_add_tables_for_lucia`
The following migration(s) have been created and applied from new schema changes:
migrations/
└─ 20231128121010_add_tables_for_lucia/
└─ migration.sql
Your database is now in sync with your schema.
✔ Generated Prisma Client (v5.6.0) to .\node_modules\.pnpm\@prisma+client@5.6.0_prisma@5.6.0\node_modules\@prisma\client in 154ms
** ライブラリに追加 [#u2aec515]
サーバー上でしか使わないので lib/server の下に置く
src/lib/server/db.ts
LANG: ts
import { PrismaClient } from '@prisma/client';
export const db = new PrismaClient();
コミットしておく
LANG: console
$ git add . && git commit -m "Lucia 用のテーブルを準備"
src/lib/server/db.ts 169ms
[master 184f947] Lucia 用のテーブルを準備
5 files changed, 79 insertions(+)
create mode 100644 prisma/migrations/20231128121010_add_tables_for_lucia/migration.sql
create mode 100644 prisma/migrations/migration_lock.toml
create mode 100644 src/lib/server/db.ts
* Lucia を導入 [#p8368e9f]
Lucia は認証やセッション管理を行うライブラリ。
https://lucia-auth.com/getting-started/sveltekit/ を見ながら v2 を使う
LANG: console
$ pnpm add lucia @lucia-auth/adapter-prisma
Packages: +2
++
Progress: resolved 294, reused 271, downloaded 0, added 2, done
dependencies:
+ @lucia-auth/adapter-prisma 3.0.2
+ lucia 2.7.4
Done in 3s
** Lucia の初期化 [#qe9c6371]
テーブルの対応や User テーブルに追加した追加の属性をライブラリに教える。
src/lib/server/lucia.ts
LANG: ts
import { lucia } from "lucia";
import { sveltekit } from "lucia/middleware";
import { dev } from "$app/environment";
import { prisma } from "@lucia-auth/adapter-prisma";
import { db } from "$lib/server/db";
export const auth = lucia({
env: dev ? "DEV" : "PROD",
middleware: sveltekit(),
adapter: prisma(db, {
user: "user",
key: "authKey",
session: "session"
}),
getUserAttributes: (data) => {
return {
// IMPORTANT!!!!
// `userId` included by default!!
id: data.id,
name: data.name,
email: data.email
};
},
});
export type Auth = typeof auth;
** locals.auth と locals.session を追加 [#gb60f175]
User および Session に追加したフィールドの型定義を与えるとともに、
locals.auth に認証情報を持てるようにする
src/app.d.ts
LANG: ts
// See https://kit.svelte.dev/docs/types#app
// for information about these interfaces
declare global {
declare namespace Lucia {
type Auth = import('$lib/server/lucia').Auth;
type DatabaseUserAttributes = {name: string, email: string};
type DatabaseSessionAttributes = object;
}
namespace App {
// interface Error {}
interface Locals {
auth: import('lucia').AuthRequest;
session: import('lucia').Session | null;
}
// interface PageData {}
// interface Platform {}
}
}
export {};
** hook で認証情報を読み込む [#m4cb4b20]
https://lucia-auth.com/basics/handle-requests/#sveltekit の通り、
hooks で event から認証情報を得て locals.auth へ入れる。
src/hooks.server.ts
LANG: ts
import { auth } from '$lib/server/lucia';
import type { Handle } from '@sveltejs/kit';
import { sequence } from '@sveltejs/kit/hooks';
const authHandler: Handle = async ({ event, resolve }) => {
event.locals.auth = auth.handleRequest(event);
event.locals.session = await event.locals.auth.validate();
return await resolve(event);
};
export const handle = sequence(authHandler);
** サインアップ処理 [#jb708cb7]
Lucia v2 では createUser にて primaryKey の代わりに key とする。
src/lib/index.ts
src/lib/server/index.ts
LANG: ts
// place files you want to import through the `$lib` alias in this folder.
export const urlRoot = process.env["URL_ROOT"] || '/';
export function path(relative: string) {
return urlRoot + relative;
}
src/routes/account/new/+page.server.ts
LANG: ts
// 冒頭に追加
import { fail, redirect } from '@sveltejs/kit';
import { auth } from '$lib/server/lucia';
import { LuciaError } from 'lucia';
import { path } from '$lib';
import { path } from '$lib/server';
...
// サインアップ処理
try {
const user = await auth.createUser({
key: {
providerId: 'email',
providerUserId: form.data.email,
password: form.data.password
},
attributes: {
name: form.data.name,
email: form.data.email,
}
});
// そのままログイン状態にする
const session = await auth.createSession({userId: user.userId, attributes: {}});
event.locals.auth.setSession(session);
} catch (e) {
if (e instanceof LuciaError && e.message === `AUTH_DUPLICATE_KEY_ID`) {
return fail(400, { form: { ...form, message: '名前またはメールアドレスが既存のアカウントと重複しています' } });
}
// provided user attributes violates database rules (e.g. unique constraint)
// or unexpected database errors
return fail(400, { form: { ...form, message: 'サインアップエラー' } });
}
throw redirect(302, path('/'));
},
};
これでサインアップできるようになった。
ここではそのままログイン状態にしてしまっている。
*** データベースを確認 [#v8c34fa4]
テスト用にサインアップをしてみた後、
LANG: console
$ pnpm prisma studio
とすると Prisma Studio が立ち上がるので、AuthUser テーブルや AuthKey テーブルに正しく情報が登録していることを確認する。
*** ログイン状態を確認 [#k63bf4ed]
上記のコードではサインアップと同時にログインしているので、
hooks により locals.session にログイン情報が入っているはず。
そこで、トップページでログイン情報を参照してみることにする。
src/routes/+page.server.ts
LANG: ts
import type { PageServerLoad } from "./$types";
export const load: PageServerLoad = async ({locals}) => {
return {user: locals.session?.user}
}
session.user に格納されるログインユーザーの情報をページに渡す。
ページ側でそれを受け取って、
src/routes/+page.svelte
LANG: html
<script lang="ts">
import type { PageData } from './$types';
export let data: PageData;
</script>
<h1>Welcome to SvelteKit</h1>
<p>Visit <a href="https://kit.svelte.dev">kit.svelte.dev</a> to read the documentation</p>
{#if data.user}
<p>Hello { data.user.name } !!</p>
{/if}
とすれば、ログインしている場合に "Hello (ユーザー名) !!" と表示されるはずで・・・
試したところうまく行ってるようだった。
** ログアウト処理 [#rbc8d465]
locals.auth の持つ validate() 結果 (session 情報) の内部キャッシュを無効化し、
それを参照するクッキーも削除する。
src/routes/session/delete/+server.ts
LANG: ts
import { redirect } from '@sveltejs/kit';
import type { RequestHandler } from './$types';
import { path } from '$lib';
import { path } from '$lib/server';
export const GET: RequestHandler = async ({ locals }) => {
// 読み出し済みセッション情報の無効化
locals.auth.invalidate();
// クッキーからセッションID削除
locals.auth.setSession(null);
throw redirect(302, path('/'));
};
画面表示が必要ないので +server.ts とする。
これで確かにログアウトできた。
locals.auth は読み出し済みのセッション情報のキャッシュを消すだけで
データベース上のセッションレコードは消さないみたいなのだけれどそれでいいのかしら？？？
** ログイン処理 [#lda79f99]
フォームのバリデーション
メールアドレスやパスワードが正しいかどうかはログイン処理で確認するので
ここでは１文字でも入力されていれば良いことにする。
src/lib/zod/session/new.ts
LANG: ts
import { z } from 'zod';
export const schema = z
.object({
email: z.string().min(1, 'メールアドレスを入力して下さい'),
password: z.string().min(1, 'パスワードを入力して下さい'),
});
ログインフォーム
src/routes/session/new/+page.svelte
LANG: html
<script lang="ts">
import type { PageData } from './$types';
import { superForm } from 'sveltekit-superforms/client';
export let data: PageData;
const { form, message, errors, submitting, capture, restore, enhance }
= superForm(data.form, {taintedMessage: false});
export const snapshot = { capture, restore };
</script>
<div>
<h1>ログイン</h1>
{#if $message}<span class="invalid">{$message}</span>{/if}
<form method="POST" use:enhance>
<label for="email">ユーザー名</label>
<input type="text" name="email" bind:value={$form.email} disabled={$submitting} />
{#if $errors.email}<span class="invalid">{$errors.email[0]}</span>{/if}
<label for="password">パスワード</label>
<input type="password" name="password" bind:value={$form.password} disabled={$submitting} />
{#if $errors.password}<span class="invalid">{$errors.password[0]}</span>{/if}
<div><button disabled={$submitting}>ログイン</button></div>
</form>
</div>
<style>
input {
display: block;
margin-bottom: 10px;
}
.invalid {
display: block;
color: red;
}
</style>
ログイン処理
src/routes/session/new/+page.server.ts
LANG: ts
import type { Actions, PageServerLoad } from './$types';
import { schema } from '$lib/zod/session/new';
import { superValidate } from 'sveltekit-superforms/server';
import { fail, redirect } from '@sveltejs/kit';
import { path } from '$lib';
import { path } from '$lib/server';
import { auth } from '$lib/server/lucia';
export const load = (async () => {
const form = await superValidate(schema);
return { form };
}) satisfies PageServerLoad;
export const actions: Actions = {
default: async (event) => {
// フォームデータのバリデーション
const form = await superValidate(event, schema);
if (!form.valid) {
return fail(400, { form });
}
// ログイン処理
try {
const key = await auth.useKey('email', form.data.email, form.data.password);
const session = await auth.createSession({userId: key.userId, attributes: {}});
event.locals.auth.setSession(session);
} catch {
return fail(400, { form: { ...form, message: 'ログインエラー' } });
}
throw redirect(302, path('/'));
}
};
ログインもできるようになった
LANG: console
$ git add . && git commit -m "サインイン・ログイン・ログアウトができるようになった"
package.json 124ms (unchanged)
src/app.d.ts 298ms
src/hooks.server.ts 18ms
src/lib/index.ts 8ms
src/lib/server/lucia.ts 12ms
src/lib/zod/session/new.ts 14ms
src/routes/+page.server.ts 5ms
src/routes/+page.svelte 167ms
src/routes/account/new/+page.server.ts 44ms
src/routes/session/delete/+server.ts 10ms
src/routes/session/new/+page.server.ts 21ms
src/routes/session/new/+page.svelte 112ms
[master 902570e] サインイン・ログイン・ログアウトができるようになった
13 files changed, 208 insertions(+), 5 deletions(-)
create mode 100644 src/hooks.server.ts
create mode 100644 src/lib/server/lucia.ts
create mode 100644 src/lib/zod/session/new.ts
create mode 100644 src/routes/+page.server.ts
create mode 100644 src/routes/session/delete/+server.ts
create mode 100644 src/routes/session/new/+page.server.ts
create mode 100644 src/routes/session/new/+page.svelte
* ログインあり・なしで閲覧制限する [#l79649c5]
route に (loggedIn) や (loggedOut) があれば、
ログインしている／していないときしかアクセスを許さないようにする。
src/hooks.server.ts
LANG: ts
import { auth } from '$lib/server/lucia';
* import { redirect, type Handle } from '@sveltejs/kit';
import { sequence } from '@sveltejs/kit/hooks';
+ import { path } from '$lib';
+ import { path } from '$lib/server';
const authHandler: Handle = async ({ event, resolve }) => {
event.locals.auth = auth.handleRequest(event);
event.locals.session = await event.locals.auth.validate();
+ if (event.route.id?.match(/\/\(login\)\//) && !event.locals.session?.user) {
+ throw redirect(302, path('/session/new'));
+ }
+
+ if (event.route.id?.match(/\/\(logout\)\//) && event.locals.session?.user) {
+ throw redirect(302, path('/'));
+ }
+
return await resolve(event);
};
export const handle = sequence(authHandler);
** ページに適用する [#h0373366]
routes を変更してアクセス制限を掛ける
- /account/new を /account/(logout)/new
- /session/new を /session/(logout)/new
- /session/delete を /session/(login)/delete
LANG: console
$ mkdir src/routes/account/\(logout\)
$ git mv src/routes/account/new src/routes/account/\(logout\)/new
$ mkdir src/routes/session/\(logout\)
$ git mv src/routes/session/new src/routes/session/\(logout\)/new
$ mkdir src/routes/session/\(login\)
$ git mv src/routes/session/delete src/routes/session/\(login\)/delete
$ git add . && git commit -m "ログインしているかどうかでアクセス制限を掛けた"
src/hooks.server.ts 370ms (unchanged)
src/routes/account/(logout)/new/+page.server.ts 55ms (unchanged)
src/routes/account/(logout)/new/+page.svelte 508ms (unchanged)
src/routes/session/(login)/delete/+server.ts 11ms (unchanged)
src/routes/session/(logout)/new/+page.server.ts 31ms (unchanged)
src/routes/session/(logout)/new/+page.svelte 57ms (unchanged)
[master f8b071a] ログインしているかどうかでアクセス制限を掛けた
6 files changed, 10 insertions(+), 1 deletion(-)
rename src/routes/account/{ => (logout)}/new/+page.server.ts (100%)
rename src/routes/account/{ => (logout)}/new/+page.svelte (100%)
rename src/routes/session/{ => (login)}/delete/+server.ts (100%)
rename src/routes/session/{ => (logout)}/new/+page.server.ts (100%)
rename src/routes/session/{ => (logout)}/new/+page.svelte (100%)
* flash メッセージ [#mb60d486]
redirect による遷移先でメッセージを表示したい
http では遷移元と遷移先のページの表示は独立した処理になるため、
遷移元ページの処理結果に応じて遷移先ページにメッセージを出すには工夫がいる。
それを簡単に行えるようにするため sveltekit-flash-message というライブラリを利用する
もっともよくある使い方としては、フォームの POST が成功した場合に redirect で
別ページに移るのが良い作りとされているので、
その遷移先で送信成功を示すメッセージを表示するのにこのライブラリを使える
https://www.npmjs.com/package/sveltekit-flash-message の通りの手順で、
LANG: console
$ pnpm add -D sveltekit-flash-message
Packages: +1
+
Progress: resolved 295, reused 272, downloaded 0, added 0, done
devDependencies:
+ sveltekit-flash-message ^2.2.2
Done in 3.4s
src/app.d.ts
LANG: ts
declare namespace App {
...
interface PageData {
flash?: { type: 'success' | 'error'; message: string };
};
...
}
src/routes/+layout.server.ts
LANG: ts
export { load } from 'sveltekit-flash-message/server';
src/routes/+layout.svelte
LANG: html
<script lang="ts">
import { getFlash } from 'sveltekit-flash-message';
import { page } from '$app/stores';
const flash = getFlash(page);
</script>
{#if $flash}
{@const bg = $flash.type == 'success' ? '#3D9970' : '#FF4136'}
<div style:background-color={bg} class="flash">{$flash.message}</div>
{/if}
<slot />
これで準備完了。
LANG: console
$ git commit -m "sveltekit-flash-message を導入"
** redirect しているところに片っ端からメッセージを付ける (server 側) [#u39a8996]
src/routes/account/(logout)/new/+page.svelte
LANG: ts
+ import { setFlash } from 'sveltekit-flash-message/server';
...
+ setFlash({type: 'success', message: 'サインアップ＆ログインしました'}, event);
throw redirect(302, path('/'));
みたいな感じ。
src/routes/session/(logout)/new/+page.svelte
LANG: ts
+ setFlash({type: 'success', message: 'ログインしました'}, event);
throw redirect(302, path('/'));
も問題ない。
ところが +server.ts の RequestHandler からだと event が手に入らないため困ってしまう。
実は setFlash には cookies を渡すこともできるので、それでしのげる。
src/routes/session/(login)/delete/+page.svelte
LANG: ts
* export const GET: RequestHandler = async ({ locals, cookies }) => {
...
+ setFlash({type: 'success', message: 'ログアウトしました'}, cookies);
throw redirect(302, path('/'));
また、
src/hooks.server.ts
+ import { setFlash } from 'sveltekit-flash-message/server';
...
if (event.route.id?.match(/\/\(login\)\//) && !event.locals.session?.user) {
+ setFlash({type: 'error', message: 'ログインユーザーのみアクセスできます'}, event);
throw redirect(302, path('/session/new'));
}
if (event.route.id?.match(/\/\(logout\)\//) && event.locals.session?.user) {
+ setFlash({type: 'error', message: 'すでにログインしています'}, event);
throw redirect(302, path('/'));
}
ここで Response.redirect を使ってリダイレクトしようとするとうまく行かないので
注意が必要だ。setFlash は event.cookies あるいは cookies の中身を書き換えるのだけれど
Response.redirect はそれらの変数を参照しないので書き換えた内容が反映されない。
cookies を渡したければ through redirect する必要がある。
このようにして redirect 先で成功・失敗を通知できるようになった。
LANG: console
$ git add . && git commit -m "flash メッセージを追加した"
package.json 121ms (unchanged)
src/app.d.ts 299ms
src/hooks.server.ts 45ms
src/routes/+layout.server.ts 4ms
src/routes/+layout.svelte 298ms
src/routes/account/(logout)/new/+page.server.ts 42ms
src/routes/session/(login)/delete/+server.ts 12ms
src/routes/session/(logout)/new/+page.server.ts 23ms
[master 602e71e] flash メッセージを追加した
9 files changed, 41 insertions(+), 2 deletions(-)
create mode 100644 src/routes/+layout.server.ts
create mode 100644 src/routes/+layout.svelte
** flash メッセージの表示方法 [#f2e8d67c]
特にクライアントサイドから表示した場合には
画面上部に出るだけだと気づけない場合もあるので、~
「表示領域の上部に出て、しばらくしたら引っ込む」~
みたいな動作が望ましい気がする。
https://github.com/ciscoheat/sveltekit-flash-message#toast-messages-event-style
によれば svelte-french-toast を使うと良いらしい。
LANG: console
$ pnpm add svelte-french-toast
Packages: +2
++
Progress: resolved 297, reused 274, downloaded 0, added 0, done
dependencies:
+ svelte-french-toast 1.2.0
Done in 2.5s
src/routes/+layout.svelte
LANG: html
<script lang="ts">
import { getFlash } from 'sveltekit-flash-message';
import { page } from '$app/stores';
+ import toast, { Toaster } from 'svelte-french-toast';
const flash = getFlash(page);
+ flash.subscribe(($flash) => {
+ if (!$flash) return;
+
+ toast($flash.message, {
+ + icon: $flash.type == 'success' ? '✅' : '❌'
+ });
+
+ // Clearing the flash message could sometimes
+ // be required here to avoid double-toasting.
+ flash.set(undefined);
+ });
</script>
+ <Toaster />
<slot />
これで望み通りの表示になった。
#ref(toast-message.gif);
LANG: console
$ git add . && git commit -m "flash メッセージを toast するようにした"
package.json 119ms (unchanged)
src/routes/+layout.svelte 340ms
[master cd6fe78] flash メッセージを toast するようにした
3 files changed, 36 insertions(+), 22 deletions(-)
*** クライアントサイドで使う例も後で勉強すべき [#l5add4ea]
https://www.npmjs.com/package/sveltekit-flash-message#client-side
どういう風に実装されているかまで理解しないと
どうしてこういう処理が必要になるのか納得しづらいかも。
* 見た目を整える [#ff83ba55]
DaisyUI を入れる
** DaisyUI を入れる [#f242fddb]
https://daisyui.com/
DaisyUI は TailwindCSS を元にしているので、まずは TailwindCSS を入れる。
LANG: console
$ pnpm dlx svelte-add@latest tailwindcss
.../Local/pnpm/store/v3/tmp/dlx-21132 | +121 ++++++++++++
.../Local/pnpm/store/v3/tmp/dlx-21132 | Progress: resolved 121, reused 121, downloaded 0, added 121, done
➕ Svelte Add (Version 2023.11.191.00)
The project directory you're giving to this command cannot be determined to be guaranteed fresh — maybe it is, maybe it isn't. If any issues arise after running this command, please try again, making sure you've run it on a freshly initialized SvelteKit or Vite–Svelte app template.
{
"type": "Script",
"start": 0,
"end": 251,
"context": "default",
"content": {
"type": "Program",
"start": 240,
"end": 242,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 1,
"column": 242
}
},
"body": [
{
"type": "BlockStatement",
"start": 240,
"end": 242,
"loc": {
"start": {
"line": 1,
"column": 240
},
"end": {
"line": 1,
"column": 242
}
},
"body": []
}
],
"sourceType": "module"
}
}
{
"type": "Script",
"start": 0,
"end": 251,
"context": "default",
"content": {
"type": "Program",
"start": 240,
"end": 242,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 1,
"column": 242
}
},
"body": [
{
"type": "BlockStatement",
"start": 240,
"end": 242,
"loc": {
"start": {
"line": 1,
"column": 240
},
"end": {
"line": 1,
"column": 242
}
},
"body": []
}
],
"sourceType": "module"
}
}
PostCSS
✅ successfully set up and repaired (it looks like it was in a broken setup before this command was run)!
Create or find an existing issue at https://github.com/svelte-add/svelte-add/issues if this is wrong.
Tailwind CSS
✅ successfully set up!
Create or find an existing issue at https://github.com/svelte-add/svelte-add/issues if this is wrong.
Run pnpm install to install new dependencies, and then reload your IDE before starting your app.
言われた通りに、
LANG: console
$ pnpm install
Packages: +45 -3
+++++++++++++++++++++++++++++++++++++++++++++---
Progress: resolved 337, reused 312, downloaded 2, added 45, done
Progress: resolved 339, reused 315, downloaded 1, added 1, done
node_modules/.pnpm/svelte-preprocess@5.1.1_postcss-load-config@4.0.1_postcss@8.4.31_svelte@4.2.7_typescript@5.3.2/node_modules/svelte-preprocess: Running postinstall script, done in 51ms
devDependencies:
+ autoprefixer 10.4.14 (10.4.16 is available)
+ postcss 8.4.31
+ postcss-load-config 4.0.1 (4.0.2 is available)
- prettier-plugin-svelte 3.1.2
+ prettier-plugin-tailwindcss 0.4.1 (0.5.7 is available)
+ tailwindcss 3.3.2 (3.3.5 is available)
Done in 9.6s
そして、
LANG: console
$ pnpm add -D daisyui@latest
$ pnpm add -D daisyui@latest @tailwindcss/typography
Packages: +8
++++++++
Progress: resolved 347, reused 323, downloaded 1, added 1, done
Packages: +4
++++
Progress: resolved 341, reused 317, downloaded 1, added 4, done
devDependencies:
+ daisyui 4.4.12
Done in 4.2s
$ pnpm add -D @tailwindcss/typography
Packages: +4
++++
Progress: resolved 345, reused 318, downloaded 4, added 4, done
devDependencies:
+ @tailwindcss/typography 0.5.10
+ daisyui 4.4.14
Done in 4.9s
Done in 4.1s
https://daisyui.com/docs/layout-and-typography/#-1
tailwind.config.cjs
+ daisyui: {
+ themes: ['lemonade']
+ themes: ['light']
+ },
+ plugins: [
+ require("@tailwindcss/typography"),
+ require("daisyui")
+ ],
- plugins: [],
DaisyUI は TailwindCSS をベースにしている
- @apply が使える https://tailwindcss.com/docs/reusing-styles#extracting-classes-with-apply
-- class の add/remove を css だけでできる感じになる
** コンポーネントの準備 [#g6e8a392]
*** コンポーネントの準備 [#g6e8a392]
src/lib/components/DialogPage.svelte
src/lib/components/Dialog.svelte
LANG: html
<script lang="ts">
export let title: string;
</script>
<div class="relative flex flex-col items-center justify-center h-screen overflow-hidden">
<div class="dialog relative flex flex-col items-center justify-center min-h-screen">
<div class="w-full lg:max-w-lg p-6 m-auto rounded-md shadow-2xl">
<h1 class="text-3xl font-semibold text-center text-primary">{title}</h1>
<slot />
</div>
</div>
src/lib/components/Form.svelte
LANG: html
<script lang="ts">
import { afterUpdate } from 'svelte';
export let message= '';
export let enhance: ((el: HTMLFormElement) => object) = ()=>{return {}};
export let props: svelteHTML.IntrinsicElements['form'] | undefined = undefined;
let form: HTMLFormElement;
afterUpdate(()=> {
if(message) {
for(const elem of form.querySelectorAll('input')){
elem.classList.add('input-error')
}
// エラーメッセージが付いていたらすべてのコントロールをエラー表示にする
['checkbox', 'file-input', 'radio', 'range', 'select', 'ihput', 'textarea', 'toggle'].forEach(kind=>{
for(const elem of form.querySelectorAll(`.${kind}`)){
elem.classList.add(`${kind}-error`);
}
})
}
})
</script>
{#if message}<span class="text-sm text-red-600">{message}</span>{/if}
<form bind:this={form} class="space-y-4" method="POST" use:enhance>
{#if message}<span class="text-error text-sm">{message}</span>{/if}
<form bind:this={form} class="space-y-4" method="POST" use:enhance {...props}>
<slot />
</form>
src/lib/components/LabeledInput.svelte
src/lib/components/InputText.svelte
LANG: html
<label for={name} class="label"><span class="text-base label-text">{label}</span></label>
<input {...{ name, type }} bind:value disabled={disabled} on:input
class="w-full input input-bordered input-primary" class:input-error={errors && $errors && $errors[key]} />
{#if errors && $errors && $errors[key]}<span class="text-xs text-red-600">{$errors[key]}</span>{/if}
src/lib/components/SubmitButton.svelte
LANG: html
<script lang="ts">
import type { Writable } from 'svelte/store';
export let name: string;
export let label: string;
export let labelAlt: string = '';
export let value: string;
export let disabled = false;
export let errors: Writable<{}> | undefined = undefined;
export let props: svelteHTML.IntrinsicElements['input'] | undefined = undefined;
let key = name as keyof typeof errors;
</script>
<div><button disabled={disabled} class="btn btn-block btn-primary text-white"><slot /></button></div>
<label for={name} class="label">
<span class="label-text">{label}</span>
{#if labelAlt}<span class="label-text-alt">{labelAlt}</span>{/if}
</label>
<input {...{ name, type: "text", ...props }} bind:value disabled={disabled} on:input
class="w-full input input-bordered input-primary" class:input-error={errors && $errors && $errors[key]} />
{#if errors && $errors && $errors[key]}
<label class="label" for={name}>
<span class="label-text-alt text-error">{$errors[key]}</span>
</label>
{/if}
*** 書き換える [#red8afd3]
こんな風に書ける
src/routes/[purpose=emailVerificationPurpose]/+page.svelte
src/lib/components/InputPassword.svelte
LANG: html
<DialogPage title={purpose}>
<Form meesage={$message} {enhance}>
<LabeledInput name="email" label="メールアドレス" bind:value={$form.email} disabled={$submitting} errors={errors} />
<p>{purpose} を続けるためのリンクを含むメールを送信します<br />
そちらのリンクから {purpose} 手続きを進めて下さい</p>
<SubmitButton disabled={$submitting}>メールを送信</SubmitButton>
<div>
<a class="text-sm text-blue-600 hover:underline hover:text-blue-400" href="/">トップへ戻る</a>
</div>
</Form>
</DialogPage>
&ref(emailVerificationForm.png,,50%);
** 見せ方 [#f2e8d67c]
特にクライアントサイドから表示した場合には
画面上部に出るだけだと気づけない場合もあるので、~
「表示領域の上部に出て、クリックされたら、あるいはしばらくしたら、引っ込む」~
みたいな動作が望ましい気がする。
そういう動作は toast と呼ばれるらしい。
https://github.com/ciscoheat/sveltekit-flash-message#toast-messages-event-style
によれば svelte-french-toast を使うと良いらしい。
LANG: console
$ pnpm i svelte-french-toast
Packages: +2
++
Progress: resolved 304, reused 280, downloaded 2, added 2, done
dependencies:
+ svelte-french-toast 1.2.0
Done in 4.9s
src/routes/+layout.svelte
LANG: html
<script lang="ts">
import { getFlash } from 'sveltekit-flash-message';
import { page } from '$app/stores';
import toast, { Toaster } from 'svelte-french-toast';
import InputText from '$lib/components/InputText.svelte';
import type { Writable } from 'svelte/store';
const flash = getFlash(page);
flash.subscribe(($flash) => {
if (!$flash) return;
toast($flash.message, {
icon: $flash.type == 'success' ? '✅' : '❌'
});
// Clearing the flash message could sometimes
// be required here to avoid double-toasting.
flash.set(undefined);
});
export let name: string;
export let label: string;
export let labelAlt: string = '';
export let value: string;
export let disabled = false;
export let errors: Writable<{}> | undefined = undefined;
export let props: svelteHTML.IntrinsicElements['input'] | undefined = undefined;
</script>
<Toaster />
<slot />
<InputText {...{name, label, labelAlt, disabled, errors}}
props= {{type: "password", ...props}} bind:value on:input />
これでうまく行った。
*** クライアントサイドで使う例も後で勉強すべき [#l5add4ea]
https://www.npmjs.com/package/sveltekit-flash-message#client-side
どういう風に実装されているかまで理解しないと
どうしてこういう処理が必要になるのか納得しづらいかも。
** サインアップ時にメールアドレスの確認を行う [#ufa1af42]
いきなりサインアップするのではなく、入力されたメールアドレスに確認リンク入りのメールを送って
メールアドレスの確認が取れたらサインアップを行う、という動作をしたい。
https://lucia-auth.com/guidebook/email-verification-links/
によると
- authUser テーブルに email_verified フィールドを追加
- emailVerification テーブルを追加
という形で行う形が紹介されているけれど、
user テーブルに email_verified フィールドを追加する代わりに、
そもそも email を verify しないと signup ページに
たどり着けない形にした方が間違いが生じない気がする？
+ /signup でメールアドレスのみ入力
+ メールが届く
+ メールに記載のリンク先で名前やパスワードなどメールアドレス以外の情報を入力
-- /signup/xxxxxxxx
のような。
これを実現するため emailVerification テーブルには以下のフィールドを定義する。
- token @id @default(uuid())
- email
- createdAt
流れはこんな感じ
¨(
skinparam handwritten true
actor User
participant System
database Database
User -> System : /signup へアクセス
System --> User : メールアドレス入力フォームを表示
User -> System : メールアドレスを入力
System -> Database : トークンとメールアドレスを保存
System --> User : トークン入りの URL をメールで通知
User -> System : トークン入りの URL へアクセス
System -> Database : トークンを確認
Database --> System : メールアドレスを返す
System --> User : サインアップフォームを表示
User -> System : サインアップフォームを送信
System -> Database : トークンを確認
Database --> System : メールアドレスを返す
System -> Database : ユーザー登録
System -> Database : トークンを削除
System --> User : サインアップ完了を表示
);
*** パスワードリセットもできるようにしたい [#w3f0baa5]
サインアップと同様に以下の流れで行う。
+ /reset-password にメールアドレスだけを入力
+ メールが届く
+ メールに記載のリンク先で新しいパスワードを入力
-- /reset-password/xxxxxxxx
¨(
skinparam handwritten true
actor User
participant System
database Database
User -> System : /reset-password へアクセス
System --> User : メールアドレス入力フォームを表示
User -> System : メールアドレスを入力
System -> Database : トークンとメールアドレスを保存
System --> User : トークン入りの URL をメールで通知
User -> System : トークン入りの URL へアクセス
System -> Database : トークンを確認
Database --> System : メールアドレスを返す
System --> User : パスワード入力フォームを表示
User -> System : パスワード入力フォームを送信
System -> Database : トークンを確認
Database --> System : メールアドレスを返す
System -> Database : パスワード変更
System -> Database : トークンを削除
System --> User : パスワード変更完了を表示
);
*** emailVerification テーブル [#gc99d89b]
prisma/schema.prisma
+ model emailVerification {
+ id String @id @default(uuid())
+ email String @unique
+ createdAt DateTime @default(now()) @map("created_at")
+ }
id を秘密のトークンとして使う
LANG:console
$ npx prisma migrate dev --name "add emailVerification table"
*** メールアドレス入力フォーム [#j7548045]
メールアドレス確認用の正規表現を使いまわせるようライブラリに切り出す
src/lib/emailRegexp.ts
LANG: ts
// https://qiita.com/sakuro/items/1eaa307609ceaaf51123
export const emailRegexp = /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/;
メールアドレスのチェックを行うスキーマを用意
src/lib/formSchemas/emailVerification.ts
LANG: ts
import { z } from 'zod';
import { emailRegexp } from '$lib/emailRegexp'
export const schema = z
.object({
email: z.string().regex(emailRegexp, { message: 'メールアドレスが不正です' }),
})
サインアップとパスワードリセットの両方を扱えるようにするため
matcher を使ったルーティングを行う。
https://kit.svelte.jp/docs/advanced-routing#matching
src/lib/emailVerificationPurposes.ts
LANG: ts
export const purposes = {
signup: 'サインアップ',
'reset-password': 'パスワードリセット'
};
src/params/emailVerificationPurpose.ts
LANG: ts
import type { ParamMatcher } from '@sveltejs/kit';
import { purposes } from '$lib/emailVerificationPurposes';
export const match: ParamMatcher = (param) => {
return Object.hasOwn(purposes, param);
};
src/routes/(loggedOut)/[purpose=emailVerificationPurpose]/+page.svelte
src/lib/components/SubmitButton.svelte
LANG: html
<script lang="ts">
import type { PageData } from './$types';
import { superForm } from 'sveltekit-superforms/client';
import { purposes } from '$lib/emailVerificationPurposes';
export let data: PageData;
const { form, message, errors, submitting, capture, restore, enhance } = superForm(data.form, {
taintedMessage: false
});
export const snapshot = { capture, restore };
const purpose = purposes[data.purpose];
export let disabled = false;
</script>
<div>
<h1>メールアドレスを入力して下さい</h1>
<p>入力されたアドレスへ {purpose} を続けるためのリンクを含むメールを送信します<br />
そちらのリンクから {purpose} 手続きを進めて下さい</p>
{#if $message}<span class="invalid">{$message}</span>{/if}
<form method="POST" use:enhance>
<label for="email">メールアドレス</label>
<input type="text" name="email" bind:value={$form.email} disabled={$submitting} />
{#if $errors.email}<span class="invalid">{$errors.email}</span>{/if}
<div><button disabled={$submitting}>メールを送信</button></div>
</form>
<button disabled={disabled} class="btn btn-block btn-primary text-white"><slot /></button>
</div>
<style>
.invalid {
color: red;
}
</style>
src/routes/(loggedOut)/[purpose=emailVerificationPurpose]/+page.server.ts
LANG: ts
import type { Actions, PageServerLoad, PageServerLoadEvent, RequestEvent } from './$types';
import { schema } from '$lib/formSchemas/emailVerification';
import { superValidate } from 'sveltekit-superforms/server';
import { fail } from '@sveltejs/kit';
import { redirect } from 'sveltekit-flash-message/server';
import { purposes } from '$lib/emailVerificationPurposes';
import { transporter } from '$lib/server/transporter';
import { db } from '$lib/server/db'
async function getPurpose(event: PageServerLoadEvent | RequestEvent) {
const purpose = event.params.purpose as keyof typeof purposes;
return purpose;
}
export const load = (async (event) => {
const form = await superValidate(schema);
const purpose = await getPurpose(event);
return { form, purpose };
}) satisfies PageServerLoad;
export const actions: Actions = {
default: async (event) => {
// フォームデータのバリデーション
const form = await superValidate(event, schema);
const purpose = await getPurpose(event);
if (!form.valid) {
return fail(400, { form, purpose });
}
// TODO: emailVerification レコードを作成
// TODO: メールを送信
throw redirect(302, '/', { type: 'success', message: 'メールを送信しました'}, event);
}
};
** 書き換える [#red8afd3]
*** emailVerification レコードを作成 [#z328139c]
こんな風に書ける
一定時間以内に作成されたものがすでに存在すればエラーにする
src/routes/(loggedOut)/[purpose=emailVerificationPurpose]/+page.server.ts
LANG: ts
// emailVerification レコードが既に存在するか？
const existing = await db.emailVerification.findUnique({where: {email: form.data.email}})
if(existing) {
// ２時間以内に送っていればエラーにする
if(existing.createdAt.getTime() > Date.now() - (1000 * 60 * 60 * 2)) {
throw redirect(302, '/', { type: 'error', message: '先ほどメールを送信しましたのでしばらく経ってから試してください'}, event);
}
// 既存のものを削除
await db.emailVerification.delete({where: {email: form.data.email}});
}
// レコードを作成する
const record = await db.emailVerification.create({data: {email: form.data.email}});
const token = record.id;
*** メールを送信 [#hb25fe9c]
アドレスは /signup/[token] になる
https://shinobiworks.com/blog/385/ のように nodemailer を使う
LANG: console
$ npm i nodemailer && npm i --save-dev @types/nodemailer
src/lib/server/transporter.ts
LANG: ts
import { createTransport } from "nodemailer";
export const transporter = createTransport({
host: "localhost",
port: 25,
});
src/routes/(loggedOut)/[purpose=emailVerificationPurpose]/+page.server.ts
LANG: ts
import { transporter } from '$lib/server/transporter';
...
// メールを送信
const url = `${event.url.origin}/${purpose}/${token}`
try {
await transporter.sendMail({
from: `"authtest system" <authtest@my.server.net>`,
to: form.data.email,
subject: `[authtest] ${purposes[purpose]} 用のリンクをお送りします`,
text: `次の URL より ${purposes[purpose]} の手続きをお勧めください\n${url}`
});
} catch (error) {
throw redirect(302, event.url, { type: 'error', message: 'メールを送信できませんでした'}, event);
}
*** サインアップフォーム [#j99985ea]
フォームからメールアドレス欄を除く
src/lib/formSchemas/signup.ts
LANG: ts
import { z } from 'zod';
- // https://qiita.com/sakuro/items/1eaa307609ceaaf51123
- const emailRegexp = /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/;
-
export const schema = z
.object({
name: z.string().min(3, { message: 'ユーザー名は3文字以上で入力してください' }),
- email: z.string().regex(emailRegexp, { message: 'メールアドレスが不正です' }),
password: z
.string()
.regex(/^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9]).{8,}$/, {
message: 'パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください'
}),
confirm: z.string(),
})
.refine((data) => data.password === data.confirm, {
message: '確認用パスワードが一致しません',
path: ['confirm']
});
disabled にしたフィールドは表示専用になりフォーム送信時にデータが送られない。
src/routes/(loggedOut)/signup/[token]/+page.svelte
src/routes/account/(logout)/new/+page.svelte
LANG: html
<label for="email">メールアドレス</label>
+ <input type="text" name="email" bind:value={data.email} disabled />
- <input type="text" name="email" bind:value={$form.email} disabled={$submitting} />
- {#if $errors.email}<span class="invalid">{$errors.email}</span>{/if}
以前の src/routes/(loggedOut)/signup/+page.* を
src/routes/(loggedOut)/signup/[token]/+page.* に移す。
form と共に email アドレスを返す。
src/routes/(loggedOut)/signup/[token]/+page.server.ts
LANG: ts
- import type { Actions, PageServerLoad } from './$types';
+ import type { Actions, PageServerLoad, PageServerLoadEvent, RequestEvent } from './$types';
...
+ async function getEmail(event: PageServerLoadEvent | RequestEvent) {
+ const record = await db.emailVerification.findUnique({where: {id: event.params.token}})
+ if(!record || Date.now() - (1000 * 60 * 60 * 2) > record.createdAt.getTime()) {
+ // 見つからないあるいは古すぎる
+ throw redirect(302, '/', {type: 'error', message: '無効なトークンです'}, event);
+ }
+ return record.email;
+ }
- export const load = (async () => {
+ export const load = (async (event) => {
const form = await superValidate(schema);
- return { form };
+ const email = await getEmail(event)
+ return { form, email };
}) satisfies PageServerLoad;
export const actions: Actions = {
default: async (event) => {
// フォームデータのバリデーション
const form = await superValidate(event, schema);
+ const email = await getEmail(event)
if (!form.valid) {
return fail(400, { form, email });
}
// サインアップ処理
try {
const user = await auth.createUser({
key: {
providerId: 'email',
- providerUserId: form.data.email,
+ providerUserId: email,
password: form.data.password
},
attributes: {
name: form.data.name,
- email: form.data.email,
+ email: email,
}
});
...
- return fail(400, { form: { ...form, message: '名前またはメールアドレスが既存のアカウントと重複しています' } });
+ return fail(400, { form: { ...form, message: '名前またはメールアドレスが既存のアカウントと重複しています' }, email });
...
- return fail(400, { form: { ...form, message: 'サインアップエラー' } });
+ return fail(400, { form: { ...form, message: 'サインアップエラー' }, email });
...
+ // レコードを消去
+ await db.emailVerification.delete({where: {id: event.params.token}})
throw redirect(302, '/', { type: 'success', message: 'サインアップしました'}, event);
}
};
これで大丈夫そう。
*** パスワードリセット [#l485ccd3]
メール送信フォームでそのメールアドレスを持つアカウントの存在を確認する
src/routes/(loggedOut)/[purpose=emailVerificationPurpose]/+page.server.ts
LANG: ts
// フォームデータのバリデーション
const form = await superValidate(event, schema);
+ // パスワードリセットは既存のアカウントがなければエラー
+ if(purpose == 'reset-password') {
+ if(!await db.authUser.findUnique({where: {email: form.data.email}})){
+ form.errors.email = [...(form.errors.email || []), '登録されていません'];
+ form.valid = false;
+ }
+ }
if (!form.valid) {
return fail(400, { form, purpose });
}
フォーム検証スキーム
authtest/src/lib/formSchemas/resetPassword.ts
LANG: ts
import { z } from 'zod';
export const schema = z
.object({
password: z
.string()
.regex(/^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9]).{8,}$/, {
message: 'パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください'
}),
confirm: z.string(),
})
.refine((data) => data.password === data.confirm, {
message: '確認用パスワードが一致しません',
path: ['confirm']
});
ユーザー名とメールアドレスは変更不可
フォームに表示はするが disable なので値は POST されない。
src/routes/(loggedOut)/reset-password/[token]/+page.svelte
LANG: html
<script lang="ts">
import type { PageData } from './$types';
import { superForm } from 'sveltekit-superforms/client';
import Dialog from '$lib/components/Dialog.svelte';
import Form from '$lib/components/Form.svelte';
import InputText from '$lib/components/InputText.svelte';
import InputPassword from '$lib/components/InputPassword.svelte';
import Button from '$lib/components/Button.svelte';
import { path } from '$lib/server';
export let data: PageData;
const { form, message, errors, submitting, capture, restore, enhance } = superForm(data.form, {
taintedMessage: false
taintedMessage: false,
});
export const snapshot = { capture, restore };
</script>
<div>
<h1>パスワードの変更</h1>
{#if $message}<span class="invalid">{$message}</span>{/if}
<form method="POST" use:enhance>
<label for="name">ユーザー名</label>
<input type="text" name="name" bind:value={data.user.name} disabled />
<label for="email">メールアドレス</label>
<input type="text" name="email" bind:value={data.user.email} disabled />
<label for="password">パスワード</label>
<input type="password" name="password" bind:value={$form.password} disabled={$submitting} />
{#if $errors.password}<span class="invalid">{$errors.password}</span>{/if}
<label for="confirm">パスワード（確認）</label>
<input
type="password"
name="confirm"
bind:value={$form.confirm}
disabled={$submitting}
/>
{#if $errors.confirm}<span class="invalid">{$errors.confirm}</span>{/if}
<div><button disabled={$submitting}>パスワードを変更</button></div>
</form>
</div>
<style>
.invalid {
color: red;
}
</style>
<Dialog title="サインアップ">
<Form message={$message} {enhance}>
<InputText name="name" label="ユーザー名" bind:value={$form.name} disabled={$submitting} errors={errors} />
<InputText name="email" label="メールアドレス" bind:value={$form.email} disabled={$submitting} errors={errors} props={{placeholder: "account@example.com"}} />
<InputPassword name="password" label="パスワード" bind:value={$form.password} disabled={$submitting} errors={errors} />
<InputPassword name="confirm" label="パスワード（確認）" bind:value={$form.confirm} disabled={$submitting} errors={errors} />
<Button disabled={$submitting}>サインアップ</Button>
<p>アカウントをお持ちなら <a href={path('/session/new')}>サインアップ</a></p>
</Form>
</Dialog>
src/routes/(loggedOut)/reset-password/[token]/+page.server.ts
LANG: ts
import type { Actions, PageServerLoad, PageServerLoadEvent, RequestEvent } from './$types';
import { schema } from '$lib/formSchemas/signup';
import { superValidate } from 'sveltekit-superforms/server';
import { fail } from '@sveltejs/kit';
import { redirect } from 'sveltekit-flash-message/server';
import { auth } from '$lib/server/lucia';
import { db } from '$lib/server/db'
async function getUser(event: PageServerLoadEvent | RequestEvent) {
const record = await db.emailVerification.findUnique({where: {id: event.params.token}});
if(!record || Date.now() - (1000 * 60 * 60 * 2) > record.createdAt.getTime()) {
throw redirect(302, '/', {type: 'error', message: '無効なトークンです'}, event);
}
const user = await db.authUser.findUnique({where: {email: record.email}});
if (!user) {
throw redirect(302, '/', {type: 'error', message: '無効なトークンです'}, event);
}
return user;
}
export const load = (async (event) => {
const form = await superValidate(schema);
const user = await getUser(event);
return { form, user };
}) satisfies PageServerLoad;
export const actions: Actions = {
default: async (event) => {
// フォームデータのバリデーション
const form = await superValidate(event, schema);
const user = await getUser(event);
if (!form.valid) {
return fail(400, { form, user });
}
// パスワードを変更
await auth.updateKeyPassword(
'email', user.email, form.data.password
)
// 直接ログインする
const session = await auth.createSession({userId: user.id, attributes: {}});
event.locals.auth.setSession(session);
// レコードを消去
await db.emailVerification.delete({where: {id: event.params.token}});
throw redirect(302, '/', { type: 'success', message: 'パスワードを変更してログインしました'}, event);
}
};
&ref(signup-formatted.png,,50%);
** メールアドレス変更 [#g1870852]
これもメールアドレスを確認後、飛び先で確認ボタンを押したら変更という形にすべき。
'chage-email' というパスを用意
src/lib/emailVerificationPurposes.ts
LANG: ts
export const purposes = {
signup: 'サインアップ',
'reset-password': 'パスワードリセット',
+ 'change-email': 'メールアドレス変更',
};
signup や reset-password はログアウト状態で行う処理だったのに対して
この作業はログイン状態で行うので、
src/routes/(loggedOut)/[purpose=emailVerificationPurpose] を~
src/routes/[purpose=emailVerificationPurpose] へ移動した上で、
コード上でログイン状態を確認することにした。
|>||>|!!session?.user|
|~|~|true|false|
|purpose == 'change-email'|true|OK|Error|
|~|false|Error|OK|
なので (purpose == 'change-email') !== (!! session?.user) で判断すればいい。
src/routes/[purpose=emailVerificationPurpose]/+page.server.ts
LANG: ts
async function getPurpose(event: PageServerLoadEvent | RequestEvent) {
const purpose = event.params.purpose as keyof typeof purposes;
+ const session = await event.locals.auth.validate();
+ if((purpose == 'change-email') !== (!! session?.user)) {
+ throw redirect(302, '/', { type: 'error', message: 'ログイン状態が無効です'}, event);
+ }
return purpose;
}
...
+ // メールアドレス変更は既存のアカウントがあければエラー
+ if(purpose == 'change-email') {
+ if(await db.authUser.findUnique({where: {email: form.data.email}})){
+ form.errors.email = [...(form.errors.email || []), '既存のアカウントと重複しています'];
+ form.valid = false;
+ }
+ }
フォームは単なる確認用なのでデータは何も受け取らない
したがって、バリデーション用スキームも必要ない
src/routes/(loggedIn)/change-email/[token]/+page.svelte
src/routes/session/(logout)/new/+page.svelte
LANG: html
<script lang="ts">
import type { PageData } from './$types';
export let data: PageData;
</script>
<script lang="ts">
...
+ import Dialog from '$lib/components/Dialog.svelte';
+ import Form from '$lib/components/Form.svelte';
+ import InputText from '$lib/components/InputText.svelte';
+ import InputPassword from '$lib/components/InputPassword.svelte';
+ import Button from '$lib/components/Button.svelte';
...
</script>
<div>
<h1>メールアドレスの変更</h1>
<form method="POST">
<label for="name">ユーザー名</label>
<input type="text" name="name" value={data.user.name} disabled />
<label for="email">古いメールアドレス</label>
<input type="text" name="email" value={data.user.email} disabled />
<label for="email">新しいメールアドレス</label>
<input type="text" name="email" value={data.email} disabled />
<div><button>メールアドレスを変更</button></div>
</form>
</div>
* <Dialog title="ログイン">
* <Form message={$message} {enhance}>
* <InputText name="email" label="メールアドレス" bind:value={$form.email} disabled={$submitting} errors={errors} props={{placeholder: "account@example.com"}} />
* <InputPassword name="password" label="パスワード" bind:value={$form.password} disabled={$submitting} errors={errors} />
* <Button disabled={$submitting}>ログイン</Button>
* <p>アカウントをお持ちでなければ <a class="link link-primary" href={data.urlRoot+'/account/new'}>サインアップ</a></p>
* </Form>
</Dialog>
認証キー（ここではメールアドレス）を変更する機能は Lucia には備わっていない？
** うまくコミットできなくなっていた [#w022bd92]
見つけられなかったのでデータベースを直接書き換えている。
src/routes/(loggedIn)/change-email/[token]/+page.server.ts
LANG: ts
import type { Actions, PageServerLoad, PageServerLoadEvent, RequestEvent } from './$types';
import { redirect } from 'sveltekit-flash-message/server';
import { db } from '$lib/server/db'
async function getEmailAndUser(event: PageServerLoadEvent | RequestEvent) {
const record = await db.emailVerification.findUnique({where: {id: event.params.token}});
if(!record || Date.now() - (1000 * 60 * 60 * 2) > record.createdAt.getTime()) {
throw redirect(302, '/', {type: 'error', message: '無効なトークンです'}, event);
}
const session = await event.locals.auth.validate();
if(!session?.user) {
throw redirect(302, '/login', {type: 'error', message: '旧メールアドレスでログインしてください'}, event);
}
return {email: record.email, user: session.user};
}
export const load = (async (event) => {
return await getEmailAndUser(event);
}) satisfies PageServerLoad;
export const actions: Actions = {
default: async (event) => {
const {email, user} = await getEmailAndUser(event);
// メールアドレスを変更
await db.$transaction([
db.authUser.update({
where: {id: user.userId},
data: {email},
}),
db.authKey.update({
where: {id: `email:${user.email}`, user_id: user.userId},
data: {id: `email:${email}`},
}),
])
// レコードを消去
await db.emailVerification.delete({where: {id: event.params.token}});
throw redirect(302, '/', { type: 'success', message: 'メールアドレスを変更しました'}, event);
}
};
** ユーザー情報変更 [#ea677d6d]
メールアドレス以外を変更できる
パスワードを変更しない場合には空にしておく
src/lib/formSchemas/changeProfile.ts
LANG: ts
import { z } from 'zod';
export const schema = z
.object({
name: z.string().min(3, { message: 'ユーザー名は3文字以上で入力してください' }),
password: z
.string()
.regex(/^$|^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9]).{8,}$/, {
message: 'パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください'
}),
confirm: z.string(),
})
.refine((data) => data.password === data.confirm, {
message: '確認用パスワードが一致しません',
path: ['confirm']
});
src/routes/(loggedIn)/change-profile/+page.svelte
LANG: html
<script lang="ts">
import type { PageData } from './$types';
import { superForm } from 'sveltekit-superforms/client';
export let data: PageData;
const { form, message, errors, submitting, capture, restore, enhance } = superForm(data.form, {
taintedMessage: false
});
export const snapshot = { capture, restore };
</script>
<div>
<h1>ユーザー情報の変更</h1>
{#if $message}<span class="invalid">{$message}</span>{/if}
<form method="POST" use:enhance>
<label for="name">ユーザー名</label>
<input type="text" name="name" bind:value={$form.name} disabled={$submitting} />
{#if $errors.name}<span class="invalid">{$errors.name}</span>{/if}
<label for="email">メールアドレス</label>
<input type="text" name="email" bind:value={data.user.email} disabled />
<label for="password">パスワード（変更しないなら何も入力しない）</label>
<input type="password" name="password" bind:value={$form.password} disabled={$submitting} />
{#if $errors.password}<span class="invalid">{$errors.password}</span>{/if}
<label for="confirm">パスワード（確認）</label>
<input
type="password"
name="confirm"
bind:value={$form.confirm}
disabled={$submitting}
/>
{#if $errors.confirm}<span class="invalid">{$errors.confirm}</span>{/if}
<div><button disabled={$submitting}>ユーザー情報を変更</button></div>
</form>
</div>
<style>
.invalid {
color: red;
}
</style>
src/routes/(loggedIn)/change-profile/+page.server.ts
LANG: ts
import type { Actions, PageServerLoad, PageServerLoadEvent, RequestEvent } from './$types';
import { schema } from '$lib/formSchemas/changeProfile';
import { superValidate } from 'sveltekit-superforms/server';
import { fail } from '@sveltejs/kit';
import { redirect } from 'sveltekit-flash-message/server';
import { auth } from '$lib/server/lucia';
import { db } from '$lib/server/db'
async function getUser(event: PageServerLoadEvent | RequestEvent) {
const session = await event.locals.auth.validate();
return session!.user;
}
export const load = (async (event) => {
const form = await superValidate(schema);
const user = await getUser(event);
form.data.name = user.name;
return { form, user };
}) satisfies PageServerLoad;
export const actions: Actions = {
default: async (event) => {
// フォームデータのバリデーション
const form = await superValidate(event, schema);
const user = await getUser(event);
if (!form.valid) {
return fail(400, { form, user });
}
const changed = [] as string[];
if(form.data.password) {
await auth.updateKeyPassword('email', user.email, form.data.password);
changed.push('パスワード');
}
if(form.data.name != user.name) {
db.authUser.update({where: {id: user.userId}, data: {name: user.name}});
changed.push('名前');
}
let message: string;
if(changed.length == 0) {
message = '何も変更されませんでした';
} else {
message = changed.join('と') + 'が変更されました';
}
throw redirect(302, '/', { type: 'success', message}, event);
}
};
** Node サーバーを作成してみる [#sfd1def2]
デプロイ手順を見てみる
https://kit.svelte.jp/docs/adapter-node
LANG: console
$ npm i -D @sveltejs/adapter-node
Packages: +21
+++++++++++++++++++++
Progress: resolved 327, reused 284, downloaded 21, added 21, done
$ git add . && git commit -m "DaisyUI を入れて見た目を整えた"
.prettierrc 231ms (unchanged)
package.json 10ms (unchanged)
devDependencies:
+ @sveltejs/adapter-node 1.3.1
🌼 daisyUI 4.4.14
├─ ✔︎ 1 theme added https://daisyui.com/docs/themes
╰─ ★ Star daisyUI on GitHub https://github.com/saadeghi/daisyui
Done in 7s
postcss.config.cjs 1575ms (unchanged)
src/app.pcss 126ms (unchanged)
src/hooks.server.ts 115ms (unchanged)
[error] Couldn't resolve parser "svelte".
[master 9e98390] DaisyUI を入れて見た目を整えた
22 files changed, 644 insertions(+), 111 deletions(-)
create mode 100644 postcss.config.cjs
create mode 100644 src/app.pcss
create mode 100644 src/lib/components/Button.svelte
create mode 100644 src/lib/components/Dialog.svelte
create mode 100644 src/lib/components/Form.svelte
create mode 100644 src/lib/components/InputPassword.svelte
create mode 100644 src/lib/components/InputText.svelte
create mode 100644 src/lib/server/index.ts
create mode 100644 tailwind.config.cjs
svelte.config.js
LANG: js
- import adapter from '@sveltejs/adapter-auto';
+ // import adapter from '@sveltejs/adapter-auto';
+ import adapter from '@sveltejs/adapter-node';
あれ、エラー出た。
あとは npm で build すれば node build/index.js で立ち上がる？
LANG: console
$ pnpm build
> authtest@0.0.1 build C:\Users\osamu\Desktop\svelte\authtest
> vite build
vite v4.4.2 building SSR bundle for production...
✓ 159 modules transformed.
vite v4.4.2 building for production...
✓ 122 modules transformed.
.svelte-kit/output/client/_app/version.json 0.03 kB │ gzip: 0.05 kB
.svelte-kit/output/client/.vite/manifest.json 7.03 kB │ gzip: 0.78 kB
.svelte-kit/output/client/_app/immutable/assets/4.ff1cfcc4.css 0.04 kB │ gzip: 0.06 kB
.svelte-kit/output/client/_app/immutable/assets/0.3a6d0da3.css 4.42 kB │ gzip: 1.20 kB
.svelte-kit/output/client/_app/immutable/chunks/emailVerificationPurposes.c76ea6d4.js 0.10 kB │ gzip: 0.15 kB
.svelte-kit/output/client/_app/immutable/chunks/navigation.69a4676d.js 0.16 kB │ gzip: 0.14 kB
.svelte-kit/output/client/_app/immutable/chunks/stores.d869250f.js 0.24 kB │ gzip: 0.17 kB
.svelte-kit/output/client/_app/immutable/nodes/2.02fcdf6e.js 0.66 kB │ gzip: 0.43 kB
.svelte-kit/output/client/_app/immutable/nodes/1.43b0e5d2.js 0.84 kB │ gzip: 0.52 kB
.svelte-kit/output/client/_app/immutable/chunks/parse.7d180a0f.js 1.31 kB │ gzip: 0.63 kB
.svelte-kit/output/client/_app/immutable/nodes/3.f8093b5c.js 2.06 kB │ gzip: 1.05 kB
.svelte-kit/output/client/_app/immutable/chunks/scheduler.690599bf.js 2.33 kB │ gzip: 1.08 kB
.svelte-kit/output/client/_app/immutable/nodes/8.0a6a485a.js 3.19 kB │ gzip: 1.73 kB
.svelte-kit/output/client/_app/immutable/chunks/singletons.0f20aa31.js 3.40 kB │ gzip: 1.76 kB
.svelte-kit/output/client/_app/immutable/nodes/5.328fded3.js 3.77 kB │ gzip: 1.71 kB
.svelte-kit/output/client/_app/immutable/nodes/6.7265cad3.js 4.53 kB │ gzip: 1.93 kB
.svelte-kit/output/client/_app/immutable/nodes/4.41943ab9.js 4.99 kB │ gzip: 2.06 kB
.svelte-kit/output/client/_app/immutable/nodes/7.33022ab8.js 5.13 kB │ gzip: 2.09 kB
.svelte-kit/output/client/_app/immutable/chunks/index.ee4472c9.js 5.90 kB │ gzip: 2.51 kB
.svelte-kit/output/client/_app/immutable/entry/app.2b7fc7d3.js 8.33 kB │ gzip: 2.67 kB
.svelte-kit/output/client/_app/immutable/nodes/0.9f73b240.js 23.26 kB │ gzip: 7.68 kB
.svelte-kit/output/client/_app/immutable/entry/start.cf548541.js 23.73 kB │ gzip: 9.38 kB
.svelte-kit/output/client/_app/immutable/chunks/index.e68bcff4.js 27.10 kB │ gzip: 10.20 kB
✓ built in 3.24s
.svelte-kit/output/server/.vite/manifest.json 9.26 kB
.svelte-kit/output/server/_app/immutable/assets/_page.ff1cfcc4.css 0.04 kB
.svelte-kit/output/server/_app/immutable/assets/_layout.3a6d0da3.css 4.42 kB
.svelte-kit/output/server/entries/pages/_layout.server.ts.js 0.08 kB
.svelte-kit/output/server/chunks/emailVerificationPurposes.js 0.13 kB
.svelte-kit/output/server/entries/pages/_page.server.ts.js 0.14 kB
.svelte-kit/output/server/entries/matchers/emailVerificationPurpose.js 0.17 kB
.svelte-kit/output/server/internal.js 0.19 kB
.svelte-kit/output/server/entries/endpoints/(loggedIn)/logout/_server.ts.js 0.30 kB
.svelte-kit/output/server/entries/pages/_page.svelte.js 0.39 kB
.svelte-kit/output/server/entries/fallbacks/error.svelte.js 0.47 kB
.svelte-kit/output/server/chunks/stores.js 0.52 kB
.svelte-kit/output/server/chunks/lucia.js 0.52 kB
.svelte-kit/output/server/entries/pages/(loggedIn)/change-email/_token_/_page.svelte.js 0.95 kB
.svelte-kit/output/server/entries/pages/(loggedOut)/login/_page.server.ts.js 1.09 kB
.svelte-kit/output/server/chunks/db.js 1.14 kB
.svelte-kit/output/server/entries/pages/(loggedIn)/change-email/_token_/_page.server.ts.js 1.31 kB
.svelte-kit/output/server/entries/pages/(loggedIn)/change-profile/_page.server.ts.js 1.76 kB
.svelte-kit/output/server/entries/pages/(loggedOut)/reset-password/_token_/_page.server.ts.js 1.90 kB
.svelte-kit/output/server/chunks/_layout.server.js 2.02 kB
.svelte-kit/output/server/entries/pages/_purpose_emailVerificationPurpose_/_page.svelte.js 2.15 kB
.svelte-kit/output/server/chunks/hooks.server.js 2.22 kB
.svelte-kit/output/server/entries/pages/(loggedOut)/login/_page.svelte.js 2.27 kB
.svelte-kit/output/server/chunks/index.js 2.29 kB
.svelte-kit/output/server/entries/pages/(loggedOut)/signup/_token_/_page.server.ts.js 2.40 kB
.svelte-kit/output/server/entries/pages/(loggedOut)/reset-password/_token_/_page.svelte.js 2.54 kB
.svelte-kit/output/server/entries/pages/_purpose_emailVerificationPurpose_/_page.server.ts.js 2.61 kB
.svelte-kit/output/server/chunks/index3.js 2.65 kB
.svelte-kit/output/server/entries/pages/(loggedIn)/change-profile/_page.svelte.js 2.67 kB
.svelte-kit/output/server/entries/pages/(loggedOut)/signup/_token_/_page.svelte.js 2.70 kB
.svelte-kit/output/server/chunks/navigation.js 2.72 kB
.svelte-kit/output/server/chunks/internal.js 5.44 kB
.svelte-kit/output/server/chunks/stringify.js 6.44 kB
.svelte-kit/output/server/chunks/ssr.js 7.72 kB
.svelte-kit/output/server/chunks/superValidate.js 8.93 kB
.svelte-kit/output/server/chunks/errors.js 18.22 kB
.svelte-kit/output/server/entries/pages/_layout.svelte.js 26.58 kB
.svelte-kit/output/server/chunks/index2.js 44.74 kB
.svelte-kit/output/server/index.js 102.76 kB
Run npm run preview to preview your production build locally.
> Using @sveltejs/adapter-node
✔ done
✓ built in 19.50s
$ ls build
client/ env.js handler.js index.js server/ shims.js
$ HOST=127.0.0.1 PORT=4000 node build
[error] Couldn't resolve parser "svelte".
ちゃんと build/ にファイルは作成され、
node build でサーバーは立ち上がるのだけれど、
アクセスするとデータベースが読めないという 500 エラーが出る。
これか→ https://github.com/tailwindlabs/prettier-plugin-tailwindcss/issues/113#issuecomment-1368282240
LANG: console
PrismaClientInitializationError:
Invalid `prisma.authSession.findUnique()` invocation:
Error querying the database: Error code 14: Unable to open the database file
at ni.handleRequestError (C:\Users\osamu\Desktop\svelte\authtest\node_modules\.pnpm\@prisma+client@5.6.0_prisma@5.6.0\node_modules\@prisma\client\runtime\library.js:124:7090)
at ni.handleAndLogRequestError (C:\Users\osamu\Desktop\svelte\authtest\node_modules\.pnpm\@prisma+client@5.6.0_prisma@5.6.0\node_modules\@prisma\client\runtime\library.js:124:6206)
...
.prettierrc
- "plugins": ["prettier-plugin-tailwindcss"],
+ "plugins": [
+ "prettier-plugin-svelte",
+ "prettier-plugin-tailwindcss"
+ ],
データベース関連の設定をするにはどうしたら？？？
として、
https://www.reddit.com/r/sveltejs/comments/14xxgt5/deploy_sveltekit_with_prisma_to_node_server_with/
- npx prisma migrate deploy
- npx prisma generate
が必要らしい。
LANG: console
$ mkdir build/db
$ DATABASE_URL="file:/c/Users/osamu/Desktop/svelte/authtest/build/db/prod.db" npx prisma migrate deploy
Environment variables loaded from .env
Prisma schema loaded from prisma\schema.prisma
Datasource "db": SQLite database "prod.db" at "file:/c/Users/osamu/Desktop/svelte/authtest/build/db/prod.db"
$ pnpm add -D prettier-plugin-svelte
Packages: +2 -1
++-
Progress: resolved 348, reused 325, downloaded 0, added 1, done
SQLite database prod.db created at file:/c/Users/osamu/Desktop/svelte/authtest/build/db/prod.db
devDependencies:
+ prettier-plugin-svelte 3.1.2
5 migrations found in prisma/migrations
Done in 5.3s
$ git reset --soft HEAD^
$ git add package.json pnpm-lock.yaml .prettierrc
$ git commit -m "DaisyUI を入れて見た目を整えた"
.prettierrc 187ms
package.json 6ms (unchanged)
Applying migration `20231121075732_add_tables_for_lucia`
Applying migration `20231121093844_alter_tables_for_lucia_v2_again`
Applying migration `20231121112232_add_roles`
Applying migration `20231121112522_alter_roles`
Applying migration `20231122211319_add_email_verification_table`
🌼 daisyUI 4.4.14
├─ ✔︎ 1 theme added https://daisyui.com/docs/themes
╰─ ★ Star daisyUI on GitHub https://github.com/saadeghi/daisyui
The following migrations have been applied:
migrations/
└─ 20231121075732_add_tables_for_lucia/
└─ migration.sql
└─ 20231121093844_alter_tables_for_lucia_v2_again/
└─ migration.sql
└─ 20231121112232_add_roles/
└─ migration.sql
└─ 20231121112522_alter_roles/
└─ migration.sql
└─ 20231122211319_add_email_verification_table/
└─ migration.sql
$ DATABASE_URL="file:/c/Users/osamu/Desktop/svelte/authtest/build/db/prod.db" npx prisma generate
Environment variables loaded from .env
Prisma schema loaded from prisma\schema.prisma
✔ Generated Prisma Client (v5.6.0) to .\node_modules\.pnpm\@prisma+client@5.6.0_prisma@5.6.0\node_modules\@prisma\client in 308ms
Start using Prisma Client in Node.js (See: https://pris.ly/d/client)
```
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
```
or start using Prisma Client at the edge (See: https://pris.ly/d/accelerate)
```
import { PrismaClient } from '@prisma/client/edge'
const prisma = new PrismaClient()
```
See other ways of importing Prisma Client: http://pris.ly/d/importing-client
$ DATABASE_URL="file:/c/Users/osamu/Desktop/svelte/authtest/build/db/prod.db" HOST=127.0.0.1 PORT=4000 node build
postcss.config.cjs 3734ms (unchanged)
src/app.pcss 109ms (unchanged)
src/hooks.server.ts 104ms (unchanged)
src/lib/components/Button.svelte 228ms
src/lib/components/Dialog.svelte 44ms
src/lib/components/Form.svelte 58ms
src/lib/components/InputPassword.svelte 35ms
src/lib/components/InputText.svelte 51ms
src/lib/index.ts 16ms (unchanged)
src/lib/server/index.ts 19ms (unchanged)
src/routes/+layout.svelte 31ms
src/routes/+page.svelte 21ms (unchanged)
src/routes/account/(logout)/new/+page.server.ts 38ms (unchanged)
src/routes/account/(logout)/new/+page.svelte 59ms
src/routes/session/(login)/delete/+server.ts 26ms (unchanged)
src/routes/session/(logout)/new/+page.server.ts 31ms (unchanged)
src/routes/session/(logout)/new/+page.svelte 33ms
svelte.config.js 12ms (unchanged)
tailwind.config.cjs 11ms
[master 6531fb9] DaisyUI を入れて見た目を整えた
22 files changed, 678 insertions(+), 82 deletions(-)
create mode 100644 postcss.config.cjs
create mode 100644 src/app.pcss
create mode 100644 src/lib/components/Button.svelte
create mode 100644 src/lib/components/Dialog.svelte
create mode 100644 src/lib/components/Form.svelte
create mode 100644 src/lib/components/InputPassword.svelte
create mode 100644 src/lib/components/InputText.svelte
create mode 100644 src/lib/server/index.ts
create mode 100644 tailwind.config.cjs
これでデータベースには接続できた。
どうして prettier-plugin-svelte を取り除こうと思ったし？？？
ただ form を POST すると 403 Forbidden になる。~
strict-origin-when-cross-origin のせいっぽい。
* リンクを追加 [#a2ea0232]
起動時に ORIGIN を指定してやれば大丈夫だった。
LANG: html
<p>アカウントをお持ちなら <a class="link link-primary" href="/session/new">ログイン</a></p>
LANG: console
$ DATABASE_URL="file:/c/Users/osamu/Desktop/svelte/authtest/build/db/prod.db" HOST=127.0.0.1 PORT=4000 ORIGIN="http://localhost:4000" node build
みたいのを入れたいのだけれど URL_ROOT を変えられるようにしておきたいので、
ん？
動くには動くのだけれど build/db/prod.db にファイルが見つからない？？？
データベース本体はどこに作られているのか？！
うわぁ、ここにあった。
C:\c\Users\osamu\Desktop\svelte\authtest\build\db
これは MingW64 限定の問題だけど、データベースファイル位置をフルパスで指定するには
DATABASE_URL="file:/c/Users/osamu/Desktop/svelte/authtest/build/db/prod.db"
ではなく、
DATABASE_URL="file:/Users/osamu/Desktop/svelte/authtest/build/db/prod.db"
としないとダメみたいだった。
** ダメなパスワードを検出してエラーにする [#gb55701b]
- worst password list~
https://github.com/danielmiessler/SecLists/blob/master/Passwords/Common-Credentials/10-million-password-list-top-100000.txt
をデータベースに入れておき、ここに載っていたら弾く。
*** Prisma への seeding [#w3deb79e]
そのために上記のリストを Prisma のデータベースに入れたい。
https://m-shige1979.hatenablog.com/entry/2021/11/20/213051
あたりを参考にしつつ、
prisma/seed.ts
src/app.d.ts
LANG: ts
import { db } from '../src/lib/server/db';
import * as fs from 'fs';
async function main() {
await db.worstPassword.deleteMany();
const text = fs.readFileSync('./prisma/seed/10-million-password-list-top-1000000.txt', 'utf-8');
text.split(/\n\r?|\r/).forEach(async (value, rank)=> {
await db.worstPassword.create({data:{value, rank}})
})
}
main()
.catch((e) => {
console.error(e)
process.exit(1)
})
.finally(async () => {
await db.$disconnect()
})
interface PageData {
flash?: { type: 'success' | 'error'; message: string };
+ urlRoot: string;
}
これを実行するために以下を行う
- prisma/seed に 10-million-password-list-top-100000.txt をダウンロード
- ts-node を入れて .ts ファイルを直接実行可能にする
-- 参照 https://qiita.com/mangano-ito/items/75e65071c9c482ddc335
- そして ./node_modules/.bin/ts-node prisma/seed.ts
LANG: console
$ mkdir prisma/seed
$ curl https://raw.githubusercontent.com/danielmiessler/SecLists/master/Passwords/Common-Credentials/10-million-password-list-top-100000.txt > prisma/seed/10-million-password-list-top-100000.txt
$ npm install --save typescript ts-node
$ ./node_modules/.bin/ts-node prisma/seed.ts
TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" for C:\Users\osamu\Desktop\svelte\authtest\prisma\seed.ts
at new NodeError (node:internal/errors:399:5)
at Object.getFileProtocolModuleFormat [as file:] (node:internal/modules/esm/get_format:79:11)
at defaultGetFormat (node:internal/modules/esm/get_format:121:38)
at defaultLoad (node:internal/modules/esm/load:81:20)
at nextLoad (node:internal/modules/esm/loader:163:28)
at ESMLoader.load (node:internal/modules/esm/loader:605:26)
at ESMLoader.moduleProvider (node:internal/modules/esm/loader:457:22)
at new ModuleJob (node:internal/modules/esm/module_job:64:26)
at ESMLoader.#createModuleJob (node:internal/modules/esm/loader:480:17)
at ESMLoader.getModuleJob (node:internal/modules/esm/loader:434:34) {
code: 'ERR_UNKNOWN_FILE_EXTENSION'
}
エラーが出た。
https://qiita.com/nyanchu/items/82903e0463fa9d558639 を参考にして tsconfig.json を書き換える。
tsconfig.json
LANG: json
{
"extends": "./.svelte-kit/tsconfig.json",
+ "ts-node": {
+ "esm": true,
+ "experimentalSpecifierResolution": "node"
+ },
...
これで実行はされるようになった・・・が、
LANG: console
$ ./node_modules/.bin/ts-node prisma/seed.ts
<--- Last few GCs --->
[54920:00000183318518E0] 42008 ms: Mark-sweep (reduce) 2047.2 (2083.1) -> 2046.6 (2083.6) MB, 765.8 / 0.0 ms (+ 46.6 ms in 14 steps since start of marking, biggest step 4.6 ms, walltime since start of marking 828 ms) (average mu = 0.382, current mu = [54920:00000183318518E0] 44566 ms: Mark-sweep (reduce) 2047.7 (2083.6) -> 2047.3 (2084.4) MB, 2164.6 / 0.0 ms (+ 58.2 ms in 12 steps since start of marking, biggest step 7.2 ms, walltime since start of marking 2238 ms) (average mu = 0.228, current mu
<--- JS stacktrace --->
FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory
...
メモリ不足で落ちた。
prisma/seed.ts
src/routes/+layout.server.ts
LANG: ts
- text.split(/\n\r?|\r/).forEach(async (value, rank)=> {
- await db.worstPassword.create({data:{value, rank}})
- })
+ const items = text.split(/\n\r?|\r/);
+ for(let rank = 0; rank < items.length; rank++) {
+ const value = items[rank];
+ await db.worstPassword.create({data:{value, rank}})
+ }
あー、考えてみれば元のコードでは forEach に与えてる async 関数を誰も await
していなかったのでひたすら Promise の山が生成されてしまっていた。
素人丸出しのダメコードだった。
１つ１つの create を await するようにしたところ、時間はかかったものの、
ちゃんとデータが追加された。
*** npm で動かせるようにする [#of203763]
package.json
LANG: json
"dependencies": {
"@lucia-auth/adapter-prisma": "^3.0.2",
"@prisma/client": "^5.6.0",
"lucia": "^2.7.4",
"nodemailer": "^6.9.7",
"svelte-french-toast": "^1.2.0",
"ts-node": "^10.9.1"
},
+ "prisma": {
+ "seed": "ts-node prisma/seed.ts"
+ }
}
これで、
LANG: console
$ npm prisma db seed
Environment variables loaded from .env
Running seed command `ts-node prisma/seed.ts` ...
の形で seeding が行える。
ただ、 https://github.com/prisma/prisma/discussions/18057 などによると
seeding というのはあくまで開発途上でデータベースにテストデータを入れたりするのに
使われるものなので、今回の用途のように本番環境でも使うようなのはいわゆる seeding
の用途とは異なるようだ。
上記の処理は非常に長い時間もかかるので seed コマンドとは異なる形で実行できるように
しておくべきっぽい。
どうするべきか要検討。
*** パスワードを検証するのに使う [#g91c4d92]
src/lib/formSchemas/changeProfile.ts
LANG: ts
import { z } from 'zod';
+ import { db } from '$lib/server/db';
export const schema = z
.object({
name: z.string().min(3, { message: 'ユーザー名は3文字以上で入力してください' }),
password: z.string().regex(/^$|^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9]).{8,}$/, {
message: 'パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください'
}),
confirm: z.string()
})
.refine((data) => data.password === data.confirm, {
message: '確認用パスワードが一致しません',
path: ['confirm']
+ })
+ .superRefine(async (data, ctx) => {
+ const record = await db.worstPassword.findUnique({where: {value: data.password}, select: {rank: true}});
+ if(record) {
+ ctx.addIssue({
+ code: z.ZodIssueCode.custom,
+ message: `容易に推測可能なパスワードです (rank = ${record.rank})`,
+ fatal: true,
+ path: ['password'],
+ });
+ return z.NEVER;
+ }
});
うまく判定されるようになった。
src/lib/formSchemas/resetPassword.ts や src/lib/formSchemas/signup.ts も同様に変更するため、
判定部分を切り出した。
authtest\src\lib\formSchemas\superRefine\password.ts
LANG: ts
import { z } from 'zod';
import { db } from '$lib/server/db';
import { loadFlash } from 'sveltekit-flash-message/server';
import { urlRoot } from '$lib/server';
export async function refinerForPassword(data: {password: string}, ctx: z.RefinementCtx) {
const record = await db.worstPassword.findUnique({where: {value: data.password}, select: {rank: true}});
if(record) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
message: `容易に推測可能なパスワードです (rank = ${record.rank})`,
fatal: true,
path: ['password'],
});
return z.NEVER;
}
}
export const load = loadFlash(async () => {
const data = { urlRoot };
return data;
});
これを使うと個々の schema では１行追加するだけで済む。
として各ページで data.urlRoot を参照できるようにする。
.superRefine(refinerForPassword);
これを使って、
src/lib/formSchemas/changeProfile.ts
LANG: ts
import { z } from 'zod';
* import { refinerForPassword } from './superRefine/password'
export const schema = z
.object({
name: z.string().min(3, { message: 'ユーザー名は3文字以上で入力してください' }),
password: z.string().regex(/^$|^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9]).{8,}$/, {
message: 'パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください'
}),
confirm: z.string()
})
.refine((data) => data.password === data.confirm, {
message: '確認用パスワードが一致しません',
path: ['confirm']
})
* .superRefine(refinerForPassword);
src/lib/formSchemas/resetPassword.ts
src/lib/formSchemas/signup.ts
も同様にする。
*** パスワード検証 API を用意する [#oec090e8]
サブミットしてみなくても脆弱性が分かるよう、
クライアントサイドから確認するための API を用意する。
src/routes/password-ranking/+server.ts
LANG: ts
import { json } from '@sveltejs/kit';
import { db } from '$lib/server/db'
export async function POST({ request }) {
const { password } = await request.json();
const record = await db.worstPassword.findUnique({where: {value: password}, select: {rank: true}});
if(record) {
return json(record.rank + 1);
}
return json(0);
}
*** パスワード入力フォームから使う [#d9089ba2]
src/routes/account/(logout)/new/+page.svelte
LANG: html
<input type="password" name="password" bind:value={$form.password} disabled={$submitting} on:input={checkPassword} />
+ <p>アカウントをお持ちなら <a class="link link-primary" href={data.urlRoot+'/session/new'}>ログイン</a></p>
のように onInput イベントを拾って、
LANG: ts
let timer: NodeJS.Timeout;
function checkPassword(e: Event) {
const password = (e.target as HTMLInputElement).value;
if (password && password.length < 8) {
errors.update((e)=>{e.password = ['パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください']; return e});
return;
}
// 一旦エラーをキャンセル
errors.update((e)=>{e.password = undefined; return e});
// 設定待ちがあればキャンセル
clearTimeout(timer);
// 500 ms 後に設定
timer = setTimeout(()=> checkPasswordSub(password), 500);
}
function checkPasswordSub(password: string) {
if(!password.match(/^$|^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9]).{8,}$/)) {
errors.update((e)=>{e.password = ['パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください']; return e});
} else {
const method = "POST";
const body = JSON.stringify({ password });
const headers = {
'Accept': 'application/json',
'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8'
};
fetch("/password-ranking", {method, headers, body})
.then((res)=> res.json())
.then((rank) => {
if(rank) {
errors.update((e)=>{e.password = [`容易に推測可能なパスワードです (rank = ${rank})`]; return e});
} else {
errors.update((e)=>{e.password = undefined; return e});
}
})
}
}
のようにエラーチェックする。
他でも使えるようこれをコンポーネント化したい。
*** コンポーネント化する [#f33ce260]
ラベル + Input + エラー表示をひとまとめにする。
type を動的に変更すると文句を言われるので、
src/routes/session/(logout)/new/+page.svelte
LANG: html
<input {...{ name, type }}
+ <p>アカウントをお持ちでなければ <a class="link link-primary" href={data.urlRoot+'/account/new'}>サインアップ</a></p>
の形にしている。
src/lib/components/LabeledInput.svelte
LANG: html
<script lang="ts">
import type { Writable } from 'svelte/store';
export let name: string;
export let label: string;
export let type = "text";
export let value: string;
export let disabled = false;
export let errors: Writable<{}> | undefined = undefined;
let key = name as keyof typeof errors;
</script>
<label for={name}>{label}</label>
<input {...{ name, type }} bind:value disabled={disabled} on:input />
{#if errors && $errors[key]}<span class="invalid">{$errors[key]}</span>{/if}
<style>
.invalid {
color: red;
}
</style>
パスワードに特化してエラーチェックを行うのがこちら。
src/lib/components/PasswordInput.svelte
LANG: html
<script lang="ts">
import type { Writable } from 'svelte/store';
import LabeledInput from '$lib/components/LabeledInput.svelte';
export let name: string;
export let label: string;
export let value: string;
export let disabled = false;
export let errors: Writable<{password?:string[]}> | undefined = undefined;
function checkPasswordSub(password: string) {
if(!password.match(/^$|^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9]).{8,}$/)) {
errors?.update((e)=>{e.password = ['パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください']; return e});
} else {
const method = "POST";
const body = JSON.stringify({ password });
const headers = {
'Accept': 'application/json',
'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8'
};
fetch("/password-ranking", {method, headers, body})
.then((res)=> res.json())
.then((rank) => {
if(rank) {
errors?.update((e)=>{e.password = [`容易に推測可能なパスワードです (rank = ${rank})`]; return e});
} else {
errors?.update((e)=>{e.password = undefined; return e});
}
})
}
}
let timer: NodeJS.Timeout;
function checkPassword(e: Event) {
console.log('ok');
const password = (e.target as HTMLInputElement).value;
if (password && password.length < 8) {
errors?.update((e)=>{e.password = ['パスワードは小文字・大文字・数字を一文字以上含めて8文字以上で入力してください']; return e});
return;
}
// 一旦エラーをキャンセル
errors?.update((e)=>{e.password = undefined; return e});
// 設定待ちがあればキャンセル
clearTimeout(timer);
// 500 ms 後に設定
timer = setTimeout(()=> checkPasswordSub(password), 500);
}
</script>
<LabeledInput {...{name, label, disabled, errors}} type="password" bind:value on:input={checkPassword} />
これらを使うとフォーム定義がすっきりする。
src/routes/(loggedIn)/change-profile/+page.svelte
LANG: html
<script lang="ts">
import type { PageData } from './$types';
import { superForm } from 'sveltekit-superforms/client';
import LabeledInput from '$lib/components/LabeledInput.svelte';
import PasswordInput from '$lib/components/PasswordInput.svelte';
export let data: PageData;
const { form, message, errors, submitting, capture, restore, enhance } = superForm(data.form, {
taintedMessage: false
});
export const snapshot = { capture, restore };
</script>
<div>
<h1>ユーザー情報の変更</h1>
{#if $message}<span class="invalid">{$message}</span>{/if}
<form method="POST" use:enhance>
<LabeledInput name="name" label="ユーザー名" bind:value={$form.name} disabled={$submitting} {errors} />
<LabeledInput name="email" label="メールアドレス" value={data.user.email} disabled={true} />
<PasswordInput name="password" label="パスワード（変更しないなら何も入力しない）" value={$form.password} disabled={$submitting} errors={errors} />
<LabeledInput name="confirm" label="パスワード（確認）" type="password" value={$form.confirm} disabled={$submitting} {errors} />
<div><button disabled={$submitting}>ユーザー情報を変更</button></div>
</form>
</div>
他の form もこれに準じて直す。
** いまさらテストを追加 [#iac1c315]
サーバーの起動とテストの実行を切り離した方が使いやすそう？
*** サーバーの起動 [#r621d0b1]
デバッグサーバーでテストするならこう
LANG: console
$ DATABASE_URL="file:test.db" bash -c 'prisma migrate reset -f && pnpm dev --port 4173'
ビルド済みでテストするならこう
LANG: console
$ DATABASE_URL="file:test.db" bash -c 'prisma migrate reset -f && pnpm build && pnpm preview --port 4173'
これを package.json に入れる方法が良く分からない？
https://qiita.com/riversun/items/d45b26f4a7aad6e51b69 によると、
LANG: console
$ npm install --save-dev cross-env
しておいて、
package.json
+ "test-dev": "cross-env DATABASE_URL='file:test.db' prisma migrate reset -f && cross-env DATABASE_URL='file:test.db' vite dev --port 4173",
+ "test-preview": "cross-env DATABASE_URL='file:test.db' prisma migrate reset -f && cross-env DATABASE_URL='file:test.db' vite build && cross-env DATABASE_URL='file:test.db' vite preview --port 4173"
こうかな？
*** テストの実行 [#o5d2e777]
上記のコマンドでサーバーを起動しておいて、
playwright.config.ts
LANG: ts
import type { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {
webServer: {
command: "",
port: 4173,
reuseExistingServer: !process.env.CI,
},
testDir: 'tests',
testMatch: /(.+\.)?(test|spec)\.[jt]s/,
};
export default config;
および
package.json
- "test:integration": "playwright test",
+ "test:integration": "cross-env DATABASE_URL='file:test.db' playwright test",
の設定で
LANG: console
$ pnpm test:integration
とすればいい。
*** テスト時のメールは実際に送信する代わりにファイルに保存する [#l8b2cdac]
src/lib/server/transporter.ts
LANG: ts
import { createTransport, type SentMessageInfo, type SendMailOptions } from "nodemailer";
import { env } from "$env/dynamic/private";
import * as fs from "fs";
export const transporter = createTransport({
host: "localhost",
port: 25,
});
if(env.DATABASE_URL=='file:dev.db' || env.DATABASE_URL=='file:test.db') {
transporter.sendMail = async (mailOptions: SendMailOptions) => {
console.log(process.cwd());
console.log(mailOptions);
fs.writeFileSync('test-results/mailOptions.txt', JSON.stringify(mailOptions));
return null as SentMessageInfo;
};
}
*** テストを書く [#i8e7b89e]
https://playwright.dev/docs/api/class-test
例えばこんな風に書ける。
LANG: ts
test('/signup へフォームを送信', async ({ page }) => {
await page.goto('/signup', {waitUntil: 'load'});
await page.locator('input[name="email"]').fill('test@example.com');
Promise.all([
page.locator('input[name="email"]').press('Enter'),
page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'})
]);
await expect(page.getByRole('heading', { name: 'Welcome to Svelte' })).toBeVisible();
});
でもこれを、
LANG: ts
await page.locator('input[name="email"]').fill('test@example.com');
await page.locator('form button').click();
とすると email フィールドへの入力が送信データに反映されないケースがあったり（svelte による reactivity が発揮される前にフォームが送信されてしまうため？）、
なぜか fill を２回繰り返さないと書き込み自体を行えないケースがあったり、
LANG: ts
await page.locator('input[name="email"]').fill('test@example.com');
await page.locator('input[name="email"]').fill('test@example.com'); // 念のためもう一度 orz
なかなかに落とし穴も多そうな雰囲気だ？
- locator と WaitForSelector, $, $$ の違い https://qiita.com/ko-he-8/items/85116e1d99ed4b176657
- npm playwright codegen で操作手順の記録ができる https://playwright.dev/docs/codegen-intro
- 以前 --ui オプションで GUI が立ち上がるのを確認した記録があるのだけれど、このプロジェクトにインストールされているバージョンだとそんなオプションないと言われる？
- https://www.summerbud.org/dev-notes/playwright-tips-that-will-make-your-life-easier
-- .fill などは readonly や disable の間はそうじゃなくなるまで待つらしい
-- race condition を避けるために Promise.all を使う
- DEBUG=pw:api pnpm test:integration で verbose な出力が得られる
- テストは test( を test.skip( にするとスキップできる
tests/auth.test.ts
LANG: ts
import { expect, test, type Page, type TestInfo } from '@playwright/test';
import type { SendMailOptions } from "nodemailer";
import * as fs from "fs";
import { db } from '../src/lib/server/db.js';
test.setTimeout(5000);
let testId = 0;
let screenshotId = 0;
let screenshotTitle = "";
async function screenshot(page: Page, info: TestInfo) {
if(screenshotTitle != info.title) {
testId++;
screenshotTitle = info.title;
screenshotId = 0;
}
await page.screenshot({path: `test-results/ss${testId.toString().padStart(4, '0')}-${info.title.replaceAll("/","_")}${++screenshotId}.png`})
}
test('データベースをクリアする', async () => {
await db.emailVerification.deleteMany()
await db.authUser.deleteMany();
expect(await db.emailVerification.count()).toBe(0);
expect(await db.authUser.count()).toBe(0);
});
test('インデックスページを表示できる', async ({ page }, info) => {
await page.goto('/', {waitUntil: 'load'});
await expect(page.getByRole('heading', { name: 'Welcome to Svelte' })).toBeVisible();
await screenshot(page, info);
});
test('/signup のメールアドレスの検証', async ({ page }, info) => {
await page.goto('/signup', {waitUntil: 'load'});
await page.locator('input[name="email"]').fill('');
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="email"]+.invalid')).toContainText('メールアドレスが不正です');
await page.locator('input[name="email"]').fill('abcd@');
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="email"]+.invalid')).toContainText('メールアドレスが不正です');
await page.locator('input[name="email"]').fill('@abcc');
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="email"]+.invalid')).toContainText('メールアドレスが不正です');
await screenshot(page, info);
});
test('メールアドレスを入力する /signup', async ({ page }, info) => {
await page.goto('/signup', {waitUntil: 'load'});
await page.locator('input[name="email"]').fill('test@example.com');
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('form button')).not.toBeVisible();
await page.waitForLoadState('load');
await expect(page.url()).toBe('http://localhost:4173/');
await expect(page.locator('.toaster .message')).toHaveText('メールを送信しました')
await page.waitForTimeout(200);
await screenshot(page, info);
});
test('連続して送ろうとするとエラーになる', async ({ page }, info) => {
await page.goto('/signup', {waitUntil: 'load'});
await page.locator('input[name="email"]').fill('test@example.com');
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="email"]+.invalid')).toContainText('先ほどメールを送信しましたのでしばらく経ってから試してください');
await screenshot(page, info);
});
test('サインアップを続ける', async ({ page }, info) => {
const mailOptions = JSON.parse(fs.readFileSync('test-results/mailOptions.txt', 'utf-8')) as SendMailOptions;
await expect(mailOptions.text).toContain('http');
await page.goto((mailOptions.text as string).split(/\n/)[1], {waitUntil: 'load'});
await screenshot(page, info);
await page.click('form button');
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="name"]+.invalid')).toContainText('文字');
await expect(page.locator('input[name="name"]')).not.toHaveProperty('disabled');
await page.locator('input[name="name"]').fill('First Family');
await page.locator('input[name="name"]').fill('First Family'); // 1回だと失敗することがある？？？
await page.locator('input[name="name"]').press('Enter');
await screenshot(page, info);
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="email"]+.invalid')).not.toHaveProperty('disabled');
await screenshot(page, info);
await expect(page.locator('input[name="name"]+.invalid')).not.toBeVisible();
await expect(page.locator('input[name="password"]+.invalid')).toContainText('文字');
await page.fill('input[name="password"]', 'aaaaaaaa');
await page.click('form button');
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="email"]+.invalid')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="password"]+.invalid')).toContainText('文字');
await page.fill('input[name="password"]', 'Aa1aaaaa');
await page.click('form button');
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="email"]+.invalid')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="password"]+.invalid')).not.toBeVisible();
await expect(page.locator('input[name="confirm"]+.invalid')).toContainText('一致しません');
await page.fill('input[name="confirm"]', 'Aa1aaaaa');
await screenshot(page, info);
await page.click('form button');
await expect(page.locator('form button')).not.toHaveProperty('disabled');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toHaveText('サインアップしました')
await page.waitForTimeout(200);
await screenshot(page, info);
// ログアウトする
await logout(page, info);
await page.waitForTimeout(200);
await screenshot(page, info);
});
async function logout(page: Page, info: TestInfo) {
Promise.all([
page.goto('/logout', {waitUntil: 'load'}),
page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'})
]);
await expect(page.locator('.toaster .message').nth(0)).toHaveText('ログアウトしました')
await page.waitForTimeout(200);
await screenshot(page, info);
}
async function login(page: Page, email='test@example.com', password='Aa1aaaaa') {
await page.goto('/login', {waitUntil: 'load'});
await page.locator('input[name="email"]').fill(email);
await page.locator('input[name="password"]').fill(password);
await page.locator('input[name="password"]').press('Enter');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toHaveText('ログインしました');
}
test('ログインしていないのにログアウトする', async ({ page }, info) => {
await page.goto('/logout', {waitUntil: 'load'});
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toHaveText('ログインユーザーのみアクセス可能です')
await page.waitForTimeout(200);
await screenshot(page, info);
});
test('ログインする', async ({ page }, info) => {
// ログインする
await page.goto('/login', {waitUntil: 'load'});
await screenshot(page, info);
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('input[name="email"]')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="email"]+.invalid')).toContainText('入力して下さい');
await page.locator('input[name="email"]').fill('test@example.com');
await page.locator('input[name="email"]').fill('test@example.com');
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('input[name="email"]')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="password"]+.invalid')).toContainText('入力して下さい');
await page.locator('input[name="password"]').fill('Aa1aaaaa');
await screenshot(page, info);
await page.locator('input[name="password"]').press('Enter');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toHaveText('ログインしました');
await page.waitForTimeout(200);
await screenshot(page, info);
});
test('名前やパスワードを変更する', async ({ page }, info)=> {
// ログイン
await login(page);
// 名前・パスワードを変更する（実際にはしない）
await page.goto('/change-profile', {waitUntil: 'load'});
await screenshot(page, info);
await page.locator('input[name="name"]').press('Enter');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toContainText('変更されませんでした');
await page.waitForTimeout(200);
await screenshot(page, info);
// 名前を変更する
await page.goto('/change-profile', {waitUntil: 'load'});
await page.locator('input[name="name"]').fill('First Middle Family');
await page.locator('input[name="name"]').fill('First Middle Family');
await page.locator('input[name="name"]').press('Enter');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toContainText('名前が変更されました');
await page.waitForTimeout(200);
await screenshot(page, info);
// パスワードを変更する
await page.goto('/change-profile', {waitUntil: 'load'});
await screenshot(page, info);
await page.locator('input[name="password"]').fill('Aa1aaaa');
await page.locator('input[name="password"]').fill('Aa1aaaa');
await page.locator('input[name="password"]').press('Enter');
await expect(page.locator('input[name="password"]')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="password"]+.invalid')).toContainText('文字');
await page.locator('input[name="password"]').fill('Aa1aaaab');
await page.locator('input[name="password"]').fill('Aa1aaaab');
await page.locator('input[name="password"]').press('Enter');
await expect(page.locator('input[name="password"]')).not.toHaveProperty('disabled');
await expect(page.locator('input[name="confirm"]+.invalid')).toContainText('一致しません');
await page.locator('input[name="confirm"]').fill('Aa1aaaab');
await page.locator('input[name="confirm"]').fill('Aa1aaaab');
await page.locator('input[name="confirm"]').press('Enter');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toContainText('パスワードが変更されました');
await page.waitForTimeout(200);
await screenshot(page, info);
// 名前とパスワードを変更する
await page.goto('/change-profile', {waitUntil: 'load'});
await screenshot(page, info);
await expect(page.locator('input[name="name"]')).toHaveValue('First Middle Family');
await page.locator('input[name="name"]').fill('First Family');
await page.locator('input[name="name"]').fill('First Family');
await page.locator('input[name="password"]').fill('Aa1aaaaa');
await page.locator('input[name="password"]').fill('Aa1aaaaa');
await page.locator('input[name="confirm"]').fill('Aa1aaaaa');
await page.locator('input[name="confirm"]').fill('Aa1aaaaa');
await screenshot(page, info);
await page.locator('input[name="confirm"]').press('Enter');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toContainText('パスワードと名前が変更されました');
await page.waitForTimeout(200);
await screenshot(page, info);
await logout(page, info);
});
test('メールアドレスを変更する', async ({ page }, info)=> {
// ログイン
await login(page);
await page.goto('/change-email', {waitUntil: 'load'});
await screenshot(page, info);
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('input[name="email"]+.invalid')).toContainText('不正です');
await page.locator('input[name="email"]').fill('changed@example.com');
await page.locator('input[name="email"]').press('Enter');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toContainText('送信しました');
await page.waitForTimeout(200);
await screenshot(page, info);
const mailOptions = JSON.parse(fs.readFileSync('test-results/mailOptions.txt', 'utf-8')) as SendMailOptions;
await expect(mailOptions.text).toContain('http');
await page.goto((mailOptions.text as string).split(/\n/)[1], {waitUntil: 'load'});
await screenshot(page, info);
await expect(page.locator('input[name="name"]')).toHaveValue('First Family');
await expect(page.locator('input[name="email-old"]')).toHaveValue('test@example.com');
await expect(page.locator('input[name="email-new"]')).toHaveValue('changed@example.com');
Promise.all([
page.locator('form button').click(),
page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'})
]);
await expect(page.locator('.toaster .message').nth(0)).toContainText('変更しました');
await page.waitForTimeout(200);
await screenshot(page, info);
// ログアウト
await logout(page, info);
});
test('新しいメールアドレスでログインしてから元に戻す', async ({ page }, info)=> {
await login(page, 'changed@example.com');
await page.goto('/change-email', {waitUntil: 'load'});
await page.locator('input[name="email"]').fill('test@example.com');
await page.locator('input[name="email"]').fill('test@example.com');
await Promise.all([
page.locator('input[name="email"]').press('Enter'),
page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'})
]);
await expect(page.locator('.toaster .message').nth(0)).toContainText('送信しました');
const mailOptions2 = JSON.parse(fs.readFileSync('test-results/mailOptions.txt', 'utf-8')) as SendMailOptions;
await expect(mailOptions2.text).toContain('http');
await page.goto((mailOptions2.text as string).split(/\n/)[1], {waitUntil: 'load'});
await page.locator('form button').click();
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toContainText('変更しました');
await logout(page, info);
});
test('パスワードのリセットを行う', async ({ page }, info) => {
await page.goto('/reset-password', {waitUntil: 'load'});
await screenshot(page, info);
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('input[name="email"]+.invalid')).toContainText('不正です');
await page.locator('input[name="email"]').fill('notfound@example.com');
await page.locator('input[name="email"]').press('Enter');
await expect(page.locator('input[name="email"]+.invalid')).toContainText('登録されていません');
await page.locator('input[name="email"]').fill('test@example.com');
Promise.all([
page.locator('input[name="email"]').press('Enter'),
page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'})
]);
await expect(page.locator('.toaster .message').nth(0)).toContainText('送信しました');
await page.waitForTimeout(200);
await screenshot(page, info);
const mailOptions = JSON.parse(fs.readFileSync('test-results/mailOptions.txt', 'utf-8')) as SendMailOptions;
await expect(mailOptions.text).toContain('http');
await page.goto((mailOptions.text as string).split(/\n/)[1], {waitUntil: 'load'});
await screenshot(page, info);
await expect(page.locator('input[name="name"]')).toHaveValue('First Family');
await expect(page.locator('input[name="email"]')).toHaveValue('test@example.com');
await page.locator('input[name="password"]').press('Enter');
await expect(page.locator('input[name="password"]+.invalid')).toContainText('文字');
await page.locator('input[name="password"]').fill('Aa1aaaaa');
await page.locator('input[name="confirm"]').fill('Aa1aaaaa');
await screenshot(page, info);
await page.locator('input[name="confirm"]').press('Enter');
await page.waitForNavigation({url: 'http://localhost:4173/', waitUntil: 'load'});
await expect(page.locator('.toaster .message').nth(0)).toContainText('パスワードを変更してログインしました');
await page.waitForTimeout(200);
await screenshot(page, info);
});
LANG: console
$ pnpm test:integration
> authtest@0.0.1 test:integration C:\Users\osamu\Desktop\svelte\authtest
> cross-env DATABASE_URL='file:test.db'; playwright test
Running 12 tests using 1 worker
✓ 1 auth.test.ts:13:1 › データベースをクリアする (44ms)
✓ 2 auth.test.ts:21:1 › インデックスページを表示できる (351ms)
✓ 3 auth.test.ts:27:1 › /signup のメールアドレスの検証 (580ms)
✓ 4 auth.test.ts:48:1 › メールアドレスを入力する /signup (749ms)
✓ 5 auth.test.ts:64:1 › 連続して送ろうとするとエラーになる (509ms)
✓ 6 auth.test.ts:75:1 › サインアップを続ける (2s)
✓ 7 auth.test.ts:146:1 › ログインしていないのにログアウトする (569ms)
✓ 8 auth.test.ts:155:1 › ログインする (1s)
✓ 9 auth.test.ts:181:1 › 名前やパスワードを変更する (4s)
✓ 10 auth.test.ts:256:1 › メールアドレスを変更する (2s)
✓ 11 auth.test.ts:297:1 › 新しいメールアドレスでログインしてから元に戻す (1s)
✓ 12 auth.test.ts:321:1 › パスワードのリセットを行う (2s)
Slow test file: auth.test.ts (16s)
Consider splitting slow test files to speed up parallel execution
12 passed (17s)
* 権限を管理する [#a538926a]
AuthUser と 多対多 関係を持つ Role を導入する。
prisma/schema.prisma
model AuthUser {
...
+ roles Role[]
}
$ git add . && git commit -m "ログイン・サインイン間にリンクを追加"
+ model Role {
+ id String @id @default(uuid())
+ name String @unique
+
+ users AuthUser[]
+ }
🌼 daisyUI 4.4.14
├─ ✔︎ 1 theme added https://daisyui.com/docs/themes
╰─ ★ Star daisyUI on GitHub https://github.com/saadeghi/daisyui
src/app.d.ts 1713ms (unchanged)
src/routes/+layout.server.ts 30ms (unchanged)
src/routes/account/(logout)/new/+page.svelte 286ms
src/routes/session/(logout)/new/+page.svelte 81ms
[master 304ac3e] ログイン・サインイン間にリンクを追加
4 files changed, 18 insertions(+), 1 deletion(-)
マイグレーションする。
毎回 daisyUI のメッセージが出るのはそういうもの？
LANG: console
$ npx prisma migrate dev --name "add Role"
https://github.com/saadeghi/daisyui/blob/35dbea89ca5b82dd0c3ba4bb69d5f39a7b7c4d54/src/index.js#L119
Prisma で多対多関係を扱うためのコードは結構煩雑になるようなので、
Role を使うためのユーティリティ関数を db に持たせる。
これなわけだけど・・・
このやり方が良いのかは疑問が残る?
src/lib/server/db.ts
LANG: ts
import { PrismaClient } from '@prisma/client';
export class ExtendedPrismaClient extends PrismaClient {
constructor() { super() }
// userId が undefined なら権限は空とみなされる
async getRoles(userId: string | undefined) {
if(!userId) {
return []
}
return (await this.authUser.findUnique({
where: {id: userId},
select: {roles: true}
}))?.roles || []
}
async getRolesString(userId: string | undefined) {
return (await this.getRoles(userId)).map((role)=> role.name);
}
async hasRole(userId: string | undefined, role: string) {
return (await this.getRolesString(userId)).includes(role);
}
async addRoles(userId: string, ...roles: string[]) {
await this.authUser.update({
where: { id: userId },
data: {
roles: {
connectOrCreate: roles.map(role=>
({where: {name: role}, create: {name: role}})
)
},
},
})
}
async removeRoles(userId: string, ...roles: string[]) {
await this.authUser.update({
where: { id: userId },
data: {
roles: {
deleteMany: roles.map(role=>({name: role}))
},
},
})
}
}
export const db = new ExtendedPrismaClient();
Prisma の言語仕様を見ていると TypeScript と VSCode の存在がいかに偉大か実感する。
こんな DSL はエディタ上でエラー検出してくれなきゃ、とてもじゃないけど書けない。
ところで、
LANG: ts
roles.map(role=>({name: role}))
などという記述に注意が必要。これを
LANG: ts
roles.map(role=>{name: role})
と書いてしまうと role=>{ の { がブロックの開始として解釈されてしまい、うまく行かない。
（その場合 name: はラベルとして解釈される）
JavaScriptのアロー関数でオブジェクトを返す方法~
https://dev.classmethod.jp/articles/arrow-func-return-object/
そこで一見すると無駄に見える括弧で括っている。
サインアップ時、最初のユーザーには admin 権限を持たせることにする。
src/routes/(loggedOut)/signup/+page.server.ts
+ import { db } from '$lib/server/db'
...
+ // 最初のユーザーには admin 権限を持たせる
+ if(await db.authUser.count() == 1) {
+ await db.addRoles(user.userId, 'admin')
+ }
/(admin) あるいは /admin から始まるパスには admin 権限を持っているユーザーしかアクセスできない。
src/hooks.server.ts
LANG:ts
+ if (event.route.id?.startsWith('/(admin)') || event.route.id?.startsWith('/admin')) {
+ if (!await db.hasRole(session?.user?.userId, 'admin')) {
+ return Response.redirect(`${event.url.origin}/`, 302);
+ }
+ }
Counter: 856 (from 2010/06/03),
today: 2,
yesterday: 0