Add more audit log events

2026-10-11 23:29:05 +00:00 · 2023-08-08 09:50:49 +07:00
parent 648968c453
commit 2591161272
19 changed files with 1117 additions and 53 deletions
@@ -1,11 +1,31 @@
 import { EventType, UserAgentType } from "./enums";

 export const eventToNameMap: { [K in EventType]: string } = {
-    [EventType.GET_SECRETS]: "Get Secrets",
-    [EventType.GET_SECRET]: "Get Secret",
-    [EventType.CREATE_SECRET]: "Create Secret",
-    [EventType.UPDATE_SECRET]: "Update Secret",
-    [EventType.DELETE_SECRET]: "Delete Secret",
+    [EventType.GET_SECRETS]: "Get secrets",
+    [EventType.GET_SECRET]: "Get secret",
+    [EventType.CREATE_SECRET]: "Create secret",
+    [EventType.UPDATE_SECRET]: "Update secret",
+    [EventType.DELETE_SECRET]: "Delete secret",
+    [EventType.AUTHORIZE_INTEGRATION]: "Authorize integration",
+    [EventType.UNAUTHORIZE_INTEGRATION]: "Unauthorize integration",
+    [EventType.CREATE_INTEGRATION]: "Create integration",
+    [EventType.DELETE_INTEGRATION]: "Delete integration",
+    [EventType.ADD_TRUSTED_IP]: "Add trusted IP",
+    [EventType.UPDATE_TRUSTED_IP]: "Update trusted IP",
+    [EventType.DELETE_TRUSTED_IP]: "Delete trusted IP",
+    [EventType.CREATE_SERVICE_TOKEN]: "Create service token",
+    [EventType.DELETE_SERVICE_TOKEN]: "Delete service token",
+    [EventType.CREATE_ENVIRONMENT]: "Create environment",
+    [EventType.UPDATE_ENVIRONMENT]: "Update environment",
+    [EventType.DELETE_ENVIRONMENT]: "Delete environment",
+    [EventType.ADD_WORKSPACE_MEMBER]: "Add member",
+    [EventType.REMOVE_WORKSPACE_MEMBER]: "Remove member",
+    [EventType.CREATE_FOLDER]: "Create folder",
+    [EventType.UPDATE_FOLDER]: "Update folder",
+    [EventType.DELETE_FOLDER]: "Delete folder",
+    [EventType.CREATE_WEBHOOK]: "Create webhook",
+    [EventType.UPDATE_WEBHOOK_STATUS]: "Update webhook status",
+    [EventType.DELETE_WEBHOOK]: "Delete webhook",
 };

 export const userAgentTTypeoNameMap: { [K in UserAgentType]: string } = {
@@ -11,9 +11,29 @@ export enum UserAgentType {
 }

 export enum EventType {
-    GET_SECRETS = "get-secrets",
-    GET_SECRET = "get-secret",
-    CREATE_SECRET = "create-secret",
-    UPDATE_SECRET = "update-secret",
-    DELETE_SECRET = "delete-secret"
+  GET_SECRETS = "get-secrets",
+  GET_SECRET = "get-secret",
+  CREATE_SECRET = "create-secret",
+  UPDATE_SECRET = "update-secret",
+  DELETE_SECRET = "delete-secret",
+  AUTHORIZE_INTEGRATION = "authorize-integration",
+  UNAUTHORIZE_INTEGRATION = "unauthorize-integration",
+  CREATE_INTEGRATION = "create-integration",
+  DELETE_INTEGRATION = "delete-integration",
+  ADD_TRUSTED_IP = "add-trusted-ip",
+  UPDATE_TRUSTED_IP = "update-trusted-ip",
+  DELETE_TRUSTED_IP = "delete-trusted-ip",
+  CREATE_SERVICE_TOKEN = "create-service-token",
+  DELETE_SERVICE_TOKEN = "delete-service-token",
+  CREATE_ENVIRONMENT = "create-environment",
+  UPDATE_ENVIRONMENT = "update-environment",
+  DELETE_ENVIRONMENT = "delete-environment",
+  ADD_WORKSPACE_MEMBER = "add-workspace-member",
+  REMOVE_WORKSPACE_MEMBER = "remove-workspace-member",
+  CREATE_FOLDER = "create-folder",
+  UPDATE_FOLDER = "update-folder",
+  DELETE_FOLDER = "delete-folder",
+  CREATE_WEBHOOK = "create-webhook",
+  UPDATE_WEBHOOK_STATUS = "update-webhook-status",
+  DELETE_WEBHOOK = "delete-webhook"
 }
@@ -2,28 +2,22 @@ import { useQuery } from "@tanstack/react-query";

 import { apiRequest } from "@app/config/request";

-import { EventType, UserAgentType } from "./enums";
 import {
    Actor,
-    AuditLog} from "./types";
+    AuditLog,
+    AuditLogFilters
+} from "./types";

 export const workspaceKeys = {
-    getAuditLogs: (workspaceId: string, filters: {
-        eventType?: EventType;
-        userAgentType?: UserAgentType;
-        actor?: string;
-    }) => [{ workspaceId, filters }, "audit-logs"] as const,
+    getAuditLogs: (workspaceId: string, filters: AuditLogFilters) => [{ workspaceId, filters }, "audit-logs"] as const,
    getAuditLogActorFilterOpts: (workspaceId: string) => [{ workspaceId }, "audit-log-actor-filters"] as const
 }

