Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

basic validators for time unit #311

Merged
merged 5 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion backend/src/routes/timeUnit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ import { EditDataType, EditMetaData, TimeUnitDetailsType } from '../../../fronte
import { Role } from '../../../frontend/src/types'
import { requireOneOf } from '../middlewares/authorizer'
import { getAllSequences } from '../services/sequence'
import { getAllTimeUnits, getTimeUnitDetails, getTimeUnitLocalities } from '../services/timeUnit'
import {
getAllTimeUnits,
getTimeUnitDetails,
getTimeUnitLocalities,
validateEntireTimeUnit,
} from '../services/timeUnit'
import { deleteTimeUnit, writeTimeUnit } from '../services/write/timeUnit'
import { fixBigInt } from '../utils/common'

Expand Down Expand Up @@ -37,6 +42,10 @@ router.put(
requireOneOf([Role.Admin, Role.EditUnrestricted]),
async (req: Request<object, object, { timeUnit: EditDataType<TimeUnitDetailsType> & EditMetaData }>, res) => {
const { comment, references, ...editedTimeUnit } = req.body.timeUnit
const validationErrors = validateEntireTimeUnit(editedTimeUnit)
if (validationErrors.length > 0) {
return res.status(400).send({ validationErrors })
}
const result = await writeTimeUnit(editedTimeUnit, comment, references, req.user!.initials)
return res.status(200).send({ id: result })
}
Expand Down
14 changes: 14 additions & 0 deletions backend/src/services/timeUnit.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { logDb, nowDb } from '../utils/db'
import { EditDataType, TimeUnitDetailsType } from '../../../frontend/src/backendTypes'
import { ValidationObject } from '../../../frontend/src/validators/validator'
import { validateTimeUnit } from '../../../frontend/src/validators/timeUnit'
import Prisma from '../../prisma/generated/now_test_client'

export const getAllTimeUnits = async () => {
const result = await nowDb.now_time_unit.findMany({
Expand Down Expand Up @@ -85,3 +89,13 @@ export const getTimeUnitLocalities = async (id: string) => {
})
return result
}

export const validateEntireTimeUnit = (editedFields: EditDataType<Prisma.now_time_unit>) => {
const keys = Object.keys(editedFields)
const errors: ValidationObject[] = []
for (const key of keys) {
const error = validateTimeUnit(editedFields as EditDataType<TimeUnitDetailsType>, key as keyof TimeUnitDetailsType)
if (error.error) errors.push(error)
}
return errors
}
3 changes: 2 additions & 1 deletion frontend/src/components/TimeUnit/TimeUnitDetails.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { UpdateTab } from '../DetailView/common/UpdateTab'
import { DetailView, TabType } from '../DetailView/DetailView'
import { LocalityTab } from './Tabs/LocalityTab'
import { TimeUnitTab } from './Tabs/TimeUnitTab'
import { validateTimeUnit } from '@/validators/timeUnit'

export const TimeUnitDetails = () => {
const { id } = useParams()
Expand Down Expand Up @@ -72,7 +73,7 @@ export const TimeUnitDetails = () => {
hasStagingMode
data={isNew ? emptyTimeUnit : data!}
onWrite={onWrite}
validator={() => ({ name: '', error: null })}
validator={validateTimeUnit}
deleteFunction={deleteFunction}
/>
)
Expand Down
27 changes: 27 additions & 0 deletions frontend/src/validators/timeUnit.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { EditDataType, TimeUnitDetailsType } from '../backendTypes'
import { Validators, validator } from './validator'

export const validateTimeUnit = (editData: EditDataType<TimeUnitDetailsType>, fieldName: keyof TimeUnitDetailsType) => {
const validators: Validators<EditDataType<Partial<TimeUnitDetailsType>>> = {
tu_display_name: {
name: 'Name',
required: true,
},
sequence: {
name: 'Sequence',
required: true,
},
up_bnd: {
name: 'New Upper Bound',
required: true,
asNumber: true,
},
low_bnd: {
name: 'New Lower Bound',
required: true,
asNumber: true,
},
}

return validator<EditDataType<TimeUnitDetailsType>>(validators, editData, fieldName)
}