parking bylaws and locations cache

closes #610

database/parkingDB/addParkingBylaw.js

@@ -1,5 +1,6 @@
 import sqlite from 'better-sqlite3';
 import { parkingDB as databasePath } from '../../data/databasePaths.js';
+import { clearCacheByTableName } from '../../helpers/functions.cache.js';
 export default function addParkingBylaw(requestBody) {
     const database = sqlite(databasePath);
     const bylawRecord = database
@@ -21,6 +22,7 @@ export default function addParkingBylaw(requestBody) {
           where bylawNumber = ?`)
             .run(requestBody.bylawNumber);
         database.close();
+        clearCacheByTableName('ParkingBylaws');
         return {
             success: info.changes > 0,
             message: `By-law number "${requestBody.bylawNumber}" is associated with a previously removed record.
@@ -34,6 +36,7 @@ export default function addParkingBylaw(requestBody) {
         values (?, ?, 0, 1)`)
         .run(requestBody.bylawNumber, requestBody.bylawDescription);
     database.close();
+    clearCacheByTableName('ParkingBylaws');
     return {
         success: info.changes > 0
     };

database/parkingDB/addParkingBylaw.ts

@@ -1,6 +1,7 @@
 import sqlite from 'better-sqlite3'
 
 import { parkingDB as databasePath } from '../../data/databasePaths.js'
+import { clearCacheByTableName } from '../../helpers/functions.cache.js'
 import type { ParkingBylaw } from '../../types/recordTypes.js'
 
 import type { AddUpdateParkingBylawReturn } from './getParkingBylaws.js'
@@ -41,6 +42,7 @@ export default function addParkingBylaw(
       .run(requestBody.bylawNumber)
 
     database.close()
+    clearCacheByTableName('ParkingBylaws')
 
     return {
       success: info.changes > 0,
@@ -61,6 +63,7 @@ export default function addParkingBylaw(
     .run(requestBody.bylawNumber, requestBody.bylawDescription)
 
   database.close()
+  clearCacheByTableName('ParkingBylaws')
 
   return {
     success: info.changes > 0

database/parkingDB/addParkingLocation.js

@@ -1,5 +1,6 @@
 import sqlite from 'better-sqlite3';
 import { parkingDB as databasePath } from '../../data/databasePaths.js';
+import { clearCacheByTableName } from '../../helpers/functions.cache.js';
 export default function addParkingLocation(requestBody) {
     const database = sqlite(databasePath);
     const locationRecord = database
@@ -20,6 +21,7 @@ export default function addParkingLocation(requestBody) {
         values (?, ?, ?, 0, 1)`)
         .run(requestBody.locationKey, requestBody.locationName, requestBody.locationClassKey);
     database.close();
+    clearCacheByTableName('ParkingLocations');
     return {
         success: info.changes > 0
     };

database/parkingDB/addParkingLocation.ts

@@ -1,6 +1,7 @@
 import sqlite from 'better-sqlite3'
 
 import { parkingDB as databasePath } from '../../data/databasePaths.js'
+import { clearCacheByTableName } from '../../helpers/functions.cache.js'
 import type { ParkingLocation } from '../../types/recordTypes.js'
 
 import type { AddUpdateParkingLocationReturn } from './getParkingLocations.js'
@@ -48,6 +49,7 @@ export default function addParkingLocation(
     )
 
   database.close()
+  clearCacheByTableName('ParkingLocations')
 
   return {
     success: info.changes > 0

database/parkingDB/deleteParkingBylaw.js

@@ -1,5 +1,6 @@
 import sqlite from 'better-sqlite3';
 import { parkingDB as databasePath } from '../../data/databasePaths.js';
+import { clearCacheByTableName } from '../../helpers/functions.cache.js';
 export default function deleteParkingBylaw(bylawNumber) {
     const database = sqlite(databasePath);
     const info = database
@@ -9,6 +10,7 @@ export default function deleteParkingBylaw(bylawNumber) {
         and isActive = 1`)
         .run(bylawNumber);
     database.close();
+    clearCacheByTableName('ParkingBylaws');
     return {
         success: info.changes > 0
     };

database/parkingDB/deleteParkingBylaw.ts

@@ -1,6 +1,7 @@
 import sqlite from 'better-sqlite3'
 
 import { parkingDB as databasePath } from '../../data/databasePaths.js'
+import { clearCacheByTableName } from '../../helpers/functions.cache.js'
 
 import type { AddUpdateParkingBylawReturn } from './getParkingBylaws.js'
 
@@ -20,6 +21,7 @@ export default function deleteParkingBylaw(
     .run(bylawNumber)
 
   database.close()
+  clearCacheByTableName('ParkingBylaws')
 
   return {
     success: info.changes > 0

database/parkingDB/deleteParkingLocation.js

@@ -1,5 +1,6 @@
 import sqlite from 'better-sqlite3';
 import { parkingDB as databasePath } from '../../data/databasePaths.js';
+import { clearCacheByTableName } from '../../helpers/functions.cache.js';
 export default function deleteParkingLocation(locationKey) {
     const database = sqlite(databasePath);
     const info = database
@@ -9,6 +10,7 @@ export default function deleteParkingLocation(locationKey) {
         and isActive = 1`)
         .run(locationKey);
     database.close();
+    clearCacheByTableName('ParkingLocations');
     return {
         success: info.changes > 0
     };

database/parkingDB/deleteParkingLocation.ts

@@ -1,6 +1,7 @@
 import sqlite from 'better-sqlite3'
 
 import { parkingDB as databasePath } from '../../data/databasePaths.js'
+import { clearCacheByTableName } from '../../helpers/functions.cache.js'
 
 import type { AddUpdateParkingLocationReturn } from './getParkingLocations.js'
 
@@ -20,6 +21,7 @@ export default function deleteParkingLocation(
     .run(locationKey)
 
   database.close()
+  clearCacheByTableName('ParkingLocations')
 
   return {
     success: info.changes > 0

database/parkingDB/updateParkingBylaw.js

@@ -1,5 +1,6 @@
 import sqlite from 'better-sqlite3';
 import { parkingDB as databasePath } from '../../data/databasePaths.js';
+import { clearCacheByTableName } from '../../helpers/functions.cache.js';
 export default function updateParkingBylaw(requestBody) {
     const database = sqlite(databasePath);
     const info = database
@@ -9,6 +10,7 @@ export default function updateParkingBylaw(requestBody) {
         and isActive = 1`)
         .run(requestBody.bylawDescription, requestBody.bylawNumber);
     database.close();
+    clearCacheByTableName('ParkingBylaws');
     return {
         success: info.changes > 0
     };

database/parkingDB/updateParkingBylaw.ts

@@ -1,6 +1,7 @@
 import sqlite from 'better-sqlite3'
 
 import { parkingDB as databasePath } from '../../data/databasePaths.js'
+import { clearCacheByTableName } from '../../helpers/functions.cache.js'
 import type { ParkingBylaw } from '../../types/recordTypes.js'
 
 import type { AddUpdateParkingBylawReturn } from './getParkingBylaws.js'
@@ -21,6 +22,7 @@ export default function updateParkingBylaw(
     .run(requestBody.bylawDescription, requestBody.bylawNumber)
 
   database.close()
+  clearCacheByTableName('ParkingBylaws')
 
   return {
     success: info.changes > 0

database/parkingDB/updateParkingLocation.js

@@ -1,5 +1,6 @@
 import sqlite from 'better-sqlite3';
 import { parkingDB as databasePath } from '../../data/databasePaths.js';
+import { clearCacheByTableName } from '../../helpers/functions.cache.js';
 export default function updateParkingLocation(requestBody) {
     const database = sqlite(databasePath);
     const info = database
@@ -10,6 +11,7 @@ export default function updateParkingLocation(requestBody) {
         and isActive = 1`)
         .run(requestBody.locationName, requestBody.locationClassKey, requestBody.locationKey);
     database.close();
+    clearCacheByTableName('ParkingLocations');
     return {
         success: info.changes > 0
     };

database/parkingDB/updateParkingLocation.ts

@@ -1,6 +1,7 @@
 import sqlite from 'better-sqlite3'
 
 import { parkingDB as databasePath } from '../../data/databasePaths.js'
+import { clearCacheByTableName } from '../../helpers/functions.cache.js'
 import type { ParkingLocation } from '../../types/recordTypes.js'
 
 import type { AddUpdateParkingLocationReturn } from './getParkingLocations.js'
@@ -26,6 +27,7 @@ export default function updateParkingLocation(
     )
 
   database.close()
+  clearCacheByTableName('ParkingLocations')
 
   return {
     success: info.changes > 0

handlers/admin-get/locations.js

@@ -1,4 +1,4 @@
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js';
+import { getParkingLocations } from '../../helpers/functions.cache.js';
 export default function handler(_request, response) {
     const locations = getParkingLocations();
     response.render('location-maint', {

handlers/admin-get/locations.ts

@@ -1,6 +1,6 @@
 import type { Request, Response } from 'express'
 
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js'
+import { getParkingLocations } from '../../helpers/functions.cache.js'
 
 export default function handler(_request: Request, response: Response): void {
   const locations = getParkingLocations()

handlers/admin-get/offences.js

@@ -1,6 +1,5 @@
-import getParkingBylaws from '../../database/parkingDB/getParkingBylaws.js';
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js';
 import getParkingOffences from '../../database/parkingDB/getParkingOffences.js';
+import { getParkingBylaws, getParkingLocations } from '../../helpers/functions.cache.js';
 export default function handler(_request, response) {
     const locations = getParkingLocations();
     const bylaws = getParkingBylaws();

handlers/admin-get/offences.ts

@@ -1,8 +1,10 @@
 import type { Request, Response } from 'express'
 
-import getParkingBylaws from '../../database/parkingDB/getParkingBylaws.js'
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js'
 import getParkingOffences from '../../database/parkingDB/getParkingOffences.js'
+import {
+  getParkingBylaws,
+  getParkingLocations
+} from '../../helpers/functions.cache.js'
 
 export default function handler(_request: Request, response: Response): void {
   const locations = getParkingLocations()

handlers/admin-post/doAddLocation.js

@@ -1,5 +1,5 @@
 import addParkingLocation from '../../database/parkingDB/addParkingLocation.js';
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js';
+import { getParkingLocations } from '../../helpers/functions.cache.js';
 export default function handler(request, response) {
     const results = addParkingLocation(request.body);
     if (results.success) {

handlers/admin-post/doAddLocation.ts

@@ -1,7 +1,7 @@
 import type { Request, Response } from 'express'
 
 import addParkingLocation from '../../database/parkingDB/addParkingLocation.js'
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js'
+import { getParkingLocations } from '../../helpers/functions.cache.js'
 import type { ParkingLocation } from '../../types/recordTypes.js'
 
 export default function handler(request: Request, response: Response): void {

handlers/admin-post/doDeleteLocation.js

@@ -1,5 +1,5 @@
 import deleteParkingLocation from '../../database/parkingDB/deleteParkingLocation.js';
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js';
+import { getParkingLocations } from '../../helpers/functions.cache.js';
 export default function handler(request, response) {
     const results = deleteParkingLocation(request.body.locationKey);
     if (results.success) {

handlers/admin-post/doDeleteLocation.ts

@@ -1,7 +1,7 @@
 import type { Request, Response } from 'express'
 
 import deleteParkingLocation from '../../database/parkingDB/deleteParkingLocation.js'
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js'
+import { getParkingLocations } from '../../helpers/functions.cache.js'
 
 export default function handler(request: Request, response: Response): void {
   const results = deleteParkingLocation(request.body.locationKey as string)

handlers/admin-post/doUpdateLocation.js

@@ -1,5 +1,5 @@
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js';
 import updateParkingLocation from '../../database/parkingDB/updateParkingLocation.js';
+import { getParkingLocations } from '../../helpers/functions.cache.js';
 export default function handler(request, response) {
     const results = updateParkingLocation(request.body);
     if (results.success) {

handlers/admin-post/doUpdateLocation.ts

@@ -1,7 +1,7 @@
 import type { Request, Response } from 'express'
 
-import getParkingLocations from '../../database/parkingDB/getParkingLocations.js'
 import updateParkingLocation from '../../database/parkingDB/updateParkingLocation.js'
+import { getParkingLocations } from '../../helpers/functions.cache.js'
 import type { ParkingLocation } from '../../types/recordTypes.js'
 
 export default function handler(request: Request, response: Response): void {

helpers/functions.cache.d.ts

@@ -0,0 +1,5 @@
+import type { CacheTableName } from '../types/applicationTypes.js';
+import type { ParkingBylaw, ParkingLocation } from '../types/recordTypes.js';
+export declare function getParkingBylaws(): ParkingBylaw[];
+export declare function getParkingLocations(): ParkingLocation[];
+export declare function clearCacheByTableName(tableName: CacheTableName, relayMessage?: boolean): void;

helpers/functions.cache.js

@@ -0,0 +1,57 @@
+import cluster from 'node:cluster';
+import Debug from 'debug';
+import getParkingBylawsFromDatabase from '../database/parkingDB/getParkingBylaws.js';
+import getParkingLocationsFromDatabase from '../database/parkingDB/getParkingLocations.js';
+const debug = Debug(`parking-ticket-system:functions.cache:${process.pid}`);
+let parkingBylaws = [];
+export function getParkingBylaws() {
+    if (parkingBylaws.length === 0) {
+        debug('Cache miss: ParkingBylaws');
+        parkingBylaws = getParkingBylawsFromDatabase();
+    }
+    return parkingBylaws;
+}
+let parkingLocations = [];
+export function getParkingLocations() {
+    if (parkingLocations.length === 0) {
+        debug('Cache miss: ParkingLocations');
+        parkingLocations = getParkingLocationsFromDatabase();
+    }
+    return parkingLocations;
+}
+export function clearCacheByTableName(tableName, relayMessage = true) {
+    switch (tableName) {
+        case 'ParkingBylaws': {
+            parkingBylaws = [];
+            break;
+        }
+        case 'ParkingLocations': {
+            parkingLocations = [];
+            break;
+        }
+        default: {
+            debug(`Ignoring clear cache for unknown table: ${tableName}`);
+        }
+    }
+    try {
+        if (relayMessage && cluster.isWorker && process.send !== undefined) {
+            const workerMessage = {
+                messageType: 'clearCache',
+                tableName,
+                timeMillis: Date.now(),
+                pid: process.pid
+            };
+            debug(`Sending clear cache from worker: ${tableName}`);
+            process.send(workerMessage);
+        }
+    }
+    catch {
+        debug('Error sending clear cache message.');
+    }
+}
+process.on('message', (message) => {
+    if (message.messageType === 'clearCache' && message.pid !== process.pid) {
+        debug(`Clearing cache: ${message.tableName}`);
+        clearCacheByTableName(message.tableName, false);
+    }
+});