Merge pull request #44 from icefoganalytics/caleb/dev

ytgov#168 - Ability to delete place (site)

Author: burkkyy

.tool-versions

@@ -0,0 +1,2 @@
+nodejs 20.18.0
+ruby 3.3.5

api/.eslintrc.cjs

@@ -0,0 +1,28 @@
+/* eslint-env node */
+
+// https://github.com/typescript-eslint/typescript-eslint/issues/251
+module.exports = {
+  root: true,
+  env: {
+    es2020: true,
+    node: true,
+  },
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
+  overrides: [],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  rules: {
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        args: "all",
+        argsIgnorePattern: "^_",
+        caughtErrors: "all",
+        caughtErrorsIgnorePattern: "^_",
+        destructuredArrayIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
+        ignoreRestSiblings: true,
+      },
+    ],
+  },
+}

api/index.ts

@@ -119,7 +119,7 @@ CreateMigrationRoutes(app);
 
 configureAuthentication(app);
 
-app.get('/api/healthCheck', (req: Request, res: Response) => {
+app.get('/api/healthCheck', (_req: Request, res: Response) => {
 	doHealthCheck(res);
 });
 
@@ -195,7 +195,7 @@ app.use('/api', RequiresAuthentication, staticRouter);
 app.use(express.static(path.join(__dirname, 'web')));
 
 // if no other routes match, just send the front-end
-app.use((req: Request, res: Response) => {
+app.use((_req: Request, res: Response) => {
 	res.sendFile(path.join(__dirname, 'web') + '/index.html');
 });
 

api/middleware/index.ts

@@ -20,21 +20,11 @@ export function ReturnValidationErrors(req: Request, res: Response, next: NextFu
 	next();
 }
 
-export function RequiresRoleAdmin(req: Request, res: Response, next: NextFunction) {
-	if (req.user && req.user.roles.indexOf('Admin') == -1) {
-		return res.status(401).send('You are not an Administrator');
-	}
-
-	next();
-}
-
-export async function doHealthCheck(req: Request, res: Response) {
+export async function doHealthCheck(_req: Request, res: Response) {
 	//let dbConnected = await data.isConnected();
 
 	//if (!dbConnected)
 	//    return res.status(500).send(`Not able to connect to <strong>MONGODB</strong> database on <strong>${MONGO_HOST}</strong>.`);
 
-	res.send(
-		`Connection to database on '<strong>${DB_HOST}</strong>' is connected and functioning.`
-	);
+	res.send(`Connection to database on '<strong>${DB_HOST}</strong>' is connected and functioning.`);
 }

api/routes/place-router.ts

@@ -13,6 +13,7 @@ import PlacesController from '../controllers/places-controller';
 import { PlacePolicy } from '../policies';
 import { generatePDF } from '../utils/pdf-generator';
 import { createThumbnail } from '../utils/image';
+import { DestroyService } from '../services/place';
 
 const placeService = new PlaceService(DB_CONFIG);
 const PAGE_SIZE = 10;
@@ -357,3 +358,18 @@ placeRouter.patch(
 			});
 	}
 );
+
+placeRouter.delete(
+	'/:id',
+	authorize([UserRoles.SITE_ADMIN, UserRoles.ADMINISTRATOR]),
+	async (req: Request, res: Response) => {
+		try {
+			const id = parseInt(req.params.id);
+			await DestroyService.perform(id);
+			return res.status(204).json({ messages: 'Place was deleted' });
+		} catch (error) {
+			console.error(`Place deletion failed: ${error}`, { error });
+			return res.status(422).json({ messages: `Place deletion failed: ${error}` });
+		}
+	}
+);

api/routes/user-router.ts

@@ -3,12 +3,7 @@ import axios from 'axios';
 import moment from 'moment';
 import { body, param } from 'express-validator';
 
-import {
-	DB_CONFIG,
-	ISSUER_BASE_URL,
-	CLIENT_ID,
-	AUTH_DB_CONNECTION,
-} from '../config';
+import { DB_CONFIG, ISSUER_BASE_URL, CLIENT_ID, AUTH_DB_CONNECTION } from '../config';
 import { UserService } from '../services';
 import { ReturnValidationErrors } from '../middleware';
 import { UserRoles } from '../models/user-roles';
@@ -17,41 +12,33 @@ import { authorize, UserRoleOptions } from '../middleware/authorization';
 export const userRouter = express.Router();
 const db = new UserService(DB_CONFIG);
 
-userRouter.get(
-	'/',
-	authorize([UserRoles.ADMINISTRATOR]),
-	async (req: Request, res: Response) => {
-		const users = await db.getAll();
-
-		for (const user of users) {
-			if (user.last_login_date)
-				user.last_login_date_display = moment(user.last_login_date)
-					.utc(true)
-					.format('YYYY-MM-DD @ h:mmA');
-
-			if (user.expire_date) {
-				const isExpired = moment().isAfter(moment(user.expire_date));
-				if (user.status == 'Active' && isExpired) user.status = 'Expired';
-			}
-		}
+userRouter.get('/', authorize([UserRoles.ADMINISTRATOR]), async (req: Request, res: Response) => {
+	const users = await db.getAll();
 
-		res.json({ data: users });
+	for (const user of users) {
+		if (user.last_login_date)
+			user.last_login_date_display = moment(user.last_login_date)
+				.utc(true)
+				.format('YYYY-MM-DD @ h:mmA');
+
+		if (user.expire_date) {
+			const isExpired = moment().isAfter(moment(user.expire_date));
+			if (user.status == 'Active' && isExpired) user.status = 'Expired';
+		}
 	}
-);
+
+	res.json({ data: users });
+});
 
 userRouter.get('/roles', authorize(), async (req: Request, res: Response) => {
 	return res.json({ data: UserRoleOptions });
 });
 
-userRouter.get(
-	'/me',
-	authorize([], true),
-	async (req: Request, res: Response) => {
-		const person = req.user;
+userRouter.get('/me', authorize([], true), async (req: Request, res: Response) => {
+	const person = req.user;
 
-		if (person) return res.json({ data: await makeDTO(person) });
-	}
-);
+	if (person) return res.json({ data: await makeDTO(person) });
+});
 
 userRouter.get(
 	'/:id',
@@ -66,9 +53,7 @@ userRouter.get(
 			const isExpired = moment().isAfter(moment(user.expire_date));
 			if (isExpired) user.status = 'Expired';
 
-			user.expire_date_display = moment(user.expire_date)
-				.utc(false)
-				.format('YYYY-MM-DD');
+			user.expire_date_display = moment(user.expire_date).utc(false).format('YYYY-MM-DD');
 		}
 
 		res.json({ data: user });
@@ -87,8 +72,7 @@ userRouter.put(
 	ReturnValidationErrors,
 	async (req: Request, res: Response) => {
 		const { id } = req.params;
-		const { first_name, last_name, expire_date_display, role_list, status } =
-			req.body;
+		const { first_name, last_name, expire_date_display, role_list, status } = req.body;
 		const item = {
 			first_name,
 			last_name,
@@ -106,10 +90,7 @@ userRouter.put(
 userRouter.post(
 	'/sign-up-external',
 	[
-		body('email')
-			.isEmail()
-			.normalizeEmail()
-			.withMessage('This email appears invalid'),
+		body('email').isEmail().normalizeEmail().withMessage('This email appears invalid'),
 		body('first_name').notEmpty(),
 		body('last_name').notEmpty(),
 		body('password')
@@ -124,9 +105,7 @@ userRouter.post(
 
 		if (existingEmail) {
 			return res.status(400).json({
-				errors: [
-					{ msg: 'A user with that email already exists, try to sign in' },
-				],
+				errors: [{ msg: 'A user with that email already exists, try to sign in' }],
 			});
 		}
 
@@ -150,9 +129,7 @@ userRouter.post(
 				});
 			})
 			.catch((err: any) => {
-				return res
-					.status(400)
-					.json({ errors: [{ msg: err.response.data.description }] });
+				return res.status(400).json({ errors: [{ msg: err.response.data.description }] });
 			});
 	}
 );
@@ -208,9 +185,7 @@ async function makeDTO(userRaw: any) {
 	dto.display_name = `${userRaw.first_name} ${userRaw.last_name}`;
 
 	if (userRaw.expire_date)
-		dto.expire_date_display = moment(userRaw.expire_date)
-			.utc(false)
-			.format('YYYY-MM-DD');
+		dto.expire_date_display = moment(userRaw.expire_date).utc(false).format('YYYY-MM-DD');
 
 	//dto.roles = _.split(userRaw.roles, ",").filter(r => r.length > 0);
 	//dto.access = await db.getAccessFor(userRaw.email);

api/services/place/destroy-service.ts

@@ -0,0 +1,102 @@
+import BaseService from '../base-service';
+
+import { DB_CONFIG } from '../../config';
+import knex, { Knex } from 'knex';
+
+const db = knex(DB_CONFIG);
+
+export class DestroyService extends BaseService {
+	constructor(private placeId: number) {
+		super();
+	}
+
+	async perform(): Promise<void> {
+		return db.transaction(async (trx) => {
+			await this.deleteAssociations(trx);
+			await this.deleteConstructionPeriods(trx);
+			await this.deleteContacts(trx);
+			await this.deleteDates(trx);
+			await this.deleteDescriptions(trx);
+			await this.deleteFirstNationAssociations(trx);
+			await this.deleteFunctionalUses(trx);
+			await this.deleteHistoricalPatterns(trx);
+			await this.deleteNames(trx);
+			await this.deleteOwnerships(trx);
+			// await this.deletePhotos(trx);
+			await this.deletePlaceEdits(trx);
+			await this.deletePreviousOwnerships(trx);
+			await this.deleteRevisionLogs(trx);
+			await this.deleteThemes(trx);
+			await this.deleteWebLinks(trx);
+
+			await trx('place').where({ id: this.placeId }).delete();
+		});
+	}
+
+	private async deleteAssociations(trx: Knex.Transaction) {
+		await trx('Association').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteConstructionPeriods(trx: Knex.Transaction) {
+		await trx('ConstructionPeriod').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteContacts(trx: Knex.Transaction) {
+		await trx('Contact').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteDates(trx: Knex.Transaction) {
+		await trx('Dates').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteDescriptions(trx: Knex.Transaction) {
+		await trx('Description').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteFirstNationAssociations(trx: Knex.Transaction) {
+		await trx('FirstNationAssociation').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteFunctionalUses(trx: Knex.Transaction) {
+		await trx('FunctionalUse').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteHistoricalPatterns(trx: Knex.Transaction) {
+		await trx('historicalpattern').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteNames(trx: Knex.Transaction) {
+		await trx('name').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteOwnerships(trx: Knex.Transaction) {
+		await trx('Ownership').where({ placeId: this.placeId }).delete();
+	}
+
+	// private async deletePhotos(trx: Knex.Transaction) {
+	// 	return;
+	// }
+
+	private async deletePlaceEdits(trx: Knex.Transaction) {
+		// TODO Investigate if a seperate delete service is needed
+		await trx('PlaceEdit').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deletePreviousOwnerships(trx: Knex.Transaction) {
+		await trx('PreviousOwnership').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteRevisionLogs(trx: Knex.Transaction) {
+		await trx('RevisionLog').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteThemes(trx: Knex.Transaction) {
+		await trx('Theme').where({ placeId: this.placeId }).delete();
+	}
+
+	private async deleteWebLinks(trx: Knex.Transaction) {
+		await trx('WebLink').where({ placeId: this.placeId }).delete();
+	}
+}
+
+export default DestroyService;

api/services/place/index.ts

@@ -1 +1,2 @@
+export { DestroyService } from './destroy-service';
 export { PrintSiteService } from './print-site-service';

api/services/place/print-site-service.ts

@@ -268,8 +268,6 @@ export class PrintSiteService extends BaseService {
 			descriptions: descriptionsHandlebarData,
 		};
 
-		console.log(handlebarsData);
-
 		return template(handlebarsData);
 	}
 

web/src/apis/places-api.js

@@ -61,4 +61,13 @@ export default {
 				return Promise.reject(error);
 			});
 	},
+	delete(id) {
+		return http
+			.delete(`${placeUrl}/${id}`)
+			.then((response) => response.data)
+			.catch((error) => {
+				console.error(error);
+				return Promise.reject(error);
+			});
+	}
 };