Add basic auditXService code

BrunoQuaresma · BrunoQuaresma · commit b8fa378a0211 · 2022-08-30T20:23:02.000Z
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -1,8 +1,10 @@
 import axios, { AxiosRequestHeaders } from "axios"
 import dayjs from "dayjs"
+import { MockAuditLog } from "testHelpers/entities"
 import * as Types from "./types"
 import { WorkspaceBuildTransition } from "./types"
 import * as TypesGen from "./typesGenerated"
+import { User } from "./typesGenerated"
 
 const CONTENT_TYPE_JSON: AxiosRequestHeaders = {
   "Content-Type": "application/json",
@@ -383,3 +385,32 @@ export const getEntitlements = async (): Promise<TypesGen.Entitlements> => {
   const response = await axios.get("/api/v2/entitlements")
   return response.data
 }
+
+interface AuditLog {
+  readonly id: string
+  readonly request_id: string
+  readonly time: string
+  readonly organization_id: string
+  // Named type "net/netip.Addr" unknown, using "any"
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  readonly ip: any
+  readonly user_agent: string
+  readonly resource_type: any
+  readonly resource_id: string
+  readonly resource_target: string
+  readonly action: any
+  readonly diff: any
+  readonly status_code: number
+  // This is likely an enum in an external package ("encoding/json.RawMessage")
+  readonly additional_fields: any
+  readonly description: string
+  readonly user?: User
+  // This is likely an enum in an external package ("encoding/json.RawMessage")
+  readonly resource: any
+}
+
+export const getAuditLogs = async (): Promise<AuditLog[]> => {
+  return [MockAuditLog]
+  // const response = await axios.get("/api/v2/audit")
+  // return response.data
+}
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -637,8 +637,8 @@ export const makeMockApiError = ({
   detail,
   validations,
 }: {
-  message?: string
-  detail?: string
+  message?: ""
+  detail?: ""
   validations?: FieldError[]
 }) => ({
   response: {
@@ -684,3 +684,22 @@ export const MockEntitlementsWithAuditLog: TypesGen.Entitlements = {
     },
   },
 }
+
+export const MockAuditLog = {
+  id: "fbd2116a-8961-4954-87ae-e4575bd29ce0",
+  request_id: "53bded77-7b9d-4e82-8771-991a34d759f9",
+  time: "2022-05-19T16:45:57.122Z",
+  organization_id: "fc0774ce-cc9e-48d4-80ae-88f7a4d4a8b0",
+  ip: "127.0.0.1",
+  user_agent: "browser",
+  resource_type: "organization",
+  resource_id: "ef8d1cf4-82de-4fd9-8980-047dad6d06b5",
+  resource_target: "Bruno's Org",
+  action: "create",
+  diff: {},
+  status_code: 200,
+  additional_fields: {},
+  description: "Colin Adler updated the organization Bruno's Org",
+  user: MockUser,
+  resource: MockOrganization,
+}
diff --git a/site/src/testHelpers/handlers.ts b/site/src/testHelpers/handlers.ts
@@ -147,4 +147,9 @@ export const handlers = [
   rest.get("/api/v2/entitlements", (req, res, ctx) => {
     return res(ctx.status(200), ctx.json(M.MockEntitlements))
   }),
+
+  // Audit
+  rest.get("/api/v2/audit", (req, res, ctx) => {
+    return res(ctx.status(200), ctx.json(M.MockAuditLog))
+  }),
 ]
diff --git a/site/src/xServices/audit/auditXService.ts b/site/src/xServices/audit/auditXService.ts
@@ -0,0 +1,43 @@
+import { getAuditLogs } from "api/api"
+import { assign, createMachine } from "xstate"
+
+type AuditLogs = Awaited<ReturnType<typeof getAuditLogs>>
+
+export const auditMachine = createMachine(
+  {
+    id: "auditMachine",
+    schema: {
+      context: {} as { auditLogs: AuditLogs },
+      services: {} as {
+        loadAuditLogs: {
+          data: AuditLogs
+        }
+      },
+    },
+    tsTypes: {} as import("./auditXService.typegen").Typegen0,
+    states: {
+      loadingLogs: {
+        invoke: {
+          src: "loadAuditLogs",
+          onDone: {
+            target: "success",
+            actions: ["assignAuditLogs"],
+          },
+        },
+      },
+      success: {
+        type: "final",
+      },
+    },
+  },
+  {
+    actions: {
+      assignAuditLogs: assign({
+        auditLogs: (_, event) => event.data,
+      }),
+    },
+    services: {
+      loadAuditLogs: () => getAuditLogs(),
+    },
+  },
+)
