feat: implement auth for folders

This commit is contained in:
Takeshi Kimata
2024-06-01 22:00:45 +09:00
parent d941b2a08e
commit 8300520a86
14 changed files with 188 additions and 63 deletions

View File

@@ -1,9 +1,10 @@
const jwt = require('jsonwebtoken'); const jwt = require('jsonwebtoken');
const { roles, memberRoles, defaultDangerKey } = require('../routes/users/authSettings'); const { roles, memberRoles, defaultDangerKey } = require('../routes/users/authSettings');
const defineProject = require('../models/projects');
const defineUser = require('../models/users');
const { DataTypes } = require('sequelize'); const { DataTypes } = require('sequelize');
const defineUser = require('../models/users');
const defineMember = require('../models/members'); const defineMember = require('../models/members');
const defineProject = require('../models/projects');
const defineFolder = require('../models/folders');
function authMiddleware(sequelize) { function authMiddleware(sequelize) {
/** /**
@@ -56,7 +57,7 @@ function authMiddleware(sequelize) {
async function verifyProjectVisible(req, res, next) { async function verifyProjectVisible(req, res, next) {
const Project = defineProject(sequelize, DataTypes); const Project = defineProject(sequelize, DataTypes);
const projectId = req.params.projectId; const projectId = req.params.projectId || req.query.projectId;
if (!projectId) { if (!projectId) {
return res.status(400).json({ error: 'projectId is required' }); return res.status(400).json({ error: 'projectId is required' });
} }
@@ -140,7 +141,69 @@ function authMiddleware(sequelize) {
return res.status(403).json({ error: 'Forbidden' }); return res.status(403).json({ error: 'Forbidden' });
} }
return { verifySignedIn, verifyAdmin, verifyProjectVisible, verifyProjectOwner, verifyProjectManager }; /**
* Verify user has permission of project development
* (User must be the owner or manager or developer of the project)
* (have to be called after verifySignedIn() middleware)
*/
async function verifyProjectDeveloper(req, res, next) {
const Project = defineProject(sequelize, DataTypes);
const Folder = defineFolder(sequelize, DataTypes);
let projectId = req.params.projectId || req.query.projectId;
const folderId = req.params.folderId || req.query.folderId;
if (!projectId && !folderId) {
return res.status(400).json({ error: 'projectId or folderId is required' });
}
if (!projectId) {
// find project id from folderId
const folder = await Folder.findByPk(folderId);
if (folder && folder.projectId) {
projectId = folder.projectId;
} else {
return res.status(404).send('failed to find project from folderId');
}
}
const project = await Project.findByPk(projectId);
if (!project) {
return res.status(404).send('Project not found');
}
if (project.userId === req.userId) {
next();
return;
}
// check the user is manager or developer of the project
const Member = defineMember(sequelize, DataTypes);
const member = await Member.findOne({
where: {
userId: req.userId,
projectId: projectId,
},
});
if (member) {
const managerRoleIndex = memberRoles.findIndex((entry) => entry.uid === 'manager');
const developerRoleIndex = memberRoles.findIndex((entry) => entry.uid === 'developer');
if (member.role === managerRoleIndex || member.role === developerRoleIndex) {
next();
return;
}
}
return res.status(403).json({ error: 'Forbidden' });
}
return {
verifySignedIn,
verifyAdmin,
verifyProjectVisible,
verifyProjectOwner,
verifyProjectManager,
verifyProjectDeveloper,
};
} }
module.exports = authMiddleware; module.exports = authMiddleware;

View File

