Merge pull request #6377 from bcgov/refactor/6115

junminahn · web-flow · commit 206a514bde43 · 2025-08-25T17:19:14.000-07:00
feat(6115): improve event service design pattern
diff --git a/Makefile b/Makefile
@@ -25,10 +25,17 @@ install:
 	pnpm --dir sandbox/keycloak-provision install
 	pnpm --dir sandbox/m365mock install
 	pnpm --dir sandbox/nats-provision install
+install: canvas-install
+
+.PHONY: canvas-install
+canvas-install:
+	cd app/node_modules/.pnpm/canvas@3.2.0/node_modules/canvas &&\
+	pnpm add -D node-gyp &&\
+	pnpm exec node-gyp rebuild
 
 .PHONY: asdf-install
 asdf-install:
-	cat .tool-versions | cut -f 1 -d ' ' | xargs -n 1 asdf plugin-add || true
+	cat .tool-versions | cut -f 1 -d ' ' | xargs -n 1 asdf plugin add || true
 	asdf plugin update --all
 	asdf install || true
 	asdf reshim
diff --git a/app/app/api/keycloak/api-accounts/team/_operations/create.ts b/app/app/api/keycloak/api-accounts/team/_operations/create.ts
@@ -68,7 +68,7 @@ export default async function getOp({
 
   if (client) {
     await createEvent(EventType.CREATE_TEAM_API_TOKEN, session.user.id, {
-      clientUid: client.id,
+      clientUid: client.id!,
     });
   }
 
diff --git a/app/app/api/keycloak/api-accounts/team/_operations/update.ts b/app/app/api/keycloak/api-accounts/team/_operations/update.ts
@@ -78,7 +78,7 @@ export default async function getOp({
   });
 
   if (client) {
-    await createEvent(EventType.UPDATE_TEAM_API_TOKEN, session.user.id, { clientUid: client.id, roles });
+    await createEvent(EventType.UPDATE_TEAM_API_TOKEN, session.user.id, { clientUid: client.id!, roles });
   }
 
   return OkResponse({ client, user });
diff --git a/app/services/db/event.ts b/app/services/db/event.ts
@@ -9,40 +9,60 @@ import { objectId } from '@/validation-schemas';
 import { EventSearchBody } from '@/validation-schemas/event';
 import { organizationBodySchema } from '@/validation-schemas/organization';
 
+const requestIdSchema = z.object({
+  requestId: z.string().length(24),
+});
+
+const licencePlateSchema = z.object({
+  licencePlate: z.string().min(6),
+});
+
 const validationSchemas = {
-  [EventType.CREATE_PRIVATE_CLOUD_PRODUCT]: z.object({
-    requestId: z.string().length(24),
-  }),
-  [EventType.UPDATE_PRIVATE_CLOUD_PRODUCT]: z.object({
-    requestId: z.string().length(24),
-  }),
-  [EventType.DELETE_PRIVATE_CLOUD_PRODUCT]: z.object({
-    requestId: z.string().length(24),
-  }),
-  [EventType.REVIEW_PRIVATE_CLOUD_REQUEST]: z.object({
-    requestId: z.string().length(24),
-  }),
-  [EventType.RESEND_PRIVATE_CLOUD_REQUEST]: z.object({
-    requestId: z.string().length(24),
-  }),
-  [EventType.REPROVISION_PRIVATE_CLOUD_PRODUCT]: z.object({
-    licencePlate: z.string().min(6),
+  [EventType.CREATE_TEAM_API_TOKEN]: z.object({
+    clientUid: z.string(),
   }),
-  [EventType.CREATE_PUBLIC_CLOUD_PRODUCT]: z.object({
-    requestId: z.string().length(24),
+  [EventType.UPDATE_TEAM_API_TOKEN]: z.object({
+    clientUid: z.string(),
+    users: z
+      .array(
+        z.object({
+          email: z.string().email(),
+          type: z.enum(['add', 'remove']),
+        }),
+      )
+      .optional(),
+    roles: z.array(z.string()).optional(),
+    result: z
+      .array(
+        z.object({
+          success: z.boolean(),
+          email: z.email(),
+          error: z.string().optional(),
+        }),
+      )
+      .optional(),
   }),
-  [EventType.UPDATE_PUBLIC_CLOUD_PRODUCT]: z.object({
-    requestId: z.string().length(24),
-  }),
-  [EventType.DELETE_PUBLIC_CLOUD_PRODUCT]: z.object({
-    requestId: z.string().length(24),
-  }),
-  [EventType.REVIEW_PUBLIC_CLOUD_REQUEST]: z.object({
-    requestId: z.string().length(24),
-  }),
-  [EventType.RESEND_PUBLIC_CLOUD_REQUEST]: z.object({
-    requestId: z.string().length(24),
+  [EventType.DELETE_TEAM_API_TOKEN]: z.object({
+    clientUid: z.string(),
   }),
+  [EventType.CREATE_API_TOKEN]: z.undefined(),
+  [EventType.DELETE_API_TOKEN]: z.undefined(),
+
+  [EventType.CREATE_PRIVATE_CLOUD_PRODUCT]: requestIdSchema,
+  [EventType.UPDATE_PRIVATE_CLOUD_PRODUCT]: requestIdSchema,
+  [EventType.DELETE_PRIVATE_CLOUD_PRODUCT]: requestIdSchema,
+  [EventType.REVIEW_PRIVATE_CLOUD_REQUEST]: requestIdSchema,
+  [EventType.RESEND_PRIVATE_CLOUD_REQUEST]: requestIdSchema,
+  [EventType.CANCEL_PRIVATE_CLOUD_REQUEST]: requestIdSchema,
+  [EventType.REPROVISION_PRIVATE_CLOUD_PRODUCT]: licencePlateSchema,
+
+  [EventType.CREATE_PUBLIC_CLOUD_PRODUCT]: requestIdSchema,
+  [EventType.UPDATE_PUBLIC_CLOUD_PRODUCT]: requestIdSchema,
+  [EventType.DELETE_PUBLIC_CLOUD_PRODUCT]: requestIdSchema,
+  [EventType.REVIEW_PUBLIC_CLOUD_REQUEST]: requestIdSchema,
+  [EventType.RESEND_PUBLIC_CLOUD_REQUEST]: requestIdSchema,
+  [EventType.CANCEL_PUBLIC_CLOUD_REQUEST]: requestIdSchema,
+
   [EventType.CREATE_ORGANIZATION]: z.object({
     id: objectId,
     data: organizationBodySchema,
@@ -54,10 +74,50 @@ const validationSchemas = {
   }),
   [EventType.DELETE_ORGANIZATION]: z.object({
     id: objectId,
+    to: objectId,
     data: organizationBodySchema,
   }),
+  [EventType.LOGIN]: z.undefined(),
+  [EventType.LOGOUT]: z.undefined(),
+  [EventType.EXPORT_PRIVATE_CLOUD_PRODUCT]: z.any(),
+  [EventType.EXPORT_PUBLIC_CLOUD_PRODUCT]: z.any(),
+};
+
+type EventDataMap = {
+  [K in keyof typeof validationSchemas]: z.infer<(typeof validationSchemas)[K]>;
 };
 
+export async function createEvent<T extends keyof typeof validationSchemas>(
+  type: T,
+  userId = '',
+  data?: EventDataMap[T],
+) {
+  try {
+    const validationSchema = validationSchemas[type];
+
+    // Validate only if schema is not z.any()
+    if (validationSchema && validationSchema !== z.any()) {
+      const parsed = validationSchema.safeParse(data);
+      if (!parsed.success) {
+        throw new Error(`Invalid data for event type ${type}: ${JSON.stringify(parsed.error.format())}`);
+      }
+    }
+
+    return await prisma.event.create({
+      data: {
+        type,
+        userId,
+        data: (data ?? {}) as Prisma.InputJsonValue,
+      },
+    });
+  } catch (error) {
+    logger.error('createEvent error:', error);
+    throw error;
+  }
+}
+
+const defaultSortKey = 'createdAt';
+
 type SearchEvent = Prisma.EventGetPayload<{
   select: {
     id: true;
@@ -76,35 +136,6 @@ type SearchEvent = Prisma.EventGetPayload<{
   };
 }>;
 
-const defaultSortKey = 'createdAt';
-
-const validationKeys = Object.keys(validationSchemas);
-
-export async function createEvent(type: EventType, userId = '', data = {}) {
-  try {
-    if (validationKeys.includes(type)) {
-      const validationSchame = validationSchemas[type as keyof typeof validationSchemas];
-
-      const parsed = validationSchame.safeParse(data);
-      if (!parsed.success) {
-        throw Error(`invalid data for event type ${type}: ${JSON.stringify(data)}`);
-      }
-    }
-
-    const event = await prisma.event.create({
-      data: {
-        type,
-        userId,
-        data,
-      },
-    });
-
-    return event;
-  } catch (error) {
-    logger.error('createEvent:', error);
-  }
-}
-
 export async function searchEvents({
   types = [],
   dates = [],
diff --git a/docs/development-setup/local-development-environment.md b/docs/development-setup/local-development-environment.md
@@ -61,6 +61,14 @@ git config gpg.program gpg
 
 1. Install `asdf` according to the `asdf` installation guide.
     - https://asdf-vm.com/guide/getting-started.html#getting-started
+    - example
+        ```sh
+        curl -fsSL -o asdf.tar.gz "https://github.com/asdf-vm/asdf/releases/download/v0.19.0/asdf-v0.19.0-linux-amd64.tar.gz" || { echo "❌ Failed to download ASDF" }
+        tar -xzf asdf.tar.gz
+        rm -f asdf.tar.gz
+        mv asdf /usr/local/bin/
+        echo 'export PATH="/usr/local/bin/:${ASDF_DATA_DIR:-$HOME/.asdf}/shims:$PATH"' >> ~/.bashrc # or ~/.zshrc, ~/.bash_profile, etc..
+        ```
 1. Install `asdf` packages defined in `.tool-versions`.
     ```sh
     cat .tool-versions | cut -f 1 -d ' ' | xargs -n 1 asdf plugin-add || true
diff --git a/sandbox/keycloak-provision/main.ts b/sandbox/keycloak-provision/main.ts
@@ -115,41 +115,6 @@ async function main() {
     clientScopeId: scope?.id as string,
   });
 
-  // Create ministry level roles
-  [
-    'aest',
-    'ag',
-    'agri',
-    'alc',
-    'bcpc',
-    'citz',
-    'dbc',
-    'eao',
-    'educ',
-    'emcr',
-    'empr',
-    'env',
-    'fin',
-    'flnr',
-    'hlth',
-    'irr',
-    'jedc',
-    'lbr',
-    'ldb',
-    'mcf',
-    'mmha',
-    'psa',
-    'pssg',
-    'sdpr',
-    'tca',
-    'tran',
-    'hma',
-    'wlrs',
-  ].forEach(async (ministry) => {
-    await kc.createClientRole(AUTH_REALM_NAME, authClient?.id as string, `ministry-${ministry}-reader`);
-    await kc.createClientRole(AUTH_REALM_NAME, authClient?.id as string, `ministry-${ministry}-editor`);
-  });
-
   await kc.createClientRole(AUTH_REALM_NAME, authClient?.id as string, `billing-reviewer`);
   await kc.createClientRole(AUTH_REALM_NAME, authClient?.id as string, `billing-reader`);
   await kc.createClientRole(AUTH_REALM_NAME, authClient?.id as string, `finance-manager`);

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ export default async function getOp({`
`68`	`68`
`69`	`69`	`if (client) {`
`70`	`70`	`await createEvent(EventType.CREATE_TEAM_API_TOKEN, session.user.id, {`
`71`		`- clientUid: client.id,`
	`71`	`+ clientUid: client.id!,`
`72`	`72`	`});`
`73`	`73`	`}`
`74`	`74`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ export default async function getOp({`
`78`	`78`	`});`
`79`	`79`
`80`	`80`	`if (client) {`
`81`		`- await createEvent(EventType.UPDATE_TEAM_API_TOKEN, session.user.id, { clientUid: client.id, roles });`
	`81`	`+ await createEvent(EventType.UPDATE_TEAM_API_TOKEN, session.user.id, { clientUid: client.id!, roles });`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`return OkResponse({ client, user });`