Merge pull request #636 from nowcommunity/refactor-shared-code-better

Move all shared code to frontend/src/shared & divide types into separate folders

README.md

@@ -94,7 +94,7 @@ Docker:
 
 :memo: [Frontend](documentation/components/frontend.md) Explanation of the frontend logic and how to add views
 
-:mag_right: [Validators](frontend/src/validators/) The [readme](frontend/src/validators/README.md) explains how validators are written
+:mag_right: [Validators](frontend/src/shared/validators/) The [readme](frontend/src/shared/validators/README.md) explains how validators are written
 
 :mag_right: [Class diagram](documentation/class_diagram.md) See the relations of relevant tables. Notice that it omits some unimportant tables and does not show most columns.
 

backend/Dockerfile

@@ -4,13 +4,10 @@ ENV TZ="Europe/Helsinki"
 
 RUN  npm i -g npm
 WORKDIR /usr/src/app
-RUN mkdir -p /usr/src/app/frontend/src/validators
 
 USER node
 
-COPY --chown=node frontend/src/backendTypes.d.ts /usr/src/app/frontend/src/backendTypes.d.ts
-COPY --chown=node frontend/src/types.ts /usr/src/app/frontend/src/types.ts
-COPY --chown=node frontend/src/validators /usr/src/app/frontend/src/validators
+COPY --chown=node frontend/src/shared /usr/src/app/frontend/src/shared/
 COPY --chown=node backend/package.json backend/
 COPY --chown=node backend/package-lock.json backend/
 COPY --chown=node backend/prisma/schema.prisma backend
@@ -41,8 +38,7 @@ RUN chown node:node /usr/src/app -R
 WORKDIR /usr/src/app
 USER node
 
-COPY --from=backend-build --chown=node /usr/src/app/frontend/src/backendTypes.d.ts ../frontend/src/backendTypes.d.ts
-COPY --from=backend-build --chown=node /usr/src/app/frontend/src/types.ts ../frontend/src/types.ts
+COPY --from=backend-build --chown=node /usr/src/app/frontend/src/shared/ ../frontend/src/shared/
 COPY --from=backend-build --chown=node /usr/src/app/backend/build .
 COPY --from=backend-build --chown=node /usr/src/app/backend/node_modules ./backend/node_modules
 COPY --from=backend-build --chown=node /usr/src/app/backend/prisma ./backend/prisma

backend/dev.Dockerfile

@@ -8,7 +8,7 @@ RUN  npm i -g npm
 USER node
 WORKDIR /usr/src/app
 
-RUN mkdir -p /usr/src/app/frontend/src/validators
+RUN mkdir -p /usr/src/app/frontend/src/shared/validators
 
 COPY --chown=node ./backend/package.json backend/
 COPY --chown=node ./backend/package-lock.json backend/

backend/src/api-tests/crossSearch/get.test.ts

@@ -1,4 +1,4 @@
-import type { CrossSearch } from '../../../../frontend/src/backendTypes'
+import type { CrossSearch } from '../../../../frontend/src/shared/types'
 import { beforeAll, afterAll, describe, it, expect } from '@jest/globals'
 import { resetDatabase, send, resetDatabaseTimeout, login, logout } from '../utils'
 import { pool } from '../../utils/db'

backend/src/api-tests/geonames-api.test.ts

@@ -1,5 +1,5 @@
 import { afterAll, describe, it, expect } from '@jest/globals'
-import type { ParsedGeoname } from '../../../frontend/src/backendTypes'
+import type { ParsedGeoname } from '../../../frontend/src/shared/types'
 import { send } from './utils'
 import { pool } from '../utils/db'
 

backend/src/api-tests/geonames-api/data.ts