@@ -4,9 +4,10 @@ const defineFolder = require('../../models/folders');
const { DataTypes } = require('sequelize'); const { DataTypes } = require('sequelize');
module.exports = function (sequelize) { module.exports = function (sequelize) {
const { verifySignedIn, verifyProjectDeveloper } = require('../../middleware/auth')(sequelize);
const Folder = defineFolder(sequelize, DataTypes); const Folder = defineFolder(sequelize, DataTypes);
router.delete('/:folderId', async (req, res) => { router.delete('/:folderId', verifySignedIn, verifyProjectDeveloper, async (req, res) => {
const folderId = req.params.folderId; const folderId = req.params.folderId;
try { try {
const folder = await Folder.findByPk(folderId); const folder = await Folder.findByPk(folderId);

View File

@@ -4,9 +4,10 @@ const defineFolder = require('../../models/folders');
const { DataTypes } = require('sequelize'); const { DataTypes } = require('sequelize');
module.exports = function (sequelize) { module.exports = function (sequelize) {
const { verifySignedIn, verifyProjectDeveloper } = require('../../middleware/auth')(sequelize);
const Folder = defineFolder(sequelize, DataTypes); const Folder = defineFolder(sequelize, DataTypes);
router.put('/:folderId', async (req, res) => { router.put('/:folderId', verifySignedIn, verifyProjectDeveloper, async (req, res) => {
const folderId = req.params.folderId; const folderId = req.params.folderId;
const { name, detail, projectId, parentFolderId } = req.body; const { name, detail, projectId, parentFolderId } = req.body;
try { try {

View File

@@ -4,9 +4,10 @@ const defineFolder = require('../../models/folders');
const { DataTypes } = require('sequelize'); const { DataTypes } = require('sequelize');
module.exports = function (sequelize) { module.exports = function (sequelize) {
const { verifySignedIn, verifyProjectVisible } = require('../../middleware/auth')(sequelize);
const Folder = defineFolder(sequelize, DataTypes); const Folder = defineFolder(sequelize, DataTypes);
router.get('/', async (req, res) => { router.get('/', verifySignedIn, verifyProjectVisible, async (req, res) => {
const { projectId } = req.query; const { projectId } = req.query;
if (!projectId) { if (!projectId) {

View File

@@ -4,11 +4,13 @@ const defineFolder = require('../../models/folders');
const { DataTypes } = require('sequelize'); const { DataTypes } = require('sequelize');
module.exports = function (sequelize) { module.exports = function (sequelize) {
const { verifySignedIn, verifyProjectDeveloper } = require('../../middleware/auth')(sequelize);
const Folder = defineFolder(sequelize, DataTypes); const Folder = defineFolder(sequelize, DataTypes);
router.post('/', async (req, res) => { router.post('/', verifySignedIn, verifyProjectDeveloper, async (req, res) => {
try { try {
const { name, detail, projectId, parentFolderId } = req.body; const projectId = req.query.projectId;
const { name, detail, parentFolderId } = req.body;
if (!name || !projectId) { if (!name || !projectId) {
return res.status(400).json({ error: 'Name and projectId are required' }); return res.status(400).json({ error: 'Name and projectId are required' });
} }

View File

@@ -138,7 +138,9 @@
"close": "Close", "close": "Close",
"create": "Create", "create": "Create",
"update": "Update", "update": "Update",
"please_enter": "Please enter folder name" "please_enter": "Please enter folder name",
"delete": "Delete",
"are_you_sure": "Are you sure you want to delete the folder?"
}, },
"Cases": { "Cases": {
"test_case_list": "Test Case List", "test_case_list": "Test Case List",

View File

@@ -137,7 +137,9 @@
"close": "閉じる", "close": "閉じる",
"create": "作成", "create": "作成",
"update": "更新", "update": "更新",
"please_enter": "フォルダ名を入力してください" "please_enter": "フォルダ名を入力してください",
"delete": "削除",
"are_you_sure": "フォルダーを削除してもよろしいですか?"
}, },
"Cases": { "Cases": {
"test_case_list": "テストケース一覧", "test_case_list": "テストケース一覧",

View File

@@ -4,7 +4,6 @@ export default function Page(params: { locale: string }) {
const t = useTranslations('Auth'); const t = useTranslations('Auth');
const messages = { const messages = {
yourProjects: t('your_projects'), yourProjects: t('your_projects'),
moveToAdmin: t('move_to_admin'),
}; };
return <AccountPage messages={messages} locale={params.locale} />; return <AccountPage messages={messages} locale={params.locale} />;

View File

@@ -6,7 +6,7 @@ import { FolderType, FoldersMessages } from '@/types/folder';
type Props = { type Props = {
isOpen: boolean; isOpen: boolean;
editingFolder: FolderType; editingFolder: FolderType | null;
onCancel: () => void; onCancel: () => void;
onSubmit: (name: string, detail: string) => void; onSubmit: (name: string, detail: string) => void;
messages: FoldersMessages; messages: FoldersMessages;
@@ -66,7 +66,7 @@ export default function FolderDialog({ isOpen, editingFolder, onCancel, onSubmit
if (!folderName.text) { if (!folderName.text) {
setFolderName({ setFolderName({
text: '', text: '',
isValid: false, isValid: true,
errorMessage: messages.pleaseEnter, errorMessage: messages.pleaseEnter,
}); });

View File

@@ -5,7 +5,7 @@ import { FolderType, FoldersMessages } from '@/types/folder';
type Props = { type Props = {
folder: FolderType; folder: FolderType;
onEditClick: (folder: FolderType) => void; onEditClick: (folder: FolderType) => void;
onDeleteClick: (folder: FolderType) => void; onDeleteClick: (deleteFolderId: number) => void;
messages: FoldersMessages; messages: FoldersMessages;
}; };

View File

@@ -1,14 +1,14 @@
'use client'; 'use client';
import React from 'react';
import { FolderType, FoldersMessages } from '@/types/folder'; import { FolderType, FoldersMessages } from '@/types/folder';
import { useEffect, useState } from 'react'; import { useState, useEffect, useContext } from 'react';
import { Button, Listbox, ListboxItem } from '@nextui-org/react'; import { Button, Listbox, ListboxItem } from '@nextui-org/react';
import { Folder, Plus } from 'lucide-react'; import { Folder, Plus } from 'lucide-react';
import { usePathname, useRouter } from '@/src/navigation'; import { usePathname, useRouter } from '@/src/navigation';
import { TokenContext } from '@/utils/TokenProvider';
import useGetCurrentIds from '@/utils/useGetCurrentIds'; import useGetCurrentIds from '@/utils/useGetCurrentIds';
import FolderDialog from './FolderDialog'; import FolderDialog from './FolderDialog';
import FolderEditMenu from './FolderEditMenu'; import FolderEditMenu from './FolderEditMenu';
import DeleteConfirmDialog from '@/components/DeleteConfirmDialog';
import { fetchFolders, createFolder, updateFolder, deleteFolder } from './foldersControl'; import { fetchFolders, createFolder, updateFolder, deleteFolder } from './foldersControl';
type Props = { type Props = {
@@ -20,50 +20,20 @@ type Props = {
export default function FoldersPane({ projectId, messages, locale }: Props) { export default function FoldersPane({ projectId, messages, locale }: Props) {
const router = useRouter(); const router = useRouter();
const pathname = usePathname(); const pathname = usePathname();
const [folders, setFolders] = useState([]); const context = useContext(TokenContext);
const [selectedFolder, setSelectedFolder] = useState<FolderType>({}); const [folders, setFolders] = useState<FolderType[]>([]);
const [selectedFolder, setSelectedFolder] = useState<FolderType | null>(null);
const { folderId } = useGetCurrentIds(); const { folderId } = useGetCurrentIds();
const [isFolderDialogOpen, setIsFolderDialogOpen] = useState(false); const [isFolderDialogOpen, setIsFolderDialogOpen] = useState(false);
const [editingFolder, setEditingProject] = useState<FolderType | null>(null); const [editingFolder, setEditingProject] = useState<FolderType | null>(null);
const openDialogForCreate = () => {
setIsFolderDialogOpen(true);
setEditingProject(null);
};
const closeDialog = () => {
setIsFolderDialogOpen(false);
setEditingProject(null);
};
const onSubmit = async (name: string, detail: string) => {
if (editingFolder) {
const updatedProject = await updateFolder(editingFolder.id, name, detail, projectId, null);
const updatedProjects = folders.map((project) => (project.id === updatedProject.id ? updatedProject : project));
setFolders(updatedProjects);
} else {
const newProject = await createFolder(name, detail, projectId, null);
setFolders([...folders, newProject]);
}
closeDialog();
};
const onEditClick = (folder: FolderType) => {
setEditingProject(folder);
setIsFolderDialogOpen(true);
};
const onDeleteClick = async (folderId: number) => {
await deleteFolder(folderId);
router.push(`/projects/${projectId}/folders`, { locale: locale });
};
useEffect(() => { useEffect(() => {
async function fetchDataEffect() { async function fetchDataEffect() {
if (!context.isSignedIn()) {
return;
}
try { try {
const data = await fetchFolders(projectId); const data = await fetchFolders(context.token.access_token, projectId);
setFolders(data); setFolders(data);
const selectedFolderFromUrl = data.find((folder) => folder.id === folderId); const selectedFolderFromUrl = data.find((folder) => folder.id === folderId);
@@ -80,7 +50,62 @@ export default function FoldersPane({ projectId, messages, locale }: Props) {
} }
fetchDataEffect(); fetchDataEffect();
}, [folderId]); }, [context, folderId]);
const openDialogForCreate = () => {
setIsFolderDialogOpen(true);
setEditingProject(null);
};
const closeDialog = () => {
setIsFolderDialogOpen(false);
setEditingProject(null);
};
const onSubmit = async (name: string, detail: string) => {
if (editingFolder) {
const updatedProject = await updateFolder(
context.token.access_token,
editingFolder.id,
name,
detail,
projectId,
null
);
const updatedProjects = folders.map((project) => (project.id === updatedProject.id ? updatedProject : project));
setFolders(updatedProjects);
} else {
const newProject = await createFolder(context.token.access_token, name, detail, projectId, null);
setFolders([...folders, newProject]);
}
closeDialog();
};
const onEditClick = (folder: FolderType) => {
setEditingProject(folder);
setIsFolderDialogOpen(true);
};
// Delete confirm dialog
const [isDeleteConfirmDialogOpen, setIsDeleteConfirmDialogOpen] = useState(false);
const [deleteFolderId, setDeleteFolderId] = useState<number | null>(null);
const closeDeleteConfirmDialog = () => {
setIsDeleteConfirmDialogOpen(false);
setDeleteFolderId(null);
};
const onDeleteClick = (deleteFolderId: number) => {
setDeleteFolderId(deleteFolderId);
setIsDeleteConfirmDialogOpen(true);
};
const onConfirm = async () => {
if (deleteFolderId) {
await deleteFolder(context.token.access_token, deleteFolderId);
router.push(`/projects/${projectId}/folders`, { locale: locale });
closeDeleteConfirmDialog();
}
};
const baseClass = ''; const baseClass = '';
const selectedClass = `${baseClass} bg-neutral-200 dark:bg-neutral-700`; const selectedClass = `${baseClass} bg-neutral-200 dark:bg-neutral-700`;
@@ -126,6 +151,15 @@ export default function FoldersPane({ projectId, messages, locale }: Props) {
onSubmit={onSubmit} onSubmit={onSubmit}
messages={messages} messages={messages}
/> />
<DeleteConfirmDialog
isOpen={isDeleteConfirmDialogOpen}
onCancel={closeDeleteConfirmDialog}
onConfirm={onConfirm}
closeText={messages.close}
confirmText={messages.areYouSure}
deleteText={messages.delete}
/>
</> </>
); );
} }

View File

@@ -4,13 +4,14 @@ const apiServer = Config.apiServer;
/** /**
* fetch folder records * fetch folder records
*/ */
async function fetchFolders(projectId: string) { async function fetchFolders(jwt: string, projectId: string) {
try { try {
const url = `${apiServer}/folders?projectId=${projectId}`; const url = `${apiServer}/folders?projectId=${projectId}`;
const response = await fetch(url, { const response = await fetch(url, {
method: 'GET', method: 'GET',
headers: { headers: {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
Authorization: `Bearer ${jwt}`,
}, },
}); });
@@ -28,11 +29,16 @@ async function fetchFolders(projectId: string) {
/** /**
* Create project * Create project
*/ */
async function createFolder(name: string, detail: string, projectId: strting, parentFolderId: number) { async function createFolder(
jwt: string,
name: string,
detail: string,
projectId: string,
parentFolderId: number | null
) {
const newFolderData = { const newFolderData = {
name: name, name: name,
detail: detail, detail: detail,
projectId: projectId,
parentFolderId: parentFolderId, parentFolderId: parentFolderId,
}; };
@@ -40,11 +46,12 @@ async function createFolder(name: string, detail: string, projectId: strting, pa
method: 'POST', method: 'POST',
headers: { headers: {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
Authorization: `Bearer ${jwt}`,
}, },
body: JSON.stringify(newFolderData), body: JSON.stringify(newFolderData),
}; };
const url = `${apiServer}/folders`; const url = `${apiServer}/folders?projectId=${projectId}`;
try { try {
const response = await fetch(url, fetchOptions); const response = await fetch(url, fetchOptions);
@@ -62,7 +69,14 @@ async function createFolder(name: string, detail: string, projectId: strting, pa
/** /**
* Update folder * Update folder
*/ */
async function updateFolder(folderId: number, name: string, detail: string, projectId: string, parentFolderId: number) { async function updateFolder(
jwt: string,
folderId: number,
name: string,
detail: string,
projectId: string,
parentFolderId: number | null
) {
const updateFolderData = { const updateFolderData = {
name: name, name: name,
detail: detail, detail: detail,
@@ -74,6 +88,7 @@ async function updateFolder(folderId: number, name: string, detail: string, proj
method: 'PUT', method: 'PUT',
headers: { headers: {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
Authorization: `Bearer ${jwt}`,
}, },
body: JSON.stringify(updateFolderData), body: JSON.stringify(updateFolderData),
}; };
@@ -96,11 +111,12 @@ async function updateFolder(folderId: number, name: string, detail: string, proj
/** /**
* Delete folder * Delete folder
*/ */
async function deleteFolder(folderId: number) { async function deleteFolder(jwt: string, folderId: number) {
const fetchOptions = { const fetchOptions = {
method: 'DELETE', method: 'DELETE',
headers: { headers: {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
Authorization: `Bearer ${jwt}`,
}, },
}; };

View File

@@ -20,6 +20,8 @@ export default function FoldersLayout({
create: t('create'), create: t('create'),
update: t('update'), update: t('update'),
pleaseEnter: t('please_enter'), pleaseEnter: t('please_enter'),
delete: t('delete'),
areYouSure: t('are_you_sure'),
}; };
return ( return (

View File

@@ -22,4 +22,6 @@ export type FoldersMessages = {
create: string; create: string;
update: string; update: string;
pleaseEnter: string; pleaseEnter: string;
delete: string;
areYouSure: string;
}; };