auditing login

Kira-Pilot · Kira-Pilot · commit a75392ef2991 · 2023-02-01T20:13:56.000Z
diff --git a/site/src/components/AuditLogRow/AuditLogDescription.test.tsx b/site/src/components/AuditLogRow/AuditLogDescription.test.tsx
@@ -2,8 +2,12 @@ import {
   MockAuditLog,
   MockAuditLogWithWorkspaceBuild,
   MockWorkspaceCreateAuditLogForDifferentOwner,
+  MockAuditLogSuccessfulLogin,
+  MockAuditLogUnsuccessfulLoginKnownUser,
+  MockAuditLogUnsuccessfulLoginUnknownUser,
 } from "testHelpers/entities"
 import { AuditLogDescription } from "./AuditLogDescription"
+import { AuditLogRow } from "./AuditLogRow"
 import { render } from "../../testHelpers/renderHelpers"
 import { screen } from "@testing-library/react"
 
@@ -59,4 +63,22 @@ describe("AuditLogDescription", () => {
       ),
     ).toBeDefined()
   })
+  it("renders the correct string for successful login", async () => {
+    render(<AuditLogRow auditLog={MockAuditLogSuccessfulLogin} />)
+    expect(getByTextContent(`TestUser logged in`)).toBeDefined()
+    const statusPill = screen.getByRole("status")
+    expect(statusPill).toHaveTextContent("201")
+  })
+  it("renders the correct string for unsuccessful login for a known user", async () => {
+    render(<AuditLogRow auditLog={MockAuditLogUnsuccessfulLoginKnownUser} />)
+    expect(getByTextContent(`TestUser logged in`)).toBeDefined()
+    const statusPill = screen.getByRole("status")
+    expect(statusPill).toHaveTextContent("401")
+  })
+  it("renders the correct string for unsuccessful login for an unknown user", async () => {
+    render(<AuditLogRow auditLog={MockAuditLogUnsuccessfulLoginUnknownUser} />)
+    expect(getByTextContent(`An unknown user logged in`)).toBeDefined()
+    const statusPill = screen.getByRole("status")
+    expect(statusPill).toHaveTextContent("401")
+  })
 })
diff --git a/site/src/components/AuditLogRow/AuditLogDescription.tsx b/site/src/components/AuditLogRow/AuditLogDescription.tsx
@@ -12,7 +12,9 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
   const { t } = i18next
 
   let target = auditLog.resource_target.trim()
-  let user = auditLog.user?.username.trim()
+  let user = auditLog.user
+    ? auditLog.user.username.trim()
+    : t("auditLog:table.logRow.unknownUser")
 
   if (auditLog.resource_type === "workspace_build") {
     // audit logs with a resource_type of workspace build use workspace name as a target
@@ -22,7 +24,7 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
       auditLog.additional_fields?.build_reason &&
       auditLog.additional_fields?.build_reason !== "initiator"
         ? t("auditLog:table.logRow.buildReason")
-        : auditLog.user?.username.trim()
+        : user
   }
 
   // SSH key entries have no links
diff --git a/site/src/components/AuditLogRow/AuditLogRow.tsx b/site/src/components/AuditLogRow/AuditLogRow.tsx
@@ -93,7 +93,7 @@ export const AuditLogRow: React.FC<AuditLogRowProps> = ({
               className={styles.fullWidth}
             >
               <UserAvatar
-                username={auditLog.user?.username ?? ""}
+                username={auditLog.user?.username ?? "?"}
                 avatarURL={auditLog.user?.avatar_url}
               />
 
diff --git a/site/src/i18n/en/auditLog.json b/site/src/i18n/en/auditLog.json
@@ -14,7 +14,8 @@
       "browser": "Browser: ",
       "notAvailable": "Not available",
       "onBehalfOf": " on behalf of {{owner}}",
-      "buildReason": "Coder automatically"
+      "buildReason": "Coder automatically",
+      "unknownUser": "An unknown user"
     }
   },
   "paywall": {
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -1117,6 +1117,26 @@ export const MockAuditLogGitSSH: TypesGen.AuditLog = {
   },
 }
 
+export const MockAuditLogSuccessfulLogin: TypesGen.AuditLog = {
+  ...MockAuditLog,
+  resource_type: "api_key",
+  resource_target: "",
+  action: "login",
+  status_code: 201,
+  description: "{user} logged in",
+}
+
+export const MockAuditLogUnsuccessfulLoginKnownUser: TypesGen.AuditLog = {
+  ...MockAuditLogSuccessfulLogin,
+  status_code: 401,
+}
+
+export const MockAuditLogUnsuccessfulLoginUnknownUser: TypesGen.AuditLog = {
+  ...MockAuditLogSuccessfulLogin,
+  status_code: 401,
+  user: undefined,
+}
+
 export const MockWorkspaceQuota: TypesGen.WorkspaceQuota = {
   credits_consumed: 0,
   budget: 100,

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ export const AuditLogRow: React.FC<AuditLogRowProps> = ({`
`93`	`93`	`className={styles.fullWidth}`
`94`	`94`	`>`
`95`	`95`	`<UserAvatar`
`96`		`- username={auditLog.user?.username ?? ""}`
	`96`	`+ username={auditLog.user?.username ?? "?"}`
`97`	`97`	`avatarURL={auditLog.user?.avatar_url}`
`98`	`98`	`/>`
`99`	`99`