@@ -1,4 +1,4 @@
-import type { ParsedGeoname } from '../../../../frontend/src/backendTypes'
+import type { ParsedGeoname } from '../../../../frontend/src/shared/types'
 
 export const localities: ParsedGeoname[] = [
   { countryName: 'Finland', lat: 63.05484, lng: 24.75291, name: 'Kumpula' },

backend/src/api-tests/locality/contradictory_loc.test.ts

@@ -1,5 +1,5 @@
 import { beforeEach, beforeAll, afterAll, describe, it, expect } from '@jest/globals'
-import { LocalityDetailsType } from '../../../../frontend/src/backendTypes'
+import { LocalityDetailsType } from '../../../../frontend/src/shared/types'
 import { editedLocality, newLocalityBasis } from './data'
 import { login, resetDatabase, send, resetDatabaseTimeout } from '../utils'
 import { pool } from '../../utils/db'

backend/src/api-tests/locality/create.test.ts

@@ -1,5 +1,5 @@
 import { beforeEach, beforeAll, afterAll, describe, it, expect } from '@jest/globals'
-import { LocalityDetailsType, SpeciesDetailsType } from '../../../../frontend/src/backendTypes'
+import { LocalityDetailsType, SpeciesDetailsType } from '../../../../frontend/src/shared/types'
 import { LogRow } from '../../services/write/writeOperations/types'
 import { newLocalityBasis } from './data'
 import { login, logout, resetDatabase, send, testLogRows, resetDatabaseTimeout, noPermError } from '../utils'

backend/src/api-tests/locality/data.ts

@@ -1,4 +1,4 @@
-import { SpeciesDetailsType } from '../../../../frontend/src/backendTypes'
+import { SpeciesDetailsType } from '../../../../frontend/src/shared/types'
 
 const references = [
   {

backend/src/api-tests/locality/update.test.ts

@@ -1,5 +1,5 @@
 import { beforeEach, beforeAll, afterAll, describe, it, expect } from '@jest/globals'
-import { LocalityDetailsType, SpeciesDetailsType } from '../../../../frontend/src/backendTypes'
+import { LocalityDetailsType, SpeciesDetailsType } from '../../../../frontend/src/shared/types'
 import { LogRow } from '../../services/write/writeOperations/types'
 import { editedLocality } from './data'
 import { login, resetDatabase, send, testLogRows, resetDatabaseTimeout } from '../utils'

backend/src/api-tests/reference/create.test.ts

@@ -1,5 +1,5 @@
 import { beforeEach, beforeAll, afterAll, describe, it, expect } from '@jest/globals'
-import { ReferenceDetailsType } from '../../../../frontend/src/backendTypes'
+import { ReferenceDetailsType } from '../../../../frontend/src/shared/types'
 //import { LogRow } from '../../services/write/writeOperations/types'
 import { newReferenceBasis, emptyReferenceBasis } from './data'
 import { login, logout, resetDatabase, send, /*testLogRows,*/ resetDatabaseTimeout, noPermError } from '../utils'

backend/src/api-tests/reference/data.ts

@@ -1,4 +1,4 @@
-import { EditDataType, /*EditMetaData, Reference,*/ ReferenceDetailsType } from '../../../../frontend/src/backendTypes'
+import { EditDataType, /*EditMetaData, Reference,*/ ReferenceDetailsType } from '../../../../frontend/src/shared/types'
 
 /*
 "ref_type_id": 1, "ref_type": "Journal"'

backend/src/api-tests/reference/delete.test.ts

@@ -1,7 +1,7 @@
 import { afterAll, beforeAll, beforeEach, describe, expect, it } from '@jest/globals'
 import { pool } from '../../utils/db'
 import { login, logout, resetDatabase, resetDatabaseTimeout, send } from '../utils'
-import { ReferenceDetailsType } from '../../../../frontend/src/backendTypes'
+import { ReferenceDetailsType } from '../../../../frontend/src/shared/types'
 import Prisma from '../../../prisma/generated/now_test_client'
 import { newReferenceBasis } from './data'
 

backend/src/api-tests/species/create.test.ts

@@ -1,5 +1,5 @@
 import { beforeEach, beforeAll, afterAll, describe, it, expect } from '@jest/globals'
-import { LocalityDetailsType, SpeciesDetailsType } from '../../../../frontend/src/backendTypes'
+import { LocalityDetailsType, SpeciesDetailsType } from '../../../../frontend/src/shared/types'
 import { LogRow } from '../../services/write/writeOperations/types'
 import { newSpeciesBasis, newSpeciesWithoutRequiredFields } from './data'
 import { login, logout, resetDatabase, send, testLogRows, resetDatabaseTimeout, noPermError } from '../utils'

backend/src/api-tests/species/data.ts

@@ -1,4 +1,4 @@
-import { EditDataType, EditMetaData, SpeciesDetailsType } from '../../../../frontend/src/backendTypes'
+import { EditDataType, EditMetaData, SpeciesDetailsType } from '../../../../frontend/src/shared/types'
 
 const references = [
   {

backend/src/api-tests/species/update.test.ts

@@ -1,5 +1,5 @@
 import { beforeEach, beforeAll, afterAll, describe, it, expect } from '@jest/globals'
-import { EditMetaData, SpeciesDetailsType } from '../../../../frontend/src/backendTypes'
+import { EditMetaData, SpeciesDetailsType } from '../../../../frontend/src/shared/types'
 import { LogRow } from '../../services/write/writeOperations/types'
 import { login, resetDatabase, send, testLogRows, resetDatabaseTimeout } from '../utils'
 import { editedSpecies } from './data'

backend/src/api-tests/timeBound/create.test.ts

@@ -2,7 +2,7 @@ import { beforeEach, beforeAll, afterAll, describe, it, expect } from '@jest/glo
 import { LogRow } from '../../services/write/writeOperations/types'
 import { login, logout, resetDatabase, send, testLogRows, resetDatabaseTimeout, noPermError } from '../utils'
 import { newTimeBoundBasis } from './data'
-import { TimeBoundDetailsType } from '../../../../frontend/src/backendTypes'
+import { TimeBoundDetailsType } from '../../../../frontend/src/shared/types'
 import { pool } from '../../utils/db'
 
 let createdTimeBound: TimeBoundDetailsType | null = null

backend/src/api-tests/timeBound/data.ts

@@ -1,4 +1,4 @@
-import { EditDataType, EditMetaData, TimeBoundDetailsType } from '../../../../frontend/src/backendTypes'
+import { EditDataType, EditMetaData, TimeBoundDetailsType } from '../../../../frontend/src/shared/types'
 
 const references = [
   {

backend/src/api-tests/timeBound/update.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, beforeAll, afterAll, beforeEach, expect } from '@jest/globals'
 import { editedTimeBound, newTimeBoundBasis } from './data'
 import { send, resetDatabase, login, resetDatabaseTimeout, testLogRows } from '../utils'
-import { TimeBoundDetailsType } from '../../../../frontend/src/backendTypes'
+import { TimeBoundDetailsType } from '../../../../frontend/src/shared/types'
 import { LogRow } from '../../services/write/writeOperations/types'
 import { pool } from '../../utils/db'
 

backend/src/api-tests/timeUnit/create.test.ts

@@ -1,5 +1,5 @@
 import { beforeEach, beforeAll, afterAll, describe, it, expect } from '@jest/globals'
-import { TimeUnitDetailsType } from '../../../../frontend/src/backendTypes'
+import { TimeUnitDetailsType } from '../../../../frontend/src/shared/types'
 import { LogRow } from '../../services/write/writeOperations/types'
 import { login, logout, resetDatabase, send, testLogRows, resetDatabaseTimeout, noPermError } from '../utils'
 import { newTimeUnitBasis } from './data'

backend/src/api-tests/timeUnit/data.ts

@@ -1,4 +1,4 @@
-import { EditDataType, EditMetaData, TimeUnitDetailsType } from '../../../../frontend/src/backendTypes'
+import { EditDataType, EditMetaData, TimeUnitDetailsType } from '../../../../frontend/src/shared/types'
 
 const references = [
   {

backend/src/api-tests/timeUnit/update.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, beforeEach, beforeAll, afterAll, expect } from '@jest/globals'
-import { TimeUnitDetailsType, EditDataType, EditMetaData } from '../../../../frontend/src/backendTypes'
+import { TimeUnitDetailsType, EditDataType, EditMetaData } from '../../../../frontend/src/shared/types'
 import { login, resetDatabase, send, resetDatabaseTimeout, testLogRows } from '../utils'
 import { editedTimeUnit, newTimeUnitBasis, conflictingTimeUnit } from './data'
 import { pool } from '../../utils/db'

backend/src/api-tests/user/login.test.ts

@@ -16,7 +16,7 @@ describe('Logging in', () => {
 
     expect(result.status).toEqual(200)
     expect(result.body.username).toEqual('testSu')
-    expect(result.body.role).toEqual(1) // frontend/src/types: Role enum
+    expect(result.body.role).toEqual(1) // frontend/src/shared/types: Role enum
     expect(result.body.isFirstLogin).toEqual(undefined)
   })
 

backend/src/api-tests/utils.ts

@@ -1,7 +1,7 @@
 import request from 'supertest'
 import app from '../app'
 import { expect } from '@jest/globals'
-import { UpdateLog } from '../../../frontend/src/backendTypes'
+import { UpdateLog } from '../../../frontend/src/shared/types'
 import { LogRow } from '../services/write/writeOperations/types'
 
 let token: string | null = null

backend/src/app.ts

@@ -24,7 +24,7 @@ import { ENABLE_WRITE, RUNNING_ENV } from './utils/config'
 import { tokenExtractor, userExtractor } from './middlewares/authenticator'
 import { errorHandler } from './middlewares/errorHandler'
 import { requireOneOf } from './middlewares/authorizer'
-import { Role } from './../../frontend/src/types'
+import { Role } from './../../frontend/src/shared/types'
 import { blockWriteRequests } from './middlewares/misc'
 import testRouter from './routes/test'
 

backend/src/middlewares/authenticator.ts

@@ -2,8 +2,7 @@ import { Middleware } from '../types'
 import { SECRET } from '../utils/config'
 import jwt, { Secret, TokenExpiredError } from 'jsonwebtoken'
 import { nowDb } from '../utils/db'
-import { User } from '../../../frontend/src/backendTypes'
-import { Role } from '../../../frontend/src/types'
+import { User, Role } from '../../../frontend/src/shared/types'
 
 /*
   This allows extractors to add user and token to request

backend/src/middlewares/authorizer.ts

@@ -1,4 +1,4 @@
-import { Role } from '../../../frontend/src/types'
+import { Role } from '../../../frontend/src/shared/types'
 import { Middleware } from '../types'
 
 export class AccessError extends Error {

backend/src/routes/geonames-api.ts

@@ -1,7 +1,7 @@
 import { Router, Request } from 'express'
 import { GEONAMES_USERNAME } from '../utils/config'
 import { logger } from '../utils/logger'
-import { GeonamesJSON, ParsedGeoname } from '../../../frontend/src/backendTypes'
+import { GeonamesJSON, ParsedGeoname } from '../../../frontend/src/shared/types'
 
 const router = Router()
 

backend/src/routes/locality.ts

@@ -1,9 +1,8 @@
 import { Request, Router } from 'express'
 import { getAllLocalities, getLocalityDetails, validateEntireLocality } from '../services/locality'
 import { fixBigInt } from '../utils/common'
-import { EditDataType, EditMetaData, LocalityDetailsType } from '../../../frontend/src/backendTypes'
+import { EditDataType, EditMetaData, LocalityDetailsType, Role } from '../../../frontend/src/shared/types'
 import { requireOneOf } from '../middlewares/authorizer'
-import { Role } from '../../../frontend/src/types'
 import { deleteLocality, writeLocality } from '../services/write/locality'
 
 const router = Router()

backend/src/routes/person.ts

@@ -1,6 +1,6 @@
 import { Router } from 'express'
 import { getAllPersons, getPersonDetails } from '../services/person'
-import { Role } from '../../../frontend/src/types'
+import { Role } from '../../../frontend/src/shared/types'
 import { requireOneOf } from '../middlewares/authorizer'
 
 const router = Router()

backend/src/routes/project.ts

@@ -1,7 +1,7 @@
 import { Router } from 'express'
 import { getAllProjects, getProjectDetails } from '../services/project'
 import { requireOneOf } from '../middlewares/authorizer'
-import { Role } from '../../../frontend/src/types'
+import { Role } from '../../../frontend/src/shared/types'
 
 const router = Router()
 

backend/src/routes/reference.ts

@@ -10,8 +10,7 @@ import {
   getJournalById,
 } from '../services/reference'
 import { requireOneOf } from '../middlewares/authorizer'
-import { Role } from '../../../frontend/src/types'
-import { EditMetaData, ReferenceDetailsType, EditDataType } from '../../../frontend/src/backendTypes'
+import { Role, EditMetaData, ReferenceDetailsType, EditDataType } from '../../../frontend/src/shared/types'
 import { deleteReference, writeReference } from '../services/write/reference'
 
 const router = Router()

backend/src/routes/region.ts

@@ -1,7 +1,7 @@
 import { Router } from 'express'
 import { getAllRegions, getRegionDetails } from '../services/region'
 import { requireOneOf } from '../middlewares/authorizer'
-import { Role } from '../../../frontend/src/types'
+import { Role } from '../../../frontend/src/shared/types'
 
 const router = Router()
 

backend/src/routes/species.ts

@@ -1,10 +1,9 @@
 import { Request, Router } from 'express'
 import { getAllSpecies, getSpeciesDetails, validateEntireSpecies } from '../services/species'
 import { fixBigInt } from '../utils/common'
-import { EditMetaData, SpeciesDetailsType } from '../../../frontend/src/backendTypes'
+import { EditMetaData, SpeciesDetailsType, Role } from '../../../frontend/src/shared/types'
 import { deleteSpecies, writeSpecies } from '../services/write/species'
 import { requireOneOf } from '../middlewares/authorizer'
-import { Role } from '../../../frontend/src/types'
 
 const router = Router()
 

backend/src/routes/timeBound.ts

@@ -1,6 +1,5 @@
 import { Request, Router } from 'express'
-import { EditDataType, EditMetaData, TimeBoundDetailsType } from '../../../frontend/src/backendTypes'
-import { Role } from '../../../frontend/src/types'
+import { EditDataType, EditMetaData, TimeBoundDetailsType, Role } from '../../../frontend/src/shared/types'
 import { requireOneOf } from '../middlewares/authorizer'
 import {
   getAllTimeBounds,

backend/src/routes/timeUnit.ts

@@ -1,6 +1,5 @@
 import { Request, Router } from 'express'
-import { EditDataType, EditMetaData, TimeUnitDetailsType } from '../../../frontend/src/backendTypes'
-import { Role } from '../../../frontend/src/types'
+import { EditDataType, EditMetaData, TimeUnitDetailsType, Role } from '../../../frontend/src/shared/types'
 import { requireOneOf } from '../middlewares/authorizer'
 import { getAllSequences } from '../services/sequence'
 import {

backend/src/routes/user.ts

@@ -6,7 +6,7 @@ import * as bcrypt from 'bcrypt'
 import { nowDb } from '../utils/db'
 import { getRole } from '../middlewares/authenticator'
 import { AccessError } from '../middlewares/authorizer'
-import { Role } from '../../../frontend/src/types'
+import { Role } from '../../../frontend/src/shared/types'
 import md5 from 'md5'
 
 const router = Router()

backend/src/services/crossSearch.ts

@@ -1,5 +1,4 @@
-import { User, CrossSearch } from '../../../frontend/src/backendTypes'
-import { Role } from '../../../frontend/src/types'
+import { User, CrossSearch, Role } from '../../../frontend/src/shared/types'
 import { nowDb } from '../utils/db'
 import {
   generateFilteredCrossSearchSql,

backend/src/services/locality.ts

@@ -1,7 +1,6 @@
-import { EditDataType, EditMetaData, LocalityDetailsType, User } from '../../../frontend/src/backendTypes'
-import { Role } from '../../../frontend/src/types'
-import { validateLocality } from '../../../frontend/src/validators/locality'
-import { ValidationObject, referenceValidator } from '../../../frontend/src/validators/validator'
+import { EditDataType, EditMetaData, LocalityDetailsType, User, Role } from '../../../frontend/src/shared/types'
+import { validateLocality } from '../../../frontend/src/shared/validators/locality'
+import { ValidationObject, referenceValidator } from '../../../frontend/src/shared/validators/validator'
 import Prisma from '../../prisma/generated/now_test_client'
 import { AccessError } from '../middlewares/authorizer'
 import { fixBigInt } from '../utils/common'

backend/src/services/localitySpeciesExport.ts

@@ -1,7 +1,6 @@
 import { PoolConnection } from 'mariadb'
-import { User } from '../../../frontend/src/backendTypes'
+import { User, Role } from '../../../frontend/src/shared/types'
 import { NOW_DB_NAME } from '../utils/config'
-import { Role } from '../../../frontend/src/types'
 import { pool } from '../utils/db'
 
 const getExportList = async (

backend/src/services/reference.ts

@@ -1,7 +1,7 @@
 import { nowDb } from '../utils/db'
-import { EditDataType, ReferenceDetailsType } from '../../../frontend/src/backendTypes'
-import { ValidationObject } from '../../../frontend/src/validators/validator'
-import { validateReference } from '../../../frontend/src/validators/reference'
+import { EditDataType, ReferenceDetailsType } from '../../../frontend/src/shared/types'
+import { ValidationObject } from '../../../frontend/src/shared/validators/validator'
+import { validateReference } from '../../../frontend/src/shared/validators/reference'
 import Prisma from '../../prisma/generated/now_test_client'
 
 export const getAllReferences = async () => {

backend/src/services/species.ts

@@ -1,6 +1,6 @@
-import { EditDataType, EditMetaData, SpeciesDetailsType } from '../../../frontend/src/backendTypes'
-import { validateSpecies } from '../../../frontend/src/validators/species'
-import { ValidationObject, referenceValidator } from '../../../frontend/src/validators/validator'
+import { EditDataType, EditMetaData, SpeciesDetailsType } from '../../../frontend/src/shared/types'
+import { validateSpecies } from '../../../frontend/src/shared/validators/species'
+import { ValidationObject, referenceValidator } from '../../../frontend/src/shared/validators/validator'
 import Prisma from '../../prisma/generated/now_test_client'
 import { fixBigInt } from '../utils/common'
 import { logDb, nowDb } from '../utils/db'

backend/src/services/timeBound.ts

@@ -1,8 +1,8 @@
 import { logDb, nowDb } from '../utils/db'
-import { validateTimeBound } from '../../../frontend/src/validators/timeBound'
-import { TimeBoundDetailsType, EditDataType, EditMetaData } from '../../../frontend/src/backendTypes'
+import { validateTimeBound } from '../../../frontend/src/shared/validators/timeBound'
+import { TimeBoundDetailsType, EditDataType, EditMetaData } from '../../../frontend/src/shared/types'
 import Prisma from '../../prisma/generated/now_test_client'
-import { ValidationObject, referenceValidator } from '../../../frontend/src/validators/validator'
+import { ValidationObject, referenceValidator } from '../../../frontend/src/shared/validators/validator'
 import { getReferenceDetails } from './reference'
 
 export const getAllTimeBounds = async () => {

backend/src/services/timeUnit.ts

@@ -1,7 +1,7 @@
 import { logDb, nowDb } from '../utils/db'
-import { EditDataType, TimeUnitDetailsType, EditMetaData } from '../../../frontend/src/backendTypes'
-import { ValidationObject, referenceValidator } from '../../../frontend/src/validators/validator'
-import { validateTimeUnit } from '../../../frontend/src/validators/timeUnit'
+import { EditDataType, TimeUnitDetailsType, EditMetaData } from '../../../frontend/src/shared/types'
+import { ValidationObject, referenceValidator } from '../../../frontend/src/shared/validators/validator'
+import { validateTimeUnit } from '../../../frontend/src/shared/validators/timeUnit'
 import { getReferenceDetails } from './reference'
 
 export const getAllTimeUnits = async () => {