refactor(core): add user ip to webhook event payload (#5049)

.changeset/spotty-ants-clap.md

@@ -0,0 +1,6 @@
+---
+"@logto/schemas": patch
+"@logto/core": patch
+---
+
+refactor: add user ip to webhook event payload

packages/core/src/libraries/hook/index.ts

@@ -27,6 +27,7 @@ export type InteractionHookContext = {
   event: InteractionEvent;
   sessionId?: string;
   applicationId?: string;
+  userIp?: string;
 };
 
 /**
@@ -59,7 +60,7 @@ export const createHookLibrary = (queries: Queries) => {
     userAgent?: string
   ) => {
     const { userId } = interactionResult;
-    const { event, sessionId, applicationId } = interactionContext;
+    const { event, sessionId, applicationId, userIp } = interactionContext;
 
     const hookEvent = eventToHook[event];
     const found = await findAllHooks();
@@ -84,6 +85,7 @@ export const createHookLibrary = (queries: Queries) => {
       sessionId,
       userAgent,
       userId,
+      userIp,
       user: user && pick(user, ...userInfoSelectFields),
       application: application && pick(application, 'id', 'type', 'name', 'description'),
     } satisfies Omit<HookEventPayload, 'hookId'>;

packages/core/src/libraries/hook/utils.ts

@@ -51,6 +51,7 @@ export const generateHookTestPayload = (hookId: string, event: HookEvent): HookE
     sessionId: 'fake-session-id',
     userAgent: 'fake-user-agent',
     userId: fakeUserId,
+    userIp: 'fake-user-ip',
     user: {
       id: fakeUserId,
       username: 'fake-user',

packages/core/src/routes/interaction/middleware/koa-interaction-hooks.ts

@@ -35,6 +35,7 @@ export default function koaInteractionHooks<
     const {
       interactionDetails,
       header: { 'user-agent': userAgent },
+      ip,
     } = ctx;
 
     // Predefined interaction hook context
@@ -42,6 +43,7 @@ export default function koaInteractionHooks<
       event,
       sessionId: interactionDetails.jti,
       applicationId: conditionalString(interactionDetails.params.client_id),
+      userIp: ip,
     };
 
     // eslint-disable-next-line @silverhand/fp/no-let

packages/integration-tests/src/tests/api/hook/hook.trigger.test.ts

@@ -129,6 +129,12 @@ describe('trigger hooks', () => {
     const { username, password } = generateNewUserProfile({ username: true, password: true });
     const userId = await registerNewUser(username, password);
 
+    type HookRequest = {
+      body: {
+        userIp?: string;
+      } & Record<string, unknown>;
+    };
+
     // Check hook trigger log
     for (const [hook, expectedResult, expectedError] of [
       [hook1, LogResult.Error, 'RequestError: Invalid URL'],
@@ -140,6 +146,12 @@ describe('trigger hooks', () => {
         hook.id,
         new URLSearchParams({ logKey, page_size: '100' })
       );
+
+      // Assert user ip is in the hook request
+      expect(
+        logs.every(({ payload }) => (payload.hookRequest as HookRequest).body.userIp)
+      ).toBeTruthy();
+
       expect(
         logs.some(
           ({ payload: { result, error } }) =>

packages/schemas/src/types/hook.ts

@@ -12,6 +12,7 @@ export type HookEventPayload = {
   sessionId?: string;
   userAgent?: string;
   userId?: string;
+  userIp?: string;
   user?: Pick<User, (typeof userInfoSelectFields)[number]>;
   application?: Pick<Application, 'id' | 'type' | 'name' | 'description'>;
 } & Record<string, unknown>;