Merge pull request #530 from bcgov/chore/migrate-to-native-uuid

refactor: migrate to node:crypto UUIDv4 generation

Author: kyle1morel

app/package-lock.json

@@ -86,7 +86,6 @@
     "pg": "8.22.0",
     "proj4": "2.20.9",
     "tsx": "4.23.0",
-    "uuid": "11.1.1",
     "winston-transport": "4.9.0"
   },
   "devDependencies": {

app/package.json

@@ -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]);
 };

app/src/controllers/contact.ts

@@ -1,10 +1,12 @@
 /* eslint-disable max-len */
-import { NIL, v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 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()
@@ -421,18 +423,18 @@ export async function up(knex: Knex): Promise<void> {
       .then(() => {
         const users = ['system'];
         const items = users.map((user) => ({
-          user_id: NIL,
+          user_id: NIL_UUID,
           username: user,
           active: true,
-          created_by: NIL
+          created_by: NIL_UUID
         }));
         return knex('user').insert(items);
       })
 
       .then(() => {
         const items = [
           {
-            initiative_id: uuidv4(),
+            initiative_id: randomUUID(),
             code: 'HOUSING',
             label: 'Housing'
           }

app/src/db/migrations/20231212000000_init.ts

@@ -1,5 +1,5 @@
 /* eslint-disable max-len */
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { addAuditStamps } from '../utils/migrations/helpers.ts';
 import { Action, GroupName, Initiative, Resource, ResourceLegacy } from '../../utils/enums/application.ts';
@@ -420,7 +420,7 @@ export async function up(knex: Knex): Promise<void> {
         if (exists.length === 0) {
           const items = [
             {
-              initiative_id: uuidv4(),
+              initiative_id: randomUUID(),
               code: Initiative.PCNS,
               label: 'Permit Connect Navigator Service'
             }

app/src/db/migrations/20240904000000_009-rbac.ts

@@ -7,7 +7,7 @@
  */
 
 /* eslint-disable max-len */
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { addAuditStamps } from '../utils/migrations/helpers.ts';
 
@@ -117,7 +117,7 @@ export async function up(knex: Knex): Promise<void> {
           .from({ s: 'public.submission' });
 
         submissions = submissions.map((x) => ({
-          contact_id: uuidv4(),
+          contact_id: randomUUID(),
           ...x
         }));
 
@@ -134,7 +134,7 @@ export async function up(knex: Knex): Promise<void> {
           .from({ e: 'public.enquiry' });
 
         enquiries = enquiries.map((x) => ({
-          contact_id: uuidv4(),
+          contact_id: randomUUID(),
           ...x
         }));
 

app/src/db/migrations/20241125000000_014-user-contacts.ts

@@ -1,5 +1,5 @@
 /* eslint-disable max-len */
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import { addAuditStamps } from '../utils/migrations/helpers.ts';
 import { Action, GroupName, Initiative, Resource } from '../../utils/enums/application.ts';
@@ -186,7 +186,7 @@ export async function up(knex: Knex): Promise<void> {
       .then(() => {
         const items = [
           {
-            initiative_id: uuidv4(),
+            initiative_id: randomUUID(),
             code: 'ELECTRIFICATION',
             label: 'Electrification'
           }

app/src/db/migrations/20250514000000_031-electrification.ts

@@ -1,13 +1,13 @@
-import { NIL } from 'uuid';
-
 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(() => {
-      return knex('user').where('user_id', NIL).update({ user_id: SYSTEM_ID });
+      return knex('user').where('user_id', NIL_UUID).update({ user_id: SYSTEM_ID });
     })
 
     .then(() =>
@@ -118,6 +118,6 @@ export async function down(knex: Knex): Promise<void> {
     )
 
     .then(() => {
-      return knex('user').where('user_id', SYSTEM_ID).update({ user_id: NIL });
+      return knex('user').where('user_id', SYSTEM_ID).update({ user_id: NIL_UUID });
     });
 }

app/src/db/migrations/20251027000000_044-system-id-change.ts

@@ -1,5 +1,5 @@
 /* eslint-disable max-len */
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID } from 'node:crypto';
 
 import {
   addAuditStamps,
@@ -35,7 +35,7 @@ export async function up(knex: Knex): Promise<void> {
       .then(() => {
         return knex('initiative').insert([
           {
-            initiative_id: uuidv4(),
+            initiative_id: randomUUID(),
             code: Initiative.GENERAL,
             label: 'Generic'
           }

app/src/db/migrations/20260420000000_058-general-projects.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 }