-export const useGetAuditLogs = (workspaceId: string, filters: {
-    eventType?: EventType;
-    userAgentType?: UserAgentType;
-    actor?: string;
-}) => {
+export const useGetAuditLogs = (workspaceId: string, filters: AuditLogFilters) => {
    return useQuery({ 
        queryKey: workspaceKeys.getAuditLogs(workspaceId, filters), 
        queryFn: async () => {
+            
            const params = new URLSearchParams();
            if (filters.eventType) {
                params.append("eventType", filters.eventType);
@@ -37,6 +31,13 @@ export const useGetAuditLogs = (workspaceId: string, filters: {
                params.append("actor", filters.actor); 
            }

+            if (filters.actor) {
+                params.append("actor", filters.actor); 
+            }
+
+            params.append("offset ", String(filters.offset));
+            params.append("limit ", String(filters.limit));
+            
            const { data } = await apiRequest.get<{ auditLogs: AuditLog[] }>(`/api/v1/workspace/${workspaceId}/audit-logs`, { params });
            return data.auditLogs;
        }
@@ -82,12 +82,227 @@ interface DeleteSecretEvent {
    }
 }

+interface AuthorizeIntegrationEvent {
+    type: EventType.AUTHORIZE_INTEGRATION;
+    metadata: {
+        integration: string; // TODO: fix type
+    }
+}
+
+interface UnauthorizeIntegrationEvent {
+    type: EventType.UNAUTHORIZE_INTEGRATION;
+    metadata: {
+        integration: string; // TODO: fix type
+    }
+}
+
+interface CreateIntegrationEvent {
+    type: EventType.CREATE_INTEGRATION;
+    metadata: {
+        integrationId: string;
+        integration: string; // TODO: fix type
+        environment: string;
+        secretPath: string;
+        app?: string;
+        targetEnvironment?: string;
+        targetEnvironmentId?: string; // TODO: consider adding other vars
+    }
+}
+
+interface DeleteIntegrationEvent {
+    type: EventType.DELETE_INTEGRATION;
+    metadata: {
+        integrationId: string;
+        integration: string; // TODO: fix type
+        environment: string;
+        secretPath: string;
+        app?: string;
+        targetEnvironment?: string;
+        targetEnvironmentId?: string;
+    }
+}
+
+interface AddTrustedIPEvent {
+    type: EventType.ADD_TRUSTED_IP;
+    metadata: {
+        trustedIpId: string;
+        ipAddress: string;
+        prefix?: number;
+    }
+}
+
+interface UpdateTrustedIPEvent {
+    type: EventType.UPDATE_TRUSTED_IP;
+    metadata: {
+        trustedIpId: string;
+        ipAddress: string;
+        prefix?: number;
+    }
+}
+
+interface DeleteTrustedIPEvent {
+    type: EventType.DELETE_TRUSTED_IP;
+    metadata: {
+        trustedIpId: string;
+        ipAddress: string;
+        prefix?: number;
+    }
+}
+
+interface CreateServiceTokenEvent {
+    type: EventType.CREATE_SERVICE_TOKEN;
+    metadata: {
+        name: string;
+        scopes: Array<{
+            environment: string;
+            secretPath: string;
+        }>;
+    }
+}
+
+interface DeleteServiceTokenEvent {
+    type: EventType.DELETE_SERVICE_TOKEN;
+    metadata: {
+        name: string;
+        scopes: Array<{
+            environment: string;
+            secretPath: string;
+        }>;
+    }
+}
+
+interface CreateEnvironmentEvent {
+    type: EventType.CREATE_ENVIRONMENT;
+    metadata: {
+        name: string;
+        slug: string;
+    }
+}
+
+interface UpdateEnvironmentEvent {
+    type: EventType.UPDATE_ENVIRONMENT;
+    metadata: {
+        oldName: string;
+        newName: string;
+        oldSlug: string;
+        newSlug: string;
+    }
+}
+
+interface DeleteEnvironmentEvent {
+    type: EventType.DELETE_ENVIRONMENT;
+    metadata: {
+        name: string;
+        slug: string;
+    }
+}
+
+interface AddWorkspaceMemberEvent {
+    type: EventType.ADD_WORKSPACE_MEMBER;
+    metadata: {
+        userId: string;
+        email: string;
+    }
+}
+
+interface RemoveWorkspaceMemberEvent {
+    type: EventType.REMOVE_WORKSPACE_MEMBER;
+    metadata: {
+        userId: string;
+        email: string;
+    }
+}
+
+interface CreateFolderEvent {
+    type: EventType.CREATE_FOLDER;
+    metadata: {
+        environment: string;
+        folderId: string;
+        folderName: string;
+        folderPath: string;
+    }
+}
+
+interface UpdateFolderEvent {
+    type: EventType.UPDATE_FOLDER;
+    metadata: {
+        environment: string;
+        folderId: string;
+        oldFolderName: string;
+        newFolderName: string;
+        folderPath: string;
+    }
+}
+
+interface DeleteFolderEvent {
+    type: EventType.DELETE_FOLDER;
+    metadata: {
+        environment: string;
+        folderId: string;
+        folderName: string;
+        folderPath: string;
+    }
+}
+
+interface CreateWebhookEvent {
+    type: EventType.CREATE_WEBHOOK,
+    metadata: {
+        webhookId: string;
+        environment: string;
+        secretPath: string;
+        webhookUrl: string;
+        isDisabled: boolean;
+    }
+}
+
+interface UpdateWebhookStatusEvent {
+    type: EventType.UPDATE_WEBHOOK_STATUS,
+    metadata: {
+        webhookId: string;
+        environment: string;
+        secretPath: string;
+        webhookUrl: string;
+        isDisabled: boolean;
+    }
+}
+
+interface DeleteWebhookEvent {
+    type: EventType.DELETE_WEBHOOK,
+    metadata: {
+        webhookId: string;
+        environment: string;
+        secretPath: string;
+        webhookUrl: string;
+        isDisabled: boolean;
+    }
+}
+
 export type Event = 
    | GetSecretsEvent
    | GetSecretEvent
    | CreateSecretEvent
    | UpdateSecretEvent
-    | DeleteSecretEvent;
+    | DeleteSecretEvent
+    | AuthorizeIntegrationEvent
+    | UnauthorizeIntegrationEvent
+    | CreateIntegrationEvent
+    | DeleteIntegrationEvent
+    | AddTrustedIPEvent
+    | UpdateTrustedIPEvent
+    | DeleteTrustedIPEvent
+    | CreateServiceTokenEvent
+    | DeleteServiceTokenEvent
+    | CreateEnvironmentEvent
+    | UpdateEnvironmentEvent
+    | DeleteEnvironmentEvent
+    | AddWorkspaceMemberEvent
+    | RemoveWorkspaceMemberEvent
+    | CreateFolderEvent
+    | UpdateFolderEvent
+    | DeleteFolderEvent
+    | CreateWebhookEvent
+    | UpdateWebhookStatusEvent
+    | DeleteWebhookEvent;

 export type AuditLog = {
  _id: string;
@@ -101,3 +316,11 @@ export type AuditLog = {
  createdAt: string;
  updatedAt: string;
 }
+
+export type AuditLogFilters = {
+    eventType?: EventType;
+    userAgentType?: UserAgentType;
+    actor?: string;
+    offset: number;
+    limit: number;
+}
@@ -33,7 +33,9 @@ export const LogsTable = ({
    const { data, isLoading } = useGetAuditLogs(currentWorkspace?._id ?? "", {
        eventType,
        userAgentType,
-        actor
+        actor,
+        offset: 0, // TODO: update with pagination
+        limit: 20 // TODO: update with pagination
    });
    
    return (
@@ -79,6 +79,169 @@ export const LogsTableRow = ({
                        <p>{`Secret: ${event.metadata.secretKey}`}</p>
                    </Td>
                );
+            case EventType.AUTHORIZE_INTEGRATION:
+                return (
+                    <Td>
+                        <p>{`Integration: ${event.metadata.integration}`}</p>
+                    </Td>
+                );
+            case EventType.UNAUTHORIZE_INTEGRATION:
+                return (
+                    <Td>
+                        <p>{`Integration: ${event.metadata.integration}`}</p>
+                    </Td>
+                );
+            case EventType.CREATE_INTEGRATION:
+                return (
+                    <Td>
+                        <p>{`Integration: ${event.metadata.integration}`}</p>
+                        <p>{`Environment: ${event.metadata.environment}`}</p>
+                        <p>{`Path: ${event.metadata.secretPath}`}</p>
+                        {event.metadata.app && (
+                            <p>{`Target app: ${event.metadata.app}`}</p>
+                        )}
+                        {event.metadata.targetEnvironment && (
+                            <p>{`Target environment: ${event.metadata.targetEnvironment}`}</p>
+                        )}
+                        {event.metadata.targetEnvironmentId && (
+                            <p>{`Target environment ID: ${event.metadata.targetEnvironmentId}`}</p>
+                        )}
+                    </Td>
+                );
+            case EventType.DELETE_INTEGRATION:
+                return (
+                    <Td>
+                        <p>{`Integration: ${event.metadata.integration}`}</p>
+                        <p>{`Environment: ${event.metadata.environment}`}</p>
+                        <p>{`Path: ${event.metadata.secretPath}`}</p>
+                        {event.metadata.app && (
+                            <p>{`Target App: ${event.metadata.app}`}</p>
+                        )}
+                        {event.metadata.targetEnvironment && (
+                            <p>{`Target environment: ${event.metadata.targetEnvironment}`}</p>
+                        )}
+                        {event.metadata.targetEnvironmentId && (
+                            <p>{`Target environment ID: ${event.metadata.targetEnvironmentId}`}</p>
+                        )}
+                    </Td>
+                );
+            case EventType.ADD_TRUSTED_IP:
+                return (
+                    <Td>
+                        <p>{`IP: ${event.metadata.ipAddress}${event.metadata.prefix !== undefined ? `/${event.metadata.prefix}` : ""}`}</p>
+                    </Td>
+                );
+            case EventType.UPDATE_TRUSTED_IP:
+                return (
+                    <Td>
+                        <p>{`IP: ${event.metadata.ipAddress}${event.metadata.prefix !== undefined ? `/${event.metadata.prefix}` : ""}`}</p>
+                    </Td>
+                );
+            case EventType.DELETE_TRUSTED_IP:
+                return (
+                    <Td>
+                        <p>{`IP: ${event.metadata.ipAddress}${event.metadata.prefix !== undefined ? `/${event.metadata.prefix}` : ""}`}</p>
+                    </Td>
+                );
+            case EventType.CREATE_SERVICE_TOKEN:
+                return (
+                    <Td>
+                        <p>{`Name: ${event.metadata.name}`}</p>
+                    </Td>
+                );
+            case EventType.DELETE_SERVICE_TOKEN:
+                return (
+                    <Td>
+                        <p>{`Name: ${event.metadata.name}`}</p>
+                    </Td>
+                );
+            case EventType.CREATE_ENVIRONMENT:
+                return (
+                    <Td>
+                        <p>{`Name: ${event.metadata.name}`}</p>
+                        <p>{`Slug: ${event.metadata.slug}`}</p>
+                    </Td>
+                );
+            case EventType.UPDATE_ENVIRONMENT:
+                return (
+                    <Td>
+                        <p>{`Old name: ${event.metadata.oldName}`}</p>
+                        <p>{`New name: ${event.metadata.newName}`}</p>
+                        <p>{`Old slug: ${event.metadata.oldSlug}`}</p>
+                        <p>{`New slug: ${event.metadata.newSlug}`}</p>
+                    </Td>
+                );
+            case EventType.DELETE_ENVIRONMENT:
+                return (
+                    <Td>
+                        <p>{`Name: ${event.metadata.name}`}</p>
+                        <p>{`Slug: ${event.metadata.slug}`}</p>
+                    </Td>
+                );
+            case EventType.ADD_WORKSPACE_MEMBER:
+                return (
+                    <Td>
+                        <p>{`Email: ${event.metadata.email}`}</p>
+                    </Td>
+                );
+            case EventType.REMOVE_WORKSPACE_MEMBER:
+                return (
+                    <Td>
+                        <p>{`Email: ${event.metadata.email}`}</p>
+                    </Td>
+                );
+            case EventType.CREATE_FOLDER:
+                return (
+                    <Td>
+                        <p>{`Environment: ${event.metadata.environment}`}</p>
+                        <p>{`Path: ${event.metadata.folderPath}`}</p>
+                        <p>{`Folder: ${event.metadata.folderName}`}</p>
+                    </Td>
+                );
+            case EventType.UPDATE_FOLDER:
+                return (
+                    <Td>
+                        <p>{`Environment: ${event.metadata.environment}`}</p>
+                        <p>{`Path: ${event.metadata.folderPath}`}</p>
+                        <p>{`Old folder: ${event.metadata.oldFolderName}`}</p>
+                        <p>{`New folder: ${event.metadata.newFolderName}`}</p>
+                    </Td>
+                );
+            case EventType.DELETE_FOLDER:
+                return (
+                    <Td>
+                        <p>{`Environment: ${event.metadata.environment}`}</p>
+                        <p>{`Path: ${event.metadata.folderPath}`}</p>
+                        <p>{`Folder: ${event.metadata.folderName}`}</p>
+                    </Td>
+                );
+            case EventType.CREATE_WEBHOOK:
+                return (
+                    <Td>
+                        <p>{`Environment: ${event.metadata.environment}`}</p>
+                        <p>{`Secret Path: ${event.metadata.secretPath}`}</p>
+                        <p>{`Webhook URL: ${event.metadata.webhookUrl}`}</p>
+                        <p>{`Disabled: ${event.metadata.isDisabled}`}</p>
+                    </Td>
+                );
+            case EventType.UPDATE_WEBHOOK_STATUS:
+                return (
+                    <Td>
+                        <p>{`Environment: ${event.metadata.environment}`}</p>
+                        <p>{`Secret Path: ${event.metadata.secretPath}`}</p>
+                        <p>{`Webhook URL: ${event.metadata.webhookUrl}`}</p>
+                        <p>{`Disabled: ${event.metadata.isDisabled}`}</p>
+                    </Td>
+                );
+            case EventType.DELETE_WEBHOOK:
+                return (
+                    <Td>
+                        <p>{`Environment: ${event.metadata.environment}`}</p>
+                        <p>{`Secret Path: ${event.metadata.secretPath}`}</p>
+                        <p>{`Webhook URL: ${event.metadata.webhookUrl}`}</p>
+                        <p>{`Disabled: ${event.metadata.isDisabled}`}</p>
+                    </Td>
+                );
            default:
                return (
                    <Td>Test</Td>