refactor: migrate to native uuid functions

sanjaytkbabu · sanjaytkbabu · commit 966941d64e71 · 2026-07-15T15:32:52.000-07:00
Signed-off-by: Sanjay Babu &lt;sanjaytkbabu@gmail.com&gt;
diff --git a/app/src/controllers/contact.ts b/app/src/controllers/contact.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import {
   deleteContactService,
@@ -76,7 +76,7 @@ export const upsertContactController = async (
   req: Request<never, never, Contact, never>,
   res: Response<Contact, LocalContext>
 ) => {
-  const contact = { ...req.body, contactId: req.body.contactId ?? uuidv4() };
+  const contact = { ...req.body, contactId: req.body.contactId ?? randomUUID() };
   const response = await upsertContactsService([contact]);
   res.status(200).json(response[0]);
 };
diff --git a/app/src/db/migrations/20231212000000_init.ts b/app/src/db/migrations/20231212000000_init.ts
@@ -1,11 +1,12 @@
 /* eslint-disable max-len */
 import { randomUUID } from 'node:crypto';
 
-import { NIL_UUID } from '../../utils/constants/application.ts';
 import { addAuditStamps } from '../utils/migrations/helpers.ts';
 
 import type { Knex } from 'knex';
 
+const NIL_UUID = '00000000-0000-0000-0000-000000000000';
+
 export async function up(knex: Knex): Promise<void> {
   return (
     Promise.resolve()
diff --git a/app/src/db/migrations/20251027000000_044-system-id-change.ts b/app/src/db/migrations/20251027000000_044-system-id-change.ts
@@ -1,7 +1,9 @@
-import { NIL_UUID, SYSTEM_ID } from '../../utils/constants/application.ts';
+import { SYSTEM_ID } from '../../utils/constants/application.ts';
 
 import type { Knex } from 'knex';
 
+const NIL_UUID = '00000000-0000-0000-0000-000000000000';
+
 export async function up(knex: Knex): Promise<void> {
   return Promise.resolve()
     .then(() => {
diff --git a/app/src/domains/activity.ts b/app/src/domains/activity.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { Initiative } from '../utils/enums/application.ts';
 
@@ -19,7 +19,7 @@ export const createActivity = async (
   let id, queryResult;
 
   do {
-    id = uuidv4().substring(0, 8).toUpperCase();
+    id = randomUUID().substring(0, 8).toUpperCase();
     queryResult = await repositories.activity.findUnique({
       where: { activityId: id },
       select: { activityId: true }
diff --git a/app/src/domains/electrificationProject.ts b/app/src/domains/electrificationProject.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { createActivity } from './activity';
 import { Initiative } from '../utils/enums/application';
@@ -43,7 +43,7 @@ export const generateElectrificationProjectData = async (
   if (!activityId) throw new Error('Failed to generate activity ID');
 
   // Put new electrification project together
-  const UUID = uuidv4();
+  const UUID = randomUUID();
 
   const electrificationProjectData: ElectrificationProjectBase = {
     companyIdRegistered: data.basic?.registeredId ?? null,
diff --git a/app/src/domains/enquiry.ts b/app/src/domains/enquiry.ts
@@ -1,5 +1,5 @@
 import config from 'config';
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { createActivity } from './activity';
 import { getProjectByActivityId } from './project';
@@ -118,7 +118,7 @@ export const generateEnquiryData = async (
 
   // Put new enquiry together
   return {
-    enquiryId: data.enquiryId ?? uuidv4(),
+    enquiryId: data.enquiryId ?? randomUUID(),
     activityId: activityId,
     relatedActivityId: data.relatedActivityId,
     enquiryDescription: data.enquiryDescription,
diff --git a/app/src/domains/generalProject.ts b/app/src/domains/generalProject.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { createActivity } from './activity';
 import { PermitStage, PermitState } from '../db/codes/enums';
@@ -82,7 +82,7 @@ export const generateGeneralProjectData = async (
 
     if (data.permits.appliedPermits?.length) {
       appliedPermits = data.permits.appliedPermits.map((x: Permit) => {
-        const permitId = x.permitId ?? uuidv4();
+        const permitId = x.permitId ?? randomUUID();
 
         // Add each tracker for this permit with the proper permitId
         x.permitTracking?.forEach((pt) => appliedPermitTrackers.push({ ...pt, permitId }));
@@ -113,7 +113,7 @@ export const generateGeneralProjectData = async (
 
     if (data.permits.investigatePermits?.length) {
       investigatePermits = data.permits.investigatePermits.map((x: Permit) => ({
-        permitId: x.permitId ?? uuidv4(),
+        permitId: x.permitId ?? randomUUID(),
         permitTypeId: x.permitTypeId,
         activityId: activityId,
         stage: PermitStage.PRE_SUBMISSION,
@@ -142,7 +142,7 @@ export const generateGeneralProjectData = async (
       ...basic,
       ...location,
       ...permits,
-      generalProjectId: uuidv4(),
+      generalProjectId: randomUUID(),
       activityId: activityId,
       submittedAt: data.submittedAt ? new Date(data.submittedAt) : new Date(),
       applicationStatus: data.applicationStatus ?? ApplicationStatus.NEW,
diff --git a/app/src/domains/housingProject.ts b/app/src/domains/housingProject.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { createActivity } from './activity';
 import { PermitStage, PermitState } from '../db/codes/enums';
@@ -150,7 +150,7 @@ export const generateHousingProjectData = async (
 
     if (data.permits.appliedPermits?.length) {
       appliedPermits = data.permits.appliedPermits.map((x: Permit) => {
-        const permitId = x.permitId ?? uuidv4();
+        const permitId = x.permitId ?? randomUUID();
 
         // Add each tracker for this permit with the proper permitId
         x.permitTracking?.forEach((pt) => appliedPermitTrackers.push({ ...pt, permitId }));
@@ -181,7 +181,7 @@ export const generateHousingProjectData = async (
 
     if (data.permits.investigatePermits?.length) {
       investigatePermits = data.permits.investigatePermits.map((x: Permit) => ({
-        permitId: x.permitId ?? uuidv4(),
+        permitId: x.permitId ?? randomUUID(),
         permitTypeId: x.permitTypeId,
         activityId: activityId,
         stage: PermitStage.PRE_SUBMISSION,
@@ -211,7 +211,7 @@ export const generateHousingProjectData = async (
       ...housing,
       ...location,
       ...permits,
-      housingProjectId: uuidv4(),
+      housingProjectId: randomUUID(),
       activityId: activityId,
       submittedAt: new Date(),
       submittedBy: getCurrentUsername(currentContext),
diff --git a/app/src/domains/permit.ts b/app/src/domains/permit.ts
@@ -1,5 +1,5 @@
 import config from 'config';
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { getProjectByActivityId } from './project';
 import { codeTable } from '../db/codes/cache';
@@ -132,7 +132,7 @@ export const sendPermitUpdateNotifications = async (
 
   // Create update note for status change
   const permitNoteRes = await repositories.permitNote.create({
-    permitNoteId: uuidv4(),
+    permitNoteId: randomUUID(),
     permitId: permit.permitId,
     note: note ?? `This application is ${stateDisplay.toLocaleLowerCase()} in the ${stageDisplay.toLocaleLowerCase()}.`
   });
diff --git a/app/src/domains/user.ts b/app/src/domains/user.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { DuplicateKeyProblem, NotFoundProblem } from '../db/errors';
 import { JwtUser } from '../services/login';
@@ -17,7 +17,7 @@ export const createUser = async (
 
   const newUser = {
     bceidBusinessName: data.bceidBusinessName ?? null,
-    userId: uuidv4(),
+    userId: randomUUID(),
     sub: data.sub,
     fullName: data.fullName,
     email: data.email,
diff --git a/app/src/external/ches.ts b/app/src/external/ches.ts
@@ -1,6 +1,6 @@
 import axios from 'axios';
 import config from 'config';
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import prisma from '../db/database.ts';
 
@@ -106,7 +106,7 @@ export const logEmail = async (data: EmailData | null, recipients: string[], sta
   return await prisma.$transaction(async (trx) => {
     return await trx.email_log.createMany({
       data: recipients.map((recipient) => ({
-        emailLogId: uuidv4(),
+        emailLogId: randomUUID(),
         msgId: data?.messages?.[0].msgId,
         to: recipient,
         txId: data?.txId,
diff --git a/app/src/services/accessRequest.ts b/app/src/services/accessRequest.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { unitOfWork } from '../db/unitOfWork.ts';
 import { isUserAdmin, removeUserGroups } from '../domains/accessRequest.ts';
@@ -146,7 +146,7 @@ export const createAccessRequestService = async (
         updateComsPerms = true;
       } else {
         const newAccessRequest = {
-          accessRequestId: uuidv4(),
+          accessRequestId: randomUUID(),
           grant: accessReq.grant,
           groupId: accessReq.groupId,
           status: AccessRequestStatus.PENDING,
diff --git a/app/src/services/draft.ts b/app/src/services/draft.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { jsonToPrismaInputJson } from '../db/utils/utils.ts';
 import { unitOfWork } from '../db/unitOfWork.ts';
@@ -110,7 +110,7 @@ export const upsertDraftService = async (
       const activityId = (await createActivity({ activity, initiative }, initiativeCode))?.activityId;
 
       const response = await draft.create({
-        draftId: uuidv4(),
+        draftId: randomUUID(),
         activityId,
         draftCode,
         data: jsonToPrismaInputJson(data.data)
diff --git a/app/src/services/login.ts b/app/src/services/login.ts
@@ -1,5 +1,5 @@
 import jwt from 'jsonwebtoken';
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { unitOfWork } from '../db/unitOfWork.ts';
 import { createUser, updateUser } from '../domains/user.ts';
@@ -83,7 +83,7 @@ export const loginService = async (token: jwt.JwtPayload): Promise<User> => {
         }
 
         const newContact = {
-          contactId: uuidv4(),
+          contactId: randomUUID(),
           userId: response.userId,
           firstName: firstNameOverride ?? newUser.firstName,
           lastName: lastNameOverride ?? newUser.lastName ?? ' ', // Default blank string if no other options
diff --git a/app/src/services/noteHistory.ts b/app/src/services/noteHistory.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { unitOfWork } from '../db/unitOfWork.ts';
 import { emailBringForwardNotification } from '../domains/noteHistory.ts';
@@ -23,11 +23,11 @@ export const createNoteHistoryService = async (data: NoteHistoryBase, noteStr: s
   return await unitOfWork.execute(async ({ note, noteHistory }) => {
     const historyResult = await noteHistory.create({
       ...data,
-      noteHistoryId: uuidv4()
+      noteHistoryId: randomUUID()
     });
 
     const noteResult = await note.create({
-      noteId: uuidv4(),
+      noteId: randomUUID(),
       noteHistoryId: historyResult.noteHistoryId,
       note: noteStr
     });
@@ -144,7 +144,7 @@ export const updateNoteHistoryService = async (
       if (note) {
         await note.create({
           noteHistoryId: data.noteHistoryId,
-          noteId: uuidv4(),
+          noteId: randomUUID(),
           note: noteStr
         });
       }
diff --git a/app/src/services/permit.ts b/app/src/services/permit.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { unitOfWork } from '../db/unitOfWork.ts';
 import { findPriorityPermitTracking } from '../domains/peach.ts';
@@ -191,7 +191,7 @@ export const upsertPermitService = async (
       // Add permit ID and stamp data if necessary
       const upsertPermitData: PermitBase = {
         ...permitData,
-        permitId: permitData.permitId || uuidv4()
+        permitId: permitData.permitId || randomUUID()
       };
 
       const sourceSystemKinds = await sourceSystemKind.list();
diff --git a/app/src/services/roadmap.ts b/app/src/services/roadmap.ts
@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { PermitStage } from '../db/codes/enums';
 import { unitOfWork } from '../db/unitOfWork';
@@ -117,7 +117,7 @@ export const sendRoadmapService = async (
       }
 
       const noteHistoryRes = await noteHistory.create({
-        noteHistoryId: uuidv4(),
+        noteHistoryId: randomUUID(),
         activityId: activityId,
         type: 'Roadmap',
         title: 'Sent roadmap',
@@ -130,7 +130,7 @@ export const sendRoadmapService = async (
       });
 
       const noteRes = await note.create({
-        noteId: uuidv4(),
+        noteId: randomUUID(),
         noteHistoryId: noteHistoryRes.noteHistoryId,
         note: noteBody
       });
diff --git a/app/src/utils/constants/application.ts b/app/src/utils/constants/application.ts
@@ -16,7 +16,6 @@ export const GROUP_NAME_LIST = [
   GroupName.SUPERVISOR
 ];
 
-export const NIL_UUID = '00000000-0000-0000-0000-000000000000';
 /**
  * Minimally valid UUIDv4 for the system ID
  * @see https://www.rfc-editor.org/rfc/rfc9562#variant_field
diff --git a/app/src/utils/regexp.ts b/app/src/utils/regexp.ts
@@ -1,2 +1,2 @@
 export const isoPattern = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/;
-export const uuidv4Pattern = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/;
+export const uuidV4Pattern = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/;
diff --git a/app/src/utils/utils.ts b/app/src/utils/utils.ts
@@ -4,14 +4,12 @@ import { join } from 'node:path';
 import { cwd } from 'node:process';
 
 import { IdentityProviderKind } from './enums/application.ts';
+import { uuidV4Pattern } from './regexp.ts';
 import { getLogger } from '../utils/log.ts';
 
 import type { CurrentContext, IdpAttributes, DateTimeStrings } from '../types/index.ts';
 
-// Constants
-const UUID_REGEX =
-  // eslint-disable-next-line max-len
-  /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/i;
+// Constants;
 const log = getLogger(module.filename);
 
 /**
@@ -410,34 +408,11 @@ export function toTitleCase(str: string): string {
 }
 
 /**
- * Validates a UUID and checks if it is version 4
- * @param uuid The UUID to validate
- * @returns True if the UUID is valid and is version 4
+ * Validates a UUIDV4
+ * @param uuid The UUIDV4 to validate
+ * @returns True if the UUIDV4 is valid
  */
-export function uuidValidateV4(uuid: string): boolean {
-  return uuidValidate(uuid) && uuidVersion(uuid) === 4;
-}
-
-/**
- * Validates a UUID
- * @param uuid The UUID to validate
- * @returns True if the UUID is valid
- */
-
-function uuidValidate(uuid: unknown) {
-  return typeof uuid === 'string' && UUID_REGEX.test(uuid);
-}
-
-/**
- * Validates a UUID and returns the version
- * @param uuid The UUID to get the version of
- * @returns The version of the UUID
- */
-
-export function uuidVersion(uuid: string) {
-  if (!uuidValidate(uuid)) {
-    throw TypeError('Invalid UUID');
-  }
 
-  return parseInt(uuid.slice(14, 15), 16);
+export function uuidValidateV4(uuid: string) {
+  return uuidV4Pattern.test(uuid);
 